Note: You are viewing the documentation for an older major version of the AWS SDK for JavaScript (v2).

The modular AWS SDK for JavaScript (v3) is now General Available. For more information see the Developer Guide or API Reference.

Class: AWS.IoT1ClickDevicesService

Inherits:
AWS.Service show all
Identifier:
iot1clickdevicesservice
API Version:
2018-05-14
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

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.

Sending a Request Using IoT1ClickDevicesService

var iot1clickdevicesservice = new AWS.IoT1ClickDevicesService();
iot1clickdevicesservice.claimDevicesByClaimCode(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the IoT1ClickDevicesService object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var iot1clickdevicesservice = new AWS.IoT1ClickDevicesService({apiVersion: '2018-05-14'});

You can also set the API version globally in AWS.config.apiVersions using the iot1clickdevicesservice service identifier:

AWS.config.apiVersions = {
  iot1clickdevicesservice: '2018-05-14',
  // other service API versions
};

var iot1clickdevicesservice = new AWS.IoT1ClickDevicesService();

Version:

  • 2018-05-14

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.IoT1ClickDevicesService(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a IoT1ClickDevicesService object

var iot1clickdevicesservice = new AWS.IoT1ClickDevicesService({apiVersion: '2018-05-14'});

Options Hash (options):

  • params (map) —

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint) —

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String) —

    your AWS access key ID.

  • secretAccessKey (String) —

    your AWS secret access key.

  • sessionToken (AWS.Credentials) —

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials) —

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain) —

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String) —

    the region to send service requests to. See AWS.IoT1ClickDevicesService.region for more information.

  • maxRetries (Integer) —

    the maximum amount of retries to attempt with a request. See AWS.IoT1ClickDevicesService.maxRetries for more information.

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.IoT1ClickDevicesService.maxRedirects for more information.

  • sslEnabled (Boolean) —

    whether to enable SSL for requests.

  • paramValidation (Boolean|map) —

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean) —

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean) —

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean) —

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean) —

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean) —

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean) —

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional') —

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean) —

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map) —

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map) —

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date) —

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>) —

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log) —

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number) —

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String) —

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean) —

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean) —

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean) —

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean) —

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined) —

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number) —

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean) —

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional') —

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

claimDevicesByClaimCode(params = {}, callback) ⇒ AWS.Request

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).

Service Reference:

Examples:

Calling the claimDevicesByClaimCode operation

