@aws-sdk/client-ivs 3.686.0 → 3.691.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.
- package/dist-types/models/models_0.d.ts +199 -199
- package/dist-types/ts3.4/models/models_0.d.ts +199 -199
- package/package.json +7 -7
|
@@ -11,7 +11,7 @@ export declare class AccessDeniedException extends __BaseException {
|
|
|
11
11
|
* <p>User does not have sufficient access to perform this action.</p>
|
|
12
12
|
* @public
|
|
13
13
|
*/
|
|
14
|
-
exceptionMessage?: string;
|
|
14
|
+
exceptionMessage?: string | undefined;
|
|
15
15
|
/**
|
|
16
16
|
* @internal
|
|
17
17
|
*/
|
|
@@ -60,14 +60,14 @@ export interface Srt {
|
|
|
60
60
|
* <p>The endpoint to be used when streaming with IVS using the SRT protocol.</p>
|
|
61
61
|
* @public
|
|
62
62
|
*/
|
|
63
|
-
endpoint?: string;
|
|
63
|
+
endpoint?: string | undefined;
|
|
64
64
|
/**
|
|
65
65
|
* <p>Auto-generated passphrase to enable encryption. This field is applicable only if the end
|
|
66
66
|
* user has <i>not</i> enabled the <code>insecureIngest</code> option for the
|
|
67
67
|
* channel.</p>
|
|
68
68
|
* @public
|
|
69
69
|
*/
|
|
70
|
-
passphrase?: string;
|
|
70
|
+
passphrase?: string | undefined;
|
|
71
71
|
}
|
|
72
72
|
/**
|
|
73
73
|
* @public
|
|
@@ -92,19 +92,19 @@ export interface Channel {
|
|
|
92
92
|
* <p>Channel ARN.</p>
|
|
93
93
|
* @public
|
|
94
94
|
*/
|
|
95
|
-
arn?: string;
|
|
95
|
+
arn?: string | undefined;
|
|
96
96
|
/**
|
|
97
97
|
* <p>Channel name.</p>
|
|
98
98
|
* @public
|
|
99
99
|
*/
|
|
100
|
-
name?: string;
|
|
100
|
+
name?: string | undefined;
|
|
101
101
|
/**
|
|
102
102
|
* <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to
|
|
103
103
|
* Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default:
|
|
104
104
|
* <code>LOW</code>.</p>
|
|
105
105
|
* @public
|
|
106
106
|
*/
|
|
107
|
-
latencyMode?: ChannelLatencyMode;
|
|
107
|
+
latencyMode?: ChannelLatencyMode | undefined;
|
|
108
108
|
/**
|
|
109
109
|
* <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
|
|
110
110
|
* exceed the allowable input resolution or bitrate, the stream probably will disconnect
|
|
@@ -112,42 +112,42 @@ export interface Channel {
|
|
|
112
112
|
* Types</a>.</p>
|
|
113
113
|
* @public
|
|
114
114
|
*/
|
|
115
|
-
type?: ChannelType;
|
|
115
|
+
type?: ChannelType | undefined;
|
|
116
116
|
/**
|
|
117
117
|
* <p>Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables
|
|
118
118
|
* recording. Default: "" (empty string, recording is disabled).</p>
|
|
119
119
|
* @public
|
|
120
120
|
*/
|
|
121
|
-
recordingConfigurationArn?: string;
|
|
121
|
+
recordingConfigurationArn?: string | undefined;
|
|
122
122
|
/**
|
|
123
123
|
* <p>Channel ingest endpoint, part of the definition of an ingest server, used when you set up
|
|
124
124
|
* streaming software.</p>
|
|
125
125
|
* @public
|
|
126
126
|
*/
|
|
127
|
-
ingestEndpoint?: string;
|
|
127
|
+
ingestEndpoint?: string | undefined;
|
|
128
128
|
/**
|
|
129
129
|
* <p>Channel playback URL.</p>
|
|
130
130
|
* @public
|
|
131
131
|
*/
|
|
132
|
-
playbackUrl?: string;
|
|
132
|
+
playbackUrl?: string | undefined;
|
|
133
133
|
/**
|
|
134
134
|
* <p>Whether the channel is private (enabled for playback authorization). Default:
|
|
135
135
|
* <code>false</code>.</p>
|
|
136
136
|
* @public
|
|
137
137
|
*/
|
|
138
|
-
authorized?: boolean;
|
|
138
|
+
authorized?: boolean | undefined;
|
|
139
139
|
/**
|
|
140
140
|
* <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
|
|
141
141
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
|
|
142
142
|
* service-specific constraints beyond what is documented there.</p>
|
|
143
143
|
* @public
|
|
144
144
|
*/
|
|
145
|
-
tags?: Record<string, string
|
|
145
|
+
tags?: Record<string, string> | undefined;
|
|
146
146
|
/**
|
|
147
147
|
* <p>Whether the channel allows insecure RTMP ingest. Default: <code>false</code>.</p>
|
|
148
148
|
* @public
|
|
149
149
|
*/
|
|
150
|
-
insecureIngest?: boolean;
|
|
150
|
+
insecureIngest?: boolean | undefined;
|
|
151
151
|
/**
|
|
152
152
|
* <p>Optional transcode preset for the channel. This is selectable only for
|
|
153
153
|
* <code>ADVANCED_HD</code> and <code>ADVANCED_SD</code> channel types. For those channel
|
|
@@ -156,19 +156,19 @@ export interface Channel {
|
|
|
156
156
|
* string (<code>""</code>).</p>
|
|
157
157
|
* @public
|
|
158
158
|
*/
|
|
159
|
-
preset?: TranscodePreset;
|
|
159
|
+
preset?: TranscodePreset | undefined;
|
|
160
160
|
/**
|
|
161
161
|
* <p>Specifies the endpoint and optional passphrase for streaming with the SRT protocol.</p>
|
|
162
162
|
* @public
|
|
163
163
|
*/
|
|
164
|
-
srt?: Srt;
|
|
164
|
+
srt?: Srt | undefined;
|
|
165
165
|
/**
|
|
166
166
|
* <p>Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables
|
|
167
167
|
* playback restriction. Default: "" (empty string, no playback restriction policy is
|
|
168
168
|
* applied).</p>
|
|
169
169
|
* @public
|
|
170
170
|
*/
|
|
171
|
-
playbackRestrictionPolicyArn?: string;
|
|
171
|
+
playbackRestrictionPolicyArn?: string | undefined;
|
|
172
172
|
}
|
|
173
173
|
/**
|
|
174
174
|
* <p>Error related to a specific channel, specified by its ARN.</p>
|
|
@@ -179,17 +179,17 @@ export interface BatchError {
|
|
|
179
179
|
* <p>ARN of an IVS resource; e.g., channel.</p>
|
|
180
180
|
* @public
|
|
181
181
|
*/
|
|
182
|
-
arn?: string;
|
|
182
|
+
arn?: string | undefined;
|
|
183
183
|
/**
|
|
184
184
|
* <p>Error code.</p>
|
|
185
185
|
* @public
|
|
186
186
|
*/
|
|
187
|
-
code?: string;
|
|
187
|
+
code?: string | undefined;
|
|
188
188
|
/**
|
|
189
189
|
* <p>Error message, determined by the application.</p>
|
|
190
190
|
* @public
|
|
191
191
|
*/
|
|
192
|
-
message?: string;
|
|
192
|
+
message?: string | undefined;
|
|
193
193
|
}
|
|
194
194
|
/**
|
|
195
195
|
* @public
|
|
@@ -199,12 +199,12 @@ export interface BatchGetChannelResponse {
|
|
|
199
199
|
* <p/>
|
|
200
200
|
* @public
|
|
201
201
|
*/
|
|
202
|
-
channels?: Channel[];
|
|
202
|
+
channels?: Channel[] | undefined;
|
|
203
203
|
/**
|
|
204
204
|
* <p>Each error object is related to a specific ARN in the request.</p>
|
|
205
205
|
* @public
|
|
206
206
|
*/
|
|
207
|
-
errors?: BatchError[];
|
|
207
|
+
errors?: BatchError[] | undefined;
|
|
208
208
|
}
|
|
209
209
|
/**
|
|
210
210
|
* @public
|
|
@@ -225,24 +225,24 @@ export interface StreamKey {
|
|
|
225
225
|
* <p>Stream-key ARN.</p>
|
|
226
226
|
* @public
|
|
227
227
|
*/
|
|
228
|
-
arn?: string;
|
|
228
|
+
arn?: string | undefined;
|
|
229
229
|
/**
|
|
230
230
|
* <p>Stream-key value.</p>
|
|
231
231
|
* @public
|
|
232
232
|
*/
|
|
233
|
-
value?: string;
|
|
233
|
+
value?: string | undefined;
|
|
234
234
|
/**
|
|
235
235
|
* <p>Channel ARN for the stream.</p>
|
|
236
236
|
* @public
|
|
237
237
|
*/
|
|
238
|
-
channelArn?: string;
|
|
238
|
+
channelArn?: string | undefined;
|
|
239
239
|
/**
|
|
240
240
|
* <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
|
|
241
241
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
|
|
242
242
|
* service-specific constraints beyond what is documented there.</p>
|
|
243
243
|
* @public
|
|
244
244
|
*/
|
|
245
|
-
tags?: Record<string, string
|
|
245
|
+
tags?: Record<string, string> | undefined;
|
|
246
246
|
}
|
|
247
247
|
/**
|
|
248
248
|
* @public
|
|
@@ -252,12 +252,12 @@ export interface BatchGetStreamKeyResponse {
|
|
|
252
252
|
* <p/>
|
|
253
253
|
* @public
|
|
254
254
|
*/
|
|
255
|
-
streamKeys?: StreamKey[];
|
|
255
|
+
streamKeys?: StreamKey[] | undefined;
|
|
256
256
|
/**
|
|
257
257
|
* <p/>
|
|
258
258
|
* @public
|
|
259
259
|
*/
|
|
260
|
-
errors?: BatchError[];
|
|
260
|
+
errors?: BatchError[] | undefined;
|
|
261
261
|
}
|
|
262
262
|
/**
|
|
263
263
|
* <p>A viewer session to revoke in the call to <a>BatchStartViewerSessionRevocation</a>.</p>
|
|
@@ -280,7 +280,7 @@ export interface BatchStartViewerSessionRevocationViewerSession {
|
|
|
280
280
|
* than or equal to the specified version will be revoked. Default: 0.</p>
|
|
281
281
|
* @public
|
|
282
282
|
*/
|
|
283
|
-
viewerSessionVersionsLessThanOrEqualTo?: number;
|
|
283
|
+
viewerSessionVersionsLessThanOrEqualTo?: number | undefined;
|
|
284
284
|
}
|
|
285
285
|
/**
|
|
286
286
|
* @public
|
|
@@ -312,12 +312,12 @@ export interface BatchStartViewerSessionRevocationError {
|
|
|
312
312
|
* <p>Error code.</p>
|
|
313
313
|
* @public
|
|
314
314
|
*/
|
|
315
|
-
code?: string;
|
|
315
|
+
code?: string | undefined;
|
|
316
316
|
/**
|
|
317
317
|
* <p>Error message, determined by the application.</p>
|
|
318
318
|
* @public
|
|
319
319
|
*/
|
|
320
|
-
message?: string;
|
|
320
|
+
message?: string | undefined;
|
|
321
321
|
}
|
|
322
322
|
/**
|
|
323
323
|
* @public
|
|
@@ -328,7 +328,7 @@ export interface BatchStartViewerSessionRevocationResponse {
|
|
|
328
328
|
* <code>viewerId</code> pair in the request.</p>
|
|
329
329
|
* @public
|
|
330
330
|
*/
|
|
331
|
-
errors?: BatchStartViewerSessionRevocationError[];
|
|
331
|
+
errors?: BatchStartViewerSessionRevocationError[] | undefined;
|
|
332
332
|
}
|
|
333
333
|
/**
|
|
334
334
|
* <p/>
|
|
@@ -341,7 +341,7 @@ export declare class PendingVerification extends __BaseException {
|
|
|
341
341
|
* <p> Your account is pending verification. </p>
|
|
342
342
|
* @public
|
|
343
343
|
*/
|
|
344
|
-
exceptionMessage?: string;
|
|
344
|
+
exceptionMessage?: string | undefined;
|
|
345
345
|
/**
|
|
346
346
|
* @internal
|
|
347
347
|
*/
|
|
@@ -358,7 +358,7 @@ export declare class ThrottlingException extends __BaseException {
|
|
|
358
358
|
* <p>Request was denied due to request throttling.</p>
|
|
359
359
|
* @public
|
|
360
360
|
*/
|
|
361
|
-
exceptionMessage?: string;
|
|
361
|
+
exceptionMessage?: string | undefined;
|
|
362
362
|
/**
|
|
363
363
|
* @internal
|
|
364
364
|
*/
|
|
@@ -375,7 +375,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
375
375
|
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
376
376
|
* @public
|
|
377
377
|
*/
|
|
378
|
-
exceptionMessage?: string;
|
|
378
|
+
exceptionMessage?: string | undefined;
|
|
379
379
|
/**
|
|
380
380
|
* @internal
|
|
381
381
|
*/
|
|
@@ -389,13 +389,13 @@ export interface CreateChannelRequest {
|
|
|
389
389
|
* <p>Channel name.</p>
|
|
390
390
|
* @public
|
|
391
391
|
*/
|
|
392
|
-
name?: string;
|
|
392
|
+
name?: string | undefined;
|
|
393
393
|
/**
|
|
394
394
|
* <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to
|
|
395
395
|
* Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default: <code>LOW</code>.</p>
|
|
396
396
|
* @public
|
|
397
397
|
*/
|
|
398
|
-
latencyMode?: ChannelLatencyMode;
|
|
398
|
+
latencyMode?: ChannelLatencyMode | undefined;
|
|
399
399
|
/**
|
|
400
400
|
* <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
|
|
401
401
|
* exceed the allowable input resolution or bitrate, the stream probably will disconnect
|
|
@@ -403,30 +403,30 @@ export interface CreateChannelRequest {
|
|
|
403
403
|
* Types</a>.</p>
|
|
404
404
|
* @public
|
|
405
405
|
*/
|
|
406
|
-
type?: ChannelType;
|
|
406
|
+
type?: ChannelType | undefined;
|
|
407
407
|
/**
|
|
408
408
|
* <p>Whether the channel is private (enabled for playback authorization). Default:
|
|
409
409
|
* <code>false</code>.</p>
|
|
410
410
|
* @public
|
|
411
411
|
*/
|
|
412
|
-
authorized?: boolean;
|
|
412
|
+
authorized?: boolean | undefined;
|
|
413
413
|
/**
|
|
414
414
|
* <p>Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording.
|
|
415
415
|
* Default: "" (empty string, recording is disabled).</p>
|
|
416
416
|
* @public
|
|
417
417
|
*/
|
|
418
|
-
recordingConfigurationArn?: string;
|
|
418
|
+
recordingConfigurationArn?: string | undefined;
|
|
419
419
|
/**
|
|
420
420
|
* <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is
|
|
421
421
|
* documented there.</p>
|
|
422
422
|
* @public
|
|
423
423
|
*/
|
|
424
|
-
tags?: Record<string, string
|
|
424
|
+
tags?: Record<string, string> | undefined;
|
|
425
425
|
/**
|
|
426
426
|
* <p>Whether the channel allows insecure RTMP and SRT ingest. Default: <code>false</code>.</p>
|
|
427
427
|
* @public
|
|
428
428
|
*/
|
|
429
|
-
insecureIngest?: boolean;
|
|
429
|
+
insecureIngest?: boolean | undefined;
|
|
430
430
|
/**
|
|
431
431
|
* <p>Optional transcode preset for the channel. This is selectable only for
|
|
432
432
|
* <code>ADVANCED_HD</code> and <code>ADVANCED_SD</code> channel types. For those channel
|
|
@@ -435,13 +435,13 @@ export interface CreateChannelRequest {
|
|
|
435
435
|
* string (<code>""</code>).</p>
|
|
436
436
|
* @public
|
|
437
437
|
*/
|
|
438
|
-
preset?: TranscodePreset;
|
|
438
|
+
preset?: TranscodePreset | undefined;
|
|
439
439
|
/**
|
|
440
440
|
* <p>Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction.
|
|
441
441
|
* Default: "" (empty string, no playback restriction policy is applied).</p>
|
|
442
442
|
* @public
|
|
443
443
|
*/
|
|
444
|
-
playbackRestrictionPolicyArn?: string;
|
|
444
|
+
playbackRestrictionPolicyArn?: string | undefined;
|
|
445
445
|
}
|
|
446
446
|
/**
|
|
447
447
|
* @public
|
|
@@ -451,12 +451,12 @@ export interface CreateChannelResponse {
|
|
|
451
451
|
* <p/>
|
|
452
452
|
* @public
|
|
453
453
|
*/
|
|
454
|
-
channel?: Channel;
|
|
454
|
+
channel?: Channel | undefined;
|
|
455
455
|
/**
|
|
456
456
|
* <p/>
|
|
457
457
|
* @public
|
|
458
458
|
*/
|
|
459
|
-
streamKey?: StreamKey;
|
|
459
|
+
streamKey?: StreamKey | undefined;
|
|
460
460
|
}
|
|
461
461
|
/**
|
|
462
462
|
* <p/>
|
|
@@ -469,7 +469,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
469
469
|
* <p>Request references a resource which does not exist.</p>
|
|
470
470
|
* @public
|
|
471
471
|
*/
|
|
472
|
-
exceptionMessage?: string;
|
|
472
|
+
exceptionMessage?: string | undefined;
|
|
473
473
|
/**
|
|
474
474
|
* @internal
|
|
475
475
|
*/
|
|
@@ -486,7 +486,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
486
486
|
* <p>Request would cause a service quota to be exceeded.</p>
|
|
487
487
|
* @public
|
|
488
488
|
*/
|
|
489
|
-
exceptionMessage?: string;
|
|
489
|
+
exceptionMessage?: string | undefined;
|
|
490
490
|
/**
|
|
491
491
|
* @internal
|
|
492
492
|
*/
|
|
@@ -502,31 +502,31 @@ export interface CreatePlaybackRestrictionPolicyRequest {
|
|
|
502
502
|
* alpha-2</a> codes. Default: All countries (an empty array).</p>
|
|
503
503
|
* @public
|
|
504
504
|
*/
|
|
505
|
-
allowedCountries?: string[];
|
|
505
|
+
allowedCountries?: string[] | undefined;
|
|
506
506
|
/**
|
|
507
507
|
* <p>A list of origin sites that control CORS restriction. Allowed values are the same as valid
|
|
508
508
|
* values of the Origin header defined at <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin">https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin</a>. Default: All
|
|
509
509
|
* origins (an empty array).</p>
|
|
510
510
|
* @public
|
|
511
511
|
*/
|
|
512
|
-
allowedOrigins?: string[];
|
|
512
|
+
allowedOrigins?: string[] | undefined;
|
|
513
513
|
/**
|
|
514
514
|
* <p>Whether channel playback is constrained by origin site. Default:
|
|
515
515
|
* <code>false</code>.</p>
|
|
516
516
|
* @public
|
|
517
517
|
*/
|
|
518
|
-
enableStrictOriginEnforcement?: boolean;
|
|
518
|
+
enableStrictOriginEnforcement?: boolean | undefined;
|
|
519
519
|
/**
|
|
520
520
|
* <p>Playback-restriction-policy name. The value does not need to be unique.</p>
|
|
521
521
|
* @public
|
|
522
522
|
*/
|
|
523
|
-
name?: string;
|
|
523
|
+
name?: string | undefined;
|
|
524
524
|
/**
|
|
525
525
|
* <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is
|
|
526
526
|
* documented there.</p>
|
|
527
527
|
* @public
|
|
528
528
|
*/
|
|
529
|
-
tags?: Record<string, string
|
|
529
|
+
tags?: Record<string, string> | undefined;
|
|
530
530
|
}
|
|
531
531
|
/**
|
|
532
532
|
* <p>An object representing a policy to constrain playback by country and/or origin
|
|
@@ -558,19 +558,19 @@ export interface PlaybackRestrictionPolicy {
|
|
|
558
558
|
* <code>false</code>.</p>
|
|
559
559
|
* @public
|
|
560
560
|
*/
|
|
561
|
-
enableStrictOriginEnforcement?: boolean;
|
|
561
|
+
enableStrictOriginEnforcement?: boolean | undefined;
|
|
562
562
|
/**
|
|
563
563
|
* <p>Playback-restriction-policy name. The value does not need to be unique.</p>
|
|
564
564
|
* @public
|
|
565
565
|
*/
|
|
566
|
-
name?: string;
|
|
566
|
+
name?: string | undefined;
|
|
567
567
|
/**
|
|
568
568
|
* <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
|
|
569
569
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
|
|
570
570
|
* service-specific constraints beyond what is documented there.</p>
|
|
571
571
|
* @public
|
|
572
572
|
*/
|
|
573
|
-
tags?: Record<string, string
|
|
573
|
+
tags?: Record<string, string> | undefined;
|
|
574
574
|
}
|
|
575
575
|
/**
|
|
576
576
|
* @public
|
|
@@ -580,7 +580,7 @@ export interface CreatePlaybackRestrictionPolicyResponse {
|
|
|
580
580
|
* <p/>
|
|
581
581
|
* @public
|
|
582
582
|
*/
|
|
583
|
-
playbackRestrictionPolicy?: PlaybackRestrictionPolicy;
|
|
583
|
+
playbackRestrictionPolicy?: PlaybackRestrictionPolicy | undefined;
|
|
584
584
|
}
|
|
585
585
|
/**
|
|
586
586
|
* <p/>
|
|
@@ -593,7 +593,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
593
593
|
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
594
594
|
* @public
|
|
595
595
|
*/
|
|
596
|
-
exceptionMessage?: string;
|
|
596
|
+
exceptionMessage?: string | undefined;
|
|
597
597
|
/**
|
|
598
598
|
* @internal
|
|
599
599
|
*/
|
|
@@ -621,7 +621,7 @@ export interface DestinationConfiguration {
|
|
|
621
621
|
* <p>An S3 destination configuration where recorded videos will be stored.</p>
|
|
622
622
|
* @public
|
|
623
623
|
*/
|
|
624
|
-
s3?: S3DestinationConfiguration;
|
|
624
|
+
s3?: S3DestinationConfiguration | undefined;
|
|
625
625
|
}
|
|
626
626
|
/**
|
|
627
627
|
* @public
|
|
@@ -662,7 +662,7 @@ export interface RenditionConfiguration {
|
|
|
662
662
|
* <code>ALL</code>.</p>
|
|
663
663
|
* @public
|
|
664
664
|
*/
|
|
665
|
-
renditionSelection?: RenditionConfigurationRenditionSelection;
|
|
665
|
+
renditionSelection?: RenditionConfigurationRenditionSelection | undefined;
|
|
666
666
|
/**
|
|
667
667
|
* <p>Indicates which renditions are recorded for a stream, if <code>renditionSelection</code>
|
|
668
668
|
* is <code>CUSTOM</code>; otherwise, this field is irrelevant. The selected renditions are
|
|
@@ -671,7 +671,7 @@ export interface RenditionConfiguration {
|
|
|
671
671
|
* rendition, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/record-to-s3.html">Auto-Record to Amazon S3</a>.</p>
|
|
672
672
|
* @public
|
|
673
673
|
*/
|
|
674
|
-
renditions?: RenditionConfigurationRendition[];
|
|
674
|
+
renditions?: RenditionConfigurationRendition[] | undefined;
|
|
675
675
|
}
|
|
676
676
|
/**
|
|
677
677
|
* @public
|
|
@@ -720,7 +720,7 @@ export interface ThumbnailConfiguration {
|
|
|
720
720
|
* <p>Thumbnail recording mode. Default: <code>INTERVAL</code>.</p>
|
|
721
721
|
* @public
|
|
722
722
|
*/
|
|
723
|
-
recordingMode?: RecordingMode;
|
|
723
|
+
recordingMode?: RecordingMode | undefined;
|
|
724
724
|
/**
|
|
725
725
|
* <p>The targeted thumbnail-generation interval in seconds. This is configurable (and required)
|
|
726
726
|
* only if <code>recordingMode</code> is <code>INTERVAL</code>. Default: 60.</p>
|
|
@@ -734,7 +734,7 @@ export interface ThumbnailConfiguration {
|
|
|
734
734
|
* recommended value in video-encoder settings.</p>
|
|
735
735
|
* @public
|
|
736
736
|
*/
|
|
737
|
-
targetIntervalSeconds?: number;
|
|
737
|
+
targetIntervalSeconds?: number | undefined;
|
|
738
738
|
/**
|
|
739
739
|
* <p>Indicates the desired resolution of recorded thumbnails. Thumbnails are recorded at the
|
|
740
740
|
* selected resolution if the corresponding rendition is available during the stream; otherwise,
|
|
@@ -743,7 +743,7 @@ export interface ThumbnailConfiguration {
|
|
|
743
743
|
* Null (source resolution is returned).</p>
|
|
744
744
|
* @public
|
|
745
745
|
*/
|
|
746
|
-
resolution?: ThumbnailConfigurationResolution;
|
|
746
|
+
resolution?: ThumbnailConfigurationResolution | undefined;
|
|
747
747
|
/**
|
|
748
748
|
* <p>Indicates the format in which thumbnails are recorded. <code>SEQUENTIAL</code> records all
|
|
749
749
|
* generated thumbnails in a serial manner, to the media/thumbnails directory.
|
|
@@ -752,7 +752,7 @@ export interface ThumbnailConfiguration {
|
|
|
752
752
|
* both <code>SEQUENTIAL</code> and <code>LATEST</code>. Default: <code>SEQUENTIAL</code>.</p>
|
|
753
753
|
* @public
|
|
754
754
|
*/
|
|
755
|
-
storage?: ThumbnailConfigurationStorage[];
|
|
755
|
+
storage?: ThumbnailConfigurationStorage[] | undefined;
|
|
756
756
|
}
|
|
757
757
|
/**
|
|
758
758
|
* @public
|
|
@@ -762,7 +762,7 @@ export interface CreateRecordingConfigurationRequest {
|
|
|
762
762
|
* <p>Recording-configuration name. The value does not need to be unique.</p>
|
|
763
763
|
* @public
|
|
764
764
|
*/
|
|
765
|
-
name?: string;
|
|
765
|
+
name?: string | undefined;
|
|
766
766
|
/**
|
|
767
767
|
* <p>A complex type that contains a destination configuration for where recorded video will be
|
|
768
768
|
* stored.</p>
|
|
@@ -774,24 +774,24 @@ export interface CreateRecordingConfigurationRequest {
|
|
|
774
774
|
* documented there.</p>
|
|
775
775
|
* @public
|
|
776
776
|
*/
|
|
777
|
-
tags?: Record<string, string
|
|
777
|
+
tags?: Record<string, string> | undefined;
|
|
778
778
|
/**
|
|
779
779
|
* <p>A complex type that allows you to enable/disable the recording of thumbnails for a live
|
|
780
780
|
* session and modify the interval at which thumbnails are generated for the live session.</p>
|
|
781
781
|
* @public
|
|
782
782
|
*/
|
|
783
|
-
thumbnailConfiguration?: ThumbnailConfiguration;
|
|
783
|
+
thumbnailConfiguration?: ThumbnailConfiguration | undefined;
|
|
784
784
|
/**
|
|
785
785
|
* <p>If a broadcast disconnects and then reconnects within the specified interval, the multiple
|
|
786
786
|
* streams will be considered a single broadcast and merged together. Default: 0.</p>
|
|
787
787
|
* @public
|
|
788
788
|
*/
|
|
789
|
-
recordingReconnectWindowSeconds?: number;
|
|
789
|
+
recordingReconnectWindowSeconds?: number | undefined;
|
|
790
790
|
/**
|
|
791
791
|
* <p>Object that describes which renditions should be recorded for a stream.</p>
|
|
792
792
|
* @public
|
|
793
793
|
*/
|
|
794
|
-
renditionConfiguration?: RenditionConfiguration;
|
|
794
|
+
renditionConfiguration?: RenditionConfiguration | undefined;
|
|
795
795
|
}
|
|
796
796
|
/**
|
|
797
797
|
* @public
|
|
@@ -820,7 +820,7 @@ export interface RecordingConfiguration {
|
|
|
820
820
|
* <p>Recording-configuration name. The value does not need to be unique.</p>
|
|
821
821
|
* @public
|
|
822
822
|
*/
|
|
823
|
-
name?: string;
|
|
823
|
+
name?: string | undefined;
|
|
824
824
|
/**
|
|
825
825
|
* <p>A complex type that contains information about where recorded video will be stored.</p>
|
|
826
826
|
* @public
|
|
@@ -838,24 +838,24 @@ export interface RecordingConfiguration {
|
|
|
838
838
|
* service-specific constraints beyond what is documented there.</p>
|
|
839
839
|
* @public
|
|
840
840
|
*/
|
|
841
|
-
tags?: Record<string, string
|
|
841
|
+
tags?: Record<string, string> | undefined;
|
|
842
842
|
/**
|
|
843
843
|
* <p>A complex type that allows you to enable/disable the recording of thumbnails for a live
|
|
844
844
|
* session and modify the interval at which thumbnails are generated for the live session.</p>
|
|
845
845
|
* @public
|
|
846
846
|
*/
|
|
847
|
-
thumbnailConfiguration?: ThumbnailConfiguration;
|
|
847
|
+
thumbnailConfiguration?: ThumbnailConfiguration | undefined;
|
|
848
848
|
/**
|
|
849
849
|
* <p>If a broadcast disconnects and then reconnects within the specified interval, the multiple
|
|
850
850
|
* streams will be considered a single broadcast and merged together. Default: 0.</p>
|
|
851
851
|
* @public
|
|
852
852
|
*/
|
|
853
|
-
recordingReconnectWindowSeconds?: number;
|
|
853
|
+
recordingReconnectWindowSeconds?: number | undefined;
|
|
854
854
|
/**
|
|
855
855
|
* <p>Object that describes which renditions should be recorded for a stream.</p>
|
|
856
856
|
* @public
|
|
857
857
|
*/
|
|
858
|
-
renditionConfiguration?: RenditionConfiguration;
|
|
858
|
+
renditionConfiguration?: RenditionConfiguration | undefined;
|
|
859
859
|
}
|
|
860
860
|
/**
|
|
861
861
|
* @public
|
|
@@ -865,7 +865,7 @@ export interface CreateRecordingConfigurationResponse {
|
|
|
865
865
|
*
|
|
866
866
|
* @public
|
|
867
867
|
*/
|
|
868
|
-
recordingConfiguration?: RecordingConfiguration;
|
|
868
|
+
recordingConfiguration?: RecordingConfiguration | undefined;
|
|
869
869
|
}
|
|
870
870
|
/**
|
|
871
871
|
* <p/>
|
|
@@ -878,7 +878,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
878
878
|
* <p>Unexpected error during processing of request.</p>
|
|
879
879
|
* @public
|
|
880
880
|
*/
|
|
881
|
-
exceptionMessage?: string;
|
|
881
|
+
exceptionMessage?: string | undefined;
|
|
882
882
|
/**
|
|
883
883
|
* @internal
|
|
884
884
|
*/
|
|
@@ -898,7 +898,7 @@ export interface CreateStreamKeyRequest {
|
|
|
898
898
|
* documented there.</p>
|
|
899
899
|
* @public
|
|
900
900
|
*/
|
|
901
|
-
tags?: Record<string, string
|
|
901
|
+
tags?: Record<string, string> | undefined;
|
|
902
902
|
}
|
|
903
903
|
/**
|
|
904
904
|
* @public
|
|
@@ -908,7 +908,7 @@ export interface CreateStreamKeyResponse {
|
|
|
908
908
|
* <p>Stream key used to authenticate an RTMPS stream for ingestion.</p>
|
|
909
909
|
* @public
|
|
910
910
|
*/
|
|
911
|
-
streamKey?: StreamKey;
|
|
911
|
+
streamKey?: StreamKey | undefined;
|
|
912
912
|
}
|
|
913
913
|
/**
|
|
914
914
|
* @public
|
|
@@ -983,7 +983,7 @@ export interface GetChannelResponse {
|
|
|
983
983
|
* <p/>
|
|
984
984
|
* @public
|
|
985
985
|
*/
|
|
986
|
-
channel?: Channel;
|
|
986
|
+
channel?: Channel | undefined;
|
|
987
987
|
}
|
|
988
988
|
/**
|
|
989
989
|
* @public
|
|
@@ -1004,24 +1004,24 @@ export interface PlaybackKeyPair {
|
|
|
1004
1004
|
* <p>Key-pair ARN.</p>
|
|
1005
1005
|
* @public
|
|
1006
1006
|
*/
|
|
1007
|
-
arn?: string;
|
|
1007
|
+
arn?: string | undefined;
|
|
1008
1008
|
/**
|
|
1009
1009
|
* <p>Playback-key-pair name. The value does not need to be unique.</p>
|
|
1010
1010
|
* @public
|
|
1011
1011
|
*/
|
|
1012
|
-
name?: string;
|
|
1012
|
+
name?: string | undefined;
|
|
1013
1013
|
/**
|
|
1014
1014
|
* <p>Key-pair identifier.</p>
|
|
1015
1015
|
* @public
|
|
1016
1016
|
*/
|
|
1017
|
-
fingerprint?: string;
|
|
1017
|
+
fingerprint?: string | undefined;
|
|
1018
1018
|
/**
|
|
1019
1019
|
* <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
|
|
1020
1020
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
|
|
1021
1021
|
* service-specific constraints beyond what is documented there.</p>
|
|
1022
1022
|
* @public
|
|
1023
1023
|
*/
|
|
1024
|
-
tags?: Record<string, string
|
|
1024
|
+
tags?: Record<string, string> | undefined;
|
|
1025
1025
|
}
|
|
1026
1026
|
/**
|
|
1027
1027
|
* @public
|
|
@@ -1031,7 +1031,7 @@ export interface GetPlaybackKeyPairResponse {
|
|
|
1031
1031
|
*
|
|
1032
1032
|
* @public
|
|
1033
1033
|
*/
|
|
1034
|
-
keyPair?: PlaybackKeyPair;
|
|
1034
|
+
keyPair?: PlaybackKeyPair | undefined;
|
|
1035
1035
|
}
|
|
1036
1036
|
/**
|
|
1037
1037
|
* @public
|
|
@@ -1051,7 +1051,7 @@ export interface GetPlaybackRestrictionPolicyResponse {
|
|
|
1051
1051
|
* <p/>
|
|
1052
1052
|
* @public
|
|
1053
1053
|
*/
|
|
1054
|
-
playbackRestrictionPolicy?: PlaybackRestrictionPolicy;
|
|
1054
|
+
playbackRestrictionPolicy?: PlaybackRestrictionPolicy | undefined;
|
|
1055
1055
|
}
|
|
1056
1056
|
/**
|
|
1057
1057
|
* @public
|
|
@@ -1071,7 +1071,7 @@ export interface GetRecordingConfigurationResponse {
|
|
|
1071
1071
|
*
|
|
1072
1072
|
* @public
|
|
1073
1073
|
*/
|
|
1074
|
-
recordingConfiguration?: RecordingConfiguration;
|
|
1074
|
+
recordingConfiguration?: RecordingConfiguration | undefined;
|
|
1075
1075
|
}
|
|
1076
1076
|
/**
|
|
1077
1077
|
* <p/>
|
|
@@ -1084,7 +1084,7 @@ export declare class ChannelNotBroadcasting extends __BaseException {
|
|
|
1084
1084
|
* <p>The stream is offline for the given channel ARN.</p>
|
|
1085
1085
|
* @public
|
|
1086
1086
|
*/
|
|
1087
|
-
exceptionMessage?: string;
|
|
1087
|
+
exceptionMessage?: string | undefined;
|
|
1088
1088
|
/**
|
|
1089
1089
|
* @internal
|
|
1090
1090
|
*/
|
|
@@ -1134,35 +1134,35 @@ export interface _Stream {
|
|
|
1134
1134
|
* <p>Channel ARN for the stream.</p>
|
|
1135
1135
|
* @public
|
|
1136
1136
|
*/
|
|
1137
|
-
channelArn?: string;
|
|
1137
|
+
channelArn?: string | undefined;
|
|
1138
1138
|
/**
|
|
1139
1139
|
* <p>Unique identifier for a live or previously live stream in the specified channel.</p>
|
|
1140
1140
|
* @public
|
|
1141
1141
|
*/
|
|
1142
|
-
streamId?: string;
|
|
1142
|
+
streamId?: string | undefined;
|
|
1143
1143
|
/**
|
|
1144
1144
|
* <p>URL of the master playlist, required by the video player to play the HLS stream.</p>
|
|
1145
1145
|
* @public
|
|
1146
1146
|
*/
|
|
1147
|
-
playbackUrl?: string;
|
|
1147
|
+
playbackUrl?: string | undefined;
|
|
1148
1148
|
/**
|
|
1149
1149
|
* <p>Time of the stream’s start. This is an ISO 8601 timestamp; <i>note that this is
|
|
1150
1150
|
* returned as a string</i>.</p>
|
|
1151
1151
|
* @public
|
|
1152
1152
|
*/
|
|
1153
|
-
startTime?: Date;
|
|
1153
|
+
startTime?: Date | undefined;
|
|
1154
1154
|
/**
|
|
1155
1155
|
* <p>The stream’s state. Do not rely on the <code>OFFLINE</code> state, as the API may not
|
|
1156
1156
|
* return it; instead, a "NotBroadcasting" error will indicate that the stream is not
|
|
1157
1157
|
* live.</p>
|
|
1158
1158
|
* @public
|
|
1159
1159
|
*/
|
|
1160
|
-
state?: StreamState;
|
|
1160
|
+
state?: StreamState | undefined;
|
|
1161
1161
|
/**
|
|
1162
1162
|
* <p>The stream’s health.</p>
|
|
1163
1163
|
* @public
|
|
1164
1164
|
*/
|
|
1165
|
-
health?: StreamHealth;
|
|
1165
|
+
health?: StreamHealth | undefined;
|
|
1166
1166
|
/**
|
|
1167
1167
|
* <p>A count of concurrent views of the stream. Typically, a new view appears in
|
|
1168
1168
|
* <code>viewerCount</code> within 15 seconds of when video playback starts and a view is
|
|
@@ -1170,7 +1170,7 @@ export interface _Stream {
|
|
|
1170
1170
|
* -1 indicates that the request timed out; in this case, retry.</p>
|
|
1171
1171
|
* @public
|
|
1172
1172
|
*/
|
|
1173
|
-
viewerCount?: number;
|
|
1173
|
+
viewerCount?: number | undefined;
|
|
1174
1174
|
}
|
|
1175
1175
|
/**
|
|
1176
1176
|
* @public
|
|
@@ -1180,7 +1180,7 @@ export interface GetStreamResponse {
|
|
|
1180
1180
|
* <p/>
|
|
1181
1181
|
* @public
|
|
1182
1182
|
*/
|
|
1183
|
-
stream?: _Stream;
|
|
1183
|
+
stream?: _Stream | undefined;
|
|
1184
1184
|
}
|
|
1185
1185
|
/**
|
|
1186
1186
|
* @public
|
|
@@ -1200,7 +1200,7 @@ export interface GetStreamKeyResponse {
|
|
|
1200
1200
|
*
|
|
1201
1201
|
* @public
|
|
1202
1202
|
*/
|
|
1203
|
-
streamKey?: StreamKey;
|
|
1203
|
+
streamKey?: StreamKey | undefined;
|
|
1204
1204
|
}
|
|
1205
1205
|
/**
|
|
1206
1206
|
* @public
|
|
@@ -1217,7 +1217,7 @@ export interface GetStreamSessionRequest {
|
|
|
1217
1217
|
* channel, if it exists.</p>
|
|
1218
1218
|
* @public
|
|
1219
1219
|
*/
|
|
1220
|
-
streamId?: string;
|
|
1220
|
+
streamId?: string | undefined;
|
|
1221
1221
|
}
|
|
1222
1222
|
/**
|
|
1223
1223
|
* <p>Object specifying a stream’s audio configuration, as set up by the broadcaster (usually in
|
|
@@ -1230,22 +1230,22 @@ export interface AudioConfiguration {
|
|
|
1230
1230
|
* <p>Codec used for the audio encoding.</p>
|
|
1231
1231
|
* @public
|
|
1232
1232
|
*/
|
|
1233
|
-
codec?: string;
|
|
1233
|
+
codec?: string | undefined;
|
|
1234
1234
|
/**
|
|
1235
1235
|
* <p>The expected ingest bitrate (bits per second). This is configured in the encoder.</p>
|
|
1236
1236
|
* @public
|
|
1237
1237
|
*/
|
|
1238
|
-
targetBitrate?: number;
|
|
1238
|
+
targetBitrate?: number | undefined;
|
|
1239
1239
|
/**
|
|
1240
1240
|
* <p>Number of audio samples recorded per second.</p>
|
|
1241
1241
|
* @public
|
|
1242
1242
|
*/
|
|
1243
|
-
sampleRate?: number;
|
|
1243
|
+
sampleRate?: number | undefined;
|
|
1244
1244
|
/**
|
|
1245
1245
|
* <p>Number of audio channels.</p>
|
|
1246
1246
|
* @public
|
|
1247
1247
|
*/
|
|
1248
|
-
channels?: number;
|
|
1248
|
+
channels?: number | undefined;
|
|
1249
1249
|
}
|
|
1250
1250
|
/**
|
|
1251
1251
|
* <p>Object specifying a stream’s video configuration, as set up by the broadcaster (usually in
|
|
@@ -1259,43 +1259,43 @@ export interface VideoConfiguration {
|
|
|
1259
1259
|
* valid values, see the H.264 specification.</p>
|
|
1260
1260
|
* @public
|
|
1261
1261
|
*/
|
|
1262
|
-
avcProfile?: string;
|
|
1262
|
+
avcProfile?: string | undefined;
|
|
1263
1263
|
/**
|
|
1264
1264
|
* <p>Indicates the degree of required decoder performance for a profile. Normally this is set
|
|
1265
1265
|
* automatically by the encoder. For details, see the H.264 specification.</p>
|
|
1266
1266
|
* @public
|
|
1267
1267
|
*/
|
|
1268
|
-
avcLevel?: string;
|
|
1268
|
+
avcLevel?: string | undefined;
|
|
1269
1269
|
/**
|
|
1270
1270
|
* <p>Codec used for the video encoding.</p>
|
|
1271
1271
|
* @public
|
|
1272
1272
|
*/
|
|
1273
|
-
codec?: string;
|
|
1273
|
+
codec?: string | undefined;
|
|
1274
1274
|
/**
|
|
1275
1275
|
* <p>Software or hardware used to encode the video.</p>
|
|
1276
1276
|
* @public
|
|
1277
1277
|
*/
|
|
1278
|
-
encoder?: string;
|
|
1278
|
+
encoder?: string | undefined;
|
|
1279
1279
|
/**
|
|
1280
1280
|
* <p>The expected ingest bitrate (bits per second). This is configured in the encoder.</p>
|
|
1281
1281
|
* @public
|
|
1282
1282
|
*/
|
|
1283
|
-
targetBitrate?: number;
|
|
1283
|
+
targetBitrate?: number | undefined;
|
|
1284
1284
|
/**
|
|
1285
1285
|
* <p>The expected ingest framerate. This is configured in the encoder.</p>
|
|
1286
1286
|
* @public
|
|
1287
1287
|
*/
|
|
1288
|
-
targetFramerate?: number;
|
|
1288
|
+
targetFramerate?: number | undefined;
|
|
1289
1289
|
/**
|
|
1290
1290
|
* <p>Video-resolution height in pixels.</p>
|
|
1291
1291
|
* @public
|
|
1292
1292
|
*/
|
|
1293
|
-
videoHeight?: number;
|
|
1293
|
+
videoHeight?: number | undefined;
|
|
1294
1294
|
/**
|
|
1295
1295
|
* <p>Video-resolution width in pixels.</p>
|
|
1296
1296
|
* @public
|
|
1297
1297
|
*/
|
|
1298
|
-
videoWidth?: number;
|
|
1298
|
+
videoWidth?: number | undefined;
|
|
1299
1299
|
}
|
|
1300
1300
|
/**
|
|
1301
1301
|
* <p>Object specifying the ingest configuration set up by the broadcaster, usually in an
|
|
@@ -1307,12 +1307,12 @@ export interface IngestConfiguration {
|
|
|
1307
1307
|
* <p>Encoder settings for video.</p>
|
|
1308
1308
|
* @public
|
|
1309
1309
|
*/
|
|
1310
|
-
video?: VideoConfiguration;
|
|
1310
|
+
video?: VideoConfiguration | undefined;
|
|
1311
1311
|
/**
|
|
1312
1312
|
* <p>Encoder settings for audio.</p>
|
|
1313
1313
|
* @public
|
|
1314
1314
|
*/
|
|
1315
|
-
audio?: AudioConfiguration;
|
|
1315
|
+
audio?: AudioConfiguration | undefined;
|
|
1316
1316
|
}
|
|
1317
1317
|
/**
|
|
1318
1318
|
* <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
|
|
@@ -1324,18 +1324,18 @@ export interface StreamEvent {
|
|
|
1324
1324
|
* <p>Name that identifies the stream event within a <code>type</code>.</p>
|
|
1325
1325
|
* @public
|
|
1326
1326
|
*/
|
|
1327
|
-
name?: string;
|
|
1327
|
+
name?: string | undefined;
|
|
1328
1328
|
/**
|
|
1329
1329
|
* <p>Logical group for certain events.</p>
|
|
1330
1330
|
* @public
|
|
1331
1331
|
*/
|
|
1332
|
-
type?: string;
|
|
1332
|
+
type?: string | undefined;
|
|
1333
1333
|
/**
|
|
1334
1334
|
* <p>Time when the event occurred. This is an ISO 8601 timestamp; <i>note that this is
|
|
1335
1335
|
* returned as a string</i>.</p>
|
|
1336
1336
|
* @public
|
|
1337
1337
|
*/
|
|
1338
|
-
eventTime?: Date;
|
|
1338
|
+
eventTime?: Date | undefined;
|
|
1339
1339
|
/**
|
|
1340
1340
|
* <p>Provides additional details about the stream event. There are several values; note that
|
|
1341
1341
|
* the long descriptions are provided in the IVS console but not delivered through
|
|
@@ -1361,7 +1361,7 @@ export interface StreamEvent {
|
|
|
1361
1361
|
* </ul>
|
|
1362
1362
|
* @public
|
|
1363
1363
|
*/
|
|
1364
|
-
code?: string;
|
|
1364
|
+
code?: string | undefined;
|
|
1365
1365
|
}
|
|
1366
1366
|
/**
|
|
1367
1367
|
* <p>Object that captures the Amazon IVS configuration that the customer provisioned, the
|
|
@@ -1374,41 +1374,41 @@ export interface StreamSession {
|
|
|
1374
1374
|
* <p>Unique identifier for a live or previously live stream in the specified channel.</p>
|
|
1375
1375
|
* @public
|
|
1376
1376
|
*/
|
|
1377
|
-
streamId?: string;
|
|
1377
|
+
streamId?: string | undefined;
|
|
1378
1378
|
/**
|
|
1379
1379
|
* <p>Time when the channel went live. This is an ISO 8601 timestamp; <i>note that this
|
|
1380
1380
|
* is returned as a string</i>.</p>
|
|
1381
1381
|
* @public
|
|
1382
1382
|
*/
|
|
1383
|
-
startTime?: Date;
|
|
1383
|
+
startTime?: Date | undefined;
|
|
1384
1384
|
/**
|
|
1385
1385
|
* <p>Time when the channel went offline. This is an ISO 8601 timestamp; <i>note that
|
|
1386
1386
|
* this is returned as a string</i>. For live streams, this is <code>NULL</code>.</p>
|
|
1387
1387
|
* @public
|
|
1388
1388
|
*/
|
|
1389
|
-
endTime?: Date;
|
|
1389
|
+
endTime?: Date | undefined;
|
|
1390
1390
|
/**
|
|
1391
1391
|
* <p>The properties of the channel at the time of going live.</p>
|
|
1392
1392
|
* @public
|
|
1393
1393
|
*/
|
|
1394
|
-
channel?: Channel;
|
|
1394
|
+
channel?: Channel | undefined;
|
|
1395
1395
|
/**
|
|
1396
1396
|
* <p>The properties of the incoming RTMP stream for the stream.</p>
|
|
1397
1397
|
* @public
|
|
1398
1398
|
*/
|
|
1399
|
-
ingestConfiguration?: IngestConfiguration;
|
|
1399
|
+
ingestConfiguration?: IngestConfiguration | undefined;
|
|
1400
1400
|
/**
|
|
1401
1401
|
* <p>The properties of recording the live stream.</p>
|
|
1402
1402
|
* @public
|
|
1403
1403
|
*/
|
|
1404
|
-
recordingConfiguration?: RecordingConfiguration;
|
|
1404
|
+
recordingConfiguration?: RecordingConfiguration | undefined;
|
|
1405
1405
|
/**
|
|
1406
1406
|
* <p>List of Amazon IVS events that the stream encountered. The list is sorted by most recent
|
|
1407
1407
|
* events and contains up to 500 events. For Amazon IVS events, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html">Using Amazon EventBridge with Amazon
|
|
1408
1408
|
* IVS</a>.</p>
|
|
1409
1409
|
* @public
|
|
1410
1410
|
*/
|
|
1411
|
-
truncatedEvents?: StreamEvent[];
|
|
1411
|
+
truncatedEvents?: StreamEvent[] | undefined;
|
|
1412
1412
|
}
|
|
1413
1413
|
/**
|
|
1414
1414
|
* @public
|
|
@@ -1418,7 +1418,7 @@ export interface GetStreamSessionResponse {
|
|
|
1418
1418
|
* <p>List of stream details.</p>
|
|
1419
1419
|
* @public
|
|
1420
1420
|
*/
|
|
1421
|
-
streamSession?: StreamSession;
|
|
1421
|
+
streamSession?: StreamSession | undefined;
|
|
1422
1422
|
}
|
|
1423
1423
|
/**
|
|
1424
1424
|
* @public
|
|
@@ -1433,13 +1433,13 @@ export interface ImportPlaybackKeyPairRequest {
|
|
|
1433
1433
|
* <p>Playback-key-pair name. The value does not need to be unique.</p>
|
|
1434
1434
|
* @public
|
|
1435
1435
|
*/
|
|
1436
|
-
name?: string;
|
|
1436
|
+
name?: string | undefined;
|
|
1437
1437
|
/**
|
|
1438
1438
|
* <p>Any tags provided with the request are added to the playback key pair tags. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is
|
|
1439
1439
|
* documented there.</p>
|
|
1440
1440
|
* @public
|
|
1441
1441
|
*/
|
|
1442
|
-
tags?: Record<string, string
|
|
1442
|
+
tags?: Record<string, string> | undefined;
|
|
1443
1443
|
}
|
|
1444
1444
|
/**
|
|
1445
1445
|
* @public
|
|
@@ -1449,7 +1449,7 @@ export interface ImportPlaybackKeyPairResponse {
|
|
|
1449
1449
|
* <p/>
|
|
1450
1450
|
* @public
|
|
1451
1451
|
*/
|
|
1452
|
-
keyPair?: PlaybackKeyPair;
|
|
1452
|
+
keyPair?: PlaybackKeyPair | undefined;
|
|
1453
1453
|
}
|
|
1454
1454
|
/**
|
|
1455
1455
|
* @public
|
|
@@ -1459,28 +1459,28 @@ export interface ListChannelsRequest {
|
|
|
1459
1459
|
* <p>Filters the channel list to match the specified name.</p>
|
|
1460
1460
|
* @public
|
|
1461
1461
|
*/
|
|
1462
|
-
filterByName?: string;
|
|
1462
|
+
filterByName?: string | undefined;
|
|
1463
1463
|
/**
|
|
1464
1464
|
* <p>Filters the channel list to match the specified recording-configuration ARN.</p>
|
|
1465
1465
|
* @public
|
|
1466
1466
|
*/
|
|
1467
|
-
filterByRecordingConfigurationArn?: string;
|
|
1467
|
+
filterByRecordingConfigurationArn?: string | undefined;
|
|
1468
1468
|
/**
|
|
1469
1469
|
* <p>Filters the channel list to match the specified policy.</p>
|
|
1470
1470
|
* @public
|
|
1471
1471
|
*/
|
|
1472
|
-
filterByPlaybackRestrictionPolicyArn?: string;
|
|
1472
|
+
filterByPlaybackRestrictionPolicyArn?: string | undefined;
|
|
1473
1473
|
/**
|
|
1474
1474
|
* <p>The first channel to retrieve. This is used for pagination; see the <code>nextToken</code>
|
|
1475
1475
|
* response field.</p>
|
|
1476
1476
|
* @public
|
|
1477
1477
|
*/
|
|
1478
|
-
nextToken?: string;
|
|
1478
|
+
nextToken?: string | undefined;
|
|
1479
1479
|
/**
|
|
1480
1480
|
* <p>Maximum number of channels to return. Default: 100.</p>
|
|
1481
1481
|
* @public
|
|
1482
1482
|
*/
|
|
1483
|
-
maxResults?: number;
|
|
1483
|
+
maxResults?: number | undefined;
|
|
1484
1484
|
}
|
|
1485
1485
|
/**
|
|
1486
1486
|
* <p>Summary information about a channel.</p>
|
|
@@ -1491,43 +1491,43 @@ export interface ChannelSummary {
|
|
|
1491
1491
|
* <p>Channel ARN.</p>
|
|
1492
1492
|
* @public
|
|
1493
1493
|
*/
|
|
1494
|
-
arn?: string;
|
|
1494
|
+
arn?: string | undefined;
|
|
1495
1495
|
/**
|
|
1496
1496
|
* <p>Channel name.</p>
|
|
1497
1497
|
* @public
|
|
1498
1498
|
*/
|
|
1499
|
-
name?: string;
|
|
1499
|
+
name?: string | undefined;
|
|
1500
1500
|
/**
|
|
1501
1501
|
* <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to
|
|
1502
1502
|
* Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default:
|
|
1503
1503
|
* <code>LOW</code>.</p>
|
|
1504
1504
|
* @public
|
|
1505
1505
|
*/
|
|
1506
|
-
latencyMode?: ChannelLatencyMode;
|
|
1506
|
+
latencyMode?: ChannelLatencyMode | undefined;
|
|
1507
1507
|
/**
|
|
1508
1508
|
* <p>Whether the channel is private (enabled for playback authorization). Default:
|
|
1509
1509
|
* <code>false</code>.</p>
|
|
1510
1510
|
* @public
|
|
1511
1511
|
*/
|
|
1512
|
-
authorized?: boolean;
|
|
1512
|
+
authorized?: boolean | undefined;
|
|
1513
1513
|
/**
|
|
1514
1514
|
* <p>Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables
|
|
1515
1515
|
* recording. Default: "" (empty string, recording is disabled).</p>
|
|
1516
1516
|
* @public
|
|
1517
1517
|
*/
|
|
1518
|
-
recordingConfigurationArn?: string;
|
|
1518
|
+
recordingConfigurationArn?: string | undefined;
|
|
1519
1519
|
/**
|
|
1520
1520
|
* <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
|
|
1521
1521
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
|
|
1522
1522
|
* service-specific constraints beyond what is documented there.</p>
|
|
1523
1523
|
* @public
|
|
1524
1524
|
*/
|
|
1525
|
-
tags?: Record<string, string
|
|
1525
|
+
tags?: Record<string, string> | undefined;
|
|
1526
1526
|
/**
|
|
1527
1527
|
* <p>Whether the channel allows insecure RTMP ingest. Default: <code>false</code>.</p>
|
|
1528
1528
|
* @public
|
|
1529
1529
|
*/
|
|
1530
|
-
insecureIngest?: boolean;
|
|
1530
|
+
insecureIngest?: boolean | undefined;
|
|
1531
1531
|
/**
|
|
1532
1532
|
* <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
|
|
1533
1533
|
* exceed the allowable input resolution or bitrate, the stream probably will disconnect
|
|
@@ -1535,7 +1535,7 @@ export interface ChannelSummary {
|
|
|
1535
1535
|
* Types</a>.</p>
|
|
1536
1536
|
* @public
|
|
1537
1537
|
*/
|
|
1538
|
-
type?: ChannelType;
|
|
1538
|
+
type?: ChannelType | undefined;
|
|
1539
1539
|
/**
|
|
1540
1540
|
* <p>Optional transcode preset for the channel. This is selectable only for
|
|
1541
1541
|
* <code>ADVANCED_HD</code> and <code>ADVANCED_SD</code> channel types. For those channel
|
|
@@ -1544,14 +1544,14 @@ export interface ChannelSummary {
|
|
|
1544
1544
|
* string (<code>""</code>).</p>
|
|
1545
1545
|
* @public
|
|
1546
1546
|
*/
|
|
1547
|
-
preset?: TranscodePreset;
|
|
1547
|
+
preset?: TranscodePreset | undefined;
|
|
1548
1548
|
/**
|
|
1549
1549
|
* <p>Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables
|
|
1550
1550
|
* playback restriction. Default: "" (empty string, no playback restriction policy is
|
|
1551
1551
|
* applied).</p>
|
|
1552
1552
|
* @public
|
|
1553
1553
|
*/
|
|
1554
|
-
playbackRestrictionPolicyArn?: string;
|
|
1554
|
+
playbackRestrictionPolicyArn?: string | undefined;
|
|
1555
1555
|
}
|
|
1556
1556
|
/**
|
|
1557
1557
|
* @public
|
|
@@ -1567,7 +1567,7 @@ export interface ListChannelsResponse {
|
|
|
1567
1567
|
* request to get the next set.</p>
|
|
1568
1568
|
* @public
|
|
1569
1569
|
*/
|
|
1570
|
-
nextToken?: string;
|
|
1570
|
+
nextToken?: string | undefined;
|
|
1571
1571
|
}
|
|
1572
1572
|
/**
|
|
1573
1573
|
* @public
|
|
@@ -1578,13 +1578,13 @@ export interface ListPlaybackKeyPairsRequest {
|
|
|
1578
1578
|
* <code>nextToken</code> response field.</p>
|
|
1579
1579
|
* @public
|
|
1580
1580
|
*/
|
|
1581
|
-
nextToken?: string;
|
|
1581
|
+
nextToken?: string | undefined;
|
|
1582
1582
|
/**
|
|
1583
1583
|
* <p>Maximum number of key pairs to return. Default: your service quota or 100, whichever is
|
|
1584
1584
|
* smaller.</p>
|
|
1585
1585
|
* @public
|
|
1586
1586
|
*/
|
|
1587
|
-
maxResults?: number;
|
|
1587
|
+
maxResults?: number | undefined;
|
|
1588
1588
|
}
|
|
1589
1589
|
/**
|
|
1590
1590
|
* <p>Summary information about a playback key pair.</p>
|
|
@@ -1595,19 +1595,19 @@ export interface PlaybackKeyPairSummary {
|
|
|
1595
1595
|
* <p>Key-pair ARN.</p>
|
|
1596
1596
|
* @public
|
|
1597
1597
|
*/
|
|
1598
|
-
arn?: string;
|
|
1598
|
+
arn?: string | undefined;
|
|
1599
1599
|
/**
|
|
1600
1600
|
* <p>Playback-key-pair name. The value does not need to be unique.</p>
|
|
1601
1601
|
* @public
|
|
1602
1602
|
*/
|
|
1603
|
-
name?: string;
|
|
1603
|
+
name?: string | undefined;
|
|
1604
1604
|
/**
|
|
1605
1605
|
* <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
|
|
1606
1606
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
|
|
1607
1607
|
* service-specific constraints beyond what is documented there.</p>
|
|
1608
1608
|
* @public
|
|
1609
1609
|
*/
|
|
1610
|
-
tags?: Record<string, string
|
|
1610
|
+
tags?: Record<string, string> | undefined;
|
|
1611
1611
|
}
|
|
1612
1612
|
/**
|
|
1613
1613
|
* @public
|
|
@@ -1623,7 +1623,7 @@ export interface ListPlaybackKeyPairsResponse {
|
|
|
1623
1623
|
* the request to get the next set.</p>
|
|
1624
1624
|
* @public
|
|
1625
1625
|
*/
|
|
1626
|
-
nextToken?: string;
|
|
1626
|
+
nextToken?: string | undefined;
|
|
1627
1627
|
}
|
|
1628
1628
|
/**
|
|
1629
1629
|
* @public
|
|
@@ -1634,12 +1634,12 @@ export interface ListPlaybackRestrictionPoliciesRequest {
|
|
|
1634
1634
|
* response field.</p>
|
|
1635
1635
|
* @public
|
|
1636
1636
|
*/
|
|
1637
|
-
nextToken?: string;
|
|
1637
|
+
nextToken?: string | undefined;
|
|
1638
1638
|
/**
|
|
1639
1639
|
* <p>Maximum number of policies to return. Default: 1.</p>
|
|
1640
1640
|
* @public
|
|
1641
1641
|
*/
|
|
1642
|
-
maxResults?: number;
|
|
1642
|
+
maxResults?: number | undefined;
|
|
1643
1643
|
}
|
|
1644
1644
|
/**
|
|
1645
1645
|
* <p>Summary information about a PlaybackRestrictionPolicy.</p>
|
|
@@ -1670,19 +1670,19 @@ export interface PlaybackRestrictionPolicySummary {
|
|
|
1670
1670
|
* <code>false</code>.</p>
|
|
1671
1671
|
* @public
|
|
1672
1672
|
*/
|
|
1673
|
-
enableStrictOriginEnforcement?: boolean;
|
|
1673
|
+
enableStrictOriginEnforcement?: boolean | undefined;
|
|
1674
1674
|
/**
|
|
1675
1675
|
* <p>Playback-restriction-policy name. The value does not need to be unique.</p>
|
|
1676
1676
|
* @public
|
|
1677
1677
|
*/
|
|
1678
|
-
name?: string;
|
|
1678
|
+
name?: string | undefined;
|
|
1679
1679
|
/**
|
|
1680
1680
|
* <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
|
|
1681
1681
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
|
|
1682
1682
|
* service-specific constraints beyond what is documented there.</p>
|
|
1683
1683
|
* @public
|
|
1684
1684
|
*/
|
|
1685
|
-
tags?: Record<string, string
|
|
1685
|
+
tags?: Record<string, string> | undefined;
|
|
1686
1686
|
}
|
|
1687
1687
|
/**
|
|
1688
1688
|
* @public
|
|
@@ -1698,7 +1698,7 @@ export interface ListPlaybackRestrictionPoliciesResponse {
|
|
|
1698
1698
|
* request to get the next set.</p>
|
|
1699
1699
|
* @public
|
|
1700
1700
|
*/
|
|
1701
|
-
nextToken?: string;
|
|
1701
|
+
nextToken?: string | undefined;
|
|
1702
1702
|
}
|
|
1703
1703
|
/**
|
|
1704
1704
|
* @public
|
|
@@ -1709,13 +1709,13 @@ export interface ListRecordingConfigurationsRequest {
|
|
|
1709
1709
|
* <code>nextToken</code> response field.</p>
|
|
1710
1710
|
* @public
|
|
1711
1711
|
*/
|
|
1712
|
-
nextToken?: string;
|
|
1712
|
+
nextToken?: string | undefined;
|
|
1713
1713
|
/**
|
|
1714
1714
|
* <p>Maximum number of recording configurations to return. Default: your service quota or 100,
|
|
1715
1715
|
* whichever is smaller. </p>
|
|
1716
1716
|
* @public
|
|
1717
1717
|
*/
|
|
1718
|
-
maxResults?: number;
|
|
1718
|
+
maxResults?: number | undefined;
|
|
1719
1719
|
}
|
|
1720
1720
|
/**
|
|
1721
1721
|
* <p>Summary information about a RecordingConfiguration.</p>
|
|
@@ -1731,7 +1731,7 @@ export interface RecordingConfigurationSummary {
|
|
|
1731
1731
|
* <p>Recording-configuration name. The value does not need to be unique.</p>
|
|
1732
1732
|
* @public
|
|
1733
1733
|
*/
|
|
1734
|
-
name?: string;
|
|
1734
|
+
name?: string | undefined;
|
|
1735
1735
|
/**
|
|
1736
1736
|
* <p>A complex type that contains information about where recorded video will be stored.</p>
|
|
1737
1737
|
* @public
|
|
@@ -1749,7 +1749,7 @@ export interface RecordingConfigurationSummary {
|
|
|
1749
1749
|
* service-specific constraints beyond what is documented there.</p>
|
|
1750
1750
|
* @public
|
|
1751
1751
|
*/
|
|
1752
|
-
tags?: Record<string, string
|
|
1752
|
+
tags?: Record<string, string> | undefined;
|
|
1753
1753
|
}
|
|
1754
1754
|
/**
|
|
1755
1755
|
* @public
|
|
@@ -1765,7 +1765,7 @@ export interface ListRecordingConfigurationsResponse {
|
|
|
1765
1765
|
* <code>nextToken</code> in the request to get the next set.</p>
|
|
1766
1766
|
* @public
|
|
1767
1767
|
*/
|
|
1768
|
-
nextToken?: string;
|
|
1768
|
+
nextToken?: string | undefined;
|
|
1769
1769
|
}
|
|
1770
1770
|
/**
|
|
1771
1771
|
* @public
|
|
@@ -1781,12 +1781,12 @@ export interface ListStreamKeysRequest {
|
|
|
1781
1781
|
* <code>nextToken</code> response field.</p>
|
|
1782
1782
|
* @public
|
|
1783
1783
|
*/
|
|
1784
|
-
nextToken?: string;
|
|
1784
|
+
nextToken?: string | undefined;
|
|
1785
1785
|
/**
|
|
1786
1786
|
* <p>Maximum number of streamKeys to return. Default: 1.</p>
|
|
1787
1787
|
* @public
|
|
1788
1788
|
*/
|
|
1789
|
-
maxResults?: number;
|
|
1789
|
+
maxResults?: number | undefined;
|
|
1790
1790
|
}
|
|
1791
1791
|
/**
|
|
1792
1792
|
* <p>Summary information about a stream key.</p>
|
|
@@ -1797,19 +1797,19 @@ export interface StreamKeySummary {
|
|
|
1797
1797
|
* <p>Stream-key ARN.</p>
|
|
1798
1798
|
* @public
|
|
1799
1799
|
*/
|
|
1800
|
-
arn?: string;
|
|
1800
|
+
arn?: string | undefined;
|
|
1801
1801
|
/**
|
|
1802
1802
|
* <p>Channel ARN for the stream.</p>
|
|
1803
1803
|
* @public
|
|
1804
1804
|
*/
|
|
1805
|
-
channelArn?: string;
|
|
1805
|
+
channelArn?: string | undefined;
|
|
1806
1806
|
/**
|
|
1807
1807
|
* <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
|
|
1808
1808
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/tag-editor/latest/userguide/best-practices-and-strats.html">Best practices and strategies</a> in <i>Tagging Amazon Web Services Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
|
|
1809
1809
|
* service-specific constraints beyond what is documented there.</p>
|
|
1810
1810
|
* @public
|
|
1811
1811
|
*/
|
|
1812
|
-
tags?: Record<string, string
|
|
1812
|
+
tags?: Record<string, string> | undefined;
|
|
1813
1813
|
}
|
|
1814
1814
|
/**
|
|
1815
1815
|
* @public
|
|
@@ -1825,7 +1825,7 @@ export interface ListStreamKeysResponse {
|
|
|
1825
1825
|
* the request to get the next set.</p>
|
|
1826
1826
|
* @public
|
|
1827
1827
|
*/
|
|
1828
|
-
nextToken?: string;
|
|
1828
|
+
nextToken?: string | undefined;
|
|
1829
1829
|
}
|
|
1830
1830
|
/**
|
|
1831
1831
|
* <p>Object specifying the stream attribute on which to filter.</p>
|
|
@@ -1836,7 +1836,7 @@ export interface StreamFilters {
|
|
|
1836
1836
|
* <p>The stream’s health.</p>
|
|
1837
1837
|
* @public
|
|
1838
1838
|
*/
|
|
1839
|
-
health?: StreamHealth;
|
|
1839
|
+
health?: StreamHealth | undefined;
|
|
1840
1840
|
}
|
|
1841
1841
|
/**
|
|
1842
1842
|
* @public
|
|
@@ -1846,18 +1846,18 @@ export interface ListStreamsRequest {
|
|
|
1846
1846
|
* <p>Filters the stream list to match the specified criterion.</p>
|
|
1847
1847
|
* @public
|
|
1848
1848
|
*/
|
|
1849
|
-
filterBy?: StreamFilters;
|
|
1849
|
+
filterBy?: StreamFilters | undefined;
|
|
1850
1850
|
/**
|
|
1851
1851
|
* <p>The first stream to retrieve. This is used for pagination; see the <code>nextToken</code>
|
|
1852
1852
|
* response field.</p>
|
|
1853
1853
|
* @public
|
|
1854
1854
|
*/
|
|
1855
|
-
nextToken?: string;
|
|
1855
|
+
nextToken?: string | undefined;
|
|
1856
1856
|
/**
|
|
1857
1857
|
* <p>Maximum number of streams to return. Default: 100.</p>
|
|
1858
1858
|
* @public
|
|
1859
1859
|
*/
|
|
1860
|
-
maxResults?: number;
|
|
1860
|
+
maxResults?: number | undefined;
|
|
1861
1861
|
}
|
|
1862
1862
|
/**
|
|
1863
1863
|
* <p>Summary information about a stream.</p>
|
|
@@ -1868,24 +1868,24 @@ export interface StreamSummary {
|
|
|
1868
1868
|
* <p>Channel ARN for the stream.</p>
|
|
1869
1869
|
* @public
|
|
1870
1870
|
*/
|
|
1871
|
-
channelArn?: string;
|
|
1871
|
+
channelArn?: string | undefined;
|
|
1872
1872
|
/**
|
|
1873
1873
|
* <p>Unique identifier for a live or previously live stream in the specified channel.</p>
|
|
1874
1874
|
* @public
|
|
1875
1875
|
*/
|
|
1876
|
-
streamId?: string;
|
|
1876
|
+
streamId?: string | undefined;
|
|
1877
1877
|
/**
|
|
1878
1878
|
* <p>The stream’s state. Do not rely on the <code>OFFLINE</code> state, as the API may not
|
|
1879
1879
|
* return it; instead, a "NotBroadcasting" error will indicate that the stream is not
|
|
1880
1880
|
* live.</p>
|
|
1881
1881
|
* @public
|
|
1882
1882
|
*/
|
|
1883
|
-
state?: StreamState;
|
|
1883
|
+
state?: StreamState | undefined;
|
|
1884
1884
|
/**
|
|
1885
1885
|
* <p>The stream’s health.</p>
|
|
1886
1886
|
* @public
|
|
1887
1887
|
*/
|
|
1888
|
-
health?: StreamHealth;
|
|
1888
|
+
health?: StreamHealth | undefined;
|
|
1889
1889
|
/**
|
|
1890
1890
|
* <p>A count of concurrent views of the stream. Typically, a new view appears in
|
|
1891
1891
|
* <code>viewerCount</code> within 15 seconds of when video playback starts and a view is
|
|
@@ -1893,13 +1893,13 @@ export interface StreamSummary {
|
|
|
1893
1893
|
* -1 indicates that the request timed out; in this case, retry.</p>
|
|
1894
1894
|
* @public
|
|
1895
1895
|
*/
|
|
1896
|
-
viewerCount?: number;
|
|
1896
|
+
viewerCount?: number | undefined;
|
|
1897
1897
|
/**
|
|
1898
1898
|
* <p>Time of the stream’s start. This is an ISO 8601 timestamp; <i>note that this is
|
|
1899
1899
|
* returned as a string</i>. </p>
|
|
1900
1900
|
* @public
|
|
1901
1901
|
*/
|
|
1902
|
-
startTime?: Date;
|
|
1902
|
+
startTime?: Date | undefined;
|
|
1903
1903
|
}
|
|
1904
1904
|
/**
|
|
1905
1905
|
* @public
|
|
@@ -1915,7 +1915,7 @@ export interface ListStreamsResponse {
|
|
|
1915
1915
|
* request to get the next set.</p>
|
|
1916
1916
|
* @public
|
|
1917
1917
|
*/
|
|
1918
|
-
nextToken?: string;
|
|
1918
|
+
nextToken?: string | undefined;
|
|
1919
1919
|
}
|
|
1920
1920
|
/**
|
|
1921
1921
|
* @public
|
|
@@ -1931,12 +1931,12 @@ export interface ListStreamSessionsRequest {
|
|
|
1931
1931
|
* response field.</p>
|
|
1932
1932
|
* @public
|
|
1933
1933
|
*/
|
|
1934
|
-
nextToken?: string;
|
|
1934
|
+
nextToken?: string | undefined;
|
|
1935
1935
|
/**
|
|
1936
1936
|
* <p>Maximum number of streams to return. Default: 100.</p>
|
|
1937
1937
|
* @public
|
|
1938
1938
|
*/
|
|
1939
|
-
maxResults?: number;
|
|
1939
|
+
maxResults?: number | undefined;
|
|
1940
1940
|
}
|
|
1941
1941
|
/**
|
|
1942
1942
|
* <p>Summary information about a stream session.</p>
|
|
@@ -1947,24 +1947,24 @@ export interface StreamSessionSummary {
|
|
|
1947
1947
|
* <p>Unique identifier for a live or previously live stream in the specified channel.</p>
|
|
1948
1948
|
* @public
|
|
1949
1949
|
*/
|
|
1950
|
-
streamId?: string;
|
|
1950
|
+
streamId?: string | undefined;
|
|
1951
1951
|
/**
|
|
1952
1952
|
* <p>Time when the channel went live. This is an ISO 8601 timestamp; <i>note that this
|
|
1953
1953
|
* is returned as a string</i>.</p>
|
|
1954
1954
|
* @public
|
|
1955
1955
|
*/
|
|
1956
|
-
startTime?: Date;
|
|
1956
|
+
startTime?: Date | undefined;
|
|
1957
1957
|
/**
|
|
1958
1958
|
* <p>Time when the channel went offline. This is an ISO 8601 timestamp; <i>note that
|
|
1959
1959
|
* this is returned as a string</i>. For live streams, this is <code>NULL</code>.</p>
|
|
1960
1960
|
* @public
|
|
1961
1961
|
*/
|
|
1962
|
-
endTime?: Date;
|
|
1962
|
+
endTime?: Date | undefined;
|
|
1963
1963
|
/**
|
|
1964
1964
|
* <p>If <code>true</code>, this stream encountered a quota breach or failure.</p>
|
|
1965
1965
|
* @public
|
|
1966
1966
|
*/
|
|
1967
|
-
hasErrorEvent?: boolean;
|
|
1967
|
+
hasErrorEvent?: boolean | undefined;
|
|
1968
1968
|
}
|
|
1969
1969
|
/**
|
|
1970
1970
|
* @public
|
|
@@ -1980,7 +1980,7 @@ export interface ListStreamSessionsResponse {
|
|
|
1980
1980
|
* request to get the next set.</p>
|
|
1981
1981
|
* @public
|
|
1982
1982
|
*/
|
|
1983
|
-
nextToken?: string;
|
|
1983
|
+
nextToken?: string | undefined;
|
|
1984
1984
|
}
|
|
1985
1985
|
/**
|
|
1986
1986
|
* @public
|
|
@@ -2039,7 +2039,7 @@ export interface StartViewerSessionRevocationRequest {
|
|
|
2039
2039
|
* than or equal to the specified version will be revoked. Default: 0.</p>
|
|
2040
2040
|
* @public
|
|
2041
2041
|
*/
|
|
2042
|
-
viewerSessionVersionsLessThanOrEqualTo?: number;
|
|
2042
|
+
viewerSessionVersionsLessThanOrEqualTo?: number | undefined;
|
|
2043
2043
|
}
|
|
2044
2044
|
/**
|
|
2045
2045
|
* @public
|
|
@@ -2072,7 +2072,7 @@ export declare class StreamUnavailable extends __BaseException {
|
|
|
2072
2072
|
* <p>The stream is temporarily unavailable.</p>
|
|
2073
2073
|
* @public
|
|
2074
2074
|
*/
|
|
2075
|
-
exceptionMessage?: string;
|
|
2075
|
+
exceptionMessage?: string | undefined;
|
|
2076
2076
|
/**
|
|
2077
2077
|
* @internal
|
|
2078
2078
|
*/
|
|
@@ -2136,13 +2136,13 @@ export interface UpdateChannelRequest {
|
|
|
2136
2136
|
* <p>Channel name.</p>
|
|
2137
2137
|
* @public
|
|
2138
2138
|
*/
|
|
2139
|
-
name?: string;
|
|
2139
|
+
name?: string | undefined;
|
|
2140
2140
|
/**
|
|
2141
2141
|
* <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to
|
|
2142
2142
|
* Full HD. Use <code>LOW</code> for near-real-time interaction with viewers.</p>
|
|
2143
2143
|
* @public
|
|
2144
2144
|
*/
|
|
2145
|
-
latencyMode?: ChannelLatencyMode;
|
|
2145
|
+
latencyMode?: ChannelLatencyMode | undefined;
|
|
2146
2146
|
/**
|
|
2147
2147
|
* <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
|
|
2148
2148
|
* exceed the allowable input resolution or bitrate, the stream probably will disconnect
|
|
@@ -2150,23 +2150,23 @@ export interface UpdateChannelRequest {
|
|
|
2150
2150
|
* Types</a>.</p>
|
|
2151
2151
|
* @public
|
|
2152
2152
|
*/
|
|
2153
|
-
type?: ChannelType;
|
|
2153
|
+
type?: ChannelType | undefined;
|
|
2154
2154
|
/**
|
|
2155
2155
|
* <p>Whether the channel is private (enabled for playback authorization).</p>
|
|
2156
2156
|
* @public
|
|
2157
2157
|
*/
|
|
2158
|
-
authorized?: boolean;
|
|
2158
|
+
authorized?: boolean | undefined;
|
|
2159
2159
|
/**
|
|
2160
2160
|
* <p>Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording.
|
|
2161
2161
|
* If this is set to an empty string, recording is disabled.</p>
|
|
2162
2162
|
* @public
|
|
2163
2163
|
*/
|
|
2164
|
-
recordingConfigurationArn?: string;
|
|
2164
|
+
recordingConfigurationArn?: string | undefined;
|
|
2165
2165
|
/**
|
|
2166
2166
|
* <p>Whether the channel allows insecure RTMP and SRT ingest. Default: <code>false</code>.</p>
|
|
2167
2167
|
* @public
|
|
2168
2168
|
*/
|
|
2169
|
-
insecureIngest?: boolean;
|
|
2169
|
+
insecureIngest?: boolean | undefined;
|
|
2170
2170
|
/**
|
|
2171
2171
|
* <p>Optional transcode preset for the channel. This is selectable only for
|
|
2172
2172
|
* <code>ADVANCED_HD</code> and <code>ADVANCED_SD</code> channel types. For those channel
|
|
@@ -2175,13 +2175,13 @@ export interface UpdateChannelRequest {
|
|
|
2175
2175
|
* string (<code>""</code>).</p>
|
|
2176
2176
|
* @public
|
|
2177
2177
|
*/
|
|
2178
|
-
preset?: TranscodePreset;
|
|
2178
|
+
preset?: TranscodePreset | undefined;
|
|
2179
2179
|
/**
|
|
2180
2180
|
* <p>Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction.
|
|
2181
2181
|
* If this is set to an empty string, playback restriction policy is disabled.</p>
|
|
2182
2182
|
* @public
|
|
2183
2183
|
*/
|
|
2184
|
-
playbackRestrictionPolicyArn?: string;
|
|
2184
|
+
playbackRestrictionPolicyArn?: string | undefined;
|
|
2185
2185
|
}
|
|
2186
2186
|
/**
|
|
2187
2187
|
* @public
|
|
@@ -2191,7 +2191,7 @@ export interface UpdateChannelResponse {
|
|
|
2191
2191
|
* <p>Object specifying the updated channel.</p>
|
|
2192
2192
|
* @public
|
|
2193
2193
|
*/
|
|
2194
|
-
channel?: Channel;
|
|
2194
|
+
channel?: Channel | undefined;
|
|
2195
2195
|
}
|
|
2196
2196
|
/**
|
|
2197
2197
|
* @public
|
|
@@ -2208,25 +2208,25 @@ export interface UpdatePlaybackRestrictionPolicyRequest {
|
|
|
2208
2208
|
* alpha-2</a> codes. Default: All countries (an empty array).</p>
|
|
2209
2209
|
* @public
|
|
2210
2210
|
*/
|
|
2211
|
-
allowedCountries?: string[];
|
|
2211
|
+
allowedCountries?: string[] | undefined;
|
|
2212
2212
|
/**
|
|
2213
2213
|
* <p>A list of origin sites that control CORS restriction. Allowed values are the same as valid
|
|
2214
2214
|
* values of the Origin header defined at <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin">https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin</a>. Default: All
|
|
2215
2215
|
* origins (an empty array).</p>
|
|
2216
2216
|
* @public
|
|
2217
2217
|
*/
|
|
2218
|
-
allowedOrigins?: string[];
|
|
2218
|
+
allowedOrigins?: string[] | undefined;
|
|
2219
2219
|
/**
|
|
2220
2220
|
* <p>Whether channel playback is constrained by origin site. Default:
|
|
2221
2221
|
* <code>false</code>.</p>
|
|
2222
2222
|
* @public
|
|
2223
2223
|
*/
|
|
2224
|
-
enableStrictOriginEnforcement?: boolean;
|
|
2224
|
+
enableStrictOriginEnforcement?: boolean | undefined;
|
|
2225
2225
|
/**
|
|
2226
2226
|
* <p>Playback-restriction-policy name. The value does not need to be unique.</p>
|
|
2227
2227
|
* @public
|
|
2228
2228
|
*/
|
|
2229
|
-
name?: string;
|
|
2229
|
+
name?: string | undefined;
|
|
2230
2230
|
}
|
|
2231
2231
|
/**
|
|
2232
2232
|
* @public
|
|
@@ -2236,7 +2236,7 @@ export interface UpdatePlaybackRestrictionPolicyResponse {
|
|
|
2236
2236
|
* <p>Object specifying the updated policy.</p>
|
|
2237
2237
|
* @public
|
|
2238
2238
|
*/
|
|
2239
|
-
playbackRestrictionPolicy?: PlaybackRestrictionPolicy;
|
|
2239
|
+
playbackRestrictionPolicy?: PlaybackRestrictionPolicy | undefined;
|
|
2240
2240
|
}
|
|
2241
2241
|
/**
|
|
2242
2242
|
* @internal
|