AWS Batch 2016-08-10

CancelJob

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

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([/* ... */]);

Parameter Syntax

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

Parameter Details

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([/* ... */]);

Parameter Syntax

$result = $client->createJobQueue([
    'computeEnvironmentOrder' => [ // REQUIRED
        [
            'computeEnvironment' => '<string>', // REQUIRED
            'order' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'jobQueueName' => '<string>', // 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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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

Result Details

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([/* ... */]);

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>',
                    ],
                    // ...
                ],
                '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,
                'resourceRequirements' => [
                    [
                        'type' => 'GPU|VCPU|MEMORY',
                        'value' => '<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>',
                    ],
                    // ...
                ],
            ],
            'eksProperties' => [
                'podProperties' => [
                    'containers' => [
                        [
                            'args' => ['<string>', ...],
                            'command' => ['<string>', ...],
                            'env' => [
                                [
                                    'name' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'image' => '<string>',
                            'imagePullPolicy' => '<string>',
                            'name' => '<string>',
                            'resources' => [
                                'limits' => ['<string>', ...],
                                'requests' => ['<string>', ...],
                            ],
                            'securityContext' => [
                                '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,
                    'serviceAccountName' => '<string>',
                    '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>',
                                ],
                                // ...
                            ],
                            '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,
                            'resourceRequirements' => [
                                [
                                    'type' => 'GPU|VCPU|MEMORY',
                                    'value' => '<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>',
                                ],
                                // ...
                            ],
                        ],
                        '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([/* ... */]);

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>',
            '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([/* ... */]);

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>,
                ],
                // ...
            ],
            'container' => [
                'command' => ['<string>', ...],
                'containerInstanceArn' => '<string>',
                'environment' => [
                    [
                        'name' => '<string>',
                        'value' => '<string>',
                    ],
                    // ...
                ],
                '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>',
                'resourceRequirements' => [
                    [
                        'type' => 'GPU|VCPU|MEMORY',
                        'value' => '<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',
                ],
                // ...
            ],
            'eksAttempts' => [
                [
                    'containers' => [
                        [
                            'exitCode' => <integer>,
                            'reason' => '<string>',
                        ],
                        // ...
                    ],
                    'nodeName' => '<string>',
                    'podName' => '<string>',
                    'startedAt' => <integer>,
                    'statusReason' => '<string>',
                    'stoppedAt' => <integer>,
                ],
                // ...
            ],
            'eksProperties' => [
                'podProperties' => [
                    'containers' => [
                        [
                            'args' => ['<string>', ...],
                            'command' => ['<string>', ...],
                            'env' => [
                                [
                                    'name' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'exitCode' => <integer>,
                            'image' => '<string>',
                            'imagePullPolicy' => '<string>',
                            'name' => '<string>',
                            'reason' => '<string>',
                            'resources' => [
                                'limits' => ['<string>', ...],
                                'requests' => ['<string>', ...],
                            ],
                            'securityContext' => [
                                '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,
                    'nodeName' => '<string>',
                    'podName' => '<string>',
                    'serviceAccountName' => '<string>',
                    '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>',
                                ],
                                // ...
                            ],
                            '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,
                            'resourceRequirements' => [
                                [
                                    'type' => 'GPU|VCPU|MEMORY',
                                    'value' => '<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>',
                                ],
                                // ...
                            ],
                        ],
                        '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([/* ... */]);

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.

ListJobs

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

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

Parameter Syntax

$result = $client->registerJobDefinition([
    'containerProperties' => [
        'command' => ['<string>', ...],
        'environment' => [
            [
                'name' => '<string>',
                'value' => '<string>',
            ],
            // ...
        ],
        '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,
        '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>',
        '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>',
            ],
            // ...
        ],
    ],
    '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' => [
                        '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,
            'serviceAccountName' => '<string>',
            '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>',
                        ],
                        // ...
                    ],
                    '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,
                    '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>',
                    '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>',
                        ],
                        // ...
                    ],
                ],
                '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([/* ... */]);

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',
        ],
        // ...
    ],
    'eksPropertiesOverride' => [
        'podProperties' => [
            'containers' => [
                [
                    'args' => ['<string>', ...],
                    'command' => ['<string>', ...],
                    'env' => [
                        [
                            'name' => '<string>', // REQUIRED
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'image' => '<string>',
                    'resources' => [
                        'limits' => ['<string>', ...],
                        'requests' => ['<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>,
                ],
                '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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

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([/* ... */]);

Parameter Syntax

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

Parameter Details

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([/* ... */]);

Parameter Syntax

$result = $client->updateJobQueue([
    'computeEnvironmentOrder' => [
        [
            'computeEnvironment' => '<string>', // REQUIRED
            'order' => <integer>, // REQUIRED
        ],
        // ...
    ],
    'jobQueue' => '<string>', // 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([/* ... */]);

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.