CodeCatalyst / Client / get_project

get_project#

CodeCatalyst.Client.get_project(**kwargs)#

Returns information about a project.

See also: AWS API Documentation

Request Syntax

response = client.get_project(
    spaceName='string',
    name='string'
)
Parameters:
  • spaceName (string) –

    [REQUIRED]

    The name of the space.

  • name (string) –

    [REQUIRED]

    The name of the project in the space.

Return type:

dict

Returns:

Response Syntax

{
    'spaceName': 'string',
    'name': 'string',
    'displayName': 'string',
    'description': 'string'
}

Response Structure

  • (dict) –

    • spaceName (string) –

      The name of the space.

    • name (string) –

      The name of the project in the space.

    • displayName (string) –

      The friendly name of the project displayed to users in Amazon CodeCatalyst.

    • description (string) –

      The description of the project.

Exceptions