Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1457289301.4 KB

Creates worlds using the specified template.

post/createWorldGenerationJob

Request body

clientRequestTokenstring

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

templatestring required

The Amazon Resource Name (arn) of the world template describing the worlds you want to create.

tagsobject

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

worldTagsobject

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

Response

Success

arnstring

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

status'Pending' | 'Running' | 'Completed' | 'Failed' | 'PartialFailed' | 'Canceling' | 'Canceled'
<p>The status of the world generator job.</p> <dl> <dt>Pending</dt> <dd> <p>The world generator job request is pending.</p> </dd> <dt>Running</dt> <dd> <p>The world generator job is running. </p> </dd> <dt>Completed</dt> <dd> <p>The world generator job completed. </p> </dd> <dt>Failed</dt> <dd> <p>The world generator job failed. See <code>failureCode</code> for more information. </p> </dd> <dt>PartialFailed</dt> <dd> <p>Some worlds did not generate.</p> </dd> <dt>Canceled</dt> <dd> <p>The world generator job was cancelled.</p> </dd> <dt>Canceling</dt> <dd> <p>The world generator job is being cancelled.</p> </dd> </dl>
createdAtstring date-time

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

failureCode'InternalServiceError' | 'LimitExceeded' | 'ResourceNotFound' | 'RequestThrottled' | 'InvalidInput' | 'AllWorldGenerationFailed'
<p>The failure code of the world generator 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>
clientRequestTokenstring

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

templatestring

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

tagsobject

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

worldTagsobject

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