Skip to content
AWS for Query.Farm

aws.robomaker.describe_simulation_job_batch

Example SQL Queries

SELECT * FROM
aws.robomaker.describe_simulation_job_batch
WHERE
"batch" = 'VALUE';

Description

Describes a simulation job batch.

Table Definition

Column NameColumn Data Type
batch Required Input Column

The id of the batch to describe.

VARCHAR
_aws_profile Input Column

The AWS profile defines the AWS identity used. It can be defined via credentials or by assuming a IAM role.

STRUCT(
    "type" VARCHAR,
    "name" VARCHAR,
    "account_id" VARCHAR,
    "via_profile_name" VARCHAR,
    "assumed_role_arn" VARCHAR,
    "organization" STRUCT(
        "account_name" VARCHAR,
        "id" VARCHAR,
        "tags" STRUCT(
            "key" VARCHAR,
            "value" VARCHAR
        )[],
        "master_account" STRUCT(
            "id" VARCHAR,
            "email" VARCHAR
        ),
        "parents" STRUCT(
            "type" VARCHAR,
            "id" VARCHAR,
            "name" VARCHAR,
            "tags" STRUCT(
                "key" VARCHAR,
                "value" VARCHAR
            )[]
        )[]
    )
)
Show child fields
_aws_profile.account_id

The AWS account id

_aws_profile.assumed_role_arn

The ARN of the assumed role

_aws_profile.name

The unique name of the profile.

_aws_profile.organization

Information about this profile's membership in the AWS organization.

Show child fields
_aws_profile.organization.account_name

The name of account speciifed by the organization

_aws_profile.organization.id

The organization id

_aws_profile.organization.master_account
Show child fields
_aws_profile.organization.master_account.email

The organization master account email address

_aws_profile.organization.master_account.id

The organization master account id

_aws_profile.organization.parents[]
Show child fields
_aws_profile.organization.parents[].id

The id of the parent

_aws_profile.organization.parents[].name

The name of the parent

_aws_profile.organization.parents[].tags[]
Show child fields
_aws_profile.organization.parents[].tags[].key
_aws_profile.organization.parents[].tags[].value
_aws_profile.organization.parents[].type

The type of parent can be an organization unit or a root

_aws_profile.organization.tags[]
Show child fields
_aws_profile.organization.tags[].key
_aws_profile.organization.tags[].value
_aws_profile.type

The type of profile, either 'credentials' or 'assumed_role'

_aws_profile.via_profile_name

This IAM role for this profile is assumed by first utilizing another profile with this name to obtain credentials.

_aws_region Input Column

The AWS region to use.

VARCHAR
arn

The Amazon Resource Name (ARN) of the batch.

VARCHAR
batch_policy

The batch policy.

STRUCT(
    "timeout_in_seconds" BIGINT,
    "max_concurrency" BIGINT
)
Show child fields
batch_policy.max_concurrency

The number of active simulation jobs create as part of the batch that can be in an active state at the same time.

Active states include: Pending,Preparing, Running, Restarting, RunningFailed and Terminating. All other states are terminal states.

batch_policy.timeout_in_seconds

The amount of time, in seconds, to wait for the batch to complete.

If a batch times out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), they will be moved to the failed list and the batch status will be Failed. If the pending requests were failing for any other reason, the failed pending requests will be moved to the failed list and the batch status will be TimedOut.

client_request_token

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

VARCHAR
created_at

The time, in milliseconds since the epoch, when the simulation job batch was created.

TIMESTAMP_S
created_requests

A list of created simulation job summaries.

STRUCT(
    "arn" VARCHAR,
    "last_updated_at" TIMESTAMP_S,
    "name" VARCHAR,
    "status" VARCHAR,
    "simulation_application_names" VARCHAR[],
    "robot_application_names" VARCHAR[],
    "data_source_names" VARCHAR[],
    "compute_type" VARCHAR
)[]
Show child fields
created_requests[]
Show child fields
created_requests[].arn

The Amazon Resource Name (ARN) of the simulation job.

created_requests[].compute_type

