« blib/lib/Paws/CloudHSMv2/DeleteHsmResponse.pm
↑ Summary
blib/lib/Paws/CloudHSMv2/DescribeBackupsResponse.pm »
| 1 | |||
| 2 | package Paws::CloudHSMv2::DescribeBackups; | ||
| 3 | use Moose; | ||
| 4 | has Filters => (is => 'ro', isa => 'Paws::CloudHSMv2::Filters'); | ||
| 5 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 6 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 7 | has SortAscending => (is => 'ro', isa => 'Bool'); | ||
| 8 | |||
| 9 | use MooseX::ClassAttribute; | ||
| 10 | |||
| 11 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeBackups'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::CloudHSMv2::DescribeBackupsResponse'); | ||
| 13 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 14 | 1; | ||
| 15 | |||
| 16 | ### main pod documentation begin ### | ||
| 17 | |||
| 18 | =head1 NAME | ||
| 19 | |||
| 20 | Paws::CloudHSMv2::DescribeBackups - Arguments for method DescribeBackups on L<Paws::CloudHSMv2> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeBackups on the | ||
| 25 | L<AWS CloudHSM V2|Paws::CloudHSMv2> service. Use the attributes of this class | ||
| 26 | as arguments to method DescribeBackups. | ||
| 27 | |||
| 28 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeBackups. | ||
| 29 | |||
| 30 | =head1 SYNOPSIS | ||
| 31 | |||
| 32 | my $cloudhsmv2 = Paws->service('CloudHSMv2'); | ||
| 33 | my $DescribeBackupsResponse = $cloudhsmv2->DescribeBackups( | ||
| 34 | Filters => { 'MyField' => [ 'MyString', ... ], }, # OPTIONAL | ||
| 35 | MaxResults => 1, # OPTIONAL | ||
| 36 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 37 | SortAscending => 1, # OPTIONAL | ||
| 38 | ); | ||
| 39 | |||
| 40 | # Results: | ||
| 41 | my $Backups = $DescribeBackupsResponse->Backups; | ||
| 42 | my $NextToken = $DescribeBackupsResponse->NextToken; | ||
| 43 | |||
| 44 | # Returns a L<Paws::CloudHSMv2::DescribeBackupsResponse> object. | ||
| 45 | |||
| 46 | 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. | ||
| 47 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/cloudhsmv2/DescribeBackups> | ||
| 48 | |||
| 49 | =head1 ATTRIBUTES | ||
| 50 | |||
| 51 | |||
| 52 | =head2 Filters => L<Paws::CloudHSMv2::Filters> | ||
| 53 | |||
| 54 | One or more filters to limit the items returned in the response. | ||
| 55 | |||
| 56 | Use the C<backupIds> filter to return only the specified backups. | ||
| 57 | Specify backups by their backup identifier (ID). | ||
| 58 | |||
| 59 | Use the C<sourceBackupIds> filter to return only the backups created | ||
| 60 | from a source backup. The C<sourceBackupID> of a source backup is | ||
| 61 | returned by the CopyBackupToRegion operation. | ||
| 62 | |||
| 63 | Use the C<clusterIds> filter to return only the backups for the | ||
| 64 | specified clusters. Specify clusters by their cluster identifier (ID). | ||
| 65 | |||
| 66 | Use the C<states> filter to return only backups that match the | ||
| 67 | specified state. | ||
| 68 | |||
| 69 | Use the C<neverExpires> filter to return backups filtered by the value | ||
| 70 | in the C<neverExpires> parameter. C<True> returns all backups exempt | ||
| 71 | from the backup retention policy. C<False> returns all backups with a | ||
| 72 | backup retention policy defined at the cluster. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 MaxResults => Int | ||
| 77 | |||
| 78 | The maximum number of backups to return in the response. When there are | ||
| 79 | more backups than the number you specify, the response contains a | ||
| 80 | C<NextToken> value. | ||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head2 NextToken => Str | ||
| 85 | |||
| 86 | The C<NextToken> value that you received in the previous response. Use | ||
| 87 | this value to get more backups. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 SortAscending => Bool | ||
| 92 | |||
| 93 | Designates whether or not to sort the return backups by ascending | ||
| 94 | chronological order of generation. | ||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | |||
| 99 | =head1 SEE ALSO | ||
| 100 | |||
| 101 | This class forms part of L<Paws>, documenting arguments for method DescribeBackups in L<Paws::CloudHSMv2> | ||
| 102 | |||
| 103 | =head1 BUGS and CONTRIBUTIONS | ||
| 104 | |||
| 105 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 106 | |||
| 107 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 108 | |||
| 109 | =cut | ||
| 110 |