Describes all of the AWS IoT 1-Click device-related API operations for the service. Also provides sample requests, responses, and errors for the supported web services protocols.
', 'operations' => [ 'ClaimDevicesByClaimCode' => 'Adds device(s) to your account (i.e., claim one or more devices) if and only if you received a claim code with the device(s).
', 'DescribeDevice' => 'Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
', 'FinalizeDeviceClaim' => 'Given a device ID, finalizes the claim request for the associated device.
Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.
Given a device ID, returns the invokable methods associated with the device.
', 'InitiateDeviceClaim' => 'Given a device ID, initiates a claim request for the associated device.
Claiming a device consists of initiating a claim, then publishing a device event, and finalizing the claim. For a device of type button, a device event can be published by simply clicking the device.
Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.
', 'ListDeviceEvents' => 'Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
', 'ListDevices' => 'Lists the 1-Click compatible devices associated with your AWS account.
', 'ListTagsForResource' => 'Lists the tags associated with the specified resource ARN.
', 'TagResource' => '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 resource.
', 'UnclaimDevice' => 'Disassociates a device from your AWS account using its device ID.
', 'UntagResource' => 'Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
', 'UpdateDeviceState' => 'Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
', ], 'shapes' => [ 'Attributes' => [ 'base' => NULL, 'refs' => [ 'Device$Attributes' => 'The user specified attributes associated with the device for an event.
', ], ], 'ClaimDevicesByClaimCodeResponse' => [ 'base' => NULL, 'refs' => [], ], 'DescribeDeviceResponse' => [ 'base' => NULL, 'refs' => [], ], 'Device' => [ 'base' => NULL, 'refs' => [ 'DeviceEvent$Device' => 'An object representing the device associated with the event.
', ], ], 'DeviceAttributes' => [ 'base' => 'DeviceAttributes is a string-to-string map specified by the user.
', 'refs' => [ 'DeviceDescription$Attributes' => 'An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.
', ], ], 'DeviceClaimResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeviceDescription' => [ 'base' => NULL, 'refs' => [ 'DescribeDeviceResponse$DeviceDescription' => 'Device details.
', '__listOfDeviceDescription$member' => NULL, ], ], 'DeviceEvent' => [ 'base' => NULL, 'refs' => [ '__listOfDeviceEvent$member' => NULL, ], ], 'DeviceEventsResponse' => [ 'base' => NULL, 'refs' => [], ], 'DeviceMethod' => [ 'base' => NULL, 'refs' => [ 'InvokeDeviceMethodRequest$DeviceMethod' => 'The device method to invoke.
', '__listOfDeviceMethod$member' => NULL, ], ], 'Empty' => [ 'base' => 'On success, an empty object is returned.
', 'refs' => [], ], 'ForbiddenException' => [ 'base' => NULL, 'refs' => [], ], 'GetDeviceMethodsResponse' => [ 'base' => NULL, 'refs' => [], ], 'InternalFailureException' => [ 'base' => NULL, 'refs' => [], ], 'InvalidRequestException' => [ 'base' => NULL, 'refs' => [], ], 'InvokeDeviceMethodRequest' => [ 'base' => NULL, 'refs' => [], ], 'InvokeDeviceMethodResponse' => [ 'base' => NULL, 'refs' => [], ], 'ListDevicesResponse' => [ 'base' => NULL, 'refs' => [], ], 'PreconditionFailedException' => [ 'base' => NULL, 'refs' => [], ], 'RangeNotSatisfiableException' => [ 'base' => NULL, 'refs' => [], ], 'ResourceConflictException' => [ 'base' => NULL, 'refs' => [], ], 'ResourceNotFoundException' => [ 'base' => NULL, 'refs' => [], ], 'UpdateDeviceStateRequest' => [ 'base' => NULL, 'refs' => [], ], '__boolean' => [ 'base' => NULL, 'refs' => [ 'DeviceDescription$Enabled' => 'A Boolean value indicating whether or not the device is enabled.
', 'UpdateDeviceStateRequest$Enabled' => 'If true, the device is enabled. If false, the device is disabled.
', ], ], '__doubleMin0Max100' => [ 'base' => NULL, 'refs' => [ 'DeviceDescription$RemainingLife' => 'A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.
', ], ], '__integer' => [ 'base' => NULL, 'refs' => [ 'ClaimDevicesByClaimCodeResponse$Total' => 'The total number of devices associated with the claim code that has been processed in the claim request.
', ], ], '__listOfDeviceDescription' => [ 'base' => NULL, 'refs' => [ 'ListDevicesResponse$Devices' => 'A list of devices.
', ], ], '__listOfDeviceEvent' => [ 'base' => NULL, 'refs' => [ 'DeviceEventsResponse$Events' => 'An array of zero or more elements describing the event(s) associated with the device.
', ], ], '__listOfDeviceMethod' => [ 'base' => NULL, 'refs' => [ 'GetDeviceMethodsResponse$DeviceMethods' => 'List of available device APIs.
', ], ], '__string' => [ 'base' => NULL, 'refs' => [ 'Device$DeviceId' => 'The unique identifier of the device.
', 'Device$Type' => 'The device type, such as "button".
', 'DeviceAttributes$member' => NULL, 'DeviceClaimResponse$State' => 'The device\'s final claim state.
', 'DeviceDescription$Arn' => 'The ARN of the device.
', 'DeviceDescription$DeviceId' => 'The unique identifier of the device.
', 'DeviceDescription$Type' => 'The type of the device, such as "button".
', 'DeviceEvent$StdEvent' => 'A serialized JSON object representing the device-type specific event.
', 'DeviceEventsResponse$NextToken' => 'The token to retrieve the next set of results.
', 'DeviceMethod$DeviceType' => 'The type of the device, such as "button".
', 'DeviceMethod$MethodName' => 'The name of the method applicable to the deviceType.
', 'ForbiddenException$Code' => '403
', 'ForbiddenException$Message' => 'The 403 error message returned by the web server.
', 'InternalFailureException$Code' => '500
', 'InternalFailureException$Message' => 'The 500 error message returned by the web server.
', 'InvalidRequestException$Code' => '400
', 'InvalidRequestException$Message' => 'The 400 error message returned by the web server.
', 'InvokeDeviceMethodRequest$DeviceMethodParameters' => 'A JSON encoded string containing the device method request parameters.
', 'InvokeDeviceMethodResponse$DeviceMethodResponse' => 'A JSON encoded string containing the device method response.
', 'ListDevicesResponse$NextToken' => 'The token to retrieve the next set of results.
', 'PreconditionFailedException$Code' => '412
', 'PreconditionFailedException$Message' => 'An error message explaining the error or its remedy.
', 'RangeNotSatisfiableException$Code' => '416
', 'RangeNotSatisfiableException$Message' => 'The requested number of results specified by nextToken cannot be satisfied.
', 'ResourceConflictException$Code' => '409
', 'ResourceConflictException$Message' => 'An error message explaining the error or its remedy.
', 'ResourceNotFoundException$Code' => '404
', 'ResourceNotFoundException$Message' => 'The requested device could not be found.
', ], ], '__stringMin12Max40' => [ 'base' => NULL, 'refs' => [ 'ClaimDevicesByClaimCodeResponse$ClaimCode' => 'The claim code provided by the device manufacturer.
', ], ], ],];