{"note":"OpenAPI conversion -- returning structured metadata","name":"amazonaws-com-iot1click-devices","description":"AWS IoT 1-Click Devices Service","version":"2018-05-14","base_url":"","endpoints":13,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api AWS IoT 1-Click Devices Service\n@version 2018-05-14\n@auth AWS SigV4\n@endpoints 13\n@toc claims(1), devices(9), tags(3)\n\n@group claims\n@endpoint PUT /claims/{claimCode}\n@desc Adds device(s) to your account (i.e., claim one or more devices) if and only if you\n received a claim code with the device(s).\n@required {ClaimCode: str}\n@returns(200) {ClaimCode: str?, Total: int?}\n\n@endgroup\n\n@group devices\n@endpoint GET /devices/{deviceId}\n@desc Given a device ID, returns a DescribeDeviceResponse object describing the\n details of the device.\n@required {DeviceId: str}\n@returns(200) {DeviceDescription: DeviceDescription?{Arn: str?, Attributes: map<str,str>?, DeviceId: str?, Enabled: bool?, RemainingLife: num(f64)?, Type: str?, Tags: map<str,str>?}}\n\n@endpoint PUT /devices/{deviceId}/finalize-claim\n@desc Given a device ID, finalizes the claim request for the associated device.\n Claiming a device consists of initiating a claim, then publishing a device event,\n and finalizing the claim. For a device of type button, a device event can\n be published by simply clicking the device.\n@required {DeviceId: str}\n@optional {Tags: map<str,str>}\n@returns(200) {State: str?}\n\n@endpoint GET /devices/{deviceId}/methods\n@desc Given a device ID, returns the invokable methods associated with the device.\n@required {DeviceId: str}\n@returns(200) {DeviceMethods: [DeviceMethod]?}\n\n@endpoint PUT /devices/{deviceId}/initiate-claim\n@desc Given a device ID, initiates a claim request for the associated device.\n Claiming a device consists of initiating a claim, then publishing a device event,\n and finalizing the claim. For a device of type button, a device event can\n be published by simply clicking the device.\n@required {DeviceId: str}\n@returns(200) {State: str?}\n\n@endpoint POST /devices/{deviceId}/methods\n@desc Given a device ID, issues a request to invoke a named device method (with possible\n parameters). See the \"Example POST\" code snippet below.\n@required {DeviceId: str}\n@optional {DeviceMethod: DeviceMethod, DeviceMethodParameters: str}\n@returns(200) {DeviceMethodResponse: str?}\n\n@endpoint GET /devices/{deviceId}/events\n@desc Using a device ID, returns a DeviceEventsResponse object containing an\n array of events for the device.\n@required {DeviceId: str, fromTimeStamp: str(timestamp), toTimeStamp: str(timestamp)}\n@optional {maxResults: int, nextToken: str}\n@returns(200) {Events: [DeviceEvent]?, NextToken: str?}\n\n@endpoint GET /devices\n@desc Lists the 1-Click compatible devices associated with your AWS account.\n@optional {deviceType: str, maxResults: int, nextToken: str}\n@returns(200) {Devices: [DeviceDescription]?, NextToken: str?}\n\n@endgroup\n\n@group tags\n@endpoint GET /tags/{resource-arn}\n@desc Lists the tags associated with the specified resource ARN.\n@required {ResourceArn: str}\n@returns(200) {Tags: map<str,str>?}\n\n@endpoint POST /tags/{resource-arn}\n@desc Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits for the maximum number of tags allowed per\n resource.\n@required {ResourceArn: str, Tags: map<str,str>}\n\n@endgroup\n\n@group devices\n@endpoint PUT /devices/{deviceId}/unclaim\n@desc Disassociates a device from your AWS account using its device ID.\n@required {DeviceId: str}\n@returns(200) {State: str?}\n\n@endgroup\n\n@group tags\n@endpoint DELETE /tags/{resource-arn}\n@desc Using tag keys, deletes the tags (key/value pairs) associated with the specified\n resource ARN.\n@required {ResourceArn: str, tagKeys: [str]}\n\n@endgroup\n\n@group devices\n@endpoint PUT /devices/{deviceId}/state\n@desc Using a Boolean value (true or false), this operation\n enables or disables the device given a device ID.\n@required {DeviceId: str}\n@optional {Enabled: bool}\n\n@endgroup\n\n@end\n"}