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 canceled. Jobs that have progressed to "STARTING" or "RUNNING" aren't canceled, but the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.

CreateComputeEnvironment

ComputeEnvironmentName => Str

Type => Str

[ComputeResources => Paws::Batch::ComputeResource]

[ServiceRole => Str]

[State => Str]

[Tags => Paws::Batch::TagrisTagsMap]

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. "MANAGED" compute environments can use Amazon EC2 or AWS Fargate resources. "UNMANAGED" compute environments can only use EC2 resources.

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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-launch-templates.html) that you specify when you create the compute environment. Either, you can choose to use EC2 On-Demand Instances and EC2 Spot Instances. Or, you can use Fargate and Fargate Spot capacity in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is less than a specified percentage of the On-Demand price.

Multi-node parallel jobs aren't supported on Spot Instances.

In an unmanaged compute environment, you can manage your own EC2 compute resources and have a lot of flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/container_instance_AMIs.html) in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance (https://docs.aws.amazon.com/AmazonECS/latest/developerguide/launch_container_instance.html) in the Amazon Elastic Container Service Developer Guide.

AWS Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible for managing the guest operating system (including its 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, complete these steps:

1.

Create a new compute environment with the new AMI.

2.

Add the compute environment to an existing job queue.

3.

Remove the earlier compute environment from your job queue.

4.

Delete the earlier compute environment.

CreateJobQueue

ComputeEnvironmentOrder => ArrayRef[Paws::Batch::ComputeEnvironmentOrder]

JobQueueName => Str

Priority => Int

[State => Str]

[Tags => Paws::Batch::TagrisTagsMap]

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 that 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. Compute environments that use AWS Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment enters an invalid state.

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 eventually terminated when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each second.

It's 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. Job definitions are permanently deleted after 180 days.

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're 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 items:

• 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 nodes for that job
• An array job ID to return a list of the children for that job

You can filter the results by job status with the "jobStatus" parameter. If you don't specify a status, only "RUNNING" jobs are returned.

ListTagsForResource

ResourceArn => Str

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

Returns: a Paws::Batch::ListTagsForResourceResponse instance

Lists the tags for an AWS Batch resource. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

RegisterJobDefinition

JobDefinitionName => Str

Type => Str

[ContainerProperties => Paws::Batch::ContainerProperties]

[NodeProperties => Paws::Batch::NodeProperties]

[Parameters => Paws::Batch::ParametersMap]

[PlatformCapabilities => ArrayRef[Str|Undef]]

[PropagateTags => Bool]

[RetryStrategy => Paws::Batch::RetryStrategy]

[Tags => Paws::Batch::TagrisTagsMap]

[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]

[PropagateTags => Bool]

[RetryStrategy => Paws::Batch::RetryStrategy]

[Tags => Paws::Batch::TagrisTagsMap]

[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 that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the "ResourceRequirements" objects in the job definition are the exception. They can't be overridden this way using the "memory" and "vcpus" parameters. Rather, you must specify updates to job definition parameters in a "ResourceRequirements" object that's included in the "containerOverrides" parameter.

Jobs that run on Fargate resources can't be guaranteed to run for more than 14 days. This is because, after 14 days, Fargate resources might become unavailable and job might be terminated.

TagResource

ResourceArn => Str

Tags => Paws::Batch::TagrisTagsMap

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

Returns: a Paws::Batch::TagResourceResponse instance

Associates the specified tags to a resource with the specified "resourceArn". If existing tags on a resource aren't specified in the request parameters, they aren't changed. When a resource is deleted, the tags associated with that resource are deleted as well. AWS Batch resources that support tags are compute environments, jobs, job definitions, and job queues. ARNs for child jobs of array and multi-node parallel (MNP) jobs are not supported.

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.

UntagResource

ResourceArn => Str

TagKeys => ArrayRef[Str|Undef]

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

Returns: a Paws::Batch::UntagResourceResponse instance

Deletes specified tags from an AWS Batch resource.

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.

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 "param"s; 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 "param"s; 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 "param"s; 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 "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.