IotWirelessClient

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.

Properties

Link copied to clipboard
abstract override val config: IotWirelessClient.Config

IotWirelessClient's configuration

Functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Associates a wireless device with a thing.

Link copied to clipboard
Link copied to clipboard

Cancels an existing multicast group session.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun createDeviceProfile(input: CreateDeviceProfileRequest = CreateDeviceProfileRequest { }): CreateDeviceProfileResponse

Creates a new device profile.

Link copied to clipboard

Creates a FUOTA task.

Link copied to clipboard

Creates a multicast group.

Link copied to clipboard
Link copied to clipboard
abstract suspend fun createServiceProfile(input: CreateServiceProfileRequest = CreateServiceProfileRequest { }): CreateServiceProfileResponse

Creates a new service profile.

Link copied to clipboard

Provisions a wireless device.

Link copied to clipboard

Provisions a wireless gateway.

Link copied to clipboard

Creates a task for a wireless gateway.

Link copied to clipboard

Deletes a destination.

Link copied to clipboard

Deletes a device profile.

Link copied to clipboard

Deletes a FUOTA task.

Link copied to clipboard

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

Link copied to clipboard
Link copied to clipboard

Remove queued messages from the downlink queue.

Link copied to clipboard

Deletes a service profile.

Link copied to clipboard

Deletes a wireless device.

Link copied to clipboard

Deletes a wireless gateway.

Link copied to clipboard

Deletes a wireless gateway task.

Link copied to clipboard

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

Link copied to clipboard

Deregister a wireless device from AWS IoT Wireless.

Link copied to clipboard

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

Link copied to clipboard

Disassociates a wireless device from its currently associated thing.

Disassociates a wireless gateway from its currently associated certificate.

Link copied to clipboard

Disassociates a wireless gateway from its currently associated thing.

Link copied to clipboard

Gets information about a destination.

Link copied to clipboard

Gets information about a device profile.

Link copied to clipboard
abstract suspend fun getEventConfigurationByResourceTypes(input: GetEventConfigurationByResourceTypesRequest = GetEventConfigurationByResourceTypesRequest { }): GetEventConfigurationByResourceTypesResponse

Get the event configuration based on resource types.

Link copied to clipboard

Gets information about a FUOTA task.

Link copied to clipboard
abstract suspend fun getLogLevelsByResourceTypes(input: GetLogLevelsByResourceTypesRequest = GetLogLevelsByResourceTypesRequest { }): GetLogLevelsByResourceTypesResponse

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.

Link copied to clipboard

Gets information about a multicast group.

Link copied to clipboard

Gets information about a multicast group session.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun getPosition(input: GetPositionRequest): GetPositionResponse

Get the position information for a given resource.

Link copied to clipboard

Get position configuration for a given resource.

Link copied to clipboard
abstract suspend fun getPositionEstimate(input: GetPositionEstimateRequest = GetPositionEstimateRequest { }): GetPositionEstimateResponse

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.

Link copied to clipboard

Get the event configuration for a particular resource identifier.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun getServiceEndpoint(input: GetServiceEndpointRequest = GetServiceEndpointRequest { }): GetServiceEndpointResponse

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

Link copied to clipboard

Gets information about a service profile.

Link copied to clipboard

Gets information about a wireless device.

Link copied to clipboard

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

Link copied to clipboard

Gets operating information about a wireless device.

Link copied to clipboard

Gets information about a wireless gateway.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Gets operating information about a wireless gateway.

Link copied to clipboard

Gets information about a wireless gateway task.

Link copied to clipboard

Gets information about a wireless gateway task definition.

Link copied to clipboard
abstract suspend fun listDestinations(input: ListDestinationsRequest = ListDestinationsRequest { }): ListDestinationsResponse

Lists the destinations registered to your AWS account.

Link copied to clipboard
abstract suspend fun listDeviceProfiles(input: ListDeviceProfilesRequest = ListDeviceProfilesRequest { }): ListDeviceProfilesResponse

Lists the device profiles registered to your AWS account.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun listFuotaTasks(input: ListFuotaTasksRequest = ListFuotaTasksRequest { }): ListFuotaTasksResponse

