On July 31, 2024, Amazon Web Services (AWS) will discontinue support for creating and viewing AWS CodeStar projects. After July 31, 2024, you will no longer be able to access the AWS CodeStar console or create new projects. However, the AWS resources created by AWS CodeStar, including your source repositories, pipelines, and builds, will be unaffected by this change and will continue to function. AWS CodeStar Connections will not be impacted by this discontinuation.
If you wish to track work, develop code, and build, test, and deploy
your applications, Amazon CodeCatalyst provides a streamlined getting started
process and additional functionality to manage your software projects. Learn
more about functionality
DescribeProject
Describes a project and its resources.
Request Syntax
{
"id": "string
"
}
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- id
-
The ID of the project.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 15.
Pattern:
^[a-z][a-z0-9-]+$
Required: Yes
Response Syntax
{
"arn": "string",
"clientRequestToken": "string",
"createdTimeStamp": number,
"description": "string",
"id": "string",
"name": "string",
"projectTemplateId": "string",
"stackId": "string",
"status": {
"reason": "string",
"state": "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.
- arn
-
The Amazon Resource Name (ARN) for the project.
Type: String
Pattern:
^arn:aws[^:\s]*:codestar:[^:\s]+:[0-9]{12}:project\/[a-z]([a-z0-9|-])+$
- clientRequestToken
-
A user- or system-generated token that identifies the entity that requested project creation.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[\w:/-]+$
- createdTimeStamp
-
The date and time the project was created, in timestamp format.
Type: Timestamp
- description
-
The description of the project, if any.
Type: String
Length Constraints: Maximum length of 1024.
Pattern:
^$|^\S(.*\S)?$
- id
-
The ID of the project.
Type: String
Length Constraints: Minimum length of 2. Maximum length of 15.
Pattern:
^[a-z][a-z0-9-]+$
- name
-
The display name for the project.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
^\S(.*\S)?$
- projectTemplateId
-
The ID for the AWS CodeStar project template used to create the project.
Type: String
Length Constraints: Minimum length of 1.
Pattern:
^arn:aws[^:\s]{0,5}:codestar:[^:\s]+::project-template(\/(github|codecommit))?\/[a-z0-9-]+$
- stackId
-
The ID of the primary stack in AWS CloudFormation used to generate resources for the project.
Type: String
Pattern:
^arn:aws[^:\s]*:cloudformation:[^:\s]+:[0-9]{12}:stack\/[^:\s]+\/[^:\s]+$
- status
-
The project creation or deletion status.
Type: ProjectStatus object
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConcurrentModificationException
-
Another modification is being made. That modification must complete before you can make your change.
HTTP Status Code: 400
- InvalidServiceRoleException
-
The service role is not valid.
HTTP Status Code: 400
- ProjectConfigurationException
-
Project configuration information is required but not specified.
HTTP Status Code: 400
- ProjectNotFoundException
-
The specified AWS CodeStar project was not found.
HTTP Status Code: 400
- ValidationException
-
The specified input is either not valid, or it could not be validated.
HTTP Status Code: 400
Examples
Example
This example illustrates one usage of DescribeProject.
Sample Request
POST / HTTP/1.1
Host: codestar.us-east-1.amazonaws.com
Accept-Encoding: identity
Content-Length: 25
X-Amz-Target: CodeStar_20170419.DescribeProject
X-Amz-Date: 20170406T002601Z
User-Agent: aws-cli/1.11.36 Python/2.7.9 Windows/7 botocore/1.4.93
Content-Type: application/x-amz-json-1.1
Authorization: AWS4-HMAC-SHA256 Credential=AIDACKCEVSQ6C2EXAMPLE/20170406/us-east-1/codestar/aws4_request, SignedHeaders=content-type;host;x-amz-date;x-amz-target, Signature=c25ddcd5EXAMPLE
{"id": "my-first-projec"}
Sample Response
HTTP/1.1 200 OK
x-amzn-RequestId: 9e16d048-EXAMPLE
Content-Type: application/x-amz-json-1.1
Content-Length: 409
Date: Thu, 06 Apr 2017 00:26:03 GMT
{
"arn":"arn:aws:codestar:us-east-1:111111111111:project/my-first-projec",
"createdTimeStamp":1.491000495561E9,
"description":"AWS CodeStar created project",
"id":"my-first-projec","name":"My First Project",
"projectTemplateId":"arn:aws:codestar:us-east-1::project-template/webapp-nodeweb-ec2",
"stackId":"arn:aws:cloudformation:us-east-1:111111111111:stack/awscodestar-my-first-projec/01234567-EXAMPLE"
}
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: