« blib/lib/Paws/Macie2/UntagResourceResponse.pm
↑ Summary
blib/lib/Paws/Macie2/UpdateClassificationJobResponse.pm »
| 1 | |||
| 2 | package Paws::Macie2::UpdateClassificationJob; | ||
| 3 | use Moose; | ||
| 4 | has JobId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'jobId', required => 1); | ||
| 5 | has JobStatus => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobStatus', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateClassificationJob'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/jobs/{jobId}'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'PATCH'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Macie2::UpdateClassificationJobResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Macie2::UpdateClassificationJob - Arguments for method UpdateClassificationJob on L<Paws::Macie2> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method UpdateClassificationJob on the | ||
| 24 | L<Amazon Macie 2|Paws::Macie2> service. Use the attributes of this class | ||
| 25 | as arguments to method UpdateClassificationJob. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateClassificationJob. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $macie2 = Paws->service('Macie2'); | ||
| 32 | my $UpdateClassificationJobResponse = $macie2->UpdateClassificationJob( | ||
| 33 | JobId => 'My__string', | ||
| 34 | JobStatus => 'RUNNING', | ||
| 35 | |||
| 36 | ); | ||
| 37 | |||
| 38 | 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. | ||
| 39 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/macie2/UpdateClassificationJob> | ||
| 40 | |||
| 41 | =head1 ATTRIBUTES | ||
| 42 | |||
| 43 | |||
| 44 | =head2 B<REQUIRED> JobId => Str | ||
| 45 | |||
| 46 | The unique identifier for the classification job. | ||
| 47 | |||
| 48 | |||
| 49 | |||
| 50 | =head2 B<REQUIRED> JobStatus => Str | ||
| 51 | |||
| 52 | The new status for the job. Valid values are: | ||
| 53 | |||
| 54 | =over | ||
| 55 | |||
| 56 | =item * | ||
| 57 | |||
| 58 | CANCELLED - Stops the job permanently and cancels it. This value is | ||
| 59 | valid only if the job's current status is IDLE, PAUSED, RUNNING, or | ||
| 60 | USER_PAUSED. | ||
| 61 | |||
| 62 | If you specify this value and the job's current status is RUNNING, | ||
| 63 | Amazon Macie immediately begins to stop all processing tasks for the | ||
| 64 | job. You can't resume or restart a job after you cancel it. | ||
| 65 | |||
| 66 | =item * | ||
| 67 | |||
| 68 | RUNNING - Resumes the job. This value is valid only if the job's | ||
| 69 | current status is USER_PAUSED. | ||
| 70 | |||
| 71 | If you paused the job while it was actively running and you specify | ||
| 72 | this value less than 30 days after you paused the job, Macie | ||
| 73 | immediately resumes processing from the point where you paused the job. | ||
| 74 | Otherwise, Macie resumes the job according to the schedule and other | ||
| 75 | settings for the job. | ||
| 76 | |||
| 77 | =item * | ||
| 78 | |||
| 79 | USER_PAUSED - Pauses the job temporarily. This value is valid only if | ||
| 80 | the job's current status is IDLE, PAUSED, or RUNNING. If you specify | ||
| 81 | this value and the job's current status is RUNNING, Macie immediately | ||
| 82 | begins to pause all processing tasks for the job. | ||
| 83 | |||
| 84 | If you pause a one-time job and you don't resume it within 30 days, the | ||
| 85 | job expires and Macie cancels the job. If you pause a recurring job | ||
| 86 | when its status is RUNNING and you don't resume it within 30 days, the | ||
| 87 | job run expires and Macie cancels the run. To check the expiration | ||
| 88 | date, refer to the UserPausedDetails.jobExpiresAt property. | ||
| 89 | |||
| 90 | =back | ||
| 91 | |||
| 92 | |||
| 93 | Valid values are: C<"RUNNING">, C<"PAUSED">, C<"CANCELLED">, C<"COMPLETE">, C<"IDLE">, C<"USER_PAUSED"> | ||
| 94 | |||
| 95 | |||
| 96 | =head1 SEE ALSO | ||
| 97 | |||
| 98 | This class forms part of L<Paws>, documenting arguments for method UpdateClassificationJob in L<Paws::Macie2> | ||
| 99 | |||
| 100 | =head1 BUGS and CONTRIBUTIONS | ||
| 101 | |||
| 102 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 103 | |||
| 104 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 105 | |||
| 106 | =cut | ||
| 107 |