aws-sdk-panorama 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.
@@ -0,0 +1,3139 @@
1
+ # frozen_string_literal: true
2
+
3
+ # WARNING ABOUT GENERATED CODE
4
+ #
5
+ # This file is generated. See the contributing guide for more information:
6
+ # https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
7
+ #
8
+ # WARNING ABOUT GENERATED CODE
9
+
10
+ module Aws::Panorama
11
+ module Types
12
+
13
+ # The requestor does not have permission to access the target action or
14
+ # resource.
15
+ #
16
+ # @!attribute [rw] message
17
+ # @return [String]
18
+ #
19
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/AccessDeniedException AWS API Documentation
20
+ #
21
+ class AccessDeniedException < Struct.new(
22
+ :message)
23
+ SENSITIVE = []
24
+ include Aws::Structure
25
+ end
26
+
27
+ # An application instance on a device.
28
+ #
29
+ # @!attribute [rw] name
30
+ # The application instance's name.
31
+ # @return [String]
32
+ #
33
+ # @!attribute [rw] application_instance_id
34
+ # The application instance's ID.
35
+ # @return [String]
36
+ #
37
+ # @!attribute [rw] default_runtime_context_device
38
+ # The device's ID.
39
+ # @return [String]
40
+ #
41
+ # @!attribute [rw] default_runtime_context_device_name
42
+ # The device's name.
43
+ # @return [String]
44
+ #
45
+ # @!attribute [rw] description
46
+ # The application instance's description.
47
+ # @return [String]
48
+ #
49
+ # @!attribute [rw] status
50
+ # The application instance's status.
51
+ # @return [String]
52
+ #
53
+ # @!attribute [rw] health_status
54
+ # The application instance's health status.
55
+ # @return [String]
56
+ #
57
+ # @!attribute [rw] status_description
58
+ # The application instance's status description.
59
+ # @return [String]
60
+ #
61
+ # @!attribute [rw] created_time
62
+ # When the application instance was created.
63
+ # @return [Time]
64
+ #
65
+ # @!attribute [rw] arn
66
+ # The application instance's ARN.
67
+ # @return [String]
68
+ #
69
+ # @!attribute [rw] tags
70
+ # The application instance's tags.
71
+ # @return [Hash<String,String>]
72
+ #
73
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ApplicationInstance AWS API Documentation
74
+ #
75
+ class ApplicationInstance < Struct.new(
76
+ :name,
77
+ :application_instance_id,
78
+ :default_runtime_context_device,
79
+ :default_runtime_context_device_name,
80
+ :description,
81
+ :status,
82
+ :health_status,
83
+ :status_description,
84
+ :created_time,
85
+ :arn,
86
+ :tags)
87
+ SENSITIVE = []
88
+ include Aws::Structure
89
+ end
90
+
91
+ # The target resource is in use.
92
+ #
93
+ # @!attribute [rw] message
94
+ # @return [String]
95
+ #
96
+ # @!attribute [rw] resource_id
97
+ # The resource's ID.
98
+ # @return [String]
99
+ #
100
+ # @!attribute [rw] resource_type
101
+ # The resource's type.
102
+ # @return [String]
103
+ #
104
+ # @!attribute [rw] error_id
105
+ # A unique ID for the error.
106
+ # @return [String]
107
+ #
108
+ # @!attribute [rw] error_arguments
109
+ # A list of attributes that led to the exception and their values.
110
+ # @return [Array<Types::ConflictExceptionErrorArgument>]
111
+ #
112
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ConflictException AWS API Documentation
113
+ #
114
+ class ConflictException < Struct.new(
115
+ :message,
116
+ :resource_id,
117
+ :resource_type,
118
+ :error_id,
119
+ :error_arguments)
120
+ SENSITIVE = []
121
+ include Aws::Structure
122
+ end
123
+
124
+ # A conflict exception error argument.
125
+ #
126
+ # @!attribute [rw] name
127
+ # The error argument's name.
128
+ # @return [String]
129
+ #
130
+ # @!attribute [rw] value
131
+ # The error argument's value.
132
+ # @return [String]
133
+ #
134
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ConflictExceptionErrorArgument AWS API Documentation
135
+ #
136
+ class ConflictExceptionErrorArgument < Struct.new(
137
+ :name,
138
+ :value)
139
+ SENSITIVE = []
140
+ include Aws::Structure
141
+ end
142
+
143
+ # @note When making an API call, you may pass CreateApplicationInstanceRequest
144
+ # data as a hash:
145
+ #
146
+ # {
147
+ # name: "ApplicationInstanceName",
148
+ # description: "Description",
149
+ # manifest_payload: { # required
150
+ # payload_data: "ManifestPayloadData",
151
+ # },
152
+ # manifest_overrides_payload: {
153
+ # payload_data: "ManifestOverridesPayloadData",
154
+ # },
155
+ # application_instance_id_to_replace: "ApplicationInstanceId",
156
+ # runtime_role_arn: "RuntimeRoleArn",
157
+ # default_runtime_context_device: "DefaultRuntimeContextDevice", # required
158
+ # tags: {
159
+ # "TagKey" => "TagValue",
160
+ # },
161
+ # }
162
+ #
163
+ # @!attribute [rw] name
164
+ # A name for the application instance.
165
+ # @return [String]
166
+ #
167
+ # @!attribute [rw] description
168
+ # A description for the application instance.
169
+ # @return [String]
170
+ #
171
+ # @!attribute [rw] manifest_payload
172
+ # The application's manifest document.
173
+ # @return [Types::ManifestPayload]
174
+ #
175
+ # @!attribute [rw] manifest_overrides_payload
176
+ # Setting overrides for the application manifest.
177
+ # @return [Types::ManifestOverridesPayload]
178
+ #
179
+ # @!attribute [rw] application_instance_id_to_replace
180
+ # The ID of an application instance to replace with the new instance.
181
+ # @return [String]
182
+ #
183
+ # @!attribute [rw] runtime_role_arn
184
+ # The ARN of a runtime role for the application instance.
185
+ # @return [String]
186
+ #
187
+ # @!attribute [rw] default_runtime_context_device
188
+ # A device's ID.
189
+ # @return [String]
190
+ #
191
+ # @!attribute [rw] tags
192
+ # Tags for the application instance.
193
+ # @return [Hash<String,String>]
194
+ #
195
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateApplicationInstanceRequest AWS API Documentation
196
+ #
197
+ class CreateApplicationInstanceRequest < Struct.new(
198
+ :name,
199
+ :description,
200
+ :manifest_payload,
201
+ :manifest_overrides_payload,
202
+ :application_instance_id_to_replace,
203
+ :runtime_role_arn,
204
+ :default_runtime_context_device,
205
+ :tags)
206
+ SENSITIVE = []
207
+ include Aws::Structure
208
+ end
209
+
210
+ # @!attribute [rw] application_instance_id
211
+ # The application instance's ID.
212
+ # @return [String]
213
+ #
214
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateApplicationInstanceResponse AWS API Documentation
215
+ #
216
+ class CreateApplicationInstanceResponse < Struct.new(
217
+ :application_instance_id)
218
+ SENSITIVE = []
219
+ include Aws::Structure
220
+ end
221
+
222
+ # @note When making an API call, you may pass CreateJobForDevicesRequest
223
+ # data as a hash:
224
+ #
225
+ # {
226
+ # device_ids: ["DeviceId"], # required
227
+ # device_job_config: { # required
228
+ # ota_job_config: {
229
+ # image_version: "ImageVersion", # required
230
+ # },
231
+ # },
232
+ # job_type: "OTA", # required, accepts OTA
233
+ # }
234
+ #
235
+ # @!attribute [rw] device_ids
236
+ # IDs of target devices.
237
+ # @return [Array<String>]
238
+ #
239
+ # @!attribute [rw] device_job_config
240
+ # Configuration settings for the job.
241
+ # @return [Types::DeviceJobConfig]
242
+ #
243
+ # @!attribute [rw] job_type
244
+ # The type of job to run.
245
+ # @return [String]
246
+ #
247
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateJobForDevicesRequest AWS API Documentation
248
+ #
249
+ class CreateJobForDevicesRequest < Struct.new(
250
+ :device_ids,
251
+ :device_job_config,
252
+ :job_type)
253
+ SENSITIVE = []
254
+ include Aws::Structure
255
+ end
256
+
257
+ # @!attribute [rw] jobs
258
+ # A list of jobs.
259
+ # @return [Array<Types::Job>]
260
+ #
261
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateJobForDevicesResponse AWS API Documentation
262
+ #
263
+ class CreateJobForDevicesResponse < Struct.new(
264
+ :jobs)
265
+ SENSITIVE = []
266
+ include Aws::Structure
267
+ end
268
+
269
+ # @note When making an API call, you may pass CreateNodeFromTemplateJobRequest
270
+ # data as a hash:
271
+ #
272
+ # {
273
+ # template_type: "RTSP_CAMERA_STREAM", # required, accepts RTSP_CAMERA_STREAM
274
+ # output_package_name: "NodePackageName", # required
275
+ # output_package_version: "NodePackageVersion", # required
276
+ # node_name: "NodeName", # required
277
+ # node_description: "Description",
278
+ # template_parameters: { # required
279
+ # "TemplateKey" => "TemplateValue",
280
+ # },
281
+ # job_tags: [
282
+ # {
283
+ # resource_type: "PACKAGE", # required, accepts PACKAGE
284
+ # tags: { # required
285
+ # "TagKey" => "TagValue",
286
+ # },
287
+ # },
288
+ # ],
289
+ # }
290
+ #
291
+ # @!attribute [rw] template_type
292
+ # The type of node.
293
+ # @return [String]
294
+ #
295
+ # @!attribute [rw] output_package_name
296
+ # An output package name for the node.
297
+ # @return [String]
298
+ #
299
+ # @!attribute [rw] output_package_version
300
+ # An output package version for the node.
301
+ # @return [String]
302
+ #
303
+ # @!attribute [rw] node_name
304
+ # A name for the node.
305
+ # @return [String]
306
+ #
307
+ # @!attribute [rw] node_description
308
+ # A description for the node.
309
+ # @return [String]
310
+ #
311
+ # @!attribute [rw] template_parameters
312
+ # Template parameters for the node.
313
+ # @return [Hash<String,String>]
314
+ #
315
+ # @!attribute [rw] job_tags
316
+ # Tags for the job.
317
+ # @return [Array<Types::JobResourceTags>]
318
+ #
319
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateNodeFromTemplateJobRequest AWS API Documentation
320
+ #
321
+ class CreateNodeFromTemplateJobRequest < Struct.new(
322
+ :template_type,
323
+ :output_package_name,
324
+ :output_package_version,
325
+ :node_name,
326
+ :node_description,
327
+ :template_parameters,
328
+ :job_tags)
329
+ SENSITIVE = []
330
+ include Aws::Structure
331
+ end
332
+
333
+ # @!attribute [rw] job_id
334
+ # The job's ID.
335
+ # @return [String]
336
+ #
337
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreateNodeFromTemplateJobResponse AWS API Documentation
338
+ #
339
+ class CreateNodeFromTemplateJobResponse < Struct.new(
340
+ :job_id)
341
+ SENSITIVE = []
342
+ include Aws::Structure
343
+ end
344
+
345
+ # @note When making an API call, you may pass CreatePackageImportJobRequest
346
+ # data as a hash:
347
+ #
348
+ # {
349
+ # job_type: "NODE_PACKAGE_VERSION", # required, accepts NODE_PACKAGE_VERSION
350
+ # input_config: { # required
351
+ # package_version_input_config: {
352
+ # s3_location: { # required
353
+ # region: "Region",
354
+ # bucket_name: "BucketName", # required
355
+ # object_key: "ObjectKey", # required
356
+ # },
357
+ # },
358
+ # },
359
+ # output_config: { # required
360
+ # package_version_output_config: {
361
+ # package_name: "NodePackageName", # required
362
+ # package_version: "NodePackageVersion", # required
363
+ # mark_latest: false,
364
+ # },
365
+ # },
366
+ # client_token: "ClientToken", # required
367
+ # job_tags: [
368
+ # {
369
+ # resource_type: "PACKAGE", # required, accepts PACKAGE
370
+ # tags: { # required
371
+ # "TagKey" => "TagValue",
372
+ # },
373
+ # },
374
+ # ],
375
+ # }
376
+ #
377
+ # @!attribute [rw] job_type
378
+ # A job type for the package import job.
379
+ # @return [String]
380
+ #
381
+ # @!attribute [rw] input_config
382
+ # An input config for the package import job.
383
+ # @return [Types::PackageImportJobInputConfig]
384
+ #
385
+ # @!attribute [rw] output_config
386
+ # An output config for the package import job.
387
+ # @return [Types::PackageImportJobOutputConfig]
388
+ #
389
+ # @!attribute [rw] client_token
390
+ # A client token for the package import job.
391
+ # @return [String]
392
+ #
393
+ # @!attribute [rw] job_tags
394
+ # Tags for the package import job.
395
+ # @return [Array<Types::JobResourceTags>]
396
+ #
397
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreatePackageImportJobRequest AWS API Documentation
398
+ #
399
+ class CreatePackageImportJobRequest < Struct.new(
400
+ :job_type,
401
+ :input_config,
402
+ :output_config,
403
+ :client_token,
404
+ :job_tags)
405
+ SENSITIVE = []
406
+ include Aws::Structure
407
+ end
408
+
409
+ # @!attribute [rw] job_id
410
+ # The job's ID.
411
+ # @return [String]
412
+ #
413
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreatePackageImportJobResponse AWS API Documentation
414
+ #
415
+ class CreatePackageImportJobResponse < Struct.new(
416
+ :job_id)
417
+ SENSITIVE = []
418
+ include Aws::Structure
419
+ end
420
+
421
+ # @note When making an API call, you may pass CreatePackageRequest
422
+ # data as a hash:
423
+ #
424
+ # {
425
+ # package_name: "NodePackageName", # required
426
+ # tags: {
427
+ # "TagKey" => "TagValue",
428
+ # },
429
+ # }
430
+ #
431
+ # @!attribute [rw] package_name
432
+ # A name for the package.
433
+ # @return [String]
434
+ #
435
+ # @!attribute [rw] tags
436
+ # Tags for the package.
437
+ # @return [Hash<String,String>]
438
+ #
439
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreatePackageRequest AWS API Documentation
440
+ #
441
+ class CreatePackageRequest < Struct.new(
442
+ :package_name,
443
+ :tags)
444
+ SENSITIVE = []
445
+ include Aws::Structure
446
+ end
447
+
448
+ # @!attribute [rw] package_id
449
+ # The package's ID.
450
+ # @return [String]
451
+ #
452
+ # @!attribute [rw] arn
453
+ # The package's ARN.
454
+ # @return [String]
455
+ #
456
+ # @!attribute [rw] storage_location
457
+ # The package's storage location.
458
+ # @return [Types::StorageLocation]
459
+ #
460
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/CreatePackageResponse AWS API Documentation
461
+ #
462
+ class CreatePackageResponse < Struct.new(
463
+ :package_id,
464
+ :arn,
465
+ :storage_location)
466
+ SENSITIVE = []
467
+ include Aws::Structure
468
+ end
469
+
470
+ # @note When making an API call, you may pass DeleteDeviceRequest
471
+ # data as a hash:
472
+ #
473
+ # {
474
+ # device_id: "DeviceId", # required
475
+ # }
476
+ #
477
+ # @!attribute [rw] device_id
478
+ # The device's ID.
479
+ # @return [String]
480
+ #
481
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeleteDeviceRequest AWS API Documentation
482
+ #
483
+ class DeleteDeviceRequest < Struct.new(
484
+ :device_id)
485
+ SENSITIVE = []
486
+ include Aws::Structure
487
+ end
488
+
489
+ # @!attribute [rw] device_id
490
+ # The device's ID.
491
+ # @return [String]
492
+ #
493
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeleteDeviceResponse AWS API Documentation
494
+ #
495
+ class DeleteDeviceResponse < Struct.new(
496
+ :device_id)
497
+ SENSITIVE = []
498
+ include Aws::Structure
499
+ end
500
+
501
+ # @note When making an API call, you may pass DeletePackageRequest
502
+ # data as a hash:
503
+ #
504
+ # {
505
+ # package_id: "NodePackageId", # required
506
+ # force_delete: false,
507
+ # }
508
+ #
509
+ # @!attribute [rw] package_id
510
+ # The package's ID.
511
+ # @return [String]
512
+ #
513
+ # @!attribute [rw] force_delete
514
+ # Delete the package even if it has artifacts stored in its access
515
+ # point. Deletes the package's artifacts from Amazon S3.
516
+ # @return [Boolean]
517
+ #
518
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeletePackageRequest AWS API Documentation
519
+ #
520
+ class DeletePackageRequest < Struct.new(
521
+ :package_id,
522
+ :force_delete)
523
+ SENSITIVE = []
524
+ include Aws::Structure
525
+ end
526
+
527
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeletePackageResponse AWS API Documentation
528
+ #
529
+ class DeletePackageResponse < Aws::EmptyStructure; end
530
+
531
+ # @note When making an API call, you may pass DeregisterPackageVersionRequest
532
+ # data as a hash:
533
+ #
534
+ # {
535
+ # owner_account: "PackageOwnerAccount",
536
+ # package_id: "NodePackageId", # required
537
+ # package_version: "NodePackageVersion", # required
538
+ # patch_version: "NodePackagePatchVersion", # required
539
+ # updated_latest_patch_version: "NodePackagePatchVersion",
540
+ # }
541
+ #
542
+ # @!attribute [rw] owner_account
543
+ # An owner account.
544
+ # @return [String]
545
+ #
546
+ # @!attribute [rw] package_id
547
+ # A package ID.
548
+ # @return [String]
549
+ #
550
+ # @!attribute [rw] package_version
551
+ # A package version.
552
+ # @return [String]
553
+ #
554
+ # @!attribute [rw] patch_version
555
+ # A patch version.
556
+ # @return [String]
557
+ #
558
+ # @!attribute [rw] updated_latest_patch_version
559
+ # If the version was marked latest, the new version to maker as
560
+ # latest.
561
+ # @return [String]
562
+ #
563
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeregisterPackageVersionRequest AWS API Documentation
564
+ #
565
+ class DeregisterPackageVersionRequest < Struct.new(
566
+ :owner_account,
567
+ :package_id,
568
+ :package_version,
569
+ :patch_version,
570
+ :updated_latest_patch_version)
571
+ SENSITIVE = []
572
+ include Aws::Structure
573
+ end
574
+
575
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeregisterPackageVersionResponse AWS API Documentation
576
+ #
577
+ class DeregisterPackageVersionResponse < Aws::EmptyStructure; end
578
+
579
+ # @note When making an API call, you may pass DescribeApplicationInstanceDetailsRequest
580
+ # data as a hash:
581
+ #
582
+ # {
583
+ # application_instance_id: "ApplicationInstanceId", # required
584
+ # }
585
+ #
586
+ # @!attribute [rw] application_instance_id
587
+ # The application instance's ID.
588
+ # @return [String]
589
+ #
590
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeApplicationInstanceDetailsRequest AWS API Documentation
591
+ #
592
+ class DescribeApplicationInstanceDetailsRequest < Struct.new(
593
+ :application_instance_id)
594
+ SENSITIVE = []
595
+ include Aws::Structure
596
+ end
597
+
598
+ # @!attribute [rw] name
599
+ # The application instance's name.
600
+ # @return [String]
601
+ #
602
+ # @!attribute [rw] description
603
+ # The application instance's description.
604
+ # @return [String]
605
+ #
606
+ # @!attribute [rw] default_runtime_context_device
607
+ # The application instance's default runtime context device.
608
+ # @return [String]
609
+ #
610
+ # @!attribute [rw] manifest_payload
611
+ # The application instance's configuration manifest.
612
+ # @return [Types::ManifestPayload]
613
+ #
614
+ # @!attribute [rw] manifest_overrides_payload
615
+ # Parameter overrides for the configuration manifest.
616
+ # @return [Types::ManifestOverridesPayload]
617
+ #
618
+ # @!attribute [rw] application_instance_id_to_replace
619
+ # The ID of the application instance that this instance replaced.
620
+ # @return [String]
621
+ #
622
+ # @!attribute [rw] created_time
623
+ # When the application instance was created.
624
+ # @return [Time]
625
+ #
626
+ # @!attribute [rw] application_instance_id
627
+ # The application instance's ID.
628
+ # @return [String]
629
+ #
630
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeApplicationInstanceDetailsResponse AWS API Documentation
631
+ #
632
+ class DescribeApplicationInstanceDetailsResponse < Struct.new(
633
+ :name,
634
+ :description,
635
+ :default_runtime_context_device,
636
+ :manifest_payload,
637
+ :manifest_overrides_payload,
638
+ :application_instance_id_to_replace,
639
+ :created_time,
640
+ :application_instance_id)
641
+ SENSITIVE = []
642
+ include Aws::Structure
643
+ end
644
+
645
+ # @note When making an API call, you may pass DescribeApplicationInstanceRequest
646
+ # data as a hash:
647
+ #
648
+ # {
649
+ # application_instance_id: "ApplicationInstanceId", # required
650
+ # }
651
+ #
652
+ # @!attribute [rw] application_instance_id
653
+ # The application instance's ID.
654
+ # @return [String]
655
+ #
656
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeApplicationInstanceRequest AWS API Documentation
657
+ #
658
+ class DescribeApplicationInstanceRequest < Struct.new(
659
+ :application_instance_id)
660
+ SENSITIVE = []
661
+ include Aws::Structure
662
+ end
663
+
664
+ # @!attribute [rw] name
665
+ # The application instance's name.
666
+ # @return [String]
667
+ #
668
+ # @!attribute [rw] description
669
+ # The application instance's description.
670
+ # @return [String]
671
+ #
672
+ # @!attribute [rw] default_runtime_context_device
673
+ # The device's ID.
674
+ # @return [String]
675
+ #
676
+ # @!attribute [rw] default_runtime_context_device_name
677
+ # The device's bane.
678
+ # @return [String]
679
+ #
680
+ # @!attribute [rw] application_instance_id_to_replace
681
+ # The ID of the application instance that this instance replaced.
682
+ # @return [String]
683
+ #
684
+ # @!attribute [rw] runtime_role_arn
685
+ # The application instance's runtime role ARN.
686
+ # @return [String]
687
+ #
688
+ # @!attribute [rw] status
689
+ # The application instance's status.
690
+ # @return [String]
691
+ #
692
+ # @!attribute [rw] health_status
693
+ # The application instance's health status.
694
+ # @return [String]
695
+ #
696
+ # @!attribute [rw] status_description
697
+ # The application instance's status description.
698
+ # @return [String]
699
+ #
700
+ # @!attribute [rw] created_time
701
+ # When the application instance was created.
702
+ # @return [Time]
703
+ #
704
+ # @!attribute [rw] last_updated_time
705
+ # The application instance was updated.
706
+ # @return [Time]
707
+ #
708
+ # @!attribute [rw] application_instance_id
709
+ # The application instance's ID.
710
+ # @return [String]
711
+ #
712
+ # @!attribute [rw] arn
713
+ # The application instance's ARN.
714
+ # @return [String]
715
+ #
716
+ # @!attribute [rw] tags
717
+ # The application instance's tags.
718
+ # @return [Hash<String,String>]
719
+ #
720
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeApplicationInstanceResponse AWS API Documentation
721
+ #
722
+ class DescribeApplicationInstanceResponse < Struct.new(
723
+ :name,
724
+ :description,
725
+ :default_runtime_context_device,
726
+ :default_runtime_context_device_name,
727
+ :application_instance_id_to_replace,
728
+ :runtime_role_arn,
729
+ :status,
730
+ :health_status,
731
+ :status_description,
732
+ :created_time,
733
+ :last_updated_time,
734
+ :application_instance_id,
735
+ :arn,
736
+ :tags)
737
+ SENSITIVE = []
738
+ include Aws::Structure
739
+ end
740
+
741
+ # @note When making an API call, you may pass DescribeDeviceJobRequest
742
+ # data as a hash:
743
+ #
744
+ # {
745
+ # job_id: "JobId", # required
746
+ # }
747
+ #
748
+ # @!attribute [rw] job_id
749
+ # The job's ID.
750
+ # @return [String]
751
+ #
752
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeDeviceJobRequest AWS API Documentation
753
+ #
754
+ class DescribeDeviceJobRequest < Struct.new(
755
+ :job_id)
756
+ SENSITIVE = []
757
+ include Aws::Structure
758
+ end
759
+
760
+ # @!attribute [rw] job_id
761
+ # The job's ID.
762
+ # @return [String]
763
+ #
764
+ # @!attribute [rw] device_id
765
+ # The device's ID.
766
+ # @return [String]
767
+ #
768
+ # @!attribute [rw] device_arn
769
+ # The device's ARN.
770
+ # @return [String]
771
+ #
772
+ # @!attribute [rw] device_name
773
+ # The device's name.
774
+ # @return [String]
775
+ #
776
+ # @!attribute [rw] device_type
777
+ # The device's type.
778
+ # @return [String]
779
+ #
780
+ # @!attribute [rw] image_version
781
+ # For an OTA job, the target version of the device software.
782
+ # @return [String]
783
+ #
784
+ # @!attribute [rw] status
785
+ # The job's status.
786
+ # @return [String]
787
+ #
788
+ # @!attribute [rw] created_time
789
+ # When the job was created.
790
+ # @return [Time]
791
+ #
792
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeDeviceJobResponse AWS API Documentation
793
+ #
794
+ class DescribeDeviceJobResponse < Struct.new(
795
+ :job_id,
796
+ :device_id,
797
+ :device_arn,
798
+ :device_name,
799
+ :device_type,
800
+ :image_version,
801
+ :status,
802
+ :created_time)
803
+ SENSITIVE = []
804
+ include Aws::Structure
805
+ end
806
+
807
+ # @note When making an API call, you may pass DescribeDeviceRequest
808
+ # data as a hash:
809
+ #
810
+ # {
811
+ # device_id: "DeviceId", # required
812
+ # }
813
+ #
814
+ # @!attribute [rw] device_id
815
+ # The device's ID.
816
+ # @return [String]
817
+ #
818
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeDeviceRequest AWS API Documentation
819
+ #
820
+ class DescribeDeviceRequest < Struct.new(
821
+ :device_id)
822
+ SENSITIVE = []
823
+ include Aws::Structure
824
+ end
825
+
826
+ # @!attribute [rw] device_id
827
+ # The device's ID.
828
+ # @return [String]
829
+ #
830
+ # @!attribute [rw] name
831
+ # The device's name.
832
+ # @return [String]
833
+ #
834
+ # @!attribute [rw] arn
835
+ # The device's ARN.
836
+ # @return [String]
837
+ #
838
+ # @!attribute [rw] description
839
+ # The device's description.
840
+ # @return [String]
841
+ #
842
+ # @!attribute [rw] type
843
+ # The device's type.
844
+ # @return [String]
845
+ #
846
+ # @!attribute [rw] device_connection_status
847
+ # The device's connection status.
848
+ # @return [String]
849
+ #
850
+ # @!attribute [rw] created_time
851
+ # When the device was created.
852
+ # @return [Time]
853
+ #
854
+ # @!attribute [rw] provisioning_status
855
+ # The device's provisioning status.
856
+ # @return [String]
857
+ #
858
+ # @!attribute [rw] latest_software
859
+ # The latest software version available for the device.
860
+ # @return [String]
861
+ #
862
+ # @!attribute [rw] current_software
863
+ # The device's current software version.
864
+ # @return [String]
865
+ #
866
+ # @!attribute [rw] serial_number
867
+ # The device's serial number.
868
+ # @return [String]
869
+ #
870
+ # @!attribute [rw] tags
871
+ # The device's tags.
872
+ # @return [Hash<String,String>]
873
+ #
874
+ # @!attribute [rw] networking_configuration
875
+ # The device's networking configuration.
876
+ # @return [Types::NetworkPayload]
877
+ #
878
+ # @!attribute [rw] current_networking_status
879
+ # The device's networking status.
880
+ # @return [Types::NetworkStatus]
881
+ #
882
+ # @!attribute [rw] lease_expiration_time
883
+ # The device's lease expiration time.
884
+ # @return [Time]
885
+ #
886
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeDeviceResponse AWS API Documentation
887
+ #
888
+ class DescribeDeviceResponse < Struct.new(
889
+ :device_id,
890
+ :name,
891
+ :arn,
892
+ :description,
893
+ :type,
894
+ :device_connection_status,
895
+ :created_time,
896
+ :provisioning_status,
897
+ :latest_software,
898
+ :current_software,
899
+ :serial_number,
900
+ :tags,
901
+ :networking_configuration,
902
+ :current_networking_status,
903
+ :lease_expiration_time)
904
+ SENSITIVE = []
905
+ include Aws::Structure
906
+ end
907
+
908
+ # @note When making an API call, you may pass DescribeNodeFromTemplateJobRequest
909
+ # data as a hash:
910
+ #
911
+ # {
912
+ # job_id: "JobId", # required
913
+ # }
914
+ #
915
+ # @!attribute [rw] job_id
916
+ # The job's ID.
917
+ # @return [String]
918
+ #
919
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeNodeFromTemplateJobRequest AWS API Documentation
920
+ #
921
+ class DescribeNodeFromTemplateJobRequest < Struct.new(
922
+ :job_id)
923
+ SENSITIVE = []
924
+ include Aws::Structure
925
+ end
926
+
927
+ # @!attribute [rw] job_id
928
+ # The job's ID.
929
+ # @return [String]
930
+ #
931
+ # @!attribute [rw] status
932
+ # The job's status.
933
+ # @return [String]
934
+ #
935
+ # @!attribute [rw] status_message
936
+ # The job's status message.
937
+ # @return [String]
938
+ #
939
+ # @!attribute [rw] created_time
940
+ # When the job was created.
941
+ # @return [Time]
942
+ #
943
+ # @!attribute [rw] last_updated_time
944
+ # When the job was updated.
945
+ # @return [Time]
946
+ #
947
+ # @!attribute [rw] output_package_name
948
+ # The job's output package name.
949
+ # @return [String]
950
+ #
951
+ # @!attribute [rw] output_package_version
952
+ # The job's output package version.
953
+ # @return [String]
954
+ #
955
+ # @!attribute [rw] node_name
956
+ # The node's name.
957
+ # @return [String]
958
+ #
959
+ # @!attribute [rw] node_description
960
+ # The node's description.
961
+ # @return [String]
962
+ #
963
+ # @!attribute [rw] template_type
964
+ # The job's template type.
965
+ # @return [String]
966
+ #
967
+ # @!attribute [rw] template_parameters
968
+ # The job's template parameters.
969
+ # @return [Hash<String,String>]
970
+ #
971
+ # @!attribute [rw] job_tags
972
+ # The job's tags.
973
+ # @return [Array<Types::JobResourceTags>]
974
+ #
975
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeNodeFromTemplateJobResponse AWS API Documentation
976
+ #
977
+ class DescribeNodeFromTemplateJobResponse < Struct.new(
978
+ :job_id,
979
+ :status,
980
+ :status_message,
981
+ :created_time,
982
+ :last_updated_time,
983
+ :output_package_name,
984
+ :output_package_version,
985
+ :node_name,
986
+ :node_description,
987
+ :template_type,
988
+ :template_parameters,
989
+ :job_tags)
990
+ SENSITIVE = []
991
+ include Aws::Structure
992
+ end
993
+
994
+ # @note When making an API call, you may pass DescribeNodeRequest
995
+ # data as a hash:
996
+ #
997
+ # {
998
+ # node_id: "NodeId", # required
999
+ # owner_account: "PackageOwnerAccount",
1000
+ # }
1001
+ #
1002
+ # @!attribute [rw] node_id
1003
+ # The node's ID.
1004
+ # @return [String]
1005
+ #
1006
+ # @!attribute [rw] owner_account
1007
+ # The account ID of the node's owner.
1008
+ # @return [String]
1009
+ #
1010
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeNodeRequest AWS API Documentation
1011
+ #
1012
+ class DescribeNodeRequest < Struct.new(
1013
+ :node_id,
1014
+ :owner_account)
1015
+ SENSITIVE = []
1016
+ include Aws::Structure
1017
+ end
1018
+
1019
+ # @!attribute [rw] node_id
1020
+ # The node's ID.
1021
+ # @return [String]
1022
+ #
1023
+ # @!attribute [rw] name
1024
+ # The node's name.
1025
+ # @return [String]
1026
+ #
1027
+ # @!attribute [rw] category
1028
+ # The node's category.
1029
+ # @return [String]
1030
+ #
1031
+ # @!attribute [rw] owner_account
1032
+ # The account ID of the node's owner.
1033
+ # @return [String]
1034
+ #
1035
+ # @!attribute [rw] package_name
1036
+ # The node's package name.
1037
+ # @return [String]
1038
+ #
1039
+ # @!attribute [rw] package_id
1040
+ # The node's package ID.
1041
+ # @return [String]
1042
+ #
1043
+ # @!attribute [rw] package_arn
1044
+ # The node's ARN.
1045
+ # @return [String]
1046
+ #
1047
+ # @!attribute [rw] package_version
1048
+ # The node's package version.
1049
+ # @return [String]
1050
+ #
1051
+ # @!attribute [rw] patch_version
1052
+ # The node's patch version.
1053
+ # @return [String]
1054
+ #
1055
+ # @!attribute [rw] node_interface
1056
+ # The node's interface.
1057
+ # @return [Types::NodeInterface]
1058
+ #
1059
+ # @!attribute [rw] asset_name
1060
+ # The node's asset name.
1061
+ # @return [String]
1062
+ #
1063
+ # @!attribute [rw] description
1064
+ # The node's description.
1065
+ # @return [String]
1066
+ #
1067
+ # @!attribute [rw] created_time
1068
+ # When the node was created.
1069
+ # @return [Time]
1070
+ #
1071
+ # @!attribute [rw] last_updated_time
1072
+ # When the node was updated.
1073
+ # @return [Time]
1074
+ #
1075
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribeNodeResponse AWS API Documentation
1076
+ #
1077
+ class DescribeNodeResponse < Struct.new(
1078
+ :node_id,
1079
+ :name,
1080
+ :category,
1081
+ :owner_account,
1082
+ :package_name,
1083
+ :package_id,
1084
+ :package_arn,
1085
+ :package_version,
1086
+ :patch_version,
1087
+ :node_interface,
1088
+ :asset_name,
1089
+ :description,
1090
+ :created_time,
1091
+ :last_updated_time)
1092
+ SENSITIVE = []
1093
+ include Aws::Structure
1094
+ end
1095
+
1096
+ # @note When making an API call, you may pass DescribePackageImportJobRequest
1097
+ # data as a hash:
1098
+ #
1099
+ # {
1100
+ # job_id: "JobId", # required
1101
+ # }
1102
+ #
1103
+ # @!attribute [rw] job_id
1104
+ # The job's ID.
1105
+ # @return [String]
1106
+ #
1107
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackageImportJobRequest AWS API Documentation
1108
+ #
1109
+ class DescribePackageImportJobRequest < Struct.new(
1110
+ :job_id)
1111
+ SENSITIVE = []
1112
+ include Aws::Structure
1113
+ end
1114
+
1115
+ # @!attribute [rw] job_id
1116
+ # The job's ID.
1117
+ # @return [String]
1118
+ #
1119
+ # @!attribute [rw] client_token
1120
+ # The job's client token.
1121
+ # @return [String]
1122
+ #
1123
+ # @!attribute [rw] job_type
1124
+ # The job's type.
1125
+ # @return [String]
1126
+ #
1127
+ # @!attribute [rw] input_config
1128
+ # The job's input config.
1129
+ # @return [Types::PackageImportJobInputConfig]
1130
+ #
1131
+ # @!attribute [rw] output_config
1132
+ # The job's output config.
1133
+ # @return [Types::PackageImportJobOutputConfig]
1134
+ #
1135
+ # @!attribute [rw] output
1136
+ # The job's output.
1137
+ # @return [Types::PackageImportJobOutput]
1138
+ #
1139
+ # @!attribute [rw] created_time
1140
+ # When the job was created.
1141
+ # @return [Time]
1142
+ #
1143
+ # @!attribute [rw] last_updated_time
1144
+ # When the job was updated.
1145
+ # @return [Time]
1146
+ #
1147
+ # @!attribute [rw] status
1148
+ # The job's status.
1149
+ # @return [String]
1150
+ #
1151
+ # @!attribute [rw] status_message
1152
+ # The job's status message.
1153
+ # @return [String]
1154
+ #
1155
+ # @!attribute [rw] job_tags
1156
+ # The job's tags.
1157
+ # @return [Array<Types::JobResourceTags>]
1158
+ #
1159
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackageImportJobResponse AWS API Documentation
1160
+ #
1161
+ class DescribePackageImportJobResponse < Struct.new(
1162
+ :job_id,
1163
+ :client_token,
1164
+ :job_type,
1165
+ :input_config,
1166
+ :output_config,
1167
+ :output,
1168
+ :created_time,
1169
+ :last_updated_time,
1170
+ :status,
1171
+ :status_message,
1172
+ :job_tags)
1173
+ SENSITIVE = []
1174
+ include Aws::Structure
1175
+ end
1176
+
1177
+ # @note When making an API call, you may pass DescribePackageRequest
1178
+ # data as a hash:
1179
+ #
1180
+ # {
1181
+ # package_id: "NodePackageId", # required
1182
+ # }
1183
+ #
1184
+ # @!attribute [rw] package_id
1185
+ # The package's ID.
1186
+ # @return [String]
1187
+ #
1188
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackageRequest AWS API Documentation
1189
+ #
1190
+ class DescribePackageRequest < Struct.new(
1191
+ :package_id)
1192
+ SENSITIVE = []
1193
+ include Aws::Structure
1194
+ end
1195
+
1196
+ # @!attribute [rw] package_id
1197
+ # The package's ID.
1198
+ # @return [String]
1199
+ #
1200
+ # @!attribute [rw] package_name
1201
+ # The package's name.
1202
+ # @return [String]
1203
+ #
1204
+ # @!attribute [rw] arn
1205
+ # The package's ARN.
1206
+ # @return [String]
1207
+ #
1208
+ # @!attribute [rw] storage_location
1209
+ # The package's storage location.
1210
+ # @return [Types::StorageLocation]
1211
+ #
1212
+ # @!attribute [rw] read_access_principal_arns
1213
+ # ARNs of accounts that have read access to the package.
1214
+ # @return [Array<String>]
1215
+ #
1216
+ # @!attribute [rw] write_access_principal_arns
1217
+ # ARNs of accounts that have write access to the package.
1218
+ # @return [Array<String>]
1219
+ #
1220
+ # @!attribute [rw] created_time
1221
+ # When the package was created.
1222
+ # @return [Time]
1223
+ #
1224
+ # @!attribute [rw] tags
1225
+ # The package's tags.
1226
+ # @return [Hash<String,String>]
1227
+ #
1228
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackageResponse AWS API Documentation
1229
+ #
1230
+ class DescribePackageResponse < Struct.new(
1231
+ :package_id,
1232
+ :package_name,
1233
+ :arn,
1234
+ :storage_location,
1235
+ :read_access_principal_arns,
1236
+ :write_access_principal_arns,
1237
+ :created_time,
1238
+ :tags)
1239
+ SENSITIVE = []
1240
+ include Aws::Structure
1241
+ end
1242
+
1243
+ # @note When making an API call, you may pass DescribePackageVersionRequest
1244
+ # data as a hash:
1245
+ #
1246
+ # {
1247
+ # owner_account: "PackageOwnerAccount",
1248
+ # package_id: "NodePackageId", # required
1249
+ # package_version: "NodePackageVersion", # required
1250
+ # patch_version: "NodePackagePatchVersion",
1251
+ # }
1252
+ #
1253
+ # @!attribute [rw] owner_account
1254
+ # The version's owner account.
1255
+ # @return [String]
1256
+ #
1257
+ # @!attribute [rw] package_id
1258
+ # The version's ID.
1259
+ # @return [String]
1260
+ #
1261
+ # @!attribute [rw] package_version
1262
+ # The version's version.
1263
+ # @return [String]
1264
+ #
1265
+ # @!attribute [rw] patch_version
1266
+ # The version's patch version.
1267
+ # @return [String]
1268
+ #
1269
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackageVersionRequest AWS API Documentation
1270
+ #
1271
+ class DescribePackageVersionRequest < Struct.new(
1272
+ :owner_account,
1273
+ :package_id,
1274
+ :package_version,
1275
+ :patch_version)
1276
+ SENSITIVE = []
1277
+ include Aws::Structure
1278
+ end
1279
+
1280
+ # @!attribute [rw] owner_account
1281
+ # The account ID of the version's owner.
1282
+ # @return [String]
1283
+ #
1284
+ # @!attribute [rw] package_id
1285
+ # The version's ID.
1286
+ # @return [String]
1287
+ #
1288
+ # @!attribute [rw] package_arn
1289
+ # The ARN of the package.
1290
+ # @return [String]
1291
+ #
1292
+ # @!attribute [rw] package_name
1293
+ # The version's name.
1294
+ # @return [String]
1295
+ #
1296
+ # @!attribute [rw] package_version
1297
+ # The version's version.
1298
+ # @return [String]
1299
+ #
1300
+ # @!attribute [rw] patch_version
1301
+ # The version's patch version.
1302
+ # @return [String]
1303
+ #
1304
+ # @!attribute [rw] is_latest_patch
1305
+ # Whether the version is the latest available.
1306
+ # @return [Boolean]
1307
+ #
1308
+ # @!attribute [rw] status
1309
+ # The version's status.
1310
+ # @return [String]
1311
+ #
1312
+ # @!attribute [rw] status_description
1313
+ # The version's status description.
1314
+ # @return [String]
1315
+ #
1316
+ # @!attribute [rw] registered_time
1317
+ # The version's registered time.
1318
+ # @return [Time]
1319
+ #
1320
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DescribePackageVersionResponse AWS API Documentation
1321
+ #
1322
+ class DescribePackageVersionResponse < Struct.new(
1323
+ :owner_account,
1324
+ :package_id,
1325
+ :package_arn,
1326
+ :package_name,
1327
+ :package_version,
1328
+ :patch_version,
1329
+ :is_latest_patch,
1330
+ :status,
1331
+ :status_description,
1332
+ :registered_time)
1333
+ SENSITIVE = []
1334
+ include Aws::Structure
1335
+ end
1336
+
1337
+ # A device.
1338
+ #
1339
+ # @!attribute [rw] device_id
1340
+ # The device's ID.
1341
+ # @return [String]
1342
+ #
1343
+ # @!attribute [rw] name
1344
+ # The device's name.
1345
+ # @return [String]
1346
+ #
1347
+ # @!attribute [rw] created_time
1348
+ # When the device was created.
1349
+ # @return [Time]
1350
+ #
1351
+ # @!attribute [rw] provisioning_status
1352
+ # The device's provisioning status.
1353
+ # @return [String]
1354
+ #
1355
+ # @!attribute [rw] last_updated_time
1356
+ # When the device was updated.
1357
+ # @return [Time]
1358
+ #
1359
+ # @!attribute [rw] lease_expiration_time
1360
+ # The device's lease expiration time.
1361
+ # @return [Time]
1362
+ #
1363
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/Device AWS API Documentation
1364
+ #
1365
+ class Device < Struct.new(
1366
+ :device_id,
1367
+ :name,
1368
+ :created_time,
1369
+ :provisioning_status,
1370
+ :last_updated_time,
1371
+ :lease_expiration_time)
1372
+ SENSITIVE = []
1373
+ include Aws::Structure
1374
+ end
1375
+
1376
+ # A job that runs on a device.
1377
+ #
1378
+ # @!attribute [rw] device_name
1379
+ # The name of the target device
1380
+ # @return [String]
1381
+ #
1382
+ # @!attribute [rw] device_id
1383
+ # The ID of the target device.
1384
+ # @return [String]
1385
+ #
1386
+ # @!attribute [rw] job_id
1387
+ # The job's ID.
1388
+ # @return [String]
1389
+ #
1390
+ # @!attribute [rw] created_time
1391
+ # When the job was created.
1392
+ # @return [Time]
1393
+ #
1394
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeviceJob AWS API Documentation
1395
+ #
1396
+ class DeviceJob < Struct.new(
1397
+ :device_name,
1398
+ :device_id,
1399
+ :job_id,
1400
+ :created_time)
1401
+ SENSITIVE = []
1402
+ include Aws::Structure
1403
+ end
1404
+
1405
+ # A job's configuration.
1406
+ #
1407
+ # @note When making an API call, you may pass DeviceJobConfig
1408
+ # data as a hash:
1409
+ #
1410
+ # {
1411
+ # ota_job_config: {
1412
+ # image_version: "ImageVersion", # required
1413
+ # },
1414
+ # }
1415
+ #
1416
+ # @!attribute [rw] ota_job_config
1417
+ # A configuration for an over-the-air (OTA) upgrade. Required for OTA
1418
+ # jobs.
1419
+ # @return [Types::OTAJobConfig]
1420
+ #
1421
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/DeviceJobConfig AWS API Documentation
1422
+ #
1423
+ class DeviceJobConfig < Struct.new(
1424
+ :ota_job_config)
1425
+ SENSITIVE = []
1426
+ include Aws::Structure
1427
+ end
1428
+
1429
+ # A device's network configuration.
1430
+ #
1431
+ # @note When making an API call, you may pass EthernetPayload
1432
+ # data as a hash:
1433
+ #
1434
+ # {
1435
+ # connection_type: "STATIC_IP", # required, accepts STATIC_IP, DHCP
1436
+ # static_ip_connection_info: {
1437
+ # ip_address: "IpAddress", # required
1438
+ # mask: "Mask", # required
1439
+ # dns: ["Dns"], # required
1440
+ # default_gateway: "DefaultGateway", # required
1441
+ # },
1442
+ # }
1443
+ #
1444
+ # @!attribute [rw] connection_type
1445
+ # How the device gets an IP address.
1446
+ # @return [String]
1447
+ #
1448
+ # @!attribute [rw] static_ip_connection_info
1449
+ # Network configuration for a static IP connection.
1450
+ # @return [Types::StaticIpConnectionInfo]
1451
+ #
1452
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/EthernetPayload AWS API Documentation
1453
+ #
1454
+ class EthernetPayload < Struct.new(
1455
+ :connection_type,
1456
+ :static_ip_connection_info)
1457
+ SENSITIVE = []
1458
+ include Aws::Structure
1459
+ end
1460
+
1461
+ # A device's Ethernet status.
1462
+ #
1463
+ # @!attribute [rw] ip_address
1464
+ # The device's IP address.
1465
+ # @return [String]
1466
+ #
1467
+ # @!attribute [rw] connection_status
1468
+ # The device's connection status.
1469
+ # @return [String]
1470
+ #
1471
+ # @!attribute [rw] hw_address
1472
+ # The device's physical address.
1473
+ # @return [String]
1474
+ #
1475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/EthernetStatus AWS API Documentation
1476
+ #
1477
+ class EthernetStatus < Struct.new(
1478
+ :ip_address,
1479
+ :connection_status,
1480
+ :hw_address)
1481
+ SENSITIVE = []
1482
+ include Aws::Structure
1483
+ end
1484
+
1485
+ # An internal error occurred.
1486
+ #
1487
+ # @!attribute [rw] message
1488
+ # @return [String]
1489
+ #
1490
+ # @!attribute [rw] retry_after_seconds
1491
+ # The number of seconds a client should wait before retrying the call.
1492
+ # @return [Integer]
1493
+ #
1494
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/InternalServerException AWS API Documentation
1495
+ #
1496
+ class InternalServerException < Struct.new(
1497
+ :message,
1498
+ :retry_after_seconds)
1499
+ SENSITIVE = []
1500
+ include Aws::Structure
1501
+ end
1502
+
1503
+ # A job for a device.
1504
+ #
1505
+ # @!attribute [rw] job_id
1506
+ # The job's ID.
1507
+ # @return [String]
1508
+ #
1509
+ # @!attribute [rw] device_id
1510
+ # The target device's ID.
1511
+ # @return [String]
1512
+ #
1513
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/Job AWS API Documentation
1514
+ #
1515
+ class Job < Struct.new(
1516
+ :job_id,
1517
+ :device_id)
1518
+ SENSITIVE = []
1519
+ include Aws::Structure
1520
+ end
1521
+
1522
+ # Tags for a job.
1523
+ #
1524
+ # @note When making an API call, you may pass JobResourceTags
1525
+ # data as a hash:
1526
+ #
1527
+ # {
1528
+ # resource_type: "PACKAGE", # required, accepts PACKAGE
1529
+ # tags: { # required
1530
+ # "TagKey" => "TagValue",
1531
+ # },
1532
+ # }
1533
+ #
1534
+ # @!attribute [rw] resource_type
1535
+ # The job's type.
1536
+ # @return [String]
1537
+ #
1538
+ # @!attribute [rw] tags
1539
+ # The job's tags.
1540
+ # @return [Hash<String,String>]
1541
+ #
1542
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/JobResourceTags AWS API Documentation
1543
+ #
1544
+ class JobResourceTags < Struct.new(
1545
+ :resource_type,
1546
+ :tags)
1547
+ SENSITIVE = []
1548
+ include Aws::Structure
1549
+ end
1550
+
1551
+ # @note When making an API call, you may pass ListApplicationInstanceDependenciesRequest
1552
+ # data as a hash:
1553
+ #
1554
+ # {
1555
+ # application_instance_id: "ApplicationInstanceId", # required
1556
+ # max_results: 1,
1557
+ # next_token: "NextToken",
1558
+ # }
1559
+ #
1560
+ # @!attribute [rw] application_instance_id
1561
+ # The application instance's ID.
1562
+ # @return [String]
1563
+ #
1564
+ # @!attribute [rw] max_results
1565
+ # The maximum number of application instance dependencies to return in
1566
+ # one page of results.
1567
+ # @return [Integer]
1568
+ #
1569
+ # @!attribute [rw] next_token
1570
+ # Specify the pagination token from a previous request to retrieve the
1571
+ # next page of results.
1572
+ # @return [String]
1573
+ #
1574
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstanceDependenciesRequest AWS API Documentation
1575
+ #
1576
+ class ListApplicationInstanceDependenciesRequest < Struct.new(
1577
+ :application_instance_id,
1578
+ :max_results,
1579
+ :next_token)
1580
+ SENSITIVE = []
1581
+ include Aws::Structure
1582
+ end
1583
+
1584
+ # @!attribute [rw] package_objects
1585
+ # A list of package objects.
1586
+ # @return [Array<Types::PackageObject>]
1587
+ #
1588
+ # @!attribute [rw] next_token
1589
+ # A pagination token that's included if more results are available.
1590
+ # @return [String]
1591
+ #
1592
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstanceDependenciesResponse AWS API Documentation
1593
+ #
1594
+ class ListApplicationInstanceDependenciesResponse < Struct.new(
1595
+ :package_objects,
1596
+ :next_token)
1597
+ SENSITIVE = []
1598
+ include Aws::Structure
1599
+ end
1600
+
1601
+ # @note When making an API call, you may pass ListApplicationInstanceNodeInstancesRequest
1602
+ # data as a hash:
1603
+ #
1604
+ # {
1605
+ # application_instance_id: "ApplicationInstanceId", # required
1606
+ # max_results: 1,
1607
+ # next_token: "NextToken",
1608
+ # }
1609
+ #
1610
+ # @!attribute [rw] application_instance_id
1611
+ # The node instances' application instance ID.
1612
+ # @return [String]
1613
+ #
1614
+ # @!attribute [rw] max_results
1615
+ # The maximum number of node instances to return in one page of
1616
+ # results.
1617
+ # @return [Integer]
1618
+ #
1619
+ # @!attribute [rw] next_token
1620
+ # Specify the pagination token from a previous request to retrieve the
1621
+ # next page of results.
1622
+ # @return [String]
1623
+ #
1624
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstanceNodeInstancesRequest AWS API Documentation
1625
+ #
1626
+ class ListApplicationInstanceNodeInstancesRequest < Struct.new(
1627
+ :application_instance_id,
1628
+ :max_results,
1629
+ :next_token)
1630
+ SENSITIVE = []
1631
+ include Aws::Structure
1632
+ end
1633
+
1634
+ # @!attribute [rw] node_instances
1635
+ # A list of node instances.
1636
+ # @return [Array<Types::NodeInstance>]
1637
+ #
1638
+ # @!attribute [rw] next_token
1639
+ # A pagination token that's included if more results are available.
1640
+ # @return [String]
1641
+ #
1642
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstanceNodeInstancesResponse AWS API Documentation
1643
+ #
1644
+ class ListApplicationInstanceNodeInstancesResponse < Struct.new(
1645
+ :node_instances,
1646
+ :next_token)
1647
+ SENSITIVE = []
1648
+ include Aws::Structure
1649
+ end
1650
+
1651
+ # @note When making an API call, you may pass ListApplicationInstancesRequest
1652
+ # data as a hash:
1653
+ #
1654
+ # {
1655
+ # device_id: "DeviceId",
1656
+ # status_filter: "DEPLOYMENT_SUCCEEDED", # accepts DEPLOYMENT_SUCCEEDED, DEPLOYMENT_ERROR, REMOVAL_SUCCEEDED, REMOVAL_FAILED, PROCESSING_DEPLOYMENT, PROCESSING_REMOVAL
1657
+ # max_results: 1,
1658
+ # next_token: "NextToken",
1659
+ # }
1660
+ #
1661
+ # @!attribute [rw] device_id
1662
+ # The application instances' device ID.
1663
+ # @return [String]
1664
+ #
1665
+ # @!attribute [rw] status_filter
1666
+ # Only include instances with a specific status.
1667
+ # @return [String]
1668
+ #
1669
+ # @!attribute [rw] max_results
1670
+ # The maximum number of application instances to return in one page of
1671
+ # results.
1672
+ # @return [Integer]
1673
+ #
1674
+ # @!attribute [rw] next_token
1675
+ # Specify the pagination token from a previous request to retrieve the
1676
+ # next page of results.
1677
+ # @return [String]
1678
+ #
1679
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstancesRequest AWS API Documentation
1680
+ #
1681
+ class ListApplicationInstancesRequest < Struct.new(
1682
+ :device_id,
1683
+ :status_filter,
1684
+ :max_results,
1685
+ :next_token)
1686
+ SENSITIVE = []
1687
+ include Aws::Structure
1688
+ end
1689
+
1690
+ # @!attribute [rw] application_instances
1691
+ # A list of application instances.
1692
+ # @return [Array<Types::ApplicationInstance>]
1693
+ #
1694
+ # @!attribute [rw] next_token
1695
+ # A pagination token that's included if more results are available.
1696
+ # @return [String]
1697
+ #
1698
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListApplicationInstancesResponse AWS API Documentation
1699
+ #
1700
+ class ListApplicationInstancesResponse < Struct.new(
1701
+ :application_instances,
1702
+ :next_token)
1703
+ SENSITIVE = []
1704
+ include Aws::Structure
1705
+ end
1706
+
1707
+ # @note When making an API call, you may pass ListDevicesJobsRequest
1708
+ # data as a hash:
1709
+ #
1710
+ # {
1711
+ # device_id: "DeviceId",
1712
+ # next_token: "NextToken",
1713
+ # max_results: 1,
1714
+ # }
1715
+ #
1716
+ # @!attribute [rw] device_id
1717
+ # Filter results by the job's target device ID.
1718
+ # @return [String]
1719
+ #
1720
+ # @!attribute [rw] next_token
1721
+ # Specify the pagination token from a previous request to retrieve the
1722
+ # next page of results.
1723
+ # @return [String]
1724
+ #
1725
+ # @!attribute [rw] max_results
1726
+ # The maximum number of device jobs to return in one page of results.
1727
+ # @return [Integer]
1728
+ #
1729
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListDevicesJobsRequest AWS API Documentation
1730
+ #
1731
+ class ListDevicesJobsRequest < Struct.new(
1732
+ :device_id,
1733
+ :next_token,
1734
+ :max_results)
1735
+ SENSITIVE = []
1736
+ include Aws::Structure
1737
+ end
1738
+
1739
+ # @!attribute [rw] device_jobs
1740
+ # A list of jobs.
1741
+ # @return [Array<Types::DeviceJob>]
1742
+ #
1743
+ # @!attribute [rw] next_token
1744
+ # A pagination token that's included if more results are available.
1745
+ # @return [String]
1746
+ #
1747
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListDevicesJobsResponse AWS API Documentation
1748
+ #
1749
+ class ListDevicesJobsResponse < Struct.new(
1750
+ :device_jobs,
1751
+ :next_token)
1752
+ SENSITIVE = []
1753
+ include Aws::Structure
1754
+ end
1755
+
1756
+ # @note When making an API call, you may pass ListDevicesRequest
1757
+ # data as a hash:
1758
+ #
1759
+ # {
1760
+ # next_token: "NextToken",
1761
+ # max_results: 1,
1762
+ # }
1763
+ #
1764
+ # @!attribute [rw] next_token
1765
+ # Specify the pagination token from a previous request to retrieve the
1766
+ # next page of results.
1767
+ # @return [String]
1768
+ #
1769
+ # @!attribute [rw] max_results
1770
+ # The maximum number of devices to return in one page of results.
1771
+ # @return [Integer]
1772
+ #
1773
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListDevicesRequest AWS API Documentation
1774
+ #
1775
+ class ListDevicesRequest < Struct.new(
1776
+ :next_token,
1777
+ :max_results)
1778
+ SENSITIVE = []
1779
+ include Aws::Structure
1780
+ end
1781
+
1782
+ # @!attribute [rw] devices
1783
+ # A list of devices.
1784
+ # @return [Array<Types::Device>]
1785
+ #
1786
+ # @!attribute [rw] next_token
1787
+ # A pagination token that's included if more results are available.
1788
+ # @return [String]
1789
+ #
1790
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListDevicesResponse AWS API Documentation
1791
+ #
1792
+ class ListDevicesResponse < Struct.new(
1793
+ :devices,
1794
+ :next_token)
1795
+ SENSITIVE = []
1796
+ include Aws::Structure
1797
+ end
1798
+
1799
+ # @note When making an API call, you may pass ListNodeFromTemplateJobsRequest
1800
+ # data as a hash:
1801
+ #
1802
+ # {
1803
+ # next_token: "NextToken",
1804
+ # max_results: 1,
1805
+ # }
1806
+ #
1807
+ # @!attribute [rw] next_token
1808
+ # Specify the pagination token from a previous request to retrieve the
1809
+ # next page of results.
1810
+ # @return [String]
1811
+ #
1812
+ # @!attribute [rw] max_results
1813
+ # The maximum number of node from template jobs to return in one page
1814
+ # of results.
1815
+ # @return [Integer]
1816
+ #
1817
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListNodeFromTemplateJobsRequest AWS API Documentation
1818
+ #
1819
+ class ListNodeFromTemplateJobsRequest < Struct.new(
1820
+ :next_token,
1821
+ :max_results)
1822
+ SENSITIVE = []
1823
+ include Aws::Structure
1824
+ end
1825
+
1826
+ # @!attribute [rw] node_from_template_jobs
1827
+ # A list of jobs.
1828
+ # @return [Array<Types::NodeFromTemplateJob>]
1829
+ #
1830
+ # @!attribute [rw] next_token
1831
+ # A pagination token that's included if more results are available.
1832
+ # @return [String]
1833
+ #
1834
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListNodeFromTemplateJobsResponse AWS API Documentation
1835
+ #
1836
+ class ListNodeFromTemplateJobsResponse < Struct.new(
1837
+ :node_from_template_jobs,
1838
+ :next_token)
1839
+ SENSITIVE = []
1840
+ include Aws::Structure
1841
+ end
1842
+
1843
+ # @note When making an API call, you may pass ListNodesRequest
1844
+ # data as a hash:
1845
+ #
1846
+ # {
1847
+ # category: "BUSINESS_LOGIC", # accepts BUSINESS_LOGIC, ML_MODEL, MEDIA_SOURCE, MEDIA_SINK
1848
+ # owner_account: "PackageOwnerAccount",
1849
+ # package_name: "NodePackageName",
1850
+ # package_version: "NodePackageVersion",
1851
+ # patch_version: "NodePackagePatchVersion",
1852
+ # next_token: "Token",
1853
+ # max_results: 1,
1854
+ # }
1855
+ #
1856
+ # @!attribute [rw] category
1857
+ # Search for nodes by category.
1858
+ # @return [String]
1859
+ #
1860
+ # @!attribute [rw] owner_account
1861
+ # Search for nodes by the account ID of the nodes' owner.
1862
+ # @return [String]
1863
+ #
1864
+ # @!attribute [rw] package_name
1865
+ # Search for nodes by name.
1866
+ # @return [String]
1867
+ #
1868
+ # @!attribute [rw] package_version
1869
+ # Search for nodes by version.
1870
+ # @return [String]
1871
+ #
1872
+ # @!attribute [rw] patch_version
1873
+ # Search for nodes by patch version.
1874
+ # @return [String]
1875
+ #
1876
+ # @!attribute [rw] next_token
1877
+ # Specify the pagination token from a previous request to retrieve the
1878
+ # next page of results.
1879
+ # @return [String]
1880
+ #
1881
+ # @!attribute [rw] max_results
1882
+ # The maximum number of nodes to return in one page of results.
1883
+ # @return [Integer]
1884
+ #
1885
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListNodesRequest AWS API Documentation
1886
+ #
1887
+ class ListNodesRequest < Struct.new(
1888
+ :category,
1889
+ :owner_account,
1890
+ :package_name,
1891
+ :package_version,
1892
+ :patch_version,
1893
+ :next_token,
1894
+ :max_results)
1895
+ SENSITIVE = []
1896
+ include Aws::Structure
1897
+ end
1898
+
1899
+ # @!attribute [rw] nodes
1900
+ # A list of nodes.
1901
+ # @return [Array<Types::Node>]
1902
+ #
1903
+ # @!attribute [rw] next_token
1904
+ # A pagination token that's included if more results are available.
1905
+ # @return [String]
1906
+ #
1907
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListNodesResponse AWS API Documentation
1908
+ #
1909
+ class ListNodesResponse < Struct.new(
1910
+ :nodes,
1911
+ :next_token)
1912
+ SENSITIVE = []
1913
+ include Aws::Structure
1914
+ end
1915
+
1916
+ # @note When making an API call, you may pass ListPackageImportJobsRequest
1917
+ # data as a hash:
1918
+ #
1919
+ # {
1920
+ # next_token: "NextToken",
1921
+ # max_results: 1,
1922
+ # }
1923
+ #
1924
+ # @!attribute [rw] next_token
1925
+ # Specify the pagination token from a previous request to retrieve the
1926
+ # next page of results.
1927
+ # @return [String]
1928
+ #
1929
+ # @!attribute [rw] max_results
1930
+ # The maximum number of package import jobs to return in one page of
1931
+ # results.
1932
+ # @return [Integer]
1933
+ #
1934
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListPackageImportJobsRequest AWS API Documentation
1935
+ #
1936
+ class ListPackageImportJobsRequest < Struct.new(
1937
+ :next_token,
1938
+ :max_results)
1939
+ SENSITIVE = []
1940
+ include Aws::Structure
1941
+ end
1942
+
1943
+ # @!attribute [rw] package_import_jobs
1944
+ # A list of package import jobs.
1945
+ # @return [Array<Types::PackageImportJob>]
1946
+ #
1947
+ # @!attribute [rw] next_token
1948
+ # A pagination token that's included if more results are available.
1949
+ # @return [String]
1950
+ #
1951
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListPackageImportJobsResponse AWS API Documentation
1952
+ #
1953
+ class ListPackageImportJobsResponse < Struct.new(
1954
+ :package_import_jobs,
1955
+ :next_token)
1956
+ SENSITIVE = []
1957
+ include Aws::Structure
1958
+ end
1959
+
1960
+ # @note When making an API call, you may pass ListPackagesRequest
1961
+ # data as a hash:
1962
+ #
1963
+ # {
1964
+ # max_results: 1,
1965
+ # next_token: "Token",
1966
+ # }
1967
+ #
1968
+ # @!attribute [rw] max_results
1969
+ # The maximum number of packages to return in one page of results.
1970
+ # @return [Integer]
1971
+ #
1972
+ # @!attribute [rw] next_token
1973
+ # Specify the pagination token from a previous request to retrieve the
1974
+ # next page of results.
1975
+ # @return [String]
1976
+ #
1977
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListPackagesRequest AWS API Documentation
1978
+ #
1979
+ class ListPackagesRequest < Struct.new(
1980
+ :max_results,
1981
+ :next_token)
1982
+ SENSITIVE = []
1983
+ include Aws::Structure
1984
+ end
1985
+
1986
+ # @!attribute [rw] packages
1987
+ # A list of packages.
1988
+ # @return [Array<Types::PackageListItem>]
1989
+ #
1990
+ # @!attribute [rw] next_token
1991
+ # A pagination token that's included if more results are available.
1992
+ # @return [String]
1993
+ #
1994
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListPackagesResponse AWS API Documentation
1995
+ #
1996
+ class ListPackagesResponse < Struct.new(
1997
+ :packages,
1998
+ :next_token)
1999
+ SENSITIVE = []
2000
+ include Aws::Structure
2001
+ end
2002
+
2003
+ # @note When making an API call, you may pass ListTagsForResourceRequest
2004
+ # data as a hash:
2005
+ #
2006
+ # {
2007
+ # resource_arn: "ResourceArn", # required
2008
+ # }
2009
+ #
2010
+ # @!attribute [rw] resource_arn
2011
+ # The resource's ARN.
2012
+ # @return [String]
2013
+ #
2014
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListTagsForResourceRequest AWS API Documentation
2015
+ #
2016
+ class ListTagsForResourceRequest < Struct.new(
2017
+ :resource_arn)
2018
+ SENSITIVE = []
2019
+ include Aws::Structure
2020
+ end
2021
+
2022
+ # @!attribute [rw] tags
2023
+ # A list of tags.
2024
+ # @return [Hash<String,String>]
2025
+ #
2026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ListTagsForResourceResponse AWS API Documentation
2027
+ #
2028
+ class ListTagsForResourceResponse < Struct.new(
2029
+ :tags)
2030
+ SENSITIVE = []
2031
+ include Aws::Structure
2032
+ end
2033
+
2034
+ # Parameter overrides for an application instance. This is a JSON
2035
+ # document that has a single key (`PayloadData`) where the value is an
2036
+ # escaped string representation of the overrides document.
2037
+ #
2038
+ # @note ManifestOverridesPayload is a union - when making an API calls you must set exactly one of the members.
2039
+ #
2040
+ # @note ManifestOverridesPayload is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ManifestOverridesPayload corresponding to the set member.
2041
+ #
2042
+ # @!attribute [rw] payload_data
2043
+ # The overrides document.
2044
+ # @return [String]
2045
+ #
2046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ManifestOverridesPayload AWS API Documentation
2047
+ #
2048
+ class ManifestOverridesPayload < Struct.new(
2049
+ :payload_data,
2050
+ :unknown)
2051
+ SENSITIVE = []
2052
+ include Aws::Structure
2053
+ include Aws::Structure::Union
2054
+
2055
+ class PayloadData < ManifestOverridesPayload; end
2056
+ class Unknown < ManifestOverridesPayload; end
2057
+ end
2058
+
2059
+ # A application verion's manifest file. This is a JSON document that
2060
+ # has a single key (`PayloadData`) where the value is an escaped string
2061
+ # representation of the application manifest (`graph.json`). This file
2062
+ # is located in the `graphs` folder in your application source.
2063
+ #
2064
+ # @note ManifestPayload is a union - when making an API calls you must set exactly one of the members.
2065
+ #
2066
+ # @note ManifestPayload is a union - when returned from an API call exactly one value will be set and the returned type will be a subclass of ManifestPayload corresponding to the set member.
2067
+ #
2068
+ # @!attribute [rw] payload_data
2069
+ # The application manifest.
2070
+ # @return [String]
2071
+ #
2072
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ManifestPayload AWS API Documentation
2073
+ #
2074
+ class ManifestPayload < Struct.new(
2075
+ :payload_data,
2076
+ :unknown)
2077
+ SENSITIVE = []
2078
+ include Aws::Structure
2079
+ include Aws::Structure::Union
2080
+
2081
+ class PayloadData < ManifestPayload; end
2082
+ class Unknown < ManifestPayload; end
2083
+ end
2084
+
2085
+ # The network configuration for a device.
2086
+ #
2087
+ # @note When making an API call, you may pass NetworkPayload
2088
+ # data as a hash:
2089
+ #
2090
+ # {
2091
+ # ethernet_0: {
2092
+ # connection_type: "STATIC_IP", # required, accepts STATIC_IP, DHCP
2093
+ # static_ip_connection_info: {
2094
+ # ip_address: "IpAddress", # required
2095
+ # mask: "Mask", # required
2096
+ # dns: ["Dns"], # required
2097
+ # default_gateway: "DefaultGateway", # required
2098
+ # },
2099
+ # },
2100
+ # ethernet_1: {
2101
+ # connection_type: "STATIC_IP", # required, accepts STATIC_IP, DHCP
2102
+ # static_ip_connection_info: {
2103
+ # ip_address: "IpAddress", # required
2104
+ # mask: "Mask", # required
2105
+ # dns: ["Dns"], # required
2106
+ # default_gateway: "DefaultGateway", # required
2107
+ # },
2108
+ # },
2109
+ # }
2110
+ #
2111
+ # @!attribute [rw] ethernet_0
2112
+ # Settings for Ethernet port 0.
2113
+ # @return [Types::EthernetPayload]
2114
+ #
2115
+ # @!attribute [rw] ethernet_1
2116
+ # Settings for Ethernet port 1.
2117
+ # @return [Types::EthernetPayload]
2118
+ #
2119
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/NetworkPayload AWS API Documentation
2120
+ #
2121
+ class NetworkPayload < Struct.new(
2122
+ :ethernet_0,
2123
+ :ethernet_1)
2124
+ SENSITIVE = []
2125
+ include Aws::Structure
2126
+ end
2127
+
2128
+ # The network status of a device.
2129
+ #
2130
+ # @!attribute [rw] ethernet_0_status
2131
+ # The status of Ethernet port 0.
2132
+ # @return [Types::EthernetStatus]
2133
+ #
2134
+ # @!attribute [rw] ethernet_1_status
2135
+ # The status of Ethernet port 1.
2136
+ # @return [Types::EthernetStatus]
2137
+ #
2138
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/NetworkStatus AWS API Documentation
2139
+ #
2140
+ class NetworkStatus < Struct.new(
2141
+ :ethernet_0_status,
2142
+ :ethernet_1_status)
2143
+ SENSITIVE = []
2144
+ include Aws::Structure
2145
+ end
2146
+
2147
+ # An application node that represents a camera stream, a model, code, or
2148
+ # output.
2149
+ #
2150
+ # @!attribute [rw] node_id
2151
+ # The node's ID.
2152
+ # @return [String]
2153
+ #
2154
+ # @!attribute [rw] name
2155
+ # The node's name.
2156
+ # @return [String]
2157
+ #
2158
+ # @!attribute [rw] category
2159
+ # The node's category.
2160
+ # @return [String]
2161
+ #
2162
+ # @!attribute [rw] owner_account
2163
+ # The account ID of the node's owner.
2164
+ # @return [String]
2165
+ #
2166
+ # @!attribute [rw] package_name
2167
+ # The node's package name.
2168
+ # @return [String]
2169
+ #
2170
+ # @!attribute [rw] package_id
2171
+ # The node's package ID.
2172
+ # @return [String]
2173
+ #
2174
+ # @!attribute [rw] package_arn
2175
+ # The node's ARN.
2176
+ # @return [String]
2177
+ #
2178
+ # @!attribute [rw] package_version
2179
+ # The node's package version.
2180
+ # @return [String]
2181
+ #
2182
+ # @!attribute [rw] patch_version
2183
+ # The node's patch version.
2184
+ # @return [String]
2185
+ #
2186
+ # @!attribute [rw] description
2187
+ # The node's description.
2188
+ # @return [String]
2189
+ #
2190
+ # @!attribute [rw] created_time
2191
+ # When the node was created.
2192
+ # @return [Time]
2193
+ #
2194
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/Node AWS API Documentation
2195
+ #
2196
+ class Node < Struct.new(
2197
+ :node_id,
2198
+ :name,
2199
+ :category,
2200
+ :owner_account,
2201
+ :package_name,
2202
+ :package_id,
2203
+ :package_arn,
2204
+ :package_version,
2205
+ :patch_version,
2206
+ :description,
2207
+ :created_time)
2208
+ SENSITIVE = []
2209
+ include Aws::Structure
2210
+ end
2211
+
2212
+ # A job to create a camera stream node.
2213
+ #
2214
+ # @!attribute [rw] job_id
2215
+ # The job's ID.
2216
+ # @return [String]
2217
+ #
2218
+ # @!attribute [rw] template_type
2219
+ # The job's template type.
2220
+ # @return [String]
2221
+ #
2222
+ # @!attribute [rw] status
2223
+ # The job's status.
2224
+ # @return [String]
2225
+ #
2226
+ # @!attribute [rw] status_message
2227
+ # The job's status message.
2228
+ # @return [String]
2229
+ #
2230
+ # @!attribute [rw] created_time
2231
+ # When the job was created.
2232
+ # @return [Time]
2233
+ #
2234
+ # @!attribute [rw] node_name
2235
+ # The node's name.
2236
+ # @return [String]
2237
+ #
2238
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/NodeFromTemplateJob AWS API Documentation
2239
+ #
2240
+ class NodeFromTemplateJob < Struct.new(
2241
+ :job_id,
2242
+ :template_type,
2243
+ :status,
2244
+ :status_message,
2245
+ :created_time,
2246
+ :node_name)
2247
+ SENSITIVE = []
2248
+ include Aws::Structure
2249
+ end
2250
+
2251
+ # A node input port.
2252
+ #
2253
+ # @!attribute [rw] name
2254
+ # The input port's name.
2255
+ # @return [String]
2256
+ #
2257
+ # @!attribute [rw] description
2258
+ # The input port's description.
2259
+ # @return [String]
2260
+ #
2261
+ # @!attribute [rw] type
2262
+ # The input port's type.
2263
+ # @return [String]
2264
+ #
2265
+ # @!attribute [rw] default_value
2266
+ # The input port's default value.
2267
+ # @return [String]
2268
+ #
2269
+ # @!attribute [rw] max_connections
2270
+ # The input port's max connections.
2271
+ # @return [Integer]
2272
+ #
2273
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/NodeInputPort AWS API Documentation
2274
+ #
2275
+ class NodeInputPort < Struct.new(
2276
+ :name,
2277
+ :description,
2278
+ :type,
2279
+ :default_value,
2280
+ :max_connections)
2281
+ SENSITIVE = []
2282
+ include Aws::Structure
2283
+ end
2284
+
2285
+ # A node instance.
2286
+ #
2287
+ # @!attribute [rw] node_instance_id
2288
+ # The instance's ID.
2289
+ # @return [String]
2290
+ #
2291
+ # @!attribute [rw] node_id
2292
+ # The node's ID.
2293
+ # @return [String]
2294
+ #
2295
+ # @!attribute [rw] package_name
2296
+ # The instance's package name.
2297
+ # @return [String]
2298
+ #
2299
+ # @!attribute [rw] package_version
2300
+ # The instance's package version.
2301
+ # @return [String]
2302
+ #
2303
+ # @!attribute [rw] package_patch_version
2304
+ # The instance's package patch version.
2305
+ # @return [String]
2306
+ #
2307
+ # @!attribute [rw] node_name
2308
+ # The instance's name.
2309
+ # @return [String]
2310
+ #
2311
+ # @!attribute [rw] current_status
2312
+ # The instance's current status.
2313
+ # @return [String]
2314
+ #
2315
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/NodeInstance AWS API Documentation
2316
+ #
2317
+ class NodeInstance < Struct.new(
2318
+ :node_instance_id,
2319
+ :node_id,
2320
+ :package_name,
2321
+ :package_version,
2322
+ :package_patch_version,
2323
+ :node_name,
2324
+ :current_status)
2325
+ SENSITIVE = []
2326
+ include Aws::Structure
2327
+ end
2328
+
2329
+ # A node interface.
2330
+ #
2331
+ # @!attribute [rw] inputs
2332
+ # The node interface's inputs.
2333
+ # @return [Array<Types::NodeInputPort>]
2334
+ #
2335
+ # @!attribute [rw] outputs
2336
+ # The node interface's outputs.
2337
+ # @return [Array<Types::NodeOutputPort>]
2338
+ #
2339
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/NodeInterface AWS API Documentation
2340
+ #
2341
+ class NodeInterface < Struct.new(
2342
+ :inputs,
2343
+ :outputs)
2344
+ SENSITIVE = []
2345
+ include Aws::Structure
2346
+ end
2347
+
2348
+ # A node output port.
2349
+ #
2350
+ # @!attribute [rw] name
2351
+ # The output port's name.
2352
+ # @return [String]
2353
+ #
2354
+ # @!attribute [rw] description
2355
+ # The output port's description.
2356
+ # @return [String]
2357
+ #
2358
+ # @!attribute [rw] type
2359
+ # The output port's type.
2360
+ # @return [String]
2361
+ #
2362
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/NodeOutputPort AWS API Documentation
2363
+ #
2364
+ class NodeOutputPort < Struct.new(
2365
+ :name,
2366
+ :description,
2367
+ :type)
2368
+ SENSITIVE = []
2369
+ include Aws::Structure
2370
+ end
2371
+
2372
+ # An over-the-air update (OTA) job configuration.
2373
+ #
2374
+ # @note When making an API call, you may pass OTAJobConfig
2375
+ # data as a hash:
2376
+ #
2377
+ # {
2378
+ # image_version: "ImageVersion", # required
2379
+ # }
2380
+ #
2381
+ # @!attribute [rw] image_version
2382
+ # The target version of the device software.
2383
+ # @return [String]
2384
+ #
2385
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/OTAJobConfig AWS API Documentation
2386
+ #
2387
+ class OTAJobConfig < Struct.new(
2388
+ :image_version)
2389
+ SENSITIVE = []
2390
+ include Aws::Structure
2391
+ end
2392
+
2393
+ # The location of an output object in Amazon S3.
2394
+ #
2395
+ # @!attribute [rw] bucket_name
2396
+ # The object's bucket.
2397
+ # @return [String]
2398
+ #
2399
+ # @!attribute [rw] object_key
2400
+ # The object's key.
2401
+ # @return [String]
2402
+ #
2403
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/OutPutS3Location AWS API Documentation
2404
+ #
2405
+ class OutPutS3Location < Struct.new(
2406
+ :bucket_name,
2407
+ :object_key)
2408
+ SENSITIVE = []
2409
+ include Aws::Structure
2410
+ end
2411
+
2412
+ # A job to import a package version.
2413
+ #
2414
+ # @!attribute [rw] job_id
2415
+ # The job's ID.
2416
+ # @return [String]
2417
+ #
2418
+ # @!attribute [rw] job_type
2419
+ # The job's type.
2420
+ # @return [String]
2421
+ #
2422
+ # @!attribute [rw] status
2423
+ # The job's status.
2424
+ # @return [String]
2425
+ #
2426
+ # @!attribute [rw] status_message
2427
+ # The job's status message.
2428
+ # @return [String]
2429
+ #
2430
+ # @!attribute [rw] created_time
2431
+ # When the job was created.
2432
+ # @return [Time]
2433
+ #
2434
+ # @!attribute [rw] last_updated_time
2435
+ # When the job was updated.
2436
+ # @return [Time]
2437
+ #
2438
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/PackageImportJob AWS API Documentation
2439
+ #
2440
+ class PackageImportJob < Struct.new(
2441
+ :job_id,
2442
+ :job_type,
2443
+ :status,
2444
+ :status_message,
2445
+ :created_time,
2446
+ :last_updated_time)
2447
+ SENSITIVE = []
2448
+ include Aws::Structure
2449
+ end
2450
+
2451
+ # A configuration for a package import job.
2452
+ #
2453
+ # @note When making an API call, you may pass PackageImportJobInputConfig
2454
+ # data as a hash:
2455
+ #
2456
+ # {
2457
+ # package_version_input_config: {
2458
+ # s3_location: { # required
2459
+ # region: "Region",
2460
+ # bucket_name: "BucketName", # required
2461
+ # object_key: "ObjectKey", # required
2462
+ # },
2463
+ # },
2464
+ # }
2465
+ #
2466
+ # @!attribute [rw] package_version_input_config
2467
+ # The package version's input configuration.
2468
+ # @return [Types::PackageVersionInputConfig]
2469
+ #
2470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/PackageImportJobInputConfig AWS API Documentation
2471
+ #
2472
+ class PackageImportJobInputConfig < Struct.new(
2473
+ :package_version_input_config)
2474
+ SENSITIVE = []
2475
+ include Aws::Structure
2476
+ end
2477
+
2478
+ # Results of a package import job.
2479
+ #
2480
+ # @!attribute [rw] package_id
2481
+ # The package's ID.
2482
+ # @return [String]
2483
+ #
2484
+ # @!attribute [rw] package_version
2485
+ # The package's version.
2486
+ # @return [String]
2487
+ #
2488
+ # @!attribute [rw] patch_version
2489
+ # The package's patch version.
2490
+ # @return [String]
2491
+ #
2492
+ # @!attribute [rw] output_s3_location
2493
+ # The package's output location.
2494
+ # @return [Types::OutPutS3Location]
2495
+ #
2496
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/PackageImportJobOutput AWS API Documentation
2497
+ #
2498
+ class PackageImportJobOutput < Struct.new(
2499
+ :package_id,
2500
+ :package_version,
2501
+ :patch_version,
2502
+ :output_s3_location)
2503
+ SENSITIVE = []
2504
+ include Aws::Structure
2505
+ end
2506
+
2507
+ # An output configuration for a package import job.
2508
+ #
2509
+ # @note When making an API call, you may pass PackageImportJobOutputConfig
2510
+ # data as a hash:
2511
+ #
2512
+ # {
2513
+ # package_version_output_config: {
2514
+ # package_name: "NodePackageName", # required
2515
+ # package_version: "NodePackageVersion", # required
2516
+ # mark_latest: false,
2517
+ # },
2518
+ # }
2519
+ #
2520
+ # @!attribute [rw] package_version_output_config
2521
+ # The package version's output configuration.
2522
+ # @return [Types::PackageVersionOutputConfig]
2523
+ #
2524
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/PackageImportJobOutputConfig AWS API Documentation
2525
+ #
2526
+ class PackageImportJobOutputConfig < Struct.new(
2527
+ :package_version_output_config)
2528
+ SENSITIVE = []
2529
+ include Aws::Structure
2530
+ end
2531
+
2532
+ # A package summary.
2533
+ #
2534
+ # @!attribute [rw] package_id
2535
+ # The package's ID.
2536
+ # @return [String]
2537
+ #
2538
+ # @!attribute [rw] package_name
2539
+ # The package's name.
2540
+ # @return [String]
2541
+ #
2542
+ # @!attribute [rw] arn
2543
+ # The package's ARN.
2544
+ # @return [String]
2545
+ #
2546
+ # @!attribute [rw] created_time
2547
+ # When the package was created.
2548
+ # @return [Time]
2549
+ #
2550
+ # @!attribute [rw] tags
2551
+ # The package's tags.
2552
+ # @return [Hash<String,String>]
2553
+ #
2554
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/PackageListItem AWS API Documentation
2555
+ #
2556
+ class PackageListItem < Struct.new(
2557
+ :package_id,
2558
+ :package_name,
2559
+ :arn,
2560
+ :created_time,
2561
+ :tags)
2562
+ SENSITIVE = []
2563
+ include Aws::Structure
2564
+ end
2565
+
2566
+ # A package object.
2567
+ #
2568
+ # @!attribute [rw] name
2569
+ # The object's name.
2570
+ # @return [String]
2571
+ #
2572
+ # @!attribute [rw] package_version
2573
+ # The object's package version.
2574
+ # @return [String]
2575
+ #
2576
+ # @!attribute [rw] patch_version
2577
+ # The object's patch version.
2578
+ # @return [String]
2579
+ #
2580
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/PackageObject AWS API Documentation
2581
+ #
2582
+ class PackageObject < Struct.new(
2583
+ :name,
2584
+ :package_version,
2585
+ :patch_version)
2586
+ SENSITIVE = []
2587
+ include Aws::Structure
2588
+ end
2589
+
2590
+ # A package version input configuration.
2591
+ #
2592
+ # @note When making an API call, you may pass PackageVersionInputConfig
2593
+ # data as a hash:
2594
+ #
2595
+ # {
2596
+ # s3_location: { # required
2597
+ # region: "Region",
2598
+ # bucket_name: "BucketName", # required
2599
+ # object_key: "ObjectKey", # required
2600
+ # },
2601
+ # }
2602
+ #
2603
+ # @!attribute [rw] s3_location
2604
+ # A location in Amazon S3.
2605
+ # @return [Types::S3Location]
2606
+ #
2607
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/PackageVersionInputConfig AWS API Documentation
2608
+ #
2609
+ class PackageVersionInputConfig < Struct.new(
2610
+ :s3_location)
2611
+ SENSITIVE = []
2612
+ include Aws::Structure
2613
+ end
2614
+
2615
+ # A package version output configuration.
2616
+ #
2617
+ # @note When making an API call, you may pass PackageVersionOutputConfig
2618
+ # data as a hash:
2619
+ #
2620
+ # {
2621
+ # package_name: "NodePackageName", # required
2622
+ # package_version: "NodePackageVersion", # required
2623
+ # mark_latest: false,
2624
+ # }
2625
+ #
2626
+ # @!attribute [rw] package_name
2627
+ # The output's package name.
2628
+ # @return [String]
2629
+ #
2630
+ # @!attribute [rw] package_version
2631
+ # The output's package version.
2632
+ # @return [String]
2633
+ #
2634
+ # @!attribute [rw] mark_latest
2635
+ # Indicates that the version is recommended for all users.
2636
+ # @return [Boolean]
2637
+ #
2638
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/PackageVersionOutputConfig AWS API Documentation
2639
+ #
2640
+ class PackageVersionOutputConfig < Struct.new(
2641
+ :package_name,
2642
+ :package_version,
2643
+ :mark_latest)
2644
+ SENSITIVE = []
2645
+ include Aws::Structure
2646
+ end
2647
+
2648
+ # @note When making an API call, you may pass ProvisionDeviceRequest
2649
+ # data as a hash:
2650
+ #
2651
+ # {
2652
+ # name: "DeviceName", # required
2653
+ # description: "Description",
2654
+ # tags: {
2655
+ # "TagKey" => "TagValue",
2656
+ # },
2657
+ # networking_configuration: {
2658
+ # ethernet_0: {
2659
+ # connection_type: "STATIC_IP", # required, accepts STATIC_IP, DHCP
2660
+ # static_ip_connection_info: {
2661
+ # ip_address: "IpAddress", # required
2662
+ # mask: "Mask", # required
2663
+ # dns: ["Dns"], # required
2664
+ # default_gateway: "DefaultGateway", # required
2665
+ # },
2666
+ # },
2667
+ # ethernet_1: {
2668
+ # connection_type: "STATIC_IP", # required, accepts STATIC_IP, DHCP
2669
+ # static_ip_connection_info: {
2670
+ # ip_address: "IpAddress", # required
2671
+ # mask: "Mask", # required
2672
+ # dns: ["Dns"], # required
2673
+ # default_gateway: "DefaultGateway", # required
2674
+ # },
2675
+ # },
2676
+ # },
2677
+ # }
2678
+ #
2679
+ # @!attribute [rw] name
2680
+ # A name for the device.
2681
+ # @return [String]
2682
+ #
2683
+ # @!attribute [rw] description
2684
+ # A description for the device.
2685
+ # @return [String]
2686
+ #
2687
+ # @!attribute [rw] tags
2688
+ # Tags for the device.
2689
+ # @return [Hash<String,String>]
2690
+ #
2691
+ # @!attribute [rw] networking_configuration
2692
+ # A networking configuration for the device.
2693
+ # @return [Types::NetworkPayload]
2694
+ #
2695
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ProvisionDeviceRequest AWS API Documentation
2696
+ #
2697
+ class ProvisionDeviceRequest < Struct.new(
2698
+ :name,
2699
+ :description,
2700
+ :tags,
2701
+ :networking_configuration)
2702
+ SENSITIVE = []
2703
+ include Aws::Structure
2704
+ end
2705
+
2706
+ # @!attribute [rw] device_id
2707
+ # The device's ID.
2708
+ # @return [String]
2709
+ #
2710
+ # @!attribute [rw] arn
2711
+ # The device's ARN.
2712
+ # @return [String]
2713
+ #
2714
+ # @!attribute [rw] status
2715
+ # The device's status.
2716
+ # @return [String]
2717
+ #
2718
+ # @!attribute [rw] certificates
2719
+ # The device's configuration bundle.
2720
+ # @return [String]
2721
+ #
2722
+ # @!attribute [rw] iot_thing_name
2723
+ # The device's IoT thing name.
2724
+ # @return [String]
2725
+ #
2726
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ProvisionDeviceResponse AWS API Documentation
2727
+ #
2728
+ class ProvisionDeviceResponse < Struct.new(
2729
+ :device_id,
2730
+ :arn,
2731
+ :status,
2732
+ :certificates,
2733
+ :iot_thing_name)
2734
+ SENSITIVE = []
2735
+ include Aws::Structure
2736
+ end
2737
+
2738
+ # @note When making an API call, you may pass RegisterPackageVersionRequest
2739
+ # data as a hash:
2740
+ #
2741
+ # {
2742
+ # owner_account: "PackageOwnerAccount",
2743
+ # package_id: "NodePackageId", # required
2744
+ # package_version: "NodePackageVersion", # required
2745
+ # patch_version: "NodePackagePatchVersion", # required
2746
+ # mark_latest: false,
2747
+ # }
2748
+ #
2749
+ # @!attribute [rw] owner_account
2750
+ # An owner account.
2751
+ # @return [String]
2752
+ #
2753
+ # @!attribute [rw] package_id
2754
+ # A package ID.
2755
+ # @return [String]
2756
+ #
2757
+ # @!attribute [rw] package_version
2758
+ # A package version.
2759
+ # @return [String]
2760
+ #
2761
+ # @!attribute [rw] patch_version
2762
+ # A patch version.
2763
+ # @return [String]
2764
+ #
2765
+ # @!attribute [rw] mark_latest
2766
+ # Whether to mark the new version as the latest version.
2767
+ # @return [Boolean]
2768
+ #
2769
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/RegisterPackageVersionRequest AWS API Documentation
2770
+ #
2771
+ class RegisterPackageVersionRequest < Struct.new(
2772
+ :owner_account,
2773
+ :package_id,
2774
+ :package_version,
2775
+ :patch_version,
2776
+ :mark_latest)
2777
+ SENSITIVE = []
2778
+ include Aws::Structure
2779
+ end
2780
+
2781
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/RegisterPackageVersionResponse AWS API Documentation
2782
+ #
2783
+ class RegisterPackageVersionResponse < Aws::EmptyStructure; end
2784
+
2785
+ # @note When making an API call, you may pass RemoveApplicationInstanceRequest
2786
+ # data as a hash:
2787
+ #
2788
+ # {
2789
+ # application_instance_id: "ApplicationInstanceId", # required
2790
+ # }
2791
+ #
2792
+ # @!attribute [rw] application_instance_id
2793
+ # An application instance ID.
2794
+ # @return [String]
2795
+ #
2796
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/RemoveApplicationInstanceRequest AWS API Documentation
2797
+ #
2798
+ class RemoveApplicationInstanceRequest < Struct.new(
2799
+ :application_instance_id)
2800
+ SENSITIVE = []
2801
+ include Aws::Structure
2802
+ end
2803
+
2804
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/RemoveApplicationInstanceResponse AWS API Documentation
2805
+ #
2806
+ class RemoveApplicationInstanceResponse < Aws::EmptyStructure; end
2807
+
2808
+ # The target resource was not found.
2809
+ #
2810
+ # @!attribute [rw] message
2811
+ # @return [String]
2812
+ #
2813
+ # @!attribute [rw] resource_id
2814
+ # The resource's ID.
2815
+ # @return [String]
2816
+ #
2817
+ # @!attribute [rw] resource_type
2818
+ # The resource's type.
2819
+ # @return [String]
2820
+ #
2821
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ResourceNotFoundException AWS API Documentation
2822
+ #
2823
+ class ResourceNotFoundException < Struct.new(
2824
+ :message,
2825
+ :resource_id,
2826
+ :resource_type)
2827
+ SENSITIVE = []
2828
+ include Aws::Structure
2829
+ end
2830
+
2831
+ # A location in Amazon S3.
2832
+ #
2833
+ # @note When making an API call, you may pass S3Location
2834
+ # data as a hash:
2835
+ #
2836
+ # {
2837
+ # region: "Region",
2838
+ # bucket_name: "BucketName", # required
2839
+ # object_key: "ObjectKey", # required
2840
+ # }
2841
+ #
2842
+ # @!attribute [rw] region
2843
+ # The bucket's Region.
2844
+ # @return [String]
2845
+ #
2846
+ # @!attribute [rw] bucket_name
2847
+ # A bucket name.
2848
+ # @return [String]
2849
+ #
2850
+ # @!attribute [rw] object_key
2851
+ # An object key.
2852
+ # @return [String]
2853
+ #
2854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/S3Location AWS API Documentation
2855
+ #
2856
+ class S3Location < Struct.new(
2857
+ :region,
2858
+ :bucket_name,
2859
+ :object_key)
2860
+ SENSITIVE = []
2861
+ include Aws::Structure
2862
+ end
2863
+
2864
+ # The request would cause a limit to be exceeded.
2865
+ #
2866
+ # @!attribute [rw] message
2867
+ # @return [String]
2868
+ #
2869
+ # @!attribute [rw] resource_id
2870
+ # The target resource's ID.
2871
+ # @return [String]
2872
+ #
2873
+ # @!attribute [rw] resource_type
2874
+ # The target resource's type.
2875
+ # @return [String]
2876
+ #
2877
+ # @!attribute [rw] quota_code
2878
+ # The name of the limit.
2879
+ # @return [String]
2880
+ #
2881
+ # @!attribute [rw] service_code
2882
+ # The name of the service.
2883
+ # @return [String]
2884
+ #
2885
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ServiceQuotaExceededException AWS API Documentation
2886
+ #
2887
+ class ServiceQuotaExceededException < Struct.new(
2888
+ :message,
2889
+ :resource_id,
2890
+ :resource_type,
2891
+ :quota_code,
2892
+ :service_code)
2893
+ SENSITIVE = []
2894
+ include Aws::Structure
2895
+ end
2896
+
2897
+ # A static IP configuration.
2898
+ #
2899
+ # @note When making an API call, you may pass StaticIpConnectionInfo
2900
+ # data as a hash:
2901
+ #
2902
+ # {
2903
+ # ip_address: "IpAddress", # required
2904
+ # mask: "Mask", # required
2905
+ # dns: ["Dns"], # required
2906
+ # default_gateway: "DefaultGateway", # required
2907
+ # }
2908
+ #
2909
+ # @!attribute [rw] ip_address
2910
+ # The connection's IP address.
2911
+ # @return [String]
2912
+ #
2913
+ # @!attribute [rw] mask
2914
+ # The connection's DNS mask.
2915
+ # @return [String]
2916
+ #
2917
+ # @!attribute [rw] dns
2918
+ # The connection's DNS address.
2919
+ # @return [Array<String>]
2920
+ #
2921
+ # @!attribute [rw] default_gateway
2922
+ # The connection's default gateway.
2923
+ # @return [String]
2924
+ #
2925
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/StaticIpConnectionInfo AWS API Documentation
2926
+ #
2927
+ class StaticIpConnectionInfo < Struct.new(
2928
+ :ip_address,
2929
+ :mask,
2930
+ :dns,
2931
+ :default_gateway)
2932
+ SENSITIVE = []
2933
+ include Aws::Structure
2934
+ end
2935
+
2936
+ # A storage location.
2937
+ #
2938
+ # @!attribute [rw] bucket
2939
+ # The location's bucket.
2940
+ # @return [String]
2941
+ #
2942
+ # @!attribute [rw] repo_prefix_location
2943
+ # The location's repo prefix.
2944
+ # @return [String]
2945
+ #
2946
+ # @!attribute [rw] generated_prefix_location
2947
+ # The location's generated prefix.
2948
+ # @return [String]
2949
+ #
2950
+ # @!attribute [rw] binary_prefix_location
2951
+ # The location's binary prefix.
2952
+ # @return [String]
2953
+ #
2954
+ # @!attribute [rw] manifest_prefix_location
2955
+ # The location's manifest prefix.
2956
+ # @return [String]
2957
+ #
2958
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/StorageLocation AWS API Documentation
2959
+ #
2960
+ class StorageLocation < Struct.new(
2961
+ :bucket,
2962
+ :repo_prefix_location,
2963
+ :generated_prefix_location,
2964
+ :binary_prefix_location,
2965
+ :manifest_prefix_location)
2966
+ SENSITIVE = []
2967
+ include Aws::Structure
2968
+ end
2969
+
2970
+ # @note When making an API call, you may pass TagResourceRequest
2971
+ # data as a hash:
2972
+ #
2973
+ # {
2974
+ # resource_arn: "ResourceArn", # required
2975
+ # tags: { # required
2976
+ # "TagKey" => "TagValue",
2977
+ # },
2978
+ # }
2979
+ #
2980
+ # @!attribute [rw] resource_arn
2981
+ # The resource's ARN.
2982
+ # @return [String]
2983
+ #
2984
+ # @!attribute [rw] tags
2985
+ # Tags for the resource.
2986
+ # @return [Hash<String,String>]
2987
+ #
2988
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/TagResourceRequest AWS API Documentation
2989
+ #
2990
+ class TagResourceRequest < Struct.new(
2991
+ :resource_arn,
2992
+ :tags)
2993
+ SENSITIVE = []
2994
+ include Aws::Structure
2995
+ end
2996
+
2997
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/TagResourceResponse AWS API Documentation
2998
+ #
2999
+ class TagResourceResponse < Aws::EmptyStructure; end
3000
+
3001
+ # @note When making an API call, you may pass UntagResourceRequest
3002
+ # data as a hash:
3003
+ #
3004
+ # {
3005
+ # resource_arn: "ResourceArn", # required
3006
+ # tag_keys: ["TagKey"], # required
3007
+ # }
3008
+ #
3009
+ # @!attribute [rw] resource_arn
3010
+ # The resource's ARN.
3011
+ # @return [String]
3012
+ #
3013
+ # @!attribute [rw] tag_keys
3014
+ # Tag keys to remove.
3015
+ # @return [Array<String>]
3016
+ #
3017
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/UntagResourceRequest AWS API Documentation
3018
+ #
3019
+ class UntagResourceRequest < Struct.new(
3020
+ :resource_arn,
3021
+ :tag_keys)
3022
+ SENSITIVE = []
3023
+ include Aws::Structure
3024
+ end
3025
+
3026
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/UntagResourceResponse AWS API Documentation
3027
+ #
3028
+ class UntagResourceResponse < Aws::EmptyStructure; end
3029
+
3030
+ # @note When making an API call, you may pass UpdateDeviceMetadataRequest
3031
+ # data as a hash:
3032
+ #
3033
+ # {
3034
+ # device_id: "DeviceId", # required
3035
+ # description: "Description",
3036
+ # }
3037
+ #
3038
+ # @!attribute [rw] device_id
3039
+ # The device's ID.
3040
+ # @return [String]
3041
+ #
3042
+ # @!attribute [rw] description
3043
+ # A description for the device.
3044
+ # @return [String]
3045
+ #
3046
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/UpdateDeviceMetadataRequest AWS API Documentation
3047
+ #
3048
+ class UpdateDeviceMetadataRequest < Struct.new(
3049
+ :device_id,
3050
+ :description)
3051
+ SENSITIVE = []
3052
+ include Aws::Structure
3053
+ end
3054
+
3055
+ # @!attribute [rw] device_id
3056
+ # The device's ID.
3057
+ # @return [String]
3058
+ #
3059
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/UpdateDeviceMetadataResponse AWS API Documentation
3060
+ #
3061
+ class UpdateDeviceMetadataResponse < Struct.new(
3062
+ :device_id)
3063
+ SENSITIVE = []
3064
+ include Aws::Structure
3065
+ end
3066
+
3067
+ # The request contains an invalid parameter value.
3068
+ #
3069
+ # @!attribute [rw] message
3070
+ # @return [String]
3071
+ #
3072
+ # @!attribute [rw] reason
3073
+ # The reason that validation failed.
3074
+ # @return [String]
3075
+ #
3076
+ # @!attribute [rw] error_id
3077
+ # A unique ID for the error.
3078
+ # @return [String]
3079
+ #
3080
+ # @!attribute [rw] error_arguments
3081
+ # A list of attributes that led to the exception and their values.
3082
+ # @return [Array<Types::ValidationExceptionErrorArgument>]
3083
+ #
3084
+ # @!attribute [rw] fields
3085
+ # A list of request parameters that failed validation.
3086
+ # @return [Array<Types::ValidationExceptionField>]
3087
+ #
3088
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ValidationException AWS API Documentation
3089
+ #
3090
+ class ValidationException < Struct.new(
3091
+ :message,
3092
+ :reason,
3093
+ :error_id,
3094
+ :error_arguments,
3095
+ :fields)
3096
+ SENSITIVE = []
3097
+ include Aws::Structure
3098
+ end
3099
+
3100
+ # A validation exception error argument.
3101
+ #
3102
+ # @!attribute [rw] name
3103
+ # The argument's name.
3104
+ # @return [String]
3105
+ #
3106
+ # @!attribute [rw] value
3107
+ # The argument's value.
3108
+ # @return [String]
3109
+ #
3110
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ValidationExceptionErrorArgument AWS API Documentation
3111
+ #
3112
+ class ValidationExceptionErrorArgument < Struct.new(
3113
+ :name,
3114
+ :value)
3115
+ SENSITIVE = []
3116
+ include Aws::Structure
3117
+ end
3118
+
3119
+ # A validation exception field.
3120
+ #
3121
+ # @!attribute [rw] name
3122
+ # The field's name.
3123
+ # @return [String]
3124
+ #
3125
+ # @!attribute [rw] message
3126
+ # The field's message.
3127
+ # @return [String]
3128
+ #
3129
+ # @see http://docs.aws.amazon.com/goto/WebAPI/panorama-2019-07-24/ValidationExceptionField AWS API Documentation
3130
+ #
3131
+ class ValidationExceptionField < Struct.new(
3132
+ :name,
3133
+ :message)
3134
+ SENSITIVE = []
3135
+ include Aws::Structure
3136
+ end
3137
+
3138
+ end
3139
+ end