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.
http://docs.aws.amazon.com/AWSEC2/latest/APIReference/ApiReference-query-DescribeSnapshots.html
- data DescribeSnapshots
- describeSnapshots :: DescribeSnapshots
- ds1DryRun :: Lens' DescribeSnapshots (Maybe Bool)
- ds1Filters :: Lens' DescribeSnapshots [Filter]
- ds1MaxResults :: Lens' DescribeSnapshots (Maybe Int)
- ds1NextToken :: Lens' DescribeSnapshots (Maybe Text)
- ds1OwnerIds :: Lens' DescribeSnapshots [Text]
- ds1RestorableByUserIds :: Lens' DescribeSnapshots [Text]
- ds1SnapshotIds :: Lens' DescribeSnapshots [Text]
- data DescribeSnapshotsResponse
- describeSnapshotsResponse :: DescribeSnapshotsResponse
- dsrNextToken :: Lens' DescribeSnapshotsResponse (Maybe Text)
- dsrSnapshots :: Lens' DescribeSnapshotsResponse [Snapshot]
Request
data DescribeSnapshots Source
Request constructor
describeSnapshots :: DescribeSnapshots Source
DescribeSnapshots
constructor.
The fields accessible through corresponding lenses are:
ds1DryRun
::
Maybe
Bool
ds1Filters
::
[Filter
]ds1MaxResults
::
Maybe
Int
ds1NextToken
::
Maybe
Text
ds1OwnerIds
::
[Text
]ds1RestorableByUserIds
::
[Text
]ds1SnapshotIds
::
[Text
]
Request lenses
ds1DryRun :: 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
.
ds1Filters :: 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.
ds1MaxResults :: 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.
ds1NextToken :: 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.
ds1OwnerIds :: Lens' DescribeSnapshots [Text] Source
Returns the snapshots owned by the specified owner. Multiple owners can be specified.
ds1RestorableByUserIds :: Lens' DescribeSnapshots [Text] Source
One or more AWS accounts IDs that can create volumes from the snapshot.
ds1SnapshotIds :: Lens' DescribeSnapshots [Text] Source
One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
Response
Response constructor
describeSnapshotsResponse :: DescribeSnapshotsResponse Source
DescribeSnapshotsResponse
constructor.
The fields accessible through corresponding lenses are:
dsrNextToken
::
Maybe
Text
dsrSnapshots
::
[Snapshot
]
Response lenses
dsrNextToken :: 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.
dsrSnapshots :: Lens' DescribeSnapshotsResponse [Snapshot] Source
Information about the snapshots.