Stay organized with collections
Save and categorize content based on your preferences.
Cancels a HyperparameterTuningJob. Starts asynchronous cancellation on
the HyperparameterTuningJob. The server makes a best effort to cancel
the job, but success is not guaranteed. Clients can use
JobService.GetHyperparameterTuningJob or other methods to check whether
the cancellation succeeded or whether the job completed despite
cancellation. On successful cancellation, the HyperparameterTuningJob is
not deleted; instead it becomes a job with a
HyperparameterTuningJob.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED, and HyperparameterTuningJob.state is
set to CANCELLED.
Arguments
Parameters
name
string
Required. The name of the HyperparameterTuningJob to cancel. Format: projects/{project}/locations/{location}/hyperparameterTuningJobs/{hyperparameter_tuning_job}
region
string
Required. Region of the HTTP endpoint. For example, if region is set to us-central1, the endpoint https://us-central1-integrations.googleapis.com will be used. See service endpoints.
Raised exceptions
Exceptions
ConnectionError
In case of a network problem (such as DNS failure or refused connection).
HttpError
If the response status is >= 400 (excluding 429 and 503).
TimeoutError
If a long-running operation takes longer to finish than the specified timeout limit.
TypeError
If an operation or function receives an argument of the wrong type.
ValueError
If an operation or function receives an argument of the right type but an inappropriate value. For example, a negative timeout.
Response
If successful, the response will be empty.
Subworkflow snippet
Some fields might be optional or required.
To identify required fields, refer to the API documentation.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-28 UTC."],[],[],null,["# Method: googleapis.aiplatform.v1.projects.locations.hyperparameterTuningJobs.cancel\n\n| **Preview**\n|\n|\n| This feature is subject to the \"Pre-GA Offerings Terms\" in the General Service Terms section\n| of the [Service Specific Terms](/terms/service-terms#1).\n|\n| Pre-GA features are available \"as is\" and might have limited support.\n|\n| For more information, see the\n| [launch stage descriptions](/products#product-launch-stages).\n\nCancels a HyperparameterTuningJob. Starts asynchronous cancellation on\nthe HyperparameterTuningJob. The server makes a best effort to cancel\nthe job, but success is not guaranteed. Clients can use\nJobService.GetHyperparameterTuningJob or other methods to check whether\nthe cancellation succeeded or whether the job completed despite\ncancellation. On successful cancellation, the HyperparameterTuningJob is\nnot deleted; instead it becomes a job with a\nHyperparameterTuningJob.error value with a google.rpc.Status.code of 1,\ncorresponding to `Code.CANCELLED`, and HyperparameterTuningJob.state is\nset to `CANCELLED`.\n\nArguments\n---------\n\nRaised exceptions\n-----------------\n\nResponse\n--------\n\nIf successful, the response will be empty.\n\nSubworkflow snippet\n-------------------\n\nSome fields might be optional or required.\nTo identify required fields, refer to the [API documentation](https://cloud.google.com/vertex-ai/docs/reference/rest/v1/projects.locations.hyperparameterTuningJobs/cancel). \n\n### YAML\n\n```yaml\n- cancel:\n call: googleapis.aiplatform.v1.projects.locations.hyperparameterTuningJobs.cancel\n args:\n name: ...\n region: ...\n result: cancelResult\n```\n\n### JSON\n\n```json\n[\n {\n \"cancel\": {\n \"call\": \"googleapis.aiplatform.v1.projects.locations.hyperparameterTuningJobs.cancel\",\n \"args\": {\n \"name\": \"...\",\n \"region\": \"...\"\n },\n \"result\": \"cancelResult\"\n }\n }\n]\n```"]]