Skip to content

DescribeAccessControlConfigurationResponse

Source code in docs_src/capo_kendra/types/describe_access_control_configuration_response.py 
17
18
19
20
21
22
23
24
25
26
27
28
29
class DescribeAccessControlConfigurationResponse(TypedDict, closed=True):
    name: "capo_kendra.types.access_control_configuration_name.AccessControlConfigurationName"
    """<p>The name for the access control configuration.</p>"""
    description: NotRequired["capo_kendra.types.description.Description"]
    """<p>The description for the access control configuration.</p>"""
    error_message: NotRequired["capo_kendra.types.error_message.ErrorMessage"]
    """<p>The error message containing details if there are issues processing the access control configuration.</p>"""
    access_control_list: NotRequired["capo_kendra.types.principal_list.PrincipalList"]
    """<p>Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.</p>"""
    hierarchical_access_control_list: NotRequired[
        "capo_kendra.types.hierarchical_principal_list.HierarchicalPrincipalList"
    ]
    """<p>The list of <a href="https://docs.aws.amazon.com/kendra/latest/dg/API_Principal.html">principal</a> lists that define the hierarchy for which documents users should have access to.</p>"""

access_control_list instance-attribute 

access_control_list: NotRequired[PrincipalList]

Information on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.

description instance-attribute 

description: NotRequired[Description]

The description for the access control configuration.

error_message instance-attribute 

error_message: NotRequired[ErrorMessage]

The error message containing details if there are issues processing the access control configuration.

hierarchical_access_control_list instance-attribute 

hierarchical_access_control_list: NotRequired[HierarchicalPrincipalList]

The list of principal lists that define the hierarchy for which documents users should have access to.

name instance-attribute 

name: AccessControlConfigurationName

The name for the access control configuration.