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.

METHODS

CancelJob(JobId => Str, Reason => Str)

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

Returns: a Paws::Batch::CancelJobResponse instance

Cancels jobs in an AWS Batch job queue. Jobs that are in the
C<SUBMITTED>, C<PENDING>, or C<RUNNABLE> state are cancelled. Jobs that
have progressed to C<STARTING> or C<RUNNING> are not cancelled (but the
API operation still succeeds, even if no jobs are 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 C<MANAGED> or
C<UNMANAGED> compute environments.

In a managed compute environment, AWS Batch manages the compute resources within the environment, based on the compute resources that you specify. Instances launched into a managed compute environment use a recent, approved version of the Amazon ECS-optimized AMI. You can choose to use Amazon EC2 On-Demand instances in your managed compute environment, or you can use Amazon EC2 Spot instances that only launch when the Spot bid price is below a specified percentage of the On-Demand price.

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 in the Amazon EC2 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 and then manually launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS Container Instance in the Amazon EC2 Container Service Developer Guide.

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 C<status> (such
as C<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(JobQueue => Str, [JobStatus => Str, MaxResults => Int, NextToken => Str])

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

Returns: a Paws::Batch::ListJobsResponse instance

Returns a list of task jobs for a specified job queue. You can filter
the results by job status with the C<jobStatus> parameter. If you do
not specify a status, only C<RUNNING> jobs are returned.

RegisterJobDefinition(JobDefinitionName => Str, Type => Str, [ContainerProperties => Paws::Batch::ContainerProperties, Parameters => Paws::Batch::ParametersMap, RetryStrategy => Paws::Batch::RetryStrategy])

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, [ContainerOverrides => Paws::Batch::ContainerOverrides, DependsOn => ArrayRef[Paws::Batch::JobDependency], Parameters => Paws::Batch::ParametersMap, RetryStrategy => Paws::Batch::RetryStrategy])

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 jobs in a job queue. Jobs that are in the C<STARTING> or
C<RUNNING> state are terminated, which causes them to transition to
C<FAILED>. Jobs that have not progressed to the C<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

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