`job run pause`

Important: IBM Cloud Pak® for Data Version 4.6 will reach end of support (EOS) on 31 July, 2025. For more information, see the Discontinuance of service announcement for IBM Cloud Pak for Data Version 4.X.

Upgrade to IBM Software Hub Version 5.1 before IBM Cloud Pak for Data Version 4.6 reaches end of support. For more information, see Upgrading IBM Software Hub in the IBM Software Hub Version 5.1 documentation.

Pause a running job run.

Syntax

cpd-cli job run pause \
--body=<empty-body> \
[--context=<catalog-project-or-space-id>] \
[--cpd-config=<cpd-config-location>] \
[--cpd-scope=<cpd-config-location>] \
[--jmes-query=<jmespath-query>] \
--job-id=<job-id> \
[--output=json|yaml|table] \
[--output-file=<output-file-location>] \
--profile=<cpd-configuration-profile-name> \
[--project-id=<cpd-project-id>] \
[--quiet] \
[--raw-output=true|false] \
--run-id=<job-run-id> \
[--space-id=<space-identifier>] \
[--verbose]

Arguments

The job run pause command has no arguments.

Options

Option	Description
`--body`	Specify an empty body. Status Required. Syntax `--body=<empty-body>` Default value No default. Valid values An empty body.
`--context`	Specify the configuration context  name. Status Optional. Syntax `--context=<catalog-project-or-space-id>` Default value Not applicable. Valid values A valid configuration context name.
`--cpd-config`	The Cloud Pak for Data configuration location (for example, $HOME/.cpd-cli/config). Status Required. Syntax `--cpd-config=<cpd-config-location>` Default value No default. Valid values A valid Cloud Pak for Data configuration location.
`--cpd-scope`	The Cloud Pak for Data space, project, or catalog scope (for example, cpd://default-context/spaces/7bccdda4-9752-4f37-868e-891de6c48135). Status Optional. Syntax `--cpd-scope=<cpd-config-location>` Default value No default. Valid values A valid Cloud Pak for Data space, project, or catalog scope.
`--help` `-h`	Display command help. Status Optional. Syntax `--help` Default value No default. Valid values Not applicable.
`--jmes-query`	Provide a JMESPath query to customize the output. Status Optional. Syntax `--jmes-query=<jmespath-query>` Default value No default. Valid values A valid JMESPath query.
`--job-id`	Specify the job ID. Each job has a unique ID. Alternatively, the serving_name value can be used. Status Required. Syntax `--job-id=<job-id>` Default value No default. Valid values A valid job ID.
`--output`	Specify an output format. Valid formats include json, yaml, or text (the default format). Status Optional. Syntax `--output=json\|yaml\|text` Default value `text` Valid values `json\|yaml\|text`
`--output-file`	Specify a file path where all output is redirected. Status Required. Syntax `--output-file=<output-file-location>` Default value No default. Valid values A valid output file path location.
`--profile`	The profile-name from the Cloud Pak for Data configuration. Status Required. Syntax `--profile=<cpd-configuration-profile-name>` Default value default Valid values Any valid profile name from the Cloud Pak for Data configuration.
`--project-id`	Specify a Cloud Pak for Data project instance. Status Required. Syntax `--project-id=<cpd-project-id>` Default value No default. Valid values A valid project identifier.
`--quiet`	Suppress verbose messages. Status Optional. Syntax `--quiet` Default value No default. Valid values Not applicable.
`--raw-output`	When set to true, single values in  JSON output mode are not surrounded by quotes. Status Optional. Syntax `--raw-output=true\|false` Default value `false` Valid values `false` Single values in JSON output mode are surrounded by quotes. `true` Single values in JSON output mode are not surrounded by quotes.
`--run-id`	Specify a job run ID. The job run ID can be used to search the parent job of a job run. Status Required. Syntax `--run-id=<job-run-id>` Default value No default. Valid values A valid job run ID.
`--space-id`	Specify a space identifier. Status Required. Syntax `--space-id=<space-identifier>` Default value No default. Valid values A valid space identifier.
`--verbose`	Logs include more detailed messages. Status Optional. Syntax `--verbose` Default value No default. Valid values Not applicable.