Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . sagemaker ]

update-trial-component

Description

Updates one or more properties of a trial component.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-trial-component
--trial-component-name <value>
[--display-name <value>]
[--status <value>]
[--start-time <value>]
[--end-time <value>]
[--parameters <value>]
[--parameters-to-remove <value>]
[--input-artifacts <value>]
[--input-artifacts-to-remove <value>]
[--output-artifacts <value>]
[--output-artifacts-to-remove <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--trial-component-name (string)

The name of the component to update.

--display-name (string)

The name of the component as displayed. The name doesn't need to be unique. If DisplayName isn't specified, TrialComponentName is displayed.

--status (structure)

The new status of the component.

PrimaryStatus -> (string)

The status of the trial component.

Message -> (string)

If the component failed, a message describing why.

Shorthand Syntax:

PrimaryStatus=string,Message=string

JSON Syntax:

{
  "PrimaryStatus": "InProgress"|"Completed"|"Failed"|"Stopping"|"Stopped",
  "Message": "string"
}

--start-time (timestamp)

When the component started.

--end-time (timestamp)

When the component ended.

--parameters (map)

Replaces all of the component's hyperparameters with the specified hyperparameters.

key -> (string)

value -> (structure)

The value of a hyperparameter. Only one of NumberValue or StringValue can be specified.

This object is specified in the CreateTrialComponent request.

StringValue -> (string)

The string value of a categorical hyperparameter. If you specify a value for this parameter, you can't specify the NumberValue parameter.

NumberValue -> (double)

The numeric value of a numeric hyperparameter. If you specify a value for this parameter, you can't specify the StringValue parameter.

Shorthand Syntax:

KeyName1=StringValue=string,NumberValue=double,KeyName2=StringValue=string,NumberValue=double

JSON Syntax:

{"string": {
      "StringValue": "string",
      "NumberValue": double
    }
  ...}

--parameters-to-remove (list)

The hyperparameters to remove from the component.

(string)

Syntax:

"string" "string" ...

--input-artifacts (map)

Replaces all of the component's input artifacts with the specified artifacts.

key -> (string)

value -> (structure)

Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.

Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

MediaType -> (string)

The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

Value -> (string)

The location of the artifact.

Shorthand Syntax:

KeyName1=MediaType=string,Value=string,KeyName2=MediaType=string,Value=string

JSON Syntax:

{"string": {
      "MediaType": "string",
      "Value": "string"
    }
  ...}

--input-artifacts-to-remove (list)

The input artifacts to remove from the component.

(string)

Syntax:

"string" "string" ...

--output-artifacts (map)

Replaces all of the component's output artifacts with the specified artifacts.

key -> (string)

value -> (structure)

Represents an input or output artifact of a trial component. You specify TrialComponentArtifact as part of the InputArtifacts and OutputArtifacts parameters in the CreateTrialComponent request.

Examples of input artifacts are datasets, algorithms, hyperparameters, source code, and instance types. Examples of output artifacts are metrics, snapshots, logs, and images.

MediaType -> (string)

The media type of the artifact, which indicates the type of data in the artifact file. The media type consists of a type and a subtype concatenated with a slash (/) character, for example, text/csv, image/jpeg, and s3/uri. The type specifies the category of the media. The subtype specifies the kind of data.

Value -> (string)

The location of the artifact.

Shorthand Syntax:

KeyName1=MediaType=string,Value=string,KeyName2=MediaType=string,Value=string

JSON Syntax:

{"string": {
      "MediaType": "string",
      "Value": "string"
    }
  ...}

--output-artifacts-to-remove (list)

The output artifacts to remove from the component.

(string)

Syntax:

"string" "string" ...

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI 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.

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

TrialComponentArn -> (string)

The Amazon Resource Name (ARN) of the trial component.