Module types

Data structures used by operation inputs/outputs.

Modules

builders

Builders

error

Error types that AWS IoT Wireless can respond with.

Structs

AbpV11

ABP device object for LoRaWAN specification v1.1

AbpV10X

ABP device object for LoRaWAN specification v1.0.x

Accuracy

The accuracy of the estimated position in meters. An empty value indicates that no position data is available. A value of ‘0.0’ value indicates that position data is available. This data corresponds to the position information that you specified instead of the position computed by solver.

ApplicationConfig

LoRaWAN application configuration, which can be used to perform geolocation.

Beaconing

Beaconing parameters for configuring the wireless gateways.

CdmaLocalId

CDMA local ID information, which corresponds to the local identification parameters of a CDMA cell.

CdmaNmrObj

CDMA object for network measurement reports.

CdmaObj

CDMA (Code-division multiple access) object.

CellTowers

The cell towers that were used to perform the measurements.

CertificateList

List of sidewalk certificates.

ConnectionStatusEventConfiguration

Connection status event configuration object for enabling or disabling topic.

ConnectionStatusResourceTypeEventConfiguration

Connection status resource type event configuration object for enabling or disabling topic.

DakCertificateMetadata

The device attestation key (DAK) information.

Destinations

Describes a destination.

DeviceProfile

Describes a device profile.

DeviceRegistrationStateEventConfiguration

Device registration state event configuration object for enabling and disabling relevant topics.

DeviceRegistrationStateResourceTypeEventConfiguration

Device registration state resource type event configuration object for enabling or disabling topic.

Dimension

The required list of dimensions for the metric.

DownlinkQueueMessage

The message in the downlink queue.

EventConfigurationItem

Event configuration object for a single resource.

EventNotificationItemConfigurations

Object of all event configurations and the status of the event topics.

FPorts

List of FPort assigned for different LoRaWAN application packages to use

FuotaTask

A FUOTA task.

FuotaTaskEventLogOption

The log options for a FUOTA task event and can be used to set log levels for a specific FUOTA task event.

For a LoRaWAN FUOTA task, the only possible event for a log message is Fuota.

FuotaTaskLogOption

The log options for FUOTA tasks and can be used to set log levels for a specific type of FUOTA task.

GatewayListItem

Gateway list item object that specifies the frequency and list of gateways for which the downlink message should be sent.

GlobalIdentity

Global identity information.

Gnss

Global navigation satellite system (GNSS) object used for positioning.

GsmLocalId

GSM local ID information, which corresponds to the local identification parameters of a GSM cell.

GsmNmrObj

GSM object for network measurement reports.

GsmObj

GSM object.

ImportedSidewalkDevice

Information about a Sidewalk device that has been added to an import task.

ImportedWirelessDevice

Information about a wireless device that has been added to an import task.

Ip

IP address used for resolving device location.

JoinEventConfiguration

Join event configuration object for enabling or disabling topic.

JoinResourceTypeEventConfiguration

Join resource type event configuration object for enabling or disabling topic.

LoRaWanConnectionStatusEventNotificationConfigurations

Object for LoRaWAN connection status resource type event configuration.

LoRaWanConnectionStatusResourceTypeEventConfiguration

Object for LoRaWAN connection status resource type event configuration.

LoRaWanDevice

LoRaWAN object for create functions.

LoRaWanDeviceMetadata

LoRaWAN device metatdata.

LoRaWanDeviceProfile

LoRaWANDeviceProfile object.

LoRaWanFuotaTask

The LoRaWAN information used with a FUOTA task.

LoRaWanFuotaTaskGetInfo

The LoRaWAN information returned from getting a FUOTA task.

LoRaWanGateway

LoRaWANGateway object.

LoRaWanGatewayCurrentVersion

LoRaWANGatewayCurrentVersion object.

LoRaWanGatewayMetadata

LoRaWAN gateway metatdata.

LoRaWanGatewayVersion

LoRaWANGatewayVersion object.

LoRaWanGetServiceProfileInfo

LoRaWANGetServiceProfileInfo object.

LoRaWanJoinEventNotificationConfigurations

Object for LoRaWAN join resource type event configuration.

LoRaWanJoinResourceTypeEventConfiguration

Object for LoRaWAN join resource type event configuration.

LoRaWanListDevice

LoRaWAN object for list functions.

LoRaWanMulticast

The LoRaWAN information that is to be used with the multicast group.

LoRaWanMulticastGet

The LoRaWAN information that is to be returned from getting multicast group information.

LoRaWanMulticastMetadata

The metadata information of the LoRaWAN multicast group.

LoRaWanMulticastSession

The LoRaWAN information used with the multicast session.

LoRaWanPublicGatewayMetadata

LoRaWAN public gateway metadata.

