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

# POST /describeWorldGenerationJob

`POST /describeWorldGenerationJob`

Describes a world generation job.

## Request body

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

## Response `200`

Success

- DescribeWorldGenerationJobResponse
  - `arn` string — The Amazon Resource Name (ARN) of the world generation job.
  - `status` 'Pending' | 'Running' | 'Completed' | 'Failed' | 'PartialFailed' | 'Canceling' | 'Canceled' — <p>The status of the world generation job:</p> <dl> <dt>Pending</dt> <dd> <p>The world generation job request is pending.</p> </dd> <dt>Running</dt> <dd> <p>The world generation job is running. </p> </dd> <dt>Completed</dt> <dd> <p>The world generation job completed. </p> </dd> <dt>Failed</dt> <dd> <p>The world generation 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 generation job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The world generation job is being cancelled.</p> </dd> </dl>
  - `createdAt` string, date-time — The time, in milliseconds since the epoch, when the world generation job was created.
  - `failureCode` 'InternalServiceError' | 'LimitExceeded' | 'ResourceNotFound' | 'RequestThrottled' | 'InvalidInput' | 'AllWorldGenerationFailed' — <p>The failure code of the world generation 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>
  - `failureReason` string — The reason why the world generation job failed.
  - `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.
  - `finishedWorldsSummary` object — Summary information about finished worlds.
    - `finishedCount` integer — The total number of finished worlds.
    - `succeededWorlds` Arn[] — A list of worlds that succeeded.
    - `failureSummary` object — Information about worlds that failed.
      - `totalFailureCount` integer — The total number of failures.
      - `failures` WorldFailure[] — The worlds that failed.
        - `failureCode` 'InternalServiceError' | 'LimitExceeded' | 'ResourceNotFound' | 'RequestThrottled' | 'InvalidInput' | 'AllWorldGenerationFailed' — <p>The failure code of the world export 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>
        - `sampleFailureReason` string — The sample reason why the world failed. World errors are aggregated. A sample is used as the <code>sampleFailureReason</code>.
        - `failureCount` integer — The number of failed worlds.
  - `tags` object — A map that contains tag keys and tag values that are attached to the world generation 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

---

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