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

UpdateProject

Updates the specified project in Amazon DataZone.

Request Syntax


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

{
   "description": "string",
   "environmentDeploymentDetails": { 
      "environmentFailureReasons": { 
         "string" : [ 
            { 
               "code": "string",
               "message": "string"
            }
         ]
      },
      "overallDeploymentStatus": "string"
   },
   "glossaryTerms": [ "string" ],
   "name": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

The ID of the Amazon DataZone domain where a project is being updated.

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

Required: Yes

identifier

The identifier of the project 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 UpdateProject action.

Type: String

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

Required: No

environmentDeploymentDetails

The environment deployment details of the project.

Type: EnvironmentDeploymentDetails object

Required: No

glossaryTerms

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

Type: String

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

Pattern: ^[\w -]+$

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "createdAt": "string",
   "createdBy": "string",
   "description": "string",
   "domainId": "string",
   "domainUnitId": "string",
   "environmentDeploymentDetails": { 
      "environmentFailureReasons": { 
         "string" : [ 
            { 
               "code": "string",
               "message": "string"
            }
         ]
      },
      "overallDeploymentStatus": "string"
   },
   "failureReasons": [ 
      { 
         "code": "string",
         "message": "string"
      }
   ],
   "glossaryTerms": [ "string" ],
   "id": "string",
   "lastUpdatedAt": "string",
   "name": "string",
   "projectProfileId": "string",
   "projectStatus": "string",
   "userParameters": [ 
      { 
         "environmentConfigurationName": "string",
         "environmentParameters": [ 
            { 
               "name": "string",
               "value": "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 project was created.

Type: Timestamp

createdBy

The Amazon DataZone user who created the project.

Type: String

description

The description of the project that is to be updated.

Type: String

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

domainId

The identifier of the Amazon DataZone domain in which a project is updated.

Type: String

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

domainUnitId

The ID of the domain unit.

Type: String

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

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

environmentDeploymentDetails

The environment deployment details of the project.

Type: EnvironmentDeploymentDetails object

failureReasons

Specifies the error message that is returned if the operation cannot be successfully completed.

Type: Array of ProjectDeletionError objects

glossaryTerms

The glossary terms of the project that are to be updated.

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 project that is to be updated.

Type: String

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

lastUpdatedAt

The timestamp of when the project was last updated.

Type: Timestamp

name

The name of the project that is to be updated.

Type: String

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

Pattern: ^[\w -]+$

projectProfileId

The ID of the project profile.

Type: String

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

projectStatus

The status of the project.

Type: String

Valid Values: ACTIVE | DELETING | DELETE_FAILED

userParameters

The user parameters of the project.

Type: Array of EnvironmentConfigurationUserParameter 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