lib/aws-sdk-batch/errors.rb in aws-sdk-batch-1.28.0 vs lib/aws-sdk-batch/errors.rb in aws-sdk-batch-1.29.0

@@ -4,10 +4,34 @@
 # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Batch
+
+  # When Batch returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::Batch::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all Batch errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::Batch::Errors::ServiceError
+  #       # rescues all Batch 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
+  # * {ClientException}
+  # * {ServerException}
+  #
+  # 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 ClientException < ServiceError
@@ -21,11 +45,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class ServerException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -37,10 +60,9 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
   end
 end