|
79 | 79 | { |
80 | 80 | "shape": "ResourceNotFoundException" |
81 | 81 | } |
82 | | - ] |
| 82 | + ], |
| 83 | + "documentation": "<p>Gets information about an Device Advisor endpoint.</p>" |
83 | 84 | }, |
84 | 85 | "GetSuiteDefinition": { |
85 | 86 | "name": "GetSuiteDefinition", |
|
198 | 199 | "shape": "InternalServerException" |
199 | 200 | } |
200 | 201 | ], |
201 | | - "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>" |
| 202 | + "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>" |
202 | 203 | }, |
203 | 204 | "ListTagsForResource": { |
204 | 205 | "name": "ListTagsForResource", |
|
418 | 419 | "documentation": "<p>Lists devices certificate ARN.</p>" |
419 | 420 | } |
420 | 421 | }, |
421 | | - "documentation": "<p>Information of a test device. Required to provide either a thing ARN or a certificate ARN.</p>" |
| 422 | + "documentation": "<p>Information of a test device. A thing ARN or a certificate ARN is required.</p>" |
422 | 423 | }, |
423 | 424 | "DeviceUnderTestList": { |
424 | 425 | "type": "list", |
|
444 | 445 | "members": { |
445 | 446 | "thingArn": { |
446 | 447 | "shape": "AmazonResourceName", |
| 448 | + "documentation": "<p>The thing ARN of the device. This is an optional parameter.</p>", |
447 | 449 | "location": "querystring", |
448 | 450 | "locationName": "thingArn" |
449 | 451 | }, |
450 | 452 | "certificateArn": { |
451 | 453 | "shape": "AmazonResourceName", |
| 454 | + "documentation": "<p>The certificate ARN of the device. This is an optional parameter.</p>", |
452 | 455 | "location": "querystring", |
453 | 456 | "locationName": "certificateArn" |
454 | 457 | } |
|
458 | 461 | "type": "structure", |
459 | 462 | "members": { |
460 | 463 | "endpoint": { |
461 | | - "shape": "Endpoint" |
| 464 | + "shape": "Endpoint", |
| 465 | + "documentation": "<p>The response of an Device Advisor endpoint.</p>" |
462 | 466 | } |
463 | 467 | } |
464 | 468 | }, |
|
599 | 603 | }, |
600 | 604 | "startTime": { |
601 | 605 | "shape": "Timestamp", |
602 | | - "documentation": "<p>Date (in Unix epoch time) when the test suite run was started.</p>" |
| 606 | + "documentation": "<p>Date (in Unix epoch time) when the test suite run started.</p>" |
603 | 607 | }, |
604 | 608 | "endTime": { |
605 | 609 | "shape": "Timestamp", |
|
691 | 695 | }, |
692 | 696 | "suiteDefinitionVersion": { |
693 | 697 | "shape": "SuiteDefinitionVersion", |
694 | | - "documentation": "<p>Must be passed along with suiteDefinitionId. Lists the test suite runs of the specified test suite based on suite definition version.</p>", |
| 698 | + "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>", |
695 | 699 | "location": "querystring", |
696 | 700 | "locationName": "suiteDefinitionVersion" |
697 | 701 | }, |
|
885 | 889 | }, |
886 | 890 | "devicePermissionRoleArn": { |
887 | 891 | "shape": "AmazonResourceName", |
888 | | - "documentation": "<p>Gets device permission ARN.</p>" |
| 892 | + "documentation": "<p>Gets the device permission ARN.</p>" |
889 | 893 | } |
890 | 894 | }, |
891 | 895 | "documentation": "<p>Gets Suite Definition Configuration.</p>" |
|
903 | 907 | }, |
904 | 908 | "defaultDevices": { |
905 | 909 | "shape": "DeviceUnderTestList", |
906 | | - "documentation": "<p>Specifies the devices under test for the test suite.</p>" |
| 910 | + "documentation": "<p>Specifies the devices that are under test for the test suite.</p>" |
907 | 911 | }, |
908 | 912 | "intendedForQualification": { |
909 | 913 | "shape": "IntendedForQualificationBoolean", |
|
944 | 948 | "documentation": "<p>Gets test case list.</p>" |
945 | 949 | }, |
946 | 950 | "parallelRun": { |
947 | | - "shape": "ParallelRun" |
| 951 | + "shape": "ParallelRun", |
| 952 | + "documentation": "<p>TRUE if multiple test suites run in parallel.</p>" |
948 | 953 | } |
949 | 954 | }, |
950 | 955 | "documentation": "<p>Gets suite run configuration.</p>" |
|
1070 | 1075 | "members": { |
1071 | 1076 | "testCaseRunId": { |
1072 | 1077 | "shape": "UUID", |
1073 | | - "documentation": "<p>Provides test case run ID.</p>" |
| 1078 | + "documentation": "<p>Provides the test case run ID.</p>" |
1074 | 1079 | }, |
1075 | 1080 | "testCaseDefinitionId": { |
1076 | 1081 | "shape": "UUID", |
1077 | | - "documentation": "<p>Provides test case run definition ID.</p>" |
| 1082 | + "documentation": "<p>Provides the test case run definition ID.</p>" |
1078 | 1083 | }, |
1079 | 1084 | "testCaseDefinitionName": { |
1080 | 1085 | "shape": "TestCaseDefinitionName", |
1081 | | - "documentation": "<p>Provides test case run definition Name.</p>" |
| 1086 | + "documentation": "<p>Provides the test case run definition name.</p>" |
1082 | 1087 | }, |
1083 | 1088 | "status": { |
1084 | 1089 | "shape": "Status", |
1085 | | - "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>" |
| 1090 | + "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>" |
1086 | 1091 | }, |
1087 | 1092 | "startTime": { |
1088 | 1093 | "shape": "Timestamp", |
|
1094 | 1099 | }, |
1095 | 1100 | "logUrl": { |
1096 | 1101 | "shape": "LogUrl", |
1097 | | - "documentation": "<p>Provides test case run log Url.</p>" |
| 1102 | + "documentation": "<p>Provides test case run log URL.</p>" |
1098 | 1103 | }, |
1099 | 1104 | "warnings": { |
1100 | 1105 | "shape": "Warnings", |
|
1105 | 1110 | "documentation": "<p>Provides test case run failure result.</p>" |
1106 | 1111 | } |
1107 | 1112 | }, |
1108 | | - "documentation": "<p>Provides test case run.</p>" |
| 1113 | + "documentation": "<p>Provides the test case run.</p>" |
1109 | 1114 | }, |
1110 | 1115 | "TestCaseRuns": { |
1111 | 1116 | "type": "list", |
|
0 commit comments