LoRaWanSendDataToDevice

LoRaWAN router info.

LoRaWanServiceProfile

LoRaWANServiceProfile object.

LoRaWanStartFuotaTask

The LoRaWAN information used to start a FUOTA task.

LoRaWanUpdateDevice

LoRaWAN object for update functions.

LoRaWanUpdateGatewayTaskCreate

LoRaWANUpdateGatewayTaskCreate object.

LoRaWanUpdateGatewayTaskEntry

LoRaWANUpdateGatewayTaskEntry object.

LteLocalId

LTE local identification (local ID) information.

LteNmrObj

LTE object for network measurement reports.

LteObj

LTE object.

MessageDeliveryStatusEventConfiguration

Message delivery status event configuration object for enabling and disabling relevant topics.

MessageDeliveryStatusResourceTypeEventConfiguration

Message delivery status resource type event configuration object for enabling or disabling relevant topic.

MetricQueryValue

The aggregated values of the metric.

MulticastGroup

A multicast group.

MulticastGroupByFuotaTask

A multicast group that is associated with a FUOTA task.

MulticastWirelessMetadata

Wireless metadata that is to be sent to multicast group.

NetworkAnalyzerConfigurations

Network analyzer configurations.

OtaaV11

OTAA device object for v1.1

OtaaV10X

OTAA device object for v1.0.x

ParticipatingGateways

Specify the list of gateways to which you want to send downlink data traffic when the wireless device is running in class B or class C mode.

ParticipatingGatewaysMulticast

Specify the list of gateways to which you want to send the multicast downlink messages. The multicast message will be sent to each gateway in the list, with the transmission interval as the time interval between each message.

PositionConfigurationItem

The wrapper for a position configuration.

PositionSolverConfigurations

The wrapper for position solver configurations.

PositionSolverDetails

The wrapper for position solver details.

Positioning

The FPorts for the position information.

ProximityEventConfiguration

Proximity event configuration object for enabling and disabling relevant topics.

ProximityResourceTypeEventConfiguration

Proximity resource type event configuration object for enabling or disabling topic.

SemtechGnssConfiguration

Information about the Semtech GNSS solver configuration.

SemtechGnssDetail

Details of the Semtech GNSS solver object.

ServiceProfile

Information about a service profile.

SessionKeysAbpV11

Session keys for ABP v1.1

SessionKeysAbpV10X

Session keys for ABP v1.1

SidewalkAccountInfo

Information about a Sidewalk account.

SidewalkAccountInfoWithFingerprint

Information about a Sidewalk account.

SidewalkCreateDeviceProfile

Sidewalk object for creating a device profile.

SidewalkCreateWirelessDevice

Sidewalk object for creating a wireless device.

SidewalkDevice

Sidewalk device object.

SidewalkDeviceMetadata

MetaData for Sidewalk device.

SidewalkEventNotificationConfigurations

SidewalkEventNotificationConfigurations object, which is the event configuration object for Sidewalk-related event topics.

SidewalkGetDeviceProfile

Gets information about a Sidewalk device profile.

SidewalkGetStartImportInfo

Sidewalk-related information for devices in an import task that are being onboarded.

SidewalkListDevice

Sidewalk object used by list functions.

SidewalkResourceTypeEventConfiguration

Sidewalk resource type event configuration object for enabling or disabling topic.

SidewalkSendDataToDevice

Information about a Sidewalk router.

SidewalkSingleStartImportInfo

Information about an import task created for an individual Sidewalk device.

SidewalkStartImportInfo

Information about an import task created for bulk provisioning.

SidewalkUpdateAccount

Sidewalk update.

SidewalkUpdateImportInfo

Sidewalk object information for updating an import task.

SummaryMetricConfiguration

The configuration of summary metrics.

SummaryMetricQuery

The summary metric query object.

SummaryMetricQueryResult

The result of the summary metrics aggregation operation.

Tag

A simple label consisting of a customer-defined key-value pair

TdscdmaLocalId

TD-SCDMA local identification (local Id) information.

TdscdmaNmrObj

TD-SCDMA object for network measurement reports.

TdscdmaObj

TD-SCDMA object.

TraceContent

Trace content for your wireless devices, gateways, and multicast groups.

UpdateAbpV11

ABP device object for LoRaWAN specification v1.1

UpdateAbpV10X

ABP device object for LoRaWAN specification v1.0.x

UpdateFPorts

Object for updating the FPorts information.

UpdateWirelessGatewayTaskCreate

UpdateWirelessGatewayTaskCreate object.

UpdateWirelessGatewayTaskEntry

UpdateWirelessGatewayTaskEntry object.

WcdmaLocalId

WCDMA local identification (local ID) information.

WcdmaNmrObj

