UpdateTrialComponent - Amazon SageMaker Service

UpdateTrialComponent

Updates one or more properties of a trial component.

Request Syntax

{ "DisplayName": "string", "EndTime": number, "InputArtifacts": { "string" : { "MediaType": "string", "Value": "string" } }, "InputArtifactsToRemove": [ "string" ], "OutputArtifacts": { "string" : { "MediaType": "string", "Value": "string" } }, "OutputArtifactsToRemove": [ "string" ], "Parameters": { "string" : { "NumberValue": number, "StringValue": "string" } }, "ParametersToRemove": [ "string" ], "StartTime": number, "Status": { "Message": "string", "PrimaryStatus": "string" }, "TrialComponentName": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

DisplayName

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 82.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: No

EndTime

When the component ended.

Type: Timestamp

Required: No

InputArtifacts

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

Type: String to TrialComponentArtifact object map

Map Entries: Maximum number of 30 items.

Key Length Constraints: Maximum length of 64.

Key Pattern: .*

Required: No

InputArtifactsToRemove

The input artifacts to remove from the component.

Type: Array of strings

Length Constraints: Maximum length of 256.

Pattern: .*

Required: No

OutputArtifacts

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

Type: String to TrialComponentArtifact object map

Map Entries: Maximum number of 30 items.

Key Length Constraints: Maximum length of 64.

Key Pattern: .*

Required: No

OutputArtifactsToRemove

The output artifacts to remove from the component.

Type: Array of strings

Length Constraints: Maximum length of 256.

Pattern: .*

Required: No

Parameters

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

Type: String to TrialComponentParameterValue object map

Map Entries: Maximum number of 150 items.

Key Length Constraints: Maximum length of 256.

Key Pattern: .*

Required: No

ParametersToRemove

The hyperparameters to remove from the component.

Type: Array of strings

Length Constraints: Maximum length of 256.

Pattern: .*

Required: No

StartTime

When the component started.

Type: Timestamp

Required: No

Status

The new status of the component.

Type: TrialComponentStatus object

Required: No

TrialComponentName

The name of the component to update.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 82.

Pattern: ^[a-zA-Z0-9](-*[a-zA-Z0-9])*

Required: Yes

Response Syntax

{ "TrialComponentArn": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

TrialComponentArn

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

Type: String

Length Constraints: Maximum length of 256.

Pattern: arn:aws[a-z\-]*:sagemaker:[a-z0-9\-]*:[0-9]{12}:experiment-trial-component/.*

Errors

For information about the errors that are common to all actions, see Common Errors.

ConflictException

There was a conflict when you attempted to modify an experiment, trial, or trial component.

HTTP Status Code: 400

ResourceNotFound

Resource being access is not found.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: