ivs.d.ts
29.2 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class IVS extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: IVS.Types.ClientConfiguration)
config: Config & IVS.Types.ClientConfiguration;
/**
* Performs GetChannel on multiple ARNs simultaneously.
*/
batchGetChannel(params: IVS.Types.BatchGetChannelRequest, callback?: (err: AWSError, data: IVS.Types.BatchGetChannelResponse) => void): Request<IVS.Types.BatchGetChannelResponse, AWSError>;
/**
* Performs GetChannel on multiple ARNs simultaneously.
*/
batchGetChannel(callback?: (err: AWSError, data: IVS.Types.BatchGetChannelResponse) => void): Request<IVS.Types.BatchGetChannelResponse, AWSError>;
/**
* Performs GetStreamKey on multiple ARNs simultaneously.
*/
batchGetStreamKey(params: IVS.Types.BatchGetStreamKeyRequest, callback?: (err: AWSError, data: IVS.Types.BatchGetStreamKeyResponse) => void): Request<IVS.Types.BatchGetStreamKeyResponse, AWSError>;
/**
* Performs GetStreamKey on multiple ARNs simultaneously.
*/
batchGetStreamKey(callback?: (err: AWSError, data: IVS.Types.BatchGetStreamKeyResponse) => void): Request<IVS.Types.BatchGetStreamKeyResponse, AWSError>;
/**
* Creates a new channel and an associated stream key to start streaming.
*/
createChannel(params: IVS.Types.CreateChannelRequest, callback?: (err: AWSError, data: IVS.Types.CreateChannelResponse) => void): Request<IVS.Types.CreateChannelResponse, AWSError>;
/**
* Creates a new channel and an associated stream key to start streaming.
*/
createChannel(callback?: (err: AWSError, data: IVS.Types.CreateChannelResponse) => void): Request<IVS.Types.CreateChannelResponse, AWSError>;
/**
* Creates a stream key, used to initiate a stream, for the specified channel ARN. Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.
*/
createStreamKey(params: IVS.Types.CreateStreamKeyRequest, callback?: (err: AWSError, data: IVS.Types.CreateStreamKeyResponse) => void): Request<IVS.Types.CreateStreamKeyResponse, AWSError>;
/**
* Creates a stream key, used to initiate a stream, for the specified channel ARN. Note that CreateChannel creates a stream key. If you subsequently use CreateStreamKey on the same channel, it will fail because a stream key already exists and there is a limit of 1 stream key per channel. To reset the stream key on a channel, use DeleteStreamKey and then CreateStreamKey.
*/
createStreamKey(callback?: (err: AWSError, data: IVS.Types.CreateStreamKeyResponse) => void): Request<IVS.Types.CreateStreamKeyResponse, AWSError>;
/**
* Deletes the specified channel and its associated stream keys.
*/
deleteChannel(params: IVS.Types.DeleteChannelRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the specified channel and its associated stream keys.
*/
deleteChannel(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey.
*/
deletePlaybackKeyPair(params: IVS.Types.DeletePlaybackKeyPairRequest, callback?: (err: AWSError, data: IVS.Types.DeletePlaybackKeyPairResponse) => void): Request<IVS.Types.DeletePlaybackKeyPairResponse, AWSError>;
/**
* Deletes a specified authorization key pair. This invalidates future viewer tokens generated using the key pair’s privateKey.
*/
deletePlaybackKeyPair(callback?: (err: AWSError, data: IVS.Types.DeletePlaybackKeyPairResponse) => void): Request<IVS.Types.DeletePlaybackKeyPairResponse, AWSError>;
/**
* Deletes the stream key for the specified ARN, so it can no longer be used to stream.
*/
deleteStreamKey(params: IVS.Types.DeleteStreamKeyRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Deletes the stream key for the specified ARN, so it can no longer be used to stream.
*/
deleteStreamKey(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
*/
getChannel(params: IVS.Types.GetChannelRequest, callback?: (err: AWSError, data: IVS.Types.GetChannelResponse) => void): Request<IVS.Types.GetChannelResponse, AWSError>;
/**
* Gets the channel configuration for the specified channel ARN. See also BatchGetChannel.
*/
getChannel(callback?: (err: AWSError, data: IVS.Types.GetChannelResponse) => void): Request<IVS.Types.GetChannelResponse, AWSError>;
/**
* Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to authorized channels.
*/
getPlaybackKeyPair(params: IVS.Types.GetPlaybackKeyPairRequest, callback?: (err: AWSError, data: IVS.Types.GetPlaybackKeyPairResponse) => void): Request<IVS.Types.GetPlaybackKeyPairResponse, AWSError>;
/**
* Gets a specified playback authorization key pair and returns the arn and fingerprint. The privateKey held by the caller can be used to generate viewer authorization tokens, to grant viewers access to authorized channels.
*/
getPlaybackKeyPair(callback?: (err: AWSError, data: IVS.Types.GetPlaybackKeyPairResponse) => void): Request<IVS.Types.GetPlaybackKeyPairResponse, AWSError>;
/**
* Gets information about the active (live) stream on a specified channel.
*/
getStream(params: IVS.Types.GetStreamRequest, callback?: (err: AWSError, data: IVS.Types.GetStreamResponse) => void): Request<IVS.Types.GetStreamResponse, AWSError>;
/**
* Gets information about the active (live) stream on a specified channel.
*/
getStream(callback?: (err: AWSError, data: IVS.Types.GetStreamResponse) => void): Request<IVS.Types.GetStreamResponse, AWSError>;
/**
* Gets stream-key information for a specified ARN.
*/
getStreamKey(params: IVS.Types.GetStreamKeyRequest, callback?: (err: AWSError, data: IVS.Types.GetStreamKeyResponse) => void): Request<IVS.Types.GetStreamKeyResponse, AWSError>;
/**
* Gets stream-key information for a specified ARN.
*/
getStreamKey(callback?: (err: AWSError, data: IVS.Types.GetStreamKeyResponse) => void): Request<IVS.Types.GetStreamKeyResponse, AWSError>;
/**
* Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to authorized channels.
*/
importPlaybackKeyPair(params: IVS.Types.ImportPlaybackKeyPairRequest, callback?: (err: AWSError, data: IVS.Types.ImportPlaybackKeyPairResponse) => void): Request<IVS.Types.ImportPlaybackKeyPairResponse, AWSError>;
/**
* Imports the public portion of a new key pair and returns its arn and fingerprint. The privateKey can then be used to generate viewer authorization tokens, to grant viewers access to authorized channels.
*/
importPlaybackKeyPair(callback?: (err: AWSError, data: IVS.Types.ImportPlaybackKeyPairResponse) => void): Request<IVS.Types.ImportPlaybackKeyPairResponse, AWSError>;
/**
* Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified string.
*/
listChannels(params: IVS.Types.ListChannelsRequest, callback?: (err: AWSError, data: IVS.Types.ListChannelsResponse) => void): Request<IVS.Types.ListChannelsResponse, AWSError>;
/**
* Gets summary information about all channels in your account, in the AWS region where the API request is processed. This list can be filtered to match a specified string.
*/
listChannels(callback?: (err: AWSError, data: IVS.Types.ListChannelsResponse) => void): Request<IVS.Types.ListChannelsResponse, AWSError>;
/**
* Gets summary information about playback key pairs.
*/
listPlaybackKeyPairs(params: IVS.Types.ListPlaybackKeyPairsRequest, callback?: (err: AWSError, data: IVS.Types.ListPlaybackKeyPairsResponse) => void): Request<IVS.Types.ListPlaybackKeyPairsResponse, AWSError>;
/**
* Gets summary information about playback key pairs.
*/
listPlaybackKeyPairs(callback?: (err: AWSError, data: IVS.Types.ListPlaybackKeyPairsResponse) => void): Request<IVS.Types.ListPlaybackKeyPairsResponse, AWSError>;
/**
* Gets summary information about stream keys for the specified channel.
*/
listStreamKeys(params: IVS.Types.ListStreamKeysRequest, callback?: (err: AWSError, data: IVS.Types.ListStreamKeysResponse) => void): Request<IVS.Types.ListStreamKeysResponse, AWSError>;
/**
* Gets summary information about stream keys for the specified channel.
*/
listStreamKeys(callback?: (err: AWSError, data: IVS.Types.ListStreamKeysResponse) => void): Request<IVS.Types.ListStreamKeysResponse, AWSError>;
/**
* Gets summary information about live streams in your account, in the AWS region where the API request is processed.
*/
listStreams(params: IVS.Types.ListStreamsRequest, callback?: (err: AWSError, data: IVS.Types.ListStreamsResponse) => void): Request<IVS.Types.ListStreamsResponse, AWSError>;
/**
* Gets summary information about live streams in your account, in the AWS region where the API request is processed.
*/
listStreams(callback?: (err: AWSError, data: IVS.Types.ListStreamsResponse) => void): Request<IVS.Types.ListStreamsResponse, AWSError>;
/**
* Gets information about AWS tags for the specified ARN.
*/
listTagsForResource(params: IVS.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: IVS.Types.ListTagsForResourceResponse) => void): Request<IVS.Types.ListTagsForResourceResponse, AWSError>;
/**
* Gets information about AWS tags for the specified ARN.
*/
listTagsForResource(callback?: (err: AWSError, data: IVS.Types.ListTagsForResourceResponse) => void): Request<IVS.Types.ListTagsForResourceResponse, AWSError>;
/**
* Inserts metadata into an RTMPS stream for the specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.
*/
putMetadata(params: IVS.Types.PutMetadataRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Inserts metadata into an RTMPS stream for the specified channel. A maximum of 5 requests per second per channel is allowed, each with a maximum 1KB payload.
*/
putMetadata(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel. Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.
*/
stopStream(params: IVS.Types.StopStreamRequest, callback?: (err: AWSError, data: IVS.Types.StopStreamResponse) => void): Request<IVS.Types.StopStreamResponse, AWSError>;
/**
* Disconnects the incoming RTMPS stream for the specified channel. Can be used in conjunction with DeleteStreamKey to prevent further streaming to a channel. Many streaming client-software libraries automatically reconnect a dropped RTMPS session, so to stop the stream permanently, you may want to first revoke the streamKey attached to the channel.
*/
stopStream(callback?: (err: AWSError, data: IVS.Types.StopStreamResponse) => void): Request<IVS.Types.StopStreamResponse, AWSError>;
/**
* Adds or updates tags for the AWS resource with the specified ARN.
*/
tagResource(params: IVS.Types.TagResourceRequest, callback?: (err: AWSError, data: IVS.Types.TagResourceResponse) => void): Request<IVS.Types.TagResourceResponse, AWSError>;
/**
* Adds or updates tags for the AWS resource with the specified ARN.
*/
tagResource(callback?: (err: AWSError, data: IVS.Types.TagResourceResponse) => void): Request<IVS.Types.TagResourceResponse, AWSError>;
/**
* Removes tags from the resource with the specified ARN.
*/
untagResource(params: IVS.Types.UntagResourceRequest, callback?: (err: AWSError, data: IVS.Types.UntagResourceResponse) => void): Request<IVS.Types.UntagResourceResponse, AWSError>;
/**
* Removes tags from the resource with the specified ARN.
*/
untagResource(callback?: (err: AWSError, data: IVS.Types.UntagResourceResponse) => void): Request<IVS.Types.UntagResourceResponse, AWSError>;
/**
* Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
*/
updateChannel(params: IVS.Types.UpdateChannelRequest, callback?: (err: AWSError, data: IVS.Types.UpdateChannelResponse) => void): Request<IVS.Types.UpdateChannelResponse, AWSError>;
/**
* Updates a channel's configuration. This does not affect an ongoing stream of this channel. You must stop and restart the stream for the changes to take effect.
*/
updateChannel(callback?: (err: AWSError, data: IVS.Types.UpdateChannelResponse) => void): Request<IVS.Types.UpdateChannelResponse, AWSError>;
}
declare namespace IVS {
export interface BatchError {
/**
* Channel ARN.
*/
arn?: ResourceArn;
/**
* Error code.
*/
code?: errorCode;
/**
* Error message, determined by the application.
*/
message?: errorMessage;
}
export type BatchErrors = BatchError[];
export interface BatchGetChannelRequest {
/**
* Array of ARNs, one per channel.
*/
arns: ChannelArnList;
}
export interface BatchGetChannelResponse {
channels?: Channels;
/**
* Each error object is related to a specific ARN in the request.
*/
errors?: BatchErrors;
}
export interface BatchGetStreamKeyRequest {
/**
* Array of ARNs, one per channel.
*/
arns: StreamKeyArnList;
}
export interface BatchGetStreamKeyResponse {
streamKeys?: StreamKeys;
errors?: BatchErrors;
}
export type Boolean = boolean;
export interface Channel {
/**
* Channel ARN.
*/
arn?: ChannelArn;
/**
* Channel name.
*/
name?: ChannelName;
/**
* Channel latency mode. Default: LOW.
*/
latencyMode?: ChannelLatencyMode;
/**
* Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values: STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps. BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps. Default: STANDARD.
*/
type?: ChannelType;
/**
* Channel ingest endpoint, part of the definition of an ingest server, used when you set up streaming software.
*/
ingestEndpoint?: IngestEndpoint;
/**
* Channel playback URL.
*/
playbackUrl?: PlaybackURL;
/**
* Whether the channel is authorized.
*/
authorized?: IsAuthorized;
/**
* Array of 1-50 maps, each of the form string:string (key:value).
*/
tags?: Tags;
}
export type ChannelArn = string;
export type ChannelArnList = ChannelArn[];
export type ChannelLatencyMode = "NORMAL"|"LOW"|string;
export type ChannelList = ChannelSummary[];
export type ChannelName = string;
export interface ChannelSummary {
/**
* Channel ARN.
*/
arn?: ChannelArn;
/**
* Channel name.
*/
name?: ChannelName;
/**
* Channel latency mode. Default: LOW.
*/
latencyMode?: ChannelLatencyMode;
/**
* Whether the channel is authorized.
*/
authorized?: IsAuthorized;
/**
* Array of 1-50 maps, each of the form string:string (key:value).
*/
tags?: Tags;
}
export type ChannelType = "BASIC"|"STANDARD"|string;
export type Channels = Channel[];
export interface CreateChannelRequest {
/**
* Channel name.
*/
name?: ChannelName;
/**
* Channel latency mode. Default: LOW.
*/
latencyMode?: ChannelLatencyMode;
/**
* Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values: STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps. BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps. Default: STANDARD.
*/
type?: ChannelType;
/**
* Whether the channel is authorized. Default: false.
*/
authorized?: Boolean;
/**
* See Channel$tags.
*/
tags?: Tags;
}
export interface CreateChannelResponse {
channel?: Channel;
streamKey?: StreamKey;
}
export interface CreateStreamKeyRequest {
/**
* ARN of the channel for which to create the stream key.
*/
channelArn: ChannelArn;
/**
* See Channel$tags.
*/
tags?: Tags;
}
export interface CreateStreamKeyResponse {
/**
* Stream key used to authenticate an RTMPS stream for ingestion.
*/
streamKey?: StreamKey;
}
export interface DeleteChannelRequest {
/**
* ARN of the channel to be deleted.
*/
arn: ChannelArn;
}
export interface DeletePlaybackKeyPairRequest {
/**
* ARN of the key pair to be deleted.
*/
arn: PlaybackKeyPairArn;
}
export interface DeletePlaybackKeyPairResponse {
}
export interface DeleteStreamKeyRequest {
/**
* ARN of the stream key to be deleted.
*/
arn: StreamKeyArn;
}
export interface GetChannelRequest {
/**
* ARN of the channel for which the configuration is to be retrieved.
*/
arn: ChannelArn;
}
export interface GetChannelResponse {
channel?: Channel;
}
export interface GetPlaybackKeyPairRequest {
/**
* ARN of the key pair to be returned.
*/
arn: PlaybackKeyPairArn;
}
export interface GetPlaybackKeyPairResponse {
keyPair?: PlaybackKeyPair;
}
export interface GetStreamKeyRequest {
/**
* ARN for the stream key to be retrieved.
*/
arn: StreamKeyArn;
}
export interface GetStreamKeyResponse {
streamKey?: StreamKey;
}
export interface GetStreamRequest {
/**
* Channel ARN for stream to be accessed.
*/
channelArn: ChannelArn;
}
export interface GetStreamResponse {
stream?: Stream;
}
export interface ImportPlaybackKeyPairRequest {
/**
* The public portion of a customer-generated key pair.
*/
publicKeyMaterial: PlaybackPublicKeyMaterial;
/**
* An arbitrary string (a nickname) assigned to a playback key pair that helps the customer identify that resource. The value does not need to be unique.
*/
name?: PlaybackKeyPairName;
/**
* Any tags provided with the request are added to the playback key pair tags.
*/
tags?: Tags;
}
export interface ImportPlaybackKeyPairResponse {
keyPair?: PlaybackKeyPair;
}
export type IngestEndpoint = string;
export type IsAuthorized = boolean;
export interface ListChannelsRequest {
/**
* Filters the channel list to match the specified name.
*/
filterByName?: ChannelName;
/**
* The first channel to retrieve. This is used for pagination; see the nextToken response field.
*/
nextToken?: PaginationToken;
/**
* Maximum number of channels to return.
*/
maxResults?: MaxChannelResults;
}
export interface ListChannelsResponse {
/**
* List of the matching channels.
*/
channels: ChannelList;
/**
* If there are more channels than maxResults, use nextToken in the request to get the next set.
*/
nextToken?: PaginationToken;
}
export interface ListPlaybackKeyPairsRequest {
/**
* Maximum number of key pairs to return.
*/
nextToken?: PaginationToken;
/**
* The first key pair to retrieve. This is used for pagination; see the nextToken response field.
*/
maxResults?: MaxPlaybackKeyPairResults;
}
export interface ListPlaybackKeyPairsResponse {
/**
* List of key pairs.
*/
keyPairs: PlaybackKeyPairList;
/**
* If there are more key pairs than maxResults, use nextToken in the request to get the next set.
*/
nextToken?: PaginationToken;
}
export interface ListStreamKeysRequest {
/**
* Channel ARN used to filter the list.
*/
channelArn: ChannelArn;
/**
* The first stream key to retrieve. This is used for pagination; see the nextToken response field.
*/
nextToken?: PaginationToken;
/**
* Maximum number of streamKeys to return.
*/
maxResults?: MaxStreamKeyResults;
}
export interface ListStreamKeysResponse {
/**
* List of stream keys.
*/
streamKeys: StreamKeyList;
/**
* If there are more stream keys than maxResults, use nextToken in the request to get the next set.
*/
nextToken?: PaginationToken;
}
export interface ListStreamsRequest {
/**
* The first stream to retrieve. This is used for pagination; see the nextToken response field.
*/
nextToken?: PaginationToken;
/**
* Maximum number of streams to return.
*/
maxResults?: MaxStreamResults;
}
export interface ListStreamsResponse {
/**
* List of streams.
*/
streams: StreamList;
/**
* If there are more streams than maxResults, use nextToken in the request to get the next set.
*/
nextToken?: PaginationToken;
}
export interface ListTagsForResourceRequest {
/**
* The ARN of the resource to be retrieved.
*/
resourceArn: ResourceArn;
/**
* The first tag to retrieve. This is used for pagination; see the nextToken response field.
*/
nextToken?: String;
/**
* Maximum number of tags to return.
*/
maxResults?: MaxTagResults;
}
export interface ListTagsForResourceResponse {
tags: Tags;
/**
* If there are more tags than maxResults, use nextToken in the request to get the next set.
*/
nextToken?: String;
}
export type MaxChannelResults = number;
export type MaxPlaybackKeyPairResults = number;
export type MaxStreamKeyResults = number;
export type MaxStreamResults = number;
export type MaxTagResults = number;
export type PaginationToken = string;
export interface PlaybackKeyPair {
/**
* Key-pair ARN.
*/
arn?: PlaybackKeyPairArn;
/**
* Key-pair name.
*/
name?: PlaybackKeyPairName;
/**
* Key-pair identifier.
*/
fingerprint?: PlaybackKeyPairFingerprint;
/**
* Array of 1-50 maps, each of the form string:string (key:value).
*/
tags?: Tags;
}
export type PlaybackKeyPairArn = string;
export type PlaybackKeyPairFingerprint = string;
export type PlaybackKeyPairList = PlaybackKeyPairSummary[];
export type PlaybackKeyPairName = string;
export interface PlaybackKeyPairSummary {
/**
* Key-pair ARN.
*/
arn?: PlaybackKeyPairArn;
/**
* Key-pair name.
*/
name?: PlaybackKeyPairName;
/**
* Array of 1-50 maps, each of the form string:string (key:value)
*/
tags?: Tags;
}
export type PlaybackPublicKeyMaterial = string;
export type PlaybackURL = string;
export interface PutMetadataRequest {
/**
* ARN of the channel into which metadata is inserted. This channel must have an active stream.
*/
channelArn: ChannelArn;
/**
* Metadata to insert into the stream. Maximum: 1 KB per request.
*/
metadata: StreamMetadata;
}
export type ResourceArn = string;
export interface StopStreamRequest {
/**
* ARN of the channel for which the stream is to be stopped.
*/
channelArn: ChannelArn;
}
export interface StopStreamResponse {
}
export interface Stream {
/**
* Channel ARN for the stream.
*/
channelArn?: ChannelArn;
/**
* URL of the video master manifest, required by the video player to play the HLS stream.
*/
playbackUrl?: PlaybackURL;
/**
* ISO-8601 formatted timestamp of the stream’s start.
*/
startTime?: StreamStartTime;
/**
* The stream’s state.
*/
state?: StreamState;
/**
* The stream’s health.
*/
health?: StreamHealth;
/**
* Number of current viewers of the stream.
*/
viewerCount?: StreamViewerCount;
}
export type StreamHealth = "HEALTHY"|"STARVING"|"UNKNOWN"|string;
export interface StreamKey {
/**
* Stream-key ARN.
*/
arn?: StreamKeyArn;
/**
* Stream-key value.
*/
value?: StreamKeyValue;
/**
* Channel ARN for the stream.
*/
channelArn?: ChannelArn;
/**
* Array of 1-50 maps, each of the form string:string (key:value).
*/
tags?: Tags;
}
export type StreamKeyArn = string;
export type StreamKeyArnList = StreamKeyArn[];
export type StreamKeyList = StreamKeySummary[];
export interface StreamKeySummary {
/**
* Stream-key ARN.
*/
arn?: StreamKeyArn;
/**
* Channel ARN for the stream.
*/
channelArn?: ChannelArn;
/**
* Array of 1-50 maps, each of the form string:string (key:value).
*/
tags?: Tags;
}
export type StreamKeyValue = string;
export type StreamKeys = StreamKey[];
export type StreamList = StreamSummary[];
export type StreamMetadata = string;
export type StreamStartTime = Date;
export type StreamState = "LIVE"|"OFFLINE"|string;
export interface StreamSummary {
/**
* Channel ARN for the stream.
*/
channelArn?: ChannelArn;
/**
* The stream’s state.
*/
state?: StreamState;
/**
* The stream’s health.
*/
health?: StreamHealth;
/**
* Number of current viewers of the stream.
*/
viewerCount?: StreamViewerCount;
/**
* ISO-8601 formatted timestamp of the stream’s start.
*/
startTime?: StreamStartTime;
}
export type StreamViewerCount = number;
export type String = string;
export type TagKey = string;
export type TagKeyList = TagKey[];
export interface TagResourceRequest {
/**
* ARN of the resource for which tags are to be added or updated.
*/
resourceArn: ResourceArn;
/**
* Array of tags to be added or updated.
*/
tags: Tags;
}
export interface TagResourceResponse {
}
export type TagValue = string;
export type Tags = {[key: string]: TagValue};
export interface UntagResourceRequest {
/**
* ARN of the resource for which tags are to be removed.
*/
resourceArn: ResourceArn;
/**
* Array of tags to be removed.
*/
tagKeys: TagKeyList;
}
export interface UntagResourceResponse {
}
export interface UpdateChannelRequest {
/**
* ARN of the channel to be updated.
*/
arn: ChannelArn;
/**
* Channel name.
*/
name?: ChannelName;
/**
* Channel latency mode. Default: LOW.
*/
latencyMode?: ChannelLatencyMode;
/**
* Channel type, which determines the allowable resolution and bitrate. If you exceed the allowable resolution or bitrate, the stream probably will disconnect immediately. Valid values: STANDARD: Multiple qualities are generated from the original input, to automatically give viewers the best experience for their devices and network conditions. Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps. BASIC: Amazon IVS delivers the original input to viewers. The viewer’s video-quality choice is limited to the original input. Vertical resolution can be up to 480 and bitrate can be up to 1.5 Mbps. Default: STANDARD.
*/
type?: ChannelType;
/**
* Whether the channel is authorized. Default: false.
*/
authorized?: Boolean;
}
export interface UpdateChannelResponse {
channel?: Channel;
}
export type errorCode = string;
export type errorMessage = string;
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
export type apiVersion = "2020-07-14"|"latest"|string;
export interface ClientApiVersions {
/**
* A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
*/
apiVersion?: apiVersion;
}
export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
/**
* Contains interfaces for use with the IVS client.
*/
export import Types = IVS;
}
export = IVS;