aws-sdk-robomaker 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
File without changes
@@ -0,0 +1,14 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::RoboMaker
9
+ module Errors
10
+
11
+ extend Aws::Errors::DynamicErrors
12
+
13
+ end
14
+ end
@@ -0,0 +1,23 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::RoboMaker
9
+ class Resource
10
+
11
+ # @param options ({})
12
+ # @option options [Client] :client
13
+ def initialize(options = {})
14
+ @client = options[:client] || Client.new(options)
15
+ end
16
+
17
+ # @return [Client]
18
+ def client
19
+ @client
20
+ end
21
+
22
+ end
23
+ end
@@ -0,0 +1,3111 @@
1
+ # WARNING ABOUT GENERATED CODE
2
+ #
3
+ # This file is generated. See the contributing guide for more information:
4
+ # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
5
+ #
6
+ # WARNING ABOUT GENERATED CODE
7
+
8
+ module Aws::RoboMaker
9
+ module Types
10
+
11
+ # @note When making an API call, you may pass BatchDescribeSimulationJobRequest
12
+ # data as a hash:
13
+ #
14
+ # {
15
+ # jobs: ["Arn"], # required
16
+ # }
17
+ #
18
+ # @!attribute [rw] jobs
19
+ # A list of Amazon Resource Names (ARNs) of simulation jobs to
20
+ # describe.
21
+ # @return [Array<String>]
22
+ #
23
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/BatchDescribeSimulationJobRequest AWS API Documentation
24
+ #
25
+ class BatchDescribeSimulationJobRequest < Struct.new(
26
+ :jobs)
27
+ include Aws::Structure
28
+ end
29
+
30
+ # @!attribute [rw] jobs
31
+ # A list of simulation jobs.
32
+ # @return [Array<Types::SimulationJob>]
33
+ #
34
+ # @!attribute [rw] unprocessed_jobs
35
+ # A list of unprocessed simulation job Amazon Resource Names (ARNs).
36
+ # @return [Array<String>]
37
+ #
38
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/BatchDescribeSimulationJobResponse AWS API Documentation
39
+ #
40
+ class BatchDescribeSimulationJobResponse < Struct.new(
41
+ :jobs,
42
+ :unprocessed_jobs)
43
+ include Aws::Structure
44
+ end
45
+
46
+ # @note When making an API call, you may pass CancelSimulationJobRequest
47
+ # data as a hash:
48
+ #
49
+ # {
50
+ # job: "Arn", # required
51
+ # }
52
+ #
53
+ # @!attribute [rw] job
54
+ # The simulation job ARN to cancel.
55
+ # @return [String]
56
+ #
57
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CancelSimulationJobRequest AWS API Documentation
58
+ #
59
+ class CancelSimulationJobRequest < Struct.new(
60
+ :job)
61
+ include Aws::Structure
62
+ end
63
+
64
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CancelSimulationJobResponse AWS API Documentation
65
+ #
66
+ class CancelSimulationJobResponse < Aws::EmptyStructure; end
67
+
68
+ # @note When making an API call, you may pass CreateDeploymentJobRequest
69
+ # data as a hash:
70
+ #
71
+ # {
72
+ # deployment_config: {
73
+ # concurrent_deployment_percentage: 1,
74
+ # failure_threshold_percentage: 1,
75
+ # },
76
+ # client_request_token: "ClientRequestToken", # required
77
+ # fleet: "Arn", # required
78
+ # deployment_application_configs: [ # required
79
+ # {
80
+ # application: "Arn", # required
81
+ # application_version: "Version", # required
82
+ # launch_config: { # required
83
+ # package_name: "GenericString", # required
84
+ # pre_launch_file: "GenericString",
85
+ # launch_file: "GenericString", # required
86
+ # post_launch_file: "GenericString",
87
+ # environment_variables: {
88
+ # "EnvironmentVariableKey" => "EnvironmentVariableValue",
89
+ # },
90
+ # },
91
+ # },
92
+ # ],
93
+ # }
94
+ #
95
+ # @!attribute [rw] deployment_config
96
+ # The requested deployment configuration.
97
+ # @return [Types::DeploymentConfig]
98
+ #
99
+ # @!attribute [rw] client_request_token
100
+ # Unique, case-sensitive identifier that you provide to ensure the
101
+ # idempotency of the request.
102
+ #
103
+ # **A suitable default value is auto-generated.** You should normally
104
+ # not need to pass this option.
105
+ # @return [String]
106
+ #
107
+ # @!attribute [rw] fleet
108
+ # The Amazon Resource Name (ARN) of the fleet to deploy.
109
+ # @return [String]
110
+ #
111
+ # @!attribute [rw] deployment_application_configs
112
+ # The deployment application configuration.
113
+ # @return [Array<Types::DeploymentApplicationConfig>]
114
+ #
115
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateDeploymentJobRequest AWS API Documentation
116
+ #
117
+ class CreateDeploymentJobRequest < Struct.new(
118
+ :deployment_config,
119
+ :client_request_token,
120
+ :fleet,
121
+ :deployment_application_configs)
122
+ include Aws::Structure
123
+ end
124
+
125
+ # @!attribute [rw] arn
126
+ # The Amazon Resource Name (ARN) of the deployment job.
127
+ # @return [String]
128
+ #
129
+ # @!attribute [rw] fleet
130
+ # The target fleet for the deployment job.
131
+ # @return [String]
132
+ #
133
+ # @!attribute [rw] status
134
+ # The status of the deployment job.
135
+ # @return [String]
136
+ #
137
+ # @!attribute [rw] deployment_application_configs
138
+ # The deployment application configuration.
139
+ # @return [Array<Types::DeploymentApplicationConfig>]
140
+ #
141
+ # @!attribute [rw] failure_reason
142
+ # The failure reason of the deployment job if it failed.
143
+ # @return [String]
144
+ #
145
+ # @!attribute [rw] failure_code
146
+ # The failure code of the deployment job if it failed.
147
+ # @return [String]
148
+ #
149
+ # @!attribute [rw] created_at
150
+ # The time, in milliseconds since the epoch, when the fleet was
151
+ # created.
152
+ # @return [Time]
153
+ #
154
+ # @!attribute [rw] deployment_config
155
+ # The deployment configuration.
156
+ # @return [Types::DeploymentConfig]
157
+ #
158
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateDeploymentJobResponse AWS API Documentation
159
+ #
160
+ class CreateDeploymentJobResponse < Struct.new(
161
+ :arn,
162
+ :fleet,
163
+ :status,
164
+ :deployment_application_configs,
165
+ :failure_reason,
166
+ :failure_code,
167
+ :created_at,
168
+ :deployment_config)
169
+ include Aws::Structure
170
+ end
171
+
172
+ # @note When making an API call, you may pass CreateFleetRequest
173
+ # data as a hash:
174
+ #
175
+ # {
176
+ # name: "Name", # required
177
+ # }
178
+ #
179
+ # @!attribute [rw] name
180
+ # The name of the fleet.
181
+ # @return [String]
182
+ #
183
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateFleetRequest AWS API Documentation
184
+ #
185
+ class CreateFleetRequest < Struct.new(
186
+ :name)
187
+ include Aws::Structure
188
+ end
189
+
190
+ # @!attribute [rw] arn
191
+ # The Amazon Resource Name (ARN) of the fleet.
192
+ # @return [String]
193
+ #
194
+ # @!attribute [rw] name
195
+ # The name of the fleet.
196
+ # @return [String]
197
+ #
198
+ # @!attribute [rw] created_at
199
+ # The time, in milliseconds since the epoch, when the fleet was
200
+ # created.
201
+ # @return [Time]
202
+ #
203
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateFleetResponse AWS API Documentation
204
+ #
205
+ class CreateFleetResponse < Struct.new(
206
+ :arn,
207
+ :name,
208
+ :created_at)
209
+ include Aws::Structure
210
+ end
211
+
212
+ # @note When making an API call, you may pass CreateRobotApplicationRequest
213
+ # data as a hash:
214
+ #
215
+ # {
216
+ # name: "Name", # required
217
+ # sources: [ # required
218
+ # {
219
+ # s3_bucket: "S3Bucket",
220
+ # s3_key: "S3Key",
221
+ # architecture: "X86_64", # accepts X86_64, ARM64, ARMHF
222
+ # },
223
+ # ],
224
+ # robot_software_suite: { # required
225
+ # name: "ROS", # accepts ROS
226
+ # version: "Kinetic", # accepts Kinetic
227
+ # },
228
+ # }
229
+ #
230
+ # @!attribute [rw] name
231
+ # The name of the robot application.
232
+ # @return [String]
233
+ #
234
+ # @!attribute [rw] sources
235
+ # The sources of the robot application.
236
+ # @return [Array<Types::SourceConfig>]
237
+ #
238
+ # @!attribute [rw] robot_software_suite
239
+ # The robot software suite used by the robot application.
240
+ # @return [Types::RobotSoftwareSuite]
241
+ #
242
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateRobotApplicationRequest AWS API Documentation
243
+ #
244
+ class CreateRobotApplicationRequest < Struct.new(
245
+ :name,
246
+ :sources,
247
+ :robot_software_suite)
248
+ include Aws::Structure
249
+ end
250
+
251
+ # @!attribute [rw] arn
252
+ # The Amazon Resource Name (ARN) of the robot application.
253
+ # @return [String]
254
+ #
255
+ # @!attribute [rw] name
256
+ # The name of the robot application.
257
+ # @return [String]
258
+ #
259
+ # @!attribute [rw] version
260
+ # The version of the robot application.
261
+ # @return [String]
262
+ #
263
+ # @!attribute [rw] sources
264
+ # The sources of the robot application.
265
+ # @return [Array<Types::Source>]
266
+ #
267
+ # @!attribute [rw] robot_software_suite
268
+ # The robot software suite used by the robot application.
269
+ # @return [Types::RobotSoftwareSuite]
270
+ #
271
+ # @!attribute [rw] last_updated_at
272
+ # The time, in milliseconds since the epoch, when the robot
273
+ # application was last updated.
274
+ # @return [Time]
275
+ #
276
+ # @!attribute [rw] revision_id
277
+ # The revision id of the robot application.
278
+ # @return [String]
279
+ #
280
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateRobotApplicationResponse AWS API Documentation
281
+ #
282
+ class CreateRobotApplicationResponse < Struct.new(
283
+ :arn,
284
+ :name,
285
+ :version,
286
+ :sources,
287
+ :robot_software_suite,
288
+ :last_updated_at,
289
+ :revision_id)
290
+ include Aws::Structure
291
+ end
292
+
293
+ # @note When making an API call, you may pass CreateRobotApplicationVersionRequest
294
+ # data as a hash:
295
+ #
296
+ # {
297
+ # application: "Arn", # required
298
+ # current_revision_id: "RevisionId",
299
+ # }
300
+ #
301
+ # @!attribute [rw] application
302
+ # The application information for the robot application.
303
+ # @return [String]
304
+ #
305
+ # @!attribute [rw] current_revision_id
306
+ # The current revision id for the robot application. If you provide a
307
+ # value and it matches the latest revision ID, a new version will be
308
+ # created.
309
+ # @return [String]
310
+ #
311
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateRobotApplicationVersionRequest AWS API Documentation
312
+ #
313
+ class CreateRobotApplicationVersionRequest < Struct.new(
314
+ :application,
315
+ :current_revision_id)
316
+ include Aws::Structure
317
+ end
318
+
319
+ # @!attribute [rw] arn
320
+ # The Amazon Resource Name (ARN) of the robot application.
321
+ # @return [String]
322
+ #
323
+ # @!attribute [rw] name
324
+ # The name of the robot application.
325
+ # @return [String]
326
+ #
327
+ # @!attribute [rw] version
328
+ # The version of the robot application.
329
+ # @return [String]
330
+ #
331
+ # @!attribute [rw] sources
332
+ # The sources of the robot application.
333
+ # @return [Array<Types::Source>]
334
+ #
335
+ # @!attribute [rw] robot_software_suite
336
+ # The robot software suite used by the robot application.
337
+ # @return [Types::RobotSoftwareSuite]
338
+ #
339
+ # @!attribute [rw] last_updated_at
340
+ # The time, in milliseconds since the epoch, when the robot
341
+ # application was last updated.
342
+ # @return [Time]
343
+ #
344
+ # @!attribute [rw] revision_id
345
+ # The revision id of the robot application.
346
+ # @return [String]
347
+ #
348
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateRobotApplicationVersionResponse AWS API Documentation
349
+ #
350
+ class CreateRobotApplicationVersionResponse < Struct.new(
351
+ :arn,
352
+ :name,
353
+ :version,
354
+ :sources,
355
+ :robot_software_suite,
356
+ :last_updated_at,
357
+ :revision_id)
358
+ include Aws::Structure
359
+ end
360
+
361
+ # @note When making an API call, you may pass CreateRobotRequest
362
+ # data as a hash:
363
+ #
364
+ # {
365
+ # name: "Name", # required
366
+ # architecture: "X86_64", # required, accepts X86_64, ARM64, ARMHF
367
+ # greengrass_group_id: "Id", # required
368
+ # }
369
+ #
370
+ # @!attribute [rw] name
371
+ # The name for the robot.
372
+ # @return [String]
373
+ #
374
+ # @!attribute [rw] architecture
375
+ # The target architecture of the robot.
376
+ # @return [String]
377
+ #
378
+ # @!attribute [rw] greengrass_group_id
379
+ # The Greengrass group id.
380
+ # @return [String]
381
+ #
382
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateRobotRequest AWS API Documentation
383
+ #
384
+ class CreateRobotRequest < Struct.new(
385
+ :name,
386
+ :architecture,
387
+ :greengrass_group_id)
388
+ include Aws::Structure
389
+ end
390
+
391
+ # @!attribute [rw] arn
392
+ # The Amazon Resource Name (ARN) of the robot.
393
+ # @return [String]
394
+ #
395
+ # @!attribute [rw] name
396
+ # The name of the robot.
397
+ # @return [String]
398
+ #
399
+ # @!attribute [rw] created_at
400
+ # The time, in milliseconds since the epoch, when the robot was
401
+ # created.
402
+ # @return [Time]
403
+ #
404
+ # @!attribute [rw] greengrass_group_id
405
+ # The Amazon Resource Name (ARN) of the Greengrass group associated
406
+ # with the robot.
407
+ # @return [String]
408
+ #
409
+ # @!attribute [rw] architecture
410
+ # The target architecture of the robot.
411
+ # @return [String]
412
+ #
413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateRobotResponse AWS API Documentation
414
+ #
415
+ class CreateRobotResponse < Struct.new(
416
+ :arn,
417
+ :name,
418
+ :created_at,
419
+ :greengrass_group_id,
420
+ :architecture)
421
+ include Aws::Structure
422
+ end
423
+
424
+ # @note When making an API call, you may pass CreateSimulationApplicationRequest
425
+ # data as a hash:
426
+ #
427
+ # {
428
+ # name: "Name", # required
429
+ # sources: [ # required
430
+ # {
431
+ # s3_bucket: "S3Bucket",
432
+ # s3_key: "S3Key",
433
+ # architecture: "X86_64", # accepts X86_64, ARM64, ARMHF
434
+ # },
435
+ # ],
436
+ # simulation_software_suite: { # required
437
+ # name: "Gazebo", # accepts Gazebo
438
+ # version: "SimulationSoftwareSuiteVersionType",
439
+ # },
440
+ # robot_software_suite: { # required
441
+ # name: "ROS", # accepts ROS
442
+ # version: "Kinetic", # accepts Kinetic
443
+ # },
444
+ # rendering_engine: { # required
445
+ # name: "OGRE", # accepts OGRE
446
+ # version: "RenderingEngineVersionType",
447
+ # },
448
+ # }
449
+ #
450
+ # @!attribute [rw] name
451
+ # The name of the simulation application.
452
+ # @return [String]
453
+ #
454
+ # @!attribute [rw] sources
455
+ # The sources of the simulation application.
456
+ # @return [Array<Types::SourceConfig>]
457
+ #
458
+ # @!attribute [rw] simulation_software_suite
459
+ # The simulation software suite used by the simulation application.
460
+ # @return [Types::SimulationSoftwareSuite]
461
+ #
462
+ # @!attribute [rw] robot_software_suite
463
+ # The robot software suite of the simulation application.
464
+ # @return [Types::RobotSoftwareSuite]
465
+ #
466
+ # @!attribute [rw] rendering_engine
467
+ # The rendering engine for the simulation application.
468
+ # @return [Types::RenderingEngine]
469
+ #
470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateSimulationApplicationRequest AWS API Documentation
471
+ #
472
+ class CreateSimulationApplicationRequest < Struct.new(
473
+ :name,
474
+ :sources,
475
+ :simulation_software_suite,
476
+ :robot_software_suite,
477
+ :rendering_engine)
478
+ include Aws::Structure
479
+ end
480
+
481
+ # @!attribute [rw] arn
482
+ # The Amazon Resource Name (ARN) of the simulation application.
483
+ # @return [String]
484
+ #
485
+ # @!attribute [rw] name
486
+ # The name of the simulation application.
487
+ # @return [String]
488
+ #
489
+ # @!attribute [rw] version
490
+ # The version of the simulation application.
491
+ # @return [String]
492
+ #
493
+ # @!attribute [rw] sources
494
+ # The sources of the simulation application.
495
+ # @return [Array<Types::Source>]
496
+ #
497
+ # @!attribute [rw] simulation_software_suite
498
+ # The simulation software suite used by the simulation application.
499
+ # @return [Types::SimulationSoftwareSuite]
500
+ #
501
+ # @!attribute [rw] robot_software_suite
502
+ # Information about the robot software suite.
503
+ # @return [Types::RobotSoftwareSuite]
504
+ #
505
+ # @!attribute [rw] rendering_engine
506
+ # The rendering engine for the simulation application.
507
+ # @return [Types::RenderingEngine]
508
+ #
509
+ # @!attribute [rw] last_updated_at
510
+ # The time, in milliseconds since the epoch, when the simulation
511
+ # application was last updated.
512
+ # @return [Time]
513
+ #
514
+ # @!attribute [rw] revision_id
515
+ # The revision id of the simulation application.
516
+ # @return [String]
517
+ #
518
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateSimulationApplicationResponse AWS API Documentation
519
+ #
520
+ class CreateSimulationApplicationResponse < Struct.new(
521
+ :arn,
522
+ :name,
523
+ :version,
524
+ :sources,
525
+ :simulation_software_suite,
526
+ :robot_software_suite,
527
+ :rendering_engine,
528
+ :last_updated_at,
529
+ :revision_id)
530
+ include Aws::Structure
531
+ end
532
+
533
+ # @note When making an API call, you may pass CreateSimulationApplicationVersionRequest
534
+ # data as a hash:
535
+ #
536
+ # {
537
+ # application: "Arn", # required
538
+ # current_revision_id: "RevisionId",
539
+ # }
540
+ #
541
+ # @!attribute [rw] application
542
+ # The application information for the simulation application.
543
+ # @return [String]
544
+ #
545
+ # @!attribute [rw] current_revision_id
546
+ # The current revision id for the simulation application. If you
547
+ # provide a value and it matches the latest revision ID, a new version
548
+ # will be created.
549
+ # @return [String]
550
+ #
551
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateSimulationApplicationVersionRequest AWS API Documentation
552
+ #
553
+ class CreateSimulationApplicationVersionRequest < Struct.new(
554
+ :application,
555
+ :current_revision_id)
556
+ include Aws::Structure
557
+ end
558
+
559
+ # @!attribute [rw] arn
560
+ # The Amazon Resource Name (ARN) of the simulation application.
561
+ # @return [String]
562
+ #
563
+ # @!attribute [rw] name
564
+ # The name of the simulation application.
565
+ # @return [String]
566
+ #
567
+ # @!attribute [rw] version
568
+ # The version of the simulation application.
569
+ # @return [String]
570
+ #
571
+ # @!attribute [rw] sources
572
+ # The sources of the simulation application.
573
+ # @return [Array<Types::Source>]
574
+ #
575
+ # @!attribute [rw] simulation_software_suite
576
+ # The simulation software suite used by the simulation application.
577
+ # @return [Types::SimulationSoftwareSuite]
578
+ #
579
+ # @!attribute [rw] robot_software_suite
580
+ # Information about the robot software suite.
581
+ # @return [Types::RobotSoftwareSuite]
582
+ #
583
+ # @!attribute [rw] rendering_engine
584
+ # The rendering engine for the simulation application.
585
+ # @return [Types::RenderingEngine]
586
+ #
587
+ # @!attribute [rw] last_updated_at
588
+ # The time, in milliseconds since the epoch, when the simulation
589
+ # application was last updated.
590
+ # @return [Time]
591
+ #
592
+ # @!attribute [rw] revision_id
593
+ # The revision ID of the simulation application.
594
+ # @return [String]
595
+ #
596
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateSimulationApplicationVersionResponse AWS API Documentation
597
+ #
598
+ class CreateSimulationApplicationVersionResponse < Struct.new(
599
+ :arn,
600
+ :name,
601
+ :version,
602
+ :sources,
603
+ :simulation_software_suite,
604
+ :robot_software_suite,
605
+ :rendering_engine,
606
+ :last_updated_at,
607
+ :revision_id)
608
+ include Aws::Structure
609
+ end
610
+
611
+ # @note When making an API call, you may pass CreateSimulationJobRequest
612
+ # data as a hash:
613
+ #
614
+ # {
615
+ # client_request_token: "ClientRequestToken",
616
+ # output_location: {
617
+ # s3_bucket: "S3Bucket",
618
+ # s3_prefix: "S3Key",
619
+ # },
620
+ # max_job_duration_in_seconds: 1, # required
621
+ # iam_role: "IamRole", # required
622
+ # failure_behavior: "Fail", # accepts Fail, Continue
623
+ # robot_applications: [
624
+ # {
625
+ # application: "Arn", # required
626
+ # application_version: "Version",
627
+ # launch_config: { # required
628
+ # package_name: "GenericString", # required
629
+ # launch_file: "GenericString", # required
630
+ # environment_variables: {
631
+ # "EnvironmentVariableKey" => "EnvironmentVariableValue",
632
+ # },
633
+ # },
634
+ # },
635
+ # ],
636
+ # simulation_applications: [
637
+ # {
638
+ # application: "Arn", # required
639
+ # application_version: "Version",
640
+ # launch_config: { # required
641
+ # package_name: "GenericString", # required
642
+ # launch_file: "GenericString", # required
643
+ # environment_variables: {
644
+ # "EnvironmentVariableKey" => "EnvironmentVariableValue",
645
+ # },
646
+ # },
647
+ # },
648
+ # ],
649
+ # vpc_config: {
650
+ # subnets: ["GenericString"], # required
651
+ # security_groups: ["GenericString"],
652
+ # assign_public_ip: false,
653
+ # },
654
+ # }
655
+ #
656
+ # @!attribute [rw] client_request_token
657
+ # Unique, case-sensitive identifier that you provide to ensure the
658
+ # idempotency of the request.
659
+ #
660
+ # **A suitable default value is auto-generated.** You should normally
661
+ # not need to pass this option.
662
+ # @return [String]
663
+ #
664
+ # @!attribute [rw] output_location
665
+ # Location for output files generated by the simulation job.
666
+ # @return [Types::OutputLocation]
667
+ #
668
+ # @!attribute [rw] max_job_duration_in_seconds
669
+ # The maximum simulation job duration in seconds (up to 14 days or
670
+ # 1,209,600 seconds. When `maxJobDurationInSeconds` is reached, the
671
+ # simulation job will status will transition to `Completed`.
672
+ # @return [Integer]
673
+ #
674
+ # @!attribute [rw] iam_role
675
+ # The IAM role that allows the simulation instance to call the AWS
676
+ # APIs that are specified in its associated policies on your behalf.
677
+ # This is how credentials are passed in to your simulation job. See
678
+ # how to [specify AWS security credentials for your application][1].
679
+ #
680
+ #
681
+ #
682
+ # [1]: https://docs.aws.amazon.com/toolkit-for-visual-studio/latest/user-guide/deployment-ecs-specify-credentials
683
+ # @return [String]
684
+ #
685
+ # @!attribute [rw] failure_behavior
686
+ # The failure behavior the simulation job.
687
+ #
688
+ # Continue
689
+ #
690
+ # : Restart the simulation job in the same host instance.
691
+ #
692
+ # Fail
693
+ #
694
+ # : Stop the simulation job and terminate the instance.
695
+ # @return [String]
696
+ #
697
+ # @!attribute [rw] robot_applications
698
+ # The robot application to use in the simulation job.
699
+ # @return [Array<Types::RobotApplicationConfig>]
700
+ #
701
+ # @!attribute [rw] simulation_applications
702
+ # The simulation application to use in the simulation job.
703
+ # @return [Array<Types::SimulationApplicationConfig>]
704
+ #
705
+ # @!attribute [rw] vpc_config
706
+ # If your simulation job accesses resources in a VPC, you provide this
707
+ # parameter identifying the list of security group IDs and subnet IDs.
708
+ # These must belong to the same VPC. You must provide at least one
709
+ # security group and one subnet ID.
710
+ # @return [Types::VPCConfig]
711
+ #
712
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateSimulationJobRequest AWS API Documentation
713
+ #
714
+ class CreateSimulationJobRequest < Struct.new(
715
+ :client_request_token,
716
+ :output_location,
717
+ :max_job_duration_in_seconds,
718
+ :iam_role,
719
+ :failure_behavior,
720
+ :robot_applications,
721
+ :simulation_applications,
722
+ :vpc_config)
723
+ include Aws::Structure
724
+ end
725
+
726
+ # @!attribute [rw] arn
727
+ # The Amazon Resource Name (ARN) of the simulation job.
728
+ # @return [String]
729
+ #
730
+ # @!attribute [rw] status
731
+ # The status of the simulation job.
732
+ # @return [String]
733
+ #
734
+ # @!attribute [rw] last_updated_at
735
+ # The time, in milliseconds since the epoch, when the simulation job
736
+ # was last updated.
737
+ # @return [Time]
738
+ #
739
+ # @!attribute [rw] failure_behavior
740
+ # the failure behavior for the simulation job.
741
+ # @return [String]
742
+ #
743
+ # @!attribute [rw] failure_code
744
+ # The failure code of the simulation job if it failed.
745
+ # @return [String]
746
+ #
747
+ # @!attribute [rw] client_request_token
748
+ # Unique, case-sensitive identifier that you provide to ensure the
749
+ # idempotency of the request.
750
+ # @return [String]
751
+ #
752
+ # @!attribute [rw] output_location
753
+ # Simulation job output files location.
754
+ # @return [Types::OutputLocation]
755
+ #
756
+ # @!attribute [rw] max_job_duration_in_seconds
757
+ # The maximum simulation job duration in seconds. The value must be 8
758
+ # days (691,200 seconds) or less.
759
+ # @return [Integer]
760
+ #
761
+ # @!attribute [rw] simulation_time_millis
762
+ # The simulation job execution duration in milliseconds.
763
+ # @return [Integer]
764
+ #
765
+ # @!attribute [rw] iam_role
766
+ # The IAM role that allows the simulation job to call the AWS APIs
767
+ # that are specified in its associated policies on your behalf.
768
+ # @return [String]
769
+ #
770
+ # @!attribute [rw] robot_applications
771
+ # The robot application used by the simulation job.
772
+ # @return [Array<Types::RobotApplicationConfig>]
773
+ #
774
+ # @!attribute [rw] simulation_applications
775
+ # The simulation application used by the simulation job.
776
+ # @return [Array<Types::SimulationApplicationConfig>]
777
+ #
778
+ # @!attribute [rw] vpc_config
779
+ # Information about the vpc configuration.
780
+ # @return [Types::VPCConfigResponse]
781
+ #
782
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/CreateSimulationJobResponse AWS API Documentation
783
+ #
784
+ class CreateSimulationJobResponse < Struct.new(
785
+ :arn,
786
+ :status,
787
+ :last_updated_at,
788
+ :failure_behavior,
789
+ :failure_code,
790
+ :client_request_token,
791
+ :output_location,
792
+ :max_job_duration_in_seconds,
793
+ :simulation_time_millis,
794
+ :iam_role,
795
+ :robot_applications,
796
+ :simulation_applications,
797
+ :vpc_config)
798
+ include Aws::Structure
799
+ end
800
+
801
+ # @note When making an API call, you may pass DeleteFleetRequest
802
+ # data as a hash:
803
+ #
804
+ # {
805
+ # fleet: "Arn", # required
806
+ # }
807
+ #
808
+ # @!attribute [rw] fleet
809
+ # The Amazon Resource Name (ARN) of the fleet.
810
+ # @return [String]
811
+ #
812
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteFleetRequest AWS API Documentation
813
+ #
814
+ class DeleteFleetRequest < Struct.new(
815
+ :fleet)
816
+ include Aws::Structure
817
+ end
818
+
819
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteFleetResponse AWS API Documentation
820
+ #
821
+ class DeleteFleetResponse < Aws::EmptyStructure; end
822
+
823
+ # @note When making an API call, you may pass DeleteRobotApplicationRequest
824
+ # data as a hash:
825
+ #
826
+ # {
827
+ # application: "Arn", # required
828
+ # application_version: "Version",
829
+ # }
830
+ #
831
+ # @!attribute [rw] application
832
+ # The Amazon Resource Name (ARN) of the the robot application.
833
+ # @return [String]
834
+ #
835
+ # @!attribute [rw] application_version
836
+ # The version of the robot application to delete.
837
+ # @return [String]
838
+ #
839
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteRobotApplicationRequest AWS API Documentation
840
+ #
841
+ class DeleteRobotApplicationRequest < Struct.new(
842
+ :application,
843
+ :application_version)
844
+ include Aws::Structure
845
+ end
846
+
847
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteRobotApplicationResponse AWS API Documentation
848
+ #
849
+ class DeleteRobotApplicationResponse < Aws::EmptyStructure; end
850
+
851
+ # @note When making an API call, you may pass DeleteRobotRequest
852
+ # data as a hash:
853
+ #
854
+ # {
855
+ # robot: "Arn", # required
856
+ # }
857
+ #
858
+ # @!attribute [rw] robot
859
+ # The Amazon Resource Name (ARN) of the robot.
860
+ # @return [String]
861
+ #
862
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteRobotRequest AWS API Documentation
863
+ #
864
+ class DeleteRobotRequest < Struct.new(
865
+ :robot)
866
+ include Aws::Structure
867
+ end
868
+
869
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteRobotResponse AWS API Documentation
870
+ #
871
+ class DeleteRobotResponse < Aws::EmptyStructure; end
872
+
873
+ # @note When making an API call, you may pass DeleteSimulationApplicationRequest
874
+ # data as a hash:
875
+ #
876
+ # {
877
+ # application: "Arn", # required
878
+ # application_version: "Version",
879
+ # }
880
+ #
881
+ # @!attribute [rw] application
882
+ # The application information for the simulation application to
883
+ # delete.
884
+ # @return [String]
885
+ #
886
+ # @!attribute [rw] application_version
887
+ # The version of the simulation application to delete.
888
+ # @return [String]
889
+ #
890
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteSimulationApplicationRequest AWS API Documentation
891
+ #
892
+ class DeleteSimulationApplicationRequest < Struct.new(
893
+ :application,
894
+ :application_version)
895
+ include Aws::Structure
896
+ end
897
+
898
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeleteSimulationApplicationResponse AWS API Documentation
899
+ #
900
+ class DeleteSimulationApplicationResponse < Aws::EmptyStructure; end
901
+
902
+ # Information about a deployment application configuration.
903
+ #
904
+ # @note When making an API call, you may pass DeploymentApplicationConfig
905
+ # data as a hash:
906
+ #
907
+ # {
908
+ # application: "Arn", # required
909
+ # application_version: "Version", # required
910
+ # launch_config: { # required
911
+ # package_name: "GenericString", # required
912
+ # pre_launch_file: "GenericString",
913
+ # launch_file: "GenericString", # required
914
+ # post_launch_file: "GenericString",
915
+ # environment_variables: {
916
+ # "EnvironmentVariableKey" => "EnvironmentVariableValue",
917
+ # },
918
+ # },
919
+ # }
920
+ #
921
+ # @!attribute [rw] application
922
+ # The application.
923
+ # @return [String]
924
+ #
925
+ # @!attribute [rw] application_version
926
+ # The version of the application.
927
+ # @return [String]
928
+ #
929
+ # @!attribute [rw] launch_config
930
+ # The launch configuration, usually `roslaunch`.
931
+ # @return [Types::DeploymentLaunchConfig]
932
+ #
933
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeploymentApplicationConfig AWS API Documentation
934
+ #
935
+ class DeploymentApplicationConfig < Struct.new(
936
+ :application,
937
+ :application_version,
938
+ :launch_config)
939
+ include Aws::Structure
940
+ end
941
+
942
+ # Information about a deployment configuration.
943
+ #
944
+ # @note When making an API call, you may pass DeploymentConfig
945
+ # data as a hash:
946
+ #
947
+ # {
948
+ # concurrent_deployment_percentage: 1,
949
+ # failure_threshold_percentage: 1,
950
+ # }
951
+ #
952
+ # @!attribute [rw] concurrent_deployment_percentage
953
+ # The percentage of robots receiving the deployment at the same time.
954
+ # @return [Integer]
955
+ #
956
+ # @!attribute [rw] failure_threshold_percentage
957
+ # The percentage of deployments that need to fail before stopping
958
+ # deployment.
959
+ # @return [Integer]
960
+ #
961
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeploymentConfig AWS API Documentation
962
+ #
963
+ class DeploymentConfig < Struct.new(
964
+ :concurrent_deployment_percentage,
965
+ :failure_threshold_percentage)
966
+ include Aws::Structure
967
+ end
968
+
969
+ # Information about a deployment job.
970
+ #
971
+ # @!attribute [rw] arn
972
+ # The Amazon Resource Name (ARN) of the deployment job.
973
+ # @return [String]
974
+ #
975
+ # @!attribute [rw] fleet
976
+ # The Amazon Resource Name (ARN) of the fleet.
977
+ # @return [String]
978
+ #
979
+ # @!attribute [rw] status
980
+ # The status of the deployment job.
981
+ # @return [String]
982
+ #
983
+ # @!attribute [rw] deployment_application_configs
984
+ # The deployment application configuration.
985
+ # @return [Array<Types::DeploymentApplicationConfig>]
986
+ #
987
+ # @!attribute [rw] deployment_config
988
+ # The deployment configuration.
989
+ # @return [Types::DeploymentConfig]
990
+ #
991
+ # @!attribute [rw] failure_reason
992
+ # A short description of the reason why the deployment job failed.
993
+ # @return [String]
994
+ #
995
+ # @!attribute [rw] failure_code
996
+ # The deployment job failure code.
997
+ # @return [String]
998
+ #
999
+ # @!attribute [rw] created_at
1000
+ # The time, in milliseconds since the epoch, when the deployment job
1001
+ # was created.
1002
+ # @return [Time]
1003
+ #
1004
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeploymentJob AWS API Documentation
1005
+ #
1006
+ class DeploymentJob < Struct.new(
1007
+ :arn,
1008
+ :fleet,
1009
+ :status,
1010
+ :deployment_application_configs,
1011
+ :deployment_config,
1012
+ :failure_reason,
1013
+ :failure_code,
1014
+ :created_at)
1015
+ include Aws::Structure
1016
+ end
1017
+
1018
+ # Configuration information for a deployment launch.
1019
+ #
1020
+ # @note When making an API call, you may pass DeploymentLaunchConfig
1021
+ # data as a hash:
1022
+ #
1023
+ # {
1024
+ # package_name: "GenericString", # required
1025
+ # pre_launch_file: "GenericString",
1026
+ # launch_file: "GenericString", # required
1027
+ # post_launch_file: "GenericString",
1028
+ # environment_variables: {
1029
+ # "EnvironmentVariableKey" => "EnvironmentVariableValue",
1030
+ # },
1031
+ # }
1032
+ #
1033
+ # @!attribute [rw] package_name
1034
+ # The package name.
1035
+ # @return [String]
1036
+ #
1037
+ # @!attribute [rw] pre_launch_file
1038
+ # The deployment pre-launch file. This file will be executed prior to
1039
+ # the deployment launch file.
1040
+ # @return [String]
1041
+ #
1042
+ # @!attribute [rw] launch_file
1043
+ # The deployment launch file.
1044
+ # @return [String]
1045
+ #
1046
+ # @!attribute [rw] post_launch_file
1047
+ # The deployment post-launch file. This file will be executed after
1048
+ # the deployment launch file.
1049
+ # @return [String]
1050
+ #
1051
+ # @!attribute [rw] environment_variables
1052
+ # An array of key/value pairs specifying environment variables for the
1053
+ # deployment application.
1054
+ # @return [Hash<String,String>]
1055
+ #
1056
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeploymentLaunchConfig AWS API Documentation
1057
+ #
1058
+ class DeploymentLaunchConfig < Struct.new(
1059
+ :package_name,
1060
+ :pre_launch_file,
1061
+ :launch_file,
1062
+ :post_launch_file,
1063
+ :environment_variables)
1064
+ include Aws::Structure
1065
+ end
1066
+
1067
+ # @note When making an API call, you may pass DeregisterRobotRequest
1068
+ # data as a hash:
1069
+ #
1070
+ # {
1071
+ # fleet: "Arn", # required
1072
+ # robot: "Arn", # required
1073
+ # }
1074
+ #
1075
+ # @!attribute [rw] fleet
1076
+ # The Amazon Resource Name (ARN) of the fleet.
1077
+ # @return [String]
1078
+ #
1079
+ # @!attribute [rw] robot
1080
+ # The Amazon Resource Name (ARN) of the robot.
1081
+ # @return [String]
1082
+ #
1083
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeregisterRobotRequest AWS API Documentation
1084
+ #
1085
+ class DeregisterRobotRequest < Struct.new(
1086
+ :fleet,
1087
+ :robot)
1088
+ include Aws::Structure
1089
+ end
1090
+
1091
+ # @!attribute [rw] fleet
1092
+ # The Amazon Resource Name (ARN) of the fleet.
1093
+ # @return [String]
1094
+ #
1095
+ # @!attribute [rw] robot
1096
+ # The Amazon Resource Name (ARN) of the robot.
1097
+ # @return [String]
1098
+ #
1099
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DeregisterRobotResponse AWS API Documentation
1100
+ #
1101
+ class DeregisterRobotResponse < Struct.new(
1102
+ :fleet,
1103
+ :robot)
1104
+ include Aws::Structure
1105
+ end
1106
+
1107
+ # @note When making an API call, you may pass DescribeDeploymentJobRequest
1108
+ # data as a hash:
1109
+ #
1110
+ # {
1111
+ # job: "Arn", # required
1112
+ # }
1113
+ #
1114
+ # @!attribute [rw] job
1115
+ # The Amazon Resource Name (ARN) of the deployment job.
1116
+ # @return [String]
1117
+ #
1118
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeDeploymentJobRequest AWS API Documentation
1119
+ #
1120
+ class DescribeDeploymentJobRequest < Struct.new(
1121
+ :job)
1122
+ include Aws::Structure
1123
+ end
1124
+
1125
+ # @!attribute [rw] arn
1126
+ # The Amazon Resource Name (ARN) of the deployment job.
1127
+ # @return [String]
1128
+ #
1129
+ # @!attribute [rw] fleet
1130
+ # The Amazon Resource Name (ARN) of the fleet.
1131
+ # @return [String]
1132
+ #
1133
+ # @!attribute [rw] status
1134
+ # The status of the deployment job.
1135
+ # @return [String]
1136
+ #
1137
+ # @!attribute [rw] deployment_config
1138
+ # The deployment configuration.
1139
+ # @return [Types::DeploymentConfig]
1140
+ #
1141
+ # @!attribute [rw] deployment_application_configs
1142
+ # The deployment application configuration.
1143
+ # @return [Array<Types::DeploymentApplicationConfig>]
1144
+ #
1145
+ # @!attribute [rw] failure_reason
1146
+ # A short description of the reason why the deployment job failed.
1147
+ # @return [String]
1148
+ #
1149
+ # @!attribute [rw] failure_code
1150
+ # The deployment job failure code.
1151
+ # @return [String]
1152
+ #
1153
+ # @!attribute [rw] created_at
1154
+ # The time, in milliseconds since the epoch, when the deployment job
1155
+ # was created.
1156
+ # @return [Time]
1157
+ #
1158
+ # @!attribute [rw] robot_deployment_summary
1159
+ # A list of robot deployment summaries.
1160
+ # @return [Array<Types::RobotDeployment>]
1161
+ #
1162
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeDeploymentJobResponse AWS API Documentation
1163
+ #
1164
+ class DescribeDeploymentJobResponse < Struct.new(
1165
+ :arn,
1166
+ :fleet,
1167
+ :status,
1168
+ :deployment_config,
1169
+ :deployment_application_configs,
1170
+ :failure_reason,
1171
+ :failure_code,
1172
+ :created_at,
1173
+ :robot_deployment_summary)
1174
+ include Aws::Structure
1175
+ end
1176
+
1177
+ # @note When making an API call, you may pass DescribeFleetRequest
1178
+ # data as a hash:
1179
+ #
1180
+ # {
1181
+ # fleet: "Arn", # required
1182
+ # }
1183
+ #
1184
+ # @!attribute [rw] fleet
1185
+ # The Amazon Resource Name (ARN) of the fleet.
1186
+ # @return [String]
1187
+ #
1188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeFleetRequest AWS API Documentation
1189
+ #
1190
+ class DescribeFleetRequest < Struct.new(
1191
+ :fleet)
1192
+ include Aws::Structure
1193
+ end
1194
+
1195
+ # @!attribute [rw] name
1196
+ # The name of the fleet.
1197
+ # @return [String]
1198
+ #
1199
+ # @!attribute [rw] arn
1200
+ # The Amazon Resource Name (ARN) of the fleet.
1201
+ # @return [String]
1202
+ #
1203
+ # @!attribute [rw] robots
1204
+ # A list of robots.
1205
+ # @return [Array<Types::Robot>]
1206
+ #
1207
+ # @!attribute [rw] created_at
1208
+ # The time, in milliseconds since the epoch, when the fleet was
1209
+ # created.
1210
+ # @return [Time]
1211
+ #
1212
+ # @!attribute [rw] last_deployment_status
1213
+ # The status of the last deployment.
1214
+ # @return [String]
1215
+ #
1216
+ # @!attribute [rw] last_deployment_job
1217
+ # The Amazon Resource Name (ARN) of the last deployment job.
1218
+ # @return [String]
1219
+ #
1220
+ # @!attribute [rw] last_deployment_time
1221
+ # The time of the last deployment.
1222
+ # @return [Time]
1223
+ #
1224
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeFleetResponse AWS API Documentation
1225
+ #
1226
+ class DescribeFleetResponse < Struct.new(
1227
+ :name,
1228
+ :arn,
1229
+ :robots,
1230
+ :created_at,
1231
+ :last_deployment_status,
1232
+ :last_deployment_job,
1233
+ :last_deployment_time)
1234
+ include Aws::Structure
1235
+ end
1236
+
1237
+ # @note When making an API call, you may pass DescribeRobotApplicationRequest
1238
+ # data as a hash:
1239
+ #
1240
+ # {
1241
+ # application: "Arn", # required
1242
+ # application_version: "Version",
1243
+ # }
1244
+ #
1245
+ # @!attribute [rw] application
1246
+ # The Amazon Resource Name (ARN) of the robot application.
1247
+ # @return [String]
1248
+ #
1249
+ # @!attribute [rw] application_version
1250
+ # The version of the robot application to describe.
1251
+ # @return [String]
1252
+ #
1253
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeRobotApplicationRequest AWS API Documentation
1254
+ #
1255
+ class DescribeRobotApplicationRequest < Struct.new(
1256
+ :application,
1257
+ :application_version)
1258
+ include Aws::Structure
1259
+ end
1260
+
1261
+ # @!attribute [rw] arn
1262
+ # The Amazon Resource Name (ARN) of the robot application.
1263
+ # @return [String]
1264
+ #
1265
+ # @!attribute [rw] name
1266
+ # The name of the robot application.
1267
+ # @return [String]
1268
+ #
1269
+ # @!attribute [rw] version
1270
+ # The version of the robot application.
1271
+ # @return [String]
1272
+ #
1273
+ # @!attribute [rw] sources
1274
+ # The sources of the robot application.
1275
+ # @return [Array<Types::Source>]
1276
+ #
1277
+ # @!attribute [rw] robot_software_suite
1278
+ # The robot software suite used by the robot application.
1279
+ # @return [Types::RobotSoftwareSuite]
1280
+ #
1281
+ # @!attribute [rw] revision_id
1282
+ # The revision id of the robot application.
1283
+ # @return [String]
1284
+ #
1285
+ # @!attribute [rw] last_updated_at
1286
+ # The time, in milliseconds since the epoch, when the robot
1287
+ # application was last updated.
1288
+ # @return [Time]
1289
+ #
1290
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeRobotApplicationResponse AWS API Documentation
1291
+ #
1292
+ class DescribeRobotApplicationResponse < Struct.new(
1293
+ :arn,
1294
+ :name,
1295
+ :version,
1296
+ :sources,
1297
+ :robot_software_suite,
1298
+ :revision_id,
1299
+ :last_updated_at)
1300
+ include Aws::Structure
1301
+ end
1302
+
1303
+ # @note When making an API call, you may pass DescribeRobotRequest
1304
+ # data as a hash:
1305
+ #
1306
+ # {
1307
+ # robot: "Arn", # required
1308
+ # }
1309
+ #
1310
+ # @!attribute [rw] robot
1311
+ # The Amazon Resource Name (ARN) of the robot to be described.
1312
+ # @return [String]
1313
+ #
1314
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeRobotRequest AWS API Documentation
1315
+ #
1316
+ class DescribeRobotRequest < Struct.new(
1317
+ :robot)
1318
+ include Aws::Structure
1319
+ end
1320
+
1321
+ # @!attribute [rw] arn
1322
+ # The Amazon Resource Name (ARN) of the robot.
1323
+ # @return [String]
1324
+ #
1325
+ # @!attribute [rw] name
1326
+ # The name of the robot.
1327
+ # @return [String]
1328
+ #
1329
+ # @!attribute [rw] fleet_arn
1330
+ # The Amazon Resource Name (ARN) of the fleet.
1331
+ # @return [String]
1332
+ #
1333
+ # @!attribute [rw] status
1334
+ # The status of the fleet.
1335
+ # @return [String]
1336
+ #
1337
+ # @!attribute [rw] greengrass_group_id
1338
+ # The Greengrass group id.
1339
+ # @return [String]
1340
+ #
1341
+ # @!attribute [rw] created_at
1342
+ # The time, in milliseconds since the epoch, when the robot was
1343
+ # created.
1344
+ # @return [Time]
1345
+ #
1346
+ # @!attribute [rw] architecture
1347
+ # The target architecture of the robot application.
1348
+ # @return [String]
1349
+ #
1350
+ # @!attribute [rw] last_deployment_job
1351
+ # The Amazon Resource Name (ARN) of the last deployment job.
1352
+ # @return [String]
1353
+ #
1354
+ # @!attribute [rw] last_deployment_time
1355
+ # The time of the last deployment job.
1356
+ # @return [Time]
1357
+ #
1358
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeRobotResponse AWS API Documentation
1359
+ #
1360
+ class DescribeRobotResponse < Struct.new(
1361
+ :arn,
1362
+ :name,
1363
+ :fleet_arn,
1364
+ :status,
1365
+ :greengrass_group_id,
1366
+ :created_at,
1367
+ :architecture,
1368
+ :last_deployment_job,
1369
+ :last_deployment_time)
1370
+ include Aws::Structure
1371
+ end
1372
+
1373
+ # @note When making an API call, you may pass DescribeSimulationApplicationRequest
1374
+ # data as a hash:
1375
+ #
1376
+ # {
1377
+ # application: "Arn", # required
1378
+ # application_version: "Version",
1379
+ # }
1380
+ #
1381
+ # @!attribute [rw] application
1382
+ # The application information for the simulation application.
1383
+ # @return [String]
1384
+ #
1385
+ # @!attribute [rw] application_version
1386
+ # The version of the simulation application to describe.
1387
+ # @return [String]
1388
+ #
1389
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationApplicationRequest AWS API Documentation
1390
+ #
1391
+ class DescribeSimulationApplicationRequest < Struct.new(
1392
+ :application,
1393
+ :application_version)
1394
+ include Aws::Structure
1395
+ end
1396
+
1397
+ # @!attribute [rw] arn
1398
+ # The Amazon Resource Name (ARN) of the robot simulation application.
1399
+ # @return [String]
1400
+ #
1401
+ # @!attribute [rw] name
1402
+ # The name of the simulation application.
1403
+ # @return [String]
1404
+ #
1405
+ # @!attribute [rw] version
1406
+ # The version of the simulation application.
1407
+ # @return [String]
1408
+ #
1409
+ # @!attribute [rw] sources
1410
+ # The sources of the simulation application.
1411
+ # @return [Array<Types::Source>]
1412
+ #
1413
+ # @!attribute [rw] simulation_software_suite
1414
+ # The simulation software suite used by the simulation application.
1415
+ # @return [Types::SimulationSoftwareSuite]
1416
+ #
1417
+ # @!attribute [rw] robot_software_suite
1418
+ # Information about the robot software suite.
1419
+ # @return [Types::RobotSoftwareSuite]
1420
+ #
1421
+ # @!attribute [rw] rendering_engine
1422
+ # The rendering engine for the simulation application.
1423
+ # @return [Types::RenderingEngine]
1424
+ #
1425
+ # @!attribute [rw] revision_id
1426
+ # The revision id of the simulation application.
1427
+ # @return [String]
1428
+ #
1429
+ # @!attribute [rw] last_updated_at
1430
+ # The time, in milliseconds since the epoch, when the simulation
1431
+ # application was last updated.
1432
+ # @return [Time]
1433
+ #
1434
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationApplicationResponse AWS API Documentation
1435
+ #
1436
+ class DescribeSimulationApplicationResponse < Struct.new(
1437
+ :arn,
1438
+ :name,
1439
+ :version,
1440
+ :sources,
1441
+ :simulation_software_suite,
1442
+ :robot_software_suite,
1443
+ :rendering_engine,
1444
+ :revision_id,
1445
+ :last_updated_at)
1446
+ include Aws::Structure
1447
+ end
1448
+
1449
+ # @note When making an API call, you may pass DescribeSimulationJobRequest
1450
+ # data as a hash:
1451
+ #
1452
+ # {
1453
+ # job: "Arn", # required
1454
+ # }
1455
+ #
1456
+ # @!attribute [rw] job
1457
+ # The Amazon Resource Name (ARN) of the simulation job to be
1458
+ # described.
1459
+ # @return [String]
1460
+ #
1461
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationJobRequest AWS API Documentation
1462
+ #
1463
+ class DescribeSimulationJobRequest < Struct.new(
1464
+ :job)
1465
+ include Aws::Structure
1466
+ end
1467
+
1468
+ # @!attribute [rw] arn
1469
+ # The Amazon Resource Name (ARN) of the simulation job.
1470
+ # @return [String]
1471
+ #
1472
+ # @!attribute [rw] name
1473
+ # The name of the simulation job.
1474
+ # @return [String]
1475
+ #
1476
+ # @!attribute [rw] status
1477
+ # The status of the simulation job.
1478
+ # @return [String]
1479
+ #
1480
+ # @!attribute [rw] last_updated_at
1481
+ # The time, in milliseconds since the epoch, when the simulation job
1482
+ # was last updated.
1483
+ # @return [Time]
1484
+ #
1485
+ # @!attribute [rw] failure_behavior
1486
+ # The failure behavior for the simulation job.
1487
+ # @return [String]
1488
+ #
1489
+ # @!attribute [rw] failure_code
1490
+ # The failure code of the simulation job if it failed:
1491
+ #
1492
+ # InternalServiceError
1493
+ #
1494
+ # : Internal service error
1495
+ #
1496
+ # RobotApplicationCrash
1497
+ #
1498
+ # : Robot application exited abnormally (segfault, etc.)
1499
+ #
1500
+ # SimulationApplicationCrash
1501
+ #
1502
+ # : Simulation application exited abnormally (segfault, etc.)
1503
+ #
1504
+ # BadPermissionsRobotApplication
1505
+ #
1506
+ # : Robot application bundle could not be downloaded
1507
+ #
1508
+ # BadPermissionsSimulationApplication
1509
+ #
1510
+ # : Simulation application bundle could not be downloaded
1511
+ #
1512
+ # BadPermissionsS3Output
1513
+ #
1514
+ # : Unable to publish outputs to customer-provided S3 bucket
1515
+ #
1516
+ # BadPermissionsCloudwatchLogs
1517
+ #
1518
+ # : Unable to publish logs to customer-provided CloudWatch Logs
1519
+ # resource
1520
+ #
1521
+ # SubnetIpLimitExceeded
1522
+ #
1523
+ # : Subnet IP limit exceeded
1524
+ #
1525
+ # ENILimitExceeded
1526
+ #
1527
+ # : ENI limit exceeded
1528
+ #
1529
+ # BadPermissionsUserCredentials
1530
+ #
1531
+ # : Unable to use the Role provided
1532
+ #
1533
+ # InvalidBundleRobotApplication
1534
+ #
1535
+ # : Robot bundle cannot be extracted (invalid format, bundling error,
1536
+ # etc.)
1537
+ #
1538
+ # InvalidBundleSimulationApplication
1539
+ #
1540
+ # : Simulation bundle cannot be extracted (invalid format, bundling
1541
+ # error, etc.)
1542
+ #
1543
+ # RobotApplicationVersionMismatchedEtag
1544
+ #
1545
+ # : Etag for RobotApplication does not match value during version
1546
+ # creation
1547
+ #
1548
+ # SimulationApplicationVersionMismatchedEtag
1549
+ #
1550
+ # : Etag for SimulationApplication does not match value during version
1551
+ # creation
1552
+ # @return [String]
1553
+ #
1554
+ # @!attribute [rw] client_request_token
1555
+ # Unique, case-sensitive identifier that you provide to ensure the
1556
+ # idempotency of the request.
1557
+ # @return [String]
1558
+ #
1559
+ # @!attribute [rw] output_location
1560
+ # Location for output files generated by the simulation job.
1561
+ # @return [Types::OutputLocation]
1562
+ #
1563
+ # @!attribute [rw] max_job_duration_in_seconds
1564
+ # The maximum job duration in seconds. The value must be 8 days
1565
+ # (691,200 seconds) or less.
1566
+ # @return [Integer]
1567
+ #
1568
+ # @!attribute [rw] simulation_time_millis
1569
+ # The simulation job execution duration in milliseconds.
1570
+ # @return [Integer]
1571
+ #
1572
+ # @!attribute [rw] iam_role
1573
+ # The IAM role that allows the simulation instance to call the AWS
1574
+ # APIs that are specified in its associated policies on your behalf.
1575
+ # @return [String]
1576
+ #
1577
+ # @!attribute [rw] robot_applications
1578
+ # A list of robot applications.
1579
+ # @return [Array<Types::RobotApplicationConfig>]
1580
+ #
1581
+ # @!attribute [rw] simulation_applications
1582
+ # A list of simulation applications.
1583
+ # @return [Array<Types::SimulationApplicationConfig>]
1584
+ #
1585
+ # @!attribute [rw] vpc_config
1586
+ # The VPC configuration.
1587
+ # @return [Types::VPCConfigResponse]
1588
+ #
1589
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/DescribeSimulationJobResponse AWS API Documentation
1590
+ #
1591
+ class DescribeSimulationJobResponse < Struct.new(
1592
+ :arn,
1593
+ :name,
1594
+ :status,
1595
+ :last_updated_at,
1596
+ :failure_behavior,
1597
+ :failure_code,
1598
+ :client_request_token,
1599
+ :output_location,
1600
+ :max_job_duration_in_seconds,
1601
+ :simulation_time_millis,
1602
+ :iam_role,
1603
+ :robot_applications,
1604
+ :simulation_applications,
1605
+ :vpc_config)
1606
+ include Aws::Structure
1607
+ end
1608
+
1609
+ # Information about a filter.
1610
+ #
1611
+ # @note When making an API call, you may pass Filter
1612
+ # data as a hash:
1613
+ #
1614
+ # {
1615
+ # name: "Name",
1616
+ # values: ["Name"],
1617
+ # }
1618
+ #
1619
+ # @!attribute [rw] name
1620
+ # The name of the filter.
1621
+ # @return [String]
1622
+ #
1623
+ # @!attribute [rw] values
1624
+ # A list of values.
1625
+ # @return [Array<String>]
1626
+ #
1627
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/Filter AWS API Documentation
1628
+ #
1629
+ class Filter < Struct.new(
1630
+ :name,
1631
+ :values)
1632
+ include Aws::Structure
1633
+ end
1634
+
1635
+ # Information about a fleet.
1636
+ #
1637
+ # @!attribute [rw] name
1638
+ # The name of the fleet.
1639
+ # @return [String]
1640
+ #
1641
+ # @!attribute [rw] arn
1642
+ # The Amazon Resource Name (ARN) of the fleet.
1643
+ # @return [String]
1644
+ #
1645
+ # @!attribute [rw] created_at
1646
+ # The time, in milliseconds since the epoch, when the fleet was
1647
+ # created.
1648
+ # @return [Time]
1649
+ #
1650
+ # @!attribute [rw] last_deployment_status
1651
+ # The status of the last fleet deployment.
1652
+ # @return [String]
1653
+ #
1654
+ # @!attribute [rw] last_deployment_job
1655
+ # The Amazon Resource Name (ARN) of the last deployment job.
1656
+ # @return [String]
1657
+ #
1658
+ # @!attribute [rw] last_deployment_time
1659
+ # The time of the last deployment.
1660
+ # @return [Time]
1661
+ #
1662
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/Fleet AWS API Documentation
1663
+ #
1664
+ class Fleet < Struct.new(
1665
+ :name,
1666
+ :arn,
1667
+ :created_at,
1668
+ :last_deployment_status,
1669
+ :last_deployment_job,
1670
+ :last_deployment_time)
1671
+ include Aws::Structure
1672
+ end
1673
+
1674
+ # Information about a launch configuration.
1675
+ #
1676
+ # @note When making an API call, you may pass LaunchConfig
1677
+ # data as a hash:
1678
+ #
1679
+ # {
1680
+ # package_name: "GenericString", # required
1681
+ # launch_file: "GenericString", # required
1682
+ # environment_variables: {
1683
+ # "EnvironmentVariableKey" => "EnvironmentVariableValue",
1684
+ # },
1685
+ # }
1686
+ #
1687
+ # @!attribute [rw] package_name
1688
+ # The package name.
1689
+ # @return [String]
1690
+ #
1691
+ # @!attribute [rw] launch_file
1692
+ # The launch file.
1693
+ # @return [String]
1694
+ #
1695
+ # @!attribute [rw] environment_variables
1696
+ # The environment variables for the application launch.
1697
+ # @return [Hash<String,String>]
1698
+ #
1699
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/LaunchConfig AWS API Documentation
1700
+ #
1701
+ class LaunchConfig < Struct.new(
1702
+ :package_name,
1703
+ :launch_file,
1704
+ :environment_variables)
1705
+ include Aws::Structure
1706
+ end
1707
+
1708
+ # @note When making an API call, you may pass ListDeploymentJobsRequest
1709
+ # data as a hash:
1710
+ #
1711
+ # {
1712
+ # filters: [
1713
+ # {
1714
+ # name: "Name",
1715
+ # values: ["Name"],
1716
+ # },
1717
+ # ],
1718
+ # next_token: "PaginationToken",
1719
+ # max_results: 1,
1720
+ # }
1721
+ #
1722
+ # @!attribute [rw] filters
1723
+ # Optional filters to limit results.
1724
+ # @return [Array<Types::Filter>]
1725
+ #
1726
+ # @!attribute [rw] next_token
1727
+ # The `nextToken` value returned from a previous paginated
1728
+ # `ListDeploymentJobs` request where `maxResults` was used and the
1729
+ # results exceeded the value of that parameter. Pagination continues
1730
+ # from the end of the previous results that returned the `nextToken`
1731
+ # value.
1732
+ #
1733
+ # <note markdown="1"> This token should be treated as an opaque identifier that is only
1734
+ # used to retrieve the next items in a list and not for other
1735
+ # programmatic purposes.
1736
+ #
1737
+ # </note>
1738
+ # @return [String]
1739
+ #
1740
+ # @!attribute [rw] max_results
1741
+ # The maximum number of deployment job results returned by
1742
+ # `ListDeploymentJobs` in paginated output. When this parameter is
1743
+ # used, `ListDeploymentJobs` only returns `maxResults` results in a
1744
+ # single page along with a `nextToken` response element. The remaining
1745
+ # results of the initial request can be seen by sending another
1746
+ # `ListDeploymentJobs` request with the returned `nextToken` value.
1747
+ # This value can be between 1 and 100. If this parameter is not used,
1748
+ # then `ListDeploymentJobs` returns up to 100 results and a
1749
+ # `nextToken` value if applicable.
1750
+ # @return [Integer]
1751
+ #
1752
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListDeploymentJobsRequest AWS API Documentation
1753
+ #
1754
+ class ListDeploymentJobsRequest < Struct.new(
1755
+ :filters,
1756
+ :next_token,
1757
+ :max_results)
1758
+ include Aws::Structure
1759
+ end
1760
+
1761
+ # @!attribute [rw] deployment_jobs
1762
+ # A list of deployment jobs that meet the criteria of the request.
1763
+ # @return [Array<Types::DeploymentJob>]
1764
+ #
1765
+ # @!attribute [rw] next_token
1766
+ # The `nextToken` value to include in a future `ListDeploymentJobs`
1767
+ # request. When the results of a `ListDeploymentJobs` request exceed
1768
+ # `maxResults`, this value can be used to retrieve the next page of
1769
+ # results. This value is `null` when there are no more results to
1770
+ # return.
1771
+ # @return [String]
1772
+ #
1773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListDeploymentJobsResponse AWS API Documentation
1774
+ #
1775
+ class ListDeploymentJobsResponse < Struct.new(
1776
+ :deployment_jobs,
1777
+ :next_token)
1778
+ include Aws::Structure
1779
+ end
1780
+
1781
+ # @note When making an API call, you may pass ListFleetsRequest
1782
+ # data as a hash:
1783
+ #
1784
+ # {
1785
+ # next_token: "PaginationToken",
1786
+ # max_results: 1,
1787
+ # filters: [
1788
+ # {
1789
+ # name: "Name",
1790
+ # values: ["Name"],
1791
+ # },
1792
+ # ],
1793
+ # }
1794
+ #
1795
+ # @!attribute [rw] next_token
1796
+ # The `nextToken` value returned from a previous paginated
1797
+ # `ListFleets` request where `maxResults` was used and the results
1798
+ # exceeded the value of that parameter. Pagination continues from the
1799
+ # end of the previous results that returned the `nextToken` value.
1800
+ #
1801
+ # <note markdown="1"> This token should be treated as an opaque identifier that is only
1802
+ # used to retrieve the next items in a list and not for other
1803
+ # programmatic purposes.
1804
+ #
1805
+ # </note>
1806
+ # @return [String]
1807
+ #
1808
+ # @!attribute [rw] max_results
1809
+ # The maximum number of deployment job results returned by
1810
+ # `ListFleets` in paginated output. When this parameter is used,
1811
+ # `ListFleets` only returns `maxResults` results in a single page
1812
+ # along with a `nextToken` response element. The remaining results of
1813
+ # the initial request can be seen by sending another `ListFleets`
1814
+ # request with the returned `nextToken` value. This value can be
1815
+ # between 1 and 100. If this parameter is not used, then `ListFleets`
1816
+ # returns up to 100 results and a `nextToken` value if applicable.
1817
+ # @return [Integer]
1818
+ #
1819
+ # @!attribute [rw] filters
1820
+ # Optional filters to limit results.
1821
+ # @return [Array<Types::Filter>]
1822
+ #
1823
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListFleetsRequest AWS API Documentation
1824
+ #
1825
+ class ListFleetsRequest < Struct.new(
1826
+ :next_token,
1827
+ :max_results,
1828
+ :filters)
1829
+ include Aws::Structure
1830
+ end
1831
+
1832
+ # @!attribute [rw] fleet_details
1833
+ # A list of fleet details meeting the request criteria.
1834
+ # @return [Array<Types::Fleet>]
1835
+ #
1836
+ # @!attribute [rw] next_token
1837
+ # The `nextToken` value to include in a future `ListDeploymentJobs`
1838
+ # request. When the results of a `ListFleets` request exceed
1839
+ # `maxResults`, this value can be used to retrieve the next page of
1840
+ # results. This value is `null` when there are no more results to
1841
+ # return.
1842
+ # @return [String]
1843
+ #
1844
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListFleetsResponse AWS API Documentation
1845
+ #
1846
+ class ListFleetsResponse < Struct.new(
1847
+ :fleet_details,
1848
+ :next_token)
1849
+ include Aws::Structure
1850
+ end
1851
+
1852
+ # @note When making an API call, you may pass ListRobotApplicationsRequest
1853
+ # data as a hash:
1854
+ #
1855
+ # {
1856
+ # version_qualifier: "VersionQualifier",
1857
+ # next_token: "PaginationToken",
1858
+ # max_results: 1,
1859
+ # filters: [
1860
+ # {
1861
+ # name: "Name",
1862
+ # values: ["Name"],
1863
+ # },
1864
+ # ],
1865
+ # }
1866
+ #
1867
+ # @!attribute [rw] version_qualifier
1868
+ # The version qualifier of the robot application.
1869
+ # @return [String]
1870
+ #
1871
+ # @!attribute [rw] next_token
1872
+ # The `nextToken` value returned from a previous paginated
1873
+ # `ListRobotApplications` request where `maxResults` was used and the
1874
+ # results exceeded the value of that parameter. Pagination continues
1875
+ # from the end of the previous results that returned the `nextToken`
1876
+ # value.
1877
+ #
1878
+ # <note markdown="1"> This token should be treated as an opaque identifier that is only
1879
+ # used to retrieve the next items in a list and not for other
1880
+ # programmatic purposes.
1881
+ #
1882
+ # </note>
1883
+ # @return [String]
1884
+ #
1885
+ # @!attribute [rw] max_results
1886
+ # The maximum number of deployment job results returned by
1887
+ # `ListRobotApplications` in paginated output. When this parameter is
1888
+ # used, `ListRobotApplications` only returns `maxResults` results in a
1889
+ # single page along with a `nextToken` response element. The remaining
1890
+ # results of the initial request can be seen by sending another
1891
+ # `ListFleets` request with the returned `nextToken` value. This value
1892
+ # can be between 1 and 100. If this parameter is not used, then
1893
+ # `ListRobotApplications` returns up to 100 results and a `nextToken`
1894
+ # value if applicable.
1895
+ # @return [Integer]
1896
+ #
1897
+ # @!attribute [rw] filters
1898
+ # Optional filters to limit results.
1899
+ # @return [Array<Types::Filter>]
1900
+ #
1901
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListRobotApplicationsRequest AWS API Documentation
1902
+ #
1903
+ class ListRobotApplicationsRequest < Struct.new(
1904
+ :version_qualifier,
1905
+ :next_token,
1906
+ :max_results,
1907
+ :filters)
1908
+ include Aws::Structure
1909
+ end
1910
+
1911
+ # @!attribute [rw] robot_application_summaries
1912
+ # A list of robot application summaries that meet the criteria of the
1913
+ # request.
1914
+ # @return [Array<Types::RobotApplicationSummary>]
1915
+ #
1916
+ # @!attribute [rw] next_token
1917
+ # The `nextToken` value to include in a future `ListRobotApplications`
1918
+ # request. When the results of a `ListRobotApplications` request
1919
+ # exceed `maxResults`, this value can be used to retrieve the next
1920
+ # page of results. This value is `null` when there are no more results
1921
+ # to return.
1922
+ # @return [String]
1923
+ #
1924
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListRobotApplicationsResponse AWS API Documentation
1925
+ #
1926
+ class ListRobotApplicationsResponse < Struct.new(
1927
+ :robot_application_summaries,
1928
+ :next_token)
1929
+ include Aws::Structure
1930
+ end
1931
+
1932
+ # @note When making an API call, you may pass ListRobotsRequest
1933
+ # data as a hash:
1934
+ #
1935
+ # {
1936
+ # next_token: "PaginationToken",
1937
+ # max_results: 1,
1938
+ # filters: [
1939
+ # {
1940
+ # name: "Name",
1941
+ # values: ["Name"],
1942
+ # },
1943
+ # ],
1944
+ # }
1945
+ #
1946
+ # @!attribute [rw] next_token
1947
+ # The `nextToken` value returned from a previous paginated
1948
+ # `ListRobots` request where `maxResults` was used and the results
1949
+ # exceeded the value of that parameter. Pagination continues from the
1950
+ # end of the previous results that returned the `nextToken` value.
1951
+ #
1952
+ # <note markdown="1"> This token should be treated as an opaque identifier that is only
1953
+ # used to retrieve the next items in a list and not for other
1954
+ # programmatic purposes.
1955
+ #
1956
+ # </note>
1957
+ # @return [String]
1958
+ #
1959
+ # @!attribute [rw] max_results
1960
+ # The maximum number of deployment job results returned by
1961
+ # `ListRobots` in paginated output. When this parameter is used,
1962
+ # `ListRobots` only returns `maxResults` results in a single page
1963
+ # along with a `nextToken` response element. The remaining results of
1964
+ # the initial request can be seen by sending another `ListFleets`
1965
+ # request with the returned `nextToken` value. This value can be
1966
+ # between 1 and 100. If this parameter is not used, then `ListRobots`
1967
+ # returns up to 100 results and a `nextToken` value if applicable.
1968
+ # @return [Integer]
1969
+ #
1970
+ # @!attribute [rw] filters
1971
+ # Optional filters to limit results.
1972
+ # @return [Array<Types::Filter>]
1973
+ #
1974
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListRobotsRequest AWS API Documentation
1975
+ #
1976
+ class ListRobotsRequest < Struct.new(
1977
+ :next_token,
1978
+ :max_results,
1979
+ :filters)
1980
+ include Aws::Structure
1981
+ end
1982
+
1983
+ # @!attribute [rw] robots
1984
+ # A list of robots that meet the criteria of the request.
1985
+ # @return [Array<Types::Robot>]
1986
+ #
1987
+ # @!attribute [rw] next_token
1988
+ # The `nextToken` value to include in a future `ListRobots` request.
1989
+ # When the results of a `ListRobot` request exceed `maxResults`, this
1990
+ # value can be used to retrieve the next page of results. This value
1991
+ # is `null` when there are no more results to return.
1992
+ # @return [String]
1993
+ #
1994
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListRobotsResponse AWS API Documentation
1995
+ #
1996
+ class ListRobotsResponse < Struct.new(
1997
+ :robots,
1998
+ :next_token)
1999
+ include Aws::Structure
2000
+ end
2001
+
2002
+ # @note When making an API call, you may pass ListSimulationApplicationsRequest
2003
+ # data as a hash:
2004
+ #
2005
+ # {
2006
+ # version_qualifier: "VersionQualifier",
2007
+ # next_token: "PaginationToken",
2008
+ # max_results: 1,
2009
+ # filters: [
2010
+ # {
2011
+ # name: "Name",
2012
+ # values: ["Name"],
2013
+ # },
2014
+ # ],
2015
+ # }
2016
+ #
2017
+ # @!attribute [rw] version_qualifier
2018
+ # The version qualifier of the simulation application.
2019
+ # @return [String]
2020
+ #
2021
+ # @!attribute [rw] next_token
2022
+ # The `nextToken` value returned from a previous paginated
2023
+ # `ListSimulationApplications` request where `maxResults` was used and
2024
+ # the results exceeded the value of that parameter. Pagination
2025
+ # continues from the end of the previous results that returned the
2026
+ # `nextToken` value.
2027
+ #
2028
+ # <note markdown="1"> This token should be treated as an opaque identifier that is only
2029
+ # used to retrieve the next items in a list and not for other
2030
+ # programmatic purposes.
2031
+ #
2032
+ # </note>
2033
+ # @return [String]
2034
+ #
2035
+ # @!attribute [rw] max_results
2036
+ # The maximum number of deployment job results returned by
2037
+ # `ListSimulationApplications` in paginated output. When this
2038
+ # parameter is used, `ListSimulationApplications` only returns
2039
+ # `maxResults` results in a single page along with a `nextToken`
2040
+ # response element. The remaining results of the initial request can
2041
+ # be seen by sending another `ListFleets` request with the returned
2042
+ # `nextToken` value. This value can be between 1 and 100. If this
2043
+ # parameter is not used, then `ListSimulationApplications` returns up
2044
+ # to 100 results and a `nextToken` value if applicable.
2045
+ # @return [Integer]
2046
+ #
2047
+ # @!attribute [rw] filters
2048
+ # Optional list of filters to limit results. The only valid filter
2049
+ # name is `name`.
2050
+ # @return [Array<Types::Filter>]
2051
+ #
2052
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationApplicationsRequest AWS API Documentation
2053
+ #
2054
+ class ListSimulationApplicationsRequest < Struct.new(
2055
+ :version_qualifier,
2056
+ :next_token,
2057
+ :max_results,
2058
+ :filters)
2059
+ include Aws::Structure
2060
+ end
2061
+
2062
+ # @!attribute [rw] simulation_application_summaries
2063
+ # A list of simulation application summaries that meet the criteria of
2064
+ # the request.
2065
+ # @return [Array<Types::SimulationApplicationSummary>]
2066
+ #
2067
+ # @!attribute [rw] next_token
2068
+ # The `nextToken` value to include in a future
2069
+ # `ListSimulationApplications` request. When the results of a
2070
+ # `ListRobot` request exceed `maxResults`, this value can be used to
2071
+ # retrieve the next page of results. This value is `null` when there
2072
+ # are no more results to return.
2073
+ # @return [String]
2074
+ #
2075
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationApplicationsResponse AWS API Documentation
2076
+ #
2077
+ class ListSimulationApplicationsResponse < Struct.new(
2078
+ :simulation_application_summaries,
2079
+ :next_token)
2080
+ include Aws::Structure
2081
+ end
2082
+
2083
+ # @note When making an API call, you may pass ListSimulationJobsRequest
2084
+ # data as a hash:
2085
+ #
2086
+ # {
2087
+ # next_token: "PaginationToken",
2088
+ # max_results: 1,
2089
+ # filters: [
2090
+ # {
2091
+ # name: "Name",
2092
+ # values: ["Name"],
2093
+ # },
2094
+ # ],
2095
+ # }
2096
+ #
2097
+ # @!attribute [rw] next_token
2098
+ # The `nextToken` value returned from a previous paginated
2099
+ # `ListSimulationJobs` request where `maxResults` was used and the
2100
+ # results exceeded the value of that parameter. Pagination continues
2101
+ # from the end of the previous results that returned the `nextToken`
2102
+ # value.
2103
+ #
2104
+ # <note markdown="1"> This token should be treated as an opaque identifier that is only
2105
+ # used to retrieve the next items in a list and not for other
2106
+ # programmatic purposes.
2107
+ #
2108
+ # </note>
2109
+ # @return [String]
2110
+ #
2111
+ # @!attribute [rw] max_results
2112
+ # The maximum number of deployment job results returned by
2113
+ # `ListSimulationJobs` in paginated output. When this parameter is
2114
+ # used, `ListSimulationJobs` only returns `maxResults` results in a
2115
+ # single page along with a `nextToken` response element. The remaining
2116
+ # results of the initial request can be seen by sending another
2117
+ # `ListFleets` request with the returned `nextToken` value. This value
2118
+ # can be between 1 and 100. If this parameter is not used, then
2119
+ # `ListSimulationJobs` returns up to 100 results and a `nextToken`
2120
+ # value if applicable.
2121
+ # @return [Integer]
2122
+ #
2123
+ # @!attribute [rw] filters
2124
+ # Optional filters to limit results.
2125
+ # @return [Array<Types::Filter>]
2126
+ #
2127
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationJobsRequest AWS API Documentation
2128
+ #
2129
+ class ListSimulationJobsRequest < Struct.new(
2130
+ :next_token,
2131
+ :max_results,
2132
+ :filters)
2133
+ include Aws::Structure
2134
+ end
2135
+
2136
+ # @!attribute [rw] simulation_job_summaries
2137
+ # A list of simulation job summaries that meet the criteria of the
2138
+ # request.
2139
+ # @return [Array<Types::SimulationJobSummary>]
2140
+ #
2141
+ # @!attribute [rw] next_token
2142
+ # The `nextToken` value to include in a future `ListSimulationJobs`
2143
+ # request. When the results of a `ListRobot` request exceed
2144
+ # `maxResults`, this value can be used to retrieve the next page of
2145
+ # results. This value is `null` when there are no more results to
2146
+ # return.
2147
+ # @return [String]
2148
+ #
2149
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ListSimulationJobsResponse AWS API Documentation
2150
+ #
2151
+ class ListSimulationJobsResponse < Struct.new(
2152
+ :simulation_job_summaries,
2153
+ :next_token)
2154
+ include Aws::Structure
2155
+ end
2156
+
2157
+ # The output location.
2158
+ #
2159
+ # @note When making an API call, you may pass OutputLocation
2160
+ # data as a hash:
2161
+ #
2162
+ # {
2163
+ # s3_bucket: "S3Bucket",
2164
+ # s3_prefix: "S3Key",
2165
+ # }
2166
+ #
2167
+ # @!attribute [rw] s3_bucket
2168
+ # The S3 bucket for output.
2169
+ # @return [String]
2170
+ #
2171
+ # @!attribute [rw] s3_prefix
2172
+ # The S3 folder in the `s3Bucket` where output files will be placed.
2173
+ # @return [String]
2174
+ #
2175
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/OutputLocation AWS API Documentation
2176
+ #
2177
+ class OutputLocation < Struct.new(
2178
+ :s3_bucket,
2179
+ :s3_prefix)
2180
+ include Aws::Structure
2181
+ end
2182
+
2183
+ # Information about the progress of a deployment job.
2184
+ #
2185
+ # @!attribute [rw] current_progress
2186
+ # The current progress status.
2187
+ # @return [String]
2188
+ #
2189
+ # @!attribute [rw] target_resource
2190
+ # The Amazon Resource Name (ARN) of the deployment job.
2191
+ # @return [String]
2192
+ #
2193
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/ProgressDetail AWS API Documentation
2194
+ #
2195
+ class ProgressDetail < Struct.new(
2196
+ :current_progress,
2197
+ :target_resource)
2198
+ include Aws::Structure
2199
+ end
2200
+
2201
+ # @note When making an API call, you may pass RegisterRobotRequest
2202
+ # data as a hash:
2203
+ #
2204
+ # {
2205
+ # fleet: "Arn", # required
2206
+ # robot: "Arn", # required
2207
+ # }
2208
+ #
2209
+ # @!attribute [rw] fleet
2210
+ # The Amazon Resource Name (ARN) of the fleet.
2211
+ # @return [String]
2212
+ #
2213
+ # @!attribute [rw] robot
2214
+ # The Amazon Resource Name (ARN) of the robot.
2215
+ # @return [String]
2216
+ #
2217
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RegisterRobotRequest AWS API Documentation
2218
+ #
2219
+ class RegisterRobotRequest < Struct.new(
2220
+ :fleet,
2221
+ :robot)
2222
+ include Aws::Structure
2223
+ end
2224
+
2225
+ # @!attribute [rw] fleet
2226
+ # The Amazon Resource Name (ARN) of the fleet that the robot will
2227
+ # join.
2228
+ # @return [String]
2229
+ #
2230
+ # @!attribute [rw] robot
2231
+ # Information about the robot registration.
2232
+ # @return [String]
2233
+ #
2234
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RegisterRobotResponse AWS API Documentation
2235
+ #
2236
+ class RegisterRobotResponse < Struct.new(
2237
+ :fleet,
2238
+ :robot)
2239
+ include Aws::Structure
2240
+ end
2241
+
2242
+ # Information about a rendering engine.
2243
+ #
2244
+ # @note When making an API call, you may pass RenderingEngine
2245
+ # data as a hash:
2246
+ #
2247
+ # {
2248
+ # name: "OGRE", # accepts OGRE
2249
+ # version: "RenderingEngineVersionType",
2250
+ # }
2251
+ #
2252
+ # @!attribute [rw] name
2253
+ # The name of the rendering engine.
2254
+ # @return [String]
2255
+ #
2256
+ # @!attribute [rw] version
2257
+ # The version of the rendering engine.
2258
+ # @return [String]
2259
+ #
2260
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RenderingEngine AWS API Documentation
2261
+ #
2262
+ class RenderingEngine < Struct.new(
2263
+ :name,
2264
+ :version)
2265
+ include Aws::Structure
2266
+ end
2267
+
2268
+ # @note When making an API call, you may pass RestartSimulationJobRequest
2269
+ # data as a hash:
2270
+ #
2271
+ # {
2272
+ # job: "Arn", # required
2273
+ # }
2274
+ #
2275
+ # @!attribute [rw] job
2276
+ # The Amazon Resource Name (ARN) of the simulation job.
2277
+ # @return [String]
2278
+ #
2279
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RestartSimulationJobRequest AWS API Documentation
2280
+ #
2281
+ class RestartSimulationJobRequest < Struct.new(
2282
+ :job)
2283
+ include Aws::Structure
2284
+ end
2285
+
2286
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RestartSimulationJobResponse AWS API Documentation
2287
+ #
2288
+ class RestartSimulationJobResponse < Aws::EmptyStructure; end
2289
+
2290
+ # Information about a robot.
2291
+ #
2292
+ # @!attribute [rw] arn
2293
+ # The Amazon Resource Name (ARN) of the robot.
2294
+ # @return [String]
2295
+ #
2296
+ # @!attribute [rw] name
2297
+ # The name of the robot.
2298
+ # @return [String]
2299
+ #
2300
+ # @!attribute [rw] fleet_arn
2301
+ # The Amazon Resource Name (ARN) of the fleet.
2302
+ # @return [String]
2303
+ #
2304
+ # @!attribute [rw] status
2305
+ # The status of the robot.
2306
+ # @return [String]
2307
+ #
2308
+ # @!attribute [rw] green_grass_group_id
2309
+ # The Greengrass group associated with the robot.
2310
+ # @return [String]
2311
+ #
2312
+ # @!attribute [rw] created_at
2313
+ # The time, in milliseconds since the epoch, when the robot was
2314
+ # created.
2315
+ # @return [Time]
2316
+ #
2317
+ # @!attribute [rw] architecture
2318
+ # The architecture of the robot.
2319
+ # @return [String]
2320
+ #
2321
+ # @!attribute [rw] last_deployment_job
2322
+ # The Amazon Resource Name (ARN) of the last deployment job.
2323
+ # @return [String]
2324
+ #
2325
+ # @!attribute [rw] last_deployment_time
2326
+ # The time of the last deployment.
2327
+ # @return [Time]
2328
+ #
2329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/Robot AWS API Documentation
2330
+ #
2331
+ class Robot < Struct.new(
2332
+ :arn,
2333
+ :name,
2334
+ :fleet_arn,
2335
+ :status,
2336
+ :green_grass_group_id,
2337
+ :created_at,
2338
+ :architecture,
2339
+ :last_deployment_job,
2340
+ :last_deployment_time)
2341
+ include Aws::Structure
2342
+ end
2343
+
2344
+ # Application configuration information for a robot.
2345
+ #
2346
+ # @note When making an API call, you may pass RobotApplicationConfig
2347
+ # data as a hash:
2348
+ #
2349
+ # {
2350
+ # application: "Arn", # required
2351
+ # application_version: "Version",
2352
+ # launch_config: { # required
2353
+ # package_name: "GenericString", # required
2354
+ # launch_file: "GenericString", # required
2355
+ # environment_variables: {
2356
+ # "EnvironmentVariableKey" => "EnvironmentVariableValue",
2357
+ # },
2358
+ # },
2359
+ # }
2360
+ #
2361
+ # @!attribute [rw] application
2362
+ # The application information for the robot application.
2363
+ # @return [String]
2364
+ #
2365
+ # @!attribute [rw] application_version
2366
+ # The version of the robot application.
2367
+ # @return [String]
2368
+ #
2369
+ # @!attribute [rw] launch_config
2370
+ # The launch configuration for the robot application.
2371
+ # @return [Types::LaunchConfig]
2372
+ #
2373
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RobotApplicationConfig AWS API Documentation
2374
+ #
2375
+ class RobotApplicationConfig < Struct.new(
2376
+ :application,
2377
+ :application_version,
2378
+ :launch_config)
2379
+ include Aws::Structure
2380
+ end
2381
+
2382
+ # Summary information for a robot application.
2383
+ #
2384
+ # @!attribute [rw] name
2385
+ # The name of the robot application.
2386
+ # @return [String]
2387
+ #
2388
+ # @!attribute [rw] arn
2389
+ # The Amazon Resource Name (ARN) of the robot.
2390
+ # @return [String]
2391
+ #
2392
+ # @!attribute [rw] version
2393
+ # The version of the robot application.
2394
+ # @return [String]
2395
+ #
2396
+ # @!attribute [rw] last_updated_at
2397
+ # The time, in milliseconds since the epoch, when the robot
2398
+ # application was last updated.
2399
+ # @return [Time]
2400
+ #
2401
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RobotApplicationSummary AWS API Documentation
2402
+ #
2403
+ class RobotApplicationSummary < Struct.new(
2404
+ :name,
2405
+ :arn,
2406
+ :version,
2407
+ :last_updated_at)
2408
+ include Aws::Structure
2409
+ end
2410
+
2411
+ # Information about a robot deployment.
2412
+ #
2413
+ # @!attribute [rw] arn
2414
+ # The robot deployment Amazon Resource Name (ARN).
2415
+ # @return [String]
2416
+ #
2417
+ # @!attribute [rw] deployment_start_time
2418
+ # The time, in milliseconds since the epoch, when the deployment was
2419
+ # started.
2420
+ # @return [Time]
2421
+ #
2422
+ # @!attribute [rw] deployment_finish_time
2423
+ # The time, in milliseconds since the epoch, when the deployment
2424
+ # finished.
2425
+ # @return [Time]
2426
+ #
2427
+ # @!attribute [rw] status
2428
+ # The status of the robot deployment.
2429
+ # @return [String]
2430
+ #
2431
+ # @!attribute [rw] progress_detail
2432
+ # Information about how the deployment is progressing.
2433
+ # @return [Types::ProgressDetail]
2434
+ #
2435
+ # @!attribute [rw] failure_reason
2436
+ # A short description of the reason why the robot deployment failed.
2437
+ # @return [String]
2438
+ #
2439
+ # @!attribute [rw] failure_code
2440
+ # The robot deployment failure code.
2441
+ # @return [String]
2442
+ #
2443
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RobotDeployment AWS API Documentation
2444
+ #
2445
+ class RobotDeployment < Struct.new(
2446
+ :arn,
2447
+ :deployment_start_time,
2448
+ :deployment_finish_time,
2449
+ :status,
2450
+ :progress_detail,
2451
+ :failure_reason,
2452
+ :failure_code)
2453
+ include Aws::Structure
2454
+ end
2455
+
2456
+ # Information about a robot software suite.
2457
+ #
2458
+ # @note When making an API call, you may pass RobotSoftwareSuite
2459
+ # data as a hash:
2460
+ #
2461
+ # {
2462
+ # name: "ROS", # accepts ROS
2463
+ # version: "Kinetic", # accepts Kinetic
2464
+ # }
2465
+ #
2466
+ # @!attribute [rw] name
2467
+ # The name of the robot software suite.
2468
+ # @return [String]
2469
+ #
2470
+ # @!attribute [rw] version
2471
+ # The version of the robot software suite.
2472
+ # @return [String]
2473
+ #
2474
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/RobotSoftwareSuite AWS API Documentation
2475
+ #
2476
+ class RobotSoftwareSuite < Struct.new(
2477
+ :name,
2478
+ :version)
2479
+ include Aws::Structure
2480
+ end
2481
+
2482
+ # Information about a simulation application configuration.
2483
+ #
2484
+ # @note When making an API call, you may pass SimulationApplicationConfig
2485
+ # data as a hash:
2486
+ #
2487
+ # {
2488
+ # application: "Arn", # required
2489
+ # application_version: "Version",
2490
+ # launch_config: { # required
2491
+ # package_name: "GenericString", # required
2492
+ # launch_file: "GenericString", # required
2493
+ # environment_variables: {
2494
+ # "EnvironmentVariableKey" => "EnvironmentVariableValue",
2495
+ # },
2496
+ # },
2497
+ # }
2498
+ #
2499
+ # @!attribute [rw] application
2500
+ # The application information for the simulation application.
2501
+ # @return [String]
2502
+ #
2503
+ # @!attribute [rw] application_version
2504
+ # The version of the simulation application.
2505
+ # @return [String]
2506
+ #
2507
+ # @!attribute [rw] launch_config
2508
+ # The launch configuration for the simulation application.
2509
+ # @return [Types::LaunchConfig]
2510
+ #
2511
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/SimulationApplicationConfig AWS API Documentation
2512
+ #
2513
+ class SimulationApplicationConfig < Struct.new(
2514
+ :application,
2515
+ :application_version,
2516
+ :launch_config)
2517
+ include Aws::Structure
2518
+ end
2519
+
2520
+ # Summary information for a simulation application.
2521
+ #
2522
+ # @!attribute [rw] name
2523
+ # The name of the simulation application.
2524
+ # @return [String]
2525
+ #
2526
+ # @!attribute [rw] arn
2527
+ # The Amazon Resource Name (ARN) of the simulation application.
2528
+ # @return [String]
2529
+ #
2530
+ # @!attribute [rw] version
2531
+ # The version of the simulation application.
2532
+ # @return [String]
2533
+ #
2534
+ # @!attribute [rw] last_updated_at
2535
+ # The time, in milliseconds since the epoch, when the simulation
2536
+ # application was last updated.
2537
+ # @return [Time]
2538
+ #
2539
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/SimulationApplicationSummary AWS API Documentation
2540
+ #
2541
+ class SimulationApplicationSummary < Struct.new(
2542
+ :name,
2543
+ :arn,
2544
+ :version,
2545
+ :last_updated_at)
2546
+ include Aws::Structure
2547
+ end
2548
+
2549
+ # Information about a simulation job.
2550
+ #
2551
+ # @!attribute [rw] arn
2552
+ # The Amazon Resource Name (ARN) of the simulation job.
2553
+ # @return [String]
2554
+ #
2555
+ # @!attribute [rw] name
2556
+ # The name of the simulation job.
2557
+ # @return [String]
2558
+ #
2559
+ # @!attribute [rw] status
2560
+ # Status of the simulation job.
2561
+ # @return [String]
2562
+ #
2563
+ # @!attribute [rw] last_updated_at
2564
+ # The time, in milliseconds since the epoch, when the simulation job
2565
+ # was last updated.
2566
+ # @return [Time]
2567
+ #
2568
+ # @!attribute [rw] failure_behavior
2569
+ # The failure behavior the simulation job.
2570
+ #
2571
+ # Continue
2572
+ #
2573
+ # : Restart the simulation job in the same host instance.
2574
+ #
2575
+ # Fail
2576
+ #
2577
+ # : Stop the simulation job and terminate the instance.
2578
+ # @return [String]
2579
+ #
2580
+ # @!attribute [rw] failure_code
2581
+ # The failure code of the simulation job if it failed.
2582
+ # @return [String]
2583
+ #
2584
+ # @!attribute [rw] client_request_token
2585
+ # A unique identifier for this `SimulationJob` request.
2586
+ # @return [String]
2587
+ #
2588
+ # @!attribute [rw] output_location
2589
+ # Location for output files generated by the simulation job.
2590
+ # @return [Types::OutputLocation]
2591
+ #
2592
+ # @!attribute [rw] max_job_duration_in_seconds
2593
+ # The maximum simulation job duration in seconds. The value must be 8
2594
+ # days (691,200 seconds) or less.
2595
+ # @return [Integer]
2596
+ #
2597
+ # @!attribute [rw] simulation_time_millis
2598
+ # The simulation job execution duration in milliseconds.
2599
+ # @return [Integer]
2600
+ #
2601
+ # @!attribute [rw] iam_role
2602
+ # The IAM role that allows the simulation instance to call the AWS
2603
+ # APIs that are specified in its associated policies on your behalf.
2604
+ # This is how credentials are passed in to your simulation job. See
2605
+ # how to [specify AWS security credentials for your application][1].
2606
+ #
2607
+ #
2608
+ #
2609
+ # [1]: https://docs.aws.amazon.com/toolkit-for-visual-studio/latest/user-guide/deployment-ecs-specify-credentials
2610
+ # @return [String]
2611
+ #
2612
+ # @!attribute [rw] robot_applications
2613
+ # A list of robot applications.
2614
+ # @return [Array<Types::RobotApplicationConfig>]
2615
+ #
2616
+ # @!attribute [rw] simulation_applications
2617
+ # A list of simulation applications.
2618
+ # @return [Array<Types::SimulationApplicationConfig>]
2619
+ #
2620
+ # @!attribute [rw] vpc_config
2621
+ # VPC configuration information.
2622
+ # @return [Types::VPCConfigResponse]
2623
+ #
2624
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/SimulationJob AWS API Documentation
2625
+ #
2626
+ class SimulationJob < Struct.new(
2627
+ :arn,
2628
+ :name,
2629
+ :status,
2630
+ :last_updated_at,
2631
+ :failure_behavior,
2632
+ :failure_code,
2633
+ :client_request_token,
2634
+ :output_location,
2635
+ :max_job_duration_in_seconds,
2636
+ :simulation_time_millis,
2637
+ :iam_role,
2638
+ :robot_applications,
2639
+ :simulation_applications,
2640
+ :vpc_config)
2641
+ include Aws::Structure
2642
+ end
2643
+
2644
+ # Summary information for a simulation job.
2645
+ #
2646
+ # @!attribute [rw] arn
2647
+ # The Amazon Resource Name (ARN) of the simulation job.
2648
+ # @return [String]
2649
+ #
2650
+ # @!attribute [rw] last_updated_at
2651
+ # The time, in milliseconds since the epoch, when the simulation job
2652
+ # was last updated.
2653
+ # @return [Time]
2654
+ #
2655
+ # @!attribute [rw] name
2656
+ # The name of the simulation job.
2657
+ # @return [String]
2658
+ #
2659
+ # @!attribute [rw] status
2660
+ # The status of the simulation job.
2661
+ # @return [String]
2662
+ #
2663
+ # @!attribute [rw] simulation_application_names
2664
+ # A list of simulation job simulation application names.
2665
+ # @return [Array<String>]
2666
+ #
2667
+ # @!attribute [rw] robot_application_names
2668
+ # A list of simulation job robot application names.
2669
+ # @return [Array<String>]
2670
+ #
2671
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/SimulationJobSummary AWS API Documentation
2672
+ #
2673
+ class SimulationJobSummary < Struct.new(
2674
+ :arn,
2675
+ :last_updated_at,
2676
+ :name,
2677
+ :status,
2678
+ :simulation_application_names,
2679
+ :robot_application_names)
2680
+ include Aws::Structure
2681
+ end
2682
+
2683
+ # Information about a simulation software suite.
2684
+ #
2685
+ # @note When making an API call, you may pass SimulationSoftwareSuite
2686
+ # data as a hash:
2687
+ #
2688
+ # {
2689
+ # name: "Gazebo", # accepts Gazebo
2690
+ # version: "SimulationSoftwareSuiteVersionType",
2691
+ # }
2692
+ #
2693
+ # @!attribute [rw] name
2694
+ # The name of the simulation software suite.
2695
+ # @return [String]
2696
+ #
2697
+ # @!attribute [rw] version
2698
+ # The version of the simulation software suite.
2699
+ # @return [String]
2700
+ #
2701
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/SimulationSoftwareSuite AWS API Documentation
2702
+ #
2703
+ class SimulationSoftwareSuite < Struct.new(
2704
+ :name,
2705
+ :version)
2706
+ include Aws::Structure
2707
+ end
2708
+
2709
+ # Information about a source.
2710
+ #
2711
+ # @!attribute [rw] s3_bucket
2712
+ # The s3 bucket name.
2713
+ # @return [String]
2714
+ #
2715
+ # @!attribute [rw] s3_key
2716
+ # The s3 object key.
2717
+ # @return [String]
2718
+ #
2719
+ # @!attribute [rw] etag
2720
+ # A hash of the object specified by `s3Bucket` and `s3Key`.
2721
+ # @return [String]
2722
+ #
2723
+ # @!attribute [rw] architecture
2724
+ # The taget processor architecture for the application.
2725
+ # @return [String]
2726
+ #
2727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/Source AWS API Documentation
2728
+ #
2729
+ class Source < Struct.new(
2730
+ :s3_bucket,
2731
+ :s3_key,
2732
+ :etag,
2733
+ :architecture)
2734
+ include Aws::Structure
2735
+ end
2736
+
2737
+ # Information about a source configuration.
2738
+ #
2739
+ # @note When making an API call, you may pass SourceConfig
2740
+ # data as a hash:
2741
+ #
2742
+ # {
2743
+ # s3_bucket: "S3Bucket",
2744
+ # s3_key: "S3Key",
2745
+ # architecture: "X86_64", # accepts X86_64, ARM64, ARMHF
2746
+ # }
2747
+ #
2748
+ # @!attribute [rw] s3_bucket
2749
+ # The Amazon S3 bucket name.
2750
+ # @return [String]
2751
+ #
2752
+ # @!attribute [rw] s3_key
2753
+ # The s3 object key.
2754
+ # @return [String]
2755
+ #
2756
+ # @!attribute [rw] architecture
2757
+ # The target processor architecture for the application.
2758
+ # @return [String]
2759
+ #
2760
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/SourceConfig AWS API Documentation
2761
+ #
2762
+ class SourceConfig < Struct.new(
2763
+ :s3_bucket,
2764
+ :s3_key,
2765
+ :architecture)
2766
+ include Aws::Structure
2767
+ end
2768
+
2769
+ # @note When making an API call, you may pass SyncDeploymentJobRequest
2770
+ # data as a hash:
2771
+ #
2772
+ # {
2773
+ # client_request_token: "ClientRequestToken", # required
2774
+ # fleet: "Arn", # required
2775
+ # }
2776
+ #
2777
+ # @!attribute [rw] client_request_token
2778
+ # Unique, case-sensitive identifier that you provide to ensure the
2779
+ # idempotency of the request.
2780
+ #
2781
+ # **A suitable default value is auto-generated.** You should normally
2782
+ # not need to pass this option.
2783
+ # @return [String]
2784
+ #
2785
+ # @!attribute [rw] fleet
2786
+ # The target fleet for the synchronization.
2787
+ # @return [String]
2788
+ #
2789
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/SyncDeploymentJobRequest AWS API Documentation
2790
+ #
2791
+ class SyncDeploymentJobRequest < Struct.new(
2792
+ :client_request_token,
2793
+ :fleet)
2794
+ include Aws::Structure
2795
+ end
2796
+
2797
+ # @!attribute [rw] arn
2798
+ # The Amazon Resource Name (ARN) of the synchronization request.
2799
+ # @return [String]
2800
+ #
2801
+ # @!attribute [rw] fleet
2802
+ # The Amazon Resource Name (ARN) of the fleet.
2803
+ # @return [String]
2804
+ #
2805
+ # @!attribute [rw] status
2806
+ # The status of the synchronization job.
2807
+ # @return [String]
2808
+ #
2809
+ # @!attribute [rw] deployment_config
2810
+ # Information about the deployment configuration.
2811
+ # @return [Types::DeploymentConfig]
2812
+ #
2813
+ # @!attribute [rw] deployment_application_configs
2814
+ # Information about the deployment application configurations.
2815
+ # @return [Array<Types::DeploymentApplicationConfig>]
2816
+ #
2817
+ # @!attribute [rw] failure_reason
2818
+ # The failure reason if the job fails.
2819
+ # @return [String]
2820
+ #
2821
+ # @!attribute [rw] failure_code
2822
+ # The failure code if the job fails.
2823
+ # @return [String]
2824
+ #
2825
+ # @!attribute [rw] created_at
2826
+ # The time, in milliseconds since the epoch, when the fleet was
2827
+ # created.
2828
+ # @return [Time]
2829
+ #
2830
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/SyncDeploymentJobResponse AWS API Documentation
2831
+ #
2832
+ class SyncDeploymentJobResponse < Struct.new(
2833
+ :arn,
2834
+ :fleet,
2835
+ :status,
2836
+ :deployment_config,
2837
+ :deployment_application_configs,
2838
+ :failure_reason,
2839
+ :failure_code,
2840
+ :created_at)
2841
+ include Aws::Structure
2842
+ end
2843
+
2844
+ # @note When making an API call, you may pass UpdateRobotApplicationRequest
2845
+ # data as a hash:
2846
+ #
2847
+ # {
2848
+ # application: "Arn", # required
2849
+ # sources: [ # required
2850
+ # {
2851
+ # s3_bucket: "S3Bucket",
2852
+ # s3_key: "S3Key",
2853
+ # architecture: "X86_64", # accepts X86_64, ARM64, ARMHF
2854
+ # },
2855
+ # ],
2856
+ # robot_software_suite: { # required
2857
+ # name: "ROS", # accepts ROS
2858
+ # version: "Kinetic", # accepts Kinetic
2859
+ # },
2860
+ # current_revision_id: "RevisionId",
2861
+ # }
2862
+ #
2863
+ # @!attribute [rw] application
2864
+ # The application information for the robot application.
2865
+ # @return [String]
2866
+ #
2867
+ # @!attribute [rw] sources
2868
+ # The sources of the robot application.
2869
+ # @return [Array<Types::SourceConfig>]
2870
+ #
2871
+ # @!attribute [rw] robot_software_suite
2872
+ # The robot software suite used by the robot application.
2873
+ # @return [Types::RobotSoftwareSuite]
2874
+ #
2875
+ # @!attribute [rw] current_revision_id
2876
+ # The revision id for the robot application.
2877
+ # @return [String]
2878
+ #
2879
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateRobotApplicationRequest AWS API Documentation
2880
+ #
2881
+ class UpdateRobotApplicationRequest < Struct.new(
2882
+ :application,
2883
+ :sources,
2884
+ :robot_software_suite,
2885
+ :current_revision_id)
2886
+ include Aws::Structure
2887
+ end
2888
+
2889
+ # @!attribute [rw] arn
2890
+ # The Amazon Resource Name (ARN) of the updated robot application.
2891
+ # @return [String]
2892
+ #
2893
+ # @!attribute [rw] name
2894
+ # The name of the robot application.
2895
+ # @return [String]
2896
+ #
2897
+ # @!attribute [rw] version
2898
+ # The version of the robot application.
2899
+ # @return [String]
2900
+ #
2901
+ # @!attribute [rw] sources
2902
+ # The sources of the robot application.
2903
+ # @return [Array<Types::Source>]
2904
+ #
2905
+ # @!attribute [rw] robot_software_suite
2906
+ # The robot software suite used by the robot application.
2907
+ # @return [Types::RobotSoftwareSuite]
2908
+ #
2909
+ # @!attribute [rw] last_updated_at
2910
+ # The time, in milliseconds since the epoch, when the robot
2911
+ # application was last updated.
2912
+ # @return [Time]
2913
+ #
2914
+ # @!attribute [rw] revision_id
2915
+ # The revision id of the robot application.
2916
+ # @return [String]
2917
+ #
2918
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateRobotApplicationResponse AWS API Documentation
2919
+ #
2920
+ class UpdateRobotApplicationResponse < Struct.new(
2921
+ :arn,
2922
+ :name,
2923
+ :version,
2924
+ :sources,
2925
+ :robot_software_suite,
2926
+ :last_updated_at,
2927
+ :revision_id)
2928
+ include Aws::Structure
2929
+ end
2930
+
2931
+ # @note When making an API call, you may pass UpdateSimulationApplicationRequest
2932
+ # data as a hash:
2933
+ #
2934
+ # {
2935
+ # application: "Arn", # required
2936
+ # sources: [ # required
2937
+ # {
2938
+ # s3_bucket: "S3Bucket",
2939
+ # s3_key: "S3Key",
2940
+ # architecture: "X86_64", # accepts X86_64, ARM64, ARMHF
2941
+ # },
2942
+ # ],
2943
+ # simulation_software_suite: { # required
2944
+ # name: "Gazebo", # accepts Gazebo
2945
+ # version: "SimulationSoftwareSuiteVersionType",
2946
+ # },
2947
+ # robot_software_suite: { # required
2948
+ # name: "ROS", # accepts ROS
2949
+ # version: "Kinetic", # accepts Kinetic
2950
+ # },
2951
+ # rendering_engine: { # required
2952
+ # name: "OGRE", # accepts OGRE
2953
+ # version: "RenderingEngineVersionType",
2954
+ # },
2955
+ # current_revision_id: "RevisionId",
2956
+ # }
2957
+ #
2958
+ # @!attribute [rw] application
2959
+ # The application information for the simulation application.
2960
+ # @return [String]
2961
+ #
2962
+ # @!attribute [rw] sources
2963
+ # The sources of the simulation application.
2964
+ # @return [Array<Types::SourceConfig>]
2965
+ #
2966
+ # @!attribute [rw] simulation_software_suite
2967
+ # The simulation software suite used by the simulation application.
2968
+ # @return [Types::SimulationSoftwareSuite]
2969
+ #
2970
+ # @!attribute [rw] robot_software_suite
2971
+ # Information about the robot software suite.
2972
+ # @return [Types::RobotSoftwareSuite]
2973
+ #
2974
+ # @!attribute [rw] rendering_engine
2975
+ # The rendering engine for the simulation application.
2976
+ # @return [Types::RenderingEngine]
2977
+ #
2978
+ # @!attribute [rw] current_revision_id
2979
+ # The revision id for the robot application.
2980
+ # @return [String]
2981
+ #
2982
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateSimulationApplicationRequest AWS API Documentation
2983
+ #
2984
+ class UpdateSimulationApplicationRequest < Struct.new(
2985
+ :application,
2986
+ :sources,
2987
+ :simulation_software_suite,
2988
+ :robot_software_suite,
2989
+ :rendering_engine,
2990
+ :current_revision_id)
2991
+ include Aws::Structure
2992
+ end
2993
+
2994
+ # @!attribute [rw] arn
2995
+ # The Amazon Resource Name (ARN) of the updated simulation
2996
+ # application.
2997
+ # @return [String]
2998
+ #
2999
+ # @!attribute [rw] name
3000
+ # The name of the simulation application.
3001
+ # @return [String]
3002
+ #
3003
+ # @!attribute [rw] version
3004
+ # The version of the robot application.
3005
+ # @return [String]
3006
+ #
3007
+ # @!attribute [rw] sources
3008
+ # The sources of the simulation application.
3009
+ # @return [Array<Types::Source>]
3010
+ #
3011
+ # @!attribute [rw] simulation_software_suite
3012
+ # The simulation software suite used by the simulation application.
3013
+ # @return [Types::SimulationSoftwareSuite]
3014
+ #
3015
+ # @!attribute [rw] robot_software_suite
3016
+ # Information about the robot software suite.
3017
+ # @return [Types::RobotSoftwareSuite]
3018
+ #
3019
+ # @!attribute [rw] rendering_engine
3020
+ # The rendering engine for the simulation application.
3021
+ # @return [Types::RenderingEngine]
3022
+ #
3023
+ # @!attribute [rw] last_updated_at
3024
+ # The time, in milliseconds since the epoch, when the simulation
3025
+ # application was last updated.
3026
+ # @return [Time]
3027
+ #
3028
+ # @!attribute [rw] revision_id
3029
+ # The revision id of the simulation application.
3030
+ # @return [String]
3031
+ #
3032
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/UpdateSimulationApplicationResponse AWS API Documentation
3033
+ #
3034
+ class UpdateSimulationApplicationResponse < Struct.new(
3035
+ :arn,
3036
+ :name,
3037
+ :version,
3038
+ :sources,
3039
+ :simulation_software_suite,
3040
+ :robot_software_suite,
3041
+ :rendering_engine,
3042
+ :last_updated_at,
3043
+ :revision_id)
3044
+ include Aws::Structure
3045
+ end
3046
+
3047
+ # If your simulation job accesses resources in a VPC, you provide this
3048
+ # parameter identifying the list of security group IDs and subnet IDs.
3049
+ # These must belong to the same VPC. You must provide at least one
3050
+ # security group and two subnet IDs.
3051
+ #
3052
+ # @note When making an API call, you may pass VPCConfig
3053
+ # data as a hash:
3054
+ #
3055
+ # {
3056
+ # subnets: ["GenericString"], # required
3057
+ # security_groups: ["GenericString"],
3058
+ # assign_public_ip: false,
3059
+ # }
3060
+ #
3061
+ # @!attribute [rw] subnets
3062
+ # A list of one or more subnet IDs in your VPC.
3063
+ # @return [Array<String>]
3064
+ #
3065
+ # @!attribute [rw] security_groups
3066
+ # A list of one or more security groups IDs in your VPC.
3067
+ # @return [Array<String>]
3068
+ #
3069
+ # @!attribute [rw] assign_public_ip
3070
+ # A boolean indicating whether to assign a public IP address.
3071
+ # @return [Boolean]
3072
+ #
3073
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/VPCConfig AWS API Documentation
3074
+ #
3075
+ class VPCConfig < Struct.new(
3076
+ :subnets,
3077
+ :security_groups,
3078
+ :assign_public_ip)
3079
+ include Aws::Structure
3080
+ end
3081
+
3082
+ # VPC configuration associated with your simulation job.
3083
+ #
3084
+ # @!attribute [rw] subnets
3085
+ # A list of subnet IDs associated with the simulation job.
3086
+ # @return [Array<String>]
3087
+ #
3088
+ # @!attribute [rw] security_groups
3089
+ # A list of security group IDs associated with the simulation job.
3090
+ # @return [Array<String>]
3091
+ #
3092
+ # @!attribute [rw] vpc_id
3093
+ # The VPC ID associated with your simulation job.
3094
+ # @return [String]
3095
+ #
3096
+ # @!attribute [rw] assign_public_ip
3097
+ # A boolean indicating if a public IP was assigned.
3098
+ # @return [Boolean]
3099
+ #
3100
+ # @see http://docs.aws.amazon.com/goto/WebAPI/robomaker-2018-06-29/VPCConfigResponse AWS API Documentation
3101
+ #
3102
+ class VPCConfigResponse < Struct.new(
3103
+ :subnets,
3104
+ :security_groups,
3105
+ :vpc_id,
3106
+ :assign_public_ip)
3107
+ include Aws::Structure
3108
+ end
3109
+
3110
+ end
3111
+ end