Lists the FUOTA tasks registered to your AWS account.

Link copied to clipboard
abstract suspend fun listMulticastGroups(input: ListMulticastGroupsRequest = ListMulticastGroupsRequest { }): ListMulticastGroupsResponse

Lists the multicast groups registered to your AWS account.

Link copied to clipboard

List all multicast groups associated with a fuota task.

Link copied to clipboard
abstract suspend fun listNetworkAnalyzerConfigurations(input: ListNetworkAnalyzerConfigurationsRequest = ListNetworkAnalyzerConfigurationsRequest { }): ListNetworkAnalyzerConfigurationsResponse

Lists the network analyzer configurations.

Link copied to clipboard
abstract suspend fun listPartnerAccounts(input: ListPartnerAccountsRequest = ListPartnerAccountsRequest { }): ListPartnerAccountsResponse

Lists the partner accounts associated with your AWS account.

Link copied to clipboard
abstract suspend fun listPositionConfigurations(input: ListPositionConfigurationsRequest = ListPositionConfigurationsRequest { }): ListPositionConfigurationsResponse

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

Link copied to clipboard

List queued messages in the downlink queue.

Link copied to clipboard
abstract suspend fun listServiceProfiles(input: ListServiceProfilesRequest = ListServiceProfilesRequest { }): ListServiceProfilesResponse

Lists the service profiles registered to your AWS account.

Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun listWirelessDeviceImportTasks(input: ListWirelessDeviceImportTasksRequest = ListWirelessDeviceImportTasksRequest { }): ListWirelessDeviceImportTasksResponse

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

Link copied to clipboard
abstract suspend fun listWirelessDevices(input: ListWirelessDevicesRequest = ListWirelessDevicesRequest { }): ListWirelessDevicesResponse

Lists the wireless devices registered to your AWS account.

Link copied to clipboard
abstract suspend fun listWirelessGateways(input: ListWirelessGatewaysRequest = ListWirelessGatewaysRequest { }): ListWirelessGatewaysResponse

Lists the wireless gateways registered to your AWS account.

Link copied to clipboard
abstract suspend fun listWirelessGatewayTaskDefinitions(input: ListWirelessGatewayTaskDefinitionsRequest = ListWirelessGatewayTaskDefinitionsRequest { }): ListWirelessGatewayTaskDefinitionsResponse

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

Link copied to clipboard

Put position configuration for a given resource.

Link copied to clipboard

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.

Link copied to clipboard
abstract suspend fun resetAllResourceLogLevels(input: ResetAllResourceLogLevelsRequest = ResetAllResourceLogLevelsRequest { }): ResetAllResourceLogLevelsResponse

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

Link copied to clipboard

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.

Link copied to clipboard

Sends the specified data to a multicast group.

Link copied to clipboard

Sends a decrypted application data frame to a device.

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

Link copied to clipboard

Starts a FUOTA task.

Link copied to clipboard

Starts a multicast group session.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard
abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds a tag to a resource.

Link copied to clipboard

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

Link copied to clipboard

Removes one or more tags from a resource.

Link copied to clipboard

Updates properties of a destination.

Link copied to clipboard

Update the event configuration based on resource types.

Link copied to clipboard

Updates properties of a FUOTA task.

Link copied to clipboard
abstract suspend fun updateLogLevelsByResourceTypes(input: UpdateLogLevelsByResourceTypesRequest = UpdateLogLevelsByResourceTypesRequest { }): UpdateLogLevelsByResourceTypesResponse

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.

Link copied to clipboard

Updates properties of a multicast group session.

Link copied to clipboard

Updates properties of a partner account.

Link copied to clipboard

Update the position information of a resource.

Link copied to clipboard

Update the event configuration for a particular resource identifier.

Link copied to clipboard

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

Link copied to clipboard

Updates properties of a wireless device.

Link copied to clipboard

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

Link copied to clipboard

Updates properties of a wireless gateway.

Inherited functions

Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard

Cancels an existing multicast group session.

Link copied to clipboard
expect abstract fun close()
Link copied to clipboard

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

Link copied to clipboard

