aws-sdk-backupgateway 1.0.0 → 1.15.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -29,14 +29,6 @@ module Aws::BackupGateway
29
29
  include Aws::Structure
30
30
  end
31
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
32
  # @!attribute [rw] gateway_arn
41
33
  # The Amazon Resource Name (ARN) of the gateway. Use the
42
34
  # `ListGateways` operation to return a list of gateways for your
@@ -69,6 +61,62 @@ module Aws::BackupGateway
69
61
  include Aws::Structure
70
62
  end
71
63
 
64
+ # Describes a bandwidth rate limit interval for a gateway. A bandwidth
65
+ # rate limit schedule consists of one or more bandwidth rate limit
66
+ # intervals. A bandwidth rate limit interval defines a period of time on
67
+ # one or more days of the week, during which bandwidth rate limits are
68
+ # specified for uploading, downloading, or both.
69
+ #
70
+ # @!attribute [rw] average_upload_rate_limit_in_bits_per_sec
71
+ # The average upload rate limit component of the bandwidth rate limit
72
+ # interval, in bits per second. This field does not appear in the
73
+ # response if the upload rate limit is not set.
74
+ #
75
+ # <note markdown="1"> For Backup Gateway, the minimum value is `(Value)`.
76
+ #
77
+ # </note>
78
+ # @return [Integer]
79
+ #
80
+ # @!attribute [rw] days_of_week
81
+ # The days of the week component of the bandwidth rate limit interval,
82
+ # represented as ordinal numbers from 0 to 6, where 0 represents
83
+ # Sunday and 6 represents Saturday.
84
+ # @return [Array<Integer>]
85
+ #
86
+ # @!attribute [rw] end_hour_of_day
87
+ # The hour of the day to end the bandwidth rate limit interval.
88
+ # @return [Integer]
89
+ #
90
+ # @!attribute [rw] end_minute_of_hour
91
+ # The minute of the hour to end the bandwidth rate limit interval.
92
+ #
93
+ # The bandwidth rate limit interval ends at the end of the minute. To
94
+ # end an interval at the end of an hour, use the value `59`.
95
+ # @return [Integer]
96
+ #
97
+ # @!attribute [rw] start_hour_of_day
98
+ # The hour of the day to start the bandwidth rate limit interval.
99
+ # @return [Integer]
100
+ #
101
+ # @!attribute [rw] start_minute_of_hour
102
+ # The minute of the hour to start the bandwidth rate limit interval.
103
+ # The interval begins at the start of that minute. To begin an
104
+ # interval exactly at the start of the hour, use the value `0`.
105
+ # @return [Integer]
106
+ #
107
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/BandwidthRateLimitInterval AWS API Documentation
108
+ #
109
+ class BandwidthRateLimitInterval < Struct.new(
110
+ :average_upload_rate_limit_in_bits_per_sec,
111
+ :days_of_week,
112
+ :end_hour_of_day,
113
+ :end_minute_of_hour,
114
+ :start_hour_of_day,
115
+ :start_minute_of_hour)
116
+ SENSITIVE = []
117
+ include Aws::Structure
118
+ end
119
+
72
120
  # The operation cannot proceed because it is not supported.
73
121
  #
74
122
  # @!attribute [rw] error_code
@@ -87,21 +135,6 @@ module Aws::BackupGateway
87
135
  include Aws::Structure
88
136
  end
89
137
 
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
138
  # @!attribute [rw] activation_key
106
139
  # The activation key of the created gateway.
107
140
  # @return [String]
@@ -142,13 +175,6 @@ module Aws::BackupGateway
142
175
  include Aws::Structure
143
176
  end
144
177
 
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
178
  # @!attribute [rw] gateway_arn
153
179
  # The Amazon Resource Name (ARN) of the gateway to delete.
154
180
  # @return [String]
@@ -173,13 +199,6 @@ module Aws::BackupGateway
173
199
  include Aws::Structure
174
200
  end
175
201
 
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
202
  # @!attribute [rw] hypervisor_arn
184
203
  # The Amazon Resource Name (ARN) of the hypervisor to delete.
185
204
  # @return [String]
@@ -204,13 +223,6 @@ module Aws::BackupGateway
204
223
  include Aws::Structure
205
224
  end
