RoboMaker / Client / cancel_simulation_job_batch

cancel_simulation_job_batch#

RoboMaker.Client.cancel_simulation_job_batch(**kwargs)#

Warning

End of support notice: On September 10, 2025, Amazon Web Services will discontinue support for Amazon Web Services RoboMaker. After September 10, 2025, you will no longer be able to access the Amazon Web Services RoboMaker console or Amazon Web Services RoboMaker resources. For more information on transitioning to Batch to help run containerized simulations, visit https://aws.amazon.com/blogs/hpc/run-simulations-using-multiple-containers-in-a-single-aws-batch-job/.

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.

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