:py:mod:`exceptions`
====================

.. py:module:: exceptions

.. autoapi-nested-parse::

   Exception classes.



Module Contents
---------------


Functions
~~~~~~~~~

.. autoapisummary::

   exceptions.handle_client_exceptions
   exceptions.handle_exceptions



.. py:exception:: BadRequest(message='Bad request.')


   Bases: :py:obj:`CustomHTTPException`

   .. autoapi-inheritance-diagram:: exceptions.BadRequest
      :parts: 1
      :private-bases:

   Class that all Bad request exceptions must inherit in order for
   exception to be caught by the handle_exceptions decorator.


.. py:exception:: ClientNotDefinedError(client_name, exception)


   Bases: :py:obj:`CustomHTTPException`

   .. autoapi-inheritance-diagram:: exceptions.ClientNotDefinedError
      :parts: 1
      :private-bases:

   Class that all ClientNotDefined exceptions must inherit in order for
   exception to be caught by the handle_exceptions decorator.


.. py:exception:: ClientTokenError(client_name, exception)


   Bases: :py:obj:`CustomHTTPException`

   .. autoapi-inheritance-diagram:: exceptions.ClientTokenError
      :parts: 1
      :private-bases:

   Class that all ClientTokenError exceptions must inherit in order for
   exception to be caught by the handle_exceptions decorator.


.. py:exception:: CustomException(message)


   Bases: :py:obj:`Exception`

   .. autoapi-inheritance-diagram:: exceptions.CustomException
      :parts: 1
      :private-bases:

   Class that all custom exceptions must inherit in order for
   exception to be caught by the handle_exceptions decorator.


.. py:exception:: CustomHTTPException(message, http_error_status=status.HTTP_500_INTERNAL_SERVER_ERROR)


   Bases: :py:obj:`Exception`

   .. autoapi-inheritance-diagram:: exceptions.CustomHTTPException
      :parts: 1
      :private-bases:

   Class that all custom HTTP exceptions must inherit in order for
   exception to be caught by the handle_exceptions decorator.


.. py:exception:: FlowNotImplementedError(message='This functionality is not implemented yet.')


   Bases: :py:obj:`CustomHTTPException`

   .. autoapi-inheritance-diagram:: exceptions.FlowNotImplementedError
      :parts: 1
      :private-bases:

   Class that all Not implemented exceptions must inherit in order for
   exception to be caught by the handle_exceptions decorator.


.. py:exception:: IAMEndpointNotFoundInWellKnown(endpoint)


   Bases: :py:obj:`CustomException`

   .. autoapi-inheritance-diagram:: exceptions.IAMEndpointNotFoundInWellKnown
      :parts: 1
      :private-bases:

   Class that all IAMEndPoint custom exceptions must inherit in order for
   exception to be caught by the handle_exceptions decorator.


.. py:exception:: InternalServerError(message='An internal server error occurred.')


   Bases: :py:obj:`CustomHTTPException`

   .. autoapi-inheritance-diagram:: exceptions.InternalServerError
      :parts: 1
      :private-bases:

   Class that all Internal server error exceptions must inherit in order for
   exception to be caught by the handle_exceptions decorator.


.. py:exception:: PermissionDenied


   Bases: :py:obj:`CustomHTTPException`

   .. autoapi-inheritance-diagram:: exceptions.PermissionDenied
      :parts: 1
      :private-bases:

   Class that all Permission denied exceptions must inherit in order for
   exception to be caught by the handle_exceptions decorator.


.. py:exception:: ResourceNotFoundError(resource_name = None, message = None)


   Bases: :py:obj:`CustomHTTPException`

   .. autoapi-inheritance-diagram:: exceptions.ResourceNotFoundError
      :parts: 1
      :private-bases:

   Class that all Resource not found exceptions must inherit in order for
   exception to be caught by the handle_exceptions decorator.


.. py:function:: handle_client_exceptions(func)

   Decorator to handle client exceptions.


.. py:function:: handle_exceptions(func)

   Decorator to handle server exceptions.