1{
2  "version": "2.0",
3  "service": "<p>AWS IoT Core Device Advisor is a cloud-based, fully managed test capability for validating IoT devices during device software development. Device Advisor provides pre-built tests that you can use to validate IoT devices for reliable and secure connectivity with AWS IoT Core before deploying devices to production. By using Device Advisor, you can confirm that your devices can connect to AWS IoT Core, follow security best practices and, if applicable, receive software updates from IoT Device Management. You can also download signed qualification reports to submit to the AWS Partner Network to get your device qualified for the AWS Partner Device Catalog without the need to send your device in and wait for it to be tested.</p>",
4  "operations": {
5    "CreateSuiteDefinition": "<p>Creates a Device Advisor test suite.</p>",
6    "DeleteSuiteDefinition": "<p>Deletes a Device Advisor test suite.</p>",
7    "GetSuiteDefinition": "<p>Gets information about a Device Advisor test suite.</p>",
8    "GetSuiteRun": "<p>Gets information about a Device Advisor test suite run.</p>",
9    "GetSuiteRunReport": "<p>Gets a report download link for a successful Device Advisor qualifying test suite run.</p>",
10    "ListSuiteDefinitions": "<p>Lists the Device Advisor test suites you have created.</p>",
11    "ListSuiteRuns": "<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>",
12    "ListTagsForResource": "<p>Lists the tags attached to an IoT Device Advisor resource.</p>",
13    "ListTestCases": "<p>Lists all the test cases in the test suite.</p>",
14    "StartSuiteRun": "<p>Starts a Device Advisor test suite run.</p>",
15    "TagResource": "<p>Adds to and modifies existing tags of an IoT Device Advisor resource.</p>",
16    "UntagResource": "<p>Removes tags from an IoT Device Advisor resource.</p>",
17    "UpdateSuiteDefinition": "<p>Updates a Device Advisor test suite.</p>"
18  },
19  "shapes": {
20    "AmazonResourceName": {
21      "base": null,
22      "refs": {
23        "CreateSuiteDefinitionResponse$suiteDefinitionArn": "<p>Creates a Device Advisor test suite with Amazon Resource name.</p>",
24        "DeviceUnderTest$thingArn": "<p>Lists devices thing arn</p>",
25        "DeviceUnderTest$certificateArn": "<p>Lists devices certificate arn</p>",
26        "GetSuiteDefinitionResponse$suiteDefinitionArn": "<p>The ARN of the suite definition.</p>",
27        "GetSuiteRunResponse$suiteRunArn": "<p>The ARN of the suite run.</p>",
28        "ListTagsForResourceRequest$resourceArn": "<p>The ARN of the IoT Device Advisor resource.</p>",
29        "StartSuiteRunResponse$suiteRunArn": "<p>Starts a Device Advisor test suite run based on suite run arn.</p>",
30        "SuiteDefinitionConfiguration$devicePermissionRoleArn": "<p>Gets device permission arn.</p>",
31        "TagResourceRequest$resourceArn": "<p>The resource ARN of an IoT Device Advisor resource.</p>",
32        "UntagResourceRequest$resourceArn": "<p>The resource ARN of an IoT Device Advisor resource.</p>",
33        "UpdateSuiteDefinitionResponse$suiteDefinitionArn": "<p>Updates a Device Advisor test suite with Amazon Resource name.</p>"
34      }
35    },
36    "CategoryName": {
37      "base": null,
38      "refs": {
39        "TestCaseCategory$name": "<p>Lists all the tests name in the specified category.</p>"
40      }
41    },
42    "ConfigString": {
43      "base": null,
44      "refs": {
45        "TestConfiguration$key": null,
46        "TestConfiguration$value": null
47      }
48    },
49    "ConflictException": {
50      "base": "<p>Sends Conflict Exception.</p>",
51      "refs": {
52      }
53    },
54    "CreateSuiteDefinitionRequest": {
55      "base": null,
56      "refs": {
57      }
58    },
59    "CreateSuiteDefinitionResponse": {
60      "base": null,
61      "refs": {
62      }
63    },
64    "DeleteSuiteDefinitionRequest": {
65      "base": null,
66      "refs": {
67      }
68    },
69    "DeleteSuiteDefinitionResponse": {
70      "base": null,
71      "refs": {
72      }
73    },
74    "DeviceUnderTest": {
75      "base": "<p>Lists all the devices under test</p>",
76      "refs": {
77        "DeviceUnderTestList$member": null,
78        "SuiteRunConfiguration$primaryDevice": "<p>Gets the primary device for suite run.</p>",
79        "SuiteRunConfiguration$secondaryDevice": "<p>Gets the secondary device for suite run.</p>"
80      }
81    },
82    "DeviceUnderTestList": {
83      "base": null,
84      "refs": {
85        "SuiteDefinitionConfiguration$devices": "<p>Gets the devices configured.</p>",
86        "SuiteDefinitionInformation$defaultDevices": "<p>Specifies the devices under test.</p>"
87      }
88    },
89    "ErrorReason": {
90      "base": null,
91      "refs": {
92        "GetSuiteRunResponse$errorReason": "<p>Gets the information about Device Advisor test suite run based on error.</p>"
93      }
94    },
95    "Failure": {
96      "base": null,
97      "refs": {
98        "TestCaseRun$failure": "<p>Provides test case run failure result.</p>"
99      }
100    },
101    "GetSuiteDefinitionRequest": {
102      "base": null,
103      "refs": {
104      }
105    },
106    "GetSuiteDefinitionResponse": {
107      "base": null,
108      "refs": {
109      }
110    },
111    "GetSuiteRunReportRequest": {
112      "base": null,
113      "refs": {
114      }
115    },
116    "GetSuiteRunReportResponse": {
117      "base": null,
118      "refs": {
119      }
120    },
121    "GetSuiteRunRequest": {
122      "base": null,
123      "refs": {
124      }
125    },
126    "GetSuiteRunResponse": {
127      "base": null,
128      "refs": {
129      }
130    },
131    "GroupName": {
132      "base": null,
133      "refs": {
134        "GroupResult$groupName": "<p>Show Group Result Name.</p>"
135      }
136    },
137    "GroupResult": {
138      "base": "<p>Show Group Result.</p>",
139      "refs": {
140        "GroupResultList$member": null
141      }
142    },
143    "GroupResultList": {
144      "base": "<p>how Group Result list.</p>",
145      "refs": {
146        "TestResult$groups": "<p>Show each group of test results.</p>"
147      }
148    },
149    "IntendedForQualificationBoolean": {
150      "base": null,
151      "refs": {
152        "ListTestCasesRequest$intendedForQualification": "<p>Lists all the qualification test cases in the test suite.</p>",
153        "SuiteDefinitionConfiguration$intendedForQualification": "<p>Gets the tests intended for qualification in a suite.</p>",
154        "SuiteDefinitionInformation$intendedForQualification": "<p>Gets the test suites which will be used for qualification.</p>"
155      }
156    },
157    "InternalServerException": {
158      "base": "<p>Sends Internal Failure Exception.</p>",
159      "refs": {
160      }
161    },
162    "ListSuiteDefinitionsRequest": {
163      "base": null,
164      "refs": {
165      }
166    },
167    "ListSuiteDefinitionsResponse": {
168      "base": null,
169      "refs": {
170      }
171    },
172    "ListSuiteRunsRequest": {
173      "base": null,
174      "refs": {
175      }
176    },
177    "ListSuiteRunsResponse": {
178      "base": null,
179      "refs": {
180      }
181    },
182    "ListTagsForResourceRequest": {
183      "base": null,
184      "refs": {
185      }
186    },
187    "ListTagsForResourceResponse": {
188      "base": null,
189      "refs": {
190      }
191    },
192    "ListTestCasesRequest": {
193      "base": null,
194      "refs": {
195      }
196    },
197    "ListTestCasesResponse": {
198      "base": null,
199      "refs": {
200      }
201    },
202    "LogUrl": {
203      "base": null,
204      "refs": {
205        "TestCaseRun$logUrl": "<p>Provides test case run log Url.</p>"
206      }
207    },
208    "MaxResults": {
209      "base": null,
210      "refs": {
211        "ListSuiteDefinitionsRequest$maxResults": "<p>Request the list of all the Device Advisor test suites.</p>",
212        "ListSuiteRunsRequest$maxResults": "<p>MaxResults for list suite run API request.</p>",
213        "ListTestCasesRequest$maxResults": "<p>Requests the test cases max results.</p>"
214      }
215    },
216    "Message": {
217      "base": null,
218      "refs": {
219        "ConflictException$message": "<p>Sends Conflict Exception message.</p>",
220        "InternalServerException$message": "<p>Sends Internal Failure Exception message.</p>",
221        "ResourceNotFoundException$message": "<p>Sends Resource Not Found Exception message.</p>",
222        "ValidationException$message": "<p>Sends invalid request exception message.</p>"
223      }
224    },
225    "QualificationReportDownloadUrl": {
226      "base": null,
227      "refs": {
228        "GetSuiteRunReportResponse$qualificationReportDownloadUrl": "<p>Gets the download URL of the qualification report.</p>"
229      }
230    },
231    "ResourceNotFoundException": {
232      "base": "<p>Sends Resource Not Found Exception.</p>",
233      "refs": {
234      }
235    },
236    "RootGroup": {
237      "base": null,
238      "refs": {
239        "SuiteDefinitionConfiguration$rootGroup": "<p>Gets test suite root group.</p>"
240      }
241    },
242    "SelectedTestList": {
243      "base": null,
244      "refs": {
245        "SuiteRunConfiguration$selectedTestList": "<p>Gets test case list.</p>"
246      }
247    },
248    "StartSuiteRunRequest": {
249      "base": null,
250      "refs": {
251      }
252    },
253    "StartSuiteRunResponse": {
254      "base": null,
255      "refs": {
256      }
257    },
258    "Status": {
259      "base": null,
260      "refs": {
261        "TestCaseRun$status": "<p>Provides test case run status.</p>"
262      }
263    },
264    "String128": {
265      "base": null,
266      "refs": {
267        "TagKeyList$member": null,
268        "TagMap$key": null
269      }
270    },
271    "String256": {
272      "base": null,
273      "refs": {
274        "TagMap$value": null
275      }
276    },
277    "SuiteDefinitionConfiguration": {
278      "base": "<p>Gets Suite Definition Configuration.</p>",
279      "refs": {
280        "CreateSuiteDefinitionRequest$suiteDefinitionConfiguration": "<p>Creates a Device Advisor test suite with suite definition configuration.</p>",
281        "GetSuiteDefinitionResponse$suiteDefinitionConfiguration": "<p>Gets the suite configuration with GetSuiteDefinition API call.</p>",
282        "UpdateSuiteDefinitionRequest$suiteDefinitionConfiguration": "<p>Updates a Device Advisor test suite with suite definition configuration.</p>"
283      }
284    },
285    "SuiteDefinitionInformation": {
286      "base": "<p>Get suite definition information.</p>",
287      "refs": {
288        "SuiteDefinitionInformationList$member": null
289      }
290    },
291    "SuiteDefinitionInformationList": {
292      "base": null,
293      "refs": {
294        "ListSuiteDefinitionsResponse$suiteDefinitionInformationList": "<p>Lists test suite information using List suite definition.</p>"
295      }
296    },
297    "SuiteDefinitionName": {
298      "base": null,
299      "refs": {
300        "CreateSuiteDefinitionResponse$suiteDefinitionName": "<p>Creates a Device Advisor test suite with suite definition name.</p>",
301        "SuiteDefinitionConfiguration$suiteDefinitionName": "<p>Gets Suite Definition Configuration name.</p>",
302        "SuiteDefinitionInformation$suiteDefinitionName": "<p>Get test suite name.</p>",
303        "SuiteRunInformation$suiteDefinitionName": "<p>Get suite run information based on suite definition name.</p>",
304        "UpdateSuiteDefinitionResponse$suiteDefinitionName": "<p>Updates a Device Advisor test suite with suite definition name.</p>"
305      }
306    },
307    "SuiteDefinitionVersion": {
308      "base": null,
309      "refs": {
310        "GetSuiteDefinitionRequest$suiteDefinitionVersion": "<p>Requests the suite definition version of a test suite.</p>",
311        "GetSuiteDefinitionResponse$suiteDefinitionVersion": "<p>Gets suite definition version with GetSuiteDefinition API call.</p>",
312        "GetSuiteDefinitionResponse$latestVersion": "<p>Gets latest suite definition version with GetSuiteDefinition API call.</p>",
313        "GetSuiteRunResponse$suiteDefinitionVersion": "<p>Gets the information about Device Advisor test suite run based on suite definition version.</p>",
314        "ListSuiteRunsRequest$suiteDefinitionVersion": "<p>Lists the runs of the specified Device Advisor test suite based on suite definition version.</p>",
315        "StartSuiteRunRequest$suiteDefinitionVersion": "<p>Request to start suite run based on suite definition version.</p>",
316        "SuiteRunInformation$suiteDefinitionVersion": "<p>Get suite run information based on suite definition version.</p>",
317        "UpdateSuiteDefinitionResponse$suiteDefinitionVersion": "<p>Updates a Device Advisor test suite with suite definition version.</p>"
318      }
319    },
320    "SuiteRunConfiguration": {
321      "base": "<p>Gets suite run configuration.</p>",
322      "refs": {
323        "GetSuiteRunResponse$suiteRunConfiguration": "<p>Gets the information about Device Advisor test suite run based on suite configuration.</p>",
324        "StartSuiteRunRequest$suiteRunConfiguration": "<p>Request to start suite run based on suite configuration.</p>"
325      }
326    },
327    "SuiteRunInformation": {
328      "base": "<p>Get suite run information.</p>",
329      "refs": {
330        "SuiteRunsList$member": null
331      }
332    },
333    "SuiteRunResultCount": {
334      "base": null,
335      "refs": {
336        "SuiteRunInformation$passed": "<p>Get suite run information based on result of the test suite run.</p>",
337        "SuiteRunInformation$failed": "<p>Get suite run information based on result of the test suite run.</p>"
338      }
339    },
340    "SuiteRunStatus": {
341      "base": null,
342      "refs": {
343        "GetSuiteRunResponse$status": "<p>Gets the information about Device Advisor test suite run based on its status.</p>",
344        "SuiteRunInformation$status": "<p>Get suite run information based on test run status.</p>"
345      }
346    },
347    "SuiteRunsList": {
348      "base": null,
349      "refs": {
350        "ListSuiteRunsResponse$suiteRunsList": "<p>Lists the runs of the specified Device Advisor test suite.</p>"
351      }
352    },
353    "TagKeyList": {
354      "base": null,
355      "refs": {
356        "UntagResourceRequest$tagKeys": "<p>List of tag keys to remove from the IoT Device Advisor resource.</p>"
357      }
358    },
359    "TagMap": {
360      "base": null,
361      "refs": {
362        "CreateSuiteDefinitionRequest$tags": "<p>The tags to be attached to the suite definition.</p>",
363        "GetSuiteDefinitionResponse$tags": "<p>Tags attached to the suite definition.</p>",
364        "GetSuiteRunResponse$tags": "<p>The tags attached to the suite run.</p>",
365        "ListTagsForResourceResponse$tags": "<p>The tags attached to the IoT Device Advisor resource.</p>",
366        "StartSuiteRunRequest$tags": "<p>The tags to be attached to the suite run.</p>",
367        "TagResourceRequest$tags": "<p>The tags to be attached to the IoT Device Advisor resource.</p>"
368      }
369    },
370    "TagResourceRequest": {
371      "base": null,
372      "refs": {
373      }
374    },
375    "TagResourceResponse": {
376      "base": null,
377      "refs": {
378      }
379    },
380    "TestCase": {
381      "base": "<p>Shows tests in a test group.</p>",
382      "refs": {
383        "TestCaseList$member": null
384      }
385    },
386    "TestCaseCategory": {
387      "base": "<p>Gets the test case category.</p>",
388      "refs": {
389        "TestCategory$member": null
390      }
391    },
392    "TestCaseDefinition": {
393      "base": "<p>Provides test case definition.</p>",
394      "refs": {
395        "TestCase$test": "<p>Specifies a test.</p>"
396      }
397    },
398    "TestCaseDefinitionName": {
399      "base": null,
400      "refs": {
401        "TestCaseRun$testCaseDefinitionName": "<p>Provides test case run definition Name.</p>"
402      }
403    },
404    "TestCaseList": {
405      "base": null,
406      "refs": {
407        "TestCaseCategory$tests": "<p>Lists all the tests in the specified category.</p>"
408      }
409    },
410    "TestCaseName": {
411      "base": null,
412      "refs": {
413        "TestCase$name": "<p>Shows test case name.</p>",
414        "TestCaseDefinition$id": "<p>Provides test case definition Id.</p>"
415      }
416    },
417    "TestCaseRun": {
418      "base": "<p>Provides test case run.</p>",
419      "refs": {
420        "TestCaseRuns$member": null
421      }
422    },
423    "TestCaseRuns": {
424      "base": "<p>Show each group result.</p>",
425      "refs": {
426        "GroupResult$tests": "<p>Show Group Result.</p>"
427      }
428    },
429    "TestCaseVersion": {
430      "base": null,
431      "refs": {
432        "TestCaseDefinition$testCaseVersion": "<p>Provides test case definition version.</p>"
433      }
434    },
435    "TestCategory": {
436      "base": null,
437      "refs": {
438        "ListTestCasesResponse$categories": "<p>Gets the category of test case.</p>"
439      }
440    },
441    "TestConfiguration": {
442      "base": null,
443      "refs": {
444        "ListTestCasesResponse$rootGroupConfiguration": "<p>Gets the configuration of root test group.</p>",
445        "ListTestCasesResponse$groupConfiguration": "<p>Gets the configuration of test group.</p>",
446        "TestCase$configuration": "<p>Shows test case configuration.</p>"
447      }
448    },
449    "TestResult": {
450      "base": "<p>Show each group result.</p>",
451      "refs": {
452        "GetSuiteRunResponse$testResult": "<p>Gets the information about Device Advisor test suite run based on test case runs.</p>"
453      }
454    },
455    "Timestamp": {
456      "base": null,
457      "refs": {
458        "CreateSuiteDefinitionResponse$createdAt": "<p>Creates a Device Advisor test suite with TimeStamp of when it was created.</p>",
459        "GetSuiteDefinitionResponse$createdAt": "<p>Gets the timestamp of the time suite was created with GetSuiteDefinition API call.</p>",
460        "GetSuiteDefinitionResponse$lastModifiedAt": "<p>Gets the timestamp of the time suite was modified with GetSuiteDefinition API call.</p>",
461        "GetSuiteRunResponse$startTime": "<p>Gets the information about Device Advisor test suite run based on start time.</p>",
462        "GetSuiteRunResponse$endTime": "<p>Gets the information about Device Advisor test suite run based on end time.</p>",
463        "StartSuiteRunResponse$createdAt": "<p>Starts a Device Advisor test suite run based on suite create time.</p>",
464        "SuiteDefinitionInformation$createdAt": "<p>Gets the information of when the test suite was created.</p>",
465        "SuiteRunInformation$createdAt": "<p>Get suite run information based on time suite was created.</p>",
466        "SuiteRunInformation$startedAt": "<p>Get suite run information based on start time of the run.</p>",
467        "SuiteRunInformation$endAt": "<p>Get suite run information based on end time of the run.</p>",
468        "TestCaseRun$startTime": "<p>Provides test case run start time.</p>",
469        "TestCaseRun$endTime": "<p>Provides test case run end time.</p>",
470        "UpdateSuiteDefinitionResponse$createdAt": "<p>Updates a Device Advisor test suite with TimeStamp of when it was created.</p>",
471        "UpdateSuiteDefinitionResponse$lastUpdatedAt": "<p>Updates a Device Advisor test suite with TimeStamp of when it was updated.</p>"
472      }
473    },
474    "Token": {
475      "base": null,
476      "refs": {
477        "ListSuiteDefinitionsRequest$nextToken": "<p>Requests the Device Advisor test suites next token.</p>",
478        "ListSuiteDefinitionsResponse$nextToken": "<p>Creates a Device Advisor test suite.</p>",
479        "ListSuiteRunsRequest$nextToken": "<p>Next pagination token for list suite run request.</p>",
480        "ListSuiteRunsResponse$nextToken": "<p>Next pagination token for list suite run response.</p>",
481        "ListTestCasesRequest$nextToken": "<p>Requests the test cases next token.</p>",
482        "ListTestCasesResponse$nextToken": "<p>Test cases next token response.</p>"
483      }
484    },
485    "UUID": {
486      "base": null,
487      "refs": {
488        "CreateSuiteDefinitionResponse$suiteDefinitionId": "<p>Creates a Device Advisor test suite with suite UUID.</p>",
489        "DeleteSuiteDefinitionRequest$suiteDefinitionId": "<p>Deletes a Device Advisor test suite with defined suite Id.</p>",
490        "GetSuiteDefinitionRequest$suiteDefinitionId": "<p>Requests suite definition Id with GetSuiteDefinition API call.</p>",
491        "GetSuiteDefinitionResponse$suiteDefinitionId": "<p>Gets suite definition Id with GetSuiteDefinition API call.</p>",
492        "GetSuiteRunReportRequest$suiteDefinitionId": "<p>Device Advisor suite definition Id.</p>",
493        "GetSuiteRunReportRequest$suiteRunId": "<p>Device Advisor suite run Id.</p>",
494        "GetSuiteRunRequest$suiteDefinitionId": "<p>Requests the information about Device Advisor test suite run based on suite definition Id.</p>",
495        "GetSuiteRunRequest$suiteRunId": "<p>Requests the information about Device Advisor test suite run based on suite run Id.</p>",
496        "GetSuiteRunResponse$suiteDefinitionId": "<p>Gets the information about Device Advisor test suite run based on suite definition Id.</p>",
497        "GetSuiteRunResponse$suiteRunId": "<p>Gets the information about Device Advisor test suite run based on suite run Id.</p>",
498        "GroupResult$groupId": "<p>Show Group Result Id.</p>",
499        "ListSuiteRunsRequest$suiteDefinitionId": "<p>Lists the runs of the specified Device Advisor test suite based on suite definition Id.</p>",
500        "SelectedTestList$member": null,
501        "StartSuiteRunRequest$suiteDefinitionId": "<p>Request to start suite run based on suite definition Id.</p>",
502        "StartSuiteRunResponse$suiteRunId": "<p>Starts a Device Advisor test suite run based on suite Run Id.</p>",
503        "SuiteDefinitionInformation$suiteDefinitionId": "<p>Get suite definition Id.</p>",
504        "SuiteRunInformation$suiteDefinitionId": "<p>Get suite run information based on suite definition Id.</p>",
505        "SuiteRunInformation$suiteRunId": "<p>Get suite run information based on suite run Id.</p>",
506        "TestCaseRun$testCaseRunId": "<p>Provides test case run Id.</p>",
507        "TestCaseRun$testCaseDefinitionId": "<p>Provides test case run definition Id.</p>",
508        "UpdateSuiteDefinitionRequest$suiteDefinitionId": "<p>Updates a Device Advisor test suite with suite definition id.</p>",
509        "UpdateSuiteDefinitionResponse$suiteDefinitionId": "<p>Updates a Device Advisor test suite with suite UUID.</p>"
510      }
511    },
512    "UntagResourceRequest": {
513      "base": null,
514      "refs": {
515      }
516    },
517    "UntagResourceResponse": {
518      "base": null,
519      "refs": {
520      }
521    },
522    "UpdateSuiteDefinitionRequest": {
523      "base": null,
524      "refs": {
525      }
526    },
527    "UpdateSuiteDefinitionResponse": {
528      "base": null,
529      "refs": {
530      }
531    },
532    "ValidationException": {
533      "base": "<p>Sends invalid request exception.</p>",
534      "refs": {
535      }
536    },
537    "Warnings": {
538      "base": null,
539      "refs": {
540        "TestCaseRun$warnings": "<p>Provides test case run warnings.</p>"
541      }
542    }
543  }
544}
545