Amazon Lookout for Equipment Update: This feature allows customers to see pointwise model diagnostics results for their models.

AWS · AWS · commit 0d2f44a024c8 · 2024-02-14T19:07:21.000Z
diff --git a/.changes/next-release/feature-AmazonLookoutforEquipment-dab2db3.json b/.changes/next-release/feature-AmazonLookoutforEquipment-dab2db3.json
@@ -0,0 +1,6 @@
+{
+    "type": "feature",
+    "category": "Amazon Lookout for Equipment",
+    "contributor": "",
+    "description": "This feature allows customers to see pointwise model diagnostics results for their models."
+}
diff --git a/services/lookoutequipment/src/main/resources/codegen-resources/endpoint-rule-set.json b/services/lookoutequipment/src/main/resources/codegen-resources/endpoint-rule-set.json
@@ -40,7 +40,6 @@
                     ]
                 }
             ],
-            "type": "tree",
             "rules": [
                 {
                     "conditions": [
@@ -83,7 +82,8 @@
                     },
                     "type": "endpoint"
                 }
-            ]
+            ],
+            "type": "tree"
         },
         {
             "conditions": [
@@ -96,7 +96,6 @@
                     ]
                 }
             ],
-            "type": "tree",
             "rules": [
                 {
                     "conditions": [
@@ -110,7 +109,6 @@
                             "assign": "PartitionResult"
                         }
                     ],
-                    "type": "tree",
                     "rules": [
                         {
                             "conditions": [
@@ -133,7 +131,6 @@
                                     ]
                                 }
                             ],
-                            "type": "tree",
                             "rules": [
                                 {
                                     "conditions": [
@@ -168,7 +165,6 @@
                                             ]
                                         }
                                     ],
-                                    "type": "tree",
                                     "rules": [
                                         {
                                             "conditions": [],
@@ -179,14 +175,16 @@
                                             },
                                             "type": "endpoint"
                                         }
-                                    ]
+                                    ],
+                                    "type": "tree"
                                 },
                                 {
                                     "conditions": [],
                                     "error": "FIPS and DualStack are enabled, but this partition does not support one or both",
                                     "type": "error"
                                 }
-                            ]
+                            ],
+                            "type": "tree"
                         },
                         {
                             "conditions": [
@@ -200,14 +198,12 @@
                                     ]
                                 }
                             ],
-                            "type": "tree",
                             "rules": [
                                 {
                                     "conditions": [
                                         {
                                             "fn": "booleanEquals",
                                             "argv": [
-                                                true,
                                                 {
                                                     "fn": "getAttr",
                                                     "argv": [
@@ -216,11 +212,11 @@
                                                         },
                                                         "supportsFIPS"
                                                     ]
-                                                }
+                                                },
+                                                true
                                             ]
                                         }
                                     ],
-                                    "type": "tree",
                                     "rules": [
                                         {
                                             "conditions": [],
@@ -231,14 +227,16 @@
                                             },
                                             "type": "endpoint"
                                         }
-                                    ]
+                                    ],
+                                    "type": "tree"
                                 },
                                 {
                                     "conditions": [],
                                     "error": "FIPS is enabled but this partition does not support FIPS",
                                     "type": "error"
                                 }
-                            ]
+                            ],
+                            "type": "tree"
                         },
                         {
                             "conditions": [
@@ -252,7 +250,6 @@
                                     ]
                                 }
                             ],
-                            "type": "tree",
                             "rules": [
                                 {
                                     "conditions": [
@@ -272,7 +269,6 @@
                                             ]
                                         }
                                     ],
-                                    "type": "tree",
                                     "rules": [
                                         {
                                             "conditions": [],
@@ -283,14 +279,16 @@
                                             },
                                             "type": "endpoint"
                                         }
-                                    ]
+                                    ],
+                                    "type": "tree"
                                 },
                                 {
                                     "conditions": [],
                                     "error": "DualStack is enabled but this partition does not support DualStack",
                                     "type": "error"
                                 }
