| 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.ListGroupsOlderThanOrderingId
Description
Provides a list of groups that are mapped to users before a given ordering or timestamp identifier.
ListGroupsOlderThanOrderingId is currently not supported in the Amazon
Web Services GovCloud (US-West) region.
Synopsis
- data ListGroupsOlderThanOrderingId = ListGroupsOlderThanOrderingId' {
- dataSourceId :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- indexId :: Text
- orderingId :: Natural
- newListGroupsOlderThanOrderingId :: Text -> Natural -> ListGroupsOlderThanOrderingId
- listGroupsOlderThanOrderingId_dataSourceId :: Lens' ListGroupsOlderThanOrderingId (Maybe Text)
- listGroupsOlderThanOrderingId_maxResults :: Lens' ListGroupsOlderThanOrderingId (Maybe Natural)
- listGroupsOlderThanOrderingId_nextToken :: Lens' ListGroupsOlderThanOrderingId (Maybe Text)
- listGroupsOlderThanOrderingId_indexId :: Lens' ListGroupsOlderThanOrderingId Text
- listGroupsOlderThanOrderingId_orderingId :: Lens' ListGroupsOlderThanOrderingId Natural
- data ListGroupsOlderThanOrderingIdResponse = ListGroupsOlderThanOrderingIdResponse' {
- groupsSummaries :: Maybe [GroupSummary]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListGroupsOlderThanOrderingIdResponse :: Int -> ListGroupsOlderThanOrderingIdResponse
- listGroupsOlderThanOrderingIdResponse_groupsSummaries :: Lens' ListGroupsOlderThanOrderingIdResponse (Maybe [GroupSummary])
- listGroupsOlderThanOrderingIdResponse_nextToken :: Lens' ListGroupsOlderThanOrderingIdResponse (Maybe Text)
- listGroupsOlderThanOrderingIdResponse_httpStatus :: Lens' ListGroupsOlderThanOrderingIdResponse Int
Creating a Request
data ListGroupsOlderThanOrderingId Source #
See: newListGroupsOlderThanOrderingId smart constructor.
Constructors
| ListGroupsOlderThanOrderingId' | |
Fields
| |
Instances
newListGroupsOlderThanOrderingId Source #
Arguments
| :: Text | |
| -> Natural | |
| -> ListGroupsOlderThanOrderingId |
Create a value of ListGroupsOlderThanOrderingId 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:
ListGroupsOlderThanOrderingId, listGroupsOlderThanOrderingId_dataSourceId - The identifier of the data source for getting a list of groups mapped to
users before a given ordering timestamp identifier.
ListGroupsOlderThanOrderingId, listGroupsOlderThanOrderingId_maxResults - The maximum number of returned groups that are mapped to users before a
given ordering or timestamp identifier.
ListGroupsOlderThanOrderingId, listGroupsOlderThanOrderingId_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 groups that
are mapped to users before a given ordering or timestamp identifier.
$sel:indexId:ListGroupsOlderThanOrderingId', listGroupsOlderThanOrderingId_indexId - The identifier of the index for getting a list of groups mapped to users
before a given ordering or timestamp identifier.
ListGroupsOlderThanOrderingId, listGroupsOlderThanOrderingId_orderingId - The timestamp identifier used for the latest PUT or DELETE action
for mapping users to their groups.
Request Lenses
listGroupsOlderThanOrderingId_dataSourceId :: Lens' ListGroupsOlderThanOrderingId (Maybe Text) Source #
The identifier of the data source for getting a list of groups mapped to users before a given ordering timestamp identifier.
listGroupsOlderThanOrderingId_maxResults :: Lens' ListGroupsOlderThanOrderingId (Maybe Natural) Source #
The maximum number of returned groups that are mapped to users before a given ordering or timestamp identifier.
listGroupsOlderThanOrderingId_nextToken :: Lens' ListGroupsOlderThanOrderingId (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 groups that are mapped to users before a given ordering or timestamp identifier.
listGroupsOlderThanOrderingId_indexId :: Lens' ListGroupsOlderThanOrderingId Text Source #
The identifier of the index for getting a list of groups mapped to users before a given ordering or timestamp identifier.
listGroupsOlderThanOrderingId_orderingId :: Lens' ListGroupsOlderThanOrderingId Natural Source #
The timestamp identifier used for the latest PUT or DELETE action
for mapping users to their groups.
Destructuring the Response
data ListGroupsOlderThanOrderingIdResponse Source #
See: newListGroupsOlderThanOrderingIdResponse smart constructor.
Constructors
| ListGroupsOlderThanOrderingIdResponse' | |
Fields
| |
Instances
newListGroupsOlderThanOrderingIdResponse Source #
Arguments
| :: Int | |
| -> ListGroupsOlderThanOrderingIdResponse |
Create a value of ListGroupsOlderThanOrderingIdResponse 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:groupsSummaries:ListGroupsOlderThanOrderingIdResponse', listGroupsOlderThanOrderingIdResponse_groupsSummaries - Summary information for list of groups that are mapped to users before a
given ordering or timestamp identifier.
ListGroupsOlderThanOrderingId, listGroupsOlderThanOrderingIdResponse_nextToken - If the response is truncated, Amazon Kendra returns this token that you
can use in the subsequent request to retrieve the next set of groups
that are mapped to users before a given ordering or timestamp
identifier.
$sel:httpStatus:ListGroupsOlderThanOrderingIdResponse', listGroupsOlderThanOrderingIdResponse_httpStatus - The response's http status code.
Response Lenses
listGroupsOlderThanOrderingIdResponse_groupsSummaries :: Lens' ListGroupsOlderThanOrderingIdResponse (Maybe [GroupSummary]) Source #
Summary information for list of groups that are mapped to users before a given ordering or timestamp identifier.
listGroupsOlderThanOrderingIdResponse_nextToken :: Lens' ListGroupsOlderThanOrderingIdResponse (Maybe Text) Source #
If the response is truncated, Amazon Kendra returns this token that you can use in the subsequent request to retrieve the next set of groups that are mapped to users before a given ordering or timestamp identifier.
listGroupsOlderThanOrderingIdResponse_httpStatus :: Lens' ListGroupsOlderThanOrderingIdResponse Int Source #
The response's http status code.