ListModels

Lists models created with the CreateModel API.

{
   "[CreationTimeAfter](#SageMaker-ListModels-request-CreationTimeAfter)": number,
   "[CreationTimeBefore](#SageMaker-ListModels-request-CreationTimeBefore)": number,
   "[MaxResults](#SageMaker-ListModels-request-MaxResults)": number,
   "[NameContains](#SageMaker-ListModels-request-NameContains)": "string",
   "[NextToken](#SageMaker-ListModels-request-NextToken)": "string",
   "[SortBy](#SageMaker-ListModels-request-SortBy)": "string",
   "[SortOrder](#SageMaker-ListModels-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 models with a creation time greater than or equal to the specified time (timestamp).
Type: Timestamp
Required: No

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

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

** NameContains ** A string in the training job name. This filter returns only models in the training job 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 ListModels request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.
Type: String
Length Constraints: Maximum length of 8192.
Pattern: .*
Required: No

** SortBy ** Sorts the list of results. The default is CreationTime.
Type: String
Valid Values:Name | CreationTime
Required: No

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

{
   "[Models](#SageMaker-ListModels-response-Models)": [ 
      { 
         "[CreationTime](API_ModelSummary.md#SageMaker-Type-ModelSummary-CreationTime)": number,
         "[ModelArn](API_ModelSummary.md#SageMaker-Type-ModelSummary-ModelArn)": "string",
         "[ModelName](API_ModelSummary.md#SageMaker-Type-ModelSummary-ModelName)": "string"
      }
   ],
   "[NextToken](#SageMaker-ListModels-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.

** Models ** An array of ModelSummary objects, each of which lists a model.
Type: Array of ModelSummary objects

** NextToken ** If the response is truncated, Amazon SageMaker returns this token. To retrieve the next set of models, 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