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 |
Lists specific permissions of users and groups with access to your Amazon Kendra experience.
Synopsis
- data ListEntityPersonas = ListEntityPersonas' {}
- newListEntityPersonas :: Text -> Text -> ListEntityPersonas
- listEntityPersonas_maxResults :: Lens' ListEntityPersonas (Maybe Natural)
- listEntityPersonas_nextToken :: Lens' ListEntityPersonas (Maybe Text)
- listEntityPersonas_id :: Lens' ListEntityPersonas Text
- listEntityPersonas_indexId :: Lens' ListEntityPersonas Text
- data ListEntityPersonasResponse = ListEntityPersonasResponse' {
- nextToken :: Maybe Text
- summaryItems :: Maybe [PersonasSummary]
- httpStatus :: Int
- newListEntityPersonasResponse :: Int -> ListEntityPersonasResponse
- listEntityPersonasResponse_nextToken :: Lens' ListEntityPersonasResponse (Maybe Text)
- listEntityPersonasResponse_summaryItems :: Lens' ListEntityPersonasResponse (Maybe [PersonasSummary])
- listEntityPersonasResponse_httpStatus :: Lens' ListEntityPersonasResponse Int
Creating a Request
data ListEntityPersonas Source #
See: newListEntityPersonas
smart constructor.
ListEntityPersonas' | |
|
Instances
newListEntityPersonas Source #
Create a value of ListEntityPersonas
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:
ListEntityPersonas
, listEntityPersonas_maxResults
- The maximum number of returned users or groups.
ListEntityPersonas
, listEntityPersonas_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.
ListEntityPersonas
, listEntityPersonas_id
- The identifier of your Amazon Kendra experience.
$sel:indexId:ListEntityPersonas'
, listEntityPersonas_indexId
- The identifier of the index for your Amazon Kendra experience.
Request Lenses
listEntityPersonas_maxResults :: Lens' ListEntityPersonas (Maybe Natural) Source #
The maximum number of returned users or groups.
listEntityPersonas_nextToken :: Lens' ListEntityPersonas (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.
listEntityPersonas_id :: Lens' ListEntityPersonas Text Source #
The identifier of your Amazon Kendra experience.
listEntityPersonas_indexId :: Lens' ListEntityPersonas Text Source #
The identifier of the index for your Amazon Kendra experience.
Destructuring the Response
data ListEntityPersonasResponse Source #
See: newListEntityPersonasResponse
smart constructor.
ListEntityPersonasResponse' | |
|
Instances
newListEntityPersonasResponse Source #
Create a value of ListEntityPersonasResponse
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:
ListEntityPersonas
, listEntityPersonasResponse_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:ListEntityPersonasResponse'
, listEntityPersonasResponse_summaryItems
- An array of summary information for one or more users or groups.
$sel:httpStatus:ListEntityPersonasResponse'
, listEntityPersonasResponse_httpStatus
- The response's http status code.
Response Lenses
listEntityPersonasResponse_nextToken :: Lens' ListEntityPersonasResponse (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.
listEntityPersonasResponse_summaryItems :: Lens' ListEntityPersonasResponse (Maybe [PersonasSummary]) Source #
An array of summary information for one or more users or groups.
listEntityPersonasResponse_httpStatus :: Lens' ListEntityPersonasResponse Int Source #
The response's http status code.