Expand description
This section provides documentation for the AWS RoboMaker API operations.
If you’re using the service, you’re probably looking for RobomakerClient and Robomaker.
Structs§
- Batch
Delete Worlds Request - Batch
Delete Worlds Response - Batch
Describe Simulation JobRequest - Batch
Describe Simulation JobResponse - Batch
Policy Information about the batch policy.
- Cancel
Deployment JobRequest - Cancel
Deployment JobResponse - Cancel
Simulation JobBatch Request - Cancel
Simulation JobBatch Response - Cancel
Simulation JobRequest - Cancel
Simulation JobResponse - Cancel
World Export JobRequest - Cancel
World Export JobResponse - Cancel
World Generation JobRequest - Cancel
World Generation JobResponse - Compute
Compute information for the simulation job.
- Compute
Response Compute information for the simulation job
- Create
Deployment JobRequest - Create
Deployment JobResponse - Create
Fleet Request - Create
Fleet Response - Create
Robot Application Request - Create
Robot Application Response - Create
Robot Application Version Request - Create
Robot Application Version Response - Create
Robot Request - Create
Robot Response - Create
Simulation Application Request - Create
Simulation Application Response - Create
Simulation Application Version Request - Create
Simulation Application Version Response - Create
Simulation JobRequest - Create
Simulation JobResponse - Create
World Export JobRequest - Create
World Export JobResponse - Create
World Generation JobRequest - Create
World Generation JobResponse - Create
World Template Request - Create
World Template Response - Data
Source Information about a data source.
- Data
Source Config Information about a data source.
- Delete
Fleet Request - Delete
Fleet Response - Delete
Robot Application Request - Delete
Robot Application Response - Delete
Robot Request - Delete
Robot Response - Delete
Simulation Application Request - Delete
Simulation Application Response - Delete
World Template Request - Delete
World Template Response - Deployment
Application Config Information about a deployment application configuration.
- Deployment
Config Information about a deployment configuration.
- Deployment
Job Information about a deployment job.
- Deployment
Launch Config Configuration information for a deployment launch.
- Deregister
Robot Request - Deregister
Robot Response - Describe
Deployment JobRequest - Describe
Deployment JobResponse - Describe
Fleet Request - Describe
Fleet Response - Describe
Robot Application Request - Describe
Robot Application Response - Describe
Robot Request - Describe
Robot Response - Describe
Simulation Application Request - Describe
Simulation Application Response - Describe
Simulation JobBatch Request - Describe
Simulation JobBatch Response - Describe
Simulation JobRequest - Describe
Simulation JobResponse - Describe
World Export JobRequest - Describe
World Export JobResponse - Describe
World Generation JobRequest - Describe
World Generation JobResponse - Describe
World Request - Describe
World Response - Describe
World Template Request - Describe
World Template Response - Failed
Create Simulation JobRequest Information about a failed create simulation job request.
- Failure
Summary Information about worlds that failed.
- Filter
Information about a filter.
- Finished
Worlds Summary Information about worlds that finished.
- Fleet
Information about a fleet.
- GetWorld
Template Body Request - GetWorld
Template Body Response - Launch
Config Information about a launch configuration.
- List
Deployment Jobs Request - List
Deployment Jobs Response - List
Fleets Request - List
Fleets Response - List
Robot Applications Request - List
Robot Applications Response - List
Robots Request - List
Robots Response - List
Simulation Applications Request - List
Simulation Applications Response - List
Simulation JobBatches Request - List
Simulation JobBatches Response - List
Simulation Jobs Request - List
Simulation Jobs Response - List
Tags ForResource Request - List
Tags ForResource Response - List
World Export Jobs Request - List
World Export Jobs Response - List
World Generation Jobs Request - List
World Generation Jobs Response - List
World Templates Request - List
World Templates Response - List
Worlds Request - List
Worlds Response - Logging
Config The logging configuration.
- Network
Interface Describes a network interface.
- Output
Location The output location.
- Port
Forwarding Config Configuration information for port forwarding.
- Port
Mapping An object representing a port mapping.
- Progress
Detail Information about the progress of a deployment job.
- Register
Robot Request - Register
Robot Response - Rendering
Engine Information about a rendering engine.
- Restart
Simulation JobRequest - Restart
Simulation JobResponse - Robomaker
Client - A client for the RoboMaker API.
- Robot
Information about a robot.
- Robot
Application Config Application configuration information for a robot.
- Robot
Application Summary Summary information for a robot application.
- Robot
Deployment Information about a robot deployment.
- Robot
Software Suite Information about a robot software suite (ROS distribution).
- S3Key
Output Information about S3 keys.
- S3Object
Information about an S3 object.
- Simulation
Application Config Information about a simulation application configuration.
- Simulation
Application Summary Summary information for a simulation application.
- Simulation
Job Information about a simulation job.
- Simulation
JobBatch Summary Information about a simulation job batch.
- Simulation
JobRequest Information about a simulation job request.
- Simulation
JobSummary Summary information for a simulation job.
- Simulation
Software Suite Information about a simulation software suite.
- Source
Information about a source.
- Source
Config Information about a source configuration.
- Start
Simulation JobBatch Request - Start
Simulation JobBatch Response - Sync
Deployment JobRequest - Sync
Deployment JobResponse - TagResource
Request - TagResource
Response - Template
Location Information about a template location.
- Template
Summary Summary information for a template.
- Tool
Information about a tool. Tools are used in a simulation job.
- Untag
Resource Request - Untag
Resource Response - Update
Robot Application Request - Update
Robot Application Response - Update
Simulation Application Request - Update
Simulation Application Response - Update
World Template Request - Update
World Template Response - Upload
Configuration Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.
- VPCConfig
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.
- VPCConfig
Response VPC configuration associated with your simulation job.
- World
Config Configuration information for a world.
- World
Count The number of worlds that will be created. You can configure the number of unique floorplans and the number of unique interiors for each floor plan. For example, if you want 1 world with 20 unique interiors, you set
floorplanCount = 1andinteriorCountPerFloorplan = 20. This will result in 20 worlds (floorplanCount*interiorCountPerFloorplan).If you set
floorplanCount = 4andinteriorCountPerFloorplan = 5, there will be 20 worlds with 5 unique floor plans.- World
Export JobSummary Information about a world export job.
- World
Failure Information about a failed world.
- World
Generation JobSummary Information about a world generator job.
- World
Summary Information about a world.
Enums§
- Batch
Delete Worlds Error - Errors returned by BatchDeleteWorlds
- Batch
Describe Simulation JobError - Errors returned by BatchDescribeSimulationJob
- Cancel
Deployment JobError - Errors returned by CancelDeploymentJob
- Cancel
Simulation JobBatch Error - Errors returned by CancelSimulationJobBatch
- Cancel
Simulation JobError - Errors returned by CancelSimulationJob
- Cancel
World Export JobError - Errors returned by CancelWorldExportJob
- Cancel
World Generation JobError - Errors returned by CancelWorldGenerationJob
- Create
Deployment JobError - Errors returned by CreateDeploymentJob
- Create
Fleet Error - Errors returned by CreateFleet
- Create
Robot Application Error - Errors returned by CreateRobotApplication
- Create
Robot Application Version Error - Errors returned by CreateRobotApplicationVersion
- Create
Robot Error - Errors returned by CreateRobot
- Create
Simulation Application Error - Errors returned by CreateSimulationApplication
- Create
Simulation Application Version Error - Errors returned by CreateSimulationApplicationVersion
- Create
Simulation JobError - Errors returned by CreateSimulationJob
- Create
World Export JobError - Errors returned by CreateWorldExportJob
- Create
World Generation JobError - Errors returned by CreateWorldGenerationJob
- Create
World Template Error - Errors returned by CreateWorldTemplate
- Delete
Fleet Error - Errors returned by DeleteFleet
- Delete
Robot Application Error - Errors returned by DeleteRobotApplication
- Delete
Robot Error - Errors returned by DeleteRobot
- Delete
Simulation Application Error - Errors returned by DeleteSimulationApplication
- Delete
World Template Error - Errors returned by DeleteWorldTemplate
- Deregister
Robot Error - Errors returned by DeregisterRobot
- Describe
Deployment JobError - Errors returned by DescribeDeploymentJob
- Describe
Fleet Error - Errors returned by DescribeFleet
- Describe
Robot Application Error - Errors returned by DescribeRobotApplication
- Describe
Robot Error - Errors returned by DescribeRobot
- Describe
Simulation Application Error - Errors returned by DescribeSimulationApplication
- Describe
Simulation JobBatch Error - Errors returned by DescribeSimulationJobBatch
- Describe
Simulation JobError - Errors returned by DescribeSimulationJob
- Describe
World Error - Errors returned by DescribeWorld
- Describe
World Export JobError - Errors returned by DescribeWorldExportJob
- Describe
World Generation JobError - Errors returned by DescribeWorldGenerationJob
- Describe
World Template Error - Errors returned by DescribeWorldTemplate
- GetWorld
Template Body Error - Errors returned by GetWorldTemplateBody
- List
Deployment Jobs Error - Errors returned by ListDeploymentJobs
- List
Fleets Error - Errors returned by ListFleets
- List
Robot Applications Error - Errors returned by ListRobotApplications
- List
Robots Error - Errors returned by ListRobots
- List
Simulation Applications Error - Errors returned by ListSimulationApplications
- List
Simulation JobBatches Error - Errors returned by ListSimulationJobBatches
- List
Simulation Jobs Error - Errors returned by ListSimulationJobs
- List
Tags ForResource Error - Errors returned by ListTagsForResource
- List
World Export Jobs Error - Errors returned by ListWorldExportJobs
- List
World Generation Jobs Error - Errors returned by ListWorldGenerationJobs
- List
World Templates Error - Errors returned by ListWorldTemplates
- List
Worlds Error - Errors returned by ListWorlds
- Register
Robot Error - Errors returned by RegisterRobot
- Restart
Simulation JobError - Errors returned by RestartSimulationJob
- Start
Simulation JobBatch Error - Errors returned by StartSimulationJobBatch
- Sync
Deployment JobError - Errors returned by SyncDeploymentJob
- TagResource
Error - Errors returned by TagResource
- Untag
Resource Error - Errors returned by UntagResource
- Update
Robot Application Error - Errors returned by UpdateRobotApplication
- Update
Simulation Application Error - Errors returned by UpdateSimulationApplication
- Update
World Template Error - Errors returned by UpdateWorldTemplate
Traits§
- Robomaker
- Trait representing the capabilities of the RoboMaker API. RoboMaker clients implement this trait.