Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-141891,2951.1 MB

Create an Amazon DataZone environment.

post/v2/domains/{domainIdentifier}/environments

Path parameters

domainIdentifierstring required

The identifier of the Amazon DataZone domain in which the environment is created.

Request body

projectIdentifierstring required

The identifier of the Amazon DataZone project in which this environment is created.

descriptionstring

The description of the Amazon DataZone environment.

namestring required

The name of the Amazon DataZone environment.

environmentProfileIdentifierstring

The identifier of the environment profile that is used to create this Amazon DataZone environment.

glossaryTermsGlossaryTermId[]

The glossary terms that can be used in this Amazon DataZone environment.

environmentAccountIdentifierstring

The ID of the account in which the environment is being created.

environmentAccountRegionstring

The region of the account in which the environment is being created.

environmentBlueprintIdentifierstring
<p>The ID of the blueprint with which the environment is being created.</p> <note> <p>This parameter is only valid for V1 domains. If provided for a V2 domain, the service returns a ValidationException.</p> </note>
deploymentOrderinteger

The deployment order of the environment.

environmentConfigurationIdstring

The configuration ID of the environment.

environmentConfigurationNamestring password

The configuration name of the environment.

Response

Success

projectIdstring required

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

idstring

The ID of this Amazon DataZone environment.

domainIdstring required

The identifier of the Amazon DataZone domain in which the environment is created.

createdBystring required

The Amazon DataZone user who created this environment.

createdAtstring date-time

The timestamp of when the environment was created.

updatedAtstring date-time

The timestamp of when this environment was updated.

namestring password required

The name of this environment.

descriptionstring password

The description of this Amazon DataZone environment.

environmentProfileIdstring

The ID of the environment profile with which this Amazon DataZone environment was created.

awsAccountIdstring

The Amazon Web Services account in which the Amazon DataZone environment is created.

awsAccountRegionstring

The Amazon Web Services region in which the Amazon DataZone environment is created.

providerstring required

The provider of this Amazon DataZone environment.

status'ACTIVE' | 'CREATING' | 'UPDATING' | 'DELETING' | 'CREATE_FAILED' | 'UPDATE_FAILED' | 'DELETE_FAILED' | 'VALIDATION_FAILED' | 'SUSPENDED' | 'DISABLED' | 'EXPIRED' | 'DELETED' | 'INACCESSIBLE'

The status of this Amazon DataZone environment.

glossaryTermsGlossaryTermId[]

The glossary terms that can be used in this Amazon DataZone environment.

environmentBlueprintIdstring

The ID of the blueprint with which this Amazon DataZone environment was created.

environmentConfigurationIdstring password

The configuration ID of the environment.

environmentConfigurationNamestring password

The configuration name of the environment.