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().

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,
            'pipelineType': 'V1'|'V2',
            '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.
    - pipelineType (string) –
      
      CodePipeline provides the following pipeline types, which differ in characteristics and price, so that you can tailor your pipeline features and cost to the needs of your applications.
      - V1 type pipelines have a JSON structure that contains standard pipeline, stage, and action-level parameters.
      - V2 type pipelines have the same structure as a V1 type, along with additional parameters for release safety and trigger configuration.
      Warning
      Including V2 parameters, such as triggers on Git tags, in the pipeline JSON when creating or updating a pipeline will result in the pipeline having the V2 type of pipeline and the associated costs.
      
      For information about pricing for CodePipeline, see Pricing.
      
      For information about which type of pipeline to choose, see What type of pipeline is right for me?.
      
      Note
      V2 type pipelines, along with triggers on Git tags and pipeline-level variables, are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see Pipeline types in the CodePipeline User Guide.
    - 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.