CodeStar / Client / list_projects

list_projects#

CodeStar.Client.list_projects(**kwargs)#

Lists all projects in AWS CodeStar associated with your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_projects(
    nextToken='string',
    maxResults=123
)
Parameters:
  • nextToken (string) – The continuation token to be used to return the next set of results, if the results cannot be returned in one response.

  • maxResults (integer) – The maximum amount of data that can be contained in a single set of results.

Return type:

dict

Returns:

Response Syntax

{
    'projects': [
        {
            'projectId': 'string',
            'projectArn': 'string'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • projects (list) –

      A list of projects.

      • (dict) –

        Information about the metadata for a project.

        • projectId (string) –

          The ID of the project.

        • projectArn (string) –

          The Amazon Resource Name (ARN) of the project.

    • nextToken (string) –

      The continuation token to use when requesting the next set of results, if there are more results to be returned.

Exceptions

  • CodeStar.Client.exceptions.InvalidNextTokenException

  • CodeStar.Client.exceptions.ValidationException