[ aws . robomaker ]

create-world-template

Description

Creates a world template.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-world-template
[--client-request-token <value>]
[--name <value>]
[--template-body <value>]
[--template-location <value>]
[--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.

--name (string)

The name of the world template.

--template-body (string)

The world template body.

--template-location (structure)

The location of the world template.

s3Bucket -> (string)

The Amazon S3 bucket name.

s3Key -> (string)

The list of S3 keys identifying the data source files.

Shorthand Syntax:

s3Bucket=string,s3Key=string

JSON Syntax:

{
  "s3Bucket": "string",
  "s3Key": "string"
}

--tags (map)

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

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 template.

clientRequestToken -> (string)

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

createdAt -> (timestamp)

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

name -> (string)

The name of the world template.

tags -> (map)

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

key -> (string)

value -> (string)