SDK for PHP 3.x

Client: Aws\Batch\BatchClient
Service ID: batch
Version: 2016-08-10

This page describes the parameters and results for the operations of the AWS Batch (2016-08-10), and shows how to use the Aws\Batch\BatchClient object to call the described operations. This documentation is specific to the 2016-08-10 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

CancelJob ( array $params = [] )
Cancels a job in an Batch job queue.
CreateComputeEnvironment ( array $params = [] )
Creates an Batch compute environment.
CreateJobQueue ( array $params = [] )
Creates an Batch job queue.
CreateSchedulingPolicy ( array $params = [] )
Creates an Batch scheduling policy.
DeleteComputeEnvironment ( array $params = [] )
Deletes an Batch compute environment.
DeleteJobQueue ( array $params = [] )
Deletes the specified job queue.
DeleteSchedulingPolicy ( array $params = [] )
Deletes the specified scheduling policy.
DeregisterJobDefinition ( array $params = [] )
Deregisters an Batch job definition.
DescribeComputeEnvironments ( array $params = [] )
Describes one or more of your compute environments.
DescribeJobDefinitions ( array $params = [] )
Describes a list of job definitions.
DescribeJobQueues ( array $params = [] )
Describes one or more of your job queues.
DescribeJobs ( array $params = [] )
Describes a list of Batch jobs.
DescribeSchedulingPolicies ( array $params = [] )
Describes one or more of your scheduling policies.
ListJobs ( array $params = [] )
Returns a list of Batch jobs.
ListSchedulingPolicies ( array $params = [] )
Returns a list of Batch scheduling policies.
ListTagsForResource ( array $params = [] )
Lists the tags for an Batch resource.
RegisterJobDefinition ( array $params = [] )
Registers an Batch job definition.
SubmitJob ( array $params = [] )
Submits an Batch job from a job definition.
TagResource ( array $params = [] )
Associates the specified tags to a resource with the specified resourceArn.
TerminateJob ( array $params = [] )
Terminates a job in a job queue.
UntagResource ( array $params = [] )
Deletes specified tags from an Batch resource.
UpdateComputeEnvironment ( array $params = [] )
Updates an Batch compute environment.
UpdateJobQueue ( array $params = [] )
Updates a job queue.
UpdateSchedulingPolicy ( array $params = [] )
Updates a scheduling policy.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

DescribeComputeEnvironments
DescribeJobDefinitions
DescribeJobQueues
ListJobs
ListSchedulingPolicies

Operations

CancelJob

$result = $client->cancelJob([/* ... */]);
$promise = $client->cancelJobAsync([/* ... */]);

Cancels a job in an Batch job queue. Jobs that are in the SUBMITTED or PENDING are canceled. A job inRUNNABLE remains in RUNNABLE until it reaches the head of the job queue. Then the job status is updated to FAILED.

A PENDING job is canceled after all dependency jobs are completed. Therefore, it may take longer than expected to cancel a job in PENDING status.

When you try to cancel an array parent job in PENDING, Batch attempts to cancel all child jobs. The array parent job is canceled when all child jobs are completed.

Jobs that progressed to the STARTING or RUNNING state aren't canceled. However, the API operation still succeeds, even if no job is canceled. These jobs must be terminated with the TerminateJob operation.

Parameter Syntax

$result = $client->cancelJob([
    'jobId' => '<string>', // REQUIRED
    'reason' => '<string>', // REQUIRED
]);

Parameter Details

Members
jobId
Required: Yes
Type: string

The Batch job ID of the job to cancel.

reason
Required: Yes
Type: string

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To cancel a job

This example cancels a job with the specified job ID.

$result = $client->cancelJob([
    'jobId' => '1d828f65-7a4d-42e8-996d-3b900ed59dc4',
    'reason' => 'Cancelling job.',
]);

Result syntax:

[
]

CreateComputeEnvironment

$result = $client->createComputeEnvironment([/* ... */]);
$promise = $client->createComputeEnvironmentAsync([/* ... */]);

Creates an Batch compute environment. You can create MANAGED or UNMANAGED compute environments. MANAGED compute environments can use Amazon EC2 or Fargate resources. UNMANAGED compute environments can only use EC2 resources.

In a managed compute environment, 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 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 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 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 in the Amazon Elastic Container Service Developer Guide.

To create a compute environment that uses EKS resources, the caller must have permissions to call eks:DescribeCluster.

Batch doesn't automatically upgrade the AMIs in a compute environment after it's created. For example, it also doesn't update the AMIs in your compute environment when a newer version of the Amazon ECS optimized AMI is available. You're responsible for the management of the guest operating system. This includes any updates and security patches. You're also responsible for any additional application software or utilities that you install on the compute resources. There are two ways to use a new AMI for your Batch jobs. The original method is to 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.

In April 2022, Batch added enhanced support for updating compute environments. For more information, see Updating compute environments. To use the enhanced updating of compute environments to update AMIs, follow these rules:

  • Either don't set the service role (serviceRole) parameter or set it to the AWSBatchServiceRole service-linked role.

  • Set the allocation strategy (allocationStrategy) parameter to BEST_FIT_PROGRESSIVE, SPOT_CAPACITY_OPTIMIZED, or SPOT_PRICE_CAPACITY_OPTIMIZED.

  • Set the update to latest image version (updateToLatestImageVersion) parameter to true. The updateToLatestImageVersion parameter is used when you update a compute environment. This parameter is ignored when you create a compute environment.

  • Don't specify an AMI ID in imageId, imageIdOverride (in ec2Configuration ), or in the launch template (launchTemplate). In that case, Batch selects the latest Amazon ECS optimized AMI that's supported by Batch at the time the infrastructure update is initiated. Alternatively, you can specify the AMI ID in the imageId or imageIdOverride parameters, or the launch template identified by the LaunchTemplate properties. Changing any of these properties starts an infrastructure update. If the AMI ID is specified in the launch template, it can't be replaced by specifying an AMI ID in either the imageId or imageIdOverride parameters. It can only be replaced by specifying a different launch template, or if the launch template version is set to $Default or $Latest, by setting either a new default version for the launch template (if $Default) or by adding a new version to the launch template (if $Latest).

If these rules are followed, any update that starts an infrastructure update causes the AMI ID to be re-selected. If the version setting in the launch template (launchTemplate) is set to $Latest or $Default, the latest or default version of the launch template is evaluated up at the time of the infrastructure update, even if the launchTemplate wasn't updated.

Parameter Syntax

