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 the description of specific Amazon FSx for OpenZFS snapshots, if
a SnapshotIds
value is provided. Otherwise, this operation returns all
snapshots owned by your Amazon Web Services account in the Amazon Web
Services Region of the endpoint that you're calling.
When retrieving all snapshots, you can optionally specify the
MaxResults
parameter to limit the number of snapshots in a response.
If more backups remain, Amazon FSx returns a NextToken
value in the
response. In this case, send a later request with the NextToken
request parameter set to the value of NextToken
from the last
response.
Use this operation in an iterative process to retrieve a list of your
snapshots. DescribeSnapshots
is called first without a NextToken
value. Then the operation continues to be called with the NextToken
parameter set to the value of the last NextToken
value until a
response has no NextToken
value.
When using this operation, keep the following in mind:
- The operation might return fewer than the
MaxResults
value of snapshot descriptions while still including aNextToken
value. - The order of snapshots returned in the response of one
DescribeSnapshots
call and the order of backups returned across the responses of a multi-call iteration is unspecified.
Synopsis
- data DescribeSnapshots = DescribeSnapshots' {
- filters :: Maybe [SnapshotFilter]
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- snapshotIds :: Maybe [Text]
- newDescribeSnapshots :: DescribeSnapshots
- describeSnapshots_filters :: Lens' DescribeSnapshots (Maybe [SnapshotFilter])
- describeSnapshots_maxResults :: Lens' DescribeSnapshots (Maybe Natural)
- describeSnapshots_nextToken :: Lens' DescribeSnapshots (Maybe Text)
- describeSnapshots_snapshotIds :: Lens' DescribeSnapshots (Maybe [Text])
- data DescribeSnapshotsResponse = DescribeSnapshotsResponse' {}
- newDescribeSnapshotsResponse :: Int -> DescribeSnapshotsResponse
- describeSnapshotsResponse_nextToken :: Lens' DescribeSnapshotsResponse (Maybe Text)
- describeSnapshotsResponse_snapshots :: Lens' DescribeSnapshotsResponse (Maybe [Snapshot])
- describeSnapshotsResponse_httpStatus :: Lens' DescribeSnapshotsResponse Int
Creating a Request
data DescribeSnapshots Source #
See: newDescribeSnapshots
smart constructor.
DescribeSnapshots' | |
|
Instances
newDescribeSnapshots :: DescribeSnapshots Source #
Create a value of DescribeSnapshots
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:filters:DescribeSnapshots'
, describeSnapshots_filters
- The filters structure. The supported names are file-system-id
or
volume-id
.
$sel:maxResults:DescribeSnapshots'
, describeSnapshots_maxResults
- Undocumented member.
DescribeSnapshots
, describeSnapshots_nextToken
- Undocumented member.
$sel:snapshotIds:DescribeSnapshots'
, describeSnapshots_snapshotIds
- The IDs of the snapshots that you want to retrieve. This parameter value
overrides any filters. If any IDs aren't found, a SnapshotNotFound
error occurs.
Request Lenses
describeSnapshots_filters :: Lens' DescribeSnapshots (Maybe [SnapshotFilter]) Source #
The filters structure. The supported names are file-system-id
or
volume-id
.
describeSnapshots_maxResults :: Lens' DescribeSnapshots (Maybe Natural) Source #
Undocumented member.
describeSnapshots_nextToken :: Lens' DescribeSnapshots (Maybe Text) Source #
Undocumented member.
describeSnapshots_snapshotIds :: Lens' DescribeSnapshots (Maybe [Text]) Source #
The IDs of the snapshots that you want to retrieve. This parameter value
overrides any filters. If any IDs aren't found, a SnapshotNotFound
error occurs.
Destructuring the Response
data DescribeSnapshotsResponse Source #
See: newDescribeSnapshotsResponse
smart constructor.
Instances
newDescribeSnapshotsResponse Source #
Create a value of DescribeSnapshotsResponse
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:
DescribeSnapshots
, describeSnapshotsResponse_nextToken
- Undocumented member.
$sel:snapshots:DescribeSnapshotsResponse'
, describeSnapshotsResponse_snapshots
- An array of snapshots.
$sel:httpStatus:DescribeSnapshotsResponse'
, describeSnapshotsResponse_httpStatus
- The response's http status code.
Response Lenses
describeSnapshotsResponse_nextToken :: Lens' DescribeSnapshotsResponse (Maybe Text) Source #
Undocumented member.
describeSnapshotsResponse_snapshots :: Lens' DescribeSnapshotsResponse (Maybe [Snapshot]) Source #
An array of snapshots.
describeSnapshotsResponse_httpStatus :: Lens' DescribeSnapshotsResponse Int Source #
The response's http status code.