/AWS1/CL_QQB=>CREATEDATASOURCE()

About CreateDataSource

Creates a data source connector for an Amazon Q Business application.

CreateDataSource is a synchronous operation. The operation returns 200 if the data source was successfully created. Otherwise, an exception is raised.

Method Signature

IMPORTING

Required arguments:

IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID

The identifier of the Amazon Q Business application the data source will be attached to.

IV_INDEXID TYPE /AWS1/QQBINDEXID /AWS1/QQBINDEXID

The identifier of the index that you want to use with the data source connector.

IV_DISPLAYNAME TYPE /AWS1/QQBDATASOURCENAME /AWS1/QQBDATASOURCENAME

A name for the data source connector.

IO_CONFIGURATION TYPE REF TO /AWS1/CL_RT_DOCUMENT /AWS1/CL_RT_DOCUMENT

Configuration information to connect to your data source repository. For configuration templates for your specific data source, see Supported connectors.

Optional arguments:

IO_VPCCONFIGURATION TYPE REF TO /AWS1/CL_QQBDATASOURCEVPCCONF /AWS1/CL_QQBDATASOURCEVPCCONF

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.

IV_DESCRIPTION TYPE /AWS1/QQBDESCRIPTION /AWS1/QQBDESCRIPTION

A description for the data source connector.

IT_TAGS TYPE /AWS1/CL_QQBTAG=>TT_TAGS TT_TAGS

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: _ . : / = + - @.

IV_SYNCSCHEDULE TYPE /AWS1/QQBSYNCSCHEDULE /AWS1/QQBSYNCSCHEDULE

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.

IV_ROLEARN TYPE /AWS1/QQBROLEARN /AWS1/QQBROLEARN

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

IV_CLIENTTOKEN TYPE /AWS1/QQBCLIENTTOKEN /AWS1/QQBCLIENTTOKEN

A token you provide to identify a request to create a data source connector. Multiple calls to the CreateDataSource API with the same client token will create only one data source connector.

IO_DOCUMENTENRICHMENTCONF TYPE REF TO /AWS1/CL_QQBDOCENRICHMENTCONF /AWS1/CL_QQBDOCENRICHMENTCONF

documentEnrichmentConfiguration

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_QQBCREATEDATASRCRSP /AWS1/CL_QQBCREATEDATASRCRSP