Stops one or more job runs for a specified job definition.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
batch-stop-job-run
--job-name <value>
--job-run-ids <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
--job-name
(string)
The name of the job definition for which to stop job runs.
--job-run-ids
(list)
A list of the
JobRunIds
that should be stopped for that job definition.(string)
Syntax:
"string" "string" ...
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt
(boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
SuccessfulSubmissions -> (list)
A list of the JobRuns that were successfully submitted for stopping.
(structure)
Records a successful request to stop a specified
JobRun
.JobName -> (string)
The name of the job definition used in the job run that was stopped.
JobRunId -> (string)
The
JobRunId
of the job run that was stopped.
Errors -> (list)
A list of the errors that were encountered in trying to stop
JobRuns
, including theJobRunId
for which each error was encountered and details about the error.(structure)
Records an error that occurred when attempting to stop a specified job run.
JobName -> (string)
The name of the job definition that is used in the job run in question.
JobRunId -> (string)
The
JobRunId
of the job run in question.ErrorDetail -> (structure)
Specifies details about the error that was encountered.
ErrorCode -> (string)
The code associated with this error.
ErrorMessage -> (string)
A message describing the error.