Creates a simulation job.
Note
After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible.
See also: AWS API Documentation
create-simulation-job
[--client-request-token <value>]
[--output-location <value>]
[--logging-config <value>]
--max-job-duration-in-seconds <value>
--iam-role <value>
[--failure-behavior <value>]
[--robot-applications <value>]
[--simulation-applications <value>]
[--data-sources <value>]
[--tags <value>]
[--vpc-config <value>]
[--compute <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
--client-request-token
(string)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
--output-location
(structure)
Location for output files generated by the simulation job.
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"
}
--logging-config
(structure)
The logging configuration.
recordAllRosTopics -> (boolean)
A boolean indicating whether to record all ROS topics.
Warning
This API is no longer supported and will throw an error if used.
Shorthand Syntax:
recordAllRosTopics=booleanJSON Syntax:
{ "recordAllRosTopics": true|false }
--max-job-duration-in-seconds
(long)The maximum simulation job duration in seconds (up to 14 days or 1,209,600 seconds. When
maxJobDurationInSeconds
is reached, the simulation job will status will transition toCompleted
.
--iam-role
(string)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.
--failure-behavior
(string)The failure behavior the simulation job.
Continue
Leaves the instance running for its maximum timeout duration after a
4XX
error code.Fail
Stop the simulation job and terminate the instance.
Possible values:
Fail
Continue
--robot-applications
(list)The robot application to use in the simulation job.
(structure)
Application configuration information for a robot.
application -> (string)
The application information for the robot application.
applicationVersion -> (string)
The version of the robot application.
launchConfig -> (structure)
The launch configuration for the robot application.
packageName -> (string)
The package name.
launchFile -> (string)
The launch file name.
environmentVariables -> (map)
The environment variables for the application launch.
key -> (string)
value -> (string)
portForwardingConfig -> (structure)
The port forwarding configuration.
portMappings -> (list)
The port mappings for the configuration.
(structure)
An object representing a port mapping.
jobPort -> (integer)
The port number on the simulation job instance to use as a remote connection point.
applicationPort -> (integer)
The port number on the application.
enableOnPublicIp -> (boolean)
A Boolean indicating whether to enable this port mapping on public IP.
streamUI -> (boolean)
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.command -> (list)
If you’ve specified
General
as the value for yourRobotSoftwareSuite
, you can use this field to specify a list of commands for your container image.If you’ve specified
SimulationRuntime
as the value for yourSimulationSoftwareSuite
, you can use this field to specify a list of commands for your container image.(string)
uploadConfigurations -> (list)
The upload configurations for the robot application.
(structure)
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
name -> (string)
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 isrobot-test
, your files will be uploaded tos3://my-bucket/<simid>/<runid>/robot-test
.path -> (string)
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 .uploadBehavior -> (string)
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.
useDefaultUploadConfigurations -> (boolean)
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
.Warning
This API is no longer supported and will throw an error if used.
tools -> (list)
Information about tools configured for the robot application.
(structure)
Information about a tool. Tools are used in a simulation job.
streamUI -> (boolean)
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 isFalse
.name -> (string)
The name of the tool.
command -> (string)
Command-line arguments for the tool. It must include the tool executable name.
streamOutputToCloudWatch -> (boolean)
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is
False
.exitBehavior -> (string)
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 isRESTART
.useDefaultTools -> (boolean)
A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is
False
.Warning
This API is no longer supported and will throw an error if used.
JSON Syntax:
[ { "application": "string", "applicationVersion": "string", "launchConfig": { "packageName": "string", "launchFile": "string", "environmentVariables": {"string": "string" ...}, "portForwardingConfig": { "portMappings": [ { "jobPort": integer, "applicationPort": integer, "enableOnPublicIp": true|false } ... ] }, "streamUI": true|false, "command": ["string", ...] }, "uploadConfigurations": [ { "name": "string", "path": "string", "uploadBehavior": "UPLOAD_ON_TERMINATE"|"UPLOAD_ROLLING_AUTO_REMOVE" } ... ], "useDefaultUploadConfigurations": true|false, "tools": [ { "streamUI": true|false, "name": "string", "command": "string", "streamOutputToCloudWatch": true|false, "exitBehavior": "FAIL"|"RESTART" } ... ], "useDefaultTools": true|false } ... ]
--simulation-applications
(list)The simulation application to use in the simulation job.
(structure)
Information about a simulation application configuration.
application -> (string)
The application information for the simulation application.
applicationVersion -> (string)
The version of the simulation application.
launchConfig -> (structure)
The launch configuration for the simulation application.
packageName -> (string)
The package name.
launchFile -> (string)
The launch file name.
environmentVariables -> (map)
The environment variables for the application launch.
key -> (string)
value -> (string)
portForwardingConfig -> (structure)
The port forwarding configuration.
portMappings -> (list)
The port mappings for the configuration.
(structure)
An object representing a port mapping.
jobPort -> (integer)
The port number on the simulation job instance to use as a remote connection point.
applicationPort -> (integer)
The port number on the application.
enableOnPublicIp -> (boolean)
A Boolean indicating whether to enable this port mapping on public IP.
streamUI -> (boolean)
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.command -> (list)
If you’ve specified
General
as the value for yourRobotSoftwareSuite
, you can use this field to specify a list of commands for your container image.If you’ve specified
SimulationRuntime
as the value for yourSimulationSoftwareSuite
, you can use this field to specify a list of commands for your container image.(string)
uploadConfigurations -> (list)
Information about upload configurations for the simulation application.
(structure)
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
name -> (string)
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 isrobot-test
, your files will be uploaded tos3://my-bucket/<simid>/<runid>/robot-test
.path -> (string)
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 .uploadBehavior -> (string)
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.
worldConfigs -> (list)
A list of world configurations.
(structure)
Configuration information for a world.
world -> (string)
The world generated by Simulation WorldForge.
useDefaultUploadConfigurations -> (boolean)
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
.Warning
This API is no longer supported and will throw an error if used.
tools -> (list)
Information about tools configured for the simulation application.
(structure)
Information about a tool. Tools are used in a simulation job.
streamUI -> (boolean)
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 isFalse
.name -> (string)
The name of the tool.
command -> (string)
Command-line arguments for the tool. It must include the tool executable name.
streamOutputToCloudWatch -> (boolean)
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is
False
.exitBehavior -> (string)
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 isRESTART
.useDefaultTools -> (boolean)
A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is
False
.Warning
This API is no longer supported and will throw an error if used.
JSON Syntax:
[ { "application": "string", "applicationVersion": "string", "launchConfig": { "packageName": "string", "launchFile": "string", "environmentVariables": {"string": "string" ...}, "portForwardingConfig": { "portMappings": [ { "jobPort": integer, "applicationPort": integer, "enableOnPublicIp": true|false } ... ] }, "streamUI": true|false, "command": ["string", ...] }, "uploadConfigurations": [ { "name": "string", "path": "string", "uploadBehavior": "UPLOAD_ON_TERMINATE"|"UPLOAD_ROLLING_AUTO_REMOVE" } ... ], "worldConfigs": [ { "world": "string" } ... ], "useDefaultUploadConfigurations": true|false, "tools": [ { "streamUI": true|false, "name": "string", "command": "string", "streamOutputToCloudWatch": true|false, "exitBehavior": "FAIL"|"RESTART" } ... ], "useDefaultTools": true|false } ... ]
--data-sources
(list)Specify data sources to mount read-only files from S3 into your simulation. These files are available under
/opt/robomaker/datasources/data_source_name
.Note
There is a limit of 100 files and a combined size of 25GB for all
DataSourceConfig
objects.(structure)
Information about a data source.
name -> (string)
The name of the data source.
s3Bucket -> (string)
The S3 bucket where the data files are located.
s3Keys -> (list)
The list of S3 keys identifying the data source files.
(string)
type -> (string)
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
.destination -> (string)
The location where your files are mounted in the container image.
If you’ve specified the
type
of the data source as anArchive
, 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 aPrefix
, 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 aFile
, you provide the Amazon S3 path to the file that you’re using as your data source.Shorthand Syntax:
name=string,s3Bucket=string,s3Keys=string,string,type=string,destination=string ...JSON Syntax:
[ { "name": "string", "s3Bucket": "string", "s3Keys": ["string", ...], "type": "Prefix"|"Archive"|"File", "destination": "string" } ... ]
--tags
(map)A map that contains tag keys and tag values that are attached to the simulation job.
key -> (string)
value -> (string)
Shorthand Syntax:
KeyName1=string,KeyName2=stringJSON Syntax:
{"string": "string" ...}
--vpc-config
(structure)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 one subnet ID.
subnets -> (list)
A list of one or more subnet IDs in your VPC.
(string)
securityGroups -> (list)
A list of one or more security groups IDs in your VPC.
(string)
assignPublicIp -> (boolean)
A boolean indicating whether to assign a public IP address.
Shorthand Syntax:
subnets=string,string,securityGroups=string,string,assignPublicIp=booleanJSON Syntax:
{ "subnets": ["string", ...], "securityGroups": ["string", ...], "assignPublicIp": true|false }
--compute
(structure)Compute information for the simulation job.
simulationUnitLimit -> (integer)
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.
computeType -> (string)
Compute type information for the simulation job.
gpuUnitLimit -> (integer)
Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.
Shorthand Syntax:
simulationUnitLimit=integer,computeType=string,gpuUnitLimit=integerJSON Syntax:
{ "simulationUnitLimit": integer, "computeType": "CPU"|"GPU_AND_CPU", "gpuUnitLimit": integer }
--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 valueinput
, prints a sample input JSON that can be used as an argument for--cli-input-json
. Similarly, if providedyaml-input
it will print a sample input YAML that can be used with--cli-input-yaml
. If provided with the valueoutput
, 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.Global Options¶
--debug
(boolean)Turn on debug logging.
--endpoint-url
(string)Override command’s default URL with the given URL.
--no-verify-ssl
(boolean)By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)Disable automatic pagination.
--output
(string)The formatting style for command output.
json
text
table
yaml
yaml-stream
--query
(string)A JMESPath query to use in filtering the response data.
--profile
(string)Use a specific profile from your credential file.
--region
(string)The region to use. Overrides config/env settings.
--version
(string)Display the version of this tool.
--color
(string)Turn on/off color output.
on
off
auto
--no-sign-request
(boolean)Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
--cli-binary-format
(string)The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob
fileb://
will always be treated as binary and use the file contents directly regardless of thecli-binary-format
setting. When usingfile://
the file contents will need to properly formatted for the configuredcli-binary-format
.
base64
raw-in-base64-out
--no-cli-pager
(boolean)Disable cli pager for output.
--cli-auto-prompt
(boolean)Automatically prompt for CLI input parameters.
--no-cli-auto-prompt
(boolean)Disable automatically prompt for CLI input parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To create a simulation job
This example creates a simulation job. It uses a robot application and a simulation application.
Command:
aws robomaker create-simulation-job --max-job-duration-in-seconds 3600 --iam-role arn:aws:iam::111111111111:role/AWSRoboMakerCloudWatch-154766341-SimulationJobRole-G0OBWTQ8YBG6 --robot-applications application=arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551203485821,launchConfig={packageName=hello_world_robot,launchFile=rotate.launch} --simulation-applications application=arn:aws:robomaker:us-west-2:111111111111:simulation-application/MySimulationApplication/1551203427605,launchConfig={packageName=hello_world_simulation,launchFile=empty_world.launch} --tags Region=NorthOutput:
{ "arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-w7m68wpr05h8", "status": "Pending", "lastUpdatedAt": 1551213837.0, "failureBehavior": "Fail", "clientRequestToken": "b283ccce-e468-43ee-8642-be76a9d69f15", "maxJobDurationInSeconds": 3600, "simulationTimeMillis": 0, "iamRole": "arn:aws:iam::111111111111:role/MySimulationRole", "robotApplications": [ { "application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/MyRobotApplication/1551203485821", "applicationVersion": "$LATEST", "launchConfig": { "packageName": "hello_world_robot", "launchFile": "rotate.launch" } } ], "simulationApplications": [ { "application": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/MySimulationApplication/1551203427605", "applicationVersion": "$LATEST", "launchConfig": { "packageName": "hello_world_simulation", "launchFile": "empty_world.launch" } } ], "tags": { "Region": "North" } }Output¶
arn -> (string)
The Amazon Resource Name (ARN) of the simulation job.
status -> (string)
The status of the simulation job.
lastStartedAt -> (timestamp)
The time, in milliseconds since the epoch, when the simulation job was last started.
lastUpdatedAt -> (timestamp)
The time, in milliseconds since the epoch, when the simulation job was last updated.
failureBehavior -> (string)
the failure behavior for the simulation job.
failureCode -> (string)
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.
clientRequestToken -> (string)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
outputLocation -> (structure)
Simulation job output files location.
s3Bucket -> (string)
The S3 bucket for output.
s3Prefix -> (string)
The S3 folder in the
s3Bucket
where output files will be placed.loggingConfig -> (structure)
The logging configuration.
recordAllRosTopics -> (boolean)
A boolean indicating whether to record all ROS topics.
Warning
This API is no longer supported and will throw an error if used.
maxJobDurationInSeconds -> (long)
The maximum simulation job duration in seconds.
simulationTimeMillis -> (long)
The simulation job execution duration in milliseconds.
iamRole -> (string)
The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.
robotApplications -> (list)
The robot application used by the simulation job.
(structure)
Application configuration information for a robot.
application -> (string)
The application information for the robot application.
applicationVersion -> (string)
The version of the robot application.
launchConfig -> (structure)
The launch configuration for the robot application.
packageName -> (string)
The package name.
launchFile -> (string)
The launch file name.
environmentVariables -> (map)
The environment variables for the application launch.
key -> (string)
value -> (string)
portForwardingConfig -> (structure)
The port forwarding configuration.
portMappings -> (list)
The port mappings for the configuration.
(structure)
An object representing a port mapping.
jobPort -> (integer)
The port number on the simulation job instance to use as a remote connection point.
applicationPort -> (integer)
The port number on the application.
enableOnPublicIp -> (boolean)
A Boolean indicating whether to enable this port mapping on public IP.
streamUI -> (boolean)
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.command -> (list)
If you’ve specified
General
as the value for yourRobotSoftwareSuite
, you can use this field to specify a list of commands for your container image.If you’ve specified
SimulationRuntime
as the value for yourSimulationSoftwareSuite
, you can use this field to specify a list of commands for your container image.(string)
uploadConfigurations -> (list)
The upload configurations for the robot application.
(structure)
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
name -> (string)
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 isrobot-test
, your files will be uploaded tos3://my-bucket/<simid>/<runid>/robot-test
.path -> (string)
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 .uploadBehavior -> (string)
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.
useDefaultUploadConfigurations -> (boolean)
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
.Warning
This API is no longer supported and will throw an error if used.
tools -> (list)
Information about tools configured for the robot application.
(structure)
Information about a tool. Tools are used in a simulation job.
streamUI -> (boolean)
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 isFalse
.name -> (string)
The name of the tool.
command -> (string)
Command-line arguments for the tool. It must include the tool executable name.
streamOutputToCloudWatch -> (boolean)
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is
False
.exitBehavior -> (string)
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 isRESTART
.useDefaultTools -> (boolean)
A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is
False
.Warning
This API is no longer supported and will throw an error if used.
simulationApplications -> (list)
The simulation application used by the simulation job.
(structure)
Information about a simulation application configuration.
application -> (string)
The application information for the simulation application.
applicationVersion -> (string)
The version of the simulation application.
launchConfig -> (structure)
The launch configuration for the simulation application.
packageName -> (string)
The package name.
launchFile -> (string)
The launch file name.
environmentVariables -> (map)
The environment variables for the application launch.
key -> (string)
value -> (string)
portForwardingConfig -> (structure)
The port forwarding configuration.
portMappings -> (list)
The port mappings for the configuration.
(structure)
An object representing a port mapping.
jobPort -> (integer)
The port number on the simulation job instance to use as a remote connection point.
applicationPort -> (integer)
The port number on the application.
enableOnPublicIp -> (boolean)
A Boolean indicating whether to enable this port mapping on public IP.
streamUI -> (boolean)
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.command -> (list)
If you’ve specified
General
as the value for yourRobotSoftwareSuite
, you can use this field to specify a list of commands for your container image.If you’ve specified
SimulationRuntime
as the value for yourSimulationSoftwareSuite
, you can use this field to specify a list of commands for your container image.(string)
uploadConfigurations -> (list)
Information about upload configurations for the simulation application.
(structure)
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
name -> (string)
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 isrobot-test
, your files will be uploaded tos3://my-bucket/<simid>/<runid>/robot-test
.path -> (string)
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 .uploadBehavior -> (string)
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.
worldConfigs -> (list)
A list of world configurations.
(structure)
Configuration information for a world.
world -> (string)
The world generated by Simulation WorldForge.
useDefaultUploadConfigurations -> (boolean)
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
.Warning
This API is no longer supported and will throw an error if used.
tools -> (list)
Information about tools configured for the simulation application.
(structure)
Information about a tool. Tools are used in a simulation job.
streamUI -> (boolean)
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 isFalse
.name -> (string)
The name of the tool.
command -> (string)
Command-line arguments for the tool. It must include the tool executable name.
streamOutputToCloudWatch -> (boolean)
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is
False
.exitBehavior -> (string)
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 isRESTART
.useDefaultTools -> (boolean)
A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is
False
.Warning
This API is no longer supported and will throw an error if used.
dataSources -> (list)
The data sources for the simulation job.
(structure)
Information about a data source.
name -> (string)
The name of the data source.
s3Bucket -> (string)
The S3 bucket where the data files are located.
s3Keys -> (list)
The list of S3 keys identifying the data source files.
(structure)
Information about S3 keys.
s3Key -> (string)
The S3 key.
etag -> (string)
The etag for the object.
type -> (string)
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
.destination -> (string)
The location where your files are mounted in the container image.
If you’ve specified the
type
of the data source as anArchive
, 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 aPrefix
, 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 aFile
, you provide the Amazon S3 path to the file that you’re using as your data source.tags -> (map)
The list of all tags added to the simulation job.
key -> (string)
value -> (string)
vpcConfig -> (structure)
Information about the vpc configuration.
subnets -> (list)
A list of subnet IDs associated with the simulation job.
(string)
securityGroups -> (list)
A list of security group IDs associated with the simulation job.
(string)
vpcId -> (string)
The VPC ID associated with your simulation job.
assignPublicIp -> (boolean)
A boolean indicating if a public IP was assigned.
compute -> (structure)
Compute information for the simulation job.
simulationUnitLimit -> (integer)
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.
computeType -> (string)
Compute type response information for the simulation job.
gpuUnitLimit -> (integer)
Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.