CancelJob

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

Cancels a job in an Batch job queue. Jobs that are in a SUBMITTED, PENDING, or RUNNABLE state are cancelled and the job status is updated to FAILED.

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To cancel a job

This example cancels a job with the specified job ID.

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

Result syntax:

[
]

CreateComputeEnvironment

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

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

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

In an unmanaged compute environment, you can manage your own EC2 compute resources and have flexibility with how you configure your compute resources. For example, you can use custom AMIs. However, you must verify that each of your AMIs meet the Amazon ECS container instance AMI specification. For more information, see container instance AMIs in the Amazon Elastic Container Service Developer Guide. After you created your unmanaged compute environment, you can use the DescribeComputeEnvironments operation to find the Amazon ECS cluster that's associated with it. Then, launch your container instances into that Amazon ECS cluster. For more information, see Launching an Amazon ECS container instance in the Amazon Elastic Container Service Developer Guide.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To create a managed EC2 compute environment

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

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

Result syntax:

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

Example 2: To create a managed EC2 Spot compute environment

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

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

Result syntax:

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

CreateJobQueue

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

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

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

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

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

Result syntax:

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

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

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

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

Result syntax:

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

CreateSchedulingPolicy

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

Creates an Batch scheduling policy.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

DeleteComputeEnvironment

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

Deletes an Batch compute environment.

Before you can delete a compute environment, you must set its state to DISABLED with the UpdateComputeEnvironment API operation and disassociate it from any job queues with the UpdateJobQueue API operation. Compute environments that use Fargate resources must terminate all active jobs on that compute environment before deleting the compute environment. If this isn't done, the compute environment enters an invalid state.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To delete a compute environment

This example deletes the P2OnDemand compute environment.

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

Result syntax:

[
]

DeleteJobQueue

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

Deletes the specified job queue. You must first disable submissions for a queue with the UpdateJobQueue operation. All jobs in the queue are eventually terminated when you delete a job queue. The jobs are terminated at a rate of about 16 jobs each second.

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To delete a job queue

This example deletes the GPGPU job queue.

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

Result syntax:

[
]

DeleteSchedulingPolicy

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

Deletes the specified scheduling policy.

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

DeregisterJobDefinition

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To deregister a job definition

This example deregisters a job definition called sleep10.

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

Result syntax:

[
]

DescribeComputeEnvironments

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

Describes one or more of your compute environments.

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To describe a compute environment

This example describes the P2OnDemand compute environment.

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

Result syntax:

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

DescribeJobDefinitions

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To describe active job definitions

This example describes all of your active job definitions.

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

Result syntax:

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

DescribeJobQueues

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

Describes one or more of your job queues.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To describe a job queue

This example describes the HighPriority job queue.

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

Result syntax:

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

DescribeJobs

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

Describes a list of Batch jobs.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To describe a specific job

This example describes a job with the specified job ID.

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

Result syntax:

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

DescribeSchedulingPolicies

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

Describes one or more of your scheduling policies.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

GetJobQueueSnapshot

$result = $client->getJobQueueSnapshot([/* ... */]);
$promise = $client->getJobQueueSnapshotAsync([/* ... */]);

Provides a list of the first 100 RUNNABLE jobs associated to a single job queue.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'frontOfQueue' => [
        'jobs' => [
            [
                'earliestTimeAtPosition' => <integer>,
                'jobArn' => '<string>',
            ],
            // ...
        ],
        'lastUpdatedAt' => <integer>,
    ],
]

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

ListJobs

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

Returns a list of Batch jobs.

You must specify only one of the following items:

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

• A multi-node parallel job ID to return a list of nodes for that job

• An array job ID to return a list of the children for that job

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To list running jobs

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

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

Result syntax:

[
    'jobSummaryList' => [
        [
            'jobId' => 'e66ff5fd-a1ff-4640-b1a2-0b0a142f49bb',
            'jobName' => 'example',
        ],
    ],
]

Example 2: To list submitted jobs

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

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

Result syntax:

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

ListSchedulingPolicies

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

Returns a list of Batch scheduling policies.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

ListTagsForResource

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: ListTagsForResource Example

This demonstrates calling the ListTagsForResource action.

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

Result syntax:

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

RegisterJobDefinition

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

Registers an Batch job definition.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To register a job definition

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

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

Result syntax:

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

Example 2: RegisterJobDefinition with tags

This demonstrates calling the RegisterJobDefinition action, including tags.

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

Result syntax:

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

SubmitJob

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

Submits an Batch job from a job definition. Parameters that are specified during SubmitJob override parameters defined in the job definition. vCPU and memory requirements that are specified in the resourceRequirements objects in the job definition are the exception. They can't be overridden this way using the memory and vcpus parameters. Rather, you must specify updates to job definition parameters in a resourceRequirements object that's included in the containerOverrides parameter.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To submit a job to a queue

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

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

Result syntax:

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

TagResource

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: TagResource Example

This demonstrates calling the TagResource action.

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

Result syntax:

[
]

TerminateJob

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

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To terminate a job

This example terminates a job with the specified job ID.

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

Result syntax:

[
]

UntagResource

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

Deletes specified tags from an Batch resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: UntagResource Example

This demonstrates calling the UntagResource action.

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

Result syntax:

[
]

UpdateComputeEnvironment

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

Updates an Batch compute environment.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To update a compute environment

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

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

Result syntax:

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

UpdateJobQueue

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

Updates a job queue.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.

Examples

Example 1: To update a job queue

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

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

Result syntax:

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

UpdateSchedulingPolicy

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

Updates a scheduling policy.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ClientException:

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

ServerException:

These errors are usually caused by a server issue.