Skip to content

List Models

sagemaker_list_models R Documentation

Lists models created with the CreateModel API

Description

Lists models created with the create_model API.

Usage

sagemaker_list_models(SortBy, SortOrder, NextToken, MaxResults,
  NameContains, CreationTimeBefore, CreationTimeAfter)

Arguments

SortBy

Sorts the list of results. The default is CreationTime.

SortOrder

The sort order for results. The default is Descending.

NextToken

If the response to a previous list_models request was truncated, the response includes a NextToken. To retrieve the next set of models, use the token in the next request.

MaxResults

The maximum number of models to return in the response.

NameContains

A string in the model name. This filter returns only models whose name contains the specified string.

CreationTimeBefore

A filter that returns only models created before the specified time (timestamp).

CreationTimeAfter

A filter that returns only models with a creation time greater than or equal to the specified time (timestamp).

Value

A list with the following syntax: 

list(
  Models = list(
    list(
      ModelName = "string",
      ModelArn = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_models(
  SortBy = "Name"|"CreationTime",
  SortOrder = "Ascending"|"Descending",
  NextToken = "string",
  MaxResults = 123,
  NameContains = "string",
  CreationTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  CreationTimeAfter = as.POSIXct(
    "2015-01-01"
  )
)