IoTWirelessClient

Suggest an Edit

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

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

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

To connect to the AWS IoT Wireless Service, use the Service endpoints as described in IoT Wireless Service endpoints  in the AWS General Reference.

Installation

NPM
npm install @aws-sdk/client-iot-wireless
Yarn
yarn add @aws-sdk/client-iot-wireless
pnpm
pnpm add @aws-sdk/client-iot-wireless

IoTWirelessClient Operations

Command
Summary
AssociateAwsAccountWithPartnerAccountCommand

Associates a partner account with your AWS account.

AssociateMulticastGroupWithFuotaTaskCommand

Associate a multicast group with a FUOTA task.

AssociateWirelessDeviceWithFuotaTaskCommand

Associate a wireless device with a FUOTA task.

AssociateWirelessDeviceWithMulticastGroupCommand

Associates a wireless device with a multicast group.

AssociateWirelessDeviceWithThingCommand

Associates a wireless device with a thing.

AssociateWirelessGatewayWithCertificateCommand

Associates a wireless gateway with a certificate.

AssociateWirelessGatewayWithThingCommand

Associates a wireless gateway with a thing.

CancelMulticastGroupSessionCommand

Cancels an existing multicast group session.

CreateDestinationCommand

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

CreateDeviceProfileCommand

Creates a new device profile.

CreateFuotaTaskCommand

Creates a FUOTA task.

CreateMulticastGroupCommand

Creates a multicast group.

CreateNetworkAnalyzerConfigurationCommand

Creates a new network analyzer configuration.

CreateServiceProfileCommand

Creates a new service profile.

CreateWirelessDeviceCommand

Provisions a wireless device.

CreateWirelessGatewayCommand

Provisions a wireless gateway.

When provisioning a wireless gateway, you might run into duplication errors for the following reasons.

  • If you specify a GatewayEui value that already exists.

  • If you used a ClientRequestToken with the same parameters within the last 10 minutes.

To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.

CreateWirelessGatewayTaskCommand

Creates a task for a wireless gateway.

CreateWirelessGatewayTaskDefinitionCommand

Creates a gateway task definition.

DeleteDestinationCommand

Deletes a destination.

DeleteDeviceProfileCommand

Deletes a device profile.

DeleteFuotaTaskCommand

Deletes a FUOTA task.

DeleteMulticastGroupCommand

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

DeleteNetworkAnalyzerConfigurationCommand

Deletes a network analyzer configuration.

DeleteQueuedMessagesCommand

Remove queued messages from the downlink queue.

DeleteServiceProfileCommand

Deletes a service profile.

DeleteWirelessDeviceCommand

Deletes a wireless device.

DeleteWirelessDeviceImportTaskCommand

Delete an import task.

DeleteWirelessGatewayCommand

Deletes a wireless gateway.

When deleting a wireless gateway, you might run into duplication errors for the following reasons.

  • If you specify a GatewayEui value that already exists.

  • If you used a ClientRequestToken with the same parameters within the last 10 minutes.

To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.

DeleteWirelessGatewayTaskCommand

Deletes a wireless gateway task.

DeleteWirelessGatewayTaskDefinitionCommand

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

DeregisterWirelessDeviceCommand

Deregister a wireless device from AWS IoT Wireless.

DisassociateAwsAccountFromPartnerAccountCommand

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

DisassociateMulticastGroupFromFuotaTaskCommand

Disassociates a multicast group from a fuota task.

DisassociateWirelessDeviceFromFuotaTaskCommand

Disassociates a wireless device from a FUOTA task.

DisassociateWirelessDeviceFromMulticastGroupCommand

Disassociates a wireless device from a multicast group.

DisassociateWirelessDeviceFromThingCommand

Disassociates a wireless device from its currently associated thing.

DisassociateWirelessGatewayFromCertificateCommand

Disassociates a wireless gateway from its currently associated certificate.

DisassociateWirelessGatewayFromThingCommand

Disassociates a wireless gateway from its currently associated thing.

GetDestinationCommand

Gets information about a destination.

GetDeviceProfileCommand

Gets information about a device profile.

GetEventConfigurationByResourceTypesCommand

Get the event configuration based on resource types.

GetFuotaTaskCommand

Gets information about a FUOTA task.

GetLogLevelsByResourceTypesCommand

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.

GetMetricConfigurationCommand

Get the metric configuration status for this AWS account.

GetMetricsCommand

Get the summary metrics for this AWS account.

GetMulticastGroupCommand

Gets information about a multicast group.

GetMulticastGroupSessionCommand

Gets information about a multicast group session.

GetNetworkAnalyzerConfigurationCommand

