device_profiles

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

Overview

Name	device_profiles
Type	Resource
Id	aws.iotwireless.device_profiles

Fields

The following fields are returned by SELECT queries:

get_device_profile

Name	Datatype	Description
arn	string	The Amazon Resource Name of the resource.
id	string	The ID of the device profile.
lo_ra_wan	object	LoRaWANDeviceProfile object.
name	string	The name of the resource.
sidewalk	object	Information about the Sidewalk parameters in the device profile.

list_device_profiles

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_device_profile	select	id, region		Gets information about a device profile.
list_device_profiles	select	region	nextToken, maxResults, deviceProfileType	Lists the device profiles registered to your AWS account.
create_device_profile	insert	region		Creates a new device profile.
delete_device_profile	delete	id, region		Deletes a device profile.

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 delete.
region	string	AWS region (default: us-east-1)
deviceProfileType	string	A filter to list only device profiles that use this type, which can be LoRaWAN or Sidewalk.
maxResults	integer	The maximum number of results to return in this operation.
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.

SELECT examples

get_device_profile

Gets information about a device profile.

SELECT
arn,
id,
lo_ra_wan,
name,
sidewalk
FROM aws.iotwireless.device_profiles
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;

list_device_profiles

Lists the device profiles registered to your AWS account.

SELECT
device_profile_list,
next_token
FROM aws.iotwireless.device_profiles
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND deviceProfileType = '{{ deviceProfileType }}'
;

INSERT examples

create_device_profile

Creates a new device profile.

INSERT INTO aws.iotwireless.device_profiles (
Name,
LoRaWAN,
Tags,
ClientRequestToken,
Sidewalk,
region
)
SELECT 
'{{ Name }}',
'{{ LoRaWAN }}',
'{{ Tags }}',
'{{ ClientRequestToken }}',
'{{ Sidewalk }}',
'{{ region }}'
RETURNING
arn,
id
;

Manifest

# Description fields are for documentation purposes
- name: device_profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the device_profiles resource.
  - name: Name
    value: "{{ Name }}"
  - name: LoRaWAN
    description: |
      LoRaWANDeviceProfile object.
    value:
      SupportsClassB: {{ SupportsClassB }}
      ClassBTimeout: {{ ClassBTimeout }}
      PingSlotPeriod: {{ PingSlotPeriod }}
      PingSlotDr: {{ PingSlotDr }}
      PingSlotFreq: {{ PingSlotFreq }}
      SupportsClassC: {{ SupportsClassC }}
      ClassCTimeout: {{ ClassCTimeout }}
      MacVersion: "{{ MacVersion }}"
      RegParamsRevision: "{{ RegParamsRevision }}"
      RxDelay1: {{ RxDelay1 }}
      RxDrOffset1: {{ RxDrOffset1 }}
      RxDataRate2: {{ RxDataRate2 }}
      RxFreq2: {{ RxFreq2 }}
      FactoryPresetFreqsList:
        - {{ FactoryPresetFreqsList }}
      MaxEirp: {{ MaxEirp }}
      MaxDutyCycle: {{ MaxDutyCycle }}
      RfRegion: "{{ RfRegion }}"
      SupportsJoin: {{ SupportsJoin }}
      Supports32BitFCnt: {{ Supports32BitFCnt }}
  - 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: 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: Sidewalk
    value: "{{ Sidewalk }}"
    description: |
      Sidewalk object for creating a device profile.

DELETE examples

delete_device_profile

Deletes a device profile.

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