ansible / ansible.builtin / v2.9.17 / module / _ec2_snapshot_facts Gather information about ec2 volume snapshots in AWS | "added in version" 2.1 of ansible.builtin" Authors: Rob White (@wimnat) preview | supported by communityansible.builtin._ec2_snapshot_facts (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
Gather information about ec2 volume snapshots in AWS
This module was called C(ec2_snapshot_facts) before Ansible 2.9. The usage did not change.
# Note: These examples do not set authentication details, see the AWS Guide for details. # Gather information about all snapshots, including public ones - ec2_snapshot_info:
# Gather information about all snapshots owned by the account 0123456789 - ec2_snapshot_info: filters: owner-id: 0123456789
# Or alternatively... - ec2_snapshot_info: owner_ids: - 0123456789
# Gather information about a particular snapshot using ID - ec2_snapshot_info: filters: snapshot-id: snap-00112233
# Or alternatively... - ec2_snapshot_info: snapshot_ids: - snap-00112233
# Gather information about any snapshot with a tag key Name and value Example - ec2_snapshot_info: filters: "tag:Name": Example
# Gather information about any snapshot with an error status - ec2_snapshot_info: filters: status: error
region: aliases: - aws_region - ec2_region description: - 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 U(http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region) type: str ec2_url: aliases: - aws_endpoint_url - endpoint_url description: - 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. type: str filters: default: {} description: - A dict of filters to apply. Each dict item consists of a filter key and a filter value. See U(https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html) for possible filters. Filter names and values are case sensitive. required: false profile: aliases: - aws_profile description: - Using I(profile) will override I(aws_access_key), I(aws_secret_key) and I(security_token) and support for passing them at the same time as I(profile) has been deprecated. - I(aws_access_key), I(aws_secret_key) and I(security_token) will be made mutually exclusive with I(profile) after 2022-06-01. type: str owner_ids: default: [] description: - If you specify one or more snapshot owners, only snapshots from the specified owners and for which you have access are returned. required: false aws_config: description: - A dictionary to modify the botocore configuration. - Parameters can be found at U(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 U(http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto) for more boto configuration. type: dict snapshot_ids: default: [] description: - If you specify one or more snapshot IDs, only snapshots that have the specified IDs are returned. required: false aws_ca_bundle: description: - The location of a CA Bundle to use when validating SSL certificates. - Not used by boto 2 based modules. - 'Note: The CA Bundle is read ''module'' side and may need to be explicitly copied from the controller if not run locally.' type: path aws_access_key: aliases: - ec2_access_key - access_key description: - C(AWS access key). If not set then the value of the C(AWS_ACCESS_KEY_ID), C(AWS_ACCESS_KEY) or C(EC2_ACCESS_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_access_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str aws_secret_key: aliases: - ec2_secret_key - secret_key description: - C(AWS secret key). If not set then the value of the C(AWS_SECRET_ACCESS_KEY), C(AWS_SECRET_KEY), or C(EC2_SECRET_KEY) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(aws_secret_key) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str security_token: aliases: - aws_security_token - access_token description: - C(AWS STS security token). If not set then the value of the C(AWS_SECURITY_TOKEN) or C(EC2_SECURITY_TOKEN) environment variable is used. - If I(profile) is set this parameter is ignored. - Passing the I(security_token) and I(profile) options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01. type: str validate_certs: default: true description: - When set to "no", SSL certificates will not be validated for communication with the AWS APIs. type: bool restorable_by_user_ids: default: [] description: - If you specify a list of restorable users, only snapshots with create snapshot permissions for those users are returned. required: false debug_botocore_endpoint_logs: default: 'no' description: - 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. type: bool
data_encryption_key_id: description: 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. returned: always sample: arn:aws:kms:ap-southeast-2:012345678900:key/74c9742a-a1b2-45cb-b3fe-abcdef123456 type: str description: description: The description for the snapshot. returned: always sample: My important backup type: str encrypted: description: Indicates whether the snapshot is encrypted. returned: always sample: 'True' type: bool kms_key_id: description: 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. returned: always sample: 74c9742a-a1b2-45cb-b3fe-abcdef123456 type: str owner_alias: description: The AWS account alias (for example, amazon, self) or AWS account ID that owns the snapshot. returned: always sample: '033440102211' type: str owner_id: description: The AWS account ID of the EBS snapshot owner. returned: always sample: 099720109477 type: str progress: description: The progress of the snapshot, as a percentage. returned: always sample: 100% type: str snapshot_id: description: The ID of the snapshot. Each snapshot receives a unique identifier when it is created. returned: always sample: snap-01234567 type: str start_time: description: The time stamp when the snapshot was initiated. returned: always sample: '2015-02-12T02:14:02+00:00' type: str state: description: The snapshot state (completed, pending or error). returned: always sample: completed type: str state_message: description: 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. returned: always sample: null type: str tags: description: Any tags assigned to the snapshot. returned: always sample: '{ ''my_tag_key'': ''my_tag_value'' }' type: dict volume_id: description: The ID of the volume that was used to create the snapshot. returned: always sample: vol-01234567 type: str volume_size: description: The size of the volume, in GiB. returned: always sample: 8 type: int