Glue / Client / batch_stop_job_run

batch_stop_job_run

Glue.Client.batch_stop_job_run(**kwargs)

Stops one or more job runs for a specified job definition.

See also: AWS API Documentation

Request Syntax

response = client.batch_stop_job_run(
    JobName='string',
    JobRunIds=[
        'string',
    ]
)

Parameters:

• JobName (string) –

  [REQUIRED]

  The name of the job definition for which to stop job runs.

• JobRunIds (list) –

  [REQUIRED]

  A list of the JobRunIds that should be stopped for that job definition.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'SuccessfulSubmissions': [
        {
            'JobName': 'string',
            'JobRunId': 'string'
        },
    ],
    'Errors': [
        {
            'JobName': 'string',
            'JobRunId': 'string',
            'ErrorDetail': {
                'ErrorCode': 'string',
                'ErrorMessage': 'string'
            }
        },
    ]
}

Response Structure

• (dict) –

  • SuccessfulSubmissions (list) –

    A list of the JobRuns that were successfully submitted for stopping.

    • (dict) –

      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 the JobRunId for which each error was encountered and details about the error.

    • (dict) –

      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 (dict) –

        Specifies details about the error that was encountered.

        • ErrorCode (string) –

          The code associated with this error.

        • ErrorMessage (string) –

          A message describing the error.

Exceptions

• Glue.Client.exceptions.InvalidInputException

• Glue.Client.exceptions.InternalServiceException

• Glue.Client.exceptions.OperationTimeoutException