Skip to content

Bedrock Agent Runtime  >  Operations  >  get_ingested_document_acl

get_ingested_document_acl

Operation

get_ingested_document_acl async 

get_ingested_document_acl(input: GetIngestedDocumentAclInput, plugins: list[Plugin] | None = None) -> GetIngestedDocumentAclOutput

Retrieves the ingested access control list (ACL) for a specific document in a knowledge base. Use this operation to inspect the allow and deny lists that were ingested for a document to troubleshoot access control issues. To use this operation, you must have the bedrock:GetIngestedDocumentAcl permission.

Parameters:

Name Type Description Default
input GetIngestedDocumentAclInput

An instance of GetIngestedDocumentAclInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
GetIngestedDocumentAclOutput

An instance of GetIngestedDocumentAclOutput.

Input

GetIngestedDocumentAclInput dataclass

Dataclass for GetIngestedDocumentAclInput structure.

Attributes

data_source_id class-attribute instance-attribute 
data_source_id: str | None = None

The unique identifier of the data source that contains the document.

document_id class-attribute instance-attribute 
document_id: str | None = None

The unique identifier of the document to retrieve the ingested access control list (ACL) for.

knowledge_base_id class-attribute instance-attribute 
knowledge_base_id: str | None = None

The unique identifier of the knowledge base that contains the document.

Output

GetIngestedDocumentAclOutput dataclass

Dataclass for GetIngestedDocumentAclOutput structure.

Attributes

document_acl class-attribute instance-attribute 
document_acl: DocumentAcl = field(repr=False)

The ingested document access control list (ACL) containing allow and deny membership information.