amazon.aws.ec2_ami_info 模块 – 收集有关 EC2 AMI 的信息

注意

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

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

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

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

amazon.aws 1.0.0 中的新增功能

概要

• 收集有关 EC2 AMI 的信息。

要求

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

• python >= 3.6

• boto3 >= 1.28.0

• botocore >= 1.31.0

参数

参数	注释
access_key 别名：aws_access_key_id、aws_access_key、ec2_access_key string	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_access_key_id 别名在 5.1.0 版本中添加，以便与 AWS botocore SDK 保持一致。 ec2_access_key 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_ACCESS_KEY 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
aws_ca_bundle path	验证 SSL 证书时要使用的 CA 捆绑包的位置。 也可以使用 AWS_CA_BUNDLE 环境变量。
aws_config dictionary	用于修改 botocore 配置的字典。 可以在 AWS 文档中找到参数 https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config。
debug_botocore_endpoint_logs boolean	使用 botocore.endpoint 记录器解析任务期间进行的唯一（而不是总数）"resource:action" API 调用，将集合输出到任务结果中的 resource_actions 键。使用 aws_resource_action 回调输出 playbook 期间生成的总列表。 也可以使用 ANSIBLE_DEBUG_BOTOCORE_LOGS 环境变量。 选择 false ← (默认) true
describe_image_attributes boolean	描述找到的映像的属性（如 launchPermission）。 选择 false ← (默认) true
endpoint_url 别名：ec2_url、aws_endpoint_url、s3_url string	连接到而不是默认 AWS 端点的 URL。虽然这可以用于连接到其他与 AWS 兼容的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行测试。 也可以使用 AWS_URL 或 EC2_URL 环境变量，按优先级递减的顺序使用。 ec2_url 和 s3_url 别名已弃用，将在 2024-12-01 之后的版本中删除。 对 EC2_URL 环境变量的支持已弃用，将在 2024-12-01 之后的版本中删除。
executable_users 别名：executable_user list / elements=string	按具有显式启动权限的用户筛选映像。有效选项是 AWS 账户 ID、self 或 all（公共 AMI）。 默认: []
filters dictionary	要应用的筛选器字典。每个字典项都包含一个筛选器键和一个筛选器值。 有关可能的筛选器，请参阅 https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html。 筛选器名称和值区分大小写。 默认: {}
image_ids 别名：image_id list / elements=string	一个或多个映像 ID。 默认: []
owners 别名：owner list / elements=string	按所有者筛选镜像。有效选项为 AWS 账户 ID、self 或 AWS 所有者别名（amazon | aws-marketplace | microsoft）。 默认: []
profile 别名：aws_profile string	用于身份验证的已命名 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 string	要使用的 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 string	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 string	用于临时凭证的 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 boolean	如果设置为 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。

示例

# Note: These examples do not set authentication details, see the AWS Guide for details.

- name: gather information about an AMI using ami-id
  amazon.aws.ec2_ami_info:
    image_ids: ami-5b488823

- name: gather information about all AMIs with tag key Name and value webapp
  amazon.aws.ec2_ami_info:
    filters:
      "tag:Name": webapp

- name: gather information about an AMI with 'AMI Name' equal to foobar
  amazon.aws.ec2_ami_info:
    filters:
      name: foobar

- name: gather information about Ubuntu 17.04 AMIs published by Canonical (099720109477)
  amazon.aws.ec2_ami_info:
    owners: 099720109477
    filters:
      name: "ubuntu/images/ubuntu-zesty-17.04-*"

返回值

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

键	描述
images 列表 / 元素=字典	镜像列表。 返回： 始终
architecture string	镜像的架构。 返回： 始终 示例： "x86_64"
block_device_mappings 列表 / 元素=字典	任何块设备映射条目。 返回： 始终
device_name string	暴露给实例的设备名称。 返回： 始终 示例： "/dev/sda1"
ebs 复杂	EBS 卷 返回： 始终
creation_date string	创建镜像的日期和时间。 返回： 始终 示例： "2017-10-16T19:22:13.000Z"
description string	AMI 的描述。 返回： 成功 示例： ""
ena_support boolean	是否启用 ENA 增强联网。 返回： 始终 示例： true
hypervisor string	镜像的虚拟机监控程序类型。 返回： 始终 示例： "xen"
image_id string	AMI 的 ID。 返回： 始终 示例： "ami-5b466623"
image_location string	AMI 的位置。 返回： 始终 示例： "123456789012/Webapp"
image_type string	镜像的类型。 返回： 始终 示例： "machine"
launch_permissions 列表 / 元素=字典	可以启动 AMI 的 AWS 账户列表。 返回： 当镜像由调用帐户拥有且 describe_image_attributes=true 时。 示例： [{"group": "all"}, {"user_id": "123456789012"}]
group string	值为“all”表示 AMI 是公共的。 返回： 成功
user_id string	具有启动 AMI 权限的 AWS 账户 ID。 返回： 成功
name string	在镜像创建期间提供的 AMI 名称。 返回： 始终 示例： "Webapp"
owner_id string	镜像所有者的 AWS 账户 ID。 返回： 始终 示例： "123456789012"
platform_details string	镜像的平台。 返回： 始终 示例： "Windows"
public boolean	镜像是否具有公共启动权限。 返回： 始终 示例： true
root_device_name string	根设备的设备名称。 返回： 始终 示例： "/dev/sda1"
root_device_type string	AMI 使用的根设备类型。 返回： 始终 示例： "ebs"
sriov_net_support string	是否启用增强联网。 返回： 成功 示例： "simple"
state string	AMI 的当前状态。 返回： 始终 示例： "available"
tags dictionary	分配给镜像的任何标签。 返回： 始终
usage_operation string	Amazon EC2 实例的操作以及与 AMI 关联的计费代码。 返回： 始终 示例： "RunInstances"
virtualization_type string	AMI 的虚拟化类型。 返回： 始终 示例： "hvm"

作者

• Prasad Katti (@prasadkatti)

集合链接

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