[ 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 | --cli-input-yaml]
[--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>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

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.

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
• yaml
• yaml-stream

--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.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input 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 Unix timestamp when an action was last updated. An action can be a PUT or DELETE action for mapping users to their groups.

ReceivedAt -> (timestamp)

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 -> (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.