amazon.aws.lambda_info 模块 – 收集 AWS Lambda 函数详细信息

注意

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

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

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

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

amazon.aws 5.0.0 中的新增功能

概要

• 收集与 Lambda 函数相关的各种详细信息，包括别名、版本和事件源映射。

• 使用模块 amazon.aws.lambda 来管理 lambda 函数本身，amazon.aws.lambda_alias 来管理函数别名，amazon.aws.lambda_event 来管理 lambda 事件源映射，以及 amazon.aws.lambda_policy 来管理策略语句。

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

要求

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

• 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
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 之后的一个版本中删除。
event_source_arn 字符串	当 query=mappings 时，这是 Amazon Kinesis 或 DynamoDB 流的 Amazon 资源名称 (ARN)。
function_name 别名：function, name 字符串	请求信息的 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 选项互斥。
query 字符串	指定要收集信息的资源类型。 当指定 function_name 时，默认为 all。 当未指定 function_name 时，默认为 config。 选项 "aliases" "all" "config" "mappings" "policy" "versions" "tags"
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 botocore SDK 保持一致，在 5.1.0 版本中添加了aws_secret_access_key 别名。 别名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 选项是互斥的。 在 3.2.0 版本中添加了别名aws_session_token 和 session_token，在 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 之后的一个版本中删除。
validate_certs 布尔值	设置为false 时，将不会验证与 AWS API 通信的 SSL 证书。 强烈建议不要设置validate_certs=false，作为替代方案，请考虑改用aws_ca_bundle。 选项 false true ← (默认)

注释

注意

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

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

示例

---
# Simple example of listing all info for a function
- name: List all for a specific function
  amazon.aws.lambda_info:
    query: all
    function_name: myFunction
  register: my_function_details

# Get basic information about AWS Lambda Functions in the current region
- name: List Lambda Functions
  amazon.aws.lambda_info:
  register: lambda_functions

# List all versions of a function
- name: List function versions
  amazon.aws.lambda_info:
    query: versions
    function_name: myFunction
  register: my_function_versions

# List all info for all functions
- name: List all functions
  amazon.aws.lambda_info:
    query: all
  register: output

- name: show Lambda information
  ansible.builtin.debug:
    msg: "{{ output['function'] }}"

返回值

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

