CreateEnvironment
Create an Amazon DataZone environment.
Request Syntax
POST /v2/domains/domainIdentifier/environments HTTP/1.1
Content-type: application/json
{
"deploymentOrder": number,
"description": "string",
"environmentAccountIdentifier": "string",
"environmentAccountRegion": "string",
"environmentBlueprintIdentifier": "string",
"environmentConfigurationId": "string",
"environmentProfileIdentifier": "string",
"glossaryTerms": [ "string" ],
"name": "string",
"projectIdentifier": "string",
"userParameters": [
{
"name": "string",
"value": "string"
}
]
}URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The identifier of the Amazon DataZone domain in which the environment is created.
Pattern:
dzd[-_][a-zA-Z0-9_-]{1,36}Required: Yes
Request Body
The request accepts the following data in JSON format.
- deploymentOrder
-
The deployment order of the environment.
Type: Integer
Required: No
- description
-
The description of the Amazon DataZone environment.
Type: String
Required: No
- environmentAccountIdentifier
-
The ID of the account in which the environment is being created.
Type: String
Required: No
- environmentAccountRegion
-
The region of the account in which the environment is being created.
Type: String
Required: No
- environmentBlueprintIdentifier
-
The ID of the blueprint with which the environment is being created.
Type: String
Required: No
- environmentConfigurationId
-
The configuration ID of the environment.
Type: String
Required: No
- environmentProfileIdentifier
-
The identifier of the environment profile that is used to create this Amazon DataZone environment.
Type: String
Pattern:
[a-zA-Z0-9_-]{0,36}Required: No
- glossaryTerms
-
The glossary terms that can be used in this Amazon DataZone environment.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Pattern:
[a-zA-Z0-9_-]{1,36}Required: No
- name
-
The name of the Amazon DataZone environment.
Type: String
Required: Yes
- projectIdentifier
-
The identifier of the Amazon DataZone project in which this environment is created.
Type: String
Pattern:
[a-zA-Z0-9_-]{1,36}Required: Yes
- userParameters
-
The user parameters of this Amazon DataZone environment.
Type: Array of EnvironmentParameter objects
Required: No
Response Syntax
HTTP/1.1 201
Content-type: application/json
{
"awsAccountId": "string",
"awsAccountRegion": "string",
"createdAt": "string",
"createdBy": "string",
"deploymentProperties": {
"endTimeoutMinutes": number,
"startTimeoutMinutes": number
},
"description": "string",
"domainId": "string",
"environmentActions": [
{
"auth": "string",
"parameters": [
{
"key": "string",
"value": "string"
}
],
"type": "string"
}
],
"environmentBlueprintId": "string",
"environmentConfigurationId": "string",
"environmentProfileId": "string",
"glossaryTerms": [ "string" ],
"id": "string",
"lastDeployment": {
"deploymentId": "string",
"deploymentStatus": "string",
"deploymentType": "string",
"failureReason": {
"code": "string",
"message": "string"
},
"isDeploymentComplete": boolean,
"messages": [ "string" ]
},
"name": "string",
"projectId": "string",
"provider": "string",
"provisionedResources": [
{
"name": "string",
"provider": "string",
"type": "string",
"value": "string"
}
],
"provisioningProperties": { ... },
"status": "string",
"updatedAt": "string",
"userParameters": [
{
"defaultValue": "string",
"description": "string",
"fieldType": "string",
"isEditable": boolean,
"isOptional": boolean,
"isUpdateSupported": boolean,
"keyName": "string"
}
]
}Response Elements
If the action is successful, the service sends back an HTTP 201 response.
The following data is returned in JSON format by the service.
- awsAccountId
-
The AWS account in which the Amazon DataZone environment is created.
Type: String
Pattern:
\d{12} - awsAccountRegion
-
The AWS region in which the Amazon DataZone environment is created.
Type: String
Pattern:
[a-z]{2}-[a-z]{4,10}-\d - createdAt
-
The timestamp of when the environment was created.
Type: Timestamp
- createdBy
-
The Amazon DataZone user who created this environment.
Type: String
- deploymentProperties
-
The deployment properties of this Amazon DataZone environment.
Type: DeploymentProperties object
- description
-
The description of this Amazon DataZone environment.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
- domainId
-
The identifier of the Amazon DataZone domain in which the environment is created.
Type: String
Pattern:
dzd[-_][a-zA-Z0-9_-]{1,36} - environmentActions
-
The configurable actions of this Amazon DataZone environment.
Type: Array of ConfigurableEnvironmentAction objects
- environmentBlueprintId
-
The ID of the blueprint with which this Amazon DataZone environment was created.
Type: String
Pattern:
[a-zA-Z0-9_-]{1,36} - environmentConfigurationId
-
The configuration ID of the environment.
Type: String
Pattern:
[a-zA-Z0-9_-]{1,36} - environmentProfileId
-
The ID of the environment profile with which this Amazon DataZone environment was created.
Type: String
Pattern:
[a-zA-Z0-9_-]{0,36} - glossaryTerms
-
The glossary terms that can be used in this Amazon DataZone environment.
Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 20 items.
Pattern:
[a-zA-Z0-9_-]{1,36} - id
-
The ID of this Amazon DataZone environment.
Type: String
Pattern:
[a-zA-Z0-9_-]{1,36} - lastDeployment
-
The details of the last deployment of this Amazon DataZone environment.
Type: Deployment object
- name
-
The name of this environment.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
[\w -]+ - projectId
-
The ID of the Amazon DataZone project in which this environment is created.
Type: String
Pattern:
[a-zA-Z0-9_-]{1,36} - provider
-
The provider of this Amazon DataZone environment.
Type: String
- provisionedResources
-
The provisioned resources of this Amazon DataZone environment.
Type: Array of Resource objects
- provisioningProperties
-
The provisioning properties of this Amazon DataZone environment.
Type: ProvisioningProperties object
Note: This object is a Union. Only one member of this object can be specified or returned.
- status
-
The status of this Amazon DataZone environment.
Type: String
Valid Values:
ACTIVE | CREATING | UPDATING | DELETING | CREATE_FAILED | UPDATE_FAILED | DELETE_FAILED | VALIDATION_FAILED | SUSPENDED | DISABLED | EXPIRED | DELETED | INACCESSIBLE - updatedAt
-
The timestamp of when this environment was updated.
Type: Timestamp
- userParameters
-
The user parameters of this Amazon DataZone environment.
Type: Array of CustomParameter objects
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
There is a conflict while performing this action.
HTTP Status Code: 409
- InternalServerException
-
The request has failed because of an unknown error, exception or failure.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource cannot be found.
HTTP Status Code: 404
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- UnauthorizedException
-
You do not have permission to perform this action.
HTTP Status Code: 401
- ValidationException
-
The input fails to satisfy the constraints specified by the AWS service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
