- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
TerminateEnvironmentCommand
Terminates the specified environment.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { ElasticBeanstalkClient, TerminateEnvironmentCommand } from "@aws-sdk/client-elastic-beanstalk"; // ES Modules import
// const { ElasticBeanstalkClient, TerminateEnvironmentCommand } = require("@aws-sdk/client-elastic-beanstalk"); // CommonJS import
const client = new ElasticBeanstalkClient(config);
const input = { // TerminateEnvironmentMessage
EnvironmentId: "STRING_VALUE",
EnvironmentName: "STRING_VALUE",
TerminateResources: true || false,
ForceTerminate: true || false,
};
const command = new TerminateEnvironmentCommand(input);
const response = await client.send(command);
// { // EnvironmentDescription
// EnvironmentName: "STRING_VALUE",
// EnvironmentId: "STRING_VALUE",
// ApplicationName: "STRING_VALUE",
// VersionLabel: "STRING_VALUE",
// SolutionStackName: "STRING_VALUE",
// PlatformArn: "STRING_VALUE",
// TemplateName: "STRING_VALUE",
// Description: "STRING_VALUE",
// EndpointURL: "STRING_VALUE",
// CNAME: "STRING_VALUE",
// DateCreated: new Date("TIMESTAMP"),
// DateUpdated: new Date("TIMESTAMP"),
// Status: "Aborting" || "Launching" || "Updating" || "LinkingFrom" || "LinkingTo" || "Ready" || "Terminating" || "Terminated",
// AbortableOperationInProgress: true || false,
// Health: "Green" || "Yellow" || "Red" || "Grey",
// HealthStatus: "NoData" || "Unknown" || "Pending" || "Ok" || "Info" || "Warning" || "Degraded" || "Severe" || "Suspended",
// Resources: { // EnvironmentResourcesDescription
// LoadBalancer: { // LoadBalancerDescription
// LoadBalancerName: "STRING_VALUE",
// Domain: "STRING_VALUE",
// Listeners: [ // LoadBalancerListenersDescription
// { // Listener
// Protocol: "STRING_VALUE",
// Port: Number("int"),
// },
// ],
// },
// },
// Tier: { // EnvironmentTier
// Name: "STRING_VALUE",
// Type: "STRING_VALUE",
// Version: "STRING_VALUE",
// },
// EnvironmentLinks: [ // EnvironmentLinks
// { // EnvironmentLink
// LinkName: "STRING_VALUE",
// EnvironmentName: "STRING_VALUE",
// },
// ],
// EnvironmentArn: "STRING_VALUE",
// OperationsRole: "STRING_VALUE",
// };
Example Usage
TerminateEnvironmentCommand Input
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
EnvironmentId | string | undefined | The ID of the environment to terminate. Condition: You must specify either this or an EnvironmentName, or both. If you do not specify either, AWS Elastic Beanstalk returns |
EnvironmentName | string | undefined | The name of the environment to terminate. Condition: You must specify either this or an EnvironmentId, or both. If you do not specify either, AWS Elastic Beanstalk returns |
ForceTerminate | boolean | undefined | Terminates the target environment even if another environment in the same group is dependent on it. |
TerminateResources | boolean | undefined | Indicates whether the associated AWS resources should shut down when the environment is terminated:
For more information, see the AWS Elastic Beanstalk User Guide. Default: Valid Values: |
TerminateEnvironmentCommand Output
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
AbortableOperationInProgress | boolean | undefined | Indicates if there is an in-progress environment configuration update or application version deployment that you can cancel. |
ApplicationName | string | undefined | The name of the application associated with this environment. |
CNAME | string | undefined | The URL to the CNAME for this environment. |
DateCreated | Date | undefined | The creation date for this environment. |
DateUpdated | Date | undefined | The last modified date for this environment. |
Description | string | undefined | Describes this environment. |
EndpointURL | string | undefined | For load-balanced, autoscaling environments, the URL to the LoadBalancer. For single-instance environments, the IP address of the instance. |
EnvironmentArn | string | undefined | The environment's Amazon Resource Name (ARN), which can be used in other API requests that require an ARN. |
EnvironmentId | string | undefined | The ID of this environment. |
EnvironmentLinks | EnvironmentLink[] | undefined | A list of links to other environments in the same group. |
EnvironmentName | string | undefined | The name of this environment. |
Health | EnvironmentHealth | undefined | Describes the health status of the environment. AWS Elastic Beanstalk indicates the failure levels for a running environment:
Default: |
HealthStatus | EnvironmentHealthStatus | undefined | Returns the health status of the application running in your environment. For more information, see Health Colors and Statuses . |
OperationsRole | string | undefined | The Amazon Resource Name (ARN) of the environment's operations role. For more information, see Operations roles in the AWS Elastic Beanstalk Developer Guide. |
PlatformArn | string | undefined | The ARN of the platform version. |
Resources | EnvironmentResourcesDescription | undefined | The description of the AWS resources used by this environment. |
SolutionStackName | string | undefined | The name of the |
Status | EnvironmentStatus | undefined | The current operational status of the environment:
|
TemplateName | string | undefined | The name of the configuration template used to originally launch this environment. |
Tier | EnvironmentTier | undefined | Describes the current tier of this environment. |
VersionLabel | string | undefined | The application version deployed in this environment. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
InsufficientPrivilegesException | client | The specified account does not have sufficient privileges for one or more AWS services. |
ElasticBeanstalkServiceException | Base exception class for all service exceptions from ElasticBeanstalk service. |