community.aws.sns 模块 – 发送 Amazon 简单通知服务消息

注意

此模块是 community.aws 集合 (版本 9.0.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.aws。您需要其他要求才能使用此模块，请参阅要求以了解详细信息。

要在 playbook 中使用它，请指定：community.aws.sns。

community.aws 1.0.0 中的新增功能

摘要 

将通知发送到您的 Amazon SNS 帐户中的主题。

要求 

执行此模块的主机需要以下要求。

python >= 3.6
boto3 >= 1.28.0
botocore >= 1.31.0

参数 

参数	注释
access_key 别名：aws_access_key_id、aws_access_key、ec2_access_key 字符串	AWS 访问密钥 ID。有关访问令牌的更多信息，请参见 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` 或 `EC2_ACCESS_KEY` 环境变量，优先级依次递减。 aws_access_key 和 profile 选项是互斥的。为了与 AWS botocore SDK 保持一致，在 5.1.0 版本中添加了 aws_access_key_id 别名。 ec2_access_key 别名已被弃用，并将在 2024-12-01 之后的一个版本中删除。 `EC2_ACCESS_KEY` 环境变量的支持已被弃用，并将在 2024-12-01 之后的一个版本中删除。
application 字符串	发送到应用程序订阅的消息。
aws_ca_bundle 路径	验证 SSL 证书时要使用的 CA 捆绑包的位置。还可以使用 `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` 记录器来解析在任务期间进行的唯一（而不是总计）`"resource:action"` API 调用，并将集合输出到任务结果中的 resource_actions 密钥。使用 `aws_resource_action` 回调来输出 playbook 期间进行的总列表。还可以使用 `ANSIBLE_DEBUG_BOTOCORE_LOGS` 环境变量。选项 `false` ← (默认) `true`
email 字符串	发送到电子邮件订阅的消息。
email_json 字符串	发送到 email-json 订阅的消息。
endpoint_url 别名：ec2_url、aws_endpoint_url、s3_url 字符串	连接到默认 AWS 端点以外的 URL。虽然这可以用于连接到其他兼容 AWS 的服务，但 amazon.aws 和 community.aws 集合仅针对 AWS 进行了测试。还可以使用 `AWS_URL` 或 `EC2_URL` 环境变量，优先级依次递减。 ec2_url 和 s3_url 别名已被弃用，并将在 2024-12-01 之后的一个版本中删除。 `EC2_URL` 环境变量的支持已被弃用，并将在 2024-12-01 之后的一个版本中删除。
http 字符串	发送到 HTTP 订阅的消息。
https 字符串	发送到 HTTPS 订阅的消息。
lambda 字符串	发送到 Lambda 订阅的消息。
message_attributes 字典	消息属性的字典。这些是可选的结构化数据条目，将发送到端点。这是 AWS 独有的名称/类型/值格式；请参见下面的示例。
message_deduplication_id 字符串 community.aws 5.4.0 中新增	仅与 message_group_id 结合使用。覆盖自动生成的 MessageDeduplicationId。最多可以包含 128 个字母数字字符和标点符号。具有相同去重 ID 的消息将被识别为相同的消息。如果主题已设置 ContentBasedDeduplication，则会被自动生成的令牌覆盖。
message_group_id 字符串 community.aws 5.4.0 中新增	用于以 FIFO 方式处理属于同一组的消息的标记。必须在将消息发布到 fifo 主题时包含。最多可以包含 128 个字母数字字符和标点符号。
message_structure 字符串	用于消息的有效负载格式。这必须是 `json` 以支持特定于协议的消息（`http`、`https`、`email`、`sms`、`sqs`）。它必须是 `string` 以支持 message_attributes。选项 `"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和security_token选项互斥。
region 别名: aws_region, ec2_region 字符串	要使用的AWS区域。对于IAM、Route53和CloudFront等全球服务，将忽略region。也可以使用`AWS_REGION`或`EC2_REGION`环境变量。有关更多信息，请参见Amazon AWS文档 http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region。别名`ec2_region`已弃用，将在2024-12-01之后的发行版中移除。对`EC2_REGION`环境变量的支持已弃用，将在2024-12-01之后的发行版中移除。
secret_key 别名: aws_secret_access_key, aws_secret_key, ec2_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`或`EC2_SECRET_KEY`环境变量（优先级递减）。 secret_key和profile选项互斥。为了与AWS botocore SDK保持一致，在5.1.0版本中添加了aws_secret_access_key别名。别名ec2_secret_key已弃用，将在2024-12-01之后的发行版中移除。对`EC2_SECRET_KEY`环境变量的支持已弃用，将在2024-12-01之后的发行版中移除。
session_token 别名: aws_session_token, security_token, aws_security_token, access_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`、`AWS_SECURITY_TOKEN`或`EC2_SECURITY_TOKEN`环境变量（优先级递减）。 security_token和profile选项互斥。别名aws_session_token和session_token是在3.2.0版本中添加的，参数名称从6.0.0版本的security_token更改为session_token。别名security_token、aws_security_token和access_token已弃用，将在2024-12-01之后的发行版中移除。对`EC2_SECRET_KEY`和`AWS_SECURITY_TOKEN`环境变量的支持已弃用，将在2024-12-01之后的发行版中移除。
sms 字符串	发送到SMS订阅的邮件。
sqs 字符串	发送到SQS订阅的邮件。
subject 字符串	邮件主题
topic 字符串 / 必填	要发布到的主题的名称或ARN。
validate_certs 布尔值	设置为`false`时，将不会验证与AWS API通信的SSL证书。强烈建议不要设置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 字符串	提交邮件的邮件ID 返回：成功时示例：`"2f681ef0-6d76-5c94-99b2-4ae3996ce57b"`
msg 字符串	人类可读的诊断信息返回：始终示例：`"OK"`
sequence_number 字符串	分配给fifo主题中邮件的128位长序列号返回：成功时

作者

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