IoT1ClickDevicesService class
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.
Constructors
- IoT1ClickDevicesService({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
claimDevicesByClaimCode(
{required String claimCode}) → Future< ClaimDevicesByClaimCodeResponse> - 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).
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
describeDevice(
{required String deviceId}) → Future< DescribeDeviceResponse> - Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.
-
finalizeDeviceClaim(
{required String deviceId, Map< String, String> ? tags}) → Future<FinalizeDeviceClaimResponse> - Given a device ID, finalizes the claim request for the associated device.
-
getDeviceMethods(
{required String deviceId}) → Future< GetDeviceMethodsResponse> - Given a device ID, returns the invokable methods associated with the device.
-
initiateDeviceClaim(
{required String deviceId}) → Future< InitiateDeviceClaimResponse> - Given a device ID, initiates a claim request for the associated device.
-
invokeDeviceMethod(
{required String deviceId, DeviceMethod? deviceMethod, String? deviceMethodParameters}) → Future< InvokeDeviceMethodResponse> - Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.
-
listDeviceEvents(
{required String deviceId, required DateTime fromTimeStamp, required DateTime toTimeStamp, int? maxResults, String? nextToken}) → Future< ListDeviceEventsResponse> - Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.
-
listDevices(
{String? deviceType, int? maxResults, String? nextToken}) → Future< ListDevicesResponse> - Lists the 1-Click compatible devices associated with your AWS account.
-
listTagsForResource(
{required String resourceArn}) → Future< ListTagsForResourceResponse> - Lists the tags associated with the specified resource ARN.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
tagResource(
{required String resourceArn, required Map< String, String> tags}) → Future<void> - 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.
-
toString(
) → String -
A string representation of this object.
inherited
-
unclaimDevice(
{required String deviceId}) → Future< UnclaimDeviceResponse> - Disassociates a device from your AWS account using its device ID.
-
untagResource(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.
-
updateDeviceState(
{required String deviceId, bool? enabled}) → Future< void> - Using a Boolean value (true or false), this operation enables or disables the device given a device ID.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited