lib/aws-sdk-kafka/errors.rb in aws-sdk-kafka-1.18.0 vs lib/aws-sdk-kafka/errors.rb in aws-sdk-kafka-1.19.0

@@ -4,10 +4,40 @@
 # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Kafka
+
+  # When Kafka returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::Kafka::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all Kafka errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::Kafka::Errors::ServiceError
+  #       # rescues all Kafka 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
+  # * {BadRequestException}
+  # * {ConflictException}
+  # * {ForbiddenException}
+  # * {InternalServerErrorException}
+  # * {NotFoundException}
+  # * {ServiceUnavailableException}
+  # * {TooManyRequestsException}
+  # * {UnauthorizedException}
+  #
+  # 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
 
     class BadRequestException < ServiceError
@@ -26,11 +56,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class ConflictException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -47,11 +76,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class ForbiddenException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -68,11 +96,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class InternalServerErrorException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -89,11 +116,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class NotFoundException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -110,11 +136,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class ServiceUnavailableException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -131,11 +156,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class TooManyRequestsException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -152,11 +176,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class UnauthorizedException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -173,10 +196,9 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
   end
 end