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 |
Returns information about provisioned Elastic DocumentDB clusters.
This operation returns paginated results.
Synopsis
- data ListClusters = ListClusters' {}
- newListClusters :: ListClusters
- listClusters_maxResults :: Lens' ListClusters (Maybe Natural)
- listClusters_nextToken :: Lens' ListClusters (Maybe Text)
- data ListClustersResponse = ListClustersResponse' {
- clusters :: Maybe [ClusterInList]
- nextToken :: Maybe Text
- httpStatus :: Int
- newListClustersResponse :: Int -> ListClustersResponse
- listClustersResponse_clusters :: Lens' ListClustersResponse (Maybe [ClusterInList])
- listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text)
- listClustersResponse_httpStatus :: Lens' ListClustersResponse Int
Creating a Request
data ListClusters Source #
See: newListClusters
smart constructor.
Instances
newListClusters :: ListClusters Source #
Create a value of ListClusters
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:maxResults:ListClusters'
, listClusters_maxResults
- The maximum number of entries to recieve in the response.
ListClusters
, listClusters_nextToken
- The nextToken which is used the get the next page of data.
Request Lenses
listClusters_maxResults :: Lens' ListClusters (Maybe Natural) Source #
The maximum number of entries to recieve in the response.
listClusters_nextToken :: Lens' ListClusters (Maybe Text) Source #
The nextToken which is used the get the next page of data.
Destructuring the Response
data ListClustersResponse Source #
See: newListClustersResponse
smart constructor.
ListClustersResponse' | |
|
Instances
newListClustersResponse Source #
Create a value of ListClustersResponse
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:clusters:ListClustersResponse'
, listClustersResponse_clusters
- A list of Elastic DocumentDB cluster.
ListClusters
, listClustersResponse_nextToken
- The response will provide a nextToken if there is more data beyond the
maxResults.
If there is no more data in the responce, the nextToken will not be returned.
$sel:httpStatus:ListClustersResponse'
, listClustersResponse_httpStatus
- The response's http status code.
Response Lenses
listClustersResponse_clusters :: Lens' ListClustersResponse (Maybe [ClusterInList]) Source #
A list of Elastic DocumentDB cluster.
listClustersResponse_nextToken :: Lens' ListClustersResponse (Maybe Text) Source #
The response will provide a nextToken if there is more data beyond the maxResults.
If there is no more data in the responce, the nextToken will not be returned.
listClustersResponse_httpStatus :: Lens' ListClustersResponse Int Source #
The response's http status code.