Lists jobs in a specified category¶

Description¶

Lists jobs in a specified category. You can filter results by creation time, last modified time, name, and status. Results are sorted by the field you specify in SortBy. Use pagination to retrieve large result sets efficiently.

The following operations are related to list_jobs:

Usage¶

sagemaker_list_jobs(JobCategory, NextToken, MaxResults,
  CreationTimeAfter, CreationTimeBefore, LastModifiedTimeAfter,
  LastModifiedTimeBefore, NameContains, SortBy, SortOrder, StatusEquals)

Arguments¶

JobCategory

[required] The category of jobs to list.
NextToken

If the previous response was truncated, this token retrieves the next set of results.
MaxResults

The maximum number of jobs to return in the response. The default value is 50.
CreationTimeAfter

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

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

A filter that returns only jobs modified after the specified time.
LastModifiedTimeBefore

A filter that returns only jobs modified before the specified time.
NameContains

A string in the job name to filter results. Only jobs whose name contains the specified string are returned.
SortBy

The field to sort results by.
SortOrder

The sort order for results. Valid values are Ascending and Descending.
StatusEquals

A filter that returns only jobs with the specified status.

Value¶

A list with the following syntax:

list(
  NextToken = "string",
  JobSummaries = list(
    list(
      JobArn = "string",
      JobName = "string",
      JobCategory = "AgentRFT"|"AgentRFTEvaluation",
      JobStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|"Deleting"|"DeleteFailed",
      JobSecondaryStatus = "Starting"|"Downloading"|"Training"|"Uploading"|"Stopping"|"Stopped"|"MaxRuntimeExceeded"|"Interrupted"|"Failed"|"Completed"|"Restarting"|"Pending"|"Evaluating"|"Deleting"|"DeleteFailed",
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      )
    )
  )
)

Request syntax¶

svc$list_jobs(
  JobCategory = "AgentRFT"|"AgentRFTEvaluation",
  NextToken = "string",
  MaxResults = 123,
  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",
  SortBy = "Name"|"CreationTime"|"Status",
  SortOrder = "Ascending"|"Descending",
  StatusEquals = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped"|"Deleting"|"DeleteFailed"
)