SageMaker / Paginator / ListExperiments
ListExperiments#
- class SageMaker.Paginator.ListExperiments#
paginator = client.get_paginator('list_experiments')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
SageMaker.Client.list_experiments()
.See also: AWS API Documentation
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' } )
- 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
.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
{ '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 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.