@aws-sdk/client-ivs 3.369.0 → 3.371.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.
@@ -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.ServiceQuotaExceededException = exports.ResourceNotFoundException = exports.PendingVerification = exports.ValidationException = exports.ChannelType = exports.TranscodePreset = exports.ChannelLatencyMode = exports.AccessDeniedException = void 0;
3
+ exports.PutMetadataRequestFilterSensitiveLog = exports.GetStreamKeyResponseFilterSensitiveLog = exports.CreateStreamKeyResponseFilterSensitiveLog = exports.CreateChannelResponseFilterSensitiveLog = exports.BatchGetStreamKeyResponseFilterSensitiveLog = exports.StreamKeyFilterSensitiveLog = exports.StreamUnavailable = exports.StreamState = exports.StreamHealth = exports.ChannelNotBroadcasting = exports.InternalServerException = exports.RecordingConfigurationState = exports.ThumbnailConfigurationStorage = exports.ThumbnailConfigurationResolution = exports.RecordingMode = exports.RenditionConfigurationRenditionSelection = exports.RenditionConfigurationRendition = exports.ConflictException = exports.ServiceQuotaExceededException = exports.ResourceNotFoundException = exports.ValidationException = exports.ThrottlingException = exports.PendingVerification = exports.ChannelType = exports.TranscodePreset = exports.ChannelLatencyMode = exports.AccessDeniedException = void 0;
4
4
  const smithy_client_1 = require("@smithy/smithy-client");
5
5
  const IvsServiceException_1 = require("./IvsServiceException");
