aws-sdk-backupgateway 1.0.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -0,0 +1,963 @@
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::BackupGateway
11
+ module Types
12
+
13
+ # The operation cannot proceed because you have insufficient
14
+ # permissions.
15
+ #
16
+ # @!attribute [rw] error_code
17
+ # A description of why you have insufficient permissions.
18
+ # @return [String]
19
+ #
20
+ # @!attribute [rw] message
21
+ # @return [String]
22
+ #
23
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/AccessDeniedException AWS API Documentation
24
+ #
25
+ class AccessDeniedException < Struct.new(
26
+ :error_code,
27
+ :message)
28
+ SENSITIVE = []
29
+ include Aws::Structure
30
+ end
31
+
32
+ # @note When making an API call, you may pass AssociateGatewayToServerInput
33
+ # data as a hash:
34
+ #
35
+ # {
36
+ # gateway_arn: "GatewayArn", # required
37
+ # server_arn: "ServerArn", # required
38
+ # }
39
+ #
40
+ # @!attribute [rw] gateway_arn
41
+ # The Amazon Resource Name (ARN) of the gateway. Use the
42
+ # `ListGateways` operation to return a list of gateways for your
43
+ # account and Amazon Web Services Region.
44
+ # @return [String]
45
+ #
46
+ # @!attribute [rw] server_arn
47
+ # The Amazon Resource Name (ARN) of the server that hosts your virtual
48
+ # machines.
49
+ # @return [String]
50
+ #
51
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/AssociateGatewayToServerInput AWS API Documentation
52
+ #
53
+ class AssociateGatewayToServerInput < Struct.new(
54
+ :gateway_arn,
55
+ :server_arn)
56
+ SENSITIVE = []
57
+ include Aws::Structure
58
+ end
59
+
60
+ # @!attribute [rw] gateway_arn
61
+ # The Amazon Resource Name (ARN) of a gateway.
62
+ # @return [String]
63
+ #
64
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/AssociateGatewayToServerOutput AWS API Documentation
65
+ #
66
+ class AssociateGatewayToServerOutput < Struct.new(
67
+ :gateway_arn)
68
+ SENSITIVE = []
69
+ include Aws::Structure
70
+ end
71
+
72
+ # The operation cannot proceed because it is not supported.
73
+ #
74
+ # @!attribute [rw] error_code
75
+ # A description of why the operation is not supported.
76
+ # @return [String]
77
+ #
78
+ # @!attribute [rw] message
79
+ # @return [String]
80
+ #
81
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ConflictException AWS API Documentation
82
+ #
83
+ class ConflictException < Struct.new(
84
+ :error_code,
85
+ :message)
86
+ SENSITIVE = []
87
+ include Aws::Structure
88
+ end
89
+
90
+ # @note When making an API call, you may pass CreateGatewayInput
91
+ # data as a hash:
92
+ #
93
+ # {
94
+ # activation_key: "ActivationKey", # required
95
+ # gateway_display_name: "Name", # required
96
+ # gateway_type: "BACKUP_VM", # required, accepts BACKUP_VM
97
+ # tags: [
98
+ # {
99
+ # key: "TagKey", # required
100
+ # value: "TagValue", # required
101
+ # },
102
+ # ],
103
+ # }
104
+ #
105
+ # @!attribute [rw] activation_key
106
+ # The activation key of the created gateway.
107
+ # @return [String]
108
+ #
109
+ # @!attribute [rw] gateway_display_name
110
+ # The display name of the created gateway.
111
+ # @return [String]
112
+ #
113
+ # @!attribute [rw] gateway_type
114
+ # The type of created gateway.
115
+ # @return [String]
116
+ #
117
+ # @!attribute [rw] tags
118
+ # A list of up to 50 tags to assign to the gateway. Each tag is a
119
+ # key-value pair.
120
+ # @return [Array<Types::Tag>]
121
+ #
122
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/CreateGatewayInput AWS API Documentation
123
+ #
124
+ class CreateGatewayInput < Struct.new(
125
+ :activation_key,
126
+ :gateway_display_name,
127
+ :gateway_type,
128
+ :tags)
129
+ SENSITIVE = []
130
+ include Aws::Structure
131
+ end
132
+
133
+ # @!attribute [rw] gateway_arn
134
+ # The Amazon Resource Name (ARN) of the gateway you create.
135
+ # @return [String]
136
+ #
137
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/CreateGatewayOutput AWS API Documentation
138
+ #
139
+ class CreateGatewayOutput < Struct.new(
140
+ :gateway_arn)
141
+ SENSITIVE = []
142
+ include Aws::Structure
143
+ end
144
+
145
+ # @note When making an API call, you may pass DeleteGatewayInput
146
+ # data as a hash:
147
+ #
148
+ # {
149
+ # gateway_arn: "GatewayArn", # required
150
+ # }
151
+ #
152
+ # @!attribute [rw] gateway_arn
153
+ # The Amazon Resource Name (ARN) of the gateway to delete.
154
+ # @return [String]
155
+ #
156
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/DeleteGatewayInput AWS API Documentation
157
+ #
158
+ class DeleteGatewayInput < Struct.new(
159
+ :gateway_arn)
160
+ SENSITIVE = []
161
+ include Aws::Structure
162
+ end
163
+
164
+ # @!attribute [rw] gateway_arn
165
+ # The Amazon Resource Name (ARN) of the gateway you deleted.
166
+ # @return [String]
167
+ #
168
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/DeleteGatewayOutput AWS API Documentation
169
+ #
170
+ class DeleteGatewayOutput < Struct.new(
171
+ :gateway_arn)
172
+ SENSITIVE = []
173
+ include Aws::Structure
174
+ end
175
+
176
+ # @note When making an API call, you may pass DeleteHypervisorInput
177
+ # data as a hash:
178
+ #
179
+ # {
180
+ # hypervisor_arn: "ServerArn", # required
181
+ # }
182
+ #
183
+ # @!attribute [rw] hypervisor_arn
184
+ # The Amazon Resource Name (ARN) of the hypervisor to delete.
185
+ # @return [String]
186
+ #
187
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/DeleteHypervisorInput AWS API Documentation
188
+ #
189
+ class DeleteHypervisorInput < Struct.new(
190
+ :hypervisor_arn)
191
+ SENSITIVE = []
192
+ include Aws::Structure
193
+ end
194
+
195
+ # @!attribute [rw] hypervisor_arn
196
+ # The Amazon Resource Name (ARN) of the hypervisor you deleted.
197
+ # @return [String]
198
+ #
199
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/DeleteHypervisorOutput AWS API Documentation
200
+ #
201
+ class DeleteHypervisorOutput < Struct.new(
202
+ :hypervisor_arn)
203
+ SENSITIVE = []
204
+ include Aws::Structure
205
+ end
206
+
207
+ # @note When making an API call, you may pass DisassociateGatewayFromServerInput
208
+ # data as a hash:
209
+ #
210
+ # {
211
+ # gateway_arn: "GatewayArn", # required
212
+ # }
213
+ #
214
+ # @!attribute [rw] gateway_arn
215
+ # The Amazon Resource Name (ARN) of the gateway to disassociate.
216
+ # @return [String]
217
+ #
218
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/DisassociateGatewayFromServerInput AWS API Documentation
219
+ #
220
+ class DisassociateGatewayFromServerInput < Struct.new(
221
+ :gateway_arn)
222
+ SENSITIVE = []
223
+ include Aws::Structure
224
+ end
225
+
226
+ # @!attribute [rw] gateway_arn
227
+ # The Amazon Resource Name (ARN) of the gateway you disassociated.
228
+ # @return [String]
229
+ #
230
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/DisassociateGatewayFromServerOutput AWS API Documentation
231
+ #
232
+ class DisassociateGatewayFromServerOutput < Struct.new(
233
+ :gateway_arn)
234
+ SENSITIVE = []
235
+ include Aws::Structure
236
+ end
237
+
238
+ # A gateway is an Backup Gateway appliance that runs on the customer's
239
+ # network to provide seamless connectivity to backup storage in the
240
+ # Amazon Web Services Cloud.
241
+ #
242
+ # @!attribute [rw] gateway_arn
243
+ # The Amazon Resource Name (ARN) of the gateway. Use the
244
+ # `ListGateways` operation to return a list of gateways for your
245
+ # account and Amazon Web Services Region.
246
+ # @return [String]
247
+ #
248
+ # @!attribute [rw] gateway_display_name
249
+ # The display name of the gateway.
250
+ # @return [String]
251
+ #
252
+ # @!attribute [rw] gateway_type
253
+ # The type of the gateway.
254
+ # @return [String]
255
+ #
256
+ # @!attribute [rw] hypervisor_id
257
+ # The hypervisor ID of the gateway.
258
+ # @return [String]
259
+ #
260
+ # @!attribute [rw] last_seen_time
261
+ # The last time Backup gateway communicated with the gateway, in Unix
262
+ # format and UTC time.
263
+ # @return [Time]
264
+ #
265
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/Gateway AWS API Documentation
266
+ #
267
+ class Gateway < Struct.new(
268
+ :gateway_arn,
269
+ :gateway_display_name,
270
+ :gateway_type,
271
+ :hypervisor_id,
272
+ :last_seen_time)
273
+ SENSITIVE = []
274
+ include Aws::Structure
275
+ end
276
+
277
+ # Represents the hypervisor's permissions to which the gateway will
278
+ # connect.
279
+ #
280
+ # A hypervisor is hardware, software, or firmware that creates and
281
+ # manages virtual machines, and allocates resources to them.
282
+ #
283
+ # @!attribute [rw] host
284
+ # The server host of the hypervisor. This can be either an IP address
285
+ # or a fully-qualified domain name (FQDN).
286
+ # @return [String]
287
+ #
288
+ # @!attribute [rw] hypervisor_arn
289
+ # The Amazon Resource Name (ARN) of the hypervisor.
290
+ # @return [String]
291
+ #
292
+ # @!attribute [rw] kms_key_arn
293
+ # The Amazon Resource Name (ARN) of the Key Management Service used to
294
+ # encrypt the hypervisor.
295
+ # @return [String]
296
+ #
297
+ # @!attribute [rw] name
298
+ # The name of the hypervisor.
299
+ # @return [String]
300
+ #
301
+ # @!attribute [rw] state
302
+ # The state of the hypervisor.
303
+ # @return [String]
304
+ #
305
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/Hypervisor AWS API Documentation
306
+ #
307
+ class Hypervisor < Struct.new(
308
+ :host,
309
+ :hypervisor_arn,
310
+ :kms_key_arn,
311
+ :name,
312
+ :state)
313
+ SENSITIVE = []
314
+ include Aws::Structure
315
+ end
316
+
317
+ # @note When making an API call, you may pass ImportHypervisorConfigurationInput
318
+ # data as a hash:
319
+ #
320
+ # {
321
+ # host: "Host", # required
322
+ # kms_key_arn: "KmsKeyArn",
323
+ # name: "Name", # required
324
+ # password: "Password",
325
+ # tags: [
326
+ # {
327
+ # key: "TagKey", # required
328
+ # value: "TagValue", # required
329
+ # },
330
+ # ],
331
+ # username: "Username",
332
+ # }
333
+ #
334
+ # @!attribute [rw] host
335
+ # The server host of the hypervisor. This can be either an IP address
336
+ # or a fully-qualified domain name (FQDN).
337
+ # @return [String]
338
+ #
339
+ # @!attribute [rw] kms_key_arn
340
+ # The Key Management Service for the hypervisor.
341
+ # @return [String]
342
+ #
343
+ # @!attribute [rw] name
344
+ # The name of the hypervisor.
345
+ # @return [String]
346
+ #
347
+ # @!attribute [rw] password
348
+ # The password for the hypervisor.
349
+ # @return [String]
350
+ #
351
+ # @!attribute [rw] tags
352
+ # The tags of the hypervisor configuration to import.
353
+ # @return [Array<Types::Tag>]
354
+ #
355
+ # @!attribute [rw] username
356
+ # The username for the hypervisor.
357
+ # @return [String]
358
+ #
359
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ImportHypervisorConfigurationInput AWS API Documentation
360
+ #
361
+ class ImportHypervisorConfigurationInput < Struct.new(
362
+ :host,
363
+ :kms_key_arn,
364
+ :name,
365
+ :password,
366
+ :tags,
367
+ :username)
368
+ SENSITIVE = [:password, :username]
369
+ include Aws::Structure
370
+ end
371
+
372
+ # @!attribute [rw] hypervisor_arn
373
+ # The Amazon Resource Name (ARN) of the hypervisor you disassociated.
374
+ # @return [String]
375
+ #
376
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ImportHypervisorConfigurationOutput AWS API Documentation
377
+ #
378
+ class ImportHypervisorConfigurationOutput < Struct.new(
379
+ :hypervisor_arn)
380
+ SENSITIVE = []
381
+ include Aws::Structure
382
+ end
383
+
384
+ # The operation did not succeed because an internal error occurred. Try
385
+ # again later.
386
+ #
387
+ # @!attribute [rw] error_code
388
+ # A description of which internal error occured.
389
+ # @return [String]
390
+ #
391
+ # @!attribute [rw] message
392
+ # @return [String]
393
+ #
394
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/InternalServerException AWS API Documentation
395
+ #
396
+ class InternalServerException < Struct.new(
397
+ :error_code,
398
+ :message)
399
+ SENSITIVE = []
400
+ include Aws::Structure
401
+ end
402
+
403
+ # @note When making an API call, you may pass ListGatewaysInput
404
+ # data as a hash:
405
+ #
406
+ # {
407
+ # max_results: 1,
408
+ # next_token: "NextToken",
409
+ # }
410
+ #
411
+ # @!attribute [rw] max_results
412
+ # The maximum number of gateways to list.
413
+ # @return [Integer]
414
+ #
415
+ # @!attribute [rw] next_token
416
+ # The next item following a partial list of returned resources. For
417
+ # example, if a request is made to return `MaxResults` number of
418
+ # resources, `NextToken` allows you to return more items in your list
419
+ # starting at the location pointed to by the next token.
420
+ # @return [String]
421
+ #
422
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListGatewaysInput AWS API Documentation
423
+ #
424
+ class ListGatewaysInput < Struct.new(
425
+ :max_results,
426
+ :next_token)
427
+ SENSITIVE = []
428
+ include Aws::Structure
429
+ end
430
+
431
+ # @!attribute [rw] gateways
432
+ # A list of your gateways.
433
+ # @return [Array<Types::Gateway>]
434
+ #
435
+ # @!attribute [rw] next_token
436
+ # The next item following a partial list of returned resources. For
437
+ # example, if a request is made to return `maxResults` number of
438
+ # resources, `NextToken` allows you to return more items in your list
439
+ # starting at the location pointed to by the next token.
440
+ # @return [String]
441
+ #
442
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListGatewaysOutput AWS API Documentation
443
+ #
444
+ class ListGatewaysOutput < Struct.new(
445
+ :gateways,
446
+ :next_token)
447
+ SENSITIVE = []
448
+ include Aws::Structure
449
+ end
450
+
451
+ # @note When making an API call, you may pass ListHypervisorsInput
452
+ # data as a hash:
453
+ #
454
+ # {
455
+ # max_results: 1,
456
+ # next_token: "NextToken",
457
+ # }
458
+ #
459
+ # @!attribute [rw] max_results
460
+ # The maximum number of hypervisors to list.
461
+ # @return [Integer]
462
+ #
463
+ # @!attribute [rw] next_token
464
+ # The next item following a partial list of returned resources. For
465
+ # example, if a request is made to return `maxResults` number of
466
+ # resources, `NextToken` allows you to return more items in your list
467
+ # starting at the location pointed to by the next token.
468
+ # @return [String]
469
+ #
470
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListHypervisorsInput AWS API Documentation
471
+ #
472
+ class ListHypervisorsInput < Struct.new(
473
+ :max_results,
474
+ :next_token)
475
+ SENSITIVE = []
476
+ include Aws::Structure
477
+ end
478
+
479
+ # @!attribute [rw] hypervisors
480
+ # A list of your `Hypervisor` objects, ordered by their Amazon
481
+ # Resource Names (ARNs).
482
+ # @return [Array<Types::Hypervisor>]
483
+ #
484
+ # @!attribute [rw] next_token
485
+ # The next item following a partial list of returned resources. For
486
+ # example, if a request is made to return `maxResults` number of
487
+ # resources, `NextToken` allows you to return more items in your list
488
+ # starting at the location pointed to by the next token.
489
+ # @return [String]
490
+ #
491
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListHypervisorsOutput AWS API Documentation
492
+ #
493
+ class ListHypervisorsOutput < Struct.new(
494
+ :hypervisors,
495
+ :next_token)
496
+ SENSITIVE = []
497
+ include Aws::Structure
498
+ end
499
+
500
+ # @note When making an API call, you may pass ListTagsForResourceInput
501
+ # data as a hash:
502
+ #
503
+ # {
504
+ # resource_arn: "ResourceArn", # required
505
+ # }
506
+ #
507
+ # @!attribute [rw] resource_arn
508
+ # The Amazon Resource Name (ARN) of the resource's tags to list.
509
+ # @return [String]
510
+ #
511
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListTagsForResourceInput AWS API Documentation
512
+ #
513
+ class ListTagsForResourceInput < Struct.new(
514
+ :resource_arn)
515
+ SENSITIVE = []
516
+ include Aws::Structure
517
+ end
518
+
519
+ # @!attribute [rw] resource_arn
520
+ # The Amazon Resource Name (ARN) of the resource's tags that you
521
+ # listed.
522
+ # @return [String]
523
+ #
524
+ # @!attribute [rw] tags
525
+ # A list of the resource's tags.
526
+ # @return [Array<Types::Tag>]
527
+ #
528
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListTagsForResourceOutput AWS API Documentation
529
+ #
530
+ class ListTagsForResourceOutput < Struct.new(
531
+ :resource_arn,
532
+ :tags)
533
+ SENSITIVE = []
534
+ include Aws::Structure
535
+ end
536
+
537
+ # @note When making an API call, you may pass ListVirtualMachinesInput
538
+ # data as a hash:
539
+ #
540
+ # {
541
+ # max_results: 1,
542
+ # next_token: "NextToken",
543
+ # }
544
+ #
545
+ # @!attribute [rw] max_results
546
+ # The maximum number of virtual machines to list.
547
+ # @return [Integer]
548
+ #
549
+ # @!attribute [rw] next_token
550
+ # The next item following a partial list of returned resources. For
551
+ # example, if a request is made to return `maxResults` number of
552
+ # resources, `NextToken` allows you to return more items in your list
553
+ # starting at the location pointed to by the next token.
554
+ # @return [String]
555
+ #
556
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListVirtualMachinesInput AWS API Documentation
557
+ #
558
+ class ListVirtualMachinesInput < Struct.new(
559
+ :max_results,
560
+ :next_token)
561
+ SENSITIVE = []
562
+ include Aws::Structure
563
+ end
564
+
565
+ # @!attribute [rw] next_token
566
+ # The next item following a partial list of returned resources. For
567
+ # example, if a request is made to return `maxResults` number of
568
+ # resources, `NextToken` allows you to return more items in your list
569
+ # starting at the location pointed to by the next token.
570
+ # @return [String]
571
+ #
572
+ # @!attribute [rw] virtual_machines
573
+ # A list of your `VirtualMachine` objects, ordered by their Amazon
574
+ # Resource Names (ARNs).
575
+ # @return [Array<Types::VirtualMachine>]
576
+ #
577
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListVirtualMachinesOutput AWS API Documentation
578
+ #
579
+ class ListVirtualMachinesOutput < Struct.new(
580
+ :next_token,
581
+ :virtual_machines)
582
+ SENSITIVE = []
583
+ include Aws::Structure
584
+ end
585
+
586
+ # @note When making an API call, you may pass PutMaintenanceStartTimeInput
587
+ # data as a hash:
588
+ #
589
+ # {
590
+ # day_of_month: 1,
591
+ # day_of_week: 1,
592
+ # gateway_arn: "GatewayArn", # required
593
+ # hour_of_day: 1, # required
594
+ # minute_of_hour: 1, # required
595
+ # }
596
+ #
597
+ # @!attribute [rw] day_of_month
598
+ # The day of the month start maintenance on a gateway.
599
+ #
600
+ # Valid values range from `Sunday` to `Saturday`.
601
+ # @return [Integer]
602
+ #
603
+ # @!attribute [rw] day_of_week
604
+ # The day of the week to start maintenance on a gateway.
605
+ # @return [Integer]
606
+ #
607
+ # @!attribute [rw] gateway_arn
608
+ # The Amazon Resource Name (ARN) for the gateway, used to specify its
609
+ # maintenance start time.
610
+ # @return [String]
611
+ #
612
+ # @!attribute [rw] hour_of_day
613
+ # The hour of the day to start maintenance on a gateway.
614
+ # @return [Integer]
615
+ #
616
+ # @!attribute [rw] minute_of_hour
617
+ # The minute of the hour to start maintenance on a gateway.
618
+ # @return [Integer]
619
+ #
620
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutMaintenanceStartTimeInput AWS API Documentation
621
+ #
622
+ class PutMaintenanceStartTimeInput < Struct.new(
623
+ :day_of_month,
624
+ :day_of_week,
625
+ :gateway_arn,
626
+ :hour_of_day,
627
+ :minute_of_hour)
628
+ SENSITIVE = []
629
+ include Aws::Structure
630
+ end
631
+
632
+ # @!attribute [rw] gateway_arn
633
+ # The Amazon Resource Name (ARN) of a gateway for which you set the
634
+ # maintenance start time.
635
+ # @return [String]
636
+ #
637
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutMaintenanceStartTimeOutput AWS API Documentation
638
+ #
639
+ class PutMaintenanceStartTimeOutput < Struct.new(
640
+ :gateway_arn)
641
+ SENSITIVE = []
642
+ include Aws::Structure
643
+ end
644
+
645
+ # A resource that is required for the action wasn't found.
646
+ #
647
+ # @!attribute [rw] error_code
648
+ # A description of which resource wasn't found.
649
+ # @return [String]
650
+ #
651
+ # @!attribute [rw] message
652
+ # @return [String]
653
+ #
654
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ResourceNotFoundException AWS API Documentation
655
+ #
656
+ class ResourceNotFoundException < Struct.new(
657
+ :error_code,
658
+ :message)
659
+ SENSITIVE = []
660
+ include Aws::Structure
661
+ end
662
+
663
+ # A key-value pair you can use to manage, filter, and search for your
664
+ # resources. Allowed characters include UTF-8 letters, numbers, spaces,
665
+ # and the following characters: + - = . \_ : /.
666
+ #
667
+ # @note When making an API call, you may pass Tag
668
+ # data as a hash:
669
+ #
670
+ # {
671
+ # key: "TagKey", # required
672
+ # value: "TagValue", # required
673
+ # }
674
+ #
675
+ # @!attribute [rw] key
676
+ # The key part of a tag's key-value pair. The key can't start with
677
+ # `aws:`.
678
+ # @return [String]
679
+ #
680
+ # @!attribute [rw] value
681
+ # The key part of a value's key-value pair.
682
+ # @return [String]
683
+ #
684
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/Tag AWS API Documentation
685
+ #
686
+ class Tag < Struct.new(
687
+ :key,
688
+ :value)
689
+ SENSITIVE = []
690
+ include Aws::Structure
691
+ end
692
+
693
+ # @note When making an API call, you may pass TagResourceInput
694
+ # data as a hash:
695
+ #
696
+ # {
697
+ # resource_arn: "ResourceArn", # required
698
+ # tags: [ # required
699
+ # {
700
+ # key: "TagKey", # required
701
+ # value: "TagValue", # required
702
+ # },
703
+ # ],
704
+ # }
705
+ #
706
+ # @!attribute [rw] resource_arn
707
+ # The Amazon Resource Name (ARN) of the resource to tag.
708
+ # @return [String]
709
+ #
710
+ # @!attribute [rw] tags
711
+ # A list of tags to assign to the resource.
712
+ # @return [Array<Types::Tag>]
713
+ #
714
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/TagResourceInput AWS API Documentation
715
+ #
716
+ class TagResourceInput < Struct.new(
717
+ :resource_arn,
718
+ :tags)
719
+ SENSITIVE = []
720
+ include Aws::Structure
721
+ end
722
+
723
+ # @!attribute [rw] resource_arn
724
+ # The Amazon Resource Name (ARN) of the resource you tagged.
725
+ # @return [String]
726
+ #
727
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/TagResourceOutput AWS API Documentation
728
+ #
729
+ class TagResourceOutput < Struct.new(
730
+ :resource_arn)
731
+ SENSITIVE = []
732
+ include Aws::Structure
733
+ end
734
+
735
+ # @note When making an API call, you may pass TestHypervisorConfigurationInput
736
+ # data as a hash:
737
+ #
738
+ # {
739
+ # gateway_arn: "GatewayArn", # required
740
+ # host: "Host", # required
741
+ # password: "Password",
742
+ # username: "Username",
743
+ # }
744
+ #
745
+ # @!attribute [rw] gateway_arn
746
+ # The Amazon Resource Name (ARN) of the gateway to the hypervisor to
747
+ # test.
748
+ # @return [String]
749
+ #
750
+ # @!attribute [rw] host
751
+ # The server host of the hypervisor. This can be either an IP address
752
+ # or a fully-qualified domain name (FQDN).
753
+ # @return [String]
754
+ #
755
+ # @!attribute [rw] password
756
+ # The password for the hypervisor.
757
+ # @return [String]
758
+ #
759
+ # @!attribute [rw] username
760
+ # The username for the hypervisor.
761
+ # @return [String]
762
+ #
763
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/TestHypervisorConfigurationInput AWS API Documentation
764
+ #
765
+ class TestHypervisorConfigurationInput < Struct.new(
766
+ :gateway_arn,
767
+ :host,
768
+ :password,
769
+ :username)
770
+ SENSITIVE = [:password, :username]
771
+ include Aws::Structure
772
+ end
773
+
774
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/TestHypervisorConfigurationOutput AWS API Documentation
775
+ #
776
+ class TestHypervisorConfigurationOutput < Aws::EmptyStructure; end
777
+
778
+ # @note When making an API call, you may pass UntagResourceInput
779
+ # data as a hash:
780
+ #
781
+ # {
782
+ # resource_arn: "ResourceArn", # required
783
+ # tag_keys: ["TagKey"], # required
784
+ # }
785
+ #
786
+ # @!attribute [rw] resource_arn
787
+ # The Amazon Resource Name (ARN) of the resource from which to remove
788
+ # tags.
789
+ # @return [String]
790
+ #
791
+ # @!attribute [rw] tag_keys
792
+ # The list of tag keys specifying which tags to remove.
793
+ # @return [Array<String>]
794
+ #
795
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UntagResourceInput AWS API Documentation
796
+ #
797
+ class UntagResourceInput < Struct.new(
798
+ :resource_arn,
799
+ :tag_keys)
800
+ SENSITIVE = []
801
+ include Aws::Structure
802
+ end
803
+
804
+ # @!attribute [rw] resource_arn
805
+ # The Amazon Resource Name (ARN) of the resource from which you
806
+ # removed tags.
807
+ # @return [String]
808
+ #
809
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UntagResourceOutput AWS API Documentation
810
+ #
811
+ class UntagResourceOutput < Struct.new(
812
+ :resource_arn)
813
+ SENSITIVE = []
814
+ include Aws::Structure
815
+ end
816
+
817
+ # @note When making an API call, you may pass UpdateGatewayInformationInput
818
+ # data as a hash:
819
+ #
820
+ # {
821
+ # gateway_arn: "GatewayArn", # required
822
+ # gateway_display_name: "Name",
823
+ # }
824
+ #
825
+ # @!attribute [rw] gateway_arn
826
+ # The Amazon Resource Name (ARN) of the gateway to update.
827
+ # @return [String]
828
+ #
829
+ # @!attribute [rw] gateway_display_name
830
+ # The updated display name of the gateway.
831
+ # @return [String]
832
+ #
833
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateGatewayInformationInput AWS API Documentation
834
+ #
835
+ class UpdateGatewayInformationInput < Struct.new(
836
+ :gateway_arn,
837
+ :gateway_display_name)
838
+ SENSITIVE = []
839
+ include Aws::Structure
840
+ end
841
+
842
+ # @!attribute [rw] gateway_arn
843
+ # The Amazon Resource Name (ARN) of the gateway you updated.
844
+ # @return [String]
845
+ #
846
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateGatewayInformationOutput AWS API Documentation
847
+ #
848
+ class UpdateGatewayInformationOutput < Struct.new(
849
+ :gateway_arn)
850
+ SENSITIVE = []
851
+ include Aws::Structure
852
+ end
853
+
854
+ # @note When making an API call, you may pass UpdateHypervisorInput
855
+ # data as a hash:
856
+ #
857
+ # {
858
+ # host: "Host",
859
+ # hypervisor_arn: "ServerArn", # required
860
+ # password: "Password",
861
+ # username: "Username",
862
+ # }
863
+ #
864
+ # @!attribute [rw] host
865
+ # The updated host of the hypervisor. This can be either an IP address
866
+ # or a fully-qualified domain name (FQDN).
867
+ # @return [String]
868
+ #
869
+ # @!attribute [rw] hypervisor_arn
870
+ # The Amazon Resource Name (ARN) of the hypervisor to update.
871
+ # @return [String]
872
+ #
873
+ # @!attribute [rw] password
874
+ # The updated password for the hypervisor.
875
+ # @return [String]
876
+ #
877
+ # @!attribute [rw] username
878
+ # The updated username for the hypervisor.
879
+ # @return [String]
880
+ #
881
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateHypervisorInput AWS API Documentation
882
+ #
883
+ class UpdateHypervisorInput < Struct.new(
884
+ :host,
885
+ :hypervisor_arn,
886
+ :password,
887
+ :username)
888
+ SENSITIVE = [:password, :username]
889
+ include Aws::Structure
890
+ end
891
+
892
+ # @!attribute [rw] hypervisor_arn
893
+ # The Amazon Resource Name (ARN) of the hypervisor you updated.
894
+ # @return [String]
895
+ #
896
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateHypervisorOutput AWS API Documentation
897
+ #
898
+ class UpdateHypervisorOutput < Struct.new(
899
+ :hypervisor_arn)
900
+ SENSITIVE = []
901
+ include Aws::Structure
902
+ end
903
+
904
+ # The operation did not succeed because a validation error occurred.
905
+ #
906
+ # @!attribute [rw] error_code
907
+ # A description of what caused the validation error.
908
+ # @return [String]
909
+ #
910
+ # @!attribute [rw] message
911
+ # @return [String]
912
+ #
913
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ValidationException AWS API Documentation
914
+ #
915
+ class ValidationException < Struct.new(
916
+ :error_code,
917
+ :message)
918
+ SENSITIVE = []
919
+ include Aws::Structure
920
+ end
921
+
922
+ # A virtual machine that is on a hypervisor.
923
+ #
924
+ # @!attribute [rw] host_name
925
+ # The host name of the virtual machine.
926
+ # @return [String]
927
+ #
928
+ # @!attribute [rw] hypervisor_id
929
+ # The ID of the virtual machine's hypervisor.
930
+ # @return [String]
931
+ #
932
+ # @!attribute [rw] last_backup_date
933
+ # The most recent date a virtual machine was backed up, in Unix format
934
+ # and UTC time.
935
+ # @return [Time]
936
+ #
937
+ # @!attribute [rw] name
938
+ # The name of the virtual machine.
939
+ # @return [String]
940
+ #
941
+ # @!attribute [rw] path
942
+ # The path of the virtual machine.
943
+ # @return [String]
944
+ #
945
+ # @!attribute [rw] resource_arn
946
+ # The Amazon Resource Name (ARN) of the virtual machine.
947
+ # @return [String]
948
+ #
949
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/VirtualMachine AWS API Documentation
950
+ #
951
+ class VirtualMachine < Struct.new(
952
+ :host_name,
953
+ :hypervisor_id,
954
+ :last_backup_date,
955
+ :name,
956
+ :path,
957
+ :resource_arn)
958
+ SENSITIVE = []
959
+ include Aws::Structure
960
+ end
961
+
962
+ end
963
+ end