AWS SDK for PHP 3.x

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 AWS Batch job queue.
CreateComputeEnvironment ( array $params = [] )
Creates an AWS Batch compute environment.
CreateJobQueue ( array $params = [] )
Creates an AWS Batch job queue.
DeleteComputeEnvironment ( array $params = [] )
Deletes an AWS Batch compute environment.
DeleteJobQueue ( array $params = [] )
Deletes the specified job queue.
DeregisterJobDefinition ( array $params = [] )
Deregisters an AWS 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 AWS Batch jobs.
ListJobs ( array $params = [] )
Returns a list of AWS Batch jobs.
RegisterJobDefinition ( array $params = [] )
Registers an AWS Batch job definition.
SubmitJob ( array $params = [] )
Submits an AWS Batch job from a job definition.
TerminateJob ( array $params = [] )
Terminates a job in a job queue.
UpdateComputeEnvironment ( array $params = [] )
Updates an AWS Batch compute environment.
UpdateJobQueue ( array $params = [] )
Updates a job queue.

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

Operations

CancelJob

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

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

Parameter Syntax

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

Parameter Details

Members

jobId

Required: Yes
Type: string

The AWS 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 AWS 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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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 AWS Batch compute environment. You can create MANAGED or UNMANAGED compute environments.

In a managed compute environment, AWS Batch manages the capacity and instance types of the compute resources within the environment. This is based on the compute resource specification that you define or the launch template that you specify when you create the compute environment. You can choose to use Amazon EC2 On-Demand Instances or Spot Instances in your managed compute environment. You can optionally set a maximum price so that Spot Instances only launch when the Spot Instance price is below a specified percentage of the On-Demand price.

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

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

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

Create a new compute environment with the new AMI.
Add the compute environment to an existing job queue.
Remove the old compute environment from your job queue.
Delete the old compute environment.

Parameter Syntax

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

Parameter Details

Members

computeEnvironmentName

Required: Yes
Type: string

The name for your compute environment. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

computeResources

Type: ComputeResource structure

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

serviceRole

Required: Yes
Type: string

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

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

Depending on how you created your AWS Batch service role, its ARN may contain the service-role path prefix. When you only specify the name of the service role, AWS Batch assumes that your ARN does not 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.

type

Required: Yes
Type: string

The type of the compute environment. For more information, see Compute Environments in the AWS 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.

Errors

ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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 AWS Batch job queue. When you create a job queue, you associate one or more compute environments to the queue and assign an order of preference for the compute environments.

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

Parameter Syntax

$result = $client->createJobQueue([
    'computeEnvironmentOrder' => [ // REQUIRED
        [
            'computeEnvironment' => '<string>', // REQUIRED
            'order' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'jobQueueName' => '<string>', // REQUIRED
    'priority' => <integer>, // REQUIRED
    'state' => 'ENABLED|DISABLED',
]);

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 should execute a given 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.

jobQueueName

Required: Yes
Type: string

The name of the job queue.

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.

state

Type: string

The state of the job queue. If the job queue state is ENABLED, it is able to accept jobs.

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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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',
]

DeleteComputeEnvironment

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

Deletes an AWS Batch compute environment.

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

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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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 terminated when you delete a job queue.

It is 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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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:

[
]

DeregisterJobDefinition

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

Deregisters an AWS Batch job definition.

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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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 are using an unmanaged compute environment, you can use the DescribeComputeEnvironment operation to determine the ecsClusterArn that you should launch your Amazon ECS container instances into.

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 is not 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.

This token should be treated as an opaque identifier that is 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',
                'bidPercentage' => <integer>,
                'desiredvCpus' => <integer>,
                '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',
            ],
            'ecsClusterArn' => '<string>',
            'serviceRole' => '<string>',
            'state' => 'ENABLED|DISABLED',
            'status' => 'CREATING|UPDATING|DELETING|DELETED|VALID|INVALID',
            'statusReason' => '<string>',
            'type' => 'MANAGED|UNMANAGED',
        ],
        // ...
    ],
    '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 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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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 definition names or full Amazon Resource Name (ARN) entries.

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 along with 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 is not 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.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.

status

Type: string