6
6
  class AccessDeniedException extends IvsServiceException_1.IvsServiceException {
@@ -31,34 +31,48 @@ exports.ChannelType = {
31
31
  BasicChannelType: "BASIC",
32
32
  StandardChannelType: "STANDARD",
33
33
  };
34
- class ValidationException extends IvsServiceException_1.IvsServiceException {
34
+ class PendingVerification extends IvsServiceException_1.IvsServiceException {
35
35
  constructor(opts) {
36
36
  super({
37
- name: "ValidationException",
37
+ name: "PendingVerification",
38
38
  $fault: "client",
39
39
  ...opts,
40
40
  });
41
- this.name = "ValidationException";
41
+ this.name = "PendingVerification";
42
42
  this.$fault = "client";
43
- Object.setPrototypeOf(this, ValidationException.prototype);
43
+ Object.setPrototypeOf(this, PendingVerification.prototype);
44
44
  this.exceptionMessage = opts.exceptionMessage;
45
45
  }
46
46
  }
47
- exports.ValidationException = ValidationException;
48
- class PendingVerification extends IvsServiceException_1.IvsServiceException {
47
+ exports.PendingVerification = PendingVerification;
48
+ class ThrottlingException extends IvsServiceException_1.IvsServiceException {
49
49
  constructor(opts) {
50
50
  super({
51
- name: "PendingVerification",
51
+ name: "ThrottlingException",
52
52
  $fault: "client",
53
53
  ...opts,
54
54
  });
55
- this.name = "PendingVerification";
55
+ this.name = "ThrottlingException";
56
56
  this.$fault = "client";
57
- Object.setPrototypeOf(this, PendingVerification.prototype);
57
+ Object.setPrototypeOf(this, ThrottlingException.prototype);
58
58
  this.exceptionMessage = opts.exceptionMessage;
59
59
  }
60
60
  }
61
- exports.PendingVerification = PendingVerification;
61
+ exports.ThrottlingException = ThrottlingException;
62
+ class ValidationException extends IvsServiceException_1.IvsServiceException {
63
+ constructor(opts) {
64
+ super({
65
+ name: "ValidationException",
66
+ $fault: "client",
67
+ ...opts,
68
+ });
69
+ this.name = "ValidationException";
70
+ this.$fault = "client";
71
+ Object.setPrototypeOf(this, ValidationException.prototype);
72
+ this.exceptionMessage = opts.exceptionMessage;
73
+ }
74
+ }
75
+ exports.ValidationException = ValidationException;
62
76
  class ResourceNotFoundException extends IvsServiceException_1.IvsServiceException {
63
77
  constructor(opts) {
64
78
  super({
@@ -101,10 +115,31 @@ class ConflictException extends IvsServiceException_1.IvsServiceException {
101
115
  }
102
116
  }
103
117
  exports.ConflictException = ConflictException;
118
+ exports.RenditionConfigurationRendition = {
119
+ FULL_HD: "FULL_HD",
120
+ HD: "HD",
121
+ LOWEST_RESOLUTION: "LOWEST_RESOLUTION",
122
+ SD: "SD",
123
+ };
124
+ exports.RenditionConfigurationRenditionSelection = {
125
+ ALL: "ALL",
126
+ CUSTOM: "CUSTOM",
127
+ NONE: "NONE",
128
+ };
104
129
  exports.RecordingMode = {
105
130
  Disabled: "DISABLED",
106
131
  Interval: "INTERVAL",
107
132
  };
133
+ exports.ThumbnailConfigurationResolution = {
134
+ FULL_HD: "FULL_HD",
135
+ HD: "HD",
136
+ LOWEST_RESOLUTION: "LOWEST_RESOLUTION",
137
+ SD: "SD",
138
+ };
139
+ exports.ThumbnailConfigurationStorage = {
140
+ LATEST: "LATEST",
141
+ SEQUENTIAL: "SEQUENTIAL",
142
+ };
108
143
  exports.RecordingConfigurationState = {
109
144
  Active: "ACTIVE",
110
145
  CreateFailed: "CREATE_FAILED",
@@ -147,20 +182,6 @@ exports.StreamState = {
147
182
  StreamLive: "LIVE",
148
183
  StreamOffline: "OFFLINE",
149
184
  };
150
- class ThrottlingException extends IvsServiceException_1.IvsServiceException {
151
- constructor(opts) {
152
- super({
153
- name: "ThrottlingException",
154
- $fault: "client",
155
- ...opts,
156
- });
157
- this.name = "ThrottlingException";
158
- this.$fault = "client";
159
- Object.setPrototypeOf(this, ThrottlingException.prototype);
160
- this.exceptionMessage = opts.exceptionMessage;
161
- }
162
- }
163
- exports.ThrottlingException = ThrottlingException;
164
185
  class StreamUnavailable extends IvsServiceException_1.IvsServiceException {
165
186
  constructor(opts) {
166
187
  super({
@@ -108,6 +108,7 @@ const se_CreateRecordingConfigurationCommand = async (input, context) => {
108
108
  destinationConfiguration: (_) => (0, smithy_client_1._json)(_),
109
109
  name: [],
110
110
  recordingReconnectWindowSeconds: [],
111
+ renditionConfiguration: (_) => (0, smithy_client_1._json)(_),
111
112
  tags: (_) => (0, smithy_client_1._json)(_),
112
113
  thumbnailConfiguration: (_) => (0, smithy_client_1._json)(_),
113
114
  }));
@@ -752,6 +753,15 @@ const de_BatchStartViewerSessionRevocationCommandError = async (output, context)
752
753
  };
753
754
  const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
754
755
  switch (errorCode) {
756
+ case "AccessDeniedException":
757
+ case "com.amazonaws.ivs#AccessDeniedException":
758
+ throw await de_AccessDeniedExceptionRes(parsedOutput, context);
759
+ case "PendingVerification":
760
+ case "com.amazonaws.ivs#PendingVerification":
761
+ throw await de_PendingVerificationRes(parsedOutput, context);
762
+ case "ThrottlingException":
763
+ case "com.amazonaws.ivs#ThrottlingException":
764
+ throw await de_ThrottlingExceptionRes(parsedOutput, context);
755
765
  case "ValidationException":
756
766
  case "com.amazonaws.ivs#ValidationException":
757
767
  throw await de_ValidationExceptionRes(parsedOutput, context);
@@ -1706,6 +1716,12 @@ const de_StartViewerSessionRevocationCommandError = async (output, context) => {
1706
1716
  case "InternalServerException":
1707
1717
  case "com.amazonaws.ivs#InternalServerException":
1708
1718
  throw await de_InternalServerExceptionRes(parsedOutput, context);
1719
+ case "PendingVerification":
1720
+ case "com.amazonaws.ivs#PendingVerification":
1721
+ throw await de_PendingVerificationRes(parsedOutput, context);
1722
+ case "ResourceNotFoundException":
1723
+ case "com.amazonaws.ivs#ResourceNotFoundException":
1724
+ throw await de_ResourceNotFoundExceptionRes(parsedOutput, context);
1709
1725
  case "ThrottlingException":
1710
1726
  case "com.amazonaws.ivs#ThrottlingException":
1711
1727
  throw await de_ThrottlingExceptionRes(parsedOutput, context);
@@ -27,29 +27,42 @@ export const ChannelType = {
27
27
  BasicChannelType: "BASIC",
28
28
  StandardChannelType: "STANDARD",
29
29
  };
30
- export class ValidationException extends __BaseException {
30
+ export class PendingVerification extends __BaseException {
31
31
  constructor(opts) {
32
32
  super({
33
- name: "ValidationException",
33
+ name: "PendingVerification",
34
34
  $fault: "client",
35
35
  ...opts,
36
36
  });
37
- this.name = "ValidationException";
37
+ this.name = "PendingVerification";
38
38
  this.$fault = "client";
39
- Object.setPrototypeOf(this, ValidationException.prototype);
39
+ Object.setPrototypeOf(this, PendingVerification.prototype);
40
40
  this.exceptionMessage = opts.exceptionMessage;
41
41
  }
42
42
  }
43
- export class PendingVerification extends __BaseException {
43
+ export class ThrottlingException extends __BaseException {
44
44
  constructor(opts) {
45
45
  super({
46
- name: "PendingVerification",
46
+ name: "ThrottlingException",
47
47
  $fault: "client",
48
48
  ...opts,
49
49
  });
50
- this.name = "PendingVerification";
50
+ this.name = "ThrottlingException";
51
51
  this.$fault = "client";
52
- Object.setPrototypeOf(this, PendingVerification.prototype);
52
+ Object.setPrototypeOf(this, ThrottlingException.prototype);
53
+ this.exceptionMessage = opts.exceptionMessage;
54
+ }
55
+ }
56
+ export class ValidationException extends __BaseException {
57
+ constructor(opts) {
58
+ super({
59
+ name: "ValidationException",
60
+ $fault: "client",
61
+ ...opts,
62
+ });
63
+ this.name = "ValidationException";
64
+ this.$fault = "client";
65
+ Object.setPrototypeOf(this, ValidationException.prototype);
53
66
  this.exceptionMessage = opts.exceptionMessage;
54
67
  }
55
68
  }
@@ -92,10 +105,31 @@ export class ConflictException extends __BaseException {
92
105
  this.exceptionMessage = opts.exceptionMessage;
93
106
  }
94
107
  }
108
+ export const RenditionConfigurationRendition = {
109
+ FULL_HD: "FULL_HD",
110
+ HD: "HD",
111
+ LOWEST_RESOLUTION: "LOWEST_RESOLUTION",
112
+ SD: "SD",
113
+ };
114
+ export const RenditionConfigurationRenditionSelection = {
115
+ ALL: "ALL",
116
+ CUSTOM: "CUSTOM",
117
+ NONE: "NONE",
118
+ };
95
119
  export const RecordingMode = {
96
120
  Disabled: "DISABLED",
97
121
  Interval: "INTERVAL",
98
122
  };
123
+ export const ThumbnailConfigurationResolution = {
124
+ FULL_HD: "FULL_HD",
125
+ HD: "HD",
126
+ LOWEST_RESOLUTION: "LOWEST_RESOLUTION",
127
+ SD: "SD",
128
+ };
129
+ export const ThumbnailConfigurationStorage = {
130
+ LATEST: "LATEST",
131
+ SEQUENTIAL: "SEQUENTIAL",
132
+ };
99
133
  export const RecordingConfigurationState = {
100
134
  Active: "ACTIVE",
101
135
  CreateFailed: "CREATE_FAILED",
@@ -136,19 +170,6 @@ export const StreamState = {
136
170
  StreamLive: "LIVE",
137
171
  StreamOffline: "OFFLINE",
138
172
  };
139
- export class ThrottlingException extends __BaseException {
140
- constructor(opts) {
141
- super({
142
- name: "ThrottlingException",
143
- $fault: "client",
144
- ...opts,
145
- });
146
- this.name = "ThrottlingException";
147
- this.$fault = "client";
148
- Object.setPrototypeOf(this, ThrottlingException.prototype);
149
- this.exceptionMessage = opts.exceptionMessage;
150
- }
151
- }
152
173
  export class StreamUnavailable extends __BaseException {
153
174
  constructor(opts) {
154
175
  super({
@@ -100,6 +100,7 @@ export const se_CreateRecordingConfigurationCommand = async (input, context) =>
100
100
  destinationConfiguration: (_) => _json(_),
101
101
  name: [],
102
102
  recordingReconnectWindowSeconds: [],
103
+ renditionConfiguration: (_) => _json(_),
103
104
  tags: (_) => _json(_),
104
105
  thumbnailConfiguration: (_) => _json(_),
105
106
  }));
@@ -715,6 +716,15 @@ const de_BatchStartViewerSessionRevocationCommandError = async (output, context)
715
716
  };
716
717
  const errorCode = loadRestJsonErrorCode(output, parsedOutput.body);
717
718
  switch (errorCode) {
719
+ case "AccessDeniedException":
720
+ case "com.amazonaws.ivs#AccessDeniedException":
721
+ throw await de_AccessDeniedExceptionRes(parsedOutput, context);
722
+ case "PendingVerification":
723
+ case "com.amazonaws.ivs#PendingVerification":
724
+ throw await de_PendingVerificationRes(parsedOutput, context);
725
+ case "ThrottlingException":
726
+ case "com.amazonaws.ivs#ThrottlingException":
727
+ throw await de_ThrottlingExceptionRes(parsedOutput, context);
718
728
  case "ValidationException":
719
729
  case "com.amazonaws.ivs#ValidationException":
720
730
  throw await de_ValidationExceptionRes(parsedOutput, context);
@@ -1646,6 +1656,12 @@ const de_StartViewerSessionRevocationCommandError = async (output, context) => {
1646
1656
  case "InternalServerException":
1647
1657
  case "com.amazonaws.ivs#InternalServerException":
1648
1658
  throw await de_InternalServerExceptionRes(parsedOutput, context);
1659
+ case "PendingVerification":
1660
+ case "com.amazonaws.ivs#PendingVerification":
1661
+ throw await de_PendingVerificationRes(parsedOutput, context);
1662
+ case "ResourceNotFoundException":
1663
+ case "com.amazonaws.ivs#ResourceNotFoundException":
1664
+ throw await de_ResourceNotFoundExceptionRes(parsedOutput, context);
1649
1665
  case "ThrottlingException":
1650
1666
  case "com.amazonaws.ivs#ThrottlingException":
1651
1667
  throw await de_ThrottlingExceptionRes(parsedOutput, context);
@@ -61,6 +61,15 @@ export interface BatchStartViewerSessionRevocationCommandOutput extends BatchSta
61
61
  * @see {@link BatchStartViewerSessionRevocationCommandOutput} for command's `response` shape.
62
62
  * @see {@link IvsClientResolvedConfig | config} for IvsClient's `config` shape.
63
63
  *
64
+ * @throws {@link AccessDeniedException} (client fault)
65
+ * <p/>
66
+ *
67
+ * @throws {@link PendingVerification} (client fault)
68
+ * <p/>
69
+ *
70
+ * @throws {@link ThrottlingException} (client fault)
71
+ * <p/>
72
+ *
64
73
  * @throws {@link ValidationException} (client fault)
65
74
  * <p/>
66
75
  *
@@ -54,8 +54,18 @@ export interface CreateRecordingConfigurationCommandOutput extends CreateRecordi
54
54
  * thumbnailConfiguration: { // ThumbnailConfiguration
55
55
  * recordingMode: "STRING_VALUE",
56
56
  * targetIntervalSeconds: Number("long"),
57
+ * resolution: "STRING_VALUE",
58
+ * storage: [ // ThumbnailConfigurationStorageList
59
+ * "STRING_VALUE",
60
+ * ],
57
61
  * },
58
62
  * recordingReconnectWindowSeconds: Number("int"),
63
+ * renditionConfiguration: { // RenditionConfiguration
64
+ * renditionSelection: "STRING_VALUE",
65
+ * renditions: [ // RenditionConfigurationRenditionList
66
+ * "STRING_VALUE",
67
+ * ],
68
+ * },
59
69
  * };
60
70
  * const command = new CreateRecordingConfigurationCommand(input);
61
71
  * const response = await client.send(command);
@@ -75,8 +85,18 @@ export interface CreateRecordingConfigurationCommandOutput extends CreateRecordi
75
85
  * // thumbnailConfiguration: { // ThumbnailConfiguration
76
86
  * // recordingMode: "STRING_VALUE",
77
87
  * // targetIntervalSeconds: Number("long"),
88
+ * // resolution: "STRING_VALUE",
89
+ * // storage: [ // ThumbnailConfigurationStorageList
90
+ * // "STRING_VALUE",
91
+ * // ],
78
92
  * // },
79
93
  * // recordingReconnectWindowSeconds: Number("int"),
94
+ * // renditionConfiguration: { // RenditionConfiguration
95
+ * // renditionSelection: "STRING_VALUE",
96
+ * // renditions: [ // RenditionConfigurationRenditionList
97
+ * // "STRING_VALUE",
98
+ * // ],
99
+ * // },
80
100
  * // },
81
101
  * // };
82
102
  *
@@ -51,8 +51,18 @@ export interface GetRecordingConfigurationCommandOutput extends GetRecordingConf
51
51
  * // thumbnailConfiguration: { // ThumbnailConfiguration
52
52
  * // recordingMode: "STRING_VALUE",
53
53
  * // targetIntervalSeconds: Number("long"),
54
+ * // resolution: "STRING_VALUE",
55
+ * // storage: [ // ThumbnailConfigurationStorageList
56
+ * // "STRING_VALUE",
57
+ * // ],
54
58
  * // },
55
59
  * // recordingReconnectWindowSeconds: Number("int"),
60
+ * // renditionConfiguration: { // RenditionConfiguration
61
+ * // renditionSelection: "STRING_VALUE",
62
+ * // renditions: [ // RenditionConfigurationRenditionList
63
+ * // "STRING_VALUE",
64
+ * // ],
65
+ * // },
56
66
  * // },
57
67
  * // };
58
68
  *
@@ -89,8 +89,18 @@ export interface GetStreamSessionCommandOutput extends GetStreamSessionResponse,
89
89
  * // thumbnailConfiguration: { // ThumbnailConfiguration
90
90
  * // recordingMode: "STRING_VALUE",
91
91
  * // targetIntervalSeconds: Number("long"),
92
+ * // resolution: "STRING_VALUE",
93
+ * // storage: [ // ThumbnailConfigurationStorageList
94
+ * // "STRING_VALUE",
95
+ * // ],
92
96
  * // },
93
97
  * // recordingReconnectWindowSeconds: Number("int"),
98
+ * // renditionConfiguration: { // RenditionConfiguration
99
+ * // renditionSelection: "STRING_VALUE",
100
+ * // renditions: [ // RenditionConfigurationRenditionList
101
+ * // "STRING_VALUE",
102
+ * // ],
103
+ * // },
94
104
  * // },
95
105
  * // truncatedEvents: [ // StreamEvents
96
106
  * // { // StreamEvent
@@ -57,6 +57,12 @@ export interface StartViewerSessionRevocationCommandOutput extends StartViewerSe
57
57
  * @throws {@link InternalServerException} (server fault)
58
58
  * <p/>
59
59
  *
60
+ * @throws {@link PendingVerification} (client fault)
61
+ * <p/>
62
+ *
63
+ * @throws {@link ResourceNotFoundException} (client fault)
64
+ * <p/>
65
+ *
60
66
  * @throws {@link ThrottlingException} (client fault)
61
67
  * <p/>
62
68
  *
@@ -325,6 +325,38 @@ export interface BatchStartViewerSessionRevocationResponse {
325
325
  */
326
326
  errors?: BatchStartViewerSessionRevocationError[];
327
327
  }
328
+ /**
329
+ * @public
330
+ * <p/>
331
+ */
332
+ export declare class PendingVerification extends __BaseException {
333
+ readonly name: "PendingVerification";
334
+ readonly $fault: "client";
335
+ /**
336
+ * <p> Your account is pending verification. </p>
337
+ */
338
+ exceptionMessage?: string;
339
+ /**
340
+ * @internal
341
+ */
342
+ constructor(opts: __ExceptionOptionType<PendingVerification, __BaseException>);
343
+ }
344
+ /**
345
+ * @public
346
+ * <p/>
347
+ */
348
+ export declare class ThrottlingException extends __BaseException {
349
+ readonly name: "ThrottlingException";
350
+ readonly $fault: "client";
351
+ /**
352
+ * <p>Request was denied due to request throttling.</p>
353
+ */
354
+ exceptionMessage?: string;
355
+ /**
356
+ * @internal
357
+ */
358
+ constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
359
+ }
328
360
  /**
329
361
  * @public
330
362
  * <p/>
@@ -461,22 +493,6 @@ export interface CreateChannelResponse {
461
493
  */
462
494
  streamKey?: StreamKey;
463
495
  }
464
- /**
465
- * @public
466
- * <p/>
467
- */
468
- export declare class PendingVerification extends __BaseException {
469
- readonly name: "PendingVerification";
470
- readonly $fault: "client";
471
- /**
472
- * <p> Your account is pending verification. </p>
473
- */
474
- exceptionMessage?: string;
475
- /**
476
- * @internal
477
- */
478
- constructor(opts: __ExceptionOptionType<PendingVerification, __BaseException>);
479
- }
480
496
  /**
481
497
  * @public
482
498
  * <p/>
@@ -547,6 +563,54 @@ export interface DestinationConfiguration {
547
563
  */
548
564
  s3?: S3DestinationConfiguration;
549
565
  }
566
+ /**
567
+ * @public
568
+ * @enum
569
+ */
570
+ export declare const RenditionConfigurationRendition: {
571
+ readonly FULL_HD: "FULL_HD";
572
+ readonly HD: "HD";
573
+ readonly LOWEST_RESOLUTION: "LOWEST_RESOLUTION";
574
+ readonly SD: "SD";
575
+ };
576
+ /**
577
+ * @public
578
+ */
579
+ export type RenditionConfigurationRendition = (typeof RenditionConfigurationRendition)[keyof typeof RenditionConfigurationRendition];
580
+ /**
581
+ * @public
582
+ * @enum
583
+ */
584
+ export declare const RenditionConfigurationRenditionSelection: {
585
+ readonly ALL: "ALL";
586
+ readonly CUSTOM: "CUSTOM";
587
+ readonly NONE: "NONE";
588
+ };
589
+ /**
590
+ * @public
591
+ */
592
+ export type RenditionConfigurationRenditionSelection = (typeof RenditionConfigurationRenditionSelection)[keyof typeof RenditionConfigurationRenditionSelection];
593
+ /**
594
+ * @public
595
+ * <p>Object that describes which renditions should be recorded for a stream.</p>
596
+ */
597
+ export interface RenditionConfiguration {
598
+ /**
599
+ * <p>Indicates which set of renditions are recorded for a stream. For <code>BASIC</code>
600
+ * channels, the <code>CUSTOM</code> value has no effect. If <code>CUSTOM</code> is specified, a
601
+ * set of renditions must be specified in the <code>renditions</code> field. Default:
602
+ * <code>ALL</code>.</p>
603
+ */
604
+ renditionSelection?: RenditionConfigurationRenditionSelection | string;
605
+ /**
606
+ * <p>Indicates which renditions are recorded for a stream, if <code>renditionSelection</code>
607
+ * is <code>CUSTOM</code>; otherwise, this field is irrelevant. The selected renditions are
608
+ * recorded if they are available during the stream. If a selected rendition is unavailable, the
609
+ * best available rendition is recorded. For details on the resolution dimensions of each
610
+ * rendition, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html">Auto-Record to Amazon S3</a>.</p>
611
+ */
612
+ renditions?: (RenditionConfigurationRendition | string)[];
613
+ }
550
614
  /**
551
615
  * @public
552
616
  * @enum
@@ -559,6 +623,32 @@ export declare const RecordingMode: {
559
623
  * @public
560
624
  */
561
625
  export type RecordingMode = (typeof RecordingMode)[keyof typeof RecordingMode];
626
+ /**
627
+ * @public
628
+ * @enum
629
+ */
630
+ export declare const ThumbnailConfigurationResolution: {
631
+ readonly FULL_HD: "FULL_HD";
632
+ readonly HD: "HD";
633
+ readonly LOWEST_RESOLUTION: "LOWEST_RESOLUTION";
634
+ readonly SD: "SD";
635
+ };
636
+ /**
637
+ * @public
638
+ */
639
+ export type ThumbnailConfigurationResolution = (typeof ThumbnailConfigurationResolution)[keyof typeof ThumbnailConfigurationResolution];
640
+ /**
641
+ * @public
642
+ * @enum
643
+ */
644
+ export declare const ThumbnailConfigurationStorage: {
645
+ readonly LATEST: "LATEST";
646
+ readonly SEQUENTIAL: "SEQUENTIAL";
647
+ };
648
+ /**
649
+ * @public
650
+ */
651
+ export type ThumbnailConfigurationStorage = (typeof ThumbnailConfigurationStorage)[keyof typeof ThumbnailConfigurationStorage];
562
652
  /**
563
653
  * @public
564
654
  * <p>An object representing a configuration of thumbnails for recorded video.</p>
@@ -572,15 +662,31 @@ export interface ThumbnailConfiguration {
572
662
  * <p>The targeted thumbnail-generation interval in seconds. This is configurable (and required)
573
663
  * only if <code>recordingMode</code> is <code>INTERVAL</code>. Default: 60.</p>
574
664
  * <p>
575
- * <b>Important:</b> Setting a value for
576
- * <code>targetIntervalSeconds</code> does not guarantee that thumbnails are generated at the
577
- * specified interval. For thumbnails to be generated at the <code>targetIntervalSeconds</code>
578
- * interval, the <code>IDR/Keyframe</code> value for the input video must be less than the
579
- * <code>targetIntervalSeconds</code> value. See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html"> Amazon IVS Streaming Configuration</a>
580
- * for information on setting <code>IDR/Keyframe</code> to the recommended value in video-encoder
581
- * settings.</p>
665
+ * <b>Important:</b> For the <code>BASIC</code> channel type,
666
+ * setting a value for <code>targetIntervalSeconds</code> does not guarantee that thumbnails are
667
+ * generated at the specified interval. For thumbnails to be generated at the
668
+ * <code>targetIntervalSeconds</code> interval, the <code>IDR/Keyframe</code> value for the
669
+ * input video must be less than the <code>targetIntervalSeconds</code> value. See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/streaming-config.html"> Amazon IVS Streaming
670
+ * Configuration</a> for information on setting <code>IDR/Keyframe</code> to the
671
+ * recommended value in video-encoder settings.</p>
582
672
  */
583
673
  targetIntervalSeconds?: number;
674
+ /**
675
+ * <p>Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the
676
+ * selected resolution if the corresponding rendition is available during the stream; otherwise,
677
+ * they are recorded at source resolution. For more information about resolution values and their
678
+ * corresponding height and width dimensions, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html">Auto-Record to Amazon S3</a>. Default:
679
+ * Null (source resolution is returned).</p>
680
+ */
681
+ resolution?: ThumbnailConfigurationResolution | string;
682
+ /**
683
+ * <p>Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records all
684
+ * generated thumbnails in a serial manner, to the media/thumbnails directory.
685
+ * <code>LATEST</code> saves the latest thumbnail in media/latest_thumbnail/thumb.jpg and
686
+ * overwrites it at the interval specified by <code>targetIntervalSeconds</code>. You can enable
687
+ * both <code>SEQUENTIAL</code> and <code>LATEST</code>. Default: <code>SEQUENTIAL</code>.</p>
688
+ */
689
+ storage?: (ThumbnailConfigurationStorage | string)[];
584
690
  }
585
691
  /**
586
692
  * @public
@@ -612,6 +718,10 @@ export interface CreateRecordingConfigurationRequest {
612
718
  * streams will be considered a single broadcast and merged together. Default: 0.</p>
613
719
  */
614
720
  recordingReconnectWindowSeconds?: number;
721
+ /**
722
+ * <p>Object that describes which renditions should be recorded for a stream.</p>
723
+ */
724
+ renditionConfiguration?: RenditionConfiguration;
615
725
  }
616
726
  /**
617
727
  * @public
@@ -665,6 +775,10 @@ export interface RecordingConfiguration {
665
775
  * streams will be considered a single broadcast and merged together. Default: 0.</p>
666
776
  */
667
777
  recordingReconnectWindowSeconds?: number;
778
+ /**
779
+ * <p>Object that describes which renditions should be recorded for a stream.</p>
780
+ */
781
+ renditionConfiguration?: RenditionConfiguration;
668
782
  }
669
783
  /**
670
784
  * @public
@@ -1625,22 +1739,6 @@ export interface PutMetadataRequest {
1625
1739
  */
1626
1740
  metadata: string | undefined;
1627
1741
  }
1628
- /**
1629
- * @public
1630
- * <p/>
1631
- */
1632
- export declare class ThrottlingException extends __BaseException {
1633
- readonly name: "ThrottlingException";
1634
- readonly $fault: "client";
1635
- /**
1636
- * <p>Request was denied due to request throttling.</p>
1637
- */
1638
- exceptionMessage?: string;
1639
- /**
1640
- * @internal
1641
- */
1642
- constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
1643
- }
1644
1742
  /**
1645
1743
  * @public
1646
1744
  */
@@ -82,6 +82,22 @@ export interface BatchStartViewerSessionRevocationError {
82
82
  export interface BatchStartViewerSessionRevocationResponse {
83
83
  errors?: BatchStartViewerSessionRevocationError[];
84
84
  }
85
+ export declare class PendingVerification extends __BaseException {
86
+ readonly name: "PendingVerification";
87
+ readonly $fault: "client";
88
+ exceptionMessage?: string;
89
+ constructor(
90
+ opts: __ExceptionOptionType<PendingVerification, __BaseException>
91
+ );
92
+ }
93
+ export declare class ThrottlingException extends __BaseException {
94
+ readonly name: "ThrottlingException";
95
+ readonly $fault: "client";
96
+ exceptionMessage?: string;
97
+ constructor(
98
+ opts: __ExceptionOptionType<ThrottlingException, __BaseException>
99
+ );
100
+ }
85
101
  export declare class ValidationException extends __BaseException {
86
102
  readonly name: "ValidationException";
87
103
  readonly $fault: "client";
@@ -104,14 +120,6 @@ export interface CreateChannelResponse {
104
120
  channel?: Channel;
105
121
  streamKey?: StreamKey;
106
122
  }
107
- export declare class PendingVerification extends __BaseException {
108
- readonly name: "PendingVerification";
109
- readonly $fault: "client";
110
- exceptionMessage?: string;
111
- constructor(
112
- opts: __ExceptionOptionType<PendingVerification, __BaseException>
113
- );
114
- }
115
123
  export declare class ResourceNotFoundException extends __BaseException {
116
124
  readonly name: "ResourceNotFoundException";
117
125
  readonly $fault: "client";
@@ -140,14 +148,49 @@ export interface S3DestinationConfiguration {
140
148
  export interface DestinationConfiguration {
141
149
  s3?: S3DestinationConfiguration;
142
150
  }
151
+ export declare const RenditionConfigurationRendition: {
152
+ readonly FULL_HD: "FULL_HD";
153
+ readonly HD: "HD";
154
+ readonly LOWEST_RESOLUTION: "LOWEST_RESOLUTION";
155
+ readonly SD: "SD";
156
+ };
157
+ export type RenditionConfigurationRendition =
158
+ (typeof RenditionConfigurationRendition)[keyof typeof RenditionConfigurationRendition];
159
+ export declare const RenditionConfigurationRenditionSelection: {
160
+ readonly ALL: "ALL";
161
+ readonly CUSTOM: "CUSTOM";
162
+ readonly NONE: "NONE";
163
+ };
164
+ export type RenditionConfigurationRenditionSelection =
165
+ (typeof RenditionConfigurationRenditionSelection)[keyof typeof RenditionConfigurationRenditionSelection];
166
+ export interface RenditionConfiguration {
167
+ renditionSelection?: RenditionConfigurationRenditionSelection | string;
168
+ renditions?: (RenditionConfigurationRendition | string)[];
169
+ }
143
170
  export declare const RecordingMode: {
144
171
  readonly Disabled: "DISABLED";
145
172
  readonly Interval: "INTERVAL";
146
173
  };
147
174
  export type RecordingMode = (typeof RecordingMode)[keyof typeof RecordingMode];
175
+ export declare const ThumbnailConfigurationResolution: {
176
+ readonly FULL_HD: "FULL_HD";
177
+ readonly HD: "HD";
178
+ readonly LOWEST_RESOLUTION: "LOWEST_RESOLUTION";
179
+ readonly SD: "SD";
180
+ };
181
+ export type ThumbnailConfigurationResolution =
182
+ (typeof ThumbnailConfigurationResolution)[keyof typeof ThumbnailConfigurationResolution];
183
+ export declare const ThumbnailConfigurationStorage: {
184
+ readonly LATEST: "LATEST";
185
+ readonly SEQUENTIAL: "SEQUENTIAL";
186
+ };
187
+ export type ThumbnailConfigurationStorage =
188
+ (typeof ThumbnailConfigurationStorage)[keyof typeof ThumbnailConfigurationStorage];
148
189
  export interface ThumbnailConfiguration {
149
190
  recordingMode?: RecordingMode | string;
150
191
  targetIntervalSeconds?: number;
192
+ resolution?: ThumbnailConfigurationResolution | string;
193
+ storage?: (ThumbnailConfigurationStorage | string)[];
151
194
  }
152
195
  export interface CreateRecordingConfigurationRequest {
153
196
  name?: string;
@@ -155,6 +198,7 @@ export interface CreateRecordingConfigurationRequest {
155
198
  tags?: Record<string, string>;
156
199
  thumbnailConfiguration?: ThumbnailConfiguration;
157
200
  recordingReconnectWindowSeconds?: number;
201
+ renditionConfiguration?: RenditionConfiguration;
158
202
  }
159
203
  export declare const RecordingConfigurationState: {
160
204
  readonly Active: "ACTIVE";
@@ -171,6 +215,7 @@ export interface RecordingConfiguration {
171
215
  tags?: Record<string, string>;
172
216
  thumbnailConfiguration?: ThumbnailConfiguration;
173
217
  recordingReconnectWindowSeconds?: number;
218
+ renditionConfiguration?: RenditionConfiguration;
174
219
  }
175
220
  export interface CreateRecordingConfigurationResponse {
176
221
  recordingConfiguration?: RecordingConfiguration;
@@ -424,14 +469,6 @@ export interface PutMetadataRequest {
424
469
  channelArn: string | undefined;
425
470
  metadata: string | undefined;
426
471
  }
427
- export declare class ThrottlingException extends __BaseException {
428
- readonly name: "ThrottlingException";
429
- readonly $fault: "client";
430
- exceptionMessage?: string;
431
- constructor(
432
- opts: __ExceptionOptionType<ThrottlingException, __BaseException>
433
- );
434
- }
435
472
  export interface StartViewerSessionRevocationRequest {
436
473
  channelArn: string | undefined;
437
474
  viewerId: string | undefined;
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.369.0",
4
+ "version": "3.371.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,29 +21,29 @@
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.369.0",
25
- "@aws-sdk/credential-provider-node": "3.369.0",
26
- "@aws-sdk/middleware-host-header": "3.369.0",
27
- "@aws-sdk/middleware-logger": "3.369.0",
28
- "@aws-sdk/middleware-recursion-detection": "3.369.0",
29
- "@aws-sdk/middleware-signing": "3.369.0",
30
- "@aws-sdk/middleware-user-agent": "3.369.0",
31
- "@aws-sdk/types": "3.369.0",
32
- "@aws-sdk/util-endpoints": "3.369.0",
33
- "@aws-sdk/util-user-agent-browser": "3.369.0",
34
- "@aws-sdk/util-user-agent-node": "3.369.0",
24
+ "@aws-sdk/client-sts": "3.370.0",
25
+ "@aws-sdk/credential-provider-node": "3.370.0",
26
+ "@aws-sdk/middleware-host-header": "3.370.0",
27
+ "@aws-sdk/middleware-logger": "3.370.0",
28
+ "@aws-sdk/middleware-recursion-detection": "3.370.0",
29
+ "@aws-sdk/middleware-signing": "3.370.0",
30
+ "@aws-sdk/middleware-user-agent": "3.370.0",
31
+ "@aws-sdk/types": "3.370.0",
32
+ "@aws-sdk/util-endpoints": "3.370.0",
33
+ "@aws-sdk/util-user-agent-browser": "3.370.0",
34
+ "@aws-sdk/util-user-agent-node": "3.370.0",
35
35
  "@smithy/config-resolver": "^1.0.1",
36
36
  "@smithy/fetch-http-handler": "^1.0.1",
37
37
  "@smithy/hash-node": "^1.0.1",
38
38
  "@smithy/invalid-dependency": "^1.0.1",
39
39
  "@smithy/middleware-content-length": "^1.0.1",
40
- "@smithy/middleware-endpoint": "^1.0.1",
41
- "@smithy/middleware-retry": "^1.0.2",
40
+ "@smithy/middleware-endpoint": "^1.0.2",
41
+ "@smithy/middleware-retry": "^1.0.3",
42
42
  "@smithy/middleware-serde": "^1.0.1",
43
43
  "@smithy/middleware-stack": "^1.0.1",
44
44
  "@smithy/node-config-provider": "^1.0.1",
45
45
  "@smithy/node-http-handler": "^1.0.2",
46
- "@smithy/protocol-http": "^1.0.1",
46
+ "@smithy/protocol-http": "^1.1.0",
47
47
  "@smithy/smithy-client": "^1.0.3",
48
48
  "@smithy/types": "^1.1.0",
49
49
  "@smithy/url-parser": "^1.0.1",
@@ -52,12 +52,11 @@
52
52
  "@smithy/util-body-length-node": "^1.0.1",
53
53
  "@smithy/util-defaults-mode-browser": "^1.0.1",
54
54
  "@smithy/util-defaults-mode-node": "^1.0.1",
55
- "@smithy/util-retry": "^1.0.2",
55
+ "@smithy/util-retry": "^1.0.3",
56
56
  "@smithy/util-utf8": "^1.0.1",
57
57
  "tslib": "^2.5.0"
58
58
  },
59
59
  "devDependencies": {
60
- "@aws-sdk/service-client-documentation-generator": "3.310.0",
61
60
  "@smithy/service-client-documentation-generator": "^1.0.1",
62
61
  "@tsconfig/node14": "1.0.3",
63
62
  "@types/node": "^14.14.31",