Source code for airflow.providers.amazon.aws.sensors.kinesis_analytics
# 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## http://www.apache.org/licenses/LICENSE-2.0## Unless required by applicable law or agreed to in writing,# software distributed under the License is distributed on an# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY# KIND, either express or implied. See the License for the# specific language governing permissions and limitations# under the License.from__future__importannotationsfromtypingimportTYPE_CHECKING,Any,Sequencefromairflow.configurationimportconffromairflow.exceptionsimportAirflowExceptionfromairflow.providers.amazon.aws.hooks.kinesis_analyticsimportKinesisAnalyticsV2Hookfromairflow.providers.amazon.aws.sensors.base_awsimportAwsBaseSensorfromairflow.providers.amazon.aws.triggers.kinesis_analyticsimport(KinesisAnalyticsV2ApplicationOperationCompleteTrigger,)fromairflow.providers.amazon.aws.utils.mixinsimportaws_template_fieldsifTYPE_CHECKING:fromairflow.utils.contextimportContext
[docs]classKinesisAnalyticsV2BaseSensor(AwsBaseSensor[KinesisAnalyticsV2Hook]):""" General sensor behaviour for AWS Managed Service for Apache Flink. Subclasses must set the following fields: - ``INTERMEDIATE_STATES`` - ``FAILURE_STATES`` - ``SUCCESS_STATES`` - ``FAILURE_MESSAGE`` - ``SUCCESS_MESSAGE`` :param application_name: Application name. :param deferrable: If True, the sensor will operate in deferrable mode. This mode requires aiobotocore module to be installed. (default: False, but can be overridden in config file by setting default_deferrable to True) """
[docs]defpoke(self,context:Context,**kwargs)->bool:status=self.hook.conn.describe_application(ApplicationName=self.application_name)["ApplicationDetail"]["ApplicationStatus"]self.log.info("Poking for AWS Managed Service for Apache Flink application: %s status: %s",self.application_name,status,)ifstatusinself.FAILURE_STATES:raiseAirflowException(self.FAILURE_MESSAGE)ifstatusinself.SUCCESS_STATES:self.log.info("%s `%s`.",self.SUCCESS_MESSAGE,self.application_name,)returnTruereturnFalse
[docs]classKinesisAnalyticsV2StartApplicationCompletedSensor(KinesisAnalyticsV2BaseSensor):""" Waits for AWS Managed Service for Apache Flink application to start. .. seealso:: For more information on how to use this sensor, take a look at the guide: :ref:`howto/sensor:KinesisAnalyticsV2StartApplicationCompletedSensor` :param application_name: Application name. :param deferrable: If True, the sensor will operate in deferrable mode. This mode requires aiobotocore module to be installed. (default: False, but can be overridden in config file by setting default_deferrable to True) :param poke_interval: Polling period in seconds to check for the status of the job. (default: 120) :param max_retries: Number of times before returning the current state. (default: 75) :param aws_conn_id: The Airflow connection used for AWS credentials. If this is ``None`` or empty then the default boto3 behaviour is used. If running Airflow in a distributed manner and aws_conn_id is None or empty, then default boto3 configuration would be used (and must be maintained on each worker node). :param region_name: AWS region_name. If not specified then the default boto3 behaviour is used. :param verify: Whether to verify SSL certificates. See: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html :param botocore_config: Configuration dictionary (key-values) for botocore client. See: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html """
[docs]classKinesisAnalyticsV2StopApplicationCompletedSensor(KinesisAnalyticsV2BaseSensor):""" Waits for AWS Managed Service for Apache Flink application to stop. .. seealso:: For more information on how to use this sensor, take a look at the guide: :ref:`howto/sensor:KinesisAnalyticsV2StopApplicationCompletedSensor` :param application_name: Application name. :param deferrable: If True, the sensor will operate in deferrable mode. This mode requires aiobotocore module to be installed. (default: False, but can be overridden in config file by setting default_deferrable to True) :param poke_interval: Polling period in seconds to check for the status of the job. (default: 120) :param max_retries: Number of times before returning the current state. (default: 75) :param aws_conn_id: The Airflow connection used for AWS credentials. If this is ``None`` or empty then the default boto3 behaviour is used. If running Airflow in a distributed manner and aws_conn_id is None or empty, then default boto3 configuration would be used (and must be maintained on each worker node). :param region_name: AWS region_name. If not specified then the default boto3 behaviour is used. :param verify: Whether to verify SSL certificates. See: https://boto3.amazonaws.com/v1/documentation/api/latest/reference/core/session.html :param botocore_config: Configuration dictionary (key-values) for botocore client. See: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html """