amazon.aws.ec2_ami_info module – Gather information about EC2 AMIs

Note

This module is part of the amazon.aws collection (version 9.1.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install amazon.aws. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: amazon.aws.ec2_ami_info.

New in amazon.aws 1.0.0

Synopsis

  • Gather information about EC2 AMIs.

Requirements

The below requirements are needed on the host that executes this module.

  • python >= 3.6

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

Parameters

Parameter

Comments

access_key

aliases: aws_access_key_id, aws_access_key, ec2_access_key

string

AWS access key ID.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variables may also be used in decreasing order of preference.

The aws_access_key and profile options are mutually exclusive.

The aws_access_key_id alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_access_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_ACCESS_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

aws_ca_bundle

path

The location of a CA Bundle to use when validating SSL certificates.

The AWS_CA_BUNDLE environment variable may also be used.

aws_config

dictionary

A dictionary to modify the botocore configuration.

Parameters can be found in the AWS documentation https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.

debug_botocore_endpoint_logs

boolean

Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook.

The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.

Choices:

  • false ← (default)

  • true

describe_image_attributes

boolean

Describe attributes (like launchPermission) of the images found.

Choices:

  • false ← (default)

  • true

endpoint_url

aliases: ec2_url, aws_endpoint_url, s3_url

string

URL to connect to instead of the default AWS endpoints. While this can be used to connection to other AWS-compatible services the amazon.aws and community.aws collections are only tested against AWS.

The AWS_URL or EC2_URL environment variables may also be used, in decreasing order of preference.

The ec2_url and s3_url aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_URL environment variable has been deprecated and will be removed in a release after 2024-12-01.

executable_users

aliases: executable_user

list / elements=string

Filter images by users with explicit launch permissions. Valid options are an AWS account ID, self, or all (public AMIs).

Default: []

filters

dictionary

A dict of filters to apply. Each dict item consists of a filter key and a filter value.

See https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeImages.html for possible filters.

Filter names and values are case sensitive.

Default: {}

image_ids

aliases: image_id

list / elements=string

One or more image IDs.

Default: []

owners

aliases: owner

list / elements=string

Filter the images by the owner. Valid options are an AWS account ID, self, or an AWS owner alias ( amazon | aws-marketplace | microsoft ).

Default: []

profile

aliases: aws_profile

string

A named AWS profile to use for authentication.

See the AWS documentation for more information about named profiles https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html.

The AWS_PROFILE environment variable may also be used.

The profile option is mutually exclusive with the aws_access_key, aws_secret_key and security_token options.

region

aliases: aws_region, ec2_region

string

The AWS region to use.

For global services such as IAM, Route53 and CloudFront, region is ignored.

The AWS_REGION or EC2_REGION environment variables may also be used.

See the Amazon AWS documentation for more information http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.

The ec2_region alias has been deprecated and will be removed in a release after 2024-12-01

Support for the EC2_REGION environment variable has been deprecated and will be removed in a release after 2024-12-01.

secret_key

aliases: aws_secret_access_key, aws_secret_key, ec2_secret_key

string

AWS secret access key.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variables may also be used in decreasing order of preference.

The secret_key and profile options are mutually exclusive.

The aws_secret_access_key alias was added in release 5.1.0 for consistency with the AWS botocore SDK.

The ec2_secret_key alias has been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY environment variable has been deprecated and will be removed in a release after 2024-12-01.

session_token

aliases: aws_session_token, security_token, aws_security_token, access_token

string

AWS STS session token for use with temporary credentials.

See the AWS documentation for more information about access tokens https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys.

The AWS_SESSION_TOKEN, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variables may also be used in decreasing order of preference.

The security_token and profile options are mutually exclusive.

Aliases aws_session_token and session_token were added in release 3.2.0, with the parameter being renamed from security_token to session_token in release 6.0.0.

The security_token, aws_security_token, and access_token aliases have been deprecated and will be removed in a release after 2024-12-01.

Support for the EC2_SECRET_KEY and AWS_SECURITY_TOKEN environment variables has been deprecated and will be removed in a release after 2024-12-01.

validate_certs

boolean

When set to false, SSL certificates will not be validated for communication with the AWS APIs.

Setting validate_certs=false is strongly discouraged, as an alternative, consider setting aws_ca_bundle instead.

Choices:

  • false

  • true ← (default)

Notes

Note

  • Caution: For modules, environment variables and configuration files are read from the Ansible ‘host’ context and not the ‘controller’ context. As such, files may need to be explicitly copied to the ‘host’. For lookup and connection plugins, environment variables and configuration files are read from the Ansible ‘controller’ context and not the ‘host’ context.

  • The AWS SDK (boto3) that Ansible uses may also read defaults for credentials and other settings, such as the region, from its configuration files in the Ansible ‘host’ context (typically ~/.aws/credentials). See https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html for more information.

Examples

# 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-*"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

images

list / elements=dictionary

A list of images.

Returned: always

architecture

string

The architecture of the image.

Returned: always

Sample: "x86_64"

block_device_mappings

list / elements=dictionary

Any block device mapping entries.

Returned: always

device_name

string

The device name exposed to the instance.

Returned: always

Sample: "/dev/sda1"

ebs

complex

EBS volumes

Returned: always

creation_date

string

The date and time the image was created.

Returned: always

Sample: "2017-10-16T19:22:13.000Z"

description

string

The description of the AMI.

Returned: success

Sample: ""

ena_support

boolean

Whether enhanced networking with ENA is enabled.

Returned: always

Sample: true

hypervisor

string

The hypervisor type of the image.

Returned: always

Sample: "xen"

image_id

string

The ID of the AMI.

Returned: always

Sample: "ami-5b466623"

image_location

string

The location of the AMI.

Returned: always

Sample: "123456789012/Webapp"

image_type

string

The type of image.

Returned: always

Sample: "machine"

launch_permissions

list / elements=dictionary

A List of AWS accounts may launch the AMI.

Returned: When image is owned by calling account and describe_image_attributes=true.

Sample: [{"group": "all"}, {"user_id": "123456789012"}]

group

string

A value of ‘all’ means the AMI is public.

Returned: success

user_id

string

An AWS account ID with permissions to launch the AMI.

Returned: success

name

string

The name of the AMI that was provided during image creation.

Returned: always

Sample: "Webapp"

owner_id

string

The AWS account ID of the image owner.

Returned: always

Sample: "123456789012"

platform_details

string

Platform of image.

Returned: always

Sample: "Windows"

public

boolean

Whether the image has public launch permissions.

Returned: always

Sample: true

root_device_name

string

The device name of the root device.

Returned: always

Sample: "/dev/sda1"

root_device_type

string

The type of root device used by the AMI.

Returned: always

Sample: "ebs"

sriov_net_support

string

Whether enhanced networking is enabled.

Returned: success

Sample: "simple"

state

string

The current state of the AMI.

Returned: always

Sample: "available"

tags

dictionary

Any tags assigned to the image.

Returned: always

usage_operation

string

The operation of the Amazon EC2 instance and the billing code that is associated with the AMI.

Returned: always

Sample: "RunInstances"

virtualization_type

string

The type of virtualization of the AMI.

Returned: always

Sample: "hvm"

Authors

  • Prasad Katti (@prasadkatti)