206
225
 
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
226
  # @!attribute [rw] gateway_arn
215
227
  # The Amazon Resource Name (ARN) of the gateway to disassociate.
216
228
  # @return [String]
@@ -274,6 +286,213 @@ module Aws::BackupGateway
274
286
  include Aws::Structure
275
287
  end
276
288
 
289
+ # The details of gateway.
290
+ #
291
+ # @!attribute [rw] gateway_arn
292
+ # The Amazon Resource Name (ARN) of the gateway. Use the
293
+ # `ListGateways` operation to return a list of gateways for your
294
+ # account and Amazon Web Services Region.
295
+ # @return [String]
296
+ #
297
+ # @!attribute [rw] gateway_display_name
298
+ # The display name of the gateway.
299
+ # @return [String]
300
+ #
301
+ # @!attribute [rw] gateway_type
302
+ # The type of the gateway type.
303
+ # @return [String]
304
+ #
305
+ # @!attribute [rw] hypervisor_id
306
+ # The hypervisor ID of the gateway.
307
+ # @return [String]
308
+ #
309
+ # @!attribute [rw] last_seen_time
310
+ # Details showing the last time Backup gateway communicated with the
311
+ # cloud, in Unix format and UTC time.
312
+ # @return [Time]
313
+ #
314
+ # @!attribute [rw] maintenance_start_time
315
+ # Returns your gateway's weekly maintenance start time including the
316
+ # day and time of the week. Note that values are in terms of the
317
+ # gateway's time zone. Can be weekly or monthly.
318
+ # @return [Types::MaintenanceStartTime]
319
+ #
320
+ # @!attribute [rw] next_update_availability_time
321
+ # Details showing the next update availability time of the gateway.
322
+ # @return [Time]
323
+ #
324
+ # @!attribute [rw] vpc_endpoint
325
+ # The DNS name for the virtual private cloud (VPC) endpoint the
326
+ # gateway uses to connect to the cloud for backup gateway.
327
+ # @return [String]
328
+ #
329
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GatewayDetails AWS API Documentation
330
+ #
331
+ class GatewayDetails < Struct.new(
332
+ :gateway_arn,
333
+ :gateway_display_name,
334
+ :gateway_type,
335
+ :hypervisor_id,
336
+ :last_seen_time,
337
+ :maintenance_start_time,
338
+ :next_update_availability_time,
339
+ :vpc_endpoint)
340
+ SENSITIVE = []
341
+ include Aws::Structure
342
+ end
343
+
344
+ # @!attribute [rw] gateway_arn
345
+ # The Amazon Resource Name (ARN) of the gateway. Use the [
346
+ # `ListGateways` ][1] operation to return a list of gateways for your
347
+ # account and Amazon Web Services Region.
348
+ #
349
+ #
350
+ #
351
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
352
+ # @return [String]
353
+ #
354
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetBandwidthRateLimitScheduleInput AWS API Documentation
355
+ #
356
+ class GetBandwidthRateLimitScheduleInput < Struct.new(
357
+ :gateway_arn)
358
+ SENSITIVE = []
359
+ include Aws::Structure
360
+ end
361
+
362
+ # @!attribute [rw] bandwidth_rate_limit_intervals
363
+ # An array containing bandwidth rate limit schedule intervals for a
364
+ # gateway. When no bandwidth rate limit intervals have been scheduled,
365
+ # the array is empty.
366
+ # @return [Array<Types::BandwidthRateLimitInterval>]
367
+ #
368
+ # @!attribute [rw] gateway_arn
369
+ # The Amazon Resource Name (ARN) of the gateway. Use the [
370
+ # `ListGateways` ][1] operation to return a list of gateways for your
371
+ # account and Amazon Web Services Region.
372
+ #
373
+ #
374
+ #
375
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
376
+ # @return [String]
377
+ #
378
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetBandwidthRateLimitScheduleOutput AWS API Documentation
379
+ #
380
+ class GetBandwidthRateLimitScheduleOutput < Struct.new(
381
+ :bandwidth_rate_limit_intervals,
382
+ :gateway_arn)
383
+ SENSITIVE = []
384
+ include Aws::Structure
385
+ end
386
+
387
+ # @!attribute [rw] gateway_arn
388
+ # The Amazon Resource Name (ARN) of the gateway.
389
+ # @return [String]
390
+ #
391
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetGatewayInput AWS API Documentation
392
+ #
393
+ class GetGatewayInput < Struct.new(
394
+ :gateway_arn)
395
+ SENSITIVE = []
396
+ include Aws::Structure
397
+ end
398
+
399
+ # @!attribute [rw] gateway
400
+ # By providing the ARN (Amazon Resource Name), this API returns the
401
+ # gateway.
402
+ # @return [Types::GatewayDetails]
403
+ #
404
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetGatewayOutput AWS API Documentation
405
+ #
406
+ class GetGatewayOutput < Struct.new(
407
+ :gateway)
408
+ SENSITIVE = []
409
+ include Aws::Structure
410
+ end
411
+
412
+ # @!attribute [rw] hypervisor_arn
413
+ # The Amazon Resource Name (ARN) of the hypervisor.
414
+ # @return [String]
415
+ #
416
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisorInput AWS API Documentation
417
+ #
418
+ class GetHypervisorInput < Struct.new(
419
+ :hypervisor_arn)
420
+ SENSITIVE = []
421
+ include Aws::Structure
422
+ end
423
+
424
+ # @!attribute [rw] hypervisor
425
+ # Details about the requested hypervisor.
426
+ # @return [Types::HypervisorDetails]
427
+ #
428
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisorOutput AWS API Documentation
429
+ #
430
+ class GetHypervisorOutput < Struct.new(
431
+ :hypervisor)
432
+ SENSITIVE = []
433
+ include Aws::Structure
434
+ end
435
+
436
+ # @!attribute [rw] hypervisor_arn
437
+ # The Amazon Resource Name (ARN) of the hypervisor.
438
+ # @return [String]
439
+ #
440
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisorPropertyMappingsInput AWS API Documentation
441
+ #
442
+ class GetHypervisorPropertyMappingsInput < Struct.new(
443
+ :hypervisor_arn)
444
+ SENSITIVE = []
445
+ include Aws::Structure
446
+ end
447
+
448
+ # @!attribute [rw] hypervisor_arn
449
+ # The Amazon Resource Name (ARN) of the hypervisor.
450
+ # @return [String]
451
+ #
452
+ # @!attribute [rw] iam_role_arn
453
+ # The Amazon Resource Name (ARN) of the IAM role.
454
+ # @return [String]
455
+ #
456
+ # @!attribute [rw] vmware_to_aws_tag_mappings
457
+ # This is a display of the mappings of on-premises VMware tags to the
458
+ # Amazon Web Services tags.
459
+ # @return [Array<Types::VmwareToAwsTagMapping>]
460
+ #
461
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisorPropertyMappingsOutput AWS API Documentation
462
+ #
463
+ class GetHypervisorPropertyMappingsOutput < Struct.new(
464
+ :hypervisor_arn,
465
+ :iam_role_arn,
466
+ :vmware_to_aws_tag_mappings)
467
+ SENSITIVE = []
468
+ include Aws::Structure
469
+ end
470
+
471
+ # @!attribute [rw] resource_arn
472
+ # The Amazon Resource Name (ARN) of the virtual machine.
473
+ # @return [String]
474
+ #
475
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetVirtualMachineInput AWS API Documentation
476
+ #
477
+ class GetVirtualMachineInput < Struct.new(
478
+ :resource_arn)
479
+ SENSITIVE = []
480
+ include Aws::Structure
481
+ end
482
+
483
+ # @!attribute [rw] virtual_machine
484
+ # This object contains the basic attributes of `VirtualMachine`
485
+ # contained by the output of `GetVirtualMachine`
486
+ # @return [Types::VirtualMachineDetails]
487
+ #
488
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetVirtualMachineOutput AWS API Documentation
489
+ #
490
+ class GetVirtualMachineOutput < Struct.new(
491
+ :virtual_machine)
492
+ SENSITIVE = []
493
+ include Aws::Structure
494
+ end
495
+
277
496
  # Represents the hypervisor's permissions to which the gateway will
