AWS Batch - API Reference

1 AWS BatchAPI ReferenceAPI Version 2016-08-10 AWS Batch API ReferenceAWS Batch : API ReferenceCopyright 2018 Amazon Web Services, Inc. and/or its affiliates. All rights 's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any mannerthat is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks notowned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored Batch API ReferenceTable of ContentsWelcome .. 1 Actions .. 2 CancelJob .. 3 Request Syntax .. 3 URI Request Parameters .. 3 Request Body .. 3 Response Syntax .. 3 Response Elements .. 3 Errors .. 4 See 5 CreateComputeEnvironment .. 6 Request Syntax .. 6 URI Request Parameters .. 7 Request Body.

2 7 Response Syntax .. 8 Response Elements .. 8 Errors .. 9 See 11 CreateJobQueue .. 12 Request Syntax .. 12 URI Request Parameters .. 12 Request Body .. 12 Response Syntax .. 13 Response Elements .. 13 Errors .. 14 See 15 DeleteComputeEnvironment .. 17 Request Syntax .. 17 URI Request Parameters .. 17 Request Body .. 17 Response Syntax .. 17 Response Elements .. 17 Errors .. 18 See 20 Request Syntax .. 20 URI Request Parameters .. 20 Request Body .. 20 Response Syntax .. 20 Response Elements .. 20 Errors .. 21 See 21 DeregisterJobDefinition .. 23 Request Syntax .. 23 URI Request Parameters .. 23 Request Body .. 23 Response Syntax .. 23 Response Elements .. 23 Errors .. 23 API Version 2016-08-10iiiAWS Batch API 24 See 24 DescribeComputeEnvironments .. 26 Request Syntax .. 26 URI Request Parameters .. 26 Request Body.

3 26 Response Syntax .. 27 Response Elements .. 27 Errors .. 28 See 30 Request Syntax .. 30 URI Request Parameters .. 30 Request Body .. 30 Response Syntax .. 31 Response Elements .. 33 Errors .. 33 See 35 Request Syntax .. 35 URI Request Parameters .. 35 Request Body .. 35 Response Syntax .. 36 Response Elements .. 36 Errors .. 37 See 39 Request Syntax .. 39 URI Request Parameters .. 39 Request Body .. 39 Response Syntax .. 39 Response Elements .. 42 Errors .. 42 See 45 Request Syntax .. 45 URI Request Parameters .. 45 Request Body .. 45 Response Syntax .. 46 Response Elements .. 47 Errors .. 47 See 49 RegisterJobDefinition .. 50 Request Syntax .. 50 URI Request Parameters .. 51 Request Body .. 51 Response Syntax .. 53 Response Elements .. 53 Errors .. 53 See 57 API Version 2016-08-10ivAWS Batch API ReferenceRequest Syntax.

4 57 URI Request Parameters .. 58 Request Body .. 58 Response Syntax .. 59 Response Elements .. 60 Errors .. 60 See 61 TerminateJob .. 62 Request Syntax .. 62 URI Request Parameters .. 62 Request Body .. 62 Response Syntax .. 62 Response Elements .. 62 Errors .. 63 See 64 UpdateComputeEnvironment .. 65 Request Syntax .. 65 URI Request Parameters .. 65 Request Body .. 65 Response Syntax .. 66 Response Elements .. 66 Errors .. 67 See 69 Request Syntax .. 69 URI Request Parameters .. 69 Request Body .. 69 Response Syntax .. 70 Response Elements .. 70 Errors .. 70 See 71 Data Types .. 72 ArrayProperties .. 73 See 73 ArrayPropertiesDetail .. 74 See 74 ArrayPropertiesSummary .. 75 See 75 AttemptContainerDetail .. 76 See 76 AttemptDetail .. 78 See 78 ComputeEnvironmentDetail .. 79 See 80 ComputeEnvironmentOrder.

5 81 See 81 API Version 2016-08-10vAWS Batch API ReferenceComputeResource .. 82 See 84 ComputeResourceUpdate .. 85 See 86 See 88 ContainerOverrides .. 89 See 89 ContainerProperties .. 91 See 93 ContainerSummary .. 94 See 95 See 96 See 97 JobDependency .. 98 See 99 See 102 See 103 JobSummary .. 104 See 106 See 106 KeyValuePair .. 107 See 107 LaunchTemplateSpecification .. 108 See 108 MountPoint .. 109 See 109 NetworkInterface .. 110 See 111 See 111 NodeOverrides .. 112 See 112 API Version 2016-08-10viAWS Batch API ReferenceNodeProperties .. 113 See 113 NodePropertiesSummary .. 114 See 114 NodePropertyOverride .. 115 See 115 NodeRangeProperty .. 116 See 116 RetryStrategy .. 117 See 118 See 118 Volume .. 119 See 119 Common Parameters.

