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

# POST /listWorlds

`POST /listWorlds`

Lists worlds.

## Query parameters

- `maxResults` string
- `nextToken` string

## Request body

- object
  - `nextToken` string — If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListWorlds</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
  - `maxResults` integer — When this parameter is used, <code>ListWorlds</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListWorlds</code> request with the returned <code>nextToken</code> value. This value can be between 1 and 100. If this parameter is not used, then <code>ListWorlds</code> returns up to 100 results and a <code>nextToken</code> value if applicable.
  - `filters` Filter[] — Optional filters to limit results. You can use <code>status</code>.
    - `name` string — The name of the filter.
    - `values` Name[] — A list of values.

## Response `200`

Success

- ListWorldsResponse
  - `worldSummaries` WorldSummary[] — Summary information for worlds.
    - `arn` string — The Amazon Resource Name (ARN) of the world.
    - `createdAt` string, date-time — The time, in milliseconds since the epoch, when the world was created.
    - `generationJob` string — The Amazon Resource Name (arn) of the world generation job.
    - `template` string — The Amazon Resource Name (arn) of the world template.
  - `nextToken` string — If the previous paginated request did not return all of the remaining results, the response object's <code>nextToken</code> parameter value is set to a token. To retrieve the next set of results, call <code>ListWorlds</code> again and assign that token to the request object's <code>nextToken</code> parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

## Other responses

- `480` — InvalidParameterException
- `481` — ThrottlingException
- `482` — 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/revisions/a6f68d7d4866/schema)