SageMaker / Paginator / ListModelPackageGroups

ListModelPackageGroups#

class SageMaker.Paginator.ListModelPackageGroups#
paginator = client.get_paginator('list_model_package_groups')
paginate(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    NameContains='string',
    SortBy='Name'|'CreationTime',
    SortOrder='Ascending'|'Descending',
    PaginationConfig={
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'
    }
)
Parameters:
  • CreationTimeAfter (datetime) – A filter that returns only model groups created after the specified time.

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

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

  • SortBy (string) – The field to sort results by. The default is CreationTime.

  • SortOrder (string) – The sort order for 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:

dict

Returns:

Response Syntax

{
    'ModelPackageGroupSummaryList': [
        {
            'ModelPackageGroupName': 'string',
            'ModelPackageGroupArn': 'string',
            'ModelPackageGroupDescription': 'string',
            'CreationTime': datetime(2015, 1, 1),
            'ModelPackageGroupStatus': 'Pending'|'InProgress'|'Completed'|'Failed'|'Deleting'|'DeleteFailed'
        },
    ],

}

Response Structure

  • (dict) –

    • ModelPackageGroupSummaryList (list) –

      A list of summaries of the model groups in your Amazon Web Services account.

      • (dict) –

        Summary information about a model group.

        • ModelPackageGroupName (string) –

          The name of the model group.

        • ModelPackageGroupArn (string) –

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

        • ModelPackageGroupDescription (string) –

          A description of the model group.

        • CreationTime (datetime) –

          The time that the model group was created.

        • ModelPackageGroupStatus (string) –

          The status of the model group.