[ aws . kendra ]

describe-principal-mapping

Description

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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-principal-mapping
--index-id <value>
[--data-source-id <value>]
--group-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--index-id (string)

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

--data-source-id (string)

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

--group-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

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.

(structure)

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 -> (timestamp)

The last date-time an action was updated. An action can be a PUT or DELETE action for mapping users to their groups.

ReceivedAt -> (timestamp)

The date-time an action was received by Amazon Kendra. An action can be a PUT or DELETE action for mapping users to their groups.

OrderingId -> (long)

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.