Jump to Content

New API Documentation - Developer Preview Available

We are excited to announce the developer preview of our new API documentation for AWS SDK for JavaScript v3. Please follow instructions on the landing page to leave us your feedback.

Interface DescribeWorldExportJobCommandOutputProtected

Hierarchy

Properties

$metadata: ResponseMetadata

Metadata pertaining to this request.

arn?: string

The Amazon Resource Name (ARN) of the world export job.

clientRequestToken?: string

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createdAt?: Date

The time, in milliseconds since the epoch, when the world export job was created.

failureCode?: string

The failure code of the world export job if it failed:

InternalServiceError

Internal service error.

LimitExceeded

The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.

ResourceNotFound

The specified resource could not be found.

RequestThrottled

The request was throttled.

InvalidInput

An input parameter in the request is not valid.

failureReason?: string

The reason why the world export job failed.

iamRole?: string

The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

outputLocation?: OutputLocation

The output location.

status?: string

The status of the world export job.

Pending

The world export job request is pending.

Running

The world export job is running.

Completed

The world export job completed.

Failed

The world export job failed. See failureCode and failureReason for more information.

Canceled

The world export job was cancelled.

Canceling

The world export job is being cancelled.

tags?: Record<string, string>

A map that contains tag keys and tag values that are attached to the world export job.

worlds?: string[]

A list of Amazon Resource Names (arns) that correspond to worlds to be exported.