Sign in

v1

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

Updates the specified environment in Amazon DataZone.

patch/v2/domains/{domainIdentifier}/environments/{identifier}

Path parameters

domainIdentifierstring required

The identifier of the domain in which the environment is to be updated.

identifierstring required

The identifier of the environment that is to be updated.

Request body

namestring

The name to be updated as part of the <code>UpdateEnvironment</code> action.

descriptionstring

The description to be updated as part of the <code>UpdateEnvironment</code> action.

glossaryTermsGlossaryTermId[]

The glossary terms to be updated as part of the <code>UpdateEnvironment</code> action.

blueprintVersionstring

The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: <code>latest</code>.

environmentConfigurationNamestring password

The configuration name of the environment.

Response

Success

projectIdstring required

The project identifier of the environment.

idstring

The identifier of the environment that is to be updated.

domainIdstring required

The identifier of the domain in which the environment is to be updated.

createdBystring required

The Amazon DataZone user who created the environment.

createdAtstring date-time

The timestamp of when the environment was created.

updatedAtstring date-time

The timestamp of when the environment was updated.

namestring password required

The name to be updated as part of the <code>UpdateEnvironment</code> action.

descriptionstring password

The description to be updated as part of the <code>UpdateEnvironment</code> action.

environmentProfileIdstring

The profile identifier of the environment.

awsAccountIdstring

The identifier of the Amazon Web Services account in which the environment is to be updated.

awsAccountRegionstring

The Amazon Web Services Region in which the environment is updated.

providerstring required

The provider identifier of the environment.

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

The status to be updated as part of the <code>UpdateEnvironment</code> action.

glossaryTermsGlossaryTermId[]

The glossary terms to be updated as part of the <code>UpdateEnvironment</code> action.

environmentBlueprintIdstring

The blueprint identifier of the environment.

environmentConfigurationIdstring password

The configuration ID of the environment.

environmentConfigurationNamestring password

The configuration name of the environment.