---
title: "PATCH /v2/domains/{domainIdentifier}/environments/{identifier}"
method: PATCH
path: "/v2/domains/{domainIdentifier}/environments/{identifier}"
---

# PATCH /v2/domains/{domainIdentifier}/environments/{identifier}

`PATCH /v2/domains/{domainIdentifier}/environments/{identifier}`

Updates the specified environment in Amazon DataZone.

## Path parameters

- `domainIdentifier` string, required
- `identifier` string, required

## Request body

- object
  - `name` string — The name to be updated as part of the <code>UpdateEnvironment</code> action.
  - `description` string — The description to be updated as part of the <code>UpdateEnvironment</code> action.
  - `glossaryTerms` GlossaryTermId[] — The glossary terms to be updated as part of the <code>UpdateEnvironment</code> action.
  - `blueprintVersion` string — The blueprint version to which the environment should be updated. You can only specify the following string for this parameter: <code>latest</code>.
  - `userParameters` EnvironmentParameter[] — The user parameters of the environment.
    - `name` string — The name of an environment profile parameter.
    - `value` string — The value of an environment profile parameter.
  - `environmentConfigurationName` string, password — The configuration name of the environment.

## Response `200`

Success

- UpdateEnvironmentOutput
  - `projectId` string, required — The project identifier of the environment.
  - `id` string — The identifier of the environment that is to be updated.
  - `domainId` string, required — The identifier of the domain in which the environment is to be updated.
  - `createdBy` string, required — The Amazon DataZone user who created the environment.
  - `createdAt` string, date-time — The timestamp of when the environment was created.
  - `updatedAt` string, date-time — The timestamp of when the environment was updated.
  - `name` string, password, required — The name to be updated as part of the <code>UpdateEnvironment</code> action.
  - `description` string, password — The description to be updated as part of the <code>UpdateEnvironment</code> action.
  - `environmentProfileId` string — The profile identifier of the environment.
  - `awsAccountId` string — The identifier of the Amazon Web Services account in which the environment is to be updated.
  - `awsAccountRegion` string — The Amazon Web Services Region in which the environment is updated.
  - `provider` string, required — The provider identifier of the environment.
  - `provisionedResources` Resource[] — The provisioned resources to be updated as part of the <code>UpdateEnvironment</code> action.
    - `provider` string — The provider of a provisioned resource of this Amazon DataZone environment.
    - `name` string — The name of a provisioned resource of this Amazon DataZone environment.
    - `value` string, required — The value of a provisioned resource of this Amazon DataZone environment.
    - `type` string, required — The type of a provisioned resource 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 to be updated as part of the <code>UpdateEnvironment</code> action.
  - `environmentActions` ConfigurableEnvironmentAction[] — The environment actions to be updated as part of the <code>UpdateEnvironment</code> action.
    - `type` string, required — The type of a configurable action in a Amazon DataZone environment.
    - `auth` 'IAM' | 'HTTPS' — The authentication type of a configurable action of a Amazon DataZone environment.
    - `parameters` ConfigurableActionParameter[], required — The parameters of a configurable action in a Amazon DataZone environment.
      - `key` string — The key of the configurable action parameter.
      - `value` string — The value of the configurable action parameter.
  - `glossaryTerms` GlossaryTermId[] — The glossary terms to be updated as part of the <code>UpdateEnvironment</code> action.
  - `userParameters` CustomParameter[] — The user parameters to be updated as part of the <code>UpdateEnvironment</code> action.
    - `keyName` string, required — The key name of the parameter.
    - `description` string, password — The description of the parameter.
    - `fieldType` string, required — The filed type of the parameter.
    - `defaultValue` string — The default value of the parameter.
    - `isEditable` boolean — Specifies whether the parameter is editable.
    - `isOptional` boolean — Specifies whether the custom parameter is optional.
    - `isUpdateSupported` boolean — Specifies whether a parameter value can be updated after creation.
  - `lastDeployment` object — The last deployment of the environment.
    - `deploymentId` string — The identifier of the last deployment of the environment.
    - `deploymentType` 'CREATE' | 'UPDATE' | 'DELETE' — The type of the last deployment of the environment.
    - `deploymentStatus` 'IN_PROGRESS' | 'SUCCESSFUL' | 'FAILED' | 'PENDING_DEPLOYMENT' — The status of the last deployment of the environment.
    - `failureReason` object — The failure reason of the last deployment of the environment.
      - `code` string — The error code for the failure reason for the environment deployment.
      - `message` string, required — The error message for the failure reason for the environment deployment.
    - `messages` DeploymentMessage[] — The messages of the last deployment of the environment.
    - `isDeploymentComplete` boolean — Specifies whether the last deployment of the environment is complete.
  - `provisioningProperties` object — The provisioning properties to be updated as part of the <code>UpdateEnvironment</code> action.
    - `cloudFormation` object — The cloud formation properties included as part of the provisioning properties of an environment blueprint.
      - `templateUrl` string, required — The template URL of the cloud formation provisioning properties of the environment blueprint.
  - `deploymentProperties` object — The deployment properties to be updated as part of the <code>UpdateEnvironment</code> action.
    - `startTimeoutMinutes` integer — The start timeout of the environment blueprint deployment.
    - `endTimeoutMinutes` integer — The end timeout of the environment blueprint deployment.
  - `environmentBlueprintId` string — The blueprint identifier of the environment.
  - `environmentConfigurationId` string, password — The configuration ID of the environment.
  - `environmentConfigurationName` string, password — The configuration name of the environment.

## Other responses

- `480` — InternalServerException
- `481` — AccessDeniedException
- `482` — ThrottlingException
- `483` — ServiceQuotaExceededException
- `484` — ConflictException
- `485` — ValidationException
- `486` — UnauthorizedException

---

[API](https://skmtc.net/aws/apis/datazone.md) · [All operations](https://skmtc.net/aws/apis/datazone/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/datazone/versions/055599054b53/schema)