Table Of Contents

Feedback

User Guide

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

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

Shorthand Syntax:

PrimaryStatus=string,Message=string

JSON Syntax:

{
  "PrimaryStatus": "InProgress"|"Completed"|"Failed",
  "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.

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.

Syntax:

"string" "string" ...

--input-artifacts (map)

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

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.

Syntax:

"string" "string" ...

--output-artifacts (map)

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

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.

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.