RoboMaker / Client / batch_delete_worlds

batch_delete_worlds#

RoboMaker.Client.batch_delete_worlds(**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/.

Deletes one or more worlds in a batch operation.

See also: AWS API Documentation

Request Syntax

response = client.batch_delete_worlds(
    worlds=[
        'string',
    ]
)
Parameters:

worlds (list) –

[REQUIRED]

A list of Amazon Resource Names (arns) that correspond to worlds to delete.

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'unprocessedWorlds': [
        'string',
    ]
}

Response Structure

  • (dict) –

    • unprocessedWorlds (list) –

      A list of unprocessed worlds associated with the call. These worlds were not deleted.

      • (string) –

Exceptions

  • RoboMaker.Client.exceptions.InvalidParameterException

  • RoboMaker.Client.exceptions.ThrottlingException

  • RoboMaker.Client.exceptions.InternalServerException