Skip to content

/AWS1/CL_QQB=>BATCHPUTDOCUMENT()

About BatchPutDocument

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.

Method Signature

IMPORTING

Required arguments:

IV_APPLICATIONID TYPE /AWS1/QQBAPPLICATIONID /AWS1/QQBAPPLICATIONID

The identifier of the Amazon Q Business application.

IV_INDEXID TYPE /AWS1/QQBINDEXID /AWS1/QQBINDEXID

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

IT_DOCUMENTS TYPE /AWS1/CL_QQBDOCUMENT=>TT_DOCUMENTS TT_DOCUMENTS

One or more documents to add to the index.

Optional arguments:

IV_ROLEARN TYPE /AWS1/QQBROLEARN /AWS1/QQBROLEARN

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

IV_DATASOURCESYNCID TYPE /AWS1/QQBEXECUTIONID /AWS1/QQBEXECUTIONID

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

RETURNING

OO_OUTPUT TYPE REF TO /AWS1/CL_QQBBATCHPUTDOCRSP /AWS1/CL_QQBBATCHPUTDOCRSP