String devAddr
The DevAddr value.
SessionKeysAbpV10X sessionKeys
Session keys for ABP v1.0.x
Integer fCntStart
The FCnt init value.
String devAddr
The DevAddr value.
SessionKeysAbpV11 sessionKeys
Session keys for ABP v1.1
Integer fCntStart
The FCnt init value.
Float horizontalAccuracy
The horizontal accuracy of the estimated position, which is the difference between the estimated location and the actual device location.
Float verticalAccuracy
The vertical accuracy of the estimated position, which is the difference between the estimated altitude and actual device latitude in meters.
Integer fPort
String type
Application type, which can be specified to obtain real-time position information of your LoRaWAN device.
String destinationName
The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.
SidewalkAccountInfo sidewalk
The Sidewalk account credentials.
String clientRequestToken
Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
List<E> tags
The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
SidewalkAccountInfo sidewalk
The Sidewalk account credentials.
String arn
The Amazon Resource Name of the resource.
String iotCertificateId
The ID of the certificate associated with the wireless gateway.
String id
Integer pnOffset
Pseudo-noise offset, which is a characteristic of the signal from a cell on a radio tower.
Integer cdmaChannel
CDMA channel information.
Integer pilotPower
Transmit power level of the pilot signal, measured in dBm (decibel-milliwatts).
Integer baseStationId
CDMA base station ID (BSID).
Integer systemId
CDMA system ID (SID).
Integer networkId
CDMA network ID (NID).
Integer baseStationId
CDMA base station ID (BSID).
Integer registrationZone
CDMA registration zone (RZ).
CdmaLocalId cdmaLocalId
CDMA local identification (local ID) parameters.
Integer pilotPower
Transmit power level of the pilot signal, measured in dBm (decibel-milliwatts).
Float baseLat
CDMA base station latitude in degrees.
Float baseLng
CDMA base station longitude in degrees.
List<E> cdmaNmr
CDMA network measurement reports.
LoRaWANConnectionStatusEventNotificationConfigurations loRaWAN
Connection status event configuration object for enabling or disabling LoRaWAN related event topics.
String wirelessGatewayIdEventTopic
Denotes whether the wireless gateway ID connection status event topic is enabled or disabled.
LoRaWANConnectionStatusResourceTypeEventConfiguration loRaWAN
Connection status resource type event configuration object for enabling or disabling LoRaWAN related event topics.
String name
The name of the new resource.
String expressionType
The type of value in Expression.
String expression
The rule name or topic rule to send messages to.
String description
The description of the new resource.
String roleArn
The ARN of the IAM Role that authorizes the destination.
List<E> tags
The tags to attach to the new destination. Tags are metadata that you can use to manage a resource.
String clientRequestToken
Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
String name
The name of the new resource.
LoRaWANDeviceProfile loRaWAN
The device profile information to use to create the device profile.
List<E> tags
The tags to attach to the new device profile. Tags are metadata that you can use to manage a resource.
String clientRequestToken
Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
SidewalkCreateDeviceProfile sidewalk
The Sidewalk-related information for creating the Sidewalk device profile.
String name
String description
String clientRequestToken
LoRaWANFuotaTask loRaWAN
String firmwareUpdateImage
String firmwareUpdateRole
List<E> tags
Integer redundancyPercent
Integer fragmentSizeBytes
Integer fragmentIntervalMS
String name
String description
The description of the multicast group.
String clientRequestToken
Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
LoRaWANMulticast loRaWAN
List<E> tags
String name
TraceContent traceContent
List<E> wirelessDevices
Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId
of the resource to add in the input array.
List<E> wirelessGateways
Wireless gateway resources to add to the network analyzer configuration. Provide the
WirelessGatewayId of the resource to add in the input array.
String description
List<E> tags
String clientRequestToken
List<E> multicastGroups
Multicast Group resources to add to the network analyzer configruation. Provide the MulticastGroupId
of the resource to add in the input array.
String name
The name of the new resource.
LoRaWANServiceProfile loRaWAN
The service profile information to use to create the service profile.
List<E> tags
The tags to attach to the new service profile. Tags are metadata that you can use to manage a resource.
String clientRequestToken
Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
String type
The wireless device type.
String name
The name of the new resource.
String description
The description of the new resource.
String destinationName
The name of the destination to assign to the new wireless device.
String clientRequestToken
Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
LoRaWANDevice loRaWAN
The device configuration information to use to create the wireless device.
List<E> tags
The tags to attach to the new wireless device. Tags are metadata that you can use to manage a resource.
String positioning
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
SidewalkCreateWirelessDevice sidewalk
The device configuration information to use to create the Sidewalk device.
String name
The name of the new resource.
String description
The description of the new resource.
LoRaWANGateway loRaWAN
The gateway configuration information to use to create the wireless gateway.
List<E> tags
The tags to attach to the new wireless gateway. Tags are metadata that you can use to manage a resource.
String clientRequestToken
Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
Boolean autoCreateTasks
Whether to automatically create tasks using this task definition for all gateways with the specified current
version. If false, the task must me created by calling CreateWirelessGatewayTask.
String name
The name of the new resource.
UpdateWirelessGatewayTaskCreate update
Information about the gateways to update.
String clientRequestToken
Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
List<E> tags
The tags to attach to the specified resource. Tags are metadata that you can use to manage a resource.
String certificateId
The certificate ID for the DAK.
Integer maxAllowedSignature
The maximum number of signatures that the DAK can sign. A value of -1 indicates that there's no
device limit.
Boolean factorySupport
Whether factory support has been enabled.
String apId
The advertised product ID (APID) that's used for pre-production and production applications.
String deviceTypeId
The device type ID that's used for prototyping applications.
String name
The name of the resource to delete.
String id
The ID of the resource to delete.
String id
String id
String configurationName
String id
The ID of a given wireless device for which downlink messages will be deleted.
String messageId
If message ID is "*", it cleares the entire downlink queue for a given device, specified by the
wireless device ID. Otherwise, the downlink message with the specified message ID will be deleted.
String wirelessDeviceType
The wireless device type, which can be either Sidewalk or LoRaWAN.
String id
The ID of the resource to delete.
String id
The unique identifier of the import task to be deleted.
String id
The ID of the resource to delete.
String id
The ID of the resource to delete.
String id
The ID of the resource to delete.
String id
The ID of the resource to delete.
String arn
The Amazon Resource Name of the resource.
String name
The name of the resource.
String expressionType
The type of value in Expression.
String expression
The rule name or topic rule to send messages to.
String description
The description of the resource.
String roleArn
The ARN of the IAM Role that authorizes the destination.
SidewalkEventNotificationConfigurations sidewalk
Device registration state event configuration object for enabling or disabling Sidewalk related event topics.
String wirelessDeviceIdEventTopic
Denotes whether the wireless device ID device registration state event topic is enabled or disabled.
SidewalkResourceTypeEventConfiguration sidewalk
Device registration resource type state event configuration object for enabling or disabling Sidewalk related event topics.
String id
The ID of the resource to update.
String id
The ID of the resource to update.
String id
The ID of the resource to update.
String messageId
The message ID assigned by IoT Wireless to each downlink message, which helps identify the message.
Integer transmitMode
The transmit mode to use for sending data to the wireless device. This can be 0 for UM
(unacknowledge mode) or 1 for AM (acknowledge mode).
String receivedAt
The time at which Iot Wireless received the downlink message.
LoRaWANSendDataToDevice loRaWAN
String identifier
Resource identifier opted in for event messaging.
String identifierType
Identifier type of the particular resource identifier for event configuration.
String partnerType
Partner type of the resource if the identifier type is PartnerAccountId.
EventNotificationItemConfigurations events
DeviceRegistrationStateEventConfiguration deviceRegistrationState
Device registration state event configuration for an event configuration item.
ProximityEventConfiguration proximity
Proximity event configuration for an event configuration item.
JoinEventConfiguration join
Join event configuration for an event configuration item.
ConnectionStatusEventConfiguration connectionStatus
Connection status event configuration for an event configuration item.
MessageDeliveryStatusEventConfiguration messageDeliveryStatus
Message delivery status event configuration for an event configuration item.
Integer fuota
Integer multicast
Integer clockSync
Positioning positioning
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
List<E> applications
Optional LoRaWAN application information, which can be used for geolocation.
String name
The name of the resource to get.
String arn
The Amazon Resource Name of the resource.
String name
The name of the resource.
String expression
The rule name or topic rule to send messages to.
String expressionType
The type of value in Expression.
String description
The description of the resource.
String roleArn
The ARN of the IAM Role that authorizes the destination.
String id
The ID of the resource to get.
String arn
The Amazon Resource Name of the resource.
String name
The name of the resource.
String id
The ID of the device profile.
LoRaWANDeviceProfile loRaWAN
Information about the device profile.
SidewalkGetDeviceProfile sidewalk
Information about the Sidewalk parameters in the device profile.
DeviceRegistrationStateResourceTypeEventConfiguration deviceRegistrationState
Resource type event configuration for the device registration state event.
ProximityResourceTypeEventConfiguration proximity
Resource type event configuration for the proximity event.
JoinResourceTypeEventConfiguration join
Resource type event configuration for the join event.
ConnectionStatusResourceTypeEventConfiguration connectionStatus
Resource type event configuration for the connection status event.
MessageDeliveryStatusResourceTypeEventConfiguration messageDeliveryStatus
Resource type event configuration object for the message delivery status event.
String id
String arn
String id
String status
String name
String description
LoRaWANFuotaTaskGetInfo loRaWAN
String firmwareUpdateImage
String firmwareUpdateRole
Date createdAt
Integer redundancyPercent
Integer fragmentSizeBytes
Integer fragmentIntervalMS
SummaryMetricConfiguration summaryMetric
The configuration status of the AWS account for summary metric aggregation.
String id
String id
LoRaWANMulticastSession loRaWAN
String configurationName
TraceContent traceContent
List<E> wirelessDevices
List of wireless device resources that have been added to the network analyzer configuration.
List<E> wirelessGateways
List of wireless gateway resources that have been added to the network analyzer configuration.
String description
String arn
The Amazon Resource Name of the new resource.
String name
List<E> multicastGroups
List of multicast group resources that have been added to the network analyzer configuration.
SidewalkAccountInfoWithFingerprint sidewalk
The Sidewalk account credentials.
Boolean accountLinked
Whether the partner account is linked to the AWS account.
PositionSolverDetails solvers
The wrapper for the solver configuration details object.
String destination
The position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.
List<E> wiFiAccessPoints
Retrieves an estimated device position by resolving WLAN measurement data. The position is resolved using HERE's Wi-Fi based solver.
CellTowers cellTowers
Retrieves an estimated device position by resolving measurement data from cellular radio towers. The position is resolved using HERE's cellular-based solver.
Ip ip
Retrieves an estimated device position by resolving the IP address information from the device. The position is resolved using MaxMind's IP-based solver.
Gnss gnss
Retrieves an estimated device position by resolving the global navigation satellite system (GNSS) scan data. The position is resolved using the GNSS solver powered by LoRa Cloud.
Date timestamp
Optional information that specifies the time when the position information will be resolved. It uses the Unix timestamp format. If not specified, the time at which the request was received will be used.
ByteBuffer geoJsonPayload
The position information of the resource, displayed as a JSON payload. The payload is of type blob and uses the GeoJSON format, which a format that's used to encode geographic data structures. A sample payload contains the timestamp information, the WGS84 coordinates of the location, and the accuracy and confidence level. For more information and examples, see Resolve device location (console).
List<E> position
The position information of the resource.
Accuracy 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.
String solverType
The type of solver used to identify the position of the resource.
String solverProvider
The vendor of the positioning solver.
String solverVersion
The version of the positioning solver.
String timestamp
The timestamp at which the device's position was determined.
DeviceRegistrationStateEventConfiguration deviceRegistrationState
Event configuration for the device registration state event.
ProximityEventConfiguration proximity
Event configuration for the proximity event.
JoinEventConfiguration join
Event configuration for the join event.
ConnectionStatusEventConfiguration connectionStatus
Event configuration for the connection status event.
MessageDeliveryStatusEventConfiguration messageDeliveryStatus
Event configuration for the message delivery status event.
String logLevel
String resourceIdentifier
The identifier of the resource for which position information is retrieved. It can be the wireless device ID or the wireless gateway ID, depending on the resource type.
String resourceType
The type of resource for which position information is retrieved, which can be a wireless device or a wireless gateway.
ByteBuffer geoJsonPayload
The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that's used to encode geographic data structures. For more information, see GeoJSON.
String serviceType
The service type for which to get endpoint information about. Can be CUPS for the Configuration and
Update Server endpoint, or LNS for the LoRaWAN Network Server endpoint or CLAIM for the
global endpoint.
String id
The ID of the resource to get.
String arn
The Amazon Resource Name of the resource.
String name
The name of the resource.
String id
The ID of the service profile.
LoRaWANGetServiceProfileInfo loRaWAN
Information about the service profile.
String id
The identifier of the import task for which information is requested.
String id
The identifier of the import task for which information is retrieved.
String arn
The ARN (Amazon Resource Name) of the import task.
String destinationName
The name of the destination that's assigned to the wireless devices in the import task.
SidewalkGetStartImportInfo sidewalk
The Sidewalk-related information about an import task.
Date creationTime
The time at which the import task was created.
String status
The import task status.
String statusReason
The reason for the provided status information, such as a validation error that causes the import task to fail.
Long initializedImportedDeviceCount
The number of devices in the import task that are waiting for the control log to start processing.
Long pendingImportedDeviceCount
The number of devices in the import task that are waiting in the import task queue to be onboarded.
Long onboardedImportedDeviceCount
The number of devices in the import task that have been onboarded to the import task.
Long failedImportedDeviceCount
The number of devices in the import task that failed to onboard to the import task.
String type
The wireless device type.
String name
The name of the resource.
String description
The description of the resource.
String destinationName
The name of the destination to which the device is assigned.
String id
The ID of the wireless device.
String arn
The Amazon Resource Name of the resource.
String thingName
The name of the thing associated with the wireless device. The value is empty if a thing isn't associated with the device.
String thingArn
The ARN of the thing associated with the wireless device.
LoRaWANDevice loRaWAN
Information about the wireless device.
SidewalkDevice sidewalk
Sidewalk device object.
String positioning
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
String wirelessDeviceId
The ID of the wireless device for which to get the data.
String wirelessDeviceId
The ID of the wireless device.
String lastUplinkReceivedAt
The date and time when the most recent uplink was received.
This value is only valid for 3 months.
LoRaWANDeviceMetadata loRaWAN
Information about the wireless device's operations.
SidewalkDeviceMetadata sidewalk
MetaData for Sidewalk device.
String id
The ID of the resource to get.
String id
The ID of the resource to get.
LoRaWANGatewayCurrentVersion loRaWAN
Information about the wireless gateway's firmware.
String name
The name of the resource.
String id
The ID of the wireless gateway.
String description
The description of the resource.
LoRaWANGateway loRaWAN
Information about the wireless gateway.
String arn
The Amazon Resource Name of the resource.
String thingName
The name of the thing associated with the wireless gateway. The value is empty if a thing isn't associated with the gateway.
String thingArn
The ARN of the thing associated with the wireless gateway.
String wirelessGatewayId
The ID of the wireless gateway for which to get the data.
String wirelessGatewayId
The ID of the wireless gateway.
String lastUplinkReceivedAt
The date and time when the most recent uplink was received.
This value is only valid for 3 months.
String connectionStatus
The connection status of the wireless gateway.
String id
The ID of the resource to get.
Boolean autoCreateTasks
Whether to automatically create tasks using this task definition for all gateways with the specified current
version. If false, the task must me created by calling CreateWirelessGatewayTask.
String name
The name of the resource.
UpdateWirelessGatewayTaskCreate update
Information about the gateways to update.
String arn
The Amazon Resource Name of the resource.
String id
The ID of the resource to get.
String wirelessGatewayId
The ID of the wireless gateway.
String wirelessGatewayTaskDefinitionId
The ID of the WirelessGatewayTask.
String lastUplinkReceivedAt
The date and time when the most recent uplink was received.
This value is only valid for 3 months.
String taskCreatedAt
The date and time when the task was created.
String status
The status of the request.
String payload
Payload that contains the GNSS scan result, or NAV message, in hexadecimal notation.
Float captureTime
Optional parameter that gives an estimate of the time when the GNSS scan information is taken, in seconds GPS time (GPST). If capture time is not specified, the local server time is used.
Float captureTimeAccuracy
Optional value that gives the capture time estimate accuracy, in seconds. If capture time accuracy is not specified, default value of 300 is used.
List<E> assistPosition
Optional assistance position information, specified using latitude and longitude values in degrees. The coordinates are inside the WGS84 reference frame.
Float assistAltitude
Optional assistance altitude, which is the altitude of the device at capture time, specified in meters above the WGS84 reference ellipsoid.
Boolean use2DSolver
Optional parameter that forces 2D solve, which modifies the positioning algorithm to a 2D solution problem. When this parameter is specified, the assistance altitude should have an accuracy of at least 10 meters.
Integer bsic
GSM base station identity code (BSIC).
Integer bcch
GSM broadcast control channel.
Integer rxLevel
Rx level, which is the received signal power, measured in dBm (decibel-milliwatts).
GlobalIdentity globalIdentity
Global identity information of the GSM object.
Integer mcc
Mobile Country Code.
Integer mnc
Mobile Network Code.
Integer lac
Location area code.
Integer geranCid
GERAN (GSM EDGE Radio Access Network) Cell Global Identifier.
GsmLocalId gsmLocalId
GSM local identification (local ID) information.
Integer gsmTimingAdvance
Timing advance value, which corresponds to the length of time a signal takes to reach the base station from a mobile phone.
Integer rxLevel
Rx level, which is the received signal power, measured in dBm (decibel-milliwatts).
List<E> gsmNmr
GSM object for network measurement reports.
String sidewalkManufacturingSn
The Sidewalk manufacturing serial number (SMSN) of the Sidewalk device.
String onboardingStatus
The onboarding status of the Sidewalk device in the import task.
String onboardingStatusReason
The reason for the onboarding status information for the Sidewalk device.
Date lastUpdateTime
The time at which the status information was last updated.
ImportedSidewalkDevice sidewalk
The Sidewalk-related information about a device that has been added to an import task.
String ipAddress
IP address information.
LoRaWANJoinEventNotificationConfigurations loRaWAN
Join event configuration object for enabling or disabling LoRaWAN related event topics.
String wirelessDeviceIdEventTopic
Denotes whether the wireless device ID join event topic is enabled or disabled.
LoRaWANJoinResourceTypeEventConfiguration loRaWAN
Join resource type event configuration object for enabling or disabling LoRaWAN related event topics.
String nextToken
To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
Integer maxResults
The maximum number of results to return in this operation.
String deviceProfileType
A filter to list only device profiles that use this type, which can be LoRaWAN or
Sidewalk.
String id
The identifier of the import task for which wireless devices are listed.
Integer maxResults
String nextToken
To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
String status
The status of the devices in the import task.
String nextToken
The token to use to get the next set of results, or null if there are no additional results.
String destinationName
The name of the Sidewalk destination that describes the IoT rule to route messages received from devices in an import task that are onboarded to AWS IoT Wireless.
List<E> importedWirelessDeviceList
List of wireless devices in an import task and their onboarding status.
String id
The ID of a given wireless device which the downlink message packets are being sent.
String nextToken
To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
Integer maxResults
The maximum number of results to return in this operation.
String wirelessDeviceType
The wireless device type, whic can be either Sidewalk or LoRaWAN.
String resourceArn
The ARN of the resource for which you want to list tags.
Integer maxResults
The maximum number of results to return in this operation.
String nextToken
To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
String destinationName
A filter to list only the wireless devices that use this destination.
String deviceProfileId
A filter to list only the wireless devices that use this device profile.
String serviceProfileId
A filter to list only the wireless devices that use this service profile.
String wirelessDeviceType
A filter to list only the wireless devices that use this wireless device type.
String fuotaTaskId
String multicastGroupId
Integer maxResults
The maximum number of results to return in this operation.
String nextToken
To retrieve the next set of results, the nextToken value from a previous response; otherwise
null to receive the first set of results.
String taskDefinitionType
A filter to list only the wireless gateway task definitions that use this task definition type.
String gatewayEuiEventTopic
Denotes whether the gateway EUI connection status event topic is enabled or disabled.
String wirelessGatewayEventTopic
Denotes whether the wireless gateway connection status event topic is enabled or disabled.
String devEui
The DevEUI value.
String deviceProfileId
The ID of the device profile for the new wireless device.
String serviceProfileId
The ID of the service profile.
OtaaV11 otaaV1_1
OTAA device object for v1.1 for create APIs
OtaaV10X otaaV1_0_x
OTAA device object for create APIs for v1.0.x
AbpV11 abpV1_1
ABP device object for create APIs for v1.1
AbpV10X abpV1_0_x
LoRaWAN object for create APIs
FPorts fPorts
String devEui
The DevEUI value.
Integer fPort
The FPort value.
Integer dataRate
The DataRate value.
Integer frequency
The device's channel frequency in Hz.
String timestamp
The date and time of the metadata.
List<E> gateways
Information about the gateways accessed by the device.
List<E> publicGateways
Information about the LoRaWAN public network accessed by the device.
Boolean supportsClassB
The SupportsClassB value.
Integer classBTimeout
The ClassBTimeout value.
Integer pingSlotPeriod
The PingSlotPeriod value.
Integer pingSlotDr
The PingSlotDR value.
Integer pingSlotFreq
The PingSlotFreq value.
Boolean supportsClassC
The SupportsClassC value.
Integer classCTimeout
The ClassCTimeout value.
String macVersion
The MAC version (such as OTAA 1.1 or OTAA 1.0.3) to use with this device profile.
String regParamsRevision
The version of regional parameters.
Integer rxDelay1
The RXDelay1 value.
Integer rxDrOffset1
The RXDROffset1 value.
Integer rxDataRate2
The RXDataRate2 value.
Integer rxFreq2
The RXFreq2 value.
List<E> factoryPresetFreqsList
The list of values that make up the FactoryPresetFreqs value.
Integer maxEirp
The MaxEIRP value.
Integer maxDutyCycle
The MaxDutyCycle value. It ranges from 0 to 15.
String rfRegion
The frequency band (RFRegion) value.
Boolean supportsJoin
The SupportsJoin value.
Boolean supports32BitFCnt
The Supports32BitFCnt value.
String rfRegion
String gatewayEui
The gateway's EUI value.
String rfRegion
The frequency band (RFRegion) value.
List<E> joinEuiFilters
List<E> netIdFilters
List<E> subBands
Beaconing beaconing
Beaconing object information, which consists of the data rate and frequency parameters.
Float maxEirp
The MaxEIRP value.
LoRaWANGatewayVersion currentVersion
The version of the gateways that should receive the update.
Integer ulRate
The ULRate value.
Integer ulBucketSize
The ULBucketSize value.
String ulRatePolicy
The ULRatePolicy value.
Integer dlRate
The DLRate value.
Integer dlBucketSize
The DLBucketSize value.
String dlRatePolicy
The DLRatePolicy value.
Boolean addGwMetadata
The AddGWMetaData value.
Integer devStatusReqFreq
The DevStatusReqFreq value.
Boolean reportDevStatusBattery
The ReportDevStatusBattery value.
Boolean reportDevStatusMargin
The ReportDevStatusMargin value.
Integer drMin
The DRMin value.
Integer drMax
The DRMax value.
String channelMask
The ChannelMask value.
Boolean prAllowed
The PRAllowed value that describes whether passive roaming is allowed.
Boolean hrAllowed
The HRAllowed value that describes whether handover roaming is allowed.
Boolean raAllowed
The RAAllowed value that describes whether roaming activation is allowed.
Boolean nwkGeoLoc
The NwkGeoLoc value.
Integer targetPer
The TargetPER value.
Integer minGwDiversity
The MinGwDiversity value.
String devEuiEventTopic
Denotes whether the Dev EUI join event topic is enabled or disabled.
String wirelessDeviceEventTopic
Denotes whether the wireless device join event topic is enabled or disabled.
String devEui
The DevEUI value.
Integer fPort
String providerNetId
The ID of the LoRaWAN public network provider.
String id
The ID of the gateways that are operated by the network provider.
Double rssi
The RSSI (received signal strength indicator) value.
Double snr
The SNR (signal to noise ratio) value.
String rfRegion
Boolean dlAllowed
Boolean that indicates whether downlink is allowed using the network.
Integer fPort
ParticipatingGateways participatingGateways
Choose the gateways that you want to use for the downlink data traffic when the wireless device is running in class B or class C mode.
Boolean addGwMetadata
The AddGWMetaData value.
Integer drMin
The DrMin value.
Integer drMax
The DrMax value.
Boolean prAllowed
The PRAllowed value that describes whether passive roaming is allowed.
Boolean raAllowed
The RAAllowed value that describes whether roaming activation is allowed.
Date startTime
String deviceProfileId
The ID of the device profile for the wireless device.
String serviceProfileId
The ID of the service profile.
UpdateAbpV11 abpV1_1
ABP device object for update APIs for v1.1
UpdateAbpV10X abpV1_0_x
ABP device object for update APIs for v1.0.x
UpdateFPorts fPorts
FPorts object for the positioning information of the device.
String updateSignature
The signature used to verify the update firmware.
Long sigKeyCrc
The CRC of the signature private key to check.
LoRaWANGatewayVersion currentVersion
The version of the gateways that should receive the update.
LoRaWANGatewayVersion updateVersion
The firmware version to update the gateway to.
LoRaWANGatewayVersion currentVersion
The version of the gateways that should receive the update.
LoRaWANGatewayVersion updateVersion
The firmware version to update the gateway to.
Integer pci
Physical cell ID.
Integer earfcn
E-UTRA (Evolved universal terrestrial Radio Access) absolute radio frequency channel Number (EARFCN).
Integer eutranCid
E-UTRAN (Evolved Universal Terrestrial Radio Access Network) cell global identifier (EUTRANCID).
Integer rsrp
Signal power of the reference signal received, measured in dBm (decibel-milliwatts).
Float rsrq
Signal quality of the reference Signal received, measured in decibels (dB).
Integer mcc
Mobile Country Code.
Integer mnc
Mobile Network Code.
Integer eutranCid
E-UTRAN (Evolved Universal Terrestrial Radio Access Network) Cell Global Identifier.
Integer tac
LTE tracking area code.
LteLocalId lteLocalId
LTE local identification (local ID) information.
Integer lteTimingAdvance
LTE timing advance.
Integer rsrp
Signal power of the reference signal received, measured in dBm (decibel-milliwatts).
Float rsrq
Signal quality of the reference Signal received, measured in decibels (dB).
Boolean nrCapable
Parameter that determines whether the LTE object is capable of supporting NR (new radio).
List<E> lteNmr
LTE object for network measurement reports.
SidewalkEventNotificationConfigurations sidewalk
String wirelessDeviceIdEventTopic
Denotes whether the wireless device ID message delivery status event topic is enabled or disabled.
SidewalkResourceTypeEventConfiguration sidewalk
Double min
The minimum of the values of all data points collected during the aggregation period.
Double max
The maximum of the values of all the data points collected during the aggregation period.
Double sum
The sum of the values of all data points collected during the aggregation period.
Double avg
The average of the values of all data points collected during the aggregation period.
Double std
The standard deviation of the values of all data points collected during the aggregation period.
Double p90
The 90th percentile of the values of all data points collected during the aggregation period.
String id
LoRaWANMulticastMetadata loRaWAN
String appKey
The AppKey value.
String appEui
The AppEUI value. You specify this value when using LoRaWAN versions v1.0.2 or v1.0.3.
String joinEui
The JoinEUI value. You specify this value instead of the AppEUI when using LoRaWAN version v1.0.4.
String genAppKey
The GenAppKey value.
String downlinkMode
Indicates whether to send the downlink message in sequential mode or concurrent mode, or to use only the chosen gateways from the previous uplink message transmission.
List<E> gatewayList
The list of gateways that you want to use for sending the downlink data traffic.
Integer transmissionInterval
The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the payload to the next gateway.
String resourceIdentifier
Resource identifier for the position configuration.
String resourceType
Resource type of the resource for the position configuration.
PositionSolverDetails solvers
The details of the positioning solver object used to compute the location.
String destination
The position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.
SemtechGnssConfiguration semtechGnss
The Semtech GNSS solver configuration object.
SemtechGnssDetail semtechGnss
The Semtech GNSS solver object details.
SidewalkEventNotificationConfigurations sidewalk
Proximity event configuration object for enabling or disabling Sidewalk related event topics.
String wirelessDeviceIdEventTopic
Denotes whether the wireless device ID proximity event topic is enabled or disabled.
SidewalkResourceTypeEventConfiguration sidewalk
Proximity resource type event configuration object for enabling and disabling wireless device topic.
String resourceIdentifier
Resource identifier used to update the position configuration.
String resourceType
Resource type of the resource for which you want to update the position configuration.
PositionSolverConfigurations solvers
The positioning solvers used to update the position configuration of the resource.
String destination
The position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.
String id
String payloadData
MulticastWirelessMetadata wirelessMetadata
String messageId
String id
The ID of the wireless device to receive the data.
Integer transmitMode
The transmit mode to use to send data to the wireless device. Can be: 0 for UM (unacknowledge mode)
or 1 for AM (acknowledge mode).
String payloadData
WirelessMetadata wirelessMetadata
Metadata about the message request.
String messageId
The ID of the message sent to the wireless device.
String deviceProfileId
The ID of the Sidewalk device profile.
String amazonId
String sidewalkId
The sidewalk device identification.
String sidewalkManufacturingSn
The Sidewalk manufacturing series number.
List<E> deviceCertificates
The sidewalk device certificates for Ed25519 and P256r1.
List<E> privateKeys
The Sidewalk device private keys that will be used for onboarding the device.
String deviceProfileId
The ID of the Sidewalk device profile.
String certificateId
The ID of the Sidewalk device profile.
String status
The Sidewalk device status, such as provisioned or registered.
String amazonIdEventTopic
Denotes whether the Amazon ID event topic is enabled or disabled.
String applicationServerPublicKey
The Sidewalk application server public key.
Boolean qualificationStatus
Gets information about the certification status of a Sidewalk device profile.
List<E> dakCertificateMetadata
The DAK certificate information of the Sidewalk device profile.
String amazonId
The Sidewalk Amazon ID.
String sidewalkId
The sidewalk device identification.
String sidewalkManufacturingSn
The Sidewalk manufacturing series number.
List<E> deviceCertificates
The sidewalk device certificates for Ed25519 and P256r1.
String deviceProfileId
Sidewalk object used by list functions.
String status
The status of the Sidewalk devices, such as provisioned or registered.
String wirelessDeviceEventTopic
Denotes whether the wireless device join event topic is enabled or disabled.
String sidewalkManufacturingSn
The Sidewalk manufacturing serial number (SMSN) of the device added to the import task.
String appServerPrivateKey
The new Sidewalk application server private key.
String deviceCreationFile
The CSV file contained in an S3 bucket that's used for appending devices to an existing import task.
String id
LoRaWANStartFuotaTask loRaWAN
String id
LoRaWANMulticastSession loRaWAN
String destinationName
The name of the Sidewalk destination that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless.
String clientRequestToken
String deviceName
The name of the wireless device for which an import task is being started.
List<E> tags
SidewalkSingleStartImportInfo sidewalk
The Sidewalk-related parameters for importing a single wireless device.
String destinationName
The name of the Sidewalk destination that describes the IoT rule to route messages from the devices in the import task that are onboarded to AWS IoT Wireless.
String clientRequestToken
List<E> tags
SidewalkStartImportInfo sidewalk
The Sidewalk-related parameters for importing wireless devices that need to be provisioned in bulk.
String status
The status of the configuration of summary metrics.
String queryId
The id of the summary metric query.
String metricName
The name of the metric.
List<E> dimensions
The dimensions of the summary metric.
String aggregationPeriod
The aggregation period of the summary metric.
Date startTimestamp
The start timestamp for the summary metric query.
Date endTimestamp
The end timestamp for the summary metric query.
String queryId
The ID of the summary metric results query operation.
String queryStatus
The status of the summary metric query result.
String error
The error message for the summary metric query result.
String metricName
The name of the summary metric query result.
List<E> dimensions
The dimensions of the metric.
String aggregationPeriod
The aggregation period of the metric.
Date startTimestamp
The start timestamp for the summary metric query.
Date endTimestamp
The end timestamp for the summary metric query.
List<E> timestamps
The timestamp of each aggregation result.
List<E> values
The list of aggregated summary metric query results.
String unit
The units of measurement to be used for interpreting the aggregation result.
Integer uarfcn
TD-SCDMA UTRA (Universal Terrestrial Radio Access Network) absolute RF channel number.
Integer cellParams
Cell parameters for TD-SCDMA network measurement reports object.
Integer utranCid
UTRAN (UMTS Terrestrial Radio Access Network) cell global identifier.
Integer rscp
Code power of the received signal, measured in decibel-milliwatts (dBm).
Integer pathLoss
Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.
Integer mcc
Mobile Country Code.
Integer mnc
Mobile Network Code.
Integer lac
Location Area Code.
Integer utranCid
UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.
TdscdmaLocalId tdscdmaLocalId
TD-SCDMA local identification (local ID) information.
Integer tdscdmaTimingAdvance
TD-SCDMA Timing advance.
Integer rscp
Signal power of the received signal (Received Signal Code Power), measured in decibel-milliwatts (dBm).
Integer pathLoss
Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.
List<E> tdscdmaNmr
TD-SCDMA object for network measurement reports.
String id
The ID of the wireless device to test.
String result
The result returned by the test.
String resourceName
Name of the resource that exceeds maximum number of tags allowed.
Integer fCntStart
The FCnt init value.
Integer fCntStart
The FCnt init value.
String name
The new name of the resource.
String expressionType
The type of value in Expression.
String expression
The new rule name or topic rule to send messages to.
String description
A new description of the resource.
String roleArn
The ARN of the IAM Role that authorizes the destination.
DeviceRegistrationStateResourceTypeEventConfiguration deviceRegistrationState
Device registration state resource type event configuration object for enabling and disabling wireless gateway topic.
ProximityResourceTypeEventConfiguration proximity
Proximity resource type event configuration object for enabling and disabling wireless gateway topic.
JoinResourceTypeEventConfiguration join
Join resource type event configuration object for enabling and disabling wireless device topic.
ConnectionStatusResourceTypeEventConfiguration connectionStatus
Connection status resource type event configuration object for enabling and disabling wireless gateway topic.
MessageDeliveryStatusResourceTypeEventConfiguration messageDeliveryStatus
Message delivery status resource type event configuration object for enabling and disabling wireless device topic.
Positioning positioning
Positioning FPorts for the ClockSync, Stream, and GNSS functions.
List<E> applications
LoRaWAN application, which can be used for geolocation by activating positioning.
String id
String name
String description
LoRaWANFuotaTask loRaWAN
String firmwareUpdateImage
String firmwareUpdateRole
Integer redundancyPercent
Integer fragmentSizeBytes
Integer fragmentIntervalMS
SummaryMetricConfiguration summaryMetric
The value to be used to set summary metric configuration.
String id
String name
String description
LoRaWANMulticast loRaWAN
String configurationName
TraceContent traceContent
List<E> wirelessDevicesToAdd
Wireless device resources to add to the network analyzer configuration. Provide the WirelessDeviceId
of the resource to add in the input array.
List<E> wirelessDevicesToRemove
Wireless device resources to remove from the network analyzer configuration. Provide the
WirelessDeviceId of the resources to remove in the input array.
List<E> wirelessGatewaysToAdd
Wireless gateway resources to add to the network analyzer configuration. Provide the
WirelessGatewayId of the resource to add in the input array.
List<E> wirelessGatewaysToRemove
Wireless gateway resources to remove from the network analyzer configuration. Provide the
WirelessGatewayId of the resources to remove in the input array.
String description
List<E> multicastGroupsToAdd
Multicast group resources to add to the network analyzer configuration. Provide the MulticastGroupId
of the resource to add in the input array.
List<E> multicastGroupsToRemove
Multicast group resources to remove from the network analyzer configuration. Provide the
MulticastGroupId of the resources to remove in the input array.
SidewalkUpdateAccount sidewalk
The Sidewalk account credentials.
String partnerAccountId
The ID of the partner account to update.
String partnerType
The partner type.
String identifier
Resource identifier to opt in for event messaging.
String identifierType
Identifier type of the particular resource identifier for event configuration.
String partnerType
Partner type of the resource if the identifier type is PartnerAccountId
DeviceRegistrationStateEventConfiguration deviceRegistrationState
Event configuration for the device registration state event.
ProximityEventConfiguration proximity
Event configuration for the proximity event.
JoinEventConfiguration join
Event configuration for the join event.
ConnectionStatusEventConfiguration connectionStatus
Event configuration for the connection status event.
MessageDeliveryStatusEventConfiguration messageDeliveryStatus
Event configuration for the message delivery status event.
String resourceIdentifier
The identifier of the resource for which position information is updated. It can be the wireless device ID or the wireless gateway ID, depending on the resource type.
String resourceType
The type of resource for which position information is updated, which can be a wireless device or a wireless gateway.
ByteBuffer geoJsonPayload
The position information of the resource, displayed as a JSON payload. The payload uses the GeoJSON format, which a format that's used to encode geographic data structures. For more information, see GeoJSON.
String id
The identifier of the import task to be updated.
SidewalkUpdateImportInfo sidewalk
The Sidewalk-related parameters of the import task to be updated.
String id
The ID of the resource to update.
String destinationName
The name of the new destination for the device.
String name
The new name of the resource.
String description
A new description of the resource.
LoRaWANUpdateDevice loRaWAN
The updated wireless device's configuration.
String positioning
FPort values for the GNSS, stream, and ClockSync functions of the positioning information.
String updateDataSource
The link to the S3 bucket.
String updateDataRole
The IAM role used to read data from the S3 bucket.
LoRaWANUpdateGatewayTaskCreate loRaWAN
The properties that relate to the LoRaWAN wireless gateway.
String id
The ID of the new wireless gateway task entry.
LoRaWANUpdateGatewayTaskEntry loRaWAN
The properties that relate to the LoRaWAN wireless gateway.
String arn
The Amazon Resource Name of the resource.
Integer uarfcndl
WCDMA UTRA Absolute RF Channel Number downlink.
Integer psc
Primary Scrambling Code.
Integer utranCid
UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.
Integer rscp
Received Signal Code Power (signal power) (dBm)
Integer pathLoss
Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.
Integer mcc
Mobile Country Code.
Integer mnc
Mobile Network Code.
Integer lac
Location Area Code.
Integer utranCid
UTRAN (UMTS Terrestrial Radio Access Network) Cell Global Identifier.
WcdmaLocalId wcdmaLocalId
WCDMA local ID information.
Integer rscp
Received Signal Code Power (signal power) (dBm).
Integer pathLoss
Path loss, or path attenuation, is the reduction in power density of an electromagnetic wave as it propagates through space.
List<E> wcdmaNmr
WCDMA object for network measurement reports.
String id
The ID of the wireless device import task.
String arn
The ARN (Amazon Resource Name) of the wireless device import task.
String destinationName
The name of the Sidewalk destination that that describes the IoT rule to route messages from the device in the import task that will be onboarded to AWS IoT Wireless
SidewalkGetStartImportInfo sidewalk
The Sidewalk-related information of the wireless device import task.
Date creationTime
The time at which the import task was created.
String status
The status information of the wireless device import task.
String statusReason
The reason that provides additional information about the import task status.
Long initializedImportedDeviceCount
The summary information of count of wireless devices that are waiting for the control log to be added to an import task.
Long pendingImportedDeviceCount
The summary information of count of wireless devices in an import task that are waiting in the queue to be onboarded.
Long onboardedImportedDeviceCount
The summary information of count of wireless devices in an import task that have been onboarded to the import task.
Long failedImportedDeviceCount
The summary information of count of wireless devices in an import task that failed to onboarded to the import task.
String arn
The Amazon Resource Name of the resource.
String id
The ID of the wireless device reporting the data.
String type
The wireless device type.
String name
The name of the resource.
String destinationName
The name of the destination to which the device is assigned.
String lastUplinkReceivedAt
The date and time when the most recent uplink was received.
Theis value is only valid for 3 months.
LoRaWANListDevice loRaWAN
LoRaWAN device info.
SidewalkListDevice sidewalk
The Sidewalk account credentials.
String fuotaDeviceStatus
String multicastDeviceStatus
The status of the wireless device in the multicast group.
Integer mcGroupId
String arn
The Amazon Resource Name of the resource.
String id
The ID of the wireless gateway reporting the data.
String name
The name of the resource.
String description
The description of the resource.
LoRaWANGateway loRaWAN
LoRaWAN gateway info.
String lastUplinkReceivedAt
The date and time when the most recent uplink was received.
This value is only valid for 3 months.
LoRaWANSendDataToDevice loRaWAN
LoRaWAN device info.
SidewalkSendDataToDevice sidewalk
The Sidewalk account credentials.
Copyright © 2024. All rights reserved.