service_profiles

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

Overview

Name	service_profiles
Type	Resource
Id	aws.iotwireless.service_profiles

Fields

The following fields are returned by SELECT queries:

get_service_profile

Name	Datatype	Description
arn	string	The Amazon Resource Name of the resource.
id	string	The ID of the service profile.
lo_ra_wan	object	Information about the service profile.
name	string	The name of the resource.

list_service_profiles

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.
service_profile_list	array	The list of service profiles.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_service_profile	select	id, region		Gets information about a service profile.
list_service_profiles	select	region	nextToken, maxResults	Lists the service profiles registered to your AWS account.
create_service_profile	insert	region		Creates a new service profile.
delete_service_profile	delete	id, region		Deletes a service 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)
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_service_profile

Gets information about a service profile.

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

list_service_profiles

Lists the service profiles registered to your AWS account.

SELECT
next_token,
service_profile_list
FROM aws.iotwireless.service_profiles
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
;

INSERT examples

create_service_profile

Creates a new service profile.

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

Manifest

# Description fields are for documentation purposes
- name: service_profiles
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the service_profiles resource.
  - name: Name
    value: "{{ Name }}"
  - name: LoRaWAN
    description: |
      LoRaWANServiceProfile object.
    value:
      AddGwMetadata: {{ AddGwMetadata }}
      DrMin: {{ DrMin }}
      DrMax: {{ DrMax }}
      PrAllowed: {{ PrAllowed }}
      RaAllowed: {{ RaAllowed }}
      TxPowerIndexMin: {{ TxPowerIndexMin }}
      TxPowerIndexMax: {{ TxPowerIndexMax }}
      NbTransMin: {{ NbTransMin }}
      NbTransMax: {{ NbTransMax }}
  - 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.

DELETE examples

delete_service_profile

Deletes a service profile.

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