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 all OpenSearch Serverless collections. For more information, see Creating and managing Amazon OpenSearch Serverless collections.
Make sure to include an empty request body {} if you don't include any collection filters in the request.
Synopsis
- data ListCollections = ListCollections' {}
- newListCollections :: ListCollections
- listCollections_collectionFilters :: Lens' ListCollections (Maybe CollectionFilters)
- listCollections_maxResults :: Lens' ListCollections (Maybe Natural)
- listCollections_nextToken :: Lens' ListCollections (Maybe Text)
- data ListCollectionsResponse = ListCollectionsResponse' {}
- newListCollectionsResponse :: Int -> ListCollectionsResponse
- listCollectionsResponse_collectionSummaries :: Lens' ListCollectionsResponse (Maybe [CollectionSummary])
- listCollectionsResponse_nextToken :: Lens' ListCollectionsResponse (Maybe Text)
- listCollectionsResponse_httpStatus :: Lens' ListCollectionsResponse Int
Creating a Request
data ListCollections Source #
See: newListCollections
smart constructor.
ListCollections' | |
|
Instances
newListCollections :: ListCollections Source #
Create a value of ListCollections
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:collectionFilters:ListCollections'
, listCollections_collectionFilters
- List of filter names and values that you can use for requests.
$sel:maxResults:ListCollections'
, listCollections_maxResults
- The maximum number of results to return. Default is 20. You can use
nextToken
to get the next page of results.
ListCollections
, listCollections_nextToken
- If your initial ListCollections
operation returns a nextToken
, you
can include the returned nextToken
in subsequent ListCollections
operations, which returns results in the next page.
Request Lenses
listCollections_collectionFilters :: Lens' ListCollections (Maybe CollectionFilters) Source #
List of filter names and values that you can use for requests.
listCollections_maxResults :: Lens' ListCollections (Maybe Natural) Source #
The maximum number of results to return. Default is 20. You can use
nextToken
to get the next page of results.
listCollections_nextToken :: Lens' ListCollections (Maybe Text) Source #
If your initial ListCollections
operation returns a nextToken
, you
can include the returned nextToken
in subsequent ListCollections
operations, which returns results in the next page.
Destructuring the Response
data ListCollectionsResponse Source #
See: newListCollectionsResponse
smart constructor.
ListCollectionsResponse' | |
|
Instances
newListCollectionsResponse Source #
Create a value of ListCollectionsResponse
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:collectionSummaries:ListCollectionsResponse'
, listCollectionsResponse_collectionSummaries
- Details about each collection.
ListCollections
, listCollectionsResponse_nextToken
- When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
$sel:httpStatus:ListCollectionsResponse'
, listCollectionsResponse_httpStatus
- The response's http status code.
Response Lenses
listCollectionsResponse_collectionSummaries :: Lens' ListCollectionsResponse (Maybe [CollectionSummary]) Source #
Details about each collection.
listCollectionsResponse_nextToken :: Lens' ListCollectionsResponse (Maybe Text) Source #
When nextToken
is returned, there are more results available. The
value of nextToken
is a unique pagination token for each page. Make
the call again using the returned token to retrieve the next page.
listCollectionsResponse_httpStatus :: Lens' ListCollectionsResponse Int Source #
The response's http status code.