278
497
  # connect.
279
498
  #
@@ -314,23 +533,68 @@ module Aws::BackupGateway
314
533
  include Aws::Structure
315
534
  end
316
535
 
317
- # @note When making an API call, you may pass ImportHypervisorConfigurationInput
318
- # data as a hash:
536
+ # These are the details of the specified hypervisor. A hypervisor is
537
+ # hardware, software, or firmware that creates and manages virtual
538
+ # machines, and allocates resources to them.
539
+ #
540
+ # @!attribute [rw] host
541
+ # The server host of the hypervisor. This can be either an IP address
542
+ # or a fully-qualified domain name (FQDN).
543
+ # @return [String]
319
544
  #
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
- # }
545
+ # @!attribute [rw] hypervisor_arn
546
+ # The Amazon Resource Name (ARN) of the hypervisor.
547
+ # @return [String]
333
548
  #
549
+ # @!attribute [rw] kms_key_arn
550
+ # The Amazon Resource Name (ARN) of the KMS used to encrypt the
551
+ # hypervisor.
552
+ # @return [String]
553
+ #
554
+ # @!attribute [rw] last_successful_metadata_sync_time
555
+ # This is the time when the most recent successful sync of metadata
556
+ # occurred.
557
+ # @return [Time]
558
+ #
559
+ # @!attribute [rw] latest_metadata_sync_status
560
+ # This is the most recent status for the indicated metadata sync.
561
+ # @return [String]
562
+ #
563
+ # @!attribute [rw] latest_metadata_sync_status_message
564
+ # This is the most recent status for the indicated metadata sync.
565
+ # @return [String]
566
+ #
567
+ # @!attribute [rw] log_group_arn
568
+ # The Amazon Resource Name (ARN) of the group of gateways within the
569
+ # requested log.
570
+ # @return [String]
571
+ #
572
+ # @!attribute [rw] name
573
+ # This is the name of the specified hypervisor.
574
+ # @return [String]
575
+ #
576
+ # @!attribute [rw] state
577
+ # This is the current state of the specified hypervisor.
578
+ #
579
+ # The possible states are `PENDING`, `ONLINE`, `OFFLINE`, or `ERROR`.
580
+ # @return [String]
581
+ #
582
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/HypervisorDetails AWS API Documentation
583
+ #
584
+ class HypervisorDetails < Struct.new(
585
+ :host,
586
+ :hypervisor_arn,
587
+ :kms_key_arn,
588
+ :last_successful_metadata_sync_time,
589
+ :latest_metadata_sync_status,
590
+ :latest_metadata_sync_status_message,
591
+ :log_group_arn,
592
+ :name,
593
+ :state)
594
+ SENSITIVE = []
595
+ include Aws::Structure
596
+ end
597
+
334
598
  # @!attribute [rw] host
