GetDataSourceResult

data class GetDataSourceResult(val configuration: Any? = null, val createdAt: String? = null, val dataSourceArn: String? = null, val dataSourceId: String? = null, val description: String? = null, val displayName: String? = null, val documentEnrichmentConfiguration: DataSourceDocumentEnrichmentConfiguration? = null, val roleArn: String? = null, val status: DataSourceStatus? = null, val syncSchedule: String? = null, val tags: List<Tag>? = null, val type: String? = null, val updatedAt: String? = null, val vpcConfiguration: DataSourceVpcConfiguration? = null)

Constructors

Link copied to clipboard
constructor(configuration: Any? = null, createdAt: String? = null, dataSourceArn: String? = null, dataSourceId: String? = null, description: String? = null, displayName: String? = null, documentEnrichmentConfiguration: DataSourceDocumentEnrichmentConfiguration? = null, roleArn: String? = null, status: DataSourceStatus? = null, syncSchedule: String? = null, tags: List<Tag>? = null, type: String? = null, updatedAt: String? = null, vpcConfiguration: DataSourceVpcConfiguration? = null)

Types

Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val configuration: Any? = null

Use this property to specify a JSON or YAML schema with configuration information specific to your data source connector to connect your data source repository to Amazon Q Business . You must use the JSON or YAML schema provided by Amazon Q . You can find configuration templates for your specific data source using the following steps:

Link copied to clipboard
val createdAt: String? = null

The Unix timestamp when the Amazon Q Business data source was created.

Link copied to clipboard
val dataSourceArn: String? = null

The Amazon Resource Name (ARN) of a data source in an Amazon Q Business application.

Link copied to clipboard
val dataSourceId: String? = null

The identifier of the Amazon Q Business data source.

Link copied to clipboard
val description: String? = null

A description for the data source connector.

Link copied to clipboard
val displayName: String? = null

The name of the Amazon Q Business data source.

Link copied to clipboard

Provides the configuration information for altering document metadata and content during the document ingestion process. For more information, see Custom document enrichment .

Link copied to clipboard
val roleArn: String? = null

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources.

Link copied to clipboard

The status of the Amazon Q Business data source.

Link copied to clipboard
val syncSchedule: String? = null

Sets the frequency for Amazon Q Business to check the documents in your data source repository and update your index. If you don't set a schedule, Amazon Q Business won't periodically update the index. Specify a cron- format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the Schedule parameter when the Type parameter is set to CUSTOM . If you do, you receive a ValidationException exception.

Link copied to clipboard
val tags: List<Tag>? = null

A list of key-value pairs that identify or categorize the data source connector. You can also use tags to help control access to the data source connector. Tag keys and values can consist of Unicode letters, digits, white space, and any of the following symbols: _ . : / = + - @.

Link copied to clipboard
val type: String? = null

The type of the Amazon Q Business data source.

Link copied to clipboard
val updatedAt: String? = null

The Unix timestamp when the Amazon Q Business data source was last updated.

Link copied to clipboard

Configuration information for an Amazon VPC (Virtual Private Cloud) to connect to your data source. For more information, see Using Amazon VPC with Amazon Q Business connectors .