Skip to content

UpdateAccessControlConfigurationRequest

Source code in docs_src/capo_kendra/types/update_access_control_configuration_request.py
class UpdateAccessControlConfigurationRequest(TypedDict, closed=True):
    index_id: "capo_kendra.types.index_id.IndexId"
    """<p>The identifier of the index for an access control configuration.</p>"""
    id: "capo_kendra.types.access_control_configuration_id.AccessControlConfigurationId"
    """<p>The identifier of the access control configuration you want to update.</p>"""
    name: NotRequired[
        "capo_kendra.types.access_control_configuration_name.AccessControlConfigurationName"
    ]
    """<p>A new name for the access control configuration.</p>"""
    description: NotRequired["capo_kendra.types.description.Description"]
    """<p>A new description for the access control configuration.</p>"""
    access_control_list: NotRequired["capo_kendra.types.principal_list.PrincipalList"]
    """<p>Information you want to update 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 updated 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 you want to update 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]

A new description for the access control configuration.

hierarchical_access_control_list instance-attribute

hierarchical_access_control_list: NotRequired[HierarchicalPrincipalList]

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

id instance-attribute

The identifier of the access control configuration you want to update.

index_id instance-attribute

index_id: IndexId

The identifier of the index for an access control configuration.

name instance-attribute

name: NotRequired[AccessControlConfigurationName]

A new name for the access control configuration.