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    "StartSuiteRun": "<p>Starts a Device Advisor test suite run.</p>",
14    "StopSuiteRun": "<p>Stops a Device Advisor test suite run that is currently running.</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>Amazon resource name of the started suite run.</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>Amazon Resource name of the updated test suite.</p>"
34      }
35    },
36    "ConflictException": {
37      "base": "<p>Sends Conflict Exception.</p>",
38      "refs": {
39      }
40    },
41    "CreateSuiteDefinitionRequest": {
42      "base": null,
43      "refs": {
44      }
45    },
46    "CreateSuiteDefinitionResponse": {
47      "base": null,
48      "refs": {
49      }
50    },
51    "DeleteSuiteDefinitionRequest": {
52      "base": null,
53      "refs": {
54      }
55    },
56    "DeleteSuiteDefinitionResponse": {
57      "base": null,
58      "refs": {
59      }
60    },
61    "DeviceUnderTest": {
62      "base": "<p>Lists all the devices under test</p>",
63      "refs": {
64        "DeviceUnderTestList$member": null,
65        "SuiteRunConfiguration$primaryDevice": "<p>Gets the primary device for suite run.</p>"
66      }
67    },
68    "DeviceUnderTestList": {
69      "base": null,
70      "refs": {
71        "SuiteDefinitionConfiguration$devices": "<p>Gets the devices configured.</p>",
72        "SuiteDefinitionInformation$defaultDevices": "<p>Specifies the devices under test for the test suite.</p>"
73      }
74    },
75    "ErrorReason": {
76      "base": null,
77      "refs": {
78        "GetSuiteRunResponse$errorReason": "<p>Error reason for any test suite run failure.</p>"
79      }
80    },
81    "Failure": {
82      "base": null,
83      "refs": {
84        "TestCaseRun$failure": "<p>Provides test case run failure result.</p>"
85      }
86    },
87    "GetSuiteDefinitionRequest": {
88      "base": null,
89      "refs": {
90      }
91    },
92    "GetSuiteDefinitionResponse": {
93      "base": null,
94      "refs": {
95      }
96    },
97    "GetSuiteRunReportRequest": {
98      "base": null,
99      "refs": {
100      }
101    },
102    "GetSuiteRunReportResponse": {
103      "base": null,
104      "refs": {
105      }
106    },
107    "GetSuiteRunRequest": {
108      "base": null,
109      "refs": {
110      }
111    },
112    "GetSuiteRunResponse": {
113      "base": null,
114      "refs": {
115      }
116    },
117    "GroupName": {
118      "base": null,
119      "refs": {
120        "GroupResult$groupName": "<p>Group Result Name.</p>"
121      }
122    },
123    "GroupResult": {
124      "base": "<p>Show Group Result.</p>",
125      "refs": {
126        "GroupResultList$member": null
127      }
128    },
129    "GroupResultList": {
130      "base": "<p>Group Result list.</p>",
131      "refs": {
132        "TestResult$groups": "<p>Show each group of test results.</p>"
133      }
134    },
135    "IntendedForQualificationBoolean": {
136      "base": null,
137      "refs": {
138        "SuiteDefinitionConfiguration$intendedForQualification": "<p>Gets the tests intended for qualification in a suite.</p>",
139        "SuiteDefinitionInformation$intendedForQualification": "<p>Specifies if the test suite is intended for qualification.</p>"
140      }
141    },
142    "InternalServerException": {
143      "base": "<p>Sends Internal Failure Exception.</p>",
144      "refs": {
145      }
146    },
147    "ListSuiteDefinitionsRequest": {
148      "base": null,
149      "refs": {
150      }
151    },
152    "ListSuiteDefinitionsResponse": {
153      "base": null,
154      "refs": {
155      }
156    },
157    "ListSuiteRunsRequest": {
158      "base": null,
159      "refs": {
160      }
161    },
162    "ListSuiteRunsResponse": {
163      "base": null,
164      "refs": {
165      }
166    },
167    "ListTagsForResourceRequest": {
168      "base": null,
169      "refs": {
170      }
171    },
172    "ListTagsForResourceResponse": {
173      "base": null,
174      "refs": {
175      }
176    },
177    "LogUrl": {
178      "base": null,
179      "refs": {
180        "TestCaseRun$logUrl": "<p>Provides test case run log Url.</p>"
181      }
182    },
183    "MaxResults": {
184      "base": null,
185      "refs": {
186        "ListSuiteDefinitionsRequest$maxResults": "<p>The maximum number of results to return at once.</p>",
187        "ListSuiteRunsRequest$maxResults": "<p>The maximum number of results to return at once.</p>"
188      }
189    },
190    "Message": {
191      "base": null,
192      "refs": {
193        "ConflictException$message": "<p>Sends Conflict Exception message.</p>",
194        "InternalServerException$message": "<p>Sends Internal Failure Exception message.</p>",
195        "ResourceNotFoundException$message": "<p>Sends Resource Not Found Exception message.</p>",
196        "ValidationException$message": "<p>Sends invalid request exception message.</p>"
197      }
198    },
199    "QualificationReportDownloadUrl": {
200      "base": null,
201      "refs": {
202        "GetSuiteRunReportResponse$qualificationReportDownloadUrl": "<p>Download URL of the qualification report.</p>"
203      }
204    },
205    "ResourceNotFoundException": {
206      "base": "<p>Sends Resource Not Found Exception.</p>",
207      "refs": {
208      }
209    },
210    "RootGroup": {
211      "base": null,
212      "refs": {
213        "SuiteDefinitionConfiguration$rootGroup": "<p>Gets test suite root group.</p>"
214      }
215    },
216    "SelectedTestList": {
217      "base": null,
218      "refs": {
219        "SuiteRunConfiguration$selectedTestList": "<p>Gets test case list.</p>"
220      }
221    },
222    "StartSuiteRunRequest": {
223      "base": null,
224      "refs": {
225      }
226    },
227    "StartSuiteRunResponse": {
228      "base": null,
229      "refs": {
230      }
231    },
232    "Status": {
233      "base": null,
234      "refs": {
235        "TestCaseRun$status": "<p>Provides test case run status.</p>"
236      }
237    },
238    "StopSuiteRunRequest": {
239      "base": null,
240      "refs": {
241      }
242    },
243    "StopSuiteRunResponse": {
244      "base": null,
245      "refs": {
246      }
247    },
248    "String128": {
249      "base": null,
250      "refs": {
251        "TagKeyList$member": null,
252        "TagMap$key": null
253      }
254    },
255    "String256": {
256      "base": null,
257      "refs": {
258        "TagMap$value": null
259      }
260    },
261    "SuiteDefinitionConfiguration": {
262      "base": "<p>Gets Suite Definition Configuration.</p>",
263      "refs": {
264        "CreateSuiteDefinitionRequest$suiteDefinitionConfiguration": "<p>Creates a Device Advisor test suite with suite definition configuration.</p>",
265        "GetSuiteDefinitionResponse$suiteDefinitionConfiguration": "<p>Suite configuration of the suite definition.</p>",
266        "UpdateSuiteDefinitionRequest$suiteDefinitionConfiguration": "<p>Updates a Device Advisor test suite with suite definition configuration.</p>"
267      }
268    },
269    "SuiteDefinitionInformation": {
270      "base": "<p>Information about the suite definition.</p>",
271      "refs": {
272        "SuiteDefinitionInformationList$member": null
273      }
274    },
275    "SuiteDefinitionInformationList": {
276      "base": null,
277      "refs": {
278        "ListSuiteDefinitionsResponse$suiteDefinitionInformationList": "<p>An array of objects that provide summaries of information about the suite definitions in the list.</p>"
279      }
280    },
281    "SuiteDefinitionName": {
282      "base": null,
283      "refs": {
284        "CreateSuiteDefinitionResponse$suiteDefinitionName": "<p>Creates a Device Advisor test suite with suite definition name.</p>",
285        "SuiteDefinitionConfiguration$suiteDefinitionName": "<p>Gets Suite Definition Configuration name.</p>",
286        "SuiteDefinitionInformation$suiteDefinitionName": "<p>Suite name of the test suite.</p>",
287        "SuiteRunInformation$suiteDefinitionName": "<p>Suite definition name of the suite run.</p>",
288        "UpdateSuiteDefinitionResponse$suiteDefinitionName": "<p>Suite definition name of the updated test suite.</p>"
289      }
290    },
291    "SuiteDefinitionVersion": {
292      "base": null,
293      "refs": {
294        "GetSuiteDefinitionRequest$suiteDefinitionVersion": "<p>Suite definition version of the test suite to get.</p>",
295        "GetSuiteDefinitionResponse$suiteDefinitionVersion": "<p>Suite definition version of the suite definition.</p>",
296        "GetSuiteDefinitionResponse$latestVersion": "<p>Latest suite definition version of the suite definition.</p>",
297        "GetSuiteRunResponse$suiteDefinitionVersion": "<p>Suite definition version for the test suite run.</p>",
298        "ListSuiteRunsRequest$suiteDefinitionVersion": "<p>Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.</p>",
299        "StartSuiteRunRequest$suiteDefinitionVersion": "<p>Suite definition version of the test suite.</p>",
300        "SuiteRunInformation$suiteDefinitionVersion": "<p>Suite definition version of the suite run.</p>",
301        "UpdateSuiteDefinitionResponse$suiteDefinitionVersion": "<p>Suite definition version of the updated test suite.</p>"
302      }
303    },
304    "SuiteRunConfiguration": {
305      "base": "<p>Gets suite run configuration.</p>",
306      "refs": {
307        "GetSuiteRunResponse$suiteRunConfiguration": "<p>Suite run configuration for the test suite run.</p>",
308        "StartSuiteRunRequest$suiteRunConfiguration": "<p>Suite run configuration.</p>"
309      }
310    },
311    "SuiteRunInformation": {
312      "base": "<p>Information about the suite run.</p>",
313      "refs": {
314        "SuiteRunsList$member": null
315      }
316    },
317    "SuiteRunResultCount": {
318      "base": null,
319      "refs": {
320        "SuiteRunInformation$passed": "<p>Number of test cases that passed in the suite run.</p>",
321        "SuiteRunInformation$failed": "<p>Number of test cases that failed in the suite run.</p>"
322      }
323    },
324    "SuiteRunStatus": {
325      "base": null,
326      "refs": {
327        "GetSuiteRunResponse$status": "<p>Status for the test suite run.</p>",
328        "SuiteRunInformation$status": "<p>Status of the suite run.</p>"
329      }
330    },
331    "SuiteRunsList": {
332      "base": null,
333      "refs": {
334        "ListSuiteRunsResponse$suiteRunsList": "<p>An array of objects that provide summaries of information about the suite runs in the list.</p>"
335      }
336    },
337    "TagKeyList": {
338      "base": null,
339      "refs": {
340        "UntagResourceRequest$tagKeys": "<p>List of tag keys to remove from the IoT Device Advisor resource.</p>"
341      }
342    },
343    "TagMap": {
344      "base": null,
345      "refs": {
346        "CreateSuiteDefinitionRequest$tags": "<p>The tags to be attached to the suite definition.</p>",
347        "GetSuiteDefinitionResponse$tags": "<p>Tags attached to the suite definition.</p>",
348        "GetSuiteRunResponse$tags": "<p>The tags attached to the suite run.</p>",
349        "ListTagsForResourceResponse$tags": "<p>The tags attached to the IoT Device Advisor resource.</p>",
350        "StartSuiteRunRequest$tags": "<p>The tags to be attached to the suite run.</p>",
351        "TagResourceRequest$tags": "<p>The tags to be attached to the IoT Device Advisor resource.</p>"
352      }
353    },
354    "TagResourceRequest": {
355      "base": null,
356      "refs": {
357      }
358    },
359    "TagResourceResponse": {
360      "base": null,
361      "refs": {
362      }
363    },
364    "TestCaseDefinitionName": {
365      "base": null,
366      "refs": {
367        "TestCaseRun$testCaseDefinitionName": "<p>Provides test case run definition Name.</p>"
368      }
369    },
370    "TestCaseRun": {
371      "base": "<p>Provides test case run.</p>",
372      "refs": {
373        "TestCaseRuns$member": null
374      }
375    },
376    "TestCaseRuns": {
377      "base": "<p>Tests under each group result.</p>",
378      "refs": {
379        "GroupResult$tests": "<p>Tests under Group Result.</p>"
380      }
381    },
382    "TestResult": {
383      "base": "<p>Show each group result.</p>",
384      "refs": {
385        "GetSuiteRunResponse$testResult": "<p>Test results for the test suite run.</p>"
386      }
387    },
388    "Timestamp": {
389      "base": null,
390      "refs": {
391        "CreateSuiteDefinitionResponse$createdAt": "<p>Creates a Device Advisor test suite with TimeStamp of when it was created.</p>",
392        "GetSuiteDefinitionResponse$createdAt": "<p>Date (in Unix epoch time) when the suite definition was created.</p>",
393        "GetSuiteDefinitionResponse$lastModifiedAt": "<p>Date (in Unix epoch time) when the suite definition was last modified.</p>",
394        "GetSuiteRunResponse$startTime": "<p>Date (in Unix epoch time) when the test suite run was started.</p>",
395        "GetSuiteRunResponse$endTime": "<p>Date (in Unix epoch time) when the test suite run ended.</p>",
396        "StartSuiteRunResponse$createdAt": "<p>Date (in Unix epoch time) when the suite run was created.</p>",
397        "SuiteDefinitionInformation$createdAt": "<p>Date (in Unix epoch time) when the test suite was created.</p>",
398        "SuiteRunInformation$createdAt": "<p>Date (in Unix epoch time) when the suite run was created.</p>",
399        "SuiteRunInformation$startedAt": "<p>Date (in Unix epoch time) when the suite run was started.</p>",
400        "SuiteRunInformation$endAt": "<p>Date (in Unix epoch time) when the suite run ended.</p>",
401        "TestCaseRun$startTime": "<p>Provides test case run start time.</p>",
402        "TestCaseRun$endTime": "<p>Provides test case run end time.</p>",
403        "UpdateSuiteDefinitionResponse$createdAt": "<p>Timestamp of when the test suite was created.</p>",
404        "UpdateSuiteDefinitionResponse$lastUpdatedAt": "<p>Timestamp of when the test suite was updated.</p>"
405      }
406    },
407    "Token": {
408      "base": null,
409      "refs": {
410        "ListSuiteDefinitionsRequest$nextToken": "<p>A token used to get the next set of results.</p>",
411        "ListSuiteDefinitionsResponse$nextToken": "<p>A token used to get the next set of results.</p>",
412        "ListSuiteRunsRequest$nextToken": "<p>A token to retrieve the next set of results.</p>",
413        "ListSuiteRunsResponse$nextToken": "<p>A token to retrieve the next set of results.</p>"
414      }
415    },
416    "UUID": {
417      "base": null,
418      "refs": {
419        "CreateSuiteDefinitionResponse$suiteDefinitionId": "<p>Creates a Device Advisor test suite with suite UUID.</p>",
420        "DeleteSuiteDefinitionRequest$suiteDefinitionId": "<p>Suite definition Id of the test suite to be deleted.</p>",
421        "GetSuiteDefinitionRequest$suiteDefinitionId": "<p>Suite definition Id of the test suite to get.</p>",
422        "GetSuiteDefinitionResponse$suiteDefinitionId": "<p>Suite definition Id of the suite definition.</p>",
423        "GetSuiteRunReportRequest$suiteDefinitionId": "<p>Suite definition Id of the test suite.</p>",
424        "GetSuiteRunReportRequest$suiteRunId": "<p>Suite run Id of the test suite run.</p>",
425        "GetSuiteRunRequest$suiteDefinitionId": "<p>Suite definition Id for the test suite run.</p>",
426        "GetSuiteRunRequest$suiteRunId": "<p>Suite run Id for the test suite run.</p>",
427        "GetSuiteRunResponse$suiteDefinitionId": "<p>Suite definition Id for the test suite run.</p>",
428        "GetSuiteRunResponse$suiteRunId": "<p>Suite run Id for the test suite run.</p>",
429        "GroupResult$groupId": "<p>Group result Id.</p>",
430        "ListSuiteRunsRequest$suiteDefinitionId": "<p>Lists the test suite runs of the specified test suite based on suite definition Id.</p>",
431        "SelectedTestList$member": null,
432        "StartSuiteRunRequest$suiteDefinitionId": "<p>Suite definition Id of the test suite.</p>",
433        "StartSuiteRunResponse$suiteRunId": "<p>Suite Run Id of the started suite run.</p>",
434        "StopSuiteRunRequest$suiteDefinitionId": "<p>Suite definition Id of the test suite run to be stopped.</p>",
435        "StopSuiteRunRequest$suiteRunId": "<p>Suite run Id of the test suite run to be stopped.</p>",
436        "SuiteDefinitionInformation$suiteDefinitionId": "<p>Suite definition Id of the test suite.</p>",
437        "SuiteRunInformation$suiteDefinitionId": "<p>Suite definition Id of the suite run.</p>",
438        "SuiteRunInformation$suiteRunId": "<p>Suite run Id of the suite run.</p>",
439        "TestCaseRun$testCaseRunId": "<p>Provides test case run Id.</p>",
440        "TestCaseRun$testCaseDefinitionId": "<p>Provides test case run definition Id.</p>",
441        "UpdateSuiteDefinitionRequest$suiteDefinitionId": "<p>Suite definition Id of the test suite to be updated.</p>",
442        "UpdateSuiteDefinitionResponse$suiteDefinitionId": "<p>Suite definition Id of the updated test suite.</p>"
443      }
444    },
445    "UntagResourceRequest": {
446      "base": null,
447      "refs": {
448      }
449    },
450    "UntagResourceResponse": {
451      "base": null,
452      "refs": {
453      }
454    },
455    "UpdateSuiteDefinitionRequest": {
456      "base": null,
457      "refs": {
458      }
459    },
460    "UpdateSuiteDefinitionResponse": {
461      "base": null,
462      "refs": {
463      }
464    },
465    "ValidationException": {
466      "base": "<p>Sends invalid request exception.</p>",
467      "refs": {
468      }
469    },
470    "Warnings": {
471      "base": null,
472      "refs": {
473        "TestCaseRun$warnings": "<p>Provides test case run warnings.</p>"
474      }
475    }
476  }
477}
478