| Column Name | Column Data Type |
|---|
job Required Input Column
The Amazon Resource Name (ARN) of the simulation job to be described. | 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 simulation job. | VARCHAR |
client_request_token
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. | VARCHAR |
compute
Compute information for the simulation job. | STRUCT(
"simulation_unit_limit" BIGINT,
"compute_type" VARCHAR,
"gpu_unit_limit" BIGINT
) |
Show child fields- compute.compute_type
Compute type response information for the simulation job. - 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. - 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.
|
data_sources
The data sources for the simulation job. | STRUCT(
"name" VARCHAR,
"s3_bucket" VARCHAR,
"s3_keys" STRUCT(
"s3_key" VARCHAR,
"etag" VARCHAR
)[],
"type" VARCHAR,
"destination" VARCHAR
)[] |
Show child fields- data_sources[]
Show child fields- 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. - data_sources[].name
The name of the data source. - data_sources[].s3_bucket
The S3 bucket where the data files are located. - data_sources[].s3_keys[]
Show child fields- data_sources[].s3_keys[].etag
The etag for the object. - data_sources[].s3_keys[].s3_key
The S3 key.
- 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.
|
failure_behavior
The failure behavior for the simulation job. | VARCHAR |
failure_code
The failure code of the simulation job if it failed: - InternalServiceError
-
Internal service error. - RobotApplicationCrash
-
Robot application exited abnormally. - SimulationApplicationCrash
-
Simulation application exited abnormally. - BadPermissionsRobotApplication
-
Robot application bundle could not be downloaded. - BadPermissionsSimulationApplication
-
Simulation application bundle could not be downloaded. - BadPermissionsS3Output
-
Unable to publish outputs to customer-provided S3 bucket. - BadPermissionsCloudwatchLogs
-
Unable to publish logs to customer-provided CloudWatch Logs resource. - SubnetIpLimitExceeded
-
Subnet IP limit exceeded. - ENILimitExceeded
-
ENI limit exceeded. - BadPermissionsUserCredentials
-
Unable to use the Role provided. - InvalidBundleRobotApplication
-
Robot bundle cannot be extracted (invalid format, bundling error, or other issue). - InvalidBundleSimulationApplication
-
Simulation bundle cannot be extracted (invalid format, bundling error, or other issue). - RobotApplicationVersionMismatchedEtag
-
Etag for RobotApplication does not match value during version creation. - SimulationApplicationVersionMismatchedEtag
-
Etag for SimulationApplication does not match value during version creation. | VARCHAR |
failure_reason
Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting. | VARCHAR |
iam_role
The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf. | VARCHAR |
last_started_at
The time, in milliseconds since the epoch, when the simulation job was last started. | TIMESTAMP_S |
last_updated_at
The time, in milliseconds since the epoch, when the simulation job was last updated. | TIMESTAMP_S |
logging_config
The logging configuration. | STRUCT(
"record_all_ros_topics" BOOLEAN
) |
Show child fields- 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.
|
max_job_duration_in_seconds
The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less. | BIGINT |
name
The name of the simulation job. | VARCHAR |
network_interface
The network interface information for the simulation job. | STRUCT(
"network_interface_id" VARCHAR,
"private_ip_address" VARCHAR,
"public_ip_address" VARCHAR
) |
Show child fields- network_interface.network_interface_id
The ID of the network interface. - network_interface.private_ip_address
The IPv4 address of the network interface within the subnet. - network_interface.public_ip_address
The IPv4 public address of the network interface.
|
output_location
Location for output files generated by the simulation job. | STRUCT(
"s3_bucket" VARCHAR,
"s3_prefix" VARCHAR
) |
Show child fields- output_location.s3_bucket
The S3 bucket for output. - output_location.s3_prefix
The S3 folder in the s3Bucket where output files will be placed.
|
robot_applications
A list of 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
)[] |
Show child fields- robot_applications[]
Show child fields- robot_applications[].application
The application information for the robot application. - robot_applications[].application_version
The version of the robot application. - robot_applications[].launch_config
The launch configuration for the robot application. Show child fields- robot_applications[].launch_config.command[]
- robot_applications[].launch_config.environment_variables
The environment variables for the application launch. - robot_applications[].launch_config.launch_file
The launch file name. - robot_applications[].launch_config.package_name
The package name. - robot_applications[].launch_config.port_forwarding_config
The port forwarding configuration. Show child fields- robot_applications[].launch_config.port_forwarding_config.port_mappings[]
Show child fields- robot_applications[].launch_config.port_forwarding_config.port_mappings[].application_port
The port number on the application. - 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. - 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.
- 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.
- robot_applications[].tools[]
Show child fields- robot_applications[].tools[].command
Command-line arguments for the tool. It must include the tool executable name. - 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. - robot_applications[].tools[].name
The name of the tool. - robot_applications[].tools[].stream_output_to_cloud_watch
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False. - 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.
- robot_applications[].upload_configurations[]
Show child fields- 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. - 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. - 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.
- 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. - 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.
|
simulation_applications
A list of 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
)[] |
Show child fields- simulation_applications[]
Show child fields- simulation_applications[].application
The application information for the simulation application. - simulation_applications[].application_version
The version of the simulation application. - simulation_applications[].launch_config
The launch configuration for the simulation application. Show child fields- simulation_applications[].launch_config.command[]
- simulation_applications[].launch_config.environment_variables
The environment variables for the application launch. - simulation_applications[].launch_config.launch_file
The launch file name. - simulation_applications[].launch_config.package_name
The package name. - simulation_applications[].launch_config.port_forwarding_config
The port forwarding configuration. Show child fields- simulation_applications[].launch_config.port_forwarding_config.port_mappings[]
Show child fields- simulation_applications[].launch_config.port_forwarding_config.port_mappings[].application_port
The port number on the application. - 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. - 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.
- 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.
- simulation_applications[].tools[]
Show child fields- simulation_applications[].tools[].command
Command-line arguments for the tool. It must include the tool executable name. - 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. - simulation_applications[].tools[].name
The name of the tool. - simulation_applications[].tools[].stream_output_to_cloud_watch
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False. - 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.
- simulation_applications[].upload_configurations[]
Show child fields- 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. - 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. - 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.
- 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. - 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. - simulation_applications[].world_configs[]
Show child fields- simulation_applications[].world_configs[].world
The world generated by Simulation WorldForge.
|
simulation_time_millis
The simulation job execution duration in milliseconds. | BIGINT |
status
The status of the simulation job. | VARCHAR |
tags
The list of all tags added to the specified simulation job. | MAP(VARCHAR, VARCHAR) |
vpc_config
The VPC configuration. | STRUCT(
"subnets" VARCHAR[],
"security_groups" VARCHAR[],
"vpc_id" VARCHAR,
"assign_public_ip" BOOLEAN
) |
Show child fields- vpc_config.assign_public_ip
A boolean indicating if a public IP was assigned. - vpc_config.security_groups[]
- vpc_config.subnets[]
- vpc_config.vpc_id
The VPC ID associated with your simulation job.
|