aws-elixir v0.10.1

AWS.IoTWireless (aws-elixir v0.10.1) View Source

AWS IoT Wireless API documentation

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_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_service_profile(client, id, input, options \\ [])

Deletes a service profile.

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

Deletes a wireless device.

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.

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_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_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 NetworkAnalyzer configuration.

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

Gets information about a partner account.

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_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_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, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the device profiles registered to your AWS account.

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_partner_accounts(client, max_results \\ nil, next_token \\ nil, options \\ [])

Lists the partner accounts associated with your AWS account.

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_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_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; both wireless devices and wireless gateways.

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.

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_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_multicast_group(client, id, input, options \\ [])

Updates properties of a multicast group session.

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

Update NetworkAnalyzer configuration.

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

Updates properties of a partner account.

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

Update the event configuration for a particular resource identifier.

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

Updates properties of a wireless device.

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

Updates properties of a wireless gateway.

Link to this section Functions

Link to this function

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

View Source

Associates a partner account with your AWS account.

Link to this function

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

View Source

Associate a multicast group with a FUOTA task.

Link to this function

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

View Source

Associate a wireless device with a FUOTA task.

Link to this function

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

View Source

Associates a wireless device with a multicast group.

Link to this function

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

View Source

Associates a wireless device with a thing.

Link to this function

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

View Source

Associates a wireless gateway with a certificate.

Link to this function

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

View Source

Associates a wireless gateway with a thing.

Link to this function

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

View Source

Cancels an existing multicast group session.

Link to this function

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

View Source

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

Link to this function

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

View Source

Creates a new device profile.

Link to this function

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

View Source

Creates a FUOTA task.

Link to this function

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

View Source

Creates a multicast group.

Link to this function

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

View Source

Creates a new service profile.

Link to this function

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

View Source

Provisions a wireless device.

Link to this function

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

View Source

Provisions a wireless gateway.

Link to this function

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

View Source

Creates a task for a wireless gateway.

Link to this function

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

View Source

Creates a gateway task definition.

Link to this function

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

View Source

Deletes a destination.

Link to this function

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

View Source

Deletes a device profile.

Link to this function

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

View Source

Deletes a FUOTA task.

Link to this function

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

View Source

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

Link to this function

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

View Source

Deletes a service profile.

Link to this function

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

View Source

Deletes a wireless device.

Link to this function

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

View Source

Deletes a wireless gateway.

Link to this function

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

View Source

Deletes a wireless gateway task.

Link to this function

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

View Source

Deletes a wireless gateway task definition.

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

Link to this function

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

View Source

Disassociates your AWS account from a partner account.

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

Link to this function

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

View Source

Disassociates a multicast group from a fuota task.

Link to this function

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

View Source

Disassociates a wireless device from a FUOTA task.

Link to this function

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

View Source

Disassociates a wireless device from a multicast group.

Link to this function

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

View Source

Disassociates a wireless device from its currently associated thing.

Link to this function

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

View Source

Disassociates a wireless gateway from its currently associated certificate.

Link to this function

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

View Source

Disassociates a wireless gateway from its currently associated thing.

Link to this function

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

View Source

Gets information about a destination.

Link to this function

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

View Source

Gets information about a device profile.

Link to this function

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

View Source

Gets information about a FUOTA task.

Link to this function

get_log_levels_by_resource_types(client, options \\ [])

View Source

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.

Link to this function

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

View Source

Gets information about a multicast group.

Link to this function

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

View Source

Gets information about a multicast group session.

Link to this function

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

View Source

Get NetworkAnalyzer configuration.

Link to this function

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

View Source

Gets information about a partner account.

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

Link to this function

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

View Source

Get the event configuration for a particular resource identifier.

Link to this function

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

View Source

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

Link to this function

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

View Source

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

Link to this function

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

View Source

Gets information about a service profile.

Link to this function

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

View Source

Gets information about a wireless device.

Link to this function

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

View Source

Gets operating information about a wireless device.

Link to this function

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

View Source

Gets information about a wireless gateway.

Link to this function

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

View Source

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

Link to this function

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

View Source

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

Link to this function

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

View Source

Gets operating information about a wireless gateway.

Link to this function

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

View Source

Gets information about a wireless gateway task.

Link to this function

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

View Source

Gets information about a wireless gateway task definition.

Link to this function

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

View Source

Lists the destinations registered to your AWS account.

Link to this function

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

View Source

Lists the device profiles registered to your AWS account.

Link to this function

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

View Source

Lists the FUOTA tasks registered to your AWS account.

Link to this function

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

View Source

Lists the multicast groups registered to your AWS account.

Link to this function

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

View Source

List all multicast groups associated with a fuota task.

Link to this function

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

View Source

Lists the partner accounts associated with your AWS account.

Link to this function

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

View Source

Lists the service profiles registered to your AWS account.

Link to this function

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

View Source

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

Link to this function

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 \\ [] )

View Source

Lists the wireless devices registered to your AWS account.

Link to this function

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

View Source

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

Link to this function

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

View Source

Lists the wireless gateways registered to your AWS account.

Link to this function

metadata()

View Source
Link to this function

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

View Source

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.

Link to this function

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

View Source

Removes the log-level overrides for all resources; both wireless devices and wireless gateways.

Link to this function

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

View Source

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

Link to this function

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

View Source

Sends the specified data to a multicast group.

Link to this function

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

View Source

Sends a decrypted application data frame to a device.

Link to this function

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

View Source

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

Link to this function

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

View Source

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

Link to this function

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

View Source

Starts a FUOTA task.

Link to this function

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

View Source

Starts a multicast group session.

Link to this function

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

View Source

Adds a tag to a resource.

Link to this function

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

View Source

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

Link to this function

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

View Source

Removes one or more tags from a resource.

Link to this function

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

View Source

Updates properties of a destination.

Link to this function

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

View Source

Updates properties of a FUOTA task.

Link to this function

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

View Source

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.

Link to this function

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

View Source

Updates properties of a multicast group session.

Link to this function

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

View Source

Update NetworkAnalyzer configuration.

Link to this function

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

View Source

Updates properties of a partner account.

Link to this function

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

View Source

Update the event configuration for a particular resource identifier.

Link to this function

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

View Source

Updates properties of a wireless device.

Link to this function

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

View Source

Updates properties of a wireless gateway.