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

****************
list_experiments
****************



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

  

  Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

  

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


  **Request Syntax**
  ::

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

    A filter that returns only experiments created after the specified time.

    

  
  :type CreatedBefore: datetime
  :param CreatedBefore: 

    A filter that returns only experiments created before the specified time.

    

  
  :type SortBy: string
  :param SortBy: 

    The property used to sort results. The default value is ``CreationTime``.

    

  
  :type SortOrder: string
  :param SortOrder: 

    The sort order. The default value is ``Descending``.

    

  
  :type NextToken: string
  :param NextToken: 

    If the previous call to ``ListExperiments`` didn't return the full set of experiments, the call returns a token for getting the next set of experiments.

    

  
  :type MaxResults: integer
  :param MaxResults: 

    The maximum number of experiments to return in the response. The default value is 10.

    

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

    
    ::

      {
          'ExperimentSummaries': [
              {
                  'ExperimentArn': 'string',
                  'ExperimentName': 'string',
                  'DisplayName': 'string',
                  'ExperimentSource': {
                      'SourceArn': 'string',
                      'SourceType': 'string'
                  },
                  'CreationTime': datetime(2015, 1, 1),
                  'LastModifiedTime': datetime(2015, 1, 1)
              },
          ],
          'NextToken': 'string'
      }
      
    **Response Structure**

    

    - *(dict) --* 
      

      - **ExperimentSummaries** *(list) --* 

        A list of the summaries of your experiments.

        
        

        - *(dict) --* 

          A summary of the properties of an experiment. To get the complete set of properties, call the `DescribeExperiment <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeExperiment.html>`__ API and provide the ``ExperimentName``.

          
          

          - **ExperimentArn** *(string) --* 

            The Amazon Resource Name (ARN) of the experiment.

            
          

          - **ExperimentName** *(string) --* 

            The name of the experiment.

            
          

          - **DisplayName** *(string) --* 

            The name of the experiment as displayed. If ``DisplayName`` isn't specified, ``ExperimentName`` is displayed.

            
          

          - **ExperimentSource** *(dict) --* 

            The source of the experiment.

            
            

            - **SourceArn** *(string) --* 

              The Amazon Resource Name (ARN) of the source.

              
            

            - **SourceType** *(string) --* 

              The source type.

              
        
          

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

            When the experiment was created.

            
          

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

            When the experiment was last modified.

            
      
    
      

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

        A token for getting the next set of experiments, if there are any.

        
  