amazon.aws.lambda_execute 模块 – 执行 AWS Lambda 函数

注意

此模块是 amazon.aws 集合 (版本 9.0.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install amazon.aws。您需要其他要求才能使用此模块，请参阅 要求 获取详细信息。

要在 playbook 中使用它，请指定：amazon.aws.lambda_execute。

amazon.aws 5.0.0 中的新增功能

概要

• 此模块执行 AWS Lambda 函数，允许同步和异步调用。

• 在 5.0.0 版本之前，此模块称为 community.aws.execute_lambda。用法没有改变。

• 此模块最初添加到 community.aws 的 1.0.0 版本中。

别名：execute_lambda

要求

执行此模块的主机需要以下要求。

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名：aws_access_key_id, aws_access_key, ec2_access_key 字符串	AWS 访问密钥 ID。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 还可以按优先级递减的顺序使用 AWS_ACCESS_KEY_ID、AWS_ACCESS_KEY 或 EC2_ACCESS_KEY 环境变量。 aws_access_key 和 profile 选项是互斥的。 为与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已被弃用，将在 2024-12-01 之后的一个版本中删除。 EC2_ACCESS_KEY 环境变量的支持已被弃用，将在 2024-12-01 之后的一个版本中删除。
aws_ca_bundle 路径	验证 SSL 证书时要使用的 CA 证书包的位置。 还可以使用 AWS_CA_BUNDLE 环境变量。
aws_config 字典	用于修改 botocore 配置的字典。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
debug_botocore_endpoint_logs 布尔值	使用 botocore.endpoint 记录器来解析在任务期间进行的唯一（而不是总计）"resource:action" API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 aws_resource_action 回调将输出到 playbook 期间进行的总列表。 还可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选项 false ← (默认) true
dry_run 布尔值	不要实际调用函数。DryRun 调用将检查调用者是否有权调用函数，特别是对于检查跨帐户权限。 选项 false ← (默认) true
endpoint_url 别名：ec2_url, aws_endpoint_url, s3_url 字符串	连接到默认 AWS 端点以外的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 还可以按优先级递减的顺序使用 AWS_URL 或 EC2_URL 环境变量。 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的一个版本中删除。 EC2_URL 环境变量的支持已被弃用，将在 2024-12-01 之后的一个版本中删除。
function_arn 字符串	要调用的函数的名称
name 字符串	要调用的函数的名称。这只能用于调用帐户内的调用。要调用另一个帐户中的函数，请使用 function_arn 指定完整的 ARN。
payload 字典	以任何形式提供的字典，作为 Lambda 函数的输入。 默认值： {}
profile 别名：aws_profile 字符串	用于身份验证的命名 AWS 配置文件。 有关命名配置文件的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html。 还可以使用 AWS_PROFILE 环境变量。 profile 选项与 aws_access_key、aws_secret_key 和 security_token 选项互斥。
region 别名：aws_region, ec2_region 字符串	要使用的 AWS 区域。 对于 IAM、Route53 和 CloudFront 等全球服务，将忽略 region。 还可以使用 AWS_REGION 或 EC2_REGION 环境变量。 有关更多信息，请参阅 Amazon AWS 文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。 别名 ec2_region 已弃用，将在 2024-12-01 之后的发行版中移除。 对环境变量 EC2_REGION 的支持已弃用，将在 2024-12-01 之后的发行版中移除。
secret_key 别名：aws_secret_access_key, aws_secret_key, ec2_secret_key 字符串	AWS 密钥。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用环境变量 AWS_SECRET_ACCESS_KEY、AWS_SECRET_KEY 或 EC2_SECRET_KEY，优先级依次递减。 secret_key 和 profile 选项互斥。 别名 aws_secret_access_key 在 5.1.0 版本中添加，以与 AWS botocore SDK 保持一致。 别名 ec2_secret_key 已弃用，将在 2024-12-01 之后的发行版中移除。 对环境变量 EC2_SECRET_KEY 的支持已弃用，将在 2024-12-01 之后的发行版中移除。
session_token 别名：aws_session_token, security_token, aws_security_token, access_token 字符串	用于临时凭据的 AWS STS 会话令牌。 有关访问令牌的更多信息，请参阅 AWS 文档 https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys。 也可以使用环境变量 AWS_SESSION_TOKEN、AWS_SECURITY_TOKEN 或 EC2_SECURITY_TOKEN，优先级依次递减。 security_token 和 profile 选项互斥。 别名 aws_session_token 和 session_token 在 3.2.0 版本中添加，参数名称在 6.0.0 版本中从 security_token 重命名为 session_token。 别名 security_token、aws_security_token 和 access_token 已弃用，将在 2024-12-01 之后的发行版中移除。 对环境变量 EC2_SECRET_KEY 和 AWS_SECURITY_TOKEN 的支持已弃用，将在 2024-12-01 之后的发行版中移除。
tail_log 布尔值	如果 tail_log=true，任务的结果将包含函数执行的 CloudWatch 日志的最后 4 KB。只有在使用同步调用 wait=true 时，日志尾随才有效。这通常用于开发或测试 Lambda 函数。 选项 false ← (默认) true
validate_certs 布尔值	设置为 false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置 validate_certs=false，请考虑改用 aws_ca_bundle。 选项 false true ← (默认)
version_qualifier 字符串	要运行的函数版本/别名。默认为 LATEST 版本，但可以设置为任何现有版本或别名。详情请参见 https://docs.aws.amazon.com/lambda/latest/dg/versioning-aliases.html。
wait 布尔值	是否等待函数结果。如果 wait=no，任务将不返回任何结果。要等待 Lambda 函数完成，请设置为 wait=true，结果将出现在 output 密钥中。 选项 false true ← (默认)

备注

注意

• 异步调用始终返回空的 result.output 密钥。

• 同步调用可能导致函数超时，从而导致 result.output 密钥为空。

• 注意：对于模块，环境变量和配置文件是从 Ansible 的“主机”上下文而不是“控制器”上下文读取的。因此，可能需要将文件显式复制到“主机”。对于查找和连接插件，环境变量和配置文件是从 Ansible 的“控制器”上下文而不是“主机”上下文读取的。

• Ansible 使用的 AWS SDK (boto3) 也可能从 Ansible “主机”上下文（通常为 ~/.aws/credentials）中的配置文件读取凭据和其他设置的默认值，例如区域。更多信息请参见 https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html。

示例

- amazon.aws.lambda_execute:
    name: test-function
    # the payload is automatically serialized and sent to the function
    payload:
      foo: bar
      value: 8
  register: response

# Test that you have sufficient permissions to execute a Lambda function in
# another account
- amazon.aws.lambda_execute:
    function_arn: arn:aws:lambda:us-east-1:123456789012:function/some-function
    dry_run: true

- amazon.aws.lambda_execute:
    name: test-function
    payload:
      foo: bar
      value: 8
    wait: true
    tail_log: true
  register: response
  # the response will have a `logs` key that will contain a log (up to 4KB) of the function execution in Lambda

# Pass the Lambda event payload as a json file.
- amazon.aws.lambda_execute:
    name: test-function
    payload: "{{ lookup('file','lambda_event.json') }}"
  register: response

- amazon.aws.lambda_execute:
    name: test-function
    version_qualifier: PRODUCTION

返回值

常用返回值已在 此处 记录，以下是此模块特有的字段

键	描述
result 字典	成功任务执行的结果数据结构。 返回值：success
logs 字符串	函数日志的最后 4KB。仅当 tail_log=true 时提供。 返回值：如果 tail_log=true
output 字典	如果 wait=true 且函数返回值，则为函数输出。 返回值：success 示例： {"output": "something"}
status 整数	API 调用的 StatusCode 退出状态（同步调用为 200，异步调用为 202）。 返回值：始终 示例： 200

作者

• Ryan Scott Brown (@ryansb)

资源链接

• 问题追踪器
• 代码仓库
• 通信