Skip to content

List Model Packages

sagemaker_list_model_packages R Documentation

Lists the model packages that have been created

Description

Lists the model packages that have been created.

Usage

sagemaker_list_model_packages(CreationTimeAfter, CreationTimeBefore,
  MaxResults, NameContains, ModelApprovalStatus, ModelPackageGroupName,
  ModelPackageType, NextToken, SortBy, SortOrder)

Arguments

CreationTimeAfter

A filter that returns only model packages created after the specified time (timestamp).

CreationTimeBefore

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

MaxResults

The maximum number of model packages to return in the response.

NameContains

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

ModelApprovalStatus

A filter that returns only the model packages with the specified approval status.

ModelPackageGroupName

A filter that returns only model versions that belong to the specified model group.

ModelPackageType

A filter that returns only the model packages of the specified type. This can be one of the following values.

  • UNVERSIONED - List only unversioined models. This is the default value if no ModelPackageType is specified.

  • VERSIONED - List only versioned models.

  • BOTH - List both versioned and unversioned models.

NextToken

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

SortBy

The parameter by which to sort the results. The default is CreationTime.

SortOrder

The sort order for the results. The default is Ascending.

Value

A list with the following syntax: 

list(
  ModelPackageSummaryList = list(
    list(
      ModelPackageName = "string",
      ModelPackageGroupName = "string",
      ModelPackageVersion = 123,
      ModelPackageArn = "string",
      ModelPackageDescription = "string",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      ModelPackageStatus = "Pending"|"InProgress"|"Completed"|"Failed"|"Deleting",
      ModelApprovalStatus = "Approved"|"Rejected"|"PendingManualApproval"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_model_packages(
  CreationTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  CreationTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  MaxResults = 123,
  NameContains = "string",
  ModelApprovalStatus = "Approved"|"Rejected"|"PendingManualApproval",
  ModelPackageGroupName = "string",
  ModelPackageType = "Versioned"|"Unversioned"|"Both",
  NextToken = "string",
  SortBy = "Name"|"CreationTime",
  SortOrder = "Ascending"|"Descending"
)