UpdateEnvironmentBlueprint - Amazon DataZone

UpdateEnvironmentBlueprint

Updates an environment blueprint in Amazon DataZone.

Request Syntax

PATCH /v2/domains/domainIdentifier/environment-blueprints/identifier HTTP/1.1 Content-type: application/json { "description": "string", "provisioningProperties": { ... }, "userParameters": [ { "defaultValue": "string", "description": "string", "fieldType": "string", "isEditable": boolean, "isOptional": boolean, "isUpdateSupported": boolean, "keyName": "string" } ] }

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The identifier of the Amazon DataZone domain in which an environment blueprint is to be updated.

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

Required: Yes

identifier

The identifier of the environment blueprint 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 UpdateEnvironmentBlueprint action.

Type: String

Required: No

provisioningProperties

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

Type: ProvisioningProperties object

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

Required: No

userParameters

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

Type: Array of CustomParameter objects

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "createdAt": "string", "deploymentProperties": { "endTimeoutMinutes": number, "startTimeoutMinutes": number }, "description": "string", "glossaryTerms": [ "string" ], "id": "string", "name": "string", "provider": "string", "provisioningProperties": { ... }, "updatedAt": "string", "userParameters": [ { "defaultValue": "string", "description": "string", "fieldType": "string", "isEditable": boolean, "isOptional": boolean, "isUpdateSupported": 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.

createdAt

The timestamp of when the environment blueprint was created.

Type: Timestamp

deploymentProperties

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

Type: DeploymentProperties object

description

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

Type: String

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

glossaryTerms

The glossary terms to be updated as part of the UpdateEnvironmentBlueprint 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 blueprint to be updated.

Type: String

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

name

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

Type: String

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

Pattern: [\w -]+

provider

The provider of the blueprint to be udpated.

Type: String

provisioningProperties

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

Type: ProvisioningProperties object

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

updatedAt

The timestamp of when the blueprint was updated.

Type: Timestamp

userParameters

The user parameters to be updated as part of the UpdateEnvironmentBlueprint 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

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

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: