[ aws . robomaker ]

create-world-export-job

Description

Creates a world export job.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-world-export-job
[--client-request-token <value>]
--worlds <value>
--output-location <value>
--iam-role <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.

--worlds (list)

A list of Amazon Resource Names (arns) that correspond to worlds to export.

(string)

Syntax:

"string" "string" ...

--output-location (structure)

The output location.

s3Bucket -> (string)

The S3 bucket for output.

s3Prefix -> (string)

The S3 folder in the s3Bucket where output files will be placed.

Shorthand Syntax:

s3Bucket=string,s3Prefix=string

JSON Syntax:

{
  "s3Bucket": "string",
  "s3Prefix": "string"
}

--iam-role (string)

The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

--tags (map)

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

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 export job.

status -> (string)

The status of the world export job.

Pending

The world export job request is pending.

Running

The world export job is running.

Completed

The world export job completed.

Failed

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

Canceled

The world export job was cancelled.

Canceling

The world export job is being cancelled.

createdAt -> (timestamp)

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

failureCode -> (string)

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

AllWorldGenerationFailed

All of the worlds in the world generation job failed. This can happen if your worldCount is greater than 50 or less than 1.

For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge .

clientRequestToken -> (string)

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

outputLocation -> (structure)

The output location.

s3Bucket -> (string)

The S3 bucket for output.

s3Prefix -> (string)

The S3 folder in the s3Bucket where output files will be placed.

iamRole -> (string)

The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.

tags -> (map)

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

key -> (string)

value -> (string)