Skip to content

List Inference Recommendations Jobs

sagemaker_list_inference_recommendations_jobs R Documentation

Lists recommendation jobs that satisfy various filters

Description

Lists recommendation jobs that satisfy various filters.

Usage

sagemaker_list_inference_recommendations_jobs(CreationTimeAfter,
  CreationTimeBefore, LastModifiedTimeAfter, LastModifiedTimeBefore,
  NameContains, StatusEquals, SortBy, SortOrder, NextToken, MaxResults,
  ModelNameEquals, ModelPackageVersionArnEquals)

Arguments

CreationTimeAfter

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

CreationTimeBefore

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

LastModifiedTimeAfter

A filter that returns only jobs that were last modified after the specified time (timestamp).

LastModifiedTimeBefore

A filter that returns only jobs that were last modified before the specified time (timestamp).

NameContains

A string in the job name. This filter returns only recommendations whose name contains the specified string.

StatusEquals

A filter that retrieves only inference recommendations jobs with a specific status.

SortBy

The parameter by which to sort the results.

SortOrder

The sort order for the results.

NextToken

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

MaxResults

The maximum number of recommendations to return in the response.

ModelNameEquals

A filter that returns only jobs that were created for this model.

ModelPackageVersionArnEquals

A filter that returns only jobs that were created for this versioned model package.

Value

A list with the following syntax: 

list(
  InferenceRecommendationsJobs = list(
    list(
      JobName = "string",
      JobDescription = "string",
      JobType = "Default"|"Advanced",
      JobArn = "string",
      Status = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"STOPPING"|"STOPPED"|"DELETING"|"DELETED",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      CompletionTime = as.POSIXct(
        "2015-01-01"
      ),
      RoleArn = "string",
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      FailureReason = "string",
      ModelName = "string",
      SamplePayloadUrl = "string",
      ModelPackageVersionArn = "string"
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_inference_recommendations_jobs(
  CreationTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  CreationTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  LastModifiedTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  NameContains = "string",
  StatusEquals = "PENDING"|"IN_PROGRESS"|"COMPLETED"|"FAILED"|"STOPPING"|"STOPPED"|"DELETING"|"DELETED",
  SortBy = "Name"|"CreationTime"|"Status",
  SortOrder = "Ascending"|"Descending",
  NextToken = "string",
  MaxResults = 123,
  ModelNameEquals = "string",
  ModelPackageVersionArnEquals = "string"
)