335
599
  # The server host of the hypervisor. This can be either an IP address
336
600
  # or a fully-qualified domain name (FQDN).
@@ -400,14 +664,6 @@ module Aws::BackupGateway
400
664
  include Aws::Structure
401
665
  end
402
666
 
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
667
  # @!attribute [rw] max_results
412
668
  # The maximum number of gateways to list.
413
669
  # @return [Integer]
@@ -448,14 +704,6 @@ module Aws::BackupGateway
448
704
  include Aws::Structure
449
705
  end
450
706
 
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
707
  # @!attribute [rw] max_results
460
708
  # The maximum number of hypervisors to list.
461
709
  # @return [Integer]
@@ -497,13 +745,6 @@ module Aws::BackupGateway
497
745
  include Aws::Structure
498
746
  end
499
747
 
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
748
  # @!attribute [rw] resource_arn
508
749
  # The Amazon Resource Name (ARN) of the resource's tags to list.
509
750
  # @return [String]
@@ -534,13 +775,10 @@ module Aws::BackupGateway
534
775
  include Aws::Structure
535
776
  end
536
777
 
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
- # }
778
+ # @!attribute [rw] hypervisor_arn
779
+ # The Amazon Resource Name (ARN) of the hypervisor connected to your
780
+ # virtual machine.
781
+ # @return [String]
544
782
  #
545
783
  # @!attribute [rw] max_results
546
784
  # The maximum number of virtual machines to list.
@@ -556,6 +794,7 @@ module Aws::BackupGateway
556
794
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ListVirtualMachinesInput AWS API Documentation
557
795
  #
