@aws-sdk/client-ivs 3.296.0 → 3.298.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 (99) hide show
  1. package/dist-cjs/commands/BatchGetChannelCommand.js +2 -3
  2. package/dist-cjs/commands/BatchGetStreamKeyCommand.js +1 -1
  3. package/dist-cjs/commands/CreateChannelCommand.js +1 -1
  4. package/dist-cjs/commands/CreateRecordingConfigurationCommand.js +2 -3
  5. package/dist-cjs/commands/CreateStreamKeyCommand.js +1 -1
  6. package/dist-cjs/commands/DeleteChannelCommand.js +2 -3
  7. package/dist-cjs/commands/DeletePlaybackKeyPairCommand.js +2 -3
  8. package/dist-cjs/commands/DeleteRecordingConfigurationCommand.js +2 -3
  9. package/dist-cjs/commands/DeleteStreamKeyCommand.js +2 -3
  10. package/dist-cjs/commands/GetChannelCommand.js +2 -3
  11. package/dist-cjs/commands/GetPlaybackKeyPairCommand.js +2 -3
  12. package/dist-cjs/commands/GetRecordingConfigurationCommand.js +2 -3
  13. package/dist-cjs/commands/GetStreamCommand.js +2 -3
  14. package/dist-cjs/commands/GetStreamKeyCommand.js +1 -1
  15. package/dist-cjs/commands/GetStreamSessionCommand.js +2 -3
  16. package/dist-cjs/commands/ImportPlaybackKeyPairCommand.js +2 -3
  17. package/dist-cjs/commands/ListChannelsCommand.js +2 -3
  18. package/dist-cjs/commands/ListPlaybackKeyPairsCommand.js +2 -3
  19. package/dist-cjs/commands/ListRecordingConfigurationsCommand.js +2 -3
  20. package/dist-cjs/commands/ListStreamKeysCommand.js +2 -3
  21. package/dist-cjs/commands/ListStreamSessionsCommand.js +2 -3
  22. package/dist-cjs/commands/ListStreamsCommand.js +2 -3
  23. package/dist-cjs/commands/ListTagsForResourceCommand.js +2 -3
  24. package/dist-cjs/commands/PutMetadataCommand.js +1 -1
  25. package/dist-cjs/commands/StopStreamCommand.js +2 -3
  26. package/dist-cjs/commands/TagResourceCommand.js +2 -3
  27. package/dist-cjs/commands/UntagResourceCommand.js +2 -3
  28. package/dist-cjs/commands/UpdateChannelCommand.js +2 -3
  29. package/dist-cjs/models/models_0.js +1 -270
  30. package/dist-es/commands/BatchGetChannelCommand.js +2 -3
  31. package/dist-es/commands/BatchGetStreamKeyCommand.js +2 -2
  32. package/dist-es/commands/CreateChannelCommand.js +2 -2
  33. package/dist-es/commands/CreateRecordingConfigurationCommand.js +2 -3
  34. package/dist-es/commands/CreateStreamKeyCommand.js +2 -2
  35. package/dist-es/commands/DeleteChannelCommand.js +2 -3
  36. package/dist-es/commands/DeletePlaybackKeyPairCommand.js +2 -3
  37. package/dist-es/commands/DeleteRecordingConfigurationCommand.js +2 -3
  38. package/dist-es/commands/DeleteStreamKeyCommand.js +2 -3
  39. package/dist-es/commands/GetChannelCommand.js +2 -3
  40. package/dist-es/commands/GetPlaybackKeyPairCommand.js +2 -3
  41. package/dist-es/commands/GetRecordingConfigurationCommand.js +2 -3
  42. package/dist-es/commands/GetStreamCommand.js +2 -3
  43. package/dist-es/commands/GetStreamKeyCommand.js +2 -2
  44. package/dist-es/commands/GetStreamSessionCommand.js +2 -3
  45. package/dist-es/commands/ImportPlaybackKeyPairCommand.js +2 -3
  46. package/dist-es/commands/ListChannelsCommand.js +2 -3
  47. package/dist-es/commands/ListPlaybackKeyPairsCommand.js +2 -3
  48. package/dist-es/commands/ListRecordingConfigurationsCommand.js +2 -3
  49. package/dist-es/commands/ListStreamKeysCommand.js +2 -3
  50. package/dist-es/commands/ListStreamSessionsCommand.js +2 -3
  51. package/dist-es/commands/ListStreamsCommand.js +2 -3
  52. package/dist-es/commands/ListTagsForResourceCommand.js +2 -3
  53. package/dist-es/commands/PutMetadataCommand.js +1 -1
  54. package/dist-es/commands/StopStreamCommand.js +2 -3
  55. package/dist-es/commands/TagResourceCommand.js +2 -3
  56. package/dist-es/commands/UntagResourceCommand.js +2 -3
  57. package/dist-es/commands/UpdateChannelCommand.js +2 -3
  58. package/dist-es/models/models_0.js +0 -201
  59. package/dist-types/Ivs.d.ts +29 -0
  60. package/dist-types/IvsClient.d.ts +24 -4
  61. package/dist-types/commands/BatchGetChannelCommand.d.ts +16 -0
  62. package/dist-types/commands/BatchGetStreamKeyCommand.d.ts +16 -0
  63. package/dist-types/commands/CreateChannelCommand.d.ts +16 -0
  64. package/dist-types/commands/CreateRecordingConfigurationCommand.d.ts +16 -0
  65. package/dist-types/commands/CreateStreamKeyCommand.d.ts +16 -0
  66. package/dist-types/commands/DeleteChannelCommand.d.ts +16 -0
  67. package/dist-types/commands/DeletePlaybackKeyPairCommand.d.ts +16 -0
  68. package/dist-types/commands/DeleteRecordingConfigurationCommand.d.ts +16 -0
  69. package/dist-types/commands/DeleteStreamKeyCommand.d.ts +16 -0
  70. package/dist-types/commands/GetChannelCommand.d.ts +16 -0
  71. package/dist-types/commands/GetPlaybackKeyPairCommand.d.ts +16 -0
  72. package/dist-types/commands/GetRecordingConfigurationCommand.d.ts +16 -0
  73. package/dist-types/commands/GetStreamCommand.d.ts +16 -0
  74. package/dist-types/commands/GetStreamKeyCommand.d.ts +16 -0
  75. package/dist-types/commands/GetStreamSessionCommand.d.ts +16 -0
  76. package/dist-types/commands/ImportPlaybackKeyPairCommand.d.ts +16 -0
  77. package/dist-types/commands/ListChannelsCommand.d.ts +16 -0
  78. package/dist-types/commands/ListPlaybackKeyPairsCommand.d.ts +16 -0
  79. package/dist-types/commands/ListRecordingConfigurationsCommand.d.ts +16 -0
  80. package/dist-types/commands/ListStreamKeysCommand.d.ts +16 -0
  81. package/dist-types/commands/ListStreamSessionsCommand.d.ts +16 -0
  82. package/dist-types/commands/ListStreamsCommand.d.ts +16 -0
  83. package/dist-types/commands/ListTagsForResourceCommand.d.ts +16 -0
  84. package/dist-types/commands/PutMetadataCommand.d.ts +16 -0
  85. package/dist-types/commands/StopStreamCommand.d.ts +16 -0
  86. package/dist-types/commands/TagResourceCommand.d.ts +16 -0
  87. package/dist-types/commands/UntagResourceCommand.d.ts +16 -0
  88. package/dist-types/commands/UpdateChannelCommand.d.ts +16 -0
  89. package/dist-types/models/IvsServiceException.d.ts +2 -0
  90. package/dist-types/models/models_0.d.ts +205 -268
  91. package/dist-types/pagination/Interfaces.d.ts +3 -0
  92. package/dist-types/pagination/ListChannelsPaginator.d.ts +3 -0
  93. package/dist-types/pagination/ListPlaybackKeyPairsPaginator.d.ts +3 -0
  94. package/dist-types/pagination/ListRecordingConfigurationsPaginator.d.ts +3 -0
  95. package/dist-types/pagination/ListStreamKeysPaginator.d.ts +3 -0
  96. package/dist-types/pagination/ListStreamSessionsPaginator.d.ts +3 -0
  97. package/dist-types/pagination/ListStreamsPaginator.d.ts +3 -0
  98. package/dist-types/ts3.4/models/models_0.d.ts +0 -193
  99. package/package.json +4 -3
