Skip to content

Commit 5a9a9ec

Browse files
author
AWS
committed
AWS IoT Core Device Advisor Update: Documentation update for Device Advisor GetEndpoint API
1 parent ca32f40 commit 5a9a9ec

File tree

2 files changed

+38
-23
lines changed

2 files changed

+38
-23
lines changed

‎.changes/next-release/feature-AWSIoTCoreDeviceAdvisor-68a3f5b.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
{
2+
"type": "feature",
3+
"category": "AWS IoT Core Device Advisor",
4+
"contributor": "",
5+
"description": "Documentation update for Device Advisor GetEndpoint API"
6+
}

‎services/iotdeviceadvisor/src/main/resources/codegen-resources/service-2.json

Lines changed: 32 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@
5353
{"shape":"ValidationException"},
5454
{"shape":"InternalServerException"},
5555
{"shape":"ResourceNotFoundException"}
56-
]
56+
],
57+
"documentation":"<p>Gets information about an Device Advisor endpoint.</p>"
5758
},
5859
"GetSuiteDefinition":{
5960
"name":"GetSuiteDefinition",
@@ -126,7 +127,7 @@
126127
{"shape":"ValidationException"},
127128
{"shape":"InternalServerException"}
128129
],
129-
"documentation":"<p>Lists the runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">ListSuiteRuns</a> action.</p>"
130+
"documentation":"<p>Lists runs of the specified Device Advisor test suite. You can list all runs of the test suite, or the runs of a specific version of the test suite.</p> <p>Requires permission to access the <a href=\"https://docs.aws.amazon.com/service-authorization/latest/reference/list_awsiot.html#awsiot-actions-as-permissions\">ListSuiteRuns</a> action.</p>"
130131
},
131132
"ListTagsForResource":{
132133
"name":"ListTagsForResource",
@@ -229,10 +230,10 @@
229230
"members":{
230231
"message":{
231232
"shape":"Message",
232-
"documentation":"<p>Sends Conflict Exception message.</p>"
233+
"documentation":"<p>Sends a Conflict Exception message.</p>"
233234
}
234235
},
235-
"documentation":"<p>Sends Conflict Exception.</p>",
236+
"documentation":"<p>Sends a Conflict Exception.</p>",
236237
"error":{"httpStatusCode":400},
237238
"exception":true
238239
},
@@ -299,7 +300,7 @@
299300
"documentation":"<p>Lists devices certificate ARN.</p>"
300301
}
301302
},
302-
"documentation":"<p>Information of a test device. Required to provide either a thing ARN or a certificate ARN.</p>"
303+
"documentation":"<p>Information of a test device. A thing ARN or a certificate ARN is required.</p>"
303304
},
304305
"DeviceUnderTestList":{
305306
"type":"list",
@@ -319,11 +320,13 @@
319320
"members":{
320321
"thingArn":{
321322
"shape":"AmazonResourceName",
323+
"documentation":"<p>The thing ARN of the device. This is an optional parameter.</p>",
322324
"location":"querystring",
323325
"locationName":"thingArn"
324326
},
325327
"certificateArn":{
326328
"shape":"AmazonResourceName",
329+
"documentation":"<p>The certificate ARN of the device. This is an optional parameter.</p>",
327330
"location":"querystring",
328331
"locationName":"certificateArn"
329332
}
@@ -332,7 +335,10 @@
332335
"GetEndpointResponse":{
333336
"type":"structure",
334337
"members":{
335-
"endpoint":{"shape":"Endpoint"}
338+
"endpoint":{
339+
"shape":"Endpoint",
340+
"documentation":"<p>The response of an Device Advisor endpoint.</p>"
341+
}
336342
}
337343
},
338344
"GetSuiteDefinitionRequest":{
@@ -470,7 +476,7 @@
470476
},
471477
"startTime":{
472478
"shape":"Timestamp",
473-
"documentation":"<p>Date (in Unix epoch time) when the test suite run was started.</p>"
479+
"documentation":"<p>Date (in Unix epoch time) when the test suite run started.</p>"
474480
},
475481
"endTime":{
476482
"shape":"Timestamp",
@@ -520,10 +526,10 @@
520526
"members":{
521527
"message":{
522528
"shape":"Message",
523-
"documentation":"<p>Sends Internal Failure Exception message.</p>"
529+
"documentation":"<p>Sends an Internal Failure Exception message.</p>"
524530
}
525531
},
526-
"documentation":"<p>Sends Internal Failure Exception.</p>",
532+
"documentation":"<p>Sends an Internal Failure exception.</p>",
527533
"error":{"httpStatusCode":500},
528534
"exception":true,
529535
"fault":true
@@ -569,7 +575,7 @@
569575
},
570576
"suiteDefinitionVersion":{
571577
"shape":"SuiteDefinitionVersion",
572-
"documentation":"<p>Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.</p>",
578+
"documentation":"<p>Must be passed along with <code>suiteDefinitionId</code>. Lists the test suite runs of the specified test suite based on suite definition version.</p>",
573579
"location":"querystring",
574580
"locationName":"suiteDefinitionVersion"
575581
},
@@ -639,10 +645,10 @@
639645
"members":{
640646
"message":{
641647
"shape":"Message",
642-
"documentation":"<p>Sends Resource Not Found Exception message.</p>"
648+
"documentation":"<p>Sends a Resource Not Found Exception message.</p>"
643649
}
644650
},
645-
"documentation":"<p>Sends Resource Not Found Exception.</p>",
651+
"documentation":"<p>Sends a Resource Not Found exception.</p>",
646652
"error":{"httpStatusCode":404},
647653
"exception":true
648654
},
@@ -769,7 +775,7 @@
769775
},
770776
"devicePermissionRoleArn":{
771777
"shape":"AmazonResourceName",
772-
"documentation":"<p>Gets device permission ARN.</p>"
778+
"documentation":"<p>Gets the device permission ARN.</p>"
773779
}
774780
},
775781
"documentation":"<p>Gets Suite Definition Configuration.</p>"
@@ -787,7 +793,7 @@
787793
},
788794
"defaultDevices":{
789795
"shape":"DeviceUnderTestList",
790-
"documentation":"<p>Specifies the devices under test for the test suite.</p>"
796+
"documentation":"<p>Specifies the devices that are under test for the test suite.</p>"
791797
},
792798
"intendedForQualification":{
793799
"shape":"IntendedForQualificationBoolean",
@@ -825,7 +831,10 @@
825831
"shape":"SelectedTestList",
826832
"documentation":"<p>Gets test case list.</p>"
827833
},
828-
"parallelRun":{"shape":"ParallelRun"}
834+
"parallelRun":{
835+
"shape":"ParallelRun",
836+
"documentation":"<p>TRUE if multiple test suites run in parallel.</p>"
837+
}
829838
},
830839
"documentation":"<p>Gets suite run configuration.</p>"
831840
},
@@ -941,19 +950,19 @@
941950
"members":{
942951
"testCaseRunId":{
943952
"shape":"UUID",
944-
"documentation":"<p>Provides test case run ID.</p>"
953+
"documentation":"<p>Provides the test case run ID.</p>"
945954
},
946955
"testCaseDefinitionId":{
947956
"shape":"UUID",
948-
"documentation":"<p>Provides test case run definition ID.</p>"
957+
"documentation":"<p>Provides the test case run definition ID.</p>"
949958
},
950959
"testCaseDefinitionName":{
951960
"shape":"TestCaseDefinitionName",
952-
"documentation":"<p>Provides test case run definition Name.</p>"
961+
"documentation":"<p>Provides the test case run definition name.</p>"
953962
},
954963
"status":{
955964
"shape":"Status",
956-
"documentation":"<p>Provides test case run status.</p> <ul> <li> <p> <code>PASS</code>: Test passed.</p> </li> <li> <p> <code>FAIL</code>: Test failed.</p> </li> <li> <p> <code>PENDING</code>: Test has not started running but is scheduled.</p> </li> <li> <p> <code>RUNNING</code>: Test is running</p> </li> <li> <p> <code>STOPPING</code>: Test is performing cleanup steps. You will see this status only if you stop a suite run.</p> </li> <li> <p> <code>STOPPED</code> Test is stopped. You will see this status only if you stop a suite run.</p> </li> <li> <p> <code>PASS_WITH_WARNINGS</code>: Test passed with warnings.</p> </li> <li> <p> <code>ERORR</code>: Test faced an error when running due to an internal issue.</p> </li> </ul>"
965+
"documentation":"<p>Provides the test case run status. Status is one of the following:</p> <ul> <li> <p> <code>PASS</code>: Test passed.</p> </li> <li> <p> <code>FAIL</code>: Test failed.</p> </li> <li> <p> <code>PENDING</code>: Test has not started running but is scheduled.</p> </li> <li> <p> <code>RUNNING</code>: Test is running.</p> </li> <li> <p> <code>STOPPING</code>: Test is performing cleanup steps. You will see this status only if you stop a suite run.</p> </li> <li> <p> <code>STOPPED</code> Test is stopped. You will see this status only if you stop a suite run.</p> </li> <li> <p> <code>PASS_WITH_WARNINGS</code>: Test passed with warnings.</p> </li> <li> <p> <code>ERORR</code>: Test faced an error when running due to an internal issue.</p> </li> </ul>"
957966
},
958967
"startTime":{
959968
"shape":"Timestamp",
@@ -965,7 +974,7 @@
965974
},
966975
"logUrl":{
967976
"shape":"LogUrl",
968-
"documentation":"<p>Provides test case run log Url.</p>"
977+
"documentation":"<p>Provides test case run log URL.</p>"
969978
},
970979
"warnings":{
971980
"shape":"Warnings",
@@ -976,7 +985,7 @@
976985
"documentation":"<p>Provides test case run failure result.</p>"
977986
}
978987
},
979-
"documentation":"<p>Provides test case run.</p>"
988+
"documentation":"<p>Provides the test case run.</p>"
980989
},
981990
"TestCaseRuns":{
982991
"type":"list",
@@ -1079,10 +1088,10 @@
10791088
"members":{
10801089
"message":{
10811090
"shape":"Message",
1082-
"documentation":"<p>Sends invalid request exception message.</p>"
1091+
"documentation":"<p>Sends a Validation Exception message.</p>"
10831092
}
10841093
},
1085-
"documentation":"<p>Sends invalid request exception.</p>",
1094+
"documentation":"<p>Sends a validation exception.</p>",
10861095
"error":{"httpStatusCode":400},
10871096
"exception":true
10881097
},

0 commit comments

Comments
 (0)