AWS IoT Greengrass V2 Update: This release adds error status details for deployments and components that failed on a device and adds features to improve visibility into component installation.

Author: AWS

.changes/next-release/feature-AWSIoTGreengrassV2-333f7ef.json

@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "AWS IoT Greengrass V2",
+    "contributor": "",
+    "description": "This release adds error status details for deployments and components that failed on a device and adds features to improve visibility into component installation."
+}

services/greengrassv2/src/main/resources/codegen-resources/service-2.json

@@ -1487,10 +1487,32 @@
         "modifiedTimestamp":{
           "shape":"Timestamp",
           "documentation":"<p>The time at which the deployment job was last modified, expressed in ISO 8601 format.</p>"
+        },
+        "statusDetails":{
+          "shape":"EffectiveDeploymentStatusDetails",
+          "documentation":"<p>The status details that explain why a deployment has an error. This response will be null if the deployment is in a success state.</p>"
         }
       },
       "documentation":"<p>Contains information about a deployment job that IoT Greengrass sends to a Greengrass core device.</p>"
     },
+    "EffectiveDeploymentErrorCode":{
+      "type":"string",
+      "max":255,
+      "min":1
+    },
+    "EffectiveDeploymentErrorStack":{
+      "type":"list",
+      "member":{"shape":"EffectiveDeploymentErrorCode"}
+    },
+    "EffectiveDeploymentErrorType":{
+      "type":"string",
+      "max":255,
+      "min":1
+    },
+    "EffectiveDeploymentErrorTypeList":{
+      "type":"list",
+      "member":{"shape":"EffectiveDeploymentErrorType"}
+    },
     "EffectiveDeploymentExecutionStatus":{
       "type":"string",
       "enum":[
@@ -1503,6 +1525,20 @@
         "REJECTED"
       ]
     },
+    "EffectiveDeploymentStatusDetails":{
+      "type":"structure",
+      "members":{
+        "errorStack":{
+          "shape":"EffectiveDeploymentErrorStack",
+          "documentation":"<p>Contains an ordered list of short error codes that range from the most generic error to the most specific one. The error codes describe the reason for failure whenever the <code>coreDeviceExecutionStatus</code> is in a failed state. The response will be an empty list if there is no error.</p>"
+        },
+        "errorTypes":{
+          "shape":"EffectiveDeploymentErrorTypeList",
+          "documentation":"<p>Contains tags which describe the error. You can use the error types to classify errors to assist with remediating the failure. The response will be an empty list if there is no error.</p>"
+        }
+      },
+      "documentation":"<p>Contains all error-related information for the deployment record. The status details will be null if the deployment is in a success state.</p> <note> <p>Greengrass nucleus v2.8.0 or later is required to get an accurate <code>errorStack</code> and <code>errorTypes</code> response. This field will not be returned for earlier Greengrass nucleus versions.</p> </note>"
+    },
     "EffectiveDeploymentsList":{
       "type":"list",
       "member":{"shape":"EffectiveDeployment"}
@@ -1765,7 +1801,7 @@
         },
         "lifecycleStateDetails":{
           "shape":"LifecycleStateDetails",
-          "documentation":"<p>The details about the lifecycle state of the component.</p>"
+          "documentation":"<p>A detailed response about the lifecycle state of the component that explains the reason why a component has an error or is broken.</p>"
         },
         "isRoot":{
           "shape":"IsRoot",
@@ -1774,6 +1810,18 @@
         "lastStatusChangeTimestamp":{
           "shape":"Timestamp",
           "documentation":"<p>The status of how current the data is.</p> <p>This response is based off of component state changes. The status reflects component disruptions and deployments. If a component only sees a configuration update during a deployment, it might not undergo a state change and this status would not be updated.</p>"
+        },
+        "lastReportedTimestamp":{
+          "shape":"Timestamp",
+          "documentation":"<p>The last time the Greengrass core device sent a message containing a certain component to the Amazon Web Services Cloud.</p> <p>A component does not need to see a state change for this field to update.</p>"
+        },
+        "lastInstallationSource":{
+          "shape":"NonEmptyString",
+          "documentation":"<p>The most recent deployment source that brought the component to the Greengrass core device. For a thing group deployment or thing deployment, the source will be the The ID of the deployment. and for local deployments it will be <code>LOCAL</code>.</p>"
+        },
+        "lifecycleStatusCodes":{
+          "shape":"InstalledComponentLifecycleStatusCodeList",
+          "documentation":"<p>The status codes that indicate the reason for failure whenever the <code>lifecycleState</code> has an error or is in a broken state.</p> <note> <p>Greengrass nucleus v2.8.0 or later is required to get an accurate <code>lifecycleStatusCodes</code> response. This response can be inaccurate in earlier Greengrass nucleus versions.</p> </note>"
         }
       },
       "documentation":"<p>Contains information about a component on a Greengrass core device.</p>"
@@ -1791,6 +1839,15 @@
         "FINISHED"
       ]
     },
+    "InstalledComponentLifecycleStatusCode":{
+      "type":"string",
+      "max":255,
+      "min":1
+    },
+    "InstalledComponentLifecycleStatusCodeList":{
+      "type":"list",
+      "member":{"shape":"InstalledComponentLifecycleStatusCode"}
+    },
     "InstalledComponentList":{
       "type":"list",
       "member":{"shape":"InstalledComponent"}
@@ -2512,7 +2569,7 @@
       "members":{
         "installedComponents":{
           "shape":"InstalledComponentList",
-          "documentation":"<p>A list that summarizes each component on the core device.</p> <note> <p>Accuracy of the <code>lastStatusChangeTimestamp</code> response depends on Greengrass nucleus v2.7.0. It performs best on Greengrass nucleus v2.7.0 and can be inaccurate on earlier versions.</p> </note>"
+          "documentation":"<p>A list that summarizes each component on the core device.</p> <note> <p>Greengrass nucleus v2.7.0 or later is required to get an accurate <code>lastStatusChangeTimestamp</code> response. This response can be inaccurate in earlier Greengrass nucleus versions.</p> </note> <note> <p>Greengrass nucleus v2.8.0 or later is required to get an accurate <code>lastInstallationSource</code> and <code>lastReportedTimestamp</code> response. This response can be inaccurate or null in earlier Greengrass nucleus versions.</p> </note>"
         },
         "nextToken":{
           "shape":"NextTokenString",