The status with which to filter job definitions.

Result Syntax

[
    'jobDefinitions' => [
        [
            'containerProperties' => [
                'command' => ['<string>', ...],
                'environment' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'image' => '<string>',
                'instanceType' => '<string>',
                'jobRoleArn' => '<string>',
                'linuxParameters' => [
                    'devices' => [
                        [
                            'containerPath' => '<string>',
                            'hostPath' => '<string>',
                            'permissions' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                'memory' => <integer>,
                'mountPoints' => [
                    [
                        'containerPath' => '<string>',
                        'readOnly' => true || false,
                        'sourceVolume' => '<string>',
                    ],
                    // ...
                ],
                'privileged' => true || false,
                'readonlyRootFilesystem' => true || false,
                'resourceRequirements' => [
                    [
                        'type' => 'GPU',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'ulimits' => [
                    [
                        'hardLimit' => <integer>,
                        'name' => '<string>',
                        'softLimit' => <integer>,
                    ],
                    // ...
                ],
                'user' => '<string>',
                'vcpus' => <integer>,
                'volumes' => [
                    [
                        'host' => [
                            'sourcePath' => '<string>',
                        ],
                        'name' => '<string>',
                    ],
                    // ...
                ],
            ],
            'jobDefinitionArn' => '<string>',
            'jobDefinitionName' => '<string>',
            'nodeProperties' => [
                'mainNode' => <integer>,
                'nodeRangeProperties' => [
                    [
                        'container' => [
                            'command' => ['<string>', ...],
                            'environment' => [
                                [
                                    'name' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'image' => '<string>',
                            'instanceType' => '<string>',
                            'jobRoleArn' => '<string>',
                            'linuxParameters' => [
                                'devices' => [
                                    [
                                        'containerPath' => '<string>',
                                        'hostPath' => '<string>',
                                        'permissions' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                            'memory' => <integer>,
                            'mountPoints' => [
                                [
                                    'containerPath' => '<string>',
                                    'readOnly' => true || false,
                                    'sourceVolume' => '<string>',
                                ],
                                // ...
                            ],
                            'privileged' => true || false,
                            'readonlyRootFilesystem' => true || false,
                            'resourceRequirements' => [
                                [
                                    'type' => 'GPU',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'ulimits' => [
                                [
                                    'hardLimit' => <integer>,
                                    'name' => '<string>',
                                    'softLimit' => <integer>,
                                ],
                                // ...
                            ],
                            'user' => '<string>',
                            'vcpus' => <integer>,
                            'volumes' => [
                                [
                                    'host' => [
                                        'sourcePath' => '<string>',
                                    ],
                                    'name' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'targetNodes' => '<string>',
                    ],
                    // ...
                ],
                'numNodes' => <integer>,
            ],
            'parameters' => ['<string>', ...],
            'retryStrategy' => [
                'attempts' => <integer>,
            ],
            'revision' => <integer>,
            'status' => '<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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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',
                'memory' => 128,
                'mountPoints' => [
                ],
                'ulimits' => [
                ],
                'vcpus' => 1,
                '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 along with 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 is not 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.

This token should be treated as an opaque identifier that is 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>',
            'priority' => <integer>,
            'state' => 'ENABLED|DISABLED',
            'status' => 'CREATING|UPDATING|DELETING|DELETED|VALID|INVALID',
            'statusReason' => '<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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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 AWS 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>,
                ],
                // ...
            ],
            'container' => [
                'command' => ['<string>', ...],
                'containerInstanceArn' => '<string>',
                'environment' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'exitCode' => <integer>,
                'image' => '<string>',
                'instanceType' => '<string>',
                'jobRoleArn' => '<string>',
                'linuxParameters' => [
                    'devices' => [
                        [
                            'containerPath' => '<string>',
                            'hostPath' => '<string>',
                            'permissions' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                'logStreamName' => '<string>',
                'memory' => <integer>,
                'mountPoints' => [
                    [
                        'containerPath' => '<string>',
                        'readOnly' => true || false,
                        'sourceVolume' => '<string>',
                    ],
                    // ...
                ],
                'networkInterfaces' => [
                    [
                        'attachmentId' => '<string>',
                        'ipv6Address' => '<string>',
                        'privateIpv4Address' => '<string>',
                    ],
                    // ...
                ],
                'privileged' => true || false,
                'readonlyRootFilesystem' => true || false,
                'reason' => '<string>',
                'resourceRequirements' => [
                    [
                        'type' => 'GPU',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                'taskArn' => '<string>',
                'ulimits' => [
                    [
                        'hardLimit' => <integer>,
                        'name' => '<string>',
                        'softLimit' => <integer>,
                    ],
                    // ...
                ],
                'user' => '<string>',
                'vcpus' => <integer>,
                'volumes' => [
                    [
                        'host' => [
                            'sourcePath' => '<string>',
                        ],
                        'name' => '<string>',
                    ],
                    // ...
                ],
            ],
            'createdAt' => <integer>,
            'dependsOn' => [
                [
                    'jobId' => '<string>',
                    'type' => 'N_TO_N|SEQUENTIAL',
                ],
                // ...
            ],
            '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>',
                                ],
                                // ...
                            ],
                            'image' => '<string>',
                            'instanceType' => '<string>',
                            'jobRoleArn' => '<string>',
                            'linuxParameters' => [
                                'devices' => [
                                    [
                                        'containerPath' => '<string>',
                                        'hostPath' => '<string>',
                                        'permissions' => ['<string>', ...],
                                    ],
                                    // ...
                                ],
                            ],
                            'memory' => <integer>,
                            'mountPoints' => [
                                [
                                    'containerPath' => '<string>',
                                    'readOnly' => true || false,
                                    'sourceVolume' => '<string>',
                                ],
                                // ...
                            ],
                            'privileged' => true || false,
                            'readonlyRootFilesystem' => true || false,
                            'resourceRequirements' => [
                                [
                                    'type' => 'GPU',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'ulimits' => [
                                [
                                    'hardLimit' => <integer>,
                                    'name' => '<string>',
                                    'softLimit' => <integer>,
                                ],
                                // ...
                            ],
                            'user' => '<string>',
                            'vcpus' => <integer>,
                            'volumes' => [
                                [
                                    'host' => [
                                        'sourcePath' => '<string>',
                                    ],
                                    'name' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                        'targetNodes' => '<string>',
                    ],
                    // ...
                ],
                'numNodes' => <integer>,
            ],
            'parameters' => ['<string>', ...],
            'retryStrategy' => [
                'attempts' => <integer>,
            ],
            'startedAt' => <integer>,
            'status' => 'SUBMITTED|PENDING|RUNNABLE|STARTING|RUNNING|SUCCEEDED|FAILED',
            'statusReason' => '<string>',
            'stoppedAt' => <integer>,
            '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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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,
        ],
    ],
]

ListJobs

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

Returns a list of AWS Batch jobs.

You must specify only one of the following:

a job queue ID to return a list of jobs in that job queue
a multi-node parallel job ID to return a list of that job's nodes
an array job ID to return a list of that job's children

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

Parameter Syntax

$result = $client->listJobs([
    'arrayJobId' => '<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.

jobQueue

Type: string

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

jobStatus

Type: string

The job status with which to filter jobs in the specified queue. If you do not 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 along with 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 is not 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.

This token should be treated as an opaque identifier that is 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>,
            '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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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',
        ],
    ],
]

RegisterJobDefinition

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

Registers an AWS Batch job definition.

Parameter Syntax

$result = $client->registerJobDefinition([
    'containerProperties' => [
        'command' => ['<string>', ...],
        'environment' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'image' => '<string>',
        'instanceType' => '<string>',
        'jobRoleArn' => '<string>',
        'linuxParameters' => [
            'devices' => [
                [
                    'containerPath' => '<string>',
                    'hostPath' => '<string>', // REQUIRED
                    'permissions' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'memory' => <integer>,
        'mountPoints' => [
            [
                'containerPath' => '<string>',
                'readOnly' => true || false,
                'sourceVolume' => '<string>',
            ],
            // ...
        ],
        'privileged' => true || false,
        'readonlyRootFilesystem' => true || false,
        'resourceRequirements' => [
            [
                'type' => 'GPU', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'ulimits' => [
            [
                'hardLimit' => <integer>, // REQUIRED
                'name' => '<string>', // REQUIRED
                'softLimit' => <integer>, // REQUIRED
            ],
            // ...
        ],
        'user' => '<string>',
        'vcpus' => <integer>,
        'volumes' => [
            [
                'host' => [
                    'sourcePath' => '<string>',
                ],
                'name' => '<string>',
            ],
            // ...
        ],
    ],
    'jobDefinitionName' => '<string>', // REQUIRED
    'nodeProperties' => [
        'mainNode' => <integer>, // REQUIRED
        'nodeRangeProperties' => [ // REQUIRED
            [
                'container' => [
                    'command' => ['<string>', ...],
                    'environment' => [
                        [
                            'name' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'image' => '<string>',
                    'instanceType' => '<string>',
                    'jobRoleArn' => '<string>',
                    'linuxParameters' => [
                        'devices' => [
                            [
                                'containerPath' => '<string>',
                                'hostPath' => '<string>', // REQUIRED
                                'permissions' => ['<string>', ...],
                            ],
                            // ...
                        ],
                    ],
                    'memory' => <integer>,
                    'mountPoints' => [
                        [
                            'containerPath' => '<string>',
                            'readOnly' => true || false,
                            'sourceVolume' => '<string>',
                        ],
                        // ...
                    ],
                    'privileged' => true || false,
                    'readonlyRootFilesystem' => true || false,
                    'resourceRequirements' => [
                        [
                            'type' => 'GPU', // REQUIRED
                            'value' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'ulimits' => [
                        [
                            'hardLimit' => <integer>, // REQUIRED
                            'name' => '<string>', // REQUIRED
                            'softLimit' => <integer>, // REQUIRED
                        ],
                        // ...
                    ],
                    'user' => '<string>',
                    'vcpus' => <integer>,
                    'volumes' => [
                        [
                            'host' => [
                                'sourcePath' => '<string>',
                            ],
                            'name' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'targetNodes' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'numNodes' => <integer>, // REQUIRED
    ],
    'parameters' => ['<string>', ...],
    'retryStrategy' => [
        'attempts' => <integer>,
    ],
    'timeout' => [
        'attemptDurationSeconds' => <integer>,
    ],
    'type' => 'container|multinode', // REQUIRED
]);

Parameter Details

Members

containerProperties

Type: ContainerProperties structure

An object with various properties specific to single-node container-based jobs. If the job definition's type parameter is container, then you must specify either containerProperties or nodeProperties.

jobDefinitionName

Required: Yes
Type: string

The name of the job definition to register. Up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

nodeProperties

Type: NodeProperties structure

An object with various 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 AWS Batch User Guide. If the job definition's type parameter is container, then you must specify either containerProperties or 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.

retryStrategy

Type: RetryStrategy structure

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

timeout

Type: JobTimeout structure

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

type

Required: Yes
Type: string

The type of job definition.

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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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',
        'memory' => 128,
        'vcpus' => 1,
    ],
    'jobDefinitionName' => 'sleep10',
]);

Result syntax:

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

SubmitJob

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

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

Parameter Syntax

$result = $client->submitJob([
    'arrayProperties' => [
        'size' => <integer>,
    ],
    'containerOverrides' => [
        'command' => ['<string>', ...],
        'environment' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        'instanceType' => '<string>',
        'memory' => <integer>,
        'resourceRequirements' => [
            [
                'type' => 'GPU', // REQUIRED
                'value' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'vcpus' => <integer>,
    ],
    'dependsOn' => [
        [
            'jobId' => '<string>',
            'type' => 'N_TO_N|SEQUENTIAL',
        ],
        // ...
    ],
    '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', // REQUIRED
                            'value' => '<string>', // REQUIRED
                        ],
                        // ...
                    ],
                    'vcpus' => <integer>,
                ],
                'targetNodes' => '<string>', // REQUIRED
            ],
            // ...
        ],
        'numNodes' => <integer>,
    ],
    'parameters' => ['<string>', ...],
    'retryStrategy' => [
        'attempts' => <integer>,
    ],
    '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 AWS Batch User Guide.

containerOverrides

Type: ContainerOverrides structure

A list of container overrides in JSON format 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 (that is specified in the job definition or the Docker image) with a command override. You can also override existing environment variables (that are specified in the job definition or Docker image) 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.

jobDefinition

Required: Yes
Type: string

The job definition used by this job. This value can be either a name:revision or the Amazon Resource Name (ARN) for the job definition.

jobName

Required: Yes
Type: string

The name of the job. The first character must be alphanumeric, and up to 128 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed.

jobQueue

Required: Yes
Type: string

The job queue into which 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.

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.

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.

timeout

Type: JobTimeout structure

The timeout configuration for this SubmitJob operation. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished. If a job is terminated due to a timeout, it is not 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

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

Result Details

Members

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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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',
]

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 AWS Batch job ID of the job to terminate.

reason

Required: Yes
Type: string

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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:

[
]

UpdateComputeEnvironment

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

Updates an AWS Batch compute environment.

Parameter Syntax

$result = $client->updateComputeEnvironment([
    'computeEnvironment' => '<string>', // REQUIRED
    'computeResources' => [
        'desiredvCpus' => <integer>,
        'maxvCpus' => <integer>,
        'minvCpus' => <integer>,
    ],
    'serviceRole' => '<string>',
    'state' => 'ENABLED|DISABLED',
]);

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.

serviceRole

Type: string

The full Amazon Resource Name (ARN) of the IAM role that allows AWS Batch to make calls to other AWS services on your behalf.

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

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.

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.

Errors

ClientException:
These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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
    'priority' => <integer>,
    '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 should execute a given job.

jobQueue

Required: Yes
Type: string

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

priority

Type: int

state

Type: string

Describes the queue's ability to accept new jobs.

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, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an identifier that is 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',
]

Shapes

ArrayProperties

Description

An object representing an AWS Batch array job.

Members

size

Type: int

The size of the array job.

ArrayPropertiesDetail

Description

An object representing the array properties of a job.

Members

index

Type: int

The job index within the array that is 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 representing the array properties of a job.

Members

index

Type: int

The job index within the array that is 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 representing the details of a container that is 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 a failure.

logStreamName

Type: string

The name of the CloudWatch Logs log stream associated with the container. The log group for AWS 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 associated with the job attempt.

reason

Type: string

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

taskArn

Type: string

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

AttemptDetail

Description

An object representing a job attempt.

Members

container

Type: AttemptContainerDetail structure

Details about the container in this job attempt.

startedAt

Type: long (int|float)

The Unix timestamp (in seconds and 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 about the current status of the job attempt.

stoppedAt

Type: long (int|float)

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

ClientException

Description

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

Members

message

Type: string

ComputeEnvironmentDetail

Description

An object representing an AWS 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.

computeResources

Type: ComputeResource structure

The compute resources defined for the compute environment.

ecsClusterArn

Required: Yes
Type: string

The Amazon Resource Name (ARN) of the underlying Amazon ECS cluster used by the compute environment.

serviceRole

Type: string

The service role associated with the compute environment that allows AWS Batch to make calls to AWS API operations on your behalf.

state

Type: string

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

If the state is ENABLED, then the AWS 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 AWS Batch scheduler does not 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 do not scale out. However, they scale in to minvCpus value after instances become idle.

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 about the current status of the compute environment.

type

Type: string

The type of the compute environment.

ComputeEnvironmentOrder

Description

The order in which compute environments are tried 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.

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.

ComputeResource

Description

An object representing an AWS Batch compute resource.

Members

allocationStrategy

Type: string

The allocation strategy to use for the compute resource in case not enough instances of the best fitting instance type can be allocated. This could be due to availability of the instance type in the region or Amazon EC2 service limits. If this is not specified, the default is BEST_FIT, which will use only the best fitting instance type, waiting for additional capacity if it's not available. This allocation strategy keeps costs lower but can limit scaling. BEST_FIT_PROGRESSIVE will select an additional instance type that is large enough to meet the requirements of the jobs in the queue, with a preference for an instance type with a lower cost. SPOT_CAPACITY_OPTIMIZED is only available for Spot Instance compute resources and will select an additional instance type that is large enough to meet the requirements of the jobs in the queue, with a preference for an instance type that is less likely to be interrupted.

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 below 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.

desiredvCpus

Type: int

The desired number of Amazon EC2 vCPUS in the compute environment.

ec2KeyPair

Type: string

The Amazon EC2 key pair that is used for instances launched in the compute environment.

imageId

Type: string

The Amazon Machine Image (AMI) ID used for instances launched in the compute environment.

instanceRole

Required: Yes
Type: string

The Amazon ECS instance profile applied to Amazon EC2 instances in a compute environment. 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 AWS Batch User Guide.

instanceTypes

Required: Yes
Type: Array of strings

The instances types that may 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 pick instance types (from the C, M, and R instance families) on the fly that match the demand of your job queues.

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 AWS Batch User Guide.

maxvCpus

Required: Yes
Type: int

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

minvCpus

Required: Yes
Type: int

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

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.

securityGroupIds

Type: Array of strings

The Amazon EC2 security groups 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. If security groups are specified using both securityGroupIds and launchTemplate, the values in securityGroupIds will be used.

spotIamFleetRole

Type: string

The Amazon Resource Name (ARN) of the Amazon EC2 Spot Fleet IAM role applied to a SPOT compute environment. For more information, see Amazon EC2 Spot Fleet Role in the AWS Batch User Guide.

subnets

Required: Yes
Type: Array of strings

The VPC subnets into which the compute resources are launched. For more information, see VPCs and Subnets in the Amazon VPC User Guide.

tags

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

Key-value pair tags to be applied to resources that are launched in the compute environment. For AWS Batch, these take the form of "String1": "String2", where String1 is the tag key and String2 is the tag value—for example, { "Name": "AWS Batch Instance - C4OnDemand" }.

type

Required: Yes
Type: string

The type of compute environment: EC2 or SPOT.

ComputeResourceUpdate

Description

An object representing the attributes of a compute environment that can be updated.

Members

desiredvCpus

Type: int

The desired number of Amazon EC2 vCPUS in the compute environment.

maxvCpus

Type: int

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

minvCpus

Type: int

The minimum number of Amazon EC2 vCPUs that an environment should maintain.

ContainerDetail

Description

An object representing the details of a container that is part of a job.

Members

command

Type: Array of strings

The command that is passed to the container.

containerInstanceArn

Type: string

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

environment

Type: Array of KeyValuePair structures

The environment variables to pass to a container.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

exitCode

Type: int

The exit code to return upon completion.

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.

jobRoleArn

Type: string

The Amazon Resource Name (ARN) associated with the job upon execution.

linuxParameters

Type: LinuxParameters structure

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

logStreamName

Type: string

memory

Type: int

The number of MiB of memory reserved for the job.

mountPoints

Type: Array of MountPoint structures

The mount points for data volumes in your container.

networkInterfaces

Type: Array of NetworkInterface structures

The network interfaces 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).

readonlyRootFilesystem

Type: boolean

When this parameter is true, the container is given read-only access to its root file system.

reason

Type: string

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

resourceRequirements

Type: Array of ResourceRequirement structures

The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.

taskArn

Type: string

The Amazon Resource Name (ARN) of the Amazon ECS task that is 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.

user

Type: string

The user name to use inside the container.

vcpus

Type: int

The number of VCPUs allocated for the job.

volumes

Type: Array of Volume structures

A list of volumes associated with the job.

ContainerOverrides

Description

The overrides that should be sent to a container.

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.

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 must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

instanceType

Type: string

The instance type to use for a multi-node parallel job. This parameter is not valid for single-node container jobs.

memory

Type: int

The number of MiB of memory reserved for the job. This value overrides the value set in the job definition.

resourceRequirements

Type: Array of ResourceRequirement structures

The type and amount of a resource to assign to a container. This value overrides the value set in the job definition. Currently, the only supported resource is GPU.

vcpus

Type: int

The number of vCPUs to reserve for the container. This value overrides the value set in the job definition.

ContainerProperties

Description

Container properties are used in job definitions to describe the container that is launched as part of a job.

Members

command

Type: Array of strings

The command that is 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 do not recommend using plaintext environment variables for sensitive information, such as credential data.

Environment variables must not start with AWS_BATCH; this naming convention is reserved for variables that are set by the AWS Batch service.

image

Type: string

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 . 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 docker run.

Images in Amazon ECR repositories use the full registry and repository URI (for example, 012345678910.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. Currently all node groups in a multi-node parallel job must use the same instance type. This parameter is not valid for single-node container jobs.

jobRoleArn

Type: string

The Amazon Resource Name (ARN) of the IAM role that the container can assume for AWS permissions.

linuxParameters

Type: LinuxParameters structure

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

memory

Type: int

The hard limit (in MiB) of memory to present to the container. If your container attempts to exceed the memory specified here, the container is killed. 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.

If you are 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 AWS Batch User 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.

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.

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.

resourceRequirements

Type: Array of ResourceRequirement structures

The type and amount of a resource to assign to a container. Currently, the only supported resource is GPU.

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.

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

volumes

Type: Array of Volume structures

A list of data volumes used in a job.

ContainerSummary

Description

An object representing 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 about a running or stopped container.

Device

Description

An object representing a container instance host device.

Members

containerPath

Type: string

The path inside the container at which 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.

Host

Description

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

Members

sourcePath

Type: string

The path on the host container instance that is 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 does not 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.

JobDefinition

Description

An object representing an AWS Batch job definition.

Members

containerProperties

Type: ContainerProperties structure

An object with various properties specific to container-based jobs.

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 various properties specific to multi-node parallel jobs.

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 AWS Batch User Guide.

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.

status

Type: string

The status of the job definition.

timeout

Type: JobTimeout structure

The timeout configuration for jobs that are submitted with this job definition. You can specify a timeout duration after which AWS Batch terminates your jobs if they have not finished.

type

Required: Yes
Type: string

The type of job definition.

JobDependency

Description

An object representing an AWS Batch job dependency.

Members

jobId

Type: string

The job ID of the AWS Batch job associated with this dependency.

type

Type: string

The type of the job dependency.

JobDetail

Description

An object representing an AWS Batch job.

Members

arrayProperties

Type: ArrayPropertiesDetail structure

The array properties of the job, if it is an array job.

attempts

Type: Array of AttemptDetail structures

A list of job attempts associated with this job.

container

Type: ContainerDetail structure

An object representing the details of the container that is associated with the job.

createdAt

Type: long (int|float)

The Unix timestamp (in seconds and 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.

dependsOn

Type: Array of JobDependency structures

A list of job names or IDs on which this job depends.

jobDefinition

Required: Yes
Type: string

The job definition that is used by this job.

jobId

Required: Yes
Type: string

The ID for the job.

jobName

Required: Yes
Type: string

The name of the job.

jobQueue

Required: Yes
Type: string

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

nodeDetails

Type: NodeDetails structure

An object representing the details of a node that is associated with a multi-node parallel job.

nodeProperties

Type: NodeProperties structure

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

parameters

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

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

retryStrategy

Type: RetryStrategy structure

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

startedAt

Required: Yes
Type: long (int|float)

The Unix timestamp (in seconds and milliseconds) for when the job was started (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 do not progress to STARTING, see Jobs Stuck in RUNNABLE Status in the troubleshooting section of the AWS Batch User Guide.

statusReason

Type: string

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

stoppedAt

Type: long (int|float)

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

timeout

Type: JobTimeout structure

The timeout configuration for the job.

JobQueueDetail

Description

An object representing the details of an AWS 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 in which 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 name of the job queue.

priority

Required: Yes
Type: int

The priority of the job queue.

state

Required: Yes
Type: string

Describes the ability of the queue to accept new jobs.

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 about the current status of the job queue.

JobSummary

Description

An object representing summary details of a job.

Members

arrayProperties

Type: ArrayPropertiesSummary structure

The array properties of the job, if it is an array job.

container

Type: ContainerSummary structure

An object representing the details of the container that is associated with the job.

createdAt

Type: long (int|float)

The Unix timestamp 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.

jobId

Required: Yes
Type: string

The ID of the job.

jobName

Required: Yes
Type: string

The name of the job.

nodeProperties

Type: NodePropertiesSummary structure

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

startedAt

Type: long (int|float)

The Unix timestamp for when the job was started (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 additional details about the current status of the job.

stoppedAt

Type: long (int|float)

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

JobTimeout

Description

An object representing a job timeout configuration.

Members

attemptDurationSeconds

Type: int

The time duration in seconds (measured from the job attempt's startedAt timestamp) after which AWS Batch terminates your jobs if they have not finished.

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.

LaunchTemplateSpecification

Description

An object representing a launch template associated with a compute resource. You must specify either the launch template ID or launch template name in the request, but not both.

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.

Default: The default version of the launch template.

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

MountPoint

Description

Details on a Docker volume mount point that is 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 at which to mount the host volume.

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.

NetworkInterface

Description

An object representing 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 representing 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 begins at zero. This index is also available on the node with the AWS_BATCH_JOB_NODE_INDEX environment variable.

NodeOverrides

Description

Object representing any node overrides to a job definition that is used in a SubmitJob API operation.

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:

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 specified in the job definition must be fewer than the number of nodes specified in the override.
The main node index specified in the job definition must be fewer than the number of nodes specified in the override.

NodeProperties

Description

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

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 associated with a multi-node parallel job.

numNodes

Required: Yes
Type: int

The number of nodes associated with a multi-node parallel job.

NodePropertiesSummary

Description

An object representing the properties of a node that is 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 associated with a multi-node parallel job.

NodePropertyOverride

Description

Object representing any node overrides to a job definition that is used in a SubmitJob API operation.

Members

containerOverrides

Type: ContainerOverrides structure

The overrides that should be sent to a node range.

targetNodes

Required: Yes
Type: string

The range of nodes, using node index values, with which 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

An object representing the properties of the node range for a multi-node parallel job.

Members

container

Type: ContainerProperties structure

The container details for the node range.

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 may nest node ranges, for example 0:10 and 4:5, in which case the 4:5 range properties override the 0:10 properties.

ResourceRequirement

Description

The type and amount of a resource to assign to a container. Currently, the only supported resource type is GPU.

Members

type

Required: Yes
Type: string

The type of resource to assign to a container. Currently, the only supported resource type is GPU.

value

Required: Yes
Type: string

The number of physical GPUs to reserve for the container. The number of GPUs reserved for all containers in a job should not exceed the number of available GPUs on the compute resource that the job is launched on.

RetryStrategy

Description

The retry strategy associated with a job.

Members

attempts

Type: int

The number of times to move a job to the RUNNABLE status. You may 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.

ServerException

Description

These errors are usually caused by a server issue.

Members

message

Type: string

Ulimit

Description

The ulimit settings to pass to the container.

Members

hardLimit

Required: Yes
Type: int

The hard limit for the ulimit type.

name

Required: Yes
Type: string

The type of the ulimit.

softLimit

Required: Yes
Type: int

The soft limit for the ulimit type.

Volume

Description

A data volume used in a job's container properties.

Members

host

Type: Host structure

The contents of the host parameter determine whether your data volume persists on the host container instance and where it is stored. If the host parameter is empty, then the Docker daemon assigns a host path for your data volume. However, the data is not guaranteed to persist after the containers associated with it stop running.

name

Type: string

The name of the volume. Up to 255 letters (uppercase and lowercase), numbers, hyphens, and underscores are allowed. This name is referenced in the sourceVolume parameter of container definition mountPoints.

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

AWS Batch 2016-08-10

Operation Summary

Paginators

Operations

CancelJob

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

Examples

Example 1: To cancel a job

CreateComputeEnvironment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To create a managed EC2 compute environment

Example 2: To create a managed EC2 Spot compute environment

CreateJobQueue

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

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

Example 2: To create a job queue with multiple compute environments

DeleteComputeEnvironment

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

Examples

Example 1: To delete a compute environment

DeleteJobQueue

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

Examples

Example 1: To delete a job queue

DeregisterJobDefinition

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

Examples

Example 1: To deregister a job definition

DescribeComputeEnvironments

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

Examples

Example 1: To describe a compute environment

DescribeJobDefinitions

Parameter Syntax