Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

DeleteChannelGroupCommand

Delete a channel group. You must delete the channel group's channels and origin endpoints before you can delete the channel group. If you delete a channel group, you'll lose access to the egress domain and will have to create a new channel group to replace it.

Example Syntax

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

import { MediaPackageV2Client, DeleteChannelGroupCommand } from "@aws-sdk/client-mediapackagev2"; // ES Modules import
// const { MediaPackageV2Client, DeleteChannelGroupCommand } = require("@aws-sdk/client-mediapackagev2"); // CommonJS import
const client = new MediaPackageV2Client(config);
const input = { // DeleteChannelGroupRequest
  ChannelGroupName: "STRING_VALUE", // required
};
const command = new DeleteChannelGroupCommand(input);
const response = await client.send(command);
// {};

Example Usage

Loading code editor

DeleteChannelGroupCommand Input

See DeleteChannelGroupCommandInput for more details

Parameter	Type	Description
`ChannelGroupName` Required	`string \| undefined`	The name that describes the channel group. The name is the primary identifier for the channel group, and must be unique for your account in the AWS Region.

DeleteChannelGroupCommand Output

See DeleteChannelGroupCommandOutput for details

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

Throws

Name	Fault	Details
AccessDeniedException	client	You don't have permissions to perform the requested operation. The user or role that is making the request must have at least one IAM permissions policy attached that grants the required permissions. For more information, see Access Management in the IAM User Guide.
ConflictException	client	Updating or deleting this resource can cause an inconsistent state.
InternalServerException	server	Indicates that an error from the service occurred while trying to process a request.
ThrottlingException	client	The request throughput limit was exceeded.
ValidationException	client	The input failed to meet the constraints specified by the AWS service.
MediaPackageV2ServiceException		Base exception class for all service exceptions from MediaPackageV2 service.

Getting Started

References