GetProjectProfile
The details of the project profile.
Request Syntax
GET /v2/domains/domainIdentifier/project-profiles/identifier HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The ID of the domain.
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$Required: Yes
- identifier
-
The ID of the project profile.
Pattern:
^[a-zA-Z0-9_-]{1,36}$Required: Yes
Request Body
The request does not have a request body.
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"
}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 profile was created.
Type: Timestamp
- createdBy
-
The user who created the project profile.
Type: String
- description
-
The description of the project profile.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
- domainId
-
The ID of the domain of the project profile.
Type: String
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$ - domainUnitId
-
The ID of the domain unit of the project profile.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[a-z0-9_\-]+$ - environmentConfigurations
-
The environment configurations of the 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 of when 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
- 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
- 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:
