GetEnvironment - AWS AppConfig

GetEnvironment

Retrieve information about an environment. An environment is a logical deployment group of AppConfig applications, such as applications in a Production environment or in an EU_Region 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.

Request Syntax

GET /applications/ApplicationId/environments/EnvironmentId HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

ApplicationId

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

Pattern: [a-z0-9]{4,7}

Required: Yes

EnvironmentId

The ID of the environment you wnat to get.

Pattern: [a-z0-9]{4,7}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax

HTTP/1.1 200 Content-type: application/json { "ApplicationId": "string", "Description": "string", "Id": "string", "Monitors": [ { "AlarmArn": "string", "AlarmRoleArn": "string" } ], "Name": "string", "State": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ApplicationId

The application ID.

Type: String

Pattern: [a-z0-9]{4,7}

Description

The description of the environment.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1024.

Id

The environment ID.

Type: String

Pattern: [a-z0-9]{4,7}

Monitors

Amazon CloudWatch alarms monitored during the deployment.

Type: Array of Monitor objects

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Name

The name of the environment.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

State

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

Type: String

Valid Values: READY_FOR_DEPLOYMENT | DEPLOYING | ROLLING_BACK | ROLLED_BACK

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequestException

The input fails to satisfy the constraints specified by an AWS service.

HTTP Status Code: 400

InternalServerException

There was an internal failure in the AppConfig service.

HTTP Status Code: 500

ResourceNotFoundException

The requested resource could not be found.

HTTP Status Code: 404

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: