:py:mod:`astronomer.providers.amazon.aws.sensors.batch`
=======================================================

.. py:module:: astronomer.providers.amazon.aws.sensors.batch


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

Classes
~~~~~~~

.. autoapisummary::

   astronomer.providers.amazon.aws.sensors.batch.BatchSensorAsync




.. py:class:: BatchSensorAsync(*, poll_interval = 5, **kwargs)

   Bases: :py:obj:`airflow.providers.amazon.aws.sensors.batch.BatchSensor`

   Given a job ID of a Batch Job, poll for the job status asynchronously until it
   reaches a failure or a success state.
   If the job fails, the task will fail.

   .. see also::
       For more information on how to use this sensor, take a look at the guide:
       :ref:`howto/sensor:BatchSensor`

   :param job_id: Batch job_id to check the state for
   :param aws_conn_id: aws connection to use, defaults to 'aws_default'
   :param region_name: region name to use in AWS Hook
       Override the region_name in connection (if provided)
   :param poll_interval: polling period in seconds to check for the status of the job

   .. py:method:: execute(context)

      Defers trigger class to poll for state of the job run until it reaches a failure or a success state


   .. py:method:: execute_complete(context, event)

      Callback for when the trigger fires - returns immediately.
      Relies on trigger to throw an exception, otherwise it assumes execution was
      successful.