Creates a new device profile.

Link copied to clipboard

Creates a FUOTA task.

Link copied to clipboard

Creates a multicast group.

Link copied to clipboard
Link copied to clipboard

Creates a new service profile.

Link copied to clipboard

Provisions a wireless device.

Link copied to clipboard

Provisions a wireless gateway.

Link copied to clipboard

Creates a task for a wireless gateway.

Link copied to clipboard

Deletes a destination.

Link copied to clipboard

Deletes a device profile.

Link copied to clipboard

Deletes a FUOTA task.

Link copied to clipboard

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

Link copied to clipboard

Remove queued messages from the downlink queue.

Link copied to clipboard

Deletes a service profile.

Link copied to clipboard

Deletes a wireless device.

Link copied to clipboard

Deletes a wireless gateway.

Link copied to clipboard

Deletes a wireless gateway task.

Link copied to clipboard

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

Link copied to clipboard

Deregister a wireless device from AWS IoT Wireless.

Link copied to clipboard

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

Link copied to clipboard

Disassociates a wireless device from its currently associated thing.

Disassociates a wireless gateway from its currently associated certificate.

Link copied to clipboard

Disassociates a wireless gateway from its currently associated thing.

Link copied to clipboard

Gets information about a destination.

Link copied to clipboard

Gets information about a device profile.

Link copied to clipboard

Get the event configuration based on resource types.

Link copied to clipboard

Gets information about a FUOTA task.

Link copied to clipboard

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.

Link copied to clipboard

Gets information about a multicast group.

Link copied to clipboard

Gets information about a multicast group session.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

Get the position information for a given resource.

Link copied to clipboard

Get position configuration for a given resource.

Link copied to clipboard

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.

Link copied to clipboard

Get the event configuration for a particular resource identifier.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Gets information about a service profile.

Link copied to clipboard

Gets information about a wireless device.

Link copied to clipboard

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

Link copied to clipboard

Gets operating information about a wireless device.

Link copied to clipboard

Gets information about a wireless gateway.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Gets operating information about a wireless gateway.

Link copied to clipboard

Gets information about a wireless gateway task.

Link copied to clipboard

Gets information about a wireless gateway task definition.

Link copied to clipboard

Lists the destinations registered to your AWS account.

Link copied to clipboard

Lists the device profiles registered to your AWS account.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Lists the FUOTA tasks registered to your AWS account.

Link copied to clipboard

Lists the multicast groups registered to your AWS account.

Link copied to clipboard

List all multicast groups associated with a fuota task.

Link copied to clipboard
Link copied to clipboard

Lists the partner accounts associated with your AWS account.

Link copied to clipboard

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

Link copied to clipboard

List queued messages in the downlink queue.

Link copied to clipboard

Lists the service profiles registered to your AWS account.

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

Lists the wireless devices registered to your AWS account.

Link copied to clipboard

Lists the wireless gateways registered to your AWS account.

Link copied to clipboard

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

Link copied to clipboard

Put position configuration for a given resource.

Link copied to clipboard

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.

Link copied to clipboard

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

Link copied to clipboard

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.

Link copied to clipboard

Sends the specified data to a multicast group.

Link copied to clipboard

Sends a decrypted application data frame to a device.

Link copied to clipboard

Starts a FUOTA task.

Link copied to clipboard

Starts a multicast group session.

Link copied to clipboard
Link copied to clipboard

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

Link copied to clipboard

Adds a tag to a resource.

Link copied to clipboard

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

Link copied to clipboard

Removes one or more tags from a resource.

Link copied to clipboard

Updates properties of a destination.

Link copied to clipboard

Updates properties of a FUOTA task.

Link copied to clipboard

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.

Link copied to clipboard

Updates properties of a multicast group session.

Link copied to clipboard

Updates properties of a partner account.

Link copied to clipboard

Update the position information of a resource.

Link copied to clipboard

Update the event configuration for a particular resource identifier.

Link copied to clipboard

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

Link copied to clipboard

Updates properties of a wireless device.

Link copied to clipboard

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

Link copied to clipboard

Updates properties of a wireless gateway.

Link copied to clipboard

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.