Source code for

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
from __future__ import annotations

from typing import TYPE_CHECKING, Iterable, Sequence

from deprecated import deprecated

from airflow.compat.functools import cached_property
from airflow.exceptions import AirflowException
from import DmsHook
from airflow.sensors.base import BaseSensorOperator

    from airflow.utils.context import Context

[docs]class DmsTaskBaseSensor(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 """
[docs] template_fields: Sequence[str] = ("replication_task_arn",)
[docs] template_ext: Sequence[str] = ()
def __init__( self, replication_task_arn: str, aws_conn_id="aws_default", target_statuses: Iterable[str] | None = None, termination_statuses: Iterable[str] | None = None, *args, **kwargs, ): super().__init__(*args, **kwargs) self.aws_conn_id = aws_conn_id self.replication_task_arn = replication_task_arn self.target_statuses: Iterable[str] = target_statuses or [] self.termination_statuses: Iterable[str] = termination_statuses or [] @deprecated(reason="use `hook` property instead.")
[docs] def get_hook(self) -> DmsHook: """Get DmsHook""" return self.hook
[docs] def hook(self) -> DmsHook: return DmsHook(self.aws_conn_id)
[docs] def poke(self, context: Context): status: str | None = self.hook.get_task_status(self.replication_task_arn) if not status: raise AirflowException( f"Failed to read task status, task with ARN {self.replication_task_arn} not found" )"DMS Replication task (%s) has status: %s", self.replication_task_arn, status) if status in self.target_statuses: return True if status in self.termination_statuses: raise AirflowException(f"Unexpected status: {status}") return False
[docs]class DmsTaskCompletedSensor(DmsTaskBaseSensor): """ Pokes DMS task until it is completed. .. seealso:: For more information on how to use this sensor, take a look at the guide: :ref:`howto/sensor:DmsTaskCompletedSensor` :param replication_task_arn: AWS DMS replication task ARN """
[docs] template_fields: Sequence[str] = ("replication_task_arn",)
[docs] template_ext: Sequence[str] = ()
def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) self.target_statuses = ["stopped"] self.termination_statuses = [ "creating", "deleting", "failed", "failed-move", "modifying", "moving", "ready", "testing",

Was this entry helpful?