-                            ]
+                            ],
+                            "type": "tree"
                         },
                         {
                             "conditions": [],
@@ -301,9 +299,11 @@
                             },
                             "type": "endpoint"
                         }
-                    ]
+                    ],
+                    "type": "tree"
                 }
-            ]
+            ],
+            "type": "tree"
         },
         {
             "conditions": [],
diff --git a/services/lookoutequipment/src/main/resources/codegen-resources/service-2.json b/services/lookoutequipment/src/main/resources/codegen-resources/service-2.json
@@ -1236,6 +1236,10 @@
         "OffCondition":{
           "shape":"OffCondition",
           "documentation":"<p>Indicates that the asset associated with this sensor has been shut off. As long as this condition is met, Lookout for Equipment will not use data from this asset for training, evaluation, or inference.</p>"
+        },
+        "ModelDiagnosticsOutputConfiguration":{
+          "shape":"ModelDiagnosticsOutputConfiguration",
+          "documentation":"<p>The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics. You must also specify the <code>RoleArn</code> request parameter.</p>"
         }
       }
     },
@@ -1401,7 +1405,7 @@
       "type":"string",
       "max":2048,
       "min":20,
-      "pattern":"arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:dataset\\/.+"
+      "pattern":"arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:dataset\\/[0-9a-zA-Z_-]{1,200}\\/.+"
     },
     "DatasetIdentifier":{
       "type":"string",
@@ -1658,7 +1662,7 @@
         },
         "IngestedFilesSummary":{
           "shape":"IngestedFilesSummary",
-          "documentation":"<p> IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id. </p>"
+          "documentation":"<p>IngestedFilesSummary associated with the given dataset for the latest successful associated ingestion job id. </p>"
         },
         "RoleArn":{
           "shape":"IamRoleArn",
@@ -2021,6 +2025,10 @@
         "RetrainingSchedulerStatus":{
           "shape":"RetrainingSchedulerStatus",
           "documentation":"<p>Indicates the status of the retraining scheduler. </p>"
+        },
+        "ModelDiagnosticsOutputConfiguration":{
+          "shape":"ModelDiagnosticsOutputConfiguration",
+          "documentation":"<p>Configuration information for the model's pointwise model diagnostics.</p>"
         }
       }
     },
@@ -2165,6 +2173,14 @@
         "AutoPromotionResultReason":{
           "shape":"AutoPromotionResultReason",
           "documentation":"<p>Indicates the reason for the <code>AutoPromotionResult</code>. For example, a model might not be promoted if its performance was worse than the active version, if there was an error during training, or if the retraining scheduler was using <code>MANUAL</code> promote mode. The model will be promoted in <code>MANAGED</code> promote mode if the performance is better than the previous model. </p>"
+        },
+        "ModelDiagnosticsOutputConfiguration":{
+          "shape":"ModelDiagnosticsOutputConfiguration",
+          "documentation":"<p>The Amazon S3 location where Amazon Lookout for Equipment saves the pointwise model diagnostics for the model version.</p>"
+        },
+        "ModelDiagnosticsResultsObject":{
+          "shape":"S3Object",
+          "documentation":"<p>The Amazon S3 output prefix for where Lookout for Equipment saves the pointwise model diagnostics for the model version.</p>"
         }
       }
     },
@@ -2766,7 +2782,7 @@
         },
         "SensorsWithShortDateRange":{
           "shape":"SensorsWithShortDateRange",
-          "documentation":"<p> Parameter that describes the total number of sensors that have a short date range of less than 90 days of data overall. </p>"
+          "documentation":"<p> Parameter that describes the total number of sensors that have a short date range of less than 14 days of data overall. </p>"
         }
       },
       "documentation":"<p> Entity that comprises aggregated information on sensors having insufficient data. </p>"