The compute type for the simulation job summary.

created_requests[].data_source_names[]
created_requests[].last_updated_at

The time, in milliseconds since the epoch, when the simulation job was last updated.

created_requests[].name

The name of the simulation job.

created_requests[].robot_application_names[]
created_requests[].simulation_application_names[]
created_requests[].status

The status of the simulation job.

failed_requests

A list of failed create simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID. 

STRUCT(
    "request" STRUCT(
        "output_location" STRUCT(
            "s3_bucket" VARCHAR,
            "s3_prefix" VARCHAR
        ),
        "logging_config" STRUCT(
            "record_all_ros_topics" BOOLEAN
        ),
        "max_job_duration_in_seconds" BIGINT,
        "iam_role" VARCHAR,
        "failure_behavior" VARCHAR,
        "use_default_applications" BOOLEAN,
        "robot_applications" STRUCT(
            "application" VARCHAR,
            "application_version" VARCHAR,
            "launch_config" STRUCT(
                "package_name" VARCHAR,
                "launch_file" VARCHAR,
                "environment_variables" MAP(VARCHAR, VARCHAR),
                "port_forwarding_config" STRUCT(
                    "port_mappings" STRUCT(
                        "job_port" BIGINT,
                        "application_port" BIGINT,
                        "enable_on_public_ip" BOOLEAN
                    )[]
                ),
                "stream_ui" BOOLEAN,
                "command" VARCHAR[]
            ),
            "upload_configurations" STRUCT(
                "name" VARCHAR,
                "path" VARCHAR,
                "upload_behavior" VARCHAR
            )[],
            "use_default_upload_configurations" BOOLEAN,
            "tools" STRUCT(
                "stream_ui" BOOLEAN,
                "name" VARCHAR,
                "command" VARCHAR,
                "stream_output_to_cloud_watch" BOOLEAN,
                "exit_behavior" VARCHAR
            )[],
            "use_default_tools" BOOLEAN
        )[],
        "simulation_applications" STRUCT(
            "application" VARCHAR,
            "application_version" VARCHAR,
            "launch_config" STRUCT(
                "package_name" VARCHAR,
                "launch_file" VARCHAR,
                "environment_variables" MAP(VARCHAR, VARCHAR),
                "port_forwarding_config" STRUCT(
                    "port_mappings" STRUCT(
                        "job_port" BIGINT,
                        "application_port" BIGINT,
                        "enable_on_public_ip" BOOLEAN
                    )[]
                ),
                "stream_ui" BOOLEAN,
                "command" VARCHAR[]
            ),
            "upload_configurations" STRUCT(
                "name" VARCHAR,
                "path" VARCHAR,
                "upload_behavior" VARCHAR
            )[],
            "world_configs" STRUCT(
                "world" VARCHAR
            )[],
            "use_default_upload_configurations" BOOLEAN,
            "tools" STRUCT(
                "stream_ui" BOOLEAN,
                "name" VARCHAR,
                "command" VARCHAR,
                "stream_output_to_cloud_watch" BOOLEAN,
                "exit_behavior" VARCHAR
            )[],
            "use_default_tools" BOOLEAN
        )[],
        "data_sources" STRUCT(
            "name" VARCHAR,
            "s3_bucket" VARCHAR,
            "s3_keys" VARCHAR[],
            "type" VARCHAR,
            "destination" VARCHAR
        )[],
        "vpc_config" STRUCT(
            "subnets" VARCHAR[],
            "security_groups" VARCHAR[],
            "assign_public_ip" BOOLEAN
        ),
        "compute" STRUCT(
            "simulation_unit_limit" BIGINT,
            "compute_type" VARCHAR,
            "gpu_unit_limit" BIGINT
        ),
        "tags" MAP(VARCHAR, VARCHAR)
    ),
    "failure_reason" VARCHAR,
    "failure_code" VARCHAR,
    "failed_at" TIMESTAMP_S
)[]
Show child fields
failed_requests[]
Show child fields
failed_requests[].failed_at

The time, in milliseconds since the epoch, when the simulation job batch failed.

