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

**********
ListTrials
**********



.. py:class:: SageMaker.Paginator.ListTrials

  ::

    
    paginator = client.get_paginator('list_trials')

  
  

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

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

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


    **Request Syntax**
    ::

      response_iterator = paginator.paginate(
          ExperimentName='string',
          TrialComponentName='string',
          CreatedAfter=datetime(2015, 1, 1),
          CreatedBefore=datetime(2015, 1, 1),
          SortBy='Name'|'CreationTime',
          SortOrder='Ascending'|'Descending',
          PaginationConfig={
              'MaxItems': 123,
              'PageSize': 123,
              'StartingToken': 'string'
          }
      )
      
    :type ExperimentName: string
    :param ExperimentName: 

      A filter that returns only trials that are part of the specified experiment.

      

    
    :type TrialComponentName: string
    :param TrialComponentName: 

      A filter that returns only trials that are associated with the specified trial component.

      

    
    :type CreatedAfter: datetime
    :param CreatedAfter: 

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

      

    
    :type CreatedBefore: datetime
    :param CreatedBefore: 

      A filter that returns only trials 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**

      
      ::

        {
            'TrialSummaries': [
                {
                    'TrialArn': 'string',
                    'TrialName': 'string',
                    'DisplayName': 'string',
                    'TrialSource': {
                        'SourceArn': 'string',
                        'SourceType': 'string'
                    },
                    'CreationTime': datetime(2015, 1, 1),
                    'LastModifiedTime': datetime(2015, 1, 1)
                },
            ],
            
        }
        
      **Response Structure**

      

      - *(dict) --* 
        

        - **TrialSummaries** *(list) --* 

          A list of the summaries of your trials.

          
          

          - *(dict) --* 

            A summary of the properties of a trial. To get the complete set of properties, call the `DescribeTrial <https://docs.aws.amazon.com/sagemaker/latest/APIReference/API_DescribeTrial.html>`__ API and provide the ``TrialName``.

            
            

            - **TrialArn** *(string) --* 

              The Amazon Resource Name (ARN) of the trial.

              
            

            - **TrialName** *(string) --* 

              The name of the trial.

              
            

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

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

              
            

            - **TrialSource** *(dict) --* 

              The source of the trial.

              
              

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

                The Amazon Resource Name (ARN) of the source.

                
              

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

                The source job type.

                
          
            

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

              When the trial was created.

              
            

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

              When the trial was last modified.

              
        
      
    