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

# POST /describeWorldExportJob

`POST /describeWorldExportJob`

Describes a world export job.

## Request body

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

## Response `200`

Success

- DescribeWorldExportJobResponse
  - `arn` string — The Amazon Resource Name (ARN) of the world export job.
  - `status` 'Pending' | 'Running' | 'Completed' | 'Failed' | 'Canceling' | 'Canceled' — <p>The status of the world export job.</p> <dl> <dt>Pending</dt> <dd> <p>The world export job request is pending.</p> </dd> <dt>Running</dt> <dd> <p>The world export job is running. </p> </dd> <dt>Completed</dt> <dd> <p>The world export job completed. </p> </dd> <dt>Failed</dt> <dd> <p>The world export job failed. See <code>failureCode</code> and <code>failureReason</code> for more information. </p> </dd> <dt>Canceled</dt> <dd> <p>The world export job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The world export job is being cancelled.</p> </dd> </dl>
  - `createdAt` string, date-time — The time, in milliseconds since the epoch, when the world export job was created.
  - `failureCode` 'InternalServiceError' | 'LimitExceeded' | 'ResourceNotFound' | 'RequestThrottled' | 'InvalidInput' | 'AccessDenied' — <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>
  - `failureReason` string — The reason why the world export job failed.
  - `clientRequestToken` string — Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  - `worlds` Arn[] — A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
  - `outputLocation` OutputLocation — The output location.
    - `s3Bucket` string — The S3 bucket for output.
    - `s3Prefix` string — The S3 folder in the <code>s3Bucket</code> where output files will be placed.
  - `iamRole` string — The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
  - `tags` object — A map that contains tag keys and tag values that are attached to the world export job.

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