@aws-sdk/client-ivs 3.342.0 → 3.344.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (14) hide show
  1. package/dist-cjs/models/models_0.js +7 -1
  2. package/dist-cjs/protocols/Aws_restJson1.js +2 -0
  3. package/dist-es/models/models_0.js +6 -0
  4. package/dist-es/protocols/Aws_restJson1.js +2 -0
  5. package/dist-types/commands/BatchGetChannelCommand.d.ts +2 -1
  6. package/dist-types/commands/CreateChannelCommand.d.ts +4 -2
  7. package/dist-types/commands/DeleteChannelCommand.d.ts +2 -1
  8. package/dist-types/commands/GetChannelCommand.d.ts +2 -1
  9. package/dist-types/commands/GetStreamSessionCommand.d.ts +2 -1
  10. package/dist-types/commands/ListChannelsCommand.d.ts +2 -0
  11. package/dist-types/commands/UpdateChannelCommand.d.ts +7 -4
  12. package/dist-types/models/models_0.d.ts +275 -48
  13. package/dist-types/ts3.4/models/models_0.d.ts +13 -0
  14. package/package.json +6 -6
package/dist-cjs/models/models_0.js CHANGED
@@ -1,6 +1,6 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
- exports.PutMetadataRequestFilterSensitiveLog = exports.GetStreamKeyResponseFilterSensitiveLog = exports.CreateStreamKeyResponseFilterSensitiveLog = exports.CreateChannelResponseFilterSensitiveLog = exports.BatchGetStreamKeyResponseFilterSensitiveLog = exports.StreamKeyFilterSensitiveLog = exports.StreamUnavailable = exports.ThrottlingException = exports.StreamState = exports.StreamHealth = exports.ChannelNotBroadcasting = exports.InternalServerException = exports.RecordingConfigurationState = exports.RecordingMode = exports.ConflictException = exports.ValidationException = exports.ServiceQuotaExceededException = exports.ResourceNotFoundException = exports.PendingVerification = exports.ChannelType = exports.ChannelLatencyMode = exports.AccessDeniedException = void 0;
3
+ exports.PutMetadataRequestFilterSensitiveLog = exports.GetStreamKeyResponseFilterSensitiveLog = exports.CreateStreamKeyResponseFilterSensitiveLog = exports.CreateChannelResponseFilterSensitiveLog = exports.BatchGetStreamKeyResponseFilterSensitiveLog = exports.StreamKeyFilterSensitiveLog = exports.StreamUnavailable = exports.ThrottlingException = exports.StreamState = exports.StreamHealth = exports.ChannelNotBroadcasting = exports.InternalServerException = exports.RecordingConfigurationState = exports.RecordingMode = exports.ConflictException = exports.ValidationException = exports.ServiceQuotaExceededException = exports.ResourceNotFoundException = exports.PendingVerification = exports.ChannelType = exports.TranscodePreset = exports.ChannelLatencyMode = exports.AccessDeniedException = void 0;
4
4
  const smithy_client_1 = require("@aws-sdk/smithy-client");
5
5
  const IvsServiceException_1 = require("./IvsServiceException");
6
6
  class AccessDeniedException extends IvsServiceException_1.IvsServiceException {
@@ -21,7 +21,13 @@ exports.ChannelLatencyMode = {
21
21
  LowLatency: "LOW",
22
22
  NormalLatency: "NORMAL",
23
23
  };
24
+ exports.TranscodePreset = {
25
+ ConstrainedBandwidthTranscodePreset: "CONSTRAINED_BANDWIDTH_DELIVERY",
26
+ HigherBandwidthTranscodePreset: "HIGHER_BANDWIDTH_DELIVERY",
27
+ };
24
28
  exports.ChannelType = {
29
+ AdvancedHDChannelType: "ADVANCED_HD",
30
+ AdvancedSDChannelType: "ADVANCED_SD",
25
31
  BasicChannelType: "BASIC",
26
32
  StandardChannelType: "STANDARD",
27
33
  };
package/dist-cjs/protocols/Aws_restJson1.js CHANGED
@@ -60,6 +60,7 @@ const se_CreateChannelCommand = async (input, context) => {
60
60
  insecureIngest: [],
61
61
  latencyMode: [],
62
62
  name: [],
63
+ preset: [],
63
64
  recordingConfigurationArn: [],
64
65
  tags: (_) => (0, smithy_client_1._json)(_),
65
66
  type: [],
@@ -612,6 +613,7 @@ const se_UpdateChannelCommand = async (input, context) => {
612
613
  insecureIngest: [],
613
614
  latencyMode: [],
614
615
  name: [],
616
+ preset: [],
615
617
  recordingConfigurationArn: [],
616
618
  type: [],
617
619
  }));
package/dist-es/models/models_0.js CHANGED
@@ -17,7 +17,13 @@ export const ChannelLatencyMode = {
17
17
  LowLatency: "LOW",
18
18
  NormalLatency: "NORMAL",
19
19
  };
20
+ export const TranscodePreset = {
21
+ ConstrainedBandwidthTranscodePreset: "CONSTRAINED_BANDWIDTH_DELIVERY",
22
+ HigherBandwidthTranscodePreset: "HIGHER_BANDWIDTH_DELIVERY",
23
+ };
20
24
  export const ChannelType = {
25
+ AdvancedHDChannelType: "ADVANCED_HD",
26
+ AdvancedSDChannelType: "ADVANCED_SD",
21
27
  BasicChannelType: "BASIC",
22
28
  StandardChannelType: "STANDARD",
23
29
  };
