aws-sdk-backupgateway 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e0dd4a4e0418e3927f2c56d22f106efc6e3b90a233285de830054fe72e559cfc
-  data.tar.gz: d147dcdc944e59c44bb39e07f7054c30b3ba365eb3978df9e3c54008a5e9cd5f
+  metadata.gz: fb2ed7e0e3674332eb19e5ebd2f0b9cb68aeb05a016117ee8adfd833b925450d
+  data.tar.gz: '080046744cf9383207b9854bacd576fd02a28d05315808663e50e017848fe590'
 SHA512:
-  metadata.gz: acc3a79d9c55fdc4ec0d0b453724233de291f6c510aa175f788f7f35484244bbaacb3e2bb03714fd89e063138bae74c2193b41ea02e8b153e6a7f14df7d92600
-  data.tar.gz: ff1a32bc241b1da3121a8124198f0e43b1761e06cf928de6e2bc55185af0e5badbe2af6a279fad6497812623803533d1ec22a0d1c8a3da31530feba19e950042
+  metadata.gz: f19188617e218d484c2eadaf917827e8520fb3e925f518bc15fe1788dad1b6aa0d43a04484c3ac04b3541fef70708bb05a6f8651ba3926377b751e1db567aed0
+  data.tar.gz: f004dfdfcbdf3e0b0692392983191ab8b6035a9737ce7b57aef663918d9f67cf12c9bf198bc15f9dbeaecef28eccca3e70b443e2370087865b0c05c02602e66c

data/CHANGELOG.md

@@ -1,6 +1,11 @@
 Unreleased Changes
 ------------------
 
+1.4.0 (2022-06-01)
+------------------
+
+* Feature - Adds GetGateway and UpdateGatewaySoftwareNow API and adds hypervisor name to UpdateHypervisor API
+
 1.3.0 (2022-02-24)
 ------------------
 

data/VERSION

@@ -1 +1 @@
-1.3.0
+1.4.0

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

@@ -532,6 +532,41 @@ module Aws::BackupGateway
       req.send_request(options)
     end
 
