aws-sdk-kms 1.23.0 → 1.77.0

data/lib/aws-sdk-kms/errors.rb

@@ -1,11 +1,82 @@
+# frozen_string_literal: true
+
 # WARNING ABOUT GENERATED CODE
 #
 # This file is generated. See the contributing guide for more information:
-# https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
 module Aws::KMS
+
+  # When KMS returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::KMS::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all KMS errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::KMS::Errors::ServiceError
+  #       # rescues all KMS API errors
+  #     end
+  #
+  #
+  # ## Request Context
+  # ServiceError objects have a {Aws::Errors::ServiceError#context #context} method that returns
+  # information about the request that generated the error.
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {AlreadyExistsException}
+  # * {CloudHsmClusterInUseException}
+  # * {CloudHsmClusterInvalidConfigurationException}
+  # * {CloudHsmClusterNotActiveException}
+  # * {CloudHsmClusterNotFoundException}
+  # * {CloudHsmClusterNotRelatedException}
+  # * {CustomKeyStoreHasCMKsException}
+  # * {CustomKeyStoreInvalidStateException}
+  # * {CustomKeyStoreNameInUseException}
+  # * {CustomKeyStoreNotFoundException}
+  # * {DependencyTimeoutException}
+  # * {DisabledException}
+  # * {DryRunOperationException}
+  # * {ExpiredImportTokenException}
+  # * {IncorrectKeyException}
+  # * {IncorrectKeyMaterialException}
+  # * {IncorrectTrustAnchorException}
+  # * {InvalidAliasNameException}
+  # * {InvalidArnException}
+  # * {InvalidCiphertextException}
+  # * {InvalidGrantIdException}
+  # * {InvalidGrantTokenException}
+  # * {InvalidImportTokenException}
+  # * {InvalidKeyUsageException}
+  # * {InvalidMarkerException}
+  # * {KMSInternalException}
+  # * {KMSInvalidMacException}
+  # * {KMSInvalidSignatureException}
+  # * {KMSInvalidStateException}
+  # * {KeyUnavailableException}
+  # * {LimitExceededException}
+  # * {MalformedPolicyDocumentException}
+  # * {NotFoundException}
+  # * {TagException}
+  # * {UnsupportedOperationException}
+  # * {XksKeyAlreadyInUseException}
+  # * {XksKeyInvalidConfigurationException}
+  # * {XksKeyNotFoundException}
+  # * {XksProxyIncorrectAuthenticationCredentialException}
+  # * {XksProxyInvalidConfigurationException}
+  # * {XksProxyInvalidResponseException}
+  # * {XksProxyUriEndpointInUseException}
+  # * {XksProxyUriInUseException}
+  # * {XksProxyUriUnreachableException}
+  # * {XksProxyVpcEndpointServiceInUseException}
+  # * {XksProxyVpcEndpointServiceInvalidConfigurationException}
+  # * {XksProxyVpcEndpointServiceNotFoundException}
+  #
+  # Additionally, error classes are dynamically generated for service errors based on the error code
+  # if they are not defined above.
   module Errors
 
     extend Aws::Errors::DynamicErrors
@@ -23,7 +94,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class CloudHsmClusterInUseException < ServiceError
@@ -39,7 +109,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class CloudHsmClusterInvalidConfigurationException < ServiceError
@@ -55,7 +124,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class CloudHsmClusterNotActiveException < ServiceError
@@ -71,7 +139,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class CloudHsmClusterNotFoundException < ServiceError
@@ -87,7 +154,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class CloudHsmClusterNotRelatedException < ServiceError
@@ -103,7 +169,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class CustomKeyStoreHasCMKsException < ServiceError
@@ -119,7 +184,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class CustomKeyStoreInvalidStateException < ServiceError
@@ -135,7 +199,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class CustomKeyStoreNameInUseException < ServiceError
@@ -151,7 +214,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class CustomKeyStoreNotFoundException < ServiceError
@@ -167,7 +229,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class DependencyTimeoutException < ServiceError
@@ -183,7 +244,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class DisabledException < ServiceError
@@ -199,7 +259,21 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
+    end
+
+    class DryRunOperationException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::DryRunOperationException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
 
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class ExpiredImportTokenException < ServiceError
@@ -215,7 +289,21 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
+    end
+
+    class IncorrectKeyException < ServiceError
 
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::IncorrectKeyException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class IncorrectKeyMaterialException < ServiceError
@@ -231,7 +319,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class IncorrectTrustAnchorException < ServiceError
@@ -247,7 +334,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidAliasNameException < ServiceError
@@ -263,7 +349,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidArnException < ServiceError
@@ -279,7 +364,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidCiphertextException < ServiceError
@@ -295,7 +379,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidGrantIdException < ServiceError
@@ -311,7 +394,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidGrantTokenException < ServiceError
@@ -327,7 +409,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidImportTokenException < ServiceError
@@ -343,7 +424,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidKeyUsageException < ServiceError
@@ -359,7 +439,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidMarkerException < ServiceError
@@ -375,7 +454,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class KMSInternalException < ServiceError
@@ -391,7 +469,36 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
+    end
+
+    class KMSInvalidMacException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::KMSInvalidMacException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
 
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class KMSInvalidSignatureException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::KMSInvalidSignatureException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
     class KMSInvalidStateException < ServiceError
@@ -407,7 +514,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class KeyUnavailableException < ServiceError
@@ -423,7 +529,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class LimitExceededException < ServiceError
@@ -439,7 +544,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class MalformedPolicyDocumentException < ServiceError
@@ -455,7 +559,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class NotFoundException < ServiceError
@@ -471,7 +574,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class TagException < ServiceError
@@ -487,7 +589,6 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
-
     end
 
     class UnsupportedOperationException < ServiceError
@@ -503,7 +604,186 @@ module Aws::KMS
       def message
         @message || @data[:message]
       end
+    end
+
+    class XksKeyAlreadyInUseException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::XksKeyAlreadyInUseException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
 
+    class XksKeyInvalidConfigurationException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::XksKeyInvalidConfigurationException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class XksKeyNotFoundException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::XksKeyNotFoundException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class XksProxyIncorrectAuthenticationCredentialException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::XksProxyIncorrectAuthenticationCredentialException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class XksProxyInvalidConfigurationException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::XksProxyInvalidConfigurationException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class XksProxyInvalidResponseException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::XksProxyInvalidResponseException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class XksProxyUriEndpointInUseException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::XksProxyUriEndpointInUseException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class XksProxyUriInUseException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::XksProxyUriInUseException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class XksProxyUriUnreachableException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::XksProxyUriUnreachableException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class XksProxyVpcEndpointServiceInUseException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::XksProxyVpcEndpointServiceInUseException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class XksProxyVpcEndpointServiceInvalidConfigurationException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::XksProxyVpcEndpointServiceInvalidConfigurationException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
+    end
+
+    class XksProxyVpcEndpointServiceNotFoundException < ServiceError
+
+      # @param [Seahorse::Client::RequestContext] context
+      # @param [String] message
+      # @param [Aws::KMS::Types::XksProxyVpcEndpointServiceNotFoundException] data
+      def initialize(context, message, data = Aws::EmptyStructure.new)
+        super(context, message, data)
+      end
+
+      # @return [String]
+      def message
+        @message || @data[:message]
+      end
     end
 
   end

