blib/lib/Paws/Batch/SubmitJob.pm

filter: Statementstmt 100% 23 / 23 Branchbran n/a Conditioncond n/a MC/DCmcdc n/a Subroutinesub 100% 2 / 2 Podpod n/a totaltotal 100% 25 / 25 CC 1 SCAR 0.0
CC
1
Cov
100%
BEGIN
1.0
BEGIN
1.0
CRAP 1.0
« blib/lib/Paws/Batch/ParametersMap.pm ↑ Summary blib/lib/Paws/CloudFormation/CreateStack.pm »
1  
2 package Paws::Batch::SubmitJob;
3 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
4 1 has ArrayProperties => (is => 'ro', isa => 'Paws::Batch::ArrayProperties', traits => ['NameInRequest'], request_name => 'arrayProperties');
5 1 has ContainerOverrides => (is => 'ro', isa => 'Paws::Batch::ContainerOverrides', traits => ['NameInRequest'], request_name => 'containerOverrides');
6 1 has DependsOn => (is => 'ro', isa => 'ArrayRef[Paws::Batch::JobDependency]', traits => ['NameInRequest'], request_name => 'dependsOn');
7 1 has JobDefinition => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobDefinition', required => 1);
8 1 has JobName => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobName', required => 1);
9 1 has JobQueue => (is => 'ro', isa => 'Str', traits => ['NameInRequest'], request_name => 'jobQueue', required => 1);
10 1 has NodeOverrides => (is => 'ro', isa => 'Paws::Batch::NodeOverrides', traits => ['NameInRequest'], request_name => 'nodeOverrides');
11 1 has Parameters => (is => 'ro', isa => 'Paws::Batch::ParametersMap', traits => ['NameInRequest'], request_name => 'parameters');
12 1 has PropagateTags => (is => 'ro', isa => 'Bool', traits => ['NameInRequest'], request_name => 'propagateTags');
13 1 has RetryStrategy => (is => 'ro', isa => 'Paws::Batch::RetryStrategy', traits => ['NameInRequest'], request_name => 'retryStrategy');
14 1 has Tags => (is => 'ro', isa => 'Paws::Batch::TagrisTagsMap', traits => ['NameInRequest'], request_name => 'tags');
15 1 has Timeout => (is => 'ro', isa => 'Paws::Batch::JobTimeout', traits => ['NameInRequest'], request_name => 'timeout');
16  
17 1 ▶ use MooseX::ClassAttribute;
Subroutine BEGIN: called CC=1 SCAR=0.0
18  
19 1 class_has _api_call => (isa => 'Str', is => 'ro', default => 'SubmitJob');
20 1 class_has _api_uri => (isa => 'Str', is => 'ro', default => '/v1/submitjob');
21 1 class_has _api_method => (isa => 'Str', is => 'ro', default => 'POST');
22 1 class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Batch::SubmitJobResponse');
23 1 1;
24  
25 ### main pod documentation begin ###
26  
27 =head1 NAME
28  
29 Paws::Batch::SubmitJob - Arguments for method SubmitJob on L<Paws::Batch>
30  
31 =head1 DESCRIPTION
32  
33 This class represents the parameters used for calling the method SubmitJob on the
34 L<AWS Batch|Paws::Batch> service. Use the attributes of this class
35 as arguments to method SubmitJob.
36  
37 You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to SubmitJob.
38  
39 =head1 SYNOPSIS
40  
41 my $batch = Paws->service('Batch');
42 # To submit a job to a queue
43 # This example submits a simple container job called example to the HighPriority
44 # job queue.
45 my $SubmitJobResponse = $batch->SubmitJob(
46 'JobDefinition' => 'sleep60',
47 'JobName' => 'example',
48 'JobQueue' => 'HighPriority'
49 );
50  
51 # Results:
52 my $jobId = $SubmitJobResponse->jobId;
53 my $jobName = $SubmitJobResponse->jobName;
54  
55 # Returns a L<Paws::Batch::SubmitJobResponse> 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/batch/SubmitJob>
59  
60 =head1 ATTRIBUTES
61  
62  
63 =head2 ArrayProperties => L<Paws::Batch::ArrayProperties>
64  
65 The array properties for the submitted job, such as the size of the
66 array. The array size can be between 2 and 10,000. If you specify array
67 properties for a job, it becomes an array job. For more information,
68 see Array Jobs
69 (https://docs.aws.amazon.com/batch/latest/userguide/array_jobs.html) in
70 the I<AWS Batch User Guide>.
71  
72  
73  
74 =head2 ContainerOverrides => L<Paws::Batch::ContainerOverrides>
75  
76 A list of container overrides in the JSON format that specify the name
77 of a container in the specified job definition and the overrides it
78 should receive. You can override the default command for a container,
79 which is specified in the job definition or the Docker image, with a
80 C<command> override. You can also override existing environment
81 variables on a container or add new environment variables to it with an
82 C<environment> override.
83  
84  
85  
86 =head2 DependsOn => ArrayRef[L<Paws::Batch::JobDependency>]
87  
88 A list of dependencies for the job. A job can depend upon a maximum of
89 20 jobs. You can specify a C<SEQUENTIAL> type dependency without
90 specifying a job ID for array jobs so that each child array job
91 completes sequentially, starting at index 0. You can also specify an
92 C<N_TO_N> type dependency with a job ID for array jobs. In that case,
93 each index child of this job must wait for the corresponding index
94 child of each dependency to complete before it can begin.
95  
96  
97  
98 =head2 B<REQUIRED> JobDefinition => Str
99  
100 The job definition used by this job. This value can be one of C<name>,
101 C<name:revision>, or the Amazon Resource Name (ARN) for the job
102 definition. If C<name> is specified without a revision then the latest
103 active revision is used.
104  
105  
106  
107 =head2 B<REQUIRED> JobName => Str
108  
109 The name of the job. The first character must be alphanumeric, and up
110 to 128 letters (uppercase and lowercase), numbers, hyphens, and
111 underscores are allowed.
112  
113  
114  
115 =head2 B<REQUIRED> JobQueue => Str
116  
117 The job queue where the job is submitted. You can specify either the
118 name or the Amazon Resource Name (ARN) of the queue.
119  
120  
121  
122 =head2 NodeOverrides => L<Paws::Batch::NodeOverrides>
123  
124 A list of node overrides in JSON format that specify the node range to
125 target and the container overrides for that node range.
126  
127 This parameter isn't applicable to jobs running on Fargate resources;
128 use C<containerOverrides> instead.
129  
130  
131  
132 =head2 Parameters => L<Paws::Batch::ParametersMap>
133  
134 Additional parameters passed to the job that replace parameter
135 substitution placeholders that are set in the job definition.
136 Parameters are specified as a key and value pair mapping. Parameters in
137 a C<SubmitJob> request override any corresponding parameter defaults
138 from the job definition.
139  
140  
141  
142 =head2 PropagateTags => Bool
143  
144 Specifies whether to propagate the tags from the job or job definition
145 to the corresponding Amazon ECS task. If no value is specified, the
146 tags aren't propagated. Tags can only be propagated to the tasks during
147 task creation. For tags with the same name, job tags are given priority
148 over job definitions tags. If the total number of combined tags from
149 the job and job definition is over 50, the job is moved to the
150 C<FAILED> state. When specified, this overrides the tag propagation
151 setting in the job definition.
152  
153  
154  
155 =head2 RetryStrategy => L<Paws::Batch::RetryStrategy>
156  
157 The retry strategy to use for failed jobs from this SubmitJob
158 operation. When a retry strategy is specified here, it overrides the
159 retry strategy defined in the job definition.
160  
161  
162  
163 =head2 Tags => L<Paws::Batch::TagrisTagsMap>
164  
165 The tags that you apply to the job request to help you categorize and
166 organize your resources. Each tag consists of a key and an optional
167 value. For more information, see Tagging AWS Resources
168 (https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in
169 I<AWS General Reference>.
170  
171  
172  
173 =head2 Timeout => L<Paws::Batch::JobTimeout>
174  
175 The timeout configuration for this SubmitJob operation. You can specify
176 a timeout duration after which AWS Batch terminates your jobs if they
177 haven't finished. If a job is terminated due to a timeout, it isn't
178 retried. The minimum value for the timeout is 60 seconds. This
179 configuration overrides any timeout configuration specified in the job
180 definition. For array jobs, child jobs have the same timeout
181 configuration as the parent job. For more information, see Job Timeouts
182 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/job_timeouts.html)
183 in the I<Amazon Elastic Container Service Developer Guide>.
184  
185  
186  
187  
188 =head1 SEE ALSO
189  
190 This class forms part of L<Paws>, documenting arguments for method SubmitJob in L<Paws::Batch>
191  
192 =head1 BUGS and CONTRIBUTIONS
193  
194 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
195  
196 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
197  
198 =cut
199  
« blib/lib/Paws/Batch/ParametersMap.pm ↑ Summary blib/lib/Paws/CloudFormation/CreateStack.pm »