Amazon Web Services, Inc.

AWS IoT Wireless

AWS IoT Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk…

IoT & devices#openapi#cloud

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

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 . You can use both IPv4 and IPv6 protocols to connect
to the endpoints and send requests to the AWS IoT Wireless service. For more information,
see Using
IPv6 with AWS IoT Wireless .

Endpoints 112

  • GETList partner accounts/partner-accounts?nextToken=string&maxResults=0Lists the partner accounts associated with your AWS account.
  • POSTAssociate aws account with partner account/partner-accountsAssociates a partner account with your AWS account.
  • PUTAssociate multicast group with fuota task/fuota-tasks/:Id/multicast-groupAssociate a multicast group with a FUOTA task.
  • PUTAssociate wireless device with fuota task/fuota-tasks/:Id/wireless-deviceAssociate a wireless device with a FUOTA task.
  • PUTAssociate wireless device with multicast group/multicast-groups/:Id/wireless-deviceAssociates a wireless device with a multicast group.
  • PUTAssociate wireless device with thing/wireless-devices/:Id/thingAssociates a wireless device with a thing.
  • DELETEDisassociate wireless device from thing/wireless-devices/:Id/thingDisassociates a wireless device from its currently associated thing.
  • GETGet wireless gateway certificate/wireless-gateways/:Id/certificateGets the ID of the certificate that is currently associated with a wireless gateway.
  • PUTAssociate wireless gateway with certificate/wireless-gateways/:Id/certificateAssociates a wireless gateway with a certificate.
  • DELETEDisassociate wireless gateway from certificate/wireless-gateways/:Id/certificateDisassociates a wireless gateway from its currently associated certificate.
  • PUTAssociate wireless gateway with thing/wireless-gateways/:Id/thingAssociates a wireless gateway with a thing.
  • DELETEDisassociate wireless gateway from thing/wireless-gateways/:Id/thingDisassociates a wireless gateway from its currently associated thing.
  • GETGet multicast group session/multicast-groups/:Id/sessionGets information about a multicast group session.
  • PUTStart multicast group session/multicast-groups/:Id/sessionStarts a multicast group session.
  • DELETECancel multicast group session/multicast-groups/:Id/sessionCancels an existing multicast group session.
  • GETList destinations/destinations?maxResults=0&nextToken=stringLists the destinations registered to your AWS account.
  • POSTCreate destination/destinationsCreates a new destination that maps a device message to an AWS IoT rule.
  • GETList device profiles/device-profiles?nextToken=string&maxResults=0&deviceProfileType=stringLists the device profiles registered to your AWS account.
  • POSTCreate device profile/device-profilesCreates a new device profile.
  • GETList fuota tasks/fuota-tasks?nextToken=string&maxResults=0Lists the FUOTA tasks registered to your AWS account.
  • POSTCreate fuota task/fuota-tasksCreates a FUOTA task.
  • GETList multicast groups/multicast-groups?nextToken=string&maxResults=0Lists the multicast groups registered to your AWS account.
  • POSTCreate multicast group/multicast-groupsCreates a multicast group.
  • GETList network analyzer configurations/network-analyzer-configurations?maxResults=0&nextToken=stringLists the network analyzer configurations.
  • POSTCreate network analyzer configuration/network-analyzer-configurationsCreates a new network analyzer configuration.
  • GETList service profiles/service-profiles?nextToken=string&maxResults=0Lists the service profiles registered to your AWS account.
  • POSTCreate service profile/service-profilesCreates a new service profile.
  • GETList wireless devices/wireless-devices?maxResults=0&nextToken=string&destinationName=string&deviceProfileId=string&serviceProfileId=string&wirelessDeviceType=string&fuotaTaskId=string&multicastGroupId=stringLists the wireless devices registered to your AWS account.
  • POSTCreate wireless device/wireless-devicesProvisions a wireless device.
  • GETList wireless gateways/wireless-gateways?nextToken=string&maxResults=0Lists the wireless gateways registered to your AWS account.
  • POSTCreate wireless gateway/wireless-gatewaysProvisions a wireless gateway. When provisioning a wireless gateway, you might run into duplication errors for the following reasons. If you specify a…
  • GETGet wireless gateway task/wireless-gateways/:Id/tasksGets information about a wireless gateway task.
  • POSTCreate wireless gateway task/wireless-gateways/:Id/tasksCreates a task for a wireless gateway.
  • DELETEDelete wireless gateway task/wireless-gateways/:Id/tasksDeletes a wireless gateway task.
  • GETList wireless gateway task definitions/wireless-gateway-task-definitions?maxResults=0&nextToken=string&taskDefinitionType=stringList the wireless gateway tasks definitions registered to your AWS account.
  • POSTCreate wireless gateway task definition/wireless-gateway-task-definitionsCreates a gateway task definition.
  • GETGet destination/destinations/:NameGets information about a destination.
  • DELETEDelete destination/destinations/:NameDeletes a destination.
  • PATCHUpdate destination/destinations/:NameUpdates properties of a destination.
  • GETGet device profile/device-profiles/:IdGets information about a device profile.
  • DELETEDelete device profile/device-profiles/:IdDeletes a device profile.
  • GETGet fuota task/fuota-tasks/:IdGets information about a FUOTA task.
  • PUTStart fuota task/fuota-tasks/:IdStarts a FUOTA task.
  • DELETEDelete fuota task/fuota-tasks/:IdDeletes a FUOTA task.
  • PATCHUpdate fuota task/fuota-tasks/:IdUpdates properties of a FUOTA task.
  • GETGet multicast group/multicast-groups/:IdGets information about a multicast group.
  • DELETEDelete multicast group/multicast-groups/:IdDeletes a multicast group if it is not in use by a FUOTA task.
  • PATCHUpdate multicast group/multicast-groups/:IdUpdates properties of a multicast group session.
  • GETGet network analyzer configuration/network-analyzer-configurations/:ConfigurationNameGet network analyzer configuration.
  • DELETEDelete network analyzer configuration/network-analyzer-configurations/:ConfigurationNameDeletes a network analyzer configuration.
  • PATCHUpdate network analyzer configuration/network-analyzer-configurations/:ConfigurationNameUpdate network analyzer configuration.
  • GETList queued messages/wireless-devices/:Id/data?nextToken=string&maxResults=0&WirelessDeviceType=stringList queued messages in the downlink queue.
  • POSTSend data to wireless device/wireless-devices/:Id/dataSends a decrypted application data frame to a device.
  • DELETEDelete queued messages/wireless-devices/:Id/data?messageId=string&WirelessDeviceType=stringRemove queued messages from the downlink queue.
  • GETGet service profile/service-profiles/:IdGets information about a service profile.
  • DELETEDelete service profile/service-profiles/:IdDeletes a service profile.
  • DELETEDelete wireless device/wireless-devices/:IdDeletes a wireless device.
  • PATCHUpdate wireless device/wireless-devices/:IdUpdates properties of a wireless device.
  • GETGet wireless device import task/wireless_device_import_task/:IdGet information about an import task and count of device onboarding summary information for the import task.
  • DELETEDelete wireless device import task/wireless_device_import_task/:IdDelete an import task.
  • PATCHUpdate wireless device import task/wireless_device_import_task/:IdUpdate an import task to add more devices to the task.
  • DELETEDelete wireless gateway/wireless-gateways/:IdDeletes a wireless gateway. When deleting a wireless gateway, you might run into duplication errors for the following reasons. If you specify a GatewayEui…
  • PATCHUpdate wireless gateway/wireless-gateways/:IdUpdates properties of a wireless gateway.
  • GETGet wireless gateway task definition/wireless-gateway-task-definitions/:IdGets information about a wireless gateway task definition.
  • DELETEDelete wireless gateway task definition/wireless-gateway-task-definitions/:IdDeletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.
  • PATCHDeregister wireless device/wireless-devices/:Identifier/deregister?WirelessDeviceType=stringDeregister a wireless device from AWS IoT Wireless.
  • GETGet partner account/partner-accounts/:PartnerAccountId?partnerType=stringGets information about a partner account. If PartnerAccountId and PartnerType are null , returns all partner accounts.
  • DELETEDisassociate aws account from partner account/partner-accounts/:PartnerAccountId?partnerType=stringDisassociates your AWS account from a partner account. If PartnerAccountId and PartnerType are null , disassociates your AWS account from all partner accounts.
  • PATCHUpdate partner account/partner-accounts/:PartnerAccountId?partnerType=stringUpdates properties of a partner account.
  • DELETEDisassociate multicast group from fuota task/fuota-tasks/:Id/multicast-groups/:MulticastGroupIdDisassociates a multicast group from a FUOTA task.
  • DELETEDisassociate wireless device from fuota task/fuota-tasks/:Id/wireless-devices/:WirelessDeviceIdDisassociates a wireless device from a FUOTA task.
  • DELETEDisassociate wireless device from multicast group/multicast-groups/:Id/wireless-devices/:WirelessDeviceIdDisassociates a wireless device from a multicast group.
  • GETGet event configuration by resource types/event-configurations-resource-typesGet the event configuration based on resource types.
  • PATCHUpdate event configuration by resource types/event-configurations-resource-typesUpdate the event configuration based on resource types.
  • GETGet log levels by resource types/log-levelsReturns current default log levels or log levels by resource types. Based on the resource type, log levels can be returned for wireless device, wireless…
  • POSTUpdate log levels by resource types/log-levelsSet default log level, or log levels by resource types. This can be for wireless device, wireless gateway, or FUOTA task log options, and is used to control…
  • DELETEReset all resource log levels/log-levelsRemoves the log-level overrides for all resources; wireless devices, wireless gateways, and FUOTA tasks.
  • GETGet metric configuration/metric-configurationGet the metric configuration status for this AWS account.
  • PUTUpdate metric configuration/metric-configurationUpdate the summary metric configuration.
  • POSTGet metrics/metricsGet the summary metrics for this AWS account.
  • GETGet position/positions/:ResourceIdentifier?resourceType=stringDeprecated. Get the position information for a given resource. This action is no longer supported. Calls to retrieve the position information should use the…
  • PATCHUpdate position/positions/:ResourceIdentifier?resourceType=stringDeprecated. Update the position information of a resource. This action is no longer supported. Calls to update the position information should use the…
  • GETGet position configuration/position-configurations/:ResourceIdentifier?resourceType=stringDeprecated. Get position configuration for a given resource. This action is no longer supported. Calls to retrieve the position configuration should use the…
  • PUTPut position configuration/position-configurations/:ResourceIdentifier?resourceType=stringDeprecated. Put position configuration for a given resource. This action is no longer supported. Calls to update the position configuration should use the…
  • POSTGet position estimate/position-estimateGet estimated position information as a payload in GeoJSON format. The payload measurement data is resolved using solvers that are provided by third-party…
  • GETGet resource event configuration/event-configurations/:Identifier?identifierType=string&partnerType=stringGet the event configuration for a particular resource identifier.
  • PATCHUpdate resource event configuration/event-configurations/:Identifier?identifierType=string&partnerType=stringUpdate the event configuration for a particular resource identifier.
  • GETGet resource log level/log-levels/:ResourceIdentifier?resourceType=stringFetches the log-level override, if any, for a given resource ID and resource type..
  • PUTPut resource log level/log-levels/:ResourceIdentifier?resourceType=stringSets the log-level override for a resource ID and resource type. A limit of 200 log level override can be set per account.
  • DELETEReset resource log level/log-levels/:ResourceIdentifier?resourceType=stringRemoves 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.
  • GETGet resource position/resource-positions/:ResourceIdentifier?resourceType=stringGet the position information for a given wireless device or a wireless gateway resource. The position information uses the World Geodetic System (WGS84) .
  • PATCHUpdate resource position/resource-positions/:ResourceIdentifier?resourceType=stringUpdate the position information of a given wireless device or a wireless gateway resource. The position coordinates are based on the World Geodetic System…
  • GETGet service endpoint/service-endpoint?serviceType=stringGets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.
  • GETGet wireless device/wireless-devices/:Identifier?identifierType=stringGets information about a wireless device.
  • GETGet wireless device statistics/wireless-devices/:WirelessDeviceId/statisticsGets operating information about a wireless device.
  • GETGet wireless gateway/wireless-gateways/:Identifier?identifierType=stringGets information about a wireless gateway.
  • GETGet wireless gateway firmware information/wireless-gateways/:Id/firmware-informationGets the firmware version and other information about a wireless gateway.
  • GETGet wireless gateway statistics/wireless-gateways/:WirelessGatewayId/statisticsGets operating information about a wireless gateway.
  • GETList devices for wireless device import task/wireless_device_import_task?id=string&maxResults=0&nextToken=string&status=stringList the Sidewalk devices in an import task and their onboarding status.
  • POSTStart wireless device import task/wireless_device_import_taskStart import task for provisioning Sidewalk devices in bulk using an S3 CSV file.
  • GETList event configurations/event-configurations?resourceType=string&maxResults=0&nextToken=stringList event configurations where at least one event topic has been enabled.
  • GETList multicast groups by fuota task/fuota-tasks/:Id/multicast-groups?nextToken=string&maxResults=0List all multicast groups associated with a FUOTA task.
  • GETList position configurations/position-configurations?resourceType=string&maxResults=0&nextToken=stringDeprecated. List position configurations for a given resource, such as positioning solvers. This action is no longer supported. Calls to retrieve position…
  • GETList tags for resource/tags?resourceArn=stringLists the tags (metadata) you have assigned to the resource.
  • POSTTag resource/tags?resourceArn=stringAdds a tag to a resource.
  • DELETEUntag resource/tags?resourceArn=string&tagKeys=Removes one or more tags from a resource.
  • GETList wireless device import tasks/wireless_device_import_tasks?maxResults=0&nextToken=stringList of import tasks and summary information of onboarding status of devices in each import task.
  • POSTSend data to multicast group/multicast-groups/:Id/dataSends the specified data to a multicast group.
  • POSTStart bulk disassociate wireless device from multicast group/multicast-groups/:Id/bulkStarts a bulk disassociatin of all qualifying wireless devices from a multicast group.
  • PATCHStart bulk associate wireless device with multicast group/multicast-groups/:Id/bulkStarts a bulk association of all qualifying wireless devices with a multicast group.
  • POSTStart single wireless device import task/wireless_single_device_import_taskStart import task for a single wireless device.
  • POSTTest wireless device/wireless-devices/:Id/testSimulates a provisioned device by sending an uplink data payload of Hello .

API details

Base URL
https://api.iotwireless.{region}.amazonaws.com
Authentication
AWS Signature Version 4 (requests signed with your AWS access key)
Operations
112 operations on 60 pathsGET 43DELETE 23POST 21PATCH 14PUT 11
5 marked deprecated
Description format
AWS Smithy model, API version 2020-11-22

How to test the AWS IoT Wireless in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the AWS IoT Wireless collection, without the publisher's secrets.
  3. Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “List partner accounts” (GET /partner-accounts?nextToken=string&maxResults=0), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the AWS IoT Wireless?

AWS IoT Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk… It is listed under IoT & devices and has 112 endpoints.

Who publishes the AWS IoT Wireless?

It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.

What is the base URL of the AWS IoT Wireless?

Requests go to https://api.iotwireless.{region}.amazonaws.com. Endpoint paths are added to this base URL.

How do I authenticate with the AWS IoT Wireless?

With AWS Signature Version 4 (requests signed with your AWS access key).

How many endpoints does the AWS IoT Wireless have?

112 operations on 60 paths (43 GET, 23 DELETE, 21 POST, 14 PATCH, 11 PUT).

Is forking the AWS IoT Wireless free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.