IoT Wireless

Implementation details for API iotwireless

Coverage Overview

IoT Wireless is supported by LocalStack only in the pro image.

AvailabilityTesting*
OperationImplementedImageInternal Test SuiteExternal Test SuiteTerraform ValidatedAWS ValidatedSnapshot TestedDetails
AssociateAwsAccountWithPartnerAccount
AssociateMulticastGroupWithFuotaTask
AssociateWirelessDeviceWithFuotaTask
AssociateWirelessDeviceWithMulticastGroup
AssociateWirelessDeviceWithThing
AssociateWirelessGatewayWithCertificate
AssociateWirelessGatewayWithThing
CancelMulticastGroupSession
CreateDestination
CreateDeviceProfile✔️pro✔️Show Tests
CreateFuotaTask
CreateMulticastGroup
CreateNetworkAnalyzerConfiguration
CreateServiceProfile
CreateWirelessDevice✔️pro✔️Show Tests
CreateWirelessGateway✔️pro✔️Show Tests
CreateWirelessGatewayTask
CreateWirelessGatewayTaskDefinition
DeleteDestination
DeleteDeviceProfile✔️pro✔️Show Tests
DeleteFuotaTask
DeleteMulticastGroup
DeleteNetworkAnalyzerConfiguration
DeleteQueuedMessages
DeleteServiceProfile
DeleteWirelessDevice✔️pro✔️Show Tests
DeleteWirelessDeviceImportTask
DeleteWirelessGateway✔️pro✔️Show Tests
DeleteWirelessGatewayTask
DeleteWirelessGatewayTaskDefinition
DeregisterWirelessDevice
DisassociateAwsAccountFromPartnerAccount
DisassociateMulticastGroupFromFuotaTask
DisassociateWirelessDeviceFromFuotaTask
DisassociateWirelessDeviceFromMulticastGroup
DisassociateWirelessDeviceFromThing
DisassociateWirelessGatewayFromCertificate
DisassociateWirelessGatewayFromThing
GetDestination
GetDeviceProfile✔️pro✔️Show Tests
GetEventConfigurationByResourceTypes
GetFuotaTask
GetLogLevelsByResourceTypes
GetMetricConfiguration
GetMetrics
GetMulticastGroup
GetMulticastGroupSession
GetNetworkAnalyzerConfiguration
GetPartnerAccount
GetPosition
GetPositionConfiguration
GetPositionEstimate
GetResourceEventConfiguration
GetResourceLogLevel
GetResourcePosition
GetServiceEndpoint
GetServiceProfile
GetWirelessDevice✔️pro✔️Show Tests
GetWirelessDeviceImportTask
GetWirelessDeviceStatistics
GetWirelessGateway✔️pro✔️Show Tests
GetWirelessGatewayCertificate
GetWirelessGatewayFirmwareInformation
GetWirelessGatewayStatistics
GetWirelessGatewayTask
GetWirelessGatewayTaskDefinition
ListDestinations
ListDeviceProfiles✔️pro✔️Show Tests
ListDevicesForWirelessDeviceImportTask
ListEventConfigurations
ListFuotaTasks
ListMulticastGroups
ListMulticastGroupsByFuotaTask
ListNetworkAnalyzerConfigurations
ListPartnerAccounts
ListPositionConfigurations
ListQueuedMessages
ListServiceProfiles
ListTagsForResource
ListWirelessDeviceImportTasks
ListWirelessDevices✔️pro✔️Show Tests
ListWirelessGatewayTaskDefinitions
ListWirelessGateways✔️pro✔️Show Tests
PutPositionConfiguration
PutResourceLogLevel
ResetAllResourceLogLevels
ResetResourceLogLevel
SendDataToMulticastGroup
SendDataToWirelessDevice
StartBulkAssociateWirelessDeviceWithMulticastGroup
StartBulkDisassociateWirelessDeviceFromMulticastGroup
StartFuotaTask
StartMulticastGroupSession
StartSingleWirelessDeviceImportTask
StartWirelessDeviceImportTask
TagResource
TestWirelessDevice
UntagResource
UpdateDestination
UpdateEventConfigurationByResourceTypes
UpdateFuotaTask
UpdateLogLevelsByResourceTypes
UpdateMetricConfiguration
UpdateMulticastGroup
UpdateNetworkAnalyzerConfiguration
UpdatePartnerAccount
UpdatePosition
UpdateResourceEventConfiguration
UpdateResourcePosition
UpdateWirelessDevice✔️pro
UpdateWirelessDeviceImportTask
UpdateWirelessGateway✔️pro

