Clip range configuration for the VOD source associated with the program.
+ * @public + */ +export interface ClipRange { + /** + *The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
+ * @public + */ + EndOffsetMillis?: number; + + /** + *The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
+ * @public + */ + StartOffsetMillis?: number; +} + +/** + *A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.
+ * @public + */ +export interface AlternateMedia { + /** + *The name of the source location for alternateMedia.
+ * @public + */ + SourceLocationName?: string; + + /** + *The name of the live source for alternateMedia.
+ * @public + */ + LiveSourceName?: string; + + /** + *The name of the VOD source for alternateMedia.
+ * @public + */ + VodSourceName?: string; + + /** + *Clip range configuration for the VOD source associated with the program.
+ * @public + */ + ClipRange?: ClipRange; + + /** + *The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
+ * @public + */ + ScheduledStartTimeMillis?: number; + + /** + *Ad break configuration parameters defined in AlternateMedia.
+ * @public + */ + AdBreaks?: AdBreak[]; + + /** + *The duration of the alternateMedia in milliseconds.
+ * @public + */ + DurationMillis?: number; +} + +/** + *An AudienceMedia object contains an Audience and a list of AlternateMedia.
+ * @public + */ +export interface AudienceMedia { + /** + *The Audience defined in AudienceMedia.
+ * @public + */ + Audience?: string; + + /** + *The list of AlternateMedia defined in AudienceMedia.
+ * @public + */ + AlternateMedia?: AlternateMedia[]; +} + /** * @public * @enum @@ -488,6 +572,12 @@ export interface Channel { * @public */ LogConfiguration: LogConfigurationForChannel | undefined; + + /** + *The list of audiences defined in channel.
+ * @public + */ + Audiences?: string[]; } /** @@ -1019,6 +1109,7 @@ export interface ScheduleAdBreak { * @enum */ export const ScheduleEntryType = { + ALTERNATE_MEDIA: "ALTERNATE_MEDIA", FILLER_SLATE: "FILLER_SLATE", PROGRAM: "PROGRAM", } as const; @@ -1092,6 +1183,12 @@ export interface ScheduleEntry { * @public */ VodSourceName?: string; + + /** + *The list of audiences defined in ScheduleEntry.
+ * @public + */ + Audiences?: string[]; } /** @@ -1573,6 +1670,12 @@ export interface CreateChannelRequest { * @public */ TimeShiftConfiguration?: TimeShiftConfiguration; + + /** + *The list of audiences defined in channel.
+ * @public + */ + Audiences?: string[]; } /** @@ -1660,6 +1763,12 @@ export interface CreateChannelResponse { * @public */ TimeShiftConfiguration?: TimeShiftConfiguration; + + /** + *The list of audiences defined in channel.
+ * @public + */ + Audiences?: string[]; } /** @@ -1766,6 +1875,12 @@ export interface DescribeChannelResponse { * @public */ TimeShiftConfiguration?: TimeShiftConfiguration; + + /** + *The list of audiences defined in channel.
+ * @public + */ + Audiences?: string[]; } /** @@ -1798,6 +1913,12 @@ export interface GetChannelScheduleRequest { * @public */ NextToken?: string; + + /** + *The single audience for GetChannelScheduleRequest.
+ * @public + */ + Audience?: string; } /** @@ -1851,18 +1972,6 @@ export interface ListChannelsResponse { NextToken?: string; } -/** - *Clip range configuration for the VOD source associated with the program.
- * @public - */ -export interface ClipRange { - /** - *The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
- * @public - */ - EndOffsetMillis: number | undefined; -} - /** * @public * @enum @@ -1984,6 +2093,12 @@ export interface CreateProgramRequest { * @public */ VodSourceName?: string; + + /** + *The list of AudienceMedia defined in program.
+ * @public + */ + AudienceMedia?: AudienceMedia[]; } /** @@ -2055,6 +2170,12 @@ export interface CreateProgramResponse { * @public */ DurationMillis?: number; + + /** + *The list of AudienceMedia defined in program.
+ * @public + */ + AudienceMedia?: AudienceMedia[]; } /** @@ -2165,6 +2286,12 @@ export interface DescribeProgramResponse { * @public */ DurationMillis?: number; + + /** + *The list of AudienceMedia defined in program.
+ * @public + */ + AudienceMedia?: AudienceMedia[]; } /** @@ -2230,6 +2357,12 @@ export interface UpdateProgramRequest { * @public */ ScheduleConfiguration: UpdateProgramScheduleConfiguration | undefined; + + /** + *The list of AudienceMedia defined in program.
+ * @public + */ + AudienceMedia?: AudienceMedia[]; } /** @@ -2301,6 +2434,12 @@ export interface UpdateProgramResponse { * @public */ ScheduledStartTime?: Date; + + /** + *The list of AudienceMedia defined in program.
+ * @public + */ + AudienceMedia?: AudienceMedia[]; } /** @@ -2366,6 +2505,12 @@ export interface UpdateChannelRequest { * @public */ TimeShiftConfiguration?: TimeShiftConfiguration; + + /** + *The list of audiences defined in channel.
+ * @public + */ + Audiences?: string[]; } /** @@ -2445,6 +2590,12 @@ export interface UpdateChannelResponse { * @public */ TimeShiftConfiguration?: TimeShiftConfiguration; + + /** + *The list of audiences defined in channel.
+ * @public + */ + Audiences?: string[]; } /** diff --git a/clients/client-mediatailor/src/protocols/Aws_restJson1.ts b/clients/client-mediatailor/src/protocols/Aws_restJson1.ts index 37ef4c906b02..04070c0777b5 100644 --- a/clients/client-mediatailor/src/protocols/Aws_restJson1.ts +++ b/clients/client-mediatailor/src/protocols/Aws_restJson1.ts @@ -127,6 +127,8 @@ import { AdMarkerPassthrough, AdMarkupType, Alert, + AlternateMedia, + AudienceMedia, AvailMatchingCriteria, AvailSuppression, BadRequestException, @@ -229,6 +231,7 @@ export const se_CreateChannelCommand = async ( let body: any; body = JSON.stringify( take(input, { + Audiences: (_) => _json(_), FillerSlate: (_) => _json(_), Outputs: (_) => _json(_), PlaybackMode: [], @@ -310,6 +313,7 @@ export const se_CreateProgramCommand = async ( body = JSON.stringify( take(input, { AdBreaks: (_) => _json(_), + AudienceMedia: (_) => _json(_), LiveSourceName: [], ScheduleConfiguration: (_) => _json(_), SourceLocationName: [], @@ -618,6 +622,7 @@ export const se_GetChannelScheduleCommand = async ( [_dM]: [, input[_DM]!], [_mR]: [() => input.MaxResults !== void 0, () => input[_MR]!.toString()], [_nT]: [, input[_NT]!], + [_a]: [, input[_A]!], }); let body: any; b.m("GET").h(headers).q(query).b(body); @@ -966,6 +971,7 @@ export const se_UpdateChannelCommand = async ( let body: any; body = JSON.stringify( take(input, { + Audiences: (_) => _json(_), FillerSlate: (_) => _json(_), Outputs: (_) => _json(_), TimeShiftConfiguration: (_) => _json(_), @@ -1017,6 +1023,7 @@ export const se_UpdateProgramCommand = async ( body = JSON.stringify( take(input, { AdBreaks: (_) => _json(_), + AudienceMedia: (_) => _json(_), ScheduleConfiguration: (_) => _json(_), }) ); @@ -1134,6 +1141,7 @@ export const de_CreateChannelCommand = async ( const data: RecordThe name of the source location for alternateMedia.
" + } + }, + "LiveSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the live source for alternateMedia.
" + } + }, + "VodSourceName": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The name of the VOD source for alternateMedia.
" + } + }, + "ClipRange": { + "target": "com.amazonaws.mediatailor#ClipRange" + }, + "ScheduledStartTimeMillis": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#documentation": "The date and time that the alternateMedia is scheduled to start, in epoch milliseconds.
" + } + }, + "AdBreaks": { + "target": "com.amazonaws.mediatailor#__listOfAdBreak", + "traits": { + "smithy.api#documentation": "Ad break configuration parameters defined in AlternateMedia.
" + } + }, + "DurationMillis": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#documentation": "The duration of the alternateMedia in milliseconds.
" + } + } + }, + "traits": { + "smithy.api#documentation": "A playlist of media (VOD and/or live) to be played instead of the default media on a particular program.
" + } + }, + "com.amazonaws.mediatailor#AudienceMedia": { + "type": "structure", + "members": { + "Audience": { + "target": "com.amazonaws.mediatailor#__string", + "traits": { + "smithy.api#documentation": "The Audience defined in AudienceMedia.
" + } + }, + "AlternateMedia": { + "target": "com.amazonaws.mediatailor#__listOfAlternateMedia", + "traits": { + "smithy.api#documentation": "The list of AlternateMedia defined in AudienceMedia.
" + } + } + }, + "traits": { + "smithy.api#documentation": "An AudienceMedia object contains an Audience and a list of AlternateMedia.
" + } + }, + "com.amazonaws.mediatailor#Audiences": { + "type": "list", + "member": { + "target": "smithy.api#String" + } + }, "com.amazonaws.mediatailor#AvailMatchingCriteria": { "type": "structure", "members": { @@ -402,6 +475,12 @@ "smithy.api#documentation": "The log configuration.
", "smithy.api#required": {} } + }, + "Audiences": { + "target": "com.amazonaws.mediatailor#Audiences", + "traits": { + "smithy.api#documentation": "The list of audiences defined in channel.
" + } } }, "traits": { @@ -520,8 +599,15 @@ "EndOffsetMillis": { "target": "com.amazonaws.mediatailor#__long", "traits": { - "smithy.api#documentation": "The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
", - "smithy.api#required": {} + "smithy.api#addedDefault": {}, + "smithy.api#default": 0, + "smithy.api#documentation": "The end offset of the clip range, in milliseconds, starting from the beginning of the VOD source associated with the program.
" + } + }, + "StartOffsetMillis": { + "target": "com.amazonaws.mediatailor#__long", + "traits": { + "smithy.api#documentation": "The start offset of the clip range, in milliseconds. This offset truncates the start at the number of milliseconds into the duration of the VOD source.
" } } }, @@ -745,6 +831,12 @@ "traits": { "smithy.api#documentation": "\n The time-shifted viewing configuration you want to associate to the channel.\n
" } + }, + "Audiences": { + "target": "com.amazonaws.mediatailor#Audiences", + "traits": { + "smithy.api#documentation": "The list of audiences defined in channel.
" + } } } }, @@ -823,6 +915,12 @@ "traits": { "smithy.api#documentation": "\n The time-shifted viewing configuration assigned to the channel.\n
" } + }, + "Audiences": { + "target": "com.amazonaws.mediatailor#Audiences", + "traits": { + "smithy.api#documentation": "The list of audiences defined in channel.
" + } } } }, @@ -1095,6 +1193,12 @@ "traits": { "smithy.api#documentation": "The name that's used to refer to a VOD source.
" } + }, + "AudienceMedia": { + "target": "com.amazonaws.mediatailor#__listOfAudienceMedia", + "traits": { + "smithy.api#documentation": "The list of AudienceMedia defined in program.
" + } } } }, @@ -1166,6 +1270,12 @@ "traits": { "smithy.api#documentation": "The duration of the live program in milliseconds.
" } + }, + "AudienceMedia": { + "target": "com.amazonaws.mediatailor#__listOfAudienceMedia", + "traits": { + "smithy.api#documentation": "The list of AudienceMedia defined in program.
" + } } } }, @@ -1910,6 +2020,12 @@ "traits": { "smithy.api#documentation": "\n The time-shifted viewing configuration for the channel.\n
" } + }, + "Audiences": { + "target": "com.amazonaws.mediatailor#Audiences", + "traits": { + "smithy.api#documentation": "The list of audiences defined in channel.
" + } } } }, @@ -2107,6 +2223,12 @@ "traits": { "smithy.api#documentation": "The duration of the live program in milliseconds.
" } + }, + "AudienceMedia": { + "target": "com.amazonaws.mediatailor#__listOfAudienceMedia", + "traits": { + "smithy.api#documentation": "The list of AudienceMedia defined in program.
" + } } } }, @@ -2408,6 +2530,13 @@ "smithy.api#documentation": "(Optional) If the playback configuration has more than MaxResults channel schedules, use NextToken to get the second and subsequent pages of results.
For the first GetChannelScheduleRequest request, omit this value.
For the second and subsequent requests, get the value of NextToken from the previous response and specify that value for NextToken in the request.
If the previous response didn't include a NextToken element, there are no more channel schedules to get.
The single audience for GetChannelScheduleRequest.
", + "smithy.api#httpQuery": "audience" + } } } }, @@ -5145,6 +5274,12 @@ "traits": { "smithy.api#documentation": "The name of the VOD source.
" } + }, + "Audiences": { + "target": "com.amazonaws.mediatailor#Audiences", + "traits": { + "smithy.api#documentation": "The list of audiences defined in ScheduleEntry.
" + } } }, "traits": { @@ -5165,6 +5300,12 @@ "traits": { "smithy.api#enumValue": "FILLER_SLATE" } + }, + "ALTERNATE_MEDIA": { + "target": "smithy.api#Unit", + "traits": { + "smithy.api#enumValue": "ALTERNATE_MEDIA" + } } } }, @@ -5739,6 +5880,12 @@ "traits": { "smithy.api#documentation": "\n The time-shifted viewing configuration you want to associate to the channel.\n
" } + }, + "Audiences": { + "target": "com.amazonaws.mediatailor#Audiences", + "traits": { + "smithy.api#documentation": "The list of audiences defined in channel.
" + } } } }, @@ -5817,6 +5964,12 @@ "traits": { "smithy.api#documentation": "\n The time-shifted viewing configuration for the channel.\n
" } + }, + "Audiences": { + "target": "com.amazonaws.mediatailor#Audiences", + "traits": { + "smithy.api#documentation": "The list of audiences defined in channel.
" + } } } }, @@ -5963,6 +6116,12 @@ "smithy.api#documentation": "The schedule configuration settings.
", "smithy.api#required": {} } + }, + "AudienceMedia": { + "target": "com.amazonaws.mediatailor#__listOfAudienceMedia", + "traits": { + "smithy.api#documentation": "The list of AudienceMedia defined in program.
" + } } } }, @@ -6034,6 +6193,12 @@ "traits": { "smithy.api#documentation": "The scheduled start time for this Program.
" } + }, + "AudienceMedia": { + "target": "com.amazonaws.mediatailor#__listOfAudienceMedia", + "traits": { + "smithy.api#documentation": "The list of AudienceMedia defined in program.
" + } } } }, @@ -6418,6 +6583,18 @@ "target": "com.amazonaws.mediatailor#Alert" } }, + "com.amazonaws.mediatailor#__listOfAlternateMedia": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#AlternateMedia" + } + }, + "com.amazonaws.mediatailor#__listOfAudienceMedia": { + "type": "list", + "member": { + "target": "com.amazonaws.mediatailor#AudienceMedia" + } + }, "com.amazonaws.mediatailor#__listOfAvailMatchingCriteria": { "type": "list", "member": {