Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443136141.7 KB

Creates an environment. For each application, you define one or more environments. An environment is a deployment group of AppConfig targets, such as applications in a <code>Beta</code> or <code>Production</code> environment. You can also define environments for application subcomponents such as the <code>Web</code>, <code>Mobile</code> and <code>Back-end</code> components for your application. You can configure Amazon CloudWatch alarms for each environment. The system monitors alarms during a configuration deployment. If an alarm is triggered, the system rolls back the configuration.

post/applications/{ApplicationId}/environments

Path parameters

ApplicationIdstring required

The application ID.

Request body

Namestring required

A name for the environment.

Descriptionstring

A description of the environment.

Tagsobject

Metadata to assign to the environment. Tags help organize and categorize your AppConfig resources. Each tag consists of a key and an optional value, both of which you define.

Response

Success

ApplicationIdstring

The application ID.

Idstring

The environment ID.

Namestring

The name of the environment.

Descriptionstring

The description of the environment.

State'READY_FOR_DEPLOYMENT' | 'DEPLOYING' | 'ROLLING_BACK' | 'ROLLED_BACK'

The state of the environment. An environment can be in one of the following states: <code>READY_FOR_DEPLOYMENT</code>, <code>DEPLOYING</code>, <code>ROLLING_BACK</code>, or <code>ROLLED_BACK</code>

Example response

{
  "ApplicationId": "339ohji",
  "Description": "An environment for examples.",
  "Id": "54j1r29",
  "Name": "Example-Environment",
  "State": "ROLLED_BACK"
}