- 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.
StopChannelCommand
Stops a channel. For information about MediaTailor channels, see Working with channels in the MediaTailor User Guide.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { MediaTailorClient, StopChannelCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import
// const { MediaTailorClient, StopChannelCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import
const client = new MediaTailorClient(config);
const input = { // StopChannelRequest
ChannelName: "STRING_VALUE", // required
};
const command = new StopChannelCommand(input);
const response = await client.send(command);
// {};
StopChannelCommand Input
See StopChannelCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
ChannelNameRequired | string | undefined | The name of the channel. |
StopChannelCommand Output
See StopChannelCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| MediaTailorServiceException | Base exception class for all service exceptions from MediaTailor service. |