AWS IoT Greengrass Version 1 於 2023 年 6 月 30 日進入延長使用壽命階段。如需詳細資訊,請參閱AWS IoT Greengrass V1 維護政策。在此日期之後, AWS IoT Greengrass V1 將不會發行提供功能、增強功能、錯誤修正或安全性修補程式的更新。在上運行的設備 AWS IoT Greengrass V1 不會中斷,並將繼續運行並連接到雲。我們強烈建議您移轉至 AWS IoT Greengrass Version 2,這會增加重要的新功能,並支援其他平台。
本文為英文版的機器翻譯版本,如內容有任何歧義或不一致之處,概以英文版為準。
SNS 連接器
SNS 連接器會將訊息發佈到 Amazon SNS 主題。這可讓 Web 伺服器、電子郵件地址和其他訊息訂閱者回應 Greengrass 群組中的事件。
此連接器接收 MQTT 主題上的 SNS 訊息資訊,然後將訊息傳送到指定的 SNS 主題。您可以選擇性地使用自訂 Lambda 函數,在郵件發佈到此連接器之前,對訊息實作篩選或格式化邏輯。
此連接器具有下列版本。
版本 |
ARN |
---|---|
4 |
|
3 |
|
2 |
|
1 |
|
如需版本變更的詳細資訊,請參閱 Changelog。
要求
此連接器有下列要求:
連接器參數
此連接器提供下列參數:
建立範例連接器 (AWS CLI)
下列 CLI 命令會建立ConnectorDefinition
包含 SNS 連接器的初始版本。
aws greengrass create-connector-definition --name MyGreengrassConnectors --initial-version '{ "Connectors": [ { "Id": "MySNSConnector", "ConnectorArn": "arn:aws:greengrass:
region
::/connectors/SNS/versions/4", "Parameters": { "DefaultSNSArn": "arn:aws:sns:region
:account-id
:topic-name", "IsolationMode" : "GreengrassContainer" } } ] }'
在AWS IoT Greengrass主控台中,您可以從群組的 [連接器] 頁面新增連接器。如需詳細資訊,請參閱 Greengrass 連接器入門 (主控台)。
輸入資料
此連接器接受有關 MQTT 主題的 SNS 訊息資訊,然後將訊息依原樣發佈至目標 SNS 主題。輸入訊息必須為 JSON 格式。
- 訂閱中的主題篩選條件
-
sns/message
- 訊息屬性
-
request
-
要傳送到 SNS 主題之訊息的相關資訊。
必要:
true
類型:
object
包括以下屬性:message
-
做為字串或 JSON 格式的訊息內容。如需範例,請參閱範例輸入。
若要傳送 JSON,
message_structure
屬性必須設定為json
,並且訊息必須是字串編碼的 JSON 物件,其中包含default
鍵。必要:
true
類型:
string
有效模式:
.*
subject
-
訊息的主旨。
必要:
false
類型:ASCII 文字,最多 100 個字元。這必須以字母、數字或標點符號開頭。這不可包含換行或控制字元。
有效模式:
.*
sns_topic_arn
-
將訊息發佈到其中的 SNS 主題的 ARN。如果指定,連接器會發佈到這個主題,而非預設主題。
注意
群組角色必須允許任何目標主題的
sns:Publish
許可。如需詳細資訊,請參閱 要求。必要:
false
類型:
string
有效模式:
arn:aws:sns:([a-z]{2}-[a-z]+-\d{1}):(\d{12}):([a-zA-Z0-9-_]+)$
message_structure
-
訊息的結構。
必要:
false
。這必須指定於傳送 JSON 訊息。類型:
string
有效值:
json
id
-
請求的任意 ID。此屬性用於將輸入請求映射到輸出回應。當指定時,回應物件中的
id
屬性會設為這個值。如果您不使用此功能,您可以省略此屬性或指定空白字串。必要:
false
類型:
string
有效模式:
.*
- 限制
-
訊息大小以 SNS 訊息大小上限 256 KB 為限。
- 範例輸入:字串訊息
-
此範例會傳送字串訊息。會指定選用
sns_topic_arn
屬性,此屬性會覆寫預設目的地主題。{ "request": { "subject": "Message subject", "message": "Message data", "sns_topic_arn": "arn:aws:sns:
region
:account-id
:topic2-name" }, "id": "request123" } - 範例輸入:JSON 訊息
-
此範例會傳送做為字串編碼 JSON 物件的訊息,其中包含
default
鍵。{ "request": { "subject": "Message subject", "message": "{ \"default\": \"Message data\" }", "message_structure": "json" }, "id": "request123" }
輸出資料
這個連接器會將狀態資訊發佈為輸出資料,且主題為 MQTT。
- 訂閱中的主題篩選條件
-
sns/message/status
- 範例輸出:成功
-
{ "response": { "sns_message_id": "f80a81bc-f44c-56f2-a0f0-d5af6a727c8a", "status": "success" }, "id": "request123" }
- 範例輸出:失敗
-
{ "response" : { "error": "InvalidInputException", "error_message": "SNS Topic Arn is invalid", "status": "fail" }, "id": "request123" }
用法示例
使用下列高階步驟來設定範例 Python 3.7 Lambda 函數,您可以使用此函數來試用連接器。
注意
-
如果您使用其他 Python 運行時,則可以創建一個從 Python 3.x 到 Python 3.7 的符號鏈接。
-
連接器入門 (主控台) 和 連接器入門 (CLI) 主題包含詳細步驟,說明如何設定和部署範例 Twilio 通知連接器。
確定您符合連接器的要求。
針對群組角色要求,您必須設定角色以授與必要的許可,並確認已將角色新增至群組。如需詳細資訊,請參閱 管理 Greengrass 群組角色 (主控台) 或 管理 Greengrass 群組角色 (CLI) 。
-
建立並發佈將輸入資料傳送至連接器的 Lambda 函數。
將範例程式碼儲存為 PY 檔案。下載並解壓縮適用於 Python 的AWS IoT Greengrass核心開發套件。然後,建立在根層級包含 PY 檔案和
greengrasssdk
資料夾的 zip 套件。此 zip 套件是您上傳至的部署套件AWS Lambda。建立 Python 3.7 Lambda 函數之後,請發佈函數版本並建立別名。
-
設定 Greengrass 群組。
-
部署群組。
-
在主AWS IoT控台的 [測試] 頁面上,訂閱輸出資料主題,以檢視來自連接器的狀態訊息。Lambda 函數的範例很長,並且會在部署群組後立即開始傳送訊息。
完成測試後,您可以將 Lambda 生命週期設定為隨需 (或
"Pinned": false
在 CLI 中),然後部署群組。這會讓函數停止傳送訊息。
範例
下列範例 Lambda 函數會將輸入訊息傳送至連接器。
import greengrasssdk import time import json iot_client = greengrasssdk.client('iot-data') send_topic = 'sns/message' def create_request_with_all_fields(): return { "request": { "message": "Message from SNS Connector Test" }, "id" : "req_123" } def publish_basic_message(): messageToPublish = create_request_with_all_fields() print("Message To Publish: ", messageToPublish) iot_client.publish(topic=send_topic, payload=json.dumps(messageToPublish)) publish_basic_message() def lambda_handler(event, context): return
授權
SNS 連接器包括下列協力廠商軟體/授權:
-
AWS SDK for Python (Boto3)
/Apache License 2.0 -
botocore
/Apache License 2.0 -
dateutil
/PSF License -
docutils
/BSD 授權、GNU 一般公有授權 (GPL)、Python 軟體基金會授權、公有網域 -
jmespath
/MIT License -
s3transfer
/Apache License 2.0 -
urllib3
/MIT License
此連接器是根據 Greengrass 核心軟體
變更記錄
下表說明每個版本連接器的變更。
版本 |
變更 |
---|---|
4 |
已新增 |
3 |
將 Lambda 執行階段升級至 Python 3.7,這會變更執行階段需求。 |
2 |
可減少過多記錄的修正。 |
1 |
初始版本。 |
Greengrass 群組一次只能包含一個版本的連接器。若要取得有關升級連接器版本的資訊,請參閱升級連接器版本。
另請參閱
-
Boto 3 文件中的發佈動作
-
《Amazon Simple Notification Service 開發人員指南》中的什麼是 Amazon Simple Notification Service?