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

@@ -4,10 +4,40 @@
 # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Transfer
+
+  # When Transfer returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::Transfer::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all Transfer errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::Transfer::Errors::ServiceError
+  #       # rescues all Transfer 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}
+  # * {InternalServiceError}
+  # * {InvalidNextTokenException}
+  # * {InvalidRequestException}
+  # * {ResourceExistsException}
+  # * {ResourceNotFoundException}
+  # * {ServiceUnavailableException}
+  # * {ThrottlingException}
+  #
+  # 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 +51,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class InternalServiceError < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -37,11 +66,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidNextTokenException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -53,11 +81,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidRequestException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -69,11 +96,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class ResourceExistsException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -95,11 +121,10 @@
 
       # @return [String]
       def resource_type
         @data[:resource_type]
       end
-
     end
 
     class ResourceNotFoundException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -121,11 +146,10 @@
 
       # @return [String]
       def resource_type
         @data[:resource_type]
       end
-
     end
 
     class ServiceUnavailableException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -137,11 +161,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class ThrottlingException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -153,10 +176,9 @@
 
       # @return [String]
       def retry_after_seconds
         @data[:retry_after_seconds]
       end
-
     end
 
   end
 end