« blib/lib/Paws/S3Control/ListAccessPointsResult.pm
↑ Summary
blib/lib/Paws/S3Control/ListJobsResult.pm »
| 1 | |||
| 2 | package Paws::S3Control::ListJobs; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str', header_name => 'x-amz-account-id', traits => ['ParamInHeader'], required => 1); | ||
| 5 | has JobStatuses => (is => 'ro', isa => 'ArrayRef[Str|Undef]', request_name => 'jobStatuses', traits => ['NameInRequest']); | ||
| 6 | has MaxResults => (is => 'ro', isa => 'Int', query_name => 'maxResults', traits => ['ParamInQuery']); | ||
| 7 | has NextToken => (is => 'ro', isa => 'Str', query_name => 'nextToken', traits => ['ParamInQuery']); | ||
| 8 | |||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'ListJobs'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v20180820/jobs'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3Control::ListJobsResult'); | ||
| 16 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 17 | |||
| 18 | |||
| 19 | 1; | ||
| 20 | |||
| 21 | ### main pod documentation begin ### | ||
| 22 | |||
| 23 | =head1 NAME | ||
| 24 | |||
| 25 | Paws::S3Control::ListJobs - Arguments for method ListJobs on L<Paws::S3Control> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method ListJobs on the | ||
| 30 | L<AWS S3 Control|Paws::S3Control> service. Use the attributes of this class | ||
| 31 | as arguments to method ListJobs. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to ListJobs. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $s3-control = Paws->service('S3Control'); | ||
| 38 | my $ListJobsResult = $s3 -control->ListJobs( | ||
| 39 | AccountId => 'MyAccountId', | ||
| 40 | JobStatuses => [ | ||
| 41 | 'Active', | ||
| 42 | ... # values: Active, Cancelled, Cancelling, Complete, Completing, Failed, Failing, New, Paused, Pausing, Preparing, Ready, Suspended | ||
| 43 | ], # OPTIONAL | ||
| 44 | MaxResults => 1, # OPTIONAL | ||
| 45 | NextToken => 'MyStringForNextToken', # OPTIONAL | ||
| 46 | ); | ||
| 47 | |||
| 48 | # Results: | ||
| 49 | my $Jobs = $ListJobsResult->Jobs; | ||
| 50 | my $NextToken = $ListJobsResult->NextToken; | ||
| 51 | |||
| 52 | # Returns a L<Paws::S3Control::ListJobsResult> object. | ||
| 53 | |||
| 54 | 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. | ||
| 55 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3-control/ListJobs> | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 B<REQUIRED> AccountId => Str | ||
| 61 | |||
| 62 | The AWS account ID associated with the S3 Batch Operations job. | ||
| 63 | |||
| 64 | |||
| 65 | |||
| 66 | =head2 JobStatuses => ArrayRef[Str|Undef] | ||
| 67 | |||
| 68 | The C<List Jobs> request returns jobs that match the statuses listed in | ||
| 69 | this element. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | =head2 MaxResults => Int | ||
| 74 | |||
| 75 | The maximum number of jobs that Amazon S3 will include in the C<List | ||
| 76 | Jobs> response. If there are more jobs than this number, the response | ||
| 77 | will include a pagination token in the C<NextToken> field to enable you | ||
| 78 | to retrieve the next page of results. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 NextToken => Str | ||
| 83 | |||
| 84 | A pagination token to request the next page of results. Use the token | ||
| 85 | that Amazon S3 returned in the C<NextToken> element of the | ||
| 86 | C<ListJobsResult> from the previous C<List Jobs> request. | ||
| 87 | |||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head1 SEE ALSO | ||
| 92 | |||
| 93 | This class forms part of L<Paws>, documenting arguments for method ListJobs in L<Paws::S3Control> | ||
| 94 | |||
| 95 | =head1 BUGS and CONTRIBUTIONS | ||
| 96 | |||
| 97 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 98 | |||
| 99 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 100 | |||
| 101 | =cut | ||
| 102 |