GetMulticastGroupCommand

Suggest an Edit

Gets information about a multicast group.

Example Syntax

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

import { IoTWirelessClient, GetMulticastGroupCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import
// const { IoTWirelessClient, GetMulticastGroupCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import
const client = new IoTWirelessClient(config);
const input = { // GetMulticastGroupRequest
  Id: "STRING_VALUE", // required
};
const command = new GetMulticastGroupCommand(input);
const response = await client.send(command);
// { // GetMulticastGroupResponse
//   Arn: "STRING_VALUE",
//   Id: "STRING_VALUE",
//   Name: "STRING_VALUE",
//   Description: "STRING_VALUE",
//   Status: "STRING_VALUE",
//   LoRaWAN: { // LoRaWANMulticastGet
//     RfRegion: "EU868" || "US915" || "AU915" || "AS923-1" || "AS923-2" || "AS923-3" || "AS923-4" || "EU433" || "CN470" || "CN779" || "RU864" || "KR920" || "IN865",
//     DlClass: "ClassB" || "ClassC",
//     NumberOfDevicesRequested: Number("int"),
//     NumberOfDevicesInGroup: Number("int"),
//     ParticipatingGateways: { // ParticipatingGatewaysMulticast
//       GatewayList: [ // GatewayListMulticast
//         "STRING_VALUE",
//       ],
//       TransmissionInterval: Number("int"),
//     },
//   },
//   CreatedAt: new Date("TIMESTAMP"),
// };

GetMulticastGroupCommand Input

See GetMulticastGroupCommandInput for more details

Parameter
Type
Description
Id
Required
string | undefined

The ID of the multicast group.

GetMulticastGroupCommand Output

See GetMulticastGroupCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
string | undefined

The arn of the multicast group.

CreatedAt
Date | undefined

Created at timestamp for the resource.

Description
string | undefined

The description of the new resource.

Id
string | undefined

The ID of the multicast group.

LoRaWAN
LoRaWANMulticastGet | undefined

The LoRaWAN information that is to be returned from getting multicast group information.

Name
string | undefined

The name of the multicast group.

Status
string | undefined

The status of the multicast group.

Throws

Name
Fault
Details
AccessDeniedException
client

User does not have permission to perform this action.

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.