Get network analyzer configuration.

GetPartnerAccountCommand

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

GetPositionCommand

Get the position information for a given resource.

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

GetPositionConfigurationCommand

Get position configuration for a given resource.

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

GetPositionEstimateCommand

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

GetResourceEventConfigurationCommand

Get the event configuration for a particular resource identifier.

GetResourceLogLevelCommand

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

GetResourcePositionCommand

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

GetServiceEndpointCommand

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

GetServiceProfileCommand

Gets information about a service profile.

GetWirelessDeviceCommand

Gets information about a wireless device.

GetWirelessDeviceImportTaskCommand

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

GetWirelessDeviceStatisticsCommand

Gets operating information about a wireless device.

GetWirelessGatewayCertificateCommand

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

GetWirelessGatewayCommand

Gets information about a wireless gateway.

GetWirelessGatewayFirmwareInformationCommand

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

GetWirelessGatewayStatisticsCommand

Gets operating information about a wireless gateway.

GetWirelessGatewayTaskCommand

Gets information about a wireless gateway task.

GetWirelessGatewayTaskDefinitionCommand

Gets information about a wireless gateway task definition.

ListDestinationsCommand

Lists the destinations registered to your AWS account.

ListDeviceProfilesCommand

Lists the device profiles registered to your AWS account.

ListDevicesForWirelessDeviceImportTaskCommand

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

ListEventConfigurationsCommand

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

ListFuotaTasksCommand

Lists the FUOTA tasks registered to your AWS account.

ListMulticastGroupsByFuotaTaskCommand

List all multicast groups associated with a fuota task.

ListMulticastGroupsCommand

Lists the multicast groups registered to your AWS account.

ListNetworkAnalyzerConfigurationsCommand

Lists the network analyzer configurations.

ListPartnerAccountsCommand

Lists the partner accounts associated with your AWS account.

ListPositionConfigurationsCommand

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

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

ListQueuedMessagesCommand

List queued messages in the downlink queue.

ListServiceProfilesCommand

Lists the service profiles registered to your AWS account.

ListTagsForResourceCommand

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

ListWirelessDeviceImportTasksCommand

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

ListWirelessDevicesCommand

Lists the wireless devices registered to your AWS account.

ListWirelessGatewayTaskDefinitionsCommand

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

ListWirelessGatewaysCommand

Lists the wireless gateways registered to your AWS account.

PutPositionConfigurationCommand

Put position configuration for a given resource.

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

PutResourceLogLevelCommand

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.

ResetAllResourceLogLevelsCommand

Removes the log-level overrides for all resources; wireless devices, wireless gateways, and fuota tasks.

ResetResourceLogLevelCommand

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

SendDataToMulticastGroupCommand

Sends the specified data to a multicast group.

SendDataToWirelessDeviceCommand

Sends a decrypted application data frame to a device.

StartBulkAssociateWirelessDeviceWithMulticastGroupCommand

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

StartBulkDisassociateWirelessDeviceFromMulticastGroupCommand

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

StartFuotaTaskCommand

Starts a FUOTA task.

StartMulticastGroupSessionCommand

Starts a multicast group session.

StartSingleWirelessDeviceImportTaskCommand

Start import task for a single wireless device.

StartWirelessDeviceImportTaskCommand

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

TagResourceCommand

Adds a tag to a resource.

TestWirelessDeviceCommand

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

UntagResourceCommand

Removes one or more tags from a resource.

UpdateDestinationCommand

Updates properties of a destination.

UpdateEventConfigurationByResourceTypesCommand

Update the event configuration based on resource types.

UpdateFuotaTaskCommand

Updates properties of a FUOTA task.

UpdateLogLevelsByResourceTypesCommand

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.

UpdateMetricConfigurationCommand

Update the summary metric configuration.

UpdateMulticastGroupCommand

Updates properties of a multicast group session.

UpdateNetworkAnalyzerConfigurationCommand

Update network analyzer configuration.

UpdatePartnerAccountCommand

Updates properties of a partner account.

UpdatePositionCommand

Update the position information of a resource.

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

UpdateResourceEventConfigurationCommand

Update the event configuration for a particular resource identifier.

UpdateResourcePositionCommand

Update the position information of a given wireless device or a wireless gateway resource. The position coordinates are based on the World Geodetic System (WGS84) .

UpdateWirelessDeviceCommand

Updates properties of a wireless device.

UpdateWirelessDeviceImportTaskCommand

Update an import task to add more devices to the task.

UpdateWirelessGatewayCommand

Updates properties of a wireless gateway.

IoTWirelessClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: IoTWirelessClientConfig