IoTWireless / Client / create_multicast_group

create_multicast_group#

IoTWireless.Client.create_multicast_group(**kwargs)#

Creates a multicast group.

See also: AWS API Documentation

Request Syntax

response = client.create_multicast_group(
    Name='string',
    Description='string',
    ClientRequestToken='string',
    LoRaWAN={
        'RfRegion': 'EU868'|'US915'|'AU915'|'AS923-1'|'AS923-2'|'AS923-3'|'AS923-4'|'EU433'|'CN470'|'CN779'|'RU864'|'KR920'|'IN865',
        'DlClass': 'ClassB'|'ClassC'
    },
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
Parameters:
  • Name (string) – The name of the multicast group.

  • Description (string) – The description of the multicast group.

  • ClientRequestToken (string) –

    Each resource must have a unique client request token. The client token is used to implement idempotency. It ensures that the request completes no more than one time. If you retry a request with the same token and the same parameters, the request will complete successfully. However, if you try to create a new resource using the same token but different parameters, an HTTP 409 conflict occurs. If you omit this value, AWS SDKs will automatically generate a unique client request. For more information about idempotency, see Ensuring idempotency in Amazon EC2 API requests.

    This field is autopopulated if not provided.

  • LoRaWAN (dict) –

    [REQUIRED]

    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.

  • Tags (list) –

    The tag to attach to the specified resource. Tags are metadata that you can use to manage a resource.

    • (dict) –

      A simple label consisting of a customer-defined key-value pair

      • Key (string) – [REQUIRED]

        The tag’s key value.

      • Value (string) – [REQUIRED]

        The tag’s value.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'Id': 'string'
}

Response Structure

  • (dict) –

    • Arn (string) –

      The arn of the multicast group.

    • Id (string) –

      The ID of the multicast group.

Exceptions