+    # By providing the ARN (Amazon Resource Name), this API returns the
+    # gateway.
+    #
+    # @option params [required, String] :gateway_arn
+    #   The Amazon Resource Name (ARN) of the gateway.
+    #
+    # @return [Types::GetGatewayOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::GetGatewayOutput#gateway #gateway} => Types::GatewayDetails
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.get_gateway({
+    #     gateway_arn: "GatewayArn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.gateway.gateway_arn #=> String
+    #   resp.gateway.gateway_display_name #=> String
+    #   resp.gateway.gateway_type #=> String, one of "BACKUP_VM"
+    #   resp.gateway.hypervisor_id #=> String
+    #   resp.gateway.last_seen_time #=> Time
+    #   resp.gateway.next_update_availability_time #=> Time
+    #   resp.gateway.vpc_endpoint #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetGateway AWS API Documentation
+    #
+    # @overload get_gateway(params = {})
+    # @param [Hash] params ({})
+    def get_gateway(params = {}, options = {})
+      req = build_request(:get_gateway, params)
+      req.send_request(options)
+    end
+
     # Connect to a hypervisor by importing its configuration.
     #
     # @option params [required, String] :host
@@ -941,6 +976,41 @@ module Aws::BackupGateway
       req.send_request(options)
     end
 
+    # Updates the gateway virtual machine (VM) software. The request
+    # immediately triggers the software update.
+    #
+    # <note markdown="1"> When you make this request, you get a `200 OK` success response
+    # immediately. However, it might take some time for the update to
+    # complete.
+    #
+    #  </note>
+    #
+    # @option params [required, String] :gateway_arn
+    #   The Amazon Resource Name (ARN) of the gateway to be updated.
+    #
+    # @return [Types::UpdateGatewaySoftwareNowOutput] Returns a {Seahorse::Client::Response response} object which responds to the following methods:
+    #
+    #   * {Types::UpdateGatewaySoftwareNowOutput#gateway_arn #gateway_arn} => String
+    #
+    # @example Request syntax with placeholder values
+    #
+    #   resp = client.update_gateway_software_now({
+    #     gateway_arn: "GatewayArn", # required
+    #   })
+    #
+    # @example Response structure
+    #
+    #   resp.gateway_arn #=> String
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateGatewaySoftwareNow AWS API Documentation
+    #
+    # @overload update_gateway_software_now(params = {})
+    # @param [Hash] params ({})
+    def update_gateway_software_now(params = {}, options = {})
+      req = build_request(:update_gateway_software_now, params)
+      req.send_request(options)
+    end
+
     # Updates a hypervisor metadata, including its host, username, and
     # password. Specify which hypervisor to update using the Amazon Resource
     # Name (ARN) of the hypervisor in your request.
@@ -952,6 +1022,9 @@ module Aws::BackupGateway
     # @option params [required, String] :hypervisor_arn
     #   The Amazon Resource Name (ARN) of the hypervisor to update.
     #
+    # @option params [String] :name
+    #   The updated name for the hypervisor
+    #
     # @option params [String] :password
     #   The updated password for the hypervisor.
     #
@@ -967,6 +1040,7 @@ module Aws::BackupGateway
     #   resp = client.update_hypervisor({
     #     host: "Host",
     #     hypervisor_arn: "ServerArn", # required
+    #     name: "Name",
     #     password: "Password",
     #     username: "Username",
     #   })
@@ -997,7 +1071,7 @@ module Aws::BackupGateway
         params: params,
         config: config)
       context[:gem_name] = 'aws-sdk-backupgateway'
-      context[:gem_version] = '1.3.0'
+      context[:gem_version] = '1.4.0'
       Seahorse::Client::Request.new(handlers, context)
     end
 

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

@@ -30,8 +30,11 @@ module Aws::BackupGateway
     DisassociateGatewayFromServerOutput = Shapes::StructureShape.new(name: 'DisassociateGatewayFromServerOutput')
     Gateway = Shapes::StructureShape.new(name: 'Gateway')
     GatewayArn = Shapes::StringShape.new(name: 'GatewayArn')
+    GatewayDetails = Shapes::StructureShape.new(name: 'GatewayDetails')
     GatewayType = Shapes::StringShape.new(name: 'GatewayType')
     Gateways = Shapes::ListShape.new(name: 'Gateways')
+    GetGatewayInput = Shapes::StructureShape.new(name: 'GetGatewayInput')
+    GetGatewayOutput = Shapes::StructureShape.new(name: 'GetGatewayOutput')
     Host = Shapes::StringShape.new(name: 'Host')
     HourOfDay = Shapes::IntegerShape.new(name: 'HourOfDay')
     Hypervisor = Shapes::StructureShape.new(name: 'Hypervisor')
@@ -75,12 +78,15 @@ module Aws::BackupGateway
     UntagResourceOutput = Shapes::StructureShape.new(name: 'UntagResourceOutput')
     UpdateGatewayInformationInput = Shapes::StructureShape.new(name: 'UpdateGatewayInformationInput')
     UpdateGatewayInformationOutput = Shapes::StructureShape.new(name: 'UpdateGatewayInformationOutput')
+    UpdateGatewaySoftwareNowInput = Shapes::StructureShape.new(name: 'UpdateGatewaySoftwareNowInput')
+    UpdateGatewaySoftwareNowOutput = Shapes::StructureShape.new(name: 'UpdateGatewaySoftwareNowOutput')
     UpdateHypervisorInput = Shapes::StructureShape.new(name: 'UpdateHypervisorInput')
     UpdateHypervisorOutput = Shapes::StructureShape.new(name: 'UpdateHypervisorOutput')
     Username = Shapes::StringShape.new(name: 'Username')
     ValidationException = Shapes::StructureShape.new(name: 'ValidationException')
     VirtualMachine = Shapes::StructureShape.new(name: 'VirtualMachine')
     VirtualMachines = Shapes::ListShape.new(name: 'VirtualMachines')
+    VpcEndpoint = Shapes::StringShape.new(name: 'VpcEndpoint')
     string = Shapes::StringShape.new(name: 'string')
 
     AccessDeniedException.add_member(:error_code, Shapes::ShapeRef.new(shape: string, required: true, location_name: "ErrorCode"))
@@ -132,8 +138,23 @@ module Aws::BackupGateway
     Gateway.add_member(:last_seen_time, Shapes::ShapeRef.new(shape: Time, location_name: "LastSeenTime"))
     Gateway.struct_class = Types::Gateway
 
+    GatewayDetails.add_member(:gateway_arn, Shapes::ShapeRef.new(shape: GatewayArn, location_name: "GatewayArn"))
+    GatewayDetails.add_member(:gateway_display_name, Shapes::ShapeRef.new(shape: Name, location_name: "GatewayDisplayName"))
+    GatewayDetails.add_member(:gateway_type, Shapes::ShapeRef.new(shape: GatewayType, location_name: "GatewayType"))
+    GatewayDetails.add_member(:hypervisor_id, Shapes::ShapeRef.new(shape: HypervisorId, location_name: "HypervisorId"))
+    GatewayDetails.add_member(:last_seen_time, Shapes::ShapeRef.new(shape: Time, location_name: "LastSeenTime"))
+    GatewayDetails.add_member(:next_update_availability_time, Shapes::ShapeRef.new(shape: Time, location_name: "NextUpdateAvailabilityTime"))
+    GatewayDetails.add_member(:vpc_endpoint, Shapes::ShapeRef.new(shape: VpcEndpoint, location_name: "VpcEndpoint"))
+    GatewayDetails.struct_class = Types::GatewayDetails
+
     Gateways.member = Shapes::ShapeRef.new(shape: Gateway)
 
+    GetGatewayInput.add_member(:gateway_arn, Shapes::ShapeRef.new(shape: GatewayArn, required: true, location_name: "GatewayArn"))
+    GetGatewayInput.struct_class = Types::GetGatewayInput
+
+    GetGatewayOutput.add_member(:gateway, Shapes::ShapeRef.new(shape: GatewayDetails, location_name: "Gateway"))
+    GetGatewayOutput.struct_class = Types::GetGatewayOutput
+
     Hypervisor.add_member(:host, Shapes::ShapeRef.new(shape: Host, location_name: "Host"))
     Hypervisor.add_member(:hypervisor_arn, Shapes::ShapeRef.new(shape: ServerArn, location_name: "HypervisorArn"))
     Hypervisor.add_member(:kms_key_arn, Shapes::ShapeRef.new(shape: KmsKeyArn, location_name: "KmsKeyArn"))
@@ -240,8 +261,15 @@ module Aws::BackupGateway
     UpdateGatewayInformationOutput.add_member(:gateway_arn, Shapes::ShapeRef.new(shape: GatewayArn, location_name: "GatewayArn"))
     UpdateGatewayInformationOutput.struct_class = Types::UpdateGatewayInformationOutput
 
+    UpdateGatewaySoftwareNowInput.add_member(:gateway_arn, Shapes::ShapeRef.new(shape: GatewayArn, required: true, location_name: "GatewayArn"))
+    UpdateGatewaySoftwareNowInput.struct_class = Types::UpdateGatewaySoftwareNowInput
+
+    UpdateGatewaySoftwareNowOutput.add_member(:gateway_arn, Shapes::ShapeRef.new(shape: GatewayArn, location_name: "GatewayArn"))
+    UpdateGatewaySoftwareNowOutput.struct_class = Types::UpdateGatewaySoftwareNowOutput
+
     UpdateHypervisorInput.add_member(:host, Shapes::ShapeRef.new(shape: Host, location_name: "Host"))
     UpdateHypervisorInput.add_member(:hypervisor_arn, Shapes::ShapeRef.new(shape: ServerArn, required: true, location_name: "HypervisorArn"))
+    UpdateHypervisorInput.add_member(:name, Shapes::ShapeRef.new(shape: Name, location_name: "Name"))
     UpdateHypervisorInput.add_member(:password, Shapes::ShapeRef.new(shape: Password, location_name: "Password"))
     UpdateHypervisorInput.add_member(:username, Shapes::ShapeRef.new(shape: Username, location_name: "Username"))
     UpdateHypervisorInput.struct_class = Types::UpdateHypervisorInput
@@ -338,6 +366,17 @@ module Aws::BackupGateway
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
       end)
 
