Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

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.

post/applications/{applicationId}/indices/{indexId}/datasources

Path parameters

applicationIdstring required

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

indexIdstring required

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

Request body

displayNamestring required

A name for the data source connector.

configurationobject required

Provides the configuration information for an Amazon Q Business data source.

descriptionstring

A description for the data source connector.

syncSchedulestring
<p>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.</p> <p>Specify a <code>cron-</code> format schedule string or an empty string to indicate that the index is updated on demand. You can't specify the <code>Schedule</code> parameter when the <code>Type</code> parameter is set to <code>CUSTOM</code>. If you do, you receive a <code>ValidationException</code> exception. </p>
roleArnstring

The Amazon Resource Name (ARN) of an IAM role with permission to access the data source and required resources. This field is required for all connector types except custom connectors, where it is optional.

clientTokenstring

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

Response

Success

dataSourceIdstring

The identifier of the data source connector.

dataSourceArnstring

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