SageMaker / Paginator / ListModels


class SageMaker.Paginator.ListModels#
paginator = client.get_paginator('list_models')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CreationTimeBefore=datetime(2015, 1, 1),
    CreationTimeAfter=datetime(2015, 1, 1),
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • SortBy (string) – Sorts the list of results. The default is CreationTime.

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

  • NameContains (string) – A string in the model name. This filter returns only models whose name contains the specified string.

  • CreationTimeBefore (datetime) – A filter that returns only models created before the specified time (timestamp).

  • CreationTimeAfter (datetime) – A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

  • 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:



Response Syntax

    'Models': [
            'ModelName': 'string',
            'ModelArn': 'string',
            'CreationTime': datetime(2015, 1, 1)


Response Structure

  • (dict) –

    • Models (list) –

      An array of ModelSummary objects, each of which lists a model.

      • (dict) –

        Provides summary information about a model.

        • ModelName (string) –

          The name of the model that you want a summary for.

        • ModelArn (string) –

          The Amazon Resource Name (ARN) of the model.

        • CreationTime (datetime) –

          A timestamp that indicates when the model was created.