@@ -3109,7 +3125,7 @@
         },
         "InferenceExecutionSummaries":{
           "shape":"InferenceExecutionSummaries",
-          "documentation":"<p>Provides an array of information about the individual inference executions returned from the <code>ListInferenceExecutions</code> operation, including model used, inference scheduler, data configuration, and so on. </p>"
+          "documentation":"<p>Provides an array of information about the individual inference executions returned from the <code>ListInferenceExecutions</code> operation, including model used, inference scheduler, data configuration, and so on. </p> <note> <p>If you don't supply the <code>InferenceSchedulerName</code> request parameter, or if you supply the name of an inference scheduler that doesn't exist, <code>ListInferenceExecutions</code> returns an empty array in <code>InferenceExecutionSummaries</code>.</p> </note>"
         }
       }
     },
@@ -3187,7 +3203,7 @@
       "members":{
         "LabelGroupName":{
           "shape":"LabelGroupName",
-          "documentation":"<p> Retruns the name of the label group. </p>"
+          "documentation":"<p> Returns the name of the label group. </p>"
         },
         "IntervalStartTime":{
           "shape":"Timestamp",
@@ -3224,7 +3240,7 @@
         },
         "LabelSummaries":{
           "shape":"LabelSummaries",
-          "documentation":"<p> A summary of the items in the label group. </p>"
+          "documentation":"<p> A summary of the items in the label group. </p> <note> <p>If you don't supply the <code>LabelGroupName</code> request parameter, or if you supply the name of a label group that doesn't exist, <code>ListLabels</code> returns an empty array in <code>LabelSummaries</code>.</p> </note>"
         }
       }
     },
@@ -3279,7 +3295,7 @@
         },
         "ModelVersionSummaries":{
           "shape":"ModelVersionSummaries",
-          "documentation":"<p>Provides information on the specified model version, including the created time, model and dataset ARNs, and status.</p>"
+          "documentation":"<p>Provides information on the specified model version, including the created time, model and dataset ARNs, and status.</p> <note> <p>If you don't supply the <code>ModelName</code> request parameter, or if you supply the name of a model that doesn't exist, <code>ListModelVersions</code> returns an empty array in <code>ModelVersionSummaries</code>. </p> </note>"
         }
       }
     },
@@ -3458,6 +3474,36 @@
       "min":20,
       "pattern":"arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+"
     },
+    "ModelDiagnosticsOutputConfiguration":{
+      "type":"structure",
+      "required":["S3OutputConfiguration"],
+      "members":{
+        "S3OutputConfiguration":{
+          "shape":"ModelDiagnosticsS3OutputConfiguration",
+          "documentation":"<p>The Amazon S3 location for the pointwise model diagnostics. </p>"
+        },
+        "KmsKeyId":{
+          "shape":"NameOrArn",
+          "documentation":"<p>The Amazon Web Services Key Management Service (KMS) key identifier to encrypt the pointwise model diagnostics files.</p>"
+        }
+      },
+      "documentation":"<p>Output configuration information for the pointwise model diagnostics for an Amazon Lookout for Equipment model.</p>"
+    },
+    "ModelDiagnosticsS3OutputConfiguration":{
+      "type":"structure",
+      "required":["Bucket"],
+      "members":{
+        "Bucket":{
+          "shape":"S3Bucket",
+          "documentation":"<p>The name of the Amazon S3 bucket where the pointwise model diagnostics are located. You must be the owner of the Amazon S3 bucket. </p>"
+        },
+        "Prefix":{
+          "shape":"S3Prefix",
+          "documentation":"<p>The Amazon S3 prefix for the location of the pointwise model diagnostics. The prefix specifies the folder and evaluation result file name. (<code>bucket</code>).</p> <p>When you call <code>CreateModel</code> or <code>UpdateModel</code>, specify the path within the bucket that you want Lookout for Equipment to save the model to. During training, Lookout for Equipment creates the model evaluation model as a compressed JSON file with the name <code>model_diagnostics_results.json.gz</code>.</p> <p>When you call <code>DescribeModel</code> or <code>DescribeModelVersion</code>, <code>prefix</code> contains the file path and filename of the model evaluation file. </p>"
+        }
+      },
+      "documentation":"<p>The Amazon S3 location for the pointwise model diagnostics for an Amazon Lookout for Equipment model. </p>"
+    },
     "ModelMetrics":{
       "type":"string",
       "max":50000,
@@ -3543,7 +3589,8 @@
         "RetrainingSchedulerStatus":{
           "shape":"RetrainingSchedulerStatus",
           "documentation":"<p>Indicates the status of the retraining scheduler. </p>"
-        }
+        },
+        "ModelDiagnosticsOutputConfiguration":{"shape":"ModelDiagnosticsOutputConfiguration"}
       },
       "documentation":"<p>Provides information about the specified machine learning model, including dataset and model names and ARNs, as well as status. </p>"
     },
