Stay organized with collections
Save and categorize content based on your preferences.
Pauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule
is paused, no new runs will be created. Already created runs will NOT be
paused or canceled.
Arguments
Parameters
name
string
Required. The name of the Schedule resource to be paused. Format: projects/{project}/locations/{location}/schedules/{schedule}
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-29 UTC."],[],[],null,["# Method: googleapis.aiplatform.v1beta1.projects.locations.schedules.pause\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\nPauses a Schedule. Will mark Schedule.state to 'PAUSED'. If the schedule\nis paused, no new runs will be created. Already created runs will NOT be\npaused or canceled.\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/v1beta1/projects.locations.schedules/pause). \n\n### YAML\n\n```yaml\n- pause:\n call: googleapis.aiplatform.v1beta1.projects.locations.schedules.pause\n args:\n name: ...\n region: ...\n result: pauseResult\n```\n\n### JSON\n\n```json\n[\n {\n \"pause\": {\n \"call\": \"googleapis.aiplatform.v1beta1.projects.locations.schedules.pause\",\n \"args\": {\n \"name\": \"...\",\n \"region\": \"...\"\n },\n \"result\": \"pauseResult\"\n }\n }\n]\n```"]]