$result = $client->createComputeEnvironment([
    'computeEnvironmentName' => '<string>', // REQUIRED
    'computeResources' => [
        'allocationStrategy' => 'BEST_FIT|BEST_FIT_PROGRESSIVE|SPOT_CAPACITY_OPTIMIZED|SPOT_PRICE_CAPACITY_OPTIMIZED',
        'bidPercentage' => <integer>,
        'desiredvCpus' => <integer>,
        'ec2Configuration' => [
            [
                'imageIdOverride' => '<string>',
                'imageKubernetesVersion' => '<string>',
                'imageType' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ec2KeyPair' => '<string>',
        'imageId' => '<string>',
        'instanceRole' => '<string>',
        'instanceTypes' => ['<string>', ...],
        'launchTemplate' => [
            'launchTemplateId' => '<string>',
            'launchTemplateName' => '<string>',
            'version' => '<string>',
        ],
        'maxvCpus' => <integer>, // REQUIRED
        'minvCpus' => <integer>,
        'placementGroup' => '<string>',
        'securityGroupIds' => ['<string>', ...],
        'spotIamFleetRole' => '<string>',
        'subnets' => ['<string>', ...], // REQUIRED
        'tags' => ['<string>', ...],
        'type' => 'EC2|SPOT|FARGATE|FARGATE_SPOT', // REQUIRED
    ],
    'eksConfiguration' => [
        'eksClusterArn' => '<string>', // REQUIRED
        'kubernetesNamespace' => '<string>', // REQUIRED
    ],
    'serviceRole' => '<string>',
    'state' => 'ENABLED|DISABLED',
    'tags' => ['<string>', ...],
    'type' => 'MANAGED|UNMANAGED', // REQUIRED
    'unmanagedvCpus' => <integer>,
]);

Parameter Details

Members
computeEnvironmentName
Required: Yes
Type: string

The name for your compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

computeResources
Type: ComputeResource structure

Details about the compute resources managed by the compute environment. This parameter is required for managed compute environments. For more information, see Compute Environments in the Batch User Guide.

eksConfiguration
Type: EksConfiguration structure

The details for the Amazon EKS cluster that supports the compute environment.

serviceRole
Type: string

The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

If your account already created the Batch service-linked role, that role is used by default for your compute environment unless you specify a different role here. If the Batch service-linked role doesn't exist in your account, and no role is specified here, the service attempts to create the Batch service-linked role in your account.

If your specified role has a path other than /, then you must specify either the full role ARN (recommended) or prefix the role name with the path. For example, if a role with the name bar has a path of /foo/, specify /foo/bar as the role name. For more information, see Friendly names and paths in the IAM User Guide.

Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

state
Type: string

The state of the compute environment. If the state is ENABLED, then the compute environment accepts jobs from a queue and can scale out automatically based on queues.

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out.

Compute environments in a DISABLED state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.

When an instance is idle, the instance scales down to the minvCpus value. However, the instance size doesn't change. For example, consider a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus value of 36. This instance doesn't scale down to a c5.large instance.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags that you apply to the compute environment to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations. These tags don't propagate to the underlying compute resources.

type
Required: Yes
Type: string

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute Environments in the Batch User Guide.

unmanagedvCpus
Type: int

The maximum number of vCPUs for an unmanaged compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.

This parameter is only supported when the type parameter is set to UNMANAGED.

Result Syntax

[
    'computeEnvironmentArn' => '<string>',
    'computeEnvironmentName' => '<string>',
]

Result Details

Members
computeEnvironmentArn
Type: string

The Amazon Resource Name (ARN) of the compute environment.

computeEnvironmentName
Type: string

The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To create a managed EC2 compute environment

This example creates a managed compute environment with specific C4 instance types that are launched on demand. The compute environment is called C4OnDemand.

$result = $client->createComputeEnvironment([
    'type' => 'MANAGED',
    'computeEnvironmentName' => 'C4OnDemand',
    'computeResources' => [
        'type' => 'EC2',
        'desiredvCpus' => 48,
        'ec2KeyPair' => 'id_rsa',
        'instanceRole' => 'ecsInstanceRole',
        'instanceTypes' => [
            'c4.large',
            'c4.xlarge',
            'c4.2xlarge',
            'c4.4xlarge',
            'c4.8xlarge',
        ],
        'maxvCpus' => 128,
        'minvCpus' => 0,
        'securityGroupIds' => [
            'sg-cf5093b2',
        ],
        'subnets' => [
            'subnet-220c0e0a',
            'subnet-1a95556d',
            'subnet-978f6dce',
        ],
        'tags' => [
            'Name' => 'Batch Instance - C4OnDemand',
        ],
    ],
    'serviceRole' => 'arn:aws:iam::012345678910:role/AWSBatchServiceRole',
    'state' => 'ENABLED',
]);

Result syntax:

[
    'computeEnvironmentArn' => 'arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand',
    'computeEnvironmentName' => 'C4OnDemand',
]
Example 2: To create a managed EC2 Spot compute environment

This example creates a managed compute environment with the M4 instance type that is launched when the Spot bid price is at or below 20% of the On-Demand price for the instance type. The compute environment is called M4Spot.

$result = $client->createComputeEnvironment([
    'type' => 'MANAGED',
    'computeEnvironmentName' => 'M4Spot',
    'computeResources' => [
        'type' => 'SPOT',
        'bidPercentage' => 20,
        'desiredvCpus' => 4,
        'ec2KeyPair' => 'id_rsa',
        'instanceRole' => 'ecsInstanceRole',
        'instanceTypes' => [
            'm4',
        ],
        'maxvCpus' => 128,
        'minvCpus' => 0,
        'securityGroupIds' => [
            'sg-cf5093b2',
        ],
        'spotIamFleetRole' => 'arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role',
        'subnets' => [
            'subnet-220c0e0a',
            'subnet-1a95556d',
            'subnet-978f6dce',
        ],
        'tags' => [
            'Name' => 'Batch Instance - M4Spot',
        ],
    ],
    'serviceRole' => 'arn:aws:iam::012345678910:role/AWSBatchServiceRole',
    'state' => 'ENABLED',
]);

Result syntax:

[
    'computeEnvironmentArn' => 'arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot',
    'computeEnvironmentName' => 'M4Spot',
]

CreateJobQueue

$result = $client->createJobQueue([/* ... */]);
$promise = $client->createJobQueueAsync([/* ... */]);

Creates an 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 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.

Parameter Syntax

$result = $client->createJobQueue([
    'computeEnvironmentOrder' => [ // REQUIRED
        [
            'computeEnvironment' => '<string>', // REQUIRED
            'order' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'jobQueueName' => '<string>', // REQUIRED
    'jobStateTimeLimitActions' => [
        [
            'action' => 'CANCEL', // REQUIRED
            'maxTimeSeconds' => <integer>, // REQUIRED
            'reason' => '<string>', // REQUIRED
            'state' => 'RUNNABLE', // REQUIRED
        ],
        // ...
    ],
    'priority' => <integer>, // REQUIRED
    'schedulingPolicyArn' => '<string>',
    'state' => 'ENABLED|DISABLED',
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
computeEnvironmentOrder
Required: Yes
Type: Array of ComputeEnvironmentOrder structures

The set of compute environments mapped to a job queue and their order relative to each other. The job scheduler uses this parameter to determine which compute environment runs a specific job. Compute environments must be in the VALID state before you can associate them with a job queue. You can associate up to three compute environments with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

jobQueueName
Required: Yes
Type: string

The name of the job queue. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

jobStateTimeLimitActions
Type: Array of JobStateTimeLimitAction structures

The set of actions that Batch performs on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed.

priority
Required: Yes
Type: int

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); EC2 and Fargate compute environments can't be mixed.

schedulingPolicyArn
Type: string

The Amazon Resource Name (ARN) of the fair share scheduling policy. If this parameter is specified, the job queue uses a fair share scheduling policy. If this parameter isn't specified, the job queue uses a first in, first out (FIFO) scheduling policy. After a job queue is created, you can replace but can't remove the fair share scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . An example is aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

state
Type: string

The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags that you apply to the job queue to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging your Batch resources in Batch User Guide.

Result Syntax

[
    'jobQueueArn' => '<string>',
    'jobQueueName' => '<string>',
]

Result Details

Members
jobQueueArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the job queue.

jobQueueName
Required: Yes
Type: string

The name of the job queue.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To create a job queue with a single compute environment

This example creates a job queue called LowPriority that uses the M4Spot compute environment.

$result = $client->createJobQueue([
    'computeEnvironmentOrder' => [
        [
            'computeEnvironment' => 'M4Spot',
            'order' => 1,
        ],
    ],
    'jobQueueName' => 'LowPriority',
    'priority' => 1,
    'state' => 'ENABLED',
]);

Result syntax:

[
    'jobQueueArn' => 'arn:aws:batch:us-east-1:012345678910:job-queue/LowPriority',
    'jobQueueName' => 'LowPriority',
]
Example 2: To create a job queue with multiple compute environments

This example creates a job queue called HighPriority that uses the C4OnDemand compute environment with an order of 1 and the M4Spot compute environment with an order of 2.

$result = $client->createJobQueue([
    'computeEnvironmentOrder' => [
        [
            'computeEnvironment' => 'C4OnDemand',
            'order' => 1,
        ],
        [
            'computeEnvironment' => 'M4Spot',
            'order' => 2,
        ],
    ],
    'jobQueueName' => 'HighPriority',
    'priority' => 10,
    'state' => 'ENABLED',
]);

Result syntax:

[
    'jobQueueArn' => 'arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority',
    'jobQueueName' => 'HighPriority',
]

CreateSchedulingPolicy

$result = $client->createSchedulingPolicy([/* ... */]);
$promise = $client->createSchedulingPolicyAsync([/* ... */]);

Creates an Batch scheduling policy.

Parameter Syntax

$result = $client->createSchedulingPolicy([
    'fairsharePolicy' => [
        'computeReservation' => <integer>,
        'shareDecaySeconds' => <integer>,
        'shareDistribution' => [
            [
                'shareIdentifier' => '<string>', // REQUIRED
                'weightFactor' => <float>,
            ],
            // ...
        ],
    ],
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Members
fairsharePolicy
Type: FairsharePolicy structure

The fair share policy of the scheduling policy.

name
Required: Yes
Type: string

The name of the scheduling policy. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags that you apply to the scheduling policy to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

These tags can be updated or removed using the TagResource and UntagResource API operations.

Result Syntax

[
    'arn' => '<string>',
    'name' => '<string>',
]

Result Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

name
Required: Yes
Type: string

The name of the scheduling policy.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

DeleteComputeEnvironment

$result = $client->deleteComputeEnvironment([/* ... */]);
$promise = $client->deleteComputeEnvironmentAsync([/* ... */]);

Deletes an 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 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.

Parameter Syntax

$result = $client->deleteComputeEnvironment([
    'computeEnvironment' => '<string>', // REQUIRED
]);

Parameter Details

Members
computeEnvironment
Required: Yes
Type: string

The name or Amazon Resource Name (ARN) of the compute environment to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To delete a compute environment

This example deletes the P2OnDemand compute environment.

$result = $client->deleteComputeEnvironment([
    'computeEnvironment' => 'P2OnDemand',
]);

Result syntax:

[
]

DeleteJobQueue

$result = $client->deleteJobQueue([/* ... */]);
$promise = $client->deleteJobQueueAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteJobQueue([
    'jobQueue' => '<string>', // REQUIRED
]);

Parameter Details

Members
jobQueue
Required: Yes
Type: string

The short name or full Amazon Resource Name (ARN) of the queue to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To delete a job queue

This example deletes the GPGPU job queue.

$result = $client->deleteJobQueue([
    'jobQueue' => 'GPGPU',
]);

Result syntax:

[
]

DeleteSchedulingPolicy

$result = $client->deleteSchedulingPolicy([/* ... */]);
$promise = $client->deleteSchedulingPolicyAsync([/* ... */]);

Deletes the specified scheduling policy.

You can't delete a scheduling policy that's used in any job queues.

Parameter Syntax

$result = $client->deleteSchedulingPolicy([
    'arn' => '<string>', // REQUIRED
]);

Parameter Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the scheduling policy to delete.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

DeregisterJobDefinition

$result = $client->deregisterJobDefinition([/* ... */]);
$promise = $client->deregisterJobDefinitionAsync([/* ... */]);

Deregisters an Batch job definition. Job definitions are permanently deleted after 180 days.

Parameter Syntax

$result = $client->deregisterJobDefinition([
    'jobDefinition' => '<string>', // REQUIRED
]);

Parameter Details

Members
jobDefinition
Required: Yes
Type: string

The name and revision (name:revision) or full Amazon Resource Name (ARN) of the job definition to deregister.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To deregister a job definition

This example deregisters a job definition called sleep10.

$result = $client->deregisterJobDefinition([
    'jobDefinition' => 'sleep10',
]);

Result syntax:

[
]

DescribeComputeEnvironments

$result = $client->describeComputeEnvironments([/* ... */]);
$promise = $client->describeComputeEnvironmentsAsync([/* ... */]);

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 launch your Amazon ECS container instances into.

Parameter Syntax

$result = $client->describeComputeEnvironments([
    'computeEnvironments' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
computeEnvironments
Type: Array of strings

A list of up to 100 compute environment names or full Amazon Resource Name (ARN) entries.

maxResults
Type: int

The maximum number of cluster results returned by DescribeComputeEnvironments in paginated output. When this parameter is used, DescribeComputeEnvironments only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeComputeEnvironments request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeComputeEnvironments returns up to 100 results and a nextToken value if applicable.

nextToken
Type: string

The nextToken value returned from a previous paginated DescribeComputeEnvironments request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Result Syntax

[
    'computeEnvironments' => [
        [
            'computeEnvironmentArn' => '<string>',
            'computeEnvironmentName' => '<string>',
            'computeResources' => [
                'allocationStrategy' => 'BEST_FIT|BEST_FIT_PROGRESSIVE|SPOT_CAPACITY_OPTIMIZED|SPOT_PRICE_CAPACITY_OPTIMIZED',
                'bidPercentage' => <integer>,
                'desiredvCpus' => <integer>,
                'ec2Configuration' => [
                    [
                        'imageIdOverride' => '<string>',
                        'imageKubernetesVersion' => '<string>',
                        'imageType' => '<string>',
                    ],
                    // ...
                ],
                'ec2KeyPair' => '<string>',
                'imageId' => '<string>',
                'instanceRole' => '<string>',
                'instanceTypes' => ['<string>', ...],
                'launchTemplate' => [
                    'launchTemplateId' => '<string>',
                    'launchTemplateName' => '<string>',
                    'version' => '<string>',
                ],
                'maxvCpus' => <integer>,
                'minvCpus' => <integer>,
                'placementGroup' => '<string>',
                'securityGroupIds' => ['<string>', ...],
                'spotIamFleetRole' => '<string>',
                'subnets' => ['<string>', ...],
                'tags' => ['<string>', ...],
                'type' => 'EC2|SPOT|FARGATE|FARGATE_SPOT',
            ],
            'containerOrchestrationType' => 'ECS|EKS',
            'ecsClusterArn' => '<string>',
            'eksConfiguration' => [
                'eksClusterArn' => '<string>',
                'kubernetesNamespace' => '<string>',
            ],
            'serviceRole' => '<string>',
            'state' => 'ENABLED|DISABLED',
            'status' => 'CREATING|UPDATING|DELETING|DELETED|VALID|INVALID',
            'statusReason' => '<string>',
            'tags' => ['<string>', ...],
            'type' => 'MANAGED|UNMANAGED',
            'unmanagedvCpus' => <integer>,
            'updatePolicy' => [
                'jobExecutionTimeoutMinutes' => <integer>,
                'terminateJobsOnUpdate' => true || false,
            ],
            'uuid' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
computeEnvironments
Type: Array of ComputeEnvironmentDetail structures

The list of compute environments.

nextToken
Type: string

The nextToken value to include in a future DescribeComputeEnvironments request. When the results of a DescribeComputeEnvironments request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To describe a compute environment

This example describes the P2OnDemand compute environment.

$result = $client->describeComputeEnvironments([
    'computeEnvironments' => [
        'P2OnDemand',
    ],
]);

Result syntax:

[
    'computeEnvironments' => [
        [
            'type' => 'MANAGED',
            'computeEnvironmentArn' => 'arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand',
            'computeEnvironmentName' => 'P2OnDemand',
            'computeResources' => [
                'type' => 'EC2',
                'desiredvCpus' => 48,
                'ec2KeyPair' => 'id_rsa',
                'instanceRole' => 'ecsInstanceRole',
                'instanceTypes' => [
                    'p2',
                ],
                'maxvCpus' => 128,
                'minvCpus' => 0,
                'securityGroupIds' => [
                    'sg-cf5093b2',
                ],
                'subnets' => [
                    'subnet-220c0e0a',
                    'subnet-1a95556d',
                    'subnet-978f6dce',
                ],
                'tags' => [
                    'Name' => 'Batch Instance - P2OnDemand',
                ],
            ],
            'ecsClusterArn' => 'arn:aws:ecs:us-east-1:012345678910:cluster/P2OnDemand_Batch_2c06f29d-d1fe-3a49-879d-42394c86effc',
            'serviceRole' => 'arn:aws:iam::012345678910:role/AWSBatchServiceRole',
            'state' => 'ENABLED',
            'status' => 'VALID',
            'statusReason' => 'ComputeEnvironment Healthy',
        ],
    ],
]

DescribeJobDefinitions

$result = $client->describeJobDefinitions([/* ... */]);
$promise = $client->describeJobDefinitionsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->describeJobDefinitions([
    'jobDefinitionName' => '<string>',
    'jobDefinitions' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'status' => '<string>',
]);

Parameter Details

Members
jobDefinitionName
Type: string

The name of the job definition to describe.

jobDefinitions
Type: Array of strings

A list of up to 100 job definitions. Each entry in the list can either be an ARN in the format arn:aws:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision} or a short version using the form ${JobDefinitionName}:${Revision}. This parameter can't be used with other parameters.

maxResults
Type: int

The maximum number of results returned by DescribeJobDefinitions in paginated output. When this parameter is used, DescribeJobDefinitions only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobDefinitions request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobDefinitions returns up to 100 results and a nextToken value if applicable.

nextToken
Type: string

The nextToken value returned from a previous paginated DescribeJobDefinitions request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

status
Type: string

The status used to filter job definitions.

Result Syntax

[
    'jobDefinitions' => [
        [
            'containerOrchestrationType' => 'ECS|EKS',
            'containerProperties' => [
                'command' => ['<string>', ...],
                'environment' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'ephemeralStorage' => [
                    'sizeInGiB' => <integer>,
                ],
                'executionRoleArn' => '<string>',
                'fargatePlatformConfiguration' => [
                    'platformVersion' => '<string>',
                ],
                'image' => '<string>',
                'instanceType' => '<string>',
                'jobRoleArn' => '<string>',
                'linuxParameters' => [
                    'devices' => [
                        [
                            'containerPath' => '<string>',
                            'hostPath' => '<string>',
                            'permissions' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'initProcessEnabled' => true || false,
                    'maxSwap' => <integer>,
                    'sharedMemorySize' => <integer>,
                    'swappiness' => <integer>,
                    'tmpfs' => [
                        [
                            'containerPath' => '<string>',
                            'mountOptions' => ['<string>', ...],
                            'size' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'logConfiguration' => [
                    'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk',
                    'options' => ['<string>', ...],
                    'secretOptions' => [
                        [
                            'name' => '<string>',
                            'valueFrom' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'memory' => <integer>,
                'mountPoints' => [
                    [
                        'containerPath' => '<string>',
                        'readOnly' => true || false,
                        'sourceVolume' => '<string>',
                    ],
                    // ...
                ],
                'networkConfiguration' => [
                    'assignPublicIp' => 'ENABLED|DISABLED',
                ],
                'privileged' => true || false,
                'readonlyRootFilesystem' => true || false,
                'repositoryCredentials' => [
                    'credentialsParameter' => '<string>',
                ],
                'resourceRequirements' => [
                    [
                        'type' => 'GPU|VCPU|MEMORY',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'runtimePlatform' => [
                    'cpuArchitecture' => '<string>',
                    'operatingSystemFamily' => '<string>',
                ],
                'secrets' => [
                    [
                        'name' => '<string>',
                        'valueFrom' => '<string>',
                    ],
                    // ...
                ],
                'ulimits' => [
                    [
                        'hardLimit' => <integer>,
                        'name' => '<string>',
                        'softLimit' => <integer>,
                    ],
                    // ...
                ],
                'user' => '<string>',
                'vcpus' => <integer>,
                'volumes' => [
                    [
                        'efsVolumeConfiguration' => [
                            'authorizationConfig' => [
                                'accessPointId' => '<string>',
                                'iam' => 'ENABLED|DISABLED',
                            ],
                            'fileSystemId' => '<string>',
                            'rootDirectory' => '<string>',
                            'transitEncryption' => 'ENABLED|DISABLED',
                            'transitEncryptionPort' => <integer>,
                        ],
                        'host' => [
                            'sourcePath' => '<string>',
                        ],
                        'name' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ecsProperties' => [
                'taskProperties' => [
                    [
                        'containers' => [
                            [
                                'command' => ['<string>', ...],
                                'dependsOn' => [
                                    [
                                        'condition' => '<string>',
                                        'containerName' => '<string>',
                                    ],
                                    // ...
                                ],
                                'environment' => [
                                    [
                                        'name' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'essential' => true || false,
                                'image' => '<string>',
                                'linuxParameters' => [
                                    'devices' => [
                                        [
                                            'containerPath' => '<string>',
                                            'hostPath' => '<string>',
                                            'permissions' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                    'initProcessEnabled' => true || false,
                                    'maxSwap' => <integer>,
                                    'sharedMemorySize' => <integer>,
                                    'swappiness' => <integer>,
                                    'tmpfs' => [
                                        [
                                            'containerPath' => '<string>',
                                            'mountOptions' => ['<string>', ...],
                                            'size' => <integer>,
                                        ],
                                        // ...
                                    ],
                                ],
                                'logConfiguration' => [
                                    'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk',
                                    'options' => ['<string>', ...],
                                    'secretOptions' => [
                                        [
                                            'name' => '<string>',
                                            'valueFrom' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                'mountPoints' => [
                                    [
                                        'containerPath' => '<string>',
                                        'readOnly' => true || false,
                                        'sourceVolume' => '<string>',
                                    ],
                                    // ...
                                ],
                                'name' => '<string>',
                                'privileged' => true || false,
                                'readonlyRootFilesystem' => true || false,
                                'repositoryCredentials' => [
                                    'credentialsParameter' => '<string>',
                                ],
                                'resourceRequirements' => [
                                    [
                                        'type' => 'GPU|VCPU|MEMORY',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'secrets' => [
                                    [
                                        'name' => '<string>',
                                        'valueFrom' => '<string>',
                                    ],
                                    // ...
                                ],
                                'ulimits' => [
                                    [
                                        'hardLimit' => <integer>,
                                        'name' => '<string>',
                                        'softLimit' => <integer>,
                                    ],
                                    // ...
                                ],
                                'user' => '<string>',
                            ],
                            // ...
                        ],
                        'ephemeralStorage' => [
                            'sizeInGiB' => <integer>,
                        ],
                        'executionRoleArn' => '<string>',
                        'ipcMode' => '<string>',
                        'networkConfiguration' => [
                            'assignPublicIp' => 'ENABLED|DISABLED',
                        ],
                        'pidMode' => '<string>',
                        'platformVersion' => '<string>',
                        'runtimePlatform' => [
                            'cpuArchitecture' => '<string>',
                            'operatingSystemFamily' => '<string>',
                        ],
                        'taskRoleArn' => '<string>',
                        'volumes' => [
                            [
                                'efsVolumeConfiguration' => [
                                    'authorizationConfig' => [
                                        'accessPointId' => '<string>',
                                        'iam' => 'ENABLED|DISABLED',
                                    ],
                                    'fileSystemId' => '<string>',
                                    'rootDirectory' => '<string>',
                                    'transitEncryption' => 'ENABLED|DISABLED',
                                    'transitEncryptionPort' => <integer>,
                                ],
                                'host' => [
                                    'sourcePath' => '<string>',
                                ],
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'eksProperties' => [
                'podProperties' => [
                    'containers' => [
                        [
                            'args' => ['<string>', ...],
                            'command' => ['<string>', ...],
                            'env' => [
                                [
                                    'name' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'image' => '<string>',
                            'imagePullPolicy' => '<string>',
                            'name' => '<string>',
                            'resources' => [
                                'limits' => ['<string>', ...],
                                'requests' => ['<string>', ...],
                            ],
                            'securityContext' => [
                                'allowPrivilegeEscalation' => true || false,
                                'privileged' => true || false,
                                'readOnlyRootFilesystem' => true || false,
                                'runAsGroup' => <integer>,
                                'runAsNonRoot' => true || false,
                                'runAsUser' => <integer>,
                            ],
                            'volumeMounts' => [
                                [
                                    'mountPath' => '<string>',
                                    'name' => '<string>',
                                    'readOnly' => true || false,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'dnsPolicy' => '<string>',
                    'hostNetwork' => true || false,
                    'imagePullSecrets' => [
                        [
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'initContainers' => [
                        [
                            'args' => ['<string>', ...],
                            'command' => ['<string>', ...],
                            'env' => [
                                [
                                    'name' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'image' => '<string>',
                            'imagePullPolicy' => '<string>',
                            'name' => '<string>',
                            'resources' => [
                                'limits' => ['<string>', ...],
                                'requests' => ['<string>', ...],
                            ],
                            'securityContext' => [
                                'allowPrivilegeEscalation' => true || false,
                                'privileged' => true || false,
                                'readOnlyRootFilesystem' => true || false,
                                'runAsGroup' => <integer>,
                                'runAsNonRoot' => true || false,
                                'runAsUser' => <integer>,
                            ],
                            'volumeMounts' => [
                                [
                                    'mountPath' => '<string>',
                                    'name' => '<string>',
                                    'readOnly' => true || false,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'metadata' => [
                        'labels' => ['<string>', ...],
                    ],
                    'serviceAccountName' => '<string>',
                    'shareProcessNamespace' => true || false,
                    'volumes' => [
                        [
                            'emptyDir' => [
                                'medium' => '<string>',
                                'sizeLimit' => '<string>',
                            ],
                            'hostPath' => [
                                'path' => '<string>',
                            ],
                            'name' => '<string>',
                            'secret' => [
                                'optional' => true || false,
                                'secretName' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'jobDefinitionArn' => '<string>',
            'jobDefinitionName' => '<string>',
            'nodeProperties' => [
                'mainNode' => <integer>,
                'nodeRangeProperties' => [
                    [
                        'container' => [
                            'command' => ['<string>', ...],
                            'environment' => [
                                [
                                    'name' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'ephemeralStorage' => [
                                'sizeInGiB' => <integer>,
                            ],
                            'executionRoleArn' => '<string>',
                            'fargatePlatformConfiguration' => [
                                'platformVersion' => '<string>',
                            ],
                            'image' => '<string>',
                            'instanceType' => '<string>',
                            'jobRoleArn' => '<string>',
                            'linuxParameters' => [
                                'devices' => [
                                    [
                                        'containerPath' => '<string>',
                                        'hostPath' => '<string>',
                                        'permissions' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                                'initProcessEnabled' => true || false,
                                'maxSwap' => <integer>,
                                'sharedMemorySize' => <integer>,
                                'swappiness' => <integer>,
                                'tmpfs' => [
                                    [
                                        'containerPath' => '<string>',
                                        'mountOptions' => ['<string>', ...],
                                        'size' => <integer>,
                                    ],
                                    // ...
                                ],
                            ],
                            'logConfiguration' => [
                                'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk',
                                'options' => ['<string>', ...],
                                'secretOptions' => [
                                    [
                                        'name' => '<string>',
                                        'valueFrom' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'memory' => <integer>,
                            'mountPoints' => [
                                [
                                    'containerPath' => '<string>',
                                    'readOnly' => true || false,
                                    'sourceVolume' => '<string>',
                                ],
                                // ...
                            ],
                            'networkConfiguration' => [
                                'assignPublicIp' => 'ENABLED|DISABLED',
                            ],
                            'privileged' => true || false,
                            'readonlyRootFilesystem' => true || false,
                            'repositoryCredentials' => [
                                'credentialsParameter' => '<string>',
                            ],
                            'resourceRequirements' => [
                                [
                                    'type' => 'GPU|VCPU|MEMORY',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'runtimePlatform' => [
                                'cpuArchitecture' => '<string>',
                                'operatingSystemFamily' => '<string>',
                            ],
                            'secrets' => [
                                [
                                    'name' => '<string>',
                                    'valueFrom' => '<string>',
                                ],
                                // ...
                            ],
                            'ulimits' => [
                                [
                                    'hardLimit' => <integer>,
                                    'name' => '<string>',
                                    'softLimit' => <integer>,
                                ],
                                // ...
                            ],
                            'user' => '<string>',
                            'vcpus' => <integer>,
                            'volumes' => [
                                [
                                    'efsVolumeConfiguration' => [
                                        'authorizationConfig' => [
                                            'accessPointId' => '<string>',
                                            'iam' => 'ENABLED|DISABLED',
                                        ],
                                        'fileSystemId' => '<string>',
                                        'rootDirectory' => '<string>',
                                        'transitEncryption' => 'ENABLED|DISABLED',
                                        'transitEncryptionPort' => <integer>,
                                    ],
                                    'host' => [
                                        'sourcePath' => '<string>',
                                    ],
                                    'name' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'ecsProperties' => [
                            'taskProperties' => [
                                [
                                    'containers' => [
                                        [
                                            'command' => ['<string>', ...],
                                            'dependsOn' => [
                                                [
                                                    'condition' => '<string>',
                                                    'containerName' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'environment' => [
                                                [
                                                    'name' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'essential' => true || false,
                                            'image' => '<string>',
                                            'linuxParameters' => [
                                                'devices' => [
                                                    [
                                                        'containerPath' => '<string>',
                                                        'hostPath' => '<string>',
                                                        'permissions' => ['<string>', ...],
                                                    ],
                                                    // ...
                                                ],
                                                'initProcessEnabled' => true || false,
                                                'maxSwap' => <integer>,
                                                'sharedMemorySize' => <integer>,
                                                'swappiness' => <integer>,
                                                'tmpfs' => [
                                                    [
                                                        'containerPath' => '<string>',
                                                        'mountOptions' => ['<string>', ...],
                                                        'size' => <integer>,
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                            'logConfiguration' => [
                                                'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk',
                                                'options' => ['<string>', ...],
                                                'secretOptions' => [
                                                    [
                                                        'name' => '<string>',
                                                        'valueFrom' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                            'mountPoints' => [
                                                [
                                                    'containerPath' => '<string>',
                                                    'readOnly' => true || false,
                                                    'sourceVolume' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'name' => '<string>',
                                            'privileged' => true || false,
                                            'readonlyRootFilesystem' => true || false,
                                            'repositoryCredentials' => [
                                                'credentialsParameter' => '<string>',
                                            ],
                                            'resourceRequirements' => [
                                                [
                                                    'type' => 'GPU|VCPU|MEMORY',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'secrets' => [
                                                [
                                                    'name' => '<string>',
                                                    'valueFrom' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'ulimits' => [
                                                [
                                                    'hardLimit' => <integer>,
                                                    'name' => '<string>',
                                                    'softLimit' => <integer>,
                                                ],
                                                // ...
                                            ],
                                            'user' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'ephemeralStorage' => [
                                        'sizeInGiB' => <integer>,
                                    ],
                                    'executionRoleArn' => '<string>',
                                    'ipcMode' => '<string>',
                                    'networkConfiguration' => [
                                        'assignPublicIp' => 'ENABLED|DISABLED',
                                    ],
                                    'pidMode' => '<string>',
                                    'platformVersion' => '<string>',
                                    'runtimePlatform' => [
                                        'cpuArchitecture' => '<string>',
                                        'operatingSystemFamily' => '<string>',
                                    ],
                                    'taskRoleArn' => '<string>',
                                    'volumes' => [
                                        [
                                            'efsVolumeConfiguration' => [
                                                'authorizationConfig' => [
                                                    'accessPointId' => '<string>',
                                                    'iam' => 'ENABLED|DISABLED',
                                                ],
                                                'fileSystemId' => '<string>',
                                                'rootDirectory' => '<string>',
                                                'transitEncryption' => 'ENABLED|DISABLED',
                                                'transitEncryptionPort' => <integer>,
                                            ],
                                            'host' => [
                                                'sourcePath' => '<string>',
                                            ],
                                            'name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        'instanceTypes' => ['<string>', ...],
                        'targetNodes' => '<string>',
                    ],
                    // ...
                ],
                'numNodes' => <integer>,
            ],
            'parameters' => ['<string>', ...],
            'platformCapabilities' => ['<string>', ...],
            'propagateTags' => true || false,
            'retryStrategy' => [
                'attempts' => <integer>,
                'evaluateOnExit' => [
                    [
                        'action' => 'RETRY|EXIT',
                        'onExitCode' => '<string>',
                        'onReason' => '<string>',
                        'onStatusReason' => '<string>',
                    ],
                    // ...
                ],
            ],
            'revision' => <integer>,
            'schedulingPriority' => <integer>,
            'status' => '<string>',
            'tags' => ['<string>', ...],
            'timeout' => [
                'attemptDurationSeconds' => <integer>,
            ],
            'type' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
jobDefinitions
Type: Array of JobDefinition structures

The list of job definitions.

nextToken
Type: string

The nextToken value to include in a future DescribeJobDefinitions request. When the results of a DescribeJobDefinitions request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To describe active job definitions

This example describes all of your active job definitions.

$result = $client->describeJobDefinitions([
    'status' => 'ACTIVE',
]);

Result syntax:

[
    'jobDefinitions' => [
        [
            'type' => 'container',
            'containerProperties' => [
                'command' => [
                    'sleep',
                    '60',
                ],
                'environment' => [
                ],
                'image' => 'busybox',
                'mountPoints' => [
                ],
                'resourceRequirements' => [
                    [
                        'type' => 'MEMORY',
                        'value' => '128',
                    ],
                    [
                        'type' => 'VCPU',
                        'value' => '1',
                    ],
                ],
                'ulimits' => [
                ],
                'volumes' => [
                ],
            ],
            'jobDefinitionArn' => 'arn:aws:batch:us-east-1:012345678910:job-definition/sleep60:1',
            'jobDefinitionName' => 'sleep60',
            'revision' => 1,
            'status' => 'ACTIVE',
        ],
    ],
]

DescribeJobQueues

$result = $client->describeJobQueues([/* ... */]);
$promise = $client->describeJobQueuesAsync([/* ... */]);

Describes one or more of your job queues.

Parameter Syntax

$result = $client->describeJobQueues([
    'jobQueues' => ['<string>', ...],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
jobQueues
Type: Array of strings

A list of up to 100 queue names or full queue Amazon Resource Name (ARN) entries.

maxResults
Type: int

The maximum number of results returned by DescribeJobQueues in paginated output. When this parameter is used, DescribeJobQueues only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another DescribeJobQueues request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then DescribeJobQueues returns up to 100 results and a nextToken value if applicable.

nextToken
Type: string

The nextToken value returned from a previous paginated DescribeJobQueues request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Result Syntax

[
    'jobQueues' => [
        [
            'computeEnvironmentOrder' => [
                [
                    'computeEnvironment' => '<string>',
                    'order' => <integer>,
                ],
                // ...
            ],
            'jobQueueArn' => '<string>',
            'jobQueueName' => '<string>',
            'jobStateTimeLimitActions' => [
                [
                    'action' => 'CANCEL',
                    'maxTimeSeconds' => <integer>,
                    'reason' => '<string>',
                    'state' => 'RUNNABLE',
                ],
                // ...
            ],
            'priority' => <integer>,
            'schedulingPolicyArn' => '<string>',
            'state' => 'ENABLED|DISABLED',
            'status' => 'CREATING|UPDATING|DELETING|DELETED|VALID|INVALID',
            'statusReason' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
jobQueues
Type: Array of JobQueueDetail structures

The list of job queues.

nextToken
Type: string

The nextToken value to include in a future DescribeJobQueues request. When the results of a DescribeJobQueues request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To describe a job queue

This example describes the HighPriority job queue.

$result = $client->describeJobQueues([
    'jobQueues' => [
        'HighPriority',
    ],
]);

Result syntax:

[
    'jobQueues' => [
        [
            'computeEnvironmentOrder' => [
                [
                    'computeEnvironment' => 'arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand',
                    'order' => 1,
                ],
            ],
            'jobQueueArn' => 'arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority',
            'jobQueueName' => 'HighPriority',
            'priority' => 1,
            'state' => 'ENABLED',
            'status' => 'VALID',
            'statusReason' => 'JobQueue Healthy',
        ],
    ],
]

DescribeJobs

$result = $client->describeJobs([/* ... */]);
$promise = $client->describeJobsAsync([/* ... */]);

Describes a list of Batch jobs.

Parameter Syntax

$result = $client->describeJobs([
    'jobs' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
jobs
Required: Yes
Type: Array of strings

A list of up to 100 job IDs.

Result Syntax

[
    'jobs' => [
        [
            'arrayProperties' => [
                'index' => <integer>,
                'size' => <integer>,
                'statusSummary' => [<integer>, ...],
            ],
            'attempts' => [
                [
                    'container' => [
                        'containerInstanceArn' => '<string>',
                        'exitCode' => <integer>,
                        'logStreamName' => '<string>',
                        'networkInterfaces' => [
                            [
                                'attachmentId' => '<string>',
                                'ipv6Address' => '<string>',
                                'privateIpv4Address' => '<string>',
                            ],
                            // ...
                        ],
                        'reason' => '<string>',
                        'taskArn' => '<string>',
                    ],
                    'startedAt' => <integer>,
                    'statusReason' => '<string>',
                    'stoppedAt' => <integer>,
                    'taskProperties' => [
                        [
                            'containerInstanceArn' => '<string>',
                            'containers' => [
                                [
                                    'exitCode' => <integer>,
                                    'logStreamName' => '<string>',
                                    'name' => '<string>',
                                    'networkInterfaces' => [
                                        [
                                            'attachmentId' => '<string>',
                                            'ipv6Address' => '<string>',
                                            'privateIpv4Address' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'reason' => '<string>',
                                ],
                                // ...
                            ],
                            'taskArn' => '<string>',
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'container' => [
                'command' => ['<string>', ...],
                'containerInstanceArn' => '<string>',
                'environment' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'ephemeralStorage' => [
                    'sizeInGiB' => <integer>,
                ],
                'executionRoleArn' => '<string>',
                'exitCode' => <integer>,
                'fargatePlatformConfiguration' => [
                    'platformVersion' => '<string>',
                ],
                'image' => '<string>',
                'instanceType' => '<string>',
                'jobRoleArn' => '<string>',
                'linuxParameters' => [
                    'devices' => [
                        [
                            'containerPath' => '<string>',
                            'hostPath' => '<string>',
                            'permissions' => ['<string>', ...],
                        ],
                        // ...
                    ],
                    'initProcessEnabled' => true || false,
                    'maxSwap' => <integer>,
                    'sharedMemorySize' => <integer>,
                    'swappiness' => <integer>,
                    'tmpfs' => [
                        [
                            'containerPath' => '<string>',
                            'mountOptions' => ['<string>', ...],
                            'size' => <integer>,
                        ],
                        // ...
                    ],
                ],
                'logConfiguration' => [
                    'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk',
                    'options' => ['<string>', ...],
                    'secretOptions' => [
                        [
                            'name' => '<string>',
                            'valueFrom' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'logStreamName' => '<string>',
                'memory' => <integer>,
                'mountPoints' => [
                    [
                        'containerPath' => '<string>',
                        'readOnly' => true || false,
                        'sourceVolume' => '<string>',
                    ],
                    // ...
                ],
                'networkConfiguration' => [
                    'assignPublicIp' => 'ENABLED|DISABLED',
                ],
                'networkInterfaces' => [
                    [
                        'attachmentId' => '<string>',
                        'ipv6Address' => '<string>',
                        'privateIpv4Address' => '<string>',
                    ],
                    // ...
                ],
                'privileged' => true || false,
                'readonlyRootFilesystem' => true || false,
                'reason' => '<string>',
                'repositoryCredentials' => [
                    'credentialsParameter' => '<string>',
                ],
                'resourceRequirements' => [
                    [
                        'type' => 'GPU|VCPU|MEMORY',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'runtimePlatform' => [
                    'cpuArchitecture' => '<string>',
                    'operatingSystemFamily' => '<string>',
                ],
                'secrets' => [
                    [
                        'name' => '<string>',
                        'valueFrom' => '<string>',
                    ],
                    // ...
                ],
                'taskArn' => '<string>',
                'ulimits' => [
                    [
                        'hardLimit' => <integer>,
                        'name' => '<string>',
                        'softLimit' => <integer>,
                    ],
                    // ...
                ],
                'user' => '<string>',
                'vcpus' => <integer>,
                'volumes' => [
                    [
                        'efsVolumeConfiguration' => [
                            'authorizationConfig' => [
                                'accessPointId' => '<string>',
                                'iam' => 'ENABLED|DISABLED',
                            ],
                            'fileSystemId' => '<string>',
                            'rootDirectory' => '<string>',
                            'transitEncryption' => 'ENABLED|DISABLED',
                            'transitEncryptionPort' => <integer>,
                        ],
                        'host' => [
                            'sourcePath' => '<string>',
                        ],
                        'name' => '<string>',
                    ],
                    // ...
                ],
            ],
            'createdAt' => <integer>,
            'dependsOn' => [
                [
                    'jobId' => '<string>',
                    'type' => 'N_TO_N|SEQUENTIAL',
                ],
                // ...
            ],
            'ecsProperties' => [
                'taskProperties' => [
                    [
                        'containerInstanceArn' => '<string>',
                        'containers' => [
                            [
                                'command' => ['<string>', ...],
                                'dependsOn' => [
                                    [
                                        'condition' => '<string>',
                                        'containerName' => '<string>',
                                    ],
                                    // ...
                                ],
                                'environment' => [
                                    [
                                        'name' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'essential' => true || false,
                                'exitCode' => <integer>,
                                'image' => '<string>',
                                'linuxParameters' => [
                                    'devices' => [
                                        [
                                            'containerPath' => '<string>',
                                            'hostPath' => '<string>',
                                            'permissions' => ['<string>', ...],
                                        ],
                                        // ...
                                    ],
                                    'initProcessEnabled' => true || false,
                                    'maxSwap' => <integer>,
                                    'sharedMemorySize' => <integer>,
                                    'swappiness' => <integer>,
                                    'tmpfs' => [
                                        [
                                            'containerPath' => '<string>',
                                            'mountOptions' => ['<string>', ...],
                                            'size' => <integer>,
                                        ],
                                        // ...
                                    ],
                                ],
                                'logConfiguration' => [
                                    'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk',
                                    'options' => ['<string>', ...],
                                    'secretOptions' => [
                                        [
                                            'name' => '<string>',
                                            'valueFrom' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                'logStreamName' => '<string>',
                                'mountPoints' => [
                                    [
                                        'containerPath' => '<string>',
                                        'readOnly' => true || false,
                                        'sourceVolume' => '<string>',
                                    ],
                                    // ...
                                ],
                                'name' => '<string>',
                                'networkInterfaces' => [
                                    [
                                        'attachmentId' => '<string>',
                                        'ipv6Address' => '<string>',
                                        'privateIpv4Address' => '<string>',
                                    ],
                                    // ...
                                ],
                                'privileged' => true || false,
                                'readonlyRootFilesystem' => true || false,
                                'reason' => '<string>',
                                'repositoryCredentials' => [
                                    'credentialsParameter' => '<string>',
                                ],
                                'resourceRequirements' => [
                                    [
                                        'type' => 'GPU|VCPU|MEMORY',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                                'secrets' => [
                                    [
                                        'name' => '<string>',
                                        'valueFrom' => '<string>',
                                    ],
                                    // ...
                                ],
                                'ulimits' => [
                                    [
                                        'hardLimit' => <integer>,
                                        'name' => '<string>',
                                        'softLimit' => <integer>,
                                    ],
                                    // ...
                                ],
                                'user' => '<string>',
                            ],
                            // ...
                        ],
                        'ephemeralStorage' => [
                            'sizeInGiB' => <integer>,
                        ],
                        'executionRoleArn' => '<string>',
                        'ipcMode' => '<string>',
                        'networkConfiguration' => [
                            'assignPublicIp' => 'ENABLED|DISABLED',
                        ],
                        'pidMode' => '<string>',
                        'platformVersion' => '<string>',
                        'runtimePlatform' => [
                            'cpuArchitecture' => '<string>',
                            'operatingSystemFamily' => '<string>',
                        ],
                        'taskArn' => '<string>',
                        'taskRoleArn' => '<string>',
                        'volumes' => [
                            [
                                'efsVolumeConfiguration' => [
                                    'authorizationConfig' => [
                                        'accessPointId' => '<string>',
                                        'iam' => 'ENABLED|DISABLED',
                                    ],
                                    'fileSystemId' => '<string>',
                                    'rootDirectory' => '<string>',
                                    'transitEncryption' => 'ENABLED|DISABLED',
                                    'transitEncryptionPort' => <integer>,
                                ],
                                'host' => [
                                    'sourcePath' => '<string>',
                                ],
                                'name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            'eksAttempts' => [
                [
                    'containers' => [
                        [
                            'exitCode' => <integer>,
                            'name' => '<string>',
                            'reason' => '<string>',
                        ],
                        // ...
                    ],
                    'initContainers' => [
                        [
                            'exitCode' => <integer>,
                            'name' => '<string>',
                            'reason' => '<string>',
                        ],
                        // ...
                    ],
                    'nodeName' => '<string>',
                    'podName' => '<string>',
                    'startedAt' => <integer>,
                    'statusReason' => '<string>',
                    'stoppedAt' => <integer>,
                ],
                // ...
            ],
            'eksProperties' => [
                'podProperties' => [
                    'containers' => [
                        [
                            'args' => ['<string>', ...],
                            'command' => ['<string>', ...],
                            'env' => [
                                [
                                    'name' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'exitCode' => <integer>,
                            'image' => '<string>',
                            'imagePullPolicy' => '<string>',
                            'name' => '<string>',
                            'reason' => '<string>',
                            'resources' => [
                                'limits' => ['<string>', ...],
                                'requests' => ['<string>', ...],
                            ],
                            'securityContext' => [
                                'allowPrivilegeEscalation' => true || false,
                                'privileged' => true || false,
                                'readOnlyRootFilesystem' => true || false,
                                'runAsGroup' => <integer>,
                                'runAsNonRoot' => true || false,
                                'runAsUser' => <integer>,
                            ],
                            'volumeMounts' => [
                                [
                                    'mountPath' => '<string>',
                                    'name' => '<string>',
                                    'readOnly' => true || false,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'dnsPolicy' => '<string>',
                    'hostNetwork' => true || false,
                    'imagePullSecrets' => [
                        [
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                    'initContainers' => [
                        [
                            'args' => ['<string>', ...],
                            'command' => ['<string>', ...],
                            'env' => [
                                [
                                    'name' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'exitCode' => <integer>,
                            'image' => '<string>',
                            'imagePullPolicy' => '<string>',
                            'name' => '<string>',
                            'reason' => '<string>',
                            'resources' => [
                                'limits' => ['<string>', ...],
                                'requests' => ['<string>', ...],
                            ],
                            'securityContext' => [
                                'allowPrivilegeEscalation' => true || false,
                                'privileged' => true || false,
                                'readOnlyRootFilesystem' => true || false,
                                'runAsGroup' => <integer>,
                                'runAsNonRoot' => true || false,
                                'runAsUser' => <integer>,
                            ],
                            'volumeMounts' => [
                                [
                                    'mountPath' => '<string>',
                                    'name' => '<string>',
                                    'readOnly' => true || false,
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                    'metadata' => [
                        'labels' => ['<string>', ...],
                    ],
                    'nodeName' => '<string>',
                    'podName' => '<string>',
                    'serviceAccountName' => '<string>',
                    'shareProcessNamespace' => true || false,
                    'volumes' => [
                        [
                            'emptyDir' => [
                                'medium' => '<string>',
                                'sizeLimit' => '<string>',
                            ],
                            'hostPath' => [
                                'path' => '<string>',
                            ],
                            'name' => '<string>',
                            'secret' => [
                                'optional' => true || false,
                                'secretName' => '<string>',
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'isCancelled' => true || false,
            'isTerminated' => true || false,
            'jobArn' => '<string>',
            'jobDefinition' => '<string>',
            'jobId' => '<string>',
            'jobName' => '<string>',
            'jobQueue' => '<string>',
            'nodeDetails' => [
                'isMainNode' => true || false,
                'nodeIndex' => <integer>,
            ],
            'nodeProperties' => [
                'mainNode' => <integer>,
                'nodeRangeProperties' => [
                    [
                        'container' => [
                            'command' => ['<string>', ...],
                            'environment' => [
                                [
                                    'name' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'ephemeralStorage' => [
                                'sizeInGiB' => <integer>,
                            ],
                            'executionRoleArn' => '<string>',
                            'fargatePlatformConfiguration' => [
                                'platformVersion' => '<string>',
                            ],
                            'image' => '<string>',
                            'instanceType' => '<string>',
                            'jobRoleArn' => '<string>',
                            'linuxParameters' => [
                                'devices' => [
                                    [
                                        'containerPath' => '<string>',
                                        'hostPath' => '<string>',
                                        'permissions' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                                'initProcessEnabled' => true || false,
                                'maxSwap' => <integer>,
                                'sharedMemorySize' => <integer>,
                                'swappiness' => <integer>,
                                'tmpfs' => [
                                    [
                                        'containerPath' => '<string>',
                                        'mountOptions' => ['<string>', ...],
                                        'size' => <integer>,
                                    ],
                                    // ...
                                ],
                            ],
                            'logConfiguration' => [
                                'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk',
                                'options' => ['<string>', ...],
                                'secretOptions' => [
                                    [
                                        'name' => '<string>',
                                        'valueFrom' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            'memory' => <integer>,
                            'mountPoints' => [
                                [
                                    'containerPath' => '<string>',
                                    'readOnly' => true || false,
                                    'sourceVolume' => '<string>',
                                ],
                                // ...
                            ],
                            'networkConfiguration' => [
                                'assignPublicIp' => 'ENABLED|DISABLED',
                            ],
                            'privileged' => true || false,
                            'readonlyRootFilesystem' => true || false,
                            'repositoryCredentials' => [
                                'credentialsParameter' => '<string>',
                            ],
                            'resourceRequirements' => [
                                [
                                    'type' => 'GPU|VCPU|MEMORY',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'runtimePlatform' => [
                                'cpuArchitecture' => '<string>',
                                'operatingSystemFamily' => '<string>',
                            ],
                            'secrets' => [
                                [
                                    'name' => '<string>',
                                    'valueFrom' => '<string>',
                                ],
                                // ...
                            ],
                            'ulimits' => [
                                [
                                    'hardLimit' => <integer>,
                                    'name' => '<string>',
                                    'softLimit' => <integer>,
                                ],
                                // ...
                            ],
                            'user' => '<string>',
                            'vcpus' => <integer>,
                            'volumes' => [
                                [
                                    'efsVolumeConfiguration' => [
                                        'authorizationConfig' => [
                                            'accessPointId' => '<string>',
                                            'iam' => 'ENABLED|DISABLED',
                                        ],
                                        'fileSystemId' => '<string>',
                                        'rootDirectory' => '<string>',
                                        'transitEncryption' => 'ENABLED|DISABLED',
                                        'transitEncryptionPort' => <integer>,
                                    ],
                                    'host' => [
                                        'sourcePath' => '<string>',
                                    ],
                                    'name' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'ecsProperties' => [
                            'taskProperties' => [
                                [
                                    'containers' => [
                                        [
                                            'command' => ['<string>', ...],
                                            'dependsOn' => [
                                                [
                                                    'condition' => '<string>',
                                                    'containerName' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'environment' => [
                                                [
                                                    'name' => '<string>',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'essential' => true || false,
                                            'image' => '<string>',
                                            'linuxParameters' => [
                                                'devices' => [
                                                    [
                                                        'containerPath' => '<string>',
                                                        'hostPath' => '<string>',
                                                        'permissions' => ['<string>', ...],
                                                    ],
                                                    // ...
                                                ],
                                                'initProcessEnabled' => true || false,
                                                'maxSwap' => <integer>,
                                                'sharedMemorySize' => <integer>,
                                                'swappiness' => <integer>,
                                                'tmpfs' => [
                                                    [
                                                        'containerPath' => '<string>',
                                                        'mountOptions' => ['<string>', ...],
                                                        'size' => <integer>,
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                            'logConfiguration' => [
                                                'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk',
                                                'options' => ['<string>', ...],
                                                'secretOptions' => [
                                                    [
                                                        'name' => '<string>',
                                                        'valueFrom' => '<string>',
                                                    ],
                                                    // ...
                                                ],
                                            ],
                                            'mountPoints' => [
                                                [
                                                    'containerPath' => '<string>',
                                                    'readOnly' => true || false,
                                                    'sourceVolume' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'name' => '<string>',
                                            'privileged' => true || false,
                                            'readonlyRootFilesystem' => true || false,
                                            'repositoryCredentials' => [
                                                'credentialsParameter' => '<string>',
                                            ],
                                            'resourceRequirements' => [
                                                [
                                                    'type' => 'GPU|VCPU|MEMORY',
                                                    'value' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'secrets' => [
                                                [
                                                    'name' => '<string>',
                                                    'valueFrom' => '<string>',
                                                ],
                                                // ...
                                            ],
                                            'ulimits' => [
                                                [
                                                    'hardLimit' => <integer>,
                                                    'name' => '<string>',
                                                    'softLimit' => <integer>,
                                                ],
                                                // ...
                                            ],
                                            'user' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'ephemeralStorage' => [
                                        'sizeInGiB' => <integer>,
                                    ],
                                    'executionRoleArn' => '<string>',
                                    'ipcMode' => '<string>',
                                    'networkConfiguration' => [
                                        'assignPublicIp' => 'ENABLED|DISABLED',
                                    ],
                                    'pidMode' => '<string>',
                                    'platformVersion' => '<string>',
                                    'runtimePlatform' => [
                                        'cpuArchitecture' => '<string>',
                                        'operatingSystemFamily' => '<string>',
                                    ],
                                    'taskRoleArn' => '<string>',
                                    'volumes' => [
                                        [
                                            'efsVolumeConfiguration' => [
                                                'authorizationConfig' => [
                                                    'accessPointId' => '<string>',
                                                    'iam' => 'ENABLED|DISABLED',
                                                ],
                                                'fileSystemId' => '<string>',
                                                'rootDirectory' => '<string>',
                                                'transitEncryption' => 'ENABLED|DISABLED',
                                                'transitEncryptionPort' => <integer>,
                                            ],
                                            'host' => [
                                                'sourcePath' => '<string>',
                                            ],
                                            'name' => '<string>',
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        'instanceTypes' => ['<string>', ...],
                        'targetNodes' => '<string>',
                    ],
                    // ...
                ],
                'numNodes' => <integer>,
            ],
            'parameters' => ['<string>', ...],
            'platformCapabilities' => ['<string>', ...],
            'propagateTags' => true || false,
            'retryStrategy' => [
                'attempts' => <integer>,
                'evaluateOnExit' => [
                    [
                        'action' => 'RETRY|EXIT',
                        'onExitCode' => '<string>',
                        'onReason' => '<string>',
                        'onStatusReason' => '<string>',
                    ],
                    // ...
                ],
            ],
            'schedulingPriority' => <integer>,
            'shareIdentifier' => '<string>',
            'startedAt' => <integer>,
            'status' => 'SUBMITTED|PENDING|RUNNABLE|STARTING|RUNNING|SUCCEEDED|FAILED',
            'statusReason' => '<string>',
            'stoppedAt' => <integer>,
            'tags' => ['<string>', ...],
            'timeout' => [
                'attemptDurationSeconds' => <integer>,
            ],
        ],
        // ...
    ],
]

Result Details

Members
jobs
Type: Array of JobDetail structures

The list of jobs.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To describe a specific job

This example describes a job with the specified job ID.

$result = $client->describeJobs([
    'jobs' => [
        '24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9',
    ],
]);

Result syntax:

[
    'jobs' => [
        [
            'container' => [
                'command' => [
                    'sleep',
                    '60',
                ],
                'containerInstanceArn' => 'arn:aws:ecs:us-east-1:012345678910:container-instance/5406d7cd-58bd-4b8f-9936-48d7c6b1526c',
                'environment' => [
                ],
                'exitCode' => 0,
                'image' => 'busybox',
                'memory' => 128,
                'mountPoints' => [
                ],
                'ulimits' => [
                ],
                'vcpus' => 1,
                'volumes' => [
                ],
            ],
            'createdAt' => 1480460782010,
            'dependsOn' => [
            ],
            'jobDefinition' => 'sleep60',
            'jobId' => '24fa2d7a-64c4-49d2-8b47-f8da4fbde8e9',
            'jobName' => 'example',
            'jobQueue' => 'arn:aws:batch:us-east-1:012345678910:job-queue/HighPriority',
            'parameters' => [
            ],
            'startedAt' => 1480460816500,
            'status' => 'SUCCEEDED',
            'stoppedAt' => 1480460880699,
        ],
    ],
]

DescribeSchedulingPolicies

$result = $client->describeSchedulingPolicies([/* ... */]);
$promise = $client->describeSchedulingPoliciesAsync([/* ... */]);

Describes one or more of your scheduling policies.

Parameter Syntax

$result = $client->describeSchedulingPolicies([
    'arns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
arns
Required: Yes
Type: Array of strings

A list of up to 100 scheduling policy Amazon Resource Name (ARN) entries.

Result Syntax

[
    'schedulingPolicies' => [
        [
            'arn' => '<string>',
            'fairsharePolicy' => [
                'computeReservation' => <integer>,
                'shareDecaySeconds' => <integer>,
                'shareDistribution' => [
                    [
                        'shareIdentifier' => '<string>',
                        'weightFactor' => <float>,
                    ],
                    // ...
                ],
            ],
            'name' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
]

Result Details

Members
schedulingPolicies
Type: Array of SchedulingPolicyDetail structures

The list of scheduling policies.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

ListJobs

$result = $client->listJobs([/* ... */]);
$promise = $client->listJobsAsync([/* ... */]);

Returns a list of 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.

Parameter Syntax

$result = $client->listJobs([
    'arrayJobId' => '<string>',
    'filters' => [
        [
            'name' => '<string>',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'jobQueue' => '<string>',
    'jobStatus' => 'SUBMITTED|PENDING|RUNNABLE|STARTING|RUNNING|SUCCEEDED|FAILED',
    'maxResults' => <integer>,
    'multiNodeJobId' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Members
arrayJobId
Type: string

The job ID for an array job. Specifying an array job ID with this parameter lists all child jobs from within the specified array.

filters
Type: Array of KeyValuesPair structures

The filter to apply to the query. Only one filter can be used at a time. When the filter is used, jobStatus is ignored. The filter doesn't apply to child jobs in an array or multi-node parallel (MNP) jobs. The results are sorted by the createdAt field, with the most recent jobs being first.

JOB_NAME

The value of the filter is a case-insensitive match for the job name. If the value ends with an asterisk (*), the filter matches any job name that begins with the string before the '*'. This corresponds to the jobName value. For example, test1 matches both Test1 and test1, and test1* matches both test1 and Test10. When the JOB_NAME filter is used, the results are grouped by the job name and version.

JOB_DEFINITION

The value for the filter is the name or Amazon Resource Name (ARN) of the job definition. This corresponds to the jobDefinition value. The value is case sensitive. When the value for the filter is the job definition name, the results include all the jobs that used any revision of that job definition name. If the value ends with an asterisk (*), the filter matches any job definition name that begins with the string before the '*'. For example, jd1 matches only jd1, and jd1* matches both jd1 and jd1A. The version of the job definition that's used doesn't affect the sort order. When the JOB_DEFINITION filter is used and the ARN is used (which is in the form arn:${Partition}:batch:${Region}:${Account}:job-definition/${JobDefinitionName}:${Revision}), the results include jobs that used the specified revision of the job definition. Asterisk (*) isn't supported when the ARN is used.

BEFORE_CREATED_AT

The value for the filter is the time that's before the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

AFTER_CREATED_AT

The value for the filter is the time that's after the job was created. This corresponds to the createdAt value. The value is a string representation of the number of milliseconds since 00:00:00 UTC (midnight) on January 1, 1970.

jobQueue
Type: string

The name or full Amazon Resource Name (ARN) of the job queue used to list jobs.

jobStatus
Type: string

The job status used to filter jobs in the specified queue. If the filters parameter is specified, the jobStatus parameter is ignored and jobs with any status are returned. If you don't specify a status, only RUNNING jobs are returned.

maxResults
Type: int

The maximum number of results returned by ListJobs in paginated output. When this parameter is used, ListJobs only returns maxResults results in a single page and a nextToken response element. The remaining results of the initial request can be seen by sending another ListJobs request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, then ListJobs returns up to 100 results and a nextToken value if applicable.

multiNodeJobId
Type: string

The job ID for a multi-node parallel job. Specifying a multi-node parallel job ID with this parameter lists all nodes that are associated with the specified job.

nextToken
Type: string

The nextToken value returned from a previous paginated ListJobs request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Result Syntax

[
    'jobSummaryList' => [
        [
            'arrayProperties' => [
                'index' => <integer>,
                'size' => <integer>,
            ],
            'container' => [
                'exitCode' => <integer>,
                'reason' => '<string>',
            ],
            'createdAt' => <integer>,
            'jobArn' => '<string>',
            'jobDefinition' => '<string>',
            'jobId' => '<string>',
            'jobName' => '<string>',
            'nodeProperties' => [
                'isMainNode' => true || false,
                'nodeIndex' => <integer>,
                'numNodes' => <integer>,
            ],
            'startedAt' => <integer>,
            'status' => 'SUBMITTED|PENDING|RUNNABLE|STARTING|RUNNING|SUCCEEDED|FAILED',
            'statusReason' => '<string>',
            'stoppedAt' => <integer>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Members
jobSummaryList
Required: Yes
Type: Array of JobSummary structures

A list of job summaries that match the request.

nextToken
Type: string

The nextToken value to include in a future ListJobs request. When the results of a ListJobs request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To list running jobs

This example lists the running jobs in the HighPriority job queue.

$result = $client->listJobs([
    'jobQueue' => 'HighPriority',
]);

Result syntax:

[
    'jobSummaryList' => [
        [
            'jobId' => 'e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb',
            'jobName' => 'example',
        ],
    ],
]
Example 2: To list submitted jobs

This example lists jobs in the HighPriority job queue that are in the SUBMITTED job status.

$result = $client->listJobs([
    'jobQueue' => 'HighPriority',
    'jobStatus' => 'SUBMITTED',
]);

Result syntax:

[
    'jobSummaryList' => [
        [
            'jobId' => '68f0c163-fbd4-44e6-9fd1-25b14a434786',
            'jobName' => 'example',
        ],
    ],
]

ListSchedulingPolicies

$result = $client->listSchedulingPolicies([/* ... */]);
$promise = $client->listSchedulingPoliciesAsync([/* ... */]);

Returns a list of Batch scheduling policies.

Parameter Syntax

$result = $client->listSchedulingPolicies([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Members
maxResults
Type: int

The maximum number of results that's returned by ListSchedulingPolicies in paginated output. When this parameter is used, ListSchedulingPolicies only returns maxResults results in a single page and a nextToken response element. You can see the remaining results of the initial request by sending another ListSchedulingPolicies request with the returned nextToken value. This value can be between 1 and 100. If this parameter isn't used, ListSchedulingPolicies returns up to 100 results and a nextToken value if applicable.

nextToken
Type: string

The nextToken value that's returned from a previous paginated ListSchedulingPolicies request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value. This value is null when there are no more results to return.

Treat this token as an opaque identifier that's only used to retrieve the next items in a list and not for other programmatic purposes.

Result Syntax

[
    'nextToken' => '<string>',
    'schedulingPolicies' => [
        [
            'arn' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members
nextToken
Type: string

The nextToken value to include in a future ListSchedulingPolicies request. When the results of a ListSchedulingPolicies request exceed maxResults, this value can be used to retrieve the next page of results. This value is null when there are no more results to return.

schedulingPolicies
Type: Array of SchedulingPolicyListingDetail structures

A list of scheduling policies that match the request.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listTagsForResource([
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) that identifies the resource that tags are listed for. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

Result Syntax

[
    'tags' => ['<string>', ...],
]

Result Details

Members
tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags for the resource.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: ListTagsForResource Example

This demonstrates calling the ListTagsForResource action.

$result = $client->listTagsForResource([
    'resourceArn' => 'arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1',
]);

Result syntax:

[
    'tags' => [
        'Department' => 'Engineering',
        'Stage' => 'Alpha',
        'User' => 'JaneDoe',
    ],
]

RegisterJobDefinition

$result = $client->registerJobDefinition([/* ... */]);
$promise = $client->registerJobDefinitionAsync([/* ... */]);

Registers an Batch job definition.

Parameter Syntax

$result = $client->registerJobDefinition([
    'containerProperties' => [
        'command' => ['<string>', ...],
        'environment' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'ephemeralStorage' => [
            'sizeInGiB' => <integer>, // REQUIRED
        ],
        'executionRoleArn' => '<string>',
        'fargatePlatformConfiguration' => [
            'platformVersion' => '<string>',
        ],
        'image' => '<string>',
        'instanceType' => '<string>',
        'jobRoleArn' => '<string>',
        'linuxParameters' => [
            'devices' => [
                [
                    'containerPath' => '<string>',
                    'hostPath' => '<string>', // REQUIRED
                    'permissions' => ['<string>', ...],
                ],
                // ...
            ],
            'initProcessEnabled' => true || false,
            'maxSwap' => <integer>,
            'sharedMemorySize' => <integer>,
            'swappiness' => <integer>,
            'tmpfs' => [
                [
                    'containerPath' => '<string>', // REQUIRED
                    'mountOptions' => ['<string>', ...],
                    'size' => <integer>, // REQUIRED
                ],
                // ...
            ],
        ],
        'logConfiguration' => [
            'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk', // REQUIRED
            'options' => ['<string>', ...],
            'secretOptions' => [
                [
                    'name' => '<string>', // REQUIRED
                    'valueFrom' => '<string>', // REQUIRED
                ],
                // ...
            ],
        ],
        'memory' => <integer>,
        'mountPoints' => [
            [
                'containerPath' => '<string>',
                'readOnly' => true || false,
                'sourceVolume' => '<string>',
            ],
            // ...
        ],
        'networkConfiguration' => [
            'assignPublicIp' => 'ENABLED|DISABLED',
        ],
        'privileged' => true || false,
        'readonlyRootFilesystem' => true || false,
        'repositoryCredentials' => [
            'credentialsParameter' => '<string>', // REQUIRED
        ],
        'resourceRequirements' => [
            [
                'type' => 'GPU|VCPU|MEMORY', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'runtimePlatform' => [
            'cpuArchitecture' => '<string>',
            'operatingSystemFamily' => '<string>',
        ],
        'secrets' => [
            [
                'name' => '<string>', // REQUIRED
                'valueFrom' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ulimits' => [
            [
                'hardLimit' => <integer>, // REQUIRED
                'name' => '<string>', // REQUIRED
                'softLimit' => <integer>, // REQUIRED
            ],
            // ...
        ],
        'user' => '<string>',
        'vcpus' => <integer>,
        'volumes' => [
            [
                'efsVolumeConfiguration' => [
                    'authorizationConfig' => [
                        'accessPointId' => '<string>',
                        'iam' => 'ENABLED|DISABLED',
                    ],
                    'fileSystemId' => '<string>', // REQUIRED
                    'rootDirectory' => '<string>',
                    'transitEncryption' => 'ENABLED|DISABLED',
                    'transitEncryptionPort' => <integer>,
                ],
                'host' => [
                    'sourcePath' => '<string>',
                ],
                'name' => '<string>',
            ],
            // ...
        ],
    ],
    'ecsProperties' => [
        'taskProperties' => [ // REQUIRED
            [
                'containers' => [ // REQUIRED
                    [
                        'command' => ['<string>', ...],
                        'dependsOn' => [
                            [
                                'condition' => '<string>',
                                'containerName' => '<string>',
                            ],
                            // ...
                        ],
                        'environment' => [
                            [
                                'name' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                        'essential' => true || false,
                        'image' => '<string>', // REQUIRED
                        'linuxParameters' => [
                            'devices' => [
                                [
                                    'containerPath' => '<string>',
                                    'hostPath' => '<string>', // REQUIRED
                                    'permissions' => ['<string>', ...],
                                ],
                                // ...
                            ],
                            'initProcessEnabled' => true || false,
                            'maxSwap' => <integer>,
                            'sharedMemorySize' => <integer>,
                            'swappiness' => <integer>,
                            'tmpfs' => [
                                [
                                    'containerPath' => '<string>', // REQUIRED
                                    'mountOptions' => ['<string>', ...],
                                    'size' => <integer>, // REQUIRED
                                ],
                                // ...
                            ],
                        ],
                        'logConfiguration' => [
                            'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk', // REQUIRED
                            'options' => ['<string>', ...],
                            'secretOptions' => [
                                [
                                    'name' => '<string>', // REQUIRED
                                    'valueFrom' => '<string>', // REQUIRED
                                ],
                                // ...
                            ],
                        ],
                        'mountPoints' => [
                            [
                                'containerPath' => '<string>',
                                'readOnly' => true || false,
                                'sourceVolume' => '<string>',
                            ],
                            // ...
                        ],
                        'name' => '<string>',
                        'privileged' => true || false,
                        'readonlyRootFilesystem' => true || false,
                        'repositoryCredentials' => [
                            'credentialsParameter' => '<string>', // REQUIRED
                        ],
                        'resourceRequirements' => [
                            [
                                'type' => 'GPU|VCPU|MEMORY', // REQUIRED
                                'value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'secrets' => [
                            [
                                'name' => '<string>', // REQUIRED
                                'valueFrom' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                        'ulimits' => [
                            [
                                'hardLimit' => <integer>, // REQUIRED
                                'name' => '<string>', // REQUIRED
                                'softLimit' => <integer>, // REQUIRED
                            ],
                            // ...
                        ],
                        'user' => '<string>',
                    ],
                    // ...
                ],
                'ephemeralStorage' => [
                    'sizeInGiB' => <integer>, // REQUIRED
                ],
                'executionRoleArn' => '<string>',
                'ipcMode' => '<string>',
                'networkConfiguration' => [
                    'assignPublicIp' => 'ENABLED|DISABLED',
                ],
                'pidMode' => '<string>',
                'platformVersion' => '<string>',
                'runtimePlatform' => [
                    'cpuArchitecture' => '<string>',
                    'operatingSystemFamily' => '<string>',
                ],
                'taskRoleArn' => '<string>',
                'volumes' => [
                    [
                        'efsVolumeConfiguration' => [
                            'authorizationConfig' => [
                                'accessPointId' => '<string>',
                                'iam' => 'ENABLED|DISABLED',
                            ],
                            'fileSystemId' => '<string>', // REQUIRED
                            'rootDirectory' => '<string>',
                            'transitEncryption' => 'ENABLED|DISABLED',
                            'transitEncryptionPort' => <integer>,
                        ],
                        'host' => [
                            'sourcePath' => '<string>',
                        ],
                        'name' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'eksProperties' => [
        'podProperties' => [
            'containers' => [
                [
                    'args' => ['<string>', ...],
                    'command' => ['<string>', ...],
                    'env' => [
                        [
                            'name' => '<string>', // REQUIRED
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'image' => '<string>', // REQUIRED
                    'imagePullPolicy' => '<string>',
                    'name' => '<string>',
                    'resources' => [
                        'limits' => ['<string>', ...],
                        'requests' => ['<string>', ...],
                    ],
                    'securityContext' => [
                        'allowPrivilegeEscalation' => true || false,
                        'privileged' => true || false,
                        'readOnlyRootFilesystem' => true || false,
                        'runAsGroup' => <integer>,
                        'runAsNonRoot' => true || false,
                        'runAsUser' => <integer>,
                    ],
                    'volumeMounts' => [
                        [
                            'mountPath' => '<string>',
                            'name' => '<string>',
                            'readOnly' => true || false,
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'dnsPolicy' => '<string>',
            'hostNetwork' => true || false,
            'imagePullSecrets' => [
                [
                    'name' => '<string>', // REQUIRED
                ],
                // ...
            ],
            'initContainers' => [
                [
                    'args' => ['<string>', ...],
                    'command' => ['<string>', ...],
                    'env' => [
                        [
                            'name' => '<string>', // REQUIRED
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'image' => '<string>', // REQUIRED
                    'imagePullPolicy' => '<string>',
                    'name' => '<string>',
                    'resources' => [
                        'limits' => ['<string>', ...],
                        'requests' => ['<string>', ...],
                    ],
                    'securityContext' => [
                        'allowPrivilegeEscalation' => true || false,
                        'privileged' => true || false,
                        'readOnlyRootFilesystem' => true || false,
                        'runAsGroup' => <integer>,
                        'runAsNonRoot' => true || false,
                        'runAsUser' => <integer>,
                    ],
                    'volumeMounts' => [
                        [
                            'mountPath' => '<string>',
                            'name' => '<string>',
                            'readOnly' => true || false,
                        ],
                        // ...
                    ],
                ],
                // ...
            ],
            'metadata' => [
                'labels' => ['<string>', ...],
            ],
            'serviceAccountName' => '<string>',
            'shareProcessNamespace' => true || false,
            'volumes' => [
                [
                    'emptyDir' => [
                        'medium' => '<string>',
                        'sizeLimit' => '<string>',
                    ],
                    'hostPath' => [
                        'path' => '<string>',
                    ],
                    'name' => '<string>', // REQUIRED
                    'secret' => [
                        'optional' => true || false,
                        'secretName' => '<string>', // REQUIRED
                    ],
                ],
                // ...
            ],
        ],
    ],
    'jobDefinitionName' => '<string>', // REQUIRED
    'nodeProperties' => [
        'mainNode' => <integer>, // REQUIRED
        'nodeRangeProperties' => [ // REQUIRED
            [
                'container' => [
                    'command' => ['<string>', ...],
                    'environment' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'ephemeralStorage' => [
                        'sizeInGiB' => <integer>, // REQUIRED
                    ],
                    'executionRoleArn' => '<string>',
                    'fargatePlatformConfiguration' => [
                        'platformVersion' => '<string>',
                    ],
                    'image' => '<string>',
                    'instanceType' => '<string>',
                    'jobRoleArn' => '<string>',
                    'linuxParameters' => [
                        'devices' => [
                            [
                                'containerPath' => '<string>',
                                'hostPath' => '<string>', // REQUIRED
                                'permissions' => ['<string>', ...],
                            ],
                            // ...
                        ],
                        'initProcessEnabled' => true || false,
                        'maxSwap' => <integer>,
                        'sharedMemorySize' => <integer>,
                        'swappiness' => <integer>,
                        'tmpfs' => [
                            [
                                'containerPath' => '<string>', // REQUIRED
                                'mountOptions' => ['<string>', ...],
                                'size' => <integer>, // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    'logConfiguration' => [
                        'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk', // REQUIRED
                        'options' => ['<string>', ...],
                        'secretOptions' => [
                            [
                                'name' => '<string>', // REQUIRED
                                'valueFrom' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    'memory' => <integer>,
                    'mountPoints' => [
                        [
                            'containerPath' => '<string>',
                            'readOnly' => true || false,
                            'sourceVolume' => '<string>',
                        ],
                        // ...
                    ],
                    'networkConfiguration' => [
                        'assignPublicIp' => 'ENABLED|DISABLED',
                    ],
                    'privileged' => true || false,
                    'readonlyRootFilesystem' => true || false,
                    'repositoryCredentials' => [
                        'credentialsParameter' => '<string>', // REQUIRED
                    ],
                    'resourceRequirements' => [
                        [
                            'type' => 'GPU|VCPU|MEMORY', // REQUIRED
                            'value' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'runtimePlatform' => [
                        'cpuArchitecture' => '<string>',
                        'operatingSystemFamily' => '<string>',
                    ],
                    'secrets' => [
                        [
                            'name' => '<string>', // REQUIRED
                            'valueFrom' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'ulimits' => [
                        [
                            'hardLimit' => <integer>, // REQUIRED
                            'name' => '<string>', // REQUIRED
                            'softLimit' => <integer>, // REQUIRED
                        ],
                        // ...
                    ],
                    'user' => '<string>',
                    'vcpus' => <integer>,
                    'volumes' => [
                        [
                            'efsVolumeConfiguration' => [
                                'authorizationConfig' => [
                                    'accessPointId' => '<string>',
                                    'iam' => 'ENABLED|DISABLED',
                                ],
                                'fileSystemId' => '<string>', // REQUIRED
                                'rootDirectory' => '<string>',
                                'transitEncryption' => 'ENABLED|DISABLED',
                                'transitEncryptionPort' => <integer>,
                            ],
                            'host' => [
                                'sourcePath' => '<string>',
                            ],
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'ecsProperties' => [
                    'taskProperties' => [ // REQUIRED
                        [
                            'containers' => [ // REQUIRED
                                [
                                    'command' => ['<string>', ...],
                                    'dependsOn' => [
                                        [
                                            'condition' => '<string>',
                                            'containerName' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'environment' => [
                                        [
                                            'name' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'essential' => true || false,
                                    'image' => '<string>', // REQUIRED
                                    'linuxParameters' => [
                                        'devices' => [
                                            [
                                                'containerPath' => '<string>',
                                                'hostPath' => '<string>', // REQUIRED
                                                'permissions' => ['<string>', ...],
                                            ],
                                            // ...
                                        ],
                                        'initProcessEnabled' => true || false,
                                        'maxSwap' => <integer>,
                                        'sharedMemorySize' => <integer>,
                                        'swappiness' => <integer>,
                                        'tmpfs' => [
                                            [
                                                'containerPath' => '<string>', // REQUIRED
                                                'mountOptions' => ['<string>', ...],
                                                'size' => <integer>, // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'logConfiguration' => [
                                        'logDriver' => 'json-file|syslog|journald|gelf|fluentd|awslogs|splunk', // REQUIRED
                                        'options' => ['<string>', ...],
                                        'secretOptions' => [
                                            [
                                                'name' => '<string>', // REQUIRED
                                                'valueFrom' => '<string>', // REQUIRED
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'mountPoints' => [
                                        [
                                            'containerPath' => '<string>',
                                            'readOnly' => true || false,
                                            'sourceVolume' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>',
                                    'privileged' => true || false,
                                    'readonlyRootFilesystem' => true || false,
                                    'repositoryCredentials' => [
                                        'credentialsParameter' => '<string>', // REQUIRED
                                    ],
                                    'resourceRequirements' => [
                                        [
                                            'type' => 'GPU|VCPU|MEMORY', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'secrets' => [
                                        [
                                            'name' => '<string>', // REQUIRED
                                            'valueFrom' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'ulimits' => [
                                        [
                                            'hardLimit' => <integer>, // REQUIRED
                                            'name' => '<string>', // REQUIRED
                                            'softLimit' => <integer>, // REQUIRED
                                        ],
                                        // ...
                                    ],
                                    'user' => '<string>',
                                ],
                                // ...
                            ],
                            'ephemeralStorage' => [
                                'sizeInGiB' => <integer>, // REQUIRED
                            ],
                            'executionRoleArn' => '<string>',
                            'ipcMode' => '<string>',
                            'networkConfiguration' => [
                                'assignPublicIp' => 'ENABLED|DISABLED',
                            ],
                            'pidMode' => '<string>',
                            'platformVersion' => '<string>',
                            'runtimePlatform' => [
                                'cpuArchitecture' => '<string>',
                                'operatingSystemFamily' => '<string>',
                            ],
                            'taskRoleArn' => '<string>',
                            'volumes' => [
                                [
                                    'efsVolumeConfiguration' => [
                                        'authorizationConfig' => [
                                            'accessPointId' => '<string>',
                                            'iam' => 'ENABLED|DISABLED',
                                        ],
                                        'fileSystemId' => '<string>', // REQUIRED
                                        'rootDirectory' => '<string>',
                                        'transitEncryption' => 'ENABLED|DISABLED',
                                        'transitEncryptionPort' => <integer>,
                                    ],
                                    'host' => [
                                        'sourcePath' => '<string>',
                                    ],
                                    'name' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
                'instanceTypes' => ['<string>', ...],
                'targetNodes' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'numNodes' => <integer>, // REQUIRED
    ],
    'parameters' => ['<string>', ...],
    'platformCapabilities' => ['<string>', ...],
    'propagateTags' => true || false,
    'retryStrategy' => [
        'attempts' => <integer>,
        'evaluateOnExit' => [
            [
                'action' => 'RETRY|EXIT', // REQUIRED
                'onExitCode' => '<string>',
                'onReason' => '<string>',
                'onStatusReason' => '<string>',
            ],
            // ...
        ],
    ],
    'schedulingPriority' => <integer>,
    'tags' => ['<string>', ...],
    'timeout' => [
        'attemptDurationSeconds' => <integer>,
    ],
    'type' => 'container|multinode', // REQUIRED
]);

Parameter Details

Members
containerProperties
Type: ContainerProperties structure

An object with properties specific to Amazon ECS-based single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties. This must not be specified for Amazon EKS-based job definitions.

If the job runs on Fargate resources, then you must not specify nodeProperties; use only containerProperties.

ecsProperties
Type: EcsProperties structure

An object with properties that are specific to Amazon ECS-based jobs. This must not be specified for Amazon EKS-based job definitions.

eksProperties
Type: EksProperties structure

An object with properties that are specific to Amazon EKS-based jobs. This must not be specified for Amazon ECS based job definitions.

jobDefinitionName
Required: Yes
Type: string

The name of the job definition to register. It can be up to 128 letters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

nodeProperties
Type: NodeProperties structure

An object with properties specific to multi-node parallel jobs. If you specify node properties for a job, it becomes a multi-node parallel job. For more information, see Multi-node Parallel Jobs in the Batch User Guide.

If the job runs on Fargate resources, then you must not specify nodeProperties; use containerProperties instead.

If the job runs on Amazon EKS resources, then you must not specify nodeProperties.

parameters
Type: Associative array of custom strings keys (String) to strings

Default parameter substitution placeholders to set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

platformCapabilities
Type: Array of strings

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. To run the job on Fargate resources, specify FARGATE.

If the job runs on Amazon EKS resources, then you must not specify platformCapabilities.

propagateTags
Type: boolean

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags are not propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

If the job runs on Amazon EKS resources, then you must not specify propagateTags.

retryStrategy
Type: RetryStrategy structure

The retry strategy to use for failed jobs that are submitted with this job definition. Any retry strategy that's specified during a SubmitJob operation overrides the retry strategy defined here. If a job is terminated due to a timeout, it isn't retried.

schedulingPriority
Type: int

The scheduling priority for jobs that are submitted with this job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

The minimum supported value is 0 and the maximum supported value is 9999.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags that you apply to the job definition to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Batch User Guide.

timeout
Type: JobTimeout structure

The timeout configuration for jobs that are submitted with this job definition, after which Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. Any timeout configuration that's specified during a SubmitJob operation overrides the timeout configuration defined here. For more information, see Job Timeouts in the Batch User Guide.

type
Required: Yes
Type: string

The type of job definition. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

  • If the value is container, then one of the following is required: containerProperties, ecsProperties, or eksProperties.

  • If the value is multinode, then nodeProperties is required.

If the job is run on Fargate resources, then multinode isn't supported.

Result Syntax

[
    'jobDefinitionArn' => '<string>',
    'jobDefinitionName' => '<string>',
    'revision' => <integer>,
]

Result Details

Members
jobDefinitionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the job definition.

jobDefinitionName
Required: Yes
Type: string

The name of the job definition.

revision
Required: Yes
Type: int

The revision of the job definition.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To register a job definition

This example registers a job definition for a simple container job.

$result = $client->registerJobDefinition([
    'type' => 'container',
    'containerProperties' => [
        'command' => [
            'sleep',
            '10',
        ],
        'image' => 'busybox',
        'resourceRequirements' => [
            [
                'type' => 'MEMORY',
                'value' => '128',
            ],
            [
                'type' => 'VCPU',
                'value' => '1',
            ],
        ],
    ],
    'jobDefinitionName' => 'sleep10',
]);

Result syntax:

[
    'jobDefinitionArn' => 'arn:aws:batch:us-east-1:012345678910:job-definition/sleep10:1',
    'jobDefinitionName' => 'sleep10',
    'revision' => 1,
]
Example 2: RegisterJobDefinition with tags

This demonstrates calling the RegisterJobDefinition action, including tags.

$result = $client->registerJobDefinition([
    'type' => 'container',
    'containerProperties' => [
        'command' => [
            'sleep',
            '30',
        ],
        'image' => 'busybox',
        'resourceRequirements' => [
            [
                'type' => 'MEMORY',
                'value' => '128',
            ],
            [
                'type' => 'VCPU',
                'value' => '1',
            ],
        ],
    ],
    'jobDefinitionName' => 'sleep30',
    'tags' => [
        'Department' => 'Engineering',
        'User' => 'JaneDoe',
    ],
]);

Result syntax:

[
    'jobDefinitionArn' => 'arn:aws:batch:us-east-1:012345678910:job-definition/sleep30:1',
    'jobDefinitionName' => 'sleep30',
    'revision' => 1,
]

SubmitJob

$result = $client->submitJob([/* ... */]);
$promise = $client->submitJobAsync([/* ... */]);

Submits an 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.

Job queues with a scheduling policy are limited to 500 active fair share identifiers at a time.

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.

Parameter Syntax

$result = $client->submitJob([
    'arrayProperties' => [
        'size' => <integer>,
    ],
    'containerOverrides' => [
        'command' => ['<string>', ...],
        'environment' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'instanceType' => '<string>',
        'memory' => <integer>,
        'resourceRequirements' => [
            [
                'type' => 'GPU|VCPU|MEMORY', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'vcpus' => <integer>,
    ],
    'dependsOn' => [
        [
            'jobId' => '<string>',
            'type' => 'N_TO_N|SEQUENTIAL',
        ],
        // ...
    ],
    'ecsPropertiesOverride' => [
        'taskProperties' => [
            [
                'containers' => [
                    [
                        'command' => ['<string>', ...],
                        'environment' => [
                            [
                                'name' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                        'name' => '<string>',
                        'resourceRequirements' => [
                            [
                                'type' => 'GPU|VCPU|MEMORY', // REQUIRED
                                'value' => '<string>', // REQUIRED
                            ],
                            // ...
                        ],
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
    'eksPropertiesOverride' => [
        'podProperties' => [
            'containers' => [
                [
                    'args' => ['<string>', ...],
                    'command' => ['<string>', ...],
                    'env' => [
                        [
                            'name' => '<string>', // REQUIRED
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'image' => '<string>',
                    'name' => '<string>',
                    'resources' => [
                        'limits' => ['<string>', ...],
                        'requests' => ['<string>', ...],
                    ],
                ],
                // ...
            ],
            'initContainers' => [
                [
                    'args' => ['<string>', ...],
                    'command' => ['<string>', ...],
                    'env' => [
                        [
                            'name' => '<string>', // REQUIRED
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'image' => '<string>',
                    'name' => '<string>',
                    'resources' => [
                        'limits' => ['<string>', ...],
                        'requests' => ['<string>', ...],
                    ],
                ],
                // ...
            ],
            'metadata' => [
                'labels' => ['<string>', ...],
            ],
        ],
    ],
    'jobDefinition' => '<string>', // REQUIRED
    'jobName' => '<string>', // REQUIRED
    'jobQueue' => '<string>', // REQUIRED
    'nodeOverrides' => [
        'nodePropertyOverrides' => [
            [
                'containerOverrides' => [
                    'command' => ['<string>', ...],
                    'environment' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'instanceType' => '<string>',
                    'memory' => <integer>,
                    'resourceRequirements' => [
                        [
                            'type' => 'GPU|VCPU|MEMORY', // REQUIRED
                            'value' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'vcpus' => <integer>,
                ],
                'ecsPropertiesOverride' => [
                    'taskProperties' => [
                        [
                            'containers' => [
                                [
                                    'command' => ['<string>', ...],
                                    'environment' => [
                                        [
                                            'name' => '<string>',
                                            'value' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'name' => '<string>',
                                    'resourceRequirements' => [
                                        [
                                            'type' => 'GPU|VCPU|MEMORY', // REQUIRED
                                            'value' => '<string>', // REQUIRED
                                        ],
                                        // ...
                                    ],
                                ],
                                // ...
                            ],
                        ],
                        // ...
                    ],
                ],
                'instanceTypes' => ['<string>', ...],
                'targetNodes' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'numNodes' => <integer>,
    ],
    'parameters' => ['<string>', ...],
    'propagateTags' => true || false,
    'retryStrategy' => [
        'attempts' => <integer>,
        'evaluateOnExit' => [
            [
                'action' => 'RETRY|EXIT', // REQUIRED
                'onExitCode' => '<string>',
                'onReason' => '<string>',
                'onStatusReason' => '<string>',
            ],
            // ...
        ],
    ],
    'schedulingPriorityOverride' => <integer>,
    'shareIdentifier' => '<string>',
    'tags' => ['<string>', ...],
    'timeout' => [
        'attemptDurationSeconds' => <integer>,
    ],
]);

Parameter Details

Members
arrayProperties
Type: ArrayProperties structure

The array properties for the submitted job, such as the size of the array. The array size can be between 2 and 10,000. If you specify array properties for a job, it becomes an array job. For more information, see Array Jobs in the Batch User Guide.

containerOverrides
Type: ContainerOverrides structure

An object with properties that override the defaults for the job definition that specify the name of a container in the specified job definition and the overrides it should receive. You can override the default command for a container, which is specified in the job definition or the Docker image, with a command override. You can also override existing environment variables on a container or add new environment variables to it with an environment override.

dependsOn
Type: Array of JobDependency structures

A list of dependencies for the job. A job can depend upon a maximum of 20 jobs. You can specify a SEQUENTIAL type dependency without specifying a job ID for array jobs so that each child array job completes sequentially, starting at index 0. You can also specify an N_TO_N type dependency with a job ID for array jobs. In that case, each index child of this job must wait for the corresponding index child of each dependency to complete before it can begin.

ecsPropertiesOverride
Type: EcsPropertiesOverride structure

An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon ECS resources.

eksPropertiesOverride
Type: EksPropertiesOverride structure

An object, with properties that override defaults for the job definition, can only be specified for jobs that are run on Amazon EKS resources.

jobDefinition
Required: Yes
Type: string

The job definition used by this job. This value can be one of definition-name, definition-name:revision, or the Amazon Resource Name (ARN) for the job definition, with or without the revision (arn:aws:batch:region:account:job-definition/definition-name:revision , or arn:aws:batch:region:account:job-definition/definition-name ).

If the revision is not specified, then the latest active revision is used.

jobName
Required: Yes
Type: string

The name of the job. It can be up to 128 letters long. The first character must be alphanumeric, can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

jobQueue
Required: Yes
Type: string

The job queue where the job is submitted. You can specify either the name or the Amazon Resource Name (ARN) of the queue.

nodeOverrides
Type: NodeOverrides structure

A list of node overrides in JSON format that specify the node range to target and the container overrides for that node range.

This parameter isn't applicable to jobs that are running on Fargate resources; use containerOverrides instead.

parameters
Type: Associative array of custom strings keys (String) to strings

Additional parameters passed to the job that replace parameter substitution placeholders that are set in the job definition. Parameters are specified as a key and value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition.

propagateTags
Type: boolean

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks during task creation. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state. When specified, this overrides the tag propagation setting in the job definition.

retryStrategy
Type: RetryStrategy structure

The retry strategy to use for failed jobs from this SubmitJob operation. When a retry strategy is specified here, it overrides the retry strategy defined in the job definition.

schedulingPriorityOverride
Type: int

The scheduling priority for the job. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority. This overrides any scheduling priority in the job definition and works only within a single share identifier.

The minimum supported value is 0 and the maximum supported value is 9999.

shareIdentifier
Type: string

The share identifier for the job. Don't specify this parameter if the job queue doesn't have a scheduling policy. If the job queue has a scheduling policy, then this parameter must be specified.

This string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags that you apply to the job request to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

timeout
Type: JobTimeout structure

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which Batch terminates your jobs if they haven't finished. If a job is terminated due to a timeout, it isn't retried. The minimum value for the timeout is 60 seconds. This configuration overrides any timeout configuration specified in the job definition. For array jobs, child jobs have the same timeout configuration as the parent job. For more information, see Job Timeouts in the Amazon Elastic Container Service Developer Guide.

Result Syntax

[
    'jobArn' => '<string>',
    'jobId' => '<string>',
    'jobName' => '<string>',
]

Result Details

Members
jobArn
Type: string

The Amazon Resource Name (ARN) for the job.

jobId
Required: Yes
Type: string

The unique identifier for the job.

jobName
Required: Yes
Type: string

The name of the job.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To submit a job to a queue

This example submits a simple container job called example to the HighPriority job queue.

$result = $client->submitJob([
    'jobDefinition' => 'sleep60',
    'jobName' => 'example',
    'jobQueue' => 'HighPriority',
]);

Result syntax:

[
    'jobId' => '876da822-4198-45f2-a252-6cea32512ea8',
    'jobName' => 'example',
]

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

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 that are associated with that resource are deleted as well. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

Parameter Syntax

$result = $client->tagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource that tags are added to. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

tags
Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

The tags that you apply to the resource to help you categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services Resources in Amazon Web Services General Reference.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: TagResource Example

This demonstrates calling the TagResource action.

$result = $client->tagResource([
    'resourceArn' => 'arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1',
    'tags' => [
        'Stage' => 'Alpha',
    ],
]);

Result syntax:

[
]

TerminateJob

$result = $client->terminateJob([/* ... */]);
$promise = $client->terminateJobAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->terminateJob([
    'jobId' => '<string>', // REQUIRED
    'reason' => '<string>', // REQUIRED
]);

Parameter Details

Members
jobId
Required: Yes
Type: string

The Batch job ID of the job to terminate.

reason
Required: Yes
Type: string

A message to attach to the job that explains the reason for canceling it. This message is returned by future DescribeJobs operations on the job. This message is also recorded in the Batch activity logs.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To terminate a job

This example terminates a job with the specified job ID.

$result = $client->terminateJob([
    'jobId' => '61e743ed-35e4-48da-b2de-5c8333821c84',
    'reason' => 'Terminating job.',
]);

Result syntax:

[
]

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Deletes specified tags from an Batch resource.

Parameter Syntax

$result = $client->untagResource([
    'resourceArn' => '<string>', // REQUIRED
    'tagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members
resourceArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the resource from which to delete tags. Batch resources that support tags are compute environments, jobs, job definitions, job queues, and scheduling policies. ARNs for child jobs of array and multi-node parallel (MNP) jobs aren't supported.

tagKeys
Required: Yes
Type: Array of strings

The keys of the tags to be removed.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: UntagResource Example

This demonstrates calling the UntagResource action.

$result = $client->untagResource([
    'resourceArn' => 'arn:aws:batch:us-east-1:123456789012:job-definition/sleep30:1',
    'tagKeys' => [
        'Stage',
    ],
]);

Result syntax:

[
]

UpdateComputeEnvironment

$result = $client->updateComputeEnvironment([/* ... */]);
$promise = $client->updateComputeEnvironmentAsync([/* ... */]);

Updates an Batch compute environment.

Parameter Syntax

$result = $client->updateComputeEnvironment([
    'computeEnvironment' => '<string>', // REQUIRED
    'computeResources' => [
        'allocationStrategy' => 'BEST_FIT_PROGRESSIVE|SPOT_CAPACITY_OPTIMIZED|SPOT_PRICE_CAPACITY_OPTIMIZED',
        'bidPercentage' => <integer>,
        'desiredvCpus' => <integer>,
        'ec2Configuration' => [
            [
                'imageIdOverride' => '<string>',
                'imageKubernetesVersion' => '<string>',
                'imageType' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ec2KeyPair' => '<string>',
        'imageId' => '<string>',
        'instanceRole' => '<string>',
        'instanceTypes' => ['<string>', ...],
        'launchTemplate' => [
            'launchTemplateId' => '<string>',
            'launchTemplateName' => '<string>',
            'version' => '<string>',
        ],
        'maxvCpus' => <integer>,
        'minvCpus' => <integer>,
        'placementGroup' => '<string>',
        'securityGroupIds' => ['<string>', ...],
        'subnets' => ['<string>', ...],
        'tags' => ['<string>', ...],
        'type' => 'EC2|SPOT|FARGATE|FARGATE_SPOT',
        'updateToLatestImageVersion' => true || false,
    ],
    'serviceRole' => '<string>',
    'state' => 'ENABLED|DISABLED',
    'unmanagedvCpus' => <integer>,
    'updatePolicy' => [
        'jobExecutionTimeoutMinutes' => <integer>,
        'terminateJobsOnUpdate' => true || false,
    ],
]);

Parameter Details

Members
computeEnvironment
Required: Yes
Type: string

The name or full Amazon Resource Name (ARN) of the compute environment to update.

computeResources
Type: ComputeResourceUpdate structure

Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the Batch User Guide.

serviceRole
Type: string

The full Amazon Resource Name (ARN) of the IAM role that allows Batch to make calls to other Amazon Web Services services on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

If the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Batch User Guide.

If your specified role has a path other than /, then you must either specify the full role ARN (recommended) or prefix the role name with the path.

Depending on how you created your Batch service role, its ARN might contain the service-role path prefix. When you only specify the name of the service role, Batch assumes that your ARN doesn't use the service-role path prefix. Because of this, we recommend that you specify the full ARN of your service role when you create compute environments.

state
Type: string

The state of the compute environment. Compute environments in the ENABLED state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically, based on the job queue demand.

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out.

Compute environments in a DISABLED state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.

When an instance is idle, the instance scales down to the minvCpus value. However, the instance size doesn't change. For example, consider a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus value of 36. This instance doesn't scale down to a c5.large instance.

unmanagedvCpus
Type: int

The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this parameter for a managed compute environment. This parameter is only used for fair share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair share job queue, no vCPU capacity is reserved.

updatePolicy
Type: UpdatePolicy structure

Specifies the updated infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

Result Syntax

[
    'computeEnvironmentArn' => '<string>',
    'computeEnvironmentName' => '<string>',
]

Result Details

Members
computeEnvironmentArn
Type: string

The Amazon Resource Name (ARN) of the compute environment.

computeEnvironmentName
Type: string

The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To update a compute environment

This example disables the P2OnDemand compute environment so it can be deleted.

$result = $client->updateComputeEnvironment([
    'computeEnvironment' => 'P2OnDemand',
    'state' => 'DISABLED',
]);

Result syntax:

[
    'computeEnvironmentArn' => 'arn:aws:batch:us-east-1:012345678910:compute-environment/P2OnDemand',
    'computeEnvironmentName' => 'P2OnDemand',
]

UpdateJobQueue

$result = $client->updateJobQueue([/* ... */]);
$promise = $client->updateJobQueueAsync([/* ... */]);

Updates a job queue.

Parameter Syntax

$result = $client->updateJobQueue([
    'computeEnvironmentOrder' => [
        [
            'computeEnvironment' => '<string>', // REQUIRED
            'order' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'jobQueue' => '<string>', // REQUIRED
    'jobStateTimeLimitActions' => [
        [
            'action' => 'CANCEL', // REQUIRED
            'maxTimeSeconds' => <integer>, // REQUIRED
            'reason' => '<string>', // REQUIRED
            'state' => 'RUNNABLE', // REQUIRED
        ],
        // ...
    ],
    'priority' => <integer>,
    'schedulingPolicyArn' => '<string>',
    'state' => 'ENABLED|DISABLED',
]);

Parameter Details

Members
computeEnvironmentOrder
Type: Array of ComputeEnvironmentOrder structures

Details the set of compute environments mapped to a job queue and their order relative to each other. This is one of the parameters used by the job scheduler to determine which compute environment runs a given job. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

jobQueue
Required: Yes
Type: string

The name or the Amazon Resource Name (ARN) of the job queue.

jobStateTimeLimitActions
Type: Array of JobStateTimeLimitAction structures

The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed.

priority
Type: int

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). EC2 and Fargate compute environments can't be mixed.

schedulingPolicyArn
Type: string

Amazon Resource Name (ARN) of the fair share scheduling policy. Once a job queue is created, the fair share scheduling policy can be replaced but not removed. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

state
Type: string

Describes the queue's ability to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

Result Syntax

[
    'jobQueueArn' => '<string>',
    'jobQueueName' => '<string>',
]

Result Details

Members
jobQueueArn
Type: string

The Amazon Resource Name (ARN) of the job queue.

jobQueueName
Type: string

The name of the job queue.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To update a job queue

This example disables a job queue so that it can be deleted.

$result = $client->updateJobQueue([
    'jobQueue' => 'GPGPU',
    'state' => 'DISABLED',
]);

Result syntax:

[
    'jobQueueArn' => 'arn:aws:batch:us-east-1:012345678910:job-queue/GPGPU',
    'jobQueueName' => 'GPGPU',
]

UpdateSchedulingPolicy

$result = $client->updateSchedulingPolicy([/* ... */]);
$promise = $client->updateSchedulingPolicyAsync([/* ... */]);

Updates a scheduling policy.

Parameter Syntax

$result = $client->updateSchedulingPolicy([
    'arn' => '<string>', // REQUIRED
    'fairsharePolicy' => [
        'computeReservation' => <integer>,
        'shareDecaySeconds' => <integer>,
        'shareDistribution' => [
            [
                'shareIdentifier' => '<string>', // REQUIRED
                'weightFactor' => <float>,
            ],
            // ...
        ],
    ],
]);

Parameter Details

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the scheduling policy to update.

fairsharePolicy
Type: FairsharePolicy structure

The fair share policy.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ClientException:

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

ServerException:

These errors are usually caused by a server issue.

Shapes

ArrayProperties

Description

An object that represents an Batch array job.

Members
size
Type: int

The size of the array job.

ArrayPropertiesDetail

Description

An object that represents the array properties of a job.

Members
index
Type: int

The job index within the array that's associated with this job. This parameter is returned for array job children.

size
Type: int

The size of the array job. This parameter is returned for parent array jobs.

statusSummary
Type: Associative array of custom strings keys (String) to ints

A summary of the number of array job children in each available job status. This parameter is returned for parent array jobs.

ArrayPropertiesSummary

Description

An object that represents the array properties of a job.

Members
index
Type: int

The job index within the array that's associated with this job. This parameter is returned for children of array jobs.

size
Type: int

The size of the array job. This parameter is returned for parent array jobs.

AttemptContainerDetail

Description

An object that represents the details of a container that's part of a job attempt.

Members
containerInstanceArn
Type: string

The Amazon Resource Name (ARN) of the Amazon ECS container instance that hosts the job attempt.

exitCode
Type: int

The exit code for the job attempt. A non-zero exit code is considered failed.

logStreamName
Type: string

The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

networkInterfaces
Type: Array of NetworkInterface structures

The network interfaces that are associated with the job attempt.

reason
Type: string

A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

taskArn
Type: string

The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the job attempt. Each container attempt receives a task ARN when they reach the STARTING status.

AttemptDetail

Description

An object that represents a job attempt.

Members
container
Type: AttemptContainerDetail structure

The details for the container in this job attempt.

startedAt
Type: long (int|float)

The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the STARTING state to the RUNNING state).

statusReason
Type: string

A short, human-readable string to provide additional details for the current status of the job attempt.

stoppedAt
Type: long (int|float)

The Unix timestamp (in milliseconds) for when the attempt was stopped (when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED).

taskProperties
Type: Array of AttemptEcsTaskDetails structures

The properties for a task definition that describes the container and volume definitions of an Amazon ECS task.

AttemptEcsTaskDetails

Description

An object that represents the details of a task.

Members
containerInstanceArn
Type: string

The Amazon Resource Name (ARN) of the container instance that hosts the task.

containers
Type: Array of AttemptTaskContainerDetails structures

A list of containers that are included in the taskProperties list.

taskArn
Type: string

The ARN of the Amazon ECS task.

AttemptTaskContainerDetails

Description

An object that represents the details of a container that's part of a job attempt.

Members
exitCode
Type: int

The exit code for the container’s attempt. A non-zero exit code is considered failed.

logStreamName
Type: string

The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

name
Type: string

The name of a container.

networkInterfaces
Type: Array of NetworkInterface structures

The network interfaces that are associated with the job attempt.

reason
Type: string

A short (255 max characters) string that's easy to understand and provides additional details for a running or stopped container.

ClientException

Description

These errors are usually caused by a client action. One example cause is using an action or resource on behalf of a user that doesn't have permissions to use the action or resource. Another cause is specifying an identifier that's not valid.

Members
message
Type: string

ComputeEnvironmentDetail

Description

An object that represents an Batch compute environment.

Members
computeEnvironmentArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the compute environment.

computeEnvironmentName
Required: Yes
Type: string

The name of the compute environment. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).

computeResources
Type: ComputeResource structure

The compute resources defined for the compute environment. For more information, see Compute environments in the Batch User Guide.

containerOrchestrationType
Type: string

The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

ecsClusterArn
Type: string

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster that the compute environment uses.

eksConfiguration
Type: EksConfiguration structure

The configuration for the Amazon EKS cluster that supports the Batch compute environment. Only specify this parameter if the containerOrchestrationType is EKS.

serviceRole
Type: string

The service role that's associated with the compute environment that allows Batch to make calls to Amazon Web Services API operations on your behalf. For more information, see Batch service IAM role in the Batch User Guide.

state
Type: string

The state of the compute environment. The valid values are ENABLED or DISABLED.

If the state is ENABLED, then the Batch scheduler can attempt to place jobs from an associated job queue on the compute resources within the environment. If the compute environment is managed, then it can scale its instances out or in automatically based on the job queue demand.

If the state is DISABLED, then the Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out.

Compute environments in a DISABLED state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Batch User Guide.

When an instance is idle, the instance scales down to the minvCpus value. However, the instance size doesn't change. For example, consider a c5.8xlarge instance with a minvCpus value of 4 and a desiredvCpus value of 36. This instance doesn't scale down to a c5.large instance.

status
Type: string

The current status of the compute environment (for example, CREATING or VALID).

statusReason
Type: string

A short, human-readable string to provide additional details for the current status of the compute environment.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags applied to the compute environment.

type
Type: string

The type of the compute environment: MANAGED or UNMANAGED. For more information, see Compute environments in the Batch User Guide.

unmanagedvCpus
Type: int

The maximum number of VCPUs expected to be used for an unmanaged compute environment.

updatePolicy
Type: UpdatePolicy structure

Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

uuid
Type: string

Unique identifier for the compute environment.

ComputeEnvironmentOrder

Description

The order that compute environments are tried in for job placement within a queue. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first. Compute environments must be in the VALID state before you can associate them with a job queue. All of the compute environments must be either EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT); Amazon EC2 and Fargate compute environments can't be mixed.

All compute environments that are associated with a job queue must share the same architecture. Batch doesn't support mixing compute environment architecture types in a single job queue.

Members
computeEnvironment
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the compute environment.

order
Required: Yes
Type: int

The order of the compute environment. Compute environments are tried in ascending order. For example, if two compute environments are associated with a job queue, the compute environment with a lower order integer value is tried for job placement first.

ComputeResource

Description

An object that represents an Batch compute resource. For more information, see Compute environments in the Batch User Guide.

Members
allocationStrategy
Type: string

The allocation strategy to use for the compute resource if not enough instances of the best fitting instance type can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

BEST_FIT (default)

Batch selects an instance type that best fits the needs of the jobs with a preference for the lowest-cost instance type. If additional instances of the selected instance type aren't available, Batch waits for the additional instances to be available. If there aren't enough instances available or the user is reaching Amazon EC2 service limits, additional jobs aren't run until the currently running jobs are completed. This allocation strategy keeps costs lower but can limit scaling. If you're using Spot Fleets with BEST_FIT, the Spot Fleet IAM Role must be specified. Compute resources that use a BEST_FIT allocation strategy don't support infrastructure updates and can't update some parameters. For more information, see Updating compute environments in the Batch User Guide.

BEST_FIT_PROGRESSIVE

Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected instance types aren't available, Batch selects new instance types.

SPOT_CAPACITY_OPTIMIZED

Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.

SPOT_PRICE_CAPACITY_OPTIMIZED

The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price. This allocation strategy is only available for Spot Instance compute resources.

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

bidPercentage
Type: int

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, then the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. If you leave this field empty, the default value is 100% of the On-Demand price. For most use cases, we recommend leaving this field empty.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

desiredvCpus
Type: int

The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

ec2Configuration
Type: Array of Ec2Configuration structures

Provides information that's used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2.

One or two values can be provided.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

ec2KeyPair
Type: string

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

imageId
Type: string

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

instanceRole
Type: string

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. This parameter is required for Amazon EC2 instances types. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS instance role in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

instanceTypes
Type: Array of strings

The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5, and R5 instance families are used.

launchTemplate
Type: LaunchTemplateSpecification structure

The launch template to use for your compute resources. Any other compute resource parameters that you specify in a CreateComputeEnvironment API operation override the same parameters in the launch template. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch template support in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

maxvCpus
Required: Yes
Type: int

The maximum number of vCPUs that a compute environment can support.

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

minvCpus
Type: int

The minimum number of vCPUs that a compute environment should maintain (even if the compute environment is DISABLED).

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

placementGroup
Type: string

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

securityGroupIds
Type: Array of strings

The Amazon EC2 security groups that are associated with instances launched in the compute environment. One or more security groups must be specified, either in securityGroupIds or using a launch template referenced in launchTemplate. This parameter is required for jobs that are running on Fargate resources and must contain at least one security group. Fargate doesn't support launch templates. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds are used.

spotIamFleetRole
Type: string

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. This role is required if the allocation strategy set to BEST_FIT or if the allocation strategy isn't specified. For more information, see Amazon EC2 spot fleet role in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

To tag your Spot Instances on creation, the Spot Fleet IAM role specified here must use the newer AmazonEC2SpotFleetTaggingRole managed policy. The previously recommended AmazonEC2SpotFleetRole managed policy doesn't have the required permissions to tag Spot Instances. For more information, see Spot instances not tagged on creation in the Batch User Guide.

subnets
Required: Yes
Type: Array of strings

The VPC subnets where the compute resources are launched. These subnets must be within the same VPC. Fargate compute resources can contain up to 16 subnets. For more information, see VPCs and subnets in the Amazon VPC User Guide.

Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS Developer Guide.

Batch on Fargate doesn't currently support Local Zones.

tags
Type: Associative array of custom strings keys (String) to strings

Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute environment. For Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value-for example, { "Name": "Batch Instance - C4OnDemand" }. This is helpful for recognizing your Batch instances in the Amazon EC2 console. Updating these tags requires an infrastructure update to the compute environment. For more information, see Updating compute environments in the Batch User Guide. These tags aren't seen when using the Batch ListTagsForResource API operation.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

type
Required: Yes
Type: string

The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute environments in the Batch User Guide.

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the Batch User Guide.

ComputeResourceUpdate

Description

An object that represents the attributes of a compute environment that can be updated. For more information, see Updating compute environments in the Batch User Guide.

Members
allocationStrategy
Type: string

The allocation strategy to use for the compute resource if there's not enough instances of the best fitting instance type that can be allocated. This might be because of availability of the instance type in the Region or Amazon EC2 service limits. For more information, see Allocation strategies in the Batch User Guide.

When updating a compute environment, changing the allocation strategy requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. BEST_FIT isn't supported when updating a compute environment.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

BEST_FIT_PROGRESSIVE

Batch selects additional instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types with lower cost vCPUs. If additional instances of the previously selected instance types aren't available, Batch selects new instance types.

SPOT_CAPACITY_OPTIMIZED

Batch selects one or more instance types that are large enough to meet the requirements of the jobs in the queue. Its preference is for instance types that are less likely to be interrupted. This allocation strategy is only available for Spot Instance compute resources.

SPOT_PRICE_CAPACITY_OPTIMIZED

The price and capacity optimized allocation strategy looks at both price and capacity to select the Spot Instance pools that are the least likely to be interrupted and have the lowest possible price. This allocation strategy is only available for Spot Instance compute resources.

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

bidPercentage
Type: int

The maximum percentage that a Spot Instance price can be when compared with the On-Demand price for that instance type before instances are launched. For example, if your maximum percentage is 20%, the Spot price must be less than 20% of the current On-Demand price for that Amazon EC2 instance. You always pay the lowest (market) price and never more than your maximum percentage. For most use cases, we recommend leaving this field empty.

When updating a compute environment, changing the bid percentage requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

desiredvCpus
Type: int

The desired number of vCPUS in the compute environment. Batch modifies this value between the minimum and maximum values based on job queue demand.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

Batch doesn't support changing the desired number of vCPUs of an existing compute environment. Don't specify this parameter for compute environments using Amazon EKS clusters.

When you update the desiredvCpus setting, the value must be between the minvCpus and maxvCpus values.

Additionally, the updated desiredvCpus value must be greater than or equal to the current desiredvCpus value. For more information, see Troubleshooting Batch in the Batch User Guide.

ec2Configuration
Type: Array of Ec2Configuration structures

Provides information used to select Amazon Machine Images (AMIs) for Amazon EC2 instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide. To remove the Amazon EC2 configuration and any custom AMI ID specified in imageIdOverride, set this value to an empty string.

One or two values can be provided.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

ec2KeyPair
Type: string

The Amazon EC2 key pair that's used for instances launched in the compute environment. You can use this key pair to log in to your instances with SSH. To remove the Amazon EC2 key pair, set this value to an empty string.

When updating a compute environment, changing the Amazon EC2 key pair requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

imageId
Type: string

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment. This parameter is overridden by the imageIdOverride member of the Ec2Configuration structure. To remove the custom AMI ID and use the default AMI ID, set this value to an empty string.

When updating a compute environment, changing the AMI ID requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

instanceRole
Type: string

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. Required for Amazon EC2 instances. You can specify the short name or full Amazon Resource Name (ARN) of an instance profile. For example, ecsInstanceRole or arn:aws:iam::<aws_account_id>:instance-profile/ecsInstanceRole . For more information, see Amazon ECS instance role in the Batch User Guide.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

instanceTypes
Type: Array of strings

The instances types that can be launched. You can specify instance families to launch any instance type within those families (for example, c5 or p3), or you can specify specific sizes within a family (such as c5.8xlarge). You can also choose optimal to select instance types (from the C4, M4, and R4 instance families) that match the demand of your job queues.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

When you create a compute environment, the instance types that you select for the compute environment must share the same architecture. For example, you can't mix x86 and ARM instances in the same compute environment.

Currently, optimal uses instance types from the C4, M4, and R4 instance families. In Regions that don't have instance types from those instance families, instance types from the C5, M5, and R5 instance families are used.

launchTemplate
Type: LaunchTemplateSpecification structure

The updated launch template to use for your compute resources. You must specify either the launch template ID or launch template name in the request, but not both. For more information, see Launch template support in the Batch User Guide. To remove the custom launch template and use the default launch template, set launchTemplateId or launchTemplateName member of the launch template specification to an empty string. Removing the launch template from a compute environment will not remove the AMI specified in the launch template. In order to update the AMI specified in a launch template, the updateToLatestImageVersion parameter must be set to true.

When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

maxvCpus
Type: int

The maximum number of Amazon EC2 vCPUs that an environment can reach.

With BEST_FIT_PROGRESSIVE,SPOT_CAPACITY_OPTIMIZED and SPOT_PRICE_CAPACITY_OPTIMIZED (recommended) strategies using On-Demand or Spot Instances, and the BEST_FIT strategy using Spot Instances, Batch might need to exceed maxvCpus to meet your capacity requirements. In this event, Batch never exceeds maxvCpus by more than a single instance.

minvCpus
Type: int

The minimum number of vCPUs that an environment should maintain (even if the compute environment is DISABLED).

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

placementGroup
Type: string

The Amazon EC2 placement group to associate with your compute resources. If you intend to submit multi-node parallel jobs to your compute environment, you should consider creating a cluster placement group and associate it with your compute resources. This keeps your multi-node parallel job on a logical grouping of instances within a single Availability Zone with high network flow potential. For more information, see Placement groups in the Amazon EC2 User Guide for Linux Instances.

When updating a compute environment, changing the placement group requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

securityGroupIds
Type: Array of strings

The Amazon EC2 security groups that are associated with instances launched in the compute environment. This parameter is required for Fargate compute resources, where it can contain up to 5 security groups. For Fargate compute resources, providing an empty list is handled as if this parameter wasn't specified and no change is made. For Amazon EC2 compute resources, providing an empty list removes the security groups from the compute resource.

When updating a compute environment, changing the Amazon EC2 security groups requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

subnets
Type: Array of strings

The VPC subnets where the compute resources are launched. Fargate compute resources can contain up to 16 subnets. For Fargate compute resources, providing an empty list will be handled as if this parameter wasn't specified and no change is made. For Amazon EC2 compute resources, providing an empty list removes the VPC subnets from the compute resource. For more information, see VPCs and subnets in the Amazon VPC User Guide.

When updating a compute environment, changing the VPC subnets requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

Batch on Amazon EC2 and Batch on Amazon EKS support Local Zones. For more information, see Local Zones in the Amazon EC2 User Guide for Linux Instances, Amazon EKS and Amazon Web Services Local Zones in the Amazon EKS User Guide and Amazon ECS clusters in Local Zones, Wavelength Zones, and Amazon Web Services Outposts in the Amazon ECS Developer Guide.

Batch on Fargate doesn't currently support Local Zones.

tags
Type: Associative array of custom strings keys (String) to strings

Key-value pair tags to be applied to Amazon EC2 resources that are launched in the compute environment. For Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value-for example, { "Name": "Batch Instance - C4OnDemand" }. This is helpful for recognizing your Batch instances in the Amazon EC2 console. These tags aren't seen when using the Batch ListTagsForResource API operation.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't specify it.

type
Type: string

The type of compute environment: EC2, SPOT, FARGATE, or FARGATE_SPOT. For more information, see Compute environments in the Batch User Guide.

If you choose SPOT, you must also specify an Amazon EC2 Spot Fleet role with the spotIamFleetRole parameter. For more information, see Amazon EC2 spot fleet role in the Batch User Guide.

When updating a compute environment, changing the type of a compute environment requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

updateToLatestImageVersion
Type: boolean

Specifies whether the AMI ID is updated to the latest one that's supported by Batch when the compute environment has an infrastructure update. The default value is false.

An AMI ID can either be specified in the imageId or imageIdOverride parameters or be determined by the launch template that's specified in the launchTemplate parameter. If an AMI ID is specified any of these ways, this parameter is ignored. For more information about to update AMI IDs during an infrastructure update, see Updating the AMI ID in the Batch User Guide.

When updating a compute environment, changing this setting requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

ContainerDetail

Description

An object that represents the details of a container that's part of a job.

Members
command
Type: Array of strings

The command that's passed to the container.

containerInstanceArn
Type: string

The Amazon Resource Name (ARN) of the container instance that the container is running on.

environment
Type: Array of KeyValuePair structures

The environment variables to pass to a container.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

ephemeralStorage
Type: EphemeralStorage structure

The amount of ephemeral storage allocated for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.

executionRoleArn
Type: string

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.

exitCode
Type: int

The exit code returned upon completion.

fargatePlatformConfiguration

The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

image
Type: string

The image used to start the container.

instanceType
Type: string

The instance type of the underlying host infrastructure of a multi-node parallel job.

This parameter isn't applicable to jobs that are running on Fargate resources.

jobRoleArn
Type: string

The Amazon Resource Name (ARN) that's associated with the job when run.

linuxParameters
Type: LinuxParameters structure

Linux-specific modifications that are applied to the container, such as details for device mappings.

logConfiguration
Type: LogConfiguration structure

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance. Or, alternatively, it must be configured on a different log server for remote logging options. For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers might be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

logStreamName
Type: string

The name of the Amazon CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

memory
Type: int

For jobs running on Amazon EC2 resources that didn't specify memory requirements using resourceRequirements, the number of MiB of memory reserved for the job. For other jobs, including all run on Fargate resources, see resourceRequirements.

mountPoints
Type: Array of MountPoint structures

The mount points for data volumes in your container.

networkConfiguration
Type: NetworkConfiguration structure

The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

networkInterfaces
Type: Array of NetworkInterface structures

The network interfaces that are associated with the job.

privileged
Type: boolean

When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). The default value is false.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.

readonlyRootFilesystem
Type: boolean

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run .

reason
Type: string

A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

repositoryCredentials
Type: RepositoryCredentials structure

The private repository authentication credentials to use.

resourceRequirements
Type: Array of ResourceRequirement structures

The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

runtimePlatform
Type: RuntimePlatform structure

An object that represents the compute environment architecture for Batch jobs on Fargate.

secrets
Type: Array of Secret structures

The secrets to pass to the container. For more information, see Specifying sensitive data in the Batch User Guide.

taskArn
Type: string

The Amazon Resource Name (ARN) of the Amazon ECS task that's associated with the container job. Each container attempt receives a task ARN when they reach the STARTING status.

ulimits
Type: Array of Ulimit structures

A list of ulimit values to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources.

user
Type: string

The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

vcpus
Type: int

The number of vCPUs reserved for the container. For jobs that run on Amazon EC2 resources, you can specify the vCPU requirement for the job using resourceRequirements, but you can't specify the vCPU requirements in both the vcpus and resourceRequirements object. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. You must specify at least one vCPU. This is required but can be specified in several places. It must be specified for each node at least once.

This parameter isn't applicable to jobs that run on Fargate resources. For jobs that run on Fargate resources, you must specify the vCPU requirement for the job using resourceRequirements.

volumes
Type: Array of Volume structures

A list of volumes that are associated with the job.

ContainerOverrides

Description

The overrides that should be sent to a container.

For information about using Batch overrides when you connect event sources to targets, see BatchContainerOverrides.

Members
command
Type: Array of strings

The command to send to the container that overrides the default command from the Docker image or the job definition.

This parameter can't contain an empty string.

environment
Type: Array of KeyValuePair structures

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

instanceType
Type: string

The instance type to use for a multi-node parallel job.

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

memory
Type: int

This parameter is deprecated, use resourceRequirements to override the memory requirements specified in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the memory parameter set in the job definition, but doesn't override any memory requirement that's specified in the resourceRequirements structure in the job definition. To override memory requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to MEMORY and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

resourceRequirements
Type: Array of ResourceRequirement structures

The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.

vcpus
Type: int

This parameter is deprecated, use resourceRequirements to override the vcpus parameter that's set in the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it overrides the vcpus parameter set in the job definition, but doesn't override any vCPU requirement specified in the resourceRequirements structure in the job definition. To override vCPU requirements that are specified in the resourceRequirements structure in the job definition, resourceRequirements must be specified in the SubmitJob request, with type set to VCPU and value set to the new value. For more information, see Can't override job definition resource requirements in the Batch User Guide.

ContainerProperties

Description

Container properties are used for Amazon ECS based job definitions. These properties to describe the container that's launched as part of a job.

Members
command
Type: Array of strings

The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

environment
Type: Array of KeyValuePair structures

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We don't recommend using plaintext environment variables for sensitive information, such as credential data.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

ephemeralStorage
Type: EphemeralStorage structure

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.

executionRoleArn
Type: string

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.

fargatePlatformConfiguration

The platform configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

image
Type: string

Required. The image used to start a container. This string is passed directly to the Docker daemon. Images in the Docker Hub registry are available by default. Other repositories are specified with repository-url/image:tag . It can be 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), underscores (_), colons (:), periods (.), forward slashes (/), and number signs (#). This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of docker run.

Docker image architecture must match the processor architecture of the compute resources that they're scheduled on. For example, ARM-based Docker images can only run on ARM-based compute resources.

  • Images in Amazon ECR Public repositories use the full registry/repository[:tag] or registry/repository[@digest] naming conventions. For example, public.ecr.aws/registry_alias/my-web-app:latest .

  • Images in Amazon ECR repositories use the full registry and repository URI (for example, 123456789012.dkr.ecr.<region-name>.amazonaws.com/<repository-name>).

  • Images in official repositories on Docker Hub use a single name (for example, ubuntu or mongo).

  • Images in other repositories on Docker Hub are qualified with an organization name (for example, amazon/amazon-ecs-agent).

  • Images in other online repositories are qualified further by a domain name (for example, quay.io/assemblyline/ubuntu).

instanceType
Type: string

The instance type to use for a multi-node parallel job. All node groups in a multi-node parallel job must use the same instance type.

This parameter isn't applicable to single-node container jobs or jobs that run on Fargate resources, and shouldn't be provided.

jobRoleArn
Type: string

The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

linuxParameters
Type: LinuxParameters structure

Linux-specific modifications that are applied to the container, such as details for device mappings.

logConfiguration
Type: LogConfiguration structure

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run. By default, containers use the same logging driver that the Docker daemon uses. However the container might use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information on the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Batch currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type).

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

memory
Type: int

This parameter is deprecated, use resourceRequirements to specify the memory requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs that run on Amazon EC2 resources, it specifies the memory hard limit (in MiB) for a container. If your container attempts to exceed the specified number, it's terminated. You must specify at least 4 MiB of memory for a job using this parameter. The memory hard limit can be specified in several places. It must be specified for each node at least once.

mountPoints
Type: Array of MountPoint structures

The mount points for data volumes in your container. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

networkConfiguration
Type: NetworkConfiguration structure

The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

privileged
Type: boolean

When this parameter is true, the container is given elevated permissions on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run. The default value is false.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided, or specified as false.

readonlyRootFilesystem
Type: boolean

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

repositoryCredentials
Type: RepositoryCredentials structure

The private repository authentication credentials to use.

resourceRequirements
Type: Array of ResourceRequirement structures

The type and amount of resources to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

runtimePlatform
Type: RuntimePlatform structure

An object that represents the compute environment architecture for Batch jobs on Fargate.

secrets
Type: Array of Secret structures

The secrets for the container. For more information, see Specifying sensitive data in the Batch User Guide.

ulimits
Type: Array of Ulimit structures

A list of ulimits to set in the container. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

user
Type: string

The user name to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

vcpus
Type: int

This parameter is deprecated, use resourceRequirements to specify the vCPU requirements for the job definition. It's not supported for jobs running on Fargate resources. For jobs running on Amazon EC2 resources, it specifies the number of vCPUs reserved for the job.

Each vCPU is equivalent to 1,024 CPU shares. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. The number of vCPUs must be specified but can be specified in several places. You must specify it at least once for each node.

volumes
Type: Array of Volume structures

A list of data volumes used in a job.

ContainerSummary

Description

An object that represents summary details of a container within a job.

Members
exitCode
Type: int

The exit code to return upon completion.

reason
Type: string

A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

Device

Description

An object that represents a container instance host device.

This object isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

Members
containerPath
Type: string

The path inside the container that's used to expose the host device. By default, the hostPath value is used.

hostPath
Required: Yes
Type: string

The path for the device on the host container instance.

permissions
Type: Array of strings

The explicit permissions to provide to the container for the device. By default, the container has permissions for read, write, and mknod for the device.

EFSAuthorizationConfig

Description

The authorization configuration details for the Amazon EFS file system.

Members
accessPointId
Type: string

The Amazon EFS access point ID to use. If an access point is specified, the root directory value specified in the EFSVolumeConfiguration must either be omitted or set to / which enforces the path set on the EFS access point. If an access point is used, transit encryption must be enabled in the EFSVolumeConfiguration. For more information, see Working with Amazon EFS access points in the Amazon Elastic File System User Guide.

iam
Type: string

Whether or not to use the Batch job IAM role defined in a job definition when mounting the Amazon EFS file system. If enabled, transit encryption must be enabled in the EFSVolumeConfiguration. If this parameter is omitted, the default value of DISABLED is used. For more information, see Using Amazon EFS access points in the Batch User Guide. EFS IAM authorization requires that TransitEncryption be ENABLED and that a JobRoleArn is specified.

EFSVolumeConfiguration

Description

This is used when you're using an Amazon Elastic File System file system for job storage. For more information, see Amazon EFS Volumes in the Batch User Guide.

Members
authorizationConfig
Type: EFSAuthorizationConfig structure

The authorization configuration details for the Amazon EFS file system.

fileSystemId
Required: Yes
Type: string

The Amazon EFS file system ID to use.

rootDirectory
Type: string

The directory within the Amazon EFS file system to mount as the root directory inside the host. If this parameter is omitted, the root of the Amazon EFS volume is used instead. Specifying / has the same effect as omitting this parameter. The maximum length is 4,096 characters.

If an EFS access point is specified in the authorizationConfig, the root directory parameter must either be omitted or set to /, which enforces the path set on the Amazon EFS access point.

transitEncryption
Type: string

Determines whether to enable encryption for Amazon EFS data in transit between the Amazon ECS host and the Amazon EFS server. Transit encryption must be enabled if Amazon EFS IAM authorization is used. If this parameter is omitted, the default value of DISABLED is used. For more information, see Encrypting data in transit in the Amazon Elastic File System User Guide.

transitEncryptionPort
Type: int

The port to use when sending encrypted data between the Amazon ECS host and the Amazon EFS server. If you don't specify a transit encryption port, it uses the port selection strategy that the Amazon EFS mount helper uses. The value must be between 0 and 65,535. For more information, see EFS mount helper in the Amazon Elastic File System User Guide.

Ec2Configuration

Description

Provides information used to select Amazon Machine Images (AMIs) for instances in the compute environment. If Ec2Configuration isn't specified, the default is ECS_AL2 (Amazon Linux 2).

This object isn't applicable to jobs that are running on Fargate resources.

Members
imageIdOverride
Type: string

The AMI ID used for instances launched in the compute environment that match the image type. This setting overrides the imageId set in the computeResource object.

The AMI that you choose for a compute environment must match the architecture of the instance types that you intend to use for that compute environment. For example, if your compute environment uses A1 instance types, the compute resource AMI that you choose must support ARM instances. Amazon ECS vends both x86 and ARM versions of the Amazon ECS-optimized Amazon Linux 2 AMI. For more information, see Amazon ECS-optimized Amazon Linux 2 AMI in the Amazon Elastic Container Service Developer Guide.

imageKubernetesVersion
Type: string

The Kubernetes version for the compute environment. If you don't specify a value, the latest version that Batch supports is used.

imageType
Required: Yes
Type: string

The image type to match with the instance type to select an AMI. The supported values are different for ECS and EKS resources.

ECS

If the imageIdOverride parameter isn't specified, then a recent Amazon ECS-optimized Amazon Linux 2 AMI (ECS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon ECS optimized AMI for that image type that's supported by Batch is used.

ECS_AL2

Amazon Linux 2: Default for all non-GPU instance families.

ECS_AL2_NVIDIA

Amazon Linux 2 (GPU): Default for all GPU instance families (for example P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

ECS_AL2023

Amazon Linux 2023: Batch supports Amazon Linux 2023.

Amazon Linux 2023 does not support A1 instances.

ECS_AL1

Amazon Linux. Amazon Linux has reached the end-of-life of standard support. For more information, see Amazon Linux AMI.

EKS

If the imageIdOverride parameter isn't specified, then a recent Amazon EKS-optimized Amazon Linux AMI (EKS_AL2) is used. If a new image type is specified in an update, but neither an imageId nor a imageIdOverride parameter is specified, then the latest Amazon EKS optimized AMI for that image type that Batch supports is used.

EKS_AL2

Amazon Linux 2: Default for all non-GPU instance families.

EKS_AL2_NVIDIA

Amazon Linux 2 (accelerated): Default for all GPU instance families (for example, P4 and G4) and can be used for all non Amazon Web Services Graviton-based instance types.

EcsProperties

Description

An object that contains the properties for the Amazon ECS resources of a job.

Members
taskProperties
Required: Yes
Type: Array of EcsTaskProperties structures

An object that contains the properties for the Amazon ECS task definition of a job.

This object is currently limited to one element.

EcsPropertiesDetail

Description

An object that contains the details for the Amazon ECS resources of a job.

Members
taskProperties
Type: Array of EcsTaskDetails structures

The properties for the Amazon ECS task definition of a job.

EcsPropertiesOverride

Description

An object that contains overrides for the Amazon ECS task definition of a job.

Members
taskProperties
Type: Array of TaskPropertiesOverride structures

The overrides for the Amazon ECS task definition of a job.

This object is currently limited to one element.

EcsTaskDetails

Description

The details of a task definition that describes the container and volume definitions of an Amazon ECS task.

Members
containerInstanceArn
Type: string

The Amazon Resource Name (ARN) of the container instance that hosts the task.

containers
Type: Array of TaskContainerDetails structures

A list of containers that are included in the taskProperties list.

ephemeralStorage
Type: EphemeralStorage structure

The amount of ephemeral storage allocated for the task.

executionRoleArn
Type: string

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For more information, see Batch execution IAM role in the Batch User Guide.

ipcMode
Type: string

The IPC resource namespace to use for the containers in the task.

networkConfiguration
Type: NetworkConfiguration structure

The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

pidMode
Type: string

The process namespace to use for the containers in the task.

platformVersion
Type: string

The Fargate platform version where the jobs are running.

runtimePlatform
Type: RuntimePlatform structure

An object that represents the compute environment architecture for Batch jobs on Fargate.

taskArn
Type: string

The ARN of the Amazon ECS task.

taskRoleArn
Type: string

The Amazon Resource Name (ARN) of the IAM role that the container can assume for Amazon Web Services permissions. For more information, see IAM roles for tasks in the Amazon Elastic Container Service Developer Guide.

This is object is comparable to ContainerProperties:jobRoleArn.

volumes
Type: Array of Volume structures

A list of data volumes used in a job.

EcsTaskProperties

Description

The properties for a task definition that describes the container and volume definitions of an Amazon ECS task. You can specify which Docker images to use, the required resources, and other configurations related to launching the task definition through an Amazon ECS service or task.

Members
containers
Required: Yes
Type: Array of TaskContainerProperties structures

This object is a list of containers.

ephemeralStorage
Type: EphemeralStorage structure

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.

executionRoleArn
Type: string

The Amazon Resource Name (ARN) of the execution role that Batch can assume. For jobs that run on Fargate resources, you must provide an execution role. For more information, see Batch execution IAM role in the Batch User Guide.

ipcMode
Type: string

The IPC resource namespace to use for the containers in the task. The valid values are host, task, or none.

If host is specified, all containers within the tasks that specified the host IPC mode on the same container instance share the same IPC resources with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same IPC resources.

If none is specified, the IPC resources within the containers of a task are private, and are not shared with other containers in a task or on the container instance.

If no value is specified, then the IPC resource namespace sharing depends on the Docker daemon setting on the container instance. For more information, see IPC settings in the Docker run reference.

networkConfiguration
Type: NetworkConfiguration structure

The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

pidMode
Type: string

The process namespace to use for the containers in the task. The valid values are host or task. For example, monitoring sidecars might need pidMode to access information about other containers running in the same task.

If host is specified, all containers within the tasks that specified the host PID mode on the same container instance share the process namespace with the host Amazon EC2 instance.

If task is specified, all containers within the specified task share the same process namespace.

If no value is specified, the default is a private namespace for each container. For more information, see PID settings in the Docker run reference.

platformVersion
Type: string

The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

runtimePlatform
Type: RuntimePlatform structure

An object that represents the compute environment architecture for Batch jobs on Fargate.

taskRoleArn
Type: string

The Amazon Resource Name (ARN) that's associated with the Amazon ECS task.

This is object is comparable to ContainerProperties:jobRoleArn.

volumes
Type: Array of Volume structures

A list of volumes that are associated with the job.

EksAttemptContainerDetail

Description

An object that represents the details for an attempt for a job attempt that an Amazon EKS container runs.

Members
exitCode
Type: int

The exit code returned for the job attempt. A non-zero exit code is considered failed.

name
Type: string

The name of a container.

reason
Type: string

A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

EksAttemptDetail

Description

An object that represents the details of a job attempt for a job attempt by an Amazon EKS container.

Members
containers
Type: Array of EksAttemptContainerDetail structures

The details for the final status of the containers for this job attempt.

initContainers
Type: Array of EksAttemptContainerDetail structures

The details for the init containers.

nodeName
Type: string

The name of the node for this job attempt.

podName
Type: string

The name of the pod for this job attempt.

startedAt
Type: long (int|float)

The Unix timestamp (in milliseconds) for when the attempt was started (when the attempt transitioned from the STARTING state to the RUNNING state).

statusReason
Type: string

A short, human-readable string to provide additional details for the current status of the job attempt.

stoppedAt
Type: long (int|float)

The Unix timestamp (in milliseconds) for when the attempt was stopped. This happens when the attempt transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

EksConfiguration

Description

Configuration for the Amazon EKS cluster that supports the Batch compute environment. The cluster must exist before the compute environment can be created.

Members
eksClusterArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the Amazon EKS cluster. An example is arn:aws:eks:us-east-1:123456789012:cluster/ClusterForBatch .

kubernetesNamespace
Required: Yes
Type: string

The namespace of the Amazon EKS cluster. Batch manages pods in this namespace. The value can't left empty or null. It must be fewer than 64 characters long, can't be set to default, can't start with "kube-," and must match this regular expression: ^[a-z0-9]([-a-z0-9]*[a-z0-9])?$. For more information, see Namespaces in the Kubernetes documentation.

EksContainer

Description

EKS container properties are used in job definitions for Amazon EKS based job definitions to describe the properties for a container node in the pod that's launched as part of a job. This can't be specified for Amazon ECS based job definitions.

Members
args
Type: Array of strings

An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)." $$ is replaced with $, and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD and Define a command and arguments for a pod in the Kubernetes documentation.

command
Type: Array of strings

The entrypoint for the container. This isn't run within a shell. If this isn't specified, the ENTRYPOINT of the container image is used. Environment variable references are expanded using the container's environment.

If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)." $$ is replaced with $ and the resulting string isn't expanded. For example, $$(VAR_NAME) will be passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. The entrypoint can't be updated. For more information, see ENTRYPOINT in the Dockerfile reference and Define a command and arguments for a container and Entrypoint in the Kubernetes documentation.

env
Type: Array of EksContainerEnvironmentVariable structures

The environment variables to pass to a container.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

image
Required: Yes
Type: string

The Docker image used to start the container.

imagePullPolicy
Type: string

The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to IfNotPresent. However, if the :latest tag is specified, it defaults to Always. For more information, see Updating images in the Kubernetes documentation.

name
Type: string

The name of the container. If the name isn't specified, the default name "Default" is used. Each container in a pod must have a unique name.

resources

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

securityContext
Type: EksContainerSecurityContext structure

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

volumeMounts
Type: Array of EksContainerVolumeMount structures

The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

EksContainerDetail

Description

The details for container properties that are returned by DescribeJobs for jobs that use Amazon EKS.

Members
args
Type: Array of strings

An array of arguments to the entrypoint. If this isn't specified, the CMD of the container image is used. This corresponds to the args member in the Entrypoint portion of the Pod in Kubernetes. Environment variable references are expanded using the container's environment.

If the referenced environment variable doesn't exist, the reference in the command isn't changed. For example, if the reference is to "$(NAME1)" and the NAME1 environment variable doesn't exist, the command string will remain "$(NAME1)". $$ is replaced with $ and the resulting string isn't expanded. For example, $$(VAR_NAME) is passed as $(VAR_NAME) whether or not the VAR_NAME environment variable exists. For more information, see Dockerfile reference: CMD and Define a command and arguments for a pod in the Kubernetes documentation.

command
Type: Array of strings

The entrypoint for the container. For more information, see Entrypoint in the Kubernetes documentation.

env
Type: Array of EksContainerEnvironmentVariable structures

The environment variables to pass to a container.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

exitCode
Type: int

The exit code returned for the job attempt. A non-zero exit code is considered failed.

image
Type: string

The Docker image used to start the container.

imagePullPolicy
Type: string

The image pull policy for the container. Supported values are Always, IfNotPresent, and Never. This parameter defaults to Always if the :latest tag is specified, IfNotPresent otherwise. For more information, see Updating images in the Kubernetes documentation.

name
Type: string

The name of the container. If the name isn't specified, the default name "Default" is used. Each container in a pod must have a unique name.

reason
Type: string

A short human-readable string to provide additional details for a running or stopped container. It can be up to 255 characters long.

resources

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

securityContext
Type: EksContainerSecurityContext structure

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

volumeMounts
Type: Array of EksContainerVolumeMount structures

The volume mounts for the container. Batch supports emptyDir, hostPath, and secret volume types. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

EksContainerEnvironmentVariable

Description

An environment variable.

Members
name
Required: Yes
Type: string

The name of the environment variable.

value
Type: string

The value of the environment variable.

EksContainerOverride

Description

Object representing any Kubernetes overrides to a job definition that's used in a SubmitJob API operation.

Members
args
Type: Array of strings

The arguments to the entrypoint to send to the container that overrides the default arguments from the Docker image or the job definition. For more information, see Dockerfile reference: CMD and Define a command an arguments for a pod in the Kubernetes documentation.

command
Type: Array of strings

The command to send to the container that overrides the default command from the Docker image or the job definition.

env
Type: Array of EksContainerEnvironmentVariable structures

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch. Or, you can override the existing environment variables from the Docker image or the job definition.

Environment variables cannot start with "AWS_BATCH". This naming convention is reserved for variables that Batch sets.

image
Type: string

The override of the Docker image that's used to start the container.

name
Type: string

A pointer to the container that you want to override. The name must match a unique container name that you wish to override.

resources

The type and amount of resources to assign to a container. These override the settings in the job definition. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

EksContainerResourceRequirements

Description

The type and amount of resources to assign to a container. The supported resources include memory, cpu, and nvidia.com/gpu. For more information, see Resource management for pods and containers in the Kubernetes documentation.

Members
limits
Type: Associative array of custom strings keys (String) to strings

The type and quantity of the resources to reserve for the container. The values vary based on the name that's specified. Resources can be requested using either the limits or the requests objects.

memory

The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value that's specified in requests.

To maximize your resource utilization, provide your jobs with as much memory as possible for the specific instance type that you are using. To learn how, see Memory management in the Batch User Guide.

cpu

The number of CPUs that's reserved for the container. Values must be an even multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both places, then the value that's specified in limits must be at least as large as the value that's specified in requests.

nvidia.com/gpu

The number of GPUs that's reserved for the container. Values must be a whole integer. memory can be specified in limits, requests, or both. If memory is specified in both places, then the value that's specified in limits must be equal to the value that's specified in requests.

requests
Type: Associative array of custom strings keys (String) to strings

The type and quantity of the resources to request for the container. The values vary based on the name that's specified. Resources can be requested by using either the limits or the requests objects.

memory

The memory hard limit (in MiB) for the container, using whole integers, with a "Mi" suffix. If your container attempts to exceed the memory specified, the container is terminated. You must specify at least 4 MiB of memory for a job. memory can be specified in limits, requests, or both. If memory is specified in both, then the value that's specified in limits must be equal to the value that's specified in requests.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.

cpu

The number of CPUs that are reserved for the container. Values must be an even multiple of 0.25. cpu can be specified in limits, requests, or both. If cpu is specified in both, then the value that's specified in limits must be at least as large as the value that's specified in requests.

nvidia.com/gpu

The number of GPUs that are reserved for the container. Values must be a whole integer. nvidia.com/gpu can be specified in limits, requests, or both. If nvidia.com/gpu is specified in both, then the value that's specified in limits must be equal to the value that's specified in requests.

EksContainerSecurityContext

Description

The security context for a job. For more information, see Configure a security context for a pod or container in the Kubernetes documentation.

Members
allowPrivilegeEscalation
Type: boolean

Whether or not a container or a Kubernetes pod is allowed to gain more privileges than its parent process. The default value is false.

privileged
Type: boolean

When this parameter is true, the container is given elevated permissions on the host container instance. The level of permissions are similar to the root user permissions. The default value is false. This parameter maps to privileged policy in the Privileged pod security policies in the Kubernetes documentation.

readOnlyRootFilesystem
Type: boolean

When this parameter is true, the container is given read-only access to its root file system. The default value is false. This parameter maps to ReadOnlyRootFilesystem policy in the Volumes and file systems pod security policies in the Kubernetes documentation.

runAsGroup
Type: long (int|float)

When this parameter is specified, the container is run as the specified group ID (gid). If this parameter isn't specified, the default is the group that's specified in the image metadata. This parameter maps to RunAsGroup and MustRunAs policy in the Users and groups pod security policies in the Kubernetes documentation.

runAsNonRoot
Type: boolean

When this parameter is specified, the container is run as a user with a uid other than 0. If this parameter isn't specified, so such rule is enforced. This parameter maps to RunAsUser and MustRunAsNonRoot policy in the Users and groups pod security policies in the Kubernetes documentation.

runAsUser
Type: long (int|float)

When this parameter is specified, the container is run as the specified user ID (uid). If this parameter isn't specified, the default is the user that's specified in the image metadata. This parameter maps to RunAsUser and MustRanAs policy in the Users and groups pod security policies in the Kubernetes documentation.

EksContainerVolumeMount

Description

The volume mounts for a container for an Amazon EKS job. For more information about volumes and volume mounts in Kubernetes, see Volumes in the Kubernetes documentation.

Members
mountPath
Type: string

The path on the container where the volume is mounted.

name
Type: string

The name the volume mount. This must match the name of one of the volumes in the pod.

readOnly
Type: boolean

If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.

EksEmptyDir

Description

Specifies the configuration of a Kubernetes emptyDir volume. An emptyDir volume is first created when a pod is assigned to a node. It exists as long as that pod is running on that node. The emptyDir volume is initially empty. All containers in the pod can read and write the files in the emptyDir volume. However, the emptyDir volume can be mounted at the same or different paths in each container. When a pod is removed from a node for any reason, the data in the emptyDir is deleted permanently. For more information, see emptyDir in the Kubernetes documentation.

Members
medium
Type: string

The medium to store the volume. The default value is an empty string, which uses the storage of the node.

""

(Default) Use the disk storage of the node.

"Memory"

Use the tmpfs volume that's backed by the RAM of the node. Contents of the volume are lost when the node reboots, and any storage on the volume counts against the container's memory limit.

sizeLimit
Type: string

The maximum size of the volume. By default, there's no maximum size defined.

EksHostPath

Description

Specifies the configuration of a Kubernetes hostPath volume. A hostPath volume mounts an existing file or directory from the host node's filesystem into your pod. For more information, see hostPath in the Kubernetes documentation.

Members
path
Type: string

The path of the file or directory on the host to mount into containers on the pod.

EksMetadata

Description

Describes and uniquely identifies Kubernetes resources. For example, the compute environment that a pod runs in or the jobID for a job running in the pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.

Members
labels
Type: Associative array of custom strings keys (String) to strings

Key-value pairs used to identify, sort, and organize cube resources. Can contain up to 63 uppercase letters, lowercase letters, numbers, hyphens (-), and underscores (_). Labels can be added or modified at any time. Each resource can have multiple labels, but each key must be unique for a given object.

EksPodProperties

Description

The properties for the pod.

Members
containers
Type: Array of EksContainer structures

The properties of the container that's used on the Amazon EKS pod.

dnsPolicy
Type: string

The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

hostNetwork
Type: boolean

Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and Pod networking in the Kubernetes documentation.

imagePullSecrets
Type: Array of ImagePullSecret structures

References a Kubernetes secret resource. It holds a list of secrets. These secrets help to gain access to pull an images from a private registry.

ImagePullSecret$name is required when this object is used.

initContainers
Type: Array of EksContainer structures

These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see Init Containers in the Kubernetes documentation.

This object is limited to 10 elements

metadata
Type: EksMetadata structure

Metadata about the Kubernetes pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.

serviceAccountName
Type: string

The name of the service account that's used to run the pod. For more information, see Kubernetes service accounts and Configure a Kubernetes service account to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes documentation.

shareProcessNamespace
Type: boolean

Indicates if the processes in a container are shared, or visible, to other containers in the same pod. For more information, see Share Process Namespace between Containers in a Pod.

volumes
Type: Array of EksVolume structures

Specifies the volumes for a job definition that uses Amazon EKS resources.

EksPodPropertiesDetail

Description

The details for the pod.

Members
containers
Type: Array of EksContainerDetail structures

The properties of the container that's used on the Amazon EKS pod.

dnsPolicy
Type: string

The DNS policy for the pod. The default value is ClusterFirst. If the hostNetwork parameter is not specified, the default is ClusterFirstWithHostNet. ClusterFirst indicates that any DNS query that does not match the configured cluster domain suffix is forwarded to the upstream nameserver inherited from the node. If no value was specified for dnsPolicy in the RegisterJobDefinition API operation, then no value will be returned for dnsPolicy by either of DescribeJobDefinitions or DescribeJobs API operations. The pod spec setting will contain either ClusterFirst or ClusterFirstWithHostNet, depending on the value of the hostNetwork parameter. For more information, see Pod's DNS policy in the Kubernetes documentation.

Valid values: Default | ClusterFirst | ClusterFirstWithHostNet

hostNetwork
Type: boolean

Indicates if the pod uses the hosts' network IP address. The default value is true. Setting this to false enables the Kubernetes pod networking model. Most Batch workloads are egress-only and don't require the overhead of IP allocation for each pod for incoming connections. For more information, see Host namespaces and Pod networking in the Kubernetes documentation.

imagePullSecrets
Type: Array of ImagePullSecret structures

Displays the reference pointer to the Kubernetes secret resource. These secrets help to gain access to pull an images from a private registry.

initContainers
Type: Array of EksContainerDetail structures

The container registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store.

metadata
Type: EksMetadata structure

Describes and uniquely identifies Kubernetes resources. For example, the compute environment that a pod runs in or the jobID for a job running in the pod. For more information, see Understanding Kubernetes Objects in the Kubernetes documentation.

nodeName
Type: string

The name of the node for this job.

podName
Type: string

The name of the pod for this job.

serviceAccountName
Type: string

The name of the service account that's used to run the pod. For more information, see Kubernetes service accounts and Configure a Kubernetes service account to assume an IAM role in the Amazon EKS User Guide and Configure service accounts for pods in the Kubernetes documentation.

shareProcessNamespace
Type: boolean

Indicates if the processes in a container are shared, or visible, to other containers in the same pod. For more information, see Share Process Namespace between Containers in a Pod.

volumes
Type: Array of EksVolume structures

Specifies the volumes for a job definition using Amazon EKS resources.

EksPodPropertiesOverride

Description

An object that contains overrides for the Kubernetes pod properties of a job.

Members
containers
Type: Array of EksContainerOverride structures

The overrides for the container that's used on the Amazon EKS pod.

initContainers
Type: Array of EksContainerOverride structures

The overrides for the conatainers defined in the Amazon EKS pod. These containers run before application containers, always runs to completion, and must complete successfully before the next container starts. These containers are registered with the Amazon EKS Connector agent and persists the registration information in the Kubernetes backend data store. For more information, see Init Containers in the Kubernetes documentation.

This object is limited to 10 elements

metadata
Type: EksMetadata structure

Metadata about the overrides for the container that's used on the Amazon EKS pod.

EksProperties

Description

An object that contains the properties for the Kubernetes resources of a job.

Members
podProperties
Type: EksPodProperties structure

The properties for the Kubernetes pod resources of a job.

EksPropertiesDetail

Description

An object that contains the details for the Kubernetes resources of a job.

Members
podProperties
Type: EksPodPropertiesDetail structure

The properties for the Kubernetes pod resources of a job.

EksPropertiesOverride

Description

An object that contains overrides for the Kubernetes resources of a job.

Members
podProperties
Type: EksPodPropertiesOverride structure

The overrides for the Kubernetes pod resources of a job.

EksSecret

Description

Specifies the configuration of a Kubernetes secret volume. For more information, see secret in the Kubernetes documentation.

Members
optional
Type: boolean

Specifies whether the secret or the secret's keys must be defined.

secretName
Required: Yes
Type: string

The name of the secret. The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain names in the Kubernetes documentation.

EksVolume

Description

Specifies an Amazon EKS volume for a job definition.

Members
emptyDir
Type: EksEmptyDir structure

Specifies the configuration of a Kubernetes emptyDir volume. For more information, see emptyDir in the Kubernetes documentation.

hostPath
Type: EksHostPath structure

Specifies the configuration of a Kubernetes hostPath volume. For more information, see hostPath in the Kubernetes documentation.

name
Required: Yes
Type: string

The name of the volume. The name must be allowed as a DNS subdomain name. For more information, see DNS subdomain names in the Kubernetes documentation.

secret
Type: EksSecret structure

Specifies the configuration of a Kubernetes secret volume. For more information, see secret in the Kubernetes documentation.

EphemeralStorage

Description

The amount of ephemeral storage to allocate for the task. This parameter is used to expand the total amount of ephemeral storage available, beyond the default amount, for tasks hosted on Fargate.

Members
sizeInGiB
Required: Yes
Type: int

The total amount, in GiB, of ephemeral storage to set for the task. The minimum supported value is 21 GiB and the maximum supported value is 200 GiB.

EvaluateOnExit

Description

Specifies an array of up to 5 conditions to be met, and an action to take (RETRY or EXIT) if all conditions are met. If none of the EvaluateOnExit conditions in a RetryStrategy match, then the job is retried.

Members
action
Required: Yes
Type: string

Specifies the action to take if all of the specified conditions (onStatusReason, onReason, and onExitCode) are met. The values aren't case sensitive.

onExitCode
Type: string

Contains a glob pattern to match against the decimal representation of the ExitCode returned for a job. The pattern can be up to 512 characters long. It can contain only numbers, and can end with an asterisk (*) so that only the start of the string needs to be an exact match.

The string can contain up to 512 characters.

onReason
Type: string

Contains a glob pattern to match against the Reason returned for a job. The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white space (including spaces and tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

onStatusReason
Type: string

Contains a glob pattern to match against the StatusReason returned for a job. The pattern can contain up to 512 characters. It can contain letters, numbers, periods (.), colons (:), and white spaces (including spaces or tabs). It can optionally end with an asterisk (*) so that only the start of the string needs to be an exact match.

FairsharePolicy

Description

The fair share policy for a scheduling policy.

Members
computeReservation
Type: int

A value used to reserve some of the available maximum vCPU for fair share identifiers that aren't already used.

The reserved ratio is (computeReservation/100)^ActiveFairShares where ActiveFairShares is the number of active fair share identifiers.

For example, a computeReservation value of 50 indicates that Batch reserves 50% of the maximum available vCPU if there's only one fair share identifier. It reserves 25% if there are two fair share identifiers. It reserves 12.5% if there are three fair share identifiers. A computeReservation value of 25 indicates that Batch should reserve 25% of the maximum available vCPU if there's only one fair share identifier, 6.25% if there are two fair share identifiers, and 1.56% if there are three fair share identifiers.

The minimum value is 0 and the maximum value is 99.

shareDecaySeconds
Type: int

The amount of time (in seconds) to use to calculate a fair share percentage for each fair share identifier in use. A value of zero (0) indicates that only current usage is measured. The decay allows for more recently run jobs to have more weight than jobs that ran earlier. The maximum supported value is 604800 (1 week).

shareDistribution
Type: Array of ShareAttributes structures

An array of SharedIdentifier objects that contain the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.

FargatePlatformConfiguration

Description

The platform configuration for jobs that are running on Fargate resources. Jobs that run on Amazon EC2 resources must not specify this parameter.

Members
platformVersion
Type: string

The Fargate platform version where the jobs are running. A platform version is specified only for jobs that are running on Fargate resources. If one isn't specified, the LATEST platform version is used by default. This uses a recent, approved version of the Fargate platform for compute resources. For more information, see Fargate platform versions in the Amazon Elastic Container Service Developer Guide.

Host

Description

Determine whether your data volume persists on the host container instance and where it's stored. If this parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

Members
sourcePath
Type: string

The path on the host container instance that's presented to the container. If this parameter is empty, then the Docker daemon has assigned a host path for you. If this parameter contains a file location, then the data volume persists at the specified location on the host container instance until you delete it manually. If the source path location doesn't exist on the host container instance, the Docker daemon creates it. If the location does exist, the contents of the source path folder are exported.

This parameter isn't applicable to jobs that run on Fargate resources. Don't provide this for these jobs.

ImagePullSecret

Description

References a Kubernetes secret resource. This name of the secret must start and end with an alphanumeric character, is required to be lowercase, can include periods (.) and hyphens (-), and can't contain more than 253 characters.

Members
name
Required: Yes
Type: string

Provides a unique identifier for the ImagePullSecret. This object is required when EksPodProperties$imagePullSecrets is used.

JobDefinition

Description

An object that represents an Batch job definition.

Members
containerOrchestrationType
Type: string

The orchestration type of the compute environment. The valid values are ECS (default) or EKS.

containerProperties
Type: ContainerProperties structure

An object with properties specific to Amazon ECS-based jobs. When containerProperties is used in the job definition, it can't be used in addition to eksProperties, ecsProperties, or nodeProperties.

ecsProperties
Type: EcsProperties structure

An object that contains the properties for the Amazon ECS resources of a job.When ecsProperties is used in the job definition, it can't be used in addition to containerProperties, eksProperties, or nodeProperties.

eksProperties
Type: EksProperties structure

An object with properties that are specific to Amazon EKS-based jobs. When eksProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or nodeProperties.

jobDefinitionArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) for the job definition.

jobDefinitionName
Required: Yes
Type: string

The name of the job definition.

nodeProperties
Type: NodeProperties structure

An object with properties that are specific to multi-node parallel jobs. When nodeProperties is used in the job definition, it can't be used in addition to containerProperties, ecsProperties, or eksProperties.

If the job runs on Fargate resources, don't specify nodeProperties. Use containerProperties instead.

parameters
Type: Associative array of custom strings keys (String) to strings

Default parameters or parameter substitution placeholders that are set in the job definition. Parameters are specified as a key-value pair mapping. Parameters in a SubmitJob request override any corresponding parameter defaults from the job definition. For more information about specifying parameters, see Job definition parameters in the Batch User Guide.

platformCapabilities
Type: Array of strings

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

propagateTags
Type: boolean

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

retryStrategy
Type: RetryStrategy structure

The retry strategy to use for failed jobs that are submitted with this job definition.

revision
Required: Yes
Type: int

The revision of the job definition.

schedulingPriority
Type: int

The scheduling priority of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

status
Type: string

The status of the job definition.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags that are applied to the job definition.

timeout
Type: JobTimeout structure

The timeout time for jobs that are submitted with this job definition. After the amount of time you specify passes, Batch terminates your jobs if they aren't finished.

type
Required: Yes
Type: string

The type of job definition. It's either container or multinode. If the job is run on Fargate resources, then multinode isn't supported. For more information about multi-node parallel jobs, see Creating a multi-node parallel job definition in the Batch User Guide.

JobDependency

Description

An object that represents an Batch job dependency.

Members
jobId
Type: string

The job ID of the Batch job that's associated with this dependency.

type
Type: string

The type of the job dependency.

JobDetail

Description

An object that represents an Batch job.

Members
arrayProperties
Type: ArrayPropertiesDetail structure

The array properties of the job, if it's an array job.

attempts
Type: Array of AttemptDetail structures

A list of job attempts that are associated with this job.

container
Type: ContainerDetail structure

An object that represents the details for the container that's associated with the job. If the details are for a multiple-container job, this object will be empty.

createdAt
Type: long (int|float)

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state. This is specifically at the time SubmitJob was called. For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

dependsOn
Type: Array of JobDependency structures

A list of job IDs that this job depends on.

ecsProperties
Type: EcsPropertiesDetail structure

An object with properties that are specific to Amazon ECS-based jobs.

eksAttempts
Type: Array of EksAttemptDetail structures

A list of job attempts that are associated with this job.

eksProperties
Type: EksPropertiesDetail structure

An object with various properties that are specific to Amazon EKS based jobs.

isCancelled
Type: boolean

Indicates whether the job is canceled.

isTerminated
Type: boolean

Indicates whether the job is terminated.

jobArn
Type: string

The Amazon Resource Name (ARN) of the job.

jobDefinition
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the job definition that this job uses.

jobId
Required: Yes
Type: string

The job ID.

jobName
Required: Yes
Type: string

The job name.

jobQueue
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the job queue that the job is associated with.

nodeDetails
Type: NodeDetails structure

An object that represents the details of a node that's associated with a multi-node parallel job.

nodeProperties
Type: NodeProperties structure

An object that represents the node properties of a multi-node parallel job.

This isn't applicable to jobs that are running on Fargate resources.

parameters
Type: Associative array of custom strings keys (String) to strings

Additional parameters that are passed to the job that replace parameter substitution placeholders or override any corresponding parameter defaults from the job definition.

platformCapabilities
Type: Array of strings

The platform capabilities required by the job definition. If no value is specified, it defaults to EC2. Jobs run on Fargate resources specify FARGATE.

propagateTags
Type: boolean

Specifies whether to propagate the tags from the job or job definition to the corresponding Amazon ECS task. If no value is specified, the tags aren't propagated. Tags can only be propagated to the tasks when the tasks are created. For tags with the same name, job tags are given priority over job definitions tags. If the total number of combined tags from the job and job definition is over 50, the job is moved to the FAILED state.

retryStrategy
Type: RetryStrategy structure

The retry strategy to use for this job if an attempt fails.

schedulingPriority
Type: int

The scheduling policy of the job definition. This only affects jobs in job queues with a fair share policy. Jobs with a higher scheduling priority are scheduled before jobs with a lower scheduling priority.

shareIdentifier
Type: string

The share identifier for the job.

startedAt
Required: Yes
Type: long (int|float)

The Unix timestamp (in milliseconds) for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

status
Required: Yes
Type: string

The current status for the job.

If your jobs don't progress to STARTING, see Jobs stuck in RUNNABLE status in the troubleshooting section of the Batch User Guide.

statusReason
Type: string

A short, human-readable string to provide more details for the current status of the job.

  • CAPACITY:INSUFFICIENT_INSTANCE_CAPACITY - All compute environments have insufficient capacity to service the job.

  • MISCONFIGURATION:COMPUTE_ENVIRONMENT_MAX_RESOURCE - All compute environments have a maxVcpu setting that is smaller than the job requirements.

  • MISCONFIGURATION:JOB_RESOURCE_REQUIREMENT - All compute environments have no connected instances that meet the job requirements.

  • MISCONFIGURATION:SERVICE_ROLE_PERMISSIONS - All compute environments have problems with the service role permissions.

stoppedAt
Type: long (int|float)

The Unix timestamp (in milliseconds) for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags that are applied to the job.

timeout
Type: JobTimeout structure

The timeout configuration for the job.

JobQueueDetail

Description

An object that represents the details for an Batch job queue.

Members
computeEnvironmentOrder
Required: Yes
Type: Array of ComputeEnvironmentOrder structures

The compute environments that are attached to the job queue and the order that job placement is preferred. Compute environments are selected for job placement in ascending order.

jobQueueArn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the job queue.

jobQueueName
Required: Yes
Type: string

The job queue name.

jobStateTimeLimitActions
Type: Array of JobStateTimeLimitAction structures

The set of actions that Batch perform on jobs that remain at the head of the job queue in the specified state longer than specified times. Batch will perform each action after maxTimeSeconds has passed.

priority
Required: Yes
Type: int

The priority of the job queue. Job queues with a higher priority (or a higher integer value for the priority parameter) are evaluated first when associated with the same compute environment. Priority is determined in descending order. For example, a job queue with a priority value of 10 is given scheduling preference over a job queue with a priority value of 1. All of the compute environments must be either Amazon EC2 (EC2 or SPOT) or Fargate (FARGATE or FARGATE_SPOT). Amazon EC2 and Fargate compute environments can't be mixed.

schedulingPolicyArn
Type: string

The Amazon Resource Name (ARN) of the scheduling policy. The format is aws:Partition:batch:Region:Account:scheduling-policy/Name . For example, aws:aws:batch:us-west-2:123456789012:scheduling-policy/MySchedulingPolicy.

state
Required: Yes
Type: string

Describes the ability of the queue to accept new jobs. If the job queue state is ENABLED, it can accept jobs. If the job queue state is DISABLED, new jobs can't be added to the queue, but jobs already in the queue can finish.

status
Type: string

The status of the job queue (for example, CREATING or VALID).

statusReason
Type: string

A short, human-readable string to provide additional details for the current status of the job queue.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags that are applied to the job queue. For more information, see Tagging your Batch resources in Batch User Guide.

JobStateTimeLimitAction

Description

Specifies an action that Batch will take after the job has remained at the head of the queue in the specified state for longer than the specified time.

Members
action
Required: Yes
Type: string

The action to take when a job is at the head of the job queue in the specified state for the specified period of time. The only supported value is CANCEL, which will cancel the job.

maxTimeSeconds
Required: Yes
Type: int

The approximate amount of time, in seconds, that must pass with the job in the specified state before the action is taken. The minimum value is 600 (10 minutes) and the maximum value is 86,400 (24 hours).

reason
Required: Yes
Type: string

The reason to log for the action being taken.

state
Required: Yes
Type: string

The state of the job needed to trigger the action. The only supported value is RUNNABLE.

JobSummary

Description

An object that represents summary details of a job.

Members
arrayProperties
Type: ArrayPropertiesSummary structure

The array properties of the job, if it's an array job.

container
Type: ContainerSummary structure

An object that represents the details of the container that's associated with the job.

createdAt
Type: long (int|float)

The Unix timestamp (in milliseconds) for when the job was created. For non-array jobs and parent array jobs, this is when the job entered the SUBMITTED state (at the time SubmitJob was called). For array child jobs, this is when the child job was spawned by its parent and entered the PENDING state.

jobArn
Type: string

The Amazon Resource Name (ARN) of the job.

jobDefinition
Type: string

The Amazon Resource Name (ARN) of the job definition.

jobId
Required: Yes
Type: string

The job ID.

jobName
Required: Yes
Type: string

The job name.

nodeProperties
Type: NodePropertiesSummary structure

The node properties for a single node in a job summary list.

This isn't applicable to jobs that are running on Fargate resources.

startedAt
Type: long (int|float)

The Unix timestamp for when the job was started. More specifically, it's when the job transitioned from the STARTING state to the RUNNING state.

status
Type: string

The current status for the job.

statusReason
Type: string

A short, human-readable string to provide more details for the current status of the job.

stoppedAt
Type: long (int|float)

The Unix timestamp for when the job was stopped. More specifically, it's when the job transitioned from the RUNNING state to a terminal state, such as SUCCEEDED or FAILED.

JobTimeout

Description

An object that represents a job timeout configuration.

Members
attemptDurationSeconds
Type: int

The job timeout time (in seconds) that's measured from the job attempt's startedAt timestamp. After this time passes, Batch terminates your jobs if they aren't finished. The minimum value for the timeout is 60 seconds.

For array jobs, the timeout applies to the child jobs, not to the parent array job.

For multi-node parallel (MNP) jobs, the timeout applies to the whole job, not to the individual nodes.

KeyValuePair

Description

A key-value pair object.

Members
name
Type: string

The name of the key-value pair. For environment variables, this is the name of the environment variable.

value
Type: string

The value of the key-value pair. For environment variables, this is the value of the environment variable.

KeyValuesPair

Description

A filter name and value pair that's used to return a more specific list of results from a ListJobs API operation.

Members
name
Type: string

The name of the filter. Filter names are case sensitive.

values
Type: Array of strings

The filter values.

LaunchTemplateSpecification

Description

An object that represents a launch template that's associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.

If security groups are specified using both the securityGroupIds parameter of CreateComputeEnvironment and the launch template, the values in the securityGroupIds parameter of CreateComputeEnvironment will be used.

This object isn't applicable to jobs that are running on Fargate resources.

Members
launchTemplateId
Type: string

The ID of the launch template.

launchTemplateName
Type: string

The name of the launch template.

version
Type: string

The version number of the launch template, $Latest, or $Default.

If the value is $Latest, the latest version of the launch template is used. If the value is $Default, the default version of the launch template is used.

If the AMI ID that's used in a compute environment is from the launch template, the AMI isn't changed when the compute environment is updated. It's only changed if the updateToLatestImageVersion parameter for the compute environment is set to true. During an infrastructure update, if either $Latest or $Default is specified, Batch re-evaluates the launch template version, and it might use a different version of the launch template. This is the case even if the launch template isn't specified in the update. When updating a compute environment, changing the launch template requires an infrastructure update of the compute environment. For more information, see Updating compute environments in the Batch User Guide.

Default: $Default.

LinuxParameters

Description

Linux-specific modifications that are applied to the container, such as details for device mappings.

Members
devices
Type: Array of Device structures

Any of the host devices to expose to the container. This parameter maps to Devices in the Create a container section of the Docker Remote API and the --device option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

initProcessEnabled
Type: boolean

If true, run an init process inside the container that forwards signals and reaps processes. This parameter maps to the --init option to docker run. This parameter requires version 1.25 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"

maxSwap
Type: int

The total amount of swap memory (in MiB) a container can use. This parameter is translated to the --memory-swap option to docker run where the value is the sum of the container memory plus the maxSwap value. For more information, see --memory-swap details in the Docker documentation.

If a maxSwap value of 0 is specified, the container doesn't use swap. Accepted values are 0 or any positive integer. If the maxSwap parameter is omitted, the container doesn't use the swap configuration for the container instance that it's running on. A maxSwap value must be set for the swappiness parameter to be used.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

sharedMemorySize
Type: int

The value for the size (in MiB) of the /dev/shm volume. This parameter maps to the --shm-size option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

swappiness
Type: int

You can use this parameter to tune a container's memory swappiness behavior. A swappiness value of 0 causes swapping to not occur unless absolutely necessary. A swappiness value of 100 causes pages to be swapped aggressively. Valid values are whole numbers between 0 and 100. If the swappiness parameter isn't specified, a default value of 60 is used. If a value isn't specified for maxSwap, then this parameter is ignored. If maxSwap is set to 0, the container doesn't use swap. This parameter maps to the --memory-swappiness option to docker run.

Consider the following when you use a per-container swap configuration.

  • Swap space must be enabled and allocated on the container instance for the containers to use.

    By default, the Amazon ECS optimized AMIs don't have swap enabled. You must enable swap on the instance to use this feature. For more information, see Instance store swap volumes in the Amazon EC2 User Guide for Linux Instances or How do I allocate memory to work as swap space in an Amazon EC2 instance by using a swap file?

  • The swap space parameters are only supported for job definitions using EC2 resources.

  • If the maxSwap and swappiness parameters are omitted from a job definition, each container has a default swappiness value of 60. Moreover, the total swap usage is limited to two times the memory reservation of the container.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs.

tmpfs
Type: Array of Tmpfs structures

The container path, mount options, and size (in MiB) of the tmpfs mount. This parameter maps to the --tmpfs option to docker run.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide this parameter for this resource type.

LogConfiguration

Description

Log configuration options to send to a custom log driver for the container.

Members
logDriver
Required: Yes
Type: string

The log driver to use for the container. The valid values that are listed for this parameter are log drivers that the Amazon ECS container agent can communicate with by default.

The supported log drivers are awslogs, fluentd, gelf, json-file, journald, logentries, syslog, and splunk.

Jobs that are running on Fargate resources are restricted to the awslogs and splunk log drivers.

awslogs

Specifies the Amazon CloudWatch Logs logging driver. For more information, see Using the awslogs log driver in the Batch User Guide and Amazon CloudWatch Logs logging driver in the Docker documentation.

fluentd

Specifies the Fluentd logging driver. For more information including usage and options, see Fluentd logging driver in the Docker documentation.

gelf

Specifies the Graylog Extended Format (GELF) logging driver. For more information including usage and options, see Graylog Extended Format logging driver in the Docker documentation.

journald

Specifies the journald logging driver. For more information including usage and options, see Journald logging driver in the Docker documentation.

json-file

Specifies the JSON file logging driver. For more information including usage and options, see JSON File logging driver in the Docker documentation.

splunk

Specifies the Splunk logging driver. For more information including usage and options, see Splunk logging driver in the Docker documentation.

syslog

Specifies the syslog logging driver. For more information including usage and options, see Syslog logging driver in the Docker documentation.

If you have a custom driver that's not listed earlier that you want to work with the Amazon ECS container agent, you can fork the Amazon ECS container agent project that's available on GitHub and customize it to work with that driver. We encourage you to submit pull requests for changes that you want to have included. However, Amazon Web Services doesn't currently support running modified copies of this software.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"

options
Type: Associative array of custom strings keys (String) to strings

The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version | grep "Server API version"

secretOptions
Type: Array of Secret structures

The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Batch User Guide.

MountPoint

Description

Details for a Docker volume mount point that's used in a job's container properties. This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

Members
containerPath
Type: string

The path on the container where the host volume is mounted.

readOnly
Type: boolean

If this value is true, the container has read-only access to the volume. Otherwise, the container can write to the volume. The default value is false.

sourceVolume
Type: string

The name of the volume to mount.

NetworkConfiguration

Description

The network configuration for jobs that are running on Fargate resources. Jobs that are running on Amazon EC2 resources must not specify this parameter.

Members
assignPublicIp
Type: string

Indicates whether the job has a public IP address. For a job that's running on Fargate resources in a private subnet to send outbound traffic to the internet (for example, to pull container images), the private subnet requires a NAT gateway be attached to route requests to the internet. For more information, see Amazon ECS task networking in the Amazon Elastic Container Service Developer Guide. The default value is "DISABLED".

NetworkInterface

Description

An object that represents the elastic network interface for a multi-node parallel job node.

Members
attachmentId
Type: string

The attachment ID for the network interface.

ipv6Address
Type: string

The private IPv6 address for the network interface.

privateIpv4Address
Type: string

The private IPv4 address for the network interface.

NodeDetails

Description

An object that represents the details of a multi-node parallel job node.

Members
isMainNode
Type: boolean

Specifies whether the current node is the main node for a multi-node parallel job.

nodeIndex
Type: int

The node index for the node. Node index numbering starts at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

NodeOverrides

Description

An object that represents any node overrides to a job definition that's used in a SubmitJob API operation.

This parameter isn't applicable to jobs that are running on Fargate resources. Don't provide it for these jobs. Rather, use containerOverrides instead.

Members
nodePropertyOverrides
Type: Array of NodePropertyOverride structures

The node property overrides for the job.

numNodes
Type: int

The number of nodes to use with a multi-node parallel job. This value overrides the number of nodes that are specified in the job definition. To use this override, you must meet the following conditions:

  • There must be at least one node range in your job definition that has an open upper boundary, such as : or n:.

  • The lower boundary of the node range that's specified in the job definition must be fewer than the number of nodes specified in the override.

  • The main node index that's specified in the job definition must be fewer than the number of nodes specified in the override.

NodeProperties

Description

An object that represents the node properties of a multi-node parallel job.

Node properties can't be specified for Amazon EKS based job definitions.

Members
mainNode
Required: Yes
Type: int

Specifies the node index for the main node of a multi-node parallel job. This node index value must be fewer than the number of nodes.

nodeRangeProperties
Required: Yes
Type: Array of NodeRangeProperty structures

A list of node ranges and their properties that are associated with a multi-node parallel job.

numNodes
Required: Yes
Type: int

The number of nodes that are associated with a multi-node parallel job.

NodePropertiesSummary

Description

An object that represents the properties of a node that's associated with a multi-node parallel job.

Members
isMainNode
Type: boolean

Specifies whether the current node is the main node for a multi-node parallel job.

nodeIndex
Type: int

The node index for the node. Node index numbering begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

numNodes
Type: int

The number of nodes that are associated with a multi-node parallel job.

NodePropertyOverride

Description

The object that represents any node overrides to a job definition that's used in a SubmitJob API operation.

Members
containerOverrides
Type: ContainerOverrides structure

The overrides that are sent to a node range.

ecsPropertiesOverride
Type: EcsPropertiesOverride structure

An object that contains the properties that you want to replace for the existing Amazon ECS resources of a job.

instanceTypes
Type: Array of strings

An object that contains the instance types that you want to replace for the existing resources of a job.

targetNodes
Required: Yes
Type: string

The range of nodes, using node index values, that's used to override. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range.

NodeRangeProperty

Description

This is an object that represents the properties of the node range for a multi-node parallel job.

Members
container
Type: ContainerProperties structure

The container details for the node range.

ecsProperties
Type: EcsProperties structure

This is an object that represents the properties of the node range for a multi-node parallel job.

instanceTypes
Type: Array of strings

The instance types of the underlying host infrastructure of a multi-node parallel job.

This parameter isn't applicable to jobs that are running on Fargate resources.

In addition, this list object is currently limited to one element.

targetNodes
Required: Yes
Type: string

The range of nodes, using node index values. A range of 0:3 indicates nodes with index values of 0 through 3. If the starting range value is omitted (:n), then 0 is used to start the range. If the ending range value is omitted (n:), then the highest possible node index is used to end the range. Your accumulative node ranges must account for all nodes (0:n). You can nest node ranges (for example, 0:10 and 4:5). In this case, the 4:5 range properties override the 0:10 properties.

RepositoryCredentials

Description

The repository credentials for private registry authentication.

Members
credentialsParameter
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the secret containing the private repository credentials.

ResourceRequirement

Description

The type and amount of a resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

Members
type
Required: Yes
Type: string

The type of resource to assign to a container. The supported resources include GPU, MEMORY, and VCPU.

value
Required: Yes
Type: string

The quantity of the specified resource to reserve for the container. The values vary based on the type specified.

type="GPU"

The number of physical GPUs to reserve for the container. Make sure that the number of GPUs reserved for all containers in a job doesn't exceed the number of available GPUs on the compute resource that the job is launched on.

GPUs aren't available for jobs that are running on Fargate resources.

type="MEMORY"

The memory hard limit (in MiB) present to the container. This parameter is supported for jobs that are running on Amazon EC2 resources. If your container attempts to exceed the memory specified, the container is terminated. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run. You must specify at least 4 MiB of memory for a job. This is required but can be specified in several places for multi-node parallel (MNP) jobs. It must be specified for each node at least once. This parameter maps to Memory in the Create a container section of the Docker Remote API and the --memory option to docker run.

If you're trying to maximize your resource utilization by providing your jobs as much memory as possible for a particular instance type, see Memory management in the Batch User Guide.

For jobs that are running on Fargate resources, then value is the hard limit (in MiB), and must match one of the supported values and the VCPU values must be one of the values supported for that memory value.

value = 512

VCPU = 0.25

value = 1024

VCPU = 0.25 or 0.5

value = 2048

VCPU = 0.25, 0.5, or 1

value = 3072

VCPU = 0.5, or 1

value = 4096

VCPU = 0.5, 1, or 2

value = 5120, 6144, or 7168

VCPU = 1 or 2

value = 8192

VCPU = 1, 2, or 4

value = 9216, 10240, 11264, 12288, 13312, 14336, or 15360

VCPU = 2 or 4

value = 16384

VCPU = 2, 4, or 8

value = 17408, 18432, 19456, 21504, 22528, 23552, 25600, 26624, 27648, 29696, or 30720

VCPU = 4

value = 20480, 24576, or 28672

VCPU = 4 or 8

value = 36864, 45056, 53248, or 61440

VCPU = 8

value = 32768, 40960, 49152, or 57344

VCPU = 8 or 16

value = 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

VCPU = 16

type="VCPU"

The number of vCPUs reserved for the container. This parameter maps to CpuShares in the Create a container section of the Docker Remote API and the --cpu-shares option to docker run. Each vCPU is equivalent to 1,024 CPU shares. For Amazon EC2 resources, you must specify at least one vCPU. This is required but can be specified in several places; it must be specified for each node at least once.

The default for the Fargate On-Demand vCPU resource count quota is 6 vCPUs. For more information about Fargate quotas, see Fargate quotas in the Amazon Web Services General Reference.

For jobs that are running on Fargate resources, then value must match one of the supported values and the MEMORY values must be one of the values supported for that VCPU value. The supported values are 0.25, 0.5, 1, 2, 4, 8, and 16

value = 0.25

MEMORY = 512, 1024, or 2048

value = 0.5

MEMORY = 1024, 2048, 3072, or 4096

value = 1

MEMORY = 2048, 3072, 4096, 5120, 6144, 7168, or 8192

value = 2

MEMORY = 4096, 5120, 6144, 7168, 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, or 16384

value = 4

MEMORY = 8192, 9216, 10240, 11264, 12288, 13312, 14336, 15360, 16384, 17408, 18432, 19456, 20480, 21504, 22528, 23552, 24576, 25600, 26624, 27648, 28672, 29696, or 30720

value = 8

MEMORY = 16384, 20480, 24576, 28672, 32768, 36864, 40960, 45056, 49152, 53248, 57344, or 61440

value = 16

MEMORY = 32768, 40960, 49152, 57344, 65536, 73728, 81920, 90112, 98304, 106496, 114688, or 122880

RetryStrategy

Description

The retry strategy that's associated with a job. For more information, see Automated job retries in the Batch User Guide.

Members
attempts
Type: int

The number of times to move a job to the RUNNABLE status. You can specify between 1 and 10 attempts. If the value of attempts is greater than one, the job is retried on failure the same number of attempts as the value.

evaluateOnExit
Type: Array of EvaluateOnExit structures

Array of up to 5 objects that specify the conditions where jobs are retried or failed. If this parameter is specified, then the attempts parameter must also be specified. If none of the listed conditions match, then the job is retried.

RuntimePlatform

Description

An object that represents the compute environment architecture for Batch jobs on Fargate.

Members
cpuArchitecture
Type: string

The vCPU architecture. The default value is X86_64. Valid values are X86_64 and ARM64.

This parameter must be set to X86_64 for Windows containers.

Fargate Spot is not supported for ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.

operatingSystemFamily
Type: string

The operating system for the compute environment. Valid values are: LINUX (default), WINDOWS_SERVER_2019_CORE, WINDOWS_SERVER_2019_FULL, WINDOWS_SERVER_2022_CORE, and WINDOWS_SERVER_2022_FULL.

The following parameters can’t be set for Windows containers: linuxParameters, privileged, user, ulimits, readonlyRootFilesystem, and efsVolumeConfiguration.

The Batch Scheduler checks the compute environments that are attached to the job queue before registering a task definition with Fargate. In this scenario, the job queue is where the job is submitted. If the job requires a Windows container and the first compute environment is LINUX, the compute environment is skipped and the next compute environment is checked until a Windows-based compute environment is found.

Fargate Spot is not supported for ARM64 and Windows-based containers on Fargate. A job queue will be blocked if a Fargate ARM64 or Windows job is submitted to a job queue with only Fargate Spot compute environments. However, you can attach both FARGATE and FARGATE_SPOT compute environments to the same job queue.

SchedulingPolicyDetail

Description

An object that represents a scheduling policy.

Members
arn
Required: Yes
Type: string

The Amazon Resource Name (ARN) of the scheduling policy. An example is arn:aws:batch:us-east-1:123456789012:scheduling-policy/HighPriority .

fairsharePolicy
Type: FairsharePolicy structure

The fair share policy for the scheduling policy.

name
Required: Yes
Type: string

The name of the scheduling policy.

tags
Type: Associative array of custom strings keys (TagKey) to strings

The tags that you apply to the scheduling policy to categorize and organize your resources. Each tag consists of a key and an optional value. For more information, see Tagging Amazon Web Services resources in Amazon Web Services General Reference.

SchedulingPolicyListingDetail

Description

An object that contains the details of a scheduling policy that's returned in a ListSchedulingPolicy action.

Members
arn
Required: Yes
Type: string

Amazon Resource Name (ARN) of the scheduling policy.

Secret

Description

An object that represents the secret to expose to your container. Secrets can be exposed to a container in the following ways:

  • To inject sensitive data into your containers as environment variables, use the secrets container definition parameter.

  • To reference sensitive information in the log configuration of a container, use the secretOptions container definition parameter.

For more information, see Specifying sensitive data in the Batch User Guide.

Members
name
Required: Yes
Type: string

The name of the secret.

valueFrom
Required: Yes
Type: string

The secret to expose to the container. The supported values are either the full Amazon Resource Name (ARN) of the Secrets Manager secret or the full ARN of the parameter in the Amazon Web Services Systems Manager Parameter Store.

If the Amazon Web Services Systems Manager Parameter Store parameter exists in the same Region as the job you're launching, then you can use either the full Amazon Resource Name (ARN) or name of the parameter. If the parameter exists in a different Region, then the full ARN must be specified.

ServerException

Description

These errors are usually caused by a server issue.

Members
message
Type: string

ShareAttributes

Description

Specifies the weights for the fair share identifiers for the fair share policy. Fair share identifiers that aren't included have a default weight of 1.0.

Members
shareIdentifier
Required: Yes
Type: string

A fair share identifier or fair share identifier prefix. If the string ends with an asterisk (*), this entry specifies the weight factor to use for fair share identifiers that start with that prefix. The list of fair share identifiers in a fair share policy can't overlap. For example, you can't have one that specifies a shareIdentifier of UserA* and another that specifies a shareIdentifier of UserA-1.

There can be no more than 500 fair share identifiers active in a job queue.

The string is limited to 255 alphanumeric characters, and can be followed by an asterisk (*).

weightFactor
Type: float

The weight factor for the fair share identifier. The default value is 1.0. A lower value has a higher priority for compute resources. For example, jobs that use a share identifier with a weight factor of 0.125 (1/8) get 8 times the compute resources of jobs that use a share identifier with a weight factor of 1.

The smallest supported value is 0.0001, and the largest supported value is 999.9999.

TaskContainerDependency

Description

A list of containers that this task depends on.

Members
condition
Type: string

The dependency condition of the container. The following are the available conditions and their behavior:

  • START - This condition emulates the behavior of links and volumes today. It validates that a dependent container is started before permitting other containers to start.

  • COMPLETE - This condition validates that a dependent container runs to completion (exits) before permitting other containers to start. This can be useful for nonessential containers that run a script and then exit. This condition can't be set on an essential container.

  • SUCCESS - This condition is the same as COMPLETE, but it also requires that the container exits with a zero status. This condition can't be set on an essential container.

containerName
Type: string

A unique identifier for the container.

TaskContainerDetails

Description

The details for the container in this task attempt.

Members
command
Type: Array of strings

The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see https://docs.docker.com/engine/reference/builder/#cmd.

dependsOn
Type: Array of TaskContainerDependency structures

A list of containers that this container depends on.

environment
Type: Array of KeyValuePair structures

The environment variables to pass to a container. This parameter maps to Env in the Create a container section of the Docker Remote API and the --env option to docker run.

We don't recommend using plaintext environment variables for sensitive information, such as credential data.

essential
Type: boolean

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All jobs must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

exitCode
Type: int

The exit code returned upon completion.

image
Type: string

The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of the docker run .

linuxParameters
Type: LinuxParameters structure

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information, see KernelCapabilities.

This parameter is not supported for Windows containers.

logConfiguration
Type: LogConfiguration structure

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run.

By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

logStreamName
Type: string

The name of the CloudWatch Logs log stream that's associated with the container. The log group for Batch jobs is /aws/batch/job. Each container attempt receives a log stream name when they reach the RUNNING status.

mountPoints
Type: Array of MountPoint structures

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives.

name
Type: string

The name of a container.

networkInterfaces
Type: Array of NetworkInterface structures

The network interfaces that are associated with the job.

privileged
Type: boolean

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

This parameter is not supported for Windows containers or tasks run on Fargate.

readonlyRootFilesystem
Type: boolean

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

This parameter is not supported for Windows containers.

reason
Type: string

A short (255 max characters) human-readable string to provide additional details for a running or stopped container.

repositoryCredentials
Type: RepositoryCredentials structure

The private repository authentication credentials to use.

resourceRequirements
Type: Array of ResourceRequirement structures

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

secrets
Type: Array of Secret structures

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

ulimits
Type: Array of Ulimit structures

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 65535.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

user
Type: string

The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

When running tasks using the host network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gi

  • uid:group

This parameter is not supported for Windows containers.

TaskContainerOverrides

Description

The overrides that should be sent to a container.

For information about using Batch overrides when you connect event sources to targets, see BatchContainerOverrides.

Members
command
Type: Array of strings

The command to send to the container that overrides the default command from the Docker image or the job definition.

This parameter can't contain an empty string.

environment
Type: Array of KeyValuePair structures

The environment variables to send to the container. You can add new environment variables, which are added to the container at launch, or you can override the existing environment variables from the Docker image or the job definition.

Environment variables cannot start with AWS_BATCH. This naming convention is reserved for variables that Batch sets.

name
Type: string

A pointer to the container that you want to override. The container's name provides a unique identifier for the container being used.

resourceRequirements
Type: Array of ResourceRequirement structures

The type and amount of resources to assign to a container. This overrides the settings in the job definition. The supported resources include GPU, MEMORY, and VCPU.

TaskContainerProperties

Description

Container properties are used for Amazon ECS-based job definitions. These properties to describe the container that's launched as part of a job.

Members
command
Type: Array of strings

The command that's passed to the container. This parameter maps to Cmd in the Create a container section of the Docker Remote API and the COMMAND parameter to docker run. For more information, see Dockerfile reference: CMD.

dependsOn
Type: Array of TaskContainerDependency structures

A list of containers that this container depends on.

environment
Type: Array of KeyValuePair structures

The environment variables to pass to a container. This parameter maps to Env inthe Create a container section of the Docker Remote API and the --env parameter to docker run.

We don't recommend using plaintext environment variables for sensitive information, such as credential data.

Environment variables cannot start with AWS_BATCH. This naming convention is reserved for variables that Batch sets.

essential
Type: boolean

If the essential parameter of a container is marked as true, and that container fails or stops for any reason, all other containers that are part of the task are stopped. If the essential parameter of a container is marked as false, its failure doesn't affect the rest of the containers in a task. If this parameter is omitted, a container is assumed to be essential.

All jobs must have at least one essential container. If you have an application that's composed of multiple containers, group containers that are used for a common purpose into components, and separate the different components into multiple task definitions. For more information, see Application Architecture in the Amazon Elastic Container Service Developer Guide.

image
Required: Yes
Type: string

The image used to start a container. This string is passed directly to the Docker daemon. By default, images in the Docker Hub registry are available. Other repositories are specified with either repository-url/image:tag or repository-url/image@digest. Up to 255 letters (uppercase and lowercase), numbers, hyphens, underscores, colons, periods, forward slashes, and number signs are allowed. This parameter maps to Image in the Create a container section of the Docker Remote API and the IMAGE parameter of the docker run .

linuxParameters
Type: LinuxParameters structure

Linux-specific modifications that are applied to the container, such as Linux kernel capabilities. For more information, see KernelCapabilities.

logConfiguration
Type: LogConfiguration structure

The log configuration specification for the container.

This parameter maps to LogConfig in the Create a container section of the Docker Remote API and the --log-driver option to docker run.

By default, containers use the same logging driver that the Docker daemon uses. However the container can use a different logging driver than the Docker daemon by specifying a log driver with this parameter in the container definition. To use a different logging driver for a container, the log system must be configured properly on the container instance (or on a different log server for remote logging options). For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.

Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the LogConfiguration data type). Additional log drivers may be available in future releases of the Amazon ECS container agent.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

The Amazon ECS container agent running on a container instance must register the logging drivers available on that instance with the ECS_AVAILABLE_LOGGING_DRIVERS environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide.

mountPoints
Type: Array of MountPoint structures

The mount points for data volumes in your container.

This parameter maps to Volumes in the Create a container section of the Docker Remote API and the --volume option to docker run.

Windows containers can mount whole directories on the same drive as $env:ProgramData. Windows containers can't mount directories on a different drive, and mount point can't be across drives.

name
Type: string

The name of a container. The name can be used as a unique identifier to target your dependsOn and Overrides objects.

privileged
Type: boolean

When this parameter is true, the container is given elevated privileges on the host container instance (similar to the root user). This parameter maps to Privileged in the Create a container section of the Docker Remote API and the --privileged option to docker run.

This parameter is not supported for Windows containers or tasks run on Fargate.

readonlyRootFilesystem
Type: boolean

When this parameter is true, the container is given read-only access to its root file system. This parameter maps to ReadonlyRootfs in the Create a container section of the Docker Remote API and the --read-only option to docker run.

This parameter is not supported for Windows containers.

repositoryCredentials
Type: RepositoryCredentials structure

The private repository authentication credentials to use.

resourceRequirements
Type: Array of ResourceRequirement structures

The type and amount of a resource to assign to a container. The only supported resource is a GPU.

secrets
Type: Array of Secret structures

The secrets to pass to the container. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.

ulimits
Type: Array of Ulimit structures

A list of ulimits to set in the container. If a ulimit value is specified in a task definition, it overrides the default values set by Docker. This parameter maps to Ulimits in the Create a container section of the Docker Remote API and the --ulimit option to docker run.

Amazon ECS tasks hosted on Fargate use the default resource limit values set by the operating system with the exception of the nofile resource limit parameter which Fargate overrides. The nofile resource limit sets a restriction on the number of open files that a container can use. The default nofile soft limit is 1024 and the default hard limit is 65535.

This parameter requires version 1.18 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command: sudo docker version --format '{{.Server.APIVersion}}'

This parameter is not supported for Windows containers.

user
Type: string

The user to use inside the container. This parameter maps to User in the Create a container section of the Docker Remote API and the --user option to docker run.

When running tasks using the host network mode, don't run containers using the root user (UID 0). We recommend using a non-root user for better security.

You can specify the user using the following formats. If specifying a UID or GID, you must specify it as a positive integer.

  • user

  • user:group

  • uid

  • uid:gid

  • user:gi

  • uid:group

This parameter is not supported for Windows containers.

TaskPropertiesOverride

Description

An object that contains overrides for the task definition of a job.

Members
containers
Type: Array of TaskContainerOverrides structures

The overrides for the container definition of a job.

Tmpfs

Description

The container path, mount options, and size of the tmpfs mount.

This object isn't applicable to jobs that are running on Fargate resources.

Members
containerPath
Required: Yes
Type: string

The absolute file path in the container where the tmpfs volume is mounted.

mountOptions
Type: Array of strings

The list of tmpfs volume mount options.

Valid values: "defaults" | "ro" | "rw" | "suid" | "nosuid" | "dev" | "nodev" | "exec" | "noexec" | "sync" | "async" | "dirsync" | "remount" | "mand" | "nomand" | "atime" | "noatime" | "diratime" | "nodiratime" | "bind" | "rbind" | "unbindable" | "runbindable" | "private" | "rprivate" | "shared" | "rshared" | "slave" | "rslave" | "relatime" | "norelatime" | "strictatime" | "nostrictatime" | "mode" | "uid" | "gid" | "nr_inodes" | "nr_blocks" | "mpol"

size
Required: Yes
Type: int

The size (in MiB) of the tmpfs volume.

Ulimit

Description

The ulimit settings to pass to the container. For more information, see Ulimit.

This object isn't applicable to jobs that are running on Fargate resources.

Members
hardLimit
Required: Yes
Type: int

The hard limit for the ulimit type.

name
Required: Yes
Type: string

The type of the ulimit. Valid values are: core | cpu | data | fsize | locks | memlock | msgqueue | nice | nofile | nproc | rss | rtprio | rttime | sigpending | stack.

softLimit
Required: Yes
Type: int

The soft limit for the ulimit type.

UpdatePolicy

Description

Specifies the infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Batch User Guide.

Members
jobExecutionTimeoutMinutes
Type: long (int|float)

Specifies the job timeout (in minutes) when the compute environment infrastructure is updated. The default value is 30.

terminateJobsOnUpdate
Type: boolean

Specifies whether jobs are automatically terminated when the computer environment infrastructure is updated. The default value is false.

Volume

Description

A data volume that's used in a job's container properties.

Members
efsVolumeConfiguration
Type: EFSVolumeConfiguration structure

This parameter is specified when you're using an Amazon Elastic File System file system for job storage. Jobs that are running on Fargate resources must specify a platformVersion of at least 1.4.0.

host
Type: Host structure

The contents of the host parameter determine whether your data volume persists on the host container instance and where it's stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data isn't guaranteed to persist after the containers that are associated with it stop running.

This parameter isn't applicable to jobs that are running on Fargate resources and shouldn't be provided.

name
Type: string

The name of the volume. It can be up to 255 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_). This name is referenced in the sourceVolume parameter of container definition mountPoints.