wireless_devices

Creates, updates, deletes, gets or lists a wireless_devices resource.

Overview

Name	wireless_devices
Type	Resource
Id	aws.iotwireless.wireless_devices

Fields

The following fields are returned by SELECT queries:

get_wireless_device

Name	Datatype	Description
arn	string	The Amazon Resource Name of the resource.
description	string	The description of the new resource.
destination_name	string	The name of the destination to which the device is assigned. (pattern: <code>[a-zA-Z0-9-_]+</code>)
id	string	The ID of the wireless device.
lo_ra_wan	object	LoRaWAN object for create functions.
name	string	The name of the resource.
positioning	string	The integration status of the Device Location feature for LoRaWAN and Sidewalk devices. (Enabled, Disabled)
sidewalk	object	Sidewalk device object.
thing_arn	string	The ARN of the thing associated with the wireless device.
thing_name	string	The name of the thing associated with the wireless device. The value is empty if a thing isn't associated with the device.
type	string	The wireless device type. (Sidewalk, LoRaWAN)

list_wireless_devices

Name	Datatype	Description
next_token	string	The token to use to get the next set of results, or null if there are no additional results.
wireless_device_list	array	The ID of the wireless device.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_wireless_device	select	identifier, identifierType, region		Gets information about a wireless device.
list_wireless_devices	select	region	maxResults, nextToken, destinationName, deviceProfileId, serviceProfileId, wirelessDeviceType, fuotaTaskId, multicastGroupId	Lists the wireless devices registered to your AWS account.
create_wireless_device	insert	region, DestinationName		Provisions a wireless device.
associate_wireless_device_with_thing	update	id, region, ThingArn		Associates a wireless device with a thing.
update_wireless_device	update	id, region		Updates properties of a wireless device.
delete_wireless_device	delete	id, region		Deletes a wireless device.
deregister_wireless_device	delete	identifier, region	WirelessDeviceType	Deregister a wireless device from AWS IoT Wireless.
disassociate_wireless_device_from_thing	exec	id, region		Disassociates a wireless device from its currently associated thing.
start_wireless_device_import_task	exec	region, DestinationName		Start import task for provisioning Sidewalk devices in bulk using an S3 CSV file.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
id	string	The ID of the resource to update.
identifier	string	The identifier of the wireless device to deregister from AWS IoT Wireless.
identifierType	string	The type of identifier used in identifier.
region	string	AWS region (default: us-east-1)
WirelessDeviceType	string	The type of wireless device to deregister from AWS IoT Wireless, which can be LoRaWAN or Sidewalk.
destinationName	string	A filter to list only the wireless devices that use as uplink destination.
deviceProfileId	string	A filter to list only the wireless devices that use this device profile.
fuotaTaskId	string
maxResults	integer	The maximum number of results to return in this operation.
multicastGroupId	string
nextToken	string	To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.
serviceProfileId	string	A filter to list only the wireless devices that use this service profile.
wirelessDeviceType	string	A filter to list only the wireless devices that use this wireless device type.

SELECT examples

get_wireless_device

Gets information about a wireless device.

SELECT
arn,
description,
destination_name,
id,
lo_ra_wan,
name,
positioning,
sidewalk,
thing_arn,
thing_name,
type
FROM aws.iotwireless.wireless_devices
WHERE identifier = '{{ identifier }}' -- required
AND identifierType = '{{ identifierType }}' -- required
AND region = '{{ region }}' -- required
;

list_wireless_devices

Lists the wireless devices registered to your AWS account.

SELECT
next_token,
wireless_device_list
FROM aws.iotwireless.wireless_devices
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
AND destinationName = '{{ destinationName }}'
AND deviceProfileId = '{{ deviceProfileId }}'
AND serviceProfileId = '{{ serviceProfileId }}'
AND wirelessDeviceType = '{{ wirelessDeviceType }}'
AND fuotaTaskId = '{{ fuotaTaskId }}'
AND multicastGroupId = '{{ multicastGroupId }}'
;

INSERT examples

create_wireless_device

Provisions a wireless device.

INSERT INTO aws.iotwireless.wireless_devices (
Type,
Name,
Description,
DestinationName,
ClientRequestToken,
LoRaWAN,
Tags,
Positioning,
Sidewalk,
region
)
SELECT 
'{{ Type }}',
'{{ Name }}',
'{{ Description }}',
'{{ DestinationName }}' /* required */,
'{{ ClientRequestToken }}',
'{{ LoRaWAN }}',
'{{ Tags }}',
'{{ Positioning }}',
'{{ Sidewalk }}',
'{{ region }}'
RETURNING
arn,
id
;

Manifest

