aws-sdk-backupgateway 1.5.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 721bd3ad6d15ed76b7bcd3bee66970aba8b959baf5fd9df735e277dcd2ef65a6
-  data.tar.gz: 401cb059a7d268e56529aa7fda491e71bebd0fba605c1750127fec4f83d72909
+  metadata.gz: 0a33cff8589a66fa385fd8350ddf5ee151b1ae1fa8748edf9acb7fa3b7596733
+  data.tar.gz: 317217c14f8080bbac7b2f8fcfa3eb6d54f57a398a9509a5d9de4228ee9921c7
 SHA512:
-  metadata.gz: 7d86c6a9b55e1fd8722c93e4c4d9db31e297c5e2f00552e1a1cf681929896f1aac4add3470482e6f4bf01078336fdeeb7283f2fa5da2fcbd1612926f6203a2d4
-  data.tar.gz: 32787e682b2887d577d578fd1d1e89761cb92fa6efc154329a901afbe358627f5a2564c919d996b0d5f2155083e14f8e6ec353246196fd89ede32d007379a640
+  metadata.gz: eadcae087ea0145f77b68400faecc80d89bc7ef4bef5f302282d2b9ae52b88d870c546813fe7696235a04c140ae6cb30026a2356725c02823922670e37918ae0
+  data.tar.gz: ec48a8c76de448fedf7be8bd2084033c9b7bb487ae6fb48404b8ec93bc1c33c3e7e0d81c89b0532947c61f50259c044ff7703555e3ed554eb6c9493bec031002

data/CHANGELOG.md

@@ -1,6 +1,16 @@
 Unreleased Changes
 ------------------
 
+1.7.0 (2022-12-15)
+------------------
+
+* 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.
+
+1.6.0 (2022-10-25)
+------------------
+
+* Feature - Code Generated Changes, see `./build_tools` or `aws-sdk-core`'s CHANGELOG.md for details.
+
 1.5.0 (2022-09-22)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.5.0
+1.7.0

data/lib/aws-sdk-backupgateway/client.rb

@@ -30,7 +30,7 @@ require 'aws-sdk-core/plugins/http_checksum.rb'
 require 'aws-sdk-core/plugins/checksum_algorithm.rb'
 require 'aws-sdk-core/plugins/defaults_mode.rb'
 require 'aws-sdk-core/plugins/recursion_detection.rb'
-require 'aws-sdk-core/plugins/signature_v4.rb'
+require 'aws-sdk-core/plugins/sign.rb'
 require 'aws-sdk-core/plugins/protocols/json_rpc.rb'
 
 Aws::Plugins::GlobalConfiguration.add_identifier(:backupgateway)
@@ -79,8 +79,9 @@ module Aws::BackupGateway
     add_plugin(Aws::Plugins::ChecksumAlgorithm)
     add_plugin(Aws::Plugins::DefaultsMode)
     add_plugin(Aws::Plugins::RecursionDetection)
-    add_plugin(Aws::Plugins::SignatureV4)
+    add_plugin(Aws::Plugins::Sign)
     add_plugin(Aws::Plugins::Protocols::JsonRpc)
+    add_plugin(Aws::BackupGateway::Plugins::Endpoints)
 
     # @overload initialize(options)
     #   @param [Hash] options
@@ -297,6 +298,19 @@ module Aws::BackupGateway
     #     ** Please note ** When response stubbing is enabled, no HTTP
     #     requests are made, and retries are disabled.
     #
+    #   @option options [Aws::TokenProvider] :token_provider
+    #     A Bearer Token Provider. This can be an instance of any one of the
+    #     following classes:
+    #
+    #     * `Aws::StaticTokenProvider` - Used for configuring static, non-refreshing
+    #       tokens.
+    #
+    #     * `Aws::SSOTokenProvider` - Used for loading tokens from AWS SSO using an
+    #       access token generated from `aws login`.
+    #
+    #     When `:token_provider` is not configured directly, the `Aws::TokenProviderChain`
+    #     will be used to search for tokens configured for your profile in shared configuration files.
+    #
     #   @option options [Boolean] :use_dualstack_endpoint
     #     When set to `true`, dualstack enabled endpoints (with `.aws` TLD)
     #     will be used if available.
