multicast_groups

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

Overview

Name	multicast_groups
Type	Resource
Id	aws.iotwireless.multicast_groups

Fields

The following fields are returned by SELECT queries:

get_multicast_group

Name	Datatype	Description
arn	string	The arn of the multicast group.
created_at	string (date-time)	Created at timestamp for the resource.
description	string	The description of the new resource.
id	string	The ID of the multicast group.
lo_ra_wan	object	The LoRaWAN information that is to be returned from getting multicast group information.
name	string	The name of the multicast group.
status	string	The status of the multicast group.

list_multicast_groups

Name	Datatype	Description
multicast_group_list	array	List of multicast groups.
next_token	string	To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_multicast_group	select	id, region		Gets information about a multicast group.
list_multicast_groups	select	region	nextToken, maxResults	Lists the multicast groups registered to your AWS account.
create_multicast_group	insert	region, LoRaWAN		Creates a multicast group.
associate_wireless_device_with_multicast_group	update	id, region, WirelessDeviceId		Associates a wireless device with a multicast group.
disassociate_wireless_device_from_multicast_group	update	id, wireless_device_id, region		Disassociates a wireless device from a multicast group.
update_multicast_group	update	id, region		Updates properties of a multicast group session.
delete_multicast_group	delete	id, region		Deletes a multicast group if it is not in use by a FUOTA task.
cancel_multicast_group_session	exec	id, region		Cancels an existing multicast group session.
start_multicast_group_session	exec	id, region, LoRaWAN		Starts a multicast group session.

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
region	string	AWS region (default: us-east-1)
wireless_device_id	string
maxResults	integer
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_multicast_group

Gets information about a multicast group.

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

list_multicast_groups

Lists the multicast groups registered to your AWS account.

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

INSERT examples

create_multicast_group

Creates a multicast group.

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

Manifest

# Description fields are for documentation purposes
- name: multicast_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the multicast_groups resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The name of the multicast group.
  - name: Description
    value: "{{ Description }}"
    description: |
      The description of the new resource.
  - 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: |
      The LoRaWAN information that is to be used with the multicast group.
    value:
      RfRegion: "{{ RfRegion }}"
      DlClass: "{{ DlClass }}"
      ParticipatingGateways:
        GatewayList:
          - "{{ GatewayList }}"
        TransmissionInterval: {{ TransmissionInterval }}
      DefaultSessionParameters:
        DlDr: {{ DlDr }}
        DlFreq: {{ DlFreq }}
  - 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 }}"

UPDATE examples

associate_wireless_device_with_multicast_group

Associates a wireless device with a multicast group.

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

disassociate_wireless_device_from_multicast_group

Disassociates a wireless device from a multicast group.

UPDATE aws.iotwireless.multicast_groups
SET 
-- No updatable properties
WHERE 
id = '{{ id }}' --required
AND wireless_device_id = '{{ wireless_device_id }}' --required
AND region = '{{ region }}' --required;

update_multicast_group

Updates properties of a multicast group session.

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

DELETE examples

delete_multicast_group

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

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

Lifecycle Methods

cancel_multicast_group_session

Cancels an existing multicast group session.

EXEC aws.iotwireless.multicast_groups.cancel_multicast_group_session 
@id='{{ id }}' --required, 
@region='{{ region }}' --required
;

start_multicast_group_session

Starts a multicast group session.

EXEC aws.iotwireless.multicast_groups.start_multicast_group_session 
@id='{{ id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"LoRaWAN": "{{ LoRaWAN }}"
}'
;