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 字符串	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
describe_image_attributes 布尔值	描述找到的镜像的属性（如 launchPermission）。 选项 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 后的某个版本中删除。
executable_users 别名：executable_user 列表 / 元素=字符串	按具有显式启动权限的用户过滤镜像。有效选项是 AWS 账户 ID、self 或 all（公共 AMI）。 默认值： []
filters 字典	要应用的过滤器字典。每个字典项包含一个过滤器键和一个过滤器值。 有关可能的过滤器，请参阅 https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html。 过滤器名称和值区分大小写。 默认值： {}
image_ids 别名：image_id 列表 / 元素=字符串	一个或多个镜像 ID。 默认值： []
owners 别名：owner 列表 / 元素=字符串	按所有者过滤镜像。有效选项是 AWS 账户 ID、self 或 AWS 所有者别名 (amazon | aws-marketplace | microsoft)。 默认值： []
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 选项互斥。 在 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。

示例

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

作者

• Prasad Katti (@prasadkatti)

资源链接

• 问题追踪
• 代码库 (源码)
• 沟通