| 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.CreateAccessControlConfiguration
Description
Creates an access configuration for your documents. 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 use this to re-configure your existing document level access control without indexing all of your documents again. For example, your index contains top-secret company documents that only certain employees or users should access. One of these users leaves the company or switches to a team that should be blocked from accessing top-secret documents. The user still has access to top-secret documents because the user had access when your documents were previously indexed. You can create a specific access control configuration for the user with deny access. You can later update the access control configuration to allow access if the user returns to the company and re-joins the 'top-secret' team. You can re-configure access control for your documents as circumstances change.
To apply your access control configuration to certain documents, you
call the
BatchPutDocument
API with the AccessControlConfigurationId included in the
Document
object. If you use an S3 bucket as a data source, you update the
.metadata.json with the AccessControlConfigurationId and synchronize
your data source. Amazon Kendra currently only supports access control
configuration for S3 data sources and documents indexed using the
BatchPutDocument API.
Synopsis
- data CreateAccessControlConfiguration = CreateAccessControlConfiguration' {}
- newCreateAccessControlConfiguration :: Text -> Text -> CreateAccessControlConfiguration
- createAccessControlConfiguration_accessControlList :: Lens' CreateAccessControlConfiguration (Maybe [Principal])
- createAccessControlConfiguration_clientToken :: Lens' CreateAccessControlConfiguration (Maybe Text)
- createAccessControlConfiguration_description :: Lens' CreateAccessControlConfiguration (Maybe Text)
- createAccessControlConfiguration_hierarchicalAccessControlList :: Lens' CreateAccessControlConfiguration (Maybe (NonEmpty HierarchicalPrincipal))
- createAccessControlConfiguration_indexId :: Lens' CreateAccessControlConfiguration Text
- createAccessControlConfiguration_name :: Lens' CreateAccessControlConfiguration Text
- data CreateAccessControlConfigurationResponse = CreateAccessControlConfigurationResponse' {
- httpStatus :: Int
- id :: Text
- newCreateAccessControlConfigurationResponse :: Int -> Text -> CreateAccessControlConfigurationResponse
- createAccessControlConfigurationResponse_httpStatus :: Lens' CreateAccessControlConfigurationResponse Int
- createAccessControlConfigurationResponse_id :: Lens' CreateAccessControlConfigurationResponse Text
Creating a Request
data CreateAccessControlConfiguration Source #
See: newCreateAccessControlConfiguration smart constructor.
Constructors
| CreateAccessControlConfiguration' | |
Fields
| |
Instances
newCreateAccessControlConfiguration Source #
Arguments
| :: Text | |
| -> Text | |
| -> CreateAccessControlConfiguration |
Create a value of CreateAccessControlConfiguration 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:
CreateAccessControlConfiguration, createAccessControlConfiguration_accessControlList - Information 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:clientToken:CreateAccessControlConfiguration', createAccessControlConfiguration_clientToken - A token that you provide to identify the request to create an access
control configuration. Multiple calls to the
CreateAccessControlConfiguration API with the same client token will
create only one access control configuration.
$sel:description:CreateAccessControlConfiguration', createAccessControlConfiguration_description - A description for the access control configuration.
CreateAccessControlConfiguration, createAccessControlConfiguration_hierarchicalAccessControlList - The list of
principal
lists that define the hierarchy for which documents users should have
access to.
$sel:indexId:CreateAccessControlConfiguration', createAccessControlConfiguration_indexId - The identifier of the index to create an access control configuration
for your documents.
CreateAccessControlConfiguration, createAccessControlConfiguration_name - A name for the access control configuration.
Request Lenses
createAccessControlConfiguration_accessControlList :: Lens' CreateAccessControlConfiguration (Maybe [Principal]) Source #
Information 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.
createAccessControlConfiguration_clientToken :: Lens' CreateAccessControlConfiguration (Maybe Text) Source #
A token that you provide to identify the request to create an access
control configuration. Multiple calls to the
CreateAccessControlConfiguration API with the same client token will
create only one access control configuration.
createAccessControlConfiguration_description :: Lens' CreateAccessControlConfiguration (Maybe Text) Source #
A description for the access control configuration.
createAccessControlConfiguration_hierarchicalAccessControlList :: Lens' CreateAccessControlConfiguration (Maybe (NonEmpty HierarchicalPrincipal)) Source #
The list of principal lists that define the hierarchy for which documents users should have access to.
createAccessControlConfiguration_indexId :: Lens' CreateAccessControlConfiguration Text Source #
The identifier of the index to create an access control configuration for your documents.
createAccessControlConfiguration_name :: Lens' CreateAccessControlConfiguration Text Source #
A name for the access control configuration.
Destructuring the Response
data CreateAccessControlConfigurationResponse Source #
See: newCreateAccessControlConfigurationResponse smart constructor.
Constructors
| CreateAccessControlConfigurationResponse' | |
Fields
| |
Instances
newCreateAccessControlConfigurationResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> CreateAccessControlConfigurationResponse |
Create a value of CreateAccessControlConfigurationResponse 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:CreateAccessControlConfigurationResponse', createAccessControlConfigurationResponse_httpStatus - The response's http status code.
CreateAccessControlConfigurationResponse, createAccessControlConfigurationResponse_id - The identifier of the access control configuration for your documents in
an index.
Response Lenses
createAccessControlConfigurationResponse_httpStatus :: Lens' CreateAccessControlConfigurationResponse Int Source #
The response's http status code.
createAccessControlConfigurationResponse_id :: Lens' CreateAccessControlConfigurationResponse Text Source #
The identifier of the access control configuration for your documents in an index.