docs-archive/1.10.13/_sources/_api/airflow/contrib/operators/awsbatch_operator/index.rst.txt

:mod:`airflow.contrib.operators.awsbatch_operator`
==================================================

.. py:module:: airflow.contrib.operators.awsbatch_operator


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

.. py:class:: AWSBatchOperator(job_name, job_definition, job_queue, overrides, array_properties=None, parameters=None, max_retries=MAX_RETRIES, status_retries=STATUS_RETRIES, aws_conn_id=None, region_name=None, **kwargs)

   Bases: :class:`airflow.models.BaseOperator`

   Execute a job on AWS Batch Service

   .. warning: the queue parameter was renamed to job_queue to segregate the
               internal CeleryExecutor queue from the AWS Batch internal queue.

   :param job_name: the name for the job that will run on AWS Batch (templated)
   :type job_name: str
   :param job_definition: the job definition name on AWS Batch
   :type job_definition: str
   :param job_queue: the queue name on AWS Batch
   :type job_queue: str
   :param overrides: the same parameter that boto3 will receive on
       containerOverrides (templated)
       http://boto3.readthedocs.io/en/latest/reference/services/batch.html#Batch.Client.submit_job
   :type overrides: dict
   :param array_properties: the same parameter that boto3 will receive on
       arrayProperties
       http://boto3.readthedocs.io/en/latest/reference/services/batch.html#Batch.Client.submit_job
   :type array_properties: dict
   :param parameters: the same parameter that boto3 will receive on
       parameters (templated)
       http://boto3.readthedocs.io/en/latest/reference/services/batch.html#Batch.Client.submit_job
   :type parameters: dict
   :param max_retries: exponential backoff retries while waiter is not
       merged, 4200 = 48 hours
   :type max_retries: int
   :param status_retries: number of retries to get job description (status), 10
   :type status_retries: int
   :param aws_conn_id: connection id of AWS credentials / region name. If None,
       credential boto3 strategy will be used
       (http://boto3.readthedocs.io/en/latest/guide/configuration.html).
   :type aws_conn_id: str
   :param region_name: region name to use in AWS Hook.
       Override the region_name in connection (if provided)
   :type region_name: str

   .. attribute:: MAX_RETRIES
      :annotation: = 4200

      

   .. attribute:: STATUS_RETRIES
      :annotation: = 10

      

   .. attribute:: ui_color
      :annotation: = #c3dae0

      

   .. attribute:: client
      

      

   .. attribute:: arn
      

      

   .. attribute:: template_fields
      :annotation: = ['job_name', 'overrides', 'parameters']

      

   
   .. method:: execute(self, context)



   
   .. method:: _wait_for_task_ended(self)

      Try to use a waiter from the below pull request

          * https://github.com/boto/botocore/pull/1307

      If the waiter is not available apply a exponential backoff

          * docs.aws.amazon.com/general/latest/gr/api-retries.html



   
   .. method:: _poll_for_task_ended(self)

      Poll for job status

      * docs.aws.amazon.com/general/latest/gr/api-retries.html



   
   .. method:: _get_job_description(self)

      Get job description

      * https://docs.aws.amazon.com/batch/latest/APIReference/API_DescribeJobs.html
      * https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/batch.html



   
   .. method:: _check_success_task(self)

      Check the final status of the batch job; the job status options are:
      'SUBMITTED'|'PENDING'|'RUNNABLE'|'STARTING'|'RUNNING'|'SUCCEEDED'|'FAILED'



   
   .. method:: get_hook(self)



   
   .. method:: on_kill(self)