IoTWireless / Client / update_multicast_group

update_multicast_group#

IoTWireless.Client.update_multicast_group(**kwargs)#

Updates properties of a multicast group session.

See also: AWS API Documentation

Request Syntax

response = client.update_multicast_group(
    Id='string',
    Name='string',
    Description='string',
    LoRaWAN={
        'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1'|'AS923-2'|'AS923-3'|'AS923-4'|'EU433'|'CN470'|'CN779'|'RU864'|'KR920'|'IN865',
        'DlClass': 'ClassB'|'ClassC',
        'ParticipatingGateways': {
            'GatewayList': [
                'string',
            ],
            'TransmissionInterval': 123
        }
    }
)
Parameters:

  • Id (string) –

    [REQUIRED]

    The ID of the multicast group.

  • Name (string) – The name of the multicast group.

  • Description (string) – The description of the new resource.

  • LoRaWAN (dict) –

    The LoRaWAN information that is to be used with the multicast group.

    • RfRegion (string) –

      Supported RfRegions

    • DlClass (string) –

      DlClass for LoRaWAM, valid values are ClassB and ClassC.

    • ParticipatingGateways (dict) –

      Specify the list of gateways to which you want to send the multicast downlink messages. The multicast message will be sent to each gateway in the sequence provided in the list.

      • GatewayList (list) –

        The list of gateways that you want to use for sending the multicast downlink. Each downlink will be sent to all the gateways in the list with transmission interval between them. If list is empty the gateway list will be dynamically selected similar to the case of no ParticipatingGateways

        • (string) –

      • TransmissionInterval (integer) –

        The duration of time for which AWS IoT Core for LoRaWAN will wait before transmitting the multicast payload to the next gateway in the list.

Return type:

dict

Returns:

Response Syntax

{}

Response Structure

  • (dict) –

Exceptions