Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ 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

Synopsis

  describe-principal-mapping
--index-id <value>
[--data-source-id <value>]
--group-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <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 (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

--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. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

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.