Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Creates an Amazon Q Business index.

To determine if index creation has completed, check the Status field returned from a call to DescribeIndex. The Status field is set to ACTIVE when the index is ready to use.

Once the index is active, you can index your documents using the BatchPutDocument API or the CreateDataSource API.

post/applications/{applicationId}/indices

Path parameters

applicationIdstring required

The identifier of the Amazon Q Business application using the index.

Request body

displayNamestring required

A name for the Amazon Q Business index.

descriptionstring

A description for the Amazon Q Business index.

type'ENTERPRISE' | 'STARTER'

The index type that's suitable for your needs. For more information on what's included in each type of index, see <a href="https://docs.aws.amazon.com/amazonq/latest/qbusiness-ug/tiers.html#index-tiers">Amazon Q Business tiers</a>.

clientTokenstring

A token that you provide to identify the request to create an index. Multiple calls to the <code>CreateIndex</code> API with the same client token will create only one index.

Response

Success

indexIdstring

The identifier for the Amazon Q Business index.

indexArnstring

The Amazon Resource Name (ARN) of an Amazon Q Business index.