AssociateTrialComponent - Amazon SageMaker (original) (raw)

Associates a trial component with a trial. A trial component can be associated with multiple trials. To disassociate a trial component from a trial, call the DisassociateTrialComponent API.

Request Syntax

{
   "TrialComponentName": "string",
   "TrialName": "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.

TrialComponentName

The name of the component to associated with the trial.

Type: String

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

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}

Required: Yes

TrialName

The name of the trial to associate with.

Type: String

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

Pattern: [a-zA-Z0-9](-*[a-zA-Z0-9]){0,119}

Required: Yes

Response Syntax

{
   "TrialArn": "string",
   "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.

TrialArn

The Amazon Resource Name (ARN) of the trial.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

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

TrialComponentArn

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

Type: String

Length Constraints: Minimum length of 0. 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 Error Types.

ResourceLimitExceeded

You have exceeded an SageMaker resource limit. For example, you might have too many training jobs created.

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: