/
docs-2.json
2234 lines (2234 loc) · 149 KB
/
docs-2.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"version": "2.0",
"service": "<p>This section provides documentation for the AWS RoboMaker API operations.</p>",
"operations": {
"BatchDeleteWorlds": "<p>Deletes one or more worlds in a batch operation.</p>",
"BatchDescribeSimulationJob": "<p>Describes one or more simulation jobs.</p>",
"CancelDeploymentJob": "<p>Cancels the specified deployment job.</p>",
"CancelSimulationJob": "<p>Cancels the specified simulation job.</p>",
"CancelSimulationJobBatch": "<p>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. </p>",
"CancelWorldExportJob": "<p>Cancels the specified export job.</p>",
"CancelWorldGenerationJob": "<p>Cancels the specified world generator job.</p>",
"CreateDeploymentJob": "<p>Deploys a specific version of a robot application to robots in a fleet.</p> <p>The robot application must have a numbered <code>applicationVersion</code> for consistency reasons. To create a new version, use <code>CreateRobotApplicationVersion</code> or see <a href=\"https://docs.aws.amazon.com/robomaker/latest/dg/create-robot-application-version.html\">Creating a Robot Application Version</a>. </p> <note> <p>After 90 days, deployment jobs expire and will be deleted. They will no longer be accessible. </p> </note>",
"CreateFleet": "<p>Creates a fleet, a logical group of robots running the same robot application.</p>",
"CreateRobot": "<p>Creates a robot.</p>",
"CreateRobotApplication": "<p>Creates a robot application. </p>",
"CreateRobotApplicationVersion": "<p>Creates a version of a robot application.</p>",
"CreateSimulationApplication": "<p>Creates a simulation application.</p>",
"CreateSimulationApplicationVersion": "<p>Creates a simulation application with a specific revision id.</p>",
"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>",
"CreateWorldExportJob": "<p>Creates a world export job.</p>",
"CreateWorldGenerationJob": "<p>Creates worlds using the specified template.</p>",
"CreateWorldTemplate": "<p>Creates a world template.</p>",
"DeleteFleet": "<p>Deletes a fleet.</p>",
"DeleteRobot": "<p>Deletes a robot.</p>",
"DeleteRobotApplication": "<p>Deletes a robot application.</p>",
"DeleteSimulationApplication": "<p>Deletes a simulation application.</p>",
"DeleteWorldTemplate": "<p>Deletes a world template.</p>",
"DeregisterRobot": "<p>Deregisters a robot.</p>",
"DescribeDeploymentJob": "<p>Describes a deployment job.</p>",
"DescribeFleet": "<p>Describes a fleet.</p>",
"DescribeRobot": "<p>Describes a robot.</p>",
"DescribeRobotApplication": "<p>Describes a robot application.</p>",
"DescribeSimulationApplication": "<p>Describes a simulation application.</p>",
"DescribeSimulationJob": "<p>Describes a simulation job.</p>",
"DescribeSimulationJobBatch": "<p>Describes a simulation job batch.</p>",
"DescribeWorld": "<p>Describes a world.</p>",
"DescribeWorldExportJob": "<p>Describes a world export job.</p>",
"DescribeWorldGenerationJob": "<p>Describes a world generation job.</p>",
"DescribeWorldTemplate": "<p>Describes a world template.</p>",
"GetWorldTemplateBody": "<p>Gets the world template body.</p>",
"ListDeploymentJobs": "<p>Returns a list of deployment jobs for a fleet. You can optionally provide filters to retrieve specific deployment jobs. </p>",
"ListFleets": "<p>Returns a list of fleets. You can optionally provide filters to retrieve specific fleets. </p>",
"ListRobotApplications": "<p>Returns a list of robot application. You can optionally provide filters to retrieve specific robot applications.</p>",
"ListRobots": "<p>Returns a list of robots. You can optionally provide filters to retrieve specific robots.</p>",
"ListSimulationApplications": "<p>Returns a list of simulation applications. You can optionally provide filters to retrieve specific simulation applications. </p>",
"ListSimulationJobBatches": "<p>Returns a list simulation job batches. You can optionally provide filters to retrieve specific simulation batch jobs. </p>",
"ListSimulationJobs": "<p>Returns a list of simulation jobs. You can optionally provide filters to retrieve specific simulation jobs. </p>",
"ListTagsForResource": "<p>Lists all tags on a AWS RoboMaker resource.</p>",
"ListWorldExportJobs": "<p>Lists world export jobs.</p>",
"ListWorldGenerationJobs": "<p>Lists world generator jobs.</p>",
"ListWorldTemplates": "<p>Lists world templates.</p>",
"ListWorlds": "<p>Lists worlds.</p>",
"RegisterRobot": "<p>Registers a robot with a fleet.</p>",
"RestartSimulationJob": "<p>Restarts a running simulation job.</p>",
"StartSimulationJobBatch": "<p>Starts a new simulation job batch. The batch is defined using one or more <code>SimulationJobRequest</code> objects. </p>",
"SyncDeploymentJob": "<p>Syncrhonizes robots in a fleet to the latest deployment. This is helpful if robots were added after a deployment.</p>",
"TagResource": "<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 values can be empty strings. </p> <p>For information about the rules that apply to tag keys and tag values, see <a href=\"https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/allocation-tag-restrictions.html\">User-Defined Tag Restrictions</a> in the <i>AWS Billing and Cost Management User Guide</i>. </p>",
"UntagResource": "<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 tag key, use <a href=\"https://docs.aws.amazon.com/robomaker/latest/dg/API_TagResource.html\"> <code>TagResource</code> </a>. </p>",
"UpdateRobotApplication": "<p>Updates a robot application.</p>",
"UpdateSimulationApplication": "<p>Updates a simulation application.</p>",
"UpdateWorldTemplate": "<p>Updates a world template.</p>"
},
"shapes": {
"Architecture": {
"base": null,
"refs": {
"CreateRobotRequest$architecture": "<p>The target architecture of the robot.</p>",
"CreateRobotResponse$architecture": "<p>The target architecture of the robot.</p>",
"DescribeRobotResponse$architecture": "<p>The target architecture of the robot application.</p>",
"Robot$architecture": "<p>The architecture of the robot.</p>",
"Source$architecture": "<p>The taget processor architecture for the application.</p>",
"SourceConfig$architecture": "<p>The target processor architecture for the application.</p>"
}
},
"Arn": {
"base": null,
"refs": {
"Arns$member": null,
"CancelDeploymentJobRequest$job": "<p>The deployment job ARN to cancel.</p>",
"CancelSimulationJobBatchRequest$batch": "<p>The id of the batch to cancel.</p>",
"CancelSimulationJobRequest$job": "<p>The simulation job ARN to cancel.</p>",
"CancelWorldExportJobRequest$job": "<p>The Amazon Resource Name (arn) of the world export job to cancel.</p>",
"CancelWorldGenerationJobRequest$job": "<p>The Amazon Resource Name (arn) of the world generator job to cancel.</p>",
"CreateDeploymentJobRequest$fleet": "<p>The Amazon Resource Name (ARN) of the fleet to deploy.</p>",
"CreateDeploymentJobResponse$arn": "<p>The Amazon Resource Name (ARN) of the deployment job.</p>",
"CreateDeploymentJobResponse$fleet": "<p>The target fleet for the deployment job.</p>",
"CreateFleetResponse$arn": "<p>The Amazon Resource Name (ARN) of the fleet.</p>",
"CreateRobotApplicationResponse$arn": "<p>The Amazon Resource Name (ARN) of the robot application.</p>",
"CreateRobotApplicationVersionRequest$application": "<p>The application information for the robot application.</p>",
"CreateRobotApplicationVersionResponse$arn": "<p>The Amazon Resource Name (ARN) of the robot application.</p>",
"CreateRobotResponse$arn": "<p>The Amazon Resource Name (ARN) of the robot.</p>",
"CreateSimulationApplicationResponse$arn": "<p>The Amazon Resource Name (ARN) of the simulation application.</p>",
"CreateSimulationApplicationVersionRequest$application": "<p>The application information for the simulation application.</p>",
"CreateSimulationApplicationVersionResponse$arn": "<p>The Amazon Resource Name (ARN) of the simulation application.</p>",
"CreateSimulationJobResponse$arn": "<p>The Amazon Resource Name (ARN) of the simulation job.</p>",
"CreateWorldExportJobResponse$arn": "<p>The Amazon Resource Name (ARN) of the world export job.</p>",
"CreateWorldGenerationJobRequest$template": "<p>The Amazon Resource Name (arn) of the world template describing the worlds you want to create.</p>",
"CreateWorldGenerationJobResponse$arn": "<p>The Amazon Resource Name (ARN) of the world generator job.</p>",
"CreateWorldGenerationJobResponse$template": "<p>The Amazon Resource Name (arn) of the world template.</p>",
"CreateWorldTemplateResponse$arn": "<p>The Amazon Resource Name (ARN) of the world template.</p>",
"DeleteFleetRequest$fleet": "<p>The Amazon Resource Name (ARN) of the fleet.</p>",
"DeleteRobotApplicationRequest$application": "<p>The Amazon Resource Name (ARN) of the the robot application.</p>",
"DeleteRobotRequest$robot": "<p>The Amazon Resource Name (ARN) of the robot.</p>",
"DeleteSimulationApplicationRequest$application": "<p>The application information for the simulation application to delete.</p>",
"DeleteWorldTemplateRequest$template": "<p>The Amazon Resource Name (arn) of the world template you want to delete.</p>",
"DeploymentApplicationConfig$application": "<p>The Amazon Resource Name (ARN) of the robot application.</p>",
"DeploymentJob$arn": "<p>The Amazon Resource Name (ARN) of the deployment job.</p>",
"DeploymentJob$fleet": "<p>The Amazon Resource Name (ARN) of the fleet.</p>",
"DeregisterRobotRequest$fleet": "<p>The Amazon Resource Name (ARN) of the fleet.</p>",
"DeregisterRobotRequest$robot": "<p>The Amazon Resource Name (ARN) of the robot.</p>",
"DeregisterRobotResponse$fleet": "<p>The Amazon Resource Name (ARN) of the fleet.</p>",
"DeregisterRobotResponse$robot": "<p>The Amazon Resource Name (ARN) of the robot.</p>",
"DescribeDeploymentJobRequest$job": "<p>The Amazon Resource Name (ARN) of the deployment job.</p>",
"DescribeDeploymentJobResponse$arn": "<p>The Amazon Resource Name (ARN) of the deployment job.</p>",
"DescribeDeploymentJobResponse$fleet": "<p>The Amazon Resource Name (ARN) of the fleet.</p>",
"DescribeFleetRequest$fleet": "<p>The Amazon Resource Name (ARN) of the fleet.</p>",
"DescribeFleetResponse$arn": "<p>The Amazon Resource Name (ARN) of the fleet.</p>",
"DescribeFleetResponse$lastDeploymentJob": "<p>The Amazon Resource Name (ARN) of the last deployment job.</p>",
"DescribeRobotApplicationRequest$application": "<p>The Amazon Resource Name (ARN) of the robot application.</p>",
"DescribeRobotApplicationResponse$arn": "<p>The Amazon Resource Name (ARN) of the robot application.</p>",
"DescribeRobotRequest$robot": "<p>The Amazon Resource Name (ARN) of the robot to be described.</p>",
"DescribeRobotResponse$arn": "<p>The Amazon Resource Name (ARN) of the robot.</p>",
"DescribeRobotResponse$fleetArn": "<p>The Amazon Resource Name (ARN) of the fleet.</p>",
"DescribeRobotResponse$lastDeploymentJob": "<p>The Amazon Resource Name (ARN) of the last deployment job.</p>",
"DescribeSimulationApplicationRequest$application": "<p>The application information for the simulation application.</p>",
"DescribeSimulationApplicationResponse$arn": "<p>The Amazon Resource Name (ARN) of the robot simulation application.</p>",
"DescribeSimulationJobBatchRequest$batch": "<p>The id of the batch to describe.</p>",
"DescribeSimulationJobBatchResponse$arn": "<p>The Amazon Resource Name (ARN) of the batch.</p>",
"DescribeSimulationJobRequest$job": "<p>The Amazon Resource Name (ARN) of the simulation job to be described.</p>",
"DescribeSimulationJobResponse$arn": "<p>The Amazon Resource Name (ARN) of the simulation job.</p>",
"DescribeWorldExportJobRequest$job": "<p>The Amazon Resource Name (arn) of the world export job to describe.</p>",
"DescribeWorldExportJobResponse$arn": "<p>The Amazon Resource Name (ARN) of the world export job.</p>",
"DescribeWorldGenerationJobRequest$job": "<p>The Amazon Resource Name (arn) of the world generation job to describe.</p>",
"DescribeWorldGenerationJobResponse$arn": "<p>The Amazon Resource Name (ARN) of the world generation job.</p>",
"DescribeWorldGenerationJobResponse$template": "<p>The Amazon Resource Name (arn) of the world template.</p>",
"DescribeWorldRequest$world": "<p>The Amazon Resource Name (arn) of the world you want to describe.</p>",
"DescribeWorldResponse$arn": "<p>The Amazon Resource Name (arn) of the world.</p>",
"DescribeWorldResponse$generationJob": "<p>The Amazon Resource Name (arn) of the world generation job that generated the world.</p>",
"DescribeWorldResponse$template": "<p>The world template.</p>",
"DescribeWorldTemplateRequest$template": "<p>The Amazon Resource Name (arn) of the world template you want to describe.</p>",
"DescribeWorldTemplateResponse$arn": "<p>The Amazon Resource Name (ARN) of the world template.</p>",
"Fleet$arn": "<p>The Amazon Resource Name (ARN) of the fleet.</p>",
"Fleet$lastDeploymentJob": "<p>The Amazon Resource Name (ARN) of the last deployment job.</p>",
"GetWorldTemplateBodyRequest$template": "<p>The Amazon Resource Name (arn) of the world template.</p>",
"GetWorldTemplateBodyRequest$generationJob": "<p>The Amazon Resource Name (arn) of the world generator job.</p>",
"ListTagsForResourceRequest$resourceArn": "<p>The AWS RoboMaker Amazon Resource Name (ARN) with tags to be listed.</p>",
"RegisterRobotRequest$fleet": "<p>The Amazon Resource Name (ARN) of the fleet.</p>",
"RegisterRobotRequest$robot": "<p>The Amazon Resource Name (ARN) of the robot.</p>",
"RegisterRobotResponse$fleet": "<p>The Amazon Resource Name (ARN) of the fleet that the robot will join.</p>",
"RegisterRobotResponse$robot": "<p>Information about the robot registration.</p>",
"RestartSimulationJobRequest$job": "<p>The Amazon Resource Name (ARN) of the simulation job.</p>",
"Robot$arn": "<p>The Amazon Resource Name (ARN) of the robot.</p>",
"Robot$fleetArn": "<p>The Amazon Resource Name (ARN) of the fleet.</p>",
"Robot$lastDeploymentJob": "<p>The Amazon Resource Name (ARN) of the last deployment job.</p>",
"RobotApplicationConfig$application": "<p>The application information for the robot application.</p>",
"RobotApplicationSummary$arn": "<p>The Amazon Resource Name (ARN) of the robot.</p>",
"RobotDeployment$arn": "<p>The robot deployment Amazon Resource Name (ARN).</p>",
"SimulationApplicationConfig$application": "<p>The application information for the simulation application.</p>",
"SimulationApplicationSummary$arn": "<p>The Amazon Resource Name (ARN) of the simulation application.</p>",
"SimulationJob$arn": "<p>The Amazon Resource Name (ARN) of the simulation job.</p>",
"SimulationJobBatchSummary$arn": "<p>The Amazon Resource Name (ARN) of the batch.</p>",
"SimulationJobSummary$arn": "<p>The Amazon Resource Name (ARN) of the simulation job.</p>",
"StartSimulationJobBatchResponse$arn": "<p>The Amazon Resource Name (arn) of the batch.</p>",
"SyncDeploymentJobRequest$fleet": "<p>The target fleet for the synchronization.</p>",
"SyncDeploymentJobResponse$arn": "<p>The Amazon Resource Name (ARN) of the synchronization request.</p>",
"SyncDeploymentJobResponse$fleet": "<p>The Amazon Resource Name (ARN) of the fleet.</p>",
"TagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are tagging.</p>",
"TemplateSummary$arn": "<p>The Amazon Resource Name (ARN) of the template.</p>",
"UntagResourceRequest$resourceArn": "<p>The Amazon Resource Name (ARN) of the AWS RoboMaker resource you are removing tags.</p>",
"UpdateRobotApplicationRequest$application": "<p>The application information for the robot application.</p>",
"UpdateRobotApplicationResponse$arn": "<p>The Amazon Resource Name (ARN) of the updated robot application.</p>",
"UpdateSimulationApplicationRequest$application": "<p>The application information for the simulation application.</p>",
"UpdateSimulationApplicationResponse$arn": "<p>The Amazon Resource Name (ARN) of the updated simulation application.</p>",
"UpdateWorldTemplateRequest$template": "<p>The Amazon Resource Name (arn) of the world template to update.</p>",
"UpdateWorldTemplateResponse$arn": "<p>The Amazon Resource Name (arn) of the world template.</p>",
"WorldConfig$world": "<p>The world generated by Simulation WorldForge.</p>",
"WorldExportJobSummary$arn": "<p>The Amazon Resource Name (ARN) of the world export job.</p>",
"WorldGenerationJobSummary$arn": "<p>The Amazon Resource Name (ARN) of the world generator job.</p>",
"WorldGenerationJobSummary$template": "<p>The Amazon Resource Name (arn) of the world template.</p>",
"WorldSummary$arn": "<p>The Amazon Resource Name (ARN) of the world.</p>",
"WorldSummary$generationJob": "<p>The Amazon Resource Name (arn) of the world generation job.</p>",
"WorldSummary$template": "<p>The Amazon Resource Name (arn) of the world template.</p>"
}
},
"Arns": {
"base": null,
"refs": {
"BatchDeleteWorldsRequest$worlds": "<p>A list of Amazon Resource Names (arns) that correspond to worlds to delete.</p>",
"BatchDeleteWorldsResponse$unprocessedWorlds": "<p>A list of unprocessed worlds associated with the call. These worlds were not deleted.</p>",
"BatchDescribeSimulationJobRequest$jobs": "<p>A list of Amazon Resource Names (ARNs) of simulation jobs to describe.</p>",
"BatchDescribeSimulationJobResponse$unprocessedJobs": "<p>A list of unprocessed simulation job Amazon Resource Names (ARNs).</p>",
"CreateWorldExportJobRequest$worlds": "<p>A list of Amazon Resource Names (arns) that correspond to worlds to export.</p>",
"DescribeWorldExportJobResponse$worlds": "<p>A list of Amazon Resource Names (arns) that correspond to worlds to be exported.</p>",
"FinishedWorldsSummary$succeededWorlds": "<p>A list of worlds that succeeded.</p>",
"WorldExportJobSummary$worlds": "<p>A list of worlds.</p>"
}
},
"BatchDeleteWorldsRequest": {
"base": null,
"refs": {
}
},
"BatchDeleteWorldsResponse": {
"base": null,
"refs": {
}
},
"BatchDescribeSimulationJobRequest": {
"base": null,
"refs": {
}
},
"BatchDescribeSimulationJobResponse": {
"base": null,
"refs": {
}
},
"BatchPolicy": {
"base": "<p>Information about the batch policy.</p>",
"refs": {
"DescribeSimulationJobBatchResponse$batchPolicy": "<p>The batch policy.</p>",
"StartSimulationJobBatchRequest$batchPolicy": "<p>The batch policy.</p>",
"StartSimulationJobBatchResponse$batchPolicy": "<p>The batch policy.</p>"
}
},
"BatchTimeoutInSeconds": {
"base": null,
"refs": {
"BatchPolicy$timeoutInSeconds": "<p>The amount of time, in seconds, to wait for the batch to complete. </p> <p>If a batch times out, and there are pending requests that were failing due to an internal failure (like <code>InternalServiceError</code>), they will be moved to the failed list and the batch status will be <code>Failed</code>. 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 <code>TimedOut</code>. </p>"
}
},
"Boolean": {
"base": null,
"refs": {
"LaunchConfig$streamUI": "<p>Boolean indicating whether a streaming session will be configured for the application. If <code>True</code>, 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. </p>",
"PortMapping$enableOnPublicIp": "<p>A Boolean indicating whether to enable this port mapping on public IP.</p>",
"VPCConfig$assignPublicIp": "<p>A boolean indicating whether to assign a public IP address.</p>",
"VPCConfigResponse$assignPublicIp": "<p>A boolean indicating if a public IP was assigned.</p>"
}
},
"BoxedBoolean": {
"base": null,
"refs": {
"LoggingConfig$recordAllRosTopics": "<p>A boolean indicating whether to record all ROS topics.</p>",
"RobotApplicationConfig$useDefaultUploadConfigurations": "<p>A Boolean indicating whether to use default upload configurations. By default, <code>.ros</code> and <code>.gazebo</code> files are uploaded when the application terminates and all ROS topics will be recorded.</p> <p>If you set this value, you must specify an <code>outputLocation</code>. </p>",
"RobotApplicationConfig$useDefaultTools": "<p>A Boolean indicating whether to use default robot application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is <code>False</code>. </p>",
"SimulationApplicationConfig$useDefaultUploadConfigurations": "<p>A Boolean indicating whether to use default upload configurations. By default, <code>.ros</code> and <code>.gazebo</code> files are uploaded when the application terminates and all ROS topics will be recorded.</p> <p>If you set this value, you must specify an <code>outputLocation</code>. </p>",
"SimulationApplicationConfig$useDefaultTools": "<p>A Boolean indicating whether to use default simulation application tools. The default tools are rviz, rqt, terminal and rosbag record. The default is <code>False</code>. </p>",
"SimulationJobRequest$useDefaultApplications": "<p>A Boolean indicating whether to use default applications in the simulation job. Default applications include Gazebo, rqt, rviz and terminal access. </p>",
"Tool$streamUI": "<p>Boolean indicating whether a streaming session will be configured for the tool. If <code>True</code>, 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 <code>False</code>. </p>",
"Tool$streamOutputToCloudWatch": "<p>Boolean indicating whether logs will be recorded in CloudWatch for the tool. The default is <code>False</code>. </p>"
}
},
"CancelDeploymentJobRequest": {
"base": null,
"refs": {
}
},
"CancelDeploymentJobResponse": {
"base": null,
"refs": {
}
},
"CancelSimulationJobBatchRequest": {
"base": null,
"refs": {
}
},
"CancelSimulationJobBatchResponse": {
"base": null,
"refs": {
}
},
"CancelSimulationJobRequest": {
"base": null,
"refs": {
}
},
"CancelSimulationJobResponse": {
"base": null,
"refs": {
}
},
"CancelWorldExportJobRequest": {
"base": null,
"refs": {
}
},
"CancelWorldExportJobResponse": {
"base": null,
"refs": {
}
},
"CancelWorldGenerationJobRequest": {
"base": null,
"refs": {
}
},
"CancelWorldGenerationJobResponse": {
"base": null,
"refs": {
}
},
"ClientRequestToken": {
"base": null,
"refs": {
"CreateDeploymentJobRequest$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"CreateSimulationJobRequest$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"CreateSimulationJobResponse$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"CreateWorldExportJobRequest$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"CreateWorldExportJobResponse$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"CreateWorldGenerationJobRequest$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"CreateWorldGenerationJobResponse$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"CreateWorldTemplateRequest$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"CreateWorldTemplateResponse$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"DescribeSimulationJobBatchResponse$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"DescribeSimulationJobResponse$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"DescribeWorldExportJobResponse$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"DescribeWorldGenerationJobResponse$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"DescribeWorldTemplateResponse$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"SimulationJob$clientRequestToken": "<p>A unique identifier for this <code>SimulationJob</code> request.</p>",
"StartSimulationJobBatchRequest$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"StartSimulationJobBatchResponse$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>",
"SyncDeploymentJobRequest$clientRequestToken": "<p>Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.</p>"
}
},
"Command": {
"base": null,
"refs": {
"DeploymentLaunchConfig$packageName": "<p>The package name.</p>",
"DeploymentLaunchConfig$launchFile": "<p>The launch file name.</p>",
"LaunchConfig$packageName": "<p>The package name.</p>",
"LaunchConfig$launchFile": "<p>The launch file name.</p>"
}
},
"CommandList": {
"base": null,
"refs": {
"LaunchConfig$command": "<p>If you've specified <code>General</code> as the value for your <code>RobotSoftwareSuite</code>, you can use this field to specify a list of commands for your container image.</p> <p>If you've specified <code>SimulationRuntime</code> as the value for your <code>SimulationSoftwareSuite</code>, you can use this field to specify a list of commands for your container image.</p>"
}
},
"Compute": {
"base": "<p>Compute information for the simulation job.</p>",
"refs": {
"CreateSimulationJobRequest$compute": "<p>Compute information for the simulation job.</p>",
"SimulationJobRequest$compute": "<p>Compute information for the simulation job</p>"
}
},
"ComputeResponse": {
"base": "<p>Compute information for the simulation job</p>",
"refs": {
"CreateSimulationJobResponse$compute": "<p>Compute information for the simulation job.</p>",
"DescribeSimulationJobResponse$compute": "<p>Compute information for the simulation job.</p>",
"SimulationJob$compute": "<p>Compute information for the simulation job</p>"
}
},
"ComputeType": {
"base": null,
"refs": {
"Compute$computeType": "<p>Compute type information for the simulation job.</p>",
"ComputeResponse$computeType": "<p>Compute type response information for the simulation job.</p>",
"SimulationJobSummary$computeType": "<p>The compute type for the simulation job summary.</p>"
}
},
"ConcurrentDeploymentException": {
"base": "<p>The failure percentage threshold percentage was met.</p>",
"refs": {
}
},
"CreateDeploymentJobRequest": {
"base": null,
"refs": {
}
},
"CreateDeploymentJobResponse": {
"base": null,
"refs": {
}
},
"CreateFleetRequest": {
"base": null,
"refs": {
}
},
"CreateFleetResponse": {
"base": null,
"refs": {
}
},
"CreateRobotApplicationRequest": {
"base": null,
"refs": {
}
},
"CreateRobotApplicationResponse": {
"base": null,
"refs": {
}
},
"CreateRobotApplicationVersionRequest": {
"base": null,
"refs": {
}
},
"CreateRobotApplicationVersionResponse": {
"base": null,
"refs": {
}
},
"CreateRobotRequest": {
"base": null,
"refs": {
}
},
"CreateRobotResponse": {
"base": null,
"refs": {
}
},
"CreateSimulationApplicationRequest": {
"base": null,
"refs": {
}
},
"CreateSimulationApplicationResponse": {
"base": null,
"refs": {
}
},
"CreateSimulationApplicationVersionRequest": {
"base": null,
"refs": {
}
},
"CreateSimulationApplicationVersionResponse": {
"base": null,
"refs": {
}
},
"CreateSimulationJobRequest": {
"base": null,
"refs": {
}
},
"CreateSimulationJobRequests": {
"base": null,
"refs": {
"DescribeSimulationJobBatchResponse$pendingRequests": "<p>A list of pending simulation job requests. These requests have not yet been created into simulation jobs.</p>",
"StartSimulationJobBatchRequest$createSimulationJobRequests": "<p>A list of simulation job requests to create in the batch.</p>",
"StartSimulationJobBatchResponse$pendingRequests": "<p>A list of pending simulation job requests. These requests have not yet been created into simulation jobs.</p>"
}
},
"CreateSimulationJobResponse": {
"base": null,
"refs": {
}
},
"CreateWorldExportJobRequest": {
"base": null,
"refs": {
}
},
"CreateWorldExportJobResponse": {
"base": null,
"refs": {
}
},
"CreateWorldGenerationJobRequest": {
"base": null,
"refs": {
}
},
"CreateWorldGenerationJobResponse": {
"base": null,
"refs": {
}
},
"CreateWorldTemplateRequest": {
"base": null,
"refs": {
}
},
"CreateWorldTemplateResponse": {
"base": null,
"refs": {
}
},
"CreatedAt": {
"base": null,
"refs": {
"CreateDeploymentJobResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the fleet was created.</p>",
"CreateFleetResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the fleet was created.</p>",
"CreateRobotResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the robot was created.</p>",
"CreateWorldExportJobResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the world export job was created.</p>",
"CreateWorldGenerationJobResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the world generator job was created.</p>",
"CreateWorldTemplateResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the world template was created.</p>",
"DeploymentJob$createdAt": "<p>The time, in milliseconds since the epoch, when the deployment job was created.</p>",
"DescribeDeploymentJobResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the deployment job was created.</p>",
"DescribeFleetResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the fleet was created.</p>",
"DescribeFleetResponse$lastDeploymentTime": "<p>The time of the last deployment.</p>",
"DescribeRobotResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the robot was created.</p>",
"DescribeRobotResponse$lastDeploymentTime": "<p>The time of the last deployment job.</p>",
"DescribeSimulationJobBatchResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the simulation job batch was created.</p>",
"DescribeWorldExportJobResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the world export job was created.</p>",
"DescribeWorldGenerationJobResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the world generation job was created.</p>",
"DescribeWorldResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the world was created.</p>",
"DescribeWorldTemplateResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the world template was created.</p>",
"Fleet$createdAt": "<p>The time, in milliseconds since the epoch, when the fleet was created.</p>",
"Fleet$lastDeploymentTime": "<p>The time of the last deployment.</p>",
"Robot$createdAt": "<p>The time, in milliseconds since the epoch, when the robot was created.</p>",
"Robot$lastDeploymentTime": "<p>The time of the last deployment.</p>",
"RobotDeployment$deploymentStartTime": "<p>The time, in milliseconds since the epoch, when the deployment was started.</p>",
"RobotDeployment$deploymentFinishTime": "<p>The time, in milliseconds since the epoch, when the deployment finished.</p>",
"SimulationJobBatchSummary$createdAt": "<p>The time, in milliseconds since the epoch, when the simulation job batch was created.</p>",
"StartSimulationJobBatchResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the simulation job batch was created.</p>",
"SyncDeploymentJobResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the fleet was created.</p>",
"TemplateSummary$createdAt": "<p>The time, in milliseconds since the epoch, when the template was created.</p>",
"UpdateWorldTemplateResponse$createdAt": "<p>The time, in milliseconds since the epoch, when the world template was created.</p>",
"WorldExportJobSummary$createdAt": "<p>The time, in milliseconds since the epoch, when the world export job was created.</p>",
"WorldGenerationJobSummary$createdAt": "<p>The time, in milliseconds since the epoch, when the world generator job was created.</p>",
"WorldSummary$createdAt": "<p>The time, in milliseconds since the epoch, when the world was created.</p>"
}
},
"DataSource": {
"base": "<p>Information about a data source.</p>",
"refs": {
"DataSources$member": null
}
},
"DataSourceConfig": {
"base": "<p>Information about a data source.</p>",
"refs": {
"DataSourceConfigs$member": null
}
},
"DataSourceConfigs": {
"base": null,
"refs": {
"CreateSimulationJobRequest$dataSources": "<p>Specify data sources to mount read-only files from S3 into your simulation. These files are available under <code>/opt/robomaker/datasources/data_source_name</code>. </p> <note> <p>There is a limit of 100 files and a combined size of 25GB for all <code>DataSourceConfig</code> objects. </p> </note>",
"SimulationJobRequest$dataSources": "<p>Specify data sources to mount read-only files from S3 into your simulation. These files are available under <code>/opt/robomaker/datasources/data_source_name</code>. </p> <note> <p>There is a limit of 100 files and a combined size of 25GB for all <code>DataSourceConfig</code> objects. </p> </note>"
}
},
"DataSourceNames": {
"base": null,
"refs": {
"SimulationJobSummary$dataSourceNames": "<p>The names of the data sources.</p>"
}
},
"DataSourceType": {
"base": null,
"refs": {
"DataSource$type": "<p>The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.</p> <p>If you don't specify a field, the default value is <code>File</code>.</p>",
"DataSourceConfig$type": "<p>The data type for the data source that you're using for your container image or simulation job. You can use this field to specify whether your data source is an Archive, an Amazon S3 prefix, or a file.</p> <p>If you don't specify a field, the default value is <code>File</code>.</p>"
}
},
"DataSources": {
"base": null,
"refs": {
"CreateSimulationJobResponse$dataSources": "<p>The data sources for the simulation job.</p>",
"DescribeSimulationJobResponse$dataSources": "<p>The data sources for the simulation job.</p>",
"SimulationJob$dataSources": "<p>The data sources for the simulation job.</p>"
}
},
"DeleteFleetRequest": {
"base": null,
"refs": {
}
},
"DeleteFleetResponse": {
"base": null,
"refs": {
}
},
"DeleteRobotApplicationRequest": {
"base": null,
"refs": {
}
},
"DeleteRobotApplicationResponse": {
"base": null,
"refs": {
}
},
"DeleteRobotRequest": {
"base": null,
"refs": {
}
},
"DeleteRobotResponse": {
"base": null,
"refs": {
}
},
"DeleteSimulationApplicationRequest": {
"base": null,
"refs": {
}
},
"DeleteSimulationApplicationResponse": {
"base": null,
"refs": {
}
},
"DeleteWorldTemplateRequest": {
"base": null,
"refs": {
}
},
"DeleteWorldTemplateResponse": {
"base": null,
"refs": {
}
},
"DeploymentApplicationConfig": {
"base": "<p>Information about a deployment application configuration.</p>",
"refs": {
"DeploymentApplicationConfigs$member": null
}
},
"DeploymentApplicationConfigs": {
"base": null,
"refs": {
"CreateDeploymentJobRequest$deploymentApplicationConfigs": "<p>The deployment application configuration.</p>",
"CreateDeploymentJobResponse$deploymentApplicationConfigs": "<p>The deployment application configuration.</p>",
"DeploymentJob$deploymentApplicationConfigs": "<p>The deployment application configuration.</p>",
"DescribeDeploymentJobResponse$deploymentApplicationConfigs": "<p>The deployment application configuration.</p>",
"SyncDeploymentJobResponse$deploymentApplicationConfigs": "<p>Information about the deployment application configurations.</p>"
}
},
"DeploymentConfig": {
"base": "<p>Information about a deployment configuration.</p>",
"refs": {
"CreateDeploymentJobRequest$deploymentConfig": "<p>The requested deployment configuration.</p>",
"CreateDeploymentJobResponse$deploymentConfig": "<p>The deployment configuration.</p>",
"DeploymentJob$deploymentConfig": "<p>The deployment configuration.</p>",
"DescribeDeploymentJobResponse$deploymentConfig": "<p>The deployment configuration.</p>",
"SyncDeploymentJobResponse$deploymentConfig": "<p>Information about the deployment configuration.</p>"
}
},
"DeploymentJob": {
"base": "<p>Information about a deployment job.</p>",
"refs": {
"DeploymentJobs$member": null
}
},
"DeploymentJobErrorCode": {
"base": null,
"refs": {
"CreateDeploymentJobResponse$failureCode": "<p>The failure code of the simulation job if it failed:</p> <dl> <dt>BadPermissionError</dt> <dd> <p>AWS Greengrass requires a service-level role permission to access other services. The role must include the <a href=\"https://console.aws.amazon.com/iam/home?#/policies/arn:aws:iam::aws:policy/service-role/AWSGreengrassResourceAccessRolePolicy$jsonEditor\"> <code>AWSGreengrassResourceAccessRolePolicy</code> managed policy</a>. </p> </dd> <dt>ExtractingBundleFailure</dt> <dd> <p>The robot application could not be extracted from the bundle.</p> </dd> <dt>FailureThresholdBreached</dt> <dd> <p>The percentage of robots that could not be updated exceeded the percentage set for the deployment.</p> </dd> <dt>GreengrassDeploymentFailed</dt> <dd> <p>The robot application could not be deployed to the robot.</p> </dd> <dt>GreengrassGroupVersionDoesNotExist</dt> <dd> <p>The AWS Greengrass group or version associated with a robot is missing.</p> </dd> <dt>InternalServerError</dt> <dd> <p>An internal error has occurred. Retry your request, but if the problem persists, contact us with details.</p> </dd> <dt>MissingRobotApplicationArchitecture</dt> <dd> <p>The robot application does not have a source that matches the architecture of the robot.</p> </dd> <dt>MissingRobotDeploymentResource</dt> <dd> <p>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?</p> </dd> <dt>PostLaunchFileFailure</dt> <dd> <p>The post-launch script failed.</p> </dd> <dt>PreLaunchFileFailure</dt> <dd> <p>The pre-launch script failed.</p> </dd> <dt>ResourceNotFound</dt> <dd> <p>One or more deployment resources are missing. For example, do robot application source bundles still exist? </p> </dd> <dt>RobotDeploymentNoResponse</dt> <dd> <p>There is no response from the robot. It might not be powered on or connected to the internet.</p> </dd> </dl>",
"DeploymentJob$failureCode": "<p>The deployment job failure code.</p>",
"DescribeDeploymentJobResponse$failureCode": "<p>The deployment job failure code.</p>",
"RobotDeployment$failureCode": "<p>The robot deployment failure code.</p>",
"SyncDeploymentJobResponse$failureCode": "<p>The failure code if the job fails:</p> <dl> <dt>InternalServiceError</dt> <dd> <p>Internal service error.</p> </dd> <dt>RobotApplicationCrash</dt> <dd> <p>Robot application exited abnormally.</p> </dd> <dt>SimulationApplicationCrash</dt> <dd> <p> Simulation application exited abnormally.</p> </dd> <dt>BadPermissionsRobotApplication</dt> <dd> <p>Robot application bundle could not be downloaded.</p> </dd> <dt>BadPermissionsSimulationApplication</dt> <dd> <p>Simulation application bundle could not be downloaded.</p> </dd> <dt>BadPermissionsS3Output</dt> <dd> <p>Unable to publish outputs to customer-provided S3 bucket.</p> </dd> <dt>BadPermissionsCloudwatchLogs</dt> <dd> <p>Unable to publish logs to customer-provided CloudWatch Logs resource.</p> </dd> <dt>SubnetIpLimitExceeded</dt> <dd> <p>Subnet IP limit exceeded.</p> </dd> <dt>ENILimitExceeded</dt> <dd> <p>ENI limit exceeded.</p> </dd> <dt>BadPermissionsUserCredentials</dt> <dd> <p>Unable to use the Role provided.</p> </dd> <dt>InvalidBundleRobotApplication</dt> <dd> <p>Robot bundle cannot be extracted (invalid format, bundling error, or other issue).</p> </dd> <dt>InvalidBundleSimulationApplication</dt> <dd> <p>Simulation bundle cannot be extracted (invalid format, bundling error, or other issue).</p> </dd> <dt>RobotApplicationVersionMismatchedEtag</dt> <dd> <p>Etag for RobotApplication does not match value during version creation.</p> </dd> <dt>SimulationApplicationVersionMismatchedEtag</dt> <dd> <p>Etag for SimulationApplication does not match value during version creation.</p> </dd> </dl>"
}
},
"DeploymentJobs": {
"base": null,
"refs": {
"ListDeploymentJobsResponse$deploymentJobs": "<p>A list of deployment jobs that meet the criteria of the request.</p>"
}
},
"DeploymentLaunchConfig": {
"base": "<p>Configuration information for a deployment launch.</p>",
"refs": {
"DeploymentApplicationConfig$launchConfig": "<p>The launch configuration.</p>"
}
},
"DeploymentStatus": {
"base": null,
"refs": {
"CreateDeploymentJobResponse$status": "<p>The status of the deployment job.</p>",
"DeploymentJob$status": "<p>The status of the deployment job.</p>",
"DescribeDeploymentJobResponse$status": "<p>The status of the deployment job.</p>",
"DescribeFleetResponse$lastDeploymentStatus": "<p>The status of the last deployment.</p>",
"Fleet$lastDeploymentStatus": "<p>The status of the last fleet deployment.</p>",
"SyncDeploymentJobResponse$status": "<p>The status of the synchronization job.</p>"
}
},
"DeploymentTimeout": {
"base": null,
"refs": {
"DeploymentConfig$robotDeploymentTimeoutInSeconds": "<p>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.</p>"
}
},
"DeploymentVersion": {
"base": null,
"refs": {
"DeploymentApplicationConfig$applicationVersion": "<p>The version of the application.</p>"
}
},
"DeregisterRobotRequest": {
"base": null,
"refs": {
}
},
"DeregisterRobotResponse": {
"base": null,
"refs": {
}
},
"DescribeDeploymentJobRequest": {
"base": null,
"refs": {
}
},
"DescribeDeploymentJobResponse": {
"base": null,
"refs": {
}
},
"DescribeFleetRequest": {
"base": null,
"refs": {
}
},
"DescribeFleetResponse": {
"base": null,
"refs": {
}
},
"DescribeRobotApplicationRequest": {
"base": null,
"refs": {
}
},
"DescribeRobotApplicationResponse": {
"base": null,
"refs": {
}
},
"DescribeRobotRequest": {
"base": null,
"refs": {
}
},
"DescribeRobotResponse": {
"base": null,
"refs": {
}
},
"DescribeSimulationApplicationRequest": {
"base": null,
"refs": {
}
},
"DescribeSimulationApplicationResponse": {
"base": null,
"refs": {
}
},
"DescribeSimulationJobBatchRequest": {
"base": null,
"refs": {
}
},
"DescribeSimulationJobBatchResponse": {
"base": null,
"refs": {
}
},
"DescribeSimulationJobRequest": {
"base": null,
"refs": {
}
},
"DescribeSimulationJobResponse": {
"base": null,
"refs": {
}
},
"DescribeWorldExportJobRequest": {
"base": null,
"refs": {
}
},
"DescribeWorldExportJobResponse": {
"base": null,
"refs": {
}
},
"DescribeWorldGenerationJobRequest": {
"base": null,
"refs": {
}
},
"DescribeWorldGenerationJobResponse": {
"base": null,
"refs": {
}
},
"DescribeWorldRequest": {
"base": null,
"refs": {
}
},
"DescribeWorldResponse": {
"base": null,
"refs": {
}
},
"DescribeWorldTemplateRequest": {
"base": null,
"refs": {
}
},
"DescribeWorldTemplateResponse": {
"base": null,
"refs": {
}
},
"Environment": {
"base": "<p>The object that contains the Docker image URI for either your robot or simulation applications.</p>",
"refs": {
"CreateRobotApplicationRequest$environment": "<p>The object that contains that URI of the Docker image that you use for your robot application.</p>",
"CreateRobotApplicationResponse$environment": "<p>An object that contains the Docker image URI used to a create your robot application.</p>",
"CreateRobotApplicationVersionResponse$environment": "<p>The object that contains the Docker image URI used to create your robot application.</p>",
"CreateSimulationApplicationRequest$environment": "<p>The object that contains the Docker image URI used to create your simulation application.</p>",
"CreateSimulationApplicationResponse$environment": "<p>The object that contains the Docker image URI that you used to create your simulation application.</p>",
"CreateSimulationApplicationVersionResponse$environment": "<p>The object that contains the Docker image URI used to create the simulation application.</p>",
"DescribeRobotApplicationResponse$environment": "<p>The object that contains the Docker image URI used to create the robot application.</p>",
"DescribeSimulationApplicationResponse$environment": "<p>The object that contains the Docker image URI used to create the simulation application.</p>",
"UpdateRobotApplicationRequest$environment": "<p>The object that contains the Docker image URI for your robot application.</p>",
"UpdateRobotApplicationResponse$environment": "<p>The object that contains the Docker image URI for your robot application.</p>",
"UpdateSimulationApplicationRequest$environment": "<p>The object that contains the Docker image URI for your simulation application.</p>",
"UpdateSimulationApplicationResponse$environment": "<p>The object that contains the Docker image URI used for your simulation application.</p>"
}
},
"EnvironmentVariableKey": {
"base": null,
"refs": {
"EnvironmentVariableMap$key": null
}
},
"EnvironmentVariableMap": {
"base": null,
"refs": {
"DeploymentLaunchConfig$environmentVariables": "<p>An array of key/value pairs specifying environment variables for the robot application</p>",
"LaunchConfig$environmentVariables": "<p>The environment variables for the application launch.</p>"
}
},
"EnvironmentVariableValue": {
"base": null,
"refs": {
"EnvironmentVariableMap$value": null
}
},
"ExitBehavior": {
"base": null,
"refs": {
"Tool$exitBehavior": "<p>Exit behavior determines what happens when your tool quits running. <code>RESTART</code> will cause your tool to be restarted. <code>FAIL</code> will cause your job to exit. The default is <code>RESTART</code>. </p>"
}
},
"FailedAt": {
"base": null,
"refs": {
"FailedCreateSimulationJobRequest$failedAt": "<p>The time, in milliseconds since the epoch, when the simulation job batch failed.</p>"
}
},
"FailedCreateSimulationJobRequest": {
"base": "<p>Information about a failed create simulation job request.</p>",
"refs": {
"FailedCreateSimulationJobRequests$member": null
}
},
"FailedCreateSimulationJobRequests": {
"base": null,
"refs": {
"DescribeSimulationJobBatchResponse$failedRequests": "<p>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. </p>",
"StartSimulationJobBatchResponse$failedRequests": "<p>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. </p>"
}
},
"FailureBehavior": {
"base": null,
"refs": {
"CreateSimulationJobRequest$failureBehavior": "<p>The failure behavior the simulation job.</p> <dl> <dt>Continue</dt> <dd> <p>Leaves the instance running for its maximum timeout duration after a <code>4XX</code> error code.</p> </dd> <dt>Fail</dt> <dd> <p>Stop the simulation job and terminate the instance.</p> </dd> </dl>",
"CreateSimulationJobResponse$failureBehavior": "<p>the failure behavior for the simulation job.</p>",
"DescribeSimulationJobResponse$failureBehavior": "<p>The failure behavior for the simulation job.</p>",
"SimulationJob$failureBehavior": "<p>The failure behavior the simulation job.</p> <dl> <dt>Continue</dt> <dd> <p>Leaves the host running for its maximum timeout duration after a <code>4XX</code> error code.</p> </dd> <dt>Fail</dt> <dd> <p>Stop the simulation job and terminate the instance.</p> </dd> </dl>",
"SimulationJobRequest$failureBehavior": "<p>The failure behavior the simulation job.</p> <dl> <dt>Continue</dt> <dd> <p>Leaves the host running for its maximum timeout duration after a <code>4XX</code> error code.</p> </dd> <dt>Fail</dt> <dd> <p>Stop the simulation job and terminate the instance.</p> </dd> </dl>"
}
},
"FailureSummary": {
"base": "<p>Information about worlds that failed.</p>",
"refs": {
"FinishedWorldsSummary$failureSummary": "<p>Information about worlds that failed.</p>"
}
},
"Filter": {
"base": "<p>Information about a filter.</p>",
"refs": {
"Filters$member": null
}
},
"FilterValues": {
"base": null,
"refs": {
"Filter$values": "<p>A list of values.</p>"
}
},
"Filters": {
"base": null,
"refs": {
"ListDeploymentJobsRequest$filters": "<p>Optional filters to limit results.</p> <p>The filter names <code>status</code> and <code>fleetName</code> 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 <code>InProgress</code> or the status <code>Pending</code>.</p>",
"ListFleetsRequest$filters": "<p>Optional filters to limit results.</p> <p>The filter name <code>name</code> is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.</p>",
"ListRobotApplicationsRequest$filters": "<p>Optional filters to limit results.</p> <p>The filter name <code>name</code> is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.</p>",
"ListRobotsRequest$filters": "<p>Optional filters to limit results.</p> <p>The filter names <code>status</code> and <code>fleetName</code> 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 <code>Registered</code> or the status <code>Available</code>.</p>",
"ListSimulationApplicationsRequest$filters": "<p>Optional list of filters to limit results.</p> <p>The filter name <code>name</code> is supported. When filtering, you must use the complete value of the filtered item. You can use up to three filters.</p>",
"ListSimulationJobBatchesRequest$filters": "<p>Optional filters to limit results.</p>",
"ListSimulationJobsRequest$filters": "<p>Optional filters to limit results.</p> <p>The filter names <code>status</code> and <code>simulationApplicationName</code> and <code>robotApplicationName</code> 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 <code>Preparing</code> or the status <code>Running</code>.</p>",
"ListWorldExportJobsRequest$filters": "<p>Optional filters to limit results. You can use <code>generationJobId</code> and <code>templateId</code>.</p>",
"ListWorldGenerationJobsRequest$filters": "<p>Optional filters to limit results. You can use <code>status</code> and <code>templateId</code>.</p>",
"ListWorldsRequest$filters": "<p>Optional filters to limit results. You can use <code>status</code>.</p>"
}
},
"FinishedWorldsSummary": {
"base": "<p>Information about worlds that finished.</p>",
"refs": {
"DescribeWorldGenerationJobResponse$finishedWorldsSummary": "<p>Summary information about finished worlds.</p>"
}
},
"Fleet": {
"base": "<p>Information about a fleet.</p>",
"refs": {
"Fleets$member": null
}
},
"Fleets": {
"base": null,
"refs": {
"ListFleetsResponse$fleetDetails": "<p>A list of fleet details meeting the request criteria.</p>"
}
},
"FloorplanCount": {
"base": null,
"refs": {
"WorldCount$floorplanCount": "<p>The number of unique floorplans.</p>"
}
},
"GPUUnit": {
"base": null,
"refs": {
"Compute$gpuUnitLimit": "<p>Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.</p>",
"ComputeResponse$gpuUnitLimit": "<p>Compute GPU unit limit for the simulation job. It is the same as the number of GPUs allocated to the SimulationJob.</p>"
}
},
"GenericInteger": {
"base": null,
"refs": {
"ProgressDetail$estimatedTimeRemainingSeconds": "<p>Estimated amount of time in seconds remaining in the step. This currently only applies to the <code>Downloading/Extracting</code> step of the deployment. It is empty for other steps.</p>"
}
},
"GenericString": {
"base": null,
"refs": {
"CreateDeploymentJobResponse$failureReason": "<p>The failure reason of the deployment job if it failed.</p>",
"DeploymentJob$failureReason": "<p>A short description of the reason why the deployment job failed.</p>",
"DescribeDeploymentJobResponse$failureReason": "<p>A short description of the reason why the deployment job failed.</p>",
"DescribeSimulationJobBatchResponse$failureReason": "<p>The reason the simulation job batch failed.</p>",
"DescribeSimulationJobResponse$failureReason": "<p>Details about why the simulation job failed. For more information about troubleshooting, see <a href=\"https://docs.aws.amazon.com/robomaker/latest/dg/troubleshooting.html\">Troubleshooting</a>.</p>",
"DescribeWorldExportJobResponse$failureReason": "<p>The reason why the world export job failed.</p>",
"DescribeWorldGenerationJobResponse$failureReason": "<p>The reason why the world generation job failed.</p>",
"DescribeWorldTemplateResponse$version": "<p>The version of the world template that you're using.</p>",
"FailedCreateSimulationJobRequest$failureReason": "<p>The failure reason of the simulation job request.</p>",
"NetworkInterface$networkInterfaceId": "<p>The ID of the network interface.</p>",
"NetworkInterface$privateIpAddress": "<p>The IPv4 address of the network interface within the subnet.</p>",
"NetworkInterface$publicIpAddress": "<p>The IPv4 public address of the network interface.</p>",
"ProgressDetail$targetResource": "<p>The Amazon Resource Name (ARN) of the deployment job.</p>",
"RobotDeployment$failureReason": "<p>A short description of the reason why the robot deployment failed.</p>",
"SimulationJob$failureReason": "<p>The reason why the simulation job failed.</p>",
"StartSimulationJobBatchResponse$failureReason": "<p>The reason the simulation job batch failed.</p>",
"SyncDeploymentJobResponse$failureReason": "<p>The failure reason if the job fails.</p>",
"TemplateSummary$version": "<p>The version of the template that you're using.</p>",
"VPCConfigResponse$vpcId": "<p>The VPC ID associated with your simulation job.</p>",
"WorldFailure$sampleFailureReason": "<p>The sample reason why the world failed. World errors are aggregated. A sample is used as the <code>sampleFailureReason</code>. </p>"
}
},
"GetWorldTemplateBodyRequest": {
"base": null,
"refs": {
}
},
"GetWorldTemplateBodyResponse": {
"base": null,
"refs": {
}
},
"IamRole": {
"base": null,
"refs": {
"CreateSimulationJobRequest$iamRole": "<p>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. </p>",
"CreateSimulationJobResponse$iamRole": "<p>The IAM role that allows the simulation job to call the AWS APIs that are specified in its associated policies on your behalf.</p>",
"CreateWorldExportJobRequest$iamRole": "<p>The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.</p>",
"CreateWorldExportJobResponse$iamRole": "<p>The IAM role that the world export process uses to access the Amazon S3 bucket and put the export. </p>",
"DescribeSimulationJobResponse$iamRole": "<p>The IAM role that allows the simulation instance to call the AWS APIs that are specified in its associated policies on your behalf.</p>",
"DescribeWorldExportJobResponse$iamRole": "<p>The IAM role that the world export process uses to access the Amazon S3 bucket and put the export.</p>",
"SimulationJob$iamRole": "<p>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. </p>",
"SimulationJobRequest$iamRole": "<p>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. </p>"
}
},
"Id": {