UpdateProjectProfile - Amazon DataZone
Request SyntaxURI Request ParametersRequest BodyResponse SyntaxResponse ElementsErrorsSee Also

UpdateProjectProfile

Updates a project profile.

Request Syntax

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

{
   "description": "string",
   "domainUnitIdentifier": "string",
   "environmentConfigurations": [ 
      { 
         "accountPools": [ "string" ],
         "awsAccount": { ... },
         "awsRegion": { ... },
         "configurationParameters": { 
            "parameterOverrides": [ 
               { 
                  "isEditable": boolean,
                  "name": "string",
                  "value": "string"
               }
            ],
            "resolvedParameters": [ 
               { 
                  "isEditable": boolean,
                  "name": "string",
                  "value": "string"
               }
            ],
            "ssmPath": "string"
         },
         "deploymentMode": "string",
         "deploymentOrder": number,
         "description": "string",
         "environmentBlueprintId": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "name": "string",
   "status": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the domain where a project profile is to be updated.

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

Required: Yes

identifier

The ID of a project profile 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 of a project profile.

Type: String

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

Required: No

domainUnitIdentifier

The ID of the domain unit where a project profile is to be updated.

Type: String

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

Pattern: [a-z0-9_\-]+

Required: No

environmentConfigurations

The environment configurations of a project profile.

Type: Array of EnvironmentConfiguration objects

Required: No

name

The name of a project profile.

Type: String

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

Pattern: [\w -]+

Required: No

status

The status of a project profile.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "environmentConfigurations": [ 
      { 
         "accountPools": [ "string" ],
         "awsAccount": { ... },
         "awsRegion": { ... },
         "configurationParameters": { 
            "parameterOverrides": [ 
               { 
                  "isEditable": boolean,
                  "name": "string",
                  "value": "string"
               }
            ],
            "resolvedParameters": [ 
               { 
                  "isEditable": boolean,
                  "name": "string",
                  "value": "string"
               }
            ],
            "ssmPath": "string"
         },
         "deploymentMode": "string",
         "deploymentOrder": number,
         "description": "string",
         "environmentBlueprintId": "string",
         "id": "string",
         "name": "string"
      }
   ],
   "id": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "status": "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 at which a project profile is created.

Type: Timestamp

createdBy

The user who created a project profile.

Type: String

description

The description of a project profile.

Type: String

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

domainId

The ID of the domain where project profile is to be updated.

Type: String

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

domainUnitId

The domain unit ID of the project profile to be updated.

Type: String

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

Pattern: [a-z0-9_\-]+

environmentConfigurations

The environment configurations of a project profile.

Type: Array of EnvironmentConfiguration objects

id

The ID of the project profile.

Type: String

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

lastUpdatedAt

The timestamp at which a project profile was last updated.

Type: Timestamp

name

The name of the project profile.

Type: String

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

Pattern: [\w -]+

status

The status of the project profile.

Type: String

Valid Values: ENABLED | DISABLED

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: