| 1 | |||
| 2 | package Paws::Batch::TerminateJob; | ||
| 3 | use Moose; | ||
| 4 | has JobId => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobId', required => 1); | ||
| 5 | has Reason => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'reason', required => 1); | ||
| 6 | |||
| 7 | use MooseX::ClassAttribute; | ||
| 8 | |||
| 9 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'TerminateJob'); | ||
| 10 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/terminatejob'); | ||
| 11 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST'); | ||
| 12 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Batch::TerminateJobResponse'); | ||
| 13 | 1; | ||
| 14 | |||
| 15 | ### main pod documentation begin ### | ||
| 16 | |||
| 17 | =head1 NAME | ||
| 18 | |||
| 19 | Paws::Batch::TerminateJob - Arguments for method TerminateJob on L<Paws::Batch> | ||
| 20 | |||
| 21 | =head1 DESCRIPTION | ||
| 22 | |||
| 23 | This class represents the parameters used for calling the method TerminateJob on the | ||
| 24 | L<AWS Batch|Paws::Batch> service. Use the attributes of this class | ||
| 25 | as arguments to method TerminateJob. | ||
| 26 | |||
| 27 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to TerminateJob. | ||
| 28 | |||
| 29 | =head1 SYNOPSIS | ||
| 30 | |||
| 31 | my $batch = Paws->service('Batch'); | ||
| 32 | # To terminate a job | ||
| 33 | # This example terminates a job with the specified job ID. | ||
| 34 | my $TerminateJobResponse = $batch->TerminateJob( | ||
| 35 | 'JobId' => '61e743ed-35e4-48da-b2de-5c8333821c84', | ||
| 36 | 'Reason' => 'Terminating job.' | ||
| 37 | ); | ||
| 38 | |||
| 39 | |||
| 40 | 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. | ||
| 41 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/batch/TerminateJob> | ||
| 42 | |||
| 43 | =head1 ATTRIBUTES | ||
| 44 | |||
| 45 | |||
| 46 | =head2 B<REQUIRED> JobId => Str | ||
| 47 | |||
| 48 | The AWS Batch job ID of the job to terminate. | ||
| 49 | |||
| 50 | |||
| 51 | |||
| 52 | =head2 B<REQUIRED> Reason => Str | ||
| 53 | |||
| 54 | A message to attach to the job that explains the reason for canceling | ||
| 55 | it. This message is returned by future DescribeJobs operations on the | ||
| 56 | job. This message is also recorded in the AWS Batch activity logs. | ||
| 57 | |||
| 58 | |||
| 59 | |||
| 60 | |||
| 61 | =head1 SEE ALSO | ||
| 62 | |||
| 63 | This class forms part of L<Paws>, documenting arguments for method TerminateJob in L<Paws::Batch> | ||
| 64 | |||
| 65 | =head1 BUGS and CONTRIBUTIONS | ||
| 66 | |||
| 67 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 68 | |||
| 69 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 70 | |||
| 71 | =cut | ||
| 72 |