2020/04/03 - AWS RoboMaker - 5 updated api methods
Changes Added support for limiting simulation unit usage, giving more predictable control over simulation cost
{'jobs': {'compute': {'simulationUnitLimit': 'integer'}}}
Describes one or more simulation jobs.
See also: AWS API Documentation
Request Syntax
client.batch_describe_simulation_job(
jobs=[
'string',
]
)
list
[REQUIRED]
A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
(string) --
dict
Response Syntax
{
'jobs': [
{
'arn': 'string',
'name': 'string',
'status': 'Pending'|'Preparing'|'Running'|'Restarting'|'Completed'|'Failed'|'RunningFailed'|'Terminating'|'Terminated'|'Canceled',
'lastStartedAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'failureBehavior': 'Fail'|'Continue',
'failureCode': 'InternalServiceError'|'RobotApplicationCrash'|'SimulationApplicationCrash'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Object'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'InvalidS3Resource'|'LimitExceeded'|'MismatchedEtag'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'ResourceNotFound'|'RequestThrottled'|'BatchTimedOut'|'BatchCanceled'|'InvalidInput'|'WrongRegionS3Bucket'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication',
'failureReason': 'string',
'clientRequestToken': 'string',
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'loggingConfig': {
'recordAllRosTopics': True|False
},
'maxJobDurationInSeconds': 123,
'simulationTimeMillis': 123,
'iamRole': 'string',
'robotApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'simulationApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'dataSources': [
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
{
's3Key': 'string',
'etag': 'string'
},
]
},
],
'tags': {
'string': 'string'
},
'vpcConfig': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'vpcId': 'string',
'assignPublicIp': True|False
},
'networkInterface': {
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'publicIpAddress': 'string'
},
'compute': {
'simulationUnitLimit': 123
}
},
],
'unprocessedJobs': [
'string',
]
}
Response Structure
(dict) --
jobs (list) --
A list of simulation jobs.
(dict) --
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 (datetime) --
The time, in milliseconds since the epoch, when the simulation job was last started.
lastUpdatedAt (datetime) --
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 SimulationJob request.
outputLocation (dict) --
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.
loggingConfig (dict) --
The logging configuration.
recordAllRosTopics (boolean) --
A boolean indicating whether to record all ROS topics.
maxJobDurationInSeconds (integer) --
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
simulationTimeMillis (integer) --
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.
(dict) --
Application configuration information for a robot.
application (string) --
The application information for the robot application.
applicationVersion (string) --
The version of the robot application.
launchConfig (dict) --
The launch configuration for the robot application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
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.
(dict) --
Information about a simulation application configuration.
application (string) --
The application information for the simulation application.
applicationVersion (string) --
The version of the simulation application.
launchConfig (dict) --
The launch configuration for the simulation application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
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.
(dict) --
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.
(dict) --
Information about S3 keys.
s3Key (string) --
The S3 key.
etag (string) --
The etag for the object.
tags (dict) --
A map that contains tag keys and tag values that are attached to the simulation job.
(string) --
(string) --
vpcConfig (dict) --
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 (dict) --
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 (dict) --
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) --
{'compute': {'simulationUnitLimit': 'integer'}}
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
Request Syntax
client.create_simulation_job(
clientRequestToken='string',
outputLocation={
's3Bucket': 'string',
's3Prefix': 'string'
},
loggingConfig={
'recordAllRosTopics': True|False
},
maxJobDurationInSeconds=123,
iamRole='string',
failureBehavior='Fail'|'Continue',
robotApplications=[
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
simulationApplications=[
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
dataSources=[
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
'string',
]
},
],
tags={
'string': 'string'
},
vpcConfig={
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': True|False
},
compute={
'simulationUnitLimit': 123
}
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
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.
dict
The logging configuration.
recordAllRosTopics (boolean) -- [REQUIRED]
A boolean indicating whether to record all ROS topics.
integer
[REQUIRED]
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 to Completed .
string
[REQUIRED]
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.
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.
list
The robot application to use in the simulation job.
(dict) --
Application configuration information for a robot.
application (string) -- [REQUIRED]
The application information for the robot application.
applicationVersion (string) --
The version of the robot application.
launchConfig (dict) -- [REQUIRED]
The launch configuration for the robot application.
packageName (string) -- [REQUIRED]
The package name.
launchFile (string) -- [REQUIRED]
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
An object representing a port mapping.
jobPort (integer) -- [REQUIRED]
The port number on the simulation job instance to use as a remote connection point.
applicationPort (integer) -- [REQUIRED]
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.
list
The simulation application to use in the simulation job.
(dict) --
Information about a simulation application configuration.
application (string) -- [REQUIRED]
The application information for the simulation application.
applicationVersion (string) --
The version of the simulation application.
launchConfig (dict) -- [REQUIRED]
The launch configuration for the simulation application.
packageName (string) -- [REQUIRED]
The package name.
launchFile (string) -- [REQUIRED]
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
An object representing a port mapping.
jobPort (integer) -- [REQUIRED]
The port number on the simulation job instance to use as a remote connection point.
applicationPort (integer) -- [REQUIRED]
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.
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.
(dict) --
Information about a data source.
name (string) -- [REQUIRED]
The name of the data source.
s3Bucket (string) -- [REQUIRED]
The S3 bucket where the data files are located.
s3Keys (list) -- [REQUIRED]
The list of S3 keys identifying the data source files.
(string) --
dict
A map that contains tag keys and tag values that are attached to the simulation job.
(string) --
(string) --
dict
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) -- [REQUIRED]
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.
dict
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.
dict
Response Syntax
{
'arn': 'string',
'status': 'Pending'|'Preparing'|'Running'|'Restarting'|'Completed'|'Failed'|'RunningFailed'|'Terminating'|'Terminated'|'Canceled',
'lastStartedAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'failureBehavior': 'Fail'|'Continue',
'failureCode': 'InternalServiceError'|'RobotApplicationCrash'|'SimulationApplicationCrash'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Object'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'InvalidS3Resource'|'LimitExceeded'|'MismatchedEtag'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'ResourceNotFound'|'RequestThrottled'|'BatchTimedOut'|'BatchCanceled'|'InvalidInput'|'WrongRegionS3Bucket'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication',
'clientRequestToken': 'string',
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'loggingConfig': {
'recordAllRosTopics': True|False
},
'maxJobDurationInSeconds': 123,
'simulationTimeMillis': 123,
'iamRole': 'string',
'robotApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'simulationApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'dataSources': [
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
{
's3Key': 'string',
'etag': 'string'
},
]
},
],
'tags': {
'string': 'string'
},
'vpcConfig': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'vpcId': 'string',
'assignPublicIp': True|False
},
'compute': {
'simulationUnitLimit': 123
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the simulation job.
status (string) --
The status of the simulation job.
lastStartedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation job was last started.
lastUpdatedAt (datetime) --
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 (dict) --
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 (dict) --
The logging configuration.
recordAllRosTopics (boolean) --
A boolean indicating whether to record all ROS topics.
maxJobDurationInSeconds (integer) --
The maximum simulation job duration in seconds.
simulationTimeMillis (integer) --
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.
(dict) --
Application configuration information for a robot.
application (string) --
The application information for the robot application.
applicationVersion (string) --
The version of the robot application.
launchConfig (dict) --
The launch configuration for the robot application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
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 application used by the simulation job.
(dict) --
Information about a simulation application configuration.
application (string) --
The application information for the simulation application.
applicationVersion (string) --
The version of the simulation application.
launchConfig (dict) --
The launch configuration for the simulation application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
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.
(dict) --
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.
(dict) --
Information about S3 keys.
s3Key (string) --
The S3 key.
etag (string) --
The etag for the object.
tags (dict) --
The list of all tags added to the simulation job.
(string) --
(string) --
vpcConfig (dict) --
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 (dict) --
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.
{'compute': {'simulationUnitLimit': 'integer'}}
Describes a simulation job.
See also: AWS API Documentation
Request Syntax
client.describe_simulation_job(
job='string'
)
string
[REQUIRED]
The Amazon Resource Name (ARN) of the simulation job to be described.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'status': 'Pending'|'Preparing'|'Running'|'Restarting'|'Completed'|'Failed'|'RunningFailed'|'Terminating'|'Terminated'|'Canceled',
'lastStartedAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'failureBehavior': 'Fail'|'Continue',
'failureCode': 'InternalServiceError'|'RobotApplicationCrash'|'SimulationApplicationCrash'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Object'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'InvalidS3Resource'|'LimitExceeded'|'MismatchedEtag'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'ResourceNotFound'|'RequestThrottled'|'BatchTimedOut'|'BatchCanceled'|'InvalidInput'|'WrongRegionS3Bucket'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication',
'failureReason': 'string',
'clientRequestToken': 'string',
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'loggingConfig': {
'recordAllRosTopics': True|False
},
'maxJobDurationInSeconds': 123,
'simulationTimeMillis': 123,
'iamRole': 'string',
'robotApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'simulationApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'dataSources': [
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
{
's3Key': 'string',
'etag': 'string'
},
]
},
],
'tags': {
'string': 'string'
},
'vpcConfig': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'vpcId': 'string',
'assignPublicIp': True|False
},
'networkInterface': {
'networkInterfaceId': 'string',
'privateIpAddress': 'string',
'publicIpAddress': 'string'
},
'compute': {
'simulationUnitLimit': 123
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the simulation job.
name (string) --
The name of the simulation job.
status (string) --
The status of the simulation job.
lastStartedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation job was last started.
lastUpdatedAt (datetime) --
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.
failureReason (string) --
Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting .
clientRequestToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
outputLocation (dict) --
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.
loggingConfig (dict) --
The logging configuration.
recordAllRosTopics (boolean) --
A boolean indicating whether to record all ROS topics.
maxJobDurationInSeconds (integer) --
The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.
simulationTimeMillis (integer) --
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.
robotApplications (list) --
A list of robot applications.
(dict) --
Application configuration information for a robot.
application (string) --
The application information for the robot application.
applicationVersion (string) --
The version of the robot application.
launchConfig (dict) --
The launch configuration for the robot application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
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.
(dict) --
Information about a simulation application configuration.
application (string) --
The application information for the simulation application.
applicationVersion (string) --
The version of the simulation application.
launchConfig (dict) --
The launch configuration for the simulation application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
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.
(dict) --
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.
(dict) --
Information about S3 keys.
s3Key (string) --
The S3 key.
etag (string) --
The etag for the object.
tags (dict) --
The list of all tags added to the specified simulation job.
(string) --
(string) --
vpcConfig (dict) --
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.
networkInterface (dict) --
The network interface information for the simulation job.
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 (dict) --
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.
{'failedRequests': {'request': {'compute': {'simulationUnitLimit': 'integer'}}},
'pendingRequests': {'compute': {'simulationUnitLimit': 'integer'}}}
Describes a simulation job batch.
See also: AWS API Documentation
Request Syntax
client.describe_simulation_job_batch(
batch='string'
)
string
[REQUIRED]
The id of the batch to describe.
dict
Response Syntax
{
'arn': 'string',
'status': 'Pending'|'InProgress'|'Failed'|'Completed'|'Canceled'|'Canceling'|'Completing'|'TimingOut'|'TimedOut',
'lastUpdatedAt': datetime(2015, 1, 1),
'createdAt': datetime(2015, 1, 1),
'clientRequestToken': 'string',
'batchPolicy': {
'timeoutInSeconds': 123,
'maxConcurrency': 123
},
'failureCode': 'InternalServiceError',
'failureReason': 'string',
'failedRequests': [
{
'request': {
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'loggingConfig': {
'recordAllRosTopics': True|False
},
'maxJobDurationInSeconds': 123,
'iamRole': 'string',
'failureBehavior': 'Fail'|'Continue',
'useDefaultApplications': True|False,
'robotApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'simulationApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'dataSources': [
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
'string',
]
},
],
'vpcConfig': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': True|False
},
'compute': {
'simulationUnitLimit': 123
},
'tags': {
'string': 'string'
}
},
'failureReason': 'string',
'failureCode': 'InternalServiceError'|'RobotApplicationCrash'|'SimulationApplicationCrash'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Object'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'InvalidS3Resource'|'LimitExceeded'|'MismatchedEtag'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'ResourceNotFound'|'RequestThrottled'|'BatchTimedOut'|'BatchCanceled'|'InvalidInput'|'WrongRegionS3Bucket'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication',
'failedAt': datetime(2015, 1, 1)
},
],
'pendingRequests': [
{
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'loggingConfig': {
'recordAllRosTopics': True|False
},
'maxJobDurationInSeconds': 123,
'iamRole': 'string',
'failureBehavior': 'Fail'|'Continue',
'useDefaultApplications': True|False,
'robotApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'simulationApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'dataSources': [
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
'string',
]
},
],
'vpcConfig': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': True|False
},
'compute': {
'simulationUnitLimit': 123
},
'tags': {
'string': 'string'
}
},
],
'createdRequests': [
{
'arn': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': 'string',
'status': 'Pending'|'Preparing'|'Running'|'Restarting'|'Completed'|'Failed'|'RunningFailed'|'Terminating'|'Terminated'|'Canceled',
'simulationApplicationNames': [
'string',
],
'robotApplicationNames': [
'string',
],
'dataSourceNames': [
'string',
]
},
],
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the batch.
status (string) --
The status of the batch.
Pending
The simulation job batch request is pending.
InProgress
The simulation job batch is in progress.
Failed
The simulation job batch failed. One or more simulation job requests could not be completed due to an internal failure (like InternalServiceError ). See failureCode and failureReason for more information.
Completed
The simulation batch job completed. A batch is complete when (1) there are no pending simulation job requests in the batch and none of the failed simulation job requests are due to InternalServiceError and (2) when all created simulation jobs have reached a terminal state (for example, Completed or Failed ).
Canceled
The simulation batch job was cancelled.
Canceling
The simulation batch job is being cancelled.
Completing
The simulation batch job is completing.
TimingOut
The simulation job batch is timing out.
If a batch timing out, and there are pending requests that were failing due to an internal failure (like InternalServiceError ), the batch status will be Failed . If there are no such failing request, the batch status will be TimedOut .
TimedOut
The simulation batch job timed out.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation job batch was last updated.
createdAt (datetime) --
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 (dict) --
The batch policy.
timeoutInSeconds (integer) --
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 of the simulation job batch.
failureReason (string) --
The reason the simulation job batch failed.
failedRequests (list) --
A list of failed create simulation job requests. The request failed to be created into a simulation job. Failed requests do not have a simulation job ID.
(dict) --
Information about a failed create simulation job request.
request (dict) --
The simulation job request.
outputLocation (dict) --
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 (dict) --
The logging configuration.
recordAllRosTopics (boolean) --
A boolean indicating whether to record all ROS topics.
maxJobDurationInSeconds (integer) --
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.
(dict) --
Application configuration information for a robot.
application (string) --
The application information for the robot application.
applicationVersion (string) --
The version of the robot application.
launchConfig (dict) --
The launch configuration for the robot application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
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.
(dict) --
Information about a simulation application configuration.
application (string) --
The application information for the simulation application.
applicationVersion (string) --
The version of the simulation application.
launchConfig (dict) --
The launch configuration for the simulation application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
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.
(dict) --
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 (dict) --
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 (dict) --
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 (dict) --
A map that contains tag keys and tag values that are attached to the simulation job request.
(string) --
(string) --
failureReason (string) --
The failure reason of the simulation job request.
failureCode (string) --
The failure code.
failedAt (datetime) --
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.
(dict) --
Information about a simulation job request.
outputLocation (dict) --
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 (dict) --
The logging configuration.
recordAllRosTopics (boolean) --
A boolean indicating whether to record all ROS topics.
maxJobDurationInSeconds (integer) --
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.
(dict) --
Application configuration information for a robot.
application (string) --
The application information for the robot application.
applicationVersion (string) --
The version of the robot application.
launchConfig (dict) --
The launch configuration for the robot application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
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.
(dict) --
Information about a simulation application configuration.
application (string) --
The application information for the simulation application.
applicationVersion (string) --
The version of the simulation application.
launchConfig (dict) --
The launch configuration for the simulation application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
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.
(dict) --
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 (dict) --
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 (dict) --
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 (dict) --
A map that contains tag keys and tag values that are attached to the simulation job request.
(string) --
(string) --
createdRequests (list) --
A list of created simulation job summaries.
(dict) --
Summary information for a simulation job.
arn (string) --
The Amazon Resource Name (ARN) of the simulation job.
lastUpdatedAt (datetime) --
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 (dict) --
A map that contains tag keys and tag values that are attached to the simulation job batch.
(string) --
(string) --
{'createSimulationJobRequests': {'compute': {'simulationUnitLimit': 'integer'}}}
Response {'failedRequests': {'request': {'compute': {'simulationUnitLimit': 'integer'}}},
'pendingRequests': {'compute': {'simulationUnitLimit': 'integer'}}}
Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.
See also: AWS API Documentation
Request Syntax
client.start_simulation_job_batch(
clientRequestToken='string',
batchPolicy={
'timeoutInSeconds': 123,
'maxConcurrency': 123
},
createSimulationJobRequests=[
{
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'loggingConfig': {
'recordAllRosTopics': True|False
},
'maxJobDurationInSeconds': 123,
'iamRole': 'string',
'failureBehavior': 'Fail'|'Continue',
'useDefaultApplications': True|False,
'robotApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'simulationApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'dataSources': [
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
'string',
]
},
],
'vpcConfig': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': True|False
},
'compute': {
'simulationUnitLimit': 123
},
'tags': {
'string': 'string'
}
},
],
tags={
'string': 'string'
}
)
string
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
dict
The batch policy.
timeoutInSeconds (integer) --
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.
list
[REQUIRED]
A list of simulation job requests to create in the batch.
(dict) --
Information about a simulation job request.
outputLocation (dict) --
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 (dict) --
The logging configuration.
recordAllRosTopics (boolean) -- [REQUIRED]
A boolean indicating whether to record all ROS topics.
maxJobDurationInSeconds (integer) -- [REQUIRED]
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.
(dict) --
Application configuration information for a robot.
application (string) -- [REQUIRED]
The application information for the robot application.
applicationVersion (string) --
The version of the robot application.
launchConfig (dict) -- [REQUIRED]
The launch configuration for the robot application.
packageName (string) -- [REQUIRED]
The package name.
launchFile (string) -- [REQUIRED]
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
An object representing a port mapping.
jobPort (integer) -- [REQUIRED]
The port number on the simulation job instance to use as a remote connection point.
applicationPort (integer) -- [REQUIRED]
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.
(dict) --
Information about a simulation application configuration.
application (string) -- [REQUIRED]
The application information for the simulation application.
applicationVersion (string) --
The version of the simulation application.
launchConfig (dict) -- [REQUIRED]
The launch configuration for the simulation application.
packageName (string) -- [REQUIRED]
The package name.
launchFile (string) -- [REQUIRED]
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
An object representing a port mapping.
jobPort (integer) -- [REQUIRED]
The port number on the simulation job instance to use as a remote connection point.
applicationPort (integer) -- [REQUIRED]
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.
(dict) --
Information about a data source.
name (string) -- [REQUIRED]
The name of the data source.
s3Bucket (string) -- [REQUIRED]
The S3 bucket where the data files are located.
s3Keys (list) -- [REQUIRED]
The list of S3 keys identifying the data source files.
(string) --
vpcConfig (dict) --
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) -- [REQUIRED]
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 (dict) --
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 (dict) --
A map that contains tag keys and tag values that are attached to the simulation job request.
(string) --
(string) --
dict
A map that contains tag keys and tag values that are attached to the deployment job batch.
(string) --
(string) --
dict
Response Syntax
{
'arn': 'string',
'status': 'Pending'|'InProgress'|'Failed'|'Completed'|'Canceled'|'Canceling'|'Completing'|'TimingOut'|'TimedOut',
'createdAt': datetime(2015, 1, 1),
'clientRequestToken': 'string',
'batchPolicy': {
'timeoutInSeconds': 123,
'maxConcurrency': 123
},
'failureCode': 'InternalServiceError',
'failureReason': 'string',
'failedRequests': [
{
'request': {
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'loggingConfig': {
'recordAllRosTopics': True|False
},
'maxJobDurationInSeconds': 123,
'iamRole': 'string',
'failureBehavior': 'Fail'|'Continue',
'useDefaultApplications': True|False,
'robotApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'simulationApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'dataSources': [
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
'string',
]
},
],
'vpcConfig': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': True|False
},
'compute': {
'simulationUnitLimit': 123
},
'tags': {
'string': 'string'
}
},
'failureReason': 'string',
'failureCode': 'InternalServiceError'|'RobotApplicationCrash'|'SimulationApplicationCrash'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Object'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'InvalidS3Resource'|'LimitExceeded'|'MismatchedEtag'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'ResourceNotFound'|'RequestThrottled'|'BatchTimedOut'|'BatchCanceled'|'InvalidInput'|'WrongRegionS3Bucket'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication',
'failedAt': datetime(2015, 1, 1)
},
],
'pendingRequests': [
{
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'loggingConfig': {
'recordAllRosTopics': True|False
},
'maxJobDurationInSeconds': 123,
'iamRole': 'string',
'failureBehavior': 'Fail'|'Continue',
'useDefaultApplications': True|False,
'robotApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'simulationApplications': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'launchFile': 'string',
'environmentVariables': {
'string': 'string'
},
'portForwardingConfig': {
'portMappings': [
{
'jobPort': 123,
'applicationPort': 123,
'enableOnPublicIp': True|False
},
]
},
'streamUI': True|False
}
},
],
'dataSources': [
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
'string',
]
},
],
'vpcConfig': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': True|False
},
'compute': {
'simulationUnitLimit': 123
},
'tags': {
'string': 'string'
}
},
],
'createdRequests': [
{
'arn': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'name': 'string',
'status': 'Pending'|'Preparing'|'Running'|'Restarting'|'Completed'|'Failed'|'RunningFailed'|'Terminating'|'Terminated'|'Canceled',
'simulationApplicationNames': [
'string',
],
'robotApplicationNames': [
'string',
],
'dataSourceNames': [
'string',
]
},
],
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
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 (datetime) --
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 (dict) --
The batch policy.
timeoutInSeconds (integer) --
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.
(dict) --
Information about a failed create simulation job request.
request (dict) --
The simulation job request.
outputLocation (dict) --
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 (dict) --
The logging configuration.
recordAllRosTopics (boolean) --
A boolean indicating whether to record all ROS topics.
maxJobDurationInSeconds (integer) --
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.
(dict) --
Application configuration information for a robot.
application (string) --
The application information for the robot application.
applicationVersion (string) --
The version of the robot application.
launchConfig (dict) --
The launch configuration for the robot application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
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.
(dict) --
Information about a simulation application configuration.
application (string) --
The application information for the simulation application.
applicationVersion (string) --
The version of the simulation application.
launchConfig (dict) --
The launch configuration for the simulation application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
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.
(dict) --
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 (dict) --
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 (dict) --
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 (dict) --
A map that contains tag keys and tag values that are attached to the simulation job request.
(string) --
(string) --
failureReason (string) --
The failure reason of the simulation job request.
failureCode (string) --
The failure code.
failedAt (datetime) --
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.
(dict) --
Information about a simulation job request.
outputLocation (dict) --
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 (dict) --
The logging configuration.
recordAllRosTopics (boolean) --
A boolean indicating whether to record all ROS topics.
maxJobDurationInSeconds (integer) --
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.
(dict) --
Application configuration information for a robot.
application (string) --
The application information for the robot application.
applicationVersion (string) --
The version of the robot application.
launchConfig (dict) --
The launch configuration for the robot application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
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.
(dict) --
Information about a simulation application configuration.
application (string) --
The application information for the simulation application.
applicationVersion (string) --
The version of the simulation application.
launchConfig (dict) --
The launch configuration for the simulation application.
packageName (string) --
The package name.
launchFile (string) --
The launch file name.
environmentVariables (dict) --
The environment variables for the application launch.
(string) --
(string) --
portForwardingConfig (dict) --
The port forwarding configuration.
portMappings (list) --
The port mappings for the configuration.
(dict) --
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.
(dict) --
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 (dict) --
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 (dict) --
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 (dict) --
A map that contains tag keys and tag values that are attached to the simulation job request.
(string) --
(string) --
createdRequests (list) --
A list of created simulation job request summaries.
(dict) --
Summary information for a simulation job.
arn (string) --
The Amazon Resource Name (ARN) of the simulation job.
lastUpdatedAt (datetime) --
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 (dict) --
A map that contains tag keys and tag values that are attached to the deployment job batch.
(string) --
(string) --