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

CreateEnvironmentProfile

Creates an Amazon DataZone environment profile.

Request Syntax


POST /v2/domains/domainIdentifier/environment-profiles HTTP/1.1
Content-type: application/json

{
   "awsAccountId": "string",
   "awsAccountRegion": "string",
   "description": "string",
   "environmentBlueprintIdentifier": "string",
   "name": "string",
   "projectIdentifier": "string",
   "userParameters": [ 
      { 
         "name": "string",
         "value": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the Amazon DataZone domain in which this environment profile is created.

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

Required: Yes

Request Body

The request accepts the following data in JSON format.

awsAccountId

The AWS account in which the Amazon DataZone environment is created.

Type: String

Pattern: ^\d{12}$

Required: No

awsAccountRegion

The AWS region in which this environment profile is created.

Type: String

Pattern: ^[a-z]{2}-[a-z]{4,10}-\d$

Required: No

description

The description of this Amazon DataZone environment profile.

Type: String

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

Required: No

environmentBlueprintIdentifier

The ID of the blueprint with which this environment profile is created.

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Required: Yes

name

The name of this Amazon DataZone environment profile.

Type: String

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

Pattern: ^[\w -]+$

Required: Yes

projectIdentifier

The identifier of the project in which to create the environment profile.

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

Required: Yes

userParameters

The user parameters of this Amazon DataZone environment profile.

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",
   "description": "string",
   "domainId": "string",
   "environmentBlueprintId": "string",
   "id": "string",
   "name": "string",
   "projectId": "string",
   "updatedAt": "string",
   "userParameters": [ 
      { 
         "defaultValue": "string",
         "description": "string",
         "fieldType": "string",
         "isEditable": boolean,
         "isOptional": 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 ID in which this Amazon DataZone environment profile is created.

Type: String

Pattern: ^\d{12}$

awsAccountRegion

The AWS region in which this Amazon DataZone environment profile is created.

Type: String

Pattern: ^[a-z]{2}-[a-z]{4,10}-\d$

createdAt

The timestamp of when this environment profile was created.

Type: Timestamp

createdBy

The Amazon DataZone user who created this environment profile.

Type: String

description

The description of this Amazon DataZone environment profile.

Type: String

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

domainId

The ID of the Amazon DataZone domain in which this environment profile is created.

Type: String

Pattern: ^dzd[-_][a-zA-Z0-9_-]{1,36}$

environmentBlueprintId

The ID of the blueprint with which this environment profile is created.

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

id

The ID of this Amazon DataZone environment profile.

Type: String

Pattern: ^[a-zA-Z0-9_-]{0,36}$

name

The name of this Amazon DataZone environment profile.

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 profile is created.

Type: String

Pattern: ^[a-zA-Z0-9_-]{1,36}$

updatedAt

The timestamp of when this environment profile was updated.

Type: Timestamp

userParameters

The user parameters of this Amazon DataZone environment profile.

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

ServiceQuotaExceededException

The request has exceeded the specified service quota.

HTTP Status Code: 402

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