558
796
  class ListVirtualMachinesInput < Struct.new(
797
+ :hypervisor_arn,
559
798
  :max_results,
560
799
  :next_token)
561
800
  SENSITIVE = []
@@ -583,17 +822,124 @@ module Aws::BackupGateway
583
822
  include Aws::Structure
584
823
  end
585
824
 
586
- # @note When making an API call, you may pass PutMaintenanceStartTimeInput
587
- # data as a hash:
825
+ # This is your gateway's weekly maintenance start time including the
826
+ # day and time of the week. Note that values are in terms of the
827
+ # gateway's time zone. Can be weekly or monthly.
828
+ #
829
+ # @!attribute [rw] day_of_month
830
+ # The day of the month component of the maintenance start time
831
+ # represented as an ordinal number from 1 to 28, where 1 represents
832
+ # the first day of the month and 28 represents the last day of the
833
+ # month.
834
+ # @return [Integer]
835
+ #
836
+ # @!attribute [rw] day_of_week
837
+ # An ordinal number between 0 and 6 that represents the day of the
838
+ # week, where 0 represents Sunday and 6 represents Saturday. The day
839
+ # of week is in the time zone of the gateway.
840
+ # @return [Integer]
841
+ #
842
+ # @!attribute [rw] hour_of_day
843
+ # The hour component of the maintenance start time represented as
844
+ # *hh*, where *hh* is the hour (0 to 23). The hour of the day is in
845
+ # the time zone of the gateway.
846
+ # @return [Integer]
847
+ #
848
+ # @!attribute [rw] minute_of_hour
849
+ # The minute component of the maintenance start time represented as
850
+ # *mm*, where *mm* is the minute (0 to 59). The minute of the hour is
851
+ # in the time zone of the gateway.
852
+ # @return [Integer]
853
+ #
854
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/MaintenanceStartTime AWS API Documentation
855
+ #
856
+ class MaintenanceStartTime < Struct.new(
857
+ :day_of_month,
858
+ :day_of_week,
859
+ :hour_of_day,
860
+ :minute_of_hour)
861
+ SENSITIVE = []
862
+ include Aws::Structure
863
+ end
864
+
865
+ # @!attribute [rw] bandwidth_rate_limit_intervals
866
+ # An array containing bandwidth rate limit schedule intervals for a
867
+ # gateway. When no bandwidth rate limit intervals have been scheduled,
868
+ # the array is empty.
869
+ # @return [Array<Types::BandwidthRateLimitInterval>]
870
+ #
871
+ # @!attribute [rw] gateway_arn
872
+ # The Amazon Resource Name (ARN) of the gateway. Use the [
873
+ # `ListGateways` ][1] operation to return a list of gateways for your
874
+ # account and Amazon Web Services Region.
875
+ #
876
+ #
877
+ #
878
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
879
+ # @return [String]
880
+ #
881
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutBandwidthRateLimitScheduleInput AWS API Documentation
882
+ #
883
+ class PutBandwidthRateLimitScheduleInput < Struct.new(
884
+ :bandwidth_rate_limit_intervals,
885
+ :gateway_arn)
886
+ SENSITIVE = []
887
+ include Aws::Structure
888
+ end
889
+
890
+ # @!attribute [rw] gateway_arn
891
+ # The Amazon Resource Name (ARN) of the gateway. Use the [
892
+ # `ListGateways` ][1] operation to return a list of gateways for your
893
+ # account and Amazon Web Services Region.
894
+ #
895
+ #
896
+ #
897
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
898
+ # @return [String]
899
+ #
900
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutBandwidthRateLimitScheduleOutput AWS API Documentation
901
+ #
902
+ class PutBandwidthRateLimitScheduleOutput < Struct.new(
903
+ :gateway_arn)
904
+ SENSITIVE = []
905
+ include Aws::Structure
906
+ end
907
+
908
+ # @!attribute [rw] hypervisor_arn
909
+ # The Amazon Resource Name (ARN) of the hypervisor.
910
+ # @return [String]
911
+ #
912
+ # @!attribute [rw] iam_role_arn
913
+ # The Amazon Resource Name (ARN) of the IAM role.
914
+ # @return [String]
915
+ #
916
+ # @!attribute [rw] vmware_to_aws_tag_mappings
917
+ # This action requests the mappings of on-premises VMware tags to the
918
+ # Amazon Web Services tags.
919
+ # @return [Array<Types::VmwareToAwsTagMapping>]
920
+ #
921
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutHypervisorPropertyMappingsInput AWS API Documentation
922
+ #
923
+ class PutHypervisorPropertyMappingsInput < Struct.new(
924
+ :hypervisor_arn,
925
+ :iam_role_arn,
926
+ :vmware_to_aws_tag_mappings)
927
+ SENSITIVE = []
928
+ include Aws::Structure
929
+ end
930
+
931
+ # @!attribute [rw] hypervisor_arn
932
+ # The Amazon Resource Name (ARN) of the hypervisor.
933
+ # @return [String]
588
934
  #
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
- # }
935
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutHypervisorPropertyMappingsOutput AWS API Documentation
596
936
  #
