View Source aws_iot_wireless (aws v1.0.4)
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.Summary
Functions
Deletes a wireless gateway task definition.
Disassociates your AWS account from a partner account.
Returns current default log levels or log levels by resource types.
Gets information about a partner account.
Get the position information for a given resource.
Get position configuration for a given resource.
Get estimated position information as a payload in GeoJSON format.
Fetches the log-level override, if any, for a given resource-ID and resource-type.
Get the position information for a given wireless device or a wireless gateway resource.
List position configurations for a given resource, such as positioning solvers.
Put position configuration for a given resource.
Sets the log-level override for a resource-ID and resource-type.
Removes the log-level override, if any, for a specific resource-ID and resource-type.
Hello
.Set default log level, or log levels by resource types.
Update the position information of a resource.
Update the position information of a given wireless device or a wireless gateway resource.
Functions
associate_aws_account_with_partner_account(Client, Input0, Options0)
View Sourceassociate_multicast_group_with_fuota_task(Client, Id, Input0, Options0)
View Sourceassociate_wireless_device_with_fuota_task(Client, Id, Input0, Options0)
View Sourceassociate_wireless_device_with_multicast_group(Client, Id, Input0, Options0)
View Sourceassociate_wireless_device_with_thing(Client, Id, Input0, Options0)
View Sourceassociate_wireless_gateway_with_certificate(Client, Id, Input0, Options0)
View Sourceassociate_wireless_gateway_with_thing(Client, Id, Input0, Options0)
View Sourcedelete_network_analyzer_configuration(Client, ConfigurationName, Input)
View Sourcedelete_network_analyzer_configuration(Client, ConfigurationName, Input0, Options0)
View SourceDeletes a wireless gateway task definition.
Deleting this task definition does not affect tasks that are currently in progress.delete_wireless_gateway_task_definition(Client, Id, Input0, Options0)
View Sourcedisassociate_aws_account_from_partner_account(Client, PartnerAccountId, Input)
View SourceDisassociates your AWS account from a partner account.
IfPartnerAccountId
and PartnerType
are null
, disassociates your AWS account from all partner accounts.
disassociate_aws_account_from_partner_account(Client, PartnerAccountId, Input0, Options0)
View Sourcedisassociate_multicast_group_from_fuota_task(Client, Id, MulticastGroupId, Input)
View Sourcedisassociate_multicast_group_from_fuota_task(Client, Id, MulticastGroupId, Input0, Options0)
View Sourcedisassociate_wireless_device_from_fuota_task(Client, Id, WirelessDeviceId, Input)
View Sourcedisassociate_wireless_device_from_fuota_task(Client, Id, WirelessDeviceId, Input0, Options0)
View Sourcedisassociate_wireless_device_from_multicast_group(Client, Id, WirelessDeviceId, Input)
View Sourcedisassociate_wireless_device_from_multicast_group(Client, Id, WirelessDeviceId, Input0, Options0)
View Sourcedisassociate_wireless_device_from_thing(Client, Id, Input0, Options0)
View Sourcedisassociate_wireless_gateway_from_certificate(Client, Id, Input0, Options0)
View Sourcedisassociate_wireless_gateway_from_thing(Client, Id, Input0, Options0)
View Sourceget_event_configuration_by_resource_types(Client, QueryMap, HeadersMap)
View Sourceget_event_configuration_by_resource_types(Client, QueryMap, HeadersMap, Options0)
View SourceReturns current default log levels or log levels by resource types.
Based on resource types, log levels can be for wireless device log options or wireless gateway log options.get_log_levels_by_resource_types(Client, QueryMap, HeadersMap, Options0)
View Sourceget_multicast_group_session(Client, Id, QueryMap, HeadersMap, Options0)
View Sourceget_network_analyzer_configuration(Client, ConfigurationName, QueryMap, HeadersMap)
View Sourceget_network_analyzer_configuration(Client, ConfigurationName, QueryMap, HeadersMap, Options0)
View SourceGets information about a partner account.
IfPartnerAccountId
and PartnerType
are null
, returns all partner accounts.
get_partner_account(Client, PartnerAccountId, PartnerType, QueryMap, HeadersMap)
View Sourceget_partner_account(Client, PartnerAccountId, PartnerType, QueryMap, HeadersMap, Options0)
View SourceGet the position information for a given resource.
This action is no longer supported. Calls to retrieve the position information should use the GetResourcePosition: https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html API operation instead.get_position(Client, ResourceIdentifier, ResourceType, QueryMap, HeadersMap)
View Sourceget_position(Client, ResourceIdentifier, ResourceType, QueryMap, HeadersMap, Options0)
View Sourceget_position_configuration(Client, ResourceIdentifier, ResourceType)
View SourceGet position configuration for a given resource.
This action is no longer supported. Calls to retrieve the position configuration should use the GetResourcePosition: https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html API operation instead.get_position_configuration(Client, ResourceIdentifier, ResourceType, QueryMap, HeadersMap)
View Sourceget_position_configuration(Client, ResourceIdentifier, ResourceType, QueryMap, HeadersMap, Options0)
View SourceGet estimated position information as a payload in GeoJSON format.
The payload measurement data is resolved using solvers that are provided by third-party vendors.get_resource_event_configuration(Client, Identifier, IdentifierType)
View Sourceget_resource_event_configuration(Client, Identifier, IdentifierType, QueryMap, HeadersMap)
View Sourceget_resource_event_configuration(Client, Identifier, IdentifierType, QueryMap, HeadersMap, Options0)
View SourceFetches the log-level override, if any, for a given resource-ID and resource-type.
It can be used for a wireless device or a wireless gateway.get_resource_log_level(Client, ResourceIdentifier, ResourceType, QueryMap, HeadersMap)
View Sourceget_resource_log_level(Client, ResourceIdentifier, ResourceType, QueryMap, HeadersMap, Options0)
View SourceGet the position information for a given wireless device or a wireless gateway resource.
The position information uses the World Geodetic System (WGS84): https://gisgeography.com/wgs84-world-geodetic-system/.get_resource_position(Client, ResourceIdentifier, ResourceType, QueryMap, HeadersMap)
View Sourceget_resource_position(Client, ResourceIdentifier, ResourceType, QueryMap, HeadersMap, Options0)
View Sourceget_wireless_device(Client, Identifier, IdentifierType, QueryMap, HeadersMap)
View Sourceget_wireless_device(Client, Identifier, IdentifierType, QueryMap, HeadersMap, Options0)
View Sourceget_wireless_device_import_task(Client, Id, QueryMap, HeadersMap, Options0)
View Sourceget_wireless_device_statistics(Client, WirelessDeviceId, QueryMap, HeadersMap)
View Sourceget_wireless_device_statistics(Client, WirelessDeviceId, QueryMap, HeadersMap, Options0)
View Sourceget_wireless_gateway(Client, Identifier, IdentifierType, QueryMap, HeadersMap)
View Sourceget_wireless_gateway(Client, Identifier, IdentifierType, QueryMap, HeadersMap, Options0)
View Sourceget_wireless_gateway_certificate(Client, Id, QueryMap, HeadersMap)
View Sourceget_wireless_gateway_certificate(Client, Id, QueryMap, HeadersMap, Options0)
View Sourceget_wireless_gateway_firmware_information(Client, Id, QueryMap, HeadersMap)
View Sourceget_wireless_gateway_firmware_information(Client, Id, QueryMap, HeadersMap, Options0)
View Sourceget_wireless_gateway_statistics(Client, WirelessGatewayId, QueryMap, HeadersMap)
View Sourceget_wireless_gateway_statistics(Client, WirelessGatewayId, QueryMap, HeadersMap, Options0)
View Sourceget_wireless_gateway_task(Client, Id, QueryMap, HeadersMap, Options0)
View Sourceget_wireless_gateway_task_definition(Client, Id, QueryMap, HeadersMap)
View Sourceget_wireless_gateway_task_definition(Client, Id, QueryMap, HeadersMap, Options0)
View Sourcelist_devices_for_wireless_device_import_task(Client, Id, QueryMap, HeadersMap)
View Sourcelist_devices_for_wireless_device_import_task(Client, Id, QueryMap, HeadersMap, Options0)
View Sourcelist_event_configurations(Client, ResourceType, QueryMap, HeadersMap)
View Sourcelist_event_configurations(Client, ResourceType, QueryMap, HeadersMap, Options0)
View Sourcelist_multicast_groups_by_fuota_task(Client, Id, QueryMap, HeadersMap)
View Sourcelist_multicast_groups_by_fuota_task(Client, Id, QueryMap, HeadersMap, Options0)
View Sourcelist_network_analyzer_configurations(Client, QueryMap, HeadersMap)
View Sourcelist_network_analyzer_configurations(Client, QueryMap, HeadersMap, Options0)
View SourceList position configurations for a given resource, such as positioning solvers.
This action is no longer supported. Calls to retrieve position information should use the GetResourcePosition: https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_GetResourcePosition.html API operation instead.list_position_configurations(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_tags_for_resource(Client, ResourceArn, QueryMap, HeadersMap, Options0)
View Sourcelist_wireless_device_import_tasks(Client, QueryMap, HeadersMap, Options0)
View Sourcelist_wireless_gateway_task_definitions(Client, QueryMap, HeadersMap)
View Sourcelist_wireless_gateway_task_definitions(Client, QueryMap, HeadersMap, Options0)
View SourcePut position configuration for a given resource.
This action is no longer supported. Calls to update the position configuration should use the UpdateResourcePosition: https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html API operation instead.put_position_configuration(Client, ResourceIdentifier, Input0, Options0)
View SourceSets the log-level override for a resource-ID and resource-type.
This option can be specified for a wireless gateway or a wireless device. A limit of 200 log level override can be set per account.put_resource_log_level(Client, ResourceIdentifier, Input0, Options0)
View SourceRemoves the log-level override, if any, for a specific resource-ID and resource-type.
It can be used for a wireless device or a wireless gateway.reset_resource_log_level(Client, ResourceIdentifier, Input0, Options0)
View Sourcestart_bulk_associate_wireless_device_with_multicast_group(Client, Id, Input)
View Sourcestart_bulk_associate_wireless_device_with_multicast_group(Client, Id, Input0, Options0)
View Sourcestart_bulk_disassociate_wireless_device_from_multicast_group(Client, Id, Input)
View Sourcestart_bulk_disassociate_wireless_device_from_multicast_group(Client, Id, Input0, Options0)
View Sourcestart_single_wireless_device_import_task(Client, Input0, Options0)
View SourceHello
.
update_event_configuration_by_resource_types(Client, Input0, Options0)
View SourceSet default log level, or log levels by resource types.
This can be for wireless device log options or wireless gateways log options and is used to control the log messages that'll be displayed in CloudWatch.update_network_analyzer_configuration(Client, ConfigurationName, Input)
View Sourceupdate_network_analyzer_configuration(Client, ConfigurationName, Input0, Options0)
View Sourceupdate_partner_account(Client, PartnerAccountId, Input0, Options0)
View SourceUpdate the position information of a resource.
This action is no longer supported. Calls to update the position information should use the UpdateResourcePosition: https://docs.aws.amazon.com/iot-wireless/2020-11-22/apireference/API_UpdateResourcePosition.html API operation instead.update_resource_event_configuration(Client, Identifier, Input0, Options0)
View SourceUpdate the position information of a given wireless device or a wireless gateway resource.
The position coordinates are based on the World Geodetic System (WGS84): https://gisgeography.com/wgs84-world-geodetic-system/.