blib/lib/Paws/Batch.pm

filter: Statementstmt 10.4% 15 / 144 Branchbran 0.0% 0 / 32 Conditioncond n/a MC/DCmcdc n/a Subroutinesub 19.3% 6 / 31 Podpod 82.1% 23 / 28 totaltotal 18.7% 44 / 235 CC 25 SCAR 33.8
CC
25
Cov
9%
DescribeAllComputeEnvironments
56.0
DescribeAllJobDefinitions
56.0
DescribeAllJobQueues
56.0
CRAP 29.4
« blib/lib/Paws/Lambda.pm ↑ Summary blib/lib/Paws/CloudTrail.pm »
1 package Paws::Batch;
2 1 ▶ use Moose;
Subroutine BEGIN: called CC=1 SCAR=0.0
3 1 ▶ sub service { 'batch' }
Subroutine service: called CC=1 SCAR=0.0
Pod undocumented
4 1 ▶ sub signing_name { 'batch' }
Subroutine signing_name: called CC=1 SCAR=0.0
Pod undocumented
5 0 ▶ sub version { '2016-08-10' }
Subroutine version: not called CC=1 SCAR=6.9
Pod undocumented
6 0 ▶ sub flattened_arrays { 0 }
Subroutine flattened_arrays: not called CC=1 SCAR=6.9
Pod undocumented
7 1 has max_attempts => (is => 'ro', isa => 'Int', default => 5);
8 1 ▶ has retry => (is => 'ro', isa => 'HashRef', default => sub {
Subroutine __ANON__: called CC=1 SCAR=0.0
9 1 { base => 'rand', type => 'exponential', growth_factor => 2 }
10 1 });
11 1 ▶ has retriables => (is => 'ro', isa => 'ArrayRef', default => sub { [
Subroutine __ANON__: called CC=1 SCAR=0.0
12 1 ] });
13  
14 1 with 'Paws::API::Caller', 'Paws::API::EndpointResolver', 'Paws::Net::V4Signature', 'Paws::Net::RestJsonCaller';
15  
16
17 0 ▶ sub CancelJob {
Subroutine CancelJob: not called CC=1 SCAR=6.9
Pod documented
18 0 my $self = shift;
19 0 my $call_object = $self->new_with_coercions('Paws::Batch::CancelJob', @_);
20 0 return $self->caller->do_call($self, $call_object);
21 }
22 0 ▶ sub CreateComputeEnvironment {
Subroutine CreateComputeEnvironment: not called CC=1 SCAR=6.9
Pod documented
23 0 my $self = shift;
24 0 my $call_object = $self->new_with_coercions('Paws::Batch::CreateComputeEnvironment', @_);
25 0 return $self->caller->do_call($self, $call_object);
26 }
27 0 ▶ sub CreateJobQueue {
Subroutine CreateJobQueue: not called CC=1 SCAR=6.9
Pod documented
28 0 my $self = shift;
29 0 my $call_object = $self->new_with_coercions('Paws::Batch::CreateJobQueue', @_);
30 0 return $self->caller->do_call($self, $call_object);
31 }
32 0 ▶ sub DeleteComputeEnvironment {
Subroutine DeleteComputeEnvironment: not called CC=1 SCAR=6.9
Pod documented
33 0 my $self = shift;
34 0 my $call_object = $self->new_with_coercions('Paws::Batch::DeleteComputeEnvironment', @_);
35 0 return $self->caller->do_call($self, $call_object);
36 }
37 0 ▶ sub DeleteJobQueue {
Subroutine DeleteJobQueue: not called CC=1 SCAR=6.9
Pod documented
38 0 my $self = shift;
39 0 my $call_object = $self->new_with_coercions('Paws::Batch::DeleteJobQueue', @_);
40 0 return $self->caller->do_call($self, $call_object);
41 }
42 0 ▶ sub DeregisterJobDefinition {
Subroutine DeregisterJobDefinition: not called CC=1 SCAR=6.9
Pod documented
43 0 my $self = shift;
44 0 my $call_object = $self->new_with_coercions('Paws::Batch::DeregisterJobDefinition', @_);
45 0 return $self->caller->do_call($self, $call_object);
46 }
47 0 ▶ sub DescribeComputeEnvironments {
Subroutine DescribeComputeEnvironments: not called CC=1 SCAR=6.9
Pod documented
48 0 my $self = shift;
49 0 my $call_object = $self->new_with_coercions('Paws::Batch::DescribeComputeEnvironments', @_);
50 0 return $self->caller->do_call($self, $call_object);
51 }
52 0 ▶ sub DescribeJobDefinitions {
Subroutine DescribeJobDefinitions: not called CC=1 SCAR=6.9
Pod documented
53 0 my $self = shift;
54 0 my $call_object = $self->new_with_coercions('Paws::Batch::DescribeJobDefinitions', @_);
55 0 return $self->caller->do_call($self, $call_object);
56 }
57 0 ▶ sub DescribeJobQueues {
Subroutine DescribeJobQueues: not called CC=1 SCAR=6.9
Pod documented
58 0 my $self = shift;
59 0 my $call_object = $self->new_with_coercions('Paws::Batch::DescribeJobQueues', @_);
60 0 return $self->caller->do_call($self, $call_object);
61 }
62 0 ▶ sub DescribeJobs {
Subroutine DescribeJobs: not called CC=1 SCAR=6.9
Pod documented
63 0 my $self = shift;
64 0 my $call_object = $self->new_with_coercions('Paws::Batch::DescribeJobs', @_);
65 0 return $self->caller->do_call($self, $call_object);
66 }
67 0 ▶ sub ListJobs {
Subroutine ListJobs: not called CC=1 SCAR=6.9
Pod documented
68 0 my $self = shift;
69 0 my $call_object = $self->new_with_coercions('Paws::Batch::ListJobs', @_);
70 0 return $self->caller->do_call($self, $call_object);
71 }
72 0 ▶ sub ListTagsForResource {
Subroutine ListTagsForResource: not called CC=1 SCAR=6.9
Pod documented
73 0 my $self = shift;
74 0 my $call_object = $self->new_with_coercions('Paws::Batch::ListTagsForResource', @_);
75 0 return $self->caller->do_call($self, $call_object);
76 }
77 0 ▶ sub RegisterJobDefinition {
Subroutine RegisterJobDefinition: not called CC=1 SCAR=6.9
Pod documented
78 0 my $self = shift;
79 0 my $call_object = $self->new_with_coercions('Paws::Batch::RegisterJobDefinition', @_);
80 0 return $self->caller->do_call($self, $call_object);
81 }
82 1 ▶ sub SubmitJob {
Subroutine SubmitJob: called CC=1 SCAR=0.0
Pod documented
83 1 my $self = shift;
84 1 my $call_object = $self->new_with_coercions('Paws::Batch::SubmitJob', @_);
85 1 return $self->caller->do_call($self, $call_object);
86 }
87 0 ▶ sub TagResource {
Subroutine TagResource: not called CC=1 SCAR=6.9
Pod documented
88 0 my $self = shift;
89 0 my $call_object = $self->new_with_coercions('Paws::Batch::TagResource', @_);
90 0 return $self->caller->do_call($self, $call_object);
91 }
92 0 ▶ sub TerminateJob {
Subroutine TerminateJob: not called CC=1 SCAR=6.9
Pod documented
93 0 my $self = shift;
94 0 my $call_object = $self->new_with_coercions('Paws::Batch::TerminateJob', @_);
95 0 return $self->caller->do_call($self, $call_object);
96 }
97 0 ▶ sub UntagResource {
Subroutine UntagResource: not called CC=1 SCAR=6.9
Pod documented
98 0 my $self = shift;
99 0 my $call_object = $self->new_with_coercions('Paws::Batch::UntagResource', @_);
100 0 return $self->caller->do_call($self, $call_object);
101 }
102 0 ▶ sub UpdateComputeEnvironment {
Subroutine UpdateComputeEnvironment: not called CC=1 SCAR=6.9
Pod documented
103 0 my $self = shift;
104 0 my $call_object = $self->new_with_coercions('Paws::Batch::UpdateComputeEnvironment', @_);
105 0 return $self->caller->do_call($self, $call_object);
106 }
107 0 ▶ sub UpdateJobQueue {
Subroutine UpdateJobQueue: not called CC=1 SCAR=6.9
Pod documented
108 0 my $self = shift;
109 0 my $call_object = $self->new_with_coercions('Paws::Batch::UpdateJobQueue', @_);
110 0 return $self->caller->do_call($self, $call_object);
111 }
112
113 0 ▶ sub DescribeAllComputeEnvironments {
Subroutine DescribeAllComputeEnvironments: not called CC=7 SCAR=40.3
Pod documented
114 0 my $self = shift;
115  
116 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
117 0 my $result = $self->DescribeComputeEnvironments(@_);
118 0 my $next_result = $result;
119  
120 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
121 0 ▶ while ($next_result->nextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->nextToken) 0 0 0
122 0 $next_result = $self->DescribeComputeEnvironments(@_, nextToken => $next_result->nextToken);
123 0 push @{ $result->computeEnvironments }, @{ $next_result->computeEnvironments };
124 }
125 0 return $result;
126 } else {
127 0 ▶ while ($result->nextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->nextToken) 0 0 0
128 0 $callback->($_ => 'computeEnvironments') foreach (@{ $result->computeEnvironments });
129 0 $result = $self->DescribeComputeEnvironments(@_, nextToken => $result->nextToken);
130 }
131 0 $callback->($_ => 'computeEnvironments') foreach (@{ $result->computeEnvironments });
132 }
133  
134 return undef
135 0 }
136 0 ▶ sub DescribeAllJobDefinitions {
Subroutine DescribeAllJobDefinitions: not called CC=7 SCAR=40.3
Pod documented
137 0 my $self = shift;
138  
139 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
140 0 my $result = $self->DescribeJobDefinitions(@_);
141 0 my $next_result = $result;
142  
143 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
144 0 ▶ while ($next_result->nextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->nextToken) 0 0 0
145 0 $next_result = $self->DescribeJobDefinitions(@_, nextToken => $next_result->nextToken);
146 0 push @{ $result->jobDefinitions }, @{ $next_result->jobDefinitions };
147 }
148 0 return $result;
149 } else {
150 0 ▶ while ($result->nextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->nextToken) 0 0 0
151 0 $callback->($_ => 'jobDefinitions') foreach (@{ $result->jobDefinitions });
152 0 $result = $self->DescribeJobDefinitions(@_, nextToken => $result->nextToken);
153 }
154 0 $callback->($_ => 'jobDefinitions') foreach (@{ $result->jobDefinitions });
155 }
156  
157 return undef
158 0 }
159 0 ▶ sub DescribeAllJobQueues {
Subroutine DescribeAllJobQueues: not called CC=7 SCAR=40.3
Pod documented
160 0 my $self = shift;
161  
162 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
163 0 my $result = $self->DescribeJobQueues(@_);
164 0 my $next_result = $result;
165  
166 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
167 0 ▶ while ($next_result->nextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->nextToken) 0 0 0
168 0 $next_result = $self->DescribeJobQueues(@_, nextToken => $next_result->nextToken);
169 0 push @{ $result->jobQueues }, @{ $next_result->jobQueues };
170 }
171 0 return $result;
172 } else {
173 0 ▶ while ($result->nextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->nextToken) 0 0 0
174 0 $callback->($_ => 'jobQueues') foreach (@{ $result->jobQueues });
175 0 $result = $self->DescribeJobQueues(@_, nextToken => $result->nextToken);
176 }
177 0 $callback->($_ => 'jobQueues') foreach (@{ $result->jobQueues });
178 }
179  
180 return undef
181 0 }
182 0 ▶ sub ListAllJobs {
Subroutine ListAllJobs: not called CC=7 SCAR=40.3
Pod documented
183 0 my $self = shift;
184  
185 0 ▶ my $callback = shift @_ if (ref($_[0]) eq 'CODE');
Branch: 1 branch
BranchTrueFalseTotal
if ref $_[0] eq "CODE" 0 0 0
186 0 my $result = $self->ListJobs(@_);
187 0 my $next_result = $result;
188  
189 0 ▶ if (not defined $callback) {
Branch: 1 branch
BranchTrueFalseTotal
if (not defined $callback) { } 0 0 0
190 0 ▶ while ($next_result->nextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($next_result->nextToken) 0 0 0
191 0 $next_result = $self->ListJobs(@_, nextToken => $next_result->nextToken);
192 0 push @{ $result->jobSummaryList }, @{ $next_result->jobSummaryList };
193 }
194 0 return $result;
195 } else {
196 0 ▶ while ($result->nextToken) {
Branch: 1 branch
BranchTrueFalseTotal
if ($result->nextToken) 0 0 0
197 0 $callback->($_ => 'jobSummaryList') foreach (@{ $result->jobSummaryList });
198 0 $result = $self->ListJobs(@_, nextToken => $result->nextToken);
199 }
200 0 $callback->($_ => 'jobSummaryList') foreach (@{ $result->jobSummaryList });
201 }
202  
203 return undef
204 0 }
205  
206  
207 0 ▶ sub operations { qw/CancelJob CreateComputeEnvironment CreateJobQueue DeleteComputeEnvironment DeleteJobQueue DeregisterJobDefinition DescribeComputeEnvironments DescribeJobDefinitions DescribeJobQueues DescribeJobs ListJobs ListTagsForResource RegisterJobDefinition SubmitJob TagResource TerminateJob UntagResource UpdateComputeEnvironment UpdateJobQueue / }
Subroutine operations: not called CC=1 SCAR=6.9
Pod undocumented
208  
209 1 1;
210  
211 ### main pod documentation begin ###
212  
213 =head1 NAME
214  
215 Paws::Batch - Perl Interface to AWS AWS Batch
216  
217 =head1 SYNOPSIS
218  
219 use Paws;
220  
221 my $obj = Paws->service('Batch');
222 my $res = $obj->Method(
223 Arg1 => $val1,
224 Arg2 => [ 'V1', 'V2' ],
225 # if Arg3 is an object, the HashRef will be used as arguments to the constructor
226 # of the arguments type
227 Arg3 => { Att1 => 'Val1' },
228 # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
229 # the constructor of the arguments type
230 Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ],
231 );
232  
233 =head1 DESCRIPTION
234  
235 Using AWS Batch, you can run batch computing workloads on the AWS
236 Cloud. Batch computing is a common means for developers, scientists,
237 and engineers to access large amounts of compute resources. AWS Batch
238 uses the advantages of this computing workload to remove the
239 undifferentiated heavy lifting of configuring and managing required
240 infrastructure. At the same time, it also adopts a familiar batch
241 computing software approach. Given these advantages, AWS Batch can help
242 you to efficiently provision resources in response to jobs submitted,
243 thus effectively helping you to eliminate capacity constraints, reduce
244 compute costs, and deliver your results more quickly.
245  
246 As a fully managed service, AWS Batch can run batch computing workloads
247 of any scale. AWS Batch automatically provisions compute resources and
248 optimizes workload distribution based on the quantity and scale of your
249 specific workloads. With AWS Batch, there's no need to install or
250 manage batch computing software. This means that you can focus your
251 time and energy on analyzing results and solving your specific
252 problems.
253  
254 For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10>
255  
256  
257 =head1 METHODS
258  
259 =head2 CancelJob
260  
261 =over
262  
263 =item JobId => Str
264  
265 =item Reason => Str
266  
267  
268 =back
269  
270 Each argument is described in detail in: L<Paws::Batch::CancelJob>
271  
272 Returns: a L<Paws::Batch::CancelJobResponse> instance
273  
274 Cancels a job in an AWS Batch job queue. Jobs that are in the
275 C<SUBMITTED>, C<PENDING>, or C<RUNNABLE> state are canceled. Jobs that
276 have progressed to C<STARTING> or C<RUNNING> aren't canceled, but the
277 API operation still succeeds, even if no job is canceled. These jobs
278 must be terminated with the TerminateJob operation.
279  
280  
281 =head2 CreateComputeEnvironment
282  
283 =over
284  
285 =item ComputeEnvironmentName => Str
286  
287 =item Type => Str
288  
289 =item [ComputeResources => L<Paws::Batch::ComputeResource>]
290  
291 =item [ServiceRole => Str]
292  
293 =item [State => Str]
294  
295 =item [Tags => L<Paws::Batch::TagrisTagsMap>]
296  
297  
298 =back
299  
300 Each argument is described in detail in: L<Paws::Batch::CreateComputeEnvironment>
301  
302 Returns: a L<Paws::Batch::CreateComputeEnvironmentResponse> instance
303  
304 Creates an AWS Batch compute environment. You can create C<MANAGED> or
305 C<UNMANAGED> compute environments. C<MANAGED> compute environments can
306 use Amazon EC2 or AWS Fargate resources. C<UNMANAGED> compute
307 environments can only use EC2 resources.
308  
309 In a managed compute environment, AWS Batch manages the capacity and
310 instance types of the compute resources within the environment. This is
311 based on the compute resource specification that you define or the
312 launch template
313 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html)
314 that you specify when you create the compute environment. Either, you
315 can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or,
316 you can use Fargate and Fargate Spot capacity in your managed compute
317 environment. You can optionally set a maximum price so that Spot
318 Instances only launch when the Spot Instance price is less than a
319 specified percentage of the On-Demand price.
320  
321 Multi-node parallel jobs aren't supported on Spot Instances.
322  
323 In an unmanaged compute environment, you can manage your own EC2
324 compute resources and have a lot of flexibility with how you configure
325 your compute resources. For example, you can use custom AMIs. However,
326 you must verify that each of your AMIs meet the Amazon ECS container
327 instance AMI specification. For more information, see container
328 instance AMIs
329 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html)
330 in the I<Amazon Elastic Container Service Developer Guide>. After you
331 created your unmanaged compute environment, you can use the
332 DescribeComputeEnvironments operation to find the Amazon ECS cluster
333 that's associated with it. Then, launch your container instances into
334 that Amazon ECS cluster. For more information, see Launching an Amazon
335 ECS container instance
336 (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html)
337 in the I<Amazon Elastic Container Service Developer Guide>.
338  
339 AWS Batch doesn't upgrade the AMIs in a compute environment after the
340 environment is created. For example, it doesn't update the AMIs when a
341 newer version of the Amazon ECS optimized AMI is available. Therefore,
342 you're responsible for managing the guest operating system (including
343 its updates and security patches) and any additional application
344 software or utilities that you install on the compute resources. To use
345 a new AMI for your AWS Batch jobs, complete these steps:
346  
347 =over
348  
349 =item 1.
350  
351 Create a new compute environment with the new AMI.
352  
353 =item 2.
354  
355 Add the compute environment to an existing job queue.
356  
357 =item 3.
358  
359 Remove the earlier compute environment from your job queue.
360  
361 =item 4.
362  
363 Delete the earlier compute environment.
364  
365 =back
366  
367  
368  
369 =head2 CreateJobQueue
370  
371 =over
372  
373 =item ComputeEnvironmentOrder => ArrayRef[L<Paws::Batch::ComputeEnvironmentOrder>]
374  
375 =item JobQueueName => Str
376  
377 =item Priority => Int
378  
379 =item [State => Str]
380  
381 =item [Tags => L<Paws::Batch::TagrisTagsMap>]
382  
383  
384 =back
385  
386 Each argument is described in detail in: L<Paws::Batch::CreateJobQueue>
387  
388 Returns: a L<Paws::Batch::CreateJobQueueResponse> instance
389  
390 Creates an AWS Batch job queue. When you create a job queue, you
391 associate one or more compute environments to the queue and assign an
392 order of preference for the compute environments.
393  
394 You also set a priority to the job queue that determines the order that
395 the AWS Batch scheduler places jobs onto its associated compute
396 environments. For example, if a compute environment is associated with
397 more than one job queue, the job queue with a higher priority is given
398 preference for scheduling jobs to that compute environment.
399  
400  
401 =head2 DeleteComputeEnvironment
402  
403 =over
404  
405 =item ComputeEnvironment => Str
406  
407  
408 =back
409  
410 Each argument is described in detail in: L<Paws::Batch::DeleteComputeEnvironment>
411  
412 Returns: a L<Paws::Batch::DeleteComputeEnvironmentResponse> instance
413  
414 Deletes an AWS Batch compute environment.
415  
416 Before you can delete a compute environment, you must set its state to
417 C<DISABLED> with the UpdateComputeEnvironment API operation and
418 disassociate it from any job queues with the UpdateJobQueue API
419 operation. Compute environments that use AWS Fargate resources must
420 terminate all active jobs on that compute environment before deleting
421 the compute environment. If this isn't done, the compute environment
422 enters an invalid state.
423  
424  
425 =head2 DeleteJobQueue
426  
427 =over
428  
429 =item JobQueue => Str
430  
431  
432 =back
433  
434 Each argument is described in detail in: L<Paws::Batch::DeleteJobQueue>
435  
436 Returns: a L<Paws::Batch::DeleteJobQueueResponse> instance
437  
438 Deletes the specified job queue. You must first disable submissions for
439 a queue with the UpdateJobQueue operation. All jobs in the queue are
440 eventually terminated when you delete a job queue. The jobs are
441 terminated at a rate of about 16 jobs each second.
442  
443 It's not necessary to disassociate compute environments from a queue
444 before submitting a C<DeleteJobQueue> request.
445  
446  
447 =head2 DeregisterJobDefinition
448  
449 =over
450  
451 =item JobDefinition => Str
452  
453  
454 =back
455  
456 Each argument is described in detail in: L<Paws::Batch::DeregisterJobDefinition>
457  
458 Returns: a L<Paws::Batch::DeregisterJobDefinitionResponse> instance
459  
460 Deregisters an AWS Batch job definition. Job definitions are
461 permanently deleted after 180 days.
462  
463  
464 =head2 DescribeComputeEnvironments
465  
466 =over
467  
468 =item [ComputeEnvironments => ArrayRef[Str|Undef]]
469  
470 =item [MaxResults => Int]
471  
472 =item [NextToken => Str]
473  
474  
475 =back
476  
477 Each argument is described in detail in: L<Paws::Batch::DescribeComputeEnvironments>
478  
479 Returns: a L<Paws::Batch::DescribeComputeEnvironmentsResponse> instance
480  
481 Describes one or more of your compute environments.
482  
483 If you're using an unmanaged compute environment, you can use the
484 C<DescribeComputeEnvironment> operation to determine the
485 C<ecsClusterArn> that you should launch your Amazon ECS container
486 instances into.
487  
488  
489 =head2 DescribeJobDefinitions
490  
491 =over
492  
493 =item [JobDefinitionName => Str]
494  
495 =item [JobDefinitions => ArrayRef[Str|Undef]]
496  
497 =item [MaxResults => Int]
498  
499 =item [NextToken => Str]
500  
501 =item [Status => Str]
502  
503  
504 =back
505  
506 Each argument is described in detail in: L<Paws::Batch::DescribeJobDefinitions>
507  
508 Returns: a L<Paws::Batch::DescribeJobDefinitionsResponse> instance
509  
510 Describes a list of job definitions. You can specify a C<status> (such
511 as C<ACTIVE>) to only return job definitions that match that status.
512  
513  
514 =head2 DescribeJobQueues
515  
516 =over
517  
518 =item [JobQueues => ArrayRef[Str|Undef]]
519  
520 =item [MaxResults => Int]
521  
522 =item [NextToken => Str]
523  
524  
525 =back
526  
527 Each argument is described in detail in: L<Paws::Batch::DescribeJobQueues>
528  
529 Returns: a L<Paws::Batch::DescribeJobQueuesResponse> instance
530  
531 Describes one or more of your job queues.
532  
533  
534 =head2 DescribeJobs
535  
536 =over
537  
538 =item Jobs => ArrayRef[Str|Undef]
539  
540  
541 =back
542  
543 Each argument is described in detail in: L<Paws::Batch::DescribeJobs>
544  
545 Returns: a L<Paws::Batch::DescribeJobsResponse> instance
546  
547 Describes a list of AWS Batch jobs.
548  
549  
550 =head2 ListJobs
551  
552 =over
553  
554 =item [ArrayJobId => Str]
555  
556 =item [JobQueue => Str]
557  
558 =item [JobStatus => Str]
559  
560 =item [MaxResults => Int]
561  
562 =item [MultiNodeJobId => Str]
563  
564 =item [NextToken => Str]
565  
566  
567 =back
568  
569 Each argument is described in detail in: L<Paws::Batch::ListJobs>
570  
571 Returns: a L<Paws::Batch::ListJobsResponse> instance
572  
573 Returns a list of AWS Batch jobs.
574  
575 You must specify only one of the following items:
576  
577 =over
578  
579 =item *
580  
581 A job queue ID to return a list of jobs in that job queue
582  
583 =item *
584  
585 A multi-node parallel job ID to return a list of nodes for that job
586  
587 =item *
588  
589 An array job ID to return a list of the children for that job
590  
591 =back
592  
593 You can filter the results by job status with the C<jobStatus>
594 parameter. If you don't specify a status, only C<RUNNING> jobs are
595 returned.
596  
597  
598 =head2 ListTagsForResource
599  
600 =over
601  
602 =item ResourceArn => Str
603  
604  
605 =back
606  
607 Each argument is described in detail in: L<Paws::Batch::ListTagsForResource>
608  
609 Returns: a L<Paws::Batch::ListTagsForResourceResponse> instance
610  
611 Lists the tags for an AWS Batch resource. AWS Batch resources that
612 support tags are compute environments, jobs, job definitions, and job
613 queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs
614 are not supported.
615  
616  
617 =head2 RegisterJobDefinition
618  
619 =over
620  
621 =item JobDefinitionName => Str
622  
623 =item Type => Str
624  
625 =item [ContainerProperties => L<Paws::Batch::ContainerProperties>]
626  
627 =item [NodeProperties => L<Paws::Batch::NodeProperties>]
628  
629 =item [Parameters => L<Paws::Batch::ParametersMap>]
630  
631 =item [PlatformCapabilities => ArrayRef[Str|Undef]]
632  
633 =item [PropagateTags => Bool]
634  
635 =item [RetryStrategy => L<Paws::Batch::RetryStrategy>]
636  
637 =item [Tags => L<Paws::Batch::TagrisTagsMap>]
638  
639 =item [Timeout => L<Paws::Batch::JobTimeout>]
640  
641  
642 =back
643  
644 Each argument is described in detail in: L<Paws::Batch::RegisterJobDefinition>
645  
646 Returns: a L<Paws::Batch::RegisterJobDefinitionResponse> instance
647  
648 Registers an AWS Batch job definition.
649  
650  
651 =head2 SubmitJob
652  
653 =over
654  
655 =item JobDefinition => Str
656  
657 =item JobName => Str
658  
659 =item JobQueue => Str
660  
661 =item [ArrayProperties => L<Paws::Batch::ArrayProperties>]
662  
663 =item [ContainerOverrides => L<Paws::Batch::ContainerOverrides>]
664  
665 =item [DependsOn => ArrayRef[L<Paws::Batch::JobDependency>]]
666  
667 =item [NodeOverrides => L<Paws::Batch::NodeOverrides>]
668  
669 =item [Parameters => L<Paws::Batch::ParametersMap>]
670  
671 =item [PropagateTags => Bool]
672  
673 =item [RetryStrategy => L<Paws::Batch::RetryStrategy>]
674  
675 =item [Tags => L<Paws::Batch::TagrisTagsMap>]
676  
677 =item [Timeout => L<Paws::Batch::JobTimeout>]
678  
679  
680 =back
681  
682 Each argument is described in detail in: L<Paws::Batch::SubmitJob>
683  
684 Returns: a L<Paws::Batch::SubmitJobResponse> instance
685  
686 Submits an AWS Batch job from a job definition. Parameters that are
687 specified during SubmitJob override parameters defined in the job
688 definition. vCPU and memory requirements that are specified in the
689 C<ResourceRequirements> objects in the job definition are the
690 exception. They can't be overridden this way using the C<memory> and
691 C<vcpus> parameters. Rather, you must specify updates to job definition
692 parameters in a C<ResourceRequirements> object that's included in the
693 C<containerOverrides> parameter.
694  
695 Jobs that run on Fargate resources can't be guaranteed to run for more
696 than 14 days. This is because, after 14 days, Fargate resources might
697 become unavailable and job might be terminated.
698  
699  
700 =head2 TagResource
701  
702 =over
703  
704 =item ResourceArn => Str
705  
706 =item Tags => L<Paws::Batch::TagrisTagsMap>
707  
708  
709 =back
710  
711 Each argument is described in detail in: L<Paws::Batch::TagResource>
712  
713 Returns: a L<Paws::Batch::TagResourceResponse> instance
714  
715 Associates the specified tags to a resource with the specified
716 C<resourceArn>. If existing tags on a resource aren't specified in the
717 request parameters, they aren't changed. When a resource is deleted,
718 the tags associated with that resource are deleted as well. AWS Batch
719 resources that support tags are compute environments, jobs, job
720 definitions, and job queues. ARNs for child jobs of array and
721 multi-node parallel (MNP) jobs are not supported.
722  
723  
724 =head2 TerminateJob
725  
726 =over
727  
728 =item JobId => Str
729  
730 =item Reason => Str
731  
732  
733 =back
734  
735 Each argument is described in detail in: L<Paws::Batch::TerminateJob>
736  
737 Returns: a L<Paws::Batch::TerminateJobResponse> instance
738  
739 Terminates a job in a job queue. Jobs that are in the C<STARTING> or
740 C<RUNNING> state are terminated, which causes them to transition to
741 C<FAILED>. Jobs that have not progressed to the C<STARTING> state are
742 cancelled.
743  
744  
745 =head2 UntagResource
746  
747 =over
748  
749 =item ResourceArn => Str
750  
751 =item TagKeys => ArrayRef[Str|Undef]
752  
753  
754 =back
755  
756 Each argument is described in detail in: L<Paws::Batch::UntagResource>
757  
758 Returns: a L<Paws::Batch::UntagResourceResponse> instance
759  
760 Deletes specified tags from an AWS Batch resource.
761  
762  
763 =head2 UpdateComputeEnvironment
764  
765 =over
766  
767 =item ComputeEnvironment => Str
768  
769 =item [ComputeResources => L<Paws::Batch::ComputeResourceUpdate>]
770  
771 =item [ServiceRole => Str]
772  
773 =item [State => Str]
774  
775  
776 =back
777  
778 Each argument is described in detail in: L<Paws::Batch::UpdateComputeEnvironment>
779  
780 Returns: a L<Paws::Batch::UpdateComputeEnvironmentResponse> instance
781  
782 Updates an AWS Batch compute environment.
783  
784  
785 =head2 UpdateJobQueue
786  
787 =over
788  
789 =item JobQueue => Str
790  
791 =item [ComputeEnvironmentOrder => ArrayRef[L<Paws::Batch::ComputeEnvironmentOrder>]]
792  
793 =item [Priority => Int]
794  
795 =item [State => Str]
796  
797  
798 =back
799  
800 Each argument is described in detail in: L<Paws::Batch::UpdateJobQueue>
801  
802 Returns: a L<Paws::Batch::UpdateJobQueueResponse> instance
803  
804 Updates a job queue.
805  
806  
807  
808  
809 =head1 PAGINATORS
810  
811 Paginator methods are helpers that repetively call methods that return partial results
812  
813 =head2 DescribeAllComputeEnvironments(sub { },[ComputeEnvironments => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])
814  
815 =head2 DescribeAllComputeEnvironments([ComputeEnvironments => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])
816  
817  
818 If passed a sub as first parameter, it will call the sub for each element found in :
819  
820 - computeEnvironments, passing the object as the first parameter, and the string 'computeEnvironments' as the second parameter
821  
822 If not, it will return a a L<Paws::Batch::DescribeComputeEnvironmentsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
823  
824  
825 =head2 DescribeAllJobDefinitions(sub { },[JobDefinitionName => Str, JobDefinitions => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str, Status => Str])
826  
827 =head2 DescribeAllJobDefinitions([JobDefinitionName => Str, JobDefinitions => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str, Status => Str])
828  
829  
830 If passed a sub as first parameter, it will call the sub for each element found in :
831  
832 - jobDefinitions, passing the object as the first parameter, and the string 'jobDefinitions' as the second parameter
833  
834 If not, it will return a a L<Paws::Batch::DescribeJobDefinitionsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
835  
836  
837 =head2 DescribeAllJobQueues(sub { },[JobQueues => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])
838  
839 =head2 DescribeAllJobQueues([JobQueues => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])
840  
841  
842 If passed a sub as first parameter, it will call the sub for each element found in :
843  
844 - jobQueues, passing the object as the first parameter, and the string 'jobQueues' as the second parameter
845  
846 If not, it will return a a L<Paws::Batch::DescribeJobQueuesResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
847  
848  
849 =head2 ListAllJobs(sub { },[ArrayJobId => Str, JobQueue => Str, JobStatus => Str, MaxResults => Int, MultiNodeJobId => Str, NextToken => Str])
850  
851 =head2 ListAllJobs([ArrayJobId => Str, JobQueue => Str, JobStatus => Str, MaxResults => Int, MultiNodeJobId => Str, NextToken => Str])
852  
853  
854 If passed a sub as first parameter, it will call the sub for each element found in :
855  
856 - jobSummaryList, passing the object as the first parameter, and the string 'jobSummaryList' as the second parameter
857  
858 If not, it will return a a L<Paws::Batch::ListJobsResponse> instance with all the C<param>s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.
859  
860  
861  
862  
863  
864 =head1 SEE ALSO
865  
866 This service class forms part of L<Paws>
867  
868 =head1 BUGS and CONTRIBUTIONS
869  
870 The source code is located here: L<https://github.com/pplu/aws-sdk-perl>
871  
872 Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues>
873  
874 =cut
875  
« blib/lib/Paws/Lambda.pm ↑ Summary blib/lib/Paws/CloudTrail.pm »