CodePipeline / Paginator / ListPipelines

ListPipelines

class CodePipeline.Paginator.ListPipelines

paginator = client.get_paginator('list_pipelines')

paginate(**kwargs)

Creates an iterator that will paginate through responses from CodePipeline.Client.list_pipelines().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)

Parameters:

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.

• PageSize (integer) –

  The size of each page.

• StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'pipelines': [
        {
            'name': 'string',
            'version': 123,
            'created': datetime(2015, 1, 1),
            'updated': datetime(2015, 1, 1)
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Represents the output of a ListPipelines action.

  • pipelines (list) –

    The list of pipelines.

    • (dict) –

      Returns a summary of a pipeline.

      • name (string) –

        The name of the pipeline.

      • version (integer) –

        The version number of the pipeline.

      • created (datetime) –

        The date and time the pipeline was created, in timestamp format.

      • updated (datetime) –

        The date and time of the last update to the pipeline, in timestamp format.

  • NextToken (string) –

    A token to resume pagination.