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

DescribeWorld

Describes a world.

Request Syntax


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

{
   "world": "string"
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

world

The Amazon Resource Name (arn) of the world you want to describe.

Type: String

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

Pattern: arn:.*

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "createdAt": number,
   "generationJob": "string",
   "tags": { 
      "string" : "string" 
   },
   "template": "string",
   "worldDescriptionBody": "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.

arn

The Amazon Resource Name (arn) of the world.

Type: String

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

Pattern: arn:.*

createdAt

The time, in milliseconds since the epoch, when the world was created.

Type: Timestamp

generationJob

The Amazon Resource Name (arn) of the world generation job that generated the world.

Type: String

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

Pattern: arn:.*

tags

A map that contains tag keys and tag values that are attached to the world.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Key Pattern: [a-zA-Z0-9 _.\-\/+=:]*

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Value Pattern: [a-zA-Z0-9 _.\-\/+=:]*

template

The world template.

Type: String

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

Pattern: arn:.*

worldDescriptionBody

Returns the JSON formatted string that describes the contents of your world.

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