:py:mod:`event.handler.s3`
==========================

.. py:module:: event.handler.s3

.. autoapi-nested-parse::

   AWS S3 event handler.



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

Classes
~~~~~~~

.. autoapisummary::

   event.handler.s3.S3Handler




.. py:class:: S3Handler(event_s3_url: str, log_s3_url: str, sse: str = 'AES256', profile: str | None = None)


   Bases: :py:obj:`e3.event.EventHandler`

   Event handler that relies on AWS S3.

   .. py:method:: decode_config(config_str: str) -> dict[str, str | None]
      :classmethod:

      Decode configuration string.

      :param config_str: configuration string


   .. py:method:: encode_config() -> str

      Encode configuration to string representation.


   .. py:method:: s3_prefix(event: e3.event.Event) -> str

      Additional prefix that depends on the event itself.

      This hook allows a user to add a prefix that depends on the event itself.
      Note that sufixes are still automatically computed so distinct events can
      return the same prefix. The final s3 url used will be
      {log_s3_url}/{s3_prefix}{automatic suffix} for logs and
      {event_s3_url}/{s3_prefix}{automatic suffix} for events metadata.

      :param event: an event
      :return: the prefix


   .. py:method:: send_event(event: e3.event.Event) -> bool

      Send event to S3.

      :param event: event to send