SageMaker / Client / list_experiments

list_experiments#

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

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
)
Parameters:

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

  • CreatedBefore (datetime) – A filter that returns only experiments 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.

  • NextToken (string) – 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.

  • MaxResults (integer) – The maximum number of experiments to return in the response. The default value is 10.

Return type:

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