1---2name: aws-robomaker3description: AWS RoboMaker API skill. Use when working with AWS RoboMaker for batchDeleteWorlds, batchDescribeSimulationJob, cancelDeploymentJob. Covers 57 endpoints.4---5
6# AWS RoboMaker
7API version: 2018-06-29
8
9## Auth
10AWS SigV4
11
12## Base URL
13Not specified.
14
15## Setup
161. Configure auth: AWS SigV4
172. GET /tags/{resourceArn} -- verify access
183. POST /batchDeleteWorlds -- create first batchDeleteWorlds
19
20## Endpoints
21
2257 endpoints across 55 groups. See references/api-spec.lap for full details.
23
24### batchDeleteWorlds
25| Method | Path | Description |
26|--------|------|-------------|
27| POST | /batchDeleteWorlds | Deletes one or more worlds in a batch operation. |
28
29### batchDescribeSimulationJob
30| Method | Path | Description |
31|--------|------|-------------|
32| POST | /batchDescribeSimulationJob | Describes one or more simulation jobs. |
33
34### cancelDeploymentJob
35| Method | Path | Description |
36|--------|------|-------------|
37| POST | /cancelDeploymentJob | Cancels the specified deployment job. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. |
38
39### cancelSimulationJob
40| Method | Path | Description |
41|--------|------|-------------|
42| POST | /cancelSimulationJob | Cancels the specified simulation job. |
43
44### cancelSimulationJobBatch
45| Method | Path | Description |
46|--------|------|-------------|
47| POST | /cancelSimulationJobBatch | 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. |
48
49### cancelWorldExportJob
50| Method | Path | Description |
51|--------|------|-------------|
52| POST | /cancelWorldExportJob | Cancels the specified export job. |
53
54### cancelWorldGenerationJob
55| Method | Path | Description |
56|--------|------|-------------|
57| POST | /cancelWorldGenerationJob | Cancels the specified world generator job. |
58
59### createDeploymentJob
60| Method | Path | Description |
61|--------|------|-------------|
62| POST | /createDeploymentJob | Deploys a specific version of a robot application to robots in a fleet. This API is no longer supported and will throw an error if used. 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. After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible. |
63
64### createFleet
65| Method | Path | Description |
66|--------|------|-------------|
67| POST | /createFleet | Creates a fleet, a logical group of robots running the same robot application. This API is no longer supported and will throw an error if used. |
68
69### createRobot
70| Method | Path | Description |
71|--------|------|-------------|
72| POST | /createRobot | Creates a robot. This API is no longer supported and will throw an error if used. |
73
74### createRobotApplication
75| Method | Path | Description |
76|--------|------|-------------|
77| POST | /createRobotApplication | Creates a robot application. |
78
79### createRobotApplicationVersion
80| Method | Path | Description |
81|--------|------|-------------|
82| POST | /createRobotApplicationVersion | Creates a version of a robot application. |
83
84### createSimulationApplication
85| Method | Path | Description |
86|--------|------|-------------|
87| POST | /createSimulationApplication | Creates a simulation application. |
88
89### createSimulationApplicationVersion
90| Method | Path | Description |
91|--------|------|-------------|
92| POST | /createSimulationApplicationVersion | Creates a simulation application with a specific revision id. |
93
94### createSimulationJob
95| Method | Path | Description |
96|--------|------|-------------|
97| POST | /createSimulationJob | Creates a simulation job. After 90 days, simulation jobs expire and will be deleted. They will no longer be accessible. |
98
99### createWorldExportJob
100| Method | Path | Description |
101|--------|------|-------------|
102| POST | /createWorldExportJob | Creates a world export job. |
103
104### createWorldGenerationJob
105| Method | Path | Description |
106|--------|------|-------------|
107| POST | /createWorldGenerationJob | Creates worlds using the specified template. |
108
109### createWorldTemplate
110| Method | Path | Description |
111|--------|------|-------------|
112| POST | /createWorldTemplate | Creates a world template. |
113
114### deleteFleet
115| Method | Path | Description |
116|--------|------|-------------|
117| POST | /deleteFleet | Deletes a fleet. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. |
118
119### deleteRobot
120| Method | Path | Description |
121|--------|------|-------------|
122| POST | /deleteRobot | Deletes a robot. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. |
123
124### deleteRobotApplication
125| Method | Path | Description |
126|--------|------|-------------|
127| POST | /deleteRobotApplication | Deletes a robot application. |
128
129### deleteSimulationApplication
130| Method | Path | Description |
131|--------|------|-------------|
132| POST | /deleteSimulationApplication | Deletes a simulation application. |
133
134### deleteWorldTemplate
135| Method | Path | Description |
136|--------|------|-------------|
137| POST | /deleteWorldTemplate | Deletes a world template. |
138
139### deregisterRobot
140| Method | Path | Description |
141|--------|------|-------------|
142| POST | /deregisterRobot | Deregisters a robot. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. |
143
144### describeDeploymentJob
145| Method | Path | Description |
146|--------|------|-------------|
147| POST | /describeDeploymentJob | Describes a deployment job. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. |
148
149### describeFleet
150| Method | Path | Description |
151|--------|------|-------------|
152| POST | /describeFleet | Describes a fleet. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. |
153
154### describeRobot
155| Method | Path | Description |
156|--------|------|-------------|
157| POST | /describeRobot | Describes a robot. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. |
158
159### describeRobotApplication
160| Method | Path | Description |
161|--------|------|-------------|
162| POST | /describeRobotApplication | Describes a robot application. |
163
164### describeSimulationApplication
165| Method | Path | Description |
166|--------|------|-------------|
167| POST | /describeSimulationApplication | Describes a simulation application. |
168
169### describeSimulationJob
170| Method | Path | Description |
171|--------|------|-------------|
172| POST | /describeSimulationJob | Describes a simulation job. |
173
174### describeSimulationJobBatch
175| Method | Path | Description |
176|--------|------|-------------|
177| POST | /describeSimulationJobBatch | Describes a simulation job batch. |
178
179### describeWorld
180| Method | Path | Description |
181|--------|------|-------------|
182| POST | /describeWorld | Describes a world. |
183
184### describeWorldExportJob
185| Method | Path | Description |
186|--------|------|-------------|
187| POST | /describeWorldExportJob | Describes a world export job. |
188
189### describeWorldGenerationJob
190| Method | Path | Description |
191|--------|------|-------------|
192| POST | /describeWorldGenerationJob | Describes a world generation job. |
193
194### describeWorldTemplate
195| Method | Path | Description |
196|--------|------|-------------|
197| POST | /describeWorldTemplate | Describes a world template. |
198
199### getWorldTemplateBody
200| Method | Path | Description |
201|--------|------|-------------|
202| POST | /getWorldTemplateBody | Gets the world template body. |
203
204### listDeploymentJobs
205| Method | Path | Description |
206|--------|------|-------------|
207| POST | /listDeploymentJobs | Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. |
208
209### listFleets
210| Method | Path | Description |
211|--------|------|-------------|
212| POST | /listFleets | Returns a list of fleets. You can optionally provide filters to retrieve specific fleets. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. |
213
214### listRobotApplications
215| Method | Path | Description |
216|--------|------|-------------|
217| POST | /listRobotApplications | Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications. |
218
219### listRobots
220| Method | Path | Description |
221|--------|------|-------------|
222| POST | /listRobots | Returns a list of robots. You can optionally provide filters to retrieve specific robots. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. |
223
224### listSimulationApplications
225| Method | Path | Description |
226|--------|------|-------------|
227| POST | /listSimulationApplications | Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications. |
228
229### listSimulationJobBatches
230| Method | Path | Description |
231|--------|------|-------------|
232| POST | /listSimulationJobBatches | Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs. |
233
234### listSimulationJobs
235| Method | Path | Description |
236|--------|------|-------------|
237| POST | /listSimulationJobs | Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs. |
238
239### tags
240| Method | Path | Description |
241|--------|------|-------------|
242| GET | /tags/{resourceArn} | Lists all tags on a AWS RoboMaker resource. |
243| POST | /tags/{resourceArn} | 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. |
244| DELETE | /tags/{resourceArn} | 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 . |
245
246### listWorldExportJobs
247| Method | Path | Description |
248|--------|------|-------------|
249| POST | /listWorldExportJobs | Lists world export jobs. |
250
251### listWorldGenerationJobs
252| Method | Path | Description |
253|--------|------|-------------|
254| POST | /listWorldGenerationJobs | Lists world generator jobs. |
255
256### listWorldTemplates
257| Method | Path | Description |
258|--------|------|-------------|
259| POST | /listWorldTemplates | Lists world templates. |
260
261### listWorlds
262| Method | Path | Description |
263|--------|------|-------------|
264| POST | /listWorlds | Lists worlds. |
265
266### registerRobot
267| Method | Path | Description |
268|--------|------|-------------|
269| POST | /registerRobot | Registers a robot with a fleet. This API is no longer supported and will throw an error if used. |
270
271### restartSimulationJob
272| Method | Path | Description |
273|--------|------|-------------|
274| POST | /restartSimulationJob | Restarts a running simulation job. |
275
276### startSimulationJobBatch
277| Method | Path | Description |
278|--------|------|-------------|
279| POST | /startSimulationJobBatch | Starts a new simulation job batch. The batch is defined using one or more SimulationJobRequest objects. |
280
281### syncDeploymentJob
282| Method | Path | Description |
283|--------|------|-------------|
284| POST | /syncDeploymentJob | Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment. This API will no longer be supported as of May 2, 2022. Use it to remove resources that were created for Deployment Service. |
285
286### updateRobotApplication
287| Method | Path | Description |
288|--------|------|-------------|
289| POST | /updateRobotApplication | Updates a robot application. |
290
291### updateSimulationApplication
292| Method | Path | Description |
293|--------|------|-------------|
294| POST | /updateSimulationApplication | Updates a simulation application. |
295
296### updateWorldTemplate
297| Method | Path | Description |
298|--------|------|-------------|
299| POST | /updateWorldTemplate | Updates a world template. |
300
301## Common Questions
302
303Match user requests to endpoints in references/api-spec.lap. Key patterns:
304- "Create a batchDeleteWorld?" -> POST /batchDeleteWorlds
305- "Create a batchDescribeSimulationJob?" -> POST /batchDescribeSimulationJob
306- "Create a cancelDeploymentJob?" -> POST /cancelDeploymentJob
307- "Create a cancelSimulationJob?" -> POST /cancelSimulationJob
308- "Create a cancelSimulationJobBatch?" -> POST /cancelSimulationJobBatch
309- "Create a cancelWorldExportJob?" -> POST /cancelWorldExportJob
310- "Create a cancelWorldGenerationJob?" -> POST /cancelWorldGenerationJob
311- "Create a createDeploymentJob?" -> POST /createDeploymentJob
312- "Create a createFleet?" -> POST /createFleet
313- "Create a createRobot?" -> POST /createRobot
314- "Create a createRobotApplication?" -> POST /createRobotApplication
315- "Create a createRobotApplicationVersion?" -> POST /createRobotApplicationVersion
316- "Create a createSimulationApplication?" -> POST /createSimulationApplication
317- "Create a createSimulationApplicationVersion?" -> POST /createSimulationApplicationVersion
318- "Create a createSimulationJob?" -> POST /createSimulationJob
319- "Create a createWorldExportJob?" -> POST /createWorldExportJob
320- "Create a createWorldGenerationJob?" -> POST /createWorldGenerationJob
321- "Create a createWorldTemplate?" -> POST /createWorldTemplate
322- "Create a deleteFleet?" -> POST /deleteFleet
323- "Create a deleteRobot?" -> POST /deleteRobot
324- "Create a deleteRobotApplication?" -> POST /deleteRobotApplication
325- "Create a deleteSimulationApplication?" -> POST /deleteSimulationApplication
326- "Create a deleteWorldTemplate?" -> POST /deleteWorldTemplate
327- "Create a deregisterRobot?" -> POST /deregisterRobot
328- "Create a describeDeploymentJob?" -> POST /describeDeploymentJob
329- "Create a describeFleet?" -> POST /describeFleet
330- "Create a describeRobot?" -> POST /describeRobot
331- "Create a describeRobotApplication?" -> POST /describeRobotApplication
332- "Create a describeSimulationApplication?" -> POST /describeSimulationApplication
333- "Create a describeSimulationJob?" -> POST /describeSimulationJob
334- "Create a describeSimulationJobBatch?" -> POST /describeSimulationJobBatch
335- "Create a describeWorld?" -> POST /describeWorld
336- "Create a describeWorldExportJob?" -> POST /describeWorldExportJob
337- "Create a describeWorldGenerationJob?" -> POST /describeWorldGenerationJob
338- "Create a describeWorldTemplate?" -> POST /describeWorldTemplate
339- "Create a getWorldTemplateBody?" -> POST /getWorldTemplateBody
340- "Create a listDeploymentJob?" -> POST /listDeploymentJobs
341- "Create a listFleet?" -> POST /listFleets
342- "Create a listRobotApplication?" -> POST /listRobotApplications
343- "Create a listRobot?" -> POST /listRobots
344- "Create a listSimulationApplication?" -> POST /listSimulationApplications
345- "Create a listSimulationJobBatche?" -> POST /listSimulationJobBatches
346- "Create a listSimulationJob?" -> POST /listSimulationJobs
347- "Get tag details?" -> GET /tags/{resourceArn}
348- "Create a listWorldExportJob?" -> POST /listWorldExportJobs
349- "Create a listWorldGenerationJob?" -> POST /listWorldGenerationJobs
350- "Create a listWorldTemplate?" -> POST /listWorldTemplates
351- "Create a listWorld?" -> POST /listWorlds
352- "Create a registerRobot?" -> POST /registerRobot
353- "Create a restartSimulationJob?" -> POST /restartSimulationJob
354- "Create a startSimulationJobBatch?" -> POST /startSimulationJobBatch
355- "Create a syncDeploymentJob?" -> POST /syncDeploymentJob
356- "Delete a tag?" -> DELETE /tags/{resourceArn}
357- "Create a updateRobotApplication?" -> POST /updateRobotApplication
358- "Create a updateSimulationApplication?" -> POST /updateSimulationApplication
359- "Create a updateWorldTemplate?" -> POST /updateWorldTemplate
360- "How to authenticate?" -> See Auth section
361
362## Response Tips
363- Check response schemas in references/api-spec.lap for field details
364- Create/update endpoints typically return the created/updated object
365
366## References
367- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas
368
369> Generated from the official API spec by [LAP](https://lap.sh)