Skip to content

Bedrock Agent Runtime  >  Operations  >  check_ingested_document_acl

check_ingested_document_acl

Operation

check_ingested_document_acl async 

check_ingested_document_acl(input: CheckIngestedDocumentAclInput, plugins: list[Plugin] | None = None) -> CheckIngestedDocumentAclOutput

Checks whether a user has access to a specific document by verifying against the ingested access control list (ACL) in a knowledge base. Use this operation to validate that document-level access control is working as expected after ingestion. To use this operation, you must have the bedrock:CheckIngestedDocumentAcl permission.

Parameters:

Name Type Description Default
input CheckIngestedDocumentAclInput

An instance of CheckIngestedDocumentAclInput.

 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
CheckIngestedDocumentAclOutput

An instance of CheckIngestedDocumentAclOutput.

Input

CheckIngestedDocumentAclInput dataclass

Dataclass for CheckIngestedDocumentAclInput 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 check access 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.

user_context class-attribute instance-attribute 
user_context: UserContext | None = field(repr=False, default=None)

The context object containing identity information for access control filtering, including user ID and optional group memberships used to evaluate the document access control list (ACL).

Output

CheckIngestedDocumentAclOutput dataclass

Dataclass for CheckIngestedDocumentAclOutput structure.

Attributes

has_access instance-attribute 
has_access: bool

Specifies whether the user has access to the document based on the ingested access control list (ACL). Returns true if the user is allowed access, and false otherwise.