SageMaker / Paginator / ListModelPackages


class SageMaker.Paginator.ListModelPackages#
paginator = client.get_paginator('list_model_packages')

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
  • CreationTimeAfter (datetime) – A filter that returns only model packages created after the specified time (timestamp).

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

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

  • ModelApprovalStatus (string) – A filter that returns only the model packages with the specified approval status.

  • ModelPackageGroupName (string) – A filter that returns only model versions that belong to the specified model group.

  • ModelPackageType (string) –

    A filter that returns only the model packages of the specified type. This can be one of the following values.

    • UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.

    • VERSIONED - List only versioned models.

    • BOTH - List both versioned and unversioned models.

  • SortBy (string) – The parameter by which to sort the results. The default is CreationTime.

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

  • 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

    'ModelPackageSummaryList': [
            'ModelPackageName': 'string',
            'ModelPackageGroupName': 'string',
            'ModelPackageVersion': 123,
            'ModelPackageArn': 'string',
            'ModelPackageDescription': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'ModelPackageStatus': 'Pending'|'InProgress'|'Completed'|'Failed'|'Deleting',
            'ModelApprovalStatus': 'Approved'|'Rejected'|'PendingManualApproval'


Response Structure

  • (dict) –

    • ModelPackageSummaryList (list) –

      An array of ModelPackageSummary objects, each of which lists a model package.

      • (dict) –

        Provides summary information about a model package.

        • ModelPackageName (string) –

          The name of the model package.

        • ModelPackageGroupName (string) –

          If the model package is a versioned model, the model group that the versioned model belongs to.

        • ModelPackageVersion (integer) –

          If the model package is a versioned model, the version of the model.

        • ModelPackageArn (string) –

          The Amazon Resource Name (ARN) of the model package.

        • ModelPackageDescription (string) –

          A brief description of the model package.

        • CreationTime (datetime) –

          A timestamp that shows when the model package was created.

        • ModelPackageStatus (string) –

          The overall status of the model package.

        • ModelApprovalStatus (string) –

          The approval status of the model. This can be one of the following values.

          • APPROVED - The model is approved

          • REJECTED - The model is rejected.

          • PENDING_MANUAL_APPROVAL - The model is waiting for manual approval.