![]() |
![]()
| ![]() |
![]()
NAMEPaws::IoT1ClickDevices - Perl Interface to AWS AWS IoT 1-Click Devices Service SYNOPSISuse Paws; my $obj = Paws->service('IoT1ClickDevices'); my $res = $obj->Method( Arg1 => $val1, Arg2 => [ 'V1', 'V2' ], # if Arg3 is an object, the HashRef will be used as arguments to the constructor # of the arguments type Arg3 => { Att1 => 'Val1' }, # if Arg4 is an array of objects, the HashRefs will be passed as arguments to # the constructor of the arguments type Arg4 => [ { Att1 => 'Val1' }, { Att1 => 'Val2' } ], ); DESCRIPTIONDescribes 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. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/devices.iot1click-2018-05-14> METHODSClaimDevicesByClaimCodeEach argument is described in detail in: Paws::IoT1ClickDevices::ClaimDevicesByClaimCode Returns: a Paws::IoT1ClickDevices::ClaimDevicesByClaimCodeResponse instance 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). DescribeDeviceEach argument is described in detail in: Paws::IoT1ClickDevices::DescribeDevice Returns: a Paws::IoT1ClickDevices::DescribeDeviceResponse instance Given a device ID, returns a DescribeDeviceResponse object describing the details of the device. FinalizeDeviceClaim
Each argument is described in detail in: Paws::IoT1ClickDevices::FinalizeDeviceClaim Returns: a Paws::IoT1ClickDevices::FinalizeDeviceClaimResponse instance 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. GetDeviceMethodsEach argument is described in detail in: Paws::IoT1ClickDevices::GetDeviceMethods Returns: a Paws::IoT1ClickDevices::GetDeviceMethodsResponse instance Given a device ID, returns the invokable methods associated with the device. InitiateDeviceClaimEach argument is described in detail in: Paws::IoT1ClickDevices::InitiateDeviceClaim Returns: a Paws::IoT1ClickDevices::InitiateDeviceClaimResponse instance 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. InvokeDeviceMethod
Each argument is described in detail in: Paws::IoT1ClickDevices::InvokeDeviceMethod Returns: a Paws::IoT1ClickDevices::InvokeDeviceMethodResponse instance Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below. ListDeviceEvents
Each argument is described in detail in: Paws::IoT1ClickDevices::ListDeviceEvents Returns: a Paws::IoT1ClickDevices::ListDeviceEventsResponse instance Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device. ListDevices
Each argument is described in detail in: Paws::IoT1ClickDevices::ListDevices Returns: a Paws::IoT1ClickDevices::ListDevicesResponse instance Lists the 1-Click compatible devices associated with your AWS account. ListTagsForResourceEach argument is described in detail in: Paws::IoT1ClickDevices::ListTagsForResource Returns: a Paws::IoT1ClickDevices::ListTagsForResourceResponse instance Lists the tags associated with the specified resource ARN. TagResourceEach argument is described in detail in: Paws::IoT1ClickDevices::TagResource Returns: nothing Adds or updates the tags associated with the resource ARN. See AWS IoT 1-Click Service Limits (https://docs.aws.amazon.com/iot-1-click/latest/developerguide/1click-appendix.html#1click-limits) for the maximum number of tags allowed per resource. UnclaimDeviceEach argument is described in detail in: Paws::IoT1ClickDevices::UnclaimDevice Returns: a Paws::IoT1ClickDevices::UnclaimDeviceResponse instance Disassociates a device from your AWS account using its device ID. UntagResourceEach argument is described in detail in: Paws::IoT1ClickDevices::UntagResource Returns: nothing Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN. UpdateDeviceState
Each argument is described in detail in: Paws::IoT1ClickDevices::UpdateDeviceState Returns: a Paws::IoT1ClickDevices::UpdateDeviceStateResponse instance Using a Boolean value (true or false), this operation enables or disables the device given a device ID. PAGINATORSPaginator methods are helpers that repetively call methods that return partial results ListAllDeviceEvents(sub { },DeviceId => Str, FromTimeStamp => Str, ToTimeStamp => Str, [MaxResults => Int, NextToken => Str])ListAllDeviceEvents(DeviceId => Str, FromTimeStamp => Str, ToTimeStamp => Str, [MaxResults => Int, NextToken => Str])If passed a sub as first parameter, it will call the sub for each element found in : - Events, passing the object as the first parameter, and the string 'Events' as the second parameter If not, it will return a a Paws::IoT1ClickDevices::ListDeviceEventsResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. ListAllDevices(sub { },[DeviceType => Str, MaxResults => Int, NextToken => Str])ListAllDevices([DeviceType => Str, MaxResults => Int, NextToken => Str])If passed a sub as first parameter, it will call the sub for each element found in : - Devices, passing the object as the first parameter, and the string 'Devices' as the second parameter If not, it will return a a Paws::IoT1ClickDevices::ListDevicesResponse instance with all the "param"s; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory. SEE ALSOThis service class forms part of Paws BUGS and CONTRIBUTIONSThe source code is located here: <https://github.com/pplu/aws-sdk-perl> Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>
|