lib/aws-sdk-gamelift/errors.rb in aws-sdk-gamelift-1.27.0 vs lib/aws-sdk-gamelift/errors.rb in aws-sdk-gamelift-1.28.0

@@ -4,10 +4,46 @@
 # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
 module Aws::GameLift
+
+  # When GameLift returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::GameLift::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all GameLift errors using ServiceError:
+  #
+  #     begin
+  #       # do stuff
+  #     rescue Aws::GameLift::Errors::ServiceError
+  #       # rescues all GameLift 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}
+  # * {FleetCapacityExceededException}
+  # * {GameSessionFullException}
+  # * {IdempotentParameterMismatchException}
+  # * {InternalServiceException}
+  # * {InvalidFleetStatusException}
+  # * {InvalidGameSessionStatusException}
+  # * {InvalidRequestException}
+  # * {LimitExceededException}
+  # * {NotFoundException}
+  # * {TaggingFailedException}
+  # * {TerminalRoutingStrategyException}
+  # * {UnauthorizedException}
+  # * {UnsupportedRegionException}
+  #
+  # 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 +57,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class FleetCapacityExceededException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -37,11 +72,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class GameSessionFullException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -53,11 +87,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class IdempotentParameterMismatchException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -69,11 +102,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class InternalServiceException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -85,11 +117,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidFleetStatusException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -101,11 +132,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidGameSessionStatusException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -117,11 +147,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class InvalidRequestException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -133,11 +162,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class LimitExceededException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -149,11 +177,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class NotFoundException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -165,11 +192,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class TaggingFailedException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -181,11 +207,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class TerminalRoutingStrategyException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -197,11 +222,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class UnauthorizedException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -213,11 +237,10 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
     class UnsupportedRegionException < ServiceError
 
       # @param [Seahorse::Client::RequestContext] context
@@ -229,10 +252,9 @@
 
       # @return [String]
       def message
         @message || @data[:message]
       end
-
     end
 
   end
 end