Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

GetEnvironment

Describes a specific Environment

Request Syntax


{
   "id": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

id

The identifier of the specific Environment to describe.

Type: String

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

Required: Yes

Response Syntax


{
   "environment": { 
      "activationPageUrl": "string",
      "bandwidths": { 
         "available": [ "string" ],
         "supported": [ "string" ]
      },
      "environmentId": "string",
      "location": "string",
      "provider": { ... },
      "remoteIdentifierType": "string",
      "state": "string",
      "type": "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.

environment

The requested Environment structure.

Type: Environment object

Errors

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

AccessDeniedException

The calling principal is not allowed to access the specified resource, or the resource does not exist.

HTTP Status Code: 403

InterconnectClientException

The request was denied due to incorrect client supplied parameters.

HTTP Status Code: 400

InterconnectServerException

The request resulted in an exception internal to the service.

HTTP Status Code: 500

InterconnectValidationException

The input fails to satisfy the constraints specified.

HTTP Status Code: 400

ResourceNotFoundException

The request specifies a resource that does not exist on the server.

HTTP Status Code: 404

ServiceQuotaExceededException

The requested operation would result in the calling principal exceeding their allotted quota.

HTTP Status Code: 402

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429