Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1443136141.7 KB

Retrieves information about an environment. An environment is a deployment group of AppConfig applications, such as applications in a <code>Production</code> environment or in an <code>EU_Region</code> environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.

get/applications/{ApplicationId}/environments/{EnvironmentId}

Path parameters

ApplicationIdstring required

The ID of the application that includes the environment you want to get.

EnvironmentIdstring required

The ID of the environment that you want to get.

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"
}