« blib/lib/Paws/FSX/DeleteFileSystemWindowsResponse.pm
↑ Summary
blib/lib/Paws/FSX/DescribeBackupsResponse.pm »
| 1 | |||
| 2 | package Paws::FSX::DescribeBackups; | ||
| 3 | use Moose; | ||
| 4 | has BackupIds => (is => 'ro', isa => 'ArrayRef[Str|Undef]'); | ||
| 5 | has Filters => (is => 'ro', isa => 'ArrayRef[Paws::FSX::Filter]'); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int'); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str'); | ||
| 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::FSX::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::FSX::DescribeBackups - Arguments for method DescribeBackups on L<Paws::FSX> | ||
| 21 | |||
| 22 | =head1 DESCRIPTION | ||
| 23 | |||
| 24 | This class represents the parameters used for calling the method DescribeBackups on the | ||
| 25 | L<Amazon FSx|Paws::FSX> 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 $fsx = Paws->service('FSX'); | ||
| 33 | my $DescribeBackupsResponse = $fsx->DescribeBackups( | ||
| 34 | BackupIds => [ | ||
| 35 | 'MyBackupId', ... # min: 12, max: 128 | ||
| 36 | ], # OPTIONAL | ||
| 37 | Filters => [ | ||
| 38 | { | ||
| 39 | Name => 'file-system-id' | ||
| 40 | , # values: file-system-id, backup-type, file-system-type; OPTIONAL | ||
| 41 | Values => [ | ||
| 42 | 'MyFilterValue', ... # min: 1, max: 128 | ||
| 43 | ], # max: 20; OPTIONAL | ||
| 44 | }, | ||
| 45 | ... | ||
| 46 | ], # OPTIONAL | ||
| 47 | MaxResults => 1, # OPTIONAL | ||
| 48 | NextToken => 'MyNextToken', # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $Backups = $DescribeBackupsResponse->Backups; | ||
| 53 | my $NextToken = $DescribeBackupsResponse->NextToken; | ||
| 54 | |||
| 55 | # Returns a L<Paws::FSX::DescribeBackupsResponse> object. | ||
| 56 | |||
| 57 | 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. | ||
| 58 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/fsx/DescribeBackups> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 BackupIds => ArrayRef[Str|Undef] | ||
| 64 | |||
| 65 | IDs of the backups you want to retrieve (String). This overrides any | ||
| 66 | filters. If any IDs are not found, BackupNotFound will be thrown. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 Filters => ArrayRef[L<Paws::FSX::Filter>] | ||
| 71 | |||
| 72 | Filters structure. Supported names are file-system-id and backup-type. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 MaxResults => Int | ||
| 77 | |||
| 78 | Maximum number of backups to return in the response (integer). This | ||
| 79 | parameter value must be greater than 0. The number of items that Amazon | ||
| 80 | FSx returns is the minimum of the C<MaxResults> parameter specified in | ||
| 81 | the request and the service's internal maximum number of items per | ||
| 82 | page. | ||
| 83 | |||
| 84 | |||
| 85 | |||
| 86 | =head2 NextToken => Str | ||
| 87 | |||
| 88 | Opaque pagination token returned from a previous C<DescribeBackups> | ||
| 89 | operation (String). If a token present, the action continues the list | ||
| 90 | from where the returning call left off. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | |||
| 95 | =head1 SEE ALSO | ||
| 96 | |||
| 97 | This class forms part of L<Paws>, documenting arguments for method DescribeBackups in L<Paws::FSX> | ||
| 98 | |||
| 99 | =head1 BUGS and CONTRIBUTIONS | ||
| 100 | |||
| 101 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 102 | |||
| 103 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 104 | |||
| 105 | =cut | ||
| 106 |