Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See 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": [ 
      { 
         "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": [ 
      { 
         "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"
}