123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498 |
- {
- "metadata": {
- "apiVersion": "2018-05-14",
- "endpointPrefix": "devices.iot1click",
- "signingName": "iot1click",
- "serviceFullName": "AWS IoT 1-Click Devices Service",
- "serviceId": "IoT 1Click Devices Service",
- "protocol": "rest-json",
- "jsonVersion": "1.1",
- "uid": "devices-2018-05-14",
- "signatureVersion": "v4"
- },
- "operations": {
- "ClaimDevicesByClaimCode": {
- "http": {
- "method": "PUT",
- "requestUri": "/claims/{claimCode}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "ClaimCode": {
- "location": "uri",
- "locationName": "claimCode"
- }
- },
- "required": [
- "ClaimCode"
- ]
- },
- "output": {
- "type": "structure",
- "members": {
- "ClaimCode": {
- "locationName": "claimCode"
- },
- "Total": {
- "locationName": "total",
- "type": "integer"
- }
- }
- }
- },
- "DescribeDevice": {
- "http": {
- "method": "GET",
- "requestUri": "/devices/{deviceId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "DeviceId": {
- "location": "uri",
- "locationName": "deviceId"
- }
- },
- "required": [
- "DeviceId"
- ]
- },
- "output": {
- "type": "structure",
- "members": {
- "DeviceDescription": {
- "shape": "S8",
- "locationName": "deviceDescription"
- }
- }
- }
- },
- "FinalizeDeviceClaim": {
- "http": {
- "method": "PUT",
- "requestUri": "/devices/{deviceId}/finalize-claim",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "DeviceId": {
- "location": "uri",
- "locationName": "deviceId"
- },
- "Tags": {
- "shape": "Sc",
- "locationName": "tags"
- }
- },
- "required": [
- "DeviceId"
- ]
- },
- "output": {
- "type": "structure",
- "members": {
- "State": {
- "locationName": "state"
- }
- }
- }
- },
- "GetDeviceMethods": {
- "http": {
- "method": "GET",
- "requestUri": "/devices/{deviceId}/methods",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "DeviceId": {
- "location": "uri",
- "locationName": "deviceId"
- }
- },
- "required": [
- "DeviceId"
- ]
- },
- "output": {
- "type": "structure",
- "members": {
- "DeviceMethods": {
- "locationName": "deviceMethods",
- "type": "list",
- "member": {
- "shape": "Si"
- }
- }
- }
- }
- },
- "InitiateDeviceClaim": {
- "http": {
- "method": "PUT",
- "requestUri": "/devices/{deviceId}/initiate-claim",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "DeviceId": {
- "location": "uri",
- "locationName": "deviceId"
- }
- },
- "required": [
- "DeviceId"
- ]
- },
- "output": {
- "type": "structure",
- "members": {
- "State": {
- "locationName": "state"
- }
- }
- }
- },
- "InvokeDeviceMethod": {
- "http": {
- "requestUri": "/devices/{deviceId}/methods",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "DeviceId": {
- "location": "uri",
- "locationName": "deviceId"
- },
- "DeviceMethod": {
- "shape": "Si",
- "locationName": "deviceMethod"
- },
- "DeviceMethodParameters": {
- "locationName": "deviceMethodParameters"
- }
- },
- "required": [
- "DeviceId"
- ]
- },
- "output": {
- "type": "structure",
- "members": {
- "DeviceMethodResponse": {
- "locationName": "deviceMethodResponse"
- }
- }
- }
- },
- "ListDeviceEvents": {
- "http": {
- "method": "GET",
- "requestUri": "/devices/{deviceId}/events",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "DeviceId": {
- "location": "uri",
- "locationName": "deviceId"
- },
- "FromTimeStamp": {
- "shape": "So",
- "location": "querystring",
- "locationName": "fromTimeStamp"
- },
- "MaxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "NextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "ToTimeStamp": {
- "shape": "So",
- "location": "querystring",
- "locationName": "toTimeStamp"
- }
- },
- "required": [
- "DeviceId",
- "FromTimeStamp",
- "ToTimeStamp"
- ]
- },
- "output": {
- "type": "structure",
- "members": {
- "Events": {
- "locationName": "events",
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "Device": {
- "locationName": "device",
- "type": "structure",
- "members": {
- "Attributes": {
- "locationName": "attributes",
- "type": "structure",
- "members": {}
- },
- "DeviceId": {
- "locationName": "deviceId"
- },
- "Type": {
- "locationName": "type"
- }
- }
- },
- "StdEvent": {
- "locationName": "stdEvent"
- }
- }
- }
- },
- "NextToken": {
- "locationName": "nextToken"
- }
- }
- }
- },
- "ListDevices": {
- "http": {
- "method": "GET",
- "requestUri": "/devices",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "DeviceType": {
- "location": "querystring",
- "locationName": "deviceType"
- },
- "MaxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "NextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "Devices": {
- "locationName": "devices",
- "type": "list",
- "member": {
- "shape": "S8"
- }
- },
- "NextToken": {
- "locationName": "nextToken"
- }
- }
- }
- },
- "ListTagsForResource": {
- "http": {
- "method": "GET",
- "requestUri": "/tags/{resource-arn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "ResourceArn": {
- "location": "uri",
- "locationName": "resource-arn"
- }
- },
- "required": [
- "ResourceArn"
- ]
- },
- "output": {
- "type": "structure",
- "members": {
- "Tags": {
- "shape": "Sc",
- "locationName": "tags"
- }
- }
- }
- },
- "TagResource": {
- "http": {
- "requestUri": "/tags/{resource-arn}",
- "responseCode": 204
- },
- "input": {
- "type": "structure",
- "members": {
- "ResourceArn": {
- "location": "uri",
- "locationName": "resource-arn"
- },
- "Tags": {
- "shape": "Sc",
- "locationName": "tags"
- }
- },
- "required": [
- "ResourceArn",
- "Tags"
- ]
- }
- },
- "UnclaimDevice": {
- "http": {
- "method": "PUT",
- "requestUri": "/devices/{deviceId}/unclaim",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "DeviceId": {
- "location": "uri",
- "locationName": "deviceId"
- }
- },
- "required": [
- "DeviceId"
- ]
- },
- "output": {
- "type": "structure",
- "members": {
- "State": {
- "locationName": "state"
- }
- }
- }
- },
- "UntagResource": {
- "http": {
- "method": "DELETE",
- "requestUri": "/tags/{resource-arn}",
- "responseCode": 204
- },
- "input": {
- "type": "structure",
- "members": {
- "ResourceArn": {
- "location": "uri",
- "locationName": "resource-arn"
- },
- "TagKeys": {
- "location": "querystring",
- "locationName": "tagKeys",
- "type": "list",
- "member": {}
- }
- },
- "required": [
- "TagKeys",
- "ResourceArn"
- ]
- }
- },
- "UpdateDeviceState": {
- "http": {
- "method": "PUT",
- "requestUri": "/devices/{deviceId}/state",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "DeviceId": {
- "location": "uri",
- "locationName": "deviceId"
- },
- "Enabled": {
- "locationName": "enabled",
- "type": "boolean"
- }
- },
- "required": [
- "DeviceId"
- ]
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- }
- },
- "shapes": {
- "S8": {
- "type": "structure",
- "members": {
- "Arn": {
- "locationName": "arn"
- },
- "Attributes": {
- "locationName": "attributes",
- "type": "map",
- "key": {},
- "value": {}
- },
- "DeviceId": {
- "locationName": "deviceId"
- },
- "Enabled": {
- "locationName": "enabled",
- "type": "boolean"
- },
- "RemainingLife": {
- "locationName": "remainingLife",
- "type": "double"
- },
- "Type": {
- "locationName": "type"
- },
- "Tags": {
- "shape": "Sc",
- "locationName": "tags"
- }
- }
- },
- "Sc": {
- "type": "map",
- "key": {},
- "value": {}
- },
- "Si": {
- "type": "structure",
- "members": {
- "DeviceType": {
- "locationName": "deviceType"
- },
- "MethodName": {
- "locationName": "methodName"
- }
- }
- },
- "So": {
- "type": "timestamp",
- "timestampFormat": "iso8601"
- }
- }
- }
|