Skip to content

List Experiments

sagemaker_list_experiments R Documentation

Lists all the experiments in your account

Description

Lists all the experiments in your account. The list can be filtered to show only experiments that were created in a specific time range. The list can be sorted by experiment name or creation time.

Usage

sagemaker_list_experiments(CreatedAfter, CreatedBefore, SortBy,
  SortOrder, NextToken, MaxResults)

Arguments

CreatedAfter

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

CreatedBefore

A filter that returns only experiments 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.

NextToken

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

MaxResults

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

Value

A list with the following syntax:

list(
  ExperimentSummaries = list(
    list(
      ExperimentArn = "string",
      ExperimentName = "string",
      DisplayName = "string",
      ExperimentSource = list(
        SourceArn = "string",
        SourceType = "string"
      ),
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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