:py:mod:`astronomer.providers.amazon.aws.triggers.s3`
=====================================================

.. py:module:: astronomer.providers.amazon.aws.triggers.s3


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

Classes
~~~~~~~

.. autoapisummary::

   astronomer.providers.amazon.aws.triggers.s3.S3KeyTrigger




.. py:class:: S3KeyTrigger(bucket_name, bucket_key, wildcard_match = False, use_regex = False, aws_conn_id = 'aws_default', poke_interval = 5.0, soft_fail = False, should_check_fn = False, **hook_params)


   Bases: :py:obj:`airflow.triggers.base.BaseTrigger`

   S3KeyTrigger is fired as deferred class with params to run the task in trigger worker

   This class is deprecated and will be removed in 2.0.0.
   Use :class: `~airflow.providers.amazon.aws.triggers.s3.S3KeyTrigger` instead

   :param bucket_name: Name of the S3 bucket. Only needed when ``bucket_key``
       is not provided as a full s3:// url.
   :param bucket_key:  The key being waited on. Supports full s3:// style url
       or relative path from root level. When it's specified as a full s3://
       url, please leave bucket_name as `None`.
   :param wildcard_match: whether the bucket_key should be interpreted as a
       Unix wildcard pattern
   :param use_regex: whether to use regex to check bucket
   :param aws_conn_id: reference to the s3 connection
   :param hook_params: params for hook its optional
   :param soft_fail: Set to true to mark the task as SKIPPED on failure

   .. py:method:: serialize()

      Serialize S3KeyTrigger arguments and classpath.


   .. py:method:: run()
      :async:

      Make an asynchronous connection using S3HookAsync.