@aws-sdk/client-mediatailor 3.787.0 → 3.796.0

package/dist-cjs/index.js

@@ -59,6 +59,7 @@ __export(index_exports, {
   ListChannelsCommand: () => ListChannelsCommand,
   ListLiveSourcesCommand: () => ListLiveSourcesCommand,
   ListPlaybackConfigurationsCommand: () => ListPlaybackConfigurationsCommand,
+  ListPrefetchScheduleType: () => ListPrefetchScheduleType,
   ListPrefetchSchedulesCommand: () => ListPrefetchSchedulesCommand,
   ListSourceLocationsCommand: () => ListSourceLocationsCommand,
   ListTagsForResourceCommand: () => ListTagsForResourceCommand,
@@ -74,6 +75,7 @@ __export(index_exports, {
   Operator: () => Operator,
   OriginManifestType: () => OriginManifestType,
   PlaybackMode: () => PlaybackMode,
+  PrefetchScheduleType: () => PrefetchScheduleType,
   PutChannelPolicyCommand: () => PutChannelPolicyCommand,
   PutPlaybackConfigurationCommand: () => PutPlaybackConfigurationCommand,
   RelativePosition: () => RelativePosition,
@@ -83,6 +85,7 @@ __export(index_exports, {
   StreamingMediaFileConditioning: () => StreamingMediaFileConditioning,
   TagResourceCommand: () => TagResourceCommand,
   Tier: () => Tier,
+  TrafficShapingType: () => TrafficShapingType,
   Type: () => Type,
   UntagResourceCommand: () => UntagResourceCommand,
   UpdateChannelCommand: () => UpdateChannelCommand,
@@ -400,6 +403,13 @@ var ManifestServiceExcludeEventType = {
   UNKNOWN_HOST: "UNKNOWN_HOST",
   UNSUPPORTED_SINGLE_PERIOD_DASH_MANIFEST: "UNSUPPORTED_SINGLE_PERIOD_DASH_MANIFEST"
 };
+var TrafficShapingType = {
+  RETRIEVAL_WINDOW: "RETRIEVAL_WINDOW"
+};
+var PrefetchScheduleType = {
+  RECURRING: "RECURRING",
+  SINGLE: "SINGLE"
+};
 var ScheduleEntryType = {
   ALTERNATE_MEDIA: "ALTERNATE_MEDIA",
   FILLER_SLATE: "FILLER_SLATE",
@@ -446,6 +456,11 @@ var RelativePosition = {
   AFTER_PROGRAM: "AFTER_PROGRAM",
   BEFORE_PROGRAM: "BEFORE_PROGRAM"
 };
+var ListPrefetchScheduleType = {
+  ALL: "ALL",
+  RECURRING: "RECURRING",
+  SINGLE: "SINGLE"
+};
 
 // src/protocols/Aws_restJson1.ts
 var se_ConfigureLogsForChannelCommand = /* @__PURE__ */ __name(async (input, context) => {
@@ -535,7 +550,9 @@ var se_CreatePrefetchScheduleCommand = /* @__PURE__ */ __name(async (input, cont
   body = JSON.stringify(
     (0, import_smithy_client.take)(input, {
       Consumption: /* @__PURE__ */ __name((_) => se_PrefetchConsumption(_, context), "Consumption"),
+      RecurringPrefetchConfiguration: /* @__PURE__ */ __name((_) => se_RecurringPrefetchConfiguration(_, context), "RecurringPrefetchConfiguration"),
       Retrieval: /* @__PURE__ */ __name((_) => se_PrefetchRetrieval(_, context), "Retrieval"),
+      ScheduleType: [],
       StreamId: []
     })
   );
@@ -831,6 +848,7 @@ var se_ListPrefetchSchedulesCommand = /* @__PURE__ */ __name(async (input, conte
     (0, import_smithy_client.take)(input, {
       MaxResults: [],
       NextToken: [],
+      ScheduleType: [],
       StreamId: []
     })
   );
@@ -1145,7 +1163,9 @@ var de_CreatePrefetchScheduleCommand = /* @__PURE__ */ __name(async (output, con
     Consumption: /* @__PURE__ */ __name((_) => de_PrefetchConsumption(_, context), "Consumption"),
     Name: import_smithy_client.expectString,
     PlaybackConfigurationName: import_smithy_client.expectString,
+    RecurringPrefetchConfiguration: /* @__PURE__ */ __name((_) => de_RecurringPrefetchConfiguration(_, context), "RecurringPrefetchConfiguration"),
     Retrieval: /* @__PURE__ */ __name((_) => de_PrefetchRetrieval(_, context), "Retrieval"),
+    ScheduleType: import_smithy_client.expectString,
     StreamId: import_smithy_client.expectString
   });
   Object.assign(contents, doc);
@@ -1488,7 +1508,9 @@ var de_GetPrefetchScheduleCommand = /* @__PURE__ */ __name(async (output, contex
     Consumption: /* @__PURE__ */ __name((_) => de_PrefetchConsumption(_, context), "Consumption"),
     Name: import_smithy_client.expectString,
     PlaybackConfigurationName: import_smithy_client.expectString,
+    RecurringPrefetchConfiguration: /* @__PURE__ */ __name((_) => de_RecurringPrefetchConfiguration(_, context), "RecurringPrefetchConfiguration"),
     Retrieval: /* @__PURE__ */ __name((_) => de_PrefetchRetrieval(_, context), "Retrieval"),
+    ScheduleType: import_smithy_client.expectString,
     StreamId: import_smithy_client.expectString
   });
   Object.assign(contents, doc);
@@ -1853,9 +1875,19 @@ var se_PrefetchRetrieval = /* @__PURE__ */ __name((input, context) => {
   return (0, import_smithy_client.take)(input, {
     DynamicVariables: import_smithy_client._json,
     EndTime: /* @__PURE__ */ __name((_) => _.getTime() / 1e3, "EndTime"),
-    StartTime: /* @__PURE__ */ __name((_) => _.getTime() / 1e3, "StartTime")
+    StartTime: /* @__PURE__ */ __name((_) => _.getTime() / 1e3, "StartTime"),
+    TrafficShapingRetrievalWindow: import_smithy_client._json,
+    TrafficShapingType: []
   });
 }, "se_PrefetchRetrieval");
+var se_RecurringPrefetchConfiguration = /* @__PURE__ */ __name((input, context) => {
+  return (0, import_smithy_client.take)(input, {
+    EndTime: /* @__PURE__ */ __name((_) => _.getTime() / 1e3, "EndTime"),
+    RecurringConsumption: import_smithy_client._json,
+    RecurringRetrieval: import_smithy_client._json,
+    StartTime: /* @__PURE__ */ __name((_) => _.getTime() / 1e3, "StartTime")
+  });
+}, "se_RecurringPrefetchConfiguration");
 var de___listOfAlert = /* @__PURE__ */ __name((output, context) => {
   const retVal = (output || []).filter((e) => e != null).map((entry) => {
     return de_Alert(entry, context);
@@ -1983,7 +2015,9 @@ var de_PrefetchRetrieval = /* @__PURE__ */ __name((output, context) => {
   return (0, import_smithy_client.take)(output, {
     DynamicVariables: import_smithy_client._json,
     EndTime: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "EndTime"),
-    StartTime: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "StartTime")
+    StartTime: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "StartTime"),
+    TrafficShapingRetrievalWindow: import_smithy_client._json,
+    TrafficShapingType: import_smithy_client.expectString
   });
 }, "de_PrefetchRetrieval");
 var de_PrefetchSchedule = /* @__PURE__ */ __name((output, context) => {
@@ -1992,10 +2026,20 @@ var de_PrefetchSchedule = /* @__PURE__ */ __name((output, context) => {
     Consumption: /* @__PURE__ */ __name((_) => de_PrefetchConsumption(_, context), "Consumption"),
     Name: import_smithy_client.expectString,
     PlaybackConfigurationName: import_smithy_client.expectString,
+    RecurringPrefetchConfiguration: /* @__PURE__ */ __name((_) => de_RecurringPrefetchConfiguration(_, context), "RecurringPrefetchConfiguration"),
     Retrieval: /* @__PURE__ */ __name((_) => de_PrefetchRetrieval(_, context), "Retrieval"),
+    ScheduleType: import_smithy_client.expectString,
     StreamId: import_smithy_client.expectString
   });
 }, "de_PrefetchSchedule");
+var de_RecurringPrefetchConfiguration = /* @__PURE__ */ __name((output, context) => {
+  return (0, import_smithy_client.take)(output, {
+    EndTime: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "EndTime"),
+    RecurringConsumption: import_smithy_client._json,
+    RecurringRetrieval: import_smithy_client._json,
+    StartTime: /* @__PURE__ */ __name((_) => (0, import_smithy_client.expectNonNull)((0, import_smithy_client.parseEpochTimestamp)((0, import_smithy_client.expectNumber)(_))), "StartTime")
+  });
+}, "de_RecurringPrefetchConfiguration");
 var de_ScheduleAdBreak = /* @__PURE__ */ __name((output, context) => {
   return (0, import_smithy_client.take)(output, {
     ApproximateDurationSeconds: import_smithy_client.expectLong,
@@ -2879,12 +2923,15 @@ var paginateListVodSources = (0, import_core.createPaginator)(MediaTailorClient,
   OriginManifestType,
   InsertionMode,
   ManifestServiceExcludeEventType,
+  TrafficShapingType,
+  PrefetchScheduleType,
   ScheduleEntryType,
   AccessType,
   BadRequestException,
   PlaybackMode,
   Tier,
   ChannelState,
-  RelativePosition
+  RelativePosition,
+  ListPrefetchScheduleType
 });
 

package/dist-es/models/models_0.js

@@ -127,6 +127,13 @@ export const ManifestServiceExcludeEventType = {
     UNKNOWN_HOST: "UNKNOWN_HOST",
     UNSUPPORTED_SINGLE_PERIOD_DASH_MANIFEST: "UNSUPPORTED_SINGLE_PERIOD_DASH_MANIFEST",
 };
+export const TrafficShapingType = {
+    RETRIEVAL_WINDOW: "RETRIEVAL_WINDOW",
+};
+export const PrefetchScheduleType = {
+    RECURRING: "RECURRING",
+    SINGLE: "SINGLE",
+};
 export const ScheduleEntryType = {
     ALTERNATE_MEDIA: "ALTERNATE_MEDIA",
     FILLER_SLATE: "FILLER_SLATE",
@@ -167,3 +174,8 @@ export const RelativePosition = {
     AFTER_PROGRAM: "AFTER_PROGRAM",
     BEFORE_PROGRAM: "BEFORE_PROGRAM",
 };
+export const ListPrefetchScheduleType = {
+    ALL: "ALL",
+    RECURRING: "RECURRING",
+    SINGLE: "SINGLE",
+};

package/dist-es/protocols/Aws_restJson1.js

@@ -81,7 +81,9 @@ export const se_CreatePrefetchScheduleCommand = async (input, context) => {
     let body;
     body = JSON.stringify(take(input, {
         Consumption: (_) => se_PrefetchConsumption(_, context),
+        RecurringPrefetchConfiguration: (_) => se_RecurringPrefetchConfiguration(_, context),
         Retrieval: (_) => se_PrefetchRetrieval(_, context),
+        ScheduleType: [],
         StreamId: [],
     }));
     b.m("POST").h(headers).b(body);
@@ -369,6 +371,7 @@ export const se_ListPrefetchSchedulesCommand = async (input, context) => {
     body = JSON.stringify(take(input, {
         MaxResults: [],
         NextToken: [],
+        ScheduleType: [],
         StreamId: [],
     }));
     b.m("POST").h(headers).b(body);
@@ -666,7 +669,9 @@ export const de_CreatePrefetchScheduleCommand = async (output, context) => {
         Consumption: (_) => de_PrefetchConsumption(_, context),
         Name: __expectString,
         PlaybackConfigurationName: __expectString,
+        RecurringPrefetchConfiguration: (_) => de_RecurringPrefetchConfiguration(_, context),
         Retrieval: (_) => de_PrefetchRetrieval(_, context),
+        ScheduleType: __expectString,
         StreamId: __expectString,
     });
     Object.assign(contents, doc);
@@ -1009,7 +1014,9 @@ export const de_GetPrefetchScheduleCommand = async (output, context) => {
         Consumption: (_) => de_PrefetchConsumption(_, context),
         Name: __expectString,
         PlaybackConfigurationName: __expectString,
+        RecurringPrefetchConfiguration: (_) => de_RecurringPrefetchConfiguration(_, context),
         Retrieval: (_) => de_PrefetchRetrieval(_, context),
+        ScheduleType: __expectString,
         StreamId: __expectString,
     });
     Object.assign(contents, doc);
@@ -1375,6 +1382,16 @@ const se_PrefetchRetrieval = (input, context) => {
         DynamicVariables: _json,
         EndTime: (_) => _.getTime() / 1000,
         StartTime: (_) => _.getTime() / 1000,
+        TrafficShapingRetrievalWindow: _json,
+        TrafficShapingType: [],
+    });
+};
+const se_RecurringPrefetchConfiguration = (input, context) => {
+    return take(input, {
+        EndTime: (_) => _.getTime() / 1000,
+        RecurringConsumption: _json,
+        RecurringRetrieval: _json,
+        StartTime: (_) => _.getTime() / 1000,
     });
 };
 const de___listOfAlert = (output, context) => {
@@ -1523,6 +1540,8 @@ const de_PrefetchRetrieval = (output, context) => {
         DynamicVariables: _json,
         EndTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
         StartTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
+        TrafficShapingRetrievalWindow: _json,
+        TrafficShapingType: __expectString,
     });
 };
 const de_PrefetchSchedule = (output, context) => {
@@ -1531,10 +1550,20 @@ const de_PrefetchSchedule = (output, context) => {
         Consumption: (_) => de_PrefetchConsumption(_, context),
         Name: __expectString,
         PlaybackConfigurationName: __expectString,
+        RecurringPrefetchConfiguration: (_) => de_RecurringPrefetchConfiguration(_, context),
         Retrieval: (_) => de_PrefetchRetrieval(_, context),
+        ScheduleType: __expectString,
         StreamId: __expectString,
     });
 };
+const de_RecurringPrefetchConfiguration = (output, context) => {
+    return take(output, {
+        EndTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
+        RecurringConsumption: _json,
+        RecurringRetrieval: _json,
+        StartTime: (_) => __expectNonNull(__parseEpochTimestamp(__expectNumber(_))),
+    });
+};
 const de_ScheduleAdBreak = (output, context) => {
     return take(output, {
         ApproximateDurationSeconds: __expectLong,

package/dist-types/commands/CreatePrefetchScheduleCommand.d.ts

@@ -53,7 +53,35 @@ declare const CreatePrefetchScheduleCommand_base: {
  *     },
  *     EndTime: new Date("TIMESTAMP"), // required
  *     StartTime: new Date("TIMESTAMP"),
+ *     TrafficShapingType: "RETRIEVAL_WINDOW",
+ *     TrafficShapingRetrievalWindow: { // TrafficShapingRetrievalWindow
+ *       RetrievalWindowDurationSeconds: Number("int"),
+ *     },
+ *   },
+ *   RecurringPrefetchConfiguration: { // RecurringPrefetchConfiguration
+ *     StartTime: new Date("TIMESTAMP"),
+ *     EndTime: new Date("TIMESTAMP"), // required
+ *     RecurringConsumption: { // RecurringConsumption
+ *       RetrievedAdExpirationSeconds: Number("int"),
+ *       AvailMatchingCriteria: [
+ *         {
+ *           DynamicVariable: "STRING_VALUE", // required
+ *           Operator: "EQUALS", // required
+ *         },
+ *       ],
+ *     },
+ *     RecurringRetrieval: { // RecurringRetrieval
+ *       DynamicVariables: {
+ *         "<keys>": "STRING_VALUE",
+ *       },
+ *       DelayAfterAvailEndSeconds: Number("int"),
+ *       TrafficShapingType: "RETRIEVAL_WINDOW",
+ *       TrafficShapingRetrievalWindow: {
+ *         RetrievalWindowDurationSeconds: Number("int"),
+ *       },
+ *     },
  *   },
+ *   ScheduleType: "SINGLE" || "RECURRING",
  *   StreamId: "STRING_VALUE",
  * };
  * const command = new CreatePrefetchScheduleCommand(input);
@@ -78,7 +106,35 @@ declare const CreatePrefetchScheduleCommand_base: {
  * //     },
  * //     EndTime: new Date("TIMESTAMP"), // required
  * //     StartTime: new Date("TIMESTAMP"),
+ * //     TrafficShapingType: "RETRIEVAL_WINDOW",
+ * //     TrafficShapingRetrievalWindow: { // TrafficShapingRetrievalWindow
+ * //       RetrievalWindowDurationSeconds: Number("int"),
+ * //     },
+ * //   },
+ * //   RecurringPrefetchConfiguration: { // RecurringPrefetchConfiguration
+ * //     StartTime: new Date("TIMESTAMP"),
+ * //     EndTime: new Date("TIMESTAMP"), // required
+ * //     RecurringConsumption: { // RecurringConsumption
+ * //       RetrievedAdExpirationSeconds: Number("int"),
+ * //       AvailMatchingCriteria: [
+ * //         {
+ * //           DynamicVariable: "STRING_VALUE", // required
+ * //           Operator: "EQUALS", // required
+ * //         },
+ * //       ],
+ * //     },
+ * //     RecurringRetrieval: { // RecurringRetrieval
+ * //       DynamicVariables: {
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //       DelayAfterAvailEndSeconds: Number("int"),
+ * //       TrafficShapingType: "RETRIEVAL_WINDOW",
+ * //       TrafficShapingRetrievalWindow: {
+ * //         RetrievalWindowDurationSeconds: Number("int"),
+ * //       },
+ * //     },
  * //   },
+ * //   ScheduleType: "SINGLE" || "RECURRING",
  * //   StreamId: "STRING_VALUE",
  * // };
  *

package/dist-types/commands/GetPrefetchScheduleCommand.d.ts

@@ -60,6 +60,34 @@ declare const GetPrefetchScheduleCommand_base: {
  * //     },
  * //     EndTime: new Date("TIMESTAMP"), // required
  * //     StartTime: new Date("TIMESTAMP"),
+ * //     TrafficShapingType: "RETRIEVAL_WINDOW",
+ * //     TrafficShapingRetrievalWindow: { // TrafficShapingRetrievalWindow
+ * //       RetrievalWindowDurationSeconds: Number("int"),
+ * //     },
+ * //   },
+ * //   ScheduleType: "SINGLE" || "RECURRING",
+ * //   RecurringPrefetchConfiguration: { // RecurringPrefetchConfiguration
+ * //     StartTime: new Date("TIMESTAMP"),
+ * //     EndTime: new Date("TIMESTAMP"), // required
+ * //     RecurringConsumption: { // RecurringConsumption
+ * //       RetrievedAdExpirationSeconds: Number("int"),
+ * //       AvailMatchingCriteria: [
+ * //         {
+ * //           DynamicVariable: "STRING_VALUE", // required
+ * //           Operator: "EQUALS", // required
+ * //         },
+ * //       ],
+ * //     },
+ * //     RecurringRetrieval: { // RecurringRetrieval
+ * //       DynamicVariables: {
+ * //         "<keys>": "STRING_VALUE",
+ * //       },
+ * //       DelayAfterAvailEndSeconds: Number("int"),
+ * //       TrafficShapingType: "RETRIEVAL_WINDOW",
+ * //       TrafficShapingRetrievalWindow: {
+ * //         RetrievalWindowDurationSeconds: Number("int"),
+ * //       },
+ * //     },
  * //   },
  * //   StreamId: "STRING_VALUE",
  * // };

package/dist-types/commands/ListPrefetchSchedulesCommand.d.ts

@@ -38,6 +38,7 @@ declare const ListPrefetchSchedulesCommand_base: {
  *   MaxResults: Number("int"),
  *   NextToken: "STRING_VALUE",
  *   PlaybackConfigurationName: "STRING_VALUE", // required
+ *   ScheduleType: "SINGLE" || "RECURRING" || "ALL",
  *   StreamId: "STRING_VALUE",
  * };
  * const command = new ListPrefetchSchedulesCommand(input);
@@ -64,6 +65,34 @@ declare const ListPrefetchSchedulesCommand_base: {
  * //         },
  * //         EndTime: new Date("TIMESTAMP"), // required
  * //         StartTime: new Date("TIMESTAMP"),
+ * //         TrafficShapingType: "RETRIEVAL_WINDOW",
+ * //         TrafficShapingRetrievalWindow: { // TrafficShapingRetrievalWindow
+ * //           RetrievalWindowDurationSeconds: Number("int"),
+ * //         },
+ * //       },
+ * //       ScheduleType: "SINGLE" || "RECURRING",
+ * //       RecurringPrefetchConfiguration: { // RecurringPrefetchConfiguration
+ * //         StartTime: new Date("TIMESTAMP"),
+ * //         EndTime: new Date("TIMESTAMP"), // required
+ * //         RecurringConsumption: { // RecurringConsumption
+ * //           RetrievedAdExpirationSeconds: Number("int"),
+ * //           AvailMatchingCriteria: [
+ * //             {
+ * //               DynamicVariable: "STRING_VALUE", // required
+ * //               Operator: "EQUALS", // required
+ * //             },
+ * //           ],
+ * //         },
+ * //         RecurringRetrieval: { // RecurringRetrieval
+ * //           DynamicVariables: {
+ * //             "<keys>": "STRING_VALUE",
+ * //           },
+ * //           DelayAfterAvailEndSeconds: Number("int"),
+ * //           TrafficShapingType: "RETRIEVAL_WINDOW",
+ * //           TrafficShapingRetrievalWindow: {
+ * //             RetrievalWindowDurationSeconds: Number("int"),
+ * //           },
+ * //         },
  * //       },
  * //       StreamId: "STRING_VALUE",
  * //     },

package/dist-types/models/models_0.d.ts

@@ -828,7 +828,7 @@ export interface LivePreRollConfiguration {
 /**
  * <p>Settings for customizing what events are included in logs for interactions with the ad decision server (ADS).</p>
  *          <p>For more information about ADS logs, inlcuding descriptions of the event types, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/ads-log-format.html">MediaTailor ADS logs description and event types</a>
- *         in Elemental MediaTailor User Guide.</p>
+ *             in Elemental MediaTailor User Guide.</p>
  * @public
  */
 export interface AdsInteractionLog {
@@ -1062,7 +1062,7 @@ export interface PlaybackConfiguration {
     AdConditioningConfiguration?: AdConditioningConfiguration | undefined;
 }
 /**
- * <p>A complex type that contains settings that determine how and when that MediaTailor places prefetched ads into upcoming ad breaks.</p>
+ * <p>For single prefetch, describes how and when that MediaTailor places prefetched ads into upcoming ad breaks.</p>
  * @public
  */
 export interface PrefetchConsumption {
@@ -1082,6 +1082,97 @@ export interface PrefetchConsumption {
      */
     StartTime?: Date | undefined;
 }
+/**
+ * <p>The settings that determine how and when MediaTailor places prefetched ads into upcoming ad breaks for recurring prefetch scedules.</p>
+ * @public
+ */
+export interface RecurringConsumption {
+    /**
+     * <p>The number of seconds that an ad is available for insertion after it was prefetched.</p>
+     * @public
+     */
+    RetrievedAdExpirationSeconds?: number | undefined;
+    /**
+     * <p>The configuration for the dynamic variables that determine which ad breaks that MediaTailor inserts prefetched ads in.</p>
+     * @public
+     */
+    AvailMatchingCriteria?: AvailMatchingCriteria[] | undefined;
+}
+/**
+ * <p>The configuration that tells Elemental MediaTailor how to spread out requests to the ad decision server (ADS). Instead of sending ADS requests for all sessions at the same time, MediaTailor spreads the requests across the amount of time specified in the retrieval window.</p>
+ * @public
+ */
+export interface TrafficShapingRetrievalWindow {
+    /**
+     * <p>The amount of time, in seconds, that MediaTailor spreads prefetch requests to the ADS. </p>
+     * @public
+     */
+    RetrievalWindowDurationSeconds?: number | undefined;
+}
+/**
+ * @public
+ * @enum
+ */
+export declare const TrafficShapingType: {
+    readonly RETRIEVAL_WINDOW: "RETRIEVAL_WINDOW";
+};
+/**
+ * @public
+ */
+export type TrafficShapingType = (typeof TrafficShapingType)[keyof typeof TrafficShapingType];
+/**
+ * <p>With recurring prefetch, MediaTailor automatically prefetches ads for every avail that occurs during the retrieval window. The following
+ *         configurations describe the MediaTailor behavior when prefetching ads for a live event.</p>
+ * @public
+ */
+export interface RecurringRetrieval {
+    /**
+     * <p>The dynamic variables to use for substitution during prefetch requests to the ADS.</p>
+     * @public
+     */
+    DynamicVariables?: Record<string, string> | undefined;
+    /**
+     * <p>The number of seconds that MediaTailor waits after an ad avail before prefetching ads for the next avail. If not set, the default is 0 (no delay).</p>
+     * @public
+     */
+    DelayAfterAvailEndSeconds?: number | undefined;
+    /**
+     * <p>Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.</p>
+     * @public
+     */
+    TrafficShapingType?: TrafficShapingType | undefined;
+    /**
+     * <p>Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.</p>
+     * @public
+     */
+    TrafficShapingRetrievalWindow?: TrafficShapingRetrievalWindow | undefined;
+}
+/**
+ * <p>The configuration that defines how MediaTailor performs recurring prefetch. </p>
+ * @public
+ */
+export interface RecurringPrefetchConfiguration {
+    /**
+     * <p>The start time for the window that MediaTailor prefetches and inserts ads in a live event. </p>
+     * @public
+     */
+    StartTime?: Date | undefined;
+    /**
+     * <p>The end time for the window that MediaTailor prefetches and inserts ads in a live event. </p>
+     * @public
+     */
+    EndTime: Date | undefined;
+    /**
+     * <p>The settings that determine how and when MediaTailor places prefetched ads into upcoming ad breaks for recurring prefetch scedules.</p>
+     * @public
+     */
+    RecurringConsumption: RecurringConsumption | undefined;
+    /**
+     * <p>The configuration for prefetch ad retrieval from the ADS.</p>
+     * @public
+     */
+    RecurringRetrieval: RecurringRetrieval | undefined;
+}
 /**
  * <p>A complex type that contains settings governing when MediaTailor prefetches ads, and which dynamic variables that MediaTailor includes in the request to the ad decision server.</p>
  * @public
@@ -1103,7 +1194,29 @@ export interface PrefetchRetrieval {
      * @public
      */
     StartTime?: Date | undefined;
+    /**
+     * <p>Indicates if this configuration uses a retrieval window for traffic shaping and limiting the number of requests to the ADS at one time.</p>
+     * @public
+     */
+    TrafficShapingType?: TrafficShapingType | undefined;
+    /**
+     * <p>Configuration for spreading ADS traffic across a set window instead of sending ADS requests for all sessions at the same time.</p>
+     * @public
+     */
+    TrafficShapingRetrievalWindow?: TrafficShapingRetrievalWindow | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const PrefetchScheduleType: {
+    readonly RECURRING: "RECURRING";
+    readonly SINGLE: "SINGLE";
+};
+/**
+ * @public
+ */
+export type PrefetchScheduleType = (typeof PrefetchScheduleType)[keyof typeof PrefetchScheduleType];
 /**
  * <p>A prefetch schedule allows you to tell MediaTailor to fetch and prepare certain ads before an ad break happens. For more information about ad prefetching, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html">Using ad prefetching</a> in the <i>MediaTailor User Guide</i>.</p>
  * @public
@@ -1115,10 +1228,10 @@ export interface PrefetchSchedule {
      */
     Arn: string | undefined;
     /**
-     * <p>Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a <i>consumption window</i>. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.</p>
+     * <p>Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks for single prefetch schedules. Ad consumption occurs within a span of time that you define, called a <i>consumption window</i>. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.</p>
      * @public
      */
-    Consumption: PrefetchConsumption | undefined;
+    Consumption?: PrefetchConsumption | undefined;
     /**
      * <p>The name of the prefetch schedule. The name must be unique among all prefetch schedules that are associated with the specified playback configuration.</p>
      * @public
@@ -1133,7 +1246,19 @@ export interface PrefetchSchedule {
      * <p>A complex type that contains settings for prefetch retrieval from the ad decision server (ADS).</p>
      * @public
      */
-    Retrieval: PrefetchRetrieval | undefined;
+    Retrieval?: PrefetchRetrieval | undefined;
+    /**
+     * <p>The frequency that MediaTailor creates prefetch schedules. <code>SINGLE</code> indicates that this schedule applies to one ad break. <code>RECURRING</code> indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.</p>
+     *          <p>For more information about the prefetch types and when you might use each, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html">Prefetching ads in Elemental MediaTailor.</a>
+     *          </p>
+     * @public
+     */
+    ScheduleType?: PrefetchScheduleType | undefined;
+    /**
+     * <p>The settings that determine how and when MediaTailor prefetches ads and inserts them into ad breaks.</p>
+     * @public
+     */
+    RecurringPrefetchConfiguration?: RecurringPrefetchConfiguration | undefined;
     /**
      * <p>An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.</p>
      * @public
@@ -2594,10 +2719,10 @@ export interface CreateLiveSourceResponse {
  */
 export interface CreatePrefetchScheduleRequest {
     /**
-     * <p>The configuration settings for MediaTailor's <i>consumption</i> of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the <i>consumption window</i>. Prefetch schedules automatically expire no earlier than seven days after the end time.</p>
+     * <p>The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the <i>consumption window</i>. Prefetch schedules automatically expire no earlier than seven days after the end time.</p>
      * @public
      */
-    Consumption: PrefetchConsumption | undefined;
+    Consumption?: PrefetchConsumption | undefined;
     /**
      * <p>The name to assign to the schedule request.</p>
      * @public
@@ -2612,7 +2737,19 @@ export interface CreatePrefetchScheduleRequest {
      * <p>The configuration settings for retrieval of prefetched ads from the ad decision server. Only one set of prefetched ads will be retrieved and subsequently consumed for each ad break.</p>
      * @public
      */
-    Retrieval: PrefetchRetrieval | undefined;
+    Retrieval?: PrefetchRetrieval | undefined;
+    /**
+     * <p>The configuration that defines how and when MediaTailor performs ad prefetching in a live event.</p>
+     * @public
+     */
+    RecurringPrefetchConfiguration?: RecurringPrefetchConfiguration | undefined;
+    /**
+     * <p>The frequency that MediaTailor creates prefetch schedules. <code>SINGLE</code> indicates that this schedule applies to one ad break. <code>RECURRING</code> indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.</p>
+     *          <p>For more information about the prefetch types and when you might use each, see <a href="https://docs.aws.amazon.com/mediatailor/latest/ug/prefetching-ads.html">Prefetching ads in Elemental MediaTailor.</a>
+     *          </p>
+     * @public
+     */
+    ScheduleType?: PrefetchScheduleType | undefined;
     /**
      * <p>An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If <code>StreamId</code> is specified, MediaTailor returns all of the prefetch schedules with an exact match on <code>StreamId</code>. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of <code>StreamId</code>.</p>
      * @public
@@ -2629,7 +2766,7 @@ export interface CreatePrefetchScheduleResponse {
      */
     Arn?: string | undefined;
     /**
-     * <p>The configuration settings for MediaTailor's <i>consumption</i> of the prefetched ads from the ad decision server. Each consumption configuration contains an end time and an optional start time that define the <i>consumption window</i>. Prefetch schedules automatically expire no earlier than seven days after the end time.</p>
+     * <p>The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the <i>consumption window</i>. Prefetch schedules automatically expire no earlier than seven days after the end time.</p>
      * @public
      */
     Consumption?: PrefetchConsumption | undefined;
@@ -2648,6 +2785,16 @@ export interface CreatePrefetchScheduleResponse {
      * @public
      */
     Retrieval?: PrefetchRetrieval | undefined;
+    /**
+     * <p>The configuration that defines how MediaTailor performs recurring prefetch. </p>
+     * @public
+     */
+    RecurringPrefetchConfiguration?: RecurringPrefetchConfiguration | undefined;
+    /**
+     * <p>The frequency that MediaTailor creates prefetch schedules. <code>SINGLE</code> indicates that this schedule applies to one ad break. <code>RECURRING</code> indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.</p>
+     * @public
+     */
+    ScheduleType?: PrefetchScheduleType | undefined;
     /**
      * <p>An optional stream identifier that MediaTailor uses to prefetch ads for multiple streams that use the same playback configuration. If <code>StreamId</code> is specified, MediaTailor returns all of the prefetch schedules with an exact match on <code>StreamId</code>. If not specified, MediaTailor returns all of the prefetch schedules for the playback configuration, regardless of <code>StreamId</code>.</p>
      * @public
@@ -3230,7 +3377,7 @@ export interface GetPrefetchScheduleResponse {
      */
     Arn?: string | undefined;
     /**
-     * <p>Consumption settings determine how, and when, MediaTailor places the prefetched ads into ad breaks. Ad consumption occurs within a span of time that you define, called a <i>consumption window</i>. You can designate which ad breaks that MediaTailor fills with prefetch ads by setting avail matching criteria.</p>
+     * <p>The configuration settings for how and when MediaTailor consumes prefetched ads from the ad decision server for single prefetch schedules. Each consumption configuration contains an end time and an optional start time that define the <i>consumption window</i>. Prefetch schedules automatically expire no earlier than seven days after the end time.</p>
      * @public
      */
     Consumption?: PrefetchConsumption | undefined;
@@ -3249,6 +3396,16 @@ export interface GetPrefetchScheduleResponse {
      * @public
      */
     Retrieval?: PrefetchRetrieval | undefined;
+    /**
+     * <p>The frequency that MediaTailor creates prefetch schedules. <code>SINGLE</code> indicates that this schedule applies to one ad break. <code>RECURRING</code> indicates that MediaTailor automatically creates a schedule for each ad avail in a live event.</p>
+     * @public
+     */
+    ScheduleType?: PrefetchScheduleType | undefined;
+    /**
+     * <p>The configuration that defines how and when MediaTailor performs ad prefetching in a live event.</p>
+     * @public
+     */
+    RecurringPrefetchConfiguration?: RecurringPrefetchConfiguration | undefined;
     /**
      * <p>An optional stream identifier that you can specify in order to prefetch for multiple streams that use the same playback configuration.</p>
      * @public
@@ -3355,6 +3512,19 @@ export interface ListPlaybackConfigurationsResponse {
      */
     NextToken?: string | undefined;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const ListPrefetchScheduleType: {
+    readonly ALL: "ALL";
+    readonly RECURRING: "RECURRING";
+    readonly SINGLE: "SINGLE";
+};
+/**
+ * @public
+ */
+export type ListPrefetchScheduleType = (typeof ListPrefetchScheduleType)[keyof typeof ListPrefetchScheduleType];
 /**
  * @public
  */
@@ -3377,6 +3547,12 @@ export interface ListPrefetchSchedulesRequest {
      * @public
      */
     PlaybackConfigurationName: string | undefined;
+    /**
+     * <p>The type of prefetch schedules that you want to list. <code>SINGLE</code> indicates that you want to list the configured single prefetch schedules. <code>RECURRING</code>
+     *             indicates that you want to list the configured recurring prefetch schedules. <code>ALL</code> indicates that you want to list all configured prefetch schedules.</p>
+     * @public
+     */
+    ScheduleType?: ListPrefetchScheduleType | undefined;
     /**
      * <p>An optional filtering parameter whereby MediaTailor filters the prefetch schedules to include only specific streams.</p>
      * @public

package/dist-types/ts3.4/models/models_0.d.ts

@@ -336,17 +336,51 @@ export interface PrefetchConsumption {
   EndTime: Date | undefined;
   StartTime?: Date | undefined;
 }
+export interface RecurringConsumption {
+  RetrievedAdExpirationSeconds?: number | undefined;
+  AvailMatchingCriteria?: AvailMatchingCriteria[] | undefined;
+}
+export interface TrafficShapingRetrievalWindow {
+  RetrievalWindowDurationSeconds?: number | undefined;
+}
+export declare const TrafficShapingType: {
+  readonly RETRIEVAL_WINDOW: "RETRIEVAL_WINDOW";
+};
+export type TrafficShapingType =
+  (typeof TrafficShapingType)[keyof typeof TrafficShapingType];
+export interface RecurringRetrieval {
+  DynamicVariables?: Record<string, string> | undefined;
+  DelayAfterAvailEndSeconds?: number | undefined;
+  TrafficShapingType?: TrafficShapingType | undefined;
+  TrafficShapingRetrievalWindow?: TrafficShapingRetrievalWindow | undefined;
+}
+export interface RecurringPrefetchConfiguration {
+  StartTime?: Date | undefined;
+  EndTime: Date | undefined;
+  RecurringConsumption: RecurringConsumption | undefined;
+  RecurringRetrieval: RecurringRetrieval | undefined;
+}
 export interface PrefetchRetrieval {
   DynamicVariables?: Record<string, string> | undefined;
   EndTime: Date | undefined;
   StartTime?: Date | undefined;
+  TrafficShapingType?: TrafficShapingType | undefined;
+  TrafficShapingRetrievalWindow?: TrafficShapingRetrievalWindow | undefined;
 }
+export declare const PrefetchScheduleType: {
+  readonly RECURRING: "RECURRING";
+  readonly SINGLE: "SINGLE";
+};
+export type PrefetchScheduleType =
+  (typeof PrefetchScheduleType)[keyof typeof PrefetchScheduleType];
 export interface PrefetchSchedule {
   Arn: string | undefined;
-  Consumption: PrefetchConsumption | undefined;
+  Consumption?: PrefetchConsumption | undefined;
   Name: string | undefined;
   PlaybackConfigurationName: string | undefined;
-  Retrieval: PrefetchRetrieval | undefined;
+  Retrieval?: PrefetchRetrieval | undefined;
+  ScheduleType?: PrefetchScheduleType | undefined;
+  RecurringPrefetchConfiguration?: RecurringPrefetchConfiguration | undefined;
   StreamId?: string | undefined;
 }
 export interface ScheduleAdBreak {
@@ -699,10 +733,12 @@ export interface CreateLiveSourceResponse {
   Tags?: Record<string, string> | undefined;
 }
 export interface CreatePrefetchScheduleRequest {
-  Consumption: PrefetchConsumption | undefined;
+  Consumption?: PrefetchConsumption | undefined;
   Name: string | undefined;
   PlaybackConfigurationName: string | undefined;
-  Retrieval: PrefetchRetrieval | undefined;
+  Retrieval?: PrefetchRetrieval | undefined;
+  RecurringPrefetchConfiguration?: RecurringPrefetchConfiguration | undefined;
+  ScheduleType?: PrefetchScheduleType | undefined;
   StreamId?: string | undefined;
 }
 export interface CreatePrefetchScheduleResponse {
@@ -711,6 +747,8 @@ export interface CreatePrefetchScheduleResponse {
   Name?: string | undefined;
   PlaybackConfigurationName?: string | undefined;
   Retrieval?: PrefetchRetrieval | undefined;
+  RecurringPrefetchConfiguration?: RecurringPrefetchConfiguration | undefined;
+  ScheduleType?: PrefetchScheduleType | undefined;
   StreamId?: string | undefined;
 }
 export interface CreateSourceLocationRequest {
@@ -857,6 +895,8 @@ export interface GetPrefetchScheduleResponse {
   Name?: string | undefined;
   PlaybackConfigurationName?: string | undefined;
   Retrieval?: PrefetchRetrieval | undefined;
+  ScheduleType?: PrefetchScheduleType | undefined;
+  RecurringPrefetchConfiguration?: RecurringPrefetchConfiguration | undefined;
   StreamId?: string | undefined;
 }
 export interface ListAlertsRequest {
@@ -885,10 +925,18 @@ export interface ListPlaybackConfigurationsResponse {
   Items?: PlaybackConfiguration[] | undefined;
   NextToken?: string | undefined;
 }
+export declare const ListPrefetchScheduleType: {
+  readonly ALL: "ALL";
+  readonly RECURRING: "RECURRING";
+  readonly SINGLE: "SINGLE";
+};
+export type ListPrefetchScheduleType =
+  (typeof ListPrefetchScheduleType)[keyof typeof ListPrefetchScheduleType];
 export interface ListPrefetchSchedulesRequest {
   MaxResults?: number | undefined;
   NextToken?: string | undefined;
   PlaybackConfigurationName: string | undefined;
+  ScheduleType?: ListPrefetchScheduleType | undefined;
   StreamId?: string | undefined;
 }
 export interface ListPrefetchSchedulesResponse {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-mediatailor",
   "description": "AWS SDK for JavaScript Mediatailor Client for Node.js, Browser and React Native",
-  "version": "3.787.0",
+  "version": "3.796.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-mediatailor",
@@ -20,17 +20,17 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/core": "3.775.0",
-    "@aws-sdk/credential-provider-node": "3.787.0",
+    "@aws-sdk/core": "3.796.0",
+    "@aws-sdk/credential-provider-node": "3.796.0",
     "@aws-sdk/middleware-host-header": "3.775.0",
     "@aws-sdk/middleware-logger": "3.775.0",
     "@aws-sdk/middleware-recursion-detection": "3.775.0",
-    "@aws-sdk/middleware-user-agent": "3.787.0",
+    "@aws-sdk/middleware-user-agent": "3.796.0",
     "@aws-sdk/region-config-resolver": "3.775.0",
     "@aws-sdk/types": "3.775.0",
     "@aws-sdk/util-endpoints": "3.787.0",
     "@aws-sdk/util-user-agent-browser": "3.775.0",
-    "@aws-sdk/util-user-agent-node": "3.787.0",
+    "@aws-sdk/util-user-agent-node": "3.796.0",
     "@smithy/config-resolver": "^4.1.0",
     "@smithy/core": "^3.2.0",
     "@smithy/fetch-http-handler": "^5.0.2",