Table of Contents
A low-level client representing AWS RoboMaker
This section provides documentation for the AWS RoboMaker API operations.
import boto3
client = boto3.client('robomaker')
These are the available methods:
Deletes one or more worlds in a batch operation.
See also: AWS API Documentation
Request Syntax
response = client.batch_delete_worlds(
worlds=[
'string',
]
)
[REQUIRED]
A list of Amazon Resource Names (arns) that correspond to worlds to delete.
{
'unprocessedWorlds': [
'string',
]
}
Response Structure
A list of unprocessed worlds associated with the call. These worlds were not deleted.
Exceptions
Describes one or more simulation jobs.
See also: AWS API Documentation
Request Syntax
response = client.batch_describe_simulation_job(
jobs=[
'string',
]
)
[REQUIRED]
A list of Amazon Resource Names (ARNs) of simulation jobs to describe.
{
'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'|'RobotApplicationHealthCheckFailure'|'SimulationApplicationHealthCheckFailure'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Object'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'InvalidS3Resource'|'ThrottlingError'|'LimitExceeded'|'MismatchedEtag'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'ResourceNotFound'|'RequestThrottled'|'BatchTimedOut'|'BatchCanceled'|'InvalidInput'|'WrongRegionS3Bucket'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication'|'UploadContentMismatchError',
'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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'worldConfigs': [
{
'world': 'string'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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
A list of simulation jobs.
Information about a simulation job.
The Amazon Resource Name (ARN) of the simulation job.
The name of the simulation job.
Status of the simulation job.
The time, in milliseconds since the epoch, when the simulation job was last started.
The time, in milliseconds since the epoch, when the simulation job was last updated.
The failure behavior the simulation job.
Continue
Leaves the host running for its maximum timeout duration after a 4XX error code.
Fail
Stop the simulation job and terminate the instance.
The failure code of the simulation job if it failed.
The reason why the simulation job failed.
A unique identifier for this SimulationJob request.
Location for output files generated by the simulation job.
The S3 bucket for output.
The S3 folder in the s3Bucket where output files will be placed.
The logging configuration.
A boolean indicating whether to record all ROS topics.
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
The simulation job execution duration in milliseconds.
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.
A list of robot applications.
Application configuration information for a robot.
The application information for the robot application.
The version of the robot application.
The launch configuration for the robot application.
The package name.
The launch file name.
The environment variables for the application launch.
The port forwarding configuration.
The port mappings for the configuration.
An object representing a port mapping.
The port number on the simulation job instance to use as a remote connection point.
The port number on the application.
A Boolean indicating whether to enable this port mapping on public IP.
Boolean indicating whether a streaming session will be configured for the application. If True , AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
The upload configurations for the robot application.
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
Information about tools configured for the robot application.
Information about a tool. Tools are used in a simulation job.
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
The name of the tool.
Command-line arguments for the tool. It must include the tool executable name.
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
A list of simulation applications.
Information about a simulation application configuration.
The application information for the simulation application.
The version of the simulation application.
The launch configuration for the simulation application.
The package name.
The launch file name.
The environment variables for the application launch.
The port forwarding configuration.
The port mappings for the configuration.
An object representing a port mapping.
The port number on the simulation job instance to use as a remote connection point.
The port number on the application.
A Boolean indicating whether to enable this port mapping on public IP.
Boolean indicating whether a streaming session will be configured for the application. If True , AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
Information about upload configurations for the simulation application.
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
A list of world configurations.
Configuration information for a world.
The world generated by Simulation WorldForge.
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
Information about tools configured for the simulation application.
Information about a tool. Tools are used in a simulation job.
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
The name of the tool.
Command-line arguments for the tool. It must include the tool executable name.
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
The data sources for the simulation job.
Information about a data source.
The name of the data source.
The S3 bucket where the data files are located.
The list of S3 keys identifying the data source files.
Information about S3 keys.
The S3 key.
The etag for the object.
A map that contains tag keys and tag values that are attached to the simulation job.
VPC configuration information.
A list of subnet IDs associated with the simulation job.
A list of security group IDs associated with the simulation job.
The VPC ID associated with your simulation job.
A boolean indicating if a public IP was assigned.
Information about a network interface.
The ID of the network interface.
The IPv4 address of the network interface within the subnet.
The IPv4 public address of the network interface.
Compute information for the simulation job
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. The default is 15.
A list of unprocessed simulation job Amazon Resource Names (ARNs).
Exceptions
Check if an operation can be paginated.
Cancels the specified deployment job.
See also: AWS API Documentation
Request Syntax
response = client.cancel_deployment_job(
job='string'
)
[REQUIRED]
The deployment job ARN to cancel.
{}
Response Structure
Exceptions
Cancels the specified simulation job.
See also: AWS API Documentation
Request Syntax
response = client.cancel_simulation_job(
job='string'
)
[REQUIRED]
The simulation job ARN to cancel.
{}
Response Structure
Exceptions
Cancels a simulation job batch. When you cancel a simulation job batch, you are also cancelling all of the active simulation jobs created as part of the batch.
See also: AWS API Documentation
Request Syntax
response = client.cancel_simulation_job_batch(
batch='string'
)
[REQUIRED]
The id of the batch to cancel.
{}
Response Structure
Exceptions
Cancels the specified export job.
See also: AWS API Documentation
Request Syntax
response = client.cancel_world_export_job(
job='string'
)
[REQUIRED]
The Amazon Resource Name (arn) of the world export job to cancel.
{}
Response Structure
Exceptions
Cancels the specified world generator job.
See also: AWS API Documentation
Request Syntax
response = client.cancel_world_generation_job(
job='string'
)
[REQUIRED]
The Amazon Resource Name (arn) of the world generator job to cancel.
{}
Response Structure
Exceptions
Deploys a specific version of a robot application to robots in a fleet.
The robot application must have a numbered applicationVersion for consistency reasons. To create a new version, use CreateRobotApplicationVersion or see Creating a Robot Application Version .
Note
After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible.
See also: AWS API Documentation
Request Syntax
response = client.create_deployment_job(
deploymentConfig={
'concurrentDeploymentPercentage': 123,
'failureThresholdPercentage': 123,
'robotDeploymentTimeoutInSeconds': 123,
'downloadConditionFile': {
'bucket': 'string',
'key': 'string',
'etag': 'string'
}
},
clientRequestToken='string',
fleet='string',
deploymentApplicationConfigs=[
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'preLaunchFile': 'string',
'launchFile': 'string',
'postLaunchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
tags={
'string': 'string'
}
)
The requested deployment configuration.
The percentage of robots receiving the deployment at the same time.
The percentage of deployments that need to fail before stopping deployment.
The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.
The download condition file.
The bucket containing the object.
The key of the object.
The etag of the object.
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The Amazon Resource Name (ARN) of the fleet to deploy.
[REQUIRED]
The deployment application configuration.
Information about a deployment application configuration.
The Amazon Resource Name (ARN) of the robot application.
The version of the application.
The launch configuration.
The package name.
The deployment pre-launch file. This file will be executed prior to the launch file.
The launch file name.
The deployment post-launch file. This file will be executed after the launch file.
An array of key/value pairs specifying environment variables for the robot application
A map that contains tag keys and tag values that are attached to the deployment job.
dict
Response Syntax
{
'arn': 'string',
'fleet': 'string',
'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
'deploymentApplicationConfigs': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'preLaunchFile': 'string',
'launchFile': 'string',
'postLaunchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'InvalidGreengrassGroup'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'LambdaDeleted'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'DownloadConditionFailed'|'BadLambdaAssociated'|'InternalServerError'|'RobotApplicationDoesNotExist'|'DeploymentFleetDoesNotExist'|'FleetDeploymentTimeout',
'createdAt': datetime(2015, 1, 1),
'deploymentConfig': {
'concurrentDeploymentPercentage': 123,
'failureThresholdPercentage': 123,
'robotDeploymentTimeoutInSeconds': 123,
'downloadConditionFile': {
'bucket': 'string',
'key': 'string',
'etag': 'string'
}
},
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the deployment job.
fleet (string) --
The target fleet for the deployment job.
status (string) --
The status of the deployment job.
deploymentApplicationConfigs (list) --
The deployment application configuration.
(dict) --
Information about a deployment application configuration.
application (string) --
The Amazon Resource Name (ARN) of the robot application.
applicationVersion (string) --
The version of the application.
launchConfig (dict) --
The launch configuration.
packageName (string) --
The package name.
preLaunchFile (string) --
The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile (string) --
The launch file name.
postLaunchFile (string) --
The deployment post-launch file. This file will be executed after the launch file.
environmentVariables (dict) --
An array of key/value pairs specifying environment variables for the robot application
failureReason (string) --
The failure reason of the deployment job if it failed.
failureCode (string) --
The failure code of the simulation job if it failed:
BadPermissionError
AWS Greengrass requires a service-level role permission to access other services. The role must include the ` AWSGreengrassResourceAccessRolePolicy managed policy <https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy$jsonEditor>`__ .
ExtractingBundleFailure
The robot application could not be extracted from the bundle.
FailureThresholdBreached
The percentage of robots that could not be updated exceeded the percentage set for the deployment.
GreengrassDeploymentFailed
The robot application could not be deployed to the robot.
GreengrassGroupVersionDoesNotExist
The AWS Greengrass group or version associated with a robot is missing.
InternalServerError
An internal error has occurred. Retry your request, but if the problem persists, contact us with details.
MissingRobotApplicationArchitecture
The robot application does not have a source that matches the architecture of the robot.
MissingRobotDeploymentResource
One or more of the resources specified for the robot application are missing. For example, does the robot application have the correct launch package and launch file?
PostLaunchFileFailure
The post-launch script failed.
PreLaunchFileFailure
The pre-launch script failed.
ResourceNotFound
One or more deployment resources are missing. For example, do robot application source bundles still exist?
RobotDeploymentNoResponse
There is no response from the robot. It might not be powered on or connected to the internet.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the fleet was created.
deploymentConfig (dict) --
The deployment configuration.
concurrentDeploymentPercentage (integer) --
The percentage of robots receiving the deployment at the same time.
failureThresholdPercentage (integer) --
The percentage of deployments that need to fail before stopping deployment.
robotDeploymentTimeoutInSeconds (integer) --
The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.
downloadConditionFile (dict) --
The download condition file.
bucket (string) --
The bucket containing the object.
key (string) --
The key of the object.
etag (string) --
The etag of the object.
tags (dict) --
The list of all tags added to the deployment job.
Exceptions
Creates a fleet, a logical group of robots running the same robot application.
See also: AWS API Documentation
Request Syntax
response = client.create_fleet(
name='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The name of the fleet.
A map that contains tag keys and tag values that are attached to the fleet.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'createdAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the fleet.
name (string) --
The name of the fleet.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the fleet was created.
tags (dict) --
The list of all tags added to the fleet.
Exceptions
Creates a robot.
See also: AWS API Documentation
Request Syntax
response = client.create_robot(
name='string',
architecture='X86_64'|'ARM64'|'ARMHF',
greengrassGroupId='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The name for the robot.
[REQUIRED]
The target architecture of the robot.
[REQUIRED]
The Greengrass group id.
A map that contains tag keys and tag values that are attached to the robot.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'createdAt': datetime(2015, 1, 1),
'greengrassGroupId': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the robot.
name (string) --
The name of the robot.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the robot was created.
greengrassGroupId (string) --
The Amazon Resource Name (ARN) of the Greengrass group associated with the robot.
architecture (string) --
The target architecture of the robot.
tags (dict) --
The list of all tags added to the robot.
Exceptions
Creates a robot application.
See also: AWS API Documentation
Request Syntax
response = client.create_robot_application(
name='string',
sources=[
{
's3Bucket': 'string',
's3Key': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
robotSoftwareSuite={
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
},
tags={
'string': 'string'
},
environment={
'uri': 'string'
}
)
[REQUIRED]
The name of the robot application.
The sources of the robot application.
Information about a source configuration.
The Amazon S3 bucket name.
The s3 object key.
The target processor architecture for the application.
[REQUIRED]
The robot software suite (ROS distribuition) used by the robot application.
The name of the robot software suite (ROS distribution).
The version of the robot software suite (ROS distribution).
A map that contains tag keys and tag values that are attached to the robot application.
The object that contains that URI of the Docker image that you use for your robot application.
The Docker image URI for either your robot or simulation applications.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'version': 'string',
'sources': [
{
's3Bucket': 'string',
's3Key': 'string',
'etag': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
'robotSoftwareSuite': {
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
},
'lastUpdatedAt': datetime(2015, 1, 1),
'revisionId': 'string',
'tags': {
'string': 'string'
},
'environment': {
'uri': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the robot application.
name (string) --
The name of the robot application.
version (string) --
The version of the robot application.
sources (list) --
The sources of the robot application.
(dict) --
Information about a source.
s3Bucket (string) --
The s3 bucket name.
s3Key (string) --
The s3 object key.
etag (string) --
A hash of the object specified by s3Bucket and s3Key .
architecture (string) --
The taget processor architecture for the application.
robotSoftwareSuite (dict) --
The robot software suite (ROS distribution) used by the robot application.
name (string) --
The name of the robot software suite (ROS distribution).
version (string) --
The version of the robot software suite (ROS distribution).
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the robot application was last updated.
revisionId (string) --
The revision id of the robot application.
tags (dict) --
The list of all tags added to the robot application.
environment (dict) --
An object that contains the Docker image URI used to a create your robot application.
uri (string) --
The Docker image URI for either your robot or simulation applications.
Exceptions
Creates a version of a robot application.
See also: AWS API Documentation
Request Syntax
response = client.create_robot_application_version(
application='string',
currentRevisionId='string',
s3Etags=[
'string',
],
imageDigest='string'
)
[REQUIRED]
The application information for the robot application.
The Amazon S3 identifier for the zip file bundle that you use for your robot application.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'version': 'string',
'sources': [
{
's3Bucket': 'string',
's3Key': 'string',
'etag': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
'robotSoftwareSuite': {
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
},
'lastUpdatedAt': datetime(2015, 1, 1),
'revisionId': 'string',
'environment': {
'uri': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the robot application.
name (string) --
The name of the robot application.
version (string) --
The version of the robot application.
sources (list) --
The sources of the robot application.
(dict) --
Information about a source.
s3Bucket (string) --
The s3 bucket name.
s3Key (string) --
The s3 object key.
etag (string) --
A hash of the object specified by s3Bucket and s3Key .
architecture (string) --
The taget processor architecture for the application.
robotSoftwareSuite (dict) --
The robot software suite (ROS distribution) used by the robot application.
name (string) --
The name of the robot software suite (ROS distribution).
version (string) --
The version of the robot software suite (ROS distribution).
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the robot application was last updated.
revisionId (string) --
The revision id of the robot application.
environment (dict) --
The object that contains the Docker image URI used to create your robot application.
uri (string) --
The Docker image URI for either your robot or simulation applications.
Exceptions
Creates a simulation application.
See also: AWS API Documentation
Request Syntax
response = client.create_simulation_application(
name='string',
sources=[
{
's3Bucket': 'string',
's3Key': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
simulationSoftwareSuite={
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
},
robotSoftwareSuite={
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
},
renderingEngine={
'name': 'OGRE',
'version': 'string'
},
tags={
'string': 'string'
},
environment={
'uri': 'string'
}
)
[REQUIRED]
The name of the simulation application.
The sources of the simulation application.
Information about a source configuration.
The Amazon S3 bucket name.
The s3 object key.
The target processor architecture for the application.
[REQUIRED]
The simulation software suite used by the simulation application.
The name of the simulation software suite.
The version of the simulation software suite.
[REQUIRED]
The robot software suite (ROS distribution) used by the simulation application.
The name of the robot software suite (ROS distribution).
The version of the robot software suite (ROS distribution).
The rendering engine for the simulation application.
The name of the rendering engine.
The version of the rendering engine.
A map that contains tag keys and tag values that are attached to the simulation application.
The object that contains the Docker image URI used to create your simulation application.
The Docker image URI for either your robot or simulation applications.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'version': 'string',
'sources': [
{
's3Bucket': 'string',
's3Key': 'string',
'etag': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
'simulationSoftwareSuite': {
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
},
'robotSoftwareSuite': {
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
},
'renderingEngine': {
'name': 'OGRE',
'version': 'string'
},
'lastUpdatedAt': datetime(2015, 1, 1),
'revisionId': 'string',
'tags': {
'string': 'string'
},
'environment': {
'uri': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the simulation application.
name (string) --
The name of the simulation application.
version (string) --
The version of the simulation application.
sources (list) --
The sources of the simulation application.
(dict) --
Information about a source.
s3Bucket (string) --
The s3 bucket name.
s3Key (string) --
The s3 object key.
etag (string) --
A hash of the object specified by s3Bucket and s3Key .
architecture (string) --
The taget processor architecture for the application.
simulationSoftwareSuite (dict) --
The simulation software suite used by the simulation application.
name (string) --
The name of the simulation software suite.
version (string) --
The version of the simulation software suite.
robotSoftwareSuite (dict) --
Information about the robot software suite (ROS distribution).
name (string) --
The name of the robot software suite (ROS distribution).
version (string) --
The version of the robot software suite (ROS distribution).
renderingEngine (dict) --
The rendering engine for the simulation application.
name (string) --
The name of the rendering engine.
version (string) --
The version of the rendering engine.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation application was last updated.
revisionId (string) --
The revision id of the simulation application.
tags (dict) --
The list of all tags added to the simulation application.
environment (dict) --
The object that contains the Docker image URI that you used to create your simulation application.
uri (string) --
The Docker image URI for either your robot or simulation applications.
Exceptions
Creates a simulation application with a specific revision id.
See also: AWS API Documentation
Request Syntax
response = client.create_simulation_application_version(
application='string',
currentRevisionId='string',
s3Etags=[
'string',
],
imageDigest='string'
)
[REQUIRED]
The application information for the simulation application.
The Amazon S3 eTag identifier for the zip file bundle that you use to create the simulation application.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'version': 'string',
'sources': [
{
's3Bucket': 'string',
's3Key': 'string',
'etag': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
'simulationSoftwareSuite': {
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
},
'robotSoftwareSuite': {
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
},
'renderingEngine': {
'name': 'OGRE',
'version': 'string'
},
'lastUpdatedAt': datetime(2015, 1, 1),
'revisionId': 'string',
'environment': {
'uri': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the simulation application.
name (string) --
The name of the simulation application.
version (string) --
The version of the simulation application.
sources (list) --
The sources of the simulation application.
(dict) --
Information about a source.
s3Bucket (string) --
The s3 bucket name.
s3Key (string) --
The s3 object key.
etag (string) --
A hash of the object specified by s3Bucket and s3Key .
architecture (string) --
The taget processor architecture for the application.
simulationSoftwareSuite (dict) --
The simulation software suite used by the simulation application.
name (string) --
The name of the simulation software suite.
version (string) --
The version of the simulation software suite.
robotSoftwareSuite (dict) --
Information about the robot software suite (ROS distribution).
name (string) --
The name of the robot software suite (ROS distribution).
version (string) --
The version of the robot software suite (ROS distribution).
renderingEngine (dict) --
The rendering engine for the simulation application.
name (string) --
The name of the rendering engine.
version (string) --
The version of the rendering engine.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation application was last updated.
revisionId (string) --
The revision ID of the simulation application.
environment (dict) --
The object that contains the Docker image URI used to create the simulation application.
uri (string) --
The Docker image URI for either your robot or simulation applications.
Exceptions
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
response = 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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'worldConfigs': [
{
'world': 'string'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
dataSources=[
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
'string',
]
},
],
tags={
'string': 'string'
},
vpcConfig={
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': True|False
},
compute={
'simulationUnitLimit': 123
}
)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
Location for output files generated by the simulation job.
The S3 bucket for output.
The S3 folder in the s3Bucket where output files will be placed.
The logging configuration.
A boolean indicating whether to record all ROS topics.
[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 .
[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.
The failure behavior the simulation job.
Continue
Leaves the instance running for its maximum timeout duration after a 4XX error code.
Fail
Stop the simulation job and terminate the instance.
The robot application to use in the simulation job.
Application configuration information for a robot.
The application information for the robot application.
The version of the robot application.
The launch configuration for the robot application.
The package name.
The launch file name.
The environment variables for the application launch.
The port forwarding configuration.
The port mappings for the configuration.
An object representing a port mapping.
The port number on the simulation job instance to use as a remote connection point.
The port number on the application.
A Boolean indicating whether to enable this port mapping on public IP.
Boolean indicating whether a streaming session will be configured for the application. If True , AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
The upload configurations for the robot application.
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
Information about tools configured for the robot application.
Information about a tool. Tools are used in a simulation job.
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
The name of the tool.
Command-line arguments for the tool. It must include the tool executable name.
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
The simulation application to use in the simulation job.
Information about a simulation application configuration.
The application information for the simulation application.
The version of the simulation application.
The launch configuration for the simulation application.
The package name.
The launch file name.
The environment variables for the application launch.
The port forwarding configuration.
The port mappings for the configuration.
An object representing a port mapping.
The port number on the simulation job instance to use as a remote connection point.
The port number on the application.
A Boolean indicating whether to enable this port mapping on public IP.
Boolean indicating whether a streaming session will be configured for the application. If True , AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
Information about upload configurations for the simulation application.
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
A list of world configurations.
Configuration information for a world.
The world generated by Simulation WorldForge.
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
Information about tools configured for the simulation application.
Information about a tool. Tools are used in a simulation job.
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
The name of the tool.
Command-line arguments for the tool. It must include the tool executable name.
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
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.
Information about a data source.
The name of the data source.
The S3 bucket where the data files are located.
The list of S3 keys identifying the data source files.
A map that contains tag keys and tag values that are attached to the simulation job.
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.
A list of one or more subnet IDs in your VPC.
A list of one or more security groups IDs in your VPC.
A boolean indicating whether to assign a public IP address.
Compute information for the simulation job.
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. The default is 15.
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'|'RobotApplicationHealthCheckFailure'|'SimulationApplicationHealthCheckFailure'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Object'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'InvalidS3Resource'|'ThrottlingError'|'LimitExceeded'|'MismatchedEtag'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'ResourceNotFound'|'RequestThrottled'|'BatchTimedOut'|'BatchCanceled'|'InvalidInput'|'WrongRegionS3Bucket'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication'|'UploadContentMismatchError',
'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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'worldConfigs': [
{
'world': 'string'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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.
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 launch the component. It must have a graphical user interface.
uploadConfigurations (list) --
The upload configurations for the robot application.
(dict) --
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
name (string) --
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
path (string) --
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
uploadBehavior (string) --
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
useDefaultUploadConfigurations (boolean) --
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
tools (list) --
Information about tools configured for the robot application.
(dict) --
Information about a tool. Tools are used in a simulation job.
streamUI (boolean) --
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
name (string) --
The name of the tool.
command (string) --
Command-line arguments for the tool. It must include the tool executable name.
streamOutputToCloudWatch (boolean) --
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
exitBehavior (string) --
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
useDefaultTools (boolean) --
A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
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.
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 launch the component. It must have a graphical user interface.
uploadConfigurations (list) --
Information about upload configurations for the simulation application.
(dict) --
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
name (string) --
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
path (string) --
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
uploadBehavior (string) --
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
worldConfigs (list) --
A list of world configurations.
(dict) --
Configuration information for a world.
world (string) --
The world generated by Simulation WorldForge.
useDefaultUploadConfigurations (boolean) --
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
tools (list) --
Information about tools configured for the simulation application.
(dict) --
Information about a tool. Tools are used in a simulation job.
streamUI (boolean) --
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
name (string) --
The name of the tool.
command (string) --
Command-line arguments for the tool. It must include the tool executable name.
streamOutputToCloudWatch (boolean) --
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
exitBehavior (string) --
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
useDefaultTools (boolean) --
A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
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.
vpcConfig (dict) --
Information about the vpc configuration.
subnets (list) --
A list of subnet IDs associated with the simulation job.
securityGroups (list) --
A list of security group IDs associated with the simulation job.
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. The default is 15.
Exceptions
Creates a world export job.
See also: AWS API Documentation
Request Syntax
response = client.create_world_export_job(
clientRequestToken='string',
worlds=[
'string',
],
outputLocation={
's3Bucket': 'string',
's3Prefix': 'string'
},
iamRole='string',
tags={
'string': 'string'
}
)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
A list of Amazon Resource Names (arns) that correspond to worlds to export.
[REQUIRED]
The output location.
The S3 bucket for output.
The S3 folder in the s3Bucket where output files will be placed.
[REQUIRED]
The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
A map that contains tag keys and tag values that are attached to the world export job.
dict
Response Syntax
{
'arn': 'string',
'status': 'Pending'|'Running'|'Completed'|'Failed'|'Canceling'|'Canceled',
'createdAt': datetime(2015, 1, 1),
'failureCode': 'InternalServiceError'|'LimitExceeded'|'ResourceNotFound'|'RequestThrottled'|'InvalidInput'|'AccessDenied',
'clientRequestToken': 'string',
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'iamRole': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the world export job.
status (string) --
The status of the world export job.
Pending
The world export job request is pending.
Running
The world export job is running.
Completed
The world export job completed.
Failed
The world export job failed. See failureCode for more information.
Canceled
The world export job was cancelled.
Canceling
The world export job is being cancelled.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the world export job was created.
failureCode (string) --
The failure code of the world export job if it failed:
InternalServiceError
Internal service error.
LimitExceeded
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound
The specified resource could not be found.
RequestThrottled
The request was throttled.
InvalidInput
An input parameter in the request is not valid.
AllWorldGenerationFailed
All of the worlds in the world generation job failed. This can happen if your worldCount is greater than 50 or less than 1.
For more information about troubleshooting WorldForge, see Troubleshooting Simulation WorldForge .
clientRequestToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the 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.
iamRole (string) --
The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
tags (dict) --
A map that contains tag keys and tag values that are attached to the world export job.
Exceptions
Creates worlds using the specified template.
See also: AWS API Documentation
Request Syntax
response = client.create_world_generation_job(
clientRequestToken='string',
template='string',
worldCount={
'floorplanCount': 123,
'interiorCountPerFloorplan': 123
},
tags={
'string': 'string'
},
worldTags={
'string': 'string'
}
)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The Amazon Resource Name (arn) of the world template describing the worlds you want to create.
[REQUIRED]
Information about the world count.
The number of unique floorplans.
The number of unique interiors per floorplan.
A map that contains tag keys and tag values that are attached to the world generator job.
A map that contains tag keys and tag values that are attached to the generated worlds.
dict
Response Syntax
{
'arn': 'string',
'status': 'Pending'|'Running'|'Completed'|'Failed'|'PartialFailed'|'Canceling'|'Canceled',
'createdAt': datetime(2015, 1, 1),
'failureCode': 'InternalServiceError'|'LimitExceeded'|'ResourceNotFound'|'RequestThrottled'|'InvalidInput'|'AllWorldGenerationFailed',
'clientRequestToken': 'string',
'template': 'string',
'worldCount': {
'floorplanCount': 123,
'interiorCountPerFloorplan': 123
},
'tags': {
'string': 'string'
},
'worldTags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the world generator job.
status (string) --
The status of the world generator job.
Pending
The world generator job request is pending.
Running
The world generator job is running.
Completed
The world generator job completed.
Failed
The world generator job failed. See failureCode for more information.
PartialFailed
Some worlds did not generate.
Canceled
The world generator job was cancelled.
Canceling
The world generator job is being cancelled.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the world generator job was created.
failureCode (string) --
The failure code of the world generator job if it failed:
InternalServiceError
Internal service error.
LimitExceeded
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound
The specified resource could not be found.
RequestThrottled
The request was throttled.
InvalidInput
An input parameter in the request is not valid.
clientRequestToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
template (string) --
The Amazon Resource Name (arn) of the world template.
worldCount (dict) --
Information about the world count.
floorplanCount (integer) --
The number of unique floorplans.
interiorCountPerFloorplan (integer) --
The number of unique interiors per floorplan.
tags (dict) --
A map that contains tag keys and tag values that are attached to the world generator job.
worldTags (dict) --
A map that contains tag keys and tag values that are attached to the generated worlds.
Exceptions
Creates a world template.
See also: AWS API Documentation
Request Syntax
response = client.create_world_template(
clientRequestToken='string',
name='string',
templateBody='string',
templateLocation={
's3Bucket': 'string',
's3Key': 'string'
},
tags={
'string': 'string'
}
)
The location of the world template.
The Amazon S3 bucket name.
The list of S3 keys identifying the data source files.
A map that contains tag keys and tag values that are attached to the world template.
dict
Response Syntax
{
'arn': 'string',
'clientRequestToken': 'string',
'createdAt': datetime(2015, 1, 1),
'name': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the world template.
clientRequestToken (string) --
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the world template was created.
name (string) --
The name of the world template.
tags (dict) --
A map that contains tag keys and tag values that are attached to the world template.
Exceptions
Deletes a fleet.
See also: AWS API Documentation
Request Syntax
response = client.delete_fleet(
fleet='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the fleet.
{}
Response Structure
Exceptions
Deletes a robot.
See also: AWS API Documentation
Request Syntax
response = client.delete_robot(
robot='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the robot.
{}
Response Structure
Exceptions
Deletes a robot application.
See also: AWS API Documentation
Request Syntax
response = client.delete_robot_application(
application='string',
applicationVersion='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the the robot application.
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes a simulation application.
See also: AWS API Documentation
Request Syntax
response = client.delete_simulation_application(
application='string',
applicationVersion='string'
)
[REQUIRED]
The application information for the simulation application to delete.
dict
Response Syntax
{}
Response Structure
Exceptions
Deletes a world template.
See also: AWS API Documentation
Request Syntax
response = client.delete_world_template(
template='string'
)
[REQUIRED]
The Amazon Resource Name (arn) of the world template you want to delete.
{}
Response Structure
Exceptions
Deregisters a robot.
See also: AWS API Documentation
Request Syntax
response = client.deregister_robot(
fleet='string',
robot='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the fleet.
[REQUIRED]
The Amazon Resource Name (ARN) of the robot.
dict
Response Syntax
{
'fleet': 'string',
'robot': 'string'
}
Response Structure
(dict) --
fleet (string) --
The Amazon Resource Name (ARN) of the fleet.
robot (string) --
The Amazon Resource Name (ARN) of the robot.
Exceptions
Describes a deployment job.
See also: AWS API Documentation
Request Syntax
response = client.describe_deployment_job(
job='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the deployment job.
{
'arn': 'string',
'fleet': 'string',
'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
'deploymentConfig': {
'concurrentDeploymentPercentage': 123,
'failureThresholdPercentage': 123,
'robotDeploymentTimeoutInSeconds': 123,
'downloadConditionFile': {
'bucket': 'string',
'key': 'string',
'etag': 'string'
}
},
'deploymentApplicationConfigs': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'preLaunchFile': 'string',
'launchFile': 'string',
'postLaunchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'InvalidGreengrassGroup'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'LambdaDeleted'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'DownloadConditionFailed'|'BadLambdaAssociated'|'InternalServerError'|'RobotApplicationDoesNotExist'|'DeploymentFleetDoesNotExist'|'FleetDeploymentTimeout',
'createdAt': datetime(2015, 1, 1),
'robotDeploymentSummary': [
{
'arn': 'string',
'deploymentStartTime': datetime(2015, 1, 1),
'deploymentFinishTime': datetime(2015, 1, 1),
'status': 'Available'|'Registered'|'PendingNewDeployment'|'Deploying'|'Failed'|'InSync'|'NoResponse',
'progressDetail': {
'currentProgress': 'Validating'|'DownloadingExtracting'|'ExecutingDownloadCondition'|'ExecutingPreLaunch'|'Launching'|'ExecutingPostLaunch'|'Finished',
'percentDone': ...,
'estimatedTimeRemainingSeconds': 123,
'targetResource': 'string'
},
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'InvalidGreengrassGroup'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'LambdaDeleted'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'DownloadConditionFailed'|'BadLambdaAssociated'|'InternalServerError'|'RobotApplicationDoesNotExist'|'DeploymentFleetDoesNotExist'|'FleetDeploymentTimeout'
},
],
'tags': {
'string': 'string'
}
}
Response Structure
The Amazon Resource Name (ARN) of the deployment job.
The Amazon Resource Name (ARN) of the fleet.
The status of the deployment job.
The deployment configuration.
The percentage of robots receiving the deployment at the same time.
The percentage of deployments that need to fail before stopping deployment.
The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.
The download condition file.
The bucket containing the object.
The key of the object.
The etag of the object.
The deployment application configuration.
Information about a deployment application configuration.
The Amazon Resource Name (ARN) of the robot application.
The version of the application.
The launch configuration.
The package name.
The deployment pre-launch file. This file will be executed prior to the launch file.
The launch file name.
The deployment post-launch file. This file will be executed after the launch file.
An array of key/value pairs specifying environment variables for the robot application
A short description of the reason why the deployment job failed.
The deployment job failure code.
The time, in milliseconds since the epoch, when the deployment job was created.
A list of robot deployment summaries.
Information about a robot deployment.
The robot deployment Amazon Resource Name (ARN).
The time, in milliseconds since the epoch, when the deployment was started.
The time, in milliseconds since the epoch, when the deployment finished.
The status of the robot deployment.
Information about how the deployment is progressing.
The current progress status.
Validating
Validating the deployment.
DownloadingExtracting
Downloading and extracting the bundle on the robot.
ExecutingPreLaunch
Executing pre-launch script(s) if provided.
Launching
Launching the robot application.
ExecutingPostLaunch
Executing post-launch script(s) if provided.
Finished
Deployment is complete.
Precentage of the step that is done. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.
Estimated amount of time in seconds remaining in the step. This currently only applies to the Downloading/Extracting step of the deployment. It is empty for other steps.
The Amazon Resource Name (ARN) of the deployment job.
A short description of the reason why the robot deployment failed.
The robot deployment failure code.
The list of all tags added to the specified deployment job.
Exceptions
Describes a fleet.
See also: AWS API Documentation
Request Syntax
response = client.describe_fleet(
fleet='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the fleet.
{
'name': 'string',
'arn': 'string',
'robots': [
{
'arn': 'string',
'name': 'string',
'fleetArn': 'string',
'status': 'Available'|'Registered'|'PendingNewDeployment'|'Deploying'|'Failed'|'InSync'|'NoResponse',
'greenGrassGroupId': 'string',
'createdAt': datetime(2015, 1, 1),
'architecture': 'X86_64'|'ARM64'|'ARMHF',
'lastDeploymentJob': 'string',
'lastDeploymentTime': datetime(2015, 1, 1)
},
],
'createdAt': datetime(2015, 1, 1),
'lastDeploymentStatus': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
'lastDeploymentJob': 'string',
'lastDeploymentTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
The name of the fleet.
The Amazon Resource Name (ARN) of the fleet.
A list of robots.
Information about a robot.
The Amazon Resource Name (ARN) of the robot.
The name of the robot.
The Amazon Resource Name (ARN) of the fleet.
The status of the robot.
The Greengrass group associated with the robot.
The time, in milliseconds since the epoch, when the robot was created.
The architecture of the robot.
The Amazon Resource Name (ARN) of the last deployment job.
The time of the last deployment.
The time, in milliseconds since the epoch, when the fleet was created.
The status of the last deployment.
The Amazon Resource Name (ARN) of the last deployment job.
The time of the last deployment.
The list of all tags added to the specified fleet.
Exceptions
Describes a robot.
See also: AWS API Documentation
Request Syntax
response = client.describe_robot(
robot='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the robot to be described.
{
'arn': 'string',
'name': 'string',
'fleetArn': 'string',
'status': 'Available'|'Registered'|'PendingNewDeployment'|'Deploying'|'Failed'|'InSync'|'NoResponse',
'greengrassGroupId': 'string',
'createdAt': datetime(2015, 1, 1),
'architecture': 'X86_64'|'ARM64'|'ARMHF',
'lastDeploymentJob': 'string',
'lastDeploymentTime': datetime(2015, 1, 1),
'tags': {
'string': 'string'
}
}
Response Structure
The Amazon Resource Name (ARN) of the robot.
The name of the robot.
The Amazon Resource Name (ARN) of the fleet.
The status of the fleet.
The Greengrass group id.
The time, in milliseconds since the epoch, when the robot was created.
The target architecture of the robot application.
The Amazon Resource Name (ARN) of the last deployment job.
The time of the last deployment job.
The list of all tags added to the specified robot.
Exceptions
Describes a robot application.
See also: AWS API Documentation
Request Syntax
response = client.describe_robot_application(
application='string',
applicationVersion='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the robot application.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'version': 'string',
'sources': [
{
's3Bucket': 'string',
's3Key': 'string',
'etag': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
'robotSoftwareSuite': {
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
},
'revisionId': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'environment': {
'uri': 'string'
},
'imageDigest': 'string'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the robot application.
name (string) --
The name of the robot application.
version (string) --
The version of the robot application.
sources (list) --
The sources of the robot application.
(dict) --
Information about a source.
s3Bucket (string) --
The s3 bucket name.
s3Key (string) --
The s3 object key.
etag (string) --
A hash of the object specified by s3Bucket and s3Key .
architecture (string) --
The taget processor architecture for the application.
robotSoftwareSuite (dict) --
The robot software suite (ROS distribution) used by the robot application.
name (string) --
The name of the robot software suite (ROS distribution).
version (string) --
The version of the robot software suite (ROS distribution).
revisionId (string) --
The revision id of the robot application.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the robot application was last updated.
tags (dict) --
The list of all tags added to the specified robot application.
environment (dict) --
The object that contains the Docker image URI used to create the robot application.
uri (string) --
The Docker image URI for either your robot or simulation applications.
imageDigest (string) --
A SHA256 identifier for the Docker image that you use for your robot application.
Exceptions
Describes a simulation application.
See also: AWS API Documentation
Request Syntax
response = client.describe_simulation_application(
application='string',
applicationVersion='string'
)
[REQUIRED]
The application information for the simulation application.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'version': 'string',
'sources': [
{
's3Bucket': 'string',
's3Key': 'string',
'etag': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
'simulationSoftwareSuite': {
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
},
'robotSoftwareSuite': {
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
},
'renderingEngine': {
'name': 'OGRE',
'version': 'string'
},
'revisionId': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'environment': {
'uri': 'string'
},
'imageDigest': 'string'
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the robot simulation application.
name (string) --
The name of the simulation application.
version (string) --
The version of the simulation application.
sources (list) --
The sources of the simulation application.
(dict) --
Information about a source.
s3Bucket (string) --
The s3 bucket name.
s3Key (string) --
The s3 object key.
etag (string) --
A hash of the object specified by s3Bucket and s3Key .
architecture (string) --
The taget processor architecture for the application.
simulationSoftwareSuite (dict) --
The simulation software suite used by the simulation application.
name (string) --
The name of the simulation software suite.
version (string) --
The version of the simulation software suite.
robotSoftwareSuite (dict) --
Information about the robot software suite (ROS distribution).
name (string) --
The name of the robot software suite (ROS distribution).
version (string) --
The version of the robot software suite (ROS distribution).
renderingEngine (dict) --
The rendering engine for the simulation application.
name (string) --
The name of the rendering engine.
version (string) --
The version of the rendering engine.
revisionId (string) --
The revision id of the simulation application.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation application was last updated.
tags (dict) --
The list of all tags added to the specified simulation application.
environment (dict) --
The object that contains the Docker image URI used to create the simulation application.
uri (string) --
The Docker image URI for either your robot or simulation applications.
imageDigest (string) --
A SHA256 identifier for the Docker image that you use for your simulation application.
Exceptions
Describes a simulation job.
See also: AWS API Documentation
Request Syntax
response = client.describe_simulation_job(
job='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the simulation job to be described.
{
'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'|'RobotApplicationHealthCheckFailure'|'SimulationApplicationHealthCheckFailure'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Object'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'InvalidS3Resource'|'ThrottlingError'|'LimitExceeded'|'MismatchedEtag'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'ResourceNotFound'|'RequestThrottled'|'BatchTimedOut'|'BatchCanceled'|'InvalidInput'|'WrongRegionS3Bucket'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication'|'UploadContentMismatchError',
'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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'worldConfigs': [
{
'world': 'string'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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
The Amazon Resource Name (ARN) of the simulation job.
The name of the simulation job.
The status of the simulation job.
The time, in milliseconds since the epoch, when the simulation job was last started.
The time, in milliseconds since the epoch, when the simulation job was last updated.
The failure behavior for the simulation job.
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.
Details about why the simulation job failed. For more information about troubleshooting, see Troubleshooting .
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
Location for output files generated by the simulation job.
The S3 bucket for output.
The S3 folder in the s3Bucket where output files will be placed.
The logging configuration.
A boolean indicating whether to record all ROS topics.
The maximum job duration in seconds. The value must be 8 days (691,200 seconds) or less.
The simulation job execution duration in milliseconds.
The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.
A list of robot applications.
Application configuration information for a robot.
The application information for the robot application.
The version of the robot application.
The launch configuration for the robot application.
The package name.
The launch file name.
The environment variables for the application launch.
The port forwarding configuration.
The port mappings for the configuration.
An object representing a port mapping.
The port number on the simulation job instance to use as a remote connection point.
The port number on the application.
A Boolean indicating whether to enable this port mapping on public IP.
Boolean indicating whether a streaming session will be configured for the application. If True , AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
The upload configurations for the robot application.
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
Information about tools configured for the robot application.
Information about a tool. Tools are used in a simulation job.
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
The name of the tool.
Command-line arguments for the tool. It must include the tool executable name.
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
A list of simulation applications.
Information about a simulation application configuration.
The application information for the simulation application.
The version of the simulation application.
The launch configuration for the simulation application.
The package name.
The launch file name.
The environment variables for the application launch.
The port forwarding configuration.
The port mappings for the configuration.
An object representing a port mapping.
The port number on the simulation job instance to use as a remote connection point.
The port number on the application.
A Boolean indicating whether to enable this port mapping on public IP.
Boolean indicating whether a streaming session will be configured for the application. If True , AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
Information about upload configurations for the simulation application.
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
A list of world configurations.
Configuration information for a world.
The world generated by Simulation WorldForge.
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
Information about tools configured for the simulation application.
Information about a tool. Tools are used in a simulation job.
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
The name of the tool.
Command-line arguments for the tool. It must include the tool executable name.
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
The data sources for the simulation job.
Information about a data source.
The name of the data source.
The S3 bucket where the data files are located.
The list of S3 keys identifying the data source files.
Information about S3 keys.
The S3 key.
The etag for the object.
The list of all tags added to the specified simulation job.
The VPC configuration.
A list of subnet IDs associated with the simulation job.
A list of security group IDs associated with the simulation job.
The VPC ID associated with your simulation job.
A boolean indicating if a public IP was assigned.
The network interface information for the simulation job.
The ID of the network interface.
The IPv4 address of the network interface within the subnet.
The IPv4 public address of the network interface.
Compute information for the simulation job.
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. The default is 15.
Exceptions
Describes a simulation job batch.
See also: AWS API Documentation
Request Syntax
response = client.describe_simulation_job_batch(
batch='string'
)
[REQUIRED]
The id of the batch to describe.
{
'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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'worldConfigs': [
{
'world': 'string'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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'|'RobotApplicationHealthCheckFailure'|'SimulationApplicationHealthCheckFailure'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Object'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'InvalidS3Resource'|'ThrottlingError'|'LimitExceeded'|'MismatchedEtag'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'ResourceNotFound'|'RequestThrottled'|'BatchTimedOut'|'BatchCanceled'|'InvalidInput'|'WrongRegionS3Bucket'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication'|'UploadContentMismatchError',
'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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'worldConfigs': [
{
'world': 'string'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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
The Amazon Resource Name (ARN) of the batch.
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.
The time, in milliseconds since the epoch, when the simulation job batch was last updated.
The time, in milliseconds since the epoch, when the simulation job batch was created.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
The batch policy.
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 .
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.
The failure code of the simulation job batch.
The reason the simulation job batch failed.
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.
Information about a failed create simulation job request.
The simulation job request.
The output location.
The S3 bucket for output.
The S3 folder in the s3Bucket where output files will be placed.
The logging configuration.
A boolean indicating whether to record all ROS topics.
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
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.
The failure behavior the simulation job.
Continue
Leaves the host running for its maximum timeout duration after a 4XX error code.
Fail
Stop the simulation job and terminate the instance.
A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
The robot applications to use in the simulation job.
Application configuration information for a robot.
The application information for the robot application.
The version of the robot application.
The launch configuration for the robot application.
The package name.
The launch file name.
The environment variables for the application launch.
The port forwarding configuration.
The port mappings for the configuration.
An object representing a port mapping.
The port number on the simulation job instance to use as a remote connection point.
The port number on the application.
A Boolean indicating whether to enable this port mapping on public IP.
Boolean indicating whether a streaming session will be configured for the application. If True , AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
The upload configurations for the robot application.
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
Information about tools configured for the robot application.
Information about a tool. Tools are used in a simulation job.
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
The name of the tool.
Command-line arguments for the tool. It must include the tool executable name.
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
The simulation applications to use in the simulation job.
Information about a simulation application configuration.
The application information for the simulation application.
The version of the simulation application.
The launch configuration for the simulation application.
The package name.
The launch file name.
The environment variables for the application launch.
The port forwarding configuration.
The port mappings for the configuration.
An object representing a port mapping.
The port number on the simulation job instance to use as a remote connection point.
The port number on the application.
A Boolean indicating whether to enable this port mapping on public IP.
Boolean indicating whether a streaming session will be configured for the application. If True , AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
Information about upload configurations for the simulation application.
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
A list of world configurations.
Configuration information for a world.
The world generated by Simulation WorldForge.
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
Information about tools configured for the simulation application.
Information about a tool. Tools are used in a simulation job.
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
The name of the tool.
Command-line arguments for the tool. It must include the tool executable name.
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
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.
Information about a data source.
The name of the data source.
The S3 bucket where the data files are located.
The list of S3 keys identifying the data source files.
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.
A list of one or more subnet IDs in your VPC.
A list of one or more security groups IDs in your VPC.
A boolean indicating whether to assign a public IP address.
Compute information for the simulation job
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. The default is 15.
A map that contains tag keys and tag values that are attached to the simulation job request.
The failure reason of the simulation job request.
The failure code.
The time, in milliseconds since the epoch, when the simulation job batch failed.
A list of pending simulation job requests. These requests have not yet been created into simulation jobs.
Information about a simulation job request.
The output location.
The S3 bucket for output.
The S3 folder in the s3Bucket where output files will be placed.
The logging configuration.
A boolean indicating whether to record all ROS topics.
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
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.
The failure behavior the simulation job.
Continue
Leaves the host running for its maximum timeout duration after a 4XX error code.
Fail
Stop the simulation job and terminate the instance.
A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
The robot applications to use in the simulation job.
Application configuration information for a robot.
The application information for the robot application.
The version of the robot application.
The launch configuration for the robot application.
The package name.
The launch file name.
The environment variables for the application launch.
The port forwarding configuration.
The port mappings for the configuration.
An object representing a port mapping.
The port number on the simulation job instance to use as a remote connection point.
The port number on the application.
A Boolean indicating whether to enable this port mapping on public IP.
Boolean indicating whether a streaming session will be configured for the application. If True , AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
The upload configurations for the robot application.
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
Information about tools configured for the robot application.
Information about a tool. Tools are used in a simulation job.
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
The name of the tool.
Command-line arguments for the tool. It must include the tool executable name.
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
The simulation applications to use in the simulation job.
Information about a simulation application configuration.
The application information for the simulation application.
The version of the simulation application.
The launch configuration for the simulation application.
The package name.
The launch file name.
The environment variables for the application launch.
The port forwarding configuration.
The port mappings for the configuration.
An object representing a port mapping.
The port number on the simulation job instance to use as a remote connection point.
The port number on the application.
A Boolean indicating whether to enable this port mapping on public IP.
Boolean indicating whether a streaming session will be configured for the application. If True , AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
Information about upload configurations for the simulation application.
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
A list of world configurations.
Configuration information for a world.
The world generated by Simulation WorldForge.
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
Information about tools configured for the simulation application.
Information about a tool. Tools are used in a simulation job.
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
The name of the tool.
Command-line arguments for the tool. It must include the tool executable name.
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
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.
Information about a data source.
The name of the data source.
The S3 bucket where the data files are located.
The list of S3 keys identifying the data source files.
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.
A list of one or more subnet IDs in your VPC.
A list of one or more security groups IDs in your VPC.
A boolean indicating whether to assign a public IP address.
Compute information for the simulation job
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. The default is 15.
A map that contains tag keys and tag values that are attached to the simulation job request.
A list of created simulation job summaries.
Summary information for a simulation job.
The Amazon Resource Name (ARN) of the simulation job.
The time, in milliseconds since the epoch, when the simulation job was last updated.
The name of the simulation job.
The status of the simulation job.
A list of simulation job simulation application names.
A list of simulation job robot application names.
The names of the data sources.
A map that contains tag keys and tag values that are attached to the simulation job batch.
Exceptions
Describes a world.
See also: AWS API Documentation
Request Syntax
response = client.describe_world(
world='string'
)
[REQUIRED]
The Amazon Resource Name (arn) of the world you want to describe.
{
'arn': 'string',
'generationJob': 'string',
'template': 'string',
'createdAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'worldDescriptionBody': 'string'
}
Response Structure
The Amazon Resource Name (arn) of the world.
The Amazon Resource Name (arn) of the world generation job that generated the world.
The world template.
The time, in milliseconds since the epoch, when the world was created.
A map that contains tag keys and tag values that are attached to the world.
Returns the JSON formatted string that describes the contents of your world.
Exceptions
Describes a world export job.
See also: AWS API Documentation
Request Syntax
response = client.describe_world_export_job(
job='string'
)
[REQUIRED]
The Amazon Resource Name (arn) of the world export job to describe.
{
'arn': 'string',
'status': 'Pending'|'Running'|'Completed'|'Failed'|'Canceling'|'Canceled',
'createdAt': datetime(2015, 1, 1),
'failureCode': 'InternalServiceError'|'LimitExceeded'|'ResourceNotFound'|'RequestThrottled'|'InvalidInput'|'AccessDenied',
'failureReason': 'string',
'clientRequestToken': 'string',
'worlds': [
'string',
],
'outputLocation': {
's3Bucket': 'string',
's3Prefix': 'string'
},
'iamRole': 'string',
'tags': {
'string': 'string'
}
}
Response Structure
The Amazon Resource Name (ARN) of the world export job.
The status of the world export job.
Pending
The world export job request is pending.
Running
The world export job is running.
Completed
The world export job completed.
Failed
The world export job failed. See failureCode and failureReason for more information.
Canceled
The world export job was cancelled.
Canceling
The world export job is being cancelled.
The time, in milliseconds since the epoch, when the world export job was created.
The failure code of the world export job if it failed:
InternalServiceError
Internal service error.
LimitExceeded
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound
The specified resource could not be found.
RequestThrottled
The request was throttled.
InvalidInput
An input parameter in the request is not valid.
The reason why the world export job failed.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
A list of Amazon Resource Names (arns) that correspond to worlds to be exported.
The output location.
The S3 bucket for output.
The S3 folder in the s3Bucket where output files will be placed.
The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.
A map that contains tag keys and tag values that are attached to the world export job.
Exceptions
Describes a world generation job.
See also: AWS API Documentation
Request Syntax
response = client.describe_world_generation_job(
job='string'
)
[REQUIRED]
The Amazon Resource Name (arn) of the world generation job to describe.
{
'arn': 'string',
'status': 'Pending'|'Running'|'Completed'|'Failed'|'PartialFailed'|'Canceling'|'Canceled',
'createdAt': datetime(2015, 1, 1),
'failureCode': 'InternalServiceError'|'LimitExceeded'|'ResourceNotFound'|'RequestThrottled'|'InvalidInput'|'AllWorldGenerationFailed',
'failureReason': 'string',
'clientRequestToken': 'string',
'template': 'string',
'worldCount': {
'floorplanCount': 123,
'interiorCountPerFloorplan': 123
},
'finishedWorldsSummary': {
'finishedCount': 123,
'succeededWorlds': [
'string',
],
'failureSummary': {
'totalFailureCount': 123,
'failures': [
{
'failureCode': 'InternalServiceError'|'LimitExceeded'|'ResourceNotFound'|'RequestThrottled'|'InvalidInput'|'AllWorldGenerationFailed',
'sampleFailureReason': 'string',
'failureCount': 123
},
]
}
},
'tags': {
'string': 'string'
},
'worldTags': {
'string': 'string'
}
}
Response Structure
The Amazon Resource Name (ARN) of the world generation job.
The status of the world generation job:
Pending
The world generation job request is pending.
Running
The world generation job is running.
Completed
The world generation job completed.
Failed
The world generation job failed. See failureCode for more information.
PartialFailed
Some worlds did not generate.
Canceled
The world generation job was cancelled.
Canceling
The world generation job is being cancelled.
The time, in milliseconds since the epoch, when the world generation job was created.
The failure code of the world generation job if it failed:
InternalServiceError
Internal service error.
LimitExceeded
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound
The specified resource could not be found.
RequestThrottled
The request was throttled.
InvalidInput
An input parameter in the request is not valid.
The reason why the world generation job failed.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
The Amazon Resource Name (arn) of the world template.
Information about the world count.
The number of unique floorplans.
The number of unique interiors per floorplan.
Summary information about finished worlds.
The total number of finished worlds.
A list of worlds that succeeded.
Information about worlds that failed.
The total number of failures.
The worlds that failed.
Information about a failed world.
The failure code of the world export job if it failed:
InternalServiceError
Internal service error.
LimitExceeded
The requested resource exceeds the maximum number allowed, or the number of concurrent stream requests exceeds the maximum number allowed.
ResourceNotFound
The specified resource could not be found.
RequestThrottled
The request was throttled.
InvalidInput
An input parameter in the request is not valid.
The sample reason why the world failed. World errors are aggregated. A sample is used as the sampleFailureReason .
The number of failed worlds.
A map that contains tag keys and tag values that are attached to the world generation job.
A map that contains tag keys and tag values that are attached to the generated worlds.
Exceptions
Describes a world template.
See also: AWS API Documentation
Request Syntax
response = client.describe_world_template(
template='string'
)
[REQUIRED]
The Amazon Resource Name (arn) of the world template you want to describe.
{
'arn': 'string',
'clientRequestToken': 'string',
'name': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'tags': {
'string': 'string'
},
'version': 'string'
}
Response Structure
The Amazon Resource Name (ARN) of the world template.
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
The name of the world template.
The time, in milliseconds since the epoch, when the world template was created.
The time, in milliseconds since the epoch, when the world template was last updated.
A map that contains tag keys and tag values that are attached to the world template.
The version of the world template that you're using.
Exceptions
Generate a presigned url given a client, its method, and arguments
The presigned url
Create a paginator for an operation.
Returns an object that can wait for some condition.
Gets the world template body.
See also: AWS API Documentation
Request Syntax
response = client.get_world_template_body(
template='string',
generationJob='string'
)
dict
Response Syntax
{
'templateBody': 'string'
}
Response Structure
(dict) --
templateBody (string) --
The world template body.
Exceptions
Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.
See also: AWS API Documentation
Request Syntax
response = client.list_deployment_jobs(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
nextToken='string',
maxResults=123
)
Optional filters to limit results.
The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending .
Information about a filter.
The name of the filter.
A list of values.
dict
Response Syntax
{
'deploymentJobs': [
{
'arn': 'string',
'fleet': 'string',
'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
'deploymentApplicationConfigs': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'preLaunchFile': 'string',
'launchFile': 'string',
'postLaunchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'deploymentConfig': {
'concurrentDeploymentPercentage': 123,
'failureThresholdPercentage': 123,
'robotDeploymentTimeoutInSeconds': 123,
'downloadConditionFile': {
'bucket': 'string',
'key': 'string',
'etag': 'string'
}
},
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'InvalidGreengrassGroup'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'LambdaDeleted'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'DownloadConditionFailed'|'BadLambdaAssociated'|'InternalServerError'|'RobotApplicationDoesNotExist'|'DeploymentFleetDoesNotExist'|'FleetDeploymentTimeout',
'createdAt': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
deploymentJobs (list) --
A list of deployment jobs that meet the criteria of the request.
(dict) --
Information about a deployment job.
arn (string) --
The Amazon Resource Name (ARN) of the deployment job.
fleet (string) --
The Amazon Resource Name (ARN) of the fleet.
status (string) --
The status of the deployment job.
deploymentApplicationConfigs (list) --
The deployment application configuration.
(dict) --
Information about a deployment application configuration.
application (string) --
The Amazon Resource Name (ARN) of the robot application.
applicationVersion (string) --
The version of the application.
launchConfig (dict) --
The launch configuration.
packageName (string) --
The package name.
preLaunchFile (string) --
The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile (string) --
The launch file name.
postLaunchFile (string) --
The deployment post-launch file. This file will be executed after the launch file.
environmentVariables (dict) --
An array of key/value pairs specifying environment variables for the robot application
deploymentConfig (dict) --
The deployment configuration.
concurrentDeploymentPercentage (integer) --
The percentage of robots receiving the deployment at the same time.
failureThresholdPercentage (integer) --
The percentage of deployments that need to fail before stopping deployment.
robotDeploymentTimeoutInSeconds (integer) --
The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.
downloadConditionFile (dict) --
The download condition file.
bucket (string) --
The bucket containing the object.
key (string) --
The key of the object.
etag (string) --
The etag of the object.
failureReason (string) --
A short description of the reason why the deployment job failed.
failureCode (string) --
The deployment job failure code.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the deployment job was created.
nextToken (string) --
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListDeploymentJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
Exceptions
Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.
See also: AWS API Documentation
Request Syntax
response = client.list_fleets(
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListFleets again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
Note
This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
Optional filters to limit results.
The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
Information about a filter.
The name of the filter.
A list of values.
dict
Response Syntax
{
'fleetDetails': [
{
'name': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastDeploymentStatus': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
'lastDeploymentJob': 'string',
'lastDeploymentTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
fleetDetails (list) --
A list of fleet details meeting the request criteria.
(dict) --
Information about a fleet.
name (string) --
The name of the fleet.
arn (string) --
The Amazon Resource Name (ARN) of the fleet.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the fleet was created.
lastDeploymentStatus (string) --
The status of the last fleet deployment.
lastDeploymentJob (string) --
The Amazon Resource Name (ARN) of the last deployment job.
lastDeploymentTime (datetime) --
The time of the last deployment.
nextToken (string) --
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListFleets again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
Exceptions
Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.
See also: AWS API Documentation
Request Syntax
response = client.list_robot_applications(
versionQualifier='string',
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
Optional filters to limit results.
The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
Information about a filter.
The name of the filter.
A list of values.
dict
Response Syntax
{
'robotApplicationSummaries': [
{
'name': 'string',
'arn': 'string',
'version': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'robotSoftwareSuite': {
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
robotApplicationSummaries (list) --
A list of robot application summaries that meet the criteria of the request.
(dict) --
Summary information for a robot application.
name (string) --
The name of the robot application.
arn (string) --
The Amazon Resource Name (ARN) of the robot.
version (string) --
The version of the robot application.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the robot application was last updated.
robotSoftwareSuite (dict) --
Information about a robot software suite (ROS distribution).
name (string) --
The name of the robot software suite (ROS distribution).
version (string) --
The version of the robot software suite (ROS distribution).
nextToken (string) --
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobotApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
Exceptions
Returns a list of robots. You can optionally provide filters to retrieve specific robots.
See also: AWS API Documentation
Request Syntax
response = client.list_robots(
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
Optional filters to limit results.
The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available .
Information about a filter.
The name of the filter.
A list of values.
dict
Response Syntax
{
'robots': [
{
'arn': 'string',
'name': 'string',
'fleetArn': 'string',
'status': 'Available'|'Registered'|'PendingNewDeployment'|'Deploying'|'Failed'|'InSync'|'NoResponse',
'greenGrassGroupId': 'string',
'createdAt': datetime(2015, 1, 1),
'architecture': 'X86_64'|'ARM64'|'ARMHF',
'lastDeploymentJob': 'string',
'lastDeploymentTime': datetime(2015, 1, 1)
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
robots (list) --
A list of robots that meet the criteria of the request.
(dict) --
Information about a robot.
arn (string) --
The Amazon Resource Name (ARN) of the robot.
name (string) --
The name of the robot.
fleetArn (string) --
The Amazon Resource Name (ARN) of the fleet.
status (string) --
The status of the robot.
greenGrassGroupId (string) --
The Greengrass group associated with the robot.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the robot was created.
architecture (string) --
The architecture of the robot.
lastDeploymentJob (string) --
The Amazon Resource Name (ARN) of the last deployment job.
lastDeploymentTime (datetime) --
The time of the last deployment.
nextToken (string) --
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListRobots again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
Exceptions
Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications.
See also: AWS API Documentation
Request Syntax
response = client.list_simulation_applications(
versionQualifier='string',
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
Optional list of filters to limit results.
The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
Information about a filter.
The name of the filter.
A list of values.
dict
Response Syntax
{
'simulationApplicationSummaries': [
{
'name': 'string',
'arn': 'string',
'version': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'robotSoftwareSuite': {
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
},
'simulationSoftwareSuite': {
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
}
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
simulationApplicationSummaries (list) --
A list of simulation application summaries that meet the criteria of the request.
(dict) --
Summary information for a simulation application.
name (string) --
The name of the simulation application.
arn (string) --
The Amazon Resource Name (ARN) of the simulation application.
version (string) --
The version of the simulation application.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation application was last updated.
robotSoftwareSuite (dict) --
Information about a robot software suite (ROS distribution).
name (string) --
The name of the robot software suite (ROS distribution).
version (string) --
The version of the robot software suite (ROS distribution).
simulationSoftwareSuite (dict) --
Information about a simulation software suite.
name (string) --
The name of the simulation software suite.
version (string) --
The version of the simulation software suite.
nextToken (string) --
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationApplications again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
Exceptions
Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs.
See also: AWS API Documentation
Request Syntax
response = client.list_simulation_job_batches(
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
Optional filters to limit results.
Information about a filter.
The name of the filter.
A list of values.
dict
Response Syntax
{
'simulationJobBatchSummaries': [
{
'arn': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'createdAt': datetime(2015, 1, 1),
'status': 'Pending'|'InProgress'|'Failed'|'Completed'|'Canceled'|'Canceling'|'Completing'|'TimingOut'|'TimedOut',
'failedRequestCount': 123,
'pendingRequestCount': 123,
'createdRequestCount': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
simulationJobBatchSummaries (list) --
A list of simulation job batch summaries.
(dict) --
Information about a simulation job batch.
arn (string) --
The Amazon Resource Name (ARN) of the batch.
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.
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.
failedRequestCount (integer) --
The number of failed simulation job requests.
pendingRequestCount (integer) --
The number of pending simulation job requests.
createdRequestCount (integer) --
The number of created simulation job requests.
nextToken (string) --
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobBatches again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
Exceptions
Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs.
See also: AWS API Documentation
Request Syntax
response = client.list_simulation_jobs(
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
Optional filters to limit results.
The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running .
Information about a filter.
The name of the filter.
A list of values.
dict
Response Syntax
{
'simulationJobSummaries': [
{
'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',
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
simulationJobSummaries (list) --
A list of simulation job summaries that meet the criteria of the request.
(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.
robotApplicationNames (list) --
A list of simulation job robot application names.
dataSourceNames (list) --
The names of the data sources.
nextToken (string) --
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListSimulationJobs again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
Exceptions
Lists all tags on a AWS RoboMaker resource.
See also: AWS API Documentation
Request Syntax
response = client.list_tags_for_resource(
resourceArn='string'
)
[REQUIRED]
The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.
{
'tags': {
'string': 'string'
}
}
Response Structure
The list of all tags added to the specified resource.
Exceptions
Lists world export jobs.
See also: AWS API Documentation
Request Syntax
response = client.list_world_export_jobs(
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
Optional filters to limit results. You can use generationJobId and templateId .
Information about a filter.
The name of the filter.
A list of values.
dict
Response Syntax
{
'worldExportJobSummaries': [
{
'arn': 'string',
'status': 'Pending'|'Running'|'Completed'|'Failed'|'Canceling'|'Canceled',
'createdAt': datetime(2015, 1, 1),
'worlds': [
'string',
]
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
worldExportJobSummaries (list) --
Summary information for world export jobs.
(dict) --
Information about a world export job.
arn (string) --
The Amazon Resource Name (ARN) of the world export job.
status (string) --
The status of the world export job.
Pending
The world export job request is pending.
Running
The world export job is running.
Completed
The world export job completed.
Failed
The world export job failed. See failureCode for more information.
Canceled
The world export job was cancelled.
Canceling
The world export job is being cancelled.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the world export job was created.
worlds (list) --
A list of worlds.
nextToken (string) --
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldExportJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
Exceptions
Lists world generator jobs.
See also: AWS API Documentation
Request Syntax
response = client.list_world_generation_jobs(
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
Optional filters to limit results. You can use status and templateId .
Information about a filter.
The name of the filter.
A list of values.
dict
Response Syntax
{
'worldGenerationJobSummaries': [
{
'arn': 'string',
'template': 'string',
'createdAt': datetime(2015, 1, 1),
'status': 'Pending'|'Running'|'Completed'|'Failed'|'PartialFailed'|'Canceling'|'Canceled',
'worldCount': {
'floorplanCount': 123,
'interiorCountPerFloorplan': 123
},
'succeededWorldCount': 123,
'failedWorldCount': 123
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
worldGenerationJobSummaries (list) --
Summary information for world generator jobs.
(dict) --
Information about a world generator job.
arn (string) --
The Amazon Resource Name (ARN) of the world generator job.
template (string) --
The Amazon Resource Name (arn) of the world template.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the world generator job was created.
status (string) --
The status of the world generator job:
Pending
The world generator job request is pending.
Running
The world generator job is running.
Completed
The world generator job completed.
Failed
The world generator job failed. See failureCode for more information.
PartialFailed
Some worlds did not generate.
Canceled
The world generator job was cancelled.
Canceling
The world generator job is being cancelled.
worldCount (dict) --
Information about the world count.
floorplanCount (integer) --
The number of unique floorplans.
interiorCountPerFloorplan (integer) --
The number of unique interiors per floorplan.
succeededWorldCount (integer) --
The number of worlds that were generated.
failedWorldCount (integer) --
The number of worlds that failed.
nextToken (string) --
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldGeneratorJobsRequest again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
Exceptions
Lists world templates.
See also: AWS API Documentation
Request Syntax
response = client.list_world_templates(
nextToken='string',
maxResults=123
)
dict
Response Syntax
{
'templateSummaries': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'name': 'string',
'version': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
templateSummaries (list) --
Summary information for templates.
(dict) --
Summary information for a template.
arn (string) --
The Amazon Resource Name (ARN) of the template.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the template was created.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the template was last updated.
name (string) --
The name of the template.
version (string) --
The version of the template that you're using.
nextToken (string) --
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorldTemplates again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
Exceptions
Lists worlds.
See also: AWS API Documentation
Request Syntax
response = client.list_worlds(
nextToken='string',
maxResults=123,
filters=[
{
'name': 'string',
'values': [
'string',
]
},
]
)
Optional filters to limit results. You can use status .
Information about a filter.
The name of the filter.
A list of values.
dict
Response Syntax
{
'worldSummaries': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'generationJob': 'string',
'template': 'string'
},
],
'nextToken': 'string'
}
Response Structure
(dict) --
worldSummaries (list) --
Summary information for worlds.
(dict) --
Information about a world.
arn (string) --
The Amazon Resource Name (ARN) of the world.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the world was created.
generationJob (string) --
The Amazon Resource Name (arn) of the world generation job.
template (string) --
The Amazon Resource Name (arn) of the world template.
nextToken (string) --
If the previous paginated request did not return all of the remaining results, the response object's nextToken parameter value is set to a token. To retrieve the next set of results, call ListWorlds again and assign that token to the request object's nextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.
Exceptions
Registers a robot with a fleet.
See also: AWS API Documentation
Request Syntax
response = client.register_robot(
fleet='string',
robot='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the fleet.
[REQUIRED]
The Amazon Resource Name (ARN) of the robot.
dict
Response Syntax
{
'fleet': 'string',
'robot': 'string'
}
Response Structure
(dict) --
fleet (string) --
The Amazon Resource Name (ARN) of the fleet that the robot will join.
robot (string) --
Information about the robot registration.
Exceptions
Restarts a running simulation job.
See also: AWS API Documentation
Request Syntax
response = client.restart_simulation_job(
job='string'
)
[REQUIRED]
The Amazon Resource Name (ARN) of the simulation job.
{}
Response Structure
Exceptions
Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects.
See also: AWS API Documentation
Request Syntax
response = 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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'worldConfigs': [
{
'world': 'string'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'dataSources': [
{
'name': 'string',
's3Bucket': 'string',
's3Keys': [
'string',
]
},
],
'vpcConfig': {
'subnets': [
'string',
],
'securityGroups': [
'string',
],
'assignPublicIp': True|False
},
'compute': {
'simulationUnitLimit': 123
},
'tags': {
'string': 'string'
}
},
],
tags={
'string': 'string'
}
)
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
The batch policy.
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 .
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.
[REQUIRED]
A list of simulation job requests to create in the batch.
Information about a simulation job request.
The output location.
The S3 bucket for output.
The S3 folder in the s3Bucket where output files will be placed.
The logging configuration.
A boolean indicating whether to record all ROS topics.
The maximum simulation job duration in seconds. The value must be 8 days (691,200 seconds) or less.
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.
The failure behavior the simulation job.
Continue
Leaves the host running for its maximum timeout duration after a 4XX error code.
Fail
Stop the simulation job and terminate the instance.
A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
The robot applications to use in the simulation job.
Application configuration information for a robot.
The application information for the robot application.
The version of the robot application.
The launch configuration for the robot application.
The package name.
The launch file name.
The environment variables for the application launch.
The port forwarding configuration.
The port mappings for the configuration.
An object representing a port mapping.
The port number on the simulation job instance to use as a remote connection point.
The port number on the application.
A Boolean indicating whether to enable this port mapping on public IP.
Boolean indicating whether a streaming session will be configured for the application. If True , AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
The upload configurations for the robot application.
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
Information about tools configured for the robot application.
Information about a tool. Tools are used in a simulation job.
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
The name of the tool.
Command-line arguments for the tool. It must include the tool executable name.
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
The simulation applications to use in the simulation job.
Information about a simulation application configuration.
The application information for the simulation application.
The version of the simulation application.
The launch configuration for the simulation application.
The package name.
The launch file name.
The environment variables for the application launch.
The port forwarding configuration.
The port mappings for the configuration.
An object representing a port mapping.
The port number on the simulation job instance to use as a remote connection point.
The port number on the application.
A Boolean indicating whether to enable this port mapping on public IP.
Boolean indicating whether a streaming session will be configured for the application. If True , AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface.
Information about upload configurations for the simulation application.
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
A list of world configurations.
Configuration information for a world.
The world generated by Simulation WorldForge.
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
Information about tools configured for the simulation application.
Information about a tool. Tools are used in a simulation job.
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
The name of the tool.
Command-line arguments for the tool. It must include the tool executable name.
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
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.
Information about a data source.
The name of the data source.
The S3 bucket where the data files are located.
The list of S3 keys identifying the data source files.
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.
A list of one or more subnet IDs in your VPC.
A list of one or more security groups IDs in your VPC.
A boolean indicating whether to assign a public IP address.
Compute information for the simulation job
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. The default is 15.
A map that contains tag keys and tag values that are attached to the simulation job request.
A map that contains tag keys and tag values that are attached to the deployment job batch.
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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'worldConfigs': [
{
'world': 'string'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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'|'RobotApplicationHealthCheckFailure'|'SimulationApplicationHealthCheckFailure'|'BadPermissionsRobotApplication'|'BadPermissionsSimulationApplication'|'BadPermissionsS3Object'|'BadPermissionsS3Output'|'BadPermissionsCloudwatchLogs'|'SubnetIpLimitExceeded'|'ENILimitExceeded'|'BadPermissionsUserCredentials'|'InvalidBundleRobotApplication'|'InvalidBundleSimulationApplication'|'InvalidS3Resource'|'ThrottlingError'|'LimitExceeded'|'MismatchedEtag'|'RobotApplicationVersionMismatchedEtag'|'SimulationApplicationVersionMismatchedEtag'|'ResourceNotFound'|'RequestThrottled'|'BatchTimedOut'|'BatchCanceled'|'InvalidInput'|'WrongRegionS3Bucket'|'WrongRegionS3Output'|'WrongRegionRobotApplication'|'WrongRegionSimulationApplication'|'UploadContentMismatchError',
'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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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
},
'uploadConfigurations': [
{
'name': 'string',
'path': 'string',
'uploadBehavior': 'UPLOAD_ON_TERMINATE'|'UPLOAD_ROLLING_AUTO_REMOVE'
},
],
'worldConfigs': [
{
'world': 'string'
},
],
'useDefaultUploadConfigurations': True|False,
'tools': [
{
'streamUI': True|False,
'name': 'string',
'command': 'string',
'streamOutputToCloudWatch': True|False,
'exitBehavior': 'FAIL'|'RESTART'
},
],
'useDefaultTools': True|False
},
],
'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
Leaves the host running for its maximum timeout duration after a 4XX error code.
Fail
Stop the simulation job and terminate the instance.
useDefaultApplications (boolean) --
A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
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.
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 launch the component. It must have a graphical user interface.
uploadConfigurations (list) --
The upload configurations for the robot application.
(dict) --
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
name (string) --
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
path (string) --
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
uploadBehavior (string) --
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
useDefaultUploadConfigurations (boolean) --
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
tools (list) --
Information about tools configured for the robot application.
(dict) --
Information about a tool. Tools are used in a simulation job.
streamUI (boolean) --
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
name (string) --
The name of the tool.
command (string) --
Command-line arguments for the tool. It must include the tool executable name.
streamOutputToCloudWatch (boolean) --
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
exitBehavior (string) --
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
useDefaultTools (boolean) --
A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
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.
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 launch the component. It must have a graphical user interface.
uploadConfigurations (list) --
Information about upload configurations for the simulation application.
(dict) --
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
name (string) --
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
path (string) --
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
uploadBehavior (string) --
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
worldConfigs (list) --
A list of world configurations.
(dict) --
Configuration information for a world.
world (string) --
The world generated by Simulation WorldForge.
useDefaultUploadConfigurations (boolean) --
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
tools (list) --
Information about tools configured for the simulation application.
(dict) --
Information about a tool. Tools are used in a simulation job.
streamUI (boolean) --
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
name (string) --
The name of the tool.
command (string) --
Command-line arguments for the tool. It must include the tool executable name.
streamOutputToCloudWatch (boolean) --
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
exitBehavior (string) --
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
useDefaultTools (boolean) --
A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
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.
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.
securityGroups (list) --
A list of one or more security groups IDs in your VPC.
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. The default is 15.
tags (dict) --
A map that contains tag keys and tag values that are attached to the simulation job request.
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
Leaves the host running for its maximum timeout duration after a 4XX error code.
Fail
Stop the simulation job and terminate the instance.
useDefaultApplications (boolean) --
A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access.
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.
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 launch the component. It must have a graphical user interface.
uploadConfigurations (list) --
The upload configurations for the robot application.
(dict) --
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
name (string) --
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
path (string) --
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
uploadBehavior (string) --
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
useDefaultUploadConfigurations (boolean) --
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
tools (list) --
Information about tools configured for the robot application.
(dict) --
Information about a tool. Tools are used in a simulation job.
streamUI (boolean) --
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
name (string) --
The name of the tool.
command (string) --
Command-line arguments for the tool. It must include the tool executable name.
streamOutputToCloudWatch (boolean) --
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
exitBehavior (string) --
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
useDefaultTools (boolean) --
A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
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.
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 launch the component. It must have a graphical user interface.
uploadConfigurations (list) --
Information about upload configurations for the simulation application.
(dict) --
Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
name (string) --
A prefix that specifies where files will be uploaded in Amazon S3. It is appended to the simulation output location to determine the final path.
For example, if your simulation output location is s3://my-bucket and your upload configuration name is robot-test , your files will be uploaded to s3://my-bucket/<simid>/<runid>/robot-test .
path (string) --
Specifies the path of the file(s) to upload. Standard Unix glob matching rules are accepted, with the addition of ** as a super asterisk . For example, specifying /var/log/**.log causes all .log files in the /var/log directory tree to be collected. For more examples, see Glob Library .
uploadBehavior (string) --
Specifies when to upload the files:
UPLOAD_ON_TERMINATE
Matching files are uploaded once the simulation enters the TERMINATING state. Matching files are not uploaded until all of your code (including tools) have stopped.
If there is a problem uploading a file, the upload is retried. If problems persist, no further upload attempts will be made.
UPLOAD_ROLLING_AUTO_REMOVE
Matching files are uploaded as they are created. They are deleted after they are uploaded. The specified path is checked every 5 seconds. A final check is made when all of your code (including tools) have stopped.
worldConfigs (list) --
A list of world configurations.
(dict) --
Configuration information for a world.
world (string) --
The world generated by Simulation WorldForge.
useDefaultUploadConfigurations (boolean) --
A Boolean indicating whether to use default upload configurations. By default, .ros and .gazebo files are uploaded when the application terminates and all ROS topics will be recorded.
If you set this value, you must specify an outputLocation .
tools (list) --
Information about tools configured for the simulation application.
(dict) --
Information about a tool. Tools are used in a simulation job.
streamUI (boolean) --
Boolean indicating whether a streaming session will be configured for the tool. If True , AWS RoboMaker will configure a connection so you can interact with the tool as it is running in the simulation. It must have a graphical user interface. The default is False .
name (string) --
The name of the tool.
command (string) --
Command-line arguments for the tool. It must include the tool executable name.
streamOutputToCloudWatch (boolean) --
Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is False .
exitBehavior (string) --
Exit behavior determines what happens when your tool quits running. RESTART will cause your tool to be restarted. FAIL will cause your job to exit. The default is RESTART .
useDefaultTools (boolean) --
A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is False .
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.
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.
securityGroups (list) --
A list of one or more security groups IDs in your VPC.
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. The default is 15.
tags (dict) --
A map that contains tag keys and tag values that are attached to the simulation job request.
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.
robotApplicationNames (list) --
A list of simulation job robot application names.
dataSourceNames (list) --
The names of the data sources.
tags (dict) --
A map that contains tag keys and tag values that are attached to the deployment job batch.
Exceptions
Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.
See also: AWS API Documentation
Request Syntax
response = client.sync_deployment_job(
clientRequestToken='string',
fleet='string'
)
[REQUIRED]
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
This field is autopopulated if not provided.
[REQUIRED]
The target fleet for the synchronization.
dict
Response Syntax
{
'arn': 'string',
'fleet': 'string',
'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
'deploymentConfig': {
'concurrentDeploymentPercentage': 123,
'failureThresholdPercentage': 123,
'robotDeploymentTimeoutInSeconds': 123,
'downloadConditionFile': {
'bucket': 'string',
'key': 'string',
'etag': 'string'
}
},
'deploymentApplicationConfigs': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'preLaunchFile': 'string',
'launchFile': 'string',
'postLaunchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'InvalidGreengrassGroup'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'LambdaDeleted'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'DownloadConditionFailed'|'BadLambdaAssociated'|'InternalServerError'|'RobotApplicationDoesNotExist'|'DeploymentFleetDoesNotExist'|'FleetDeploymentTimeout',
'createdAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the synchronization request.
fleet (string) --
The Amazon Resource Name (ARN) of the fleet.
status (string) --
The status of the synchronization job.
deploymentConfig (dict) --
Information about the deployment configuration.
concurrentDeploymentPercentage (integer) --
The percentage of robots receiving the deployment at the same time.
failureThresholdPercentage (integer) --
The percentage of deployments that need to fail before stopping deployment.
robotDeploymentTimeoutInSeconds (integer) --
The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.
downloadConditionFile (dict) --
The download condition file.
bucket (string) --
The bucket containing the object.
key (string) --
The key of the object.
etag (string) --
The etag of the object.
deploymentApplicationConfigs (list) --
Information about the deployment application configurations.
(dict) --
Information about a deployment application configuration.
application (string) --
The Amazon Resource Name (ARN) of the robot application.
applicationVersion (string) --
The version of the application.
launchConfig (dict) --
The launch configuration.
packageName (string) --
The package name.
preLaunchFile (string) --
The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile (string) --
The launch file name.
postLaunchFile (string) --
The deployment post-launch file. This file will be executed after the launch file.
environmentVariables (dict) --
An array of key/value pairs specifying environment variables for the robot application
failureReason (string) --
The failure reason if the job fails.
failureCode (string) --
The failure code if the job fails:
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.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the fleet was created.
Exceptions
Adds or edits tags for a AWS RoboMaker resource.
Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty strings.
For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide .
See also: AWS API Documentation
Request Syntax
response = client.tag_resource(
resourceArn='string',
tags={
'string': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.
[REQUIRED]
A map that contains tag keys and tag values that are attached to the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Removes the specified tags from the specified AWS RoboMaker resource.
To remove a tag, specify the tag key. To change the tag value of an existing tag key, use ` TagResource https://docs.aws.amazon.com/robomaker/latest/dg/API_TagResource.html`__ .
See also: AWS API Documentation
Request Syntax
response = client.untag_resource(
resourceArn='string',
tagKeys=[
'string',
]
)
[REQUIRED]
The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.
[REQUIRED]
A map that contains tag keys and tag values that will be unattached from the resource.
dict
Response Syntax
{}
Response Structure
Exceptions
Updates a robot application.
See also: AWS API Documentation
Request Syntax
response = client.update_robot_application(
application='string',
sources=[
{
's3Bucket': 'string',
's3Key': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
robotSoftwareSuite={
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
},
currentRevisionId='string',
environment={
'uri': 'string'
}
)
[REQUIRED]
The application information for the robot application.
The sources of the robot application.
Information about a source configuration.
The Amazon S3 bucket name.
The s3 object key.
The target processor architecture for the application.
[REQUIRED]
The robot software suite (ROS distribution) used by the robot application.
The name of the robot software suite (ROS distribution).
The version of the robot software suite (ROS distribution).
The object that contains the Docker image URI for your robot application.
The Docker image URI for either your robot or simulation applications.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'version': 'string',
'sources': [
{
's3Bucket': 'string',
's3Key': 'string',
'etag': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
'robotSoftwareSuite': {
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
},
'lastUpdatedAt': datetime(2015, 1, 1),
'revisionId': 'string',
'environment': {
'uri': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the updated robot application.
name (string) --
The name of the robot application.
version (string) --
The version of the robot application.
sources (list) --
The sources of the robot application.
(dict) --
Information about a source.
s3Bucket (string) --
The s3 bucket name.
s3Key (string) --
The s3 object key.
etag (string) --
A hash of the object specified by s3Bucket and s3Key .
architecture (string) --
The taget processor architecture for the application.
robotSoftwareSuite (dict) --
The robot software suite (ROS distribution) used by the robot application.
name (string) --
The name of the robot software suite (ROS distribution).
version (string) --
The version of the robot software suite (ROS distribution).
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the robot application was last updated.
revisionId (string) --
The revision id of the robot application.
environment (dict) --
The object that contains the Docker image URI for your robot application.
uri (string) --
The Docker image URI for either your robot or simulation applications.
Exceptions
Updates a simulation application.
See also: AWS API Documentation
Request Syntax
response = client.update_simulation_application(
application='string',
sources=[
{
's3Bucket': 'string',
's3Key': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
simulationSoftwareSuite={
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
},
robotSoftwareSuite={
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
},
renderingEngine={
'name': 'OGRE',
'version': 'string'
},
currentRevisionId='string',
environment={
'uri': 'string'
}
)
[REQUIRED]
The application information for the simulation application.
The sources of the simulation application.
Information about a source configuration.
The Amazon S3 bucket name.
The s3 object key.
The target processor architecture for the application.
[REQUIRED]
The simulation software suite used by the simulation application.
The name of the simulation software suite.
The version of the simulation software suite.
[REQUIRED]
Information about the robot software suite (ROS distribution).
The name of the robot software suite (ROS distribution).
The version of the robot software suite (ROS distribution).
The rendering engine for the simulation application.
The name of the rendering engine.
The version of the rendering engine.
The object that contains the Docker image URI for your simulation application.
The Docker image URI for either your robot or simulation applications.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'version': 'string',
'sources': [
{
's3Bucket': 'string',
's3Key': 'string',
'etag': 'string',
'architecture': 'X86_64'|'ARM64'|'ARMHF'
},
],
'simulationSoftwareSuite': {
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
},
'robotSoftwareSuite': {
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
},
'renderingEngine': {
'name': 'OGRE',
'version': 'string'
},
'lastUpdatedAt': datetime(2015, 1, 1),
'revisionId': 'string',
'environment': {
'uri': 'string'
}
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (ARN) of the updated simulation application.
name (string) --
The name of the simulation application.
version (string) --
The version of the robot application.
sources (list) --
The sources of the simulation application.
(dict) --
Information about a source.
s3Bucket (string) --
The s3 bucket name.
s3Key (string) --
The s3 object key.
etag (string) --
A hash of the object specified by s3Bucket and s3Key .
architecture (string) --
The taget processor architecture for the application.
simulationSoftwareSuite (dict) --
The simulation software suite used by the simulation application.
name (string) --
The name of the simulation software suite.
version (string) --
The version of the simulation software suite.
robotSoftwareSuite (dict) --
Information about the robot software suite (ROS distribution).
name (string) --
The name of the robot software suite (ROS distribution).
version (string) --
The version of the robot software suite (ROS distribution).
renderingEngine (dict) --
The rendering engine for the simulation application.
name (string) --
The name of the rendering engine.
version (string) --
The version of the rendering engine.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation application was last updated.
revisionId (string) --
The revision id of the simulation application.
environment (dict) --
The object that contains the Docker image URI used for your simulation application.
uri (string) --
The Docker image URI for either your robot or simulation applications.
Exceptions
Updates a world template.
See also: AWS API Documentation
Request Syntax
response = client.update_world_template(
template='string',
name='string',
templateBody='string',
templateLocation={
's3Bucket': 'string',
's3Key': 'string'
}
)
[REQUIRED]
The Amazon Resource Name (arn) of the world template to update.
The location of the world template.
The Amazon S3 bucket name.
The list of S3 keys identifying the data source files.
dict
Response Syntax
{
'arn': 'string',
'name': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1)
}
Response Structure
(dict) --
arn (string) --
The Amazon Resource Name (arn) of the world template.
name (string) --
The name of the world template.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the world template was created.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the world template was last updated.
Exceptions
The available paginators are:
paginator = client.get_paginator('list_deployment_jobs')
Creates an iterator that will paginate through responses from RoboMaker.Client.list_deployment_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Optional filters to limit results.
The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status InProgress or the status Pending .
Information about a filter.
The name of the filter.
A list of values.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'deploymentJobs': [
{
'arn': 'string',
'fleet': 'string',
'status': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
'deploymentApplicationConfigs': [
{
'application': 'string',
'applicationVersion': 'string',
'launchConfig': {
'packageName': 'string',
'preLaunchFile': 'string',
'launchFile': 'string',
'postLaunchFile': 'string',
'environmentVariables': {
'string': 'string'
}
}
},
],
'deploymentConfig': {
'concurrentDeploymentPercentage': 123,
'failureThresholdPercentage': 123,
'robotDeploymentTimeoutInSeconds': 123,
'downloadConditionFile': {
'bucket': 'string',
'key': 'string',
'etag': 'string'
}
},
'failureReason': 'string',
'failureCode': 'ResourceNotFound'|'EnvironmentSetupError'|'EtagMismatch'|'FailureThresholdBreached'|'RobotDeploymentAborted'|'RobotDeploymentNoResponse'|'RobotAgentConnectionTimeout'|'GreengrassDeploymentFailed'|'InvalidGreengrassGroup'|'MissingRobotArchitecture'|'MissingRobotApplicationArchitecture'|'MissingRobotDeploymentResource'|'GreengrassGroupVersionDoesNotExist'|'LambdaDeleted'|'ExtractingBundleFailure'|'PreLaunchFileFailure'|'PostLaunchFileFailure'|'BadPermissionError'|'DownloadConditionFailed'|'BadLambdaAssociated'|'InternalServerError'|'RobotApplicationDoesNotExist'|'DeploymentFleetDoesNotExist'|'FleetDeploymentTimeout',
'createdAt': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
deploymentJobs (list) --
A list of deployment jobs that meet the criteria of the request.
(dict) --
Information about a deployment job.
arn (string) --
The Amazon Resource Name (ARN) of the deployment job.
fleet (string) --
The Amazon Resource Name (ARN) of the fleet.
status (string) --
The status of the deployment job.
deploymentApplicationConfigs (list) --
The deployment application configuration.
(dict) --
Information about a deployment application configuration.
application (string) --
The Amazon Resource Name (ARN) of the robot application.
applicationVersion (string) --
The version of the application.
launchConfig (dict) --
The launch configuration.
packageName (string) --
The package name.
preLaunchFile (string) --
The deployment pre-launch file. This file will be executed prior to the launch file.
launchFile (string) --
The launch file name.
postLaunchFile (string) --
The deployment post-launch file. This file will be executed after the launch file.
environmentVariables (dict) --
An array of key/value pairs specifying environment variables for the robot application
deploymentConfig (dict) --
The deployment configuration.
concurrentDeploymentPercentage (integer) --
The percentage of robots receiving the deployment at the same time.
failureThresholdPercentage (integer) --
The percentage of deployments that need to fail before stopping deployment.
robotDeploymentTimeoutInSeconds (integer) --
The amount of time, in seconds, to wait for deployment to a single robot to complete. Choose a time between 1 minute and 7 days. The default is 5 hours.
downloadConditionFile (dict) --
The download condition file.
bucket (string) --
The bucket containing the object.
key (string) --
The key of the object.
etag (string) --
The etag of the object.
failureReason (string) --
A short description of the reason why the deployment job failed.
failureCode (string) --
The deployment job failure code.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the deployment job was created.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_fleets')
Creates an iterator that will paginate through responses from RoboMaker.Client.list_fleets().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Optional filters to limit results.
The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
Information about a filter.
The name of the filter.
A list of values.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'fleetDetails': [
{
'name': 'string',
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastDeploymentStatus': 'Pending'|'Preparing'|'InProgress'|'Failed'|'Succeeded'|'Canceled',
'lastDeploymentJob': 'string',
'lastDeploymentTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
fleetDetails (list) --
A list of fleet details meeting the request criteria.
(dict) --
Information about a fleet.
name (string) --
The name of the fleet.
arn (string) --
The Amazon Resource Name (ARN) of the fleet.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the fleet was created.
lastDeploymentStatus (string) --
The status of the last fleet deployment.
lastDeploymentJob (string) --
The Amazon Resource Name (ARN) of the last deployment job.
lastDeploymentTime (datetime) --
The time of the last deployment.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_robot_applications')
Creates an iterator that will paginate through responses from RoboMaker.Client.list_robot_applications().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
versionQualifier='string',
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Optional filters to limit results.
The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
Information about a filter.
The name of the filter.
A list of values.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'robotApplicationSummaries': [
{
'name': 'string',
'arn': 'string',
'version': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'robotSoftwareSuite': {
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
robotApplicationSummaries (list) --
A list of robot application summaries that meet the criteria of the request.
(dict) --
Summary information for a robot application.
name (string) --
The name of the robot application.
arn (string) --
The Amazon Resource Name (ARN) of the robot.
version (string) --
The version of the robot application.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the robot application was last updated.
robotSoftwareSuite (dict) --
Information about a robot software suite (ROS distribution).
name (string) --
The name of the robot software suite (ROS distribution).
version (string) --
The version of the robot software suite (ROS distribution).
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_robots')
Creates an iterator that will paginate through responses from RoboMaker.Client.list_robots().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Optional filters to limit results.
The filter names status and fleetName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Registered or the status Available .
Information about a filter.
The name of the filter.
A list of values.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'robots': [
{
'arn': 'string',
'name': 'string',
'fleetArn': 'string',
'status': 'Available'|'Registered'|'PendingNewDeployment'|'Deploying'|'Failed'|'InSync'|'NoResponse',
'greenGrassGroupId': 'string',
'createdAt': datetime(2015, 1, 1),
'architecture': 'X86_64'|'ARM64'|'ARMHF',
'lastDeploymentJob': 'string',
'lastDeploymentTime': datetime(2015, 1, 1)
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
robots (list) --
A list of robots that meet the criteria of the request.
(dict) --
Information about a robot.
arn (string) --
The Amazon Resource Name (ARN) of the robot.
name (string) --
The name of the robot.
fleetArn (string) --
The Amazon Resource Name (ARN) of the fleet.
status (string) --
The status of the robot.
greenGrassGroupId (string) --
The Greengrass group associated with the robot.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the robot was created.
architecture (string) --
The architecture of the robot.
lastDeploymentJob (string) --
The Amazon Resource Name (ARN) of the last deployment job.
lastDeploymentTime (datetime) --
The time of the last deployment.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_simulation_applications')
Creates an iterator that will paginate through responses from RoboMaker.Client.list_simulation_applications().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
versionQualifier='string',
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Optional list of filters to limit results.
The filter name name is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.
Information about a filter.
The name of the filter.
A list of values.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'simulationApplicationSummaries': [
{
'name': 'string',
'arn': 'string',
'version': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'robotSoftwareSuite': {
'name': 'ROS'|'ROS2',
'version': 'Kinetic'|'Melodic'|'Dashing'|'Foxy'
},
'simulationSoftwareSuite': {
'name': 'Gazebo'|'RosbagPlay',
'version': 'string'
}
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
simulationApplicationSummaries (list) --
A list of simulation application summaries that meet the criteria of the request.
(dict) --
Summary information for a simulation application.
name (string) --
The name of the simulation application.
arn (string) --
The Amazon Resource Name (ARN) of the simulation application.
version (string) --
The version of the simulation application.
lastUpdatedAt (datetime) --
The time, in milliseconds since the epoch, when the simulation application was last updated.
robotSoftwareSuite (dict) --
Information about a robot software suite (ROS distribution).
name (string) --
The name of the robot software suite (ROS distribution).
version (string) --
The version of the robot software suite (ROS distribution).
simulationSoftwareSuite (dict) --
Information about a simulation software suite.
name (string) --
The name of the simulation software suite.
version (string) --
The version of the simulation software suite.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_simulation_job_batches')
Creates an iterator that will paginate through responses from RoboMaker.Client.list_simulation_job_batches().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Optional filters to limit results.
Information about a filter.
The name of the filter.
A list of values.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'simulationJobBatchSummaries': [
{
'arn': 'string',
'lastUpdatedAt': datetime(2015, 1, 1),
'createdAt': datetime(2015, 1, 1),
'status': 'Pending'|'InProgress'|'Failed'|'Completed'|'Canceled'|'Canceling'|'Completing'|'TimingOut'|'TimedOut',
'failedRequestCount': 123,
'pendingRequestCount': 123,
'createdRequestCount': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
simulationJobBatchSummaries (list) --
A list of simulation job batch summaries.
(dict) --
Information about a simulation job batch.
arn (string) --
The Amazon Resource Name (ARN) of the batch.
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.
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.
failedRequestCount (integer) --
The number of failed simulation job requests.
pendingRequestCount (integer) --
The number of pending simulation job requests.
createdRequestCount (integer) --
The number of created simulation job requests.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_simulation_jobs')
Creates an iterator that will paginate through responses from RoboMaker.Client.list_simulation_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Optional filters to limit results.
The filter names status and simulationApplicationName and robotApplicationName are supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters, but they must be for the same named item. For example, if you are looking for items with the status Preparing or the status Running .
Information about a filter.
The name of the filter.
A list of values.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'simulationJobSummaries': [
{
'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',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
simulationJobSummaries (list) --
A list of simulation job summaries that meet the criteria of the request.
(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.
robotApplicationNames (list) --
A list of simulation job robot application names.
dataSourceNames (list) --
The names of the data sources.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_world_export_jobs')
Creates an iterator that will paginate through responses from RoboMaker.Client.list_world_export_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Optional filters to limit results. You can use generationJobId and templateId .
Information about a filter.
The name of the filter.
A list of values.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'worldExportJobSummaries': [
{
'arn': 'string',
'status': 'Pending'|'Running'|'Completed'|'Failed'|'Canceling'|'Canceled',
'createdAt': datetime(2015, 1, 1),
'worlds': [
'string',
]
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
worldExportJobSummaries (list) --
Summary information for world export jobs.
(dict) --
Information about a world export job.
arn (string) --
The Amazon Resource Name (ARN) of the world export job.
status (string) --
The status of the world export job.
Pending
The world export job request is pending.
Running
The world export job is running.
Completed
The world export job completed.
Failed
The world export job failed. See failureCode for more information.
Canceled
The world export job was cancelled.
Canceling
The world export job is being cancelled.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the world export job was created.
worlds (list) --
A list of worlds.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_world_generation_jobs')
Creates an iterator that will paginate through responses from RoboMaker.Client.list_world_generation_jobs().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Optional filters to limit results. You can use status and templateId .
Information about a filter.
The name of the filter.
A list of values.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'worldGenerationJobSummaries': [
{
'arn': 'string',
'template': 'string',
'createdAt': datetime(2015, 1, 1),
'status': 'Pending'|'Running'|'Completed'|'Failed'|'PartialFailed'|'Canceling'|'Canceled',
'worldCount': {
'floorplanCount': 123,
'interiorCountPerFloorplan': 123
},
'succeededWorldCount': 123,
'failedWorldCount': 123
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
worldGenerationJobSummaries (list) --
Summary information for world generator jobs.
(dict) --
Information about a world generator job.
arn (string) --
The Amazon Resource Name (ARN) of the world generator job.
template (string) --
The Amazon Resource Name (arn) of the world template.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the world generator job was created.
status (string) --
The status of the world generator job:
Pending
The world generator job request is pending.
Running
The world generator job is running.
Completed
The world generator job completed.
Failed
The world generator job failed. See failureCode for more information.
PartialFailed
Some worlds did not generate.
Canceled
The world generator job was cancelled.
Canceling
The world generator job is being cancelled.
worldCount (dict) --
Information about the world count.
floorplanCount (integer) --
The number of unique floorplans.
interiorCountPerFloorplan (integer) --
The number of unique interiors per floorplan.
succeededWorldCount (integer) --
The number of worlds that were generated.
failedWorldCount (integer) --
The number of worlds that failed.
NextToken (string) --
A token to resume pagination.
paginator = client.get_paginator('list_world_templates')
Creates an iterator that will paginate through responses from RoboMaker.Client.list_world_templates().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
{
'templateSummaries': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'lastUpdatedAt': datetime(2015, 1, 1),
'name': 'string',
'version': 'string'
},
],
'NextToken': 'string'
}
Response Structure
Summary information for templates.
Summary information for a template.
The Amazon Resource Name (ARN) of the template.
The time, in milliseconds since the epoch, when the template was created.
The time, in milliseconds since the epoch, when the template was last updated.
The name of the template.
The version of the template that you're using.
A token to resume pagination.
paginator = client.get_paginator('list_worlds')
Creates an iterator that will paginate through responses from RoboMaker.Client.list_worlds().
See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate(
filters=[
{
'name': 'string',
'values': [
'string',
]
},
],
PaginationConfig={
'MaxItems': 123,
'PageSize': 123,
'StartingToken': 'string'
}
)
Optional filters to limit results. You can use status .
Information about a filter.
The name of the filter.
A list of values.
A dictionary that provides parameters to control pagination.
The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.
The size of each page.
A token to specify where to start paginating. This is the NextToken from a previous response.
dict
Response Syntax
{
'worldSummaries': [
{
'arn': 'string',
'createdAt': datetime(2015, 1, 1),
'generationJob': 'string',
'template': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
worldSummaries (list) --
Summary information for worlds.
(dict) --
Information about a world.
arn (string) --
The Amazon Resource Name (ARN) of the world.
createdAt (datetime) --
The time, in milliseconds since the epoch, when the world was created.
generationJob (string) --
The Amazon Resource Name (arn) of the world generation job.
template (string) --
The Amazon Resource Name (arn) of the world template.
NextToken (string) --
A token to resume pagination.