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:
allgroup. All AWS accounts have create volume permissions for these snapshots.
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
amazon for snapshots owned by Amazon, or
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
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
For more information about EBS snapshots, see Amazon EBS Snapshots in the Amazon Elastic Compute Cloud User Guide.
For information about the common parameters that all actions use, see Common Query Parameters.
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
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.
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
there are no more results to return.
Returns the snapshots owned by the specified owner. Multiple owners can be specified.
Type: String list
One or more AWS accounts IDs that can create volumes from the snapshot.
Type: String list
One or more snapshot IDs.
Default: Describes snapshots for which you have launch permissions.
Type: String list
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
Otherwise, it is
One or more filters.
description - A description of the snapshot.
owner-alias - The AWS account alias (for example,
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,
snapshot-id - The snapshot ID.
start-time - The time stamp when the snapshot was initiated.
status - The status of the snapshot (
tag:key=value - The key/value combination of a tag assigned to
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-value - The value of a tag assigned to the resource. This filter is
independent of the
volume-id - The ID of the volume the snapshot is for.
volume-size - The size of the volume, in GiB.
Type: Filter list
The following elements are returned.
NextToken value to include in a future
When the results of a
DescribeSnapshots request exceed
this value can be used to retrieve the next page of results. This value is
when there are no more results to return.
The ID of the request.
Information about the snapshots.
Type: Snapshot list
For information about the errors that are common to all actions, see Common Client Errors.
This example describes a snapshot with an ID of snap-1a2b3c4d.
https://ec2.amazonaws.com/?Action=DescribeSnapshots &SnapshotId=snap-1a2b3c4d &AUTHPARAMS
<DescribeSnapshotsResponse xmlns="http://ec2.amazonaws.com/doc/2015-04-15/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <snapshotSet> <item> <snapshotId>snap-1a2b3c4d</snapshotId> <volumeId>vol-1a2b3c4d</volumeId> <status>pending</status> <startTime>YYYY-MM-DDTHH:MM:SS.SSSZ</startTime> <progress>80%</progress> <ownerId>111122223333</ownerId> <volumeSize>15</volumeSize> <description>Daily Backup</description> <encrypted>true</encrypted> <tagSet/> </item> </snapshotSet> </DescribeSnapshotsResponse>
This example filters the response to include only snapshots with the pending status, and that are also tagged with a value that includes the string db_.
https://ec2.amazonaws.com/?Action=DescribeSnapshots &Filter.1.Name=status &Filter.1.Value.1=pending &Filter.2.Name=tag-value &Filter.2.Value.1=*db_* &AUTHPARAMS
<DescribeSnapshotsResponse xmlns="http://ec2.amazonaws.com/doc/2015-04-15/"> <requestId>59dbff89-35bd-4eac-99ed-be587EXAMPLE</requestId> <snapshotSet> <item> <snapshotId>snap-1a2b3c4d</snapshotId> <volumeId>vol-1a2b3c4d</volumeId> <status>pending</status> <startTime>YYYY-MM-DDTHH:MM:SS.SSSZ</startTime> <progress>30%</progress> <ownerId>111122223333</ownerId> <volumeSize>15</volumeSize> <description>Daily Backup</description> <tagSet> <item> <key>Purpose</key> <value>demo_db_14_backup</value> </item> </tagSet> <encrypted>true</encrypted> </item> </snapshotSet> </DescribeSnapshotsResponse>