@@ -3555,7 +3602,7 @@
       "type":"string",
       "max":2048,
       "min":20,
-      "pattern":"^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/.+\\/.+\\/model-version\\/[0-9]{1,}$"
+      "pattern":"^arn:aws(-[^:]+)?:lookoutequipment:[a-zA-Z0-9\\-]*:[0-9]{12}:model\\/[0-9a-zA-Z_-]{1,200}\\/.+\\/model-version\\/[0-9]{1,}$"
     },
     "ModelVersionSourceType":{
       "type":"string",
@@ -3888,7 +3935,7 @@
       "members":{
         "AffectedSensorCount":{
           "shape":"Integer",
-          "documentation":"<p> Indicates the number of sensors that have less than 90 days of data. </p>"
+          "documentation":"<p> Indicates the number of sensors that have less than 14 days of data. </p>"
         }
       },
       "documentation":"<p> Entity that comprises information on sensors that have shorter date range. </p>"
@@ -4303,6 +4350,10 @@
         "RoleArn":{
           "shape":"IamRoleArn",
           "documentation":"<p>The ARN of the model to update.</p>"
+        },
+        "ModelDiagnosticsOutputConfiguration":{
+          "shape":"ModelDiagnosticsOutputConfiguration",
+          "documentation":"<p>The Amazon S3 location where you want Amazon Lookout for Equipment to save the pointwise model diagnostics for the model. You must also specify the <code>RoleArn</code> request parameter.</p>"
         }
       }
     },

Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,6 @@`
`40`	`40`	`]`
`41`	`41`	`}`
`42`	`42`	`],`
`43`		`- "type": "tree",`
`44`	`43`	`"rules": [`
`45`	`44`	`{`
`46`	`45`	`"conditions": [`
`@@ -83,7 +82,8 @@`
`83`	`82`	`},`
`84`	`83`	`"type": "endpoint"`
`85`	`84`	`}`
`86`		`- ]`
	`85`	`+ ],`
	`86`	`+ "type": "tree"`
`87`	`87`	`},`
`88`	`88`	`{`
`89`	`89`	`"conditions": [`
`@@ -96,7 +96,6 @@`
`96`	`96`	`]`
`97`	`97`	`}`
`98`	`98`	`],`
`99`		`- "type": "tree",`
`100`	`99`	`"rules": [`
`101`	`100`	`{`
`102`	`101`	`"conditions": [`
`@@ -110,7 +109,6 @@`
`110`	`109`	`"assign": "PartitionResult"`
`111`	`110`	`}`
`112`	`111`	`],`
`113`		`- "type": "tree",`
`114`	`112`	`"rules": [`
`115`	`113`	`{`
`116`	`114`	`"conditions": [`
`@@ -133,7 +131,6 @@`
`133`	`131`	`]`
`134`	`132`	`}`
`135`	`133`	`],`
`136`		`- "type": "tree",`
`137`	`134`	`"rules": [`
`138`	`135`	`{`
`139`	`136`	`"conditions": [`
`@@ -168,7 +165,6 @@`
`168`	`165`	`]`
`169`	`166`	`}`
`170`	`167`	`],`
`171`		`- "type": "tree",`
`172`	`168`	`"rules": [`
`173`	`169`	`{`
`174`	`170`	`"conditions": [],`
`@@ -179,14 +175,16 @@`
`179`	`175`	`},`
`180`	`176`	`"type": "endpoint"`
`181`	`177`	`}`
`182`		`- ]`
	`178`	`+ ],`
	`179`	`+ "type": "tree"`
`183`	`180`	`},`
`184`	`181`	`{`
`185`	`182`	`"conditions": [],`
`186`	`183`	`"error": "FIPS and DualStack are enabled, but this partition does not support one or both",`
`187`	`184`	`"type": "error"`
`188`	`185`	`}`
`189`		`- ]`
	`186`	`+ ],`
	`187`	`+ "type": "tree"`
`190`	`188`	`},`
`191`	`189`	`{`
`192`	`190`	`"conditions": [`
`@@ -200,14 +198,12 @@`
`200`	`198`	`]`
`201`	`199`	`}`
`202`	`200`	`],`
`203`		`- "type": "tree",`
`204`	`201`	`"rules": [`
`205`	`202`	`{`
`206`	`203`	`"conditions": [`
`207`	`204`	`{`
`208`	`205`	`"fn": "booleanEquals",`
`209`	`206`	`"argv": [`
`210`		`- true,`
`211`	`207`	`{`
`212`	`208`	`"fn": "getAttr",`
`213`	`209`	`"argv": [`
`@@ -216,11 +212,11 @@`
`216`	`212`	`},`
`217`	`213`	`"supportsFIPS"`
`218`	`214`	`]`
`219`		`- }`
	`215`	`+ },`
	`216`	`+ true`
`220`	`217`	`]`
`221`	`218`	`}`
`222`	`219`	`],`
`223`		`- "type": "tree",`
`224`	`220`	`"rules": [`
`225`	`221`	`{`
`226`	`222`	`"conditions": [],`
`@@ -231,14 +227,16 @@`
`231`	`227`	`},`
`232`	`228`	`"type": "endpoint"`
`233`	`229`	`}`
`234`		`- ]`
	`230`	`+ ],`
	`231`	`+ "type": "tree"`
`235`	`232`	`},`
`236`	`233`	`{`
`237`	`234`	`"conditions": [],`
`238`	`235`	`"error": "FIPS is enabled but this partition does not support FIPS",`
`239`	`236`	`"type": "error"`
`240`	`237`	`}`
`241`		`- ]`
	`238`	`+ ],`
	`239`	`+ "type": "tree"`
`242`	`240`	`},`
`243`	`241`	`{`
`244`	`242`	`"conditions": [`
`@@ -252,7 +250,6 @@`
`252`	`250`	`]`
`253`	`251`	`}`
`254`	`252`	`],`
`255`		`- "type": "tree",`
`256`	`253`	`"rules": [`
`257`	`254`	`{`
`258`	`255`	`"conditions": [`
`@@ -272,7 +269,6 @@`
`272`	`269`	`]`
`273`	`270`	`}`
`274`	`271`	`],`
`275`		`- "type": "tree",`
`276`	`272`	`"rules": [`
`277`	`273`	`{`
`278`	`274`	`"conditions": [],`
`@@ -283,14 +279,16 @@`
`283`	`279`	`},`
`284`	`280`	`"type": "endpoint"`
`285`	`281`	`}`
`286`		`- ]`
	`282`	`+ ],`
	`283`	`+ "type": "tree"`
`287`	`284`	`},`
`288`	`285`	`{`
`289`	`286`	`"conditions": [],`
`290`	`287`	`"error": "DualStack is enabled but this partition does not support DualStack",`
`291`	`288`	`"type": "error"`
`292`	`289`	`}`
`293`		`- ]`
	`290`	`+ ],`
	`291`	`+ "type": "tree"`
`294`	`292`	`},`
`295`	`293`	`{`
`296`	`294`	`"conditions": [],`
`@@ -301,9 +299,11 @@`
`301`	`299`	`},`
`302`	`300`	`"type": "endpoint"`
`303`	`301`	`}`
`304`		`- ]`
	`302`	`+ ],`
	`303`	`+ "type": "tree"`
`305`	`304`	`}`
`306`		`- ]`
	`305`	`+ ],`
	`306`	`+ "type": "tree"`
`307`	`307`	`},`
`308`	`308`	`{`
`309`	`309`	`"conditions": [],`