Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . iotwireless ]

create-multicast-group

Description

Creates a multicast group.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-multicast-group
[--name <value>]
[--description <value>]
[--client-request-token <value>]
[--tags <value>]
--lorawan <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--name (string)

The name of the multicast group.

--description (string)

The description of the multicast group.

--client-request-token (string)

Each resource must have a unique client request token. If you try to create a new resource with the same token as a resource that already exists, an exception occurs. If you omit this value, AWS SDKs will automatically generate a unique client request.

--tags (list)

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

(structure)

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

Key -> (string)

The tag's key value.

Value -> (string)

The tag's value.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--lorawan (structure)

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.

Shorthand Syntax:

RfRegion=string,DlClass=string

JSON Syntax:

{
  "RfRegion": "EU868"|"US915"|"AU915"|"AS923-1",
  "DlClass": "ClassB"|"ClassC"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

Arn -> (string)

The arn of the multicast group.

Id -> (string)

The ID of the multicast group.