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

# POST /createWorldGenerationJob

`POST /createWorldGenerationJob`

Creates worlds using the specified template.

## Request body

- object
  - `clientRequestToken` string — Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - `template` string, required — The Amazon Resource Name (arn) of the world template describing the worlds you want to create.
  - `worldCount` object, required — <p>The number of worlds that will be created. You can configure the number of unique floorplans and the number of unique interiors for each floor plan. For example, if you want 1 world with 20 unique interiors, you set <code>floorplanCount = 1</code> and <code>interiorCountPerFloorplan = 20</code>. This will result in 20 worlds (<code>floorplanCount</code> * <code>interiorCountPerFloorplan)</code>. </p> <p>If you set <code>floorplanCount = 4</code> and <code>interiorCountPerFloorplan = 5</code>, there will be 20 worlds with 5 unique floor plans. </p>
    - `floorplanCount` integer — The number of unique floorplans.
    - `interiorCountPerFloorplan` integer — The number of unique interiors per floorplan.
  - `tags` object — A map that contains tag keys and tag values that are attached to the world generator job.
  - `worldTags` object — A map that contains tag keys and tag values that are attached to the generated worlds.

## Response `200`

Success

- CreateWorldGenerationJobResponse
  - `arn` string — The Amazon Resource Name (ARN) of the world generator job.
  - `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>
  - `createdAt` string, date-time — The time, in milliseconds since the epoch, when the world generator job was created.
  - `failureCode` 'InternalServiceError' | 'LimitExceeded' | 'ResourceNotFound' | 'RequestThrottled' | 'InvalidInput' | 'AllWorldGenerationFailed' — <p>The failure code of the world generator job if it failed:</p> <dl> <dt>InternalServiceError</dt> <dd> <p>Internal service error.</p> </dd> <dt>LimitExceeded</dt> <dd> <p>The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed. </p> </dd> <dt>ResourceNotFound</dt> <dd> <p>The specified resource could not be found. </p> </dd> <dt>RequestThrottled</dt> <dd> <p>The request was throttled.</p> </dd> <dt>InvalidInput</dt> <dd> <p>An input parameter in the request is not valid.</p> </dd> </dl>
  - `clientRequestToken` string — Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - `template` string — The Amazon Resource Name (arn) of the world template.
  - `worldCount` object — Information about the world count.
    - `floorplanCount` integer — The number of unique floorplans.
    - `interiorCountPerFloorplan` integer — The number of unique interiors per floorplan.
  - `tags` object — A map that contains tag keys and tag values that are attached to the world generator job.
  - `worldTags` object — A map that contains tag keys and tag values that are attached to the generated worlds.

## Other responses

- `480` — ResourceNotFoundException
- `481` — InvalidParameterException
- `482` — InternalServerException
- `483` — ThrottlingException
- `484` — LimitExceededException
- `485` — IdempotentParameterMismatchException
- `486` — ServiceUnavailableException

---

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