Jump to Content

This API Documentation is now deprecated

We are excited to announce our new API Documentation.

Class UpdateEnvironmentCommandProtected

Updates the configuration details for a specific runtime environment.

Example

Use a bare-bones client and the command you need to make an API call.

import { M2Client, UpdateEnvironmentCommand } from "@aws-sdk/client-m2"; // ES Modules import
// const { M2Client, UpdateEnvironmentCommand } = require("@aws-sdk/client-m2"); // CommonJS import
const client = new M2Client(config);
const input = { // UpdateEnvironmentRequest
environmentId: "STRING_VALUE", // required
desiredCapacity: Number("int"),
instanceType: "STRING_VALUE",
engineVersion: "STRING_VALUE",
preferredMaintenanceWindow: "STRING_VALUE",
applyDuringMaintenanceWindow: true || false,
forceUpdate: true || false,
};
const command = new UpdateEnvironmentCommand(input);
const response = await client.send(command);
// { // UpdateEnvironmentResponse
// environmentId: "STRING_VALUE", // required
// };

Param

UpdateEnvironmentCommandInput

Returns

UpdateEnvironmentCommandOutput

See

Throws

AccessDeniedException (client fault)

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

Throws

ConflictException (client fault)

The parameters provided in the request conflict with existing resources.

Throws

InternalServerException (server fault)

An unexpected error occurred during the processing of the request.

Throws

ResourceNotFoundException (client fault)

The specified resource was not found.

Throws

ServiceQuotaExceededException (client fault)

One or more quotas for Amazon Web Services Mainframe Modernization exceeds the limit.

Throws

ThrottlingException (client fault)

The number of requests made exceeds the limit.

Throws

ValidationException (client fault)

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

Throws

M2ServiceException

Base exception class for all service exceptions from M2 service.

Hierarchy

Constructors

Properties

Methods

Constructors

Properties

Methods