Skip to content

BatchPutDocumentRequest

Source code in docs_src/capo_qbusiness/types/batch_put_document_request.py 
17
18
19
20
21
22
23
24
25
26
27
class BatchPutDocumentRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The identifier of the Amazon Q Business application.</p>"""
    index_id: "capo_qbusiness.types.index_id.IndexId"
    """<p>The identifier of the Amazon Q Business index to add the documents to. </p>"""
    documents: "capo_qbusiness.types.documents.Documents"
    """<p>One or more documents to add to the index.</p> <important> <p>Ensure that the name of your document doesn't contain any confidential information. Amazon Q Business returns document names in chat responses and citations when relevant.</p> </important>"""
    role_arn: NotRequired["capo_qbusiness.types.role_arn.RoleArn"]
    """<p>The Amazon Resource Name (ARN) of an IAM role with permission to access your S3 bucket.</p>"""
    data_source_sync_id: NotRequired["capo_qbusiness.types.execution_id.ExecutionId"]
    """<p>The identifier of the data source sync during which the documents were added.</p>"""

application_id instance-attribute 

application_id: ApplicationId

The identifier of the Amazon Q Business application.

data_source_sync_id instance-attribute 

data_source_sync_id: NotRequired[ExecutionId]

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

documents instance-attribute 

documents: Documents

One or more documents to add to the index.

Ensure that the name of your document doesn't contain any confidential information. Amazon Q Business returns document names in chat responses and citations when relevant.

index_id instance-attribute 

index_id: IndexId

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

role_arn instance-attribute 

role_arn: NotRequired[RoleArn]

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