logo
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

Information about the batch policy.

Compute information for the simulation job.

Compute information for the simulation job

Information about a data source.

Information about a data source.

Information about a deployment application configuration.

Information about a deployment configuration.

Information about a deployment job.

Configuration information for a deployment launch.

Information about a failed create simulation job request.

Information about worlds that failed.

Information about a filter.

Information about worlds that finished.

Information about a fleet.

Information about a launch configuration.

The logging configuration.

Describes a network interface.

The output location.

Configuration information for port forwarding.

An object representing a port mapping.

Information about the progress of a deployment job.

Information about a rendering engine.

A client for the RoboMaker API.

Information about a robot.

Application configuration information for a robot.

Summary information for a robot application.

Information about a robot deployment.

Information about a robot software suite (ROS distribution).

Information about S3 keys.

Information about an S3 object.

Information about a simulation application configuration.

Summary information for a simulation application.

Information about a simulation job.

Information about a simulation job batch.

Information about a simulation job request.

Summary information for a simulation job.

Information about a simulation software suite.

Information about a source.

Information about a source configuration.

Information about a template location.

Summary information for a template.

Information about a tool. Tools are used in a simulation job.

Provides upload configuration information. Files are uploaded from the simulation job to a location you specify.

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.

VPC configuration associated with your simulation job.

Configuration information for a world.

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 = 1 and interiorCountPerFloorplan = 20. This will result in 20 worlds (floorplanCount * interiorCountPerFloorplan).

If you set floorplanCount = 4 and interiorCountPerFloorplan = 5, there will be 20 worlds with 5 unique floor plans.

Information about a world export job.

Information about a failed world.

Information about a world generator job.

Information about a world.

Enums

Errors returned by BatchDeleteWorlds

Errors returned by BatchDescribeSimulationJob

Errors returned by CancelDeploymentJob

Errors returned by CancelSimulationJobBatch

Errors returned by CancelSimulationJob

Errors returned by CancelWorldExportJob

Errors returned by CancelWorldGenerationJob

Errors returned by CreateDeploymentJob

Errors returned by CreateFleet

Errors returned by CreateRobotApplication

Errors returned by CreateRobotApplicationVersion

Errors returned by CreateRobot

Errors returned by CreateSimulationApplication

Errors returned by CreateSimulationApplicationVersion

Errors returned by CreateSimulationJob

Errors returned by CreateWorldExportJob

Errors returned by CreateWorldGenerationJob

Errors returned by CreateWorldTemplate

Errors returned by DeleteFleet

Errors returned by DeleteRobotApplication

Errors returned by DeleteRobot

Errors returned by DeleteSimulationApplication

Errors returned by DeleteWorldTemplate

Errors returned by DeregisterRobot

Errors returned by DescribeDeploymentJob

Errors returned by DescribeFleet

Errors returned by DescribeRobotApplication

Errors returned by DescribeRobot

Errors returned by DescribeSimulationApplication

Errors returned by DescribeSimulationJobBatch

Errors returned by DescribeSimulationJob

Errors returned by DescribeWorld

Errors returned by DescribeWorldExportJob

Errors returned by DescribeWorldGenerationJob

Errors returned by DescribeWorldTemplate

Errors returned by GetWorldTemplateBody

Errors returned by ListDeploymentJobs

Errors returned by ListFleets

Errors returned by ListRobotApplications

Errors returned by ListRobots

Errors returned by ListSimulationApplications

Errors returned by ListSimulationJobBatches

Errors returned by ListSimulationJobs

Errors returned by ListTagsForResource

Errors returned by ListWorldExportJobs

Errors returned by ListWorldGenerationJobs

Errors returned by ListWorldTemplates

Errors returned by ListWorlds

Errors returned by RegisterRobot

Errors returned by RestartSimulationJob

Errors returned by StartSimulationJobBatch

Errors returned by SyncDeploymentJob

Errors returned by TagResource

Errors returned by UntagResource

Errors returned by UpdateRobotApplication

Errors returned by UpdateSimulationApplication

Errors returned by UpdateWorldTemplate

Traits

Trait representing the capabilities of the RoboMaker API. RoboMaker clients implement this trait.