UpdateMultiplexProgramCommand

Update a program in a multiplex.

Example Syntax

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

import { MediaLiveClient, UpdateMultiplexProgramCommand } from "@aws-sdk/client-medialive"; // ES Modules import
// const { MediaLiveClient, UpdateMultiplexProgramCommand } = require("@aws-sdk/client-medialive"); // CommonJS import
const client = new MediaLiveClient(config);
const input = { // UpdateMultiplexProgramRequest
  MultiplexId: "STRING_VALUE", // required
  MultiplexProgramSettings: { // MultiplexProgramSettings
    PreferredChannelPipeline: "CURRENTLY_ACTIVE" || "PIPELINE_0" || "PIPELINE_1",
    ProgramNumber: Number("int"), // required
    ServiceDescriptor: { // MultiplexProgramServiceDescriptor
      ProviderName: "STRING_VALUE", // required
      ServiceName: "STRING_VALUE", // required
    },
    VideoSettings: { // MultiplexVideoSettings
      ConstantBitrate: Number("int"),
      StatmuxSettings: { // MultiplexStatmuxVideoSettings
        MaximumBitrate: Number("int"),
        MinimumBitrate: Number("int"),
        Priority: Number("int"),
      },
    },
  },
  ProgramName: "STRING_VALUE", // required
};
const command = new UpdateMultiplexProgramCommand(input);
const response = await client.send(command);
// { // UpdateMultiplexProgramResponse
//   MultiplexProgram: { // MultiplexProgram
//     ChannelId: "STRING_VALUE",
//     MultiplexProgramSettings: { // MultiplexProgramSettings
//       PreferredChannelPipeline: "CURRENTLY_ACTIVE" || "PIPELINE_0" || "PIPELINE_1",
//       ProgramNumber: Number("int"), // required
//       ServiceDescriptor: { // MultiplexProgramServiceDescriptor
//         ProviderName: "STRING_VALUE", // required
//         ServiceName: "STRING_VALUE", // required
//       },
//       VideoSettings: { // MultiplexVideoSettings
//         ConstantBitrate: Number("int"),
//         StatmuxSettings: { // MultiplexStatmuxVideoSettings
//           MaximumBitrate: Number("int"),
//           MinimumBitrate: Number("int"),
//           Priority: Number("int"),
//         },
//       },
//     },
//     PacketIdentifiersMap: { // MultiplexProgramPacketIdentifiersMap
//       AudioPids: [ // __listOf__integer
//         Number("int"),
//       ],
//       DvbSubPids: [
//         Number("int"),
//       ],
//       DvbTeletextPid: Number("int"),
//       EtvPlatformPid: Number("int"),
//       EtvSignalPid: Number("int"),
//       KlvDataPids: [
//         Number("int"),
//       ],
//       PcrPid: Number("int"),
//       PmtPid: Number("int"),
//       PrivateMetadataPid: Number("int"),
//       Scte27Pids: [
//         Number("int"),
//       ],
//       Scte35Pid: Number("int"),
//       TimedMetadataPid: Number("int"),
//       VideoPid: Number("int"),
//       AribCaptionsPid: Number("int"),
//       DvbTeletextPids: [
//         Number("int"),
//       ],
//       EcmPid: Number("int"),
//       Smpte2038Pid: Number("int"),
//     },
//     PipelineDetails: [ // __listOfMultiplexProgramPipelineDetail
//       { // MultiplexProgramPipelineDetail
//         ActiveChannelPipeline: "STRING_VALUE",
//         PipelineId: "STRING_VALUE",
//       },
//     ],
//     ProgramName: "STRING_VALUE",
//   },
// };

UpdateMultiplexProgramCommand Input

Parameter
Type
Description
MultiplexId
Required
string | undefined
The ID of the multiplex of the program to update.
ProgramName
Required
string | undefined
The name of the program to update.
MultiplexProgramSettings
MultiplexProgramSettings | undefined
The new settings for a multiplex program.

UpdateMultiplexProgramCommand Output

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
MultiplexProgram
MultiplexProgram | undefined
The updated multiplex program.

Throws

Name
Fault
Details
BadGatewayException
server
Placeholder documentation for BadGatewayException
BadRequestException
client
Placeholder documentation for BadRequestException
ConflictException
client
Placeholder documentation for ConflictException
ForbiddenException
client
Placeholder documentation for ForbiddenException
GatewayTimeoutException
server
Placeholder documentation for GatewayTimeoutException
InternalServerErrorException
server
Placeholder documentation for InternalServerErrorException
NotFoundException
client
Placeholder documentation for NotFoundException
UnprocessableEntityException
client
Placeholder documentation for UnprocessableEntityException
MediaLiveServiceException
Base exception class for all service exceptions from MediaLive service.