Skip to content

DescribePrincipalMappingResponse

Source code in docs_src/capo_kendra/types/describe_principal_mapping_response.py
class DescribePrincipalMappingResponse(TypedDict, closed=True):
    index_id: NotRequired["capo_kendra.types.index_id.IndexId"]
    """<p>Shows the identifier of the index to see information on the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups.</p>"""
    data_source_id: NotRequired["capo_kendra.types.data_source_id.DataSourceId"]
    """<p>Shows the identifier of the data source to see information on the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups.</p>"""
    group_id: NotRequired["capo_kendra.types.group_id.GroupId"]
    """<p>Shows the identifier of the group to see information on the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups.</p>"""
    group_ordering_id_summaries: NotRequired[
        "capo_kendra.types.group_ordering_id_summaries.GroupOrderingIdSummaries"
    ]
    """<p>Shows the following information on the processing of <code>PUT</code> and <code>DELETE</code> actions for mapping users to their groups:</p> <ul> <li> <p>Status—the status can be either <code>PROCESSING</code>, <code>SUCCEEDED</code>, <code>DELETING</code>, <code>DELETED</code>, or <code>FAILED</code>.</p> </li> <li> <p>Last updated—the last date-time an action was updated.</p> </li> <li> <p>Received—the last date-time an action was received or submitted.</p> </li> <li> <p>Ordering ID—the latest action that should process and apply after other actions.</p> </li> <li> <p>Failure reason—the reason an action could not be processed.</p> </li> </ul>"""

data_source_id instance-attribute

data_source_id: NotRequired[DataSourceId]

Shows the identifier of the data source to see information on the processing of PUT and DELETE actions for mapping users to their groups.

group_id instance-attribute

group_id: NotRequired[GroupId]

Shows the identifier of the group to see information on the processing of PUT and DELETE actions for mapping users to their groups.

group_ordering_id_summaries instance-attribute

group_ordering_id_summaries: NotRequired[GroupOrderingIdSummaries]

Shows the following information on the processing of PUT and DELETE actions for mapping users to their groups:

  • Status—the status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

  • Last updated—the last date-time an action was updated.

  • Received—the last date-time an action was received or submitted.

  • Ordering ID—the latest action that should process and apply after other actions.

  • Failure reason—the reason an action could not be processed.

index_id instance-attribute

index_id: NotRequired[IndexId]

Shows the identifier of the index to see information on the processing of PUT and DELETE actions for mapping users to their groups.