NAME

Paws::Batch - Perl Interface to AWS AWS Batch

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Batch');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

AWS Batch enables you to run batch computing workloads on the AWS Cloud. Batch computing is a common way for developers, scientists, and engineers to access large amounts of compute resources, and AWS Batch removes the undifferentiated heavy lifting of configuring and managing the required infrastructure. AWS Batch will be familiar to users of traditional batch computing software. This service can efficiently provision resources in response to jobs submitted in order to eliminate capacity constraints, reduce compute costs, and deliver results quickly.

As a fully managed service, AWS Batch enables developers, scientists, and engineers to run batch computing workloads of any scale. AWS Batch automatically provisions compute resources and optimizes the workload distribution based on the quantity and scale of the workloads. With AWS Batch, there is no need to install or manage batch computing software, which allows you to focus on analyzing results and solving problems. AWS Batch reduces operational complexities, saves time, and reduces costs, which makes it easy for developers, scientists, and engineers to run their batch jobs in the AWS Cloud.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/batch-2016-08-10

METHODS

CancelJob

JobId => Str
Reason => Str

Each argument is described in detail in: Paws::Batch::CancelJob

Returns: a Paws::Batch::CancelJobResponse instance

Cancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are cancelled. Jobs that have progressed to STARTING or RUNNING are not cancelled (but the API operation still succeeds, even if no job is cancelled); these jobs must be terminated with the TerminateJob operation.

CreateComputeEnvironment

ComputeEnvironmentName => Str
ServiceRole => Str
Type => Str
[ComputeResources => Paws::Batch::ComputeResource]
[State => Str]

Each argument is described in detail in: Paws::Batch::CreateComputeEnvironment

Returns: a Paws::Batch::CreateComputeEnvironmentResponse instance

Creates an AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments.

In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template (http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) that you specify when you create the compute environment. You can choose to use Amazon EC2 On-Demand Instances or Spot Instances in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price.

Multi-node parallel jobs are not supported on Spot Instances.

