Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetWorldTemplateBody

Important

End of support notice: On September 10, 2025, AWS will discontinue support for AWS RoboMaker. After September 10, 2025, you will no longer be able to access the AWS RoboMaker console or AWS RoboMaker resources. For more information on transitioning to AWS Batch to help run containerized simulations, visit this blog post.

Gets the world template body.

Request Syntax


POST /getWorldTemplateBody HTTP/1.1
Content-type: application/json

{
   "generationJob": "string",
   "template": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

generationJob

The Amazon Resource Name (arn) of the world generator job.

Type: String

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

Pattern: arn:.*

Required: No

template

The Amazon Resource Name (arn) of the world template.

Type: String

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

Pattern: arn:.*

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "templateBody": "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.

templateBody

The world template body.

Type: String

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

Pattern: [\S\s]+

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

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 400

ThrottlingException

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

HTTP Status Code: 400