Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribePrincipalMapping

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 AWS GovCloud (US-West) region.

Request Syntax


{
   "DataSourceId": "string",
   "GroupId": "string",
   "IndexId": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DataSourceId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

Required: No

GroupId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^\P{C}*$

Required: Yes

IndexId

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

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

Required: Yes

Response Syntax


{
   "DataSourceId": "string",
   "GroupId": "string",
   "GroupOrderingIdSummaries": [ 
      { 
         "FailureReason": "string",
         "LastUpdatedAt": number,
         "OrderingId": number,
         "ReceivedAt": number,
         "Status": "string"
      }
   ],
   "IndexId": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

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.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [a-zA-Z0-9][a-zA-Z0-9_-]*

GroupId

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: ^\P{C}*$

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.

Type: Array of GroupOrderingIdSummary objects

Array Members: Maximum number of 10 items.

IndexId

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

Type: String

Length Constraints: Fixed length of 36.

Pattern: [a-zA-Z0-9][a-zA-Z0-9-]*

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have sufficient access to perform this action. Please ensure you have the required permission policies and user accounts and try again.

HTTP Status Code: 400

InternalServerException

An issue occurred with the internal server used for your Amazon Kendra service. Please wait a few minutes and try again, or contact Support for help.

HTTP Status Code: 500

ResourceNotFoundException

The resource you want to use doesn’t exist. Please check you have provided the correct resource and try again.

HTTP Status Code: 400

ThrottlingException

The request was denied due to request throttling. Please reduce the number of requests and try again.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints set by the Amazon Kendra service. Please provide the correct input and try again.

HTTP Status Code: 400