[ aws . iotwireless ]

start-multicast-group-session

Description

Starts a multicast group session.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  start-multicast-group-session
--id <value>
--lorawan <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--id (string)

The ID of the multicast group.

--lorawan (structure)

The LoRaWAN information used with the multicast session.

DlDr -> (integer)

Downlink data rate.

DlFreq -> (integer)

Downlink frequency.

SessionStartTime -> (timestamp)

Timestamp of when the multicast group session is to start.

SessionTimeout -> (integer)

How long before a multicast group session is to timeout.

Shorthand Syntax:

DlDr=integer,DlFreq=integer,SessionStartTime=timestamp,SessionTimeout=integer

JSON Syntax:

{
  "DlDr": integer,
  "DlFreq": integer,
  "SessionStartTime": timestamp,
  "SessionTimeout": integer
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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

None