failed_requests[].failure_code

The failure code.

failed_requests[].failure_reason

The failure reason of the simulation job request.

failed_requests[].request

The simulation job request.

Show child fields
failed_requests[].request.compute

Compute information for the simulation job

Show child fields
failed_requests[].request.compute.compute_type

Compute type information for the simulation job.

failed_requests[].request.compute.gpu_unit_limit

Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.

failed_requests[].request.compute.simulation_unit_limit

The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximum value provided. The default is 15.

failed_requests[].request.data_sources[]
Show child fields
failed_requests[].request.data_sources[].destination

The location where your files are mounted in the container image.

If you've specified the type of the data source as an Archive, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip or .tar.gz file.

If you've specified the type of the data source as a Prefix, you provide the Amazon S3 prefix that points to the files that you are using for your data source.

If you've specified the type of the data source as a File, you provide the Amazon S3 path to the file that you're using as your data source.

failed_requests[].request.data_sources[].name

The name of the data source.

failed_requests[].request.data_sources[].s3_bucket

The S3 bucket where the data files are located.

failed_requests[].request.data_sources[].s3_keys[]
failed_requests[].request.data_sources[].type

The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.

If you don't specify a field, the default value is File.

failed_requests[].request.failure_behavior

The failure behavior the simulation job.

Continue

Leaves the host running for its maximum timeout duration after a 4XX error code.

Fail

Stop the simulation job and terminate the instance.

failed_requests[].request.iam_role

The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

failed_requests[].request.logging_config

The logging configuration.

Show child fields
failed_requests[].request.logging_config.record_all_ros_topics

A boolean indicating whether to record all ROS topics.

This API is no longer supported and will throw an error if used.

failed_requests[].request.max_job_duration_in_seconds

The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

failed_requests[].request.output_location

The output location.

Show child fields
failed_requests[].request.output_location.s3_bucket

The S3 bucket for output.

failed_requests[].request.output_location.s3_prefix

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

failed_requests[].request.robot_applications[]
Show child fields
failed_requests[].request.robot_applications[].application

The application information for the robot application.

failed_requests[].request.robot_applications[].application_version

The version of the robot application.

failed_requests[].request.robot_applications[].launch_config

The launch configuration for the robot application.

Show child fields
failed_requests[].request.robot_applications[].launch_config.command[]
failed_requests[].request.robot_applications[].launch_config.environment_variables

The environment variables for the application launch.

failed_requests[].request.robot_applications[].launch_config.launch_file

The launch file name.

failed_requests[].request.robot_applications[].launch_config.package_name

The package name.

failed_requests[].request.robot_applications[].launch_config.port_forwarding_config

The port forwarding configuration.

Show child fields
failed_requests[].request.robot_applications[].launch_config.port_forwarding_config.port_mappings[]
Show child fields
failed_requests[].request.robot_applications[].launch_config.port_forwarding_config.port_mappings[].application_port

The port number on the application.

failed_requests[].request.robot_applications[].launch_config.port_forwarding_config.port_mappings[].enable_on_public_ip

A Boolean indicating whether to enable this port mapping on public IP.

failed_requests[].request.robot_applications[].launch_config.port_forwarding_config.port_mappings[].job_port

The port number on the simulation job instance to use as a remote connection point.

failed_requests[].request.robot_applications[].launch_config.stream_ui

Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.

failed_requests[].request.robot_applications[].tools[]
Show child fields
failed_requests[].request.robot_applications[].tools[].command

Command-line arguments for the tool. It must include the tool executable name.

failed_requests[].request.robot_applications[].tools[].exit_behavior

Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

failed_requests[].request.robot_applications[].tools[].name

The name of the tool.

failed_requests[].request.robot_applications[].tools[].stream_output_to_cloud_watch

Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

failed_requests[].request.robot_applications[].tools[].stream_ui

Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

failed_requests[].request.robot_applications[].upload_configurations[]
Show child fields
failed_requests[].request.robot_applications[].upload_configurations[].name

A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.

For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

failed_requests[].request.robot_applications[].upload_configurations[].path

Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

