:doc:`EventBridgePipes <../../pipes>` / Paginator / ListPipes

*********
ListPipes
*********



.. py:class:: EventBridgePipes.Paginator.ListPipes

  ::

    
    paginator = client.get_paginator('list_pipes')

  
  

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

    Creates an iterator that will paginate through responses from :py:meth:`EventBridgePipes.Client.list_pipes`.

    See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/pipes-2015-10-07/ListPipes>`_    


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          NamePrefix='string',
          DesiredState='RUNNING'|'STOPPED',
          CurrentState='RUNNING'|'STOPPED'|'CREATING'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'CREATE_FAILED'|'UPDATE_FAILED'|'START_FAILED'|'STOP_FAILED'|'DELETE_FAILED'|'CREATE_ROLLBACK_FAILED'|'DELETE_ROLLBACK_FAILED'|'UPDATE_ROLLBACK_FAILED',
          SourcePrefix='string',
          TargetPrefix='string',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type NamePrefix: string
    :param NamePrefix: 

      A value that will return a subset of the pipes associated with this account. For example, ``"NamePrefix": "ABC"`` will return all endpoints with "ABC" in the name.

      

    
    :type DesiredState: string
    :param DesiredState: 

      The state the pipe should be in.

      

    
    :type CurrentState: string
    :param CurrentState: 

      The state the pipe is in.

      

    
    :type SourcePrefix: string
    :param SourcePrefix: 

      The prefix matching the pipe source.

      

    
    :type TargetPrefix: string
    :param TargetPrefix: 

      The prefix matching the pipe target.

      

    
    :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**

      
      ::

        {
            'Pipes': [
                {
                    'Name': 'string',
                    'Arn': 'string',
                    'DesiredState': 'RUNNING'|'STOPPED',
                    'CurrentState': 'RUNNING'|'STOPPED'|'CREATING'|'UPDATING'|'DELETING'|'STARTING'|'STOPPING'|'CREATE_FAILED'|'UPDATE_FAILED'|'START_FAILED'|'STOP_FAILED'|'DELETE_FAILED'|'CREATE_ROLLBACK_FAILED'|'DELETE_ROLLBACK_FAILED'|'UPDATE_ROLLBACK_FAILED',
                    'StateReason': 'string',
                    'CreationTime': datetime(2015, 1, 1),
                    'LastModifiedTime': datetime(2015, 1, 1),
                    'Source': 'string',
                    'Target': 'string',
                    'Enrichment': 'string'
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **Pipes** *(list) --* 

          The pipes returned by the call.

          
          

          - *(dict) --* 

            An object that represents a pipe. Amazon EventBridgePipes connect event sources to targets and reduces the need for specialized knowledge and integration code.

            
            

            - **Name** *(string) --* 

              The name of the pipe.

              
            

            - **Arn** *(string) --* 

              The ARN of the pipe.

              
            

            - **DesiredState** *(string) --* 

              The state the pipe should be in.

              
            

            - **CurrentState** *(string) --* 

              The state the pipe is in.

              
            

            - **StateReason** *(string) --* 

              The reason the pipe is in its current state.

              
            

            - **CreationTime** *(datetime) --* 

              The time the pipe was created.

              
            

            - **LastModifiedTime** *(datetime) --* 

              When the pipe was last updated, in `ISO-8601 format <https://www.w3.org/TR/NOTE-datetime>`__ (YYYY-MM-DDThh:mm:ss.sTZD).

              
            

            - **Source** *(string) --* 

              The ARN of the source resource.

              
            

            - **Target** *(string) --* 

              The ARN of the target resource.

              
            

            - **Enrichment** *(string) --* 

              The ARN of the enrichment resource.

              
        
      
    