DataPipeline / Paginator / ListPipelines

ListPipelines

class DataPipeline.Paginator.ListPipelines

paginator = client.get_paginator('list_pipelines')

paginate(**kwargs)

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    PaginationConfig={
        'MaxItems': 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.

• StartingToken (string) –

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

Return type:

dict

Returns:

Response Syntax

{
    'pipelineIdList': [
        {
            'id': 'string',
            'name': 'string'
        },
    ],
    'hasMoreResults': True|False,
    'NextToken': 'string'
}

Response Structure

• (dict) –

  Contains the output of ListPipelines.

  • pipelineIdList (list) –

    The pipeline identifiers. If you require additional information about the pipelines, you can use these identifiers to call DescribePipelines and GetPipelineDefinition.

    • (dict) –

      Contains the name and identifier of a pipeline.

      • id (string) –

        The ID of the pipeline that was assigned by AWS Data Pipeline. This is a string of the form df-297EG78HU43EEXAMPLE .

      • name (string) –

        The name of the pipeline.

  • hasMoreResults (boolean) –

    Indicates whether there are more results that can be obtained by a subsequent call.

  • NextToken (string) –

    A token to resume pagination.