aws-sdk-backupgateway 1.0.0 → 1.15.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.
- checksums.yaml +4 -4
- data/CHANGELOG.md +77 -0
- data/VERSION +1 -1
- data/lib/aws-sdk-backupgateway/client.rb +432 -4
- data/lib/aws-sdk-backupgateway/client_api.rb +297 -0
- data/lib/aws-sdk-backupgateway/endpoint_parameters.rb +66 -0
- data/lib/aws-sdk-backupgateway/endpoint_provider.rb +54 -0
- data/lib/aws-sdk-backupgateway/endpoints.rb +366 -0
- data/lib/aws-sdk-backupgateway/errors.rb +21 -0
- data/lib/aws-sdk-backupgateway/plugins/endpoints.rb +118 -0
- data/lib/aws-sdk-backupgateway/types.rb +632 -153
- data/lib/aws-sdk-backupgateway.rb +5 -1
- metadata +8 -4
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e6ecde6c1933af5ac117017950139b12c2753f1595a8e60b1f1d0c0ebfeaae27
|
4
|
+
data.tar.gz: 0c8721d4e6e4960bfaf5bd2f5d25cbeac377fcac161dd45fb246f3da940c154f
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c4b268d4fe39e66ef1258b9afff0db10ba3593a2c00fda96c0e31d1f91d4769f3bfbf07cd7f7084adfd621c3f719cb049e5fa171475fbf44010bee65714ef982
|
7
|
+
data.tar.gz: 60c59d69dc0011348a88d0575c71da59a8553cee689ad0a2787a35b626f3a5eb289c2071357c45627c818aa90819d013a4ec7c689016e42cba27543cb3825a78
|
data/CHANGELOG.md
CHANGED
@@ -1,6 +1,83 @@
|
|
1
1
|
Unreleased Changes
|
2
2
|
------------------
|
3
3
|
|
4
|
+
1.15.0 (2023-09-27)
|
5
|
+
------------------
|
6
|
+
|
7
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
8
|
+
|
9
|
+
1.14.0 (2023-09-19)
|
10
|
+
------------------
|
11
|
+
|
12
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
13
|
+
|
14
|
+
1.13.0 (2023-07-11)
|
15
|
+
------------------
|
16
|
+
|
17
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
18
|
+
|
19
|
+
1.12.0 (2023-07-06)
|
20
|
+
------------------
|
21
|
+
|
22
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
23
|
+
|
24
|
+
1.11.0 (2023-06-28)
|
25
|
+
------------------
|
26
|
+
|
27
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
28
|
+
|
29
|
+
1.10.0 (2023-06-15)
|
30
|
+
------------------
|
31
|
+
|
32
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
33
|
+
|
34
|
+
1.9.0 (2023-05-31)
|
35
|
+
------------------
|
36
|
+
|
37
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
38
|
+
|
39
|
+
1.8.0 (2023-01-18)
|
40
|
+
------------------
|
41
|
+
|
42
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
43
|
+
|
44
|
+
* Issue - Replace runtime endpoint resolution approach with generated ruby code.
|
45
|
+
|
46
|
+
1.7.0 (2022-12-15)
|
47
|
+
------------------
|
48
|
+
|
49
|
+
* Feature - This release adds support for VMware vSphere tags, enabling customer to protect VMware virtual machines using tag-based policies for AWS tags mapped from vSphere tags. This release also adds support for customer-accessible gateway-hypervisor interaction log and upload bandwidth rate limit schedule.
|
50
|
+
|
51
|
+
1.6.0 (2022-10-25)
|
52
|
+
------------------
|
53
|
+
|
54
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
55
|
+
|
56
|
+
1.5.0 (2022-09-22)
|
57
|
+
------------------
|
58
|
+
|
59
|
+
* Feature - Changes include: new GetVirtualMachineApi to fetch a single user's VM, improving ListVirtualMachines to fetch filtered VMs as well as all VMs, and improving GetGatewayApi to now also return the gateway's MaintenanceStartTime.
|
60
|
+
|
61
|
+
1.4.0 (2022-06-01)
|
62
|
+
------------------
|
63
|
+
|
64
|
+
* Feature - Adds GetGateway and UpdateGatewaySoftwareNow API and adds hypervisor name to UpdateHypervisor API
|
65
|
+
|
66
|
+
1.3.0 (2022-02-24)
|
67
|
+
------------------
|
68
|
+
|
69
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
70
|
+
|
71
|
+
1.2.0 (2022-02-03)
|
72
|
+
------------------
|
73
|
+
|
74
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
75
|
+
|
76
|
+
1.1.0 (2021-12-21)
|
77
|
+
------------------
|
78
|
+
|
79
|
+
* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
|
80
|
+
|
4
81
|
1.0.0 (2021-11-30)
|
5
82
|
------------------
|
6
83
|
|
data/VERSION
CHANGED
@@ -1 +1 @@
|
|
1
|
-
1.
|
1
|
+
1.15.0
|
@@ -27,7 +27,11 @@ require 'aws-sdk-core/plugins/client_metrics_plugin.rb'
|
|
27
27
|
require 'aws-sdk-core/plugins/client_metrics_send_plugin.rb'
|
28
28
|
require 'aws-sdk-core/plugins/transfer_encoding.rb'
|
29
29
|
require 'aws-sdk-core/plugins/http_checksum.rb'
|
30
|
-
require 'aws-sdk-core/plugins/
|
30
|
+
require 'aws-sdk-core/plugins/checksum_algorithm.rb'
|
31
|
+
require 'aws-sdk-core/plugins/request_compression.rb'
|
32
|
+
require 'aws-sdk-core/plugins/defaults_mode.rb'
|
33
|
+
require 'aws-sdk-core/plugins/recursion_detection.rb'
|
34
|
+
require 'aws-sdk-core/plugins/sign.rb'
|
31
35
|
require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
|
32
36
|
|
33
37
|
Aws::Plugins::GlobalConfiguration.add_identifier(:backupgateway)
|
@@ -73,8 +77,13 @@ module Aws::BackupGateway
|
|
73
77
|
add_plugin(Aws::Plugins::ClientMetricsSendPlugin)
|
74
78
|
add_plugin(Aws::Plugins::TransferEncoding)
|
75
79
|
add_plugin(Aws::Plugins::HttpChecksum)
|
76
|
-
add_plugin(Aws::Plugins::
|
80
|
+
add_plugin(Aws::Plugins::ChecksumAlgorithm)
|
81
|
+
add_plugin(Aws::Plugins::RequestCompression)
|
82
|
+
add_plugin(Aws::Plugins::DefaultsMode)
|
83
|
+
add_plugin(Aws::Plugins::RecursionDetection)
|
84
|
+
add_plugin(Aws::Plugins::Sign)
|
77
85
|
add_plugin(Aws::Plugins::Protocols::JsonRpc)
|
86
|
+
add_plugin(Aws::BackupGateway::Plugins::Endpoints)
|
78
87
|
|
79
88
|
# @overload initialize(options)
|
80
89
|
# @param [Hash] options
|
@@ -175,10 +184,18 @@ module Aws::BackupGateway
|
|
175
184
|
# Used only in `standard` and adaptive retry modes. Specifies whether to apply
|
176
185
|
# a clock skew correction and retry requests with skewed client clocks.
|
177
186
|
#
|
187
|
+
# @option options [String] :defaults_mode ("legacy")
|
188
|
+
# See {Aws::DefaultsModeConfiguration} for a list of the
|
189
|
+
# accepted modes and the configuration defaults that are included.
|
190
|
+
#
|
178
191
|
# @option options [Boolean] :disable_host_prefix_injection (false)
|
179
192
|
# Set to true to disable SDK automatically adding host prefix
|
180
193
|
# to default service endpoint when available.
|
181
194
|
#
|
195
|
+
# @option options [Boolean] :disable_request_compression (false)
|
196
|
+
# When set to 'true' the request body will not be compressed
|
197
|
+
# for supported operations.
|
198
|
+
#
|
182
199
|
# @option options [String] :endpoint
|
183
200
|
# The client endpoint is normally constructed from the `:region`
|
184
201
|
# option. You should only configure an `:endpoint` when connecting
|
@@ -199,6 +216,10 @@ module Aws::BackupGateway
|
|
199
216
|
# @option options [Boolean] :endpoint_discovery (false)
|
200
217
|
# When set to `true`, endpoint discovery will be enabled for operations when available.
|
201
218
|
#
|
219
|
+
# @option options [Boolean] :ignore_configured_endpoint_urls
|
220
|
+
# Setting to true disables use of endpoint URLs provided via environment
|
221
|
+
# variables and the shared configuration file.
|
222
|
+
#
|
202
223
|
# @option options [Aws::Log::Formatter] :log_formatter (Aws::Log::Formatter.default)
|
203
224
|
# The log formatter.
|
204
225
|
#
|
@@ -219,6 +240,11 @@ module Aws::BackupGateway
|
|
219
240
|
# Used when loading credentials from the shared credentials file
|
220
241
|
# at HOME/.aws/credentials. When not specified, 'default' is used.
|
221
242
|
#
|
243
|
+
# @option options [Integer] :request_min_compression_size_bytes (10240)
|
244
|
+
# The minimum size in bytes that triggers compression for request
|
245
|
+
# bodies. The value must be non-negative integer value between 0
|
246
|
+
# and 10485780 bytes inclusive.
|
247
|
+
#
|
222
248
|
# @option options [Proc] :retry_backoff
|
223
249
|
# A proc or lambda used for backoff. Defaults to 2**retries * retry_base_delay.
|
224
250
|
# This option is only used in the `legacy` retry mode.
|
@@ -264,6 +290,11 @@ module Aws::BackupGateway
|
|
264
290
|
# in the future.
|
265
291
|
#
|
266
292
|
#
|
293
|
+
# @option options [String] :sdk_ua_app_id
|
294
|
+
# A unique and opaque application ID that is appended to the
|
295
|
+
# User-Agent header as app/<sdk_ua_app_id>. It should have a
|
296
|
+
# maximum length of 50.
|
297
|
+
#
|
267
298
|
# @option options [String] :secret_access_key
|
268
299
|
#
|
269
300
|
# @option options [String] :session_token
|
@@ -287,6 +318,19 @@ module Aws::BackupGateway
|
|
287
318
|
# ** Please note ** When response stubbing is enabled, no HTTP
|
288
319
|
# requests are made, and retries are disabled.
|
289
320
|
#
|
321
|
+
# @option options [Aws::TokenProvider] :token_provider
|
322
|
+
# A Bearer Token Provider. This can be an instance of any one of the
|
323
|
+
# following classes:
|
324
|
+
#
|
325
|
+
# * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
|
326
|
+
# tokens.
|
327
|
+
#
|
328
|
+
# * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
|
329
|
+
# access token generated from `aws login`.
|
330
|
+
#
|
331
|
+
# When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
|
332
|
+
# will be used to search for tokens configured for your profile in shared configuration files.
|
333
|
+
#
|
290
334
|
# @option options [Boolean] :use_dualstack_endpoint
|
291
335
|
# When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
|
292
336
|
# will be used if available.
|
@@ -300,6 +344,9 @@ module Aws::BackupGateway
|
|
300
344
|
# When `true`, request parameters are validated before
|
301
345
|
# sending the request.
|
302
346
|
#
|
347
|
+
# @option options [Aws::BackupGateway::EndpointProvider] :endpoint_provider
|
348
|
+
# The endpoint provider used to resolve endpoints. Any object that responds to `#resolve_endpoint(parameters)` where `parameters` is a Struct similar to `Aws::BackupGateway::EndpointParameters`
|
349
|
+
#
|
303
350
|
# @option options [URI::HTTP,String] :http_proxy A proxy to send
|
304
351
|
# requests through. Formatted like 'http://proxy.com:123'.
|
305
352
|
#
|
@@ -307,7 +354,7 @@ module Aws::BackupGateway
|
|
307
354
|
# seconds to wait when opening a HTTP session before raising a
|
308
355
|
# `Timeout::Error`.
|
309
356
|
#
|
310
|
-
# @option options [
|
357
|
+
# @option options [Float] :http_read_timeout (60) The default
|
311
358
|
# number of seconds to wait for response data. This value can
|
312
359
|
# safely be set per-request on the session.
|
313
360
|
#
|
@@ -323,6 +370,9 @@ module Aws::BackupGateway
|
|
323
370
|
# disables this behaviour. This value can safely be set per
|
324
371
|
# request on the session.
|
325
372
|
#
|
373
|
+
# @option options [Float] :ssl_timeout (nil) Sets the SSL timeout
|
374
|
+
# in seconds.
|
375
|
+
#
|
326
376
|
# @option options [Boolean] :http_wire_trace (false) When `true`,
|
327
377
|
# HTTP debug output will be sent to the `:logger`.
|
328
378
|
#
|
@@ -519,6 +569,207 @@ module Aws::BackupGateway
|
|
519
569
|
req.send_request(options)
|
520
570
|
end
|
521
571
|
|
572
|
+
# Retrieves the bandwidth rate limit schedule for a specified gateway.
|
573
|
+
# By default, gateways do not have bandwidth rate limit schedules, which
|
574
|
+
# means no bandwidth rate limiting is in effect. Use this to get a
|
575
|
+
# gateway's bandwidth rate limit schedule.
|
576
|
+
#
|
577
|
+
# @option params [required, String] :gateway_arn
|
578
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the [
|
579
|
+
# `ListGateways` ][1] operation to return a list of gateways for your
|
580
|
+
# account and Amazon Web Services Region.
|
581
|
+
#
|
582
|
+
#
|
583
|
+
#
|
584
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
|
585
|
+
#
|
586
|
+
# @return [Types::GetBandwidthRateLimitScheduleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
587
|
+
#
|
588
|
+
# * {Types::GetBandwidthRateLimitScheduleOutput#bandwidth_rate_limit_intervals #bandwidth_rate_limit_intervals} => Array<Types::BandwidthRateLimitInterval>
|
589
|
+
# * {Types::GetBandwidthRateLimitScheduleOutput#gateway_arn #gateway_arn} => String
|
590
|
+
#
|
591
|
+
# @example Request syntax with placeholder values
|
592
|
+
#
|
593
|
+
# resp = client.get_bandwidth_rate_limit_schedule({
|
594
|
+
# gateway_arn: "GatewayArn", # required
|
595
|
+
# })
|
596
|
+
#
|
597
|
+
# @example Response structure
|
598
|
+
#
|
599
|
+
# resp.bandwidth_rate_limit_intervals #=> Array
|
600
|
+
# resp.bandwidth_rate_limit_intervals[0].average_upload_rate_limit_in_bits_per_sec #=> Integer
|
601
|
+
# resp.bandwidth_rate_limit_intervals[0].days_of_week #=> Array
|
602
|
+
# resp.bandwidth_rate_limit_intervals[0].days_of_week[0] #=> Integer
|
603
|
+
# resp.bandwidth_rate_limit_intervals[0].end_hour_of_day #=> Integer
|
604
|
+
# resp.bandwidth_rate_limit_intervals[0].end_minute_of_hour #=> Integer
|
605
|
+
# resp.bandwidth_rate_limit_intervals[0].start_hour_of_day #=> Integer
|
606
|
+
# resp.bandwidth_rate_limit_intervals[0].start_minute_of_hour #=> Integer
|
607
|
+
# resp.gateway_arn #=> String
|
608
|
+
#
|
609
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule AWS API Documentation
|
610
|
+
#
|
611
|
+
# @overload get_bandwidth_rate_limit_schedule(params = {})
|
612
|
+
# @param [Hash] params ({})
|
613
|
+
def get_bandwidth_rate_limit_schedule(params = {}, options = {})
|
614
|
+
req = build_request(:get_bandwidth_rate_limit_schedule, params)
|
615
|
+
req.send_request(options)
|
616
|
+
end
|
617
|
+
|
618
|
+
# By providing the ARN (Amazon Resource Name), this API returns the
|
619
|
+
# gateway.
|
620
|
+
#
|
621
|
+
# @option params [required, String] :gateway_arn
|
622
|
+
# The Amazon Resource Name (ARN) of the gateway.
|
623
|
+
#
|
624
|
+
# @return [Types::GetGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
625
|
+
#
|
626
|
+
# * {Types::GetGatewayOutput#gateway #gateway} => Types::GatewayDetails
|
627
|
+
#
|
628
|
+
# @example Request syntax with placeholder values
|
629
|
+
#
|
630
|
+
# resp = client.get_gateway({
|
631
|
+
# gateway_arn: "GatewayArn", # required
|
632
|
+
# })
|
633
|
+
#
|
634
|
+
# @example Response structure
|
635
|
+
#
|
636
|
+
# resp.gateway.gateway_arn #=> String
|
637
|
+
# resp.gateway.gateway_display_name #=> String
|
638
|
+
# resp.gateway.gateway_type #=> String, one of "BACKUP_VM"
|
639
|
+
# resp.gateway.hypervisor_id #=> String
|
640
|
+
# resp.gateway.last_seen_time #=> Time
|
641
|
+
# resp.gateway.maintenance_start_time.day_of_month #=> Integer
|
642
|
+
# resp.gateway.maintenance_start_time.day_of_week #=> Integer
|
643
|
+
# resp.gateway.maintenance_start_time.hour_of_day #=> Integer
|
644
|
+
# resp.gateway.maintenance_start_time.minute_of_hour #=> Integer
|
645
|
+
# resp.gateway.next_update_availability_time #=> Time
|
646
|
+
# resp.gateway.vpc_endpoint #=> String
|
647
|
+
#
|
648
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetGateway AWS API Documentation
|
649
|
+
#
|
650
|
+
# @overload get_gateway(params = {})
|
651
|
+
# @param [Hash] params ({})
|
652
|
+
def get_gateway(params = {}, options = {})
|
653
|
+
req = build_request(:get_gateway, params)
|
654
|
+
req.send_request(options)
|
655
|
+
end
|
656
|
+
|
657
|
+
# This action requests information about the specified hypervisor to
|
658
|
+
# which the gateway will connect. A hypervisor is hardware, software, or
|
659
|
+
# firmware that creates and manages virtual machines, and allocates
|
660
|
+
# resources to them.
|
661
|
+
#
|
662
|
+
# @option params [required, String] :hypervisor_arn
|
663
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
664
|
+
#
|
665
|
+
# @return [Types::GetHypervisorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
666
|
+
#
|
667
|
+
# * {Types::GetHypervisorOutput#hypervisor #hypervisor} => Types::HypervisorDetails
|
668
|
+
#
|
669
|
+
# @example Request syntax with placeholder values
|
670
|
+
#
|
671
|
+
# resp = client.get_hypervisor({
|
672
|
+
# hypervisor_arn: "ServerArn", # required
|
673
|
+
# })
|
674
|
+
#
|
675
|
+
# @example Response structure
|
676
|
+
#
|
677
|
+
# resp.hypervisor.host #=> String
|
678
|
+
# resp.hypervisor.hypervisor_arn #=> String
|
679
|
+
# resp.hypervisor.kms_key_arn #=> String
|
680
|
+
# resp.hypervisor.last_successful_metadata_sync_time #=> Time
|
681
|
+
# resp.hypervisor.latest_metadata_sync_status #=> String, one of "CREATED", "RUNNING", "FAILED", "PARTIALLY_FAILED", "SUCCEEDED"
|
682
|
+
# resp.hypervisor.latest_metadata_sync_status_message #=> String
|
683
|
+
# resp.hypervisor.log_group_arn #=> String
|
684
|
+
# resp.hypervisor.name #=> String
|
685
|
+
# resp.hypervisor.state #=> String, one of "PENDING", "ONLINE", "OFFLINE", "ERROR"
|
686
|
+
#
|
687
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisor AWS API Documentation
|
688
|
+
#
|
689
|
+
# @overload get_hypervisor(params = {})
|
690
|
+
# @param [Hash] params ({})
|
691
|
+
def get_hypervisor(params = {}, options = {})
|
692
|
+
req = build_request(:get_hypervisor, params)
|
693
|
+
req.send_request(options)
|
694
|
+
end
|
695
|
+
|
696
|
+
# This action retrieves the property mappings for the specified
|
697
|
+
# hypervisor. A hypervisor property mapping displays the relationship of
|
698
|
+
# entity properties available from the on-premises hypervisor to the
|
699
|
+
# properties available in Amazon Web Services.
|
700
|
+
#
|
701
|
+
# @option params [required, String] :hypervisor_arn
|
702
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
703
|
+
#
|
704
|
+
# @return [Types::GetHypervisorPropertyMappingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
705
|
+
#
|
706
|
+
# * {Types::GetHypervisorPropertyMappingsOutput#hypervisor_arn #hypervisor_arn} => String
|
707
|
+
# * {Types::GetHypervisorPropertyMappingsOutput#iam_role_arn #iam_role_arn} => String
|
708
|
+
# * {Types::GetHypervisorPropertyMappingsOutput#vmware_to_aws_tag_mappings #vmware_to_aws_tag_mappings} => Array<Types::VmwareToAwsTagMapping>
|
709
|
+
#
|
710
|
+
# @example Request syntax with placeholder values
|
711
|
+
#
|
712
|
+
# resp = client.get_hypervisor_property_mappings({
|
713
|
+
# hypervisor_arn: "ServerArn", # required
|
714
|
+
# })
|
715
|
+
#
|
716
|
+
# @example Response structure
|
717
|
+
#
|
718
|
+
# resp.hypervisor_arn #=> String
|
719
|
+
# resp.iam_role_arn #=> String
|
720
|
+
# resp.vmware_to_aws_tag_mappings #=> Array
|
721
|
+
# resp.vmware_to_aws_tag_mappings[0].aws_tag_key #=> String
|
722
|
+
# resp.vmware_to_aws_tag_mappings[0].aws_tag_value #=> String
|
723
|
+
# resp.vmware_to_aws_tag_mappings[0].vmware_category #=> String
|
724
|
+
# resp.vmware_to_aws_tag_mappings[0].vmware_tag_name #=> String
|
725
|
+
#
|
726
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisorPropertyMappings AWS API Documentation
|
727
|
+
#
|
728
|
+
# @overload get_hypervisor_property_mappings(params = {})
|
729
|
+
# @param [Hash] params ({})
|
730
|
+
def get_hypervisor_property_mappings(params = {}, options = {})
|
731
|
+
req = build_request(:get_hypervisor_property_mappings, params)
|
732
|
+
req.send_request(options)
|
733
|
+
end
|
734
|
+
|
735
|
+
# By providing the ARN (Amazon Resource Name), this API returns the
|
736
|
+
# virtual machine.
|
737
|
+
#
|
738
|
+
# @option params [required, String] :resource_arn
|
739
|
+
# The Amazon Resource Name (ARN) of the virtual machine.
|
740
|
+
#
|
741
|
+
# @return [Types::GetVirtualMachineOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
742
|
+
#
|
743
|
+
# * {Types::GetVirtualMachineOutput#virtual_machine #virtual_machine} => Types::VirtualMachineDetails
|
744
|
+
#
|
745
|
+
# @example Request syntax with placeholder values
|
746
|
+
#
|
747
|
+
# resp = client.get_virtual_machine({
|
748
|
+
# resource_arn: "ResourceArn", # required
|
749
|
+
# })
|
750
|
+
#
|
751
|
+
# @example Response structure
|
752
|
+
#
|
753
|
+
# resp.virtual_machine.host_name #=> String
|
754
|
+
# resp.virtual_machine.hypervisor_id #=> String
|
755
|
+
# resp.virtual_machine.last_backup_date #=> Time
|
756
|
+
# resp.virtual_machine.name #=> String
|
757
|
+
# resp.virtual_machine.path #=> String
|
758
|
+
# resp.virtual_machine.resource_arn #=> String
|
759
|
+
# resp.virtual_machine.vmware_tags #=> Array
|
760
|
+
# resp.virtual_machine.vmware_tags[0].vmware_category #=> String
|
761
|
+
# resp.virtual_machine.vmware_tags[0].vmware_tag_description #=> String
|
762
|
+
# resp.virtual_machine.vmware_tags[0].vmware_tag_name #=> String
|
763
|
+
#
|
764
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetVirtualMachine AWS API Documentation
|
765
|
+
#
|
766
|
+
# @overload get_virtual_machine(params = {})
|
767
|
+
# @param [Hash] params ({})
|
768
|
+
def get_virtual_machine(params = {}, options = {})
|
769
|
+
req = build_request(:get_virtual_machine, params)
|
770
|
+
req.send_request(options)
|
771
|
+
end
|
772
|
+
|
522
773
|
# Connect to a hypervisor by importing its configuration.
|
523
774
|
#
|
524
775
|
# @option params [required, String] :host
|
@@ -698,6 +949,10 @@ module Aws::BackupGateway
|
|
698
949
|
|
699
950
|
# Lists your virtual machines.
|
700
951
|
#
|
952
|
+
# @option params [String] :hypervisor_arn
|
953
|
+
# The Amazon Resource Name (ARN) of the hypervisor connected to your
|
954
|
+
# virtual machine.
|
955
|
+
#
|
701
956
|
# @option params [Integer] :max_results
|
702
957
|
# The maximum number of virtual machines to list.
|
703
958
|
#
|
@@ -717,6 +972,7 @@ module Aws::BackupGateway
|
|
717
972
|
# @example Request syntax with placeholder values
|
718
973
|
#
|
719
974
|
# resp = client.list_virtual_machines({
|
975
|
+
# hypervisor_arn: "ServerArn",
|
720
976
|
# max_results: 1,
|
721
977
|
# next_token: "NextToken",
|
722
978
|
# })
|
@@ -741,6 +997,105 @@ module Aws::BackupGateway
|
|
741
997
|
req.send_request(options)
|
742
998
|
end
|
743
999
|
|
1000
|
+
# This action sets the bandwidth rate limit schedule for a specified
|
1001
|
+
# gateway. By default, gateways do not have a bandwidth rate limit
|
1002
|
+
# schedule, which means no bandwidth rate limiting is in effect. Use
|
1003
|
+
# this to initiate a gateway's bandwidth rate limit schedule.
|
1004
|
+
#
|
1005
|
+
# @option params [required, Array<Types::BandwidthRateLimitInterval>] :bandwidth_rate_limit_intervals
|
1006
|
+
# An array containing bandwidth rate limit schedule intervals for a
|
1007
|
+
# gateway. When no bandwidth rate limit intervals have been scheduled,
|
1008
|
+
# the array is empty.
|
1009
|
+
#
|
1010
|
+
# @option params [required, String] :gateway_arn
|
1011
|
+
# The Amazon Resource Name (ARN) of the gateway. Use the [
|
1012
|
+
# `ListGateways` ][1] operation to return a list of gateways for your
|
1013
|
+
# account and Amazon Web Services Region.
|
1014
|
+
#
|
1015
|
+
#
|
1016
|
+
#
|
1017
|
+
# [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
|
1018
|
+
#
|
1019
|
+
# @return [Types::PutBandwidthRateLimitScheduleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1020
|
+
#
|
1021
|
+
# * {Types::PutBandwidthRateLimitScheduleOutput#gateway_arn #gateway_arn} => String
|
1022
|
+
#
|
1023
|
+
# @example Request syntax with placeholder values
|
1024
|
+
#
|
1025
|
+
# resp = client.put_bandwidth_rate_limit_schedule({
|
1026
|
+
# bandwidth_rate_limit_intervals: [ # required
|
1027
|
+
# {
|
1028
|
+
# average_upload_rate_limit_in_bits_per_sec: 1,
|
1029
|
+
# days_of_week: [1], # required
|
1030
|
+
# end_hour_of_day: 1, # required
|
1031
|
+
# end_minute_of_hour: 1, # required
|
1032
|
+
# start_hour_of_day: 1, # required
|
1033
|
+
# start_minute_of_hour: 1, # required
|
1034
|
+
# },
|
1035
|
+
# ],
|
1036
|
+
# gateway_arn: "GatewayArn", # required
|
1037
|
+
# })
|
1038
|
+
#
|
1039
|
+
# @example Response structure
|
1040
|
+
#
|
1041
|
+
# resp.gateway_arn #=> String
|
1042
|
+
#
|
1043
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule AWS API Documentation
|
1044
|
+
#
|
1045
|
+
# @overload put_bandwidth_rate_limit_schedule(params = {})
|
1046
|
+
# @param [Hash] params ({})
|
1047
|
+
def put_bandwidth_rate_limit_schedule(params = {}, options = {})
|
1048
|
+
req = build_request(:put_bandwidth_rate_limit_schedule, params)
|
1049
|
+
req.send_request(options)
|
1050
|
+
end
|
1051
|
+
|
1052
|
+
# This action sets the property mappings for the specified hypervisor. A
|
1053
|
+
# hypervisor property mapping displays the relationship of entity
|
1054
|
+
# properties available from the on-premises hypervisor to the properties
|
1055
|
+
# available in Amazon Web Services.
|
1056
|
+
#
|
1057
|
+
# @option params [required, String] :hypervisor_arn
|
1058
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
1059
|
+
#
|
1060
|
+
# @option params [required, String] :iam_role_arn
|
1061
|
+
# The Amazon Resource Name (ARN) of the IAM role.
|
1062
|
+
#
|
1063
|
+
# @option params [required, Array<Types::VmwareToAwsTagMapping>] :vmware_to_aws_tag_mappings
|
1064
|
+
# This action requests the mappings of on-premises VMware tags to the
|
1065
|
+
# Amazon Web Services tags.
|
1066
|
+
#
|
1067
|
+
# @return [Types::PutHypervisorPropertyMappingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1068
|
+
#
|
1069
|
+
# * {Types::PutHypervisorPropertyMappingsOutput#hypervisor_arn #hypervisor_arn} => String
|
1070
|
+
#
|
1071
|
+
# @example Request syntax with placeholder values
|
1072
|
+
#
|
1073
|
+
# resp = client.put_hypervisor_property_mappings({
|
1074
|
+
# hypervisor_arn: "ServerArn", # required
|
1075
|
+
# iam_role_arn: "IamRoleArn", # required
|
1076
|
+
# vmware_to_aws_tag_mappings: [ # required
|
1077
|
+
# {
|
1078
|
+
# aws_tag_key: "TagKey", # required
|
1079
|
+
# aws_tag_value: "TagValue", # required
|
1080
|
+
# vmware_category: "VmwareCategory", # required
|
1081
|
+
# vmware_tag_name: "VmwareTagName", # required
|
1082
|
+
# },
|
1083
|
+
# ],
|
1084
|
+
# })
|
1085
|
+
#
|
1086
|
+
# @example Response structure
|
1087
|
+
#
|
1088
|
+
# resp.hypervisor_arn #=> String
|
1089
|
+
#
|
1090
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutHypervisorPropertyMappings AWS API Documentation
|
1091
|
+
#
|
1092
|
+
# @overload put_hypervisor_property_mappings(params = {})
|
1093
|
+
# @param [Hash] params ({})
|
1094
|
+
def put_hypervisor_property_mappings(params = {}, options = {})
|
1095
|
+
req = build_request(:put_hypervisor_property_mappings, params)
|
1096
|
+
req.send_request(options)
|
1097
|
+
end
|
1098
|
+
|
744
1099
|
# Set the maintenance start time for a gateway.
|
745
1100
|
#
|
746
1101
|
# @option params [Integer] :day_of_month
|
@@ -788,6 +1143,35 @@ module Aws::BackupGateway
|
|
788
1143
|
req.send_request(options)
|
789
1144
|
end
|
790
1145
|
|
1146
|
+
# This action sends a request to sync metadata across the specified
|
1147
|
+
# virtual machines.
|
1148
|
+
#
|
1149
|
+
# @option params [required, String] :hypervisor_arn
|
1150
|
+
# The Amazon Resource Name (ARN) of the hypervisor.
|
1151
|
+
#
|
1152
|
+
# @return [Types::StartVirtualMachinesMetadataSyncOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1153
|
+
#
|
1154
|
+
# * {Types::StartVirtualMachinesMetadataSyncOutput#hypervisor_arn #hypervisor_arn} => String
|
1155
|
+
#
|
1156
|
+
# @example Request syntax with placeholder values
|
1157
|
+
#
|
1158
|
+
# resp = client.start_virtual_machines_metadata_sync({
|
1159
|
+
# hypervisor_arn: "ServerArn", # required
|
1160
|
+
# })
|
1161
|
+
#
|
1162
|
+
# @example Response structure
|
1163
|
+
#
|
1164
|
+
# resp.hypervisor_arn #=> String
|
1165
|
+
#
|
1166
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync AWS API Documentation
|
1167
|
+
#
|
1168
|
+
# @overload start_virtual_machines_metadata_sync(params = {})
|
1169
|
+
# @param [Hash] params ({})
|
1170
|
+
def start_virtual_machines_metadata_sync(params = {}, options = {})
|
1171
|
+
req = build_request(:start_virtual_machines_metadata_sync, params)
|
1172
|
+
req.send_request(options)
|
1173
|
+
end
|
1174
|
+
|
791
1175
|
# Tag the resource.
|
792
1176
|
#
|
793
1177
|
# @option params [required, String] :resource_arn
|
@@ -928,6 +1312,41 @@ module Aws::BackupGateway
|
|
928
1312
|
req.send_request(options)
|
929
1313
|
end
|
930
1314
|
|
1315
|
+
# Updates the gateway virtual machine (VM) software. The request
|
1316
|
+
# immediately triggers the software update.
|
1317
|
+
#
|
1318
|
+
# <note markdown="1"> When you make this request, you get a `200 OK` success response
|
1319
|
+
# immediately. However, it might take some time for the update to
|
1320
|
+
# complete.
|
1321
|
+
#
|
1322
|
+
# </note>
|
1323
|
+
#
|
1324
|
+
# @option params [required, String] :gateway_arn
|
1325
|
+
# The Amazon Resource Name (ARN) of the gateway to be updated.
|
1326
|
+
#
|
1327
|
+
# @return [Types::UpdateGatewaySoftwareNowOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
|
1328
|
+
#
|
1329
|
+
# * {Types::UpdateGatewaySoftwareNowOutput#gateway_arn #gateway_arn} => String
|
1330
|
+
#
|
1331
|
+
# @example Request syntax with placeholder values
|
1332
|
+
#
|
1333
|
+
# resp = client.update_gateway_software_now({
|
1334
|
+
# gateway_arn: "GatewayArn", # required
|
1335
|
+
# })
|
1336
|
+
#
|
1337
|
+
# @example Response structure
|
1338
|
+
#
|
1339
|
+
# resp.gateway_arn #=> String
|
1340
|
+
#
|
1341
|
+
# @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow AWS API Documentation
|
1342
|
+
#
|
1343
|
+
# @overload update_gateway_software_now(params = {})
|
1344
|
+
# @param [Hash] params ({})
|
1345
|
+
def update_gateway_software_now(params = {}, options = {})
|
1346
|
+
req = build_request(:update_gateway_software_now, params)
|
1347
|
+
req.send_request(options)
|
1348
|
+
end
|
1349
|
+
|
931
1350
|
# Updates a hypervisor metadata, including its host, username, and
|
932
1351
|
# password. Specify which hypervisor to update using the Amazon Resource
|
933
1352
|
# Name (ARN) of the hypervisor in your request.
|
@@ -939,6 +1358,13 @@ module Aws::BackupGateway
|
|
939
1358
|
# @option params [required, String] :hypervisor_arn
|
940
1359
|
# The Amazon Resource Name (ARN) of the hypervisor to update.
|
941
1360
|
#
|
1361
|
+
# @option params [String] :log_group_arn
|
1362
|
+
# The Amazon Resource Name (ARN) of the group of gateways within the
|
1363
|
+
# requested log.
|
1364
|
+
#
|
1365
|
+
# @option params [String] :name
|
1366
|
+
# The updated name for the hypervisor
|
1367
|
+
#
|
942
1368
|
# @option params [String] :password
|
943
1369
|
# The updated password for the hypervisor.
|
944
1370
|
#
|
@@ -954,6 +1380,8 @@ module Aws::BackupGateway
|
|
954
1380
|
# resp = client.update_hypervisor({
|
955
1381
|
# host: "Host",
|
956
1382
|
# hypervisor_arn: "ServerArn", # required
|
1383
|
+
# log_group_arn: "LogGroupArn",
|
1384
|
+
# name: "Name",
|
957
1385
|
# password: "Password",
|
958
1386
|
# username: "Username",
|
959
1387
|
# })
|
@@ -984,7 +1412,7 @@ module Aws::BackupGateway
|
|
984
1412
|
params: params,
|
985
1413
|
config: config)
|
986
1414
|
context[:gem_name] = 'aws-sdk-backupgateway'
|
987
|
-
context[:gem_version] = '1.
|
1415
|
+
context[:gem_version] = '1.15.0'
|
988
1416
|
Seahorse::Client::Request.new(handlers, context)
|
989
1417
|
end
|
990
1418
|
|