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 WorldGenerationJobSummary

Information about a world generator job.

Hierarchy

  • WorldGenerationJobSummary

Properties

arn? createdAt? failedWorldCount? status? succeededWorldCount? template? worldCount?

Properties

Optional arn

arn?: string

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

Optional createdAt

createdAt?: Date

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

Optional failedWorldCount

failedWorldCount?: number

The number of worlds that failed.

Optional status

status?: string

The status of the world generator job:

Pending

The world generator job request is pending.

Running

The world generator job is running.

Completed

The world generator job completed.

Failed

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

PartialFailed

Some worlds did not generate.

Canceled

The world generator job was cancelled.

Canceling

The world generator job is being cancelled.

Optional succeededWorldCount

succeededWorldCount?: number

The number of worlds that were generated.

Optional template

template?: string

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

Optional worldCount

worldCount?: WorldCount

Information about the world count.

Settings

Member Visibility

Theme