| :py:mod:`airflow.providers.amazon.aws.sensors.dms` |
| ================================================== |
| |
| .. py:module:: airflow.providers.amazon.aws.sensors.dms |
| |
| |
| Module Contents |
| --------------- |
| |
| Classes |
| ~~~~~~~ |
| |
| .. autoapisummary:: |
| |
| airflow.providers.amazon.aws.sensors.dms.DmsTaskBaseSensor |
| airflow.providers.amazon.aws.sensors.dms.DmsTaskCompletedSensor |
| |
| |
| |
| |
| .. py:class:: DmsTaskBaseSensor(replication_task_arn, aws_conn_id='aws_default', target_statuses = None, termination_statuses = None, *args, **kwargs) |
| |
| Bases: :py:obj:`airflow.sensors.base.BaseSensorOperator` |
| |
| Contains general sensor behavior for DMS task. |
| |
| Subclasses should set ``target_statuses`` and ``termination_statuses`` fields. |
| |
| :param replication_task_arn: AWS DMS replication task ARN |
| :param aws_conn_id: aws connection to uses |
| :param target_statuses: the target statuses, sensor waits until |
| the task reaches any of these states |
| :param termination_statuses: the termination statuses, sensor fails when |
| the task reaches any of these states |
| |
| .. py:attribute:: template_fields |
| :annotation: :Sequence[str] = ['replication_task_arn'] |
| |
| |
| |
| .. py:attribute:: template_ext |
| :annotation: :Sequence[str] = [] |
| |
| |
| |
| .. py:method:: get_hook(self) |
| |
| Get DmsHook |
| |
| |
| .. py:method:: poke(self, context) |
| |
| Function that the sensors defined while deriving this class should |
| override. |
| |
| |
| |
| .. py:class:: DmsTaskCompletedSensor(*args, **kwargs) |
| |
| Bases: :py:obj:`DmsTaskBaseSensor` |
| |
| Pokes DMS task until it is completed. |
| |
| .. seealso:: |
| For more information on how to use this operator, take a look at the guide: |
| :ref:`howto/sensor:DmsTaskCompletedSensor` |
| |
| :param replication_task_arn: AWS DMS replication task ARN |
| |
| .. py:attribute:: template_fields |
| :annotation: :Sequence[str] = ['replication_task_arn'] |
| |
| |
| |
| .. py:attribute:: template_ext |
| :annotation: :Sequence[str] = [] |
| |
| |
| |
| |
