| 1 | |||
| 2 | package Paws::Backup::ListBackupJobs; | ||
| 3 | use Moose; | ||
| 4 | has ByAccountId => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'accountId'); | ||
| 5 | has ByBackupVaultName => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'backupVaultName'); | ||
| 6 | has ByCreatedAfter => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'createdAfter'); | ||
| 7 | has ByCreatedBefore => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'createdBefore'); | ||
| 8 | has ByResourceArn => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'resourceArn'); | ||
| 9 | has ByResourceType => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'resourceType'); | ||
| 10 | has ByState => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'state'); | ||
| 11 | has MaxResults => (is => 'ro', isa => 'Int', traits => ['ParamInQuery'], query_name => 'maxResults'); | ||
| 12 | has NextToken => (is => 'ro', isa => 'Str', traits => ['ParamInQuery'], query_name => 'nextToken'); | ||
| 13 | |||
| 14 | use MooseX::ClassAttribute; | ||
| 15 | |||
| 16 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListBackupJobs'); | ||
| 17 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/backup-jobs/'); | ||
| 18 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 19 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Backup::ListBackupJobsOutput'); | ||
| 20 | 1; | ||
| 21 | |||
| 22 | ### main pod documentation begin ### | ||
| 23 | |||
| 24 | =head1 NAME | ||
| 25 | |||
| 26 | Paws::Backup::ListBackupJobs - Arguments for method ListBackupJobs on L<Paws::Backup> | ||
| 27 | |||
| 28 | =head1 DESCRIPTION | ||
| 29 | |||
| 30 | This class represents the parameters used for calling the method ListBackupJobs on the | ||
| 31 | L<AWS Backup|Paws::Backup> service. Use the attributes of this class | ||
| 32 | as arguments to method ListBackupJobs. | ||
| 33 | |||
| 34 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListBackupJobs. | ||
| 35 | |||
| 36 | =head1 SYNOPSIS | ||
| 37 | |||
| 38 | my $backup = Paws->service('Backup'); | ||
| 39 | my $ListBackupJobsOutput = $backup->ListBackupJobs( | ||
| 40 | ByAccountId => 'MyAccountId', # OPTIONAL | ||
| 41 | ByBackupVaultName => 'MyBackupVaultName', # OPTIONAL | ||
| 42 | ByCreatedAfter => '1970-01-01T01:00:00', # OPTIONAL | ||
| 43 | ByCreatedBefore => '1970-01-01T01:00:00', # OPTIONAL | ||
| 44 | ByResourceArn => 'MyARN', # OPTIONAL | ||
| 45 | ByResourceType => 'MyResourceType', # OPTIONAL | ||
| 46 | ByState => 'CREATED', # OPTIONAL | ||
| 47 | MaxResults => 1, # OPTIONAL | ||
| 48 | NextToken => 'Mystring', # OPTIONAL | ||
| 49 | ); | ||
| 50 | |||
| 51 | # Results: | ||
| 52 | my $BackupJobs = $ListBackupJobsOutput->BackupJobs; | ||
| 53 | my $NextToken = $ListBackupJobsOutput->NextToken; | ||
| 54 | |||
| 55 | # Returns a L<Paws::Backup::ListBackupJobsOutput> 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/backup/ListBackupJobs> | ||
| 59 | |||
| 60 | =head1 ATTRIBUTES | ||
| 61 | |||
| 62 | |||
| 63 | =head2 ByAccountId => Str | ||
| 64 | |||
| 65 | The account ID to list the jobs from. Returns only backup jobs | ||
| 66 | associated with the specified account ID. | ||
| 67 | |||
| 68 | If used from an AWS Organizations management account, passing C<*> | ||
| 69 | returns all jobs across the organization. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 ByBackupVaultName => Str | ||
| 74 | |||
| 75 | Returns only backup jobs that will be stored in the specified backup | ||
| 76 | vault. Backup vaults are identified by names that are unique to the | ||
| 77 | account used to create them and the AWS Region where they are created. | ||
| 78 | They consist of lowercase letters, numbers, and hyphens. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 ByCreatedAfter => Str | ||
| 83 | |||
| 84 | Returns only backup jobs that were created after the specified date. | ||
| 85 | |||
| 86 | |||
| 87 | |||
| 88 | =head2 ByCreatedBefore => Str | ||
| 89 | |||
| 90 | Returns only backup jobs that were created before the specified date. | ||
| 91 | |||
| 92 | |||
| 93 | |||
| 94 | =head2 ByResourceArn => Str | ||
| 95 | |||
| 96 | Returns only backup jobs that match the specified resource Amazon | ||
| 97 | Resource Name (ARN). | ||
| 98 | |||
| 99 | |||
| 100 | |||
| 101 | =head2 ByResourceType => Str | ||
| 102 | |||
| 103 | Returns only backup jobs for the specified resources: | ||
| 104 | |||
| 105 | =over | ||
| 106 | |||
| 107 | =item * | ||
| 108 | |||
| 109 | C<DynamoDB> for Amazon DynamoDB | ||
| 110 | |||
| 111 | =item * | ||
| 112 | |||
| 113 | C<EBS> for Amazon Elastic Block Store | ||
| 114 | |||
| 115 | =item * | ||
| 116 | |||
| 117 | C<EC2> for Amazon Elastic Compute Cloud | ||
| 118 | |||
| 119 | =item * | ||
| 120 | |||
| 121 | C<EFS> for Amazon Elastic File System | ||
| 122 | |||
| 123 | =item * | ||
| 124 | |||
| 125 | C<RDS> for Amazon Relational Database Service | ||
| 126 | |||
| 127 | =item * | ||
| 128 | |||
| 129 | C<Aurora> for Amazon Aurora | ||
| 130 | |||
| 131 | =item * | ||
| 132 | |||
| 133 | C<Storage Gateway> for AWS Storage Gateway | ||
| 134 | |||
| 135 | =back | ||
| 136 | |||
| 137 | |||
| 138 | |||
| 139 | |||
| 140 | =head2 ByState => Str | ||
| 141 | |||
| 142 | Returns only backup jobs that are in the specified state. | ||
| 143 | |||
| 144 | Valid values are: C<"CREATED">, C<"PENDING">, C<"RUNNING">, C<"ABORTING">, C<"ABORTED">, C<"COMPLETED">, C<"FAILED">, C<"EXPIRED"> | ||
| 145 | |||
| 146 | =head2 MaxResults => Int | ||
| 147 | |||
| 148 | The maximum number of items to be returned. | ||
| 149 | |||
| 150 | |||
| 151 | |||
| 152 | =head2 NextToken => Str | ||
| 153 | |||
| 154 | The next item following a partial list of returned items. For example, | ||
| 155 | if a request is made to return C<maxResults> number of items, | ||
| 156 | C<NextToken> allows you to return more items in your list starting at | ||
| 157 | the location pointed to by the next token. | ||
| 158 | |||
| 159 | |||
| 160 | |||
| 161 | |||
| 162 | =head1 SEE ALSO | ||
| 163 | |||
| 164 | This class forms part of L<Paws>, documenting arguments for method ListBackupJobs in L<Paws::Backup> | ||
| 165 | |||
| 166 | =head1 BUGS and CONTRIBUTIONS | ||
| 167 | |||
| 168 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 169 | |||
| 170 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 171 | |||
| 172 | =cut | ||
| 173 |