amazon.aws.ec2_snapshot_info – Gather information about ec2 volume snapshots in AWS
Note
This plugin is part of the amazon.aws collection (version 1.5.1).
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.
To use it in a playbook, specify: amazon.aws.ec2_snapshot_info.
New in version 1.0.0: of amazon.aws
Synopsis
- Gather information about ec2 volume snapshots in AWS.
- This module was called
ec2_snapshot_factsbefore Ansible 2.9. The usage did not change.
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.
If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: ec2_access_key, access_key |
|
| aws_ca_bundle
path
|
The location of a CA Bundle to use when validating SSL certificates.
Only used for boto3 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
|
|
| aws_config
dictionary
|
A dictionary to modify the botocore configuration.
Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
|
|
| 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.
If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: ec2_secret_key, secret_key |
|
| 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.
|
| 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.
aliases: aws_endpoint_url, endpoint_url |
|
| filters
dictionary
|
Default:
{}
|
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_DescribeSnapshots.html for possible filters. Filter names and values are case sensitive.
|
| max_results
integer
|
The maximum number of snapshot results returned in paginated output.
When used only a single page along with a
next_token_id response element will be returned.
The remaining results of the initial request can be seen by sending another request with the returned
next_token_id value.
This value can be between 5 and 1000; if next_token_id is given a value larger than 1000, only 1000 results are returned.
If this parameter is not used, then DescribeSnapshots returns all results.
This parameter is mutually exclusive with snapshot_ids.
|
|
| next_token_id
string
|
Contains the value returned from a previous paginated request where max_results was used and the results exceeded the value of that parameter.
Pagination continues from the end of the previous results that returned the next_token_id value.
This parameter is mutually exclusive with snapshot_ids
|
|
| owner_ids
list / elements=string
|
Default:
[]
|
If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned.
|
| profile
string
|
Uses a boto profile. Only works with boto >= 2.24.0.
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
aliases: aws_profile |
|
| 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 |
|
| restorable_by_user_ids
list / elements=string
|
Default:
[]
|
If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned.
|
| 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.
If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: aws_security_token, access_token |
|
| snapshot_ids
list / elements=string
|
Default:
[]
|
If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned.
|
| validate_certs
boolean
|
|
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
|
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_URLorEC2_URL,AWS_PROFILEorAWS_DEFAULT_PROFILE,AWS_ACCESS_KEY_IDorAWS_ACCESS_KEYorEC2_ACCESS_KEY,AWS_SECRET_ACCESS_KEYorAWS_SECRET_KEYorEC2_SECRET_KEY,AWS_SECURITY_TOKENorEC2_SECURITY_TOKEN,AWS_REGIONorEC2_REGION,AWS_CA_BUNDLE - 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_REGIONorEC2_REGIONcan 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.
# Gather information about all snapshots, including public ones
- amazon.aws.ec2_snapshot_info:
# Gather information about all snapshots owned by the account 0123456789
- amazon.aws.ec2_snapshot_info:
filters:
owner-id: 0123456789
# Or alternatively...
- amazon.aws.ec2_snapshot_info:
owner_ids:
- 0123456789
# Gather information about a particular snapshot using ID
- amazon.aws.ec2_snapshot_info:
filters:
snapshot-id: snap-00112233
# Or alternatively...
- amazon.aws.ec2_snapshot_info:
snapshot_ids:
- snap-00112233
# Gather information about any snapshot with a tag key Name and value Example
- amazon.aws.ec2_snapshot_info:
filters:
"tag:Name": Example
# Gather information about any snapshot with an error status
- amazon.aws.ec2_snapshot_info:
filters:
status: error
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description | |
|---|---|---|---|
| next_token_id
string
|
when option max_results is set in input |
Contains the value returned from a previous paginated request where
max_results was used and the results exceeded the value of that parameter.
This value is null when there are no more results to return.
|
|
| snapshots
list / elements=dictionary
|
success |
snapshots retrieved
|
|
| data_encryption_key_id
string
|
always |
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.
Sample:
arn:aws:kms:ap-southeast-2:012345678900:key/74c9742a-a1b2-45cb-b3fe-abcdef123456
|
|
| description
string
|
always |
The description for the snapshot.
Sample:
My important backup
|
|
| encrypted
boolean
|
always |
Indicates whether the snapshot is encrypted.
Sample:
True
|
|
| kms_key_id
string
|
always |
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.
Sample:
74c9742a-a1b2-45cb-b3fe-abcdef123456
|
|
| owner_alias
string
|
always |
The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot.
Sample:
033440102211
|
|
| owner_id
string
|
always |
The AWS account ID of the EBS snapshot owner.
Sample:
099720109477
|
|
| progress
string
|
always |
The progress of the snapshot, as a percentage.
Sample:
100%
|
|
| snapshot_id
string
|
always |
The ID of the snapshot. Each snapshot receives a unique identifier when it is created.
Sample:
snap-01234567
|
|
| start_time
string
|
always |
The time stamp when the snapshot was initiated.
Sample:
2015-02-12T02:14:02+00:00
|
|
| state
string
|
always |
The snapshot state (completed, pending or error).
Sample:
completed
|
|
| state_message
string
|
always |
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.
|
|
| tags
dictionary
|
always |
Any tags assigned to the snapshot.
Sample:
{ 'my_tag_key': 'my_tag_value' }
|
|
| volume_id
string
|
always |
The ID of the volume that was used to create the snapshot.
Sample:
vol-01234567
|
|
| volume_size
integer
|
always |
The size of the volume, in GiB.
Sample:
8
|
|
Authors
- Rob White (@wimnat)
- Aubin Bikouo (@abikouo)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/amazon/aws/ec2_snapshot_info_module.html