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

# POST /listWorldGenerationJobs

`POST /listWorldGenerationJobs`

Lists world generator jobs.

## 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>ListWorldGenerationJobsRequest</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>ListWorldGeneratorJobs</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>ListWorldGeneratorJobs</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>ListWorldGeneratorJobs</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> and <code>templateId</code>.
    - `name` string — The name of the filter.
    - `values` Name[] — A list of values.

## Response `200`

Success

- ListWorldGenerationJobsResponse
  - `worldGenerationJobSummaries` WorldGenerationJobSummary[], required — Summary information for world generator jobs.
    - `arn` string — The Amazon Resource Name (ARN) of the world generator job.
    - `template` string — The Amazon Resource Name (arn) of the world template.
    - `createdAt` string, date-time — The time, in milliseconds since the epoch, when the world generator job was created.
    - `status` 'Pending' | 'Running' | 'Completed' | 'Failed' | 'PartialFailed' | 'Canceling' | 'Canceled' — <p>The status of the world generator job:</p> <dl> <dt>Pending</dt> <dd> <p>The world generator job request is pending.</p> </dd> <dt>Running</dt> <dd> <p>The world generator job is running. </p> </dd> <dt>Completed</dt> <dd> <p>The world generator job completed. </p> </dd> <dt>Failed</dt> <dd> <p>The world generator job failed. See <code>failureCode</code> for more information. </p> </dd> <dt>PartialFailed</dt> <dd> <p>Some worlds did not generate.</p> </dd> <dt>Canceled</dt> <dd> <p>The world generator job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The world generator job is being cancelled.</p> </dd> </dl>
    - `worldCount` object — Information about the world count.
      - `floorplanCount` integer — The number of unique floorplans.
      - `interiorCountPerFloorplan` integer — The number of unique interiors per floorplan.
    - `succeededWorldCount` integer — The number of worlds that were generated.
    - `failedWorldCount` integer — The number of worlds that failed.
  - `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>ListWorldGeneratorJobsRequest</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` — InternalServerException
- `482` — ThrottlingException

---

[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)