IoTWireless / Client / get_multicast_group_session

get_multicast_group_session¶

IoTWireless.Client.get_multicast_group_session(**kwargs)¶

Gets information about a multicast group session.

Request Syntax

response = client.get_multicast_group_session(
    Id='string'
)

Parameters:

Id (string) –

[REQUIRED]

The ID of the multicast group.

Return type:

dict

Returns:

Response Syntax

{
    'LoRaWAN': {
        'DlDr': 123,
        'DlFreq': 123,
        'SessionStartTime': datetime(2015, 1, 1),
        'SessionTimeout': 123,
        'PingSlotPeriod': 123
    }
}

Response Structure

(dict) –
- LoRaWAN (dict) –
  
  The LoRaWAN information used with the multicast session.
  - DlDr (integer) –
    
    Downlink data rate.
  - DlFreq (integer) –
    
    Downlink frequency.
  - SessionStartTime (datetime) –
    
    Timestamp of when the multicast group session is to start.
  - SessionTimeout (integer) –
    
    How long before a multicast group session is to timeout.
    
    Note
    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.
  - PingSlotPeriod (integer) –
    
    The PingSlotPeriod value.

Exceptions

IoTWireless.Client.exceptions.ValidationException
IoTWireless.Client.exceptions.ResourceNotFoundException
IoTWireless.Client.exceptions.AccessDeniedException
IoTWireless.Client.exceptions.InternalServerException
IoTWireless.Client.exceptions.ThrottlingException