AWS CodeStar

2018/09/28 - AWS CodeStar - 2 updated api methods

Changes  This release enables tagging CodeStar Projects at creation. The CreateProject API now includes optional tags parameter.

CreateProject (updated) Link ¶
Changes (request)
{'tags': {'string': 'string'}}

Reserved for future use. To create a project, use the AWS CodeStar console.

See also: AWS API Documentation

Request Syntax

client.create_project(
    name='string',
    id='string',
    description='string',
    clientRequestToken='string',
    tags={
        'string': 'string'
    }
)
type name

string

param name

[REQUIRED]

Reserved for future use.

type id

string

param id

[REQUIRED]

Reserved for future use.

type description

string

param description

Reserved for future use.

type clientRequestToken

string

param clientRequestToken

Reserved for future use.

type tags

dict

param tags

The tags created for the project.

  • (string) --

    • (string) --

rtype

dict

returns

Response Syntax

{
    'id': 'string',
    'arn': 'string',
    'clientRequestToken': 'string',
    'projectTemplateId': 'string'
}

Response Structure

  • (dict) --

    • id (string) --

      Reserved for future use.

    • arn (string) --

      Reserved for future use.

    • clientRequestToken (string) --

      Reserved for future use.

    • projectTemplateId (string) --

      Reserved for future use.

DescribeProject (updated) Link ¶
Changes (response)
{'status': {'reason': 'string', 'state': 'string'}}

Describes a project and its resources.

See also: AWS API Documentation

Request Syntax

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

string

param id

[REQUIRED]

The ID of the project.

rtype

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.