键	描述
function 字典	Lambda 函数列表。 function 已弃用，将在 2025-01-01 之后的下个主要版本中删除。 返回：成功
function.TheName 字典	Lambda 函数信息，包括事件、映射和版本信息。 function 已弃用，将在 2025-01-01 之后的下个主要版本中删除。 返回：成功
functions 列表 / 元素=字典 在 community.aws 4.1.0 中添加	与查询匹配的每个 Lambda 函数的信息列表。 返回：始终
aliases 列表 / 元素=字符串	与函数关联的别名。 返回：当 query=aliases 或 query=all 时
architectures 列表 / 元素=字符串	函数支持的架构。 返回：成功 示例：["arm64"]
code_sha256 字符串	函数部署包的 SHA256 哈希值。 返回：成功 示例："zOAGfF5JLFuzZoSNirUtOrQp+S341IOA3BcoXXoaIaU="
code_size 整数	函数部署包的大小（以字节为单位）。 返回：成功 示例：123
dead_letter_config 字典	函数的死信队列。 返回：当函数配置了死信队列时 示例：{"target_arn": "arn:aws:lambda:us-east-1:123456789012:function:myFunction:1"}
target_arn 字符串	SQS 队列或 SNS 主题的 ARN。 返回：当函数配置了死信队列时 示例："arn:aws:lambda:us-east-1:123456789012:function:myFunction:1"
description 字符串	函数的描述。 返回：成功 示例："My function"
environment 字典	函数的环境变量。 返回：当存在环境变量时
error 字典	无法应用的环境变量的错误消息。 返回：当应用环境变量时发生错误时
error_code 字符串	错误代码。 返回：当应用环境变量时发生错误时
message 字符串	错误消息。 返回：当应用环境变量时发生错误时
variables 字典	环境变量键值对。 返回：当存在环境变量时 示例：{"key": "value"}
ephermal_storage 字典	函数 /tmp 目录的大小（以 MB 为单位）。 返回：成功
size 整数	函数 /tmp 目录的大小。 返回：始终 示例：512
function_arn 字符串	函数的 Amazon 资源名称 (ARN)。 返回：成功时 示例："arn:aws:lambda:us-east-1:123456789012:function:myFunction:1"
function_name 字符串	函数的名称。 返回：成功时 示例："myFunction"
handler 字符串	Lambda 调用以开始执行函数的函数。 返回：成功时 示例："index.handler"
last_modified 字符串	上次更新函数的日期和时间，采用 ISO-8601 格式 (YYYY-MM-DDThh:mm:ssTZD)。 返回：成功时 示例："2017-08-01T00:00:00.000+0000"
mappings 列表 / 元素=字典	每个事件源映射的配置信息列表。 返回：当 query=all 或 query=mappings 时
batch_size 整数	AWS Lambda 在调用函数时将从事件源检索到的最大记录数。 返回：成功时
event_source_arn 字符串	充当事件源的 Amazon Kinesis 或 DynamoDB 流的 ARN。 返回：成功时
function_arn 字符串	当 AWS Lambda 检测到基于轮询的源上的事件时要调用的 Lambda 函数。 返回：成功时
last_modified 字符串	指示上次更新事件映射的 UTC 时间字符串。 返回：成功时
last_processing_result 字符串	上次 AWS Lambda 调用 Lambda 函数的结果。 返回：成功时
state 字符串	事件源映射的状态。 返回：成功时
state_transition_reason 字符串	事件源映射处于当前状态的原因。 返回：成功时
uuid 字符串	AWS Lambda 为映射分配的不透明标识符。 返回：成功时
memory_size 整数	分配给函数的内存。 返回：成功时 示例：128
package_type 字符串	部署包的类型。 返回：始终 示例："Zip"
policy 字典	与函数关联的策略。 返回：当 query=all 或 query=policy 时
revision_id 字符串	函数或别名的最新更新版本。 返回：成功时 示例："a2x9886d-d48a-4a0c-ab64-82abc005x80c"
role 字符串	函数的执行角色。 返回：成功时 示例："arn:aws:iam::123456789012:role/lambda_basic_execution"
runtime 字符串	Lambda 函数的运行时环境。 返回：成功时 示例："nodejs6.10"
runtime_version_config 字典	运行时的 ARN 和发生的任何错误。 返回：成功
runtime_version_arn 字符串	您希望函数使用的运行时版本的 ARN。 返回：始终 示例："arn:aws:lambda:us-west-2::runtime:123456789012"
snap_start 字典	发布函数版本时初始化的执行环境的快照。 返回：成功
apply_on 字符串	设置为PublishedVersions时，Lambda 会在您发布函数版本时创建执行环境的快照。 返回：始终 示例： "None"
optimization_status 字符串	此元素指示是否为指定的函数版本激活了 SnapStart。 返回：始终 示例： "Off"
timeout 整数	Lambda 允许函数运行的时间量，超过此时间将终止函数。 返回：成功时 示例： 3
tracing_config 字典	函数的 AWS X-Ray 追踪配置。 返回：成功时 示例： {"mode": "Active"}
mode 字符串	追踪模式。 返回：成功时 示例： "Active"
version 字符串	Lambda 函数的版本。 返回：成功时 示例： "1"
versions 列表 / 元素=字典	Lambda 函数版本的列表。 返回： 当 query=all 或 query=versions 时
vpc_config 字典	函数的网络配置。 返回：成功时 示例： {"security_group_ids": [], "subnet_ids": [], "vpc_id": "123"}

作者

• Pierre Jodouin (@pjodouin)

资源链接

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