stopHyperParameterTuningJob method

Future<void> stopHyperParameterTuningJob({
  1. required String hyperParameterTuningJobName,
})

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.

May throw ResourceNotFound.

Parameter hyperParameterTuningJobName : The name of the tuning job to stop.

Implementation

Future<void> stopHyperParameterTuningJob({
  required String hyperParameterTuningJobName,
}) async {
  ArgumentError.checkNotNull(
      hyperParameterTuningJobName, 'hyperParameterTuningJobName');
  _s.validateStringLength(
    'hyperParameterTuningJobName',
    hyperParameterTuningJobName,
    1,
    32,
    isRequired: true,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'SageMaker.StopHyperParameterTuningJob'
  };
  await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'HyperParameterTuningJobName': hyperParameterTuningJobName,
    },
  );
}