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 Elastic DocumentDB snapshots for a specified cluster.
This operation returns paginated results.
Synopsis
- data ListClusterSnapshots = ListClusterSnapshots' {
- clusterArn :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- newListClusterSnapshots :: ListClusterSnapshots
- listClusterSnapshots_clusterArn :: Lens' ListClusterSnapshots (Maybe Text)
- listClusterSnapshots_maxResults :: Lens' ListClusterSnapshots (Maybe Natural)
- listClusterSnapshots_nextToken :: Lens' ListClusterSnapshots (Maybe Text)
- data ListClusterSnapshotsResponse = ListClusterSnapshotsResponse' {}
- newListClusterSnapshotsResponse :: Int -> ListClusterSnapshotsResponse
- listClusterSnapshotsResponse_nextToken :: Lens' ListClusterSnapshotsResponse (Maybe Text)
- listClusterSnapshotsResponse_snapshots :: Lens' ListClusterSnapshotsResponse (Maybe [ClusterSnapshotInList])
- listClusterSnapshotsResponse_httpStatus :: Lens' ListClusterSnapshotsResponse Int
Creating a Request
data ListClusterSnapshots Source #
See: newListClusterSnapshots
smart constructor.
ListClusterSnapshots' | |
|
Instances
newListClusterSnapshots :: ListClusterSnapshots Source #
Create a value of ListClusterSnapshots
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:
ListClusterSnapshots
, listClusterSnapshots_clusterArn
- The arn of the Elastic DocumentDB cluster.
$sel:maxResults:ListClusterSnapshots'
, listClusterSnapshots_maxResults
- The maximum number of entries to recieve in the response.
ListClusterSnapshots
, listClusterSnapshots_nextToken
- The nextToken which is used the get the next page of data.
Request Lenses
listClusterSnapshots_clusterArn :: Lens' ListClusterSnapshots (Maybe Text) Source #
The arn of the Elastic DocumentDB cluster.
listClusterSnapshots_maxResults :: Lens' ListClusterSnapshots (Maybe Natural) Source #
The maximum number of entries to recieve in the response.
listClusterSnapshots_nextToken :: Lens' ListClusterSnapshots (Maybe Text) Source #
The nextToken which is used the get the next page of data.
Destructuring the Response
data ListClusterSnapshotsResponse Source #
See: newListClusterSnapshotsResponse
smart constructor.
ListClusterSnapshotsResponse' | |
|
Instances
newListClusterSnapshotsResponse Source #
Create a value of ListClusterSnapshotsResponse
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:
ListClusterSnapshots
, listClusterSnapshotsResponse_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:snapshots:ListClusterSnapshotsResponse'
, listClusterSnapshotsResponse_snapshots
- A list of Elastic DocumentDB snapshots for a specified cluster.
$sel:httpStatus:ListClusterSnapshotsResponse'
, listClusterSnapshotsResponse_httpStatus
- The response's http status code.
Response Lenses
listClusterSnapshotsResponse_nextToken :: Lens' ListClusterSnapshotsResponse (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.
listClusterSnapshotsResponse_snapshots :: Lens' ListClusterSnapshotsResponse (Maybe [ClusterSnapshotInList]) Source #
A list of Elastic DocumentDB snapshots for a specified cluster.
listClusterSnapshotsResponse_httpStatus :: Lens' ListClusterSnapshotsResponse Int Source #
The response's http status code.