937
+ class PutHypervisorPropertyMappingsOutput < Struct.new(
938
+ :hypervisor_arn)
939
+ SENSITIVE = []
940
+ include Aws::Structure
941
+ end
942
+
597
943
  # @!attribute [rw] day_of_month
598
944
  # The day of the month start maintenance on a gateway.
599
945
  #
@@ -660,25 +1006,41 @@ module Aws::BackupGateway
660
1006
  include Aws::Structure
661
1007
  end
662
1008
 
1009
+ # @!attribute [rw] hypervisor_arn
1010
+ # The Amazon Resource Name (ARN) of the hypervisor.
1011
+ # @return [String]
1012
+ #
1013
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSyncInput AWS API Documentation
1014
+ #
1015
+ class StartVirtualMachinesMetadataSyncInput < Struct.new(
1016
+ :hypervisor_arn)
1017
+ SENSITIVE = []
1018
+ include Aws::Structure
1019
+ end
1020
+
1021
+ # @!attribute [rw] hypervisor_arn
1022
+ # The Amazon Resource Name (ARN) of the hypervisor.
1023
+ # @return [String]
1024
+ #
1025
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSyncOutput AWS API Documentation
1026
+ #
1027
+ class StartVirtualMachinesMetadataSyncOutput < Struct.new(
1028
+ :hypervisor_arn)
1029
+ SENSITIVE = []
1030
+ include Aws::Structure
1031
+ end
1032
+
663
1033
  # A key-value pair you can use to manage, filter, and search for your
664
1034
  # resources. Allowed characters include UTF-8 letters, numbers, spaces,
665
1035
  # and the following characters: + - = . \_ : /.
666
1036
  #
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
1037
  # @!attribute [rw] key
676
1038
  # The key part of a tag's key-value pair. The key can't start with
677
1039
  # `aws:`.
678
1040
  # @return [String]
679
1041
  #
680
1042
  # @!attribute [rw] value
681
- # The key part of a value's key-value pair.
1043
+ # The value part of a tag's key-value pair.
682
1044
  # @return [String]
683
1045
  #
684
1046
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/Tag AWS API Documentation
@@ -690,19 +1052,6 @@ module Aws::BackupGateway
690
1052
  include Aws::Structure
691
1053
  end
692
1054
 
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
1055
  # @!attribute [rw] resource_arn
707
1056
  # The Amazon Resource Name (ARN) of the resource to tag.
708
1057
  # @return [String]
@@ -732,16 +1081,6 @@ module Aws::BackupGateway
732
1081
  include Aws::Structure
733
1082
  end
734
1083
 
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
1084
  # @!attribute [rw] gateway_arn
746
1085
  # The Amazon Resource Name (ARN) of the gateway to the hypervisor to
747
1086
  # test.
@@ -775,14 +1114,26 @@ module Aws::BackupGateway
775
1114
  #
776
1115
  class TestHypervisorConfigurationOutput < Aws::EmptyStructure; end
777
1116
 
778
- # @note When making an API call, you may pass UntagResourceInput
779
- # data as a hash:
1117
+ # TPS has been limited to protect against intentional or unintentional
1118
+ # high request volumes.
1119
+ #
1120
+ # @!attribute [rw] error_code
1121
+ # Error: TPS has been limited to protect against intentional or
1122
+ # unintentional high request volumes.
1123
+ # @return [String]
780
1124
  #
