CodeBuild / Paginator / ListProjects

ListProjects

class CodeBuild.Paginator.ListProjects

paginator = client.get_paginator('list_projects')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CodeBuild.Client.list_projects().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    sortBy='NAME'|'CREATED_TIME'|'LAST_MODIFIED_TIME',
    sortOrder='ASCENDING'|'DESCENDING',
    PaginationConfig={
        'MaxItems': 123,
        'StartingToken': 'string'
    }
)

Parameters:

• sortBy (string) –

  The criterion to be used to list build project names. Valid values include:

  • CREATED_TIME: List based on when each build project was created.

  • LAST_MODIFIED_TIME: List based on when information about each build project was last changed.

  • NAME: List based on each build project’s name.

  Use sortOrder to specify in what order to list the build project names based on the preceding criteria.

• sortOrder (string) –

  The order in which to list build projects. Valid values include:

  • ASCENDING: List in ascending order.

  • DESCENDING: List in descending order.

  Use sortBy to specify the criterion to be used to list build project names.

• PaginationConfig (dict) –

  A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:

dict

Returns:

Response Syntax

{
    'projects': [
        'string',
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • projects (list) –

    The list of build project names, with each build project name representing a single build project.

    • (string) –

  • NextToken (string) –

    A token to resume pagination.