# Description fields are for documentation purposes
- name: wireless_devices
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the wireless_devices resource.
  - name: Type
    value: "{{ Type }}"
    valid_values: ['Sidewalk', 'LoRaWAN']
  - name: Name
    value: "{{ Name }}"
  - name: Description
    value: "{{ Description }}"
    description: |
      The description of the new resource.
  - name: DestinationName
    value: "{{ DestinationName }}"
  - name: ClientRequestToken
    value: "{{ ClientRequestToken }}"
    description: |
      Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.
  - name: LoRaWAN
    description: |
      LoRaWAN object for create functions.
    value:
      DevEui: "{{ DevEui }}"
      DeviceProfileId: "{{ DeviceProfileId }}"
      ServiceProfileId: "{{ ServiceProfileId }}"
      OtaaV1_1:
        AppKey: "{{ AppKey }}"
        NwkKey: "{{ NwkKey }}"
        JoinEui: "{{ JoinEui }}"
      OtaaV1_0_x:
        AppKey: "{{ AppKey }}"
        AppEui: "{{ AppEui }}"
        JoinEui: "{{ JoinEui }}"
        GenAppKey: "{{ GenAppKey }}"
      AbpV1_1:
        DevAddr: "{{ DevAddr }}"
        SessionKeys:
          FNwkSIntKey: "{{ FNwkSIntKey }}"
          SNwkSIntKey: "{{ SNwkSIntKey }}"
          NwkSEncKey: "{{ NwkSEncKey }}"
          AppSKey: "{{ AppSKey }}"
        FCntStart: {{ FCntStart }}
      AbpV1_0_x:
        DevAddr: "{{ DevAddr }}"
        SessionKeys:
          NwkSKey: "{{ NwkSKey }}"
          AppSKey: "{{ AppSKey }}"
        FCntStart: {{ FCntStart }}
      FPorts:
        Fuota: {{ Fuota }}
        Multicast: {{ Multicast }}
        ClockSync: {{ ClockSync }}
        Positioning:
          ClockSync: {{ ClockSync }}
          Stream: {{ Stream }}
          Gnss: {{ Gnss }}
        Applications:
          - FPort: {{ FPort }}
            Type: "{{ Type }}"
            DestinationName: "{{ DestinationName }}"
  - name: Tags
    description: |
      The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: Positioning
    value: "{{ Positioning }}"
    valid_values: ['Enabled', 'Disabled']
  - name: Sidewalk
    description: |
      Sidewalk object for creating a wireless device.
    value:
      DeviceProfileId: "{{ DeviceProfileId }}"
      Positioning:
        DestinationName: "{{ DestinationName }}"
      SidewalkManufacturingSn: "{{ SidewalkManufacturingSn }}"

UPDATE examples

associate_wireless_device_with_thing

Associates a wireless device with a thing.

UPDATE aws.iotwireless.wireless_devices
SET 
ThingArn = '{{ ThingArn }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required
AND ThingArn = '{{ ThingArn }}' --required;

update_wireless_device

Updates properties of a wireless device.

UPDATE aws.iotwireless.wireless_devices
SET 
DestinationName = '{{ DestinationName }}',
Name = '{{ Name }}',
Description = '{{ Description }}',
LoRaWAN = '{{ LoRaWAN }}',
Positioning = '{{ Positioning }}',
Sidewalk = '{{ Sidewalk }}'
WHERE 
id = '{{ id }}' --required
AND region = '{{ region }}' --required;

DELETE examples

delete_wireless_device

Deletes a wireless device.

DELETE FROM aws.iotwireless.wireless_devices
WHERE id = '{{ id }}' --required
AND region = '{{ region }}' --required
;

deregister_wireless_device

Deregister a wireless device from AWS IoT Wireless.

DELETE FROM aws.iotwireless.wireless_devices
WHERE identifier = '{{ identifier }}' --required
AND region = '{{ region }}' --required
AND WirelessDeviceType = '{{ WirelessDeviceType }}'
;

Lifecycle Methods

disassociate_wireless_device_from_thing

Disassociates a wireless device from its currently associated thing.

EXEC aws.iotwireless.wireless_devices.disassociate_wireless_device_from_thing 
@id='{{ id }}' --required, 
@region='{{ region }}' --required
;

start_wireless_device_import_task

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

EXEC aws.iotwireless.wireless_devices.start_wireless_device_import_task 
@region='{{ region }}' --required 
@@json=
'{
"DestinationName": "{{ DestinationName }}", 
"ClientRequestToken": "{{ ClientRequestToken }}", 
"Tags": "{{ Tags }}", 
"Positioning": "{{ Positioning }}", 
"Sidewalk": "{{ Sidewalk }}"
}'
;