781
- # {
782
- # resource_arn: "ResourceArn", # required
783
- # tag_keys: ["TagKey"], # required
784
- # }
1125
+ # @!attribute [rw] message
1126
+ # @return [String]
785
1127
  #
1128
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/ThrottlingException AWS API Documentation
1129
+ #
1130
+ class ThrottlingException < Struct.new(
1131
+ :error_code,
1132
+ :message)
1133
+ SENSITIVE = []
1134
+ include Aws::Structure
1135
+ end
1136
+
786
1137
  # @!attribute [rw] resource_arn
787
1138
  # The Amazon Resource Name (ARN) of the resource from which to remove
788
1139
  # tags.
@@ -814,14 +1165,6 @@ module Aws::BackupGateway
814
1165
  include Aws::Structure
815
1166
  end
816
1167
 
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
1168
  # @!attribute [rw] gateway_arn
826
1169
  # The Amazon Resource Name (ARN) of the gateway to update.
827
1170
  # @return [String]
@@ -851,16 +1194,30 @@ module Aws::BackupGateway
851
1194
  include Aws::Structure
852
1195
  end
853
1196
 
854
- # @note When making an API call, you may pass UpdateHypervisorInput
855
- # data as a hash:
1197
+ # @!attribute [rw] gateway_arn
1198
+ # The Amazon Resource Name (ARN) of the gateway to be updated.
1199
+ # @return [String]
1200
+ #
1201
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateGatewaySoftwareNowInput AWS API Documentation
1202
+ #
1203
+ class UpdateGatewaySoftwareNowInput < Struct.new(
1204
+ :gateway_arn)
1205
+ SENSITIVE = []
1206
+ include Aws::Structure
1207
+ end
1208
+
1209
+ # @!attribute [rw] gateway_arn
1210
+ # The Amazon Resource Name (ARN) of the gateway you updated.
1211
+ # @return [String]
856
1212
  #
857
- # {
858
- # host: "Host",
859
- # hypervisor_arn: "ServerArn", # required
860
- # password: "Password",
861
- # username: "Username",
862
- # }
1213
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateGatewaySoftwareNowOutput AWS API Documentation
863
1214
  #
1215
+ class UpdateGatewaySoftwareNowOutput < Struct.new(
1216
+ :gateway_arn)
1217
+ SENSITIVE = []
1218
+ include Aws::Structure
1219
+ end
1220
+
864
1221
  # @!attribute [rw] host
865
1222
  # The updated host of the hypervisor. This can be either an IP address
866
1223
  # or a fully-qualified domain name (FQDN).
@@ -870,6 +1227,15 @@ module Aws::BackupGateway
870
1227
  # The Amazon Resource Name (ARN) of the hypervisor to update.
871
1228
  # @return [String]
872
1229
  #
1230
+ # @!attribute [rw] log_group_arn
1231
+ # The Amazon Resource Name (ARN) of the group of gateways within the
1232
+ # requested log.
1233
+ # @return [String]
1234
+ #
1235
+ # @!attribute [rw] name
1236
+ # The updated name for the hypervisor
1237
+ # @return [String]
1238
+ #
873
1239
  # @!attribute [rw] password
874
1240
  # The updated password for the hypervisor.
875
1241
  # @return [String]
@@ -883,6 +1249,8 @@ module Aws::BackupGateway
883
1249
  class UpdateHypervisorInput < Struct.new(
884
1250
  :host,
885
1251
  :hypervisor_arn,
1252
+ :log_group_arn,
1253
+ :name,
886
1254
  :password,
887
1255
  :username)
888
1256
  SENSITIVE = [:password, :username]
@@ -943,7 +1311,8 @@ module Aws::BackupGateway
943
1311
  # @return [String]
944
1312
  #
945
1313
  # @!attribute [rw] resource_arn
946
- # The Amazon Resource Name (ARN) of the virtual machine.
1314
+ # The Amazon Resource Name (ARN) of the virtual machine. For example,
1315
+ # `arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL`.
947
1316
  # @return [String]
948
1317
  #
949
1318
  # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/VirtualMachine AWS API Documentation
@@ -959,5 +1328,115 @@ module Aws::BackupGateway
959
1328
  include Aws::Structure
960
1329
  end
961
1330
 
