DeletePrincipalMapping
Deletes a group so that all users that belong to the group can no longer access documents only available to that group.
For example, after deleting the group "Summer Interns", all interns who belonged to that group no longer see intern-only documents in their search results.
If you want to delete or replace users or sub groups of a group, you need to use the
PutPrincipalMapping operation. For example, if a user in the group
"Engineering" leaves the engineering team and another user takes their place, you
provide an updated list of users or sub groups that belong to the "Engineering" group
when calling PutPrincipalMapping. You can update your internal list of
users or sub groups and input this list when calling
PutPrincipalMapping.
DeletePrincipalMapping is currently not supported in the AWS GovCloud (US-West) region.
Request Syntax
{
"DataSourceId": "string",
"GroupId": "string",
"IndexId": "string",
"OrderingId": number
}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 you want to delete a group from.
A group can be tied to multiple data sources. You can delete a group from accessing documents in a certain data source. For example, the groups "Research", "Engineering", and "Sales and Marketing" are all tied to the company's documents stored in the data sources Confluence and Salesforce. You want to delete "Research" and "Engineering" groups from Salesforce, so that these groups cannot access customer-related documents stored in Salesforce. Only "Sales and Marketing" should access documents in the Salesforce data source.
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 you want to delete.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Pattern:
^\P{C}*$Required: Yes
- IndexId
-
The identifier of the index you want to delete a group from.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
[a-zA-Z0-9][a-zA-Z0-9-]*Required: Yes
- OrderingId
-
The timestamp identifier you specify to ensure Amazon Kendra does not override the latest
DELETEaction with previous actions. The highest number ID, which is the ordering ID, is the latest action you want to process and apply on top of other actions with lower number IDs. This prevents previous actions with lower number IDs from possibly overriding the latest action.The ordering ID can be the Unix time of the last update you made to a group members list. You would then provide this list when calling
PutPrincipalMapping. This ensures yourDELETEaction for that updated group with the latest members list doesn't get overwritten by earlierDELETEactions for the same group which are yet to be processed.The default ordering ID is the current Unix time in milliseconds that the action was received by Amazon Kendra.
Type: Long
Valid Range: Minimum value of 0. Maximum value of 32535158400000.
Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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
- ConflictException
-
A conflict occurred with the request. Please fix any inconsistences with your resources 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
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
