Модуль amazon.aws.ec2_snapshot_info — собирает сведения о снимках томов EC2 в AWS

Примечание

Этот модуль входит в коллекцию amazon.aws (версия 11.3.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install amazon.aws. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в сценарии, укажите: amazon.aws.ec2_snapshot_info.

Добавлено в amazon.aws 1.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Собирает сведения о снимках томов EC2 в AWS.

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

python >= 3.6
boto3 >= 1.35.0
botocore >= 1.35.0

Параметры

Параметр	Комментарии
access_key псевдонимы: aws_access_key_id, aws_access_key строка	Идентификатор ключа доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_ACCESS_KEY_ID` или `AWS_ACCESS_KEY` в порядке убывания приоритета. Параметры aws_access_key и profile являются взаимоисключающими. Псевдоним aws_access_key_id добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.
aws_ca_bundle путь	Путь к пакету сертификатов центра сертификации, используемому для проверки SSL-сертификатов. Также можно использовать переменную окружения `AWS_CA_BUNDLE`.
aws_config словарь	Словарь для изменения конфигурации botocore. Параметры описаны в документации AWS: https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
debug_botocore_endpoint_logs логическое значение	Использовать регистратор `botocore.endpoint` для анализа уникальных (а не общего количества) вызовов API `"resource:action"`, выполненных во время задачи, и записывать их набор в ключ resource_actions результатов задачи. Используйте обработчик обратного вызова `aws_resource_action`, чтобы вывести общий список вызовов, выполненных за время сценария. Также можно использовать переменную окружения `ANSIBLE_DEBUG_BOTOCORE_LOGS`. Варианты: `false` ← (по умолчанию) `true`
endpoint_url псевдоним: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Параметр можно использовать для подключения к другим сервисам, совместимым с AWS, однако коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
filters словарь	Словарь фильтров, которые нужно применить. Каждый элемент словаря состоит из ключа фильтра и его значения. Возможные фильтры см. на странице https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeSnapshots.html. Имена и значения фильтров чувствительны к регистру. По умолчанию: `{}`
max_results целое число	Максимальное количество результатов снимков, возвращаемых в постраничном выводе. При использовании этого параметра возвращается только одна страница и элемент ответа `next_token_id`. Оставшиеся результаты первоначального запроса можно получить, отправив новый запрос с возвращённым значением `next_token_id`. Значение должно быть в диапазоне от 5 до 1000; если для `next_token_id` указано значение больше 1000, возвращается только 1000 результатов. Если этот параметр не используется, DescribeSnapshots возвращает все результаты. Этот параметр несовместим с `snapshot_ids`.
next_token_id строка	Содержит значение, возвращённое предыдущим постраничным запросом, в котором использовался параметр `max_results`, а количество результатов превысило значение этого параметра. Постраничная выдача продолжается с конца предыдущего набора результатов, для которого было возвращено значение `next_token_id`. Этот параметр несовместим с `snapshot_ids`
owner_ids список / элементы=строка	Если указать одного или нескольких владельцев снимков, будут возвращены только снимки указанных владельцев, к которым у вас есть доступ. По умолчанию: `[]`
profile псевдоним: aws_profile строка	Именованный профиль AWS для аутентификации. Дополнительные сведения об именованных профилях см. в документации AWS: https://docs.aws.amazon.com/cli/latest/userguide/cli-configure-profiles.html. Также можно использовать переменную окружения `AWS_PROFILE`. Параметр profile несовместим с параметрами aws_access_key, aws_secret_key и session_token.
region псевдоним: aws_region строка	Регион AWS, который нужно использовать. Для глобальных сервисов, таких как IAM, Route53 и CloudFront, параметр region игнорируется. Также можно использовать переменную окружения `AWS_REGION`. Дополнительные сведения см. в документации Amazon AWS: http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region.
restorable_by_user_ids список / элементы=строка	Если указать список пользователей, которым разрешено восстановление, будут возвращены только снимки, для которых этим пользователям разрешено создание снимков. По умолчанию: `[]`
secret_key псевдонимы: aws_secret_access_key, aws_secret_key строка	Секретный ключ доступа AWS. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменные окружения `AWS_SECRET_ACCESS_KEY` или `AWS_SECRET_KEY` в порядке убывания приоритета. Параметры secret_key и profile являются взаимоисключающими. Псевдоним aws_secret_access_key добавлен в выпуске 5.1.0 для соответствия AWS SDK botocore.
session_token псевдоним: aws_session_token строка	Токен сеанса AWS STS для использования с временными учетными данными. Дополнительные сведения о токенах доступа см. в документации AWS: https://docs.aws.amazon.com/general/latest/gr/aws-sec-cred-types.html#access-keys-and-secret-access-keys. Также можно использовать переменную окружения `AWS_SESSION_TOKEN`. Параметры session_token и profile являются взаимоисключающими.
snapshot_ids список / элементы=строка	Если указать один или несколько идентификаторов снимков, будут возвращены только снимки с указанными идентификаторами. По умолчанию: `[]`
validate_certs логическое значение	Если задано значение `false`, SSL-сертификаты при взаимодействии с API AWS проверяться не будут. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

По умолчанию модуль возвращает все снимки, в том числе общедоступные. Чтобы ограничить результаты снимками, принадлежащими учетной записи, используйте фильтр owner-id.
Внимание: Для модулей переменные окружения и файлы конфигурации считываются в контексте «узла» Ansible, а не «контроллера». Поэтому может потребоваться явно скопировать файлы на «узел». Для плагинов поиска и подключения переменные окружения и файлы конфигурации считываются в контексте «контроллера» Ansible, а не «узла».
Используемый Ansible SDK AWS (boto3) также может считывать значения по умолчанию для учетных данных и других настроек, например региона, из файлов конфигурации в контексте «узла» Ansible (обычно ~/.aws/credentials). Дополнительные сведения см. на странице https://boto3.amazonaws.com/v1/documentation/api/latest/guide/credentials.html.

Примеры

# 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 123456789012
- amazon.aws.ec2_snapshot_info:
    filters:
      owner-id: 123456789012

# Or alternatively...
- amazon.aws.ec2_snapshot_info:
    owner_ids:
      - 123456789012

# 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

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, относящиеся только к этому модулю:

Ключ	Описание
next_token_id строка	Содержит значение, возвращённое предыдущим постраничным запросом, в котором использовался параметр `max_results`, а количество результатов превысило значение этого параметра. Это значение равно null, если больше нет результатов для возврата. Возвращается: если во входных данных задан параметр `max_results`
snapshots список / элементы=словарь	Список полученных снимков с соответствующими сведениями. Возвращается: при успешном выполнении
create_volume_permissions список / элементы=словарь	Пользователи и группы, которым разрешено создавать тома на основе снимка. Если разрешения на создание томов для снимка имеют значение «private», модуль вернёт пустой список. Возвращается: при успешном выполнении Пример: `[{"group": "all"}]`
data_encryption_key_id строка	Идентификатор ключа шифрования данных для снимка. Это уникальный идентификатор ключа шифрования данных, использованного для шифрования исходного тома или копии снимка. Возвращается: всегда Пример: `"arn:aws:kms:ap-southeast-2:123456789012:key/74c9742a-a1b2-45cb-b3fe-abcdef123456"`
description строка	Описание снимка. Возвращается: всегда Пример: `"My important backup"`
encrypted логическое значение	Указывает, зашифрован ли снимок. Возвращается: всегда Пример: `true`
kms_key_id строка	Полный ARN главного ключа клиента (CMK) AWS Key Management Service (AWS KMS), использованного для защиты ключа шифрования тома родительского тома. Возвращается: при успешном выполнении Пример: `"74c9742a-a1b2-45cb-b3fe-abcdef123456"`
owner_id строка	Идентификатор учетной записи AWS владельца снимка EBS. Возвращается: всегда Пример: `"123456789012"`
progress строка	Ход создания снимка в процентах. Возвращается: всегда Пример: `"100%"`
snapshot_id строка	Идентификатор снимка. При создании каждому снимку присваивается уникальный идентификатор. Возвращается: всегда Пример: `"snap-01234567"`
start_time строка	Время начала создания снимка. Возвращается: всегда Пример: `"2015-02-12T02:14:02+00:00"`
state строка	Состояние снимка (completed, pending или error). Возвращается: всегда Пример: `"completed"`
state_message строка	Зашифрованные снимки Amazon EBS копируются асинхронно. Если операция копирования снимка завершается с ошибкой (например, если необходимые разрешения AWS Key Management Service (AWS KMS) не предоставлены), в этом поле отображаются сведения об ошибке, помогающие определить её причину. Возвращается: при успешном выполнении
storage_tier строка	Уровень хранилища, на котором хранится снимок. Возвращается: всегда Пример: `"standard"`
tags словарь	Все теги, назначенные снимку. Возвращается: всегда Пример: `{"my_tag_key": "my_tag_value"}`
volume_id строка	Идентификатор тома, использованного для создания снимка. Возвращается: всегда Пример: `"vol-01234567"`
volume_size целое число	Размер тома в ГиБ. Возвращается: всегда Пример: `8`

Авторы

Rob White (@wimnat)
Aubin Bikouo (@abikouo)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/amazon/aws/ec2_snapshot_info_module.html