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

CreateProjectProfile

Creates a project profile.

Request Syntax


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

{
   "allowCustomProjectResourceTags": boolean,
   "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",
   "projectResourceTags": [ 
      { 
         "isValueEditable": boolean,
         "key": "string",
         "value": "string"
      }
   ],
   "projectResourceTagsDescription": "string",
   "status": "string"
}

URI Request Parameters

The request uses the following URI parameters.

domainIdentifier

A domain ID of the project profile.

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

Required: Yes

Request Body

The request accepts the following data in JSON format.

allowCustomProjectResourceTags

Specifies whether custom project resource tags are supported.

Type: Boolean

Required: No

description

A description of a project profile.

Type: String

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

Required: No

domainUnitIdentifier

A domain unit ID of the project profile.

Type: String

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

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

Required: No

environmentConfigurations

Environment configurations of the project profile.

Type: Array of EnvironmentConfiguration objects

Required: No

name

Project profile name.

Type: String

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

Pattern: [\w -]+

Required: Yes

projectResourceTags

The resource tags of the project profile.

Type: Array of ResourceTagParameter objects

Array Members: Minimum number of 0 items. Maximum number of 25 items.

Required: No

projectResourceTagsDescription

Field viewable through the UI that provides a project user with the allowed resource tag specifications.

Type: String

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

Required: No

status

Project profile status.

Type: String

Valid Values: ENABLED | DISABLED

Required: No

Response Syntax


HTTP/1.1 201
Content-type: application/json

{
   "allowCustomProjectResourceTags": boolean,
   "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",
   "projectResourceTags": [ 
      { 
         "isValueEditable": boolean,
         "key": "string",
         "value": "string"
      }
   ],
   "projectResourceTagsDescription": "string",
   "status": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 201 response.

The following data is returned in JSON format by the service.

allowCustomProjectResourceTags

Specifies whether custom project resource tags are supported.

Type: Boolean

createdAt

A timestamp at which a project profile is created.

Type: Timestamp

createdBy

A user who created a project profile.

Type: String

description

A project profile description.

Type: String

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

domainId

The ID of the domain where a project profile is created.

Type: String

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

domainUnitId

The ID of the domain unit where a project profile is created.

Type: String

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

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

environmentConfigurations

Environment configurations of a project profile.

Type: Array of EnvironmentConfiguration objects

id

Project profile ID.

Type: String

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

lastUpdatedAt

A timestamp when a project profile was last updated.

Type: Timestamp

name

Project profile name.

Type: String

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

Pattern: [\w -]+

projectResourceTags

The resource tags of the project profile.

Type: Array of ResourceTagParameter objects

Array Members: Minimum number of 0 items. Maximum number of 25 items.

projectResourceTagsDescription

Field viewable through the UI that provides a project user with the allowed resource tag specifications.

Type: String

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

status

Project profile status.

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