| 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.AssociatePersonasToEntities
Description
Defines the specific permissions of users or groups in your IAM Identity Center identity source with access to your Amazon Kendra experience. You can create an Amazon Kendra experience such as a search application. For more information on creating a search application experience, see Building a search experience with no code.
Synopsis
- data AssociatePersonasToEntities = AssociatePersonasToEntities' {}
- newAssociatePersonasToEntities :: Text -> Text -> NonEmpty EntityPersonaConfiguration -> AssociatePersonasToEntities
- associatePersonasToEntities_id :: Lens' AssociatePersonasToEntities Text
- associatePersonasToEntities_indexId :: Lens' AssociatePersonasToEntities Text
- associatePersonasToEntities_personas :: Lens' AssociatePersonasToEntities (NonEmpty EntityPersonaConfiguration)
- data AssociatePersonasToEntitiesResponse = AssociatePersonasToEntitiesResponse' {}
- newAssociatePersonasToEntitiesResponse :: Int -> AssociatePersonasToEntitiesResponse
- associatePersonasToEntitiesResponse_failedEntityList :: Lens' AssociatePersonasToEntitiesResponse (Maybe (NonEmpty FailedEntity))
- associatePersonasToEntitiesResponse_httpStatus :: Lens' AssociatePersonasToEntitiesResponse Int
Creating a Request
data AssociatePersonasToEntities Source #
See: newAssociatePersonasToEntities smart constructor.
Constructors
| AssociatePersonasToEntities' | |
Fields
| |
Instances
newAssociatePersonasToEntities Source #
Arguments
| :: Text | |
| -> Text | |
| -> NonEmpty EntityPersonaConfiguration | |
| -> AssociatePersonasToEntities |
Create a value of AssociatePersonasToEntities 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:
AssociatePersonasToEntities, associatePersonasToEntities_id - The identifier of your Amazon Kendra experience.
$sel:indexId:AssociatePersonasToEntities', associatePersonasToEntities_indexId - The identifier of the index for your Amazon Kendra experience.
$sel:personas:AssociatePersonasToEntities', associatePersonasToEntities_personas - The personas that define the specific permissions of users or groups in
your IAM Identity Center identity source. The available personas or
access roles are Owner and Viewer. For more information on these
personas, see
Providing access to your search page.
Request Lenses
associatePersonasToEntities_id :: Lens' AssociatePersonasToEntities Text Source #
The identifier of your Amazon Kendra experience.
associatePersonasToEntities_indexId :: Lens' AssociatePersonasToEntities Text Source #
The identifier of the index for your Amazon Kendra experience.
associatePersonasToEntities_personas :: Lens' AssociatePersonasToEntities (NonEmpty EntityPersonaConfiguration) Source #
The personas that define the specific permissions of users or groups in
your IAM Identity Center identity source. The available personas or
access roles are Owner and Viewer. For more information on these
personas, see
Providing access to your search page.
Destructuring the Response
data AssociatePersonasToEntitiesResponse Source #
See: newAssociatePersonasToEntitiesResponse smart constructor.
Constructors
| AssociatePersonasToEntitiesResponse' | |
Fields
| |
Instances
newAssociatePersonasToEntitiesResponse Source #
Arguments
| :: Int | |
| -> AssociatePersonasToEntitiesResponse |
Create a value of AssociatePersonasToEntitiesResponse 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:failedEntityList:AssociatePersonasToEntitiesResponse', associatePersonasToEntitiesResponse_failedEntityList - Lists the users or groups in your IAM Identity Center identity source
that failed to properly configure with your Amazon Kendra experience.
$sel:httpStatus:AssociatePersonasToEntitiesResponse', associatePersonasToEntitiesResponse_httpStatus - The response's http status code.
Response Lenses
associatePersonasToEntitiesResponse_failedEntityList :: Lens' AssociatePersonasToEntitiesResponse (Maybe (NonEmpty FailedEntity)) Source #
Lists the users or groups in your IAM Identity Center identity source that failed to properly configure with your Amazon Kendra experience.
associatePersonasToEntitiesResponse_httpStatus :: Lens' AssociatePersonasToEntitiesResponse Int Source #
The response's http status code.