lib/aws-sdk-pinpoint/errors.rb in aws-sdk-pinpoint-1.34.0 vs lib/aws-sdk-pinpoint/errors.rb in aws-sdk-pinpoint-1.35.0

@@ -4,9 +4,42 @@
 # https://github.com/aws/aws-sdk-ruby/blob/master/CONTRIBUTING.md
 #
 # WARNING ABOUT GENERATED CODE
 
 module Aws::Pinpoint
+
+  # When Pinpoint returns an error response, the Ruby SDK constructs and raises an error.
+  # These errors all extend Aws::Pinpoint::Errors::ServiceError < {Aws::Errors::ServiceError}
+  #
+  # You can rescue all Pinpoint errors using ServiceError:
+  #     begin
+  #       # do stuff
+  #     rescue Aws::Pinpoint::Errors::ServiceError
+  #       # rescues all Pinpoint 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, including:
+  # *
+  # * #params - The request params
+  # * #operation_name - Name of the API operation invoked
+  # * #http_request
+  # * #http_response
+  # * etc ...
+  #
+  # See {Seahorse::Client::RequestContext} for more information.
+  #
+  # ## Error Classes
+  # * {BadRequestException}
+  # * {ForbiddenException}
+  # * {InternalServerErrorException}
+  # * {MethodNotAllowedException}
+  # * {NotFoundException}
+  # * {PayloadTooLargeException}
+  # * {TooManyRequestsException}
+  # 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