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

AWS IoT Wireless API documentation

Link to this section Summary

Functions

Associates a partner account with your AWS account.

Associates a wireless gateway with a certificate.

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

Disassociates a wireless device from its currently associated thing.

Disassociates a wireless gateway from its currently associated certificate.

Disassociates a wireless gateway from its currently associated thing.

Gets information about a destination.

Gets information about a device profile.

Returns current default log-levels, or log levels by resource types, could be for wireless device log options or wireless gateway log options.

Fetches the log-level override if any for a given resource-ID and resource-type, coulde be a wireless device or a wireless gateway.

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

Gets information about a service profile.

Gets operating information about a wireless device.

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

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

Gets operating information about a wireless gateway.

Gets information about a wireless gateway task.

Gets information about a wireless gateway task definition.

Lists the destinations registered to your AWS account.

Lists the device profiles registered to your AWS account.

Lists the partner accounts associated with your AWS account.

Lists the service profiles registered to your AWS account.

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

Lists the wireless gateways registered to your AWS account.

Sets the log-level override for a resource-ID and resource-type, could be a wireless gateway or a wireless device.

Remove log-level overrides if any for all resources (both wireless devices and wireless gateways).

Remove log-level override if any for a specific resource-ID and resource-type, could be a wireless device or a wireless gateway.

Sends a decrypted application data frame to a device.

Adds a tag to a resource.

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

Removes one or more tags from a resource.

Updates properties of a destination.

Set default log level, or log levels by resource types, could be for wireless device log options or wireless gateways log options.

Updates properties of a wireless device.

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_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

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

View Source

Returns current default log-levels, or log levels by resource types, could be for wireless device log options or wireless gateway log options.

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_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, coulde be 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_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, max_results \\ 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

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

View Source

Sets the log-level override for a resource-ID and resource-type, could be a wireless gateway or a wireless device.

Link to this function

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

View Source

Remove log-level overrides if any for all resources (both wireless devices and wireless gateways).

Link to this function

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

View Source

Remove log-level override if any for a specific resource-ID and resource-type, could be a wireless device or a wireless gateway.

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

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

View Source

Set default log level, or log levels by resource types, could be for wireless device log options or wireless gateways log options.

This is to control the log messages that will be displayed in CloudWatch.

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