EnvironmentSummary
The summary information for environments as a response to ListEnvironments
.
Contents
- 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+=,.@\-_/]+$
Required: No
- CreatedTime
-
A timestamp that indicates when the environment is created.
Type: Timestamp
Required: No
- Description
-
A description of the environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[a-zA-Z0-9-_\s\.\!\*\#\@\']+$
Required: No
- EnvironmentId
-
The unique identifier of the environment.
Type: String
Length Constraints: Fixed length of 14.
Pattern:
^env-[0-9A-Za-z]{10}$
Required: No
- Error
-
Any error associated with the environment resource.
Type: ErrorResponse object
Required: No
- LastUpdatedTime
-
A timestamp that indicates when the environment was last updated.
Type: Timestamp
Required: No
- 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-_ ]+$
Required: No
- NetworkFabricType
-
The network fabric type of the environment.
Type: String
Valid Values:
TRANSIT_GATEWAY | NONE
Required: No
- OwnerAccountId
-
The AWS account ID of the environment owner.
Type: String
Length Constraints: Fixed length of 12.
Pattern:
^\d{12}$
Required: No
- State
-
The current state of the environment.
Type: String
Valid Values:
CREATING | ACTIVE | DELETING | FAILED
Required: No
- Tags
-
The tags assigned to the environment.
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.
Required: No
- TransitGatewayId
-
The ID of the AWS Transit Gateway set up by the environment.
Type: String
Length Constraints: Fixed length of 21.
Pattern:
^tgw-[-a-f0-9]{17}$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: