[ aws . sagemaker ]

update-trial

Description

Updates the display name of a trial.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  update-trial
--trial-name <value>
[--display-name <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--trial-name (string)

The name of the trial to update.

--display-name (string)

The name of the trial as displayed. The name doesn’t need to be unique. If DisplayName isn’t specified, TrialName is displayed.

--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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

TrialArn -> (string)

The Amazon Resource Name (ARN) of the trial.