1331
+ # Your `VirtualMachine` objects, ordered by their Amazon Resource Names
1332
+ # (ARNs).
1333
+ #
1334
+ # @!attribute [rw] host_name
1335
+ # The host name of the virtual machine.
1336
+ # @return [String]
1337
+ #
1338
+ # @!attribute [rw] hypervisor_id
1339
+ # The ID of the virtual machine's hypervisor.
1340
+ # @return [String]
1341
+ #
1342
+ # @!attribute [rw] last_backup_date
1343
+ # The most recent date a virtual machine was backed up, in Unix format
1344
+ # and UTC time.
1345
+ # @return [Time]
1346
+ #
1347
+ # @!attribute [rw] name
1348
+ # The name of the virtual machine.
1349
+ # @return [String]
1350
+ #
1351
+ # @!attribute [rw] path
1352
+ # The path of the virtual machine.
1353
+ # @return [String]
1354
+ #
1355
+ # @!attribute [rw] resource_arn
1356
+ # The Amazon Resource Name (ARN) of the virtual machine. For example,
1357
+ # `arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL`.
1358
+ # @return [String]
1359
+ #
1360
+ # @!attribute [rw] vmware_tags
1361
+ # These are the details of the VMware tags associated with the
1362
+ # specified virtual machine.
1363
+ # @return [Array<Types::VmwareTag>]
1364
+ #
1365
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/VirtualMachineDetails AWS API Documentation
1366
+ #
1367
+ class VirtualMachineDetails < Struct.new(
1368
+ :host_name,
1369
+ :hypervisor_id,
1370
+ :last_backup_date,
1371
+ :name,
1372
+ :path,
1373
+ :resource_arn,
1374
+ :vmware_tags)
1375
+ SENSITIVE = []
1376
+ include Aws::Structure
1377
+ end
1378
+
1379
+ # A VMware tag is a tag attached to a specific virtual machine. A
1380
+ # [tag][1] is a key-value pair you can use to manage, filter, and search
1381
+ # for your resources.
1382
+ #
1383
+ # The content of VMware tags can be matched to Amazon Web Services tags.
1384
+ #
1385
+ #
1386
+ #
1387
+ # [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_Tag.html
1388
+ #
1389
+ # @!attribute [rw] vmware_category
1390
+ # The is the category of VMware.
1391
+ # @return [String]
1392
+ #
1393
+ # @!attribute [rw] vmware_tag_description
1394
+ # This is a user-defined description of a VMware tag.
1395
+ # @return [String]
1396
+ #
1397
+ # @!attribute [rw] vmware_tag_name
1398
+ # This is the user-defined name of a VMware tag.
1399
+ # @return [String]
1400
+ #
1401
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/VmwareTag AWS API Documentation
1402
+ #
1403
+ class VmwareTag < Struct.new(
1404
+ :vmware_category,
1405
+ :vmware_tag_description,
1406
+ :vmware_tag_name)
1407
+ SENSITIVE = []
1408
+ include Aws::Structure
1409
+ end
1410
+
1411
+ # This displays the mapping of on-premises VMware tags to the
1412
+ # corresponding Amazon Web Services tags.
1413
+ #
1414
+ # @!attribute [rw] aws_tag_key
1415
+ # The key part of the Amazon Web Services tag's key-value pair.
1416
+ # @return [String]
1417
+ #
1418
+ # @!attribute [rw] aws_tag_value
1419
+ # The value part of the Amazon Web Services tag's key-value pair.
1420
+ # @return [String]
1421
+ #
1422
+ # @!attribute [rw] vmware_category
1423
+ # The is the category of VMware.
1424
+ # @return [String]
1425
+ #
1426
+ # @!attribute [rw] vmware_tag_name
1427
+ # This is the user-defined name of a VMware tag.
1428
+ # @return [String]
1429
+ #
1430
+ # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/VmwareToAwsTagMapping AWS API Documentation
1431
+ #
1432
+ class VmwareToAwsTagMapping < Struct.new(
1433
+ :aws_tag_key,
1434
+ :aws_tag_value,
1435
+ :vmware_category,
1436
+ :vmware_tag_name)
1437
+ SENSITIVE = []
1438
+ include Aws::Structure
1439
+ end
1440
+
962
1441
  end
963
1442
  end