[ aws . codestar ]



Describes a project and its resources.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--id (string)

The ID of the project.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.



To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To view a project

The following describe-project example retrieves details about the specified project.

aws codestar describe-project \
    --id my-project


    "name": "my project",
    "id": "my-project",
    "arn": "arn:aws:codestar:us-west-2:123456789012:project/my-project",
    "description": "My first CodeStar project.",
    "createdTimeStamp": 1572547510.128,
    "status": {
        "state": "CreateComplete"


name -> (string)

The display name for the project.

id -> (string)

The ID of the project.

arn -> (string)

The Amazon Resource Name (ARN) for the project.

description -> (string)

The description of the project, if any.

clientRequestToken -> (string)

A user- or system-generated token that identifies the entity that requested project creation.

createdTimeStamp -> (timestamp)

The date and time the project was created, in timestamp format.

stackId -> (string)

The ID of the primary stack in AWS CloudFormation used to generate resources for the project.

projectTemplateId -> (string)

The ID for the AWS CodeStar project template used to create the project.

status -> (structure)

The project creation or deletion status.

state -> (string)

The phase of completion for a project creation or deletion.

reason -> (string)

In the case of a project creation or deletion failure, a reason for the failure.