Returns information about Amazon EBS snapshots available to the user.
Declaration Syntax
C# |
DescribeSnapshotsResponse DescribeSnapshots( DescribeSnapshotsRequest request )
Parameters
- request (DescribeSnapshotsRequest)
- Describe Snapshots request
Return Value
Describe Snapshots Response from the service
Remarks
Information returned includes volume ID, status, start time, progress,
owner ID, volume size, and description. Snapshots available to the user
include public snapshots available for any user to launch, private
snapshots owned by the user making the request, and private snapshots
owned by other users for which the user granted explicit create
volume permissions.
The create volume permissions fall into 3 categories:
public
The owner of the snapshot granted create volume permissions for the
snapshot to the all group. All users have create volume permissions
for these snapshots.
explicit
The owner of the snapshot granted create volume permissions to a
specific user.
implicit
A user has implicit create volume permissions for all snapshots he
or she owns.
The list of snapshots returned can be modified by specifying
snapshot IDs, snapshot owners, or users with create volume permissions.
If no options are specified, Amazon EC2 returns all snapshots for
which the user has 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,
a fault is returned. If you specify a snapshot ID for which you do not
have access, it will not be 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 users that
have create snapshot permissions for the snapshots are returned.
You can specify AWS Account IDs (if you own the snapshot(s)), self for
snapshots for which you own or have explicit permissions, or all for
public snapshots.
Exceptions
Exception | Condition |
---|---|
WebException | |
AmazonEC2Exception |