| Copyright | (c) 2013-2023 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Amazonka.Kendra.DeletePrincipalMapping
Description
Deletes a group so that all users and sub groups 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 Amazon Web
Services GovCloud (US-West) region.
Synopsis
- data DeletePrincipalMapping = DeletePrincipalMapping' {
- dataSourceId :: Maybe Text
- orderingId :: Maybe Natural
- indexId :: Text
- groupId :: Text
- newDeletePrincipalMapping :: Text -> Text -> DeletePrincipalMapping
- deletePrincipalMapping_dataSourceId :: Lens' DeletePrincipalMapping (Maybe Text)
- deletePrincipalMapping_orderingId :: Lens' DeletePrincipalMapping (Maybe Natural)
- deletePrincipalMapping_indexId :: Lens' DeletePrincipalMapping Text
- deletePrincipalMapping_groupId :: Lens' DeletePrincipalMapping Text
- data DeletePrincipalMappingResponse = DeletePrincipalMappingResponse' {
- newDeletePrincipalMappingResponse :: DeletePrincipalMappingResponse
Creating a Request
data DeletePrincipalMapping Source #
See: newDeletePrincipalMapping smart constructor.
Constructors
| DeletePrincipalMapping' | |
Fields
| |
Instances
newDeletePrincipalMapping Source #
Arguments
| :: Text | |
| -> Text | |
| -> DeletePrincipalMapping |
Create a value of DeletePrincipalMapping with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeletePrincipalMapping, deletePrincipalMapping_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.
DeletePrincipalMapping, deletePrincipalMapping_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.
$sel:indexId:DeletePrincipalMapping', deletePrincipalMapping_indexId - The identifier of the index you want to delete a group from.
DeletePrincipalMapping, deletePrincipalMapping_groupId - The identifier of the group you want to delete.
Request Lenses
deletePrincipalMapping_dataSourceId :: Lens' DeletePrincipalMapping (Maybe Text) Source #
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.
deletePrincipalMapping_orderingId :: Lens' DeletePrincipalMapping (Maybe Natural) Source #
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.
deletePrincipalMapping_indexId :: Lens' DeletePrincipalMapping Text Source #
The identifier of the index you want to delete a group from.
deletePrincipalMapping_groupId :: Lens' DeletePrincipalMapping Text Source #
The identifier of the group you want to delete.
Destructuring the Response
data DeletePrincipalMappingResponse Source #
See: newDeletePrincipalMappingResponse smart constructor.
Constructors
| DeletePrincipalMappingResponse' | |
Instances
| Generic DeletePrincipalMappingResponse Source # | |
Defined in Amazonka.Kendra.DeletePrincipalMapping Associated Types type Rep DeletePrincipalMappingResponse :: Type -> Type # | |
| Read DeletePrincipalMappingResponse Source # | |
| Show DeletePrincipalMappingResponse Source # | |
Defined in Amazonka.Kendra.DeletePrincipalMapping Methods showsPrec :: Int -> DeletePrincipalMappingResponse -> ShowS # show :: DeletePrincipalMappingResponse -> String # showList :: [DeletePrincipalMappingResponse] -> ShowS # | |
| NFData DeletePrincipalMappingResponse Source # | |
Defined in Amazonka.Kendra.DeletePrincipalMapping Methods rnf :: DeletePrincipalMappingResponse -> () # | |
| Eq DeletePrincipalMappingResponse Source # | |
Defined in Amazonka.Kendra.DeletePrincipalMapping | |
| type Rep DeletePrincipalMappingResponse Source # | |
Defined in Amazonka.Kendra.DeletePrincipalMapping | |
newDeletePrincipalMappingResponse :: DeletePrincipalMappingResponse Source #
Create a value of DeletePrincipalMappingResponse with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.