Skip to content

check_ingested_document_acl

Operation

check_ingested_document_acl

check_ingested_document_acl(request: CheckIngestedDocumentAclInput | CheckIngestedDocumentAclInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CheckIngestedDocumentAclInputDict]) -> 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
request CheckIngestedDocumentAclInput | CheckIngestedDocumentAclInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[CheckIngestedDocumentAclInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CheckIngestedDocumentAclOutput

An instance of CheckIngestedDocumentAclOutput.

check_ingested_document_acl async

check_ingested_document_acl(request: CheckIngestedDocumentAclInput | CheckIngestedDocumentAclInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[CheckIngestedDocumentAclInputDict]) -> 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
request CheckIngestedDocumentAclInput | CheckIngestedDocumentAclInputDict | None

The input as a model or dictionary. Pass this or keyword arguments, not both.

None
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
**kwargs Unpack[CheckIngestedDocumentAclInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
CheckIngestedDocumentAclOutput

An instance of CheckIngestedDocumentAclOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

CheckIngestedDocumentAclInputDict

Bases: TypedDict

Dictionary form of CheckIngestedDocumentAclInput.

Attributes

data_source_id instance-attribute
data_source_id: Required[str]

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

document_id instance-attribute
document_id: Required[str]

The unique identifier of the document to check access for.

knowledge_base_id instance-attribute
knowledge_base_id: Required[str]

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

user_context instance-attribute

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).

CheckIngestedDocumentAclInput dataclass

Bases: _SerdeShape

Dataclass for CheckIngestedDocumentAclInput structure.

Attributes

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

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

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

The unique identifier of the document to check access for.

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

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

user_context class-attribute instance-attribute
user_context: UserContext | 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

Bases: _SerdeShape

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.

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.