You are viewing the documentation for an older major version of the AWS SDK for JavaScript.
The modular AWS SDK for JavaScript (v3), the latest major version of AWS SDK for JavaScript, is now stable and recommended for general use. For more information, see the Migration Guide and API Reference.

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 API documentation

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

Property Details

endpoint ⇒ AWS.Endpoint (readwrite)

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

Returns:

  • (AWS.Endpoint) —

    an Endpoint object representing the endpoint URL for service requests.

Method Details

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

Associates a partner account with your AWS account.

Service Reference:

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.

      • Key — required — (String)

        The tag's key value.

      • Value — required — (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.

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

Associates a wireless device with a thing.

Service Reference:

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.

Service Reference:

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.

Service Reference:

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.

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.

      • Key — required — (String)

        The tag's key value.

      • Value — required — (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',
  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.

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

      • Key — required — (String)

        The tag's key value.

      • Value — required — (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 device profile.

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
  },
  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.

    • Tags — (Array<map>)

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

      • Key — required — (String)

        The tag's key value.

      • Value — required — (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',
      SessionKeys: {
        AppSKey: 'STRING_VALUE',
        NwkSKey: 'STRING_VALUE'
      }
    },
    AbpV1_1: {
      DevAddr: 'STRING_VALUE',
      SessionKeys: {
        AppSKey: 'STRING_VALUE',
        FNwkSIntKey: 'STRING_VALUE',
        NwkSEncKey: 'STRING_VALUE',
        SNwkSIntKey: 'STRING_VALUE'
      }
    },
    DevEui: 'STRING_VALUE',
    DeviceProfileId: 'STRING_VALUE',
    OtaaV1_0_x: {
      AppEui: 'STRING_VALUE',
      AppKey: 'STRING_VALUE'
    },
    OtaaV1_1: {
      AppKey: 'STRING_VALUE',
      JoinEui: 'STRING_VALUE',
      NwkKey: 'STRING_VALUE'
    },
    ServiceProfileId: 'STRING_VALUE'
  },
  Name: '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.

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

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

    • Tags — (Array<map>)

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

      • Key — required — (String)

        The tag's key value.

      • Value — required — (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 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 */
    GatewayEui: 'STRING_VALUE',
    JoinEuiFilters: [
      [
        'STRING_VALUE',
        /* more items */
      ],
      /* more items */
    ],
    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.

    • Tags — (Array<map>)

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

      • Key — required — (String)

        The tag's key value.

      • Value — required — (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.

Service Reference:

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.

      • Key — required — (String)

        The tag's key value.

      • Value — required — (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.

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.

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.

Service Reference:

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.

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.

Service Reference:

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.

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

Disassociates a wireless device from its currently associated thing.

Service Reference:

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.

Service Reference:

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.

Service Reference:

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.

        • RfRegion — (String)

          The frequency band (RFRegion) value.

        • SupportsJoin — (Boolean)

          The SupportsJoin value.

        • Supports32BitFCnt — (Boolean)

          The Supports32BitFCnt value.

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.

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

        The list of wireless gateway log options.

        • Type — required — (String)

          The wireless gateway type.

          Possible values include:
          • "LoRaWAN"
        • LogLevel — required — (String)

          The log level for a log message.

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

          The list of wireless gateway event log options.

          • Event — required — (String)

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

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

            The log level for a log message.

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

        The list of wireless device log options.

        • Type — required — (String)

          The wireless device type.

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

          The log level for a log message.

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

          The list of wireless device event log options.

          • Event — required — (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"
          • LogLevel — required — (String)

            The log level for a log message.

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

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.

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.

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

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.

      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.

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

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

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

          • SigningAlg — required — (String)

            The certificate chain algorithm provided by sidewalk.

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

            The value of the chosen sidewalk certificate.

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.

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

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

Service Reference:

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.

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

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

Service Reference:

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 = {
  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.

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.

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.

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.

        • Key — required — (String)

          The tag's key value.

        • Value — required — (String)

          The tag's value.

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',
  MaxResults: 'NUMBER_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"

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.

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

            • SigningAlg — required — (String)

              The certificate chain algorithm provided by sidewalk.

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

              The value of the chosen sidewalk certificate.

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.

        • LastUplinkReceivedAt — (String)

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

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.

Service Reference:

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.

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.

      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.

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'
    },
    Sidewalk: {
      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.

      • 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"

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.

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.

      • Key — required — (String)

        The tag's key value.

      • Value — required — (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.

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.

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

      The list of wireless device log options.

      • Type — required — (String)

        The wireless device type.

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

        The log level for a log message.

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

        The list of wireless device event log options.

        • Event — required — (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"
        • LogLevel — required — (String)

          The log level for a log message.

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

      The list of wireless gateway log options.

      • Type — required — (String)

        The wireless gateway type.

        Possible values include:
        • "LoRaWAN"
      • LogLevel — required — (String)

        The log level for a log message.

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

        The list of wireless gateway event log options.

        • Event — required — (String)

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

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

          The log level for a log message.

          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.

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.

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: {
    DeviceProfileId: 'STRING_VALUE',
    ServiceProfileId: 'STRING_VALUE'
  },
  Name: 'STRING_VALUE'
};
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.

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 */
  ],
  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.

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.