« blib/lib/Paws/S3Control/UpdateJobPriorityResult.pm
↑ Summary
blib/lib/Paws/S3Control/UpdateJobStatusResult.pm »
| 1 | |||
| 2 | package Paws::S3Control::UpdateJobStatus; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str', header_name => 'x-amz-account-id', traits => ['ParamInHeader'], required => 1); | ||
| 5 | has JobId => (is => 'ro', isa => 'Str', uri_name => 'id', traits => ['ParamInURI'], required => 1); | ||
| 6 | has RequestedJobStatus => (is => 'ro', isa => 'Str', query_name => 'requestedJobStatus', traits => ['ParamInQuery'], required => 1); | ||
| 7 | has StatusUpdateReason => (is => 'ro', isa => 'Str', query_name => 'statusUpdateReason', traits => ['ParamInQuery']); | ||
| 8 | |||
| 9 | |||
| 10 | use MooseX::ClassAttribute; | ||
| 11 | |||
| 12 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateJobStatus'); | ||
| 13 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v20180820/jobs/{id}/status'); | ||
| 14 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 15 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::S3Control::UpdateJobStatusResult'); | ||
| 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::UpdateJobStatus - Arguments for method UpdateJobStatus on L<Paws::S3Control> | ||
| 26 | |||
| 27 | =head1 DESCRIPTION | ||
| 28 | |||
| 29 | This class represents the parameters used for calling the method UpdateJobStatus on the | ||
| 30 | L<AWS S3 Control|Paws::S3Control> service. Use the attributes of this class | ||
| 31 | as arguments to method UpdateJobStatus. | ||
| 32 | |||
| 33 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateJobStatus. | ||
| 34 | |||
| 35 | =head1 SYNOPSIS | ||
| 36 | |||
| 37 | my $s3-control = Paws->service('S3Control'); | ||
| 38 | my $UpdateJobStatusResult = $s3 -control->UpdateJobStatus( | ||
| 39 | AccountId => 'MyAccountId', | ||
| 40 | JobId => 'MyJobId', | ||
| 41 | RequestedJobStatus => 'Cancelled', | ||
| 42 | StatusUpdateReason => 'MyJobStatusUpdateReason', # OPTIONAL | ||
| 43 | ); | ||
| 44 | |||
| 45 | # Results: | ||
| 46 | my $JobId = $UpdateJobStatusResult->JobId; | ||
| 47 | my $Status = $UpdateJobStatusResult->Status; | ||
| 48 | my $StatusUpdateReason = $UpdateJobStatusResult->StatusUpdateReason; | ||
| 49 | |||
| 50 | # Returns a L<Paws::S3Control::UpdateJobStatusResult> object. | ||
| 51 | |||
| 52 | 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. | ||
| 53 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/s3-control/UpdateJobStatus> | ||
| 54 | |||
| 55 | =head1 ATTRIBUTES | ||
| 56 | |||
| 57 | |||
| 58 | =head2 B<REQUIRED> AccountId => Str | ||
| 59 | |||
| 60 | The AWS account ID associated with the S3 Batch Operations job. | ||
| 61 | |||
| 62 | |||
| 63 | |||
| 64 | =head2 B<REQUIRED> JobId => Str | ||
| 65 | |||
| 66 | The ID of the job whose status you want to update. | ||
| 67 | |||
| 68 | |||
| 69 | |||
| 70 | =head2 B<REQUIRED> RequestedJobStatus => Str | ||
| 71 | |||
| 72 | The status that you want to move the specified job to. | ||
| 73 | |||
| 74 | Valid values are: C<"Cancelled">, C<"Ready"> | ||
| 75 | |||
| 76 | =head2 StatusUpdateReason => Str | ||
| 77 | |||
| 78 | A description of the reason why you want to change the specified job's | ||
| 79 | status. This field can be any string up to the maximum length. | ||
| 80 | |||
| 81 | |||
| 82 | |||
| 83 | |||
| 84 | =head1 SEE ALSO | ||
| 85 | |||
| 86 | This class forms part of L<Paws>, documenting arguments for method UpdateJobStatus in L<Paws::S3Control> | ||
| 87 | |||
| 88 | =head1 BUGS and CONTRIBUTIONS | ||
| 89 | |||
| 90 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 91 | |||
| 92 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 93 | |||
| 94 | =cut | ||
| 95 |