:doc:`OpenSearchIngestion <../../osis>` / Client / list_pipelines

**************
list_pipelines
**************



.. py:method:: OpenSearchIngestion.Client.list_pipelines(**kwargs)

  

  Lists all OpenSearch Ingestion pipelines in the current Amazon Web Services account and Region. For more information, see `Viewing Amazon OpenSearch Ingestion pipelines <https://docs.aws.amazon.com/opensearch-service/latest/developerguide/list-pipeline.html>`__.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/osis-2022-01-01/ListPipelines>`_  


  **Request Syntax**
  ::

    response = client.list_pipelines(
        MaxResults=123,
        NextToken='string'
    )
    
  :type MaxResults: integer
  :param MaxResults: 

    An optional parameter that specifies the maximum number of results to return. You can use ``nextToken`` to get the next page of results.

    

  
  :type NextToken: string
  :param NextToken: 

    If your initial ``ListPipelines`` operation returns a ``nextToken``, you can include the returned ``nextToken`` in subsequent ``ListPipelines`` operations, which returns results in the next page.

    

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

    
    ::

      {
          'NextToken': 'string',
          'Pipelines': [
              {
                  'Status': 'CREATING'|'ACTIVE'|'UPDATING'|'DELETING'|'CREATE_FAILED'|'UPDATE_FAILED'|'STARTING'|'START_FAILED'|'STOPPING'|'STOPPED',
                  'StatusReason': {
                      'Description': 'string'
                  },
                  'PipelineName': 'string',
                  'PipelineArn': 'string',
                  'MinUnits': 123,
                  'MaxUnits': 123,
                  'CreatedAt': datetime(2015, 1, 1),
                  'LastUpdatedAt': datetime(2015, 1, 1),
                  'Destinations': [
                      {
                          'ServiceName': 'string',
                          'Endpoint': 'string'
                      },
                  ],
                  'Tags': [
                      {
                          'Key': 'string',
                          'Value': 'string'
                      },
                  ]
              },
          ]
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

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

        When ``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.

        
      

      - **Pipelines** *(list) --* 

        A list of all existing Data Prepper pipelines.

        
        

        - *(dict) --* 

          Summary information for an OpenSearch Ingestion pipeline.

          
          

          - **Status** *(string) --* 

            The current status of the pipeline.

            
          

          - **StatusReason** *(dict) --* 

            Information about a pipeline's current status.

            
            

            - **Description** *(string) --* 

              A description of why a pipeline has a certain status.

              
        
          

          - **PipelineName** *(string) --* 

            The name of the pipeline.

            
          

          - **PipelineArn** *(string) --* 

            The Amazon Resource Name (ARN) of the pipeline.

            
          

          - **MinUnits** *(integer) --* 

            The minimum pipeline capacity, in Ingestion Compute Units (ICUs).

            
          

          - **MaxUnits** *(integer) --* 

            The maximum pipeline capacity, in Ingestion Compute Units (ICUs).

            
          

          - **CreatedAt** *(datetime) --* 

            The date and time when the pipeline was created.

            
          

          - **LastUpdatedAt** *(datetime) --* 

            The date and time when the pipeline was last updated.

            
          

          - **Destinations** *(list) --* 

            A list of destinations to which the pipeline writes data.

            
            

            - *(dict) --* 

              An object representing the destination of a pipeline.

              
              

              - **ServiceName** *(string) --* 

                The name of the service receiving data from the pipeline.

                
              

              - **Endpoint** *(string) --* 

                The endpoint receiving data from the pipeline.

                
          
        
          

          - **Tags** *(list) --* 

            A list of tags associated with the given pipeline.

            
            

            - *(dict) --* 

              A tag (key-value pair) for an OpenSearch Ingestion pipeline.

              
              

              - **Key** *(string) --* 

                The tag key. Tag keys must be unique for the pipeline to which they are attached.

                
              

              - **Value** *(string) --* 

                The value assigned to the corresponding tag key. Tag values can be null and don't have to be unique in a tag set. For example, you can have a key value pair in a tag set of ``project : Trinity`` and ``cost-center : Trinity``

                
          
        
      
    
  
  **Exceptions**
  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.DisabledOperationException`

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

  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.InternalException`

  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`OpenSearchIngestion.Client.exceptions.InvalidPaginationTokenException`

  