@@ -1,6 +1,7 @@
1
1
  import { ExceptionOptionType as __ExceptionOptionType } from "@aws-sdk/smithy-client";
2
2
  import { IvsServiceException as __BaseException } from "./IvsServiceException";
3
3
  /**
4
+ * @public
4
5
  * <p/>
5
6
  */
6
7
  export declare class AccessDeniedException extends __BaseException {
@@ -15,21 +16,31 @@ export declare class AccessDeniedException extends __BaseException {
15
16
  */
16
17
  constructor(opts: __ExceptionOptionType<AccessDeniedException, __BaseException>);
17
18
  }
19
+ /**
20
+ * @public
21
+ */
18
22
  export interface BatchGetChannelRequest {
19
23
  /**
20
24
  * <p>Array of ARNs, one per channel.</p>
21
25
  */
22
26
  arns: string[] | undefined;
23
27
  }
28
+ /**
29
+ * @public
30
+ */
24
31
  export declare enum ChannelLatencyMode {
25
32
  LowLatency = "LOW",
26
33
  NormalLatency = "NORMAL"
27
34
  }
35
+ /**
36
+ * @public
37
+ */
28
38
  export declare enum ChannelType {
29
39
  BasicChannelType = "BASIC",
30
40
  StandardChannelType = "STANDARD"
31
41
  }
32
42
  /**
43
+ * @public
33
44
  * <p>Object specifying a channel.</p>
34
45
  */
35
46
  export interface Channel {
@@ -100,6 +111,7 @@ export interface Channel {
100
111
  tags?: Record<string, string>;
101
112
  }
102
113
  /**
114
+ * @public
103
115
  * <p>Error related to a specific channel, specified by its ARN.</p>
104
116
  */
105
117
  export interface BatchError {
@@ -116,6 +128,9 @@ export interface BatchError {
116
128
  */
117
129
  message?: string;
118
130
  }
131
+ /**
132
+ * @public
133
+ */
119
134
  export interface BatchGetChannelResponse {
120
135
  /**
121
136
  * <p/>
@@ -126,6 +141,9 @@ export interface BatchGetChannelResponse {
126
141
  */
127
142
  errors?: BatchError[];
128
143
  }
144
+ /**
145
+ * @public
146
+ */
129
147
  export interface BatchGetStreamKeyRequest {
130
148
  /**
131
149
  * <p>Array of ARNs, one per stream key.</p>
@@ -133,6 +151,7 @@ export interface BatchGetStreamKeyRequest {
133
151
  arns: string[] | undefined;
134
152
  }
135
153
  /**
154
+ * @public
136
155
  * <p>Object specifying a stream key.</p>
137
156
  */
138
157
  export interface StreamKey {
@@ -156,6 +175,9 @@ export interface StreamKey {
156
175
  */
157
176
  tags?: Record<string, string>;
158
177
  }
178
+ /**
179
+ * @public
180
+ */
159
181
  export interface BatchGetStreamKeyResponse {
160
182
  /**
161
183
  * <p/>
@@ -166,6 +188,9 @@ export interface BatchGetStreamKeyResponse {
166
188
  */
167
189
  errors?: BatchError[];
168
190
  }
191
+ /**
192
+ * @public
193
+ */
169
194
  export interface CreateChannelRequest {
170
195
  /**
171
196
  * <p>Channel name.</p>
@@ -219,6 +244,9 @@ export interface CreateChannelRequest {
219
244
  */
220
245
  tags?: Record<string, string>;
221
246
  }
247
+ /**
248
+ * @public
249
+ */
222
250
  export interface CreateChannelResponse {
223
251
  /**
224
252
  * <p/>
@@ -230,6 +258,7 @@ export interface CreateChannelResponse {
230
258
  streamKey?: StreamKey;
231
259
  }
232
260
  /**
261
+ * @public
233
262
  * <p/>
234
263
  */
235
264
  export declare class PendingVerification extends __BaseException {
@@ -245,6 +274,7 @@ export declare class PendingVerification extends __BaseException {
245
274
  constructor(opts: __ExceptionOptionType<PendingVerification, __BaseException>);
246
275
  }
247
276
  /**
277
+ * @public
248
278
  * <p/>
249
279
  */
250
280
  export declare class ResourceNotFoundException extends __BaseException {
@@ -260,6 +290,7 @@ export declare class ResourceNotFoundException extends __BaseException {
260
290
  constructor(opts: __ExceptionOptionType<ResourceNotFoundException, __BaseException>);
261
291
  }
262
292
  /**
293
+ * @public
263
294
  * <p/>
264
295
  */
265
296
  export declare class ServiceQuotaExceededException extends __BaseException {
@@ -275,6 +306,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
275
306
  constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
276
307
  }
277
308
  /**
309
+ * @public
278
310
  * <p/>
279
311
  */
280
312
  export declare class ValidationException extends __BaseException {
@@ -290,6 +322,7 @@ export declare class ValidationException extends __BaseException {
290
322
  constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
291
323
  }
292
324
  /**
325
+ * @public
293
326
  * <p/>
294
327
  */
295
328
  export declare class ConflictException extends __BaseException {
@@ -305,6 +338,7 @@ export declare class ConflictException extends __BaseException {
305
338
  constructor(opts: __ExceptionOptionType<ConflictException, __BaseException>);
306
339
  }
307
340
  /**
341
+ * @public
308
342
  * <p>A complex type that describes an S3 location where recorded videos will be stored.</p>
309
343
  */
310
344
  export interface S3DestinationConfiguration {
@@ -314,6 +348,7 @@ export interface S3DestinationConfiguration {
314
348
  bucketName: string | undefined;
315
349
  }
316
350
  /**
351
+ * @public
317
352
  * <p>A complex type that describes a location where recorded videos will be stored. Each member
318
353
  * represents a type of destination configuration. For recording, you define one and only one
319
354
  * type of destination configuration.</p>
@@ -324,11 +359,15 @@ export interface DestinationConfiguration {
324
359
  */
325
360
  s3?: S3DestinationConfiguration;
326
361
  }
362
+ /**
363
+ * @public
364
+ */
327
365
  export declare enum RecordingMode {
328
366
  Disabled = "DISABLED",
329
367
  Interval = "INTERVAL"
330
368
  }
331
369
  /**
370
+ * @public
332
371
  * <p>An object representing a configuration of thumbnails for recorded video.</p>
333
372
  */
334
373
  export interface ThumbnailConfiguration {
@@ -350,6 +389,9 @@ export interface ThumbnailConfiguration {
350
389
  */
351
390
  targetIntervalSeconds?: number;
352
391
  }
392
+ /**
393
+ * @public
394
+ */
353
395
  export interface CreateRecordingConfigurationRequest {
354
396
  /**
355
397
  * <p>Recording-configuration name. The value does not need to be unique.</p>
@@ -378,12 +420,16 @@ export interface CreateRecordingConfigurationRequest {
378
420
  */
379
421
  recordingReconnectWindowSeconds?: number;
380
422
  }
423
+ /**
424
+ * @public
425
+ */
381
426
  export declare enum RecordingConfigurationState {
382
427
  Active = "ACTIVE",
383
428
  CreateFailed = "CREATE_FAILED",
384
429
  Creating = "CREATING"
385
430
  }
386
431
  /**
432
+ * @public
387
433
  * <p>An object representing a configuration to record a channel stream.</p>
388
434
  */
389
435
  export interface RecordingConfiguration {
@@ -422,6 +468,9 @@ export interface RecordingConfiguration {
422
468
  */
423
469
  recordingReconnectWindowSeconds?: number;
424
470
  }
471
+ /**
472
+ * @public
473
+ */
425
474
  export interface CreateRecordingConfigurationResponse {
426
475
  /**
427
476
  *
@@ -429,6 +478,7 @@ export interface CreateRecordingConfigurationResponse {
429
478
  recordingConfiguration?: RecordingConfiguration;
430
479
  }
431
480
  /**
481
+ * @public
432
482
  * <p/>
433
483
  */
434
484
  export declare class InternalServerException extends __BaseException {
@@ -443,6 +493,9 @@ export declare class InternalServerException extends __BaseException {
443
493
  */
444
494
  constructor(opts: __ExceptionOptionType<InternalServerException, __BaseException>);
445
495
  }
496
+ /**
497
+ * @public
498
+ */
446
499
  export interface CreateStreamKeyRequest {
447
500
  /**
448
501
  * <p>ARN of the channel for which to create the stream key.</p>
@@ -456,50 +509,77 @@ export interface CreateStreamKeyRequest {
456
509
  */
457
510
  tags?: Record<string, string>;
458
511
  }
512
+ /**
513
+ * @public
514
+ */
459
515
  export interface CreateStreamKeyResponse {
460
516
  /**
461
517
  * <p>Stream key used to authenticate an RTMPS stream for ingestion.</p>
462
518
  */
463
519
  streamKey?: StreamKey;
464
520
  }
521
+ /**
522
+ * @public
523
+ */
465
524
  export interface DeleteChannelRequest {
466
525
  /**
467
526
  * <p>ARN of the channel to be deleted.</p>
468
527
  */
469
528
  arn: string | undefined;
470
529
  }
530
+ /**
531
+ * @public
532
+ */
471
533
  export interface DeletePlaybackKeyPairRequest {
472
534
  /**
473
535
  * <p>ARN of the key pair to be deleted.</p>
474
536
  */
475
537
  arn: string | undefined;
476
538
  }
539
+ /**
540
+ * @public
541
+ */
477
542
  export interface DeletePlaybackKeyPairResponse {
478
543
  }
544
+ /**
545
+ * @public
546
+ */
479
547
  export interface DeleteRecordingConfigurationRequest {
480
548
  /**
481
549
  * <p>ARN of the recording configuration to be deleted.</p>
482
550
  */
483
551
  arn: string | undefined;
484
552
  }
553
+ /**
554
+ * @public
555
+ */
485
556
  export interface DeleteStreamKeyRequest {
486
557
  /**
487
558
  * <p>ARN of the stream key to be deleted.</p>
488
559
  */
489
560
  arn: string | undefined;
490
561
  }
562
+ /**
563
+ * @public
564
+ */
491
565
  export interface GetChannelRequest {
492
566
  /**
493
567
  * <p>ARN of the channel for which the configuration is to be retrieved.</p>
494
568
  */
495
569
  arn: string | undefined;
496
570
  }
571
+ /**
572
+ * @public
573
+ */
497
574
  export interface GetChannelResponse {
498
575
  /**
499
576
  * <p/>
500
577
  */
501
578
  channel?: Channel;
502
579
  }
580
+ /**
581
+ * @public
582
+ */
503
583
  export interface GetPlaybackKeyPairRequest {
504
584
  /**
505
585
  * <p>ARN of the key pair to be returned.</p>
@@ -507,6 +587,7 @@ export interface GetPlaybackKeyPairRequest {
507
587
  arn: string | undefined;
508
588
  }
509
589
  /**
590
+ * @public
510
591
  * <p>A key pair used to sign and validate a playback authorization token.</p>
511
592
  */
512
593
  export interface PlaybackKeyPair {
@@ -530,18 +611,27 @@ export interface PlaybackKeyPair {
530
611
  */
531
612
  tags?: Record<string, string>;
532
613
  }
614
+ /**
615
+ * @public
616
+ */
533
617
  export interface GetPlaybackKeyPairResponse {
534
618
  /**
535
619
  *
536
620
  */
537
621
  keyPair?: PlaybackKeyPair;
538
622
  }
623
+ /**
624
+ * @public
625
+ */
539
626
  export interface GetRecordingConfigurationRequest {
540
627
  /**
541
628
  * <p>ARN of the recording configuration to be retrieved.</p>
542
629
  */
543
630
  arn: string | undefined;
544
631
  }
632
+ /**
633
+ * @public
634
+ */
545
635
  export interface GetRecordingConfigurationResponse {
546
636
  /**
547
637
  *
@@ -549,6 +639,7 @@ export interface GetRecordingConfigurationResponse {
549
639
  recordingConfiguration?: RecordingConfiguration;
550
640
  }
551
641
  /**
642
+ * @public
552
643
  * <p/>
553
644
  */
554
645
  export declare class ChannelNotBroadcasting extends __BaseException {
@@ -563,22 +654,32 @@ export declare class ChannelNotBroadcasting extends __BaseException {
563
654
  */
564
655
  constructor(opts: __ExceptionOptionType<ChannelNotBroadcasting, __BaseException>);
565
656
  }
657
+ /**
658
+ * @public
659
+ */
566
660
  export interface GetStreamRequest {
567
661
  /**
568
662
  * <p>Channel ARN for stream to be accessed.</p>
569
663
  */
570
664
  channelArn: string | undefined;
571
665
  }
666
+ /**
667
+ * @public
668
+ */
572
669
  export declare enum StreamHealth {
573
670
  Starving = "STARVING",
574
671
  StreamHealthy = "HEALTHY",
575
672
  Unknown = "UNKNOWN"
576
673
  }
674
+ /**
675
+ * @public
676
+ */
577
677
  export declare enum StreamState {
578
678
  StreamLive = "LIVE",
579
679
  StreamOffline = "OFFLINE"
580
680
  }
581
681
  /**
682
+ * @public
582
683
  * <p>Specifies a live video stream that has been ingested and distributed.</p>
583
684
  */
584
685
  export interface _Stream {
@@ -617,24 +718,36 @@ export interface _Stream {
617
718
  */
618
719
  viewerCount?: number;
619
720
  }
721
+ /**
722
+ * @public
723
+ */
620
724
  export interface GetStreamResponse {
621
725
  /**
622
726
  * <p/>
623
727
  */
624
728
  stream?: _Stream;
625
729
  }
730
+ /**
731
+ * @public
732
+ */
626
733
  export interface GetStreamKeyRequest {
627
734
  /**
628
735
  * <p>ARN for the stream key to be retrieved.</p>
629
736
  */
630
737
  arn: string | undefined;
631
738
  }
739
+ /**
740
+ * @public
741
+ */
632
742
  export interface GetStreamKeyResponse {
633
743
  /**
634
744
  *
635
745
  */
636
746
  streamKey?: StreamKey;
637
747
  }
748
+ /**
749
+ * @public
750
+ */
638
751
  export interface GetStreamSessionRequest {
639
752
  /**
640
753
  * <p>ARN of the channel resource</p>
@@ -648,6 +761,7 @@ export interface GetStreamSessionRequest {
648
761
  streamId?: string;
649
762
  }
650
763
  /**
764
+ * @public
651
765
  * <p>Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in
652
766
  * an encoder). This is part of the <a>IngestConfiguration</a> object and used for
653
767
  * monitoring stream health.</p>
@@ -671,6 +785,7 @@ export interface AudioConfiguration {
671
785
  channels?: number;
672
786
  }
673
787
  /**
788
+ * @public
674
789
  * <p>Object specifying a stream’s video configuration, as set up by the broadcaster (usually in
675
790
  * an encoder). This is part of the <a>IngestConfiguration</a> object and used for
676
791
  * monitoring stream health.</p>
@@ -712,6 +827,7 @@ export interface VideoConfiguration {
712
827
  videoWidth?: number;
713
828
  }
714
829
  /**
830
+ * @public
715
831
  * <p>Object specifying the ingest configuration set up by the broadcaster, usually in an
716
832
  * encoder.</p>
717
833
  */
@@ -726,6 +842,7 @@ export interface IngestConfiguration {
726
842
  audio?: AudioConfiguration;
727
843
  }
728
844
  /**
845
+ * @public
729
846
  * <p>Object specifying a stream’s events. For a list of events, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html">Using Amazon EventBridge with Amazon
730
847
  * IVS</a>.</p>
731
848
  */
@@ -745,6 +862,7 @@ export interface StreamEvent {
745
862
  eventTime?: Date;
746
863
  }
747
864
  /**
865
+ * @public
748
866
  * <p>Object that captures the Amazon IVS configuration that the customer provisioned, the
749
867
  * ingest configurations that the broadcaster used, and the most recent Amazon IVS stream events
750
868
  * it encountered.</p>
@@ -783,12 +901,18 @@ export interface StreamSession {
783
901
  */
784
902
  truncatedEvents?: StreamEvent[];
785
903
  }
904
+ /**
905
+ * @public
906
+ */
786
907
  export interface GetStreamSessionResponse {
787
908
  /**
788
909
  * <p>List of stream details.</p>
789
910
  */
790
911
  streamSession?: StreamSession;
791
912
  }
913
+ /**
914
+ * @public
915
+ */
792
916
  export interface ImportPlaybackKeyPairRequest {
793
917
  /**
794
918
  * <p>The public portion of a customer-generated key pair.</p>
@@ -806,12 +930,18 @@ export interface ImportPlaybackKeyPairRequest {
806
930
  */
807
931
  tags?: Record<string, string>;
808
932
  }
933
+ /**
934
+ * @public
935
+ */
809
936
  export interface ImportPlaybackKeyPairResponse {
810
937
  /**
811
938
  * <p/>
812
939
  */
813
940
  keyPair?: PlaybackKeyPair;
814
941
  }
942
+ /**
943
+ * @public
944
+ */
815
945
  export interface ListChannelsRequest {
816
946
  /**
817
947
  * <p>Filters the channel list to match the specified name.</p>
@@ -832,6 +962,7 @@ export interface ListChannelsRequest {
832
962
  maxResults?: number;
833
963
  }
834
964
  /**
965
+ * @public
835
966
  * <p>Summary information about a channel.</p>
836
967
  */
837
968
  export interface ChannelSummary {
@@ -868,6 +999,9 @@ export interface ChannelSummary {
868
999
  */
869
1000
  tags?: Record<string, string>;
870
1001
  }
1002
+ /**
1003
+ * @public
1004
+ */
871
1005
  export interface ListChannelsResponse {
872
1006
  /**
873
1007
  * <p>List of the matching channels.</p>
@@ -879,6 +1013,9 @@ export interface ListChannelsResponse {
879
1013
  */
880
1014
  nextToken?: string;
881
1015
  }
1016
+ /**
1017
+ * @public
1018
+ */
882
1019
  export interface ListPlaybackKeyPairsRequest {
883
1020
  /**
884
1021
  * <p>The first key pair to retrieve. This is used for pagination; see the
@@ -892,6 +1029,7 @@ export interface ListPlaybackKeyPairsRequest {
892
1029
  maxResults?: number;
893
1030
  }
894
1031
  /**
1032
+ * @public
895
1033
  * <p>Summary information about a playback key pair.</p>
896
1034
  */
897
1035
  export interface PlaybackKeyPairSummary {
@@ -911,6 +1049,9 @@ export interface PlaybackKeyPairSummary {
911
1049
  */
912
1050
  tags?: Record<string, string>;
913
1051
  }
1052
+ /**
1053
+ * @public
1054
+ */
914
1055
  export interface ListPlaybackKeyPairsResponse {
915
1056
  /**
916
1057
  * <p>List of key pairs.</p>
@@ -922,6 +1063,9 @@ export interface ListPlaybackKeyPairsResponse {
922
1063
  */
923
1064
  nextToken?: string;
924
1065
  }
1066
+ /**
1067
+ * @public
1068
+ */
925
1069
  export interface ListRecordingConfigurationsRequest {
926
1070
  /**
927
1071
  * <p>The first recording configuration to retrieve. This is used for pagination; see the
@@ -935,6 +1079,7 @@ export interface ListRecordingConfigurationsRequest {
935
1079
  maxResults?: number;
936
1080
  }
937
1081
  /**
1082
+ * @public
938
1083
  * <p>Summary information about a RecordingConfiguration.</p>
939
1084
  */
940
1085
  export interface RecordingConfigurationSummary {
@@ -963,6 +1108,9 @@ export interface RecordingConfigurationSummary {
963
1108
  */
964
1109
  tags?: Record<string, string>;
965
1110
  }
1111
+ /**
1112
+ * @public
1113
+ */
966
1114
  export interface ListRecordingConfigurationsResponse {
967
1115
  /**
968
1116
  * <p>List of the matching recording configurations.</p>
@@ -974,6 +1122,9 @@ export interface ListRecordingConfigurationsResponse {
974
1122
  */
975
1123
  nextToken?: string;
976
1124
  }
1125
+ /**
1126
+ * @public
1127
+ */
977
1128
  export interface ListStreamKeysRequest {
978
1129
  /**
979
1130
  * <p>Channel ARN used to filter the list.</p>
@@ -990,6 +1141,7 @@ export interface ListStreamKeysRequest {
990
1141
  maxResults?: number;
991
1142
  }
992
1143
  /**
1144
+ * @public
993
1145
  * <p>Summary information about a stream key.</p>
994
1146
  */
995
1147
  export interface StreamKeySummary {
@@ -1009,6 +1161,9 @@ export interface StreamKeySummary {
1009
1161
  */
1010
1162
  tags?: Record<string, string>;
1011
1163
  }
1164
+ /**
1165
+ * @public
1166
+ */
1012
1167
  export interface ListStreamKeysResponse {
1013
1168
  /**
1014
1169
  * <p>List of stream keys.</p>
@@ -1021,6 +1176,7 @@ export interface ListStreamKeysResponse {
1021
1176
  nextToken?: string;
1022
1177
  }
1023
1178
  /**
1179
+ * @public
1024
1180
  * <p>Object specifying the stream attribute on which to filter.</p>
1025
1181
  */
1026
1182
  export interface StreamFilters {
@@ -1029,6 +1185,9 @@ export interface StreamFilters {
1029
1185
  */
1030
1186
  health?: StreamHealth | string;
1031
1187
  }
1188
+ /**
1189
+ * @public
1190
+ */
1032
1191
  export interface ListStreamsRequest {
1033
1192
  /**
1034
1193
  * <p>Filters the stream list to match the specified criterion.</p>
@@ -1045,6 +1204,7 @@ export interface ListStreamsRequest {
1045
1204
  maxResults?: number;
1046
1205
  }
1047
1206
  /**
1207
+ * @public
1048
1208
  * <p>Summary information about a stream.</p>
1049
1209
  */
1050
1210
  export interface StreamSummary {
@@ -1078,6 +1238,9 @@ export interface StreamSummary {
1078
1238
  */
1079
1239
  startTime?: Date;
1080
1240
  }
1241
+ /**
1242
+ * @public
1243
+ */
1081
1244
  export interface ListStreamsResponse {
1082
1245
  /**
1083
1246
  * <p>List of streams.</p>
@@ -1089,6 +1252,9 @@ export interface ListStreamsResponse {
1089
1252
  */
1090
1253
  nextToken?: string;
1091
1254
  }
1255
+ /**
1256
+ * @public
1257
+ */
1092
1258
  export interface ListStreamSessionsRequest {
1093
1259
  /**
1094
1260
  * <p>Channel ARN used to filter the list.</p>
@@ -1105,6 +1271,7 @@ export interface ListStreamSessionsRequest {
1105
1271
  maxResults?: number;
1106
1272
  }
1107
1273
  /**
1274
+ * @public
1108
1275
  * <p>Summary information about a stream session.</p>
1109
1276
  */
1110
1277
  export interface StreamSessionSummary {
@@ -1127,6 +1294,9 @@ export interface StreamSessionSummary {
1127
1294
  */
1128
1295
  hasErrorEvent?: boolean;
1129
1296
  }
1297
+ /**
1298
+ * @public
1299
+ */
1130
1300
  export interface ListStreamSessionsResponse {
1131
1301
  /**
1132
1302
  * <p>List of stream sessions.</p>
@@ -1138,18 +1308,27 @@ export interface ListStreamSessionsResponse {
1138
1308
  */
1139
1309
  nextToken?: string;
1140
1310
  }
1311
+ /**
1312
+ * @public
1313
+ */
1141
1314
  export interface ListTagsForResourceRequest {
1142
1315
  /**
1143
1316
  * <p>The ARN of the resource to be retrieved. The ARN must be URL-encoded.</p>
1144
1317
  */
1145
1318
  resourceArn: string | undefined;
1146
1319
  }
1320
+ /**
1321
+ * @public
1322
+ */
1147
1323
  export interface ListTagsForResourceResponse {
1148
1324
  /**
1149
1325
  * <p>Tags attached to the resource. Array of maps, each of the form <code>string:string (key:value)</code>.</p>
1150
1326
  */
1151
1327
  tags: Record<string, string> | undefined;
1152
1328
  }
1329
+ /**
1330
+ * @public
1331
+ */
1153
1332
  export interface PutMetadataRequest {
1154
1333
  /**
1155
1334
  * <p>ARN of the channel into which metadata is inserted. This channel must have an active
@@ -1162,6 +1341,7 @@ export interface PutMetadataRequest {
1162
1341
  metadata: string | undefined;
1163
1342
  }
1164
1343
  /**
1344
+ * @public
1165
1345
  * <p/>
1166
1346
  */
1167
1347
  export declare class ThrottlingException extends __BaseException {
@@ -1176,15 +1356,22 @@ export declare class ThrottlingException extends __BaseException {
1176
1356
  */
1177
1357
  constructor(opts: __ExceptionOptionType<ThrottlingException, __BaseException>);
1178
1358
  }
1359
+ /**
1360
+ * @public
1361
+ */
1179
1362
  export interface StopStreamRequest {
1180
1363
  /**
1181
1364
  * <p>ARN of the channel for which the stream is to be stopped.</p>
1182
1365
  */
1183
1366
  channelArn: string | undefined;
1184
1367
  }
1368
+ /**
1369
+ * @public
1370
+ */
1185
1371
  export interface StopStreamResponse {
1186
1372
  }
1187
1373
  /**
1374
+ * @public
1188
1375
  * <p/>
1189
1376
  */
1190
1377
  export declare class StreamUnavailable extends __BaseException {
@@ -1199,6 +1386,9 @@ export declare class StreamUnavailable extends __BaseException {
1199
1386
  */
1200
1387
  constructor(opts: __ExceptionOptionType<StreamUnavailable, __BaseException>);
1201
1388
  }
1389
+ /**
1390
+ * @public
1391
+ */
1202
1392
  export interface TagResourceRequest {
1203
1393
  /**
1204
1394
  * <p>ARN of the resource for which tags are to be added or updated. The ARN must be
@@ -1213,8 +1403,14 @@ export interface TagResourceRequest {
1213
1403
  */
1214
1404
  tags: Record<string, string> | undefined;
1215
1405
  }
1406
+ /**
1407
+ * @public
1408
+ */
1216
1409
  export interface TagResourceResponse {
1217
1410
  }
1411
+ /**
1412
+ * @public
1413
+ */
1218
1414
  export interface UntagResourceRequest {
1219
1415
  /**
1220
1416
  * <p>ARN of the resource for which tags are to be removed. The ARN must be URL-encoded.</p>
@@ -1228,8 +1424,14 @@ export interface UntagResourceRequest {
1228
1424
  */
1229
1425
  tagKeys: string[] | undefined;
1230
1426
  }
1427
+ /**
1428
+ * @public
1429
+ */
1231
1430
  export interface UntagResourceResponse {
1232
1431
  }
1432
+ /**
1433
+ * @public
1434
+ */
1233
1435
  export interface UpdateChannelRequest {
1234
1436
  /**
1235
1437
  * <p>ARN of the channel to be updated.</p>
@@ -1280,32 +1482,15 @@ export interface UpdateChannelRequest {
1280
1482
  */
1281
1483
  recordingConfigurationArn?: string;
1282
1484
  }
1485
+ /**
1486
+ * @public
1487
+ */
1283
1488
  export interface UpdateChannelResponse {
1284
1489
  /**
1285
1490
  * <p>Object specifying a channel.</p>
1286
1491
  */
1287
1492
  channel?: Channel;
1288
1493
  }
1289
- /**
1290
- * @internal
1291
- */
1292
- export declare const BatchGetChannelRequestFilterSensitiveLog: (obj: BatchGetChannelRequest) => any;
1293
- /**
1294
- * @internal
1295
- */
1296
- export declare const ChannelFilterSensitiveLog: (obj: Channel) => any;
1297
- /**
1298
- * @internal
1299
- */
1300
- export declare const BatchErrorFilterSensitiveLog: (obj: BatchError) => any;
1301
- /**
1302
- * @internal
1303
- */
1304
- export declare const BatchGetChannelResponseFilterSensitiveLog: (obj: BatchGetChannelResponse) => any;
1305
- /**
1306
- * @internal
1307
- */
1308
- export declare const BatchGetStreamKeyRequestFilterSensitiveLog: (obj: BatchGetStreamKeyRequest) => any;
1309
1494
  /**
1310
1495
  * @internal
1311
1496
  */
@@ -1314,267 +1499,19 @@ export declare const StreamKeyFilterSensitiveLog: (obj: StreamKey) => any;
1314
1499
  * @internal
1315
1500
  */
1316
1501
  export declare const BatchGetStreamKeyResponseFilterSensitiveLog: (obj: BatchGetStreamKeyResponse) => any;
1317
- /**
1318
- * @internal
1319
- */
1320
- export declare const CreateChannelRequestFilterSensitiveLog: (obj: CreateChannelRequest) => any;
1321
1502
  /**
1322
1503
  * @internal
1323
1504
  */
1324
1505
  export declare const CreateChannelResponseFilterSensitiveLog: (obj: CreateChannelResponse) => any;
1325
- /**
1326
- * @internal
1327
- */
1328
- export declare const S3DestinationConfigurationFilterSensitiveLog: (obj: S3DestinationConfiguration) => any;
1329
- /**
1330
- * @internal
1331
- */
1332
- export declare const DestinationConfigurationFilterSensitiveLog: (obj: DestinationConfiguration) => any;
1333
- /**
1334
- * @internal
1335
- */
1336
- export declare const ThumbnailConfigurationFilterSensitiveLog: (obj: ThumbnailConfiguration) => any;
1337
- /**
1338
- * @internal
1339
- */
1340
- export declare const CreateRecordingConfigurationRequestFilterSensitiveLog: (obj: CreateRecordingConfigurationRequest) => any;
1341
- /**
1342
- * @internal
1343
- */
1344
- export declare const RecordingConfigurationFilterSensitiveLog: (obj: RecordingConfiguration) => any;
1345
- /**
1346
- * @internal
1347
- */
1348
- export declare const CreateRecordingConfigurationResponseFilterSensitiveLog: (obj: CreateRecordingConfigurationResponse) => any;
1349
- /**
1350
- * @internal
1351
- */
1352
- export declare const CreateStreamKeyRequestFilterSensitiveLog: (obj: CreateStreamKeyRequest) => any;
1353
1506
  /**
1354
1507
  * @internal
1355
1508
  */
1356
1509
  export declare const CreateStreamKeyResponseFilterSensitiveLog: (obj: CreateStreamKeyResponse) => any;
1357
- /**
1358
- * @internal
1359
- */
1360
- export declare const DeleteChannelRequestFilterSensitiveLog: (obj: DeleteChannelRequest) => any;
1361
- /**
1362
- * @internal
1363
- */
1364
- export declare const DeletePlaybackKeyPairRequestFilterSensitiveLog: (obj: DeletePlaybackKeyPairRequest) => any;
1365
- /**
1366
- * @internal
1367
- */
1368
- export declare const DeletePlaybackKeyPairResponseFilterSensitiveLog: (obj: DeletePlaybackKeyPairResponse) => any;
1369
- /**
1370
- * @internal
1371
- */
1372
- export declare const DeleteRecordingConfigurationRequestFilterSensitiveLog: (obj: DeleteRecordingConfigurationRequest) => any;
1373
- /**
1374
- * @internal
1375
- */
1376
- export declare const DeleteStreamKeyRequestFilterSensitiveLog: (obj: DeleteStreamKeyRequest) => any;
1377
- /**
1378
- * @internal
1379
- */
1380
- export declare const GetChannelRequestFilterSensitiveLog: (obj: GetChannelRequest) => any;
1381
- /**
1382
- * @internal
1383
- */
1384
- export declare const GetChannelResponseFilterSensitiveLog: (obj: GetChannelResponse) => any;
1385
- /**
1386
- * @internal
1387
- */
1388
- export declare const GetPlaybackKeyPairRequestFilterSensitiveLog: (obj: GetPlaybackKeyPairRequest) => any;
1389
- /**
1390
- * @internal
1391
- */
1392
- export declare const PlaybackKeyPairFilterSensitiveLog: (obj: PlaybackKeyPair) => any;
1393
- /**
1394
- * @internal
1395
- */
1396
- export declare const GetPlaybackKeyPairResponseFilterSensitiveLog: (obj: GetPlaybackKeyPairResponse) => any;
1397
- /**
1398
- * @internal
1399
- */
1400
- export declare const GetRecordingConfigurationRequestFilterSensitiveLog: (obj: GetRecordingConfigurationRequest) => any;
1401
- /**
1402
- * @internal
1403
- */
1404
- export declare const GetRecordingConfigurationResponseFilterSensitiveLog: (obj: GetRecordingConfigurationResponse) => any;
1405
- /**
1406
- * @internal
1407
- */
1408
- export declare const GetStreamRequestFilterSensitiveLog: (obj: GetStreamRequest) => any;
1409
- /**
1410
- * @internal
1411
- */
1412
- export declare const _StreamFilterSensitiveLog: (obj: _Stream) => any;
1413
- /**
1414
- * @internal
1415
- */
1416
- export declare const GetStreamResponseFilterSensitiveLog: (obj: GetStreamResponse) => any;
1417
- /**
1418
- * @internal
1419
- */
1420
- export declare const GetStreamKeyRequestFilterSensitiveLog: (obj: GetStreamKeyRequest) => any;
1421
1510
  /**
1422
1511
  * @internal
1423
1512
  */
1424
1513
  export declare const GetStreamKeyResponseFilterSensitiveLog: (obj: GetStreamKeyResponse) => any;
1425
- /**
1426
- * @internal
1427
- */
1428
- export declare const GetStreamSessionRequestFilterSensitiveLog: (obj: GetStreamSessionRequest) => any;
1429
- /**
1430
- * @internal
1431
- */
1432
- export declare const AudioConfigurationFilterSensitiveLog: (obj: AudioConfiguration) => any;
1433
- /**
1434
- * @internal
1435
- */
1436
- export declare const VideoConfigurationFilterSensitiveLog: (obj: VideoConfiguration) => any;
1437
- /**
1438
- * @internal
1439
- */
1440
- export declare const IngestConfigurationFilterSensitiveLog: (obj: IngestConfiguration) => any;
1441
- /**
1442
- * @internal
1443
- */
1444
- export declare const StreamEventFilterSensitiveLog: (obj: StreamEvent) => any;
1445
- /**
1446
- * @internal
1447
- */
1448
- export declare const StreamSessionFilterSensitiveLog: (obj: StreamSession) => any;
1449
- /**
1450
- * @internal
1451
- */
1452
- export declare const GetStreamSessionResponseFilterSensitiveLog: (obj: GetStreamSessionResponse) => any;
1453
- /**
1454
- * @internal
1455
- */
1456
- export declare const ImportPlaybackKeyPairRequestFilterSensitiveLog: (obj: ImportPlaybackKeyPairRequest) => any;
1457
- /**
1458
- * @internal
1459
- */
1460
- export declare const ImportPlaybackKeyPairResponseFilterSensitiveLog: (obj: ImportPlaybackKeyPairResponse) => any;
1461
- /**
1462
- * @internal
1463
- */
1464
- export declare const ListChannelsRequestFilterSensitiveLog: (obj: ListChannelsRequest) => any;
1465
- /**
1466
- * @internal
1467
- */
1468
- export declare const ChannelSummaryFilterSensitiveLog: (obj: ChannelSummary) => any;
1469
- /**
1470
- * @internal
1471
- */
1472
- export declare const ListChannelsResponseFilterSensitiveLog: (obj: ListChannelsResponse) => any;
1473
- /**
1474
- * @internal
1475
- */
1476
- export declare const ListPlaybackKeyPairsRequestFilterSensitiveLog: (obj: ListPlaybackKeyPairsRequest) => any;
1477
- /**
1478
- * @internal
1479
- */
1480
- export declare const PlaybackKeyPairSummaryFilterSensitiveLog: (obj: PlaybackKeyPairSummary) => any;
1481
- /**
1482
- * @internal
1483
- */
1484
- export declare const ListPlaybackKeyPairsResponseFilterSensitiveLog: (obj: ListPlaybackKeyPairsResponse) => any;
1485
- /**
1486
- * @internal
1487
- */
1488
- export declare const ListRecordingConfigurationsRequestFilterSensitiveLog: (obj: ListRecordingConfigurationsRequest) => any;
1489
- /**
1490
- * @internal
1491
- */
1492
- export declare const RecordingConfigurationSummaryFilterSensitiveLog: (obj: RecordingConfigurationSummary) => any;
1493
- /**
1494
- * @internal
1495
- */
1496
- export declare const ListRecordingConfigurationsResponseFilterSensitiveLog: (obj: ListRecordingConfigurationsResponse) => any;
1497
- /**
1498
- * @internal
1499
- */
1500
- export declare const ListStreamKeysRequestFilterSensitiveLog: (obj: ListStreamKeysRequest) => any;
1501
- /**
1502
- * @internal
1503
- */
1504
- export declare const StreamKeySummaryFilterSensitiveLog: (obj: StreamKeySummary) => any;
1505
- /**
1506
- * @internal
1507
- */
1508
- export declare const ListStreamKeysResponseFilterSensitiveLog: (obj: ListStreamKeysResponse) => any;
1509
- /**
1510
- * @internal
1511
- */
1512
- export declare const StreamFiltersFilterSensitiveLog: (obj: StreamFilters) => any;
1513
- /**
1514
- * @internal
1515
- */
1516
- export declare const ListStreamsRequestFilterSensitiveLog: (obj: ListStreamsRequest) => any;
1517
- /**
1518
- * @internal
1519
- */
1520
- export declare const StreamSummaryFilterSensitiveLog: (obj: StreamSummary) => any;
1521
- /**
1522
- * @internal
1523
- */
1524
- export declare const ListStreamsResponseFilterSensitiveLog: (obj: ListStreamsResponse) => any;
1525
- /**
1526
- * @internal
1527
- */
1528
- export declare const ListStreamSessionsRequestFilterSensitiveLog: (obj: ListStreamSessionsRequest) => any;
1529
- /**
1530
- * @internal
1531
- */
1532
- export declare const StreamSessionSummaryFilterSensitiveLog: (obj: StreamSessionSummary) => any;
1533
- /**
1534
- * @internal
1535
- */
1536
- export declare const ListStreamSessionsResponseFilterSensitiveLog: (obj: ListStreamSessionsResponse) => any;
1537
- /**
1538
- * @internal
1539
- */
1540
- export declare const ListTagsForResourceRequestFilterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
1541
- /**
1542
- * @internal
1543
- */
1544
- export declare const ListTagsForResourceResponseFilterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
1545
1514
  /**
1546
1515
  * @internal
1547
1516
  */
1548
1517
  export declare const PutMetadataRequestFilterSensitiveLog: (obj: PutMetadataRequest) => any;
1549
- /**
1550
- * @internal
1551
- */
1552
- export declare const StopStreamRequestFilterSensitiveLog: (obj: StopStreamRequest) => any;
1553
- /**
1554
- * @internal
1555
- */
1556
- export declare const StopStreamResponseFilterSensitiveLog: (obj: StopStreamResponse) => any;
1557
- /**
1558
- * @internal
1559
- */
1560
- export declare const TagResourceRequestFilterSensitiveLog: (obj: TagResourceRequest) => any;
1561
- /**
1562
- * @internal
1563
- */
1564
- export declare const TagResourceResponseFilterSensitiveLog: (obj: TagResourceResponse) => any;
1565
- /**
1566
- * @internal
1567
- */
1568
- export declare const UntagResourceRequestFilterSensitiveLog: (obj: UntagResourceRequest) => any;
1569
- /**
1570
- * @internal
1571
- */
1572
- export declare const UntagResourceResponseFilterSensitiveLog: (obj: UntagResourceResponse) => any;
1573
- /**
1574
- * @internal
1575
- */
1576
- export declare const UpdateChannelRequestFilterSensitiveLog: (obj: UpdateChannelRequest) => any;
1577
- /**
1578
- * @internal
1579
- */
1580
- export declare const UpdateChannelResponseFilterSensitiveLog: (obj: UpdateChannelResponse) => any;