Terminology

  • Internal Test Suite: tested by LocalStack's internal integration test suite
  • External Test Suite: covered by an external integration test suite, that runs against LocalStack
  • Terraform Validated: operation tested with Terraform
  • AWS Validated: the integration test that includes this operation call was validated against AWS
  • Snapshot Tested: the operation is part of a snapshot parity test, which verifies the responses by LocalStack and AWS are the same

Testing Details

This section gives an overview about the internal integration test suite and the specific test cases that recorded the API call.

How to read the test details?

For each operation we put up a list of the related integration test cases.
Those operation calls have been recorded during the execution of the outlined test cases. Some calls might be internal, i.e., they are not explicitly called in the test, but are triggered implicitly by the LocalStack framework.

  • Parameters: The tests are ordered by the parameters used, which are highlighted in bold.
  • Test Details: LocalStack Community or LocalStack Pro indicates where the test originates. For each test you see:
    • test name
    • status code returned (which is the expected one for the test case)
    • information about validation:
      • AWS validated the test is validated against AWS, meaning it run successfully against real AWS as well
      • Snapshot Tested this is a snapshot parity test, meaning the responses are validated against AWS


CreateDeviceProfile

Parameters: ClientRequestToken, LoRaWAN, Name
  • LocalStack Pro
    • test_device_profiles LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_device_profiles HTTP Status Code: 201

CreateWirelessDevice

Parameters: ClientRequestToken, DestinationName, Name, Type
  • LocalStack Pro
    • test_wireless_devices LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_wireless_devices HTTP Status Code: 201

CreateWirelessGateway

Parameters: ClientRequestToken, LoRaWAN, Name
  • LocalStack Pro
    • test_wireless_gateways LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_wireless_gateways HTTP Status Code: 201

DeleteDeviceProfile

Parameters: Id
  • LocalStack Pro
    • test_device_profiles LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_device_profiles HTTP Status Code: 204

DeleteWirelessDevice

Parameters: Id
  • LocalStack Pro
    • test_wireless_devices LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_wireless_devices HTTP Status Code: 204

DeleteWirelessGateway

Parameters: Id
  • LocalStack Pro
    • test_wireless_gateways LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_wireless_gateways HTTP Status Code: 204

GetDeviceProfile

Parameters: Id
  • LocalStack Pro
    • test_device_profiles LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_device_profiles HTTP Status Code: 200
    • test_device_profiles LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_device_profiles HTTP Status Code: 404 (ResourceNotFoundException)

GetWirelessDevice

Parameters: Identifier, IdentifierType
  • LocalStack Pro
    • test_wireless_devices LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_wireless_devices HTTP Status Code: 200
    • test_wireless_devices LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_wireless_devices HTTP Status Code: 404 (ResourceNotFoundException)

GetWirelessGateway

Parameters: Identifier, IdentifierType
  • LocalStack Pro
    • test_wireless_gateways LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_wireless_gateways HTTP Status Code: 200
    • test_wireless_gateways LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_wireless_gateways HTTP Status Code: 404 (ResourceNotFoundException)

ListDeviceProfiles

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_device_profiles LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_device_profiles HTTP Status Code: 200

ListWirelessDevices

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_wireless_devices LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_wireless_devices HTTP Status Code: 200

ListWirelessGateways

Parameters: - (without any parameters)
  • LocalStack Pro
    • test_wireless_gateways LocalStack Pro: tests/aws/services/iotwireless/test_iotwireless.py::TestIotWireless::test_wireless_gateways HTTP Status Code: 200

Last modified July 22, 2024: Update Parity Coverage Docs (#1393) (1200bd259)