+      api.add_operation(:get_gateway, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "GetGateway"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: GetGatewayInput)
+        o.output = Shapes::ShapeRef.new(shape: GetGatewayOutput)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
+
       api.add_operation(:import_hypervisor_configuration, Seahorse::Model::Operation.new.tap do |o|
         o.name = "ImportHypervisorConfiguration"
         o.http_method = "POST"
@@ -466,6 +505,17 @@ module Aws::BackupGateway
         o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
       end)
 
+      api.add_operation(:update_gateway_software_now, Seahorse::Model::Operation.new.tap do |o|
+        o.name = "UpdateGatewaySoftwareNow"
+        o.http_method = "POST"
+        o.http_request_uri = "/"
+        o.input = Shapes::ShapeRef.new(shape: UpdateGatewaySoftwareNowInput)
+        o.output = Shapes::ShapeRef.new(shape: UpdateGatewaySoftwareNowOutput)
+        o.errors << Shapes::ShapeRef.new(shape: ValidationException)
+        o.errors << Shapes::ShapeRef.new(shape: InternalServerException)
+        o.errors << Shapes::ShapeRef.new(shape: ResourceNotFoundException)
+      end)
+
       api.add_operation(:update_hypervisor, Seahorse::Model::Operation.new.tap do |o|
         o.name = "UpdateHypervisor"
         o.http_method = "POST"

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

@@ -274,6 +274,86 @@ module Aws::BackupGateway
       include Aws::Structure
     end
 
+    # The details of gateway.
+    #
+    # @!attribute [rw] gateway_arn
+    #   The Amazon Resource Name (ARN) of the gateway. Use the
+    #   `ListGateways` operation to return a list of gateways for your
+    #   account and Amazon Web Services Region.
+    #   @return [String]
+    #
+    # @!attribute [rw] gateway_display_name
+    #   The display name of the gateway.
+    #   @return [String]
+    #
+    # @!attribute [rw] gateway_type
+    #   The type of the gateway type.
+    #   @return [String]
+    #
+    # @!attribute [rw] hypervisor_id
+    #   The hypervisor ID of the gateway.
+    #   @return [String]
+    #
+    # @!attribute [rw] last_seen_time
+    #   Details showing the last time Backup gateway communicated with the
+    #   cloud, in Unix format and UTC time.
+    #   @return [Time]
+    #
+    # @!attribute [rw] next_update_availability_time
+    #   Details showing the next update availability time of the gateway.
+    #   @return [Time]
+    #
+    # @!attribute [rw] vpc_endpoint
+    #   The DNS name for the virtual private cloud (VPC) endpoint the
+    #   gateway uses to connect to the cloud for backup gateway.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GatewayDetails AWS API Documentation
+    #
+    class GatewayDetails < Struct.new(
+      :gateway_arn,
+      :gateway_display_name,
+      :gateway_type,
+      :hypervisor_id,
+      :last_seen_time,
+      :next_update_availability_time,
+      :vpc_endpoint)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @note When making an API call, you may pass GetGatewayInput
+    #   data as a hash:
+    #
+    #       {
+    #         gateway_arn: "GatewayArn", # required
+    #       }
+    #
+    # @!attribute [rw] gateway_arn
+    #   The Amazon Resource Name (ARN) of the gateway.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetGatewayInput AWS API Documentation
+    #
+    class GetGatewayInput < Struct.new(
+      :gateway_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] gateway
+    #   By providing the ARN (Amazon Resource Name), this API returns the
+    #   gateway.
+    #   @return [Types::GatewayDetails]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/GetGatewayOutput AWS API Documentation
+    #
+    class GetGatewayOutput < Struct.new(
+      :gateway)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # Represents the hypervisor's permissions to which the gateway will
     # connect.
     #
@@ -678,7 +758,7 @@ module Aws::BackupGateway
     #   @return [String]
     #
     # @!attribute [rw] value
-    #   The key part of a value's key-value pair.
+    #   The value part of a tag's key-value pair.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/Tag AWS API Documentation
@@ -851,12 +931,44 @@ module Aws::BackupGateway
       include Aws::Structure
     end
 
+    # @note When making an API call, you may pass UpdateGatewaySoftwareNowInput
+    #   data as a hash:
+    #
+    #       {
+    #         gateway_arn: "GatewayArn", # required
+    #       }
+    #
+    # @!attribute [rw] gateway_arn
+    #   The Amazon Resource Name (ARN) of the gateway to be updated.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateGatewaySoftwareNowInput AWS API Documentation
+    #
+    class UpdateGatewaySoftwareNowInput < Struct.new(
+      :gateway_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
+    # @!attribute [rw] gateway_arn
+    #   The Amazon Resource Name (ARN) of the gateway you updated.
+    #   @return [String]
+    #
+    # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/UpdateGatewaySoftwareNowOutput AWS API Documentation
+    #
+    class UpdateGatewaySoftwareNowOutput < Struct.new(
+      :gateway_arn)
+      SENSITIVE = []
+      include Aws::Structure
+    end
+
     # @note When making an API call, you may pass UpdateHypervisorInput
     #   data as a hash:
     #
     #       {
     #         host: "Host",
     #         hypervisor_arn: "ServerArn", # required
+    #         name: "Name",
     #         password: "Password",
     #         username: "Username",
     #       }
@@ -870,6 +982,10 @@ module Aws::BackupGateway
     #   The Amazon Resource Name (ARN) of the hypervisor to update.
     #   @return [String]
     #
+    # @!attribute [rw] name
+    #   The updated name for the hypervisor
+    #   @return [String]
+    #
     # @!attribute [rw] password
     #   The updated password for the hypervisor.
     #   @return [String]
@@ -883,6 +999,7 @@ module Aws::BackupGateway
     class UpdateHypervisorInput < Struct.new(
       :host,
       :hypervisor_arn,
+      :name,
       :password,
       :username)
       SENSITIVE = [:password, :username]
@@ -943,7 +1060,8 @@ module Aws::BackupGateway
     #   @return [String]
     #
     # @!attribute [rw] resource_arn
-    #   The Amazon Resource Name (ARN) of the virtual machine.
+    #   The Amazon Resource Name (ARN) of the virtual machine. For example,
+    #   `arn:aws:backup-gateway:us-west-1:0000000000000:vm/vm-0000ABCDEFGIJKL`.
     #   @return [String]
     #
     # @see http://docs.aws.amazon.com/goto/WebAPI/backup-gateway-2021-01-01/VirtualMachine AWS API Documentation

data/lib/aws-sdk-backupgateway.rb

@@ -48,6 +48,6 @@ require_relative 'aws-sdk-backupgateway/customizations'
 # @!group service
 module Aws::BackupGateway
 
-  GEM_VERSION = '1.3.0'
+  GEM_VERSION = '1.4.0'
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aws-sdk-backupgateway
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Amazon Web Services
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-02-24 00:00:00.000000000 Z
+date: 2022-06-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk-core