SageMaker / Client / list_model_package_groups

list_model_package_groups#

SageMaker.Client.list_model_package_groups(**kwargs)#

Gets a list of the model groups in your Amazon Web Services account.

See also: AWS API Documentation

Request Syntax

response = client.list_model_package_groups(
    CreationTimeAfter=datetime(2015, 1, 1),
    CreationTimeBefore=datetime(2015, 1, 1),
    MaxResults=123,
    NameContains='string',
    NextToken='string',
    SortBy='Name'|'CreationTime',
    SortOrder='Ascending'|'Descending',
    CrossAccountFilterOption='SameAccount'|'CrossAccount'
)
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.

  • MaxResults (integer) – The maximum number of results to return in the response.

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

  • NextToken (string) – If the result of the previous ListModelPackageGroups request was truncated, the response includes a NextToken. To retrieve the next set of model groups, use the token in the next request.

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

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

  • CrossAccountFilterOption (string) – A filter that returns either model groups shared with you or model groups in your own account. When the value is CrossAccount, the results show the resources made discoverable to you from other accounts. When the value is SameAccount or null, the results show resources from your account. The default is SameAccount.

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'
        },
    ],
    'NextToken': 'string'
}

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.

    • NextToken (string) –

      If the response is truncated, SageMaker returns this token. To retrieve the next set of model groups, use it in the subsequent request.