Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Standardize AwsLambda #25100

Merged
merged 3 commits into from
Jul 19, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
90 changes: 8 additions & 82 deletions airflow/providers/amazon/aws/operators/aws_lambda.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,88 +15,14 @@
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
"""This module is deprecated. Please use :mod:`airflow.providers.amazon.aws.operators.lambda_function`."""

import json
from typing import TYPE_CHECKING, Optional, Sequence
import warnings

from airflow.models import BaseOperator
from airflow.providers.amazon.aws.hooks.lambda_function import LambdaHook
from airflow.providers.amazon.aws.operators.lambda_function import AwsLambdaInvokeFunctionOperator # noqa

if TYPE_CHECKING:
from airflow.utils.context import Context


class AwsLambdaInvokeFunctionOperator(BaseOperator):
"""
Invokes an AWS Lambda function.
You can invoke a function synchronously (and wait for the response),
or asynchronously.
To invoke a function asynchronously,
set `invocation_type` to `Event`. For more details,
review the boto3 Lambda invoke docs.

:param function_name: The name of the AWS Lambda function, version, or alias.
:param payload: The JSON string that you want to provide to your Lambda function as input.
:param log_type: Set to Tail to include the execution log in the response. Otherwise, set to "None".
:param qualifier: Specify a version or alias to invoke a published version of the function.
:param aws_conn_id: The AWS connection ID to use

.. seealso::
For more information on how to use this operator, take a look at the guide:
:ref:`howto/operator:AwsLambdaInvokeFunctionOperator`

"""

template_fields: Sequence[str] = ('function_name', 'payload', 'qualifier', 'invocation_type')
ui_color = '#ff7300'

def __init__(
self,
*,
function_name: str,
log_type: Optional[str] = None,
qualifier: Optional[str] = None,
invocation_type: Optional[str] = None,
client_context: Optional[str] = None,
payload: Optional[str] = None,
aws_conn_id: str = 'aws_default',
**kwargs,
):
super().__init__(**kwargs)
self.function_name = function_name
self.payload = payload
self.log_type = log_type
self.qualifier = qualifier
self.invocation_type = invocation_type
self.client_context = client_context
self.aws_conn_id = aws_conn_id

def execute(self, context: 'Context'):
"""
Invokes the target AWS Lambda function from Airflow.

:return: The response payload from the function, or an error object.
"""
hook = LambdaHook(aws_conn_id=self.aws_conn_id)
success_status_codes = [200, 202, 204]
self.log.info("Invoking AWS Lambda function: %s with payload: %s", self.function_name, self.payload)
response = hook.invoke_lambda(
function_name=self.function_name,
invocation_type=self.invocation_type,
log_type=self.log_type,
client_context=self.client_context,
payload=self.payload,
qualifier=self.qualifier,
)
self.log.info("Lambda response metadata: %r", response.get("ResponseMetadata"))
if response.get("StatusCode") not in success_status_codes:
raise ValueError('Lambda function did not execute', json.dumps(response.get("ResponseMetadata")))
payload_stream = response.get("Payload")
payload = payload_stream.read().decode()
if "FunctionError" in response:
raise ValueError(
'Lambda function execution resulted in error',
{"ResponseMetadata": response.get("ResponseMetadata"), "Payload": payload},
)
self.log.info('Lambda function invocation succeeded: %r', response.get("ResponseMetadata"))
return payload
warnings.warn(
"This module is deprecated. Please use `airflow.providers.amazon.aws.operators.lambda_function`.",
DeprecationWarning,
stacklevel=2,
)
102 changes: 102 additions & 0 deletions airflow/providers/amazon/aws/operators/lambda_function.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
#
# 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.

import json
from typing import TYPE_CHECKING, Optional, Sequence

from airflow.models import BaseOperator
from airflow.providers.amazon.aws.hooks.lambda_function import LambdaHook

if TYPE_CHECKING:
from airflow.utils.context import Context


class AwsLambdaInvokeFunctionOperator(BaseOperator):
"""
Invokes an AWS Lambda function.
You can invoke a function synchronously (and wait for the response),
or asynchronously.
To invoke a function asynchronously,
set `invocation_type` to `Event`. For more details,
review the boto3 Lambda invoke docs.

:param function_name: The name of the AWS Lambda function, version, or alias.
:param payload: The JSON string that you want to provide to your Lambda function as input.
:param log_type: Set to Tail to include the execution log in the response. Otherwise, set to "None".
:param qualifier: Specify a version or alias to invoke a published version of the function.
:param aws_conn_id: The AWS connection ID to use

.. seealso::
For more information on how to use this operator, take a look at the guide:
:ref:`howto/operator:AwsLambdaInvokeFunctionOperator`

"""

template_fields: Sequence[str] = ('function_name', 'payload', 'qualifier', 'invocation_type')
ui_color = '#ff7300'

