W3cubDocs

/Ansible

ec2_snapshot_facts - Gather facts about ec2 volume snapshots in AWS

New in version 2.1.

Synopsis
Requirements (on host that executes module)
Options
Examples
Return Values
Notes
- Status

Synopsis

Gather facts about ec2 volume snapshots in AWS

Requirements (on host that executes module)

python >= 2.6
boto

Options

parameter	required	default	choices	comments
aws_access_key	no			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	no			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
ec2_url	no			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.
filters	no			A dict of filters to apply. Each dict item consists of a filter key and a filter value. See http://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html for possible filters. Filter names and values are case sensitive.
owner_ids	no			If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned.
profile (added in 1.6)	no			Uses a boto profile. Only works with boto >= 2.24.0.
region	no			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
restorable_by_user_ids	no			If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned.
security_token (added in 1.6)	no			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
snapshot_ids	no			If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned.
validate_certs (added in 1.5)	no	yes	yes no	When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.

Examples

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

# Gather facts about all snapshots, including public ones
- ec2_snapshot_facts:

# Gather facts about all snapshots owned by the account 0123456789
- ec2_snapshot_facts:
    filters:
      owner-id: 0123456789

# Or alternatively...
- ec2_snapshot_facts:
    owner_ids:
      - 0123456789

# Gather facts about a particular snapshot using ID
- ec2_snapshot_facts:
    filters:
      snapshot-id: snap-00112233

# Or alternatively...
- ec2_snapshot_facts:
    snapshot_ids:
      - snap-00112233

# Gather facts about any snapshot with a tag key Name and value Example
- ec2_snapshot_facts:
    filters:
      "tag:Name": Example

# Gather facts about any snapshot with an error status
- ec2_snapshot_facts:
    filters:
      status: error

Return Values

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

name	description	returned	type	sample
state_message	Encrypted Amazon EBS snapshots are copied asynchronously. If a snapshot copy operation fails (for example, if the proper AWS Key Management Service (AWS KMS) permissions are not obtained) this field displays error state details to help you diagnose why the error occurred.	always	string	None
description	The description for the snapshot.	always	string	My important backup
volume_id	The ID of the volume that was used to create the snapshot.	always	string	vol-01234567
owner_alias	The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.	always	string	033440102211
encrypted	Indicates whether the snapshot is encrypted.	always	boolean	True
start_time	The time stamp when the snapshot was initiated.	always	string	2015-02-12T02:14:02+00:00
kms_key_id	The full ARN of the AWS Key Management Service (AWS KMS) customer master key (CMK) that was used to protect the volume encryption key for the parent volume.	always	string	74c9742a-a1b2-45cb-b3fe-abcdef123456
data_encryption_key_id	The data encryption key identifier for the snapshot. This value is a unique identifier that corresponds to the data encryption key that was used to encrypt the original volume or snapshot copy.	always	string	arn:aws:kms:ap-southeast-2:012345678900:key/74c9742a-a1b2-45cb-b3fe-abcdef123456
volume_size	The size of the volume, in GiB.	always	int	8
state	The snapshot state (completed, pending or error).	always	string	completed
snapshot_id	The ID of the snapshot. Each snapshot receives a unique identifier when it is created.	always	string	snap-01234567
progress	The progress of the snapshot, as a percentage.	always	string	100%
tags	Any tags assigned to the snapshot.	always	dict	{ 'my_tag_key': 'my_tag_value' }
owner_id	The AWS account ID of the EBS snapshot owner.	always	string	099720109477

Notes

Note

By default, the module will return all snapshots, including public ones. To limit results to snapshots owned by the account use the filter ‘owner-id’.
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 http://boto.readthedocs.org/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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ec2_snapshot_facts_module.html