Skip to content

List Trials

sagemaker_list_trials R Documentation

Lists the trials in your account

Description

Lists the trials in your account. Specify an experiment name to limit the list to the trials that are part of that experiment. Specify a trial component name to limit the list to the trials that associated with that trial component. The list can be filtered to show only trials that were created in a specific time range. The list can be sorted by trial name or creation time.

Usage

sagemaker_list_trials(ExperimentName, TrialComponentName, CreatedAfter,
  CreatedBefore, SortBy, SortOrder, MaxResults, NextToken)

Arguments

ExperimentName

A filter that returns only trials that are part of the specified experiment.

TrialComponentName

A filter that returns only trials that are associated with the specified trial component.

CreatedAfter

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

CreatedBefore

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

SortBy

The property used to sort results. The default value is CreationTime.

SortOrder

The sort order. The default value is Descending.

MaxResults

The maximum number of trials to return in the response. The default value is 10.

NextToken

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

Value

A list with the following syntax: 

list(
  TrialSummaries = list(
    list(
      TrialArn = "string",
      TrialName = "string",
      DisplayName = "string",
      TrialSource = list(
        SourceArn = "string",
        SourceType = "string"
      ),
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

svc$list_trials(
  ExperimentName = "string",
  TrialComponentName = "string",
  CreatedAfter = as.POSIXct(
    "2015-01-01"
  ),
  CreatedBefore = as.POSIXct(
    "2015-01-01"
  ),
  SortBy = "Name"|"CreationTime",
  SortOrder = "Ascending"|"Descending",
  MaxResults = 123,
  NextToken = "string"
)