EnvironmentSummary
The details of an environment.
Contents
- createdBy
-
The Amazon DataZone user who created the environment.
Type: String
Required: Yes
- domainId
-
The identifier of the Amazon DataZone domain in which the environment exists.
Type: String
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$Required: Yes
- name
-
The name of the environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[\w -]+$Required: Yes
- projectId
-
The identifier of the project in which the environment exists.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: Yes
- provider
-
The provider of the environment.
Type: String
Required: Yes
- awsAccountId
-
The identifier of the AWS account in which an environment exists.
Type: String
Pattern:
^\d{12}$Required: No
- awsAccountRegion
-
The AWS Region in which an environment exists.
Type: String
Pattern:
^[a-z]{2}-[a-z]{4,10}-\d$Required: No
- createdAt
-
The timestamp of when the environment was created.
Type: Timestamp
Required: No
- description
-
The description of the environment.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Required: No
- environmentConfigurationId
-
The configuration ID with which the environment is created.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: No
- environmentProfileId
-
The identifier of the environment profile with which the environment was created.
Type: String
Pattern:
^[a-zA-Z0-9_-]{0,36}$Required: No
- id
-
The identifier of the environment.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: No
- status
-
The status of the environment.
Type: String
Valid Values:
ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED | VALIDATION_FAILED | SUSPENDED | DISABLED | EXPIRED | DELETED | INACCESSIBLERequired: No
- updatedAt
-
The timestamp of when the environment was updated.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
