Skip to content

CheckDocumentAccessRequest

Source code in docs_src/capo_qbusiness/types/check_document_access_request.py 
15
16
17
18
19
20
21
22
23
24
25
class CheckDocumentAccessRequest(TypedDict, closed=True):
    application_id: "capo_qbusiness.types.application_id.ApplicationId"
    """<p>The unique identifier of the application. This is required to identify the specific Amazon Q Business application context for the document access check.</p>"""
    index_id: "capo_qbusiness.types.index_id.IndexId"
    """<p>The unique identifier of the index. Used to locate the correct index within the application where the document is stored.</p>"""
    user_id: "capo_qbusiness.types.string.String"
    """<p>The unique identifier of the user. Used to check the access permissions for this specific user against the document's ACL.</p>"""
    document_id: "capo_qbusiness.types.document_id.DocumentId"
    """<p>The unique identifier of the document. Specifies which document's access permissions are being checked.</p>"""
    data_source_id: NotRequired["capo_qbusiness.types.data_source_id.DataSourceId"]
    """<p>The unique identifier of the data source. Identifies the specific data source from which the document originates. Should not be used when a document is uploaded directly with BatchPutDocument, as no dataSourceId is available or necessary. </p>"""

application_id instance-attribute 

application_id: ApplicationId

The unique identifier of the application. This is required to identify the specific Amazon Q Business application context for the document access check.

data_source_id instance-attribute 

data_source_id: NotRequired[DataSourceId]

The unique identifier of the data source. Identifies the specific data source from which the document originates. Should not be used when a document is uploaded directly with BatchPutDocument, as no dataSourceId is available or necessary.

document_id instance-attribute 

document_id: DocumentId

The unique identifier of the document. Specifies which document's access permissions are being checked.

index_id instance-attribute 

index_id: IndexId

The unique identifier of the index. Used to locate the correct index within the application where the document is stored.

user_id instance-attribute 

user_id: String

The unique identifier of the user. Used to check the access permissions for this specific user against the document's ACL.