@@ -310,6 +324,9 @@ module Aws::BackupGateway
     #     When `true`, request parameters are validated before
     #     sending the request.
     #
+    #   @option options [Aws::BackupGateway::EndpointProvider] :endpoint_provider
+    #     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`
+    #
     #   @option options [URI::HTTP,String] :http_proxy A proxy to send
     #     requests through.  Formatted like 'http://proxy.com:123'.
     #
@@ -532,6 +549,52 @@ module Aws::BackupGateway
       req.send_request(options)
     end
 
+    # Retrieves the bandwidth rate limit schedule for a specified gateway.
+    # By default, gateways do not have bandwidth rate limit schedules, which
+    # means no bandwidth rate limiting is in effect. Use this to get a
+    # gateway's bandwidth rate limit schedule.
+    #
+    # @option params [required, String] :gateway_arn
+    #   The Amazon Resource Name (ARN) of the gateway. Use the [
+    #   `ListGateways` ][1] operation to return a list of gateways for your
+    #   account and Amazon Web Services Region.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
+    #
+    # @return [Types::GetBandwidthRateLimitScheduleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetBandwidthRateLimitScheduleOutput#bandwidth_rate_limit_intervals #bandwidth_rate_limit_intervals} => Array<Types::BandwidthRateLimitInterval>
+    #   * {Types::GetBandwidthRateLimitScheduleOutput#gateway_arn #gateway_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_bandwidth_rate_limit_schedule({
+    #     gateway_arn: "GatewayArn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.bandwidth_rate_limit_intervals #=> Array
+    #   resp.bandwidth_rate_limit_intervals[0].average_upload_rate_limit_in_bits_per_sec #=> Integer
+    #   resp.bandwidth_rate_limit_intervals[0].days_of_week #=> Array
+    #   resp.bandwidth_rate_limit_intervals[0].days_of_week[0] #=> Integer
+    #   resp.bandwidth_rate_limit_intervals[0].end_hour_of_day #=> Integer
+    #   resp.bandwidth_rate_limit_intervals[0].end_minute_of_hour #=> Integer
+    #   resp.bandwidth_rate_limit_intervals[0].start_hour_of_day #=> Integer
+    #   resp.bandwidth_rate_limit_intervals[0].start_minute_of_hour #=> Integer
+    #   resp.gateway_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetBandwidthRateLimitSchedule AWS API Documentation
+    #
+    # @overload get_bandwidth_rate_limit_schedule(params = {})
+    # @param [Hash] params ({})
+    def get_bandwidth_rate_limit_schedule(params = {}, options = {})
+      req = build_request(:get_bandwidth_rate_limit_schedule, params)
+      req.send_request(options)
+    end
+
     # By providing the ARN (Amazon Resource Name), this API returns the
     # gateway.
     #
@@ -571,6 +634,84 @@ module Aws::BackupGateway
       req.send_request(options)
     end
 
