Skip to content

Commit 2120460

Browse files
author
AWS
committed
AWS IoT Update: Doc only update for IoT that fixes customer-reported issues.
1 parent e3ae915 commit 2120460

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS IoT",
4+
"contributor": "",
5+
"description": "Doc only update for IoT that fixes customer-reported issues."
6+
}

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

+13-13
Original file line numberDiff line numberDiff line change
@@ -6431,17 +6431,17 @@
64316431
"members":{
64326432
"metricName":{
64336433
"shape":"MetricName",
6434-
"documentation":"<p> The name of the custom metric. This will be used in the metric report submitted from the device/thing. Shouldn't begin with <code>aws:</code>. Cannot be updated once defined.</p>",
6434+
"documentation":"<p> The name of the custom metric. This will be used in the metric report submitted from the device/thing. The name can't begin with <code>aws:</code>. You can't change the name after you define it.</p>",
64356435
"location":"uri",
64366436
"locationName":"metricName"
64376437
},
64386438
"displayName":{
64396439
"shape":"CustomMetricDisplayName",
6440-
"documentation":"<p> Field represents a friendly name in the console for the custom metric; it doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. Can be updated once defined.</p>"
6440+
"documentation":"<p> The friendly name in the console for the custom metric. This name doesn't have to be unique. Don't use this name as the metric identifier in the device metric report. You can update the friendly name after you define it.</p>"
64416441
},
64426442
"metricType":{
64436443
"shape":"CustomMetricType",
6444-
"documentation":"<p> The type of the custom metric. Types include <code>string-list</code>, <code>ip-address-list</code>, <code>number-list</code>, and <code>number</code>. </p>"
6444+
"documentation":"<p> The type of the custom metric. </p> <important> <p>The type <code>number</code> only takes a single metric value as an input, but when you submit the metrics value in the DeviceMetrics report, you must pass it as an array with a single value.</p> </important>"
64456445
},
64466446
"tags":{
64476447
"shape":"TagList",
@@ -6463,7 +6463,7 @@
64636463
},
64646464
"metricArn":{
64656465
"shape":"CustomMetricArn",
6466-
"documentation":"<p> The Amazon Resource Number (ARN) of the custom metric, e.g. <code>arn:<i>aws-partition</i>:iot:<i>region</i>:<i>accountId</i>:custommetric/<i>metricName</i> </code> </p>"
6466+
"documentation":"<p> The Amazon Resource Number (ARN) of the custom metric. For example, <code>arn:<i>aws-partition</i>:iot:<i>region</i>:<i>accountId</i>:custommetric/<i>metricName</i> </code> </p>"
64676467
}
64686468
}
64696469
},
@@ -7250,7 +7250,7 @@
72507250
},
72517251
"credentialDurationSeconds":{
72527252
"shape":"CredentialDurationSeconds",
7253-
"documentation":"<p>How long (in seconds) the credentials will be valid. The default value is 3,600 seconds.</p>"
7253+
"documentation":"<p>How long (in seconds) the credentials will be valid. The default value is 3,600 seconds.</p> <p>This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.</p>"
72547254
},
72557255
"tags":{
72567256
"shape":"TagList",
@@ -7609,11 +7609,11 @@
76097609
},
76107610
"hashAlgorithm":{
76117611
"shape":"HashAlgorithm",
7612-
"documentation":"<p>The hash algorithm used to code sign the file.</p>"
7612+
"documentation":"<p>The hash algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses <code>SHA256</code> or <code>SHA1</code>, so you can pass either of them based on which was used for generating the signature.</p>"
76137613
},
76147614
"signatureAlgorithm":{
76157615
"shape":"SignatureAlgorithm",
7616-
"documentation":"<p>The signature algorithm used to code sign the file.</p>"
7616+
"documentation":"<p>The signature algorithm used to code sign the file. You can use a string as the algorithm name if the target over-the-air (OTA) update devices are able to verify the signature that was generated using the same signature algorithm. For example, FreeRTOS uses <code>ECDSA</code> or <code>RSA</code>, so you can pass either of them based on which was used for generating the signature.</p>"
76177617
}
76187618
},
76197619
"documentation":"<p>Describes a custom method used to code sign a file.</p>"
@@ -8614,7 +8614,7 @@
86148614
},
86158615
"metricType":{
86168616
"shape":"CustomMetricType",
8617-
"documentation":"<p> The type of the custom metric. Types include <code>string-list</code>, <code>ip-address-list</code>, <code>number-list</code>, and <code>number</code>. </p>"
8617+
"documentation":"<p> The type of the custom metric. </p> <important> <p>The type <code>number</code> only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.</p> </important>"
86188618
},
86198619
"displayName":{
86208620
"shape":"CustomMetricDisplayName",
@@ -15230,7 +15230,7 @@
1523015230
},
1523115231
"setAsActive":{
1523215232
"shape":"SetAsActive",
15233-
"documentation":"<p>A boolean value that specifies if the CA certificate is set to active.</p>",
15233+
"documentation":"<p>A boolean value that specifies if the CA certificate is set to active.</p> <p>Valid values: <code>ACTIVE | INACTIVE</code> </p>",
1523415234
"location":"querystring",
1523515235
"locationName":"setAsActive"
1523615236
},
@@ -15279,14 +15279,14 @@
1527915279
},
1528015280
"setAsActive":{
1528115281
"shape":"SetAsActiveFlag",
15282-
"documentation":"<p>A boolean value that specifies if the certificate is set to active.</p>",
15282+
"documentation":"<p>A boolean value that specifies if the certificate is set to active.</p> <p>Valid values: <code>ACTIVE | INACTIVE</code> </p>",
1528315283
"deprecated":true,
1528415284
"location":"querystring",
1528515285
"locationName":"setAsActive"
1528615286
},
1528715287
"status":{
1528815288
"shape":"CertificateStatus",
15289-
"documentation":"<p>The status of the register certificate request.</p>"
15289+
"documentation":"<p>The status of the register certificate request. Valid values that you can use include <code>ACTIVE</code>, <code>INACTIVE</code>, and <code>REVOKED</code>.</p>"
1529015290
}
1529115291
},
1529215292
"documentation":"<p>The input to the RegisterCertificate operation.</p>"
@@ -18055,7 +18055,7 @@
1805518055
},
1805618056
"metricType":{
1805718057
"shape":"CustomMetricType",
18058-
"documentation":"<p> The type of the custom metric. Types include <code>string-list</code>, <code>ip-address-list</code>, <code>number-list</code>, and <code>number</code>. </p>"
18058+
"documentation":"<p> The type of the custom metric. </p> <important> <p>The type <code>number</code> only takes a single metric value as an input, but while submitting the metrics value in the DeviceMetrics report, it must be passed as an array with a single value.</p> </important>"
1805918059
},
1806018060
"displayName":{
1806118061
"shape":"CustomMetricDisplayName",
@@ -18426,7 +18426,7 @@
1842618426
},
1842718427
"credentialDurationSeconds":{
1842818428
"shape":"CredentialDurationSeconds",
18429-
"documentation":"<p>The number of seconds the credential will be valid.</p>"
18429+
"documentation":"<p>The number of seconds the credential will be valid.</p> <p>This value must be less than or equal to the maximum session duration of the IAM role that the role alias references.</p>"
1843018430
}
1843118431
}
1843218432
},

0 commit comments

Comments
 (0)