:doc:`IoTAnalytics <../../iotanalytics>` / Paginator / ListPipelines

*************
ListPipelines
*************



.. py:class:: IoTAnalytics.Paginator.ListPipelines

  ::

    
    paginator = client.get_paginator('list_pipelines')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`IoTAnalytics.Client.list_pipelines`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotanalytics-2017-11-27/ListPipelines>`_    


    **Request Syntax**
    ::

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

      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.

        

      
    
    
    :rtype: dict
    :returns: 
      
      **Response Syntax**

      
      ::

        {
            'pipelineSummaries': [
                {
                    'pipelineName': 'string',
                    'reprocessingSummaries': [
                        {
                            'id': 'string',
                            'status': 'RUNNING'|'SUCCEEDED'|'CANCELLED'|'FAILED',
                            'creationTime': datetime(2015, 1, 1)
                        },
                    ],
                    'creationTime': datetime(2015, 1, 1),
                    'lastUpdateTime': datetime(2015, 1, 1)
                },
            ],
            'NextToken': 'string'
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **pipelineSummaries** *(list) --* 

          A list of ``PipelineSummary`` objects.

          
          

          - *(dict) --* 

            A summary of information about a pipeline.

            
            

            - **pipelineName** *(string) --* 

              The name of the pipeline.

              
            

            - **reprocessingSummaries** *(list) --* 

              A summary of information about the pipeline reprocessing.

              
              

              - *(dict) --* 

                Information about pipeline reprocessing.

                
                

                - **id** *(string) --* 

                  The ``reprocessingId`` returned by ``StartPipelineReprocessing``.

                  
                

                - **status** *(string) --* 

                  The status of the pipeline reprocessing.

                  
                

                - **creationTime** *(datetime) --* 

                  The time the pipeline reprocessing was created.

                  
            
          
            

            - **creationTime** *(datetime) --* 

              When the pipeline was created.

              
            

            - **lastUpdateTime** *(datetime) --* 

              When the pipeline was last updated.

              
        
      
        

        - **NextToken** *(string) --* 

          A token to resume pagination.

          
    