| 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.ListExperienceEntities
Description
Lists users or groups in your IAM Identity Center identity source that are granted 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 ListExperienceEntities = ListExperienceEntities' {}
- newListExperienceEntities :: Text -> Text -> ListExperienceEntities
- listExperienceEntities_nextToken :: Lens' ListExperienceEntities (Maybe Text)
- listExperienceEntities_id :: Lens' ListExperienceEntities Text
- listExperienceEntities_indexId :: Lens' ListExperienceEntities Text
- data ListExperienceEntitiesResponse = ListExperienceEntitiesResponse' {}
- newListExperienceEntitiesResponse :: Int -> ListExperienceEntitiesResponse
- listExperienceEntitiesResponse_nextToken :: Lens' ListExperienceEntitiesResponse (Maybe Text)
- listExperienceEntitiesResponse_summaryItems :: Lens' ListExperienceEntitiesResponse (Maybe [ExperienceEntitiesSummary])
- listExperienceEntitiesResponse_httpStatus :: Lens' ListExperienceEntitiesResponse Int
Creating a Request
data ListExperienceEntities Source #
See: newListExperienceEntities smart constructor.
Constructors
| ListExperienceEntities' | |
Fields
| |
Instances
newListExperienceEntities Source #
Arguments
| :: Text | |
| -> Text | |
| -> ListExperienceEntities |
Create a value of ListExperienceEntities 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:
ListExperienceEntities, listExperienceEntities_nextToken - If the previous response was incomplete (because there is more data to
retrieve), Amazon Kendra returns a pagination token in the response. You
can use this pagination token to retrieve the next set of users or
groups.
ListExperienceEntities, listExperienceEntities_id - The identifier of your Amazon Kendra experience.
$sel:indexId:ListExperienceEntities', listExperienceEntities_indexId - The identifier of the index for your Amazon Kendra experience.
Request Lenses
listExperienceEntities_nextToken :: Lens' ListExperienceEntities (Maybe Text) Source #
If the previous response was incomplete (because there is more data to retrieve), Amazon Kendra returns a pagination token in the response. You can use this pagination token to retrieve the next set of users or groups.
listExperienceEntities_id :: Lens' ListExperienceEntities Text Source #
The identifier of your Amazon Kendra experience.
listExperienceEntities_indexId :: Lens' ListExperienceEntities Text Source #
The identifier of the index for your Amazon Kendra experience.
Destructuring the Response
data ListExperienceEntitiesResponse Source #
See: newListExperienceEntitiesResponse smart constructor.
Constructors
| ListExperienceEntitiesResponse' | |
Fields
| |
Instances
newListExperienceEntitiesResponse Source #
Create a value of ListExperienceEntitiesResponse 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:
ListExperienceEntities, listExperienceEntitiesResponse_nextToken - If the response is truncated, Amazon Kendra returns this token, which
you can use in a later request to retrieve the next set of users or
groups.
$sel:summaryItems:ListExperienceEntitiesResponse', listExperienceEntitiesResponse_summaryItems - An array of summary information for one or more users or groups.
$sel:httpStatus:ListExperienceEntitiesResponse', listExperienceEntitiesResponse_httpStatus - The response's http status code.
Response Lenses
listExperienceEntitiesResponse_nextToken :: Lens' ListExperienceEntitiesResponse (Maybe Text) Source #
If the response is truncated, Amazon Kendra returns this token, which you can use in a later request to retrieve the next set of users or groups.
listExperienceEntitiesResponse_summaryItems :: Lens' ListExperienceEntitiesResponse (Maybe [ExperienceEntitiesSummary]) Source #
An array of summary information for one or more users or groups.
listExperienceEntitiesResponse_httpStatus :: Lens' ListExperienceEntitiesResponse Int Source #
The response's http status code.