部署状态更改事件组件状态更改事件创建 EventBridge 规则的先决条件配置设备运行状况通知（控制台）配置设备运行状况通知（CLI）配置设备运行状况通知（Amazon CloudFormation）另请参阅

获取部署和组件运行状态通知

利用 Amazon EventBridge 事件规则，您可以获取针对设备接收的 Greengrass 部署以及设备上已安装组件的状态更改通知。EventBridge 提供近乎实时的系统事件流，这些系统事件描述了 Amazon 资源的更改。Amazon IoT Greengrass 会尽力将这些事件发送到 EventBridge。这意味着，Amazon IoT Greengrass 尝试将所有事件发送到 EventBridge，但在极少数情况下可能无法传送事件。此外，Amazon IoT Greengrass 可能会发送给定事件的多个副本，这意味着事件侦听器可能无法按事件的发生顺序接收事件。

注意

Amazon EventBridge 是一种事件总线服务，您可以使用该服务将应用程序与来自各种来源的数据连接，例如 Greengrass 核心设备以及部署和组件通知。有关更多信息，请参阅 Amazon EventBridge 用户指南中的什么是 Amazon EventBridge？。

部署状态更改事件

当部署进入以下状态时，Amazon IoT Greengrass 会发出事件：FAILED、SUCCEEDED、COMPLETED、REJECTED 和 CANCELED。您可以创建一个 EventBridge 规则，用于在发生所有状态转换或转换为您指定的状态时运行。当部署进入将启动规则的状态时，EventBridge 会调用规则中定义的目标操作。这样，您就可以发送通知、捕获事件信息、采取纠正措施或启动其他事件以响应状态更改。例如，您可以为以下使用案例创建规则：

启动部署后操作，例如下载资产和通知人员。
在部署成功或失败时发送通知。
发布关于部署事件的自定义指标。

部署状态更改的事件采用以下格式：


{
    "version":"0",
    "id":" cd4d811e-ab12-322b-8255-EXAMPLEb1bc8",
    "detail-type":"Greengrass V2 Effective Deployment Status Change",
    "source":"aws.greengrass",
    "account":"123456789012",
    "region":"us-west-2",
    "time":"2018-03-22T00:38:11Z",
    "resources":["arn:aws:greengrass:us-east-1:123456789012:coreDevices:MyGreengrassCore"],
    "detail":{    
        "deploymentId": "4f38f1a7-3dd0-42a1-af48-EXAMPLE09681",
        "coreDeviceExecutionStatus": "FAILED|SUCCEEDED|COMPLETED|REJECTED|CANCELED",
        "statusDetails": {
          "errorStack": ["DEPLOYMENT_FAILURE", "ARTIFACT_DOWNLOAD_ERROR", "S3_ERROR", "S3_ACCESS_DENIED", "S3_HEAD_OBJECT_ACCESS_DENIED"],
          "errorTypes": ["DEPENDENCY_ERROR", "PERMISSION_ERROR"],
        },
        "reason": "S3_HEAD_OBJECT_ACCESS_DENIED: FAILED_NO_STATE_CHANGE: Failed to download artifact name: 's3://pentest27/nucleus/281/aws.greengrass.nucleus.zip' for component aws.greengrass.Nucleus-2.8.1, reason: S3 HeadObject returns 403 Access Denied. Ensure the IAM role associated with the core device has a policy granting s3:GetObject. null (Service: S3, Status Code: 403, Request ID: HR94ZNT2161DAR58, Extended Request ID: wTX4DDI+qigQt3uzwl9rlnQiYlBgwvPm/KJFWeFAn9t1mnGXTms/luLCYANgq08RIH+x2H+hEKc=)"
     }
}

您可以创建规则和事件，以更新您的部署状态。当部署以 FAILED、SUCCEEDED、COMPLETED、REJECTED 或 CANCELED 状态完成时，会启动事件。如果在核心设备上部署失败，您将收到详细的回复，其中解释了部署失败的原因。有关部署错误代码的更多信息，请参阅详细的部署错误代码。

部署状态

FAILED. 部署失败。
SUCCEEDED。以事物组为目标的部署成功完成。
COMPLETED。以事物为目标的部署成功完成。
REJECTED。部署被拒绝。有关更多信息，请参阅 statusDetails 字段。
CANCELED。用户取消了部署。

可能是事件重复或者顺序颠倒。要确定事件的顺序，请使用 time 属性。

有关 errorStacks 和 errorTypes 中错误代码的完整列表，请参阅详细的部署错误代码和详细的组件状态代码。

组件状态更改事件

对于 Amazon IoT Greengrass 版本 2.12.2 及更低版本，当组件进入以下状态时，Greengrass 会发出事件：ERRORED 和 BROKEN。对于 Greengrass Nucleus 版本 2.12.3 及更高版本，当组件进入以下状态时，Greengrass 会发出事件：ERRORED、BROKEN、RUNNING 和 FINISHED。在部署完成后，Greengrass 还会发出事件。您可以创建一个 EventBridge 规则，用于在发生所有状态转换或转换为您指定的状态时运行。当已安装的组件进入将启动规则的状态时，EventBridge 会调用规则中定义的目标操作。这样，您就可以发送通知、捕获事件信息、采取纠正措施或启动其他事件以响应状态更改。

针对组件状态更改的事件采用以下格式：

Greengrass nucleus v2.12.2 and earlier

组件状态：`ERRORED` 或 `BROKEN`


{
    "version":"0",
    "id":" cd4d811e-ab12-322b-8255-EXAMPLEb1bc8",
    "detail-type":"Greengrass V2 Installed Component Status Change",
    "source":"aws.greengrass",
    "account":"123456789012",
    "region":"us-west-2",
    "time":"2018-03-22T00:38:11Z",
    "resources":["arn:aws:greengrass:us-east-1:123456789012:coreDevices:MyGreengrassCore"],
    "detail": {
       "components": [
          {
            "componentName": "MyComponent",
            "componentVersion": "1.0.0",
            "root": true,
            "lifecycleState": "ERRORED|BROKEN",
            "lifecycleStatusCodes": ["STARTUP_ERROR"],
            "lifecycleStateDetails": "An error occurred during startup. The startup script exited with code 1."
          }
        ]
    }
}

Greengrass nucleus v2.12.3 and later

组件状态：`ERRORED` 或 `BROKEN`


{
    "version":"0",
    "id":" cd4d811e-ab12-322b-8255-EXAMPLEb1bc8",
    "detail-type":"Greengrass V2 Installed Component Status Change",
    "source":"aws.greengrass",
    "account":"123456789012",
    "region":"us-west-2",
    "time":"2018-03-22T00:38:11Z",
    "resources":["arn:aws:greengrass:us-east-1:123456789012:coreDevices:MyGreengrassCore"],
    "detail": {
       "components": [
          {
            "componentName": "MyComponent",
            "componentVersion": "1.0.0",
            "root": true,
            "lifecycleState": "ERRORED|BROKEN",
            "lifecycleStatusCodes": ["STARTUP_ERROR"],
            "lifecycleStateDetails": "An error occurred during startup. The startup script exited with code 1."
          }
        ]
    }
}

组件状态：`RUNNING` 或 `FINISHED`


{
    "version":"0",
    "id":" cd4d811e-ab12-322b-8255-EXAMPLEb1bc8",
    "detail-type":"Greengrass V2 Installed Component Status Change",
    "source":"aws.greengrass",
    "account":"123456789012",
    "region":"us-west-2",
    "time":"2018-03-22T00:38:11Z",
    "resources":["arn:aws:greengrass:us-east-1:123456789012:coreDevices:MyGreengrassCore"],
    "detail": {
       "components": [
          {
            "componentName": "MyComponent",
            "componentVersion": "1.0.0",
            "root": true,
            "lifecycleState": "RUNNING|FINISHED",
            "lifecycleStateDetails": null
          }
        ]
    }
}

您可以创建规则和事件，以更新已安装组件的状态。当组件在设备上改变状态时，就会启动事件。您将收到详细的回复，其中解释了组件出错或损坏的原因。您还将收到一个指示失败原因的状态码。有关组件状态代码的更多信息，请参阅详细的组件状态代码。

创建 EventBridge 规则的先决条件

在为 Amazon IoT Greengrass 创建 EventBridge 规则之前，请先执行以下操作：

熟悉 EventBridge 中的事件、规则和目标。
创建和配置由 EventBridge 规则调用的目标。规则可以调用许多类型的目标，包括：
- Amazon Simple Notiﬁcation Service (Amazon SNS)
- Amazon Lambda 函数
- Amazon Kinesis Video Streams
- Amazon Simple Queue Service（Amazon SQS）队列

有关更多信息，请参阅 Amazon EventBridge 用户指南中的什么是 Amazon EventBridge？和 Amazon EventBridge 入门。

配置设备运行状况通知（控制台）

使用以下步骤创建一个 EventBridge 规则，此规则会在一个组的部署状态更改时发布一个 Amazon SNS 主题。这样，Web 服务器、电子邮件地址和其他主题订阅者就可以响应事件。有关更多信息，请参阅 Amazon EventBridge 用户指南中的创建针对来自 Amazon 资源的事件触发的 EventBridge 规则。

打开 Amazon EventBridge 控制台。
在导航窗格中，选择规则。
选择创建规则。
为规则输入名称和描述。

规则不能与同一区域中的另一个规则和同一事件总线上的名称相同。
对于事件总线，请选择要与此规则关联的事件总线。如果您希望此规则对来自您自己的账户的匹配事件触发，请选择 Amazon默认事件总线。当您账户中的某个 Amazon 服务发出一个事件时，它始终会发送到您账户的默认事件总线。
对于规则类型，选择具有事件模式的规则。
选择下一步。
对于事件源，选择 Amazon 事件。
在事件模式中，选择 Amazon服务。
对于 Amazon 服务，选择 Greengrass。
对于事件类型，您可以从下面选择：
- 对于部署事件，请选择 Greengrass V2 有效部署状态更改。
- 对于组件事件，请选择 Greengrass V2 已安装组件状态更改。
选择下一步。
对于目标类型，选择Amazon 服务。
在 选择目标 下，配置您的目标。此示例使用了 Amazon SNS 主题，而您可以配置其他目标类型来发送通知。
1. 对于 Target (目标)，选择 SNS topic (SNS 主题)。
2. 对于 Topic (主题)，请选择您的目标主题。
3. 选择下一步。
选择下一步。
查看规则详细信息并选择创建规则。

配置设备运行状况通知（CLI）

按照以下步骤创建 EventBridge 规则，此规则会在有 Greengrass 状态更改事件时发布 Amazon SNS 主题。这样，Web 服务器、电子邮件地址和其他主题订阅者就可以响应事件。

创建规则。

适用于部署状态更改事件。


aws events put-rule \
  --name TestRule \
  --event-pattern "{\"source\": [\"aws.greengrass\"], \"detail-type\": [\"Greengrass V2 Effective Deployment Status Change\"]}"

适用于组件状态更改事件。


aws events put-rule \
  --name TestRule \
  --event-pattern "{\"source\": [\"aws.greengrass\"], \"detail-type\": [\"Greengrass V2 Installed Component Status Change\"]}"

模式中省略的属性将被忽略。

将主题添加为规则目标。
- 将 topic-arn 替换为 Amazon SNS 主题的 ARN。
```
aws events put-targets \
  --rule TestRule \
  --targets "Id"="1","Arn"="topic-arn"
```
注意
要允许 Amazon EventBridge 调用您的目标主题，您必须将基于资源的策略添加到您的主题中。有关更多信息，请参阅 Amazon EventBridge 用户指南中的 Amazon SNS 权限。

有关更多信息，请参阅 Amazon EventBridge 用户指南中的 EventBridge 中的事件和事件模式。

配置设备运行状况通知（Amazon CloudFormation）

使用 Amazon CloudFormation 模板可创建 EventBridge 规则，这些规则将发送有关 Greengrass 组部署状态更改的通知。有关更多信息，请参阅 Amazon CloudFormation 用户指南中的 Amazon EventBridge 资源类型参考。

另请参阅

检查设备部署状态
Amazon EventBridge 用户指南中的什么是 Amazon EventBridge？。

Javascript 在您的浏览器中被禁用或不可用。

要使用 Amazon Web Services 文档，必须启用 Javascript。请参阅浏览器的帮助页面以了解相关说明。

收集系统运行状况遥测数据

获取部署和组件运行状态通知

注意

主题

部署状态更改事件

组件状态更改事件

组件状态：ERRORED 或 BROKEN

组件状态：ERRORED 或 BROKEN

组件状态：RUNNING 或 FINISHED

创建 EventBridge 规则的先决条件

配置设备运行状况通知（控制台）

配置设备运行状况通知（CLI）

注意

配置设备运行状况通知（Amazon CloudFormation）

另请参阅

组件状态：`ERRORED` 或 `BROKEN`

组件状态：`ERRORED` 或 `BROKEN`

组件状态：`RUNNING` 或 `FINISHED`