BatchDeleteWorlds - AWS RoboMaker

AWS RoboMaker is no longer available to new customers. Existing customers of AWS RoboMaker can continue to use the service as normal. AWS Batch is now the preferred service to run containerized simulations. Learn more.

BatchDeleteWorlds

Deletes one or more worlds in a batch operation.

Request Syntax

POST /batchDeleteWorlds HTTP/1.1 Content-type: application/json { "worlds": [ "string" ] }

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

worlds

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 1224.

Pattern: arn:.*

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "unprocessedWorlds": [ "string" ] }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

unprocessedWorlds

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

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 1224.

Pattern: arn:.*

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServerException

AWS RoboMaker experienced a service issue. Try your call again.

HTTP Status Code: 500

InvalidParameterException

A parameter specified in a request is not valid, is unsupported, or cannot be used. The returned message provides an explanation of the error value.

HTTP Status Code: 400

ThrottlingException

AWS RoboMaker is temporarily unable to process the request. Try your call again.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: