We announced the upcoming end-of-support for AWS SDK for JavaScript v2.
We recommend that you migrate to AWS SDK for JavaScript v3. For dates, additional details, and information on how to migrate, please refer to the linked announcement.

Class: AWS.IoTWireless

Inherits:
AWS.Service show all
Identifier:
iotwireless
API Version:
2020-11-22
Defined in:
(unknown)

Overview

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

Service Description

AWS IoT Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) communication protocol to communicate with AWS IoT.

Using the API, you can perform create, read, update, and delete operations for your wireless devices, gateways, destinations, and profiles. After onboarding your devices, you can use the API operations to set log levels and monitor your devices with CloudWatch.

You can also use the API operations to create multicast groups and schedule a multicast session for sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware of individual devices or an entire group of devices in a multicast group.

Sending a Request Using IoTWireless

var iotwireless = new AWS.IoTWireless();
iotwireless.associateAwsAccountWithPartnerAccount(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 IoTWireless object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var iotwireless = new AWS.IoTWireless({apiVersion: '2020-11-22'});

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

AWS.config.apiVersions = {
  iotwireless: '2020-11-22',
  // other service API versions
};

var iotwireless = new AWS.IoTWireless();

Version:

  • 2020-11-22

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a IoTWireless object

var iotwireless = new AWS.IoTWireless({apiVersion: '2020-11-22'});

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.IoTWireless.region for more information.

  • maxRetries (Integer)

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

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.IoTWireless.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'.

  • useFipsEndpoint (Boolean)

    Enables FIPS compatible endpoints. Defaults to false.

  • useDualstackEndpoint (Boolean)

    Enables IPv6 dualstack endpoint. Defaults to false.

Property Details

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

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

Associates a partner account with your AWS account.

Examples:

Calling the associateAwsAccountWithPartnerAccount operation

var params = {
  Sidewalk: { /* required */
    AmazonId: 'STRING_VALUE',
    AppServerPrivateKey: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotwireless.associateAwsAccountWithPartnerAccount(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: {})
    • Sidewalk — (map)

      The Sidewalk account credentials.

      • AmazonId — (String)

        The Sidewalk Amazon ID.

      • AppServerPrivateKey — (String)

        The Sidewalk application server private key.

    • ClientRequestToken — (String)

      Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

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:

      • Sidewalk — (map)

        The Sidewalk account credentials.

        • AmazonId — (String)

          The Sidewalk Amazon ID.

        • AppServerPrivateKey — (String)

          The Sidewalk application server private key.

      • Arn — (String)

        The Amazon Resource Name of the resource.

Returns:

  • (AWS.Request)

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

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

Associate a multicast group with a FUOTA task.

Examples:

Calling the associateMulticastGroupWithFuotaTask operation

var params = {
  Id: 'STRING_VALUE', /* required */
  MulticastGroupId: 'STRING_VALUE' /* required */
};
iotwireless.associateMulticastGroupWithFuotaTask(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: {})
    • Id — (String)

      The ID of a FUOTA task.

    • MulticastGroupId — (String)

      The ID of the multicast group.

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.

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

Associate a wireless device with a FUOTA task.

Examples:

Calling the associateWirelessDeviceWithFuotaTask operation

var params = {
  Id: 'STRING_VALUE', /* required */
  WirelessDeviceId: 'STRING_VALUE' /* required */
};
iotwireless.associateWirelessDeviceWithFuotaTask(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: {})
    • Id — (String)

      The ID of a FUOTA task.

    • WirelessDeviceId — (String)

      The ID of the wireless 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.

Returns:

  • (AWS.Request)

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

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

Associates a wireless device with a multicast group.

Examples:

Calling the associateWirelessDeviceWithMulticastGroup operation

var params = {
  Id: 'STRING_VALUE', /* required */
  WirelessDeviceId: 'STRING_VALUE' /* required */
};
iotwireless.associateWirelessDeviceWithMulticastGroup(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: {})
    • Id — (String)

      The ID of the multicast group.

    • WirelessDeviceId — (String)

      The ID of the wireless 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.

Returns:

  • (AWS.Request)

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

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

Associates a wireless device with a thing.

Examples:

Calling the associateWirelessDeviceWithThing operation

var params = {
  Id: 'STRING_VALUE', /* required */
  ThingArn: 'STRING_VALUE' /* required */
};
iotwireless.associateWirelessDeviceWithThing(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: {})
    • Id — (String)

      The ID of the resource to update.

    • ThingArn — (String)

      The ARN of the thing to associate with the wireless 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.

Returns:

  • (AWS.Request)

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

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

Associates a wireless gateway with a certificate.

Examples:

Calling the associateWirelessGatewayWithCertificate operation

var params = {
  Id: 'STRING_VALUE', /* required */
  IotCertificateId: 'STRING_VALUE' /* required */
};
iotwireless.associateWirelessGatewayWithCertificate(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: {})
    • Id — (String)

      The ID of the resource to update.

    • IotCertificateId — (String)

      The ID of the certificate to associate with the wireless gateway.

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:

      • IotCertificateId — (String)

        The ID of the certificate associated with the wireless gateway.

Returns:

  • (AWS.Request)

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

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

Associates a wireless gateway with a thing.

Examples:

Calling the associateWirelessGatewayWithThing operation

var params = {
  Id: 'STRING_VALUE', /* required */
  ThingArn: 'STRING_VALUE' /* required */
};
iotwireless.associateWirelessGatewayWithThing(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: {})
    • Id — (String)

      The ID of the resource to update.

    • ThingArn — (String)

      The ARN of the thing to associate with the wireless gateway.

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.

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

Cancels an existing multicast group session.

Service Reference:

Examples:

Calling the cancelMulticastGroupSession operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.cancelMulticastGroupSession(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: {})
    • Id — (String)

      The ID of the multicast group.

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.

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

Creates a new destination that maps a device message to an AWS IoT rule.

Service Reference:

Examples:

Calling the createDestination operation

var params = {
  Expression: 'STRING_VALUE', /* required */
  ExpressionType: RuleName | MqttTopic, /* required */
  Name: 'STRING_VALUE', /* required */
  RoleArn: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotwireless.createDestination(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: {})
    • Name — (String)

      The name of the new resource.

    • ExpressionType — (String)

      The type of value in Expression.

      Possible values include:
      • "RuleName"
      • "MqttTopic"
    • Expression — (String)

      The rule name or topic rule to send messages to.

    • Description — (String)

      The description of the new resource.

    • RoleArn — (String)

      The ARN of the IAM Role that authorizes the destination.

    • Tags — (Array<map>)

      The tags to attach to the new destination. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

    • ClientRequestToken — (String)

      Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • Arn — (String)

        The Amazon Resource Name of the new resource.

      • Name — (String)

        The name of the new resource.

Returns:

  • (AWS.Request)

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

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

Creates a new device profile.

Service Reference:

Examples:

Calling the createDeviceProfile operation

var params = {
  ClientRequestToken: 'STRING_VALUE',
  LoRaWAN: {
    ClassBTimeout: 'NUMBER_VALUE',
    ClassCTimeout: 'NUMBER_VALUE',
    FactoryPresetFreqsList: [
      'NUMBER_VALUE',
      /* more items */
    ],
    MacVersion: 'STRING_VALUE',
    MaxDutyCycle: 'NUMBER_VALUE',
    MaxEirp: 'NUMBER_VALUE',
    PingSlotDr: 'NUMBER_VALUE',
    PingSlotFreq: 'NUMBER_VALUE',
    PingSlotPeriod: 'NUMBER_VALUE',
    RegParamsRevision: 'STRING_VALUE',
    RfRegion: 'STRING_VALUE',
    RxDataRate2: 'NUMBER_VALUE',
    RxDelay1: 'NUMBER_VALUE',
    RxDrOffset1: 'NUMBER_VALUE',
    RxFreq2: 'NUMBER_VALUE',
    Supports32BitFCnt: true || false,
    SupportsClassB: true || false,
    SupportsClassC: true || false,
    SupportsJoin: true || false
  },
  Name: 'STRING_VALUE',
  Sidewalk: {
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotwireless.createDeviceProfile(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: {})
    • Name — (String)

      The name of the new resource.

    • LoRaWAN — (map)

      The device profile information to use to create the device profile.

      • SupportsClassB — (Boolean)

        The SupportsClassB value.

      • ClassBTimeout — (Integer)

        The ClassBTimeout value.

      • PingSlotPeriod — (Integer)

        The PingSlotPeriod value.

      • PingSlotDr — (Integer)

        The PingSlotDR value.

      • PingSlotFreq — (Integer)

        The PingSlotFreq value.

      • SupportsClassC — (Boolean)

        The SupportsClassC value.

      • ClassCTimeout — (Integer)

        The ClassCTimeout value.

      • MacVersion — (String)

        The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.

      • RegParamsRevision — (String)

        The version of regional parameters.

      • RxDelay1 — (Integer)

        The RXDelay1 value.

      • RxDrOffset1 — (Integer)

        The RXDROffset1 value.

      • RxDataRate2 — (Integer)

        The RXDataRate2 value.

      • RxFreq2 — (Integer)

        The RXFreq2 value.

      • FactoryPresetFreqsList — (Array<Integer>)

        The list of values that make up the FactoryPresetFreqs value.

      • MaxEirp — (Integer)

        The MaxEIRP value.

      • MaxDutyCycle — (Integer)

        The MaxDutyCycle value. It ranges from 0 to 15.

      • RfRegion — (String)

        The frequency band (RFRegion) value.

      • SupportsJoin — (Boolean)

        The SupportsJoin value.

      • Supports32BitFCnt — (Boolean)

        The Supports32BitFCnt value.

    • Tags — (Array<map>)

      The tags to attach to the new device profile. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

    • ClientRequestToken — (String)

      Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Sidewalk — (map)

      The Sidewalk-related information for creating the Sidewalk device profile.

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:

      • Arn — (String)

        The Amazon Resource Name of the new resource.

      • Id — (String)

        The ID of the new device profile.

Returns:

  • (AWS.Request)

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

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

Creates a FUOTA task.

Service Reference:

Examples:

Calling the createFuotaTask operation

var params = {
  FirmwareUpdateImage: 'STRING_VALUE', /* required */
  FirmwareUpdateRole: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  FragmentIntervalMS: 'NUMBER_VALUE',
  FragmentSizeBytes: 'NUMBER_VALUE',
  LoRaWAN: {
    RfRegion: EU868 | US915 | AU915 | AS923-1 | AS923-2 | AS923-3 | AS923-4 | EU433 | CN470 | CN779 | RU864 | KR920 | IN865
  },
  Name: 'STRING_VALUE',
  RedundancyPercent: 'NUMBER_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotwireless.createFuotaTask(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: {})
    • Name — (String)

      The name of a FUOTA task.

    • Description — (String)

      The description of the new resource.

    • ClientRequestToken — (String)

      Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • LoRaWAN — (map)

      The LoRaWAN information used with a FUOTA task.

      • RfRegion — (String)

        Supported RfRegions

        Possible values include:
        • "EU868"
        • "US915"
        • "AU915"
        • "AS923-1"
        • "AS923-2"
        • "AS923-3"
        • "AS923-4"
        • "EU433"
        • "CN470"
        • "CN779"
        • "RU864"
        • "KR920"
        • "IN865"
    • FirmwareUpdateImage — (String)

      The S3 URI points to a firmware update image that is to be used with a FUOTA task.

    • FirmwareUpdateRole — (String)

      The firmware update role that is to be used with a FUOTA task.

    • Tags — (Array<map>)

      The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

    • RedundancyPercent — (Integer)

      The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

    • FragmentSizeBytes — (Integer)

      The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

    • FragmentIntervalMS — (Integer)

      The interval for sending fragments in milliseconds, rounded to the nearest second.

      Note: This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.

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:

      • Arn — (String)

        The arn of a FUOTA task.

      • Id — (String)

        The ID of a FUOTA task.

Returns:

  • (AWS.Request)

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

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

Creates a multicast group.

Service Reference:

Examples:

Calling the createMulticastGroup operation

var params = {
  LoRaWAN: { /* required */
    DlClass: ClassB | ClassC,
    RfRegion: EU868 | US915 | AU915 | AS923-1 | AS923-2 | AS923-3 | AS923-4 | EU433 | CN470 | CN779 | RU864 | KR920 | IN865
  },
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotwireless.createMulticastGroup(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: {})
    • Name — (String)

      The name of the multicast group.

    • Description — (String)

      The description of the multicast group.

    • ClientRequestToken — (String)

      Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • LoRaWAN — (map)

      The LoRaWAN information that is to be used with the multicast group.

      • RfRegion — (String)

        Supported RfRegions

        Possible values include:
        • "EU868"
        • "US915"
        • "AU915"
        • "AS923-1"
        • "AS923-2"
        • "AS923-3"
        • "AS923-4"
        • "EU433"
        • "CN470"
        • "CN779"
        • "RU864"
        • "KR920"
        • "IN865"
      • DlClass — (String)

        DlClass for LoRaWAM, valid values are ClassB and ClassC.

        Possible values include:
        • "ClassB"
        • "ClassC"
    • Tags — (Array<map>)

      The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

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:

      • Arn — (String)

        The arn of the multicast group.

      • Id — (String)

        The ID of the multicast group.

Returns:

  • (AWS.Request)

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

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

Creates a new network analyzer configuration.

Examples:

Calling the createNetworkAnalyzerConfiguration operation

var params = {
  Name: 'STRING_VALUE', /* required */
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  MulticastGroups: [
    'STRING_VALUE',
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  TraceContent: {
    LogLevel: INFO | ERROR | DISABLED,
    MulticastFrameInfo: ENABLED | DISABLED,
    WirelessDeviceFrameInfo: ENABLED | DISABLED
  },
  WirelessDevices: [
    'STRING_VALUE',
    /* more items */
  ],
  WirelessGateways: [
    'STRING_VALUE',
    /* more items */
  ]
};
iotwireless.createNetworkAnalyzerConfiguration(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: {})
    • Name — (String)

      Name of the network analyzer configuration.

    • TraceContent — (map)

      Trace content for your wireless devices, gateways, and multicast groups.

      • WirelessDeviceFrameInfo — (String)

        FrameInfo of your wireless device resources for the trace content. Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • LogLevel — (String)

        The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

        Possible values include:
        • "INFO"
        • "ERROR"
        • "DISABLED"
      • MulticastFrameInfo — (String)

        FrameInfo of your multicast group resources for the trace content. Use FrameInfo to debug the multicast communication between your multicast groups and the network server.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
    • WirelessDevices — (Array<String>)

      Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

    • WirelessGateways — (Array<String>)

      Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

    • Description — (String)

      The description of the new resource.

    • Tags — (Array<map>)

      The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

    • ClientRequestToken — (String)

      Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • MulticastGroups — (Array<String>)

      Multicast Group resources to add to the network analyzer configruation. Provide the MulticastGroupId of the resource to add in the input array.

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:

      • Arn — (String)

        The Amazon Resource Name of the new resource.

      • Name — (String)

        Name of the network analyzer configuration.

Returns:

  • (AWS.Request)

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

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

Creates a new service profile.

Service Reference:

Examples:

Calling the createServiceProfile operation

var params = {
  ClientRequestToken: 'STRING_VALUE',
  LoRaWAN: {
    AddGwMetadata: true || false,
    DrMax: 'NUMBER_VALUE',
    DrMin: 'NUMBER_VALUE',
    PrAllowed: true || false,
    RaAllowed: true || false
  },
  Name: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotwireless.createServiceProfile(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: {})
    • Name — (String)

      The name of the new resource.

    • LoRaWAN — (map)

      The service profile information to use to create the service profile.

      • AddGwMetadata — (Boolean)

        The AddGWMetaData value.

      • DrMin — (Integer)

        The DrMin value.

      • DrMax — (Integer)

        The DrMax value.

      • PrAllowed — (Boolean)

        The PRAllowed value that describes whether passive roaming is allowed.

      • RaAllowed — (Boolean)

        The RAAllowed value that describes whether roaming activation is allowed.

    • Tags — (Array<map>)

      The tags to attach to the new service profile. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

    • ClientRequestToken — (String)

      Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • Arn — (String)

        The Amazon Resource Name of the new resource.

      • Id — (String)

        The ID of the new service profile.

Returns:

  • (AWS.Request)

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

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

Provisions a wireless device.

Service Reference:

Examples:

Calling the createWirelessDevice operation

var params = {
  DestinationName: 'STRING_VALUE', /* required */
  Type: Sidewalk | LoRaWAN, /* required */
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  LoRaWAN: {
    AbpV1_0_x: {
      DevAddr: 'STRING_VALUE',
      FCntStart: 'NUMBER_VALUE',
      SessionKeys: {
        AppSKey: 'STRING_VALUE',
        NwkSKey: 'STRING_VALUE'
      }
    },
    AbpV1_1: {
      DevAddr: 'STRING_VALUE',
      FCntStart: 'NUMBER_VALUE',
      SessionKeys: {
        AppSKey: 'STRING_VALUE',
        FNwkSIntKey: 'STRING_VALUE',
        NwkSEncKey: 'STRING_VALUE',
        SNwkSIntKey: 'STRING_VALUE'
      }
    },
    DevEui: 'STRING_VALUE',
    DeviceProfileId: 'STRING_VALUE',
    FPorts: {
      Applications: [
        {
          DestinationName: 'STRING_VALUE',
          FPort: 'NUMBER_VALUE',
          Type: SemtechGeolocation
        },
        /* more items */
      ],
      ClockSync: 'NUMBER_VALUE',
      Fuota: 'NUMBER_VALUE',
      Multicast: 'NUMBER_VALUE',
      Positioning: {
        ClockSync: 'NUMBER_VALUE',
        Gnss: 'NUMBER_VALUE',
        Stream: 'NUMBER_VALUE'
      }
    },
    OtaaV1_0_x: {
      AppEui: 'STRING_VALUE',
      AppKey: 'STRING_VALUE',
      GenAppKey: 'STRING_VALUE',
      JoinEui: 'STRING_VALUE'
    },
    OtaaV1_1: {
      AppKey: 'STRING_VALUE',
      JoinEui: 'STRING_VALUE',
      NwkKey: 'STRING_VALUE'
    },
    ServiceProfileId: 'STRING_VALUE'
  },
  Name: 'STRING_VALUE',
  Positioning: Enabled | Disabled,
  Sidewalk: {
    DeviceProfileId: 'STRING_VALUE'
  },
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotwireless.createWirelessDevice(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: {})
    • Type — (String)

      The wireless device type.

      Possible values include:
      • "Sidewalk"
      • "LoRaWAN"
    • Name — (String)

      The name of the new resource.

    • Description — (String)

      The description of the new resource.

    • DestinationName — (String)

      The name of the destination to assign to the new wireless device.

    • ClientRequestToken — (String)

      Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • LoRaWAN — (map)

      The device configuration information to use to create the wireless device.

      • DevEui — (String)

        The DevEUI value.

      • DeviceProfileId — (String)

        The ID of the device profile for the new wireless device.

      • ServiceProfileId — (String)

        The ID of the service profile.

      • OtaaV1_1 — (map)

        OTAA device object for v1.1 for create APIs

        • AppKey — (String)

          The AppKey value.

        • NwkKey — (String)

          The NwkKey value.

        • JoinEui — (String)

          The JoinEUI value.

      • OtaaV1_0_x — (map)

        OTAA device object for create APIs for v1.0.x

        • AppKey — (String)

          The AppKey value.

        • AppEui — (String)

          The AppEUI value.

        • JoinEui — (String)

          The JoinEUI value.

        • GenAppKey — (String)

          The GenAppKey value.

      • AbpV1_1 — (map)

        ABP device object for create APIs for v1.1

        • DevAddr — (String)

          The DevAddr value.

        • SessionKeys — (map)

          Session keys for ABP v1.1

          • FNwkSIntKey — (String)

            The FNwkSIntKey value.

          • SNwkSIntKey — (String)

            The SNwkSIntKey value.

          • NwkSEncKey — (String)

            The NwkSEncKey value.

          • AppSKey — (String)

            The AppSKey value.

        • FCntStart — (Integer)

          The FCnt init value.

      • AbpV1_0_x — (map)

        LoRaWAN object for create APIs

        • DevAddr — (String)

          The DevAddr value.

        • SessionKeys — (map)

          Session keys for ABP v1.0.x

          • NwkSKey — (String)

            The NwkSKey value.

          • AppSKey — (String)

            The AppSKey value.

        • FCntStart — (Integer)

          The FCnt init value.

      • FPorts — (map)

        List of FPort assigned for different LoRaWAN application packages to use

        • Fuota — (Integer)

          The Fport value.

        • Multicast — (Integer)

          The Fport value.

        • ClockSync — (Integer)

          The Fport value.

        • Positioning — (map)

          FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

          • ClockSync — (Integer)

            The Fport value.

          • Stream — (Integer)

            The Fport value.

          • Gnss — (Integer)

            The Fport value.

        • Applications — (Array<map>)

          Optional LoRaWAN application information, which can be used for geolocation.

          • FPort — (Integer)

            The Fport value.

          • Type — (String)

            Application type, which can be specified to obtain real-time position information of your LoRaWAN device.

            Possible values include:
            • "SemtechGeolocation"
          • DestinationName — (String)

            The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

    • Tags — (Array<map>)

      The tags to attach to the new wireless device. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

    • Positioning — (String)

      FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

      Possible values include:
      • "Enabled"
      • "Disabled"
    • Sidewalk — (map)

      The device configuration information to use to create the Sidewalk device.

      • DeviceProfileId — (String)

        The ID of the Sidewalk device profile.

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:

      • Arn — (String)

        The Amazon Resource Name of the new resource.

      • Id — (String)

        The ID of the new wireless device.

Returns:

  • (AWS.Request)

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

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

Provisions a wireless gateway.

Service Reference:

Examples:

Calling the createWirelessGateway operation

var params = {
  LoRaWAN: { /* required */
    Beaconing: {
      DataRate: 'NUMBER_VALUE',
      Frequencies: [
        'NUMBER_VALUE',
        /* more items */
      ]
    },
    GatewayEui: 'STRING_VALUE',
    JoinEuiFilters: [
      [
        'STRING_VALUE',
        /* more items */
      ],
      /* more items */
    ],
    MaxEirp: 'NUMBER_VALUE',
    NetIdFilters: [
      'STRING_VALUE',
      /* more items */
    ],
    RfRegion: 'STRING_VALUE',
    SubBands: [
      'NUMBER_VALUE',
      /* more items */
    ]
  },
  ClientRequestToken: 'STRING_VALUE',
  Description: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotwireless.createWirelessGateway(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: {})
    • Name — (String)

      The name of the new resource.

    • Description — (String)

      The description of the new resource.

    • LoRaWAN — (map)

      The gateway configuration information to use to create the wireless gateway.

      • GatewayEui — (String)

        The gateway's EUI value.

      • RfRegion — (String)

        The frequency band (RFRegion) value.

      • JoinEuiFilters — (Array<Array<String>>)

        A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.

      • NetIdFilters — (Array<String>)

        A list of NetId values that are used by LoRa gateways to filter the uplink frames.

      • SubBands — (Array<Integer>)

        A list of integer indicating which sub bands are supported by LoRa gateway.

      • Beaconing — (map)

        Beaconing object information, which consists of the data rate and frequency parameters.

        • DataRate — (Integer)

          The data rate for gateways that are sending the beacons.

        • Frequencies — (Array<Integer>)

          The frequency list for the gateways to send the beacons.

      • MaxEirp — (Float)

        The MaxEIRP value.

    • Tags — (Array<map>)

      The tags to attach to the new wireless gateway. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

    • ClientRequestToken — (String)

      Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

      If a token is not provided, the SDK will use a version 4 UUID.

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:

      • Arn — (String)

        The Amazon Resource Name of the new resource.

      • Id — (String)

        The ID of the new wireless gateway.

Returns:

  • (AWS.Request)

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

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

Creates a task for a wireless gateway.

Service Reference:

Examples:

Calling the createWirelessGatewayTask operation

var params = {
  Id: 'STRING_VALUE', /* required */
  WirelessGatewayTaskDefinitionId: 'STRING_VALUE' /* required */
};
iotwireless.createWirelessGatewayTask(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: {})
    • Id — (String)

      The ID of the resource to update.

    • WirelessGatewayTaskDefinitionId — (String)

      The ID of the WirelessGatewayTaskDefinition.

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:

      • WirelessGatewayTaskDefinitionId — (String)

        The ID of the WirelessGatewayTaskDefinition.

      • Status — (String)

        The status of the request.

        Possible values include:
        • "PENDING"
        • "IN_PROGRESS"
        • "FIRST_RETRY"
        • "SECOND_RETRY"
        • "COMPLETED"
        • "FAILED"

Returns:

  • (AWS.Request)

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

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

Creates a gateway task definition.

Examples:

Calling the createWirelessGatewayTaskDefinition operation

var params = {
  AutoCreateTasks: true || false, /* required */
  ClientRequestToken: 'STRING_VALUE',
  Name: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ],
  Update: {
    LoRaWAN: {
      CurrentVersion: {
        Model: 'STRING_VALUE',
        PackageVersion: 'STRING_VALUE',
        Station: 'STRING_VALUE'
      },
      SigKeyCrc: 'NUMBER_VALUE',
      UpdateSignature: 'STRING_VALUE',
      UpdateVersion: {
        Model: 'STRING_VALUE',
        PackageVersion: 'STRING_VALUE',
        Station: 'STRING_VALUE'
      }
    },
    UpdateDataRole: 'STRING_VALUE',
    UpdateDataSource: 'STRING_VALUE'
  }
};
iotwireless.createWirelessGatewayTaskDefinition(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: {})
    • AutoCreateTasks — (Boolean)

      Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.

    • Name — (String)

      The name of the new resource.

    • Update — (map)

      Information about the gateways to update.

      • UpdateDataSource — (String)

        The link to the S3 bucket.

      • UpdateDataRole — (String)

        The IAM role used to read data from the S3 bucket.

      • LoRaWAN — (map)

        The properties that relate to the LoRaWAN wireless gateway.

        • UpdateSignature — (String)

          The signature used to verify the update firmware.

        • SigKeyCrc — (Integer)

          The CRC of the signature private key to check.

        • CurrentVersion — (map)

          The version of the gateways that should receive the update.

          • PackageVersion — (String)

            The version of the wireless gateway firmware.

          • Model — (String)

            The model number of the wireless gateway.

          • Station — (String)

            The basic station version of the wireless gateway.

        • UpdateVersion — (map)

          The firmware version to update the gateway to.

          • PackageVersion — (String)

            The version of the wireless gateway firmware.

          • Model — (String)

            The model number of the wireless gateway.

          • Station — (String)

            The basic station version of the wireless gateway.

    • ClientRequestToken — (String)

      Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

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:

      • Id — (String)

        The ID of the new wireless gateway task definition.

      • Arn — (String)

        The Amazon Resource Name of the resource.

Returns:

  • (AWS.Request)

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

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

Deletes a destination.

Service Reference:

Examples:

Calling the deleteDestination operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
iotwireless.deleteDestination(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: {})
    • Name — (String)

      The name of the resource to delete.

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.

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

Deletes a device profile.

Service Reference:

Examples:

Calling the deleteDeviceProfile operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.deleteDeviceProfile(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: {})
    • Id — (String)

      The ID of the resource to delete.

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.

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

Deletes a FUOTA task.

Service Reference:

Examples:

Calling the deleteFuotaTask operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.deleteFuotaTask(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: {})
    • Id — (String)

      The ID of a FUOTA task.

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.

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

Deletes a multicast group if it is not in use by a fuota task.

Service Reference:

Examples:

Calling the deleteMulticastGroup operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.deleteMulticastGroup(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: {})
    • Id — (String)

      The ID of the multicast group.

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.

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

Deletes a network analyzer configuration.

Examples:

Calling the deleteNetworkAnalyzerConfiguration operation

var params = {
  ConfigurationName: 'STRING_VALUE' /* required */
};
iotwireless.deleteNetworkAnalyzerConfiguration(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: {})
    • ConfigurationName — (String)

      Name of the network analyzer configuration.

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.

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

Remove queued messages from the downlink queue.

Service Reference:

Examples:

Calling the deleteQueuedMessages operation

var params = {
  Id: 'STRING_VALUE', /* required */
  MessageId: 'STRING_VALUE', /* required */
  WirelessDeviceType: Sidewalk | LoRaWAN
};
iotwireless.deleteQueuedMessages(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: {})
    • Id — (String)

      The ID of a given wireless device for which downlink messages will be deleted.

    • MessageId — (String)

      If message ID is "*", it cleares the entire downlink queue for a given device, specified by the wireless device ID. Otherwise, the downlink message with the specified message ID will be deleted.

    • WirelessDeviceType — (String)

      The wireless device type, which can be either Sidewalk or LoRaWAN.

      Possible values include:
      • "Sidewalk"
      • "LoRaWAN"

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.

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

Deletes a service profile.

Service Reference:

Examples:

Calling the deleteServiceProfile operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.deleteServiceProfile(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: {})
    • Id — (String)

      The ID of the resource to delete.

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.

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

Deletes a wireless device.

Service Reference:

Examples:

Calling the deleteWirelessDevice operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.deleteWirelessDevice(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: {})
    • Id — (String)

      The ID of the resource to delete.

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.

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

Delete an import task.

Service Reference:

Examples:

Calling the deleteWirelessDeviceImportTask operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.deleteWirelessDeviceImportTask(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: {})
    • Id — (String)

      The unique identifier of the import task to be deleted.

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.

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

Deletes a wireless gateway.

Service Reference:

Examples:

Calling the deleteWirelessGateway operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.deleteWirelessGateway(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: {})
    • Id — (String)

      The ID of the resource to delete.

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.

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

Deletes a wireless gateway task.

Service Reference:

Examples:

Calling the deleteWirelessGatewayTask operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.deleteWirelessGatewayTask(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: {})
    • Id — (String)

      The ID of the resource to delete.

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.

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

Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.

Examples:

Calling the deleteWirelessGatewayTaskDefinition operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.deleteWirelessGatewayTaskDefinition(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: {})
    • Id — (String)

      The ID of the resource to delete.

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.

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

Deregister a wireless device from AWS IoT Wireless.

Service Reference:

Examples:

Calling the deregisterWirelessDevice operation

var params = {
  Identifier: 'STRING_VALUE', /* required */
  WirelessDeviceType: Sidewalk | LoRaWAN
};
iotwireless.deregisterWirelessDevice(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: {})
    • Identifier — (String)

      The identifier of the wireless device to deregister from AWS IoT Wireless.

    • WirelessDeviceType — (String)

      The type of wireless device to deregister from AWS IoT Wireless, which can be LoRaWAN or Sidewalk.

      Possible values include:
      • "Sidewalk"
      • "LoRaWAN"

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.

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

Disassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.

Examples:

Calling the disassociateAwsAccountFromPartnerAccount operation

var params = {
  PartnerAccountId: 'STRING_VALUE', /* required */
  PartnerType: Sidewalk /* required */
};
iotwireless.disassociateAwsAccountFromPartnerAccount(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: {})
    • PartnerAccountId — (String)

      The partner account ID to disassociate from the AWS account.

    • PartnerType — (String)

      The partner type.

      Possible values include:
      • "Sidewalk"

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.

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

Disassociates a multicast group from a fuota task.

Examples:

Calling the disassociateMulticastGroupFromFuotaTask operation

var params = {
  Id: 'STRING_VALUE', /* required */
  MulticastGroupId: 'STRING_VALUE' /* required */
};
iotwireless.disassociateMulticastGroupFromFuotaTask(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: {})
    • Id — (String)

      The ID of a FUOTA task.

    • MulticastGroupId — (String)

      The ID of the multicast group.

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.

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

Disassociates a wireless device from a FUOTA task.

Examples:

Calling the disassociateWirelessDeviceFromFuotaTask operation

var params = {
  Id: 'STRING_VALUE', /* required */
  WirelessDeviceId: 'STRING_VALUE' /* required */
};
iotwireless.disassociateWirelessDeviceFromFuotaTask(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: {})
    • Id — (String)

      The ID of a FUOTA task.

    • WirelessDeviceId — (String)

      The ID of the wireless 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.

Returns:

  • (AWS.Request)

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

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

Disassociates a wireless device from a multicast group.

Examples:

Calling the disassociateWirelessDeviceFromMulticastGroup operation

var params = {
  Id: 'STRING_VALUE', /* required */
  WirelessDeviceId: 'STRING_VALUE' /* required */
};
iotwireless.disassociateWirelessDeviceFromMulticastGroup(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: {})
    • Id — (String)

      The ID of the multicast group.

    • WirelessDeviceId — (String)

      The ID of the wireless 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.

Returns:

  • (AWS.Request)

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

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

Disassociates a wireless device from its currently associated thing.

Examples:

Calling the disassociateWirelessDeviceFromThing operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.disassociateWirelessDeviceFromThing(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: {})
    • Id — (String)

      The ID of the resource to update.

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.

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

Disassociates a wireless gateway from its currently associated certificate.

Examples:

Calling the disassociateWirelessGatewayFromCertificate operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.disassociateWirelessGatewayFromCertificate(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: {})
    • Id — (String)

      The ID of the resource to update.

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.

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

Disassociates a wireless gateway from its currently associated thing.

Examples:

Calling the disassociateWirelessGatewayFromThing operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.disassociateWirelessGatewayFromThing(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: {})
    • Id — (String)

      The ID of the resource to update.

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.

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

Gets information about a destination.

Service Reference:

Examples:

Calling the getDestination operation

var params = {
  Name: 'STRING_VALUE' /* required */
};
iotwireless.getDestination(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: {})
    • Name — (String)

      The name of the resource to get.

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:

      • Arn — (String)

        The Amazon Resource Name of the resource.

      • Name — (String)

        The name of the resource.

      • Expression — (String)

        The rule name or topic rule to send messages to.

      • ExpressionType — (String)

        The type of value in Expression.

        Possible values include:
        • "RuleName"
        • "MqttTopic"
      • Description — (String)

        The description of the resource.

      • RoleArn — (String)

        The ARN of the IAM Role that authorizes the destination.

Returns:

  • (AWS.Request)

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

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

Gets information about a device profile.

Service Reference:

Examples:

Calling the getDeviceProfile operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.getDeviceProfile(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: {})
    • Id — (String)

      The ID of the resource to get.

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:

      • Arn — (String)

        The Amazon Resource Name of the resource.

      • Name — (String)

        The name of the resource.

      • Id — (String)

        The ID of the device profile.

      • LoRaWAN — (map)

        Information about the device profile.

        • SupportsClassB — (Boolean)

          The SupportsClassB value.

        • ClassBTimeout — (Integer)

          The ClassBTimeout value.

        • PingSlotPeriod — (Integer)

          The PingSlotPeriod value.

        • PingSlotDr — (Integer)

          The PingSlotDR value.

        • PingSlotFreq — (Integer)

          The PingSlotFreq value.

        • SupportsClassC — (Boolean)

          The SupportsClassC value.

        • ClassCTimeout — (Integer)

          The ClassCTimeout value.

        • MacVersion — (String)

          The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.

        • RegParamsRevision — (String)

          The version of regional parameters.

        • RxDelay1 — (Integer)

          The RXDelay1 value.

        • RxDrOffset1 — (Integer)

          The RXDROffset1 value.

        • RxDataRate2 — (Integer)

          The RXDataRate2 value.

        • RxFreq2 — (Integer)

          The RXFreq2 value.

        • FactoryPresetFreqsList — (Array<Integer>)

          The list of values that make up the FactoryPresetFreqs value.

        • MaxEirp — (Integer)

          The MaxEIRP value.

        • MaxDutyCycle — (Integer)

          The MaxDutyCycle value. It ranges from 0 to 15.

        • RfRegion — (String)

          The frequency band (RFRegion) value.

        • SupportsJoin — (Boolean)

          The SupportsJoin value.

        • Supports32BitFCnt — (Boolean)

          The Supports32BitFCnt value.

      • Sidewalk — (map)

        Information about the Sidewalk parameters in the device profile.

        • ApplicationServerPublicKey — (String)

          The Sidewalk application server public key.

        • QualificationStatus — (Boolean)

          Gets information about the certification status of a Sidewalk device profile.

        • DakCertificateMetadata — (Array<map>)

          The DAK certificate information of the Sidewalk device profile.

          • CertificateIdrequired — (String)

            The certificate ID for the DAK.

          • MaxAllowedSignature — (Integer)

            The maximum number of signatures that the DAK can sign. A value of -1 indicates that there's no device limit.

          • FactorySupport — (Boolean)

            Whether factory support has been enabled.

          • ApId — (String)

            The advertised product ID (APID) that's used for pre-production and production applications.

          • DeviceTypeId — (String)

            The device type ID that's used for prototyping applications.

Returns:

  • (AWS.Request)

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

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

Get the event configuration based on resource types.

Examples:

Calling the getEventConfigurationByResourceTypes operation

var params = {
};
iotwireless.getEventConfigurationByResourceTypes(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: {})

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:

      • DeviceRegistrationState — (map)

        Resource type event configuration for the device registration state event.

        • Sidewalk — (map)

          Device registration resource type state event configuration object for enabling or disabling Sidewalk related event topics.

          • WirelessDeviceEventTopic — (String)

            Denotes whether the wireless device join event topic is enabled or disabled.

            Possible values include:
            • "Enabled"
            • "Disabled"
      • Proximity — (map)

        Resource type event configuration for the proximity event.

        • Sidewalk — (map)

          Proximity resource type event configuration object for enabling and disabling wireless device topic.

          • WirelessDeviceEventTopic — (String)

            Denotes whether the wireless device join event topic is enabled or disabled.

            Possible values include:
            • "Enabled"
            • "Disabled"
      • Join — (map)

        Resource type event configuration for the join event.

        • LoRaWAN — (map)

          Join resource type event configuration object for enabling or disabling LoRaWAN related event topics.

          • WirelessDeviceEventTopic — (String)

            Denotes whether the wireless device join event topic is enabled or disabled.

            Possible values include:
            • "Enabled"
            • "Disabled"
      • ConnectionStatus — (map)

        Resource type event configuration for the connection status event.

        • LoRaWAN — (map)

          Connection status resource type event configuration object for enabling or disabling LoRaWAN related event topics.

          • WirelessGatewayEventTopic — (String)

            Denotes whether the wireless gateway connection status event topic is enabled or disabled.

            Possible values include:
            • "Enabled"
            • "Disabled"
      • MessageDeliveryStatus — (map)

        Resource type event configuration object for the message delivery status event.

        • Sidewalk — (map)

          Sidewalk resource type event configuration object for enabling or disabling topic.

          • WirelessDeviceEventTopic — (String)

            Denotes whether the wireless device join event topic is enabled or disabled.

            Possible values include:
            • "Enabled"
            • "Disabled"

Returns:

  • (AWS.Request)

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

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

Gets information about a FUOTA task.

Service Reference:

Examples:

Calling the getFuotaTask operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.getFuotaTask(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: {})
    • Id — (String)

      The ID of a FUOTA task.

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:

      • Arn — (String)

        The arn of a FUOTA task.

      • Id — (String)

        The ID of a FUOTA task.

      • Status — (String)

        The status of a FUOTA task.

        Possible values include:
        • "Pending"
        • "FuotaSession_Waiting"
        • "In_FuotaSession"
        • "FuotaDone"
        • "Delete_Waiting"
      • Name — (String)

        The name of a FUOTA task.

      • Description — (String)

        The description of the new resource.

      • LoRaWAN — (map)

        The LoRaWAN information returned from getting a FUOTA task.

        • RfRegion — (String)

          The frequency band (RFRegion) value.

        • StartTime — (Date)

          Start time of a FUOTA task.

      • FirmwareUpdateImage — (String)

        The S3 URI points to a firmware update image that is to be used with a FUOTA task.

      • FirmwareUpdateRole — (String)

        The firmware update role that is to be used with a FUOTA task.

      • CreatedAt — (Date)

        Created at timestamp for the resource.

      • RedundancyPercent — (Integer)

        The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

      • FragmentSizeBytes — (Integer)

        The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

      • FragmentIntervalMS — (Integer)

        The interval for sending fragments in milliseconds, rounded to the nearest second.

        Note: This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.

Returns:

  • (AWS.Request)

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

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

Returns current default log levels or log levels by resource types. Based on resource types, log levels can be for wireless device log options or wireless gateway log options.

Service Reference:

Examples:

Calling the getLogLevelsByResourceTypes operation

var params = {
};
iotwireless.getLogLevelsByResourceTypes(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: {})

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:

      • DefaultLogLevel — (String)

        The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

        Possible values include:
        • "INFO"
        • "ERROR"
        • "DISABLED"
      • WirelessGatewayLogOptions — (Array<map>)

        The list of wireless gateway log options.

        • Typerequired — (String)

          The wireless gateway type.

          Possible values include:
          • "LoRaWAN"
        • LogLevelrequired — (String)

          The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

          Possible values include:
          • "INFO"
          • "ERROR"
          • "DISABLED"
        • Events — (Array<map>)

          The list of wireless gateway event log options.

          • Eventrequired — (String)

            The event for a log message, if the log message is tied to a wireless gateway.

            Possible values include:
            • "CUPS_Request"
            • "Certificate"
          • LogLevelrequired — (String)

            The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

            Possible values include:
            • "INFO"
            • "ERROR"
            • "DISABLED"
      • WirelessDeviceLogOptions — (Array<map>)

        The list of wireless device log options.

        • Typerequired — (String)

          The wireless device type.

          Possible values include:
          • "Sidewalk"
          • "LoRaWAN"
        • LogLevelrequired — (String)

          The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

          Possible values include:
          • "INFO"
          • "ERROR"
          • "DISABLED"
        • Events — (Array<map>)

          The list of wireless device event log options.

          • Eventrequired — (String)

            The event for a log message, if the log message is tied to a wireless device.

            Possible values include:
            • "Join"
            • "Rejoin"
            • "Uplink_Data"
            • "Downlink_Data"
            • "Registration"
          • LogLevelrequired — (String)

            The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

            Possible values include:
            • "INFO"
            • "ERROR"
            • "DISABLED"

Returns:

  • (AWS.Request)

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

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

Gets information about a multicast group.

Service Reference:

Examples:

Calling the getMulticastGroup operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.getMulticastGroup(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: {})
    • Id — (String)

      The ID of the multicast group.

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:

      • Arn — (String)

        The arn of the multicast group.

      • Id — (String)

        The ID of the multicast group.

      • Name — (String)

        The name of the multicast group.

      • Description — (String)

        The description of the new resource.

      • Status — (String)

        The status of the multicast group.

      • LoRaWAN — (map)

        The LoRaWAN information that is to be returned from getting multicast group information.

        • RfRegion — (String)

          Supported RfRegions

          Possible values include:
          • "EU868"
          • "US915"
          • "AU915"
          • "AS923-1"
          • "AS923-2"
          • "AS923-3"
          • "AS923-4"
          • "EU433"
          • "CN470"
          • "CN779"
          • "RU864"
          • "KR920"
          • "IN865"
        • DlClass — (String)

          DlClass for LoRaWAM, valid values are ClassB and ClassC.

          Possible values include:
          • "ClassB"
          • "ClassC"
        • NumberOfDevicesRequested — (Integer)

          Number of devices that are requested to be associated with the multicast group.

        • NumberOfDevicesInGroup — (Integer)

          Number of devices that are associated to the multicast group.

      • CreatedAt — (Date)

        Created at timestamp for the resource.

Returns:

  • (AWS.Request)

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

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

Gets information about a multicast group session.

Service Reference:

Examples:

Calling the getMulticastGroupSession operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.getMulticastGroupSession(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: {})
    • Id — (String)

      The ID of the multicast group.

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:

      • LoRaWAN — (map)

        The LoRaWAN information used with the multicast session.

        • DlDr — (Integer)

          Downlink data rate.

        • DlFreq — (Integer)

          Downlink frequency.

        • SessionStartTime — (Date)

          Timestamp of when the multicast group session is to start.

        • SessionTimeout — (Integer)

          How long before a multicast group session is to timeout.

        • PingSlotPeriod — (Integer)

          The PingSlotPeriod value.

Returns:

  • (AWS.Request)

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

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

Get network analyzer configuration.

Service Reference:

Examples:

Calling the getNetworkAnalyzerConfiguration operation

var params = {
  ConfigurationName: 'STRING_VALUE' /* required */
};
iotwireless.getNetworkAnalyzerConfiguration(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: {})
    • ConfigurationName — (String)

      Name of the network analyzer configuration.

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:

      • TraceContent — (map)

        Trace content for your wireless devices, gateways, and multicast groups.

        • WirelessDeviceFrameInfo — (String)

          FrameInfo of your wireless device resources for the trace content. Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
        • LogLevel — (String)

          The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

          Possible values include:
          • "INFO"
          • "ERROR"
          • "DISABLED"
        • MulticastFrameInfo — (String)

          FrameInfo of your multicast group resources for the trace content. Use FrameInfo to debug the multicast communication between your multicast groups and the network server.

          Possible values include:
          • "ENABLED"
          • "DISABLED"
      • WirelessDevices — (Array<String>)

        List of wireless device resources that have been added to the network analyzer configuration.

      • WirelessGateways — (Array<String>)

        List of wireless gateway resources that have been added to the network analyzer configuration.

      • Description — (String)

        The description of the new resource.

      • Arn — (String)

        The Amazon Resource Name of the new resource.

      • Name — (String)

        Name of the network analyzer configuration.

      • MulticastGroups — (Array<String>)

        List of multicast group resources that have been added to the network analyzer configuration.

Returns:

  • (AWS.Request)

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

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

Gets information about a partner account. If PartnerAccountId and PartnerType are null, returns all partner accounts.

Service Reference:

Examples:

Calling the getPartnerAccount operation

var params = {
  PartnerAccountId: 'STRING_VALUE', /* required */
  PartnerType: Sidewalk /* required */
};
iotwireless.getPartnerAccount(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: {})
    • PartnerAccountId — (String)

      The partner account ID to disassociate from the AWS account.

    • PartnerType — (String)

      The partner type.

      Possible values include:
      • "Sidewalk"

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:

      • Sidewalk — (map)

        The Sidewalk account credentials.

        • AmazonId — (String)

          The Sidewalk Amazon ID.

        • Fingerprint — (String)

          The fingerprint of the Sidewalk application server private key.

        • Arn — (String)

          The Amazon Resource Name of the resource.

      • AccountLinked — (Boolean)

        Whether the partner account is linked to the AWS account.

Returns:

  • (AWS.Request)

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

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

Get the position information for a given resource.

This action is no longer supported. Calls to retrieve the position information should use the GetResourcePosition API operation instead.

Service Reference:

Examples:

Calling the getPosition operation

var params = {
  ResourceIdentifier: 'STRING_VALUE', /* required */
  ResourceType: WirelessDevice | WirelessGateway /* required */
};
iotwireless.getPosition(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: {})
    • ResourceIdentifier — (String)

      Resource identifier used to retrieve the position information.

    • ResourceType — (String)

      Resource type of the resource for which position information is retrieved.

      Possible values include:
      • "WirelessDevice"
      • "WirelessGateway"

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:

      • Position — (Array<Float>)

        The position information of the resource.

      • Accuracy — (map)

        The accuracy of the estimated position in meters. An empty value indicates that no position data is available. A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information that you specified instead of the position computed by solver.

        • HorizontalAccuracy — (Float)

          The horizontal accuracy of the estimated position, which is the difference between the estimated location and the actual device location.

        • VerticalAccuracy — (Float)

          The vertical accuracy of the estimated position, which is the difference between the estimated altitude and actual device latitude in meters.

      • SolverType — (String)

        The type of solver used to identify the position of the resource.

        Possible values include:
        • "GNSS"
      • SolverProvider — (String)

        The vendor of the positioning solver.

        Possible values include:
        • "Semtech"
      • SolverVersion — (String)

        The version of the positioning solver.

      • Timestamp — (String)

        The timestamp at which the device's position was determined.

Returns:

  • (AWS.Request)

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

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

Get position configuration for a given resource.

This action is no longer supported. Calls to retrieve the position configuration should use the GetResourcePosition API operation instead.

Service Reference:

Examples:

Calling the getPositionConfiguration operation

var params = {
  ResourceIdentifier: 'STRING_VALUE', /* required */
  ResourceType: WirelessDevice | WirelessGateway /* required */
};
iotwireless.getPositionConfiguration(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: {})
    • ResourceIdentifier — (String)

      Resource identifier used in a position configuration.

    • ResourceType — (String)

      Resource type of the resource for which position configuration is retrieved.

      Possible values include:
      • "WirelessDevice"
      • "WirelessGateway"

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:

      • Solvers — (map)

        The wrapper for the solver configuration details object.

        • SemtechGnss — (map)

          The Semtech GNSS solver object details.

          • Provider — (String)

            The vendor of the solver object.

            Possible values include:
            • "Semtech"
          • Type — (String)

            The type of positioning solver used.

            Possible values include:
            • "GNSS"
          • Status — (String)

            The status indicating whether the solver is enabled.

            Possible values include:
            • "Enabled"
            • "Disabled"
          • Fec — (String)

            Whether forward error correction is enabled.

            Possible values include:
            • "ROSE"
            • "NONE"
      • Destination — (String)

        The position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

Returns:

  • (AWS.Request)

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

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

Get estimated position information as a payload in GeoJSON format. The payload measurement data is resolved using solvers that are provided by third-party vendors.

Service Reference:

Examples:

Calling the getPositionEstimate operation

var params = {
  CellTowers: {
    Cdma: [
      {
        BaseStationId: 'NUMBER_VALUE', /* required */
        NetworkId: 'NUMBER_VALUE', /* required */
        SystemId: 'NUMBER_VALUE', /* required */
        BaseLat: 'NUMBER_VALUE',
        BaseLng: 'NUMBER_VALUE',
        CdmaLocalId: {
          CdmaChannel: 'NUMBER_VALUE', /* required */
          PnOffset: 'NUMBER_VALUE' /* required */
        },
        CdmaNmr: [
          {
            CdmaChannel: 'NUMBER_VALUE', /* required */
            PnOffset: 'NUMBER_VALUE', /* required */
            BaseStationId: 'NUMBER_VALUE',
            PilotPower: 'NUMBER_VALUE'
          },
          /* more items */
        ],
        PilotPower: 'NUMBER_VALUE',
        RegistrationZone: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    Gsm: [
      {
        GeranCid: 'NUMBER_VALUE', /* required */
        Lac: 'NUMBER_VALUE', /* required */
        Mcc: 'NUMBER_VALUE', /* required */
        Mnc: 'NUMBER_VALUE', /* required */
        GsmLocalId: {
          Bcch: 'NUMBER_VALUE', /* required */
          Bsic: 'NUMBER_VALUE' /* required */
        },
        GsmNmr: [
          {
            Bcch: 'NUMBER_VALUE', /* required */
            Bsic: 'NUMBER_VALUE', /* required */
            GlobalIdentity: {
              GeranCid: 'NUMBER_VALUE', /* required */
              Lac: 'NUMBER_VALUE' /* required */
            },
            RxLevel: 'NUMBER_VALUE'
          },
          /* more items */
        ],
        GsmTimingAdvance: 'NUMBER_VALUE',
        RxLevel: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    Lte: [
      {
        EutranCid: 'NUMBER_VALUE', /* required */
        Mcc: 'NUMBER_VALUE', /* required */
        Mnc: 'NUMBER_VALUE', /* required */
        LteLocalId: {
          Earfcn: 'NUMBER_VALUE', /* required */
          Pci: 'NUMBER_VALUE' /* required */
        },
        LteNmr: [
          {
            Earfcn: 'NUMBER_VALUE', /* required */
            EutranCid: 'NUMBER_VALUE', /* required */
            Pci: 'NUMBER_VALUE', /* required */
            Rsrp: 'NUMBER_VALUE',
            Rsrq: 'NUMBER_VALUE'
          },
          /* more items */
        ],
        LteTimingAdvance: 'NUMBER_VALUE',
        NrCapable: true || false,
        Rsrp: 'NUMBER_VALUE',
        Rsrq: 'NUMBER_VALUE',
        Tac: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    Tdscdma: [
      {
        Mcc: 'NUMBER_VALUE', /* required */
        Mnc: 'NUMBER_VALUE', /* required */
        UtranCid: 'NUMBER_VALUE', /* required */
        Lac: 'NUMBER_VALUE',
        PathLoss: 'NUMBER_VALUE',
        Rscp: 'NUMBER_VALUE',
        TdscdmaLocalId: {
          CellParams: 'NUMBER_VALUE', /* required */
          Uarfcn: 'NUMBER_VALUE' /* required */
        },
        TdscdmaNmr: [
          {
            CellParams: 'NUMBER_VALUE', /* required */
            Uarfcn: 'NUMBER_VALUE', /* required */
            PathLoss: 'NUMBER_VALUE',
            Rscp: 'NUMBER_VALUE',
            UtranCid: 'NUMBER_VALUE'
          },
          /* more items */
        ],
        TdscdmaTimingAdvance: 'NUMBER_VALUE'
      },
      /* more items */
    ],
    Wcdma: [
      {
        Mcc: 'NUMBER_VALUE', /* required */
        Mnc: 'NUMBER_VALUE', /* required */
        UtranCid: 'NUMBER_VALUE', /* required */
        Lac: 'NUMBER_VALUE',
        PathLoss: 'NUMBER_VALUE',
        Rscp: 'NUMBER_VALUE',
        WcdmaLocalId: {
          Psc: 'NUMBER_VALUE', /* required */
          Uarfcndl: 'NUMBER_VALUE' /* required */
        },
        WcdmaNmr: [
          {
            Psc: 'NUMBER_VALUE', /* required */
            Uarfcndl: 'NUMBER_VALUE', /* required */
            UtranCid: 'NUMBER_VALUE', /* required */
            PathLoss: 'NUMBER_VALUE',
            Rscp: 'NUMBER_VALUE'
          },
          /* more items */
        ]
      },
      /* more items */
    ]
  },
  Gnss: {
    Payload: 'STRING_VALUE', /* required */
    AssistAltitude: 'NUMBER_VALUE',
    AssistPosition: [
      'NUMBER_VALUE',
      /* more items */
    ],
    CaptureTime: 'NUMBER_VALUE',
    CaptureTimeAccuracy: 'NUMBER_VALUE',
    Use2DSolver: true || false
  },
  Ip: {
    IpAddress: 'STRING_VALUE' /* required */
  },
  Timestamp: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
  WiFiAccessPoints: [
    {
      MacAddress: 'STRING_VALUE', /* required */
      Rss: 'NUMBER_VALUE' /* required */
    },
    /* more items */
  ]
};
iotwireless.getPositionEstimate(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: {})
    • WiFiAccessPoints — (Array<map>)

      Retrieves an estimated device position by resolving WLAN measurement data. The position is resolved using HERE's Wi-Fi based solver.

      • MacAddressrequired — (String)

        Wi-Fi MAC Address.

      • Rssrequired — (Integer)

        Received signal strength (dBm) of the WLAN measurement data.

    • CellTowers — (map)

      Retrieves an estimated device position by resolving measurement data from cellular radio towers. The position is resolved using HERE's cellular-based solver.

      • Gsm — (Array<map>)

        GSM object information.

        • Mccrequired — (Integer)

          Mobile Country Code.

        • Mncrequired — (Integer)

          Mobile Network Code.

        • Lacrequired — (Integer)

          Location area code.

        • GeranCidrequired — (Integer)

          GERAN (GSM EDGE Radio Access Network) Cell Global Identifier.

        • GsmLocalId — (map)

          GSM local identification (local ID) information.

          • Bsicrequired — (Integer)

            GSM base station identity code (BSIC).

          • Bcchrequired — (Integer)

            GSM broadcast control channel.

        • GsmTimingAdvance — (Integer)

          Timing advance value, which corresponds to the length of time a signal takes to reach the base station from a mobile phone.

        • RxLevel — (Integer)

          Rx level, which is the received signal power, measured in dBm (decibel-milliwatts).

        • GsmNmr — (Array<map>)

          GSM object for network measurement reports.

          • Bsicrequired — (Integer)

            GSM base station identity code (BSIC).

          • Bcchrequired — (Integer)

            GSM broadcast control channel.

          • RxLevel — (Integer)

            Rx level, which is the received signal power, measured in dBm (decibel-milliwatts).

          • GlobalIdentity — (map)

            Global identity information of the GSM object.

            • Lacrequired — (Integer)

              Location area code of the global identity.

            • GeranCidrequired — (Integer)

              GERAN (GSM EDGE Radio Access Network) cell global identifier.

      • Wcdma — (Array<map>)

        WCDMA object information.

        • Mccrequired — (Integer)

          Mobile Country Code.

        • Mncrequired — (Integer)

          Mobile Network Code.

        • Lac — (Integer)

          Location Area Code.

        • UtranCidrequired — (Integer)

          UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.

        • WcdmaLocalId — (map)

          WCDMA local ID information.

          • Uarfcndlrequired — (Integer)

            WCDMA UTRA Absolute RF Channel Number downlink.

          • Pscrequired — (Integer)

            Primary Scrambling Code.

        • Rscp — (Integer)

          Received Signal Code Power (signal power) (dBm).

        • PathLoss — (Integer)

          Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.

        • WcdmaNmr — (Array<map>)

          WCDMA object for network measurement reports.

          • Uarfcndlrequired — (Integer)

            WCDMA UTRA Absolute RF Channel Number downlink.

          • Pscrequired — (Integer)

            Primary Scrambling Code.

          • UtranCidrequired — (Integer)

            UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.

          • Rscp — (Integer)

            Received Signal Code Power (signal power) (dBm)

          • PathLoss — (Integer)

            Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.

      • Tdscdma — (Array<map>)

        TD-SCDMA object information.

        • Mccrequired — (Integer)

          Mobile Country Code.

        • Mncrequired — (Integer)

          Mobile Network Code.

        • Lac — (Integer)

          Location Area Code.

        • UtranCidrequired — (Integer)

          UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.

        • TdscdmaLocalId — (map)

          TD-SCDMA local identification (local ID) information.

          • Uarfcnrequired — (Integer)

            TD-SCDMA UTRA (Universal Terrestrial Radio Access Network) absolute RF channel number (UARFCN).

          • CellParamsrequired — (Integer)

            Cell parameters for TD-SCDMA.

        • TdscdmaTimingAdvance — (Integer)

          TD-SCDMA Timing advance.

        • Rscp — (Integer)

          Signal power of the received signal (Received Signal Code Power), measured in decibel-milliwatts (dBm).

        • PathLoss — (Integer)

          Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.

        • TdscdmaNmr — (Array<map>)

          TD-SCDMA object for network measurement reports.

          • Uarfcnrequired — (Integer)

            TD-SCDMA UTRA (Universal Terrestrial Radio Access Network) absolute RF channel number.

          • CellParamsrequired — (Integer)

            Cell parameters for TD-SCDMA network measurement reports object.

          • UtranCid — (Integer)

            UTRAN (UMTS Terrestrial Radio Access Network) cell global identifier.

          • Rscp — (Integer)

            Code power of the received signal, measured in decibel-milliwatts (dBm).

          • PathLoss — (Integer)

            Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.

      • Lte — (Array<map>)

        LTE object information.

        • Mccrequired — (Integer)

          Mobile Country Code.

        • Mncrequired — (Integer)

          Mobile Network Code.

        • EutranCidrequired — (Integer)

          E-UTRAN (Evolved Universal Terrestrial Radio Access Network) Cell Global Identifier.

        • Tac — (Integer)

          LTE tracking area code.

        • LteLocalId — (map)

          LTE local identification (local ID) information.

          • Pcirequired — (Integer)

            Physical cell ID.

          • Earfcnrequired — (Integer)

            Evolved universal terrestrial radio access (E-UTRA) absolute radio frequency channel number (FCN).

        • LteTimingAdvance — (Integer)

          LTE timing advance.

        • Rsrp — (Integer)

          Signal power of the reference signal received, measured in dBm (decibel-milliwatts).

        • Rsrq — (Float)

          Signal quality of the reference Signal received, measured in decibels (dB).

        • NrCapable — (Boolean)

          Parameter that determines whether the LTE object is capable of supporting NR (new radio).

        • LteNmr — (Array<map>)

          LTE object for network measurement reports.

          • Pcirequired — (Integer)

            Physical cell ID.

          • Earfcnrequired — (Integer)

            E-UTRA (Evolved universal terrestrial Radio Access) absolute radio frequency channel Number (EARFCN).

          • EutranCidrequired — (Integer)

            E-UTRAN (Evolved Universal Terrestrial Radio Access Network) cell global identifier (EUTRANCID).

          • Rsrp — (Integer)

            Signal power of the reference signal received, measured in dBm (decibel-milliwatts).

          • Rsrq — (Float)

            Signal quality of the reference Signal received, measured in decibels (dB).

      • Cdma — (Array<map>)

        CDMA object information.

        • SystemIdrequired — (Integer)

          CDMA system ID (SID).

        • NetworkIdrequired — (Integer)

          CDMA network ID (NID).

        • BaseStationIdrequired — (Integer)

          CDMA base station ID (BSID).

        • RegistrationZone — (Integer)

          CDMA registration zone (RZ).

        • CdmaLocalId — (map)

          CDMA local identification (local ID) parameters.

          • PnOffsetrequired — (Integer)

            Pseudo-noise offset, which is a characteristic of the signal from a cell on a radio tower.

          • CdmaChannelrequired — (Integer)

            CDMA channel information.

        • PilotPower — (Integer)

          Transmit power level of the pilot signal, measured in dBm (decibel-milliwatts).

        • BaseLat — (Float)

          CDMA base station latitude in degrees.

        • BaseLng — (Float)

          CDMA base station longitude in degrees.

        • CdmaNmr — (Array<map>)

          CDMA network measurement reports.

          • PnOffsetrequired — (Integer)

            Pseudo-noise offset, which is a characteristic of the signal from a cell on a radio tower.

          • CdmaChannelrequired — (Integer)

            CDMA channel information.

          • PilotPower — (Integer)

            Transmit power level of the pilot signal, measured in dBm (decibel-milliwatts).

          • BaseStationId — (Integer)

            CDMA base station ID (BSID).

    • Ip — (map)

      Retrieves an estimated device position by resolving the IP address information from the device. The position is resolved using MaxMind's IP-based solver.

      • IpAddressrequired — (String)

        IP address information.

    • Gnss — (map)

      Retrieves an estimated device position by resolving the global navigation satellite system (GNSS) scan data. The position is resolved using the GNSS solver powered by LoRa Cloud.

      • Payloadrequired — (String)

        Payload that contains the GNSS scan result, or NAV message, in hexadecimal notation.

      • CaptureTime — (Float)

        Optional parameter that gives an estimate of the time when the GNSS scan information is taken, in seconds GPS time (GPST). If capture time is not specified, the local server time is used.

      • CaptureTimeAccuracy — (Float)

        Optional value that gives the capture time estimate accuracy, in seconds. If capture time accuracy is not specified, default value of 300 is used.

      • AssistPosition — (Array<Float>)

        Optional assistance position information, specified using latitude and longitude values in degrees. The coordinates are inside the WGS84 reference frame.

      • AssistAltitude — (Float)

        Optional assistance altitude, which is the altitude of the device at capture time, specified in meters above the WGS84 reference ellipsoid.

      • Use2DSolver — (Boolean)

        Optional parameter that forces 2D solve, which modifies the positioning algorithm to a 2D solution problem. When this parameter is specified, the assistance altitude should have an accuracy of at least 10 meters.

    • Timestamp — (Date)

      Optional information that specifies the time when the position information will be resolved. It uses the Unix timestamp format. If not specified, the time at which the request was received will be used.

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:

      • GeoJsonPayload — (Buffer(Node.js), Typed Array(Browser))

        The position information of the resource, displayed as a JSON payload. The payload is of type blob and uses the GeoJSON format, which a format that's used to encode geographic data structures. A sample payload contains the timestamp information, the WGS84 coordinates of the location, and the accuracy and confidence level. For more information and examples, see Resolve device location (console).

Returns:

  • (AWS.Request)

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

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

Get the event configuration for a particular resource identifier.

Service Reference:

Examples:

Calling the getResourceEventConfiguration operation

var params = {
  Identifier: 'STRING_VALUE', /* required */
  IdentifierType: PartnerAccountId | DevEui | GatewayEui | WirelessDeviceId | WirelessGatewayId, /* required */
  PartnerType: Sidewalk
};
iotwireless.getResourceEventConfiguration(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: {})
    • Identifier — (String)

      Resource identifier to opt in for event messaging.

    • IdentifierType — (String)

      Identifier type of the particular resource identifier for event configuration.

      Possible values include:
      • "PartnerAccountId"
      • "DevEui"
      • "GatewayEui"
      • "WirelessDeviceId"
      • "WirelessGatewayId"
    • PartnerType — (String)

      Partner type of the resource if the identifier type is PartnerAccountId.

      Possible values include:
      • "Sidewalk"

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:

      • DeviceRegistrationState — (map)

        Event configuration for the device registration state event.

        • Sidewalk — (map)

          Device registration state event configuration object for enabling or disabling Sidewalk related event topics.

          • AmazonIdEventTopic — (String)

            Denotes whether the Amazon ID event topic is enabled or disabled.

            Possible values include:
            • "Enabled"
            • "Disabled"
        • WirelessDeviceIdEventTopic — (String)

          Denotes whether the wireless device ID device registration state event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
      • Proximity — (map)

        Event configuration for the proximity event.

        • Sidewalk — (map)

          Proximity event configuration object for enabling or disabling Sidewalk related event topics.

          • AmazonIdEventTopic — (String)

            Denotes whether the Amazon ID event topic is enabled or disabled.

            Possible values include:
            • "Enabled"
            • "Disabled"
        • WirelessDeviceIdEventTopic — (String)

          Denotes whether the wireless device ID proximity event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
      • Join — (map)

        Event configuration for the join event.

        • LoRaWAN — (map)

          Join event configuration object for enabling or disabling LoRaWAN related event topics.

          • DevEuiEventTopic — (String)

            Denotes whether the Dev EUI join event topic is enabled or disabled.

            Possible values include:
            • "Enabled"
            • "Disabled"
        • WirelessDeviceIdEventTopic — (String)

          Denotes whether the wireless device ID join event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
      • ConnectionStatus — (map)

        Event configuration for the connection status event.

        • LoRaWAN — (map)

          Connection status event configuration object for enabling or disabling LoRaWAN related event topics.

          • GatewayEuiEventTopic — (String)

            Denotes whether the gateway EUI connection status event topic is enabled or disabled.

            Possible values include:
            • "Enabled"
            • "Disabled"
        • WirelessGatewayIdEventTopic — (String)

          Denotes whether the wireless gateway ID connection status event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
      • MessageDeliveryStatus — (map)

        Event configuration for the message delivery status event.

        • Sidewalk — (map)

          SidewalkEventNotificationConfigurations object, which is the event configuration object for Sidewalk-related event topics.

          • AmazonIdEventTopic — (String)

            Denotes whether the Amazon ID event topic is enabled or disabled.

            Possible values include:
            • "Enabled"
            • "Disabled"
        • WirelessDeviceIdEventTopic — (String)

          Denotes whether the wireless device ID message delivery status event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "Disabled"

Returns:

  • (AWS.Request)

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

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

Fetches the log-level override, if any, for a given resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.

Service Reference:

Examples:

Calling the getResourceLogLevel operation

var params = {
  ResourceIdentifier: 'STRING_VALUE', /* required */
  ResourceType: 'STRING_VALUE' /* required */
};
iotwireless.getResourceLogLevel(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: {})
    • ResourceIdentifier — (String)

      The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.

    • ResourceType — (String)

      The type of the resource, which can be WirelessDevice or WirelessGateway.

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:

      • LogLevel — (String)

        The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

        Possible values include:
        • "INFO"
        • "ERROR"
        • "DISABLED"

Returns:

  • (AWS.Request)

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

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

Get the position information for a given wireless device or a wireless gateway resource. The position information uses the World Geodetic System (WGS84).

Service Reference:

Examples:

Calling the getResourcePosition operation

var params = {
  ResourceIdentifier: 'STRING_VALUE', /* required */
  ResourceType: WirelessDevice | WirelessGateway /* required */
};
iotwireless.getResourcePosition(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: {})
    • ResourceIdentifier — (String)

      The identifier of the resource for which position information is retrieved. It can be the wireless device ID or the wireless gateway ID, depending on the resource type.

    • ResourceType — (String)

      The type of resource for which position information is retrieved, which can be a wireless device or a wireless gateway.

      Possible values include:
      • "WirelessDevice"
      • "WirelessGateway"

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:

      • GeoJsonPayload — (Buffer(Node.js), Typed Array(Browser))

        The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that's used to encode geographic data structures. For more information, see GeoJSON.

Returns:

  • (AWS.Request)

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

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

Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.

Service Reference:

Examples:

Calling the getServiceEndpoint operation

var params = {
  ServiceType: CUPS | LNS
};
iotwireless.getServiceEndpoint(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: {})
    • ServiceType — (String)

      The service type for which to get endpoint information about. Can be CUPS for the Configuration and Update Server endpoint, or LNS for the LoRaWAN Network Server endpoint or CLAIM for the global endpoint.

      Possible values include:
      • "CUPS"
      • "LNS"

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:

      • ServiceType — (String)

        The endpoint's service type.

        Possible values include:
        • "CUPS"
        • "LNS"
      • ServiceEndpoint — (String)

        The service endpoint value.

      • ServerTrust — (String)

        The Root CA of the server trust certificate.

Returns:

  • (AWS.Request)

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

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

Gets information about a service profile.

Service Reference:

Examples:

Calling the getServiceProfile operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.getServiceProfile(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: {})
    • Id — (String)

      The ID of the resource to get.

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:

      • Arn — (String)

        The Amazon Resource Name of the resource.

      • Name — (String)

        The name of the resource.

      • Id — (String)

        The ID of the service profile.

      • LoRaWAN — (map)

        Information about the service profile.

        • UlRate — (Integer)

          The ULRate value.

        • UlBucketSize — (Integer)

          The ULBucketSize value.

        • UlRatePolicy — (String)

          The ULRatePolicy value.

        • DlRate — (Integer)

          The DLRate value.

        • DlBucketSize — (Integer)

          The DLBucketSize value.

        • DlRatePolicy — (String)

          The DLRatePolicy value.

        • AddGwMetadata — (Boolean)

          The AddGWMetaData value.

        • DevStatusReqFreq — (Integer)

          The DevStatusReqFreq value.

        • ReportDevStatusBattery — (Boolean)

          The ReportDevStatusBattery value.

        • ReportDevStatusMargin — (Boolean)

          The ReportDevStatusMargin value.

        • DrMin — (Integer)

          The DRMin value.

        • DrMax — (Integer)

          The DRMax value.

        • ChannelMask — (String)

          The ChannelMask value.

        • PrAllowed — (Boolean)

          The PRAllowed value that describes whether passive roaming is allowed.

        • HrAllowed — (Boolean)

          The HRAllowed value that describes whether handover roaming is allowed.

        • RaAllowed — (Boolean)

          The RAAllowed value that describes whether roaming activation is allowed.

        • NwkGeoLoc — (Boolean)

          The NwkGeoLoc value.

        • TargetPer — (Integer)

          The TargetPER value.

        • MinGwDiversity — (Integer)

          The MinGwDiversity value.

Returns:

  • (AWS.Request)

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

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

Gets information about a wireless device.

Service Reference:

Examples:

Calling the getWirelessDevice operation

var params = {
  Identifier: 'STRING_VALUE', /* required */
  IdentifierType: WirelessDeviceId | DevEui | ThingName | SidewalkManufacturingSn /* required */
};
iotwireless.getWirelessDevice(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: {})
    • Identifier — (String)

      The identifier of the wireless device to get.

    • IdentifierType — (String)

      The type of identifier used in identifier.

      Possible values include:
      • "WirelessDeviceId"
      • "DevEui"
      • "ThingName"
      • "SidewalkManufacturingSn"

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:

      • Type — (String)

        The wireless device type.

        Possible values include:
        • "Sidewalk"
        • "LoRaWAN"
      • Name — (String)

        The name of the resource.

      • Description — (String)

        The description of the resource.

      • DestinationName — (String)

        The name of the destination to which the device is assigned.

      • Id — (String)

        The ID of the wireless device.

      • Arn — (String)

        The Amazon Resource Name of the resource.

      • ThingName — (String)

        The name of the thing associated with the wireless device. The value is empty if a thing isn't associated with the device.

      • ThingArn — (String)

        The ARN of the thing associated with the wireless device.

      • LoRaWAN — (map)

        Information about the wireless device.

        • DevEui — (String)

          The DevEUI value.

        • DeviceProfileId — (String)

          The ID of the device profile for the new wireless device.

        • ServiceProfileId — (String)

          The ID of the service profile.

        • OtaaV1_1 — (map)

          OTAA device object for v1.1 for create APIs

          • AppKey — (String)

            The AppKey value.

          • NwkKey — (String)

            The NwkKey value.

          • JoinEui — (String)

            The JoinEUI value.

        • OtaaV1_0_x — (map)

          OTAA device object for create APIs for v1.0.x

          • AppKey — (String)

            The AppKey value.

          • AppEui — (String)

            The AppEUI value.

          • JoinEui — (String)

            The JoinEUI value.

          • GenAppKey — (String)

            The GenAppKey value.

        • AbpV1_1 — (map)

          ABP device object for create APIs for v1.1

          • DevAddr — (String)

            The DevAddr value.

          • SessionKeys — (map)

            Session keys for ABP v1.1

            • FNwkSIntKey — (String)

              The FNwkSIntKey value.

            • SNwkSIntKey — (String)

              The SNwkSIntKey value.

            • NwkSEncKey — (String)

              The NwkSEncKey value.

            • AppSKey — (String)

              The AppSKey value.

          • FCntStart — (Integer)

            The FCnt init value.

        • AbpV1_0_x — (map)

          LoRaWAN object for create APIs

          • DevAddr — (String)

            The DevAddr value.

          • SessionKeys — (map)

            Session keys for ABP v1.0.x

            • NwkSKey — (String)

              The NwkSKey value.

            • AppSKey — (String)

              The AppSKey value.

          • FCntStart — (Integer)

            The FCnt init value.

        • FPorts — (map)

          List of FPort assigned for different LoRaWAN application packages to use

          • Fuota — (Integer)

            The Fport value.

          • Multicast — (Integer)

            The Fport value.

          • ClockSync — (Integer)

            The Fport value.

          • Positioning — (map)

            FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

            • ClockSync — (Integer)

              The Fport value.

            • Stream — (Integer)

              The Fport value.

            • Gnss — (Integer)

              The Fport value.

          • Applications — (Array<map>)

            Optional LoRaWAN application information, which can be used for geolocation.

            • FPort — (Integer)

              The Fport value.

            • Type — (String)

              Application type, which can be specified to obtain real-time position information of your LoRaWAN device.

              Possible values include:
              • "SemtechGeolocation"
            • DestinationName — (String)

              The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

      • Sidewalk — (map)

        Sidewalk device object.

        • AmazonId — (String)

          The Sidewalk Amazon ID.

        • SidewalkId — (String)

          The sidewalk device identification.

        • SidewalkManufacturingSn — (String)

          The Sidewalk manufacturing series number.

        • DeviceCertificates — (Array<map>)

          The sidewalk device certificates for Ed25519 and P256r1.

          • SigningAlgrequired — (String)

            The certificate chain algorithm provided by sidewalk.

            Possible values include:
            • "Ed25519"
            • "P256r1"
          • Valuerequired — (String)

            The value of the chosen sidewalk certificate.

        • PrivateKeys — (Array<map>)

          The Sidewalk device private keys that will be used for onboarding the device.

          • SigningAlgrequired — (String)

            The certificate chain algorithm provided by sidewalk.

            Possible values include:
            • "Ed25519"
            • "P256r1"
          • Valuerequired — (String)

            The value of the chosen sidewalk certificate.

        • DeviceProfileId — (String)

          The ID of the Sidewalk device profile.

        • CertificateId — (String)

          The ID of the Sidewalk device profile.

        • Status — (String)

          The Sidewalk device status, such as provisioned or registered.

          Possible values include:
          • "PROVISIONED"
          • "REGISTERED"
          • "ACTIVATED"
          • "UNKNOWN"
      • Positioning — (String)

        FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

        Possible values include:
        • "Enabled"
        • "Disabled"

Returns:

  • (AWS.Request)

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

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

Get information about an import task and count of device onboarding summary information for the import task.

Service Reference:

Examples:

Calling the getWirelessDeviceImportTask operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.getWirelessDeviceImportTask(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: {})
    • Id — (String)

      The identifier of the import task for which information is requested.

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:

      • Id — (String)

        The identifier of the import task for which information is retrieved.

      • Arn — (String)

        The ARN (Amazon Resource Name) of the import task.

      • DestinationName — (String)

        The name of the destination that's assigned to the wireless devices in the import task.

      • Sidewalk — (map)

        The Sidewalk-related information about an import task.

        • DeviceCreationFileList — (Array<String>)

          List of Sidewalk devices that are added to the import task.

        • Role — (String)

          The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.

      • CreationTime — (Date)

        The time at which the import task was created.

      • Status — (String)

        The import task status.

        Possible values include:
        • "INITIALIZING"
        • "INITIALIZED"
        • "PENDING"
        • "COMPLETE"
        • "FAILED"
        • "DELETING"
      • StatusReason — (String)

        The reason for the provided status information, such as a validation error that causes the import task to fail.

      • InitializedImportedDeviceCount — (Integer)

        The number of devices in the import task that are waiting for the control log to start processing.

      • PendingImportedDeviceCount — (Integer)

        The number of devices in the import task that are waiting in the import task queue to be onboarded.

      • OnboardedImportedDeviceCount — (Integer)

        The number of devices in the import task that have been onboarded to the import task.

      • FailedImportedDeviceCount — (Integer)

        The number of devices in the import task that failed to onboard to the import task.

Returns:

  • (AWS.Request)

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

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

Gets operating information about a wireless device.

Service Reference:

Examples:

Calling the getWirelessDeviceStatistics operation

var params = {
  WirelessDeviceId: 'STRING_VALUE' /* required */
};
iotwireless.getWirelessDeviceStatistics(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: {})
    • WirelessDeviceId — (String)

      The ID of the wireless device for which to get the data.

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:

      • WirelessDeviceId — (String)

        The ID of the wireless device.

      • LastUplinkReceivedAt — (String)

        The date and time when the most recent uplink was received.

        Note: This value is only valid for 3 months.
      • LoRaWAN — (map)

        Information about the wireless device's operations.

        • DevEui — (String)

          The DevEUI value.

        • FPort — (Integer)

          The FPort value.

        • DataRate — (Integer)

          The DataRate value.

        • Frequency — (Integer)

          The device's channel frequency in Hz.

        • Timestamp — (String)

          The date and time of the metadata.

        • Gateways — (Array<map>)

          Information about the gateways accessed by the device.

          • GatewayEui — (String)

            The gateway's EUI value.

          • Snr — (Float)

            The SNR value.

          • Rssi — (Float)

            The RSSI value.

      • Sidewalk — (map)

        MetaData for Sidewalk device.

        • Rssi — (Integer)

          The RSSI value.

        • BatteryLevel — (String)

          Sidewalk device battery level.

          Possible values include:
          • "normal"
          • "low"
          • "critical"
        • Event — (String)

          Sidewalk device status notification.

          Possible values include:
          • "discovered"
          • "lost"
          • "ack"
          • "nack"
          • "passthrough"
        • DeviceState — (String)

          Device state defines the device status of sidewalk device.

          Possible values include:
          • "Provisioned"
          • "RegisteredNotSeen"
          • "RegisteredReachable"
          • "RegisteredUnreachable"

Returns:

  • (AWS.Request)

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

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

Gets information about a wireless gateway.

Service Reference:

Examples:

Calling the getWirelessGateway operation

var params = {
  Identifier: 'STRING_VALUE', /* required */
  IdentifierType: GatewayEui | WirelessGatewayId | ThingName /* required */
};
iotwireless.getWirelessGateway(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: {})
    • Identifier — (String)

      The identifier of the wireless gateway to get.

    • IdentifierType — (String)

      The type of identifier used in identifier.

      Possible values include:
      • "GatewayEui"
      • "WirelessGatewayId"
      • "ThingName"

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:

      • Name — (String)

        The name of the resource.

      • Id — (String)

        The ID of the wireless gateway.

      • Description — (String)

        The description of the resource.

      • LoRaWAN — (map)

        Information about the wireless gateway.

        • GatewayEui — (String)

          The gateway's EUI value.

        • RfRegion — (String)

          The frequency band (RFRegion) value.

        • JoinEuiFilters — (Array<Array<String>>)

          A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.

        • NetIdFilters — (Array<String>)

          A list of NetId values that are used by LoRa gateways to filter the uplink frames.

        • SubBands — (Array<Integer>)

          A list of integer indicating which sub bands are supported by LoRa gateway.

        • Beaconing — (map)

          Beaconing object information, which consists of the data rate and frequency parameters.

          • DataRate — (Integer)

            The data rate for gateways that are sending the beacons.

          • Frequencies — (Array<Integer>)

            The frequency list for the gateways to send the beacons.

        • MaxEirp — (Float)

          The MaxEIRP value.

      • Arn — (String)

        The Amazon Resource Name of the resource.

      • ThingName — (String)

        The name of the thing associated with the wireless gateway. The value is empty if a thing isn't associated with the gateway.

      • ThingArn — (String)

        The ARN of the thing associated with the wireless gateway.

Returns:

  • (AWS.Request)

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

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

Gets the ID of the certificate that is currently associated with a wireless gateway.

Service Reference:

Examples:

Calling the getWirelessGatewayCertificate operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.getWirelessGatewayCertificate(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: {})
    • Id — (String)

      The ID of the resource to get.

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:

      • IotCertificateId — (String)

        The ID of the certificate associated with the wireless gateway.

      • LoRaWANNetworkServerCertificateId — (String)

        The ID of the certificate that is associated with the wireless gateway and used for the LoRaWANNetworkServer endpoint.

Returns:

  • (AWS.Request)

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

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

Gets the firmware version and other information about a wireless gateway.

Examples:

Calling the getWirelessGatewayFirmwareInformation operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.getWirelessGatewayFirmwareInformation(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: {})
    • Id — (String)

      The ID of the resource to get.

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:

      • LoRaWAN — (map)

        Information about the wireless gateway's firmware.

        • CurrentVersion — (map)

          The version of the gateways that should receive the update.

          • PackageVersion — (String)

            The version of the wireless gateway firmware.

          • Model — (String)

            The model number of the wireless gateway.

          • Station — (String)

            The basic station version of the wireless gateway.

Returns:

  • (AWS.Request)

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

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

Gets operating information about a wireless gateway.

Service Reference:

Examples:

Calling the getWirelessGatewayStatistics operation

var params = {
  WirelessGatewayId: 'STRING_VALUE' /* required */
};
iotwireless.getWirelessGatewayStatistics(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: {})
    • WirelessGatewayId — (String)

      The ID of the wireless gateway for which to get the data.

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:

      • WirelessGatewayId — (String)

        The ID of the wireless gateway.

      • LastUplinkReceivedAt — (String)

        The date and time when the most recent uplink was received.

        Note: This value is only valid for 3 months.
      • ConnectionStatus — (String)

        The connection status of the wireless gateway.

        Possible values include:
        • "Connected"
        • "Disconnected"

Returns:

  • (AWS.Request)

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

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

Gets information about a wireless gateway task.

Service Reference:

Examples:

Calling the getWirelessGatewayTask operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.getWirelessGatewayTask(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: {})
    • Id — (String)

      The ID of the resource to get.

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:

      • WirelessGatewayId — (String)

        The ID of the wireless gateway.

      • WirelessGatewayTaskDefinitionId — (String)

        The ID of the WirelessGatewayTask.

      • LastUplinkReceivedAt — (String)

        The date and time when the most recent uplink was received.

        Note: This value is only valid for 3 months.
      • TaskCreatedAt — (String)

        The date and time when the task was created.

      • Status — (String)

        The status of the request.

        Possible values include:
        • "PENDING"
        • "IN_PROGRESS"
        • "FIRST_RETRY"
        • "SECOND_RETRY"
        • "COMPLETED"
        • "FAILED"

Returns:

  • (AWS.Request)

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

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

Gets information about a wireless gateway task definition.

Examples:

Calling the getWirelessGatewayTaskDefinition operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.getWirelessGatewayTaskDefinition(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: {})
    • Id — (String)

      The ID of the resource to get.

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:

      • AutoCreateTasks — (Boolean)

        Whether to automatically create tasks using this task definition for all gateways with the specified current version. If false, the task must me created by calling CreateWirelessGatewayTask.

      • Name — (String)

        The name of the resource.

      • Update — (map)

        Information about the gateways to update.

        • UpdateDataSource — (String)

          The link to the S3 bucket.

        • UpdateDataRole — (String)

          The IAM role used to read data from the S3 bucket.

        • LoRaWAN — (map)

          The properties that relate to the LoRaWAN wireless gateway.

          • UpdateSignature — (String)

            The signature used to verify the update firmware.

          • SigKeyCrc — (Integer)

            The CRC of the signature private key to check.

          • CurrentVersion — (map)

            The version of the gateways that should receive the update.

            • PackageVersion — (String)

              The version of the wireless gateway firmware.

            • Model — (String)

              The model number of the wireless gateway.

            • Station — (String)

              The basic station version of the wireless gateway.

          • UpdateVersion — (map)

            The firmware version to update the gateway to.

            • PackageVersion — (String)

              The version of the wireless gateway firmware.

            • Model — (String)

              The model number of the wireless gateway.

            • Station — (String)

              The basic station version of the wireless gateway.

      • Arn — (String)

        The Amazon Resource Name of the resource.

Returns:

  • (AWS.Request)

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

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

Lists the destinations registered to your AWS account.

Service Reference:

Examples:

Calling the listDestinations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
iotwireless.listDestinations(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: {})
    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first 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:

      • NextToken — (String)

        The token to use to get the next set of results, or null if there are no additional results.

      • DestinationList — (Array<map>)

        The list of destinations.

        • Arn — (String)

          The Amazon Resource Name of the resource.

        • Name — (String)

          The name of the resource.

        • ExpressionType — (String)

          The type of value in Expression.

          Possible values include:
          • "RuleName"
          • "MqttTopic"
        • Expression — (String)

          The rule name or topic rule to send messages to.

        • Description — (String)

          The description of the resource.

        • RoleArn — (String)

          The ARN of the IAM Role that authorizes the destination.

Returns:

  • (AWS.Request)

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

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

Lists the device profiles registered to your AWS account.

Service Reference:

Examples:

Calling the listDeviceProfiles operation

var params = {
  DeviceProfileType: Sidewalk | LoRaWAN,
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
iotwireless.listDeviceProfiles(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: {})
    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

    • DeviceProfileType — (String)

      A filter to list only device profiles that use this type, which can be LoRaWAN or Sidewalk.

      Possible values include:
      • "Sidewalk"
      • "LoRaWAN"

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:

      • NextToken — (String)

        The token to use to get the next set of results, or null if there are no additional results.

      • DeviceProfileList — (Array<map>)

        The list of device profiles.

        • Arn — (String)

          The Amazon Resource Name of the resource.

        • Name — (String)

          The name of the resource.

        • Id — (String)

          The ID of the device profile.

Returns:

  • (AWS.Request)

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

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

List the Sidewalk devices in an import task and their onboarding status.

Examples:

Calling the listDevicesForWirelessDeviceImportTask operation

var params = {
  Id: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  Status: INITIALIZED | PENDING | ONBOARDED | FAILED
};
iotwireless.listDevicesForWirelessDeviceImportTask(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: {})
    • Id — (String)

      The identifier of the import task for which wireless devices are listed.

    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • Status — (String)

      The status of the devices in the import task.

      Possible values include:
      • "INITIALIZED"
      • "PENDING"
      • "ONBOARDED"
      • "FAILED"

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:

      • NextToken — (String)

        The token to use to get the next set of results, or null if there are no additional results.

      • DestinationName — (String)

        The name of the Sidewalk destination that describes the IoT rule to route messages received from devices in an import task that are onboarded to AWS IoT Wireless.

      • ImportedWirelessDeviceList — (Array<map>)

        List of wireless devices in an import task and their onboarding status.

        • Sidewalk — (map)

          The Sidewalk-related information about a device that has been added to an import task.

          • SidewalkManufacturingSn — (String)

            The Sidewalk manufacturing serial number (SMSN) of the Sidewalk device.

          • OnboardingStatus — (String)

            The onboarding status of the Sidewalk device in the import task.

            Possible values include:
            • "INITIALIZED"
            • "PENDING"
            • "ONBOARDED"
            • "FAILED"
          • OnboardingStatusReason — (String)

            The reason for the onboarding status information for the Sidewalk device.

          • LastUpdateTime — (Date)

            The time at which the status information was last updated.

Returns:

  • (AWS.Request)

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

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

List event configurations where at least one event topic has been enabled.

Service Reference:

Examples:

Calling the listEventConfigurations operation

var params = {
  ResourceType: SidewalkAccount | WirelessDevice | WirelessGateway, /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
iotwireless.listEventConfigurations(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: {})
    • ResourceType — (String)

      Resource type to filter event configurations.

      Possible values include:
      • "SidewalkAccount"
      • "WirelessDevice"
      • "WirelessGateway"
    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first 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:

      • NextToken — (String)

        To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

      • EventConfigurationsList — (Array<map>)

        Event configurations of all events for a single resource.

        • Identifier — (String)

          Resource identifier opted in for event messaging.

        • IdentifierType — (String)

          Identifier type of the particular resource identifier for event configuration.

          Possible values include:
          • "PartnerAccountId"
          • "DevEui"
          • "GatewayEui"
          • "WirelessDeviceId"
          • "WirelessGatewayId"
        • PartnerType — (String)

          Partner type of the resource if the identifier type is PartnerAccountId.

          Possible values include:
          • "Sidewalk"
        • Events — (map)

          Object of all event configurations and the status of the event topics.

          • DeviceRegistrationState — (map)

            Device registration state event configuration for an event configuration item.

            • Sidewalk — (map)

              Device registration state event configuration object for enabling or disabling Sidewalk related event topics.

              • AmazonIdEventTopic — (String)

                Denotes whether the Amazon ID event topic is enabled or disabled.

                Possible values include:
                • "Enabled"
                • "Disabled"
            • WirelessDeviceIdEventTopic — (String)

              Denotes whether the wireless device ID device registration state event topic is enabled or disabled.

              Possible values include:
              • "Enabled"
              • "Disabled"
          • Proximity — (map)

            Proximity event configuration for an event configuration item.

            • Sidewalk — (map)

              Proximity event configuration object for enabling or disabling Sidewalk related event topics.

              • AmazonIdEventTopic — (String)

                Denotes whether the Amazon ID event topic is enabled or disabled.

                Possible values include:
                • "Enabled"
                • "Disabled"
            • WirelessDeviceIdEventTopic — (String)

              Denotes whether the wireless device ID proximity event topic is enabled or disabled.

              Possible values include:
              • "Enabled"
              • "Disabled"
          • Join — (map)

            Join event configuration for an event configuration item.

            • LoRaWAN — (map)

              Join event configuration object for enabling or disabling LoRaWAN related event topics.

              • DevEuiEventTopic — (String)

                Denotes whether the Dev EUI join event topic is enabled or disabled.

                Possible values include:
                • "Enabled"
                • "Disabled"
            • WirelessDeviceIdEventTopic — (String)

              Denotes whether the wireless device ID join event topic is enabled or disabled.

              Possible values include:
              • "Enabled"
              • "Disabled"
          • ConnectionStatus — (map)

            Connection status event configuration for an event configuration item.

            • LoRaWAN — (map)

              Connection status event configuration object for enabling or disabling LoRaWAN related event topics.

              • GatewayEuiEventTopic — (String)

                Denotes whether the gateway EUI connection status event topic is enabled or disabled.

                Possible values include:
                • "Enabled"
                • "Disabled"
            • WirelessGatewayIdEventTopic — (String)

              Denotes whether the wireless gateway ID connection status event topic is enabled or disabled.

              Possible values include:
              • "Enabled"
              • "Disabled"
          • MessageDeliveryStatus — (map)

            Message delivery status event configuration for an event configuration item.

            • Sidewalk — (map)

              SidewalkEventNotificationConfigurations object, which is the event configuration object for Sidewalk-related event topics.

              • AmazonIdEventTopic — (String)

                Denotes whether the Amazon ID event topic is enabled or disabled.

                Possible values include:
                • "Enabled"
                • "Disabled"
            • WirelessDeviceIdEventTopic — (String)

              Denotes whether the wireless device ID message delivery status event topic is enabled or disabled.

              Possible values include:
              • "Enabled"
              • "Disabled"

Returns:

  • (AWS.Request)

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

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

Lists the FUOTA tasks registered to your AWS account.

Service Reference:

Examples:

Calling the listFuotaTasks operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
iotwireless.listFuotaTasks(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: {})
    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

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:

      • NextToken — (String)

        To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

      • FuotaTaskList — (Array<map>)

        Lists the FUOTA tasks registered to your AWS account.

        • Id — (String)

          The ID of a FUOTA task.

        • Arn — (String)

          The arn of a FUOTA task.

        • Name — (String)

          The name of a FUOTA task.

Returns:

  • (AWS.Request)

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

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

Lists the multicast groups registered to your AWS account.

Service Reference:

Examples:

Calling the listMulticastGroups operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
iotwireless.listMulticastGroups(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: {})
    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

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:

      • NextToken — (String)

        To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

      • MulticastGroupList — (Array<map>)

        List of multicast groups.

        • Id — (String)

          The ID of the multicast group.

        • Arn — (String)

          The arn of the multicast group.

        • Name — (String)

          The name of the multicast group.

Returns:

  • (AWS.Request)

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

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

List all multicast groups associated with a fuota task.

Service Reference:

Examples:

Calling the listMulticastGroupsByFuotaTask operation

var params = {
  Id: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
iotwireless.listMulticastGroupsByFuotaTask(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: {})
    • Id — (String)

      The ID of a FUOTA task.

    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

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:

      • NextToken — (String)

        To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

      • MulticastGroupList — (Array<map>)

        List of multicast groups associated with a FUOTA task.

        • Id — (String)

          The ID of the multicast group.

Returns:

  • (AWS.Request)

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

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

Lists the network analyzer configurations.

Examples:

Calling the listNetworkAnalyzerConfigurations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
iotwireless.listNetworkAnalyzerConfigurations(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: {})
    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first 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:

      • NextToken — (String)

        The token to use to get the next set of results, or null if there are no additional results.

      • NetworkAnalyzerConfigurationList — (Array<map>)

        The list of network analyzer configurations.

        • Arn — (String)

          The Amazon Resource Name of the new resource.

        • Name — (String)

          Name of the network analyzer configuration.

Returns:

  • (AWS.Request)

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

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

Lists the partner accounts associated with your AWS account.

Service Reference:

Examples:

Calling the listPartnerAccounts operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
iotwireless.listPartnerAccounts(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: {})
    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

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:

      • NextToken — (String)

        The token to use to get the next set of results, or null if there are no additional results.

      • Sidewalk — (Array<map>)

        The Sidewalk account credentials.

        • AmazonId — (String)

          The Sidewalk Amazon ID.

        • Fingerprint — (String)

          The fingerprint of the Sidewalk application server private key.

        • Arn — (String)

          The Amazon Resource Name of the resource.

Returns:

  • (AWS.Request)

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

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

List position configurations for a given resource, such as positioning solvers.

This action is no longer supported. Calls to retrieve position information should use the GetResourcePosition API operation instead.

Service Reference:

Examples:

Calling the listPositionConfigurations operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  ResourceType: WirelessDevice | WirelessGateway
};
iotwireless.listPositionConfigurations(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: {})
    • ResourceType — (String)

      Resource type for which position configurations are listed.

      Possible values include:
      • "WirelessDevice"
      • "WirelessGateway"
    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first 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:

      • PositionConfigurationList — (Array<map>)

        A list of position configurations.

        • ResourceIdentifier — (String)

          Resource identifier for the position configuration.

        • ResourceType — (String)

          Resource type of the resource for the position configuration.

          Possible values include:
          • "WirelessDevice"
          • "WirelessGateway"
        • Solvers — (map)

          The details of the positioning solver object used to compute the location.

          • SemtechGnss — (map)

            The Semtech GNSS solver object details.

            • Provider — (String)

              The vendor of the solver object.

              Possible values include:
              • "Semtech"
            • Type — (String)

              The type of positioning solver used.

              Possible values include:
              • "GNSS"
            • Status — (String)

              The status indicating whether the solver is enabled.

              Possible values include:
              • "Enabled"
              • "Disabled"
            • Fec — (String)

              Whether forward error correction is enabled.

              Possible values include:
              • "ROSE"
              • "NONE"
        • Destination — (String)

          The position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

      • NextToken — (String)

        The token to use to get the next set of results, or null if there are no additional results.

Returns:

  • (AWS.Request)

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

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

List queued messages in the downlink queue.

Service Reference:

Examples:

Calling the listQueuedMessages operation

var params = {
  Id: 'STRING_VALUE', /* required */
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  WirelessDeviceType: Sidewalk | LoRaWAN
};
iotwireless.listQueuedMessages(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: {})
    • Id — (String)

      The ID of a given wireless device which the downlink message packets are being sent.

    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

    • WirelessDeviceType — (String)

      The wireless device type, whic can be either Sidewalk or LoRaWAN.

      Possible values include:
      • "Sidewalk"
      • "LoRaWAN"

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:

      • NextToken — (String)

        To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

      • DownlinkQueueMessagesList — (Array<map>)

        The messages in the downlink queue.

        • MessageId — (String)

          The message ID assigned by IoT Wireless to each downlink message, which helps identify the message.

        • TransmitMode — (Integer)

          The transmit mode to use for sending data to the wireless device. This can be 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

        • ReceivedAt — (String)

          The time at which Iot Wireless received the downlink message.

        • LoRaWAN — (map)

          LoRaWAN router info.

          • FPort — (Integer)

            The Fport value.

          • ParticipatingGateways — (map)

            Choose the gateways that you want to use for the downlink data traffic when the wireless device is running in class B or class C mode.

            • DownlinkModerequired — (String)

              Indicates whether to send the downlink message in sequential mode or concurrent mode, or to use only the chosen gateways from the previous uplink message transmission.

              Possible values include:
              • "SEQUENTIAL"
              • "CONCURRENT"
              • "USING_UPLINK_GATEWAY"
            • GatewayListrequired — (Array<map>)

              The list of gateways that you want to use for sending the downlink data traffic.

              • GatewayIdrequired — (String)

                The ID of the wireless gateways that you want to add to the list of gateways when sending downlink messages.

              • DownlinkFrequencyrequired — (Integer)

                The frequency to use for the gateways when sending a downlink message to the wireless device.

            • TransmissionIntervalrequired — (Integer)

              The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the payload to the next gateway.

Returns:

  • (AWS.Request)

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

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

Lists the service profiles registered to your AWS account.

Service Reference:

Examples:

Calling the listServiceProfiles operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
iotwireless.listServiceProfiles(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: {})
    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

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:

      • NextToken — (String)

        The token to use to get the next set of results, or null if there are no additional results.

      • ServiceProfileList — (Array<map>)

        The list of service profiles.

        • Arn — (String)

          The Amazon Resource Name of the resource.

        • Name — (String)

          The name of the resource.

        • Id — (String)

          The ID of the service profile.

Returns:

  • (AWS.Request)

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

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

Lists the tags (metadata) you have assigned to the resource.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
iotwireless.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 for which you want to list tags.

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 — (Array<map>)

        The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.

        • Keyrequired — (String)

          The tag's key value.

        • Valuerequired — (String)

          The tag's value.

Returns:

  • (AWS.Request)

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

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

List wireless devices that have been added to an import task.

Service Reference:

Examples:

Calling the listWirelessDeviceImportTasks operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
iotwireless.listWirelessDeviceImportTasks(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: {})
    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first 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:

      • NextToken — (String)

        The token to use to get the next set of results, or null if there are no additional results.

      • WirelessDeviceImportTaskList — (Array<map>)

        List of import tasks and summary information of onboarding status of devices in each import task.

        • Id — (String)

          The ID of the wireless device import task.

        • Arn — (String)

          The ARN (Amazon Resource Name) of the wireless device import task.

        • DestinationName — (String)

          The name of the Sidewalk destination that that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless

        • Sidewalk — (map)

          The Sidewalk-related information of the wireless device import task.

          • DeviceCreationFileList — (Array<String>)

            List of Sidewalk devices that are added to the import task.

          • Role — (String)

            The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.

        • CreationTime — (Date)

          The time at which the import task was created.

        • Status — (String)

          The status information of the wireless device import task.

          Possible values include:
          • "INITIALIZING"
          • "INITIALIZED"
          • "PENDING"
          • "COMPLETE"
          • "FAILED"
          • "DELETING"
        • StatusReason — (String)

          The reason that provides additional information about the import task status.

        • InitializedImportedDeviceCount — (Integer)

          The summary information of count of wireless devices that are waiting for the control log to be added to an import task.

        • PendingImportedDeviceCount — (Integer)

          The summary information of count of wireless devices in an import task that are waiting in the queue to be onboarded.

        • OnboardedImportedDeviceCount — (Integer)

          The summary information of count of wireless devices in an import task that have been onboarded to the import task.

        • FailedImportedDeviceCount — (Integer)

          The summary information of count of wireless devices in an import task that failed to onboarded to the import task.

Returns:

  • (AWS.Request)

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

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

Lists the wireless devices registered to your AWS account.

Service Reference:

Examples:

Calling the listWirelessDevices operation

var params = {
  DestinationName: 'STRING_VALUE',
  DeviceProfileId: 'STRING_VALUE',
  FuotaTaskId: 'STRING_VALUE',
  MaxResults: 'NUMBER_VALUE',
  MulticastGroupId: 'STRING_VALUE',
  NextToken: 'STRING_VALUE',
  ServiceProfileId: 'STRING_VALUE',
  WirelessDeviceType: Sidewalk | LoRaWAN
};
iotwireless.listWirelessDevices(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: {})
    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • DestinationName — (String)

      A filter to list only the wireless devices that use this destination.

    • DeviceProfileId — (String)

      A filter to list only the wireless devices that use this device profile.

    • ServiceProfileId — (String)

      A filter to list only the wireless devices that use this service profile.

    • WirelessDeviceType — (String)

      A filter to list only the wireless devices that use this wireless device type.

      Possible values include:
      • "Sidewalk"
      • "LoRaWAN"
    • FuotaTaskId — (String)

      The ID of a FUOTA task.

    • MulticastGroupId — (String)

      The ID of the multicast group.

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:

      • NextToken — (String)

        The token to use to get the next set of results, or null if there are no additional results.

      • WirelessDeviceList — (Array<map>)

        The ID of the wireless device.

        • Arn — (String)

          The Amazon Resource Name of the resource.

        • Id — (String)

          The ID of the wireless device reporting the data.

        • Type — (String)

          The wireless device type.

          Possible values include:
          • "Sidewalk"
          • "LoRaWAN"
        • Name — (String)

          The name of the resource.

        • DestinationName — (String)

          The name of the destination to which the device is assigned.

        • LastUplinkReceivedAt — (String)

          The date and time when the most recent uplink was received.

          Note: Theis value is only valid for 3 months.
        • LoRaWAN — (map)

          LoRaWAN device info.

          • DevEui — (String)

            The DevEUI value.

        • Sidewalk — (map)

          The Sidewalk account credentials.

          • AmazonId — (String)

            The Sidewalk Amazon ID.

          • SidewalkId — (String)

            The sidewalk device identification.

          • SidewalkManufacturingSn — (String)

            The Sidewalk manufacturing series number.

          • DeviceCertificates — (Array<map>)

            The sidewalk device certificates for Ed25519 and P256r1.

            • SigningAlgrequired — (String)

              The certificate chain algorithm provided by sidewalk.

              Possible values include:
              • "Ed25519"
              • "P256r1"
            • Valuerequired — (String)

              The value of the chosen sidewalk certificate.

          • DeviceProfileId — (String)

            Sidewalk object used by list functions.

          • Status — (String)

            The status of the Sidewalk devices, such as provisioned or registered.

            Possible values include:
            • "PROVISIONED"
            • "REGISTERED"
            • "ACTIVATED"
            • "UNKNOWN"
        • FuotaDeviceStatus — (String)

          The status of a wireless device in a FUOTA task.

          Possible values include:
          • "Initial"
          • "Package_Not_Supported"
          • "FragAlgo_unsupported"
          • "Not_enough_memory"
          • "FragIndex_unsupported"
          • "Wrong_descriptor"
          • "SessionCnt_replay"
          • "MissingFrag"
          • "MemoryError"
          • "MICError"
          • "Successful"
        • MulticastDeviceStatus — (String)

          The status of the wireless device in the multicast group.

        • McGroupId — (Integer)

          Id of the multicast group.

Returns:

  • (AWS.Request)

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

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

Lists the wireless gateways registered to your AWS account.

Service Reference:

Examples:

Calling the listWirelessGateways operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE'
};
iotwireless.listWirelessGateways(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: {})
    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

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:

      • NextToken — (String)

        The token to use to get the next set of results, or null if there are no additional results.

      • WirelessGatewayList — (Array<map>)

        The ID of the wireless gateway.

        • Arn — (String)

          The Amazon Resource Name of the resource.

        • Id — (String)

          The ID of the wireless gateway reporting the data.

        • Name — (String)

          The name of the resource.

        • Description — (String)

          The description of the resource.

        • LoRaWAN — (map)

          LoRaWAN gateway info.

          • GatewayEui — (String)

            The gateway's EUI value.

          • RfRegion — (String)

            The frequency band (RFRegion) value.

          • JoinEuiFilters — (Array<Array<String>>)

            A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.

          • NetIdFilters — (Array<String>)

            A list of NetId values that are used by LoRa gateways to filter the uplink frames.

          • SubBands — (Array<Integer>)

            A list of integer indicating which sub bands are supported by LoRa gateway.

          • Beaconing — (map)

            Beaconing object information, which consists of the data rate and frequency parameters.

            • DataRate — (Integer)

              The data rate for gateways that are sending the beacons.

            • Frequencies — (Array<Integer>)

              The frequency list for the gateways to send the beacons.

          • MaxEirp — (Float)

            The MaxEIRP value.

        • LastUplinkReceivedAt — (String)

          The date and time when the most recent uplink was received.

          Note: This value is only valid for 3 months.

Returns:

  • (AWS.Request)

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

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

List the wireless gateway tasks definitions registered to your AWS account.

Examples:

Calling the listWirelessGatewayTaskDefinitions operation

var params = {
  MaxResults: 'NUMBER_VALUE',
  NextToken: 'STRING_VALUE',
  TaskDefinitionType: UPDATE
};
iotwireless.listWirelessGatewayTaskDefinitions(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: {})
    • MaxResults — (Integer)

      The maximum number of results to return in this operation.

    • NextToken — (String)

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • TaskDefinitionType — (String)

      A filter to list only the wireless gateway task definitions that use this task definition type.

      Possible values include:
      • "UPDATE"

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:

      • NextToken — (String)

        The token to use to get the next set of results, or null if there are no additional results.

      • TaskDefinitions — (Array<map>)

        The list of task definitions.

        • Id — (String)

          The ID of the new wireless gateway task entry.

        • LoRaWAN — (map)

          The properties that relate to the LoRaWAN wireless gateway.

          • CurrentVersion — (map)

            The version of the gateways that should receive the update.

            • PackageVersion — (String)

              The version of the wireless gateway firmware.

            • Model — (String)

              The model number of the wireless gateway.

            • Station — (String)

              The basic station version of the wireless gateway.

          • UpdateVersion — (map)

            The firmware version to update the gateway to.

            • PackageVersion — (String)

              The version of the wireless gateway firmware.

            • Model — (String)

              The model number of the wireless gateway.

            • Station — (String)

              The basic station version of the wireless gateway.

        • Arn — (String)

          The Amazon Resource Name of the resource.

Returns:

  • (AWS.Request)

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

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

Put position configuration for a given resource.

This action is no longer supported. Calls to update the position configuration should use the UpdateResourcePosition API operation instead.

Service Reference:

Examples:

Calling the putPositionConfiguration operation

var params = {
  ResourceIdentifier: 'STRING_VALUE', /* required */
  ResourceType: WirelessDevice | WirelessGateway, /* required */
  Destination: 'STRING_VALUE',
  Solvers: {
    SemtechGnss: {
      Fec: ROSE | NONE, /* required */
      Status: Enabled | Disabled /* required */
    }
  }
};
iotwireless.putPositionConfiguration(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: {})
    • ResourceIdentifier — (String)

      Resource identifier used to update the position configuration.

    • ResourceType — (String)

      Resource type of the resource for which you want to update the position configuration.

      Possible values include:
      • "WirelessDevice"
      • "WirelessGateway"
    • Solvers — (map)

      The positioning solvers used to update the position configuration of the resource.

      • SemtechGnss — (map)

        The Semtech GNSS solver configuration object.

        • Statusrequired — (String)

          The status indicating whether the solver is enabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
        • Fecrequired — (String)

          Whether forward error correction is enabled.

          Possible values include:
          • "ROSE"
          • "NONE"
    • Destination — (String)

      The position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

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.

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

Sets the log-level override for a resource-ID and resource-type. This option can be specified for a wireless gateway or a wireless device. A limit of 200 log level override can be set per account.

Service Reference:

Examples:

Calling the putResourceLogLevel operation

var params = {
  LogLevel: INFO | ERROR | DISABLED, /* required */
  ResourceIdentifier: 'STRING_VALUE', /* required */
  ResourceType: 'STRING_VALUE' /* required */
};
iotwireless.putResourceLogLevel(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: {})
    • ResourceIdentifier — (String)

      The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.

    • ResourceType — (String)

      The type of the resource, which can be WirelessDevice or WirelessGateway.

    • LogLevel — (String)

      The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

      Possible values include:
      • "INFO"
      • "ERROR"
      • "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.

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

Removes the log-level overrides for all resources; both wireless devices and wireless gateways.

Service Reference:

Examples:

Calling the resetAllResourceLogLevels operation

var params = {
};
iotwireless.resetAllResourceLogLevels(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: {})

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.

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

Removes the log-level override, if any, for a specific resource-ID and resource-type. It can be used for a wireless device or a wireless gateway.

Service Reference:

Examples:

Calling the resetResourceLogLevel operation

var params = {
  ResourceIdentifier: 'STRING_VALUE', /* required */
  ResourceType: 'STRING_VALUE' /* required */
};
iotwireless.resetResourceLogLevel(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: {})
    • ResourceIdentifier — (String)

      The identifier of the resource. For a Wireless Device, it is the wireless device ID. For a wireless gateway, it is the wireless gateway ID.

    • ResourceType — (String)

      The type of the resource, which can be WirelessDevice or WirelessGateway.

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.

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

Sends the specified data to a multicast group.

Service Reference:

Examples:

Calling the sendDataToMulticastGroup operation

var params = {
  Id: 'STRING_VALUE', /* required */
  PayloadData: 'STRING_VALUE', /* required */
  WirelessMetadata: { /* required */
    LoRaWAN: {
      FPort: 'NUMBER_VALUE'
    }
  }
};
iotwireless.sendDataToMulticastGroup(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: {})
    • Id — (String)

      The ID of the multicast group.

    • PayloadData — (String)

      The binary to be sent to the end device, encoded in base64.

    • WirelessMetadata — (map)

      Wireless metadata that is to be sent to multicast group.

      • LoRaWAN — (map)

        The metadata information of the LoRaWAN multicast group.

        • FPort — (Integer)

          The Fport value.

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:

      • MessageId — (String)

        ID of a multicast group message.

Returns:

  • (AWS.Request)

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

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

Sends a decrypted application data frame to a device.

Service Reference:

Examples:

Calling the sendDataToWirelessDevice operation

var params = {
  Id: 'STRING_VALUE', /* required */
  PayloadData: 'STRING_VALUE', /* required */
  TransmitMode: 'NUMBER_VALUE', /* required */
  WirelessMetadata: {
    LoRaWAN: {
      FPort: 'NUMBER_VALUE',
      ParticipatingGateways: {
        DownlinkMode: SEQUENTIAL | CONCURRENT | USING_UPLINK_GATEWAY, /* required */
        GatewayList: [ /* required */
          {
            DownlinkFrequency: 'NUMBER_VALUE', /* required */
            GatewayId: 'STRING_VALUE' /* required */
          },
          /* more items */
        ],
        TransmissionInterval: 'NUMBER_VALUE' /* required */
      }
    },
    Sidewalk: {
      AckModeRetryDurationSecs: 'NUMBER_VALUE',
      MessageType: CUSTOM_COMMAND_ID_NOTIFY | CUSTOM_COMMAND_ID_GET | CUSTOM_COMMAND_ID_SET | CUSTOM_COMMAND_ID_RESP,
      Seq: 'NUMBER_VALUE'
    }
  }
};
iotwireless.sendDataToWirelessDevice(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: {})
    • Id — (String)

      The ID of the wireless device to receive the data.

    • TransmitMode — (Integer)

      The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode) or 1 for AM (acknowledge mode).

    • PayloadData — (String)

      The binary to be sent to the end device, encoded in base64.

    • WirelessMetadata — (map)

      Metadata about the message request.

      • LoRaWAN — (map)

        LoRaWAN device info.

        • FPort — (Integer)

          The Fport value.

        • ParticipatingGateways — (map)

          Choose the gateways that you want to use for the downlink data traffic when the wireless device is running in class B or class C mode.

          • DownlinkModerequired — (String)

            Indicates whether to send the downlink message in sequential mode or concurrent mode, or to use only the chosen gateways from the previous uplink message transmission.

            Possible values include:
            • "SEQUENTIAL"
            • "CONCURRENT"
            • "USING_UPLINK_GATEWAY"
          • GatewayListrequired — (Array<map>)

            The list of gateways that you want to use for sending the downlink data traffic.

            • GatewayIdrequired — (String)

              The ID of the wireless gateways that you want to add to the list of gateways when sending downlink messages.

            • DownlinkFrequencyrequired — (Integer)

              The frequency to use for the gateways when sending a downlink message to the wireless device.

          • TransmissionIntervalrequired — (Integer)

            The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the payload to the next gateway.

      • Sidewalk — (map)

        The Sidewalk account credentials.

        • Seq — (Integer)

          The sequence number.

        • MessageType — (String)

          Sidewalk device message type. Default value is CUSTOM_COMMAND_ID_NOTIFY.

          Possible values include:
          • "CUSTOM_COMMAND_ID_NOTIFY"
          • "CUSTOM_COMMAND_ID_GET"
          • "CUSTOM_COMMAND_ID_SET"
          • "CUSTOM_COMMAND_ID_RESP"
        • AckModeRetryDurationSecs — (Integer)

          The duration of time in seconds to retry sending the ACK.

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:

      • MessageId — (String)

        The ID of the message sent to the wireless device.

Returns:

  • (AWS.Request)

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

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

Starts a bulk association of all qualifying wireless devices with a multicast group.

Examples:

Calling the startBulkAssociateWirelessDeviceWithMulticastGroup operation

var params = {
  Id: 'STRING_VALUE', /* required */
  QueryString: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotwireless.startBulkAssociateWirelessDeviceWithMulticastGroup(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: {})
    • Id — (String)

      The ID of the multicast group.

    • QueryString — (String)

      Query string used to search for wireless devices as part of the bulk associate and disassociate process.

    • Tags — (Array<map>)

      The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

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.

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

Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.

Examples:

Calling the startBulkDisassociateWirelessDeviceFromMulticastGroup operation

var params = {
  Id: 'STRING_VALUE', /* required */
  QueryString: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotwireless.startBulkDisassociateWirelessDeviceFromMulticastGroup(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: {})
    • Id — (String)

      The ID of the multicast group.

    • QueryString — (String)

      Query string used to search for wireless devices as part of the bulk associate and disassociate process.

    • Tags — (Array<map>)

      The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

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.

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

Starts a FUOTA task.

Service Reference:

Examples:

Calling the startFuotaTask operation

var params = {
  Id: 'STRING_VALUE', /* required */
  LoRaWAN: {
    StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789
  }
};
iotwireless.startFuotaTask(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: {})
    • Id — (String)

      The ID of a FUOTA task.

    • LoRaWAN — (map)

      The LoRaWAN information used to start a FUOTA task.

      • StartTime — (Date)

        Start time of a FUOTA task.

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.

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

Starts a multicast group session.

Service Reference:

Examples:

Calling the startMulticastGroupSession operation

var params = {
  Id: 'STRING_VALUE', /* required */
  LoRaWAN: { /* required */
    DlDr: 'NUMBER_VALUE',
    DlFreq: 'NUMBER_VALUE',
    PingSlotPeriod: 'NUMBER_VALUE',
    SessionStartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789,
    SessionTimeout: 'NUMBER_VALUE'
  }
};
iotwireless.startMulticastGroupSession(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: {})
    • Id — (String)

      The ID of the multicast group.

    • LoRaWAN — (map)

      The LoRaWAN information used with the multicast session.

      • DlDr — (Integer)

        Downlink data rate.

      • DlFreq — (Integer)

        Downlink frequency.

      • SessionStartTime — (Date)

        Timestamp of when the multicast group session is to start.

      • SessionTimeout — (Integer)

        How long before a multicast group session is to timeout.

      • PingSlotPeriod — (Integer)

        The PingSlotPeriod value.

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.

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

Start import task for a single wireless device.

Examples:

Calling the startSingleWirelessDeviceImportTask operation

var params = {
  DestinationName: 'STRING_VALUE', /* required */
  Sidewalk: { /* required */
    SidewalkManufacturingSn: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  DeviceName: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotwireless.startSingleWirelessDeviceImportTask(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: {})
    • DestinationName — (String)

      The name of the Sidewalk destination that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless.

    • ClientRequestToken — (String)

      Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • DeviceName — (String)

      The name of the wireless device for which an import task is being started.

    • Tags — (Array<map>)

      The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

    • Sidewalk — (map)

      The Sidewalk-related parameters for importing a single wireless device.

      • SidewalkManufacturingSn — (String)

        The Sidewalk manufacturing serial number (SMSN) of the device added to the import task.

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:

      • Id — (String)

        The import task ID.

      • Arn — (String)

        The ARN (Amazon Resource Name) of the import task.

Returns:

  • (AWS.Request)

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

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

Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.

Service Reference:

Examples:

Calling the startWirelessDeviceImportTask operation

var params = {
  DestinationName: 'STRING_VALUE', /* required */
  Sidewalk: { /* required */
    DeviceCreationFile: 'STRING_VALUE',
    Role: 'STRING_VALUE'
  },
  ClientRequestToken: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotwireless.startWirelessDeviceImportTask(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: {})
    • DestinationName — (String)

      The name of the Sidewalk destination that describes the IoT rule to route messages from the devices in the import task that are onboarded to AWS IoT Wireless.

    • ClientRequestToken — (String)

      Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

      If a token is not provided, the SDK will use a version 4 UUID.
    • Tags — (Array<map>)

      The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

    • Sidewalk — (map)

      The Sidewalk-related parameters for importing wireless devices that need to be provisioned in bulk.

      • DeviceCreationFile — (String)

        The CSV file contained in an S3 bucket that's used for adding devices to an import task.

      • Role — (String)

        The IAM role that allows AWS IoT Wireless to access the CSV file in the S3 bucket.

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:

      • Id — (String)

        The import task ID.

      • Arn — (String)

        The ARN (Amazon Resource Name) of the import task.

Returns:

  • (AWS.Request)

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

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

Adds a tag to a resource.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
iotwireless.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 to add tags to.

    • Tags — (Array<map>)

      Adds to or modifies the tags of the given resource. Tags are metadata that you can use to manage a resource.

      • Keyrequired — (String)

        The tag's key value.

      • Valuerequired — (String)

        The tag's value.

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.

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

Simulates a provisioned device by sending an uplink data payload of Hello.

Service Reference:

Examples:

Calling the testWirelessDevice operation

var params = {
  Id: 'STRING_VALUE' /* required */
};
iotwireless.testWirelessDevice(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: {})
    • Id — (String)

      The ID of the wireless device to test.

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:

      • Result — (String)

        The result returned by the test.

Returns:

  • (AWS.Request)

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

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

Removes one or more tags from a resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
iotwireless.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 to remove tags from.

    • TagKeys — (Array<String>)

      A list of the keys of the tags to remove from 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.

Returns:

  • (AWS.Request)

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

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

Updates properties of a destination.

Service Reference:

Examples:

Calling the updateDestination operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  Expression: 'STRING_VALUE',
  ExpressionType: RuleName | MqttTopic,
  RoleArn: 'STRING_VALUE'
};
iotwireless.updateDestination(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: {})
    • Name — (String)

      The new name of the resource.

    • ExpressionType — (String)

      The type of value in Expression.

      Possible values include:
      • "RuleName"
      • "MqttTopic"
    • Expression — (String)

      The new rule name or topic rule to send messages to.

    • Description — (String)

      A new description of the resource.

    • RoleArn — (String)

      The ARN of the IAM Role that authorizes the destination.

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.

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

Update the event configuration based on resource types.

Examples:

Calling the updateEventConfigurationByResourceTypes operation

var params = {
  ConnectionStatus: {
    LoRaWAN: {
      WirelessGatewayEventTopic: Enabled | Disabled
    }
  },
  DeviceRegistrationState: {
    Sidewalk: {
      WirelessDeviceEventTopic: Enabled | Disabled
    }
  },
  Join: {
    LoRaWAN: {
      WirelessDeviceEventTopic: Enabled | Disabled
    }
  },
  MessageDeliveryStatus: {
    Sidewalk: {
      WirelessDeviceEventTopic: Enabled | Disabled
    }
  },
  Proximity: {
    Sidewalk: {
      WirelessDeviceEventTopic: Enabled | Disabled
    }
  }
};
iotwireless.updateEventConfigurationByResourceTypes(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: {})
    • DeviceRegistrationState — (map)

      Device registration state resource type event configuration object for enabling and disabling wireless gateway topic.

      • Sidewalk — (map)

        Device registration resource type state event configuration object for enabling or disabling Sidewalk related event topics.

        • WirelessDeviceEventTopic — (String)

          Denotes whether the wireless device join event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
    • Proximity — (map)

      Proximity resource type event configuration object for enabling and disabling wireless gateway topic.

      • Sidewalk — (map)

        Proximity resource type event configuration object for enabling and disabling wireless device topic.

        • WirelessDeviceEventTopic — (String)

          Denotes whether the wireless device join event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
    • Join — (map)

      Join resource type event configuration object for enabling and disabling wireless device topic.

      • LoRaWAN — (map)

        Join resource type event configuration object for enabling or disabling LoRaWAN related event topics.

        • WirelessDeviceEventTopic — (String)

          Denotes whether the wireless device join event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
    • ConnectionStatus — (map)

      Connection status resource type event configuration object for enabling and disabling wireless gateway topic.

      • LoRaWAN — (map)

        Connection status resource type event configuration object for enabling or disabling LoRaWAN related event topics.

        • WirelessGatewayEventTopic — (String)

          Denotes whether the wireless gateway connection status event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
    • MessageDeliveryStatus — (map)

      Message delivery status resource type event configuration object for enabling and disabling wireless device topic.

      • Sidewalk — (map)

        Sidewalk resource type event configuration object for enabling or disabling topic.

        • WirelessDeviceEventTopic — (String)

          Denotes whether the wireless device join event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "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.

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

Updates properties of a FUOTA task.

Service Reference:

Examples:

Calling the updateFuotaTask operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  FirmwareUpdateImage: 'STRING_VALUE',
  FirmwareUpdateRole: 'STRING_VALUE',
  FragmentIntervalMS: 'NUMBER_VALUE',
  FragmentSizeBytes: 'NUMBER_VALUE',
  LoRaWAN: {
    RfRegion: EU868 | US915 | AU915 | AS923-1 | AS923-2 | AS923-3 | AS923-4 | EU433 | CN470 | CN779 | RU864 | KR920 | IN865
  },
  Name: 'STRING_VALUE',
  RedundancyPercent: 'NUMBER_VALUE'
};
iotwireless.updateFuotaTask(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: {})
    • Id — (String)

      The ID of a FUOTA task.

    • Name — (String)

      The name of a FUOTA task.

    • Description — (String)

      The description of the new resource.

    • LoRaWAN — (map)

      The LoRaWAN information used with a FUOTA task.

      • RfRegion — (String)

        Supported RfRegions

        Possible values include:
        • "EU868"
        • "US915"
        • "AU915"
        • "AS923-1"
        • "AS923-2"
        • "AS923-3"
        • "AS923-4"
        • "EU433"
        • "CN470"
        • "CN779"
        • "RU864"
        • "KR920"
        • "IN865"
    • FirmwareUpdateImage — (String)

      The S3 URI points to a firmware update image that is to be used with a FUOTA task.

    • FirmwareUpdateRole — (String)

      The firmware update role that is to be used with a FUOTA task.

    • RedundancyPercent — (Integer)

      The percentage of the added fragments that are redundant. For example, if the size of the firmware image file is 100 bytes and the fragment size is 10 bytes, with RedundancyPercent set to 50(%), the final number of encoded fragments is (100 / 10) + (100 / 10 * 50%) = 15.

    • FragmentSizeBytes — (Integer)

      The size of each fragment in bytes. This parameter is supported only for FUOTA tasks with multicast groups.

    • FragmentIntervalMS — (Integer)

      The interval for sending fragments in milliseconds, rounded to the nearest second.

      Note: This interval only determines the timing for when the Cloud sends down the fragments to yor device. There can be a delay for when your device will receive these fragments. This delay depends on the device's class and the communication delay with the cloud.

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.

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

Set default log level, or log levels by resource types. This can be for wireless device log options or wireless gateways log options and is used to control the log messages that'll be displayed in CloudWatch.

Service Reference:

Examples:

Calling the updateLogLevelsByResourceTypes operation

var params = {
  DefaultLogLevel: INFO | ERROR | DISABLED,
  WirelessDeviceLogOptions: [
    {
      LogLevel: INFO | ERROR | DISABLED, /* required */
      Type: Sidewalk | LoRaWAN, /* required */
      Events: [
        {
          Event: Join | Rejoin | Uplink_Data | Downlink_Data | Registration, /* required */
          LogLevel: INFO | ERROR | DISABLED /* required */
        },
        /* more items */
      ]
    },
    /* more items */
  ],
  WirelessGatewayLogOptions: [
    {
      LogLevel: INFO | ERROR | DISABLED, /* required */
      Type: LoRaWAN, /* required */
      Events: [
        {
          Event: CUPS_Request | Certificate, /* required */
          LogLevel: INFO | ERROR | DISABLED /* required */
        },
        /* more items */
      ]
    },
    /* more items */
  ]
};
iotwireless.updateLogLevelsByResourceTypes(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: {})
    • DefaultLogLevel — (String)

      The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

      Possible values include:
      • "INFO"
      • "ERROR"
      • "DISABLED"
    • WirelessDeviceLogOptions — (Array<map>)

      The list of wireless device log options.

      • Typerequired — (String)

        The wireless device type.

        Possible values include:
        • "Sidewalk"
        • "LoRaWAN"
      • LogLevelrequired — (String)

        The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

        Possible values include:
        • "INFO"
        • "ERROR"
        • "DISABLED"
      • Events — (Array<map>)

        The list of wireless device event log options.

        • Eventrequired — (String)

          The event for a log message, if the log message is tied to a wireless device.

          Possible values include:
          • "Join"
          • "Rejoin"
          • "Uplink_Data"
          • "Downlink_Data"
          • "Registration"
        • LogLevelrequired — (String)

          The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

          Possible values include:
          • "INFO"
          • "ERROR"
          • "DISABLED"
    • WirelessGatewayLogOptions — (Array<map>)

      The list of wireless gateway log options.

      • Typerequired — (String)

        The wireless gateway type.

        Possible values include:
        • "LoRaWAN"
      • LogLevelrequired — (String)

        The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

        Possible values include:
        • "INFO"
        • "ERROR"
        • "DISABLED"
      • Events — (Array<map>)

        The list of wireless gateway event log options.

        • Eventrequired — (String)

          The event for a log message, if the log message is tied to a wireless gateway.

          Possible values include:
          • "CUPS_Request"
          • "Certificate"
        • LogLevelrequired — (String)

          The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

          Possible values include:
          • "INFO"
          • "ERROR"
          • "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.

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

Updates properties of a multicast group session.

Service Reference:

Examples:

Calling the updateMulticastGroup operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  LoRaWAN: {
    DlClass: ClassB | ClassC,
    RfRegion: EU868 | US915 | AU915 | AS923-1 | AS923-2 | AS923-3 | AS923-4 | EU433 | CN470 | CN779 | RU864 | KR920 | IN865
  },
  Name: 'STRING_VALUE'
};
iotwireless.updateMulticastGroup(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: {})
    • Id — (String)

      The ID of the multicast group.

    • Name — (String)

      The name of the multicast group.

    • Description — (String)

      The description of the new resource.

    • LoRaWAN — (map)

      The LoRaWAN information that is to be used with the multicast group.

      • RfRegion — (String)

        Supported RfRegions

        Possible values include:
        • "EU868"
        • "US915"
        • "AU915"
        • "AS923-1"
        • "AS923-2"
        • "AS923-3"
        • "AS923-4"
        • "EU433"
        • "CN470"
        • "CN779"
        • "RU864"
        • "KR920"
        • "IN865"
      • DlClass — (String)

        DlClass for LoRaWAM, valid values are ClassB and ClassC.

        Possible values include:
        • "ClassB"
        • "ClassC"

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.

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

Update network analyzer configuration.

Examples:

Calling the updateNetworkAnalyzerConfiguration operation

var params = {
  ConfigurationName: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  MulticastGroupsToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  MulticastGroupsToRemove: [
    'STRING_VALUE',
    /* more items */
  ],
  TraceContent: {
    LogLevel: INFO | ERROR | DISABLED,
    MulticastFrameInfo: ENABLED | DISABLED,
    WirelessDeviceFrameInfo: ENABLED | DISABLED
  },
  WirelessDevicesToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  WirelessDevicesToRemove: [
    'STRING_VALUE',
    /* more items */
  ],
  WirelessGatewaysToAdd: [
    'STRING_VALUE',
    /* more items */
  ],
  WirelessGatewaysToRemove: [
    'STRING_VALUE',
    /* more items */
  ]
};
iotwireless.updateNetworkAnalyzerConfiguration(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: {})
    • ConfigurationName — (String)

      Name of the network analyzer configuration.

    • TraceContent — (map)

      Trace content for your wireless devices, gateways, and multicast groups.

      • WirelessDeviceFrameInfo — (String)

        FrameInfo of your wireless device resources for the trace content. Use FrameInfo to debug the communication between your LoRaWAN end devices and the network server.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
      • LogLevel — (String)

        The log level for a log message. The log levels can be disabled, or set to ERROR to display less verbose logs containing only error information, or to INFO for more detailed logs.

        Possible values include:
        • "INFO"
        • "ERROR"
        • "DISABLED"
      • MulticastFrameInfo — (String)

        FrameInfo of your multicast group resources for the trace content. Use FrameInfo to debug the multicast communication between your multicast groups and the network server.

        Possible values include:
        • "ENABLED"
        • "DISABLED"
    • WirelessDevicesToAdd — (Array<String>)

      Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId of the resource to add in the input array.

    • WirelessDevicesToRemove — (Array<String>)

      Wireless device resources to remove from the network analyzer configuration. Provide the WirelessDeviceId of the resources to remove in the input array.

    • WirelessGatewaysToAdd — (Array<String>)

      Wireless gateway resources to add to the network analyzer configuration. Provide the WirelessGatewayId of the resource to add in the input array.

    • WirelessGatewaysToRemove — (Array<String>)

      Wireless gateway resources to remove from the network analyzer configuration. Provide the WirelessGatewayId of the resources to remove in the input array.

    • Description — (String)

      The description of the new resource.

    • MulticastGroupsToAdd — (Array<String>)

      Multicast group resources to add to the network analyzer configuration. Provide the MulticastGroupId of the resource to add in the input array.

    • MulticastGroupsToRemove — (Array<String>)

      Multicast group resources to remove from the network analyzer configuration. Provide the MulticastGroupId of the resources to remove in the input array.

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.

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

Updates properties of a partner account.

Service Reference:

Examples:

Calling the updatePartnerAccount operation

var params = {
  PartnerAccountId: 'STRING_VALUE', /* required */
  PartnerType: Sidewalk, /* required */
  Sidewalk: { /* required */
    AppServerPrivateKey: 'STRING_VALUE'
  }
};
iotwireless.updatePartnerAccount(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: {})
    • Sidewalk — (map)

      The Sidewalk account credentials.

      • AppServerPrivateKey — (String)

        The new Sidewalk application server private key.

    • PartnerAccountId — (String)

      The ID of the partner account to update.

    • PartnerType — (String)

      The partner type.

      Possible values include:
      • "Sidewalk"

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.

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

Update the position information of a resource.

This action is no longer supported. Calls to update the position information should use the UpdateResourcePosition API operation instead.

Service Reference:

Examples:

Calling the updatePosition operation

var params = {
  Position: [ /* required */
    'NUMBER_VALUE',
    /* more items */
  ],
  ResourceIdentifier: 'STRING_VALUE', /* required */
  ResourceType: WirelessDevice | WirelessGateway /* required */
};
iotwireless.updatePosition(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: {})
    • ResourceIdentifier — (String)

      Resource identifier of the resource for which position is updated.

    • ResourceType — (String)

      Resource type of the resource for which position is updated.

      Possible values include:
      • "WirelessDevice"
      • "WirelessGateway"
    • Position — (Array<Float>)

      The position information 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.

Returns:

  • (AWS.Request)

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

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

Update the event configuration for a particular resource identifier.

Examples:

Calling the updateResourceEventConfiguration operation

var params = {
  Identifier: 'STRING_VALUE', /* required */
  IdentifierType: PartnerAccountId | DevEui | GatewayEui | WirelessDeviceId | WirelessGatewayId, /* required */
  ConnectionStatus: {
    LoRaWAN: {
      GatewayEuiEventTopic: Enabled | Disabled
    },
    WirelessGatewayIdEventTopic: Enabled | Disabled
  },
  DeviceRegistrationState: {
    Sidewalk: {
      AmazonIdEventTopic: Enabled | Disabled
    },
    WirelessDeviceIdEventTopic: Enabled | Disabled
  },
  Join: {
    LoRaWAN: {
      DevEuiEventTopic: Enabled | Disabled
    },
    WirelessDeviceIdEventTopic: Enabled | Disabled
  },
  MessageDeliveryStatus: {
    Sidewalk: {
      AmazonIdEventTopic: Enabled | Disabled
    },
    WirelessDeviceIdEventTopic: Enabled | Disabled
  },
  PartnerType: Sidewalk,
  Proximity: {
    Sidewalk: {
      AmazonIdEventTopic: Enabled | Disabled
    },
    WirelessDeviceIdEventTopic: Enabled | Disabled
  }
};
iotwireless.updateResourceEventConfiguration(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: {})
    • Identifier — (String)

      Resource identifier to opt in for event messaging.

    • IdentifierType — (String)

      Identifier type of the particular resource identifier for event configuration.

      Possible values include:
      • "PartnerAccountId"
      • "DevEui"
      • "GatewayEui"
      • "WirelessDeviceId"
      • "WirelessGatewayId"
    • PartnerType — (String)

      Partner type of the resource if the identifier type is PartnerAccountId

      Possible values include:
      • "Sidewalk"
    • DeviceRegistrationState — (map)

      Event configuration for the device registration state event.

      • Sidewalk — (map)

        Device registration state event configuration object for enabling or disabling Sidewalk related event topics.

        • AmazonIdEventTopic — (String)

          Denotes whether the Amazon ID event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
      • WirelessDeviceIdEventTopic — (String)

        Denotes whether the wireless device ID device registration state event topic is enabled or disabled.

        Possible values include:
        • "Enabled"
        • "Disabled"
    • Proximity — (map)

      Event configuration for the proximity event.

      • Sidewalk — (map)

        Proximity event configuration object for enabling or disabling Sidewalk related event topics.

        • AmazonIdEventTopic — (String)

          Denotes whether the Amazon ID event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
      • WirelessDeviceIdEventTopic — (String)

        Denotes whether the wireless device ID proximity event topic is enabled or disabled.

        Possible values include:
        • "Enabled"
        • "Disabled"
    • Join — (map)

      Event configuration for the join event.

      • LoRaWAN — (map)

        Join event configuration object for enabling or disabling LoRaWAN related event topics.

        • DevEuiEventTopic — (String)

          Denotes whether the Dev EUI join event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
      • WirelessDeviceIdEventTopic — (String)

        Denotes whether the wireless device ID join event topic is enabled or disabled.

        Possible values include:
        • "Enabled"
        • "Disabled"
    • ConnectionStatus — (map)

      Event configuration for the connection status event.

      • LoRaWAN — (map)

        Connection status event configuration object for enabling or disabling LoRaWAN related event topics.

        • GatewayEuiEventTopic — (String)

          Denotes whether the gateway EUI connection status event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
      • WirelessGatewayIdEventTopic — (String)

        Denotes whether the wireless gateway ID connection status event topic is enabled or disabled.

        Possible values include:
        • "Enabled"
        • "Disabled"
    • MessageDeliveryStatus — (map)

      Event configuration for the message delivery status event.

      • Sidewalk — (map)

        SidewalkEventNotificationConfigurations object, which is the event configuration object for Sidewalk-related event topics.

        • AmazonIdEventTopic — (String)

          Denotes whether the Amazon ID event topic is enabled or disabled.

          Possible values include:
          • "Enabled"
          • "Disabled"
      • WirelessDeviceIdEventTopic — (String)

        Denotes whether the wireless device ID message delivery status event topic is enabled or disabled.

        Possible values include:
        • "Enabled"
        • "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.

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

Update the position information of a given wireless device or a wireless gateway resource. The position coordinates are based on the World Geodetic System (WGS84).

Service Reference:

Examples:

Calling the updateResourcePosition operation

var params = {
  ResourceIdentifier: 'STRING_VALUE', /* required */
  ResourceType: WirelessDevice | WirelessGateway, /* required */
  GeoJsonPayload: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */
};
iotwireless.updateResourcePosition(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: {})
    • ResourceIdentifier — (String)

      The identifier of the resource for which position information is updated. It can be the wireless device ID or the wireless gateway ID, depending on the resource type.

    • ResourceType — (String)

      The type of resource for which position information is updated, which can be a wireless device or a wireless gateway.

      Possible values include:
      • "WirelessDevice"
      • "WirelessGateway"
    • GeoJsonPayload — (Buffer, Typed Array, Blob, String)

      The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that's used to encode geographic data structures. For more information, see GeoJSON.

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.

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

Updates properties of a wireless device.

Service Reference:

Examples:

Calling the updateWirelessDevice operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  DestinationName: 'STRING_VALUE',
  LoRaWAN: {
    AbpV1_0_x: {
      FCntStart: 'NUMBER_VALUE'
    },
    AbpV1_1: {
      FCntStart: 'NUMBER_VALUE'
    },
    DeviceProfileId: 'STRING_VALUE',
    FPorts: {
      Applications: [
        {
          DestinationName: 'STRING_VALUE',
          FPort: 'NUMBER_VALUE',
          Type: SemtechGeolocation
        },
        /* more items */
      ],
      Positioning: {
        ClockSync: 'NUMBER_VALUE',
        Gnss: 'NUMBER_VALUE',
        Stream: 'NUMBER_VALUE'
      }
    },
    ServiceProfileId: 'STRING_VALUE'
  },
  Name: 'STRING_VALUE',
  Positioning: Enabled | Disabled
};
iotwireless.updateWirelessDevice(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: {})
    • Id — (String)

      The ID of the resource to update.

    • DestinationName — (String)

      The name of the new destination for the device.

    • Name — (String)

      The new name of the resource.

    • Description — (String)

      A new description of the resource.

    • LoRaWAN — (map)

      The updated wireless device's configuration.

      • DeviceProfileId — (String)

        The ID of the device profile for the wireless device.

      • ServiceProfileId — (String)

        The ID of the service profile.

      • AbpV1_1 — (map)

        ABP device object for update APIs for v1.1

        • FCntStart — (Integer)

          The FCnt init value.

      • AbpV1_0_x — (map)

        ABP device object for update APIs for v1.0.x

        • FCntStart — (Integer)

          The FCnt init value.

      • FPorts — (map)

        FPorts object for the positioning information of the device.

        • Positioning — (map)

          Positioning FPorts for the ClockSync, Stream, and GNSS functions.

          • ClockSync — (Integer)

            The Fport value.

          • Stream — (Integer)

            The Fport value.

          • Gnss — (Integer)

            The Fport value.

        • Applications — (Array<map>)

          LoRaWAN application, which can be used for geolocation by activating positioning.

          • FPort — (Integer)

            The Fport value.

          • Type — (String)

            Application type, which can be specified to obtain real-time position information of your LoRaWAN device.

            Possible values include:
            • "SemtechGeolocation"
          • DestinationName — (String)

            The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.

    • Positioning — (String)

      FPort values for the GNSS, stream, and ClockSync functions of the positioning information.

      Possible values include:
      • "Enabled"
      • "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.

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

Update an import task to add more devices to the task.

Service Reference:

Examples:

Calling the updateWirelessDeviceImportTask operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Sidewalk: { /* required */
    DeviceCreationFile: 'STRING_VALUE'
  }
};
iotwireless.updateWirelessDeviceImportTask(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: {})
    • Id — (String)

      The identifier of the import task to be updated.

    • Sidewalk — (map)

      The Sidewalk-related parameters of the import task to be updated.

      • DeviceCreationFile — (String)

        The CSV file contained in an S3 bucket that's used for appending devices to an existing import task.

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.

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

Updates properties of a wireless gateway.

Service Reference:

Examples:

Calling the updateWirelessGateway operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Description: 'STRING_VALUE',
  JoinEuiFilters: [
    [
      'STRING_VALUE',
      /* more items */
    ],
    /* more items */
  ],
  MaxEirp: 'NUMBER_VALUE',
  Name: 'STRING_VALUE',
  NetIdFilters: [
    'STRING_VALUE',
    /* more items */
  ]
};
iotwireless.updateWirelessGateway(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: {})
    • Id — (String)

      The ID of the resource to update.

    • Name — (String)

      The new name of the resource.

    • Description — (String)

      A new description of the resource.

    • JoinEuiFilters — (Array<Array<String>>)

      A list of JoinEuiRange used by LoRa gateways to filter LoRa frames.

    • NetIdFilters — (Array<String>)

      A list of NetId values that are used by LoRa gateways to filter the uplink frames.

    • MaxEirp — (Float)

      The MaxEIRP value.

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.