Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Contact Us
Online Help
Domain Status
Man Pages

Virtual Servers

Topology Map

Server Agreement
Year 2038

USA Flag



Man Pages

Manual Reference Pages  -  PAWS::EC2::DESCRIBESNAPSHOTS (3)

.ds Aq ’


Paws::EC2::DescribeSnapshots - Arguments for method DescribeSnapshots on Paws::EC2



This class represents the parameters used for calling the method DescribeSnapshots on the Amazon Elastic Compute Cloud service. Use the attributes of this class as arguments to method DescribeSnapshots.

You shouln’t make instances of this class. Each attribute should be used as a named argument in the call to DescribeSnapshots.

As an example:

  $service_obj->DescribeSnapshots(Att1 => $value1, Att2 => $value2, ...);

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object.


    DryRun => Bool

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.

    Filters => ArrayRef[Paws::EC2::Filter]

One or more filters.
o description - A description of the snapshot.
o owner-alias - The AWS account alias (for example, amazon) that owns the snapshot.
o owner-id - The ID of the AWS account that owns the snapshot.
o progress - The progress of the snapshot, as a percentage (for example, 80%).
o snapshot-id - The snapshot ID.
o start-time - The time stamp when the snapshot was initiated.
o status - The status of the snapshot (pending | completed | error).
o tag:key=value - The key/value combination of a tag assigned to the resource.
o 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.
o tag-value - The value of a tag assigned to the resource. This filter is independent of the tag-key filter.
o volume-id - The ID of the volume the snapshot is for.
o volume-size - The size of the volume, in GiB.

    MaxResults => Int

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.

    NextToken => Str

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.

    OwnerIds => ArrayRef[Str]

Returns the snapshots owned by the specified owner. Multiple owners can be specified.

    RestorableByUserIds => ArrayRef[Str]

One or more AWS accounts IDs that can create volumes from the snapshot.

    SnapshotIds => ArrayRef[Str]

One or more snapshot IDs.

Default: Describes snapshots for which you have launch permissions.


This class forms part of Paws, documenting arguments for method DescribeSnapshots in Paws::EC2


The source code is located here:

Please report bugs to:

Search for    or go to Top of page |  Section 3 |  Main Index

perl v5.20.3 PAWS::EC2::DESCRIBESNAPSHOTS (3) 2015-08-06

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.