Skip to content

List Inference Components

sagemaker_list_inference_components R Documentation

Lists the inference components in your account and their properties

Description

Lists the inference components in your account and their properties.

Usage

sagemaker_list_inference_components(SortBy, SortOrder, NextToken,
  MaxResults, NameContains, CreationTimeBefore, CreationTimeAfter,
  LastModifiedTimeBefore, LastModifiedTimeAfter, StatusEquals,
  EndpointNameEquals, VariantNameEquals)

Arguments

SortBy

The field by which to sort the inference components in the response. The default is CreationTime.

SortOrder

The sort order for results. The default is Descending.

NextToken

A token that you use to get the next set of results following a truncated response. If the response to the previous request was truncated, that response provides the value for this token.

MaxResults

The maximum number of inference components to return in the response. This value defaults to 10.

NameContains

Filters the results to only those inference components with a name that contains the specified string.

CreationTimeBefore

Filters the results to only those inference components that were created before the specified time.

CreationTimeAfter

Filters the results to only those inference components that were created after the specified time.

LastModifiedTimeBefore

Filters the results to only those inference components that were updated before the specified time.

LastModifiedTimeAfter

Filters the results to only those inference components that were updated after the specified time.

StatusEquals

Filters the results to only those inference components with the specified status.

EndpointNameEquals

An endpoint name to filter the listed inference components. The response includes only those inference components that are hosted at the specified endpoint.

VariantNameEquals

A production variant name to filter the listed inference components. The response includes only those inference components that are hosted at the specified variant.

Value

A list with the following syntax: 

list(
  InferenceComponents = list(
    list(
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      InferenceComponentArn = "string",
      InferenceComponentName = "string",
      EndpointArn = "string",
      EndpointName = "string",
      VariantName = "string",
      InferenceComponentStatus = "InService"|"Creating"|"Updating"|"Failed"|"Deleting",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_inference_components(
  SortBy = "Name"|"CreationTime"|"Status",
  SortOrder = "Ascending"|"Descending",
  NextToken = "string",
  MaxResults = 123,
  NameContains = "string",
  CreationTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  CreationTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  StatusEquals = "InService"|"Creating"|"Updating"|"Failed"|"Deleting",
  EndpointNameEquals = "string",
  VariantNameEquals = "string"
)