[ aws . robomaker ]



Describes a world export job.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.


--job <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]


--job (string)

The Amazon Resource Name (arn) of the world export job to describe.

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

See ‘aws help’ for descriptions of global parameters.


arn -> (string)

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

status -> (string)

The status of the world export job.


The world export job request is pending.


The world export job is running.


The world export job completed.


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


The world export job was cancelled.


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:


Internal service error.


The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.


The specified resource could not be found.


The request was throttled.


An input parameter in the request is not valid.

failureReason -> (string)

The reason why the world export job failed.

clientRequestToken -> (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 be exported.


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)