describe_project

describe_project(**kwargs)

Describes a project and its resources.

See also: AWS API Documentation

Request Syntax

response = client.describe_project(
    id='string'
)

Parameters

id (string) --

[REQUIRED]

The ID of the project.

Return type

dict

Returns

Response Syntax

{
    'name': 'string',
    'id': 'string',
    'arn': 'string',
    'description': 'string',
    'clientRequestToken': 'string',
    'createdTimeStamp': datetime(2015, 1, 1),
    'stackId': 'string',
    'projectTemplateId': 'string',
    'status': {
        'state': 'string',
        'reason': 'string'
    }
}

Response Structure

• (dict) --
  • 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 (datetime) --

    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 (dict) --

    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.

Exceptions

• CodeStar.Client.exceptions.ProjectNotFoundException
• CodeStar.Client.exceptions.ValidationException
• CodeStar.Client.exceptions.InvalidServiceRoleException
• CodeStar.Client.exceptions.ProjectConfigurationException
• CodeStar.Client.exceptions.ConcurrentModificationException