Network Measurement Reports.

WcdmaObj

WCDMA.

WiFiAccessPoint

Wi-Fi access point.

WirelessDeviceEventLogOption

The log options for a wireless device event and can be used to set log levels for a specific wireless device event.

For a LoRaWAN device, possible events for a log messsage are: Join, Rejoin, Downlink_Data, and Uplink_Data. For a Sidewalk device, possible events for a log message are Registration, Downlink_Data, and Uplink_Data.

WirelessDeviceImportTask

Information about an import task for wireless devices.

WirelessDeviceLogOption

The log options for wireless devices and can be used to set log levels for a specific type of wireless device.

WirelessDeviceStatistics

Information about a wireless device's operation.

WirelessGatewayEventLogOption

The log options for a wireless gateway event and can be used to set log levels for a specific wireless gateway event.

For a LoRaWAN gateway, possible events for a log message are CUPS_Request and Certificate.

WirelessGatewayLogOption

The log options for wireless gateways and can be used to set log levels for a specific type of wireless gateway.

WirelessGatewayStatistics

Information about a wireless gateway's operation.

WirelessMetadata

WirelessMetadata object.

Enums

AggregationPeriod

When writing a match expression against AggregationPeriod, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ApplicationConfigType

When writing a match expression against ApplicationConfigType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

BatteryLevel

When writing a match expression against BatteryLevel, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ConnectionStatus

When writing a match expression against ConnectionStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DeviceProfileType

When writing a match expression against DeviceProfileType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DeviceState

When writing a match expression against DeviceState, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DimensionName

When writing a match expression against DimensionName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DlClass

When writing a match expression against DlClass, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

DownlinkMode

When writing a match expression against DownlinkMode, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

Event

When writing a match expression against Event, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EventNotificationPartnerType

When writing a match expression against EventNotificationPartnerType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EventNotificationResourceType

When writing a match expression against EventNotificationResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

EventNotificationTopicStatus

When writing a match expression against EventNotificationTopicStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ExpressionType

When writing a match expression against ExpressionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FuotaDeviceStatus

When writing a match expression against FuotaDeviceStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FuotaTaskEvent

When writing a match expression against FuotaTaskEvent, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FuotaTaskStatus

When writing a match expression against FuotaTaskStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

FuotaTaskType

When writing a match expression against FuotaTaskType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

IdentifierType

When writing a match expression against IdentifierType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

ImportTaskStatus

When writing a match expression against ImportTaskStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

LogLevel

When writing a match expression against LogLevel, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MessageType

When writing a match expression against MessageType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MetricName

When writing a match expression against MetricName, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MetricQueryStatus

When writing a match expression against MetricQueryStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

MulticastFrameInfo

When writing a match expression against MulticastFrameInfo, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

OnboardStatus

When writing a match expression against OnboardStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PartnerType

When writing a match expression against PartnerType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PositionConfigurationFec

When writing a match expression against PositionConfigurationFec, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PositionConfigurationStatus

When writing a match expression against PositionConfigurationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PositionResourceType

When writing a match expression against PositionResourceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PositionSolverProvider

When writing a match expression against PositionSolverProvider, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PositionSolverType

When writing a match expression against PositionSolverType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

PositioningConfigStatus

When writing a match expression against PositioningConfigStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SigningAlg

When writing a match expression against SigningAlg, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SummaryMetricConfigurationStatus

When writing a match expression against SummaryMetricConfigurationStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

SupportedRfRegion

When writing a match expression against SupportedRfRegion, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

WirelessDeviceEvent

When writing a match expression against WirelessDeviceEvent, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

WirelessDeviceFrameInfo

When writing a match expression against WirelessDeviceFrameInfo, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

WirelessDeviceIdType

When writing a match expression against WirelessDeviceIdType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

WirelessDeviceSidewalkStatus

When writing a match expression against WirelessDeviceSidewalkStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

WirelessDeviceType

When writing a match expression against WirelessDeviceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

WirelessGatewayEvent

When writing a match expression against WirelessGatewayEvent, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

WirelessGatewayIdType

When writing a match expression against WirelessGatewayIdType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

WirelessGatewayServiceType

When writing a match expression against WirelessGatewayServiceType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

WirelessGatewayTaskDefinitionType

When writing a match expression against WirelessGatewayTaskDefinitionType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

WirelessGatewayTaskStatus

When writing a match expression against WirelessGatewayTaskStatus, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.

WirelessGatewayType

When writing a match expression against WirelessGatewayType, it is important to ensure your code is forward-compatible. That is, if a match arm handles a case for a feature that is supported by the service but has not been represented as an enum variant in a current version of SDK, your code should continue to work when you upgrade SDK to a future version in which the enum does include a variant for that feature.