List Ai Benchmark Jobs

sagemaker_list_ai_benchmark_jobs

R Documentation

Returns a list of AI benchmark jobs in your account¶

Description¶

Returns a list of AI benchmark jobs in your account. You can filter the results by name, status, and creation time, and sort the results. The response is paginated.

Usage¶

sagemaker_list_ai_benchmark_jobs(MaxResults, NextToken, NameContains,
  StatusEquals, CreationTimeAfter, CreationTimeBefore, SortBy, SortOrder)

Arguments¶

MaxResults

The maximum number of benchmark jobs to return in the response.

NextToken

If the previous call to list_ai_benchmark_jobs didn't return the full set of jobs, the call returns a token for getting the next set.

NameContains

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

StatusEquals

A filter that returns only benchmark jobs with the specified status.

CreationTimeAfter

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

CreationTimeBefore

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

SortBy

The field to sort results by. The default is CreationTime.

SortOrder

The sort order for results. The default is Descending.

Value¶

A list with the following syntax:

list(
  AIBenchmarkJobs = list(
    list(
      AIBenchmarkJobName = "string",
      AIBenchmarkJobArn = "string",
      AIBenchmarkJobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      AIWorkloadConfigName = "string"
    )
  ),
  NextToken = "string"
)

Request syntax¶

svc$list_ai_benchmark_jobs(
  MaxResults = 123,
  NextToken = "string",
  NameContains = "string",
  StatusEquals = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped",
  CreationTimeAfter = as.POSIXct(
    "2015-01-01"
  ),
  CreationTimeBefore = as.POSIXct(
    "2015-01-01"
  ),
  SortBy = "Name"|"CreationTime"|"Status",
  SortOrder = "Ascending"|"Descending"
)