CreateComputeEnvironment - Amazon Batch
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

CreateComputeEnvironment

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

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

Note

Multi-node parallel jobs aren't supported on Spot Instances.

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

Note

Amazon Batch doesn't upgrade the AMIs in a compute environment after the environment is created. For example, it doesn't update the AMIs when a newer version of the Amazon ECS optimized AMI is available. Therefore, you're responsible for managing the guest operating system (including its updates and security patches) and any additional application software or utilities that you install on the compute resources. To use a new AMI for your Amazon Batch jobs, complete these steps:

  1. Create a new compute environment with the new AMI.

  2. Add the compute environment to an existing job queue.

  3. Remove the earlier compute environment from your job queue.

  4. Delete the earlier compute environment.

Request Syntax

POST /v1/createcomputeenvironment HTTP/1.1 Content-type: application/json { "computeEnvironmentName": "string", "computeResources": { "allocationStrategy": "string", "bidPercentage": number, "desiredvCpus": number, "ec2Configuration": [ { "imageIdOverride": "string", "imageType": "string" } ], "ec2KeyPair": "string", "imageId": "string", "instanceRole": "string", "instanceTypes": [ "string" ], "launchTemplate": { "launchTemplateId": "string", "launchTemplateName": "string", "version": "string" }, "maxvCpus": number, "minvCpus": number, "placementGroup": "string", "securityGroupIds": [ "string" ], "spotIamFleetRole": "string", "subnets": [ "string" ], "tags": { "string" : "string" }, "type": "string" }, "serviceRole": "string", "state": "string", "tags": { "string" : "string" }, "type": "string" }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

computeEnvironmentName

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

Type: String

Required: Yes

computeResources

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

Type: ComputeResource object

Required: No

serviceRole

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

Important

If your account has already created the Amazon Batch service-linked role, that role is used by default for your compute environment unless you specify a role here. If the Amazon Batch service-linked role does not exist in your account, and no role is specified here, the service will try to create the Amazon Batch service-linked role in your account.

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

Note

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

Type: String

Required: No

state

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

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

If the state is DISABLED, then the Amazon Batch scheduler doesn't attempt to place jobs within the environment. Jobs in a STARTING or RUNNING state continue to progress normally. Managed compute environments in the DISABLED state don't scale out. However, they scale in to minvCpus value after instances become idle.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

tags

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

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

Type: String to string map

Map Entries: Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Maximum length of 256.

Required: No

type

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

Type: String

Valid Values: MANAGED | UNMANAGED

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "computeEnvironmentArn": "string", "computeEnvironmentName": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

computeEnvironmentArn

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

Type: String

computeEnvironmentName

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

Type: String

Errors

ClientException

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

HTTP Status Code: 400

ServerException

These errors are usually caused by a server issue.

HTTP Status Code: 500

Examples

In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an Amazon Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the Amazon General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the Amazon Command Line Interface (Amazon CLI) or one of the Amazon SDKs to make requests to Amazon, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.

Example

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

Sample Request

POST /v1/createcomputeenvironment HTTP/1.1 Host: batch.us-east-1.amazonaws.com Accept-Encoding: identity Content-Length: 538 Authorization: AUTHPARAMS X-Amz-Date: 20161128T223128Z User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78 { "computeEnvironmentName": "C4OnDemand", "state": "ENABLED", "type": "MANAGED", "computeResources": { "subnets": [ "subnet-220c0e0a", "subnet-1a95556d", "subnet-978f6dce" ], "tags": { "Name": "Batch Instance - C4OnDemand", "Department": "Engineering" }, "desiredvCpus": 48, "minvCpus": 0, "instanceTypes": [ "c4.large", "c4.xlarge", "c4.2xlarge", "c4.4xlarge", "c4.8xlarge" ], "securityGroupIds": [ "sg-cf5093b2" ], "instanceRole": "ecsInstanceRole", "maxvCpus": 128, "type": "EC2", "ec2KeyPair": "id_rsa" }, "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole" }

Sample Response

HTTP/1.1 200 OK Date: Mon, 28 Nov 2016 22:31:28 GMT Content-Type: application/json Content-Length: 133 Connection: keep-alive x-amzn-RequestId: 67558123-b5ba-11e6-b909-370261104d69 X-Amzn-Trace-Id: Root=1-583cb040-93d52243313314b33c0c1e97 X-Cache: Miss from cloudfront Via: 1.1 7e587c722adb25336835ccb4e5814e4e.cloudfront.net (CloudFront) X-Amz-Cf-Id: GwQRsxvmiuj1HYwbYq9MAEsQfJpN6BknGQlNX1jAd5qLQFXyHBwOUQ== { "computeEnvironmentName": "C4OnDemand", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/C4OnDemand" }

Example

This example creates a managed compute environment with the M4 instance type that's launched when the Spot Instance price less than or equal to 20% of the On-Demand price for the instance type. The compute environment is called M4Spot.

Sample Request

POST /v1/createcomputeenvironment HTTP/1.1 Host: batch.us-east-1.amazonaws.com Accept-Encoding: identity Content-Length: 568 Authorization: AUTHPARAMS X-Amz-Date: 20161128T223813Z User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78 { "computeEnvironmentName": "M4Spot", "state": "ENABLED", "type": "MANAGED", "computeResources": { "subnets": [ "subnet-220c0e0a", "subnet-1a95556d", "subnet-978f6dce" ], "type": "SPOT", "spotIamFleetRole": "arn:aws:iam::012345678910:role/aws-ec2-spot-fleet-role", "tags": { "Name": "Batch Instance - M4Spot", "Department": "Marketing" }, "desiredvCpus": 4, "minvCpus": 0, "instanceTypes": [ "m4" ], "securityGroupIds": [ "sg-cf5093b2" ], "instanceRole": "ecsInstanceRole", "maxvCpus": 128, "bidPercentage": 20, "ec2KeyPair": "id_rsa" }, "serviceRole": "arn:aws:iam::012345678910:role/AWSBatchServiceRole" }

Sample Response

HTTP/1.1 200 OK Date: Mon, 28 Nov 2016 22:38:16 GMT Content-Type: application/json Content-Length: 125 Connection: keep-alive x-amzn-RequestId: 59422e20-b5bb-11e6-9a64-53057c7adce9 X-Amzn-Trace-Id: Root=1-583cb1d6-b71bcabf4f10bae0f3ade63b X-Cache: Miss from cloudfront Via: 1.1 8455edd9286a1292a39c993fdeccce65.cloudfront.net (CloudFront) X-Amz-Cf-Id: 4mklLyUpygUko86fMNzPgA8_D64lSwPmG6iIKhAZkGpOp2e-3cKg_w== { "computeEnvironmentName": "M4Spot", "computeEnvironmentArn": "arn:aws:batch:us-east-1:012345678910:compute-environment/M4Spot" }