List Trial Components

sagemaker_list_trial_components

R Documentation

Lists the trial components in your account

Description

Lists the trial components in your account. You can sort the list by trial component name or creation time. You can filter the list to show only components that were created in a specific time range. You can also filter on one of the following:

• ExperimentName

• SourceArn

• TrialName

Usage

sagemaker_list_trial_components(ExperimentName, TrialName, SourceArn,
  CreatedAfter, CreatedBefore, SortBy, SortOrder, MaxResults, NextToken)

Arguments

ExperimentName

A filter that returns only components that are part of the specified experiment. If you specify ExperimentName, you can't filter by SourceArn or TrialName.

TrialName

A filter that returns only components that are part of the specified trial. If you specify TrialName, you can't filter by ExperimentName or SourceArn.

SourceArn

A filter that returns only components that have the specified source Amazon Resource Name (ARN). If you specify SourceArn, you can't filter by ExperimentName or TrialName.

CreatedAfter

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

CreatedBefore

A filter that returns only components 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 components to return in the response. The default value is 10.

NextToken

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

Value

A list with the following syntax:

list(
  TrialComponentSummaries = list(
    list(
      TrialComponentName = "string",
      TrialComponentArn = "string",
      DisplayName = "string",
      TrialComponentSource = list(
        SourceArn = "string",
        SourceType = "string"
      ),
      Status = list(
        PrimaryStatus = "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped",
        Message = "string"
      ),
      StartTime = as.POSIXct(
        "2015-01-01"
      ),
      EndTime = as.POSIXct(
        "2015-01-01"
      ),
      CreationTime = as.POSIXct(
        "2015-01-01"
      ),
      CreatedBy = list(
        UserProfileArn = "string",
        UserProfileName = "string",
        DomainId = "string",
        IamIdentity = list(
          Arn = "string",
          PrincipalId = "string",
          SourceIdentity = "string"
        )
      ),
      LastModifiedTime = as.POSIXct(
        "2015-01-01"
      ),
      LastModifiedBy = list(
        UserProfileArn = "string",
        UserProfileName = "string",
        DomainId = "string",
        IamIdentity = list(
          Arn = "string",
          PrincipalId = "string",
          SourceIdentity = "string"
        )
      )
    )
  ),
  NextToken = "string"
)

Request syntax

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