Модуль community.aws.sns — отправка сообщений Amazon Simple Notification Service

Примечание

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

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

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

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

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

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

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

Отправляет уведомление в тему учетной записи Amazon SNS.

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

python >= 3.6
boto3 >= 1.34.0
botocore >= 1.34.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.
application строка	Сообщение для подписок приложений.
aws_ca_bundle путь	Путь к пакету сертификатов CA, который будет использоваться для проверки сертификатов 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`
email строка	Сообщение для подписок по электронной почте.
email_json строка	Сообщение для подписок email-json.
endpoint_url псевдонимы: aws_endpoint_url строка	URL для подключения вместо конечных точек AWS по умолчанию. Хотя этот параметр можно использовать для подключения к другим сервисам, совместимым с AWS, коллекции amazon.aws и community.aws тестируются только с AWS. Также можно использовать переменную окружения `AWS_URL`.
http строка	Сообщение для подписок HTTP.
https строка	Сообщение для подписок HTTPS.
lambda строка	Сообщение для подписок Lambda.
message_attributes словарь	Словарь атрибутов сообщения. Это необязательные структурированные данные, которые передаются конечной точке вместе с сообщением. Используется специальный формат AWS «имя/тип/значение»; см. пример ниже.
message_deduplication_id строка добавлен в community.aws 5.4.0	Используется только вместе с параметром message_group_id. Заменяет автоматически сгенерированный MessageDeduplicationId. Может содержать до 128 буквенно-цифровых символов и знаков пунктуации. Сообщения с одинаковым идентификатором дедупликации распознаются как одно и то же сообщение. Заменяется автоматически сгенерированным токеном, если для темы задан параметр ContentBasedDeduplication.
message_group_id строка добавлен в community.aws 5.4.0	Метка, используемая для обработки сообщений, принадлежащих одной группе, в порядке FIFO. Обязателен при публикации сообщения в тему FIFO. Может содержать до 128 буквенно-цифровых символов и знаков пунктуации.
message_structure строка	Формат полезной нагрузки сообщения. Для поддержки сообщений, специфичных для протокола (`http`, `https`, `email`, `sms`, `sqs`), необходимо указать `json`. Для поддержки message_attributes необходимо указать `string`. Варианты: `"json"` ← (по умолчанию) `"string"`
msg псевдонимы: default строка / обязательный	Сообщение по умолчанию для подписок, для которых не задано более конкретное сообщение.
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.
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 нельзя использовать одновременно.
sms строка	Сообщение для подписок SMS.
sqs строка	Сообщение для подписок SQS.
subject строка	Тема сообщения
topic строка / обязательный	Имя или ARN темы, в которую нужно опубликовать сообщение.
validate_certs логический	Если задано значение `false`, проверка сертификатов SSL при взаимодействии с API AWS выполняться не будет. Настоятельно не рекомендуется задавать validate_certs=false; вместо этого рассмотрите возможность указать aws_ca_bundle. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

Примеры

- name: Send default notification message via SNS
  community.aws.sns:
    msg: '{{ inventory_hostname }} has completed the play.'
    subject: Deploy complete!
    topic: deploy
  delegate_to: localhost

- name: Send notification messages via SNS with short message for SMS
  community.aws.sns:
    msg: '{{ inventory_hostname }} has completed the play.'
    sms: deployed!
    subject: Deploy complete!
    topic: deploy
  delegate_to: localhost

- name: Send message with message_attributes
  community.aws.sns:
    topic: "deploy"
    msg: "message with extra details!"
    message_attributes:
      channel:
        data_type: String
        string_value: "mychannel"
      color:
        data_type: String
        string_value: "green"
  delegate_to: localhost

- name: Send message to a fifo topic
  community.aws.sns:
    topic: "deploy"
    msg: "Message with message group id"
    subject: Deploy complete!
    message_group_id: "deploy-1"
  delegate_to: localhost

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

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

Ключ	Описание
message_id строка	Идентификатор отправленного сообщения Возвращается: при успешном выполнении Пример: `"2f681ef0-6d76-5c94-99b2-4ae3996ce57b"`
msg строка	Диагностическая информация для пользователя Возвращается: всегда Пример: `"OK"`
sequence_number строка	128-битный порядковый номер, присваиваемый сообщению в темах FIFO Возвращается: при успешном выполнении

Авторы

Michael J. Schultz (@mjschultz)
Paul Arthur (@flowerysong)

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

© 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/community/aws/sns_module.html