v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1465566486.4 KB

Adds one or more documents to an index.

The BatchPutDocument API enables you to ingest inline documents or a set of documents stored in an Amazon S3 bucket. Use this API to ingest your text and unstructured text into an index, add custom attributes to the documents, and to attach an access control list to the documents added to the index.

The documents are indexed asynchronously. You can see the progress of the batch using Amazon Web Services CloudWatch. Any error messages related to processing the batch are sent to your Amazon Web Services CloudWatch log.

For an example of ingesting inline documents using Python and Java SDKs, see Adding files directly to an index.

post/#X-Amz-Target=AWSKendraFrontendService.BatchPutDocument

Headers

X-Amz-Target'AWSKendraFrontendService.BatchPutDocument' required

Request body

IndexIdstring required

The identifier of the index to add the documents to. You need to create the index first using the <code>CreateIndex</code> API.

RoleArnstring

The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket. For more information, see <a href="https://docs.aws.amazon.com/kendra/latest/dg/iam-roles.html">IAM access roles for Amazon Kendra</a>.

Response

Success