AWS RoboMaker
This section provides documentation for the AWS RoboMaker API operations.
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
This section provides documentation for the AWS RoboMaker API operations.
Endpoints 57
- POSTBatchDeleteWorlds
/batchDeleteWorldsDeletes one or more worlds in a batch operation. - POSTBatchDescribeSimulationJob
/batchDescribeSimulationJobDescribes one or more simulation jobs. - POSTCancelDeploymentJob
/cancelDeploymentJobDeprecated. <p>Cancels the specified deployment job.</p> <important> <p>This API will no longer be supported as of May 2, 2022. Use it to remove resources… - POSTCancelSimulationJob
/cancelSimulationJobCancels the specified simulation job. - POSTCancelSimulationJobBatch
/cancelSimulationJobBatchCancels 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. - POSTCancelWorldExportJob
/cancelWorldExportJobCancels the specified export job. - POSTCancelWorldGenerationJob
/cancelWorldGenerationJobCancels the specified world generator job. - POSTCreateDeploymentJob
/createDeploymentJobDeprecated. <p>Deploys a specific version of a robot application to robots in a fleet.</p> <important> <p>This API is no longer supported and will throw an… - POSTCreateFleet
/createFleetDeprecated. <p>Creates a fleet, a logical group of robots running the same robot application.</p> <important> <p>This API is no longer supported and will… - POSTCreateRobot
/createRobotDeprecated. <p>Creates a robot.</p> <important> <p>This API is no longer supported and will throw an error if used.</p> </important> - POSTCreateRobotApplication
/createRobotApplicationCreates a robot application. - POSTCreateRobotApplicationVersion
/createRobotApplicationVersionCreates a version of a robot application. - POSTCreateSimulationApplication
/createSimulationApplicationCreates a simulation application. - POSTCreateSimulationApplicationVersion
/createSimulationApplicationVersionCreates a simulation application with a specific revision id. - POSTCreateSimulationJob
/createSimulationJob<p>Creates a simulation job.</p> <note> <p>After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible. </p> </note> - POSTCreateWorldExportJob
/createWorldExportJobCreates a world export job. - POSTCreateWorldGenerationJob
/createWorldGenerationJobCreates worlds using the specified template. - POSTCreateWorldTemplate
/createWorldTemplateCreates a world template. - POSTDeleteFleet
/deleteFleetDeprecated. <p>Deletes a fleet.</p> <important> <p>This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for… - POSTDeleteRobot
/deleteRobotDeprecated. <p>Deletes a robot.</p> <important> <p>This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for… - POSTDeleteRobotApplication
/deleteRobotApplicationDeletes a robot application. - POSTDeleteSimulationApplication
/deleteSimulationApplicationDeletes a simulation application. - POSTDeleteWorldTemplate
/deleteWorldTemplateDeletes a world template. - POSTDeregisterRobot
/deregisterRobotDeprecated. <p>Deregisters a robot.</p> <important> <p>This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created… - POSTDescribeDeploymentJob
/describeDeploymentJobDeprecated. <p>Describes a deployment job.</p> <important> <p>This API will no longer be supported as of May 2, 2022. Use it to remove resources that were… - POSTDescribeFleet
/describeFleetDeprecated. <p>Describes a fleet.</p> <important> <p>This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for… - POSTDescribeRobot
/describeRobotDeprecated. <p>Describes a robot.</p> <important> <p>This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for… - POSTDescribeRobotApplication
/describeRobotApplicationDescribes a robot application. - POSTDescribeSimulationApplication
/describeSimulationApplicationDescribes a simulation application. - POSTDescribeSimulationJob
/describeSimulationJobDescribes a simulation job. - POSTDescribeSimulationJobBatch
/describeSimulationJobBatchDescribes a simulation job batch. - POSTDescribeWorld
/describeWorldDescribes a world. - POSTDescribeWorldExportJob
/describeWorldExportJobDescribes a world export job. - POSTDescribeWorldGenerationJob
/describeWorldGenerationJobDescribes a world generation job. - POSTDescribeWorldTemplate
/describeWorldTemplateDescribes a world template. - POSTGetWorldTemplateBody
/getWorldTemplateBodyGets the world template body. - POSTListDeploymentJobs
/listDeploymentJobs?maxResults=string&nextToken=stringDeprecated. <p>Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs.</p> <important> <p>This… - POSTListFleets
/listFleets?maxResults=string&nextToken=stringDeprecated. <p>Returns a list of fleets. You can optionally provide filters to retrieve specific fleets.</p> <important> <p>This API will no longer be… - POSTListRobotApplications
/listRobotApplications?maxResults=string&nextToken=stringReturns a list of robot application. You can optionally provide filters to retrieve specific robot applications. - POSTListRobots
/listRobots?maxResults=string&nextToken=stringDeprecated. <p>Returns a list of robots. You can optionally provide filters to retrieve specific robots.</p> <important> <p>This API will no longer be… - POSTListSimulationApplications
/listSimulationApplications?maxResults=string&nextToken=stringReturns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications. - POSTListSimulationJobBatches
/listSimulationJobBatches?maxResults=string&nextToken=stringReturns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs. - POSTListSimulationJobs
/listSimulationJobs?maxResults=string&nextToken=stringReturns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs. - GETListTagsForResource
/tags/:resourceArnLists all tags on a AWS RoboMaker resource. - POSTTagResource
/tags/:resourceArn<p>Adds or edits tags for a AWS RoboMaker resource.</p> <p>Each tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag… - POSTListWorldExportJobs
/listWorldExportJobs?maxResults=string&nextToken=stringLists world export jobs. - POSTListWorldGenerationJobs
/listWorldGenerationJobs?maxResults=string&nextToken=stringLists world generator jobs. - POSTListWorldTemplates
/listWorldTemplates?maxResults=string&nextToken=stringLists world templates. - POSTListWorlds
/listWorlds?maxResults=string&nextToken=stringLists worlds. - POSTRegisterRobot
/registerRobotDeprecated. <p>Registers a robot with a fleet.</p> <important> <p>This API is no longer supported and will throw an error if used.</p> </important> - POSTRestartSimulationJob
/restartSimulationJobRestarts a running simulation job. - POSTStartSimulationJobBatch
/startSimulationJobBatchStarts a new simulation job batch. The batch is defined using one or more <code>SimulationJobRequest</code> objects. - POSTSyncDeploymentJob
/syncDeploymentJobDeprecated. <p>Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.</p> <important> <p>This API… - DELETEUntagResource
/tags/:resourceArn#tagKeys?tagKeys=string<p>Removes the specified tags from the specified AWS RoboMaker resource.</p> <p>To remove a tag, specify the tag key. To change the tag value of an existing… - POSTUpdateRobotApplication
/updateRobotApplicationUpdates a robot application. - POSTUpdateSimulationApplication
/updateSimulationApplicationUpdates a simulation application. - POSTUpdateWorldTemplate
/updateWorldTemplateUpdates a world template.
API details
- Base URL
http://robomaker.{region}.amazonaws.comhttps://robomaker.{region}.amazonaws.comhttp://robomaker.{region}.amazonaws.com.cnhttps://robomaker.{region}.amazonaws.com.cn- Authentication
- An API key in the Authorization header
- Operations
- 57 operations on 56 pathsPOST 55GET 1DELETE 1
15 marked deprecated - Response formats
application/json- Description format
- OpenAPI 3.0.0, API version
2018-06-29 - Links
- Documentation · OpenAPI document · Terms of service · Support
- Listed from
- APIs.guru OpenAPI Directory (CC0-1.0)
Source updated
How to test the AWS RoboMaker in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the AWS RoboMaker collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “BatchDeleteWorlds” (POST /batchDeleteWorlds), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the AWS RoboMaker?
This section provides documentation for the AWS RoboMaker API operations. It is listed under Developer tools and has 57 endpoints.
Who publishes the AWS RoboMaker?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the AWS RoboMaker?
Its description lists 4 base URLs: http://robomaker.{region}.amazonaws.com, https://robomaker.{region}.amazonaws.com, http://robomaker.{region}.amazonaws.com.cn, https://robomaker.{region}.amazonaws.com.cn. The first is the usual one; the others are typically sandbox or regional servers.
How do I authenticate with the AWS RoboMaker?
With an API key in the Authorization header.
How many endpoints does the AWS RoboMaker have?
57 operations on 56 paths (55 POST, 1 GET, 1 DELETE).
Is forking the AWS RoboMaker free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.