Skip to content

Describe Trial

sagemaker_describe_trial R Documentation

Provides a list of a trial's properties

Description

Provides a list of a trial's properties.

Usage

sagemaker_describe_trial(TrialName)

Arguments

TrialName

[required] The name of the trial to describe.

Value

A list with the following syntax:

list(
  TrialName = "string",
  TrialArn = "string",
  DisplayName = "string",
  ExperimentName = "string",
  Source = list(
    SourceArn = "string",
    SourceType = "string"
  ),
  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"
    )
  ),
  MetadataProperties = list(
    CommitId = "string",
    Repository = "string",
    GeneratedBy = "string",
    ProjectId = "string"
  )
)

Request syntax

svc$describe_trial(
  TrialName = "string"
)