v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1483595482.8 KB

Adds one or more documents to an Amazon Q Business index.

You use this API to:

  • ingest your structured and unstructured documents and documents stored in an Amazon S3 bucket into an Amazon Q Business index.

  • add custom attributes to documents in an Amazon Q Business index.

  • attach an access control list to the documents added to an Amazon Q Business index.

You can see the progress of the deletion, and any error messages related to the process, by using CloudWatch.

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

Path parameters

applicationIdstring required

The identifier of the Amazon Q Business application.

indexIdstring required

The identifier of the Amazon Q Business index to add the documents to.

Request body

roleArnstring

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.

dataSourceSyncIdstring

The identifier of the data source sync during which the documents were added.

Response

Success