:doc:`SageMaker <../../sagemaker>` / Paginator / ListExperiments

***************
ListExperiments
***************



.. py:class:: SageMaker.Paginator.ListExperiments

  ::

    
    paginator = client.get_paginator('list_experiments')

  
  

  .. py:method:: paginate(**kwargs)

    Creates an iterator that will paginate through responses from :py:meth:`SageMaker.Client.list_experiments`.

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          CreatedAfter=datetime(2015, 1, 1),
          CreatedBefore=datetime(2015, 1, 1),
          SortBy='Name'|'CreationTime',
          SortOrder='Ascending'|'Descending',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :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 PaginationConfig: dict
    :param PaginationConfig: 

      A dictionary that provides parameters to control pagination.

      

    
      - **MaxItems** *(integer) --* 

        The total number of items to return. If the total number of items available is more than the value specified in max-items then a ``NextToken`` will be provided in the output that you can use to resume pagination.

        

      
      - **PageSize** *(integer) --* 

        The size of each page.

        

      
      - **StartingToken** *(string) --* 

        A token to specify where to start paginating. This is the ``NextToken`` from a previous response.

        

      
    
    
    :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)
                },
            ],
            
        }
        
      **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.

              
        
      
    