StartMulticastGroupSessionCommand

Suggest an Edit

Starts a multicast group session.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { IoTWirelessClient, StartMulticastGroupSessionCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import
// const { IoTWirelessClient, StartMulticastGroupSessionCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import
const client = new IoTWirelessClient(config);
const input = { // StartMulticastGroupSessionRequest
  Id: "STRING_VALUE", // required
  LoRaWAN: { // LoRaWANMulticastSession
    DlDr: Number("int"),
    DlFreq: Number("int"),
    SessionStartTime: new Date("TIMESTAMP"),
    SessionTimeout: Number("int"),
    PingSlotPeriod: Number("int"),
  },
};
const command = new StartMulticastGroupSessionCommand(input);
const response = await client.send(command);
// {};

StartMulticastGroupSessionCommand Input

See StartMulticastGroupSessionCommandInput for more details

Parameter
Type
Description
Id
Required
string | undefined

The ID of the multicast group.

LoRaWAN
Required
LoRaWANMulticastSession | undefined

The LoRaWAN information used with the multicast session.

StartMulticastGroupSessionCommand Output

See StartMulticastGroupSessionCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.

Throws

Name
Fault
Details
AccessDeniedException
client

User does not have permission to perform this action.

ConflictException
client

Adding, updating, or deleting the resource can cause an inconsistent state.

InternalServerException
server

An unexpected error occurred while processing a request.

ResourceNotFoundException
client

Resource does not exist.

ThrottlingException
client

The request was denied because it exceeded the allowed API request rate.

ValidationException
client

The input did not meet the specified constraints.

IoTWirelessServiceException
Base exception class for all service exceptions from IoTWireless service.