failed_requests[].request.robot_applications[].upload_configurations[].upload_behavior

Specifies when to upload the files:

UPLOAD_ON_TERMINATE

Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

UPLOAD_ROLLING_AUTO_REMOVE

Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.

failed_requests[].request.robot_applications[].use_default_tools

A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

This API is no longer supported and will throw an error if used.

failed_requests[].request.robot_applications[].use_default_upload_configurations

A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

If you set this value, you must specify an outputLocation.

This API is no longer supported and will throw an error if used.

failed_requests[].request.simulation_applications[]
Show child fields
failed_requests[].request.simulation_applications[].application

The application information for the simulation application.

failed_requests[].request.simulation_applications[].application_version

The version of the simulation application.

failed_requests[].request.simulation_applications[].launch_config

The launch configuration for the simulation application.

Show child fields
failed_requests[].request.simulation_applications[].launch_config.command[]
failed_requests[].request.simulation_applications[].launch_config.environment_variables

The environment variables for the application launch.

failed_requests[].request.simulation_applications[].launch_config.launch_file

The launch file name.

failed_requests[].request.simulation_applications[].launch_config.package_name

The package name.

failed_requests[].request.simulation_applications[].launch_config.port_forwarding_config

The port forwarding configuration.

Show child fields
failed_requests[].request.simulation_applications[].launch_config.port_forwarding_config.port_mappings[]
Show child fields
failed_requests[].request.simulation_applications[].launch_config.port_forwarding_config.port_mappings[].application_port

The port number on the application.

failed_requests[].request.simulation_applications[].launch_config.port_forwarding_config.port_mappings[].enable_on_public_ip

A Boolean indicating whether to enable this port mapping on public IP.

failed_requests[].request.simulation_applications[].launch_config.port_forwarding_config.port_mappings[].job_port

The port number on the simulation job instance to use as a remote connection point.

failed_requests[].request.simulation_applications[].launch_config.stream_ui

Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.

failed_requests[].request.simulation_applications[].tools[]
Show child fields
failed_requests[].request.simulation_applications[].tools[].command

Command-line arguments for the tool. It must include the tool executable name.

failed_requests[].request.simulation_applications[].tools[].exit_behavior

Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

failed_requests[].request.simulation_applications[].tools[].name

The name of the tool.

failed_requests[].request.simulation_applications[].tools[].stream_output_to_cloud_watch

Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

failed_requests[].request.simulation_applications[].tools[].stream_ui

Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

failed_requests[].request.simulation_applications[].upload_configurations[]
Show child fields
failed_requests[].request.simulation_applications[].upload_configurations[].name

A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.

For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

failed_requests[].request.simulation_applications[].upload_configurations[].path

Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

failed_requests[].request.simulation_applications[].upload_configurations[].upload_behavior

Specifies when to upload the files:

UPLOAD_ON_TERMINATE

Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

UPLOAD_ROLLING_AUTO_REMOVE

Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.

failed_requests[].request.simulation_applications[].use_default_tools

A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

This API is no longer supported and will throw an error if used.

failed_requests[].request.simulation_applications[].use_default_upload_configurations

A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

If you set this value, you must specify an outputLocation.

This API is no longer supported and will throw an error if used.

failed_requests[].request.simulation_applications[].world_configs[]
Show child fields
failed_requests[].request.simulation_applications[].world_configs[].world

The world generated by Simulation WorldForge.

failed_requests[].request.tags

A map that contains tag keys and tag values that are attached to the simulation job request.

failed_requests[].request.use_default_applications

A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.

failed_requests[].request.vpc_config

If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and two subnet IDs.

Show child fields
failed_requests[].request.vpc_config.assign_public_ip

A boolean indicating whether to assign a public IP address.

failed_requests[].request.vpc_config.security_groups[]
failed_requests[].request.vpc_config.subnets[]
failure_code

The failure code of the simulation job batch.

VARCHAR
failure_reason

The reason the simulation job batch failed.

VARCHAR
last_updated_at

The time, in milliseconds since the epoch, when the simulation job batch was last updated.

