本文為英文版的機器翻譯版本，如內容有任何歧義或不一致之處，概以英文版為準。 # Amazon SNS Amazon SNS 元件 (`aws.greengrass.SNS`) 會將訊息發佈至 Amazon Simple Notification Service (Amazon SNS) 主題。您可以使用此元件，將事件從 Greengrass 核心裝置傳送至 Web 伺服器、電子郵件地址和其他訊息訂閱者。如需詳細資訊，請參閱《[Amazon Simple Notification Service 開發人員指南》中的什麼是 Amazon SNS？](https://docs.aws.amazon.com/sns/latest/dg/welcome.html)。 ** 若要使用此元件發佈至 Amazon SNS 主題，請將訊息發佈至此元件訂閱的主題。根據預設，此元件會訂閱`sns/message`[本機發佈/訂閱](ipc-publish-subscribe.md)主題。您可以在部署此元件時指定其他主題，包括 AWS IoT Core MQTT 主題。在自訂元件中，您可能想要實作篩選或格式化邏輯，以便在將訊息發佈到此元件之前處理來自其他來源的訊息。這可讓您將訊息處理邏輯集中在單一元件上。 **注意** 此元件提供與 AWS IoT Greengrass V1 中的 Amazon SNS 連接器類似的功能。如需詳細資訊，請參閱《*AWS IoT Greengrass V1 開發人員指南*》中的 [Amazon SNS 連接器](https://docs.aws.amazon.com/greengrass/latest/developerguide/sns-connector.html)。 **Topics** + [版本](#sns-component-versions) + [Type](#sns-component-type) + [作業系統](#sns-component-os-support) + [要求](#sns-component-requirements) + [相依性](#sns-component-dependencies) + [Configuration](#sns-component-configuration) + [輸入資料](#sns-component-input-data) + [輸出資料](#sns-component-output-data) + [本機日誌檔案](#sns-component-log-file) + [授權](#sns-component-licenses) + [變更記錄](#sns-component-changelog) ## 版本此元件具有下列版本： + 2.1.x + 2.0.x ## Type 此元件是 Lambda 元件 (`aws.greengrass.lambda`)。[Greengrass 核](greengrass-nucleus-component.md)會使用 Lambda [啟動器元件執行此元件的 Lambda](lambda-launcher-component.md) 函數。如需詳細資訊，請參閱[元件類型](develop-greengrass-components.md#component-types)。 ## 作業系統此元件只能在 Linux 核心裝置上安裝。 ## 要求此元件有下列需求： + 您的核心裝置必須符合執行 Lambda 函數的要求。如果您希望核心裝置執行容器化 Lambda 函數，則裝置必須符合執行此作業的要求。如需詳細資訊，請參閱[Lambda 函數需求](setting-up.md#greengrass-v2-lambda-requirements)。 + 安裝在核心裝置上並新增至 PATH 環境變數的 [Python](https://www.python.org/) 3.7 版。 + Amazon SNS 主題。如需詳細資訊，請參閱《Amazon Simple Notification Service 開發人員指南》**中的[建立 Amazon SNS 主題](https://docs.aws.amazon.com/sns/latest/dg/sns-create-topic.html)。 + [Greengrass 裝置角色](device-service-role.md)必須允許 `sns:Publish`動作，如下列範例 IAM 政策所示。 ------ #### [ JSON ] **** ``` { "Version":"2012-10-17", "Statement": [ { "Action": [ "sns:Publish" ], "Effect": "Allow", "Resource": [ "arn:aws:sns:us-east-1:123456789012:topic-name" ] } ] } ``` ------ 您可以動態覆寫此元件輸入訊息承載中的預設主題。如果您的應用程式使用此功能，IAM 政策必須包含所有目標主題做為資源。您可以為資源授予精細或條件式存取 (例如，使用萬用字元 `*` 命名機制)。 + 若要從此元件接收輸出資料，您必須在部署此元件時合併[舊版訂閱路由器元件](legacy-subscription-router-component.md) (`aws.greengrass.LegacySubscriptionRouter`) 的下列組態更新。此組態會指定此元件發佈回應的主題。 ------ #### [ Legacy subscription router v2.1.x ] ``` { "subscriptions": { "aws-greengrass-sns": { "id": "aws-greengrass-sns", "source": "component:aws.greengrass.SNS", "subject": "sns/message/status", "target": "cloud" } } } ``` ------ #### [ Legacy subscription router v2.0.x ] ``` { "subscriptions": { "aws-greengrass-sns": { "id": "aws-greengrass-sns", "source": "arn:aws:lambda:region:aws:function:aws-greengrass-sns:version", "subject": "sns/message/status", "target": "cloud" } } } ``` + 以您使用 AWS 區域的取代*區域*。 + ** 以此元件執行的 Lambda 函數版本取代版本。若要尋找 Lambda 函數版本，您必須檢視要部署之此元件版本的配方。在[AWS IoT Greengrass 主控台](https://console.aws.amazon.com//greengrass)中開啟此元件的詳細資訊頁面，並尋找 **Lambda 函數**鍵/值對。此鍵/值對包含 Lambda 函數的名稱和版本。 **重要** 每次部署此元件時，都必須更新舊版訂閱路由器上的 Lambda 函數版本。這可確保針對您部署的元件版本使用正確的 Lambda 函數版本。 ------ 如需詳細資訊，請參閱[建立部署](create-deployments.md)。 + Amazon SNS 元件支援在 VPC 中執行。若要在 VPC 中部署此元件，需要下列項目。 + Amazon SNS 元件必須具有`sns.region.amazonaws.com`具有 VPC 端點的連線`com.amazonaws.us-east-1.sns`能力。 ### 端點和連接埠除了基本操作所需的端點和連接埠之外，此元件還必須能夠對下列端點和連接埠執行傳出請求。如需詳細資訊，請參閱[允許透過代理或防火牆的裝置流量](allow-device-traffic.md)。 | Endpoint | 站點 | 必要 | Description | | --- | --- | --- | --- | | `sns.region.amazonaws.com` | 443 | 是 | 將訊息發布到 Amazon SNS。 | ## 相依性當您部署元件時， AWS IoT Greengrass 也會部署其相依性的相容版本。這表示您必須符合元件及其所有相依性的要求，才能成功部署元件。本節列出此元件[發行版本的](#sns-component-changelog)相依性，以及為每個相依性定義元件版本的語意版本限制。您也可以在 [AWS IoT Greengrass 主控台](https://console.aws.amazon.com//greengrass)中檢視每個版本元件的相依性。在元件詳細資訊頁面上，尋找**相依性**清單。 ------ #### [ 2.1.10 ] 下表列出此元件 2.1.10 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.16.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [權杖交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.1.9 ] 下表列出此元件 2.1.9 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.15.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [權杖交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.1.8 ] 下表列出此元件 2.1.8 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.14.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [權杖交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.1.7 ] 下表列出此元件 2.1.7 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.13.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [權杖交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.1.6 ] 下表列出此元件 2.1.6 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.12.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [權杖交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.1.5 ] 下表列出此元件 2.1.5 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.11.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [字符交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.1.4 ] 下表列出此元件 2.1.4 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.10.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [字符交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.1.3 ] 下表列出此元件 2.1.3 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.9.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [權杖交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.1.2 ] 下表列出此元件 2.1.2 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.8.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [字符交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.1.1 ] 下表列出此元件 2.1.1 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.7.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [權杖交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.0.8 - 2.1.0 ] 下表列出此元件 2.0.8 和 2.1.0 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.6.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [字符交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.0.7 ] 下表列出此元件 2.0.7 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.5.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [字符交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.0.6 ] 下表列出此元件 2.0.6 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.4.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [權杖交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.0.5 ] 下表列出此元件 2.0.5 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.3.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [字符交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.0.4 ] 下表列出此元件 2.0.4 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.0 <2.2.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | ^2.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | ^2.0.0 | 軟式 | | [權杖交換服務](token-exchange-service-component.md) | ^2.0.0 | 硬式 | ------ #### [ 2.0.3 ] 下表列出此元件 2.0.3 版的相依性。 | 相依性 | 相容版本 | 相依性類型 | | --- | --- | --- | | [Greengrass 核](greengrass-nucleus-component.md) | >=2.0.3 <2.1.0 | 硬式 | | [Lambda 啟動器](lambda-launcher-component.md) | >=1.0.0 | 硬式 | | [Lambda 執行階段](lambda-runtimes-component.md) | >=1.0.0 | 軟式 | | [權杖交換服務](token-exchange-service-component.md) | >=1.0.0 | 硬式 | ------ 如需元件相依性的詳細資訊，請參閱[元件配方參考](component-recipe-reference.md#recipe-reference-component-dependencies)。 ## Configuration 此元件提供下列組態參數，您可以在部署元件時自訂這些參數。 **注意** 此元件的預設組態包含 Lambda 函數參數。建議您只編輯下列參數，以在裝置上設定此元件。 `lambdaParams` 包含此元件 Lambda 函數參數的物件。此物件包含下列資訊： `EnvironmentVariables` 包含 Lambda 函數參數的物件。此物件包含下列資訊： `DEFAULT_SNS_ARN` 此元件發佈訊息之預設 Amazon SNS 主題的 ARN。您可以使用輸入訊息承載中的 `sns_topic_arn` 屬性覆寫目的地主題。 `containerMode` （選用）此元件的容器化模式。您可以從以下選項中選擇： + `NoContainer` – 元件不會在隔離的執行時間環境中執行。 + `GreengrassContainer` – 元件會在 AWS IoT Greengrass 容器內的隔離執行時間環境中執行。預設：`GreengrassContainer` `containerParams` （選用）包含此元件容器參數的物件。如果您`GreengrassContainer`為指定，元件會使用這些參數`containerMode`。此物件包含下列資訊： `memorySize` （選用）要配置給元件的記憶體量（以 KB 為單位）。預設為 512 MB (525，312 KB)。 `pubsubTopics` （選用）物件，其中包含元件訂閱接收訊息的主題。您可以指定每個主題，以及元件是從訂閱 MQTT 主題 AWS IoT Core 或本機發佈/訂閱主題。此物件包含下列資訊： `0` – 這是做為字串的陣列索引。包含下列資訊的物件： `type` （選用）此元件用來訂閱訊息的發佈/訂閱訊息類型。您可以從以下選項中選擇： + `PUB_SUB` - 訂閱本機發佈/訂閱訊息。如果您選擇此選項，主題不能包含 MQTT 萬用字元。如需在指定此選項時如何從自訂元件傳送訊息的詳細資訊，請參閱 [發佈/訂閱本機訊息](ipc-publish-subscribe.md)。 + `IOT_CORE` – 訂閱 AWS IoT Core MQTT 訊息。如果您選擇此選項，主題可以包含 MQTT 萬用字元。如需在指定此選項時如何從自訂元件傳送訊息的詳細資訊，請參閱 [發佈/訂閱 AWS IoT Core MQTT 訊息](ipc-iot-core-mqtt.md)。預設：`PUB_SUB` `topic` （選用）元件訂閱接收訊息的主題。如果您`IotCore`為指定 `type`，則可以在本主題中使用 MQTT 萬用字元 (`+` 和 `#`)。 **Example 範例：組態合併更新（容器模式）** ``` { "lambdaExecutionParameters": { "EnvironmentVariables": { "DEFAULT_SNS_ARN": "arn:aws:sns:us-west-2:123456789012:mytopic" } }, "containerMode": "GreengrassContainer" } ``` **Example 範例：組態合併更新（無容器模式）** ``` { "lambdaExecutionParameters": { "EnvironmentVariables": { "DEFAULT_SNS_ARN": "arn:aws:sns:us-west-2:123456789012:mytopic" } }, "containerMode": "NoContainer" } ``` ## 輸入資料此元件接受下列主題的訊息，並將訊息依原樣發佈至目標 Amazon SNS 主題。根據預設，此元件會訂閱本機發佈/訂閱訊息。如需如何從自訂元件發佈訊息至此元件的詳細資訊，請參閱[發佈/訂閱本機訊息](ipc-publish-subscribe.md)。 **預設主題（本機發佈/訂閱）：** `sns/message` 訊息接受下列屬性。輸入訊息必須是 JSON 格式。 `request` 要傳送至 Amazon SNS 主題的訊息相關資訊。類型：`object`包含下列資訊： `message` 訊息的內容做為字串。若要傳送 JSON 物件，請將它序列化為字串，並為 `message_structure` 屬性指定 `json` 。類型：`string` `subject` （選用）訊息的主旨。類型：`string` 主旨可以是 ASCII 文字，最多 100 個字元。它必須以字母、數字或標點符號開頭。它不能包含換行符號或控制字元。 `sns_topic_arn` （選用）此元件發佈訊息之 Amazon SNS 主題的 ARN。指定此屬性以覆寫預設的 Amazon SNS 主題。類型：`string` `message_structure` （選用）訊息的結構。指定 `json`傳送您在 `content` 屬性中序列化為字串的 JSON 訊息。類型：`string` 有效值：`json` `id` 請求的任意 ID。使用此屬性將輸入請求映射至輸出回應。當您指定此屬性時，元件會將回應物件中的 `id` 屬性設定為此值。類型：`string` **注意** 訊息大小上限為 256 KB。 **Example 範例輸入：字串訊息** ``` { "request": { "subject": "Message subject", "message": "Message data", "sns_topic_arn": "arn:aws:sns:region:account-id:topic2-name" }, "id": "request123" } ``` **Example 範例輸入：JSON 訊息** ``` { "request": { "subject": "Message subject", "message": "{ \"default\": \"Message data\" }", "message_structure": "json" }, "id": "request123" } ``` ## 輸出資料此元件預設會將回應發佈為下列 MQTT 主題的輸出資料。您必須將此主題指定為[舊版訂閱路由器元件](legacy-subscription-router-component.md)組態`subject`中的。如需如何在自訂元件中訂閱此主題訊息的詳細資訊，請參閱 [發佈/訂閱 AWS IoT Core MQTT 訊息](ipc-iot-core-mqtt.md)。 **預設主題 (AWS IoT Core MQTT)：** `sns/message/status` **Example 範例輸出：成功** ``` { "response": { "sns_message_id": "f80a81bc-f44c-56f2-a0f0-d5af6a727c8a", "status": "success" }, "id": "request123" } ``` **Example 範例輸出：失敗** ``` { "response" : { "error": "InvalidInputException", "error_message": "SNS Topic Arn is invalid", "status": "fail" }, "id": "request123" } ``` ## 本機日誌檔案此元件使用以下日誌檔案。 ``` /greengrass/v2/logs/aws.greengrass.SNS.log ``` **檢視此元件的日誌** + 在核心裝置上執行下列命令，以即時檢視此元件的日誌檔案。`/greengrass/v2` 將取代為 AWS IoT Greengrass 根資料夾的路徑。 ``` sudo tail -f /greengrass/v2/logs/aws.greengrass.SNS.log ``` ## 授權此元件包含下列第三方軟體/授權： + [適用於 Python (Boto3) 的 AWS SDK](https://pypi.org/project/boto3/)/Apache License 2.0 + [botocore](https://pypi.org/project/botocore/)/Apache License 2.0 + [dateutil](https://pypi.org/project/python-dateutil/1.4/)/PSF License + [docutils](https://pypi.org/project/docutils/)/BSD 授權、GNU 一般公有授權 (GPL)、Python 軟體基金會授權、公有網域 + [jmespath](https://pypi.org/project/jmespath/)/MIT License + [s3transfer](https://pypi.org/project/s3transfer/)/Apache License 2.0 + [urllib3](https://pypi.org/project/urllib3/)/MIT License 此元件根據 [Greengrass 核心軟體授權合約](https://greengrass-release-license.s3.us-west-2.amazonaws.com/greengrass-license-v1.pdf)發行。 ## 變更記錄下表說明每個版本元件的變更。 | **版本** | **變更** | | --- | --- | | 2.1.10 | 針對 Greengrass nucleus 2.15.0 版更新版本。 | | 2.1.9 | 針對 Greengrass nucleus 2.14.0 版更新版本。 | | 2.1.8 | 針對 Greengrass nucleus 2.13.0 版更新版本。 | | 2.1.7 | 針對 Greengrass nucleus 2.12.0 版更新版本。 | | 2.1.6 | 針對 Greengrass nucleus 2.11.0 版更新版本。 | | 2.1.5 | 針對 Greengrass nucleus 2.10.0 版更新版本。 | | 2.1.4 | 針對 Greengrass nucleus 2.9.0 版更新版本。 | | 2.1.3 | 針對 Greengrass nucleus 2.8.0 版更新版本。 | | 2.1.2 | 針對 Greengrass nucleus 2.7.0 版更新版本。 | | 2.1.1 | 針對 Greengrass nucleus 2.6.0 版更新版本。 | | 2.1.0 | [\[See the AWS documentation website for more details\]](http://docs.aws.amazon.com/zh_tw/greengrass/v2/developerguide/sns-component.html) | | 2.0.8 | 針對 Greengrass nucleus 2.5.0 版更新版本。 | | 2.0.7 | 針對 Greengrass nucleus 2.4.0 版更新版本。 | | 2.0.6 | 針對 Greengrass nucleus 2.3.0 版更新版本。 | | 2.0.5 | 針對 Greengrass nucleus 2.2.0 版更新版本。 | | 2.0.4 | 針對 Greengrass nucleus 2.1.0 版更新版本。 | | 2.0.3 | 初始版本。 |