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

***************
list_algorithms
***************



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

  

  Lists the machine learning algorithms that have been created.

  

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


  **Request Syntax**
  ::

    response = client.list_algorithms(
        CreationTimeAfter=datetime(2015, 1, 1),
        CreationTimeBefore=datetime(2015, 1, 1),
        MaxResults=123,
        NameContains='string',
        NextToken='string',
        SortBy='Name'|'CreationTime',
        SortOrder='Ascending'|'Descending'
    )
    
  :type CreationTimeAfter: datetime
  :param CreationTimeAfter: 

    A filter that returns only algorithms created after the specified time (timestamp).

    

  
  :type CreationTimeBefore: datetime
  :param CreationTimeBefore: 

    A filter that returns only algorithms created before the specified time (timestamp).

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of algorithms to return in the response.

    

  
  :type NameContains: string
  :param NameContains: 

    A string in the algorithm name. This filter returns only algorithms whose name contains the specified string.

    

  
  :type NextToken: string
  :param NextToken: 

    If the response to a previous ``ListAlgorithms`` request was truncated, the response includes a ``NextToken``. To retrieve the next set of algorithms, use the token in the next request.

    

  
  :type SortBy: string
  :param SortBy: 

    The parameter by which to sort the results. The default is ``CreationTime``.

    

  
  :type SortOrder: string
  :param SortOrder: 

    The sort order for the results. The default is ``Ascending``.

    

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

    
    ::

      {
          'AlgorithmSummaryList': [
              {
                  'AlgorithmName': 'string',
                  'AlgorithmArn': 'string',
                  'AlgorithmDescription': 'string',
                  'CreationTime': datetime(2015, 1, 1),
                  'AlgorithmStatus': 'Pending'|'InProgress'|'Completed'|'Failed'|'Deleting'
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **AlgorithmSummaryList** *(list) --* 

        >An array of ``AlgorithmSummary`` objects, each of which lists an algorithm.

        
        

        - *(dict) --* 

          Provides summary information about an algorithm.

          
          

          - **AlgorithmName** *(string) --* 

            The name of the algorithm that is described by the summary.

            
          

          - **AlgorithmArn** *(string) --* 

            The Amazon Resource Name (ARN) of the algorithm.

            
          

          - **AlgorithmDescription** *(string) --* 

            A brief description of the algorithm.

            
          

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

            A timestamp that shows when the algorithm was created.

            
          

          - **AlgorithmStatus** *(string) --* 

            The overall status of the algorithm.

            
      
    
      

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

        If the response is truncated, SageMaker returns this token. To retrieve the next set of algorithms, use it in the subsequent request.

        
  