View a markdown version of this page

GetEnvironment - AWS Interconnect

GetEnvironment

Describes a specific Environment

Request Parameters

id

The identifier of the specific Environment to describe.

Type: String

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

Required: Yes

Response Elements

The following element is returned 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

See Also

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