[ aws . sagemaker ]

describe-experiment

Description

Provides a list of an experiment’s properties.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-experiment
--experiment-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--experiment-name (string)

The name of the experiment to describe.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

ExperimentName -> (string)

The name of the experiment.

ExperimentArn -> (string)

The Amazon Resource Name (ARN) of the experiment.

DisplayName -> (string)

The name of the experiment as displayed. If DisplayName isn’t specified, ExperimentName is displayed.

Source -> (structure)

The ARN of the source and, optionally, the type.

SourceArn -> (string)

The Amazon Resource Name (ARN) of the source.

SourceType -> (string)

The source type.

Description -> (string)

The description of the experiment.

CreationTime -> (timestamp)

When the experiment was created.

CreatedBy -> (structure)

Who created the experiment.

UserProfileArn -> (string)

The Amazon Resource Name (ARN) of the user’s profile.

UserProfileName -> (string)

The name of the user’s profile.

DomainId -> (string)

The domain associated with the user.

LastModifiedTime -> (timestamp)

When the experiment was last modified.

LastModifiedBy -> (structure)

Who last modified the experiment.

UserProfileArn -> (string)

The Amazon Resource Name (ARN) of the user’s profile.

UserProfileName -> (string)

The name of the user’s profile.

DomainId -> (string)

The domain associated with the user.