cancel_simulation_job_batch

RoboMaker.Client.cancel_simulation_job_batch(**kwargs)

Cancels a simulation job batch. When you cancel a simulation job batch, you are also cancelling all of the active simulation jobs created as part of the batch.

See also: AWS API Documentation

Request Syntax

response = client.cancel_simulation_job_batch(
    batch='string'
)
Parameters
batch (string) --

[REQUIRED]

The id of the batch to cancel.

Return type
dict
Returns
Response Syntax
{}

Response Structure

  • (dict) --

Exceptions

  • RoboMaker.Client.exceptions.ResourceNotFoundException
  • RoboMaker.Client.exceptions.InvalidParameterException
  • RoboMaker.Client.exceptions.InternalServerException
  • RoboMaker.Client.exceptions.ThrottlingException