IoTWireless / Client / get_multicast_group

get_multicast_group

IoTWireless.Client.get_multicast_group(**kwargs)

Gets information about a multicast group.

See also: AWS API Documentation

Request Syntax

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

Parameters:

Id (string) –

[REQUIRED]

The ID of the multicast group.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Id': 'string',
    'Name': 'string',
    'Description': 'string',
    'Status': 'string',
    'LoRaWAN': {
        'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1'|'AS923-2'|'AS923-3'|'AS923-4'|'EU433'|'CN470'|'CN779'|'RU864'|'KR920'|'IN865',
        'DlClass': 'ClassB'|'ClassC',
        'NumberOfDevicesRequested': 123,
        'NumberOfDevicesInGroup': 123,
        'ParticipatingGateways': {
            'GatewayList': [
                'string',
            ],
            'TransmissionInterval': 123
        }
    },
    'CreatedAt': datetime(2015, 1, 1)
}

Response Structure

• (dict) –

  • Arn (string) –

    The arn of the multicast group.

  • Id (string) –

    The ID of the multicast group.

  • Name (string) –

    The name of the multicast group.

  • Description (string) –

    The description of the new resource.

  • Status (string) –

    The status of the multicast group.

  • LoRaWAN (dict) –

    The LoRaWAN information that is to be returned from getting multicast group information.

    • RfRegion (string) –

      Supported RfRegions

    • DlClass (string) –

      DlClass for LoRaWAM, valid values are ClassB and ClassC.

    • NumberOfDevicesRequested (integer) –

      Number of devices that are requested to be associated with the multicast group.

    • NumberOfDevicesInGroup (integer) –

      Number of devices that are associated to the multicast group.

    • 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.

  • CreatedAt (datetime) –

    Created at timestamp for the resource.

Exceptions

• IoTWireless.Client.exceptions.ValidationException

• IoTWireless.Client.exceptions.ResourceNotFoundException

• IoTWireless.Client.exceptions.AccessDeniedException

• IoTWireless.Client.exceptions.InternalServerException

• IoTWireless.Client.exceptions.ThrottlingException