blob: 4b4ae47bf9a6022e31e03bd6b4268533b09efabf [file] [log] [blame]
:mod:`airflow.providers.amazon.aws.sensors.dms_task`
====================================================
.. py:module:: airflow.providers.amazon.aws.sensors.dms_task
Module Contents
---------------
.. py:class:: DmsTaskBaseSensor(replication_task_arn: str, aws_conn_id='aws_default', target_statuses: Optional[Iterable[str]] = None, termination_statuses: Optional[Iterable[str]] = None, *args, **kwargs)
Bases: :class:`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
:type replication_task_arn: str
:param aws_conn_id: aws connection to uses
:type aws_conn_id: str
:param target_statuses: the target statuses, sensor waits until
the task reaches any of these states
:type target_states: list[str]
:param termination_statuses: the termination statuses, sensor fails when
the task reaches any of these states
:type termination_statuses: list[str]
.. attribute:: template_fields
:annotation: = ['replication_task_arn']
.. attribute:: template_ext
:annotation: = []
.. method:: get_hook(self)
Get DmsHook
.. method:: poke(self, context)
.. py:class:: DmsTaskCompletedSensor(*args, **kwargs)
Bases: :class:`airflow.providers.amazon.aws.sensors.dms_task.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
:type replication_task_arn: str
.. attribute:: template_fields
:annotation: = ['replication_task_arn']
.. attribute:: template_ext
:annotation: = []