View Source AWS.IoTWireless (aws-elixir 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.

To connect to the AWS IoT Wireless Service, use the Service endpoints as described in IoT Wireless Service endpoints in the AWS General Reference.

Link to this section Summary

Functions

associate_aws_account_with_partner_account(client, input, options \\ [])

Associates a partner account with your AWS account.

associate_multicast_group_with_fuota_task(client, id, input, options \\ [])

Associate a multicast group with a FUOTA task.

associate_wireless_device_with_fuota_task(client, id, input, options \\ [])

Associate a wireless device with a FUOTA task.

associate_wireless_device_with_multicast_group(client, id, input, options \\ [])

Associates a wireless device with a multicast group.

associate_wireless_device_with_thing(client, id, input, options \\ [])

Associates a wireless device with a thing.

associate_wireless_gateway_with_certificate(client, id, input, options \\ [])

Associates a wireless gateway with a certificate.

associate_wireless_gateway_with_thing(client, id, input, options \\ [])

Associates a wireless gateway with a thing.

cancel_multicast_group_session(client, id, input, options \\ [])

Cancels an existing multicast group session.

create_destination(client, input, options \\ [])

Creates a new destination that maps a device message to an AWS IoT rule.

create_device_profile(client, input, options \\ [])

Creates a new device profile.

create_fuota_task(client, input, options \\ [])

Creates a FUOTA task.

create_multicast_group(client, input, options \\ [])

Creates a multicast group.

create_network_analyzer_configuration(client, input, options \\ [])

Creates a new network analyzer configuration.

create_service_profile(client, input, options \\ [])

Creates a new service profile.

create_wireless_device(client, input, options \\ [])

Provisions a wireless device.

create_wireless_gateway(client, input, options \\ [])

Provisions a wireless gateway.

create_wireless_gateway_task(client, id, input, options \\ [])

Creates a task for a wireless gateway.

create_wireless_gateway_task_definition(client, input, options \\ [])

Creates a gateway task definition.

delete_destination(client, name, input, options \\ [])

Deletes a destination.

delete_device_profile(client, id, input, options \\ [])

Deletes a device profile.

delete_fuota_task(client, id, input, options \\ [])

Deletes a FUOTA task.

delete_multicast_group(client, id, input, options \\ [])

Deletes a multicast group if it is not in use by a fuota task.

delete_network_analyzer_configuration(client, configuration_name, input, options \\ [])

Deletes a network analyzer configuration.

delete_queued_messages(client, id, input, options \\ [])

Remove queued messages from the downlink queue.

delete_service_profile(client, id, input, options \\ [])

Deletes a service profile.

delete_wireless_device(client, id, input, options \\ [])

Deletes a wireless device.

delete_wireless_device_import_task(client, id, input, options \\ [])

Delete an import task.

delete_wireless_gateway(client, id, input, options \\ [])

Deletes a wireless gateway.

delete_wireless_gateway_task(client, id, input, options \\ [])

Deletes a wireless gateway task.

delete_wireless_gateway_task_definition(client, id, input, options \\ [])

Deletes a wireless gateway task definition.

deregister_wireless_device(client, identifier, input, options \\ [])

Deregister a wireless device from AWS IoT Wireless.

disassociate_aws_account_from_partner_account(client, partner_account_id, input, options \\ [])

Disassociates your AWS account from a partner account.

disassociate_multicast_group_from_fuota_task(client, id, multicast_group_id, input, options \\ [])

Disassociates a multicast group from a fuota task.

disassociate_wireless_device_from_fuota_task(client, id, wireless_device_id, input, options \\ [])

Disassociates a wireless device from a FUOTA task.

disassociate_wireless_device_from_multicast_group(client, id, wireless_device_id, input, options \\ [])

Disassociates a wireless device from a multicast group.

disassociate_wireless_device_from_thing(client, id, input, options \\ [])

Disassociates a wireless device from its currently associated thing.

disassociate_wireless_gateway_from_certificate(client, id, input, options \\ [])

Disassociates a wireless gateway from its currently associated certificate.

disassociate_wireless_gateway_from_thing(client, id, input, options \\ [])

Disassociates a wireless gateway from its currently associated thing.

get_destination(client, name, options \\ [])

Gets information about a destination.

get_device_profile(client, id, options \\ [])

Gets information about a device profile.

get_event_configuration_by_resource_types(client, options \\ [])

Get the event configuration based on resource types.

get_fuota_task(client, id, options \\ [])

Gets information about a FUOTA task.

get_log_levels_by_resource_types(client, options \\ [])

Returns current default log levels or log levels by resource types.

get_metric_configuration(client, options \\ [])

Get the metric configuration status for this AWS account.

get_metrics(client, input, options \\ [])

Get the summary metrics for this AWS account.

get_multicast_group(client, id, options \\ [])

Gets information about a multicast group.

get_multicast_group_session(client, id, options \\ [])

Gets information about a multicast group session.

get_network_analyzer_configuration(client, configuration_name, options \\ [])

Get network analyzer configuration.

get_partner_account(client, partner_account_id, partner_type, options \\ [])

Gets information about a partner account.

get_position(client, resource_identifier, resource_type, options \\ [])

Get the position information for a given resource.

get_position_configuration(client, resource_identifier, resource_type, options \\ [])

Get position configuration for a given resource.

get_position_estimate(client, input, options \\ [])

Get estimated position information as a payload in GeoJSON format.

get_resource_event_configuration(client, identifier, identifier_type, partner_type \\ nil, options \\ [])

Get the event configuration for a particular resource identifier.

get_resource_log_level(client, resource_identifier, resource_type, options \\ [])

Fetches the log-level override, if any, for a given resource-ID and resource-type.

get_resource_position(client, resource_identifier, resource_type, options \\ [])

Get the position information for a given wireless device or a wireless gateway resource.

get_service_endpoint(client, service_type \\ nil, options \\ [])

Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.

get_service_profile(client, id, options \\ [])

Gets information about a service profile.

get_wireless_device(client, identifier, identifier_type, options \\ [])

Gets information about a wireless device.

get_wireless_device_import_task(client, id, options \\ [])

Get information about an import task and count of device onboarding summary information for the import task.

get_wireless_device_statistics(client, wireless_device_id, options \\ [])

Gets operating information about a wireless device.

get_wireless_gateway(client, identifier, identifier_type, options \\ [])

Gets information about a wireless gateway.

get_wireless_gateway_certificate(client, id, options \\ [])

Gets the ID of the certificate that is currently associated with a wireless gateway.

get_wireless_gateway_firmware_information(client, id, options \\ [])

Gets the firmware version and other information about a wireless gateway.

get_wireless_gateway_statistics(client, wireless_gateway_id, options \\ [])

Gets operating information about a wireless gateway.

get_wireless_gateway_task(client, id, options \\ [])

Gets information about a wireless gateway task.

get_wireless_gateway_task_definition(client, id, options \\ [])

Gets information about a wireless gateway task definition.

list_destinations(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the destinations registered to your AWS account.

list_device_profiles(client, device_profile_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the device profiles registered to your AWS account.

list_devices_for_wireless_device_import_task(client, id, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

List the Sidewalk devices in an import task and their onboarding status.

list_event_configurations(client, max_results \\ nil, next_token \\ nil, resource_type, options \\ [])

List event configurations where at least one event topic has been enabled.

list_fuota_tasks(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the FUOTA tasks registered to your AWS account.

list_multicast_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the multicast groups registered to your AWS account.

list_multicast_groups_by_fuota_task(client, id, max_results \\ nil, next_token \\ nil, options \\ [])

List all multicast groups associated with a fuota task.

list_network_analyzer_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the network analyzer configurations.

list_partner_accounts(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the partner accounts associated with your AWS account.

list_position_configurations(client, max_results \\ nil, next_token \\ nil, resource_type \\ nil, options \\ [])

List position configurations for a given resource, such as positioning solvers.

list_queued_messages(client, id, max_results \\ nil, next_token \\ nil, wireless_device_type \\ nil, options \\ [])

List queued messages in the downlink queue.

list_service_profiles(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the service profiles registered to your AWS account.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags (metadata) you have assigned to the resource.

list_wireless_device_import_tasks(client, max_results \\ nil, next_token \\ nil, options \\ [])

List wireless devices that have been added to an import task.

list_wireless_devices(client, destination_name \\ nil, device_profile_id \\ nil, fuota_task_id \\ nil, max_results \\ nil, multicast_group_id \\ nil, next_token \\ nil, service_profile_id \\ nil, wireless_device_type \\ nil, options \\ [])

Lists the wireless devices registered to your AWS account.

list_wireless_gateway_task_definitions(client, max_results \\ nil, next_token \\ nil, task_definition_type \\ nil, options \\ [])

List the wireless gateway tasks definitions registered to your AWS account.

list_wireless_gateways(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the wireless gateways registered to your AWS account.

metadata()

put_position_configuration(client, resource_identifier, input, options \\ [])

Put position configuration for a given resource.

put_resource_log_level(client, resource_identifier, input, options \\ [])

Sets the log-level override for a resource-ID and resource-type.

reset_all_resource_log_levels(client, input, options \\ [])

Removes the log-level overrides for all resources; wireless devices, wireless gateways, and fuota tasks.

reset_resource_log_level(client, resource_identifier, input, options \\ [])

Removes the log-level override, if any, for a specific resource-ID and resource-type.

send_data_to_multicast_group(client, id, input, options \\ [])

Sends the specified data to a multicast group.

send_data_to_wireless_device(client, id, input, options \\ [])

Sends a decrypted application data frame to a device.

start_bulk_associate_wireless_device_with_multicast_group(client, id, input, options \\ [])

Starts a bulk association of all qualifying wireless devices with a multicast group.

start_bulk_disassociate_wireless_device_from_multicast_group(client, id, input, options \\ [])

Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.

start_fuota_task(client, id, input, options \\ [])

Starts a FUOTA task.

start_multicast_group_session(client, id, input, options \\ [])

Starts a multicast group session.

start_single_wireless_device_import_task(client, input, options \\ [])

Start import task for a single wireless device.

start_wireless_device_import_task(client, input, options \\ [])

Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.

tag_resource(client, input, options \\ [])

Adds a tag to a resource.

test_wireless_device(client, id, input, options \\ [])

Simulates a provisioned device by sending an uplink data payload of Hello.

untag_resource(client, input, options \\ [])

Removes one or more tags from a resource.

update_destination(client, name, input, options \\ [])

Updates properties of a destination.

update_event_configuration_by_resource_types(client, input, options \\ [])

Update the event configuration based on resource types.

update_fuota_task(client, id, input, options \\ [])

Updates properties of a FUOTA task.

update_log_levels_by_resource_types(client, input, options \\ [])

Set default log level, or log levels by resource types.

update_metric_configuration(client, input, options \\ [])

Update the summary metric configuration.

update_multicast_group(client, id, input, options \\ [])

Updates properties of a multicast group session.

update_network_analyzer_configuration(client, configuration_name, input, options \\ [])

Update network analyzer configuration.

update_partner_account(client, partner_account_id, input, options \\ [])

Updates properties of a partner account.

update_position(client, resource_identifier, input, options \\ [])

Update the position information of a resource.

update_resource_event_configuration(client, identifier, input, options \\ [])

Update the event configuration for a particular resource identifier.

update_resource_position(client, resource_identifier, input, options \\ [])

Update the position information of a given wireless device or a wireless gateway resource.

update_wireless_device(client, id, input, options \\ [])

Updates properties of a wireless device.

update_wireless_device_import_task(client, id, input, options \\ [])

Update an import task to add more devices to the task.

update_wireless_gateway(client, id, input, options \\ [])

Updates properties of a wireless gateway.

Link to this section Functions

associate_aws_account_with_partner_account(client, input, options \\ [])

Associates a partner account with your AWS account.

associate_multicast_group_with_fuota_task(client, id, input, options \\ [])

Associate a multicast group with a FUOTA task.

associate_wireless_device_with_fuota_task(client, id, input, options \\ [])

Associate a wireless device with a FUOTA task.

associate_wireless_device_with_multicast_group(client, id, input, options \\ [])

Associates a wireless device with a multicast group.

associate_wireless_device_with_thing(client, id, input, options \\ [])

Associates a wireless device with a thing.

associate_wireless_gateway_with_certificate(client, id, input, options \\ [])

Associates a wireless gateway with a certificate.

associate_wireless_gateway_with_thing(client, id, input, options \\ [])

Associates a wireless gateway with a thing.

cancel_multicast_group_session(client, id, input, options \\ [])

Cancels an existing multicast group session.

create_destination(client, input, options \\ [])

Creates a new destination that maps a device message to an AWS IoT rule.

create_device_profile(client, input, options \\ [])

Creates a new device profile.

create_fuota_task(client, input, options \\ [])

Creates a FUOTA task.

create_multicast_group(client, input, options \\ [])

Creates a multicast group.

create_network_analyzer_configuration(client, input, options \\ [])

Creates a new network analyzer configuration.

create_service_profile(client, input, options \\ [])

Creates a new service profile.

create_wireless_device(client, input, options \\ [])

Provisions a wireless device.

create_wireless_gateway(client, input, options \\ [])

Provisions a wireless gateway.

When provisioning a wireless gateway, you might run into duplication errors for the following reasons.

If you specify a GatewayEui value that already exists.

If you used a ClientRequestToken with the same parameters within the last 10 minutes.

To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.

create_wireless_gateway_task(client, id, input, options \\ [])

Creates a task for a wireless gateway.

create_wireless_gateway_task_definition(client, input, options \\ [])

Creates a gateway task definition.

delete_destination(client, name, input, options \\ [])

Deletes a destination.

delete_device_profile(client, id, input, options \\ [])

Deletes a device profile.

delete_fuota_task(client, id, input, options \\ [])

Deletes a FUOTA task.

delete_multicast_group(client, id, input, options \\ [])

Deletes a multicast group if it is not in use by a fuota task.

delete_network_analyzer_configuration(client, configuration_name, input, options \\ [])

Deletes a network analyzer configuration.

delete_queued_messages(client, id, input, options \\ [])

Remove queued messages from the downlink queue.

delete_service_profile(client, id, input, options \\ [])

Deletes a service profile.

delete_wireless_device(client, id, input, options \\ [])

Deletes a wireless device.

delete_wireless_device_import_task(client, id, input, options \\ [])

Delete an import task.

delete_wireless_gateway(client, id, input, options \\ [])

Deletes a wireless gateway.

When deleting a wireless gateway, you might run into duplication errors for the following reasons.

If you specify a GatewayEui value that already exists.

If you used a ClientRequestToken with the same parameters within the last 10 minutes.

To avoid this error, make sure that you use unique identifiers and parameters for each request within the specified time period.

delete_wireless_gateway_task(client, id, input, options \\ [])

Deletes a wireless gateway task.

delete_wireless_gateway_task_definition(client, id, input, options \\ [])

Deletes a wireless gateway task definition.

Deleting this task definition does not affect tasks that are currently in progress.

deregister_wireless_device(client, identifier, input, options \\ [])

Deregister a wireless device from AWS IoT Wireless.

disassociate_aws_account_from_partner_account(client, partner_account_id, input, options \\ [])

Disassociates your AWS account from a partner account.

If PartnerAccountId and PartnerType are null, disassociates your AWS account from all partner accounts.

disassociate_multicast_group_from_fuota_task(client, id, multicast_group_id, input, options \\ [])

Disassociates a multicast group from a fuota task.

disassociate_wireless_device_from_fuota_task(client, id, wireless_device_id, input, options \\ [])

Disassociates a wireless device from a FUOTA task.

disassociate_wireless_device_from_multicast_group(client, id, wireless_device_id, input, options \\ [])

Disassociates a wireless device from a multicast group.

disassociate_wireless_device_from_thing(client, id, input, options \\ [])

Disassociates a wireless device from its currently associated thing.

disassociate_wireless_gateway_from_certificate(client, id, input, options \\ [])

Disassociates a wireless gateway from its currently associated certificate.

disassociate_wireless_gateway_from_thing(client, id, input, options \\ [])

Disassociates a wireless gateway from its currently associated thing.

get_destination(client, name, options \\ [])

Gets information about a destination.

get_device_profile(client, id, options \\ [])

Gets information about a device profile.

get_event_configuration_by_resource_types(client, options \\ [])

Get the event configuration based on resource types.

get_fuota_task(client, id, options \\ [])

Gets information about a FUOTA task.

get_log_levels_by_resource_types(client, options \\ [])

Returns 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_metric_configuration(client, options \\ [])

Get the metric configuration status for this AWS account.

get_metrics(client, input, options \\ [])

Get the summary metrics for this AWS account.

get_multicast_group(client, id, options \\ [])

Gets information about a multicast group.

get_multicast_group_session(client, id, options \\ [])

Gets information about a multicast group session.

get_network_analyzer_configuration(client, configuration_name, options \\ [])

Get network analyzer configuration.

get_partner_account(client, partner_account_id, partner_type, options \\ [])

Gets information about a partner account.

If PartnerAccountId and PartnerType are null, returns all partner accounts.

get_position(client, resource_identifier, resource_type, options \\ [])

Get the position information for a given resource.

This action is no longer supported. Calls to retrieve the position information should use the GetResourcePosition API operation instead.

get_position_configuration(client, resource_identifier, resource_type, options \\ [])

Get position configuration for a given resource.

This action is no longer supported. Calls to retrieve the position configuration should use the GetResourcePosition API operation instead.

get_position_estimate(client, input, options \\ [])

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.

get_resource_event_configuration(client, identifier, identifier_type, partner_type \\ nil, options \\ [])

Get the event configuration for a particular resource identifier.

get_resource_log_level(client, resource_identifier, resource_type, options \\ [])

Fetches the log-level override, if any, for a given resource-ID and resource-type.

It can be used for a wireless device, wireless gateway or fuota task.

get_resource_position(client, resource_identifier, resource_type, options \\ [])

Get the position information for a given wireless device or a wireless gateway resource.

The position information uses the World Geodetic System (WGS84).

get_service_endpoint(client, service_type \\ nil, options \\ [])

Gets the account-specific endpoint for Configuration and Update Server (CUPS) protocol or LoRaWAN Network Server (LNS) connections.

get_service_profile(client, id, options \\ [])

Gets information about a service profile.

get_wireless_device(client, identifier, identifier_type, options \\ [])

Gets information about a wireless device.

get_wireless_device_import_task(client, id, options \\ [])

Get information about an import task and count of device onboarding summary information for the import task.

get_wireless_device_statistics(client, wireless_device_id, options \\ [])

Gets operating information about a wireless device.

get_wireless_gateway(client, identifier, identifier_type, options \\ [])

Gets information about a wireless gateway.

get_wireless_gateway_certificate(client, id, options \\ [])

Gets the ID of the certificate that is currently associated with a wireless gateway.

get_wireless_gateway_firmware_information(client, id, options \\ [])

Gets the firmware version and other information about a wireless gateway.

get_wireless_gateway_statistics(client, wireless_gateway_id, options \\ [])

Gets operating information about a wireless gateway.

get_wireless_gateway_task(client, id, options \\ [])

Gets information about a wireless gateway task.

get_wireless_gateway_task_definition(client, id, options \\ [])

Gets information about a wireless gateway task definition.

list_destinations(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the destinations registered to your AWS account.

list_device_profiles(client, device_profile_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the device profiles registered to your AWS account.

list_devices_for_wireless_device_import_task(client, id, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

List the Sidewalk devices in an import task and their onboarding status.

list_event_configurations(client, max_results \\ nil, next_token \\ nil, resource_type, options \\ [])

List event configurations where at least one event topic has been enabled.

list_fuota_tasks(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the FUOTA tasks registered to your AWS account.

list_multicast_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the multicast groups registered to your AWS account.

list_multicast_groups_by_fuota_task(client, id, max_results \\ nil, next_token \\ nil, options \\ [])

List all multicast groups associated with a fuota task.

list_network_analyzer_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the network analyzer configurations.

list_partner_accounts(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the partner accounts associated with your AWS account.

list_position_configurations(client, max_results \\ nil, next_token \\ nil, resource_type \\ nil, options \\ [])

List 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 API operation instead.

list_queued_messages(client, id, max_results \\ nil, next_token \\ nil, wireless_device_type \\ nil, options \\ [])

List queued messages in the downlink queue.

list_service_profiles(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the service profiles registered to your AWS account.

list_tags_for_resource(client, resource_arn, options \\ [])

Lists the tags (metadata) you have assigned to the resource.

list_wireless_device_import_tasks(client, max_results \\ nil, next_token \\ nil, options \\ [])

List wireless devices that have been added to an import task.

list_wireless_devices(client, destination_name \\ nil, device_profile_id \\ nil, fuota_task_id \\ nil, max_results \\ nil, multicast_group_id \\ nil, next_token \\ nil, service_profile_id \\ nil, wireless_device_type \\ nil, options \\ [])

Lists the wireless devices registered to your AWS account.

list_wireless_gateway_task_definitions(client, max_results \\ nil, next_token \\ nil, task_definition_type \\ nil, options \\ [])

List the wireless gateway tasks definitions registered to your AWS account.

list_wireless_gateways(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the wireless gateways registered to your AWS account.

metadata()

put_position_configuration(client, resource_identifier, input, options \\ [])

Put position configuration for a given resource.

This action is no longer supported. Calls to update the position configuration should use the UpdateResourcePosition API operation instead.

put_resource_log_level(client, resource_identifier, input, options \\ [])

Sets 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.

reset_all_resource_log_levels(client, input, options \\ [])

Removes the log-level overrides for all resources; wireless devices, wireless gateways, and fuota tasks.

reset_resource_log_level(client, resource_identifier, input, options \\ [])

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.

send_data_to_multicast_group(client, id, input, options \\ [])

Sends the specified data to a multicast group.

send_data_to_wireless_device(client, id, input, options \\ [])

Sends a decrypted application data frame to a device.

start_bulk_associate_wireless_device_with_multicast_group(client, id, input, options \\ [])

Starts a bulk association of all qualifying wireless devices with a multicast group.

start_bulk_disassociate_wireless_device_from_multicast_group(client, id, input, options \\ [])

Starts a bulk disassociatin of all qualifying wireless devices from a multicast group.

start_fuota_task(client, id, input, options \\ [])

Starts a FUOTA task.

start_multicast_group_session(client, id, input, options \\ [])

Starts a multicast group session.

start_single_wireless_device_import_task(client, input, options \\ [])

Start import task for a single wireless device.

start_wireless_device_import_task(client, input, options \\ [])

Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.

tag_resource(client, input, options \\ [])

Adds a tag to a resource.

test_wireless_device(client, id, input, options \\ [])

Simulates a provisioned device by sending an uplink data payload of Hello.

untag_resource(client, input, options \\ [])

Removes one or more tags from a resource.

update_destination(client, name, input, options \\ [])

Updates properties of a destination.

update_event_configuration_by_resource_types(client, input, options \\ [])

Update the event configuration based on resource types.

update_fuota_task(client, id, input, options \\ [])

Updates properties of a FUOTA task.

update_log_levels_by_resource_types(client, input, options \\ [])

Set 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_metric_configuration(client, input, options \\ [])

Update the summary metric configuration.

update_multicast_group(client, id, input, options \\ [])

Updates properties of a multicast group session.

update_network_analyzer_configuration(client, configuration_name, input, options \\ [])

Update network analyzer configuration.

update_partner_account(client, partner_account_id, input, options \\ [])

Updates properties of a partner account.

update_position(client, resource_identifier, input, options \\ [])

Update the position information of a resource.

This action is no longer supported. Calls to update the position information should use the UpdateResourcePosition API operation instead.

update_resource_event_configuration(client, identifier, input, options \\ [])

Update the event configuration for a particular resource identifier.

update_resource_position(client, resource_identifier, input, options \\ [])

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).

update_wireless_device(client, id, input, options \\ [])

Updates properties of a wireless device.

update_wireless_device_import_task(client, id, input, options \\ [])

Update an import task to add more devices to the task.

update_wireless_gateway(client, id, input, options \\ [])

Updates properties of a wireless gateway.

Settings View Source AWS.IoTWireless (aws-elixir v1.0.4)

Link to this section Summary

Functions

Link to this section Functions

associate_aws_account_with_partner_account(client, input, options \\ [])

associate_multicast_group_with_fuota_task(client, id, input, options \\ [])

associate_wireless_device_with_fuota_task(client, id, input, options \\ [])

associate_wireless_device_with_multicast_group(client, id, input, options \\ [])

associate_wireless_device_with_thing(client, id, input, options \\ [])

associate_wireless_gateway_with_certificate(client, id, input, options \\ [])

associate_wireless_gateway_with_thing(client, id, input, options \\ [])

cancel_multicast_group_session(client, id, input, options \\ [])

create_destination(client, input, options \\ [])

create_device_profile(client, input, options \\ [])

create_fuota_task(client, input, options \\ [])

create_multicast_group(client, input, options \\ [])

create_network_analyzer_configuration(client, input, options \\ [])

create_service_profile(client, input, options \\ [])

create_wireless_device(client, input, options \\ [])

create_wireless_gateway(client, input, options \\ [])

create_wireless_gateway_task(client, id, input, options \\ [])

create_wireless_gateway_task_definition(client, input, options \\ [])

delete_destination(client, name, input, options \\ [])

delete_device_profile(client, id, input, options \\ [])

delete_fuota_task(client, id, input, options \\ [])

delete_multicast_group(client, id, input, options \\ [])

delete_network_analyzer_configuration(client, configuration_name, input, options \\ [])

delete_queued_messages(client, id, input, options \\ [])

delete_service_profile(client, id, input, options \\ [])

delete_wireless_device(client, id, input, options \\ [])

delete_wireless_device_import_task(client, id, input, options \\ [])

delete_wireless_gateway(client, id, input, options \\ [])

delete_wireless_gateway_task(client, id, input, options \\ [])

delete_wireless_gateway_task_definition(client, id, input, options \\ [])

deregister_wireless_device(client, identifier, input, options \\ [])

disassociate_aws_account_from_partner_account(client, partner_account_id, input, options \\ [])

disassociate_multicast_group_from_fuota_task(client, id, multicast_group_id, input, options \\ [])

disassociate_wireless_device_from_fuota_task(client, id, wireless_device_id, input, options \\ [])

disassociate_wireless_device_from_multicast_group(client, id, wireless_device_id, input, options \\ [])

disassociate_wireless_device_from_thing(client, id, input, options \\ [])

disassociate_wireless_gateway_from_certificate(client, id, input, options \\ [])

disassociate_wireless_gateway_from_thing(client, id, input, options \\ [])

get_destination(client, name, options \\ [])

get_device_profile(client, id, options \\ [])

get_event_configuration_by_resource_types(client, options \\ [])

get_fuota_task(client, id, options \\ [])

get_log_levels_by_resource_types(client, options \\ [])

get_metric_configuration(client, options \\ [])

get_metrics(client, input, options \\ [])

get_multicast_group(client, id, options \\ [])

get_multicast_group_session(client, id, options \\ [])

get_network_analyzer_configuration(client, configuration_name, options \\ [])

get_partner_account(client, partner_account_id, partner_type, options \\ [])

get_position(client, resource_identifier, resource_type, options \\ [])

get_position_configuration(client, resource_identifier, resource_type, options \\ [])

get_position_estimate(client, input, options \\ [])

get_resource_event_configuration(client, identifier, identifier_type, partner_type \\ nil, options \\ [])

get_resource_log_level(client, resource_identifier, resource_type, options \\ [])

get_resource_position(client, resource_identifier, resource_type, options \\ [])

get_service_endpoint(client, service_type \\ nil, options \\ [])

get_service_profile(client, id, options \\ [])

get_wireless_device(client, identifier, identifier_type, options \\ [])

get_wireless_device_import_task(client, id, options \\ [])

get_wireless_device_statistics(client, wireless_device_id, options \\ [])

get_wireless_gateway(client, identifier, identifier_type, options \\ [])

get_wireless_gateway_certificate(client, id, options \\ [])

get_wireless_gateway_firmware_information(client, id, options \\ [])

get_wireless_gateway_statistics(client, wireless_gateway_id, options \\ [])

get_wireless_gateway_task(client, id, options \\ [])

get_wireless_gateway_task_definition(client, id, options \\ [])

list_destinations(client, max_results \\ nil, next_token \\ nil, options \\ [])

list_device_profiles(client, device_profile_type \\ nil, max_results \\ nil, next_token \\ nil, options \\ [])

list_devices_for_wireless_device_import_task(client, id, max_results \\ nil, next_token \\ nil, status \\ nil, options \\ [])

list_event_configurations(client, max_results \\ nil, next_token \\ nil, resource_type, options \\ [])

list_fuota_tasks(client, max_results \\ nil, next_token \\ nil, options \\ [])

list_multicast_groups(client, max_results \\ nil, next_token \\ nil, options \\ [])

list_multicast_groups_by_fuota_task(client, id, max_results \\ nil, next_token \\ nil, options \\ [])

list_network_analyzer_configurations(client, max_results \\ nil, next_token \\ nil, options \\ [])

list_partner_accounts(client, max_results \\ nil, next_token \\ nil, options \\ [])

list_position_configurations(client, max_results \\ nil, next_token \\ nil, resource_type \\ nil, options \\ [])

View Source AWS.IoTWireless (aws-elixir v1.0.4)