+    # This action requests information about the specified hypervisor to
+    # which the gateway will connect. A hypervisor is hardware, software, or
+    # firmware that creates and manages virtual machines, and allocates
+    # resources to them.
+    #
+    # @option params [required, String] :hypervisor_arn
+    #   The Amazon Resource Name (ARN) of the hypervisor.
+    #
+    # @return [Types::GetHypervisorOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetHypervisorOutput#hypervisor #hypervisor} => Types::HypervisorDetails
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_hypervisor({
+    #     hypervisor_arn: "ServerArn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.hypervisor.host #=> String
+    #   resp.hypervisor.hypervisor_arn #=> String
+    #   resp.hypervisor.kms_key_arn #=> String
+    #   resp.hypervisor.last_successful_metadata_sync_time #=> Time
+    #   resp.hypervisor.latest_metadata_sync_status #=> String, one of "CREATED", "RUNNING", "FAILED", "PARTIALLY_FAILED", "SUCCEEDED"
+    #   resp.hypervisor.latest_metadata_sync_status_message #=> String
+    #   resp.hypervisor.log_group_arn #=> String
+    #   resp.hypervisor.name #=> String
+    #   resp.hypervisor.state #=> String, one of "PENDING", "ONLINE", "OFFLINE", "ERROR"
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisor AWS API Documentation
+    #
+    # @overload get_hypervisor(params = {})
+    # @param [Hash] params ({})
+    def get_hypervisor(params = {}, options = {})
+      req = build_request(:get_hypervisor, params)
+      req.send_request(options)
+    end
+
+    # This action retrieves the property mappings for the specified
+    # hypervisor. A hypervisor property mapping displays the relationship of
+    # entity properties available from the on-premises hypervisor to the
+    # properties available in Amazon Web Services.
+    #
+    # @option params [required, String] :hypervisor_arn
+    #   The Amazon Resource Name (ARN) of the hypervisor.
+    #
+    # @return [Types::GetHypervisorPropertyMappingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetHypervisorPropertyMappingsOutput#hypervisor_arn #hypervisor_arn} => String
+    #   * {Types::GetHypervisorPropertyMappingsOutput#iam_role_arn #iam_role_arn} => String
+    #   * {Types::GetHypervisorPropertyMappingsOutput#vmware_to_aws_tag_mappings #vmware_to_aws_tag_mappings} => Array<Types::VmwareToAwsTagMapping>
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_hypervisor_property_mappings({
+    #     hypervisor_arn: "ServerArn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.hypervisor_arn #=> String
+    #   resp.iam_role_arn #=> String
+    #   resp.vmware_to_aws_tag_mappings #=> Array
+    #   resp.vmware_to_aws_tag_mappings[0].aws_tag_key #=> String
+    #   resp.vmware_to_aws_tag_mappings[0].aws_tag_value #=> String
+    #   resp.vmware_to_aws_tag_mappings[0].vmware_category #=> String
+    #   resp.vmware_to_aws_tag_mappings[0].vmware_tag_name #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetHypervisorPropertyMappings AWS API Documentation
+    #
+    # @overload get_hypervisor_property_mappings(params = {})
+    # @param [Hash] params ({})
+    def get_hypervisor_property_mappings(params = {}, options = {})
+      req = build_request(:get_hypervisor_property_mappings, params)
+      req.send_request(options)
+    end
+
     # By providing the ARN (Amazon Resource Name), this API returns the
     # virtual machine.
     #
@@ -595,6 +736,10 @@ module Aws::BackupGateway
     #   resp.virtual_machine.name #=> String
     #   resp.virtual_machine.path #=> String
     #   resp.virtual_machine.resource_arn #=> String
+    #   resp.virtual_machine.vmware_tags #=> Array
+    #   resp.virtual_machine.vmware_tags[0].vmware_category #=> String
+    #   resp.virtual_machine.vmware_tags[0].vmware_tag_description #=> String
+    #   resp.virtual_machine.vmware_tags[0].vmware_tag_name #=> String
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetVirtualMachine AWS API Documentation
     #
@@ -832,6 +977,105 @@ module Aws::BackupGateway
       req.send_request(options)
     end
 
+    # This action sets the bandwidth rate limit schedule for a specified
+    # gateway. By default, gateways do not have a bandwidth rate limit
+    # schedule, which means no bandwidth rate limiting is in effect. Use
+    # this to initiate a gateway's bandwidth rate limit schedule.
+    #
+    # @option params [required, Array<Types::BandwidthRateLimitInterval>] :bandwidth_rate_limit_intervals
+    #   An array containing bandwidth rate limit schedule intervals for a
+    #   gateway. When no bandwidth rate limit intervals have been scheduled,
+    #   the array is empty.
+    #
+    # @option params [required, String] :gateway_arn
+    #   The Amazon Resource Name (ARN) of the gateway. Use the [
+    #   `ListGateways` ][1] operation to return a list of gateways for your
+    #   account and Amazon Web Services Region.
+    #
+    #
+    #
+    #   [1]: https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BGW_ListGateways.html
+    #
+    # @return [Types::PutBandwidthRateLimitScheduleOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::PutBandwidthRateLimitScheduleOutput#gateway_arn #gateway_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.put_bandwidth_rate_limit_schedule({
+    #     bandwidth_rate_limit_intervals: [ # required
+    #       {
+    #         average_upload_rate_limit_in_bits_per_sec: 1,
+    #         days_of_week: [1], # required
+    #         end_hour_of_day: 1, # required
+    #         end_minute_of_hour: 1, # required
+    #         start_hour_of_day: 1, # required
+    #         start_minute_of_hour: 1, # required
+    #       },
+    #     ],
+    #     gateway_arn: "GatewayArn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.gateway_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutBandwidthRateLimitSchedule AWS API Documentation
+    #
+    # @overload put_bandwidth_rate_limit_schedule(params = {})
+    # @param [Hash] params ({})
+    def put_bandwidth_rate_limit_schedule(params = {}, options = {})
+      req = build_request(:put_bandwidth_rate_limit_schedule, params)
+      req.send_request(options)
+    end
+
+    # This action sets the property mappings for the specified hypervisor. A
+    # hypervisor property mapping displays the relationship of entity
+    # properties available from the on-premises hypervisor to the properties
+    # available in Amazon Web Services.
+    #
+    # @option params [required, String] :hypervisor_arn
+    #   The Amazon Resource Name (ARN) of the hypervisor.
+    #
+    # @option params [required, String] :iam_role_arn
+    #   The Amazon Resource Name (ARN) of the IAM role.
+    #
+    # @option params [required, Array<Types::VmwareToAwsTagMapping>] :vmware_to_aws_tag_mappings
+    #   This action requests the mappings of on-premises VMware tags to the
+    #   Amazon Web Services tags.
+    #
+    # @return [Types::PutHypervisorPropertyMappingsOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::PutHypervisorPropertyMappingsOutput#hypervisor_arn #hypervisor_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.put_hypervisor_property_mappings({
+    #     hypervisor_arn: "ServerArn", # required
+    #     iam_role_arn: "IamRoleArn", # required
+    #     vmware_to_aws_tag_mappings: [ # required
+    #       {
+    #         aws_tag_key: "TagKey", # required
+    #         aws_tag_value: "TagValue", # required
+    #         vmware_category: "VmwareCategory", # required
+    #         vmware_tag_name: "VmwareTagName", # required
+    #       },
+    #     ],
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.hypervisor_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/PutHypervisorPropertyMappings AWS API Documentation
+    #
+    # @overload put_hypervisor_property_mappings(params = {})
+    # @param [Hash] params ({})
+    def put_hypervisor_property_mappings(params = {}, options = {})
+      req = build_request(:put_hypervisor_property_mappings, params)
+      req.send_request(options)
+    end
+
     # Set the maintenance start time for a gateway.
     #
     # @option params [Integer] :day_of_month
@@ -879,6 +1123,35 @@ module Aws::BackupGateway
       req.send_request(options)
     end
 
+    # This action sends a request to sync metadata across the specified
+    # virtual machines.
+    #
+    # @option params [required, String] :hypervisor_arn
+    #   The Amazon Resource Name (ARN) of the hypervisor.
+    #
+    # @return [Types::StartVirtualMachinesMetadataSyncOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::StartVirtualMachinesMetadataSyncOutput#hypervisor_arn #hypervisor_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.start_virtual_machines_metadata_sync({
+    #     hypervisor_arn: "ServerArn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.hypervisor_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/StartVirtualMachinesMetadataSync AWS API Documentation
+    #
+    # @overload start_virtual_machines_metadata_sync(params = {})
+    # @param [Hash] params ({})
+    def start_virtual_machines_metadata_sync(params = {}, options = {})
+      req = build_request(:start_virtual_machines_metadata_sync, params)
+      req.send_request(options)
+    end
+
     # Tag the resource.
     #
     # @option params [required, String] :resource_arn
@@ -1065,6 +1338,10 @@ module Aws::BackupGateway
     # @option params [required, String] :hypervisor_arn
     #   The Amazon Resource Name (ARN) of the hypervisor to update.
     #
+    # @option params [String] :log_group_arn
+    #   The Amazon Resource Name (ARN) of the group of gateways within the
+    #   requested log.
+    #
     # @option params [String] :name
     #   The updated name for the hypervisor
     #
@@ -1083,6 +1360,7 @@ module Aws::BackupGateway
     #   resp = client.update_hypervisor({
     #     host: "Host",
     #     hypervisor_arn: "ServerArn", # required
+    #     log_group_arn: "LogGroupArn",
     #     name: "Name",
     #     password: "Password",
     #     username: "Username",
@@ -1114,7 +1392,7 @@ module Aws::BackupGateway
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-backupgateway'
-      context[:gem_version] = '1.5.0'
+      context[:gem_version] = '1.7.0'
       Seahorse::Client::Request.new(handlers, context)
     end