multicast_group_sessions
Creates, updates, deletes, gets or lists a multicast_group_sessions resource.
Overview
| Name | multicast_group_sessions |
| Type | Resource |
| Id | aws.iotwireless.multicast_group_sessions |
Fields
The following fields are returned by SELECT queries:
- get_multicast_group_session
| Name | Datatype | Description |
|---|---|---|
dl_dr | integer | Downlink data rate. |
dl_freq | integer | Downlink frequency. |
ping_slot_period | integer | The PingSlotPeriod value. |
session_start_time | string (date-time) | Timestamp of when the multicast group session is to start. |
session_timeout | integer | How long before a multicast group session is to timeout. We recommend that you provide a timeout value that is a power-of-two (such as 64, 128, 256). If a non-power-of-two value is provided, it will automatically be rounded up to the next supported power-of-two within the allowed range. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_multicast_group_session | select | id, region | Gets information about 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) |
SELECT examples
- get_multicast_group_session
Gets information about a multicast group session.
SELECT
dl_dr,
dl_freq,
ping_slot_period,
session_start_time,
session_timeout
FROM aws.iotwireless.multicast_group_sessions
WHERE id = '{{ id }}' -- required
AND region = '{{ region }}' -- required
;