StopHyperParameterTuningJobCommand

Suggest an Edit

Stops a running hyperparameter tuning job and all running training jobs that the tuning job launched.

All model artifacts output from the training jobs are stored in Amazon Simple Storage Service (Amazon S3). All data that the training jobs write to Amazon CloudWatch Logs are still available in CloudWatch. After the tuning job moves to the Stopped state, it releases all reserved resources for the tuning job.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { SageMakerClient, StopHyperParameterTuningJobCommand } from "@aws-sdk/client-sagemaker"; // ES Modules import
// const { SageMakerClient, StopHyperParameterTuningJobCommand } = require("@aws-sdk/client-sagemaker"); // CommonJS import
const client = new SageMakerClient(config);
const input = { // StopHyperParameterTuningJobRequest
  HyperParameterTuningJobName: "STRING_VALUE", // required
};
const command = new StopHyperParameterTuningJobCommand(input);
const response = await client.send(command);
// {};

StopHyperParameterTuningJobCommand Input

See StopHyperParameterTuningJobCommandInput for more details

Parameter
Type
Description
HyperParameterTuningJobName
Required
string | undefined

The name of the tuning job to stop.

StopHyperParameterTuningJobCommand Output

See StopHyperParameterTuningJobCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
ResourceNotFound
client

Resource being access is not found.

SageMakerServiceException
Base exception class for all service exceptions from SageMaker service.