In an unmanaged compute environment, you can manage your own compute resources. This provides more compute resource configuration options, such as using a custom AMI, but you must ensure that your AMI meets the Amazon ECS container instance AMI specification. For more information, see Container Instance AMIs (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html) in the Amazon Elastic Container Service Developer Guide. After you have created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that is associated with it. Then, manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS Container Instance (http://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html) in the Amazon Elastic Container Service Developer Guide.

AWS Batch does not upgrade the AMIs in a compute environment after it is created (for example, when a newer version of the Amazon ECS-optimized AMI is available). You are responsible for the management of the guest operating system (including updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your AWS Batch jobs:

  1. Create a new compute environment with the new AMI.

  2. Add the compute environment to an existing job queue.

  3. Remove the old compute environment from your job queue.

  4. Delete the old compute environment.

CreateJobQueue

ComputeEnvironmentOrder => ArrayRef[Paws::Batch::ComputeEnvironmentOrder]
JobQueueName => Str
Priority => Int
[State => Str]

Each argument is described in detail in: Paws::Batch::CreateJobQueue

Returns: a Paws::Batch::CreateJobQueueResponse instance

Creates an AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.

You also set a priority to the job queue that determines the order in which the AWS Batch scheduler places jobs onto its associated compute environments. For example, if a compute environment is associated with more than one job queue, the job queue with a higher priority is given preference for scheduling jobs to that compute environment.

DeleteComputeEnvironment

ComputeEnvironment => Str

Each argument is described in detail in: Paws::Batch::DeleteComputeEnvironment

Returns: a Paws::Batch::DeleteComputeEnvironmentResponse instance

Deletes an AWS Batch compute environment.

Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation.

DeleteJobQueue

JobQueue => Str

Each argument is described in detail in: Paws::Batch::DeleteJobQueue

Returns: a Paws::Batch::DeleteJobQueueResponse instance

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are terminated when you delete a job queue.

It is not necessary to disassociate compute environments from a queue before submitting a DeleteJobQueue request.

DeregisterJobDefinition

JobDefinition => Str

Each argument is described in detail in: Paws::Batch::DeregisterJobDefinition

Returns: a Paws::Batch::DeregisterJobDefinitionResponse instance

Deregisters an AWS Batch job definition.

DescribeComputeEnvironments

[ComputeEnvironments => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Batch::DescribeComputeEnvironments

Returns: a Paws::Batch::DescribeComputeEnvironmentsResponse instance

Describes one or more of your compute environments.

If you are using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.

DescribeJobDefinitions

[JobDefinitionName => Str]
[JobDefinitions => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]
[Status => Str]

Each argument is described in detail in: Paws::Batch::DescribeJobDefinitions

Returns: a Paws::Batch::DescribeJobDefinitionsResponse instance

Describes a list of job definitions. You can specify a status (such as ACTIVE) to only return job definitions that match that status.

DescribeJobQueues

[JobQueues => ArrayRef[Str|Undef]]
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Batch::DescribeJobQueues

Returns: a Paws::Batch::DescribeJobQueuesResponse instance

Describes one or more of your job queues.

DescribeJobs

Jobs => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Batch::DescribeJobs

Returns: a Paws::Batch::DescribeJobsResponse instance

Describes a list of AWS Batch jobs.

ListJobs

[ArrayJobId => Str]
[JobQueue => Str]
[JobStatus => Str]
[MaxResults => Int]
[MultiNodeJobId => Str]
[NextToken => Str]

Each argument is described in detail in: Paws::Batch::ListJobs

Returns: a Paws::Batch::ListJobsResponse instance

Returns a list of AWS Batch jobs.

You must specify only one of the following:

  • a job queue ID to return a list of jobs in that job queue

  • a multi-node parallel job ID to return a list of that job's nodes

  • an array job ID to return a list of that job's children

You can filter the results by job status with the jobStatus parameter. If you do not specify a status, only RUNNING jobs are returned.

RegisterJobDefinition

JobDefinitionName => Str
Type => Str
[ContainerProperties => Paws::Batch::ContainerProperties]
[NodeProperties => Paws::Batch::NodeProperties]
[Parameters => Paws::Batch::ParametersMap]
[RetryStrategy => Paws::Batch::RetryStrategy]
[Timeout => Paws::Batch::JobTimeout]

Each argument is described in detail in: Paws::Batch::RegisterJobDefinition

Returns: a Paws::Batch::RegisterJobDefinitionResponse instance

Registers an AWS Batch job definition.

SubmitJob

JobDefinition => Str
JobName => Str
JobQueue => Str
[ArrayProperties => Paws::Batch::ArrayProperties]
[ContainerOverrides => Paws::Batch::ContainerOverrides]
[DependsOn => ArrayRef[Paws::Batch::JobDependency]]
[NodeOverrides => Paws::Batch::NodeOverrides]
[Parameters => Paws::Batch::ParametersMap]
[RetryStrategy => Paws::Batch::RetryStrategy]
[Timeout => Paws::Batch::JobTimeout]

Each argument is described in detail in: Paws::Batch::SubmitJob

Returns: a Paws::Batch::SubmitJobResponse instance

Submits an AWS Batch job from a job definition. Parameters specified during SubmitJob override parameters defined in the job definition.

TerminateJob

JobId => Str
Reason => Str

Each argument is described in detail in: Paws::Batch::TerminateJob

Returns: a Paws::Batch::TerminateJobResponse instance

Terminates a job in a job queue. Jobs that are in the STARTING or RUNNING state are terminated, which causes them to transition to FAILED. Jobs that have not progressed to the STARTING state are cancelled.

UpdateComputeEnvironment

ComputeEnvironment => Str
[ComputeResources => Paws::Batch::ComputeResourceUpdate]
[ServiceRole => Str]
[State => Str]

Each argument is described in detail in: Paws::Batch::UpdateComputeEnvironment

Returns: a Paws::Batch::UpdateComputeEnvironmentResponse instance

Updates an AWS Batch compute environment.

UpdateJobQueue

JobQueue => Str
[ComputeEnvironmentOrder => ArrayRef[Paws::Batch::ComputeEnvironmentOrder]]
[Priority => Int]
[State => Str]

Each argument is described in detail in: Paws::Batch::UpdateJobQueue

Returns: a Paws::Batch::UpdateJobQueueResponse instance

Updates a job queue.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

DescribeAllComputeEnvironments(sub { },[ComputeEnvironments => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])

DescribeAllComputeEnvironments([ComputeEnvironments => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - computeEnvironments, passing the object as the first parameter, and the string 'computeEnvironments' as the second parameter 

If not, it will return a a Paws::Batch::DescribeComputeEnvironmentsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllJobDefinitions(sub { },[JobDefinitionName => Str, JobDefinitions => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str, Status => Str])

DescribeAllJobDefinitions([JobDefinitionName => Str, JobDefinitions => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str, Status => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - jobDefinitions, passing the object as the first parameter, and the string 'jobDefinitions' as the second parameter 

If not, it will return a a Paws::Batch::DescribeJobDefinitionsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

DescribeAllJobQueues(sub { },[JobQueues => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])

DescribeAllJobQueues([JobQueues => ArrayRef[Str|Undef], MaxResults => Int, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - jobQueues, passing the object as the first parameter, and the string 'jobQueues' as the second parameter 

If not, it will return a a Paws::Batch::DescribeJobQueuesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllJobs(sub { },[ArrayJobId => Str, JobQueue => Str, JobStatus => Str, MaxResults => Int, MultiNodeJobId => Str, NextToken => Str])

ListAllJobs([ArrayJobId => Str, JobQueue => Str, JobStatus => Str, MaxResults => Int, MultiNodeJobId => Str, NextToken => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

 - jobSummaryList, passing the object as the first parameter, and the string 'jobSummaryList' as the second parameter 

If not, it will return a a Paws::Batch::ListJobsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues