github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/iotdeviceadvisor/2020-09-18/api-2.json (about) 1 { 2 "version":"2.0", 3 "metadata":{ 4 "apiVersion":"2020-09-18", 5 "endpointPrefix":"api.iotdeviceadvisor", 6 "jsonVersion":"1.1", 7 "protocol":"rest-json", 8 "serviceAbbreviation":"AWSIoTDeviceAdvisor", 9 "serviceFullName":"AWS IoT Core Device Advisor", 10 "serviceId":"IotDeviceAdvisor", 11 "signatureVersion":"v4", 12 "signingName":"iotdeviceadvisor", 13 "uid":"iotdeviceadvisor-2020-09-18" 14 }, 15 "operations":{ 16 "CreateSuiteDefinition":{ 17 "name":"CreateSuiteDefinition", 18 "http":{ 19 "method":"POST", 20 "requestUri":"/suiteDefinitions" 21 }, 22 "input":{"shape":"CreateSuiteDefinitionRequest"}, 23 "output":{"shape":"CreateSuiteDefinitionResponse"}, 24 "errors":[ 25 {"shape":"ValidationException"}, 26 {"shape":"InternalServerException"} 27 ] 28 }, 29 "DeleteSuiteDefinition":{ 30 "name":"DeleteSuiteDefinition", 31 "http":{ 32 "method":"DELETE", 33 "requestUri":"/suiteDefinitions/{suiteDefinitionId}" 34 }, 35 "input":{"shape":"DeleteSuiteDefinitionRequest"}, 36 "output":{"shape":"DeleteSuiteDefinitionResponse"}, 37 "errors":[ 38 {"shape":"ValidationException"}, 39 {"shape":"InternalServerException"} 40 ] 41 }, 42 "GetSuiteDefinition":{ 43 "name":"GetSuiteDefinition", 44 "http":{ 45 "method":"GET", 46 "requestUri":"/suiteDefinitions/{suiteDefinitionId}" 47 }, 48 "input":{"shape":"GetSuiteDefinitionRequest"}, 49 "output":{"shape":"GetSuiteDefinitionResponse"}, 50 "errors":[ 51 {"shape":"ValidationException"}, 52 {"shape":"InternalServerException"}, 53 {"shape":"ResourceNotFoundException"} 54 ] 55 }, 56 "GetSuiteRun":{ 57 "name":"GetSuiteRun", 58 "http":{ 59 "method":"GET", 60 "requestUri":"/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}" 61 }, 62 "input":{"shape":"GetSuiteRunRequest"}, 63 "output":{"shape":"GetSuiteRunResponse"}, 64 "errors":[ 65 {"shape":"ValidationException"}, 66 {"shape":"InternalServerException"}, 67 {"shape":"ResourceNotFoundException"} 68 ] 69 }, 70 "GetSuiteRunReport":{ 71 "name":"GetSuiteRunReport", 72 "http":{ 73 "method":"GET", 74 "requestUri":"/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/report" 75 }, 76 "input":{"shape":"GetSuiteRunReportRequest"}, 77 "output":{"shape":"GetSuiteRunReportResponse"}, 78 "errors":[ 79 {"shape":"ValidationException"}, 80 {"shape":"InternalServerException"}, 81 {"shape":"ResourceNotFoundException"} 82 ] 83 }, 84 "ListSuiteDefinitions":{ 85 "name":"ListSuiteDefinitions", 86 "http":{ 87 "method":"GET", 88 "requestUri":"/suiteDefinitions" 89 }, 90 "input":{"shape":"ListSuiteDefinitionsRequest"}, 91 "output":{"shape":"ListSuiteDefinitionsResponse"}, 92 "errors":[ 93 {"shape":"ValidationException"}, 94 {"shape":"InternalServerException"} 95 ] 96 }, 97 "ListSuiteRuns":{ 98 "name":"ListSuiteRuns", 99 "http":{ 100 "method":"GET", 101 "requestUri":"/suiteRuns" 102 }, 103 "input":{"shape":"ListSuiteRunsRequest"}, 104 "output":{"shape":"ListSuiteRunsResponse"}, 105 "errors":[ 106 {"shape":"ValidationException"}, 107 {"shape":"InternalServerException"} 108 ] 109 }, 110 "ListTagsForResource":{ 111 "name":"ListTagsForResource", 112 "http":{ 113 "method":"GET", 114 "requestUri":"/tags/{resourceArn}" 115 }, 116 "input":{"shape":"ListTagsForResourceRequest"}, 117 "output":{"shape":"ListTagsForResourceResponse"}, 118 "errors":[ 119 {"shape":"InternalServerException"}, 120 {"shape":"ValidationException"}, 121 {"shape":"ResourceNotFoundException"} 122 ] 123 }, 124 "StartSuiteRun":{ 125 "name":"StartSuiteRun", 126 "http":{ 127 "method":"POST", 128 "requestUri":"/suiteDefinitions/{suiteDefinitionId}/suiteRuns" 129 }, 130 "input":{"shape":"StartSuiteRunRequest"}, 131 "output":{"shape":"StartSuiteRunResponse"}, 132 "errors":[ 133 {"shape":"ValidationException"}, 134 {"shape":"InternalServerException"}, 135 {"shape":"ConflictException"} 136 ] 137 }, 138 "StopSuiteRun":{ 139 "name":"StopSuiteRun", 140 "http":{ 141 "method":"POST", 142 "requestUri":"/suiteDefinitions/{suiteDefinitionId}/suiteRuns/{suiteRunId}/stop" 143 }, 144 "input":{"shape":"StopSuiteRunRequest"}, 145 "output":{"shape":"StopSuiteRunResponse"}, 146 "errors":[ 147 {"shape":"ValidationException"}, 148 {"shape":"ResourceNotFoundException"}, 149 {"shape":"InternalServerException"} 150 ] 151 }, 152 "TagResource":{ 153 "name":"TagResource", 154 "http":{ 155 "method":"POST", 156 "requestUri":"/tags/{resourceArn}" 157 }, 158 "input":{"shape":"TagResourceRequest"}, 159 "output":{"shape":"TagResourceResponse"}, 160 "errors":[ 161 {"shape":"InternalServerException"}, 162 {"shape":"ValidationException"}, 163 {"shape":"ResourceNotFoundException"} 164 ] 165 }, 166 "UntagResource":{ 167 "name":"UntagResource", 168 "http":{ 169 "method":"DELETE", 170 "requestUri":"/tags/{resourceArn}" 171 }, 172 "input":{"shape":"UntagResourceRequest"}, 173 "output":{"shape":"UntagResourceResponse"}, 174 "errors":[ 175 {"shape":"InternalServerException"}, 176 {"shape":"ValidationException"}, 177 {"shape":"ResourceNotFoundException"} 178 ] 179 }, 180 "UpdateSuiteDefinition":{ 181 "name":"UpdateSuiteDefinition", 182 "http":{ 183 "method":"PATCH", 184 "requestUri":"/suiteDefinitions/{suiteDefinitionId}" 185 }, 186 "input":{"shape":"UpdateSuiteDefinitionRequest"}, 187 "output":{"shape":"UpdateSuiteDefinitionResponse"}, 188 "errors":[ 189 {"shape":"ValidationException"}, 190 {"shape":"InternalServerException"} 191 ] 192 } 193 }, 194 "shapes":{ 195 "AmazonResourceName":{ 196 "type":"string", 197 "max":2048, 198 "min":20 199 }, 200 "ConflictException":{ 201 "type":"structure", 202 "members":{ 203 "message":{"shape":"Message"} 204 }, 205 "error":{"httpStatusCode":400}, 206 "exception":true 207 }, 208 "CreateSuiteDefinitionRequest":{ 209 "type":"structure", 210 "members":{ 211 "suiteDefinitionConfiguration":{"shape":"SuiteDefinitionConfiguration"}, 212 "tags":{"shape":"TagMap"} 213 } 214 }, 215 "CreateSuiteDefinitionResponse":{ 216 "type":"structure", 217 "members":{ 218 "suiteDefinitionId":{"shape":"UUID"}, 219 "suiteDefinitionArn":{"shape":"AmazonResourceName"}, 220 "suiteDefinitionName":{"shape":"SuiteDefinitionName"}, 221 "createdAt":{"shape":"Timestamp"} 222 } 223 }, 224 "DeleteSuiteDefinitionRequest":{ 225 "type":"structure", 226 "required":["suiteDefinitionId"], 227 "members":{ 228 "suiteDefinitionId":{ 229 "shape":"UUID", 230 "location":"uri", 231 "locationName":"suiteDefinitionId" 232 } 233 } 234 }, 235 "DeleteSuiteDefinitionResponse":{ 236 "type":"structure", 237 "members":{ 238 } 239 }, 240 "DeviceUnderTest":{ 241 "type":"structure", 242 "members":{ 243 "thingArn":{"shape":"AmazonResourceName"}, 244 "certificateArn":{"shape":"AmazonResourceName"} 245 } 246 }, 247 "DeviceUnderTestList":{ 248 "type":"list", 249 "member":{"shape":"DeviceUnderTest"}, 250 "max":2, 251 "min":0 252 }, 253 "ErrorReason":{"type":"string"}, 254 "Failure":{"type":"string"}, 255 "GetSuiteDefinitionRequest":{ 256 "type":"structure", 257 "required":["suiteDefinitionId"], 258 "members":{ 259 "suiteDefinitionId":{ 260 "shape":"UUID", 261 "location":"uri", 262 "locationName":"suiteDefinitionId" 263 }, 264 "suiteDefinitionVersion":{ 265 "shape":"SuiteDefinitionVersion", 266 "location":"querystring", 267 "locationName":"suiteDefinitionVersion" 268 } 269 } 270 }, 271 "GetSuiteDefinitionResponse":{ 272 "type":"structure", 273 "members":{ 274 "suiteDefinitionId":{"shape":"UUID"}, 275 "suiteDefinitionArn":{"shape":"AmazonResourceName"}, 276 "suiteDefinitionVersion":{"shape":"SuiteDefinitionVersion"}, 277 "latestVersion":{"shape":"SuiteDefinitionVersion"}, 278 "suiteDefinitionConfiguration":{"shape":"SuiteDefinitionConfiguration"}, 279 "createdAt":{"shape":"Timestamp"}, 280 "lastModifiedAt":{"shape":"Timestamp"}, 281 "tags":{"shape":"TagMap"} 282 } 283 }, 284 "GetSuiteRunReportRequest":{ 285 "type":"structure", 286 "required":[ 287 "suiteDefinitionId", 288 "suiteRunId" 289 ], 290 "members":{ 291 "suiteDefinitionId":{ 292 "shape":"UUID", 293 "location":"uri", 294 "locationName":"suiteDefinitionId" 295 }, 296 "suiteRunId":{ 297 "shape":"UUID", 298 "location":"uri", 299 "locationName":"suiteRunId" 300 } 301 } 302 }, 303 "GetSuiteRunReportResponse":{ 304 "type":"structure", 305 "members":{ 306 "qualificationReportDownloadUrl":{"shape":"QualificationReportDownloadUrl"} 307 } 308 }, 309 "GetSuiteRunRequest":{ 310 "type":"structure", 311 "required":[ 312 "suiteDefinitionId", 313 "suiteRunId" 314 ], 315 "members":{ 316 "suiteDefinitionId":{ 317 "shape":"UUID", 318 "location":"uri", 319 "locationName":"suiteDefinitionId" 320 }, 321 "suiteRunId":{ 322 "shape":"UUID", 323 "location":"uri", 324 "locationName":"suiteRunId" 325 } 326 } 327 }, 328 "GetSuiteRunResponse":{ 329 "type":"structure", 330 "members":{ 331 "suiteDefinitionId":{"shape":"UUID"}, 332 "suiteDefinitionVersion":{"shape":"SuiteDefinitionVersion"}, 333 "suiteRunId":{"shape":"UUID"}, 334 "suiteRunArn":{"shape":"AmazonResourceName"}, 335 "suiteRunConfiguration":{"shape":"SuiteRunConfiguration"}, 336 "testResult":{"shape":"TestResult"}, 337 "startTime":{"shape":"Timestamp"}, 338 "endTime":{"shape":"Timestamp"}, 339 "status":{"shape":"SuiteRunStatus"}, 340 "errorReason":{"shape":"ErrorReason"}, 341 "tags":{"shape":"TagMap"} 342 } 343 }, 344 "GroupName":{"type":"string"}, 345 "GroupResult":{ 346 "type":"structure", 347 "members":{ 348 "groupId":{"shape":"UUID"}, 349 "groupName":{"shape":"GroupName"}, 350 "tests":{"shape":"TestCaseRuns"} 351 } 352 }, 353 "GroupResultList":{ 354 "type":"list", 355 "member":{"shape":"GroupResult"} 356 }, 357 "IntendedForQualificationBoolean":{"type":"boolean"}, 358 "InternalServerException":{ 359 "type":"structure", 360 "members":{ 361 "message":{"shape":"Message"} 362 }, 363 "error":{"httpStatusCode":500}, 364 "exception":true, 365 "fault":true 366 }, 367 "ListSuiteDefinitionsRequest":{ 368 "type":"structure", 369 "members":{ 370 "maxResults":{ 371 "shape":"MaxResults", 372 "location":"querystring", 373 "locationName":"maxResults" 374 }, 375 "nextToken":{ 376 "shape":"Token", 377 "location":"querystring", 378 "locationName":"nextToken" 379 } 380 } 381 }, 382 "ListSuiteDefinitionsResponse":{ 383 "type":"structure", 384 "members":{ 385 "suiteDefinitionInformationList":{"shape":"SuiteDefinitionInformationList"}, 386 "nextToken":{"shape":"Token"} 387 } 388 }, 389 "ListSuiteRunsRequest":{ 390 "type":"structure", 391 "members":{ 392 "suiteDefinitionId":{ 393 "shape":"UUID", 394 "location":"querystring", 395 "locationName":"suiteDefinitionId" 396 }, 397 "suiteDefinitionVersion":{ 398 "shape":"SuiteDefinitionVersion", 399 "location":"querystring", 400 "locationName":"suiteDefinitionVersion" 401 }, 402 "maxResults":{ 403 "shape":"MaxResults", 404 "location":"querystring", 405 "locationName":"maxResults" 406 }, 407 "nextToken":{ 408 "shape":"Token", 409 "location":"querystring", 410 "locationName":"nextToken" 411 } 412 } 413 }, 414 "ListSuiteRunsResponse":{ 415 "type":"structure", 416 "members":{ 417 "suiteRunsList":{"shape":"SuiteRunsList"}, 418 "nextToken":{"shape":"Token"} 419 } 420 }, 421 "ListTagsForResourceRequest":{ 422 "type":"structure", 423 "required":["resourceArn"], 424 "members":{ 425 "resourceArn":{ 426 "shape":"AmazonResourceName", 427 "location":"uri", 428 "locationName":"resourceArn" 429 } 430 } 431 }, 432 "ListTagsForResourceResponse":{ 433 "type":"structure", 434 "members":{ 435 "tags":{"shape":"TagMap"} 436 } 437 }, 438 "LogUrl":{"type":"string"}, 439 "MaxResults":{ 440 "type":"integer", 441 "max":50, 442 "min":1 443 }, 444 "Message":{ 445 "type":"string", 446 "max":2048, 447 "min":1 448 }, 449 "QualificationReportDownloadUrl":{"type":"string"}, 450 "ResourceNotFoundException":{ 451 "type":"structure", 452 "members":{ 453 "message":{"shape":"Message"} 454 }, 455 "error":{"httpStatusCode":404}, 456 "exception":true 457 }, 458 "RootGroup":{ 459 "type":"string", 460 "max":2048, 461 "min":1 462 }, 463 "SelectedTestList":{ 464 "type":"list", 465 "member":{"shape":"UUID"}, 466 "max":100, 467 "min":0 468 }, 469 "StartSuiteRunRequest":{ 470 "type":"structure", 471 "required":["suiteDefinitionId"], 472 "members":{ 473 "suiteDefinitionId":{ 474 "shape":"UUID", 475 "location":"uri", 476 "locationName":"suiteDefinitionId" 477 }, 478 "suiteDefinitionVersion":{"shape":"SuiteDefinitionVersion"}, 479 "suiteRunConfiguration":{"shape":"SuiteRunConfiguration"}, 480 "tags":{"shape":"TagMap"} 481 } 482 }, 483 "StartSuiteRunResponse":{ 484 "type":"structure", 485 "members":{ 486 "suiteRunId":{"shape":"UUID"}, 487 "suiteRunArn":{"shape":"AmazonResourceName"}, 488 "createdAt":{"shape":"Timestamp"} 489 } 490 }, 491 "Status":{ 492 "type":"string", 493 "enum":[ 494 "PASS", 495 "FAIL", 496 "CANCELED", 497 "PENDING", 498 "RUNNING", 499 "STOPPING", 500 "STOPPED", 501 "PASS_WITH_WARNINGS", 502 "ERROR" 503 ] 504 }, 505 "StopSuiteRunRequest":{ 506 "type":"structure", 507 "required":[ 508 "suiteDefinitionId", 509 "suiteRunId" 510 ], 511 "members":{ 512 "suiteDefinitionId":{ 513 "shape":"UUID", 514 "location":"uri", 515 "locationName":"suiteDefinitionId" 516 }, 517 "suiteRunId":{ 518 "shape":"UUID", 519 "location":"uri", 520 "locationName":"suiteRunId" 521 } 522 } 523 }, 524 "StopSuiteRunResponse":{ 525 "type":"structure", 526 "members":{ 527 } 528 }, 529 "String128":{ 530 "type":"string", 531 "max":128, 532 "min":1 533 }, 534 "String256":{ 535 "type":"string", 536 "max":256, 537 "min":1 538 }, 539 "SuiteDefinitionConfiguration":{ 540 "type":"structure", 541 "members":{ 542 "suiteDefinitionName":{"shape":"SuiteDefinitionName"}, 543 "devices":{"shape":"DeviceUnderTestList"}, 544 "intendedForQualification":{"shape":"IntendedForQualificationBoolean"}, 545 "rootGroup":{"shape":"RootGroup"}, 546 "devicePermissionRoleArn":{"shape":"AmazonResourceName"} 547 } 548 }, 549 "SuiteDefinitionInformation":{ 550 "type":"structure", 551 "members":{ 552 "suiteDefinitionId":{"shape":"UUID"}, 553 "suiteDefinitionName":{"shape":"SuiteDefinitionName"}, 554 "defaultDevices":{"shape":"DeviceUnderTestList"}, 555 "intendedForQualification":{"shape":"IntendedForQualificationBoolean"}, 556 "createdAt":{"shape":"Timestamp"} 557 } 558 }, 559 "SuiteDefinitionInformationList":{ 560 "type":"list", 561 "member":{"shape":"SuiteDefinitionInformation"} 562 }, 563 "SuiteDefinitionName":{ 564 "type":"string", 565 "max":256, 566 "min":1 567 }, 568 "SuiteDefinitionVersion":{ 569 "type":"string", 570 "max":255, 571 "min":2 572 }, 573 "SuiteRunConfiguration":{ 574 "type":"structure", 575 "members":{ 576 "primaryDevice":{"shape":"DeviceUnderTest"}, 577 "selectedTestList":{"shape":"SelectedTestList"} 578 } 579 }, 580 "SuiteRunInformation":{ 581 "type":"structure", 582 "members":{ 583 "suiteDefinitionId":{"shape":"UUID"}, 584 "suiteDefinitionVersion":{"shape":"SuiteDefinitionVersion"}, 585 "suiteDefinitionName":{"shape":"SuiteDefinitionName"}, 586 "suiteRunId":{"shape":"UUID"}, 587 "createdAt":{"shape":"Timestamp"}, 588 "startedAt":{"shape":"Timestamp"}, 589 "endAt":{"shape":"Timestamp"}, 590 "status":{"shape":"SuiteRunStatus"}, 591 "passed":{"shape":"SuiteRunResultCount"}, 592 "failed":{"shape":"SuiteRunResultCount"} 593 } 594 }, 595 "SuiteRunResultCount":{ 596 "type":"integer", 597 "max":500, 598 "min":0 599 }, 600 "SuiteRunStatus":{ 601 "type":"string", 602 "enum":[ 603 "PASS", 604 "FAIL", 605 "CANCELED", 606 "PENDING", 607 "RUNNING", 608 "STOPPING", 609 "STOPPED", 610 "PASS_WITH_WARNINGS", 611 "ERROR" 612 ] 613 }, 614 "SuiteRunsList":{ 615 "type":"list", 616 "member":{"shape":"SuiteRunInformation"} 617 }, 618 "TagKeyList":{ 619 "type":"list", 620 "member":{"shape":"String128"}, 621 "max":50, 622 "min":0 623 }, 624 "TagMap":{ 625 "type":"map", 626 "key":{"shape":"String128"}, 627 "value":{"shape":"String256"}, 628 "max":50, 629 "min":0 630 }, 631 "TagResourceRequest":{ 632 "type":"structure", 633 "required":[ 634 "resourceArn", 635 "tags" 636 ], 637 "members":{ 638 "resourceArn":{ 639 "shape":"AmazonResourceName", 640 "location":"uri", 641 "locationName":"resourceArn" 642 }, 643 "tags":{"shape":"TagMap"} 644 } 645 }, 646 "TagResourceResponse":{ 647 "type":"structure", 648 "members":{ 649 } 650 }, 651 "TestCaseDefinitionName":{"type":"string"}, 652 "TestCaseRun":{ 653 "type":"structure", 654 "members":{ 655 "testCaseRunId":{"shape":"UUID"}, 656 "testCaseDefinitionId":{"shape":"UUID"}, 657 "testCaseDefinitionName":{"shape":"TestCaseDefinitionName"}, 658 "status":{"shape":"Status"}, 659 "startTime":{"shape":"Timestamp"}, 660 "endTime":{"shape":"Timestamp"}, 661 "logUrl":{"shape":"LogUrl"}, 662 "warnings":{"shape":"Warnings"}, 663 "failure":{"shape":"Failure"} 664 } 665 }, 666 "TestCaseRuns":{ 667 "type":"list", 668 "member":{"shape":"TestCaseRun"} 669 }, 670 "TestResult":{ 671 "type":"structure", 672 "members":{ 673 "groups":{"shape":"GroupResultList"} 674 } 675 }, 676 "Timestamp":{"type":"timestamp"}, 677 "Token":{ 678 "type":"string", 679 "max":2000 680 }, 681 "UUID":{ 682 "type":"string", 683 "max":36, 684 "min":12 685 }, 686 "UntagResourceRequest":{ 687 "type":"structure", 688 "required":[ 689 "resourceArn", 690 "tagKeys" 691 ], 692 "members":{ 693 "resourceArn":{ 694 "shape":"AmazonResourceName", 695 "location":"uri", 696 "locationName":"resourceArn" 697 }, 698 "tagKeys":{ 699 "shape":"TagKeyList", 700 "location":"querystring", 701 "locationName":"tagKeys" 702 } 703 } 704 }, 705 "UntagResourceResponse":{ 706 "type":"structure", 707 "members":{ 708 } 709 }, 710 "UpdateSuiteDefinitionRequest":{ 711 "type":"structure", 712 "required":["suiteDefinitionId"], 713 "members":{ 714 "suiteDefinitionId":{ 715 "shape":"UUID", 716 "location":"uri", 717 "locationName":"suiteDefinitionId" 718 }, 719 "suiteDefinitionConfiguration":{"shape":"SuiteDefinitionConfiguration"} 720 } 721 }, 722 "UpdateSuiteDefinitionResponse":{ 723 "type":"structure", 724 "members":{ 725 "suiteDefinitionId":{"shape":"UUID"}, 726 "suiteDefinitionArn":{"shape":"AmazonResourceName"}, 727 "suiteDefinitionName":{"shape":"SuiteDefinitionName"}, 728 "suiteDefinitionVersion":{"shape":"SuiteDefinitionVersion"}, 729 "createdAt":{"shape":"Timestamp"}, 730 "lastUpdatedAt":{"shape":"Timestamp"} 731 } 732 }, 733 "ValidationException":{ 734 "type":"structure", 735 "members":{ 736 "message":{"shape":"Message"} 737 }, 738 "error":{"httpStatusCode":400}, 739 "exception":true 740 }, 741 "Warnings":{"type":"string"} 742 } 743 }