DeleteHyperParameterTuningJobCommand

Suggest an Edit

Deletes a hyperparameter tuning job. The DeleteHyperParameterTuningJob API deletes only the tuning job entry that was created in SageMaker when you called the CreateHyperParameterTuningJob API. It does not delete training jobs, artifacts, or the IAM role that you specified when creating the model.

Example Syntax

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

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

DeleteHyperParameterTuningJobCommand Input

See DeleteHyperParameterTuningJobCommandInput for more details

Parameter
Type
Description
HyperParameterTuningJobName
Required
string | undefined

The name of the hyperparameter tuning job that you want to delete.

DeleteHyperParameterTuningJobCommand Output

See DeleteHyperParameterTuningJobCommandOutput for details

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

Throws

Name
Fault
Details
SageMakerServiceException
Base exception class for all service exceptions from SageMaker service.