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

UpdateEnvironmentProfile

Updates the specified environment profile in Amazon DataZone.

Request Syntax


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

{
   "awsAccountId": "string",
   "awsAccountRegion": "string",
   "description": "string",
   "name": "string",
   "userParameters": [ 
      { 
         "name": "string",
         "value": "string"
      }
   ]
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

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

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

Required: Yes

identifier

The identifier of the environment profile that is to be updated.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

awsAccountId

The AWS account in which a specified environment profile is to be udpated.

Type: String

Pattern: ^\d{12}$

Required: No

awsAccountRegion

The AWS Region in which a specified environment profile is to be updated.

Type: String

Pattern: ^[a-z]{2}-[a-z]{4,10}-\d$

Required: No

description

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

Type: String

Required: No

name

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

Type: String

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

Pattern: ^[\w -]+$

Required: No

userParameters

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

Type: Array of EnvironmentParameter objects

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "awsAccountId": "string",
   "awsAccountRegion": "string",
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "environmentBlueprintId": "string",
   "id": "string",
   "name": "string",
   "projectId": "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 AWS account in which a specified environment profile is to be udpated.

Type: String

Pattern: ^\d{12}$

awsAccountRegion

The AWS Region in which a specified environment profile is to be updated.

Type: String

Pattern: ^[a-z]{2}-[a-z]{4,10}-\d$

createdAt

The timestamp of when the environment profile was created.

Type: Timestamp

createdBy

The Amazon DataZone user who created the environment profile.

Type: String

description

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

Type: String

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

domainId

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

Type: String

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

environmentBlueprintId

The identifier of the blueprint of the environment profile that is to be updated.

Type: String

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

id

The identifier of the environment profile that is to be udpated.

Type: String

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

name

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

Type: String

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

Pattern: ^[\w -]+$

projectId

The identifier of the project of the environment profile that is to be updated.

Type: String

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

updatedAt

The timestamp of when the environment profile was updated.

Type: Timestamp

userParameters

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