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

UpdateEnvironment

Updates the specified environment in Amazon DataZone.

Request Syntax


PATCH /v2/domains/domainIdentifier/environments/identifier HTTP/1.1
Content-type: application/json

{
   "description": "string",
   "glossaryTerms": [ "string" ],
   "name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

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

Required: Yes

identifier

The identifier of the environment that is to be updated.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

description

The description to be updated as part of the UpdateEnvironment action.

Type: String

Required: No

glossaryTerms

The glossary terms to be updated as part of the UpdateEnvironment action.

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 to be updated as part of the UpdateEnvironment action.

Type: String

Required: No

Response Syntax


HTTP/1.1 200
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",
   "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,
         "keyName": "string"
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

awsAccountId

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

Type: String

Pattern: ^\d{12}$

awsAccountRegion

The AWS Region in which the environment is updated.

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 the environment.

Type: String

deploymentProperties

The deployment properties to be updated as part of the UpdateEnvironment action.

Type: DeploymentProperties object

description

The description to be updated as part of the UpdateEnvironment action.

Type: String

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

domainId

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

Type: String

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

environmentActions

The environment actions to be updated as part of the UpdateEnvironment action.

Type: Array of ConfigurableEnvironmentAction objects

environmentBlueprintId

The blueprint identifier of the environment.

Type: String

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

environmentProfileId

The profile identifier of the environment.

Type: String

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

glossaryTerms

The glossary terms to be updated as part of the UpdateEnvironment action.

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 identifier of the environment that is to be updated.

Type: String

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

lastDeployment

The last deployment of the environment.

Type: Deployment object

name

The name to be updated as part of the UpdateEnvironment action.

Type: String

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

Pattern: ^[\w -]+$

projectId

The project identifier of the environment.

Type: String

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

provider

The provider identifier of the environment.

Type: String

provisionedResources

The provisioned resources to be updated as part of the UpdateEnvironment action.

Type: Array of Resource objects

provisioningProperties

The provisioning properties to be updated as part of the UpdateEnvironment action.

Type: ProvisioningProperties object

Note: This object is a Union. Only one member of this object can be specified or returned.

status

The status to be updated as part of the UpdateEnvironment action.

Type: String

updatedAt

The timestamp of when the environment was updated.

Type: Timestamp

userParameters

The user parameters to be updated as part of the UpdateEnvironment action.

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

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