public static interface DeletePrincipalMappingRequest.Builder extends KendraRequest.Builder, SdkPojo, CopyableBuilder<DeletePrincipalMappingRequest.Builder,DeletePrincipalMappingRequest>
| Modifier and Type | Method and Description |
|---|---|
DeletePrincipalMappingRequest.Builder |
dataSourceId(String dataSourceId)
The identifier of the data source you want to delete a group from.
|
DeletePrincipalMappingRequest.Builder |
groupId(String groupId)
The identifier of the group you want to delete.
|
DeletePrincipalMappingRequest.Builder |
indexId(String indexId)
The identifier of the index you want to delete a group from.
|
DeletePrincipalMappingRequest.Builder |
orderingId(Long orderingId)
The timestamp identifier you specify to ensure Amazon Kendra does not override the latest
DELETE
action with previous actions. |
DeletePrincipalMappingRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
DeletePrincipalMappingRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildDeletePrincipalMappingRequest.Builder indexId(String indexId)
The identifier of the index you want to delete a group from.
indexId - The identifier of the index you want to delete a group from.DeletePrincipalMappingRequest.Builder dataSourceId(String 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.
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.
DeletePrincipalMappingRequest.Builder groupId(String groupId)
The identifier of the group you want to delete.
groupId - The identifier of the group you want to delete.DeletePrincipalMappingRequest.Builder orderingId(Long orderingId)
The timestamp identifier you specify to ensure Amazon Kendra does not override the latest DELETE
action 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 your DELETE action
for that updated group with the latest members list doesn't get overwritten by earlier DELETE
actions 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.
orderingId - The timestamp identifier you specify to ensure Amazon Kendra does not override the latest
DELETE action 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 your
DELETE action for that updated group with the latest members list doesn't get overwritten
by earlier DELETE actions 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.
DeletePrincipalMappingRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderDeletePrincipalMappingRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.