Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: CC-BY-SA-4.0

ListModelPackages

Lists the model packages that have been created.

{
   "[CreationTimeAfter](#SageMaker-ListModelPackages-request-CreationTimeAfter)": number,
   "[CreationTimeBefore](#SageMaker-ListModelPackages-request-CreationTimeBefore)": number,
   "[MaxResults](#SageMaker-ListModelPackages-request-MaxResults)": number,
   "[NameContains](#SageMaker-ListModelPackages-request-NameContains)": "string",
   "[NextToken](#SageMaker-ListModelPackages-request-NextToken)": "string",
   "[SortBy](#SageMaker-ListModelPackages-request-SortBy)": "string",
   "[SortOrder](#SageMaker-ListModelPackages-request-SortOrder)": "string"
}

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

** CreationTimeAfter ** A filter that returns only model packages created after the specified time (timestamp).
Type: Timestamp
Required: No

** CreationTimeBefore ** A filter that returns only model packages created before the specified time (timestamp).
Type: Timestamp
Required: No

** MaxResults ** The maximum number of model packages to return in the response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No

** NameContains ** A string in the model package name. This filter returns only model packages whose name contains the specified string.
Type: String
Length Constraints: Maximum length of 63.
Pattern: [a-zA-Z0-9\-]+
Required: No

** NextToken ** If the response to a previous ListModelPackages request was truncated, the response includes a NextToken. To retrieve the next set of model packages, use the token in the next request.
Type: String
Length Constraints: Maximum length of 8192.
Pattern: .*
Required: No

** SortBy ** The parameter by which to sort the results. The default is CreationTime.
Type: String
Valid Values:Name | CreationTime
Required: No

** SortOrder ** The sort order for the results. The default is Ascending.
Type: String
Valid Values:Ascending | Descending
Required: No

{
   "[ModelPackageSummaryList](#SageMaker-ListModelPackages-response-ModelPackageSummaryList)": [ 
      { 
         "[CreationTime](API_ModelPackageSummary.md#SageMaker-Type-ModelPackageSummary-CreationTime)": number,
         "[ModelPackageArn](API_ModelPackageSummary.md#SageMaker-Type-ModelPackageSummary-ModelPackageArn)": "string",
         "[ModelPackageDescription](API_ModelPackageSummary.md#SageMaker-Type-ModelPackageSummary-ModelPackageDescription)": "string",
         "[ModelPackageName](API_ModelPackageSummary.md#SageMaker-Type-ModelPackageSummary-ModelPackageName)": "string",
         "[ModelPackageStatus](API_ModelPackageSummary.md#SageMaker-Type-ModelPackageSummary-ModelPackageStatus)": "string"
      }
   ],
   "[NextToken](#SageMaker-ListModelPackages-response-NextToken)": "string"
}

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

** ModelPackageSummaryList ** An array of ModelPackageSummary objects, each of which lists a model package.
Type: Array of ModelPackageSummary objects

** NextToken ** If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of model packages, use it in the subsequent request.
Type: String
Length Constraints: Maximum length of 8192.
Pattern: .*

For information about the errors that are common to all actions, see Common Errors.

For more information about using this API in one of the language-specific AWS SDKs, see the following: + AWS Command Line Interface + AWS SDK for .NET + AWS SDK for C++ + AWS SDK for Go + AWS SDK for Go - Pilot + AWS SDK for Java + AWS SDK for JavaScript + AWS SDK for PHP V3 + AWS SDK for Python + AWS SDK for Ruby V2