TIMESTAMP_S
pending_requests

A list of pending simulation job requests. These requests have not yet been created into simulation jobs.

STRUCT(
    "output_location" STRUCT(
        "s3_bucket" VARCHAR,
        "s3_prefix" VARCHAR
    ),
    "logging_config" STRUCT(
        "record_all_ros_topics" BOOLEAN
    ),
    "max_job_duration_in_seconds" BIGINT,
    "iam_role" VARCHAR,
    "failure_behavior" VARCHAR,
    "use_default_applications" BOOLEAN,
    "robot_applications" STRUCT(
        "application" VARCHAR,
        "application_version" VARCHAR,
        "launch_config" STRUCT(
            "package_name" VARCHAR,
            "launch_file" VARCHAR,
            "environment_variables" MAP(VARCHAR, VARCHAR),
            "port_forwarding_config" STRUCT(
                "port_mappings" STRUCT(
                    "job_port" BIGINT,
                    "application_port" BIGINT,
                    "enable_on_public_ip" BOOLEAN
                )[]
            ),
            "stream_ui" BOOLEAN,
            "command" VARCHAR[]
        ),
        "upload_configurations" STRUCT(
            "name" VARCHAR,
            "path" VARCHAR,
            "upload_behavior" VARCHAR
        )[],
        "use_default_upload_configurations" BOOLEAN,
        "tools" STRUCT(
            "stream_ui" BOOLEAN,
            "name" VARCHAR,
            "command" VARCHAR,
            "stream_output_to_cloud_watch" BOOLEAN,
            "exit_behavior" VARCHAR
        )[],
        "use_default_tools" BOOLEAN
    )[],
    "simulation_applications" STRUCT(
        "application" VARCHAR,
        "application_version" VARCHAR,
        "launch_config" STRUCT(
            "package_name" VARCHAR,
            "launch_file" VARCHAR,
            "environment_variables" MAP(VARCHAR, VARCHAR),
            "port_forwarding_config" STRUCT(
                "port_mappings" STRUCT(
                    "job_port" BIGINT,
                    "application_port" BIGINT,
                    "enable_on_public_ip" BOOLEAN
                )[]
            ),
            "stream_ui" BOOLEAN,
            "command" VARCHAR[]
        ),
        "upload_configurations" STRUCT(
            "name" VARCHAR,
            "path" VARCHAR,
            "upload_behavior" VARCHAR
        )[],
        "world_configs" STRUCT(
            "world" VARCHAR
        )[],
        "use_default_upload_configurations" BOOLEAN,
        "tools" STRUCT(
            "stream_ui" BOOLEAN,
            "name" VARCHAR,
            "command" VARCHAR,
            "stream_output_to_cloud_watch" BOOLEAN,
            "exit_behavior" VARCHAR
        )[],
        "use_default_tools" BOOLEAN
    )[],
    "data_sources" STRUCT(
        "name" VARCHAR,
        "s3_bucket" VARCHAR,
        "s3_keys" VARCHAR[],
        "type" VARCHAR,
        "destination" VARCHAR
    )[],
    "vpc_config" STRUCT(
        "subnets" VARCHAR[],
        "security_groups" VARCHAR[],
        "assign_public_ip" BOOLEAN
    ),
    "compute" STRUCT(
        "simulation_unit_limit" BIGINT,
        "compute_type" VARCHAR,
        "gpu_unit_limit" BIGINT
    ),
    "tags" MAP(VARCHAR, VARCHAR)
)[]
Show child fields
pending_requests[]
Show child fields
pending_requests[].compute

Compute information for the simulation job

Show child fields
pending_requests[].compute.compute_type

Compute type information for the simulation job.

pending_requests[].compute.gpu_unit_limit

Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.

pending_requests[].compute.simulation_unit_limit

The simulation unit limit. Your simulation is allocated CPU and memory proportional to the supplied simulation unit limit. A simulation unit is 1 vcpu and 2GB of memory. You are only billed for the SU utilization you consume up to the maximum value provided. The default is 15.

pending_requests[].data_sources[]
Show child fields
pending_requests[].data_sources[].destination

