import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { UpdateChannelRequest, UpdateChannelResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link UpdateChannelCommand}. */ export interface UpdateChannelCommandInput extends UpdateChannelRequest { } /** * @public * * The output of {@link UpdateChannelCommand}. */ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __MetadataBearer { } declare const UpdateChannelCommand_base: { new (input: UpdateChannelCommandInput): import("@smithy/core/client").CommandImpl; new (input: UpdateChannelCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Update the specified channel. You can edit if MediaPackage sends ingest or egress access logs to the CloudWatch log group, if content will be encrypted, the description on a channel, and your channel's policy settings. You can't edit the name of the channel or CloudFront distribution details.

Any edits you make that impact the video output may not be reflected for a few minutes.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { MediaPackageV2Client, UpdateChannelCommand } from "@aws-sdk/client-mediapackagev2"; // ES Modules import * // const { MediaPackageV2Client, UpdateChannelCommand } = require("@aws-sdk/client-mediapackagev2"); // CommonJS import * // import type { MediaPackageV2ClientConfig } from "@aws-sdk/client-mediapackagev2"; * const config = {}; // type is MediaPackageV2ClientConfig * const client = new MediaPackageV2Client(config); * const input = { // UpdateChannelRequest * ChannelGroupName: "STRING_VALUE", // required * ChannelName: "STRING_VALUE", // required * ETag: "STRING_VALUE", * Description: "STRING_VALUE", * InputSwitchConfiguration: { // InputSwitchConfiguration * MQCSInputSwitching: true || false, * PreferredInput: Number("int"), * }, * OutputHeaderConfiguration: { // OutputHeaderConfiguration * PublishMQCS: true || false, * }, * }; * const command = new UpdateChannelCommand(input); * const response = await client.send(command); * // { // UpdateChannelResponse * // Arn: "STRING_VALUE", // required * // ChannelName: "STRING_VALUE", // required * // ChannelGroupName: "STRING_VALUE", // required * // CreatedAt: new Date("TIMESTAMP"), // required * // ModifiedAt: new Date("TIMESTAMP"), // required * // Description: "STRING_VALUE", * // IngestEndpoints: [ // IngestEndpointList * // { // IngestEndpoint * // Id: "STRING_VALUE", * // Url: "STRING_VALUE", * // }, * // ], * // InputType: "HLS" || "CMAF", * // ETag: "STRING_VALUE", * // Tags: { // TagMap * // "": "STRING_VALUE", * // }, * // InputSwitchConfiguration: { // InputSwitchConfiguration * // MQCSInputSwitching: true || false, * // PreferredInput: Number("int"), * // }, * // OutputHeaderConfiguration: { // OutputHeaderConfiguration * // PublishMQCS: true || false, * // }, * // OutputLockingMode: "EPOCH_LOCKED" || "NON_EPOCH_LOCKED", * // }; * * ``` * * @param UpdateChannelCommandInput - {@link UpdateChannelCommandInput} * @returns {@link UpdateChannelCommandOutput} * @see {@link UpdateChannelCommandInput} for command's `input` shape. * @see {@link UpdateChannelCommandOutput} for command's `response` shape. * @see {@link MediaPackageV2ClientResolvedConfig | config} for MediaPackageV2Client's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Access is denied because either you don't have permissions to perform the requested operation or MediaPackage is getting throttling errors with CDN authorization. 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. Or, if you're using CDN authorization, you will receive this exception if MediaPackage receives a throttling error from Secrets Manager.

* * @throws {@link ConflictException} (client fault) *

Updating or deleting this resource can cause an inconsistent state.

* * @throws {@link InternalServerException} (server fault) *

Indicates that an error from the service occurred while trying to process a request.

* * @throws {@link ResourceNotFoundException} (client fault) *

The specified resource doesn't exist.

* * @throws {@link ThrottlingException} (client fault) *

The request throughput limit was exceeded.

* * @throws {@link ValidationException} (client fault) *

The input failed to meet the constraints specified by the AWS service.

* * @throws {@link MediaPackageV2ServiceException} *

Base exception class for all service exceptions from MediaPackageV2 service.

* * * @example Updating a Channel * ```javascript * // * const input = { * ChannelGroupName: "exampleChannelGroup", * ChannelName: "exampleChannel", * Description: "Updated description for exampleChannel" * }; * const command = new UpdateChannelCommand(input); * const response = await client.send(command); * /* response is * { * Arn: "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleChannel", * ChannelGroupName: "exampleChannelGroup", * ChannelName: "exampleChannel", * CreatedAt: "2022-10-18T09:36:00.00Z", * Description: "Updated description for exampleChannel", * ETag: "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", * IngestEndpoints: [ * { * Id: "1", * Url: "https://abcde-1.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index" * }, * { * Id: "2", * Url: "https://abcde-2.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleChannel/index" * } * ], * InputType: "HLS", * ModifiedAt: "2022-10-18T10:36:00.00Z", * Tags: { * key1: "value1", * key2: "value2" * } * } * *\/ * ``` * * @example Updating a CMAF Channel with non-epoch-locked output locking mode * ```javascript * // * const input = { * ChannelGroupName: "exampleChannelGroup", * ChannelName: "exampleCmafChannel", * Description: "Updated non-epoch-locked CMAF channel" * }; * const command = new UpdateChannelCommand(input); * const response = await client.send(command); * /* response is * { * Arn: "arn:aws:mediapackagev2:us-west-2:123456789012:channelGroup/exampleChannelGroup/channel/exampleCmafChannel", * ChannelGroupName: "exampleChannelGroup", * ChannelName: "exampleCmafChannel", * CreatedAt: "2022-10-18T09:36:00.00Z", * Description: "Updated non-epoch-locked CMAF channel", * ETag: "GlfT+dwAyGIR4wuy8nKWl1RDPwSrjQej9qUutLZxoxk=", * IngestEndpoints: [ * { * Id: "1", * Url: "https://abcde-1.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleCmafChannel" * }, * { * Id: "2", * Url: "https://abcde-2.ingest.vwxyz.mediapackagev2.us-west-2.amazonaws.com/v1/exampleChannelGroup/exampleCmafChannel" * } * ], * InputType: "CMAF", * ModifiedAt: "2022-10-18T10:36:00.00Z", * OutputLockingMode: "NON_EPOCH_LOCKED", * Tags: { * key1: "value1", * key2: "value2" * } * } * *\/ * ``` * * @public */ export declare class UpdateChannelCommand extends UpdateChannelCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: UpdateChannelRequest; output: UpdateChannelResponse; }; sdk: { input: UpdateChannelCommandInput; output: UpdateChannelCommandOutput; }; }; }