UpdateComputeEnvironment
Updates an Amazon Batch compute environment.
Request Syntax
POST /v1/updatecomputeenvironment HTTP/1.1
Content-type: application/json
{
"computeEnvironment": "string
",
"computeResources": {
"allocationStrategy": "string
",
"bidPercentage": number
,
"desiredvCpus": number
,
"ec2Configuration": [
{
"imageIdOverride": "string
",
"imageKubernetesVersion": "string
",
"imageType": "string
"
}
],
"ec2KeyPair": "string
",
"imageId": "string
",
"instanceRole": "string
",
"instanceTypes": [ "string
" ],
"launchTemplate": {
"launchTemplateId": "string
",
"launchTemplateName": "string
",
"overrides": [
{
"launchTemplateId": "string
",
"launchTemplateName": "string
",
"targetInstanceTypes": [ "string
" ],
"version": "string
"
}
],
"version": "string
"
},
"maxvCpus": number
,
"minvCpus": number
,
"placementGroup": "string
",
"securityGroupIds": [ "string
" ],
"subnets": [ "string
" ],
"tags": {
"string
" : "string
"
},
"type": "string
",
"updateToLatestImageVersion": boolean
},
"context": "string
",
"serviceRole": "string
",
"state": "string
",
"unmanagedvCpus": number
,
"updatePolicy": {
"jobExecutionTimeoutMinutes": number
,
"terminateJobsOnUpdate": boolean
}
}
URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- computeEnvironment
-
The name or full Amazon Resource Name (ARN) of the compute environment to update.
Type: String
Required: Yes
- computeResources
-
Details of the compute resources managed by the compute environment. Required for a managed compute environment. For more information, see Compute Environments in the Amazon Batch User Guide.
Type: ComputeResourceUpdate object
Required: No
- context
-
Reserved.
Type: String
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 the compute environment has a service-linked role, it can't be changed to use a regular IAM role. Likewise, if the compute environment has a regular IAM role, it can't be changed to use a service-linked role. To update the parameters for the compute environment that require an infrastructure update to change, the AWSServiceRoleForBatch service-linked role must be used. For more information, see Updating compute environments in the Amazon Batch User Guide.
If your specified role has a path other than
/
, then you must either specify the full role ARN (recommended) or prefix the role name with the path.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 theservice-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. Compute environments in the
ENABLED
state can accept jobs from a queue and scale in or out automatically based on the workload demand of its associated queues.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 aSTARTING
orRUNNING
state continue to progress normally. Managed compute environments in theDISABLED
state don't scale out.Note
Compute environments in a
DISABLED
state may continue to incur billing charges. To prevent additional charges, turn off and then delete the compute environment. For more information, see State in the Amazon Batch User Guide.When an instance is idle, the instance scales down to the
minvCpus
value. However, the instance size doesn't change. For example, consider ac5.8xlarge
instance with aminvCpus
value of4
and adesiredvCpus
value of36
. This instance doesn't scale down to ac5.large
instance.Type: String
Valid Values:
ENABLED | DISABLED
Required: No
- unmanagedvCpus
-
The maximum number of vCPUs expected to be used for an unmanaged compute environment. Don't specify this parameter for a managed compute environment. This parameter is only used for fair-share scheduling to reserve vCPU capacity for new share identifiers. If this parameter isn't provided for a fair-share job queue, no vCPU capacity is reserved.
Type: Integer
Required: No
- updatePolicy
-
Specifies the updated infrastructure update policy for the compute environment. For more information about infrastructure updates, see Updating compute environments in the Amazon Batch User Guide.
Type: UpdatePolicy object
Required: No
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. It can be up to 128 characters long. It can contain uppercase and lowercase letters, numbers, hyphens (-), and underscores (_).
Type: String
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.
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
(
[authorization-params]
) 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)
Example
This example disables the P3OnDemand
compute environment so it can be
deleted.
Sample Request
POST /v1/updatecomputeenvironment HTTP/1.1
Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: AUTHPARAMS
X-Amz-Date: 20161128T194248Z
User-Agent: aws-cli/1.11.21 Python/2.7.12 Darwin/16.1.0 botocore/1.4.78
{
"computeEnvironment": "P3OnDemand",
"state": "DISABLED"
}
Sample Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
Date: Mon, 28 Nov 2016 19:42:49 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 7f3f42df8af148df1f9f1ee7175987ad.cloudfront.net (CloudFront)
X-Amz-Cf-Id: uxJn0P7cg_1RTxOs15FkCItWfmCeniKMZdXlFWaOfPfjqATHw3j-AA==
{
"computeEnvironmentName": "P3OnDemand",
"computeEnvironmentArn": "arn:aws:batch:us-east-1:123456789012:compute-environment/P3OnDemand"
}
See Also
For more information about using this API in one of the language-specific Amazon SDKs, see the following: