Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DescribeWorldGenerationJobResponse

Hierarchy

Index

Properties

Optional arn

arn: undefined | string

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

Optional clientRequestToken

clientRequestToken: undefined | string

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

Optional createdAt

createdAt: Date

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

Optional failureCode

failureCode: WorldGenerationJobErrorCode | string

The failure code of the world generation 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.

Optional failureReason

failureReason: undefined | string

The reason why the world generation job failed.

Optional finishedWorldsSummary

finishedWorldsSummary: FinishedWorldsSummary

Summary information about finished worlds.

Optional status

status: WorldGenerationJobStatus | string

The status of the world generation job:

Pending

The world generation job request is pending.

Running

The world generation job is running.

Completed

The world generation job completed.

Failed

The world generation job failed. See failureCode for more information.

PartialFailed

Some worlds did not generate.

Canceled

The world generation job was cancelled.

Canceling

The world generation job is being cancelled.

Optional tags

tags: Record<string, string>

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

Optional template

template: undefined | string

The Amazon Resource Name (arn) of the world template.

Optional worldCount

worldCount: WorldCount

Information about the world count.

Optional worldTags

worldTags: Record<string, string>

A map that contains tag keys and tag values that are attached to the generated worlds.