GetProject
Gets a project in Amazon DataZone.
Request Syntax
GET /v2/domains/domainIdentifier/projects/identifier HTTP/1.1
URI Request Parameters
The request uses the following URI parameters.
- domainIdentifier
-
The ID of the Amazon DataZone domain in which the project exists.
Pattern:
^dzd[-_][a-zA-Z0-9_-]{1,36}$Required: Yes
- identifier
-
The ID of the project.
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",
"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",
"environmentId": "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.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
- domainId
-
The ID of the Amazon DataZone domain in which the project exists.
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 status of a 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 business glossary terms that can be used in the project.
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 ID of the project.
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^[\w -]+$ - projectProfileId
-
The ID of the project profile of a project.
Type: String
Pattern:
^[a-zA-Z0-9_-]{1,36}$ - projectStatus
-
The status of the project.
Type: String
Valid Values:
ACTIVE | DELETING | DELETE_FAILED | UPDATING | UPDATE_FAILED - userParameters
-
The user parameters of a 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
- 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:
