Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors Examples See Also

UpdateServiceEnvironment

Updates a service environment. You can update the state of a service environment from ENABLED to DISABLED to prevent new service jobs from being placed in the service environment.

Request Syntax


POST /v1/updateserviceenvironment HTTP/1.1
Content-type: application/json

{
   "capacityLimits": [ 
      { 
         "capacityUnit": "string",
         "maxCapacity": number
      }
   ],
   "serviceEnvironment": "string",
   "state": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

capacityLimits

The capacity limits for the service environment. This defines the maximum resources that can be used by service jobs in this environment.

Type: Array of CapacityLimit objects

Required: No

serviceEnvironment

The name or ARN of the service environment to update.

Type: String

Required: Yes

state

The state of the service environment.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "serviceEnvironmentArn": "string",
   "serviceEnvironmentName": "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.

serviceEnvironmentArn

The Amazon Resource Name (ARN) of the service environment that was updated.

Type: String

serviceEnvironmentName

The name of the service environment that was updated.

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 AWS Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the AWS General Reference.

You only need to learn how to sign HTTP requests if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, 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 updates a service environment to disable it.

Sample Request


POST /v1/updateserviceenvironment HTTP/1.1
Host: batch.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: [content-length]
Authorization: [authorization-params]
X-Amz-Date: 20250801T154520Z
User-Agent: aws-cli/2.27.33 Python/3.13.4 Darwin/24.3.0

{
  "serviceEnvironment": "SageMakerTrainingEnv",
  "state": "DISABLED"
}

Sample Response


HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: [content-length]
Connection: keep-alive
Date: Fri, 01 Aug 2025 15:45:21 GMT
x-amzn-RequestId: [request-id]
X-Amzn-Trace-Id: [trace-id]
X-Cache: Miss from cloudfront
Via: 1.1 25g84de7k2m5n8p1q4r9s6t3w2xexample.cloudfront.net (CloudFront)
X-Amz-Cf-Id: ghi4jkl7mno0pqr3stu6vwx9yz2345fghijklmnopqrstuexample

{
  "serviceEnvironmentName": "SageMakerTrainingEnv",
  "serviceEnvironmentArn": "arn:aws:batch:us-east-1:123456789012:service-environment/SageMakerTrainingEnv"
}