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',
        'DlClass': 'ClassB'|'ClassC',
        'NumberOfDevicesRequested': 123,
        'NumberOfDevicesInGroup': 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.

    • 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