package Paws::EC2::DescribeSnapshots; use Moose; has DryRun => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'dryRun' ); has Filters => (is => 'ro', isa => 'ArrayRef[Paws::EC2::Filter]', traits => ['NameInRequest'], request_name => 'Filter' ); has MaxResults => (is => 'ro', isa => 'Int'); has NextToken => (is => 'ro', isa => 'Str'); has OwnerIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'Owner' ); has RestorableByUserIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'RestorableBy' ); has SnapshotIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]', traits => ['NameInRequest'], request_name => 'SnapshotId' ); use MooseX::ClassAttribute; class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeSnapshots'); class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::EC2::DescribeSnapshotsResult'); class_has _result_key => (isa => 'Str', is => 'ro'); 1; ### main pod documentation begin ### =head1 NAME Paws::EC2::DescribeSnapshots - Arguments for method DescribeSnapshots on L =head1 DESCRIPTION This class represents the parameters used for calling the method DescribeSnapshots on the L service. Use the attributes of this class as arguments to method DescribeSnapshots. You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeSnapshots. =head1 SYNOPSIS my $ec2 = Paws->service('EC2'); # To describe a snapshot # This example describes a snapshot with the snapshot ID of # ``snap-1234567890abcdef0``. my $DescribeSnapshotsResult = $ec2->DescribeSnapshots( 'SnapshotIds' => ['snap-1234567890abcdef0'] ); # Results: my $NextToken = $DescribeSnapshotsResult->NextToken; my $Snapshots = $DescribeSnapshotsResult->Snapshots; # Returns a L object. # To describe snapshots using filters # This example describes all snapshots owned by the ID 012345678910 that are in # the ``pending`` status. my $DescribeSnapshotsResult = $ec2->DescribeSnapshots( 'Filters' => [ { 'Name' => 'status', 'Values' => ['pending'] } ], 'OwnerIds' => [012345678910] ); # Results: my $NextToken = $DescribeSnapshotsResult->NextToken; my $Snapshots = $DescribeSnapshotsResult->Snapshots; # Returns a L object. 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. For the AWS API documentation, see L =head1 ATTRIBUTES =head2 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 C. Otherwise, it is C. =head2 Filters => ArrayRef[L] The filters. =over =item * C - A description of the snapshot. =item * C - Indicates whether the snapshot is encrypted (C | C) =item * C - The owner alias, from an Amazon-maintained list (C). This is not the user-configured AWS account alias set using the IAM console. We recommend that you use the related parameter instead of this filter. =item * C - The AWS account ID of the owner. We recommend that you use the related parameter instead of this filter. =item * C - The progress of the snapshot, as a percentage (for example, 80%). =item * C - The snapshot ID. =item * C - The time stamp when the snapshot was initiated. =item * C - The status of the snapshot (C | C | C). =item * C:EkeyE - The key/value combination of a tag assigned to the resource. Use the tag key in the filter name and the tag value as the filter value. For example, to find all resources that have a tag with the key C and the value C, specify C for the filter name and C for the filter value. =item * C - The key of a tag assigned to the resource. Use this filter to find all resources assigned a tag with a specific key, regardless of the tag value. =item * C - The ID of the volume the snapshot is for. =item * C - The size of the volume, in GiB. =back =head2 MaxResults => Int The maximum number of snapshot results returned by C in paginated output. When this parameter is used, C only returns C results in a single page along with a C response element. The remaining results of the initial request can be seen by sending another C request with the returned C value. This value can be between 5 and 1,000; if C is given a value larger than 1,000, only 1,000 results are returned. If this parameter is not used, then C returns all results. You cannot specify this parameter and the snapshot IDs parameter in the same request. =head2 NextToken => Str The C value returned from a previous paginated C request where C was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the C value. This value is C when there are no more results to return. =head2 OwnerIds => ArrayRef[Str|Undef] Scopes the results to snapshots with the specified owners. You can specify a combination of AWS account IDs, C, and C. =head2 RestorableByUserIds => ArrayRef[Str|Undef] The IDs of the AWS accounts that can create volumes from the snapshot. =head2 SnapshotIds => ArrayRef[Str|Undef] The snapshot IDs. Default: Describes the snapshots for which you have create volume permissions. =head1 SEE ALSO This class forms part of L, documenting arguments for method DescribeSnapshots in L =head1 BUGS and CONTRIBUTIONS The source code is located here: L Please report bugs to: L =cut