AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Module: Aws::Pinpoint::Errors

Defined in:


When Amazon Pinpoint returns an error response, the Ruby SDK constructs and raises an error. These errors have the following ancestors:

You can rescue all Pinpoint errors using ServiceError:

# rescue all errors from Amazon Pinpoint
  # do stuff
rescue Aws::Pinpoint::Errors::ServiceError
  # ...

Request Context

ServiceError objects have a #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

You can rescue a specific error using the error code:

  # do stuff
rescue Aws::Pinpoint::Errors::BadRequestException
  # ...

Some of the common errors are listed below:

Defined Under Namespace

Classes: BadRequestException, ForbiddenException, InternalServerErrorException, MethodNotAllowedException, NotFoundException, PayloadTooLargeException, ServiceError, TooManyRequestsException