The location where your files are mounted in the container image.

If you've specified the type of the data source as an Archive, you must provide an Amazon S3 object key to your archive. The object key must point to either a .zip or .tar.gz file.

If you've specified the type of the data source as a Prefix, you provide the Amazon S3 prefix that points to the files that you are using for your data source.

If you've specified the type of the data source as a File, you provide the Amazon S3 path to the file that you're using as your data source.

pending_requests[].data_sources[].name

The name of the data source.

pending_requests[].data_sources[].s3_bucket

The S3 bucket where the data files are located.

pending_requests[].data_sources[].s3_keys[]
pending_requests[].data_sources[].type

The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.

If you don't specify a field, the default value is File.

pending_requests[].failure_behavior

The failure behavior the simulation job.

Continue

Leaves the host running for its maximum timeout duration after a 4XX error code.

Fail

Stop the simulation job and terminate the instance.

pending_requests[].iam_role

The IAM role name that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. This is how credentials are passed in to your simulation job.

pending_requests[].logging_config

The logging configuration.

Show child fields
pending_requests[].logging_config.record_all_ros_topics

A boolean indicating whether to record all ROS topics.

This API is no longer supported and will throw an error if used.

pending_requests[].max_job_duration_in_seconds

The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.

pending_requests[].output_location

The output location.

Show child fields
pending_requests[].output_location.s3_bucket

The S3 bucket for output.

pending_requests[].output_location.s3_prefix

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

pending_requests[].robot_applications[]
Show child fields
pending_requests[].robot_applications[].application

The application information for the robot application.

pending_requests[].robot_applications[].application_version

The version of the robot application.

pending_requests[].robot_applications[].launch_config

The launch configuration for the robot application.

Show child fields
pending_requests[].robot_applications[].launch_config.command[]
pending_requests[].robot_applications[].launch_config.environment_variables

The environment variables for the application launch.

pending_requests[].robot_applications[].launch_config.launch_file

The launch file name.

pending_requests[].robot_applications[].launch_config.package_name

The package name.

pending_requests[].robot_applications[].launch_config.port_forwarding_config

The port forwarding configuration.

Show child fields
pending_requests[].robot_applications[].launch_config.port_forwarding_config.port_mappings[]
Show child fields
pending_requests[].robot_applications[].launch_config.port_forwarding_config.port_mappings[].application_port

The port number on the application.

pending_requests[].robot_applications[].launch_config.port_forwarding_config.port_mappings[].enable_on_public_ip

A Boolean indicating whether to enable this port mapping on public IP.

pending_requests[].robot_applications[].launch_config.port_forwarding_config.port_mappings[].job_port

The port number on the simulation job instance to use as a remote connection point.

pending_requests[].robot_applications[].launch_config.stream_ui

Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.

pending_requests[].robot_applications[].tools[]
Show child fields
pending_requests[].robot_applications[].tools[].command

Command-line arguments for the tool. It must include the tool executable name.

pending_requests[].robot_applications[].tools[].exit_behavior

Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

pending_requests[].robot_applications[].tools[].name

The name of the tool.

pending_requests[].robot_applications[].tools[].stream_output_to_cloud_watch

Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

pending_requests[].robot_applications[].tools[].stream_ui

Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

pending_requests[].robot_applications[].upload_configurations[]
Show child fields
pending_requests[].robot_applications[].upload_configurations[].name

A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.

For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

pending_requests[].robot_applications[].upload_configurations[].path

Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

pending_requests[].robot_applications[].upload_configurations[].upload_behavior

Specifies when to upload the files:

UPLOAD_ON_TERMINATE

Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

UPLOAD_ROLLING_AUTO_REMOVE

Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.

pending_requests[].robot_applications[].use_default_tools

A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

This API is no longer supported and will throw an error if used.

pending_requests[].robot_applications[].use_default_upload_configurations

A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

If you set this value, you must specify an outputLocation.

This API is no longer supported and will throw an error if used.

pending_requests[].simulation_applications[]
Show child fields
pending_requests[].simulation_applications[].application

