[ aws . robomaker ]

create-world-generation-job

Description

Creates worlds using the specified template.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-world-generation-job
[--client-request-token <value>]
--template <value>
--world-count <value>
[--tags <value>]
[--world-tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--client-request-token (string)

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

--template (string)

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

--world-count (structure)

Information about the world count.

floorplanCount -> (integer)

The number of unique floorplans.

interiorCountPerFloorplan -> (integer)

The number of unique interiors per floorplan.

Shorthand Syntax:

floorplanCount=integer,interiorCountPerFloorplan=integer

JSON Syntax:

{
  "floorplanCount": integer,
  "interiorCountPerFloorplan": integer
}

--tags (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--world-tags (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

arn -> (string)

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

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.

createdAt -> (timestamp)

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

failureCode -> (string)

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

clientRequestToken -> (string)

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

template -> (string)

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

worldCount -> (structure)

Information about the world count.

floorplanCount -> (integer)

The number of unique floorplans.

interiorCountPerFloorplan -> (integer)

The number of unique interiors per floorplan.

tags -> (map)

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

key -> (string)

value -> (string)

worldTags -> (map)

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

key -> (string)

value -> (string)