6 120 API Version 2016-08-10viiAWS Batch API ReferenceWelcomeAWS Batch enables you to run Batch computing workloads on the AWS Cloud. Batch computing is acommon way for developers, scientists, and engineers to access large amounts of compute resources,and AWS Batch removes the undifferentiated heavy lifting of configuring and managing the requiredinfrastructure. AWS Batch will be familiar to users of traditional Batch computing software. Thisservice can efficiently provision resources in response to jobs submitted in order to eliminate capacityconstraints, reduce compute costs, and deliver results a fully managed service, AWS Batch enables developers, scientists, and engineers to run batchcomputing workloads of any scale. AWS Batch automatically provisions compute resources and optimizesthe workload distribution based on the quantity and scale of the workloads.

7 With AWS Batch , there isno need to install or manage Batch computing software, which allows you to focus on analyzing resultsand solving problems. AWS Batch reduces operational complexities, saves time, and reduces costs, whichmakes it easy for developers, scientists, and engineers to run their Batch jobs in the AWS document was last published on December 7, Version 2016-08-101 AWS Batch API ReferenceActionsThe following actions are supported: CancelJob (p. 3) CreateComputeEnvironment (p. 6) CreateJobQueue (p. 12) DeleteComputeEnvironment (p. 17) DeleteJobQueue (p. 20) DeregisterJobDefinition (p. 23) DescribeComputeEnvironments (p. 26) DescribeJobDefinitions (p. 30) DescribeJobQueues (p. 35) DescribeJobs (p. 39) ListJobs (p. 45) RegisterJobDefinition (p. 50) SubmitJob (p. 57) TerminateJob (p. 62) UpdateComputeEnvironment (p.)

8 65) UpdateJobQueue (p. 69)API Version 2016-08-102 AWS Batch API ReferenceCancelJobCancelJobCancels a job in an AWS Batch job queue. Jobs that are in the SUBMITTED, PENDING, or RUNNABLE state are cancelled. Jobs that have progressed to STARTING or RUNNING are not cancelled (but theAPI operation still succeeds, even if no job is cancelled); these jobs must be terminated with theTerminateJob (p. 62) SyntaxPOST /v1/canceljob : application/json{ "jobId": "string", "reason": "string"}URI Request ParametersThe request does not use any URI BodyThe request accepts the following data in JSON (p. 3)The AWS Batch job ID of the job to : StringRequired: Yesreason (p. 3)A message to attach to the job that explains the reason for canceling it. This message is returned byfuture DescribeJobs (p. 39) operations on the job. This message is also recorded in the AWS Batchactivity : StringRequired: YesResponse 200 Response ElementsIf the action is successful, the service sends back an HTTP 200 response with an empty HTTP Version 2016-08-103 AWS Batch API ReferenceErrorsErrorsClientExceptionThes e errors are usually caused by a client action, such as using an action or resource on behalf ofa user that doesn't have permissions to use the action or resource, or specifying an identifier that isnot Status Code: 400 ServerExceptionThese errors are usually caused by a server Status Code: 500 ExampleIn the following example or examples, the Authorization header contents (AUTHPARAMS) must bereplaced with an AWS Signature Version 4 signature.

9 For more information about creating thesesignatures, see Signature Version 4 Signing Process in the AWS General only need to learn how to sign HTTP requests if you intend to manually create them. When you usethe AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, thesetools automatically sign the requests for you with the access key that you specify when you configure thetools. When you use these tools, you don't need to learn how to sign requests example cancels a job with the specified job RequestPOST /v1/canceljob : : identityContent-Length: 78 Authorization: AUTHPARAMSX-Amz-Date: 20161130T001258 ZUser-Agent: aws- { "reason": "Cancelling job.", "jobId": "1d828f65-7a4d-42e8-996d-3b900ed59dc4"}S ample 200 OKContent-Type: application/jsonContent-Length: 2 Connection: keep-aliveDate: Wed, 30 Nov 2016 00:12:59 GMTx-amzn-RequestId: c0049e91-b691-11e6-964d-89ad0cc99f8eX-Am zn-Trace-Id: Root=1-583e198a-cc8df0f4fac14f0d51777093 X-Cache: Miss from cloudfrontVia: (CloudFront)X-Amz-Cf-Id: whn1dX1uTx34 Lvao7-7 ZdkDXEbCZ_sjn3v3hHVFgbo1 ORJtXyeggSw==API Version 2016-08-104 AWS Batch API ReferenceSee Also{}See AlsoFor more information about using this API in one of the language-specific AWS SDKs, see the following: AWS Command Line Interface AWS SDK for.

10 NET AWS SDK for C++ AWS SDK for Go AWS SDK for Java AWS SDK for JavaScript AWS SDK for PHP V3 AWS SDK for Python AWS SDK for Ruby V2 API Version 2016-08-105 AWS Batch API ReferenceCreateComputeEnvironmentCreateC omputeEnvironmentCreates an AWS Batch compute environment. You can create MANAGED or UNMANAGED a managed compute environment, AWS Batch manages the capacity and instance types of thecompute resources within the environment. This is based on the compute resource specification thatyou define or the launch template that you specify when you create the compute environment. Youcan choose to use Amazon EC2 On-Demand Instances or Spot Instances in your managed computeenvironment. You can optionally set a maximum price so that Spot Instances only launch when the SpotInstance price is below a specified percentage of the On-Demand parallel jobs are not supported on Spot an unmanaged compute environment, you can manage your own compute resources.