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

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


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

Classes
~~~~~~~

.. autoapisummary::

   astronomer.providers.amazon.aws.triggers.batch.BatchOperatorTrigger




.. py:class:: BatchOperatorTrigger(job_id, waiters, max_retries, region_name, aws_conn_id = 'aws_default')


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

   Checks for the state of a previously submitted job to AWS Batch.
   BatchOperatorTrigger is fired as deferred class with params to poll the job state in Triggerer

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


   :param job_id: the job ID, usually unknown (None) until the
       submit_job operation gets the jobId defined by AWS Batch
   :param waiters: a :class:`.BatchWaiters` object (see note below);
       if None, polling is used with max_retries and status_retries.
   :param max_retries: exponential back-off retries, 4200 = 48 hours;
       polling is only used when waiters is None
   :param aws_conn_id: connection id of AWS credentials / region name. If None,
       credential boto3 strategy will be used.
   :param region_name: AWS region name to use .
       Override the region_name in connection (if provided)

   .. py:method:: serialize()

      Serializes BatchOperatorTrigger arguments and classpath.


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

      Make async connection using aiobotocore library to AWS Batch,
      periodically poll for the job status on the Triggerer

      The status that indicates job completion are: 'SUCCEEDED'|'FAILED'.

      So the status options that this will poll for are the transitions from:
      'SUBMITTED'>'PENDING'>'RUNNABLE'>'STARTING'>'RUNNING'>'SUCCEEDED'|'FAILED'