Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Describes one or more of the EBS snapshots available to you. Available snapshots include public snapshots available for any AWS account to launch, private snapshots that you own, and private snapshots owned by another AWS account but for which you've been given explicit create volume permissions.
The create volume permissions fall into the following categories:
- public: The owner of the snapshot granted create volume
permissions for the snapshot to the
all
group. All AWS accounts have create volume permissions for these snapshots. - explicit: The owner of the snapshot granted create volume permissions to a specific AWS account.
- implicit: An AWS account has implicit create volume permissions for all snapshots it owns.
The list of snapshots returned can be modified by specifying snapshot IDs, snapshot owners, or AWS accounts with create volume permissions. If no options are specified, Amazon EC2 returns all snapshots for which you have create volume permissions.
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. If you specify an invalid snapshot ID, an error is returned. If you specify a snapshot ID for which you do not have access, it is not included in the returned results.
If you specify one or more snapshot owners, only snapshots from the
specified owners and for which you have access are returned. The results
can include the AWS account IDs of the specified owners, amazon
for
snapshots owned by Amazon, or self
for snapshots that you own.
If you specify a list of restorable users, only snapshots with create
snapshot permissions for those users are returned. You can specify AWS
account IDs (if you own the snapshots), self
for snapshots for which
you own or have explicit permissions, or all
for public snapshots.
If you are describing a long list of snapshots, you can paginate the
output to make the list more manageable. The MaxResults
parameter sets
the maximum number of results returned in a single page. If the list of
results exceeds your MaxResults
value, then that number of results is
returned along with a NextToken
value that can be passed to a
subsequent DescribeSnapshots
request to retrieve the remaining
results.
For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.
See: AWS API Reference for DescribeSnapshots.
This operation returns paginated results.
- describeSnapshots :: DescribeSnapshots
- data DescribeSnapshots
- dssOwnerIds :: Lens' DescribeSnapshots [Text]
- dssFilters :: Lens' DescribeSnapshots [Filter]
- dssNextToken :: Lens' DescribeSnapshots (Maybe Text)
- dssSnapshotIds :: Lens' DescribeSnapshots [Text]
- dssRestorableByUserIds :: Lens' DescribeSnapshots [Text]
- dssDryRun :: Lens' DescribeSnapshots (Maybe Bool)
- dssMaxResults :: Lens' DescribeSnapshots (Maybe Int)
- describeSnapshotsResponse :: Int -> DescribeSnapshotsResponse
- data DescribeSnapshotsResponse
- dssrsNextToken :: Lens' DescribeSnapshotsResponse (Maybe Text)
- dssrsSnapshots :: Lens' DescribeSnapshotsResponse [Snapshot]
- dssrsStatus :: Lens' DescribeSnapshotsResponse Int
Creating a Request
describeSnapshots :: DescribeSnapshots Source
Creates a value of DescribeSnapshots
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeSnapshots Source
See: describeSnapshots
smart constructor.
Request Lenses
dssOwnerIds :: Lens' DescribeSnapshots [Text] Source
Returns the snapshots owned by the specified owner. Multiple owners can be specified.
dssFilters :: Lens' DescribeSnapshots [Filter] Source
One or more filters.
description
- A description of the snapshot.- 'owner-alias' - The AWS account alias (for example,
amazon
) that owns the snapshot. - 'owner-id' - The ID of the AWS account that owns the snapshot.
progress
- The progress of the snapshot, as a percentage (for example, 80%).- 'snapshot-id' - The snapshot ID.
- 'start-time' - The time stamp when the snapshot was initiated.
status
- The status of the snapshot (pending
|completed
|error
).tag
:key=value - The key/value combination of a tag assigned to the resource.- 'tag-key' - The key of a tag assigned to the resource. This filter
is independent of the 'tag-value' filter. For example, if you use
both the filter "tag-key=Purpose" and the filter "tag-value=X",
you get any resources assigned both the tag key Purpose (regardless
of what the tag's value is), and the tag value X (regardless of
what the tag's key is). If you want to list only resources where
Purpose is X, see the
tag
:key=value filter. - 'tag-value' - The value of a tag assigned to the resource. This filter is independent of the 'tag-key' filter.
- 'volume-id' - The ID of the volume the snapshot is for.
- 'volume-size' - The size of the volume, in GiB.
dssNextToken :: Lens' DescribeSnapshots (Maybe Text) Source
The NextToken
value returned from a previous paginated
DescribeSnapshots
request where MaxResults
was used and the results
exceeded the value of that parameter. Pagination continues from the end
of the previous results that returned the NextToken
value. This value
is null
when there are no more results to return.
dssSnapshotIds :: Lens' DescribeSnapshots [Text] Source
One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
dssRestorableByUserIds :: Lens' DescribeSnapshots [Text] Source
One or more AWS accounts IDs that can create volumes from the snapshot.
dssDryRun :: Lens' DescribeSnapshots (Maybe Bool) Source
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation
.
Otherwise, it is UnauthorizedOperation
.
dssMaxResults :: Lens' DescribeSnapshots (Maybe Int) Source
The maximum number of snapshot results returned by DescribeSnapshots
in paginated output. When this parameter is used, DescribeSnapshots
only returns MaxResults
results in a single page along with a
NextToken
response element. The remaining results of the initial
request can be seen by sending another DescribeSnapshots
request with
the returned NextToken
value. This value can be between 5 and 1000; if
MaxResults
is given a value larger than 1000, only 1000 results are
returned. If this parameter is not used, then DescribeSnapshots
returns all results. You cannot specify this parameter and the snapshot
IDs parameter in the same request.
Destructuring the Response
describeSnapshotsResponse Source
Creates a value of DescribeSnapshotsResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeSnapshotsResponse Source
See: describeSnapshotsResponse
smart constructor.
Response Lenses
dssrsNextToken :: Lens' DescribeSnapshotsResponse (Maybe Text) Source
The NextToken
value to include in a future DescribeSnapshots
request. When the results of a DescribeSnapshots
request exceed
MaxResults
, this value can be used to retrieve the next page of
results. This value is null
when there are no more results to return.
dssrsSnapshots :: Lens' DescribeSnapshotsResponse [Snapshot] Source
Information about the snapshots.
dssrsStatus :: Lens' DescribeSnapshotsResponse Int Source
The response status code.