batch-describe-simulation-job¶
Description¶
Describes one or more simulation jobs.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
batch-describe-simulation-job
--jobs <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]
Options¶
--jobs (list)
A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
(string)
Syntax:
"string" "string" ...
--cli-input-json | --cli-input-yaml (string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.
--generate-cli-skeleton (string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.
--cli-auto-prompt (boolean)
Automatically prompt for CLI input parameters.
See ‘aws help’ for descriptions of global parameters.
Examples¶
To batch describe simulation jobs
The following batch-describe-simulation-job example retrieves details for the three specified simulation jobs.
Command:
aws robomaker batch-describe-simulation-job \
--job arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-66bbb3gpxm8x arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-p0cpdrrwng2n arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-g8h6tglmblgw
Output:
{
"jobs": [
{
"arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-66bbb3gpxm8x",
"status": "Completed",
"lastUpdatedAt": 1548959178.0,
"failureBehavior": "Continue",
"clientRequestToken": "6020408e-b05c-4310-9f13-4ed71c5221ed",
"outputLocation": {
"s3Bucket": "awsrobomakerobjecttracker-111111111-bundlesbucket-2lk584kiq1oa",
"s3Prefix": "output"
},
"maxJobDurationInSeconds": 3600,
"simulationTimeMillis": 0,
"iamRole": "arn:aws:iam::111111111111:role/AWSRoboMakerObjectTracker-154895-SimulationJobRole-14D5ASA7PQE3A",
"simulationApplications": [
{
"application": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/AWSRoboMakerObjectTracker-1548959046124_NPvyfcatq/1548959170096",
"applicationVersion": "$LATEST",
"launchConfig": {
"packageName": "object_tracker_simulation",
"launchFile": "local_training.launch",
"environmentVariables": {
"MARKOV_PRESET_FILE": "object_tracker.py",
"MODEL_S3_BUCKET": "awsrobomakerobjecttracker-111111111-bundlesbucket-2lk584kiq1oa",
"MODEL_S3_PREFIX": "model-store",
"ROS_AWS_REGION": "us-west-2"
}
}
}
],
"tags": {},
"vpcConfig": {
"subnets": [
"subnet-716dd52a",
"subnet-43c22325",
"subnet-3f526976"
],
"securityGroups": [
"sg-3fb40545"
],
"vpcId": "vpc-99895eff",
"assignPublicIp": true
}
},
{
"arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-p0cpdrrwng2n",
"status": "Completed",
"lastUpdatedAt": 1548168817.0,
"failureBehavior": "Continue",
"clientRequestToken": "e4a23e75-f9a7-411d-835f-21881c82c58b",
"outputLocation": {
"s3Bucket": "awsrobomakercloudwatch-111111111111-bundlesbucket-14e5s9jvwtmv7",
"s3Prefix": "output"
},
"maxJobDurationInSeconds": 3600,
"simulationTimeMillis": 0,
"iamRole": "arn:aws:iam::111111111111:role/AWSRoboMakerCloudWatch-154766341-SimulationJobRole-G0OBWTQ8YBG6",
"robotApplications": [
{
"application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/AWSRoboMakerCloudWatch-1547663411642_NZbpqEJ3T/1547663517377",
"applicationVersion": "$LATEST",
"launchConfig": {
"packageName": "cloudwatch_robot",
"launchFile": "await_commands.launch",
"environmentVariables": {
"LAUNCH_ID": "1548168752173",
"ROS_AWS_REGION": "us-west-2"
}
}
}
],
"simulationApplications": [
{
"application": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/AWSRoboMakerCloudWatch-1547663411642_0LIt6D1h6/1547663521470",
"applicationVersion": "$LATEST",
"launchConfig": {
"packageName": "cloudwatch_simulation",
"launchFile": "bookstore_turtlebot_navigation.launch",
"environmentVariables": {
"LAUNCH_ID": "1548168752173",
"ROS_AWS_REGION": "us-west-2",
"TURTLEBOT3_MODEL": "waffle_pi"
}
}
}
],
"tags": {},
"vpcConfig": {
"subnets": [
"subnet-716dd52a",
"subnet-43c22325",
"subnet-3f526976"
],
"securityGroups": [
"sg-3fb40545"
],
"vpcId": "vpc-99895eff",
"assignPublicIp": true
}
},
{
"arn": "arn:aws:robomaker:us-west-2:111111111111:simulation-job/sim-g8h6tglmblgw",
"status": "Canceled",
"lastUpdatedAt": 1546543442.0,
"failureBehavior": "Fail",
"clientRequestToken": "d796bbb4-2a2c-1abc-f2a9-0d9e547d853f",
"outputLocation": {
"s3Bucket": "sample-bucket",
"s3Prefix": "SimulationLog_115490482698"
},
"maxJobDurationInSeconds": 28800,
"simulationTimeMillis": 0,
"iamRole": "arn:aws:iam::111111111111:role/RoboMakerSampleTheFirst",
"robotApplications": [
{
"application": "arn:aws:robomaker:us-west-2:111111111111:robot-application/RoboMakerHelloWorldRobot/1546541208251",
"applicationVersion": "$LATEST",
"launchConfig": {
"packageName": "hello_world_robot",
"launchFile": "rotate.launch"
}
}
],
"simulationApplications": [
{
"application": "arn:aws:robomaker:us-west-2:111111111111:simulation-application/RoboMakerHelloWorldSimulation/1546541198985",
"applicationVersion": "$LATEST",
"launchConfig": {
"packageName": "hello_world_simulation",
"launchFile": "empty_world.launch"
}
}
],
"tags": {}
}
],
"unprocessedJobs": []
}
Output¶
jobs -> (list)
A list of simulation jobs.
(structure)
Information about a simulation job.
arn -> (string)
The Amazon Resource Name (ARN) of the simulation job.
name -> (string)
The name of the simulation job.
status -> (string)
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 the simulation job.
Continue
Restart the simulation job in the same host instance.
Fail
Stop the simulation job and terminate the instance.
failureCode -> (string)
The failure code of the simulation job if it failed.
failureReason -> (string)
The reason why the simulation job failed.
clientRequestToken -> (string)
A unique identifier for this
SimulationJobrequest.outputLocation -> (structure)
Location for output files generated by the simulation job.
s3Bucket -> (string)
The S3 bucket for output.
s3Prefix -> (string)
The S3 folder in the
s3Bucketwhere output files will be placed.loggingConfig -> (structure)
The logging configuration.
recordAllRosTopics -> (boolean)
A boolean indicating whether to record all ROS topics.
maxJobDurationInSeconds -> (long)
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
simulationTimeMillis -> (long)
The simulation job execution duration in milliseconds.
iamRole -> (string)
The IAM role 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.
robotApplications -> (list)
A list of robot applications.
(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 luanch the component. It must have a graphical user interface.simulationApplications -> (list)
A list of simulation applications.
(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 luanch the component. It must have a graphical user interface.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.
tags -> (map)
A map that contains tag keys and tag values that are attached to the simulation job.
key -> (string)
value -> (string)
vpcConfig -> (structure)
VPC configuration information.
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.
networkInterface -> (structure)
Information about a network interface.
networkInterfaceId -> (string)
The ID of the network interface.
privateIpAddress -> (string)
The IPv4 address of the network interface within the subnet.
publicIpAddress -> (string)
The IPv4 public address of the network interface.
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 maximim value provided.
unprocessedJobs -> (list)
A list of unprocessed simulation job Amazon Resource Names (ARNs).
(string)