| 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.UpdateAccessControlConfiguration
Description
Updates an access control configuration for your documents in an index. This includes user and group access information for your documents. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
You can update an access control configuration you created without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. You created an 'allow' access control configuration for one user who recently joined the 'top-secret' team, switching from a team with 'deny' access to top-secret documents. However, the user suddenly returns to their previous team and should no longer have access to top secret documents. You can update the access control configuration to re-configure access control for your documents as circumstances change.
You call the
BatchPutDocument
API to apply the updated access control configuration, with the
AccessControlConfigurationId included in the
Document
object. If you use an S3 bucket as a data source, you synchronize your
data source to apply the AccessControlConfigurationId in the
.metadata.json file. Amazon Kendra currently only supports access
control configuration for S3 data sources and documents indexed using
the BatchPutDocument API.
Synopsis
- data UpdateAccessControlConfiguration = UpdateAccessControlConfiguration' {}
- newUpdateAccessControlConfiguration :: Text -> Text -> UpdateAccessControlConfiguration
- updateAccessControlConfiguration_accessControlList :: Lens' UpdateAccessControlConfiguration (Maybe [Principal])
- updateAccessControlConfiguration_description :: Lens' UpdateAccessControlConfiguration (Maybe Text)
- updateAccessControlConfiguration_hierarchicalAccessControlList :: Lens' UpdateAccessControlConfiguration (Maybe (NonEmpty HierarchicalPrincipal))
- updateAccessControlConfiguration_name :: Lens' UpdateAccessControlConfiguration (Maybe Text)
- updateAccessControlConfiguration_indexId :: Lens' UpdateAccessControlConfiguration Text
- updateAccessControlConfiguration_id :: Lens' UpdateAccessControlConfiguration Text
- data UpdateAccessControlConfigurationResponse = UpdateAccessControlConfigurationResponse' {
- httpStatus :: Int
- newUpdateAccessControlConfigurationResponse :: Int -> UpdateAccessControlConfigurationResponse
- updateAccessControlConfigurationResponse_httpStatus :: Lens' UpdateAccessControlConfigurationResponse Int
Creating a Request
data UpdateAccessControlConfiguration Source #
See: newUpdateAccessControlConfiguration smart constructor.
Constructors
| UpdateAccessControlConfiguration' | |
Fields
| |
Instances
newUpdateAccessControlConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> UpdateAccessControlConfiguration |
Create a value of UpdateAccessControlConfiguration 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:
UpdateAccessControlConfiguration, updateAccessControlConfiguration_accessControlList - Information you want to update on principals (users and/or groups) and
which documents they should have access to. This is useful for user
context filtering, where search results are filtered based on the user
or their group access to documents.
$sel:description:UpdateAccessControlConfiguration', updateAccessControlConfiguration_description - A new description for the access control configuration.
UpdateAccessControlConfiguration, updateAccessControlConfiguration_hierarchicalAccessControlList - The updated list of
principal
lists that define the hierarchy for which documents users should have
access to.
UpdateAccessControlConfiguration, updateAccessControlConfiguration_name - A new name for the access control configuration.
$sel:indexId:UpdateAccessControlConfiguration', updateAccessControlConfiguration_indexId - The identifier of the index for an access control configuration.
UpdateAccessControlConfiguration, updateAccessControlConfiguration_id - The identifier of the access control configuration you want to update.
Request Lenses
updateAccessControlConfiguration_accessControlList :: Lens' UpdateAccessControlConfiguration (Maybe [Principal]) Source #
Information you want to update on principals (users and/or groups) and which documents they should have access to. This is useful for user context filtering, where search results are filtered based on the user or their group access to documents.
updateAccessControlConfiguration_description :: Lens' UpdateAccessControlConfiguration (Maybe Text) Source #
A new description for the access control configuration.
updateAccessControlConfiguration_hierarchicalAccessControlList :: Lens' UpdateAccessControlConfiguration (Maybe (NonEmpty HierarchicalPrincipal)) Source #
The updated list of principal lists that define the hierarchy for which documents users should have access to.
updateAccessControlConfiguration_name :: Lens' UpdateAccessControlConfiguration (Maybe Text) Source #
A new name for the access control configuration.
updateAccessControlConfiguration_indexId :: Lens' UpdateAccessControlConfiguration Text Source #
The identifier of the index for an access control configuration.
updateAccessControlConfiguration_id :: Lens' UpdateAccessControlConfiguration Text Source #
The identifier of the access control configuration you want to update.
Destructuring the Response
data UpdateAccessControlConfigurationResponse Source #
See: newUpdateAccessControlConfigurationResponse smart constructor.
Constructors
| UpdateAccessControlConfigurationResponse' | |
Fields
| |
Instances
newUpdateAccessControlConfigurationResponse Source #
Arguments
| :: Int | |
| -> UpdateAccessControlConfigurationResponse |
Create a value of UpdateAccessControlConfigurationResponse 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:
$sel:httpStatus:UpdateAccessControlConfigurationResponse', updateAccessControlConfigurationResponse_httpStatus - The response's http status code.
Response Lenses
updateAccessControlConfigurationResponse_httpStatus :: Lens' UpdateAccessControlConfigurationResponse Int Source #
The response's http status code.