data/lib/aws-sdk-kms/plugins/endpoints.rb

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+# WARNING ABOUT GENERATED CODE
+#
+# This file is generated. See the contributing guide for more information:
+# https://github.com/aws/aws-sdk-ruby/blob/version-3/CONTRIBUTING.md
+#
+# WARNING ABOUT GENERATED CODE
+
+
+module Aws::KMS
+  module Plugins
+    class Endpoints < Seahorse::Client::Plugin
+      option(
+        :endpoint_provider,
+        doc_type: 'Aws::KMS::EndpointProvider',
+        rbs_type: 'untyped',
+        docstring: 'The endpoint provider used to resolve endpoints. Any '\
+                   'object that responds to `#resolve_endpoint(parameters)` '\
+                   'where `parameters` is a Struct similar to '\
+                   '`Aws::KMS::EndpointParameters`'
+      ) do |cfg|
+        Aws::KMS::EndpointProvider.new
+      end
+
+      # @api private
+      class Handler < Seahorse::Client::Handler
+        def call(context)
+          unless context[:discovered_endpoint]
+            params = parameters_for_operation(context)
+            endpoint = context.config.endpoint_provider.resolve_endpoint(params)
+
+            context.http_request.endpoint = endpoint.url
+            apply_endpoint_headers(context, endpoint.headers)
+
+            context[:endpoint_params] = params
+            context[:endpoint_properties] = endpoint.properties
+          end
+
+          context[:auth_scheme] =
+            Aws::Endpoints.resolve_auth_scheme(context, endpoint)
+
+          @handler.call(context)
+        end
+
+        private
+
+        def apply_endpoint_headers(context, headers)
+          headers.each do |key, values|
+            value = values
+              .compact
+              .map { |s| Seahorse::Util.escape_header_list_string(s.to_s) }
+              .join(',')
+
+            context.http_request.headers[key] = value
+          end
+        end
+
+        def parameters_for_operation(context)
+          case context.operation_name
+          when :cancel_key_deletion
+            Aws::KMS::Endpoints::CancelKeyDeletion.build(context)
+          when :connect_custom_key_store
+            Aws::KMS::Endpoints::ConnectCustomKeyStore.build(context)
+          when :create_alias
+            Aws::KMS::Endpoints::CreateAlias.build(context)
+          when :create_custom_key_store
+            Aws::KMS::Endpoints::CreateCustomKeyStore.build(context)
+          when :create_grant
+            Aws::KMS::Endpoints::CreateGrant.build(context)
+          when :create_key
+            Aws::KMS::Endpoints::CreateKey.build(context)
+          when :decrypt
+            Aws::KMS::Endpoints::Decrypt.build(context)
+          when :delete_alias
+            Aws::KMS::Endpoints::DeleteAlias.build(context)
+          when :delete_custom_key_store
+            Aws::KMS::Endpoints::DeleteCustomKeyStore.build(context)
+          when :delete_imported_key_material
+            Aws::KMS::Endpoints::DeleteImportedKeyMaterial.build(context)
+          when :describe_custom_key_stores
+            Aws::KMS::Endpoints::DescribeCustomKeyStores.build(context)
+          when :describe_key
+            Aws::KMS::Endpoints::DescribeKey.build(context)
+          when :disable_key
+            Aws::KMS::Endpoints::DisableKey.build(context)
+          when :disable_key_rotation
+            Aws::KMS::Endpoints::DisableKeyRotation.build(context)
+          when :disconnect_custom_key_store
+            Aws::KMS::Endpoints::DisconnectCustomKeyStore.build(context)
+          when :enable_key
+            Aws::KMS::Endpoints::EnableKey.build(context)
+          when :enable_key_rotation
+            Aws::KMS::Endpoints::EnableKeyRotation.build(context)
+          when :encrypt
+            Aws::KMS::Endpoints::Encrypt.build(context)
+          when :generate_data_key
+            Aws::KMS::Endpoints::GenerateDataKey.build(context)
+          when :generate_data_key_pair
+            Aws::KMS::Endpoints::GenerateDataKeyPair.build(context)
+          when :generate_data_key_pair_without_plaintext
+            Aws::KMS::Endpoints::GenerateDataKeyPairWithoutPlaintext.build(context)
+          when :generate_data_key_without_plaintext
+            Aws::KMS::Endpoints::GenerateDataKeyWithoutPlaintext.build(context)
+          when :generate_mac
+            Aws::KMS::Endpoints::GenerateMac.build(context)
+          when :generate_random
+            Aws::KMS::Endpoints::GenerateRandom.build(context)
+          when :get_key_policy
+            Aws::KMS::Endpoints::GetKeyPolicy.build(context)
+          when :get_key_rotation_status
+            Aws::KMS::Endpoints::GetKeyRotationStatus.build(context)
+          when :get_parameters_for_import
+            Aws::KMS::Endpoints::GetParametersForImport.build(context)
+          when :get_public_key
+            Aws::KMS::Endpoints::GetPublicKey.build(context)
+          when :import_key_material
+            Aws::KMS::Endpoints::ImportKeyMaterial.build(context)
+          when :list_aliases
+            Aws::KMS::Endpoints::ListAliases.build(context)
+          when :list_grants
+            Aws::KMS::Endpoints::ListGrants.build(context)
+          when :list_key_policies
+            Aws::KMS::Endpoints::ListKeyPolicies.build(context)
+          when :list_keys
+            Aws::KMS::Endpoints::ListKeys.build(context)
+          when :list_resource_tags
+            Aws::KMS::Endpoints::ListResourceTags.build(context)
+          when :list_retirable_grants
+            Aws::KMS::Endpoints::ListRetirableGrants.build(context)
+          when :put_key_policy
+            Aws::KMS::Endpoints::PutKeyPolicy.build(context)
+          when :re_encrypt
+            Aws::KMS::Endpoints::ReEncrypt.build(context)
+          when :replicate_key
+            Aws::KMS::Endpoints::ReplicateKey.build(context)
+          when :retire_grant
+            Aws::KMS::Endpoints::RetireGrant.build(context)
+          when :revoke_grant
+            Aws::KMS::Endpoints::RevokeGrant.build(context)
+          when :schedule_key_deletion
+            Aws::KMS::Endpoints::ScheduleKeyDeletion.build(context)
+          when :sign
+            Aws::KMS::Endpoints::Sign.build(context)
+          when :tag_resource
+            Aws::KMS::Endpoints::TagResource.build(context)
+          when :untag_resource
+            Aws::KMS::Endpoints::UntagResource.build(context)
+          when :update_alias
+            Aws::KMS::Endpoints::UpdateAlias.build(context)
+          when :update_custom_key_store
+            Aws::KMS::Endpoints::UpdateCustomKeyStore.build(context)
+          when :update_key_description
+            Aws::KMS::Endpoints::UpdateKeyDescription.build(context)
+          when :update_primary_region
+            Aws::KMS::Endpoints::UpdatePrimaryRegion.build(context)
+          when :verify
+            Aws::KMS::Endpoints::Verify.build(context)
+          when :verify_mac
+            Aws::KMS::Endpoints::VerifyMac.build(context)
+          end
+        end
+      end
+
+      def add_handlers(handlers, _config)
+        handlers.add(Handler, step: :build, priority: 75)
+      end
+    end
+  end
+end