IoTWireless class
AWS IoT Wireless provides bi-directional communication between internet-connected wireless devices and the AWS Cloud. To onboard both LoRaWAN and Sidewalk devices to AWS IoT, use the IoT Wireless API. These wireless devices use the Low Power Wide Area Networking (LPWAN) communication protocol to communicate with AWS IoT.
Using the API, you can perform create, read, update, and delete operations for your wireless devices, gateways, destinations, and profiles. After onboarding your devices, you can use the API operations to set log levels and monitor your devices with CloudWatch.
You can also use the API operations to create multicast groups and schedule a multicast session for sending a downlink message to devices in the group. By using Firmware Updates Over-The-Air (FUOTA) API operations, you can create a FUOTA task and schedule a session to update the firmware of individual devices or an entire group of devices in a multicast group.
To connect to the AWS IoT Wireless Service, use the Service endpoints as described in IoT Wireless Service endpoints. You can use both IPv4 and IPv6 protocols to connect to the endpoints and send requests to the AWS IoT Wireless service. For more information, see Using IPv6 with AWS IoT Wireless.
Constructors
- IoTWireless({required String region, AwsClientCredentials? credentials, AwsClientCredentialsProvider? credentialsProvider, Client? client, String? endpointUrl})
Properties
- hashCode → int
-
The hash code for this object.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
associateAwsAccountWithPartnerAccount(
{required SidewalkAccountInfo sidewalk, String? clientRequestToken, List< Tag> ? tags}) → Future<AssociateAwsAccountWithPartnerAccountResponse> - Associates a partner account with your AWS account.
-
associateMulticastGroupWithFuotaTask(
{required String id, required String multicastGroupId}) → Future< void> - Associate a multicast group with a FUOTA task.
-
associateWirelessDeviceWithFuotaTask(
{required String id, required String wirelessDeviceId}) → Future< void> - Associate a wireless device with a FUOTA task.
-
associateWirelessDeviceWithMulticastGroup(
{required String id, required String wirelessDeviceId}) → Future< void> - Associates a wireless device with a multicast group.
-
associateWirelessDeviceWithThing(
{required String id, required String thingArn}) → Future< void> - Associates a wireless device with a thing.
-
associateWirelessGatewayWithCertificate(
{required String id, required String iotCertificateId}) → Future< AssociateWirelessGatewayWithCertificateResponse> - Associates a wireless gateway with a certificate.
-
associateWirelessGatewayWithThing(
{required String id, required String thingArn}) → Future< void> - Associates a wireless gateway with a thing.
-
cancelMulticastGroupSession(
{required String id}) → Future< void> - Cancels an existing multicast group session.
-
close(
) → void - Closes the internal HTTP client if none was provided at creation. If a client was passed as a constructor argument, this becomes a noop.
-
createDestination(
{required String expression, required ExpressionType expressionType, required String name, required String roleArn, String? clientRequestToken, String? description, List< Tag> ? tags}) → Future<CreateDestinationResponse> - Creates a new destination that maps a device message to an AWS IoT rule.
-
createDeviceProfile(
{String? clientRequestToken, LoRaWANDeviceProfile? loRaWAN, String? name, SidewalkCreateDeviceProfile? sidewalk, List< Tag> ? tags}) → Future<CreateDeviceProfileResponse> - Creates a new device profile.
-
createFuotaTask(
{required String firmwareUpdateImage, required String firmwareUpdateRole, String? clientRequestToken, String? description, String? descriptor, int? fragmentIntervalMS, int? fragmentSizeBytes, LoRaWANFuotaTask? loRaWAN, String? name, int? redundancyPercent, List< Tag> ? tags}) → Future<CreateFuotaTaskResponse> - Creates a FUOTA task.
-
createMulticastGroup(
{required LoRaWANMulticast loRaWAN, String? clientRequestToken, String? description, String? name, List< Tag> ? tags}) → Future<CreateMulticastGroupResponse> - Creates a multicast group.
-
createNetworkAnalyzerConfiguration(
{required String name, String? clientRequestToken, String? description, List< String> ? multicastGroups, List<Tag> ? tags, TraceContent? traceContent, List<String> ? wirelessDevices, List<String> ? wirelessGateways}) → Future<CreateNetworkAnalyzerConfigurationResponse> - Creates a new network analyzer configuration.
-
createServiceProfile(
{String? clientRequestToken, LoRaWANServiceProfile? loRaWAN, String? name, List< Tag> ? tags}) → Future<CreateServiceProfileResponse> - Creates a new service profile.
-
createWirelessDevice(
{required String destinationName, required WirelessDeviceType type, String? clientRequestToken, String? description, LoRaWANDevice? loRaWAN, String? name, PositioningConfigStatus? positioning, SidewalkCreateWirelessDevice? sidewalk, List< Tag> ? tags}) → Future<CreateWirelessDeviceResponse> - Provisions a wireless device.
-
createWirelessGateway(
{required LoRaWANGateway loRaWAN, String? clientRequestToken, String? description, String? name, List< Tag> ? tags}) → Future<CreateWirelessGatewayResponse> - Provisions a wireless gateway.
-
createWirelessGatewayTask(
{required String id, required String wirelessGatewayTaskDefinitionId}) → Future< CreateWirelessGatewayTaskResponse> - Creates a task for a wireless gateway.
-
createWirelessGatewayTaskDefinition(
{required bool autoCreateTasks, String? clientRequestToken, String? name, List< Tag> ? tags, UpdateWirelessGatewayTaskCreate? update}) → Future<CreateWirelessGatewayTaskDefinitionResponse> - Creates a gateway task definition.
-
deleteDestination(
{required String name}) → Future< void> - Deletes a destination.
-
deleteDeviceProfile(
{required String id}) → Future< void> - Deletes a device profile.
-
deleteFuotaTask(
{required String id}) → Future< void> - Deletes a FUOTA task.
-
deleteMulticastGroup(
{required String id}) → Future< void> - Deletes a multicast group if it is not in use by a FUOTA task.
-
deleteNetworkAnalyzerConfiguration(
{required String configurationName}) → Future< void> - Deletes a network analyzer configuration.
-
deleteQueuedMessages(
{required String id, required String messageId, WirelessDeviceType? wirelessDeviceType}) → Future< void> - Remove queued messages from the downlink queue.
-
deleteServiceProfile(
{required String id}) → Future< void> - Deletes a service profile.
-
deleteWirelessDevice(
{required String id}) → Future< void> - Deletes a wireless device.
-
deleteWirelessDeviceImportTask(
{required String id}) → Future< void> - Delete an import task.
-
deleteWirelessGateway(
{required String id}) → Future< void> - Deletes a wireless gateway.
-
deleteWirelessGatewayTask(
{required String id}) → Future< void> - Deletes a wireless gateway task.
-
deleteWirelessGatewayTaskDefinition(
{required String id}) → Future< void> - Deletes a wireless gateway task definition. Deleting this task definition does not affect tasks that are currently in progress.
-
deregisterWirelessDevice(
{required String identifier, WirelessDeviceType? wirelessDeviceType}) → Future< void> - Deregister a wireless device from AWS IoT Wireless.
-
disassociateAwsAccountFromPartnerAccount(
{required String partnerAccountId, required PartnerType partnerType}) → Future< void> -
Disassociates your AWS account from a partner account. If
PartnerAccountIdandPartnerTypearenull, disassociates your AWS account from all partner accounts. -
disassociateMulticastGroupFromFuotaTask(
{required String id, required String multicastGroupId}) → Future< void> - Disassociates a multicast group from a FUOTA task.
-
disassociateWirelessDeviceFromFuotaTask(
{required String id, required String wirelessDeviceId}) → Future< void> - Disassociates a wireless device from a FUOTA task.
-
disassociateWirelessDeviceFromMulticastGroup(
{required String id, required String wirelessDeviceId}) → Future< void> - Disassociates a wireless device from a multicast group.
-
disassociateWirelessDeviceFromThing(
{required String id}) → Future< void> - Disassociates a wireless device from its currently associated thing.
-
disassociateWirelessGatewayFromCertificate(
{required String id}) → Future< void> - Disassociates a wireless gateway from its currently associated certificate.
-
disassociateWirelessGatewayFromThing(
{required String id}) → Future< void> - Disassociates a wireless gateway from its currently associated thing.
-
getDestination(
{required String name}) → Future< GetDestinationResponse> - Gets information about a destination.
-
getDeviceProfile(
{required String id}) → Future< GetDeviceProfileResponse> - Gets information about a device profile.
-
getEventConfigurationByResourceTypes(
) → Future< GetEventConfigurationByResourceTypesResponse> - Get the event configuration based on resource types.
-
getFuotaTask(
{required String id}) → Future< GetFuotaTaskResponse> - Gets information about a FUOTA task.
-
getLogLevelsByResourceTypes(
) → Future< GetLogLevelsByResourceTypesResponse> - Returns current default log levels or log levels by resource types. Based on the resource type, log levels can be returned for wireless device, wireless gateway, or FUOTA task log options.
-
getMetricConfiguration(
) → Future< GetMetricConfigurationResponse> - Get the metric configuration status for this AWS account.
-
getMetrics(
{List< SummaryMetricQuery> ? summaryMetricQueries}) → Future<GetMetricsResponse> - Get the summary metrics for this AWS account.
-
getMulticastGroup(
{required String id}) → Future< GetMulticastGroupResponse> - Gets information about a multicast group.
-
getMulticastGroupSession(
{required String id}) → Future< GetMulticastGroupSessionResponse> - Gets information about a multicast group session.
-
getNetworkAnalyzerConfiguration(
{required String configurationName}) → Future< GetNetworkAnalyzerConfigurationResponse> - Get network analyzer configuration.
-
getPartnerAccount(
{required String partnerAccountId, required PartnerType partnerType}) → Future< GetPartnerAccountResponse> -
Gets information about a partner account. If
PartnerAccountIdandPartnerTypearenull, returns all partner accounts. -
getPosition(
{required String resourceIdentifier, required PositionResourceType resourceType}) → Future< GetPositionResponse> - Get the position information for a given resource.
-
getPositionConfiguration(
{required String resourceIdentifier, required PositionResourceType resourceType}) → Future< GetPositionConfigurationResponse> - Get position configuration for a given resource.
-
getPositionEstimate(
{AdvancedConfiguration? advancedConfiguration, CellTowers? cellTowers, Gnss? gnss, Ip? ip, DateTime? timestamp, List< WiFiAccessPoint> ? wiFiAccessPoints}) → Future<GetPositionEstimateResponse> - Get estimated position information as a payload in GeoJSON format. The payload measurement data is resolved using solvers that are provided by third-party vendors.
-
getResourceEventConfiguration(
{required String identifier, required IdentifierType identifierType, EventNotificationPartnerType? partnerType}) → Future< GetResourceEventConfigurationResponse> - Get the event configuration for a particular resource identifier.
-
getResourceLogLevel(
{required String resourceIdentifier, required String resourceType}) → Future< GetResourceLogLevelResponse> - Fetches the log-level override, if any, for a given resource ID and resource type..
-
getResourcePosition(
{required String resourceIdentifier, required PositionResourceType resourceType}) → Future< GetResourcePositionResponse> - Get the position information for a given wireless device or a wireless gateway resource. The position information uses the World Geodetic System (WGS84).
-
getServiceEndpoint(
{WirelessGatewayServiceType? serviceType}) → Future< GetServiceEndpointResponse> - Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.
-
getServiceProfile(
{required String id}) → Future< GetServiceProfileResponse> - Gets information about a service profile.
-
getWirelessDevice(
{required String identifier, required WirelessDeviceIdType identifierType}) → Future< GetWirelessDeviceResponse> - Gets information about a wireless device.
-
getWirelessDeviceImportTask(
{required String id}) → Future< GetWirelessDeviceImportTaskResponse> - Get information about an import task and count of device onboarding summary information for the import task.
-
getWirelessDeviceStatistics(
{required String wirelessDeviceId}) → Future< GetWirelessDeviceStatisticsResponse> - Gets operating information about a wireless device.
-
getWirelessGateway(
{required String identifier, required WirelessGatewayIdType identifierType}) → Future< GetWirelessGatewayResponse> - Gets information about a wireless gateway.
-
getWirelessGatewayCertificate(
{required String id}) → Future< GetWirelessGatewayCertificateResponse> - Gets the ID of the certificate that is currently associated with a wireless gateway.
-
getWirelessGatewayFirmwareInformation(
{required String id}) → Future< GetWirelessGatewayFirmwareInformationResponse> - Gets the firmware version and other information about a wireless gateway.
-
getWirelessGatewayStatistics(
{required String wirelessGatewayId}) → Future< GetWirelessGatewayStatisticsResponse> - Gets operating information about a wireless gateway.
-
getWirelessGatewayTask(
{required String id}) → Future< GetWirelessGatewayTaskResponse> - Gets information about a wireless gateway task.
-
getWirelessGatewayTaskDefinition(
{required String id}) → Future< GetWirelessGatewayTaskDefinitionResponse> - Gets information about a wireless gateway task definition.
-
listDestinations(
{int? maxResults, String? nextToken}) → Future< ListDestinationsResponse> - Lists the destinations registered to your AWS account.
-
listDeviceProfiles(
{DeviceProfileType? deviceProfileType, int? maxResults, String? nextToken}) → Future< ListDeviceProfilesResponse> - Lists the device profiles registered to your AWS account.
-
listDevicesForWirelessDeviceImportTask(
{required String id, int? maxResults, String? nextToken, OnboardStatus? status}) → Future< ListDevicesForWirelessDeviceImportTaskResponse> - List the Sidewalk devices in an import task and their onboarding status.
-
listEventConfigurations(
{required EventNotificationResourceType resourceType, int? maxResults, String? nextToken}) → Future< ListEventConfigurationsResponse> - List event configurations where at least one event topic has been enabled.
-
listFuotaTasks(
{int? maxResults, String? nextToken}) → Future< ListFuotaTasksResponse> - Lists the FUOTA tasks registered to your AWS account.
-
listMulticastGroups(
{int? maxResults, String? nextToken}) → Future< ListMulticastGroupsResponse> - Lists the multicast groups registered to your AWS account.
-
listMulticastGroupsByFuotaTask(
{required String id, int? maxResults, String? nextToken}) → Future< ListMulticastGroupsByFuotaTaskResponse> - List all multicast groups associated with a FUOTA task.
-
listNetworkAnalyzerConfigurations(
{int? maxResults, String? nextToken}) → Future< ListNetworkAnalyzerConfigurationsResponse> - Lists the network analyzer configurations.
-
listPartnerAccounts(
{int? maxResults, String? nextToken}) → Future< ListPartnerAccountsResponse> - Lists the partner accounts associated with your AWS account.
-
listPositionConfigurations(
{int? maxResults, String? nextToken, PositionResourceType? resourceType}) → Future< ListPositionConfigurationsResponse> - List position configurations for a given resource, such as positioning solvers.
-
listQueuedMessages(
{required String id, int? maxResults, String? nextToken, WirelessDeviceType? wirelessDeviceType}) → Future< ListQueuedMessagesResponse> - List queued messages in the downlink queue.
-
listServiceProfiles(
{int? maxResults, String? nextToken}) → Future< ListServiceProfilesResponse> - Lists the service profiles registered to your AWS account.
-
listTagsForResource(
{required String resourceArn}) → Future< ListTagsForResourceResponse> - Lists the tags (metadata) you have assigned to the resource.
-
listWirelessDeviceImportTasks(
{int? maxResults, String? nextToken}) → Future< ListWirelessDeviceImportTasksResponse> - List of import tasks and summary information of onboarding status of devices in each import task.
-
listWirelessDevices(
{String? destinationName, String? deviceProfileId, String? fuotaTaskId, int? maxResults, String? multicastGroupId, String? nextToken, String? serviceProfileId, WirelessDeviceType? wirelessDeviceType}) → Future< ListWirelessDevicesResponse> - Lists the wireless devices registered to your AWS account.
-
listWirelessGateways(
{int? maxResults, String? nextToken}) → Future< ListWirelessGatewaysResponse> - Lists the wireless gateways registered to your AWS account.
-
listWirelessGatewayTaskDefinitions(
{int? maxResults, String? nextToken, WirelessGatewayTaskDefinitionType? taskDefinitionType}) → Future< ListWirelessGatewayTaskDefinitionsResponse> - List the wireless gateway tasks definitions registered to your AWS account.
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
putPositionConfiguration(
{required String resourceIdentifier, required PositionResourceType resourceType, String? destination, PositionSolverConfigurations? solvers}) → Future< void> - Put position configuration for a given resource.
-
putResourceLogLevel(
{required LogLevel logLevel, required String resourceIdentifier, required String resourceType}) → Future< void> - Sets the log-level override for a resource ID and resource type. A limit of 200 log level override can be set per account.
-
resetAllResourceLogLevels(
) → Future< void> - Removes the log-level overrides for all resources; wireless devices, wireless gateways, and FUOTA tasks.
-
resetResourceLogLevel(
{required String resourceIdentifier, required String resourceType}) → Future< void> - Removes the log-level override, if any, for a specific resource ID and resource type. It can be used for a wireless device, a wireless gateway, or a FUOTA task.
-
sendDataToMulticastGroup(
{required String id, required String payloadData, required MulticastWirelessMetadata wirelessMetadata}) → Future< SendDataToMulticastGroupResponse> - Sends the specified data to a multicast group.
-
sendDataToWirelessDevice(
{required String id, required String payloadData, required int transmitMode, WirelessMetadata? wirelessMetadata}) → Future< SendDataToWirelessDeviceResponse> - Sends a decrypted application data frame to a device.
-
startBulkAssociateWirelessDeviceWithMulticastGroup(
{required String id, String? queryString, List< Tag> ? tags}) → Future<void> - Starts a bulk association of all qualifying wireless devices with a multicast group.
-
startBulkDisassociateWirelessDeviceFromMulticastGroup(
{required String id, String? queryString, List< Tag> ? tags}) → Future<void> - Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.
-
startFuotaTask(
{required String id, LoRaWANStartFuotaTask? loRaWAN}) → Future< void> - Starts a FUOTA task.
-
startMulticastGroupSession(
{required String id, required LoRaWANMulticastSession loRaWAN}) → Future< void> - Starts a multicast group session.
-
startSingleWirelessDeviceImportTask(
{required String destinationName, required SidewalkSingleStartImportInfo sidewalk, String? clientRequestToken, String? deviceName, PositioningConfigStatus? positioning, List< Tag> ? tags}) → Future<StartSingleWirelessDeviceImportTaskResponse> - Start import task for a single wireless device.
-
startWirelessDeviceImportTask(
{required String destinationName, required SidewalkStartImportInfo sidewalk, String? clientRequestToken, PositioningConfigStatus? positioning, List< Tag> ? tags}) → Future<StartWirelessDeviceImportTaskResponse> - Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.
-
tagResource(
{required String resourceArn, required List< Tag> tags}) → Future<void> - Adds a tag to a resource.
-
testWirelessDevice(
{required String id}) → Future< TestWirelessDeviceResponse> -
Simulates a provisioned device by sending an uplink data payload of
Hello. -
toString(
) → String -
A string representation of this object.
inherited
-
untagResource(
{required String resourceArn, required List< String> tagKeys}) → Future<void> - Removes one or more tags from a resource.
-
updateDestination(
{required String name, String? description, String? expression, ExpressionType? expressionType, String? roleArn}) → Future< void> - Updates properties of a destination.
-
updateEventConfigurationByResourceTypes(
{ConnectionStatusResourceTypeEventConfiguration? connectionStatus, DeviceRegistrationStateResourceTypeEventConfiguration? deviceRegistrationState, JoinResourceTypeEventConfiguration? join, MessageDeliveryStatusResourceTypeEventConfiguration? messageDeliveryStatus, ProximityResourceTypeEventConfiguration? proximity}) → Future< void> - Update the event configuration based on resource types.
-
updateFuotaTask(
{required String id, String? description, String? descriptor, String? firmwareUpdateImage, String? firmwareUpdateRole, int? fragmentIntervalMS, int? fragmentSizeBytes, LoRaWANFuotaTask? loRaWAN, String? name, int? redundancyPercent}) → Future< void> - Updates properties of a FUOTA task.
-
updateLogLevelsByResourceTypes(
{LogLevel? defaultLogLevel, List< FuotaTaskLogOption> ? fuotaTaskLogOptions, List<WirelessDeviceLogOption> ? wirelessDeviceLogOptions, List<WirelessGatewayLogOption> ? wirelessGatewayLogOptions}) → Future<void> - Set default log level, or log levels by resource types. This can be for wireless device, wireless gateway, or FUOTA task log options, and is used to control the log messages that'll be displayed in CloudWatch.
-
updateMetricConfiguration(
{SummaryMetricConfiguration? summaryMetric}) → Future< void> - Update the summary metric configuration.
-
updateMulticastGroup(
{required String id, String? description, LoRaWANMulticast? loRaWAN, String? name}) → Future< void> - Updates properties of a multicast group session.
-
updateNetworkAnalyzerConfiguration(
{required String configurationName, String? description, List< String> ? multicastGroupsToAdd, List<String> ? multicastGroupsToRemove, TraceContent? traceContent, List<String> ? wirelessDevicesToAdd, List<String> ? wirelessDevicesToRemove, List<String> ? wirelessGatewaysToAdd, List<String> ? wirelessGatewaysToRemove}) → Future<void> - Update network analyzer configuration.
-
updatePartnerAccount(
{required String partnerAccountId, required PartnerType partnerType, required SidewalkUpdateAccount sidewalk}) → Future< void> - Updates properties of a partner account.
-
updatePosition(
{required List< double> position, required String resourceIdentifier, required PositionResourceType resourceType}) → Future<void> - Update the position information of a resource.
-
updateResourceEventConfiguration(
{required String identifier, required IdentifierType identifierType, ConnectionStatusEventConfiguration? connectionStatus, DeviceRegistrationStateEventConfiguration? deviceRegistrationState, JoinEventConfiguration? join, MessageDeliveryStatusEventConfiguration? messageDeliveryStatus, EventNotificationPartnerType? partnerType, ProximityEventConfiguration? proximity}) → Future< void> - Update the event configuration for a particular resource identifier.
-
updateResourcePosition(
{required String resourceIdentifier, required PositionResourceType resourceType, Uint8List? geoJsonPayload}) → Future< void> - Update the position information of a given wireless device or a wireless gateway resource. The position coordinates are based on the World Geodetic System (WGS84).
-
updateWirelessDevice(
{required String id, String? description, String? destinationName, LoRaWANUpdateDevice? loRaWAN, String? name, PositioningConfigStatus? positioning, SidewalkUpdateWirelessDevice? sidewalk}) → Future< void> - Updates properties of a wireless device.
-
updateWirelessDeviceImportTask(
{required String id, required SidewalkUpdateImportInfo sidewalk}) → Future< void> - Update an import task to add more devices to the task.
-
updateWirelessGateway(
{required String id, String? description, List< List< ? joinEuiFilters, double? maxEirp, String? name, List<String> >String> ? netIdFilters}) → Future<void> - Updates properties of a wireless gateway.
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited