UpdateEnvironment - AWS Mainframe Modernization


Updates the configuration details for a specific runtime environment.

Request Syntax

PATCH /environments/environmentId HTTP/1.1 Content-type: application/json { "applyDuringMaintenanceWindow": boolean, "desiredCapacity": number, "engineVersion": "string", "forceUpdate": boolean, "instanceType": "string", "preferredMaintenanceWindow": "string" }

URI Request Parameters

The request uses the following URI parameters.


The unique identifier of the runtime environment that you want to update.

Pattern: ^\S{1,80}$

Required: Yes

Request Body

The request accepts the following data in JSON format.


Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, AWS Mainframe Modernization accepts the engineVersion parameter only if applyDuringMaintenanceWindow is true. If any parameter other than engineVersion is provided in UpdateEnvironmentRequest, it will fail if applyDuringMaintenanceWindow is set to true.

Type: Boolean

Required: No


The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100.

Type: Integer

Required: No


The version of the runtime engine for the runtime environment.

Type: String

Pattern: ^\S{1,10}$

Required: No


Forces the updates on the environment. This option is needed if the applications in the environment are not stopped or if there are ongoing application-related activities in the environment.

If you use this option, be aware that it could lead to data corruption in the applications, and that you might need to perform repair and recovery procedures for the applications.

This option is not needed if the attribute being updated is preferredMaintenanceWindow.

Type: Boolean

Required: No


The instance type for the runtime environment to update.

Type: String

Pattern: ^\S{1,20}$

Required: No


Configures the maintenance window that you want for the runtime environment. The maintenance window must have the format ddd:hh24:mi-ddd:hh24:mi and must be less than 24 hours. The following two examples are valid maintenance windows: sun:23:45-mon:00:15 or sat:01:00-sat:03:00.

If you do not provide a value, a random system-generated value will be assigned.

Type: String

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "environmentId": "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.


The unique identifier of the runtime environment that was updated.

Type: String

Pattern: ^\S{1,80}$


For information about the errors that are common to all actions, see Common Errors.


The account or role doesn't have the right permissions to make the request.

HTTP Status Code: 403


The parameters provided in the request conflict with existing resources.

HTTP Status Code: 409


An unexpected error occurred during the processing of the request.

HTTP Status Code: 500


The specified resource was not found.

HTTP Status Code: 404


One or more quotas for AWS Mainframe Modernization exceeds the limit.

HTTP Status Code: 402


The number of requests made exceeds the limit.

HTTP Status Code: 429


One or more parameters provided in the request is not valid.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: