get_ingested_document_acl¶
Operation¶
get_ingested_document_acl
¶
get_ingested_document_acl(request: GetIngestedDocumentAclInput | GetIngestedDocumentAclInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIngestedDocumentAclInputDict]) -> 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 |
|---|---|---|---|
request
|
GetIngestedDocumentAclInput | GetIngestedDocumentAclInputDict | 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[GetIngestedDocumentAclInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetIngestedDocumentAclOutput
|
An instance of |
get_ingested_document_acl
async
¶
get_ingested_document_acl(request: GetIngestedDocumentAclInput | GetIngestedDocumentAclInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetIngestedDocumentAclInputDict]) -> 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 |
|---|---|---|---|
request
|
GetIngestedDocumentAclInput | GetIngestedDocumentAclInputDict | 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[GetIngestedDocumentAclInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
GetIngestedDocumentAclOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
GetIngestedDocumentAclInputDict
¶
Bases: TypedDict
Dictionary form of GetIngestedDocumentAclInput.
GetIngestedDocumentAclInput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetIngestedDocumentAclInput 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.
Output¶
GetIngestedDocumentAclOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for GetIngestedDocumentAclOutput structure.
Attributes¶
document_acl
instance-attribute
¶
document_acl: DocumentAcl
The ingested document access control list (ACL) containing allow and deny membership information.
response_metadata
class-attribute
instance-attribute
¶
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.