package/dist-es/protocols/Aws_restJson1.js CHANGED
@@ -54,6 +54,7 @@ export const se_CreateChannelCommand = async (input, context) => {
54
54
  insecureIngest: [],
55
55
  latencyMode: [],
56
56
  name: [],
57
+ preset: [],
57
58
  recordingConfigurationArn: [],
58
59
  tags: (_) => _json(_),
59
60
  type: [],
@@ -581,6 +582,7 @@ export const se_UpdateChannelCommand = async (input, context) => {
581
582
  insecureIngest: [],
582
583
  latencyMode: [],
583
584
  name: [],
585
+ preset: [],
584
586
  recordingConfigurationArn: [],
585
587
  type: [],
586
588
  }));
package/dist-types/commands/BatchGetChannelCommand.d.ts CHANGED
@@ -43,7 +43,7 @@ export interface BatchGetChannelCommandOutput extends BatchGetChannelResponse, _
43
43
  * // arn: "STRING_VALUE",
44
44
  * // name: "STRING_VALUE",
45
45
  * // latencyMode: "STRING_VALUE",
46
- * // type: "BASIC" || "STANDARD",
46
+ * // type: "BASIC" || "STANDARD" || "ADVANCED_SD" || "ADVANCED_HD",
47
47
  * // recordingConfigurationArn: "STRING_VALUE",
48
48
  * // ingestEndpoint: "STRING_VALUE",
49
49
  * // playbackUrl: "STRING_VALUE",
@@ -52,6 +52,7 @@ export interface BatchGetChannelCommandOutput extends BatchGetChannelResponse, _
52
52
  * // "<keys>": "STRING_VALUE",
53
53
  * // },
54
54
  * // insecureIngest: true || false,
55
+ * // preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
55
56
  * // },
56
57
  * // ],
57
58
  * // errors: [ // BatchErrors
package/dist-types/commands/CreateChannelCommand.d.ts CHANGED
@@ -33,13 +33,14 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
33
33
  * const input = { // CreateChannelRequest
34
34
  * name: "STRING_VALUE",
35
35
  * latencyMode: "STRING_VALUE",
36
- * type: "BASIC" || "STANDARD",
36
+ * type: "BASIC" || "STANDARD" || "ADVANCED_SD" || "ADVANCED_HD",
37
37
  * authorized: true || false,
38
38
  * recordingConfigurationArn: "STRING_VALUE",
39
39
  * tags: { // Tags
40
40
  * "<keys>": "STRING_VALUE",
41
41
  * },
42
42
  * insecureIngest: true || false,
43
+ * preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
43
44
  * };
44
45
  * const command = new CreateChannelCommand(input);
45
46
  * const response = await client.send(command);
@@ -48,7 +49,7 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
48
49
  * // arn: "STRING_VALUE",
49
50
  * // name: "STRING_VALUE",
50
51
  * // latencyMode: "STRING_VALUE",
51
- * // type: "BASIC" || "STANDARD",
52
+ * // type: "BASIC" || "STANDARD" || "ADVANCED_SD" || "ADVANCED_HD",
52
53
  * // recordingConfigurationArn: "STRING_VALUE",
53
54
  * // ingestEndpoint: "STRING_VALUE",
54
55
  * // playbackUrl: "STRING_VALUE",
@@ -57,6 +58,7 @@ export interface CreateChannelCommandOutput extends CreateChannelResponse, __Met
57
58
  * // "<keys>": "STRING_VALUE",
58
59
  * // },
59
60
  * // insecureIngest: true || false,
61
+ * // preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
60
62
  * // },
61
63
  * // streamKey: { // StreamKey
62
64
  * // arn: "STRING_VALUE",
