DescribeWorldGenerationJobResponse

import type { DescribeWorldGenerationJobResponse } from "https://aws-api.deno.dev/v0.4/services/robomaker.ts?docs=full";

interface DescribeWorldGenerationJobResponse {

arn?: string | null;

clientRequestToken?: string | null;

createdAt?: Date | number | null;

failureCode?: WorldGenerationJobErrorCode | null;

failureReason?: string | null;

finishedWorldsSummary?: FinishedWorldsSummary | null;

status?: WorldGenerationJobStatus | null;

tags?: {

[key: string]: string | null | undefined;

} | null;

template?: string | null;

worldCount?: WorldCount | null;

worldTags?: {

[key: string]: string | null | undefined;

} | null;

}

§Properties

arn?: string | null

[src]

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

clientRequestToken?: string | null

[src]

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

createdAt?: Date | number | null

[src]

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

failureCode?: WorldGenerationJobErrorCode | null

[src]

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.

failureReason?: string | null

[src]

The reason why the world generation job failed.

finishedWorldsSummary?: FinishedWorldsSummary | null

[src]

Summary information about finished worlds.

status?: WorldGenerationJobStatus | null

[src]

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.

tags?: {

[key: string]: string | null | undefined;

} | null

[src]

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

template?: string | null

[src]

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

worldCount?: WorldCount | null

[src]

Information about the world count.

worldTags?: {

[key: string]: string | null | undefined;

} | null

[src]

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