- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
CancelMulticastGroupSessionCommand
Cancels an existing multicast group session.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { IoTWirelessClient, CancelMulticastGroupSessionCommand } from "@aws-sdk/client-iot-wireless"; // ES Modules import
// const { IoTWirelessClient, CancelMulticastGroupSessionCommand } = require("@aws-sdk/client-iot-wireless"); // CommonJS import
const client = new IoTWirelessClient(config);
const input = { // CancelMulticastGroupSessionRequest
Id: "STRING_VALUE", // required
};
const command = new CancelMulticastGroupSessionCommand(input);
const response = await client.send(command);
// {};
CancelMulticastGroupSessionCommand Input
See CancelMulticastGroupSessionCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
IdRequired | string | undefined | The ID of the multicast group. |
CancelMulticastGroupSessionCommand Output
See CancelMulticastGroupSessionCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
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. |