def __init__(
self,
*,
function_name: str,
log_type: Optional[str] = None,
qualifier: Optional[str] = None,
invocation_type: Optional[str] = None,
client_context: Optional[str] = None,
payload: Optional[str] = None,
aws_conn_id: str = 'aws_default',
**kwargs,
):
super().__init__(**kwargs)
self.function_name = function_name
self.payload = payload
self.log_type = log_type
self.qualifier = qualifier
self.invocation_type = invocation_type
self.client_context = client_context
self.aws_conn_id = aws_conn_id

def execute(self, context: 'Context'):
"""
Invokes the target AWS Lambda function from Airflow.

:return: The response payload from the function, or an error object.
"""
hook = LambdaHook(aws_conn_id=self.aws_conn_id)
success_status_codes = [200, 202, 204]
self.log.info("Invoking AWS Lambda function: %s with payload: %s", self.function_name, self.payload)
response = hook.invoke_lambda(
function_name=self.function_name,
invocation_type=self.invocation_type,
log_type=self.log_type,
client_context=self.client_context,
payload=self.payload,
qualifier=self.qualifier,
)
self.log.info("Lambda response metadata: %r", response.get("ResponseMetadata"))
if response.get("StatusCode") not in success_status_codes:
raise ValueError('Lambda function did not execute', json.dumps(response.get("ResponseMetadata")))
payload_stream = response.get("Payload")
payload = payload_stream.read().decode()
if "FunctionError" in response:
raise ValueError(
'Lambda function execution resulted in error',
{"ResponseMetadata": response.get("ResponseMetadata"), "Payload": payload},
)
self.log.info('Lambda function invocation succeeded: %r', response.get("ResponseMetadata"))
return payload
1 change: 1 addition & 0 deletions airflow/providers/amazon/provider.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -288,6 +288,7 @@ operators:
- integration-name: AWS Lambda
python-modules:
- airflow.providers.amazon.aws.operators.aws_lambda
potiuk marked this conversation as resolved.
Show resolved Hide resolved
- airflow.providers.amazon.aws.operators.lambda_function
- integration-name: Amazon Simple Storage Service (S3)
python-modules:
- airflow.providers.amazon.aws.operators.s3_bucket
Expand Down
1 change: 1 addition & 0 deletions scripts/in_container/verify_providers.py
Original file line number Diff line number Diff line change
Expand Up @@ -247,6 +247,7 @@ class ProviderPackageDetails(NamedTuple):
'This module is deprecated. Please use `airflow.providers.amazon.aws.sensors.redshift_cluster`.',
"This module is deprecated. Please use airflow.providers.amazon.aws.transfers.sql_to_s3`.",
"This module is deprecated. Please use `airflow.providers.tableau.sensors.tableau`.",
"This module is deprecated. Please use `airflow.providers.amazon.aws.operators.lambda_function`.",
}


Expand Down
4 changes: 4 additions & 0 deletions tests/deprecated_classes.py
Original file line number Diff line number Diff line change
Expand Up @@ -1131,6 +1131,10 @@
'airflow.providers.amazon.aws.operators.s3.S3FileTransformOperator',
'airflow.operators.s3_file_transform_operator.S3FileTransformOperator',
),
(
"airflow.providers.amazon.aws.operators.lambda_function.AwsLambdaInvokeFunctionOperator",
"airflow.providers.amazon.aws.operators.aws_lambda.AwsLambdaInvokeFunctionOperator",
),
(
'airflow.providers.amazon.aws.operators.sagemaker.SageMakerBaseOperator',
'airflow.providers.amazon.aws.operators.sagemaker_base.SageMakerBaseOperator',
Expand Down
2 changes: 1 addition & 1 deletion tests/providers/amazon/aws/operators/test_lambda.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@

from airflow.providers.amazon.aws.hooks.base_aws import AwsBaseHook
from airflow.providers.amazon.aws.hooks.lambda_function import LambdaHook
from airflow.providers.amazon.aws.operators.aws_lambda import AwsLambdaInvokeFunctionOperator
from airflow.providers.amazon.aws.operators.lambda_function import AwsLambdaInvokeFunctionOperator


@mock_lambda
Expand Down
2 changes: 1 addition & 1 deletion tests/system/providers/amazon/aws/example_lambda.py
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
from airflow import models
from airflow.decorators import task
from airflow.models.baseoperator import chain
from airflow.providers.amazon.aws.operators.aws_lambda import AwsLambdaInvokeFunctionOperator
from airflow.providers.amazon.aws.operators.lambda_function import AwsLambdaInvokeFunctionOperator
from airflow.utils.trigger_rule import TriggerRule
from tests.system.providers.amazon.aws.utils import ENV_ID_KEY, SystemTestContextBuilder

Expand Down