Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Class DeleteEnvironmentCommandProtected

Deletes a specific runtime environment. The environment cannot contain deployed applications. If it does, you must delete those applications before you delete the environment.

Example

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

import { M2Client, DeleteEnvironmentCommand } from "@aws-sdk/client-m2"; // ES Modules import
// const { M2Client, DeleteEnvironmentCommand } = require("@aws-sdk/client-m2"); // CommonJS import
const client = new M2Client(config);
const input = { // DeleteEnvironmentRequest
environmentId: "STRING_VALUE", // required
};
const command = new DeleteEnvironmentCommand(input);
const response = await client.send(command);
// {};

Param

DeleteEnvironmentCommandInput

Returns

DeleteEnvironmentCommandOutput

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

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