var params = {
  ClaimCode: 'STRING_VALUE' /* required */
};
iot1clickdevicesservice.claimDevicesByClaimCode(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ClaimCode — (String)

      The claim code, starting with "C-", as provided by the device manufacturer.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ClaimCode — (String)

        The claim code provided by the device manufacturer.

      • Total — (Integer)

        The total number of devices associated with the claim code that has been processed in the claim request.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

describeDevice(params = {}, callback) ⇒ AWS.Request

Given a device ID, returns a DescribeDeviceResponse object describing the details of the device.

Service Reference:

Examples:

Calling the describeDevice operation

var params = {
  DeviceId: 'STRING_VALUE' /* required */
};
iot1clickdevicesservice.describeDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceId — (String)

      The unique identifier of the device.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeviceDescription — (map)

        Device details.

        • Arn — (String)

          The ARN of the device.

        • Attributes — (map<String>)

          An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.

        • DeviceId — (String)

          The unique identifier of the device.

        • Enabled — (Boolean)

          A Boolean value indicating whether or not the device is enabled.

        • RemainingLife — (Float)

          A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.

        • Type — (String)

          The type of the device, such as "button".

        • Tags — (map<String>)

          The tags currently associated with the AWS IoT 1-Click device.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

finalizeDeviceClaim(params = {}, callback) ⇒ AWS.Request

Given a device ID, finalizes the claim request for the associated device.

Note: 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.

Service Reference:

Examples:

Calling the finalizeDeviceClaim operation

var params = {
  DeviceId: 'STRING_VALUE', /* required */
  Tags: {
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
iot1clickdevicesservice.finalizeDeviceClaim(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceId — (String)

      The unique identifier of the device.

    • Tags — (map<String>)

      A collection of key/value pairs defining the resource tags. For example, { "tags": "value1", "key2": "value2" }. For more information, see AWS Tagging Strategies.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • State — (String)

        The device's final claim state.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

getDeviceMethods(params = {}, callback) ⇒ AWS.Request

Given a device ID, returns the invokable methods associated with the device.

Service Reference:

Examples:

Calling the getDeviceMethods operation

var params = {
  DeviceId: 'STRING_VALUE' /* required */
};
iot1clickdevicesservice.getDeviceMethods(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceId — (String)

      The unique identifier of the device.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeviceMethods — (Array<map>)

        List of available device APIs.

        • DeviceType — (String)

          The type of the device, such as "button".

        • MethodName — (String)

          The name of the method applicable to the deviceType.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

initiateDeviceClaim(params = {}, callback) ⇒ AWS.Request

Given a device ID, initiates a claim request for the associated device.

Note: 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.

Service Reference:

Examples:

Calling the initiateDeviceClaim operation

var params = {
  DeviceId: 'STRING_VALUE' /* required */
};
iot1clickdevicesservice.initiateDeviceClaim(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceId — (String)

      The unique identifier of the device.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • State — (String)

        The device's final claim state.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

invokeDeviceMethod(params = {}, callback) ⇒ AWS.Request

Given a device ID, issues a request to invoke a named device method (with possible parameters). See the "Example POST" code snippet below.

Service Reference:

Examples:

Calling the invokeDeviceMethod operation

var params = {
  DeviceId: 'STRING_VALUE', /* required */
  DeviceMethod: {
    DeviceType: 'STRING_VALUE',
    MethodName: 'STRING_VALUE'
  },
  DeviceMethodParameters: 'STRING_VALUE'
};
iot1clickdevicesservice.invokeDeviceMethod(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceId — (String)

      The unique identifier of the device.

    • DeviceMethod — (map)

      The device method to invoke.

      • DeviceType — (String)

        The type of the device, such as "button".

      • MethodName — (String)

        The name of the method applicable to the deviceType.

    • DeviceMethodParameters — (String)

      A JSON encoded string containing the device method request parameters.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • DeviceMethodResponse — (String)

        A JSON encoded string containing the device method response.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDeviceEvents(params = {}, callback) ⇒ AWS.Request

Using a device ID, returns a DeviceEventsResponse object containing an array of events for the device.

Service Reference:

Examples:

Calling the listDeviceEvents operation

var params = {
  DeviceId: 'STRING_VALUE', /* required */
  FromTimeStamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  ToTimeStamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
iot1clickdevicesservice.listDeviceEvents(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceId — (String)

      The unique identifier of the device.

    • FromTimeStamp — (Date)

      The start date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z

    • MaxResults — (Integer)

      The maximum number of results to return per request. If not set, a default value of 100 is used.

    • NextToken — (String)

      The token to retrieve the next set of results.

    • ToTimeStamp — (Date)

      The end date for the device event query, in ISO8061 format. For example, 2018-03-28T15:45:12.880Z

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Events — (Array<map>)

        An array of zero or more elements describing the event(s) associated with the device.

        • Device — (map)

          An object representing the device associated with the event.

          • Attributes — (map)

            The user specified attributes associated with the device for an event.

          • DeviceId — (String)

            The unique identifier of the device.

          • Type — (String)

            The device type, such as "button".

        • StdEvent — (String)

          A serialized JSON object representing the device-type specific event.

      • NextToken — (String)

        The token to retrieve the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listDevices(params = {}, callback) ⇒ AWS.Request

Lists the 1-Click compatible devices associated with your AWS account.

Service Reference:

Examples:

Calling the listDevices operation

var params = {
  DeviceType: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
iot1clickdevicesservice.listDevices(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceType — (String)

      The type of the device, such as "button".

    • MaxResults — (Integer)

      The maximum number of results to return per request. If not set, a default value of 100 is used.

    • NextToken — (String)

      The token to retrieve the next set of results.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Devices — (Array<map>)

        A list of devices.

        • Arn — (String)

          The ARN of the device.

        • Attributes — (map<String>)

          An array of zero or more elements of DeviceAttribute objects providing user specified device attributes.

        • DeviceId — (String)

          The unique identifier of the device.

        • Enabled — (Boolean)

          A Boolean value indicating whether or not the device is enabled.

        • RemainingLife — (Float)

          A value between 0 and 1 inclusive, representing the fraction of life remaining for the device.

        • Type — (String)

          The type of the device, such as "button".

        • Tags — (map<String>)

          The tags currently associated with the AWS IoT 1-Click device.

      • NextToken — (String)

        The token to retrieve the next set of results.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Lists the tags associated with the specified resource ARN.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
iot1clickdevicesservice.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The ARN of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Tags — (map<String>)

        A collection of key/value pairs defining the resource tags. For example, { "tags": "value1", "key2": "value2" }. For more information, see AWS Tagging Strategies.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

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.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: { /* required */
    '<__string>': 'STRING_VALUE',
    /* '<__string>': ... */
  }
};
iot1clickdevicesservice.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The ARN of the resource.

    • Tags — (map<String>)

      A collection of key/value pairs defining the resource tags. For example, { "tags": "value1", "key2": "value2" }. For more information, see AWS Tagging Strategies.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

unclaimDevice(params = {}, callback) ⇒ AWS.Request

Disassociates a device from your AWS account using its device ID.

Service Reference:

Examples:

Calling the unclaimDevice operation

var params = {
  DeviceId: 'STRING_VALUE' /* required */
};
iot1clickdevicesservice.unclaimDevice(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceId — (String)

      The unique identifier of the device.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • State — (String)

        The device's final claim state.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Using tag keys, deletes the tags (key/value pairs) associated with the specified resource ARN.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
iot1clickdevicesservice.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • ResourceArn — (String)

      The ARN of the resource.

    • TagKeys — (Array<String>)

      A collections of tag keys. For example, {"key1","key2"}

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.

updateDeviceState(params = {}, callback) ⇒ AWS.Request

Using a Boolean value (true or false), this operation enables or disables the device given a device ID.

Service Reference:

Examples:

Calling the updateDeviceState operation

var params = {
  DeviceId: 'STRING_VALUE', /* required */
  Enabled: true || false
};
iot1clickdevicesservice.updateDeviceState(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {}) —
    • DeviceId — (String)

      The unique identifier of the device.

    • Enabled — (Boolean)

      If true, the device is enabled. If false, the device is disabled.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response) —

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error) —

      the error object returned from the request. Set to null if the request is successful.

    • data (Object) —

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request) —

    a handle to the operation request for subsequent event callback registration.