:doc:`EventBridgePipes <../../pipes>` / Client / list_pipes

**********
list_pipes
**********



.. py:method:: EventBridgePipes.Client.list_pipes(**kwargs)

  

  Get the pipes associated with this account. For more information about pipes, see `Amazon EventBridge Pipes <https://docs.aws.amazon.com/eventbridge/latest/userguide/eb-pipes.html>`__ in the Amazon EventBridge User Guide.

  

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


  **Request Syntax**
  ::

    response = client.list_pipes(
        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',
        NextToken='string',
        Limit=123
    )
    
  :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 NextToken: string
  :param NextToken: 

    If ``nextToken`` is returned, there are more results available. The value of ``nextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

    

  
  :type Limit: integer
  :param Limit: 

    The maximum number of pipes to include in the 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'
              },
          ],
          'NextToken': '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.

            
      
    
      

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

        If ``nextToken`` is returned, there are more results available. The value of ``nextToken`` is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page. Keep all other arguments unchanged. Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

        
  
  **Exceptions**
  
  *   :py:class:`EventBridgePipes.Client.exceptions.InternalException`

  
  *   :py:class:`EventBridgePipes.Client.exceptions.ValidationException`

  
  *   :py:class:`EventBridgePipes.Client.exceptions.ThrottlingException`

  