| :py:mod:`airflow.providers.amazon.aws.sensors.batch` |
| ==================================================== |
| |
| .. py:module:: airflow.providers.amazon.aws.sensors.batch |
| |
| |
| Module Contents |
| --------------- |
| |
| Classes |
| ~~~~~~~ |
| |
| .. autoapisummary:: |
| |
| airflow.providers.amazon.aws.sensors.batch.BatchSensor |
| |
| |
| |
| |
| .. py:class:: BatchSensor(*, job_id, aws_conn_id = 'aws_default', region_name = None, **kwargs) |
| |
| Bases: :py:obj:`airflow.sensors.base.BaseSensorOperator` |
| |
| Asks for the state of the Batch Job execution until it reaches a failure state or success state. |
| If the job fails, the task will fail. |
| |
| .. seealso:: |
| 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' |
| |
| .. py:attribute:: template_fields |
| :annotation: :Sequence[str] = ['job_id'] |
| |
| |
| |
| .. py:attribute:: template_ext |
| :annotation: :Sequence[str] = [] |
| |
| |
| |
| .. py:attribute:: ui_color |
| :annotation: = #66c3ff |
| |
| |
| |
| .. py:method:: poke(self, context) |
| |
| Function that the sensors defined while deriving this class should |
| override. |
| |
| |
| .. py:method:: get_hook(self) |
| |
| Create and return a BatchClientHook |
| |
| |
| |