The application information for the simulation application.

pending_requests[].simulation_applications[].application_version

The version of the simulation application.

pending_requests[].simulation_applications[].launch_config

The launch configuration for the simulation application.

Show child fields
pending_requests[].simulation_applications[].launch_config.command[]
pending_requests[].simulation_applications[].launch_config.environment_variables

The environment variables for the application launch.

pending_requests[].simulation_applications[].launch_config.launch_file

The launch file name.

pending_requests[].simulation_applications[].launch_config.package_name

The package name.

pending_requests[].simulation_applications[].launch_config.port_forwarding_config

The port forwarding configuration.

Show child fields
pending_requests[].simulation_applications[].launch_config.port_forwarding_config.port_mappings[]
Show child fields
pending_requests[].simulation_applications[].launch_config.port_forwarding_config.port_mappings[].application_port

The port number on the application.

pending_requests[].simulation_applications[].launch_config.port_forwarding_config.port_mappings[].enable_on_public_ip

A Boolean indicating whether to enable this port mapping on public IP.

pending_requests[].simulation_applications[].launch_config.port_forwarding_config.port_mappings[].job_port

The port number on the simulation job instance to use as a remote connection point.

pending_requests[].simulation_applications[].launch_config.stream_ui

Boolean indicating whether a streaming session will be configured for the application. If True, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.

pending_requests[].simulation_applications[].tools[]
Show child fields
pending_requests[].simulation_applications[].tools[].command

Command-line arguments for the tool. It must include the tool executable name.

pending_requests[].simulation_applications[].tools[].exit_behavior

Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART.

pending_requests[].simulation_applications[].tools[].name

The name of the tool.

pending_requests[].simulation_applications[].tools[].stream_output_to_cloud_watch

Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False.

pending_requests[].simulation_applications[].tools[].stream_ui

Boolean indicating whether a streaming session will be configured for the tool. If True, AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False.

pending_requests[].simulation_applications[].upload_configurations[]
Show child fields
pending_requests[].simulation_applications[].upload_configurations[].name

A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.

For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test, your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test.

pending_requests[].simulation_applications[].upload_configurations[].path

Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk. For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library.

pending_requests[].simulation_applications[].upload_configurations[].upload_behavior

Specifies when to upload the files:

UPLOAD_ON_TERMINATE

Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.

If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.

UPLOAD_ROLLING_AUTO_REMOVE

Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.

pending_requests[].simulation_applications[].use_default_tools

A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False.

This API is no longer supported and will throw an error if used.

pending_requests[].simulation_applications[].use_default_upload_configurations

A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.

If you set this value, you must specify an outputLocation.

This API is no longer supported and will throw an error if used.

pending_requests[].simulation_applications[].world_configs[]
Show child fields
pending_requests[].simulation_applications[].world_configs[].world

The world generated by Simulation WorldForge.

pending_requests[].tags

A map that contains tag keys and tag values that are attached to the simulation job request.

pending_requests[].use_default_applications

A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.

pending_requests[].vpc_config

If your simulation job accesses resources in a VPC, you provide this parameter identifying the list of security group IDs and subnet IDs. These must belong to the same VPC. You must provide at least one security group and two subnet IDs.

Show child fields
pending_requests[].vpc_config.assign_public_ip

A boolean indicating whether to assign a public IP address.

pending_requests[].vpc_config.security_groups[]
pending_requests[].vpc_config.subnets[]
status

The status of the batch.

Pending

The simulation job batch request is pending.

InProgress

The simulation job batch is in progress.

Failed

The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError). See failureCode and failureReason for more information.

Completed

The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed).

Canceled

The simulation batch job was cancelled.

Canceling

The simulation batch job is being cancelled.

Completing

The simulation batch job is completing.

TimingOut

The simulation job batch is timing out.

If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError), the batch status will be Failed. If there are no such failing request, the batch status will be TimedOut.

TimedOut

The simulation batch job timed out.

VARCHAR
tags

A map that contains tag keys and tag values that are attached to the simulation job batch.

MAP(VARCHAR, VARCHAR)