community.aws.api_gateway_info 模块 – 收集 AWS 中 ec2 实例的信息

注意

此模块是 community.aws 集合（版本 9.0.0）的一部分。

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

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

要在 playbook 中使用它，请指定：community.aws.api_gateway_info。

community.aws 6.1.0 中的新增功能

概要

• 收集 AWS 中 ec2 实例的信息

要求

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

• 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 字符串	连接到的 URL，而不是默认的 AWS 端点。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，优先级依次降低。 ec2_url 和 s3_url 别名已被弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_URL 环境变量的支持已被弃用，将在 2024-12-01 之后的版本中删除。
ids 列表 / 元素=字符串	关联的 RestApi 的字符串标识符列表。
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 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 选项互斥。 别名 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 之后的版本中移除。
validate_certs 布尔值	当设置为 false 时，与 AWS API 通信时将不会验证 SSL 证书。 强烈建议不要设置 validate_certs=false，作为替代方案，请考虑设置 aws_ca_bundle。 选项 false true ← (默认)

备注

注意

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

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

示例

---
# List all API gateway
- name: List all for a specific function
  community.aws.api_gateway_info:

# Get information for a specific API gateway
- name: List all for a specific function
  community.aws.api_gateway_info:
    ids:
      - 012345678a
      - abcdefghij

返回值

常见的返回值记录在 这里，以下是此模块独有的字段

键	描述
rest_apis 复杂	API 网关列表。 返回： 始终
api_key_source 字符串	根据使用计划衡量请求的 API 密钥的来源。 返回： 成功 示例： "HEADER"
created_date 字符串	API 创建时的时间戳。 返回： 成功 示例： "2020-01-01T11:37:59+00:00"
description 字符串	API 的描述。 返回： 成功 示例： "Ansible 自动部署。"
disable_execute_api_endpoint 布尔值	指定客户端是否可以使用默认的 execute-api 端点调用您的 API。 返回： 成功 示例： false
endpoint_configuration 字典	此 RestApi 的端点配置，显示 API 的端点类型。 返回： 成功 示例： {"types": ["REGIONAL"]}
id 字符串	API 的标识符。 返回： 成功 示例： "abcdefgh"
name 字符串	API 的名称。 返回： 成功 示例： "ansible-tmp-api"
tags 字典	标签集合。 返回： 成功 示例： {"key": "value"}

作者

• Aubin Bikouo (@abikouo)

集合链接

• 问题跟踪器
• 存储库（源代码）
• 沟通