Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetEnvironment

Gets an AWS Migration Hub Refactor Spaces environment.

Request Syntax


GET /environments/EnvironmentIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

EnvironmentIdentifier

The ID of the environment.

Length Constraints: Fixed length of 14.

Pattern: ^env-[0-9A-Za-z]{10}$

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "Arn": "string",
   "CreatedTime": number,
   "Description": "string",
   "EnvironmentId": "string",
   "Error": { 
      "AccountId": "string",
      "AdditionalDetails": { 
         "string" : "string" 
      },
      "Code": "string",
      "Message": "string",
      "ResourceIdentifier": "string",
      "ResourceType": "string"
   },
   "LastUpdatedTime": number,
   "Name": "string",
   "NetworkFabricType": "string",
   "OwnerAccountId": "string",
   "State": "string",
   "Tags": { 
      "string" : "string" 
   },
   "TransitGatewayId": "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.

Arn

The Amazon Resource Name (ARN) of the environment.

Type: String

Length Constraints: Minimum length of 20. Maximum length of 2048.

Pattern: ^arn:aws:refactor-spaces:[a-zA-Z0-9\-]+:\w{12}:[a-zA-Z_0-9+=,.@\-_/]+$

CreatedTime

A timestamp that indicates when the environment is created.

Type: Timestamp

Description

The description of the environment.

Type: String

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

Pattern: ^[a-zA-Z0-9-_\s\.\!\*\#\@\']+$

EnvironmentId

The unique identifier of the environment.

Type: String

Length Constraints: Fixed length of 14.

Pattern: ^env-[0-9A-Za-z]{10}$

Error

Any error associated with the environment resource.

Type: ErrorResponse object

LastUpdatedTime

A timestamp that indicates when the environment was last updated.

Type: Timestamp

Name

The name of the environment.

Type: String

Length Constraints: Minimum length of 3. Maximum length of 63.

Pattern: ^(?!env-)[a-zA-Z0-9]+[a-zA-Z0-9-_ ]+$

NetworkFabricType

The network fabric type of the environment.

Type: String

Valid Values: TRANSIT_GATEWAY | NONE

OwnerAccountId

The AWS account ID of the environment owner.

Type: String

Length Constraints: Fixed length of 12.

Pattern: ^\d{12}$

State

The current state of the environment.

Type: String

Valid Values: CREATING | ACTIVE | DELETING | FAILED

Tags

The tags to assign to the environment. A tag is a label that you assign to an AWS resource. Each tag consists of a key-value pair.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: ^(?!aws:).+

Value Length Constraints: Minimum length of 0. Maximum length of 256.

TransitGatewayId

The ID of the AWS Transit Gateway set up by the environment, if applicable.

Type: String

Length Constraints: Fixed length of 21.

Pattern: ^tgw-[-a-f0-9]{17}$

Errors

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

AccessDeniedException

The user does not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

An unexpected error occurred while processing the request.

HTTP Status Code: 500

ResourceNotFoundException

The request references a resource that does not exist.

HTTP Status Code: 404

ThrottlingException

Request was denied because the request was throttled.

HTTP Status Code: 429

ValidationException

The input does not satisfy the constraints specified by an AWS service.

HTTP Status Code: 400