:doc:`SageMaker <../../sagemaker>` / Client / list_pipelines

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



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

  

  Gets a list of pipelines.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/sagemaker-2017-07-24/ListPipelines>`_  


  **Request Syntax**
  ::

    response = client.list_pipelines(
        PipelineNamePrefix='string',
        CreatedAfter=datetime(2015, 1, 1),
        CreatedBefore=datetime(2015, 1, 1),
        SortBy='Name'|'CreationTime',
        SortOrder='Ascending'|'Descending',
        NextToken='string',
        MaxResults=123
    )
    
  :type PipelineNamePrefix: string
  :param PipelineNamePrefix: 

    The prefix of the pipeline name.

    

  
  :type CreatedAfter: datetime
  :param CreatedAfter: 

    A filter that returns the pipelines that were created after a specified time.

    

  
  :type CreatedBefore: datetime
  :param CreatedBefore: 

    A filter that returns the pipelines that were created before a specified time.

    

  
  :type SortBy: string
  :param SortBy: 

    The field by which to sort results. The default is ``CreatedTime``.

    

  
  :type SortOrder: string
  :param SortOrder: 

    The sort order for results.

    

  
  :type NextToken: string
  :param NextToken: 

    If the result of the previous ``ListPipelines`` request was truncated, the response includes a ``NextToken``. To retrieve the next set of pipelines, use the token in the next request.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of pipelines to return in the response.

    

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

    
    ::

      {
          'PipelineSummaries': [
              {
                  'PipelineArn': 'string',
                  'PipelineName': 'string',
                  'PipelineDisplayName': 'string',
                  'PipelineDescription': 'string',
                  'RoleArn': 'string',
                  'CreationTime': datetime(2015, 1, 1),
                  'LastModifiedTime': datetime(2015, 1, 1),
                  'LastExecutionTime': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **PipelineSummaries** *(list) --* 

        Contains a sorted list of ``PipelineSummary`` objects matching the specified filters. Each ``PipelineSummary`` consists of PipelineArn, PipelineName, ExperimentName, PipelineDescription, CreationTime, LastModifiedTime, LastRunTime, and RoleArn. This list can be empty.

        
        

        - *(dict) --* 

          A summary of a pipeline.

          
          

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

            The Amazon Resource Name (ARN) of the pipeline.

            
          

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

            The name of the pipeline.

            
          

          - **PipelineDisplayName** *(string) --* 

            The display name of the pipeline.

            
          

          - **PipelineDescription** *(string) --* 

            The description of the pipeline.

            
          

          - **RoleArn** *(string) --* 

            The Amazon Resource Name (ARN) that the pipeline used to execute.

            
          

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

            The creation time of the pipeline.

            
          

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

            The time that the pipeline was last modified.

            
          

          - **LastExecutionTime** *(datetime) --* 

            The last time that a pipeline execution began.

            
      
    
      

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

        If the result of the previous ``ListPipelines`` request was truncated, the response includes a ``NextToken``. To retrieve the next set of pipelines, use the token in the next request.

        
  