amazonaws.com – iotwireless

OpenAPI apis-guru cloud

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.

Homepage: https://api.apis.guru/v2/specs/amazonaws.com:iotwireless/2020-11-22.json
Provider: amazonaws.com:iotwireless / iotwireless
OpenAPI version: 3.0.0
Spec (JSON): https://api.apis.guru/v2/specs/amazonaws.com/iotwireless/2020-11-22/openapi.json
Spec (YAML): https://api.apis.guru/v2/specs/amazonaws.com/iotwireless/2020-11-22/openapi.yaml

Tools (111)

Extracted live via the executor SDK.

destinations.createDestination

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

Deletes a destination.
destinations.getDestination

Gets information about a destination.
destinations.listDestinations

Lists the destinations registered to your AWS account.
destinations.updateDestination

Updates properties of a destination.
deviceProfiles.createDeviceProfile

Creates a new device profile.
deviceProfiles.deleteDeviceProfile

Deletes a device profile.
deviceProfiles.getDeviceProfile

Gets information about a device profile.
deviceProfiles.listDeviceProfiles

Lists the device profiles registered to your AWS account.
eventConfigurations.getResourceEventConfiguration

Get the event configuration for a particular resource identifier.
eventConfigurations.updateResourceEventConfiguration

Update the event configuration for a particular resource identifier.
eventConfigurationsResourceType.listEventConfigurations

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

Get the event configuration based on resource types.
eventConfigurationsResourceTypes.updateEventConfigurationByResourceTypes

Update the event configuration based on resource types.
fuotaTasks.associateMulticastGroupWithFuotaTask

Associate a multicast group with a FUOTA task.
fuotaTasks.associateWirelessDeviceWithFuotaTask

Associate a wireless device with a FUOTA task.
fuotaTasks.createFuotaTask

Creates a FUOTA task.
fuotaTasks.deleteFuotaTask

Deletes a FUOTA task.
fuotaTasks.disassociateMulticastGroupFromFuotaTask

Disassociates a multicast group from a fuota task.
fuotaTasks.disassociateWirelessDeviceFromFuotaTask

Disassociates a wireless device from a FUOTA task.
fuotaTasks.getFuotaTask

Gets information about a FUOTA task.
fuotaTasks.listFuotaTasks

Lists the FUOTA tasks registered to your AWS account.
fuotaTasks.listMulticastGroupsByFuotaTask

List all multicast groups associated with a fuota task.
fuotaTasks.startFuotaTask

Starts a FUOTA task.
fuotaTasks.updateFuotaTask

Updates properties of a FUOTA task.
logLevels.getLogLevelsByResourceTypes

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.
logLevels.getResourceLogLevel

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.
logLevels.putResourceLogLevel

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.
logLevels.resetAllResourceLogLevels

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

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.
logLevels.updateLogLevelsByResourceTypes

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.
multicastGroups.associateWirelessDeviceWithMulticastGroup

Associates a wireless device with a multicast group.
multicastGroups.cancelMulticastGroupSession

Cancels an existing multicast group session.
multicastGroups.createMulticastGroup

Creates a multicast group.
multicastGroups.deleteMulticastGroup

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

Disassociates a wireless device from a multicast group.
multicastGroups.getMulticastGroup

Gets information about a multicast group.
multicastGroups.getMulticastGroupSession

Gets information about a multicast group session.
multicastGroups.listMulticastGroups

Lists the multicast groups registered to your AWS account.
multicastGroups.sendDataToMulticastGroup

Sends the specified data to a multicast group.
multicastGroups.startBulkAssociateWirelessDeviceWithMulticastGroup

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

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

Starts a multicast group session.
multicastGroups.updateMulticastGroup

Updates properties of a multicast group session.
networkAnalyzerConfigurations.createNetworkAnalyzerConfiguration

Creates a new network analyzer configuration.
networkAnalyzerConfigurations.deleteNetworkAnalyzerConfiguration

Deletes a network analyzer configuration.
networkAnalyzerConfigurations.getNetworkAnalyzerConfiguration

Get network analyzer configuration.
networkAnalyzerConfigurations.listNetworkAnalyzerConfigurations

Lists the network analyzer configurations.
networkAnalyzerConfigurations.updateNetworkAnalyzerConfiguration

Update network analyzer configuration.
partnerAccounts.associateAwsAccountWithPartnerAccount

Associates a partner account with your AWS account.
partnerAccounts.disassociateAwsAccountFromPartnerAccount

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

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

Lists the partner accounts associated with your AWS account.
partnerAccounts.updatePartnerAccount

Updates properties of a partner account.
positionConfigurations.getPositionConfiguration

Get position configuration for a given resource.

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

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 API operation instead.
positionConfigurations.putPositionConfiguration

Put position configuration for a given resource.

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

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.
positions.getPosition

Get the position information for a given resource.

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

Update the position information of a resource.

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

Get the position information for a given wireless device or a wireless gateway resource. The position information uses the .
resourcePositions.updateResourcePosition

Update the position information of a given wireless device or a wireless gateway resource. The position coordinates are based on the .
serviceEndpoint.getServiceEndpoint

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

Creates a new service profile.
serviceProfiles.deleteServiceProfile

Deletes a service profile.
serviceProfiles.getServiceProfile

Gets information about a service profile.
serviceProfiles.listServiceProfiles

Lists the service profiles registered to your AWS account.
tagsResourceArn.listTagsForResource

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

Adds a tag to a resource.
tagsResourceArnTagKeys.untagResource

Removes one or more tags from a resource.
wirelessDeviceImportTask.deleteWirelessDeviceImportTask

Delete an import task.
wirelessDeviceImportTask.getWirelessDeviceImportTask

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

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

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

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

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

Associates a wireless device with a thing.
wirelessDevices.createWirelessDevice

Provisions a wireless device.
wirelessDevices.deleteQueuedMessages

Remove queued messages from the downlink queue.
wirelessDevices.deleteWirelessDevice

Deletes a wireless device.
wirelessDevices.deregisterWirelessDevice

Deregister a wireless device from AWS IoT Wireless.
wirelessDevices.disassociateWirelessDeviceFromThing

Disassociates a wireless device from its currently associated thing.
wirelessDevices.getWirelessDevice

Gets information about a wireless device.
wirelessDevices.getWirelessDeviceStatistics

Gets operating information about a wireless device.
wirelessDevices.listQueuedMessages

List queued messages in the downlink queue.
wirelessDevices.listWirelessDevices

Lists the wireless devices registered to your AWS account.
wirelessDevices.sendDataToWirelessDevice

Sends a decrypted application data frame to a device.
wirelessDevices.testWirelessDevice

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

Updates properties of a wireless device.
wirelessGateways.associateWirelessGatewayWithCertificate

Associates a wireless gateway with a certificate.
wirelessGateways.associateWirelessGatewayWithThing

Associates a wireless gateway with a thing.
wirelessGateways.createWirelessGateway

Provisions a wireless gateway.
wirelessGateways.createWirelessGatewayTask

Creates a task for a wireless gateway.
wirelessGateways.deleteWirelessGateway

Deletes a wireless gateway.
wirelessGateways.deleteWirelessGatewayTask

Deletes a wireless gateway task.
wirelessGateways.disassociateWirelessGatewayFromCertificate

Disassociates a wireless gateway from its currently associated certificate.
wirelessGateways.disassociateWirelessGatewayFromThing

Disassociates a wireless gateway from its currently associated thing.
wirelessGateways.getWirelessGateway

Gets information about a wireless gateway.
wirelessGateways.getWirelessGatewayCertificate

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

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

Gets operating information about a wireless gateway.
wirelessGateways.getWirelessGatewayTask

Gets information about a wireless gateway task.
wirelessGateways.listWirelessGateways

Lists the wireless gateways registered to your AWS account.
wirelessGateways.updateWirelessGateway

Updates properties of a wireless gateway.
wirelessGatewayTaskDefinitions.createWirelessGatewayTaskDefinition

Creates a gateway task definition.
wirelessGatewayTaskDefinitions.deleteWirelessGatewayTaskDefinition

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

Gets information about a wireless gateway task definition.
wirelessGatewayTaskDefinitions.listWirelessGatewayTaskDefinitions

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

Start import task for a single wireless device.
openapi.previewSpec

Preview an OpenAPI document before adding it as a source
openapi.addSource

Add an OpenAPI source and register its operations as tools