github.com/aavshr/aws-sdk-go@v1.41.3/models/apis/iot1click-devices/2018-05-14/api-2.json (about) 1 { 2 "metadata" : { 3 "apiVersion" : "2018-05-14", 4 "endpointPrefix" : "devices.iot1click", 5 "signingName" : "iot1click", 6 "serviceFullName" : "AWS IoT 1-Click Devices Service", 7 "serviceId" : "IoT 1Click Devices Service", 8 "protocol" : "rest-json", 9 "jsonVersion" : "1.1", 10 "uid" : "devices-2018-05-14", 11 "signatureVersion" : "v4" 12 }, 13 "operations" : { 14 "ClaimDevicesByClaimCode" : { 15 "name" : "ClaimDevicesByClaimCode", 16 "http" : { 17 "method" : "PUT", 18 "requestUri" : "/claims/{claimCode}", 19 "responseCode" : 200 20 }, 21 "input" : { 22 "shape" : "ClaimDevicesByClaimCodeRequest" 23 }, 24 "output" : { 25 "shape" : "ClaimDevicesByClaimCodeResponse" 26 }, 27 "errors" : [ { 28 "shape" : "InvalidRequestException" 29 }, { 30 "shape" : "InternalFailureException" 31 }, { 32 "shape" : "ForbiddenException" 33 } ] 34 }, 35 "DescribeDevice" : { 36 "name" : "DescribeDevice", 37 "http" : { 38 "method" : "GET", 39 "requestUri" : "/devices/{deviceId}", 40 "responseCode" : 200 41 }, 42 "input" : { 43 "shape" : "DescribeDeviceRequest" 44 }, 45 "output" : { 46 "shape" : "DescribeDeviceResponse" 47 }, 48 "errors" : [ { 49 "shape" : "ResourceNotFoundException" 50 }, { 51 "shape" : "InvalidRequestException" 52 }, { 53 "shape" : "InternalFailureException" 54 } ] 55 }, 56 "FinalizeDeviceClaim" : { 57 "name" : "FinalizeDeviceClaim", 58 "http" : { 59 "method" : "PUT", 60 "requestUri" : "/devices/{deviceId}/finalize-claim", 61 "responseCode" : 200 62 }, 63 "input" : { 64 "shape" : "FinalizeDeviceClaimRequest" 65 }, 66 "output" : { 67 "shape" : "FinalizeDeviceClaimResponse" 68 }, 69 "errors" : [ { 70 "shape" : "ResourceNotFoundException" 71 }, { 72 "shape" : "InvalidRequestException" 73 }, { 74 "shape" : "InternalFailureException" 75 }, { 76 "shape" : "PreconditionFailedException" 77 }, { 78 "shape" : "ResourceConflictException" 79 } ] 80 }, 81 "GetDeviceMethods" : { 82 "name" : "GetDeviceMethods", 83 "http" : { 84 "method" : "GET", 85 "requestUri" : "/devices/{deviceId}/methods", 86 "responseCode" : 200 87 }, 88 "input" : { 89 "shape" : "GetDeviceMethodsRequest" 90 }, 91 "output" : { 92 "shape" : "GetDeviceMethodsResponse" 93 }, 94 "errors" : [ { 95 "shape" : "ResourceNotFoundException" 96 }, { 97 "shape" : "InvalidRequestException" 98 }, { 99 "shape" : "InternalFailureException" 100 } ] 101 }, 102 "InitiateDeviceClaim" : { 103 "name" : "InitiateDeviceClaim", 104 "http" : { 105 "method" : "PUT", 106 "requestUri" : "/devices/{deviceId}/initiate-claim", 107 "responseCode" : 200 108 }, 109 "input" : { 110 "shape" : "InitiateDeviceClaimRequest" 111 }, 112 "output" : { 113 "shape" : "InitiateDeviceClaimResponse" 114 }, 115 "errors" : [ { 116 "shape" : "ResourceNotFoundException" 117 }, { 118 "shape" : "InvalidRequestException" 119 }, { 120 "shape" : "InternalFailureException" 121 }, { 122 "shape" : "ResourceConflictException" 123 } ] 124 }, 125 "InvokeDeviceMethod" : { 126 "name" : "InvokeDeviceMethod", 127 "http" : { 128 "method" : "POST", 129 "requestUri" : "/devices/{deviceId}/methods", 130 "responseCode" : 200 131 }, 132 "input" : { 133 "shape" : "InvokeDeviceMethodRequest" 134 }, 135 "output" : { 136 "shape" : "InvokeDeviceMethodResponse" 137 }, 138 "errors" : [ { 139 "shape" : "InvalidRequestException" 140 }, { 141 "shape" : "PreconditionFailedException" 142 }, { 143 "shape" : "InternalFailureException" 144 }, { 145 "shape" : "ResourceNotFoundException" 146 }, { 147 "shape" : "RangeNotSatisfiableException" 148 }, { 149 "shape" : "ResourceConflictException" 150 } ] 151 }, 152 "ListDeviceEvents" : { 153 "name" : "ListDeviceEvents", 154 "http" : { 155 "method" : "GET", 156 "requestUri" : "/devices/{deviceId}/events", 157 "responseCode" : 200 158 }, 159 "input" : { 160 "shape" : "ListDeviceEventsRequest" 161 }, 162 "output" : { 163 "shape" : "ListDeviceEventsResponse" 164 }, 165 "errors" : [ { 166 "shape" : "ResourceNotFoundException" 167 }, { 168 "shape" : "RangeNotSatisfiableException" 169 }, { 170 "shape" : "InvalidRequestException" 171 }, { 172 "shape" : "InternalFailureException" 173 } ] 174 }, 175 "ListDevices" : { 176 "name" : "ListDevices", 177 "http" : { 178 "method" : "GET", 179 "requestUri" : "/devices", 180 "responseCode" : 200 181 }, 182 "input" : { 183 "shape" : "ListDevicesRequest" 184 }, 185 "output" : { 186 "shape" : "ListDevicesResponse" 187 }, 188 "errors" : [ { 189 "shape" : "RangeNotSatisfiableException" 190 }, { 191 "shape" : "InvalidRequestException" 192 }, { 193 "shape" : "InternalFailureException" 194 } ] 195 }, 196 "ListTagsForResource" : { 197 "name" : "ListTagsForResource", 198 "http" : { 199 "method" : "GET", 200 "requestUri" : "/tags/{resource-arn}", 201 "responseCode" : 200 202 }, 203 "input" : { 204 "shape" : "ListTagsForResourceRequest" 205 }, 206 "output" : { 207 "shape" : "ListTagsForResourceResponse" 208 }, 209 "errors" : [ { 210 "shape" : "ResourceNotFoundException" 211 }, { 212 "shape" : "InternalFailureException" 213 } ] 214 }, 215 "TagResource" : { 216 "name" : "TagResource", 217 "http" : { 218 "method" : "POST", 219 "requestUri" : "/tags/{resource-arn}", 220 "responseCode" : 204 221 }, 222 "input" : { 223 "shape" : "TagResourceRequest" 224 }, 225 "errors" : [ { 226 "shape" : "ResourceNotFoundException" 227 }, { 228 "shape" : "InvalidRequestException" 229 }, { 230 "shape" : "InternalFailureException" 231 } ] 232 }, 233 "UnclaimDevice" : { 234 "name" : "UnclaimDevice", 235 "http" : { 236 "method" : "PUT", 237 "requestUri" : "/devices/{deviceId}/unclaim", 238 "responseCode" : 200 239 }, 240 "input" : { 241 "shape" : "UnclaimDeviceRequest" 242 }, 243 "output" : { 244 "shape" : "UnclaimDeviceResponse" 245 }, 246 "errors" : [ { 247 "shape" : "ResourceNotFoundException" 248 }, { 249 "shape" : "InvalidRequestException" 250 }, { 251 "shape" : "InternalFailureException" 252 } ] 253 }, 254 "UntagResource" : { 255 "name" : "UntagResource", 256 "http" : { 257 "method" : "DELETE", 258 "requestUri" : "/tags/{resource-arn}", 259 "responseCode" : 204 260 }, 261 "input" : { 262 "shape" : "UntagResourceRequest" 263 }, 264 "errors" : [ { 265 "shape" : "ResourceNotFoundException" 266 }, { 267 "shape" : "InvalidRequestException" 268 }, { 269 "shape" : "InternalFailureException" 270 } ] 271 }, 272 "UpdateDeviceState" : { 273 "name" : "UpdateDeviceState", 274 "http" : { 275 "method" : "PUT", 276 "requestUri" : "/devices/{deviceId}/state", 277 "responseCode" : 200 278 }, 279 "input" : { 280 "shape" : "UpdateDeviceStateRequest" 281 }, 282 "output" : { 283 "shape" : "UpdateDeviceStateResponse" 284 }, 285 "errors" : [ { 286 "shape" : "ResourceNotFoundException" 287 }, { 288 "shape" : "InvalidRequestException" 289 }, { 290 "shape" : "InternalFailureException" 291 } ] 292 } 293 }, 294 "shapes" : { 295 "Attributes" : { 296 "type" : "structure", 297 "members" : { } 298 }, 299 "ClaimDevicesByClaimCodeRequest" : { 300 "type" : "structure", 301 "members" : { 302 "ClaimCode" : { 303 "shape" : "__string", 304 "location" : "uri", 305 "locationName" : "claimCode" 306 } 307 }, 308 "required" : [ "ClaimCode" ] 309 }, 310 "ClaimDevicesByClaimCodeResponse" : { 311 "type" : "structure", 312 "members" : { 313 "ClaimCode" : { 314 "shape" : "__stringMin12Max40", 315 "locationName" : "claimCode" 316 }, 317 "Total" : { 318 "shape" : "__integer", 319 "locationName" : "total" 320 } 321 } 322 }, 323 "DescribeDeviceRequest" : { 324 "type" : "structure", 325 "members" : { 326 "DeviceId" : { 327 "shape" : "__string", 328 "location" : "uri", 329 "locationName" : "deviceId" 330 } 331 }, 332 "required" : [ "DeviceId" ] 333 }, 334 "DescribeDeviceResponse" : { 335 "type" : "structure", 336 "members" : { 337 "DeviceDescription" : { 338 "shape" : "DeviceDescription", 339 "locationName" : "deviceDescription" 340 } 341 } 342 }, 343 "Device" : { 344 "type" : "structure", 345 "members" : { 346 "Attributes" : { 347 "shape" : "Attributes", 348 "locationName" : "attributes" 349 }, 350 "DeviceId" : { 351 "shape" : "__string", 352 "locationName" : "deviceId" 353 }, 354 "Type" : { 355 "shape" : "__string", 356 "locationName" : "type" 357 } 358 } 359 }, 360 "DeviceAttributes" : { 361 "type" : "map", 362 "key" : { 363 "shape" : "__string" 364 }, 365 "value" : { 366 "shape" : "__string" 367 } 368 }, 369 "DeviceClaimResponse" : { 370 "type" : "structure", 371 "members" : { 372 "State" : { 373 "shape" : "__string", 374 "locationName" : "state" 375 } 376 } 377 }, 378 "DeviceDescription" : { 379 "type" : "structure", 380 "members" : { 381 "Arn" : { 382 "shape" : "__string", 383 "locationName" : "arn" 384 }, 385 "Attributes" : { 386 "shape" : "DeviceAttributes", 387 "locationName" : "attributes" 388 }, 389 "DeviceId" : { 390 "shape" : "__string", 391 "locationName" : "deviceId" 392 }, 393 "Enabled" : { 394 "shape" : "__boolean", 395 "locationName" : "enabled" 396 }, 397 "RemainingLife" : { 398 "shape" : "__doubleMin0Max100", 399 "locationName" : "remainingLife" 400 }, 401 "Type" : { 402 "shape" : "__string", 403 "locationName" : "type" 404 }, 405 "Tags" : { 406 "shape" : "__mapOf__string", 407 "locationName" : "tags" 408 } 409 } 410 }, 411 "DeviceEvent" : { 412 "type" : "structure", 413 "members" : { 414 "Device" : { 415 "shape" : "Device", 416 "locationName" : "device" 417 }, 418 "StdEvent" : { 419 "shape" : "__string", 420 "locationName" : "stdEvent" 421 } 422 } 423 }, 424 "DeviceEventsResponse" : { 425 "type" : "structure", 426 "members" : { 427 "Events" : { 428 "shape" : "__listOfDeviceEvent", 429 "locationName" : "events" 430 }, 431 "NextToken" : { 432 "shape" : "__string", 433 "locationName" : "nextToken" 434 } 435 } 436 }, 437 "DeviceMethod" : { 438 "type" : "structure", 439 "members" : { 440 "DeviceType" : { 441 "shape" : "__string", 442 "locationName" : "deviceType" 443 }, 444 "MethodName" : { 445 "shape" : "__string", 446 "locationName" : "methodName" 447 } 448 } 449 }, 450 "Empty" : { 451 "type" : "structure", 452 "members" : { } 453 }, 454 "FinalizeDeviceClaimRequest" : { 455 "type" : "structure", 456 "members" : { 457 "DeviceId" : { 458 "shape" : "__string", 459 "location" : "uri", 460 "locationName" : "deviceId" 461 }, 462 "Tags" : { 463 "shape" : "__mapOf__string", 464 "locationName" : "tags" 465 } 466 }, 467 "required" : [ "DeviceId" ] 468 }, 469 "FinalizeDeviceClaimResponse" : { 470 "type" : "structure", 471 "members" : { 472 "State" : { 473 "shape" : "__string", 474 "locationName" : "state" 475 } 476 } 477 }, 478 "ForbiddenException" : { 479 "type" : "structure", 480 "members" : { 481 "Code" : { 482 "shape" : "__string", 483 "locationName" : "code" 484 }, 485 "Message" : { 486 "shape" : "__string", 487 "locationName" : "message" 488 } 489 }, 490 "exception" : true, 491 "error" : { 492 "httpStatusCode" : 403 493 } 494 }, 495 "GetDeviceMethodsRequest" : { 496 "type" : "structure", 497 "members" : { 498 "DeviceId" : { 499 "shape" : "__string", 500 "location" : "uri", 501 "locationName" : "deviceId" 502 } 503 }, 504 "required" : [ "DeviceId" ] 505 }, 506 "GetDeviceMethodsResponse" : { 507 "type" : "structure", 508 "members" : { 509 "DeviceMethods" : { 510 "shape" : "__listOfDeviceMethod", 511 "locationName" : "deviceMethods" 512 } 513 } 514 }, 515 "InitiateDeviceClaimRequest" : { 516 "type" : "structure", 517 "members" : { 518 "DeviceId" : { 519 "shape" : "__string", 520 "location" : "uri", 521 "locationName" : "deviceId" 522 } 523 }, 524 "required" : [ "DeviceId" ] 525 }, 526 "InitiateDeviceClaimResponse" : { 527 "type" : "structure", 528 "members" : { 529 "State" : { 530 "shape" : "__string", 531 "locationName" : "state" 532 } 533 } 534 }, 535 "InternalFailureException" : { 536 "type" : "structure", 537 "members" : { 538 "Code" : { 539 "shape" : "__string", 540 "locationName" : "code" 541 }, 542 "Message" : { 543 "shape" : "__string", 544 "locationName" : "message" 545 } 546 }, 547 "exception" : true, 548 "error" : { 549 "httpStatusCode" : 500 550 } 551 }, 552 "InvalidRequestException" : { 553 "type" : "structure", 554 "members" : { 555 "Code" : { 556 "shape" : "__string", 557 "locationName" : "code" 558 }, 559 "Message" : { 560 "shape" : "__string", 561 "locationName" : "message" 562 } 563 }, 564 "exception" : true, 565 "error" : { 566 "httpStatusCode" : 400 567 } 568 }, 569 "InvokeDeviceMethodRequest" : { 570 "type" : "structure", 571 "members" : { 572 "DeviceId" : { 573 "shape" : "__string", 574 "location" : "uri", 575 "locationName" : "deviceId" 576 }, 577 "DeviceMethod" : { 578 "shape" : "DeviceMethod", 579 "locationName" : "deviceMethod" 580 }, 581 "DeviceMethodParameters" : { 582 "shape" : "__string", 583 "locationName" : "deviceMethodParameters" 584 } 585 }, 586 "required" : [ "DeviceId" ] 587 }, 588 "InvokeDeviceMethodResponse" : { 589 "type" : "structure", 590 "members" : { 591 "DeviceMethodResponse" : { 592 "shape" : "__string", 593 "locationName" : "deviceMethodResponse" 594 } 595 } 596 }, 597 "ListDeviceEventsRequest" : { 598 "type" : "structure", 599 "members" : { 600 "DeviceId" : { 601 "shape" : "__string", 602 "location" : "uri", 603 "locationName" : "deviceId" 604 }, 605 "FromTimeStamp" : { 606 "shape" : "__timestampIso8601", 607 "location" : "querystring", 608 "locationName" : "fromTimeStamp" 609 }, 610 "MaxResults" : { 611 "shape" : "MaxResults", 612 "location" : "querystring", 613 "locationName" : "maxResults" 614 }, 615 "NextToken" : { 616 "shape" : "__string", 617 "location" : "querystring", 618 "locationName" : "nextToken" 619 }, 620 "ToTimeStamp" : { 621 "shape" : "__timestampIso8601", 622 "location" : "querystring", 623 "locationName" : "toTimeStamp" 624 } 625 }, 626 "required" : [ "DeviceId", "FromTimeStamp", "ToTimeStamp" ] 627 }, 628 "ListDeviceEventsResponse" : { 629 "type" : "structure", 630 "members" : { 631 "Events" : { 632 "shape" : "__listOfDeviceEvent", 633 "locationName" : "events" 634 }, 635 "NextToken" : { 636 "shape" : "__string", 637 "locationName" : "nextToken" 638 } 639 } 640 }, 641 "ListDevicesRequest" : { 642 "type" : "structure", 643 "members" : { 644 "DeviceType" : { 645 "shape" : "__string", 646 "location" : "querystring", 647 "locationName" : "deviceType" 648 }, 649 "MaxResults" : { 650 "shape" : "MaxResults", 651 "location" : "querystring", 652 "locationName" : "maxResults" 653 }, 654 "NextToken" : { 655 "shape" : "__string", 656 "location" : "querystring", 657 "locationName" : "nextToken" 658 } 659 } 660 }, 661 "ListDevicesResponse" : { 662 "type" : "structure", 663 "members" : { 664 "Devices" : { 665 "shape" : "__listOfDeviceDescription", 666 "locationName" : "devices" 667 }, 668 "NextToken" : { 669 "shape" : "__string", 670 "locationName" : "nextToken" 671 } 672 } 673 }, 674 "ListTagsForResourceRequest" : { 675 "type" : "structure", 676 "members" : { 677 "ResourceArn" : { 678 "shape" : "__string", 679 "location" : "uri", 680 "locationName" : "resource-arn" 681 } 682 }, 683 "required" : [ "ResourceArn" ] 684 }, 685 "ListTagsForResourceResponse" : { 686 "type" : "structure", 687 "members" : { 688 "Tags" : { 689 "shape" : "__mapOf__string", 690 "locationName" : "tags" 691 } 692 } 693 }, 694 "MaxResults" : { 695 "type" : "integer", 696 "min" : 1, 697 "max" : 250 698 }, 699 "PreconditionFailedException" : { 700 "type" : "structure", 701 "members" : { 702 "Code" : { 703 "shape" : "__string", 704 "locationName" : "code" 705 }, 706 "Message" : { 707 "shape" : "__string", 708 "locationName" : "message" 709 } 710 }, 711 "exception" : true, 712 "error" : { 713 "httpStatusCode" : 412 714 } 715 }, 716 "RangeNotSatisfiableException" : { 717 "type" : "structure", 718 "members" : { 719 "Code" : { 720 "shape" : "__string", 721 "locationName" : "code" 722 }, 723 "Message" : { 724 "shape" : "__string", 725 "locationName" : "message" 726 } 727 }, 728 "exception" : true, 729 "error" : { 730 "httpStatusCode" : 416 731 } 732 }, 733 "ResourceConflictException" : { 734 "type" : "structure", 735 "members" : { 736 "Code" : { 737 "shape" : "__string", 738 "locationName" : "code" 739 }, 740 "Message" : { 741 "shape" : "__string", 742 "locationName" : "message" 743 } 744 }, 745 "exception" : true, 746 "error" : { 747 "httpStatusCode" : 409 748 } 749 }, 750 "ResourceNotFoundException" : { 751 "type" : "structure", 752 "members" : { 753 "Code" : { 754 "shape" : "__string", 755 "locationName" : "code" 756 }, 757 "Message" : { 758 "shape" : "__string", 759 "locationName" : "message" 760 } 761 }, 762 "exception" : true, 763 "error" : { 764 "httpStatusCode" : 404 765 } 766 }, 767 "TagResourceRequest" : { 768 "type" : "structure", 769 "members" : { 770 "ResourceArn" : { 771 "shape" : "__string", 772 "location" : "uri", 773 "locationName" : "resource-arn" 774 }, 775 "Tags" : { 776 "shape" : "__mapOf__string", 777 "locationName" : "tags" 778 } 779 }, 780 "required" : [ "ResourceArn", "Tags" ] 781 }, 782 "UnclaimDeviceRequest" : { 783 "type" : "structure", 784 "members" : { 785 "DeviceId" : { 786 "shape" : "__string", 787 "location" : "uri", 788 "locationName" : "deviceId" 789 } 790 }, 791 "required" : [ "DeviceId" ] 792 }, 793 "UnclaimDeviceResponse" : { 794 "type" : "structure", 795 "members" : { 796 "State" : { 797 "shape" : "__string", 798 "locationName" : "state" 799 } 800 } 801 }, 802 "UntagResourceRequest" : { 803 "type" : "structure", 804 "members" : { 805 "ResourceArn" : { 806 "shape" : "__string", 807 "location" : "uri", 808 "locationName" : "resource-arn" 809 }, 810 "TagKeys" : { 811 "shape" : "__listOf__string", 812 "location" : "querystring", 813 "locationName" : "tagKeys" 814 } 815 }, 816 "required" : [ "TagKeys", "ResourceArn" ] 817 }, 818 "UpdateDeviceStateRequest" : { 819 "type" : "structure", 820 "members" : { 821 "DeviceId" : { 822 "shape" : "__string", 823 "location" : "uri", 824 "locationName" : "deviceId" 825 }, 826 "Enabled" : { 827 "shape" : "__boolean", 828 "locationName" : "enabled" 829 } 830 }, 831 "required" : [ "DeviceId" ] 832 }, 833 "UpdateDeviceStateResponse" : { 834 "type" : "structure", 835 "members" : { } 836 }, 837 "__boolean" : { 838 "type" : "boolean" 839 }, 840 "__double" : { 841 "type" : "double" 842 }, 843 "__doubleMin0Max100" : { 844 "type" : "double" 845 }, 846 "__integer" : { 847 "type" : "integer" 848 }, 849 "__listOfDeviceDescription" : { 850 "type" : "list", 851 "member" : { 852 "shape" : "DeviceDescription" 853 } 854 }, 855 "__listOfDeviceEvent" : { 856 "type" : "list", 857 "member" : { 858 "shape" : "DeviceEvent" 859 } 860 }, 861 "__listOfDeviceMethod" : { 862 "type" : "list", 863 "member" : { 864 "shape" : "DeviceMethod" 865 } 866 }, 867 "__listOf__string" : { 868 "type" : "list", 869 "member" : { 870 "shape" : "__string" 871 } 872 }, 873 "__long" : { 874 "type" : "long" 875 }, 876 "__mapOf__string" : { 877 "type" : "map", 878 "key" : { 879 "shape" : "__string" 880 }, 881 "value" : { 882 "shape" : "__string" 883 } 884 }, 885 "__string" : { 886 "type" : "string" 887 }, 888 "__stringMin12Max40" : { 889 "type" : "string", 890 "min" : 12, 891 "max" : 40 892 }, 893 "__timestampIso8601" : { 894 "type" : "timestamp", 895 "timestampFormat" : "iso8601" 896 }, 897 "__timestampUnix" : { 898 "type" : "timestamp", 899 "timestampFormat" : "unixTimestamp" 900 } 901 } 902 }