ec2_ami_facts – Gather facts about ec2 AMIs — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ec2_ami_facts – Gather facts about ec2 AMIs

New in version 2.5.

- Synopsis
- Requirements
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Gather facts about ec2 AMIs

## Requirements

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

- boto
- boto3
- python >= 2.6

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
aws_access_key string |  | AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used. aliases: ec2_access_key, access_key
aws_secret_key string |  | AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used. aliases: ec2_secret_key, secret_key
debug_botocore_endpoint_logs boolean added in 2.8 | Choices: no ← yes | 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.
describe_image_attributes boolean | Choices: no ← yes | Describe attributes (like launchPermission) of the images found.
ec2_url string |  | Url to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
executable_users - |  | Filter images by users with explicit launch permissions. Valid options are an AWS account ID, self, or all (public AMIs). aliases: executable_user
filters - |  | 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.
image_ids - |  | One or more image IDs. aliases: image_id
owners - |  | Filter the images by the owner. Valid options are an AWS account ID, self, or an AWS owner alias ( amazon | aws-marketplace | microsoft ). aliases: owner
profile string |  | Uses a boto profile. Only works with boto >= 2.24.0.
region string |  | The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region aliases: aws_region, ec2_region
security_token string |  | AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used. aliases: access_token
validate_certs boolean | Choices: no yes ← | When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

## Notes

Note

- If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence `AWS_URL` or `EC2_URL`, `AWS_ACCESS_KEY_ID` or `AWS_ACCESS_KEY` or `EC2_ACCESS_KEY`, `AWS_SECRET_ACCESS_KEY` or `AWS_SECRET_KEY` or `EC2_SECRET_KEY`, `AWS_SECURITY_TOKEN` or `EC2_SECURITY_TOKEN`, `AWS_REGION` or `EC2_REGION`
- Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
- `AWS_REGION` or `EC2_REGION` can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

## Examples

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

    - name: gather facts about an AMI using ami-id
      ec2_ami_facts:
        image_ids: ami-5b488823

    - name: gather facts about all AMIs with tag key Name and value webapp
      ec2_ami_facts:
        filters:
          "tag:Name": webapp

    - name: gather facts about an AMI with 'AMI Name' equal to foobar
      ec2_ami_facts:
        filters:
          name: foobar

    - name: gather facts about Ubuntu 17.04 AMIs published by Canonical (099720109477)
      ec2_ami_facts:
        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 | Returned | Description
--- | --- | ---
images complex | always | a list of images
| architecture string | always | The architecture of the image Sample: x86_64
| block_device_mappings complex | always | Any block device mapping entries
|  | device_name string | always | The device name exposed to the instance Sample: /dev/sda1
|  | ebs complex | always | EBS volumes
| creation_date string | always | The date and time the image was created Sample: 2017-10-16T19:22:13.000Z
| description string | always | The description of the AMI
| ena_support boolean | always | whether enhanced networking with ENA is enabled Sample: True
| hypervisor string | always | The hypervisor type of the image Sample: xen
| image_id string | always | The ID of the AMI Sample: ami-5b466623
| image_location string | always | The location of the AMI Sample: 408466080000/Webapp
| image_type string | always | The type of image Sample: machine
| launch_permissions complex | when image is owned by calling account and describe_image_attributes is yes | launch permissions of the ami Sample: [{'group': 'all'}, {'user_id': '408466080000'}]
| name string | always | The name of the AMI that was provided during image creation Sample: Webapp
| owner_id string | always | The AWS account ID of the image owner Sample: 408466080000
| public boolean | always | whether the image has public launch permissions Sample: True
| root_device_name string | always | The device name of the root device Sample: /dev/sda1
| root_device_type string | always | The type of root device used by the AMI Sample: ebs
| sriov_net_support string | always | whether enhanced networking is enabled Sample: simple
| state string | always | The current state of the AMI Sample: available
| tags complex | always | Any tags assigned to the image
| virtualization_type string | always | The type of virtualization of the AMI Sample: hvm

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Prasad Katti (@prasadkatti)

Hint

If you notice any issues in this documentation you can edit this document to improve it.