UpdateChannelCommand

Suggest an Edit

Updates 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, UpdateChannelCommand } from "@aws-sdk/client-mediatailor"; // ES Modules import
// const { MediaTailorClient, UpdateChannelCommand } = require("@aws-sdk/client-mediatailor"); // CommonJS import
const client = new MediaTailorClient(config);
const input = { // UpdateChannelRequest
  ChannelName: "STRING_VALUE", // required
  FillerSlate: { // SlateSource
    SourceLocationName: "STRING_VALUE",
    VodSourceName: "STRING_VALUE",
  },
  Outputs: [ // RequestOutputs // required
    { // RequestOutputItem
      DashPlaylistSettings: { // DashPlaylistSettings
        ManifestWindowSeconds: Number("int"),
        MinBufferTimeSeconds: Number("int"),
        MinUpdatePeriodSeconds: Number("int"),
        SuggestedPresentationDelaySeconds: Number("int"),
      },
      HlsPlaylistSettings: { // HlsPlaylistSettings
        ManifestWindowSeconds: Number("int"),
        AdMarkupType: [ // adMarkupTypes
          "DATERANGE" || "SCTE35_ENHANCED",
        ],
      },
      ManifestName: "STRING_VALUE", // required
      SourceGroup: "STRING_VALUE", // required
    },
  ],
  TimeShiftConfiguration: { // TimeShiftConfiguration
    MaxTimeDelaySeconds: Number("int"), // required
  },
  Audiences: [ // Audiences
    "STRING_VALUE",
  ],
};
const command = new UpdateChannelCommand(input);
const response = await client.send(command);
// { // UpdateChannelResponse
//   Arn: "STRING_VALUE",
//   ChannelName: "STRING_VALUE",
//   ChannelState: "RUNNING" || "STOPPED",
//   CreationTime: new Date("TIMESTAMP"),
//   FillerSlate: { // SlateSource
//     SourceLocationName: "STRING_VALUE",
//     VodSourceName: "STRING_VALUE",
//   },
//   LastModifiedTime: new Date("TIMESTAMP"),
//   Outputs: [ // ResponseOutputs
//     { // ResponseOutputItem
//       DashPlaylistSettings: { // DashPlaylistSettings
//         ManifestWindowSeconds: Number("int"),
//         MinBufferTimeSeconds: Number("int"),
//         MinUpdatePeriodSeconds: Number("int"),
//         SuggestedPresentationDelaySeconds: Number("int"),
//       },
//       HlsPlaylistSettings: { // HlsPlaylistSettings
//         ManifestWindowSeconds: Number("int"),
//         AdMarkupType: [ // adMarkupTypes
//           "DATERANGE" || "SCTE35_ENHANCED",
//         ],
//       },
//       ManifestName: "STRING_VALUE", // required
//       PlaybackUrl: "STRING_VALUE", // required
//       SourceGroup: "STRING_VALUE", // required
//     },
//   ],
//   PlaybackMode: "STRING_VALUE",
//   Tags: { // __mapOf__string
//     "<keys>": "STRING_VALUE",
//   },
//   Tier: "STRING_VALUE",
//   TimeShiftConfiguration: { // TimeShiftConfiguration
//     MaxTimeDelaySeconds: Number("int"), // required
//   },
//   Audiences: [ // Audiences
//     "STRING_VALUE",
//   ],
// };

UpdateChannelCommand Input

See UpdateChannelCommandInput for more details

Parameter
Type
Description
ChannelName
Required
string | undefined

The name of the channel.

Outputs
Required
RequestOutputItem[] | undefined

The channel's output properties.

Audiences
string[] | undefined

The list of audiences defined in channel.

FillerSlate
SlateSource | undefined

The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.

TimeShiftConfiguration
TimeShiftConfiguration | undefined

The time-shifted viewing configuration you want to associate to the channel.

UpdateChannelCommand Output

See UpdateChannelCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Arn
string | undefined

The Amazon Resource Name (ARN) associated with the channel.

Audiences
string[] | undefined

The list of audiences defined in channel.

ChannelName
string | undefined

The name of the channel.

ChannelState
ChannelState | undefined

Returns the state whether the channel is running or not.

CreationTime
Date | undefined

The timestamp of when the channel was created.

FillerSlate
SlateSource | undefined

The slate used to fill gaps between programs in the schedule. You must configure filler slate if your channel uses the LINEAR PlaybackMode. MediaTailor doesn't support filler slate for channels using the LOOP PlaybackMode.

LastModifiedTime
Date | undefined

The timestamp that indicates when the channel was last modified.

Outputs
ResponseOutputItem[] | undefined

The channel's output properties.

PlaybackMode
string | undefined

The type of playback mode for this channel.

LINEAR - Programs play back-to-back only once.

LOOP - Programs play back-to-back in an endless loop. When the last program in the schedule plays, playback loops back to the first program in the schedule.

Tags
Record<string, string> | undefined

The tags to assign to the channel. Tags are key-value pairs that you can associate with Amazon resources to help with organization, access control, and cost tracking. For more information, see Tagging AWS Elemental MediaTailor Resources .

Tier
string | undefined

The tier associated with this Channel.

TimeShiftConfiguration
TimeShiftConfiguration | undefined

The time-shifted viewing configuration for the channel.

Throws

Name
Fault
Details
MediaTailorServiceException
Base exception class for all service exceptions from MediaTailor service.