« blib/lib/Paws/Backup/ListRecoveryPointsByResourceOutput.pm
↑ Summary
blib/lib/Paws/Backup/ListRestoreJobsOutput.pm »
| 1 | |||
| 2 | package Paws::Backup::ListRestoreJobs; | ||
| 3 | use Moose; | ||
| 4 | has ByAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'accountId'); | ||
| 5 | has ByCreatedAfter => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'createdAfter'); | ||
| 6 | has ByCreatedBefore => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'createdBefore'); | ||
| 7 | has ByStatus => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'status'); | ||
| 8 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 9 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 10 | |||
| 11 | use MooseX::ClassAttribute; | ||
| 12 | |||
| 13 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListRestoreJobs'); | ||
| 14 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/restore-jobs/'); | ||
| 15 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Backup::ListRestoreJobsOutput'); | ||
| 17 | 1; | ||
| 18 | |||
| 19 | ### main pod documentation begin ### | ||
| 20 | |||
| 21 | =head1 NAME | ||
| 22 | |||
| 23 | Paws::Backup::ListRestoreJobs - Arguments for method ListRestoreJobs on L<Paws::Backup> | ||
| 24 | |||
| 25 | =head1 DESCRIPTION | ||
| 26 | |||
| 27 | This class represents the parameters used for calling the method ListRestoreJobs on the | ||
| 28 | L<AWS Backup|Paws::Backup> service. Use the attributes of this class | ||
| 29 | as arguments to method ListRestoreJobs. | ||
| 30 | |||
| 31 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListRestoreJobs. | ||
| 32 | |||
| 33 | =head1 SYNOPSIS | ||
| 34 | |||
| 35 | my $backup = Paws->service('Backup'); | ||
| 36 | my $ListRestoreJobsOutput = $backup->ListRestoreJobs( | ||
| 37 | ByAccountId => 'MyAccountId', # OPTIONAL | ||
| 38 | ByCreatedAfter => '1970-01-01T01:00:00', # OPTIONAL | ||
| 39 | ByCreatedBefore => '1970-01-01T01:00:00', # OPTIONAL | ||
| 40 | ByStatus => 'PENDING', # OPTIONAL | ||
| 41 | MaxResults => 1, # OPTIONAL | ||
| 42 | NextToken => 'Mystring', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $NextToken = $ListRestoreJobsOutput->NextToken; | ||
| 47 | my $RestoreJobs = $ListRestoreJobsOutput->RestoreJobs; | ||
| 48 | |||
| 49 | # Returns a L<Paws::Backup::ListRestoreJobsOutput> object. | ||
| 50 | |||
| 51 | 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. | ||
| 52 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/backup/ListRestoreJobs> | ||
| 53 | |||
| 54 | =head1 ATTRIBUTES | ||
| 55 | |||
| 56 | |||
| 57 | =head2 ByAccountId => Str | ||
| 58 | |||
| 59 | The account ID to list the jobs from. Returns only restore jobs | ||
| 60 | associated with the specified account ID. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 ByCreatedAfter => Str | ||
| 65 | |||
| 66 | Returns only restore jobs that were created after the specified date. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 ByCreatedBefore => Str | ||
| 71 | |||
| 72 | Returns only restore jobs that were created before the specified date. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 ByStatus => Str | ||
| 77 | |||
| 78 | Returns only restore jobs associated with the specified job status. | ||
| 79 | |||
| 80 | Valid values are: C<"PENDING">, C<"RUNNING">, C<"COMPLETED">, C<"ABORTED">, C<"FAILED"> | ||
| 81 | |||
| 82 | =head2 MaxResults => Int | ||
| 83 | |||
| 84 | The maximum number of items to be returned. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 NextToken => Str | ||
| 89 | |||
| 90 | The next item following a partial list of returned items. For example, | ||
| 91 | if a request is made to return C<maxResults> number of items, | ||
| 92 | C<NextToken> allows you to return more items in your list starting at | ||
| 93 | the location pointed to by the next token. | ||
| 94 | |||
| 95 | |||
| 96 | |||
| 97 | |||
| 98 | =head1 SEE ALSO | ||
| 99 | |||
| 100 | This class forms part of L<Paws>, documenting arguments for method ListRestoreJobs in L<Paws::Backup> | ||
| 101 | |||
| 102 | =head1 BUGS and CONTRIBUTIONS | ||
| 103 | |||
| 104 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 105 | |||
| 106 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 107 | |||
| 108 | =cut | ||
| 109 |