kendra / Client / describe_principal_mapping

describe_principal_mapping#

kendra.Client.describe_principal_mapping(**kwargs)#

Describes the processing of PUT and DELETE actions for mapping users to their groups. This includes information on the status of actions currently processing or yet to be processed, when actions were last updated, when actions were received by Amazon Kendra, the latest action that should process and apply after other actions, and useful error messages if an action could not be processed.

DescribePrincipalMapping is currently not supported in the Amazon Web Services GovCloud (US-West) region.

See also: AWS API Documentation

Request Syntax

response = client.describe_principal_mapping(
    IndexId='string',
    DataSourceId='string',
    GroupId='string'
)
Parameters:

  • IndexId (string) –

    [REQUIRED]

    The identifier of the index required to check the processing of PUT and DELETE actions for mapping users to their groups.

  • DataSourceId (string) – The identifier of the data source to check the processing of PUT and DELETE actions for mapping users to their groups.

  • GroupId (string) –

    [REQUIRED]

    The identifier of the group required to check the processing of PUT and DELETE actions for mapping users to their groups.

Return type:

dict

Returns:

Response Syntax

{
    'IndexId': 'string',
    'DataSourceId': 'string',
    'GroupId': 'string',
    'GroupOrderingIdSummaries': [
        {
            'Status': 'FAILED'|'SUCCEEDED'|'PROCESSING'|'DELETING'|'DELETED',
            'LastUpdatedAt': datetime(2015, 1, 1),
            'ReceivedAt': datetime(2015, 1, 1),
            'OrderingId': 123,
            'FailureReason': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • IndexId (string) –

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

    • DataSourceId (string) –

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

    • GroupId (string) –

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

    • GroupOrderingIdSummaries (list) –

      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.

      • (dict) –

        Summary information on the processing of PUT and DELETE actions for mapping users to their groups.

        • Status (string) –

          The current processing status of actions for mapping users to their groups. The status can be either PROCESSING, SUCCEEDED, DELETING, DELETED, or FAILED.

        • LastUpdatedAt (datetime) –

          The Unix timestamp when an action was last updated. An action can be a PUT or DELETE action for mapping users to their groups.

        • ReceivedAt (datetime) –

          The Unix timestamp when an action was received by Amazon Kendra. An action can be a PUT or DELETE action for mapping users to their groups.

        • OrderingId (integer) –

          The order in which actions should complete processing. An action can be a PUT or DELETE action for mapping users to their groups.

        • FailureReason (string) –

          The reason an action could not be processed. An action can be a PUT or DELETE action for mapping users to their groups.

Exceptions

  • kendra.Client.exceptions.ValidationException

  • kendra.Client.exceptions.ResourceNotFoundException

  • kendra.Client.exceptions.ThrottlingException

  • kendra.Client.exceptions.AccessDeniedException

  • kendra.Client.exceptions.InternalServerException