IoTWireless / Client / list_multicast_groups

list_multicast_groups#

IoTWireless.Client.list_multicast_groups(**kwargs)#

Lists the multicast groups registered to your AWS account.

See also: AWS API Documentation

Request Syntax

response = client.list_multicast_groups(
    NextToken='string',
    MaxResults=123
)
Parameters:

  • NextToken (string) – To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

  • MaxResults (integer) – The maximum number of results to return in this operation.

Return type:

dict

Returns:

Response Syntax

{
    'NextToken': 'string',
    'MulticastGroupList': [
        {
            'Id': 'string',
            'Arn': 'string',
            'Name': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • NextToken (string) –

      To retrieve the next set of results, the nextToken value from a previous response; otherwise null to receive the first set of results.

    • MulticastGroupList (list) –

      List of multicast groups.

      • (dict) –

        A multicast group.

        • Id (string) –

          The ID of the multicast group.

        • Arn (string) –

          The arn of the multicast group.

        • Name (string) –

          The name of the multicast group.

Exceptions