package/dist-types/commands/DeleteChannelCommand.d.ts CHANGED
@@ -27,7 +27,8 @@ export interface DeleteChannelCommandOutput extends __MetadataBearer {
27
27
  * <p>If you try to delete a live channel, you will get an error (409 ConflictException). To
28
28
  * delete a channel that is live, call <a>StopStream</a>, wait for the Amazon
29
29
  * EventBridge "Stream End" event (to verify that the stream's state is no longer Live), then
30
- * call DeleteChannel. (See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html"> Using EventBridge with Amazon IVS</a>.) </p>
30
+ * call DeleteChannel. (See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html"> Using EventBridge with Amazon IVS</a>.)
31
+ * </p>
31
32
  * @example
32
33
  * Use a bare-bones client and the command you need to make an API call.
33
34
  * ```javascript
package/dist-types/commands/GetChannelCommand.d.ts CHANGED
@@ -40,7 +40,7 @@ export interface GetChannelCommandOutput extends GetChannelResponse, __MetadataB
40
40
  * // arn: "STRING_VALUE",
41
41
  * // name: "STRING_VALUE",
42
42
  * // latencyMode: "STRING_VALUE",
43
- * // type: "BASIC" || "STANDARD",
43
+ * // type: "BASIC" || "STANDARD" || "ADVANCED_SD" || "ADVANCED_HD",
44
44
  * // recordingConfigurationArn: "STRING_VALUE",
45
45
  * // ingestEndpoint: "STRING_VALUE",
46
46
  * // playbackUrl: "STRING_VALUE",
@@ -49,6 +49,7 @@ export interface GetChannelCommandOutput extends GetChannelResponse, __MetadataB
49
49
  * // "<keys>": "STRING_VALUE",
50
50
  * // },
51
51
  * // insecureIngest: true || false,
52
+ * // preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
52
53
  * // },
53
54
  * // };
54
55
  *
package/dist-types/commands/GetStreamSessionCommand.d.ts CHANGED
@@ -45,7 +45,7 @@ export interface GetStreamSessionCommandOutput extends GetStreamSessionResponse,
45
45
  * // arn: "STRING_VALUE",
46
46
  * // name: "STRING_VALUE",
47
47
  * // latencyMode: "STRING_VALUE",
48
- * // type: "BASIC" || "STANDARD",
48
+ * // type: "BASIC" || "STANDARD" || "ADVANCED_SD" || "ADVANCED_HD",
49
49
  * // recordingConfigurationArn: "STRING_VALUE",
50
50
  * // ingestEndpoint: "STRING_VALUE",
51
51
  * // playbackUrl: "STRING_VALUE",
@@ -54,6 +54,7 @@ export interface GetStreamSessionCommandOutput extends GetStreamSessionResponse,
54
54
  * // "<keys>": "STRING_VALUE",
55
55
  * // },
56
56
  * // insecureIngest: true || false,
57
+ * // preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
57
58
  * // },
58
59
  * // ingestConfiguration: { // IngestConfiguration
59
60
  * // video: { // VideoConfiguration
package/dist-types/commands/ListChannelsCommand.d.ts CHANGED
@@ -53,6 +53,8 @@ export interface ListChannelsCommandOutput extends ListChannelsResponse, __Metad
53
53
  * // "<keys>": "STRING_VALUE",
54
54
  * // },
55
55
  * // insecureIngest: true || false,
56
+ * // type: "BASIC" || "STANDARD" || "ADVANCED_SD" || "ADVANCED_HD",
57
+ * // preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
56
58
  * // },
57
59
  * // ],
58
60
  * // nextToken: "STRING_VALUE",
package/dist-types/commands/UpdateChannelCommand.d.ts CHANGED
@@ -23,8 +23,9 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met
23
23
  }
24
24
  /**
25
25
  * @public
26
- * <p>Updates a channel's configuration. This does not affect an ongoing stream of this channel.
27
- * You must stop and restart the stream for the changes to take effect.</p>
26
+ * <p>Updates a channel's configuration. Live channels cannot be updated. You must stop the
27
+ * ongoing stream, update the channel, and restart the stream for the changes to take
28
+ * effect.</p>
28
29
  * @example
29
30
  * Use a bare-bones client and the command you need to make an API call.
30
31
  * ```javascript
@@ -35,10 +36,11 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met
35
36
  * arn: "STRING_VALUE", // required
36
37
  * name: "STRING_VALUE",
37
38
  * latencyMode: "STRING_VALUE",
38
- * type: "BASIC" || "STANDARD",
39
+ * type: "BASIC" || "STANDARD" || "ADVANCED_SD" || "ADVANCED_HD",
39
40
  * authorized: true || false,
40
41
  * recordingConfigurationArn: "STRING_VALUE",
41
42
  * insecureIngest: true || false,
43
+ * preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
42
44
  * };
43
45
  * const command = new UpdateChannelCommand(input);
44
46
  * const response = await client.send(command);
@@ -47,7 +49,7 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met
47
49
  * // arn: "STRING_VALUE",
48
50
  * // name: "STRING_VALUE",
49
51
  * // latencyMode: "STRING_VALUE",
50
- * // type: "BASIC" || "STANDARD",
52
+ * // type: "BASIC" || "STANDARD" || "ADVANCED_SD" || "ADVANCED_HD",
51
53
  * // recordingConfigurationArn: "STRING_VALUE",
52
54
  * // ingestEndpoint: "STRING_VALUE",
53
55
  * // playbackUrl: "STRING_VALUE",
@@ -56,6 +58,7 @@ export interface UpdateChannelCommandOutput extends UpdateChannelResponse, __Met
56
58
  * // "<keys>": "STRING_VALUE",
57
59
  * // },
58
60
  * // insecureIngest: true || false,
61
+ * // preset: "HIGHER_BANDWIDTH_DELIVERY" || "CONSTRAINED_BANDWIDTH_DELIVERY",
59
62
  * // },
60
63
  * // };
61
64
  *
package/dist-types/models/models_0.d.ts CHANGED
@@ -37,11 +37,25 @@ export declare const ChannelLatencyMode: {
37
37
  * @public
38
38
  */
39
39
  export type ChannelLatencyMode = (typeof ChannelLatencyMode)[keyof typeof ChannelLatencyMode];
40
+ /**
41
+ * @public
42
+ * @enum
43
+ */
44
+ export declare const TranscodePreset: {
45
+ readonly ConstrainedBandwidthTranscodePreset: "CONSTRAINED_BANDWIDTH_DELIVERY";
46
+ readonly HigherBandwidthTranscodePreset: "HIGHER_BANDWIDTH_DELIVERY";
47
+ };
48
+ /**
49
+ * @public
50
+ */
51
+ export type TranscodePreset = (typeof TranscodePreset)[keyof typeof TranscodePreset];
40
52
  /**
41
53
  * @public
42
54
  * @enum
43
55
  */
44
56
  export declare const ChannelType: {
57
+ readonly AdvancedHDChannelType: "ADVANCED_HD";
58
+ readonly AdvancedSDChannelType: "ADVANCED_SD";
45
59
  readonly BasicChannelType: "BASIC";
46
60
  readonly StandardChannelType: "STANDARD";
47
61
  };
@@ -71,24 +85,63 @@ export interface Channel {
71
85
  latencyMode?: ChannelLatencyMode | string;
72
86
  /**
73
87
  * <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
74
- * exceed the allowable resolution or bitrate, the stream probably will disconnect
75
- * immediately.</i> Default: <code>STANDARD</code>. Valid values:</p>
88
+ * exceed the allowable input resolution or bitrate, the stream probably will disconnect
89
+ * immediately.</i> Some types generate multiple qualities (renditions) from the
90
+ * original input; this automatically gives viewers the best experience for their devices and
91
+ * network conditions. Some types provide transcoded video; transcoding allows higher playback
92
+ * quality across a range of download speeds. Default: <code>STANDARD</code>. Valid
93
+ * values:</p>
76
94
  * <ul>
77
95
  * <li>
78
96
  * <p>
97
+ * <code>BASIC</code>: Video is transmuxed: Amazon IVS delivers the original input
98
+ * quality to viewers. The viewer’s video-quality choice is limited to the original input.
99
+ * Input resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to
100
+ * 3.5 Mbps for resolutions between 480p and 1080p. Original audio is passed through.</p>
101
+ * </li>
102
+ * <li>
103
+ * <p>
79
104
  * <code>STANDARD</code>: Video is transcoded: multiple qualities are generated from the
80
105
  * original input, to automatically give viewers the best experience for their devices and
81
106
  * network conditions. Transcoding allows higher playback quality across a range of download
82
107
  * speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is
83
108
  * transcoded only for renditions 360p and below; above that, audio is passed through. This
84
- * is the default.</p>
109
+ * is the default when you create a channel.</p>
85
110
  * </li>
86
111
  * <li>
87
112
  * <p>
88
- * <code>BASIC</code>: Video is transmuxed: Amazon IVS delivers the original input to
89
- * viewers. The viewer’s video-quality choice is limited to the original input. Resolution
90
- * can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for
91
- * resolutions between 480p and 1080p.</p>
113
+ * <code>ADVANCED_SD</code>: Video is transcoded; multiple qualities are generated from
114
+ * the original input, to automatically give viewers the best experience for their devices
115
+ * and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5
116
+ * Mbps; output is capped at SD quality (480p). You can select an optional transcode preset
117
+ * (see below). Audio for all renditions is transcoded, and an audio-only rendition is
118
+ * available.</p>
119
+ * </li>
120
+ * <li>
121
+ * <p>
122
+ * <code>ADVANCED_HD</code>: Video is transcoded; multiple qualities are generated from
123
+ * the original input, to automatically give viewers the best experience for their devices
124
+ * and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5
125
+ * Mbps; output is capped at HD quality (720p). You can select an optional transcode preset
126
+ * (see below). Audio for all renditions is transcoded, and an audio-only rendition is
127
+ * available.</p>
128
+ * </li>
129
+ * </ul>
130
+ * <p>Optional <i>transcode presets</i> (available for the <code>ADVANCED</code>
131
+ * types) allow you to trade off available download bandwidth and video quality, to optimize the
132
+ * viewing experience. There are two presets:</p>
133
+ * <ul>
134
+ * <li>
135
+ * <p>
136
+ * <i>Constrained bandwidth delivery</i> uses a lower bitrate for each
137
+ * quality level. Use it if you have low download bandwidth and/or simple video content
138
+ * (e.g., talking heads)</p>
139
+ * </li>
140
+ * <li>
141
+ * <p>
142
+ * <i>Higher bandwidth delivery</i> uses a higher bitrate for each quality
143
+ * level. Use it if you have high download bandwidth and/or complex video content (e.g.,
144
+ * flashes and quick scene changes).</p>
92
145
  * </li>
93
146
  * </ul>
94
147
  */
@@ -123,6 +176,14 @@ export interface Channel {
123
176
  * <p>Whether the channel allows insecure RTMP ingest. Default: <code>false</code>.</p>
124
177
  */
125
178
  insecureIngest?: boolean;
179
+ /**
180
+ * <p>Optional transcode preset for the channel. This is selectable only for
181
+ * <code>ADVANCED_HD</code> and <code>ADVANCED_SD</code> channel types. For those channel
182
+ * types, the default <code>preset</code> is <code>HIGHER_BANDWIDTH_DELIVERY</code>. For other
183
+ * channel types (<code>BASIC</code> and <code>STANDARD</code>), <code>preset</code> is the empty
184
+ * string (<code>""</code>).</p>
185
+ */
186
+ preset?: TranscodePreset | string;
126
187
  }
127
188
  /**
128
189
  * @public
@@ -219,24 +280,63 @@ export interface CreateChannelRequest {
219
280
  latencyMode?: ChannelLatencyMode | string;
220
281
  /**
221
282
  * <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
222
- * exceed the allowable resolution or bitrate, the stream probably will disconnect
223
- * immediately.</i> Default: <code>STANDARD</code>. Valid values:</p>
283
+ * exceed the allowable input resolution or bitrate, the stream probably will disconnect
284
+ * immediately.</i> Some types generate multiple qualities (renditions) from the
285
+ * original input; this automatically gives viewers the best experience for their devices and
286
+ * network conditions. Some types provide transcoded video; transcoding allows higher playback
287
+ * quality across a range of download speeds. Default: <code>STANDARD</code>. Valid
288
+ * values:</p>
224
289
  * <ul>
225
290
  * <li>
226
291
  * <p>
292
+ * <code>BASIC</code>: Video is transmuxed: Amazon IVS delivers the original input
293
+ * quality to viewers. The viewer’s video-quality choice is limited to the original input.
294
+ * Input resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to
295
+ * 3.5 Mbps for resolutions between 480p and 1080p. Original audio is passed through.</p>
296
+ * </li>
297
+ * <li>
298
+ * <p>
227
299
  * <code>STANDARD</code>: Video is transcoded: multiple qualities are generated from the
228
300
  * original input, to automatically give viewers the best experience for their devices and
229
301
  * network conditions. Transcoding allows higher playback quality across a range of download
230
302
  * speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is
231
303
  * transcoded only for renditions 360p and below; above that, audio is passed through. This
232
- * is the default.</p>
304
+ * is the default when you create a channel.</p>
305
+ * </li>
306
+ * <li>
307
+ * <p>
308
+ * <code>ADVANCED_SD</code>: Video is transcoded; multiple qualities are generated from
309
+ * the original input, to automatically give viewers the best experience for their devices
310
+ * and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5
311
+ * Mbps; output is capped at SD quality (480p). You can select an optional transcode preset
312
+ * (see below). Audio for all renditions is transcoded, and an audio-only rendition is
313
+ * available.</p>
314
+ * </li>
315
+ * <li>
316
+ * <p>
317
+ * <code>ADVANCED_HD</code>: Video is transcoded; multiple qualities are generated from
318
+ * the original input, to automatically give viewers the best experience for their devices
319
+ * and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5
320
+ * Mbps; output is capped at HD quality (720p). You can select an optional transcode preset
321
+ * (see below). Audio for all renditions is transcoded, and an audio-only rendition is
322
+ * available.</p>
323
+ * </li>
324
+ * </ul>
325
+ * <p>Optional <i>transcode presets</i> (available for the <code>ADVANCED</code>
326
+ * types) allow you to trade off available download bandwidth and video quality, to optimize the
327
+ * viewing experience. There are two presets:</p>
328
+ * <ul>
329
+ * <li>
330
+ * <p>
331
+ * <i>Constrained bandwidth delivery</i> uses a lower bitrate for each
332
+ * quality level. Use it if you have low download bandwidth and/or simple video content
333
+ * (e.g., talking heads)</p>
233
334
  * </li>
234
335
  * <li>
235
336
  * <p>
236
- * <code>BASIC</code>: Video is transmuxed: Amazon IVS delivers the original input to
237
- * viewers. The viewer’s video-quality choice is limited to the original input. Resolution
238
- * can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for
239
- * resolutions between 480p and 1080p.</p>
337
+ * <i>Higher bandwidth delivery</i> uses a higher bitrate for each quality
338
+ * level. Use it if you have high download bandwidth and/or complex video content (e.g.,
339
+ * flashes and quick scene changes).</p>
240
340
  * </li>
241
341
  * </ul>
242
342
  */
@@ -251,16 +351,24 @@ export interface CreateChannelRequest {
251
351
  */
252
352
  recordingConfigurationArn?: string;
253
353
  /**
254
- * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for
255
- * more information, including restrictions that apply to tags and "Tag naming limits and
256
- * requirements"; Amazon IVS has no service-specific constraints beyond what is documented
257
- * there.</p>
354
+ * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
355
+ * Resources</a> for more information, including restrictions that apply to tags and "Tag
356
+ * naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is
357
+ * documented there.</p>
258
358
  */
259
359
  tags?: Record<string, string>;
260
360
  /**
261
361
  * <p>Whether the channel allows insecure RTMP ingest. Default: <code>false</code>.</p>
262
362
  */
263
363
  insecureIngest?: boolean;
364
+ /**
365
+ * <p>Optional transcode preset for the channel. This is selectable only for
366
+ * <code>ADVANCED_HD</code> and <code>ADVANCED_SD</code> channel types. For those channel
367
+ * types, the default <code>preset</code> is <code>HIGHER_BANDWIDTH_DELIVERY</code>. For other
368
+ * channel types (<code>BASIC</code> and <code>STANDARD</code>), <code>preset</code> is the empty
369
+ * string (<code>""</code>).</p>
370
+ */
371
+ preset?: TranscodePreset | string;
264
372
  }
265
373
  /**
266
374
  * @public
@@ -426,10 +534,10 @@ export interface CreateRecordingConfigurationRequest {
426
534
  */
427
535
  destinationConfiguration: DestinationConfiguration | undefined;
428
536
  /**
429
- * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for
430
- * more information, including restrictions that apply to tags and "Tag naming limits and
431
- * requirements"; Amazon IVS has no service-specific constraints beyond what is documented
432
- * there.</p>
537
+ * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
538
+ * Resources</a> for more information, including restrictions that apply to tags and "Tag
539
+ * naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is
540
+ * documented there.</p>
433
541
  */
434
542
  tags?: Record<string, string>;
435
543
  /**
@@ -530,10 +638,10 @@ export interface CreateStreamKeyRequest {
530
638
  */
531
639
  channelArn: string | undefined;
532
640
  /**
533
- * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for
534
- * more information, including restrictions that apply to tags and "Tag naming limits and
535
- * requirements"; Amazon IVS has no service-specific constraints beyond what is documented
536
- * there.</p>
641
+ * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
642
+ * Resources</a> for more information, including restrictions that apply to tags and "Tag
643
+ * naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is
644
+ * documented there.</p>
537
645
  */
538
646
  tags?: Record<string, string>;
539
647
  }
@@ -961,10 +1069,10 @@ export interface ImportPlaybackKeyPairRequest {
961
1069
  */
962
1070
  name?: string;
963
1071
  /**
964
- * <p>Any tags provided with the request are added to the playback key pair tags. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for
965
- * more information, including restrictions that apply to tags and "Tag naming limits and
966
- * requirements"; Amazon IVS has no service-specific constraints beyond what is documented
967
- * there.</p>
1072
+ * <p>Any tags provided with the request are added to the playback key pair tags. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
1073
+ * Resources</a> for more information, including restrictions that apply to tags and "Tag
1074
+ * naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is
1075
+ * documented there.</p>
968
1076
  */
969
1077
  tags?: Record<string, string>;
970
1078
  }
@@ -1040,6 +1148,77 @@ export interface ChannelSummary {
1040
1148
  * <p>Whether the channel allows insecure RTMP ingest. Default: <code>false</code>.</p>
1041
1149
  */
1042
1150
  insecureIngest?: boolean;
1151
+ /**
1152
+ * <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
1153
+ * exceed the allowable input resolution or bitrate, the stream probably will disconnect
1154
+ * immediately.</i> Some types generate multiple qualities (renditions) from the
1155
+ * original input; this automatically gives viewers the best experience for their devices and
1156
+ * network conditions. Some types provide transcoded video; transcoding allows higher playback
1157
+ * quality across a range of download speeds. Default: <code>STANDARD</code>. Valid
1158
+ * values:</p>
1159
+ * <ul>
1160
+ * <li>
1161
+ * <p>
1162
+ * <code>BASIC</code>: Video is transmuxed: Amazon IVS delivers the original input
1163
+ * quality to viewers. The viewer’s video-quality choice is limited to the original input.
1164
+ * Input resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to
1165
+ * 3.5 Mbps for resolutions between 480p and 1080p. Original audio is passed through.</p>
1166
+ * </li>
1167
+ * <li>
1168
+ * <p>
1169
+ * <code>STANDARD</code>: Video is transcoded: multiple qualities are generated from the
1170
+ * original input, to automatically give viewers the best experience for their devices and
1171
+ * network conditions. Transcoding allows higher playback quality across a range of download
1172
+ * speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is
1173
+ * transcoded only for renditions 360p and below; above that, audio is passed through. This
1174
+ * is the default when you create a channel.</p>
1175
+ * </li>
1176
+ * <li>
1177
+ * <p>
1178
+ * <code>ADVANCED_SD</code>: Video is transcoded; multiple qualities are generated from
1179
+ * the original input, to automatically give viewers the best experience for their devices
1180
+ * and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5
1181
+ * Mbps; output is capped at SD quality (480p). You can select an optional transcode preset
1182
+ * (see below). Audio for all renditions is transcoded, and an audio-only rendition is
1183
+ * available.</p>
1184
+ * </li>
1185
+ * <li>
1186
+ * <p>
1187
+ * <code>ADVANCED_HD</code>: Video is transcoded; multiple qualities are generated from
1188
+ * the original input, to automatically give viewers the best experience for their devices
1189
+ * and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5
1190
+ * Mbps; output is capped at HD quality (720p). You can select an optional transcode preset
1191
+ * (see below). Audio for all renditions is transcoded, and an audio-only rendition is
1192
+ * available.</p>
1193
+ * </li>
1194
+ * </ul>
1195
+ * <p>Optional <i>transcode presets</i> (available for the <code>ADVANCED</code>
1196
+ * types) allow you to trade off available download bandwidth and video quality, to optimize the
1197
+ * viewing experience. There are two presets:</p>
1198
+ * <ul>
1199
+ * <li>
1200
+ * <p>
1201
+ * <i>Constrained bandwidth delivery</i> uses a lower bitrate for each
1202
+ * quality level. Use it if you have low download bandwidth and/or simple video content
1203
+ * (e.g., talking heads)</p>
1204
+ * </li>
1205
+ * <li>
1206
+ * <p>
1207
+ * <i>Higher bandwidth delivery</i> uses a higher bitrate for each quality
1208
+ * level. Use it if you have high download bandwidth and/or complex video content (e.g.,
1209
+ * flashes and quick scene changes).</p>
1210
+ * </li>
1211
+ * </ul>
1212
+ */
1213
+ type?: ChannelType | string;
1214
+ /**
1215
+ * <p>Optional transcode preset for the channel. This is selectable only for
1216
+ * <code>ADVANCED_HD</code> and <code>ADVANCED_SD</code> channel types. For those channel
1217
+ * types, the default <code>preset</code> is <code>HIGHER_BANDWIDTH_DELIVERY</code>. For other
1218
+ * channel types (<code>BASIC</code> and <code>STANDARD</code>), <code>preset</code> is the empty
1219
+ * string (<code>""</code>).</p>
1220
+ */
1221
+ preset?: TranscodePreset | string;
1043
1222
  }
1044
1223
  /**
1045
1224
  * @public
@@ -1259,8 +1438,9 @@ export interface StreamSummary {
1259
1438
  */
1260
1439
  streamId?: string;
1261
1440
  /**
1262
- * <p>The stream’s state. Do not rely on the <code>OFFLINE</code> state, as the API may not return it;
1263
- * instead, a "NotBroadcasting" error will indicate that the stream is not live.</p>
1441
+ * <p>The stream’s state. Do not rely on the <code>OFFLINE</code> state, as the API may not
1442
+ * return it; instead, a "NotBroadcasting" error will indicate that the stream is not
1443
+ * live.</p>
1264
1444
  */
1265
1445
  state?: StreamState | string;
1266
1446
  /**
@@ -1364,7 +1544,8 @@ export interface ListTagsForResourceRequest {
1364
1544
  */
1365
1545
  export interface ListTagsForResourceResponse {
1366
1546
  /**
1367
- * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>.</p>
1547
+ * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
1548
+ * (key:value)</code>.</p>
1368
1549
  */
1369
1550
  tags: Record<string, string> | undefined;
1370
1551
  }
@@ -1438,10 +1619,10 @@ export interface TagResourceRequest {
1438
1619
  */
1439
1620
  resourceArn: string | undefined;
1440
1621
  /**
1441
- * <p>Array of tags to be added or updated. Array of maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for
1442
- * more information, including restrictions that apply to tags and "Tag naming limits and
1443
- * requirements"; Amazon IVS has no service-specific constraints beyond what is documented
1444
- * there.</p>
1622
+ * <p>Array of tags to be added or updated. Array of maps, each of the form <code>string:string
1623
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions
1624
+ * that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
1625
+ * service-specific constraints beyond what is documented there.</p>
1445
1626
  */
1446
1627
  tags: Record<string, string> | undefined;
1447
1628
  }
@@ -1459,10 +1640,10 @@ export interface UntagResourceRequest {
1459
1640
  */
1460
1641
  resourceArn: string | undefined;
1461
1642
  /**
1462
- * <p>Array of tags to be removed. Array of maps, each of the form s<code>tring:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for
1463
- * more information, including restrictions that apply to tags and "Tag naming limits and
1464
- * requirements"; Amazon IVS has no service-specific constraints beyond what is documented
1465
- * there.</p>
1643
+ * <p>Array of tags to be removed. Array of maps, each of the form s<code>tring:string
1644
+ * (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions
1645
+ * that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
1646
+ * service-specific constraints beyond what is documented there.</p>
1466
1647
  */
1467
1648
  tagKeys: string[] | undefined;
1468
1649
  }
@@ -1492,24 +1673,63 @@ export interface UpdateChannelRequest {
1492
1673
  latencyMode?: ChannelLatencyMode | string;
1493
1674
  /**
1494
1675
  * <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
1495
- * exceed the allowable resolution or bitrate, the stream probably will disconnect
1496
- * immediately</i>. Valid values:</p>
1676
+ * exceed the allowable input resolution or bitrate, the stream probably will disconnect
1677
+ * immediately.</i> Some types generate multiple qualities (renditions) from the
1678
+ * original input; this automatically gives viewers the best experience for their devices and
1679
+ * network conditions. Some types provide transcoded video; transcoding allows higher playback
1680
+ * quality across a range of download speeds. Default: <code>STANDARD</code>. Valid
1681
+ * values:</p>
1497
1682
  * <ul>
1498
1683
  * <li>
1499
1684
  * <p>
1685
+ * <code>BASIC</code>: Video is transmuxed: Amazon IVS delivers the original input
1686
+ * quality to viewers. The viewer’s video-quality choice is limited to the original input.
1687
+ * Input resolution can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to
1688
+ * 3.5 Mbps for resolutions between 480p and 1080p. Original audio is passed through.</p>
1689
+ * </li>
1690
+ * <li>
1691
+ * <p>
1500
1692
  * <code>STANDARD</code>: Video is transcoded: multiple qualities are generated from the
1501
1693
  * original input, to automatically give viewers the best experience for their devices and
1502
1694
  * network conditions. Transcoding allows higher playback quality across a range of download
1503
1695
  * speeds. Resolution can be up to 1080p and bitrate can be up to 8.5 Mbps. Audio is
1504
1696
  * transcoded only for renditions 360p and below; above that, audio is passed through. This
1505
- * is the default.</p>
1697
+ * is the default when you create a channel.</p>
1698
+ * </li>
1699
+ * <li>
1700
+ * <p>
1701
+ * <code>ADVANCED_SD</code>: Video is transcoded; multiple qualities are generated from
1702
+ * the original input, to automatically give viewers the best experience for their devices
1703
+ * and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5
1704
+ * Mbps; output is capped at SD quality (480p). You can select an optional transcode preset
1705
+ * (see below). Audio for all renditions is transcoded, and an audio-only rendition is
1706
+ * available.</p>
1707
+ * </li>
1708
+ * <li>
1709
+ * <p>
1710
+ * <code>ADVANCED_HD</code>: Video is transcoded; multiple qualities are generated from
1711
+ * the original input, to automatically give viewers the best experience for their devices
1712
+ * and network conditions. Input resolution can be up to 1080p and bitrate can be up to 8.5
1713
+ * Mbps; output is capped at HD quality (720p). You can select an optional transcode preset
1714
+ * (see below). Audio for all renditions is transcoded, and an audio-only rendition is
1715
+ * available.</p>
1716
+ * </li>
1717
+ * </ul>
1718
+ * <p>Optional <i>transcode presets</i> (available for the <code>ADVANCED</code>
1719
+ * types) allow you to trade off available download bandwidth and video quality, to optimize the
1720
+ * viewing experience. There are two presets:</p>
1721
+ * <ul>
1722
+ * <li>
1723
+ * <p>
1724
+ * <i>Constrained bandwidth delivery</i> uses a lower bitrate for each
1725
+ * quality level. Use it if you have low download bandwidth and/or simple video content
1726
+ * (e.g., talking heads)</p>
1506
1727
  * </li>
1507
1728
  * <li>
1508
1729
  * <p>
1509
- * <code>BASIC</code>: Video is transmuxed: Amazon IVS delivers the original input to
1510
- * viewers. The viewer’s video-quality choice is limited to the original input. Resolution
1511
- * can be up to 1080p and bitrate can be up to 1.5 Mbps for 480p and up to 3.5 Mbps for
1512
- * resolutions between 480p and 1080p.</p>
1730
+ * <i>Higher bandwidth delivery</i> uses a higher bitrate for each quality
1731
+ * level. Use it if you have high download bandwidth and/or complex video content (e.g.,
1732
+ * flashes and quick scene changes).</p>
1513
1733
  * </li>
1514
1734
  * </ul>
1515
1735
  */
@@ -1527,6 +1747,13 @@ export interface UpdateChannelRequest {
1527
1747
  * <p>Whether the channel allows insecure RTMP ingest. Default: <code>false</code>.</p>
1528
1748
  */
1529
1749
  insecureIngest?: boolean;
1750
+ /**
1751
+ * <p>Optional transcode preset for the channel. This is selectable only for <code>ADVANCED_HD</code> and
1752
+ * <code>ADVANCED_SD</code> channel types. For those channel types, the default <code>preset</code> is
1753
+ * <code>HIGHER_BANDWIDTH_DELIVERY</code>. For other channel types (<code>BASIC</code> and <code>STANDARD</code>), <code>preset</code> is the empty
1754
+ * string (<code>""</code>).</p>
1755
+ */
1756
+ preset?: TranscodePreset | string;
1530
1757
  }
1531
1758
  /**
1532
1759
  * @public
package/dist-types/ts3.4/models/models_0.d.ts CHANGED
@@ -17,7 +17,15 @@ export declare const ChannelLatencyMode: {
17
17
  };
18
18
  export type ChannelLatencyMode =
19
19
  (typeof ChannelLatencyMode)[keyof typeof ChannelLatencyMode];
20
+ export declare const TranscodePreset: {
21
+ readonly ConstrainedBandwidthTranscodePreset: "CONSTRAINED_BANDWIDTH_DELIVERY";
22
+ readonly HigherBandwidthTranscodePreset: "HIGHER_BANDWIDTH_DELIVERY";
23
+ };
24
+ export type TranscodePreset =
25
+ (typeof TranscodePreset)[keyof typeof TranscodePreset];
20
26
  export declare const ChannelType: {
27
+ readonly AdvancedHDChannelType: "ADVANCED_HD";
28
+ readonly AdvancedSDChannelType: "ADVANCED_SD";
21
29
  readonly BasicChannelType: "BASIC";
22
30
  readonly StandardChannelType: "STANDARD";
23
31
  };
@@ -33,6 +41,7 @@ export interface Channel {
33
41
  authorized?: boolean;
34
42
  tags?: Record<string, string>;
35
43
  insecureIngest?: boolean;
44
+ preset?: TranscodePreset | string;
36
45
  }
37
46
  export interface BatchError {
38
47
  arn?: string;
@@ -64,6 +73,7 @@ export interface CreateChannelRequest {
64
73
  recordingConfigurationArn?: string;
65
74
  tags?: Record<string, string>;
66
75
  insecureIngest?: boolean;
76
+ preset?: TranscodePreset | string;
67
77
  }
68
78
  export interface CreateChannelResponse {
69
79
  channel?: Channel;
@@ -303,6 +313,8 @@ export interface ChannelSummary {
303
313
  recordingConfigurationArn?: string;
304
314
  tags?: Record<string, string>;
305
315
  insecureIngest?: boolean;
316
+ type?: ChannelType | string;
317
+ preset?: TranscodePreset | string;
306
318
  }
307
319
  export interface ListChannelsResponse {
308
320
  channels: ChannelSummary[] | undefined;
@@ -431,6 +443,7 @@ export interface UpdateChannelRequest {
431
443
  authorized?: boolean;
432
444
  recordingConfigurationArn?: string;
433
445
  insecureIngest?: boolean;
446
+ preset?: TranscodePreset | string;
434
447
  }
435
448
  export interface UpdateChannelResponse {
436
449
  channel?: Channel;
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@aws-sdk/client-ivs",
3
3
  "description": "AWS SDK for JavaScript Ivs Client for Node.js, Browser and React Native",
4
- "version": "3.342.0",
4
+ "version": "3.344.0",
5
5
  "scripts": {
6
6
  "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
7
7
  "build:cjs": "tsc -p tsconfig.cjs.json",
@@ -21,14 +21,14 @@
21
21
  "dependencies": {
22
22
  "@aws-crypto/sha256-browser": "3.0.0",
23
23
  "@aws-crypto/sha256-js": "3.0.0",
24
- "@aws-sdk/client-sts": "3.342.0",
24
+ "@aws-sdk/client-sts": "3.344.0",
25
25
  "@aws-sdk/config-resolver": "3.342.0",
26
- "@aws-sdk/credential-provider-node": "3.342.0",
26
+ "@aws-sdk/credential-provider-node": "3.344.0",
27
27
  "@aws-sdk/fetch-http-handler": "3.342.0",
28
- "@aws-sdk/hash-node": "3.342.0",
28
+ "@aws-sdk/hash-node": "3.344.0",
29
29
  "@aws-sdk/invalid-dependency": "3.342.0",
30
30
  "@aws-sdk/middleware-content-length": "3.342.0",
31
- "@aws-sdk/middleware-endpoint": "3.342.0",
31
+ "@aws-sdk/middleware-endpoint": "3.344.0",
32
32
  "@aws-sdk/middleware-host-header": "3.342.0",
33
33
  "@aws-sdk/middleware-logger": "3.342.0",
34
34
  "@aws-sdk/middleware-recursion-detection": "3.342.0",
@@ -38,7 +38,7 @@
38
38
  "@aws-sdk/middleware-stack": "3.342.0",
39
39
  "@aws-sdk/middleware-user-agent": "3.342.0",
40
40
  "@aws-sdk/node-config-provider": "3.342.0",
41
- "@aws-sdk/node-http-handler": "3.342.0",
41
+ "@aws-sdk/node-http-handler": "3.344.0",
42
42
  "@aws-sdk/smithy-client": "3.342.0",
43
43
  "@aws-sdk/types": "3.342.0",
44
44
  "@aws-sdk/url-parser": "3.342.0",