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

import json
from functools import cached_property
from typing import TYPE_CHECKING, Sequence

from deprecated import deprecated

from airflow.exceptions import AirflowException, AirflowProviderDeprecationWarning, AirflowSkipException
from import StepFunctionHook
from airflow.sensors.base import BaseSensorOperator

    from airflow.utils.context import Context

[docs]class StepFunctionExecutionSensor(BaseSensorOperator): """ Poll the Step Function State Machine Execution until it reaches a terminal state; fails if the task fails. On successful completion of the Execution the Sensor will do an XCom Push of the State Machine's output to `output` .. seealso:: For more information on how to use this sensor, take a look at the guide: :ref:`howto/sensor:StepFunctionExecutionSensor` :param execution_arn: execution_arn to check the state of :param aws_conn_id: aws connection to use, defaults to 'aws_default' """
[docs] template_fields: Sequence[str] = ("execution_arn",)
[docs] template_ext: Sequence[str] = ()
[docs] ui_color = "#66c3ff"
def __init__( self, *, execution_arn: str, aws_conn_id: str = "aws_default", region_name: str | None = None, **kwargs, ): super().__init__(**kwargs) self.execution_arn = execution_arn self.aws_conn_id = aws_conn_id self.region_name = region_name
[docs] def poke(self, context: Context): execution_status = self.hook.describe_execution(self.execution_arn) state = execution_status["status"] output = json.loads(execution_status["output"]) if "output" in execution_status else None if state in self.FAILURE_STATES: # TODO: remove this if block when min_airflow_version is set to higher than 2.7.1 message = f"Step Function sensor failed. State Machine Output: {output}" if self.soft_fail: raise AirflowSkipException(message) raise AirflowException(message) if state in self.INTERMEDIATE_STATES: return False"Doing xcom_push of output") self.xcom_push(context, "output", output) return True
@deprecated(reason="use `hook` property instead.", category=AirflowProviderDeprecationWarning)
[docs] def get_hook(self) -> StepFunctionHook: """Create and return a StepFunctionHook.""" return self.hook
[docs] def hook(self) -> StepFunctionHook: return StepFunctionHook(aws_conn_id=self.aws_conn_id, region_name=self.region_name)

Was this entry helpful?