start-simulation-job-batch¶

Description¶

Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.

Synopsis¶

  start-simulation-job-batch
[--client-request-token <value>]
[--batch-policy <value>]
--create-simulation-job-requests <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options¶

--client-request-token (string)

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

--batch-policy (structure)

The batch policy.

timeoutInSeconds -> (long)

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 .

maxConcurrency -> (integer)

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.

Shorthand Syntax:

timeoutInSeconds=long,maxConcurrency=integer

JSON Syntax:

{
  "timeoutInSeconds": long,
  "maxConcurrency": integer
}

--create-simulation-job-requests (list)

A list of simulation job requests to create in the batch.

(structure)

Information about a simulation job request.

outputLocation -> (structure)

The output location.

s3Bucket -> (string)

The S3 bucket for output.

s3Prefix -> (string)

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

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.

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

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.

useDefaultApplications -> (boolean)

Boolean indicating whether to use default simulation tool applications.

robotApplications -> (list)

The robot applications 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 luanch the component. It must have a graphical user interface.

simulationApplications -> (list)

The simulation applications 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 luanch the component. It must have a graphical user interface.

dataSources -> (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)

vpcConfig -> (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 two subnet IDs.

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.

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.

tags -> (map)

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

key -> (string)

value -> (string)

JSON Syntax:

[
  {
    "outputLocation": {
      "s3Bucket": "string",
      "s3Prefix": "string"
    },
    "loggingConfig": {
      "recordAllRosTopics": true|false
    },
    "maxJobDurationInSeconds": long,
    "iamRole": "string",
    "failureBehavior": "Fail"|"Continue",
    "useDefaultApplications": true|false,
    "robotApplications": [
      {
        "application": "string",
        "applicationVersion": "string",
        "launchConfig": {
          "packageName": "string",
          "launchFile": "string",
          "environmentVariables": {"string": "string"
            ...},
          "portForwardingConfig": {
            "portMappings": [
              {
                "jobPort": integer,
                "applicationPort": integer,
                "enableOnPublicIp": true|false
              }
              ...
            ]
          },
          "streamUI": true|false
        }
      }
      ...
    ],
    "simulationApplications": [
      {
        "application": "string",
        "applicationVersion": "string",
        "launchConfig": {
          "packageName": "string",
          "launchFile": "string",
          "environmentVariables": {"string": "string"
            ...},
          "portForwardingConfig": {
            "portMappings": [
              {
                "jobPort": integer,
                "applicationPort": integer,
                "enableOnPublicIp": true|false
              }
              ...
            ]
          },
          "streamUI": true|false
        }
      }
      ...
    ],
    "dataSources": [
      {
        "name": "string",
        "s3Bucket": "string",
        "s3Keys": ["string", ...]
      }
      ...
    ],
    "vpcConfig": {
      "subnets": ["string", ...],
      "securityGroups": ["string", ...],
      "assignPublicIp": true|false
    },
    "compute": {
      "simulationUnitLimit": integer
    },
    "tags": {"string": "string"
      ...}
  }
  ...
]

--tags (map)

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

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

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

Output¶

arn -> (string)

The Amazon Resource Name (arn) of the batch.

status -> (string)

The status of the simulation job 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.

createdAt -> (timestamp)

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

clientRequestToken -> (string)

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

batchPolicy -> (structure)

The batch policy.

timeoutInSeconds -> (long)

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 .

maxConcurrency -> (integer)

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.

failureCode -> (string)

The failure code if the simulation job batch failed.

failureReason -> (string)

The reason the simulation job batch failed.

failedRequests -> (list)

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

(structure)

Information about a failed create simulation job request.

request -> (structure)

The simulation job request.

outputLocation -> (structure)

The output location.

s3Bucket -> (string)

The S3 bucket for output.

s3Prefix -> (string)

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

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.

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

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.

useDefaultApplications -> (boolean)

Boolean indicating whether to use default simulation tool applications.

robotApplications -> (list)

The robot applications 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 luanch the component. It must have a graphical user interface.

simulationApplications -> (list)

The simulation applications 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 luanch the component. It must have a graphical user interface.

dataSources -> (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)

vpcConfig -> (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 two subnet IDs.

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.

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.

tags -> (map)

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

key -> (string)

value -> (string)

failureReason -> (string)

The failure reason of the simulation job request.

failureCode -> (string)

The failure code.

failedAt -> (timestamp)

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

pendingRequests -> (list)

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

(structure)

Information about a simulation job request.

outputLocation -> (structure)

The output location.

s3Bucket -> (string)

The S3 bucket for output.

s3Prefix -> (string)

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

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.

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

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.

useDefaultApplications -> (boolean)

Boolean indicating whether to use default simulation tool applications.

robotApplications -> (list)

The robot applications 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 luanch the component. It must have a graphical user interface.

simulationApplications -> (list)

The simulation applications 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 luanch the component. It must have a graphical user interface.

dataSources -> (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)

vpcConfig -> (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 two subnet IDs.

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.

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.

tags -> (map)

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

key -> (string)

value -> (string)

createdRequests -> (list)

A list of created simulation job request summaries.

(structure)

Summary information for a simulation job.

arn -> (string)

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

lastUpdatedAt -> (timestamp)

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

name -> (string)

The name of the simulation job.

status -> (string)

The status of the simulation job.

simulationApplicationNames -> (list)

A list of simulation job simulation application names.

(string)

robotApplicationNames -> (list)

A list of simulation job robot application names.

(string)

dataSourceNames -> (list)

The names of the data sources.

(string)

tags -> (map)

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

key -> (string)

value -> (string)

Table of Contents

Feedback

User Guide

start-simulation-job-batch¶

Description¶

Synopsis¶

Options¶

Output¶