Returns information about Amazon EBS snapshots
available to the user.
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.
Namespace: Amazon.EC2.ModelAssembly: AWSSDK (in AWSSDK.dll) Version: 1.4.10.0 (1.4.10.0)
Syntax
| C# | Visual Basic | Visual C++ |
public class DescribeSnapshotsRequest
Public Class DescribeSnapshotsRequest
public ref class DescribeSnapshotsRequest
Members
| All Members | Constructors | Properties | Methods |
| Member | Description | |
|---|---|---|
| DescribeSnapshotsRequest()()()() | Initializes a new instance of the DescribeSnapshotsRequest class | |
| Equals(Object) | (Inherited from Object.) | |
| Filter |
Gets and sets the Filter property.
A list of filters used to match system-defined properties and user-defined tags associated with
the specified Snapshots.
For a complete reference to the available filter keys for this operation, see the
Amazon EC2 API reference.
| |
| GetHashCode()()()() |
Serves as a hash function for a particular type.
(Inherited from Object.) | |
| GetType()()()() |
Gets the Type of the current instance.
(Inherited from Object.) | |
| IsSetFilter()()()() |
Checks if Filter property is set
| |
| IsSetOwner()()()() |
Checks if Owner property is set
| |
| IsSetRestorableBy()()()() |
Checks if RestorableBy property is set
| |
| IsSetSnapshotId()()()() |
Checks if SnapshotId property is set
| |
| Owner |
Gets and sets the Owner property.
Returns snapshots owned by the specified
owner. Valid Values: self |
amazon | AWS
Account ID
| |
| RestorableBy |
Gets and sets the RestorableBy property.
Account ID of a user that can create volumes
from the snapshot.
| |
| SnapshotId |
Gets and sets the SnapshotId property.
The ID of the Amazon EBS snapshot.
| |
| ToString()()()() | (Inherited from Object.) | |
| WithFilter(array<Filter>[]()[][]) |
Sets the Filter property
| |
| WithOwner(String) |
Sets the Owner property
| |
| WithRestorableBy(String) |
Sets the RestorableBy property
| |
| WithSnapshotId(array<String>[]()[][]) |
Sets the SnapshotId property
|