---
title: "POST /describeWorld"
method: POST
path: "/describeWorld"
---

# POST /describeWorld

`POST /describeWorld`

Describes a world.

## Request body

- object
  - `world` string, required — The Amazon Resource Name (arn) of the world you want to describe.

## Response `200`

Success

- DescribeWorldResponse
  - `arn` string — The Amazon Resource Name (arn) of the world.
  - `generationJob` string — The Amazon Resource Name (arn) of the world generation job that generated the world.
  - `template` string — The world template.
  - `createdAt` string, date-time — The time, in milliseconds since the epoch, when the world was created.
  - `tags` object — A map that contains tag keys and tag values that are attached to the world.
  - `worldDescriptionBody` string — Returns the JSON formatted string that describes the contents of your world.

## Other responses

- `480` — InvalidParameterException
- `481` — ResourceNotFoundException
- `482` — ThrottlingException
- `483` — InternalServerException

---

[API](https://skmtc.net/aws/apis/robomaker.md) · [All operations](https://skmtc.net/aws/apis/robomaker/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/aws/robomaker/versions/a6f68d7d4866/schema)
