lib/aws-sdk-iotdataplane/errors.rb in aws-sdk-iotdataplane-1.16.0 vs lib/aws-sdk-iotdataplane/errors.rb in aws-sdk-iotdataplane-1.17.0

@@ -4,10 +4,42 @@
 # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
 module Aws::IoTDataPlane
+
+  # When IoTDataPlane returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::IoTDataPlane::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all IoTDataPlane errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::IoTDataPlane::Errors::ServiceError
+  #       # rescues all IoTDataPlane 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
+  # * {ConflictException}
+  # * {InternalFailureException}
+  # * {InvalidRequestException}
+  # * {MethodNotAllowedException}
+  # * {RequestEntityTooLargeException}
+  # * {ResourceNotFoundException}
+  # * {ServiceUnavailableException}
+  # * {ThrottlingException}
+  # * {UnauthorizedException}
+  # * {UnsupportedDocumentEncodingException}
+  #
+  # 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 ConflictException < ServiceError
@@ -21,11 +53,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class InternalFailureException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -37,11 +68,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidRequestException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -53,11 +83,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class MethodNotAllowedException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -69,11 +98,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class RequestEntityTooLargeException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -85,11 +113,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceNotFoundException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -101,11 +128,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class ServiceUnavailableException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -117,11 +143,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class ThrottlingException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -133,11 +158,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class UnauthorizedException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -149,11 +173,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class UnsupportedDocumentEncodingException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -165,10 +188,9 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
   end
 end