SageMaker / Paginator / ListTrials

ListTrials

class SageMaker.Paginator.ListTrials

paginator = client.get_paginator('list_trials')

paginate(**kwargs)

Creates an iterator that will paginate through responses from SageMaker.Client.list_trials().

See also: AWS API Documentation

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'
    }
)

Parameters:

• ExperimentName (string) – A filter that returns only trials that are part of the specified experiment.

• TrialComponentName (string) – A filter that returns only trials that are associated with the specified trial component.

• CreatedAfter (datetime) – A filter that returns only trials created after the specified time.

• CreatedBefore (datetime) – A filter that returns only trials created before the specified time.

• SortBy (string) – The property used to sort results. The default value is CreationTime.

• SortOrder (string) – The sort order. The default value is Descending.

• PaginationConfig (dict) –

  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.

Return type:

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 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.