:doc:`IoTWireless <../../iotwireless>` / Client / start_multicast_group_session

*****************************
start_multicast_group_session
*****************************



.. py:method:: IoTWireless.Client.start_multicast_group_session(**kwargs)

  

  Starts a multicast group session.

  

  See also: `AWS API Documentation <https://docs.aws.amazon.com/goto/WebAPI/iotwireless-2020-11-22/StartMulticastGroupSession>`_  


  **Request Syntax**
  ::

    response = client.start_multicast_group_session(
        Id='string',
        LoRaWAN={
            'DlDr': 123,
            'DlFreq': 123,
            'SessionStartTime': datetime(2015, 1, 1),
            'SessionTimeout': 123,
            'PingSlotPeriod': 123
        }
    )
    
  :type Id: string
  :param Id: **[REQUIRED]** 

    The ID of the multicast group.

    

  
  :type LoRaWAN: dict
  :param LoRaWAN: **[REQUIRED]** 

    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.

      

    
  
  
  :rtype: dict
  :returns: 
    
    **Response Syntax**

    
    ::

      {}
      
    **Response Structure**

    

    - *(dict) --* 
  
  **Exceptions**
  
  *   :py:class:`IoTWireless.Client.exceptions.ValidationException`

  
  *   :py:class:`IoTWireless.Client.exceptions.ResourceNotFoundException`

  
  *   :py:class:`IoTWireless.Client.exceptions.AccessDeniedException`

  
  *   :py:class:`IoTWireless.Client.exceptions.ConflictException`

  
  *   :py:class:`IoTWireless.Client.exceptions.InternalServerException`

  
  *   :py:class:`IoTWireless.Client.exceptions.ThrottlingException`

  