@aws-sdk/client-ivs-realtime 3.687.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 +210 -210
- package/dist-types/ts3.4/models/models_0.d.ts +218 -210
- 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
|
*/
|
|
@@ -28,7 +28,7 @@ export declare class ConflictException extends __BaseException {
|
|
|
28
28
|
* <p>Updating or deleting a resource can cause an inconsistent state.</p>
|
|
29
29
|
* @public
|
|
30
30
|
*/
|
|
31
|
-
exceptionMessage?: string;
|
|
31
|
+
exceptionMessage?: string | undefined;
|
|
32
32
|
/**
|
|
33
33
|
* @internal
|
|
34
34
|
*/
|
|
@@ -45,24 +45,24 @@ export interface Video {
|
|
|
45
45
|
* 1080x1920). Default: 1280.</p>
|
|
46
46
|
* @public
|
|
47
47
|
*/
|
|
48
|
-
width?: number;
|
|
48
|
+
width?: number | undefined;
|
|
49
49
|
/**
|
|
50
50
|
* <p>Video-resolution height. This must be an even number. Note that the maximum value is determined by <code>width</code>
|
|
51
51
|
* times <code>height</code>, such that the maximum total pixels is 2073600 (1920x1080 or
|
|
52
52
|
* 1080x1920). Default: 720.</p>
|
|
53
53
|
* @public
|
|
54
54
|
*/
|
|
55
|
-
height?: number;
|
|
55
|
+
height?: number | undefined;
|
|
56
56
|
/**
|
|
57
57
|
* <p>Video frame rate, in fps. Default: 30.</p>
|
|
58
58
|
* @public
|
|
59
59
|
*/
|
|
60
|
-
framerate?: number;
|
|
60
|
+
framerate?: number | undefined;
|
|
61
61
|
/**
|
|
62
62
|
* <p>Bitrate for generated output, in bps. Default: 2500000.</p>
|
|
63
63
|
* @public
|
|
64
64
|
*/
|
|
65
|
-
bitrate?: number;
|
|
65
|
+
bitrate?: number | undefined;
|
|
66
66
|
}
|
|
67
67
|
/**
|
|
68
68
|
* @public
|
|
@@ -72,13 +72,13 @@ export interface CreateEncoderConfigurationRequest {
|
|
|
72
72
|
* <p>Optional name to identify the resource.</p>
|
|
73
73
|
* @public
|
|
74
74
|
*/
|
|
75
|
-
name?: string;
|
|
75
|
+
name?: string | undefined;
|
|
76
76
|
/**
|
|
77
77
|
* <p>Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30
|
|
78
78
|
* fps.</p>
|
|
79
79
|
* @public
|
|
80
80
|
*/
|
|
81
|
-
video?: Video;
|
|
81
|
+
video?: Video | undefined;
|
|
82
82
|
/**
|
|
83
83
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
84
84
|
* (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>
|
|
@@ -87,7 +87,7 @@ export interface CreateEncoderConfigurationRequest {
|
|
|
87
87
|
* there.</p>
|
|
88
88
|
* @public
|
|
89
89
|
*/
|
|
90
|
-
tags?: Record<string, string
|
|
90
|
+
tags?: Record<string, string> | undefined;
|
|
91
91
|
}
|
|
92
92
|
/**
|
|
93
93
|
* <p>Settings for transcoding.</p>
|
|
@@ -103,13 +103,13 @@ export interface EncoderConfiguration {
|
|
|
103
103
|
* <p>Optional name to identify the resource.</p>
|
|
104
104
|
* @public
|
|
105
105
|
*/
|
|
106
|
-
name?: string;
|
|
106
|
+
name?: string | undefined;
|
|
107
107
|
/**
|
|
108
108
|
* <p>Video configuration. Default: video resolution 1280x720, bitrate 2500 kbps, 30
|
|
109
109
|
* fps</p>
|
|
110
110
|
* @public
|
|
111
111
|
*/
|
|
112
|
-
video?: Video;
|
|
112
|
+
video?: Video | undefined;
|
|
113
113
|
/**
|
|
114
114
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
115
115
|
* (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>
|
|
@@ -117,7 +117,7 @@ export interface EncoderConfiguration {
|
|
|
117
117
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
118
118
|
* @public
|
|
119
119
|
*/
|
|
120
|
-
tags?: Record<string, string
|
|
120
|
+
tags?: Record<string, string> | undefined;
|
|
121
121
|
}
|
|
122
122
|
/**
|
|
123
123
|
* @public
|
|
@@ -127,7 +127,7 @@ export interface CreateEncoderConfigurationResponse {
|
|
|
127
127
|
* <p>The EncoderConfiguration that was created.</p>
|
|
128
128
|
* @public
|
|
129
129
|
*/
|
|
130
|
-
encoderConfiguration?: EncoderConfiguration;
|
|
130
|
+
encoderConfiguration?: EncoderConfiguration | undefined;
|
|
131
131
|
}
|
|
132
132
|
/**
|
|
133
133
|
* <p/>
|
|
@@ -140,7 +140,7 @@ export declare class InternalServerException extends __BaseException {
|
|
|
140
140
|
* <p>Unexpected error during processing of request.</p>
|
|
141
141
|
* @public
|
|
142
142
|
*/
|
|
143
|
-
exceptionMessage?: string;
|
|
143
|
+
exceptionMessage?: string | undefined;
|
|
144
144
|
/**
|
|
145
145
|
* @internal
|
|
146
146
|
*/
|
|
@@ -157,7 +157,7 @@ export declare class PendingVerification extends __BaseException {
|
|
|
157
157
|
* <p> Your account is pending verification. </p>
|
|
158
158
|
* @public
|
|
159
159
|
*/
|
|
160
|
-
exceptionMessage?: string;
|
|
160
|
+
exceptionMessage?: string | undefined;
|
|
161
161
|
/**
|
|
162
162
|
* @internal
|
|
163
163
|
*/
|
|
@@ -174,7 +174,7 @@ export declare class ResourceNotFoundException extends __BaseException {
|
|
|
174
174
|
* <p>Request references a resource which does not exist.</p>
|
|
175
175
|
* @public
|
|
176
176
|
*/
|
|
177
|
-
exceptionMessage?: string;
|
|
177
|
+
exceptionMessage?: string | undefined;
|
|
178
178
|
/**
|
|
179
179
|
* @internal
|
|
180
180
|
*/
|
|
@@ -191,7 +191,7 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
191
191
|
* <p>Request would cause a service quota to be exceeded.</p>
|
|
192
192
|
* @public
|
|
193
193
|
*/
|
|
194
|
-
exceptionMessage?: string;
|
|
194
|
+
exceptionMessage?: string | undefined;
|
|
195
195
|
/**
|
|
196
196
|
* @internal
|
|
197
197
|
*/
|
|
@@ -208,7 +208,7 @@ export declare class ValidationException extends __BaseException {
|
|
|
208
208
|
* <p>The input fails to satisfy the constraints specified by an Amazon Web Services service.</p>
|
|
209
209
|
* @public
|
|
210
210
|
*/
|
|
211
|
-
exceptionMessage?: string;
|
|
211
|
+
exceptionMessage?: string | undefined;
|
|
212
212
|
/**
|
|
213
213
|
* @internal
|
|
214
214
|
*/
|
|
@@ -234,26 +234,26 @@ export interface CreateIngestConfigurationRequest {
|
|
|
234
234
|
* <p>Optional name that can be specified for the IngestConfiguration being created.</p>
|
|
235
235
|
* @public
|
|
236
236
|
*/
|
|
237
|
-
name?: string;
|
|
237
|
+
name?: string | undefined;
|
|
238
238
|
/**
|
|
239
239
|
* <p>ARN of the stage with which the IngestConfiguration is associated.</p>
|
|
240
240
|
* @public
|
|
241
241
|
*/
|
|
242
|
-
stageArn?: string;
|
|
242
|
+
stageArn?: string | undefined;
|
|
243
243
|
/**
|
|
244
244
|
* <p>Customer-assigned name to help identify the participant using the IngestConfiguration; this can be used to link a participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
|
|
245
245
|
* <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
|
|
246
246
|
* </p>
|
|
247
247
|
* @public
|
|
248
248
|
*/
|
|
249
|
-
userId?: string;
|
|
249
|
+
userId?: string | undefined;
|
|
250
250
|
/**
|
|
251
251
|
* <p>Application-provided attributes to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
|
|
252
252
|
* <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
|
|
253
253
|
* </p>
|
|
254
254
|
* @public
|
|
255
255
|
*/
|
|
256
|
-
attributes?: Record<string, string
|
|
256
|
+
attributes?: Record<string, string> | undefined;
|
|
257
257
|
/**
|
|
258
258
|
* <p>Type of ingest protocol that the user employs to broadcast. If this is set to <code>RTMP</code>, <code>insecureIngest</code> must be set to <code>true</code>.</p>
|
|
259
259
|
* @public
|
|
@@ -263,7 +263,7 @@ export interface CreateIngestConfigurationRequest {
|
|
|
263
263
|
* <p>Whether the stage allows insecure RTMP ingest. This must be set to <code>true</code>, if <code>ingestProtocol</code> is set to <code>RTMP</code>. Default: <code>false</code>. </p>
|
|
264
264
|
* @public
|
|
265
265
|
*/
|
|
266
|
-
insecureIngest?: boolean;
|
|
266
|
+
insecureIngest?: boolean | undefined;
|
|
267
267
|
/**
|
|
268
268
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
269
269
|
* (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>
|
|
@@ -272,7 +272,7 @@ export interface CreateIngestConfigurationRequest {
|
|
|
272
272
|
* there.</p>
|
|
273
273
|
* @public
|
|
274
274
|
*/
|
|
275
|
-
tags?: Record<string, string
|
|
275
|
+
tags?: Record<string, string> | undefined;
|
|
276
276
|
}
|
|
277
277
|
/**
|
|
278
278
|
* @public
|
|
@@ -295,7 +295,7 @@ export interface IngestConfiguration {
|
|
|
295
295
|
* <p>Ingest name</p>
|
|
296
296
|
* @public
|
|
297
297
|
*/
|
|
298
|
-
name?: string;
|
|
298
|
+
name?: string | undefined;
|
|
299
299
|
/**
|
|
300
300
|
* <p>Ingest configuration ARN.</p>
|
|
301
301
|
* @public
|
|
@@ -332,14 +332,14 @@ export interface IngestConfiguration {
|
|
|
332
332
|
* </p>
|
|
333
333
|
* @public
|
|
334
334
|
*/
|
|
335
|
-
userId?: string;
|
|
335
|
+
userId?: string | undefined;
|
|
336
336
|
/**
|
|
337
337
|
* <p>Application-provided attributes to to store in the IngestConfiguration and attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
|
|
338
338
|
* <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
|
|
339
339
|
* </p>
|
|
340
340
|
* @public
|
|
341
341
|
*/
|
|
342
|
-
attributes?: Record<string, string
|
|
342
|
+
attributes?: Record<string, string> | undefined;
|
|
343
343
|
/**
|
|
344
344
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
345
345
|
* (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>
|
|
@@ -347,7 +347,7 @@ export interface IngestConfiguration {
|
|
|
347
347
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
348
348
|
* @public
|
|
349
349
|
*/
|
|
350
|
-
tags?: Record<string, string
|
|
350
|
+
tags?: Record<string, string> | undefined;
|
|
351
351
|
}
|
|
352
352
|
/**
|
|
353
353
|
* @public
|
|
@@ -357,7 +357,7 @@ export interface CreateIngestConfigurationResponse {
|
|
|
357
357
|
* <p>The IngestConfiguration that was created.</p>
|
|
358
358
|
* @public
|
|
359
359
|
*/
|
|
360
|
-
ingestConfiguration?: IngestConfiguration;
|
|
360
|
+
ingestConfiguration?: IngestConfiguration | undefined;
|
|
361
361
|
}
|
|
362
362
|
/**
|
|
363
363
|
* @public
|
|
@@ -384,7 +384,7 @@ export interface CreateParticipantTokenRequest {
|
|
|
384
384
|
* <p>Duration (in minutes), after which the token expires. Default: 720 (12 hours).</p>
|
|
385
385
|
* @public
|
|
386
386
|
*/
|
|
387
|
-
duration?: number;
|
|
387
|
+
duration?: number | undefined;
|
|
388
388
|
/**
|
|
389
389
|
* <p>Name that can be specified to help identify the token. This can be any UTF-8 encoded
|
|
390
390
|
* text. <i>This field is exposed to all stage participants and should not be used for
|
|
@@ -392,7 +392,7 @@ export interface CreateParticipantTokenRequest {
|
|
|
392
392
|
* </p>
|
|
393
393
|
* @public
|
|
394
394
|
*/
|
|
395
|
-
userId?: string;
|
|
395
|
+
userId?: string | undefined;
|
|
396
396
|
/**
|
|
397
397
|
* <p>Application-provided attributes to encode into the token and attach to a stage. Map keys
|
|
398
398
|
* and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
|
|
@@ -401,13 +401,13 @@ export interface CreateParticipantTokenRequest {
|
|
|
401
401
|
* </p>
|
|
402
402
|
* @public
|
|
403
403
|
*/
|
|
404
|
-
attributes?: Record<string, string
|
|
404
|
+
attributes?: Record<string, string> | undefined;
|
|
405
405
|
/**
|
|
406
406
|
* <p>Set of capabilities that the user is allowed to perform in the stage. Default:
|
|
407
407
|
* <code>PUBLISH, SUBSCRIBE</code>.</p>
|
|
408
408
|
* @public
|
|
409
409
|
*/
|
|
410
|
-
capabilities?: ParticipantTokenCapability[];
|
|
410
|
+
capabilities?: ParticipantTokenCapability[] | undefined;
|
|
411
411
|
}
|
|
412
412
|
/**
|
|
413
413
|
* <p>Object specifying a participant token in a stage.</p>
|
|
@@ -421,12 +421,12 @@ export interface ParticipantToken {
|
|
|
421
421
|
* <p>Unique identifier for this participant token, assigned by IVS.</p>
|
|
422
422
|
* @public
|
|
423
423
|
*/
|
|
424
|
-
participantId?: string;
|
|
424
|
+
participantId?: string | undefined;
|
|
425
425
|
/**
|
|
426
426
|
* <p>The issued client token, encrypted.</p>
|
|
427
427
|
* @public
|
|
428
428
|
*/
|
|
429
|
-
token?: string;
|
|
429
|
+
token?: string | undefined;
|
|
430
430
|
/**
|
|
431
431
|
* <p>Customer-assigned name to help identify the token; this can be used to link a
|
|
432
432
|
* participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
|
|
@@ -435,7 +435,7 @@ export interface ParticipantToken {
|
|
|
435
435
|
* </p>
|
|
436
436
|
* @public
|
|
437
437
|
*/
|
|
438
|
-
userId?: string;
|
|
438
|
+
userId?: string | undefined;
|
|
439
439
|
/**
|
|
440
440
|
* <p>Application-provided attributes to encode into the token and attach to a stage.
|
|
441
441
|
* <i>This field is exposed to all stage participants and should not be used for
|
|
@@ -443,23 +443,23 @@ export interface ParticipantToken {
|
|
|
443
443
|
* </p>
|
|
444
444
|
* @public
|
|
445
445
|
*/
|
|
446
|
-
attributes?: Record<string, string
|
|
446
|
+
attributes?: Record<string, string> | undefined;
|
|
447
447
|
/**
|
|
448
448
|
* <p>Duration (in minutes), after which the participant token expires. Default: 720 (12
|
|
449
449
|
* hours).</p>
|
|
450
450
|
* @public
|
|
451
451
|
*/
|
|
452
|
-
duration?: number;
|
|
452
|
+
duration?: number | undefined;
|
|
453
453
|
/**
|
|
454
454
|
* <p>Set of capabilities that the user is allowed to perform in the stage.</p>
|
|
455
455
|
* @public
|
|
456
456
|
*/
|
|
457
|
-
capabilities?: ParticipantTokenCapability[];
|
|
457
|
+
capabilities?: ParticipantTokenCapability[] | undefined;
|
|
458
458
|
/**
|
|
459
459
|
* <p>ISO 8601 timestamp (returned as a string) for when this token expires.</p>
|
|
460
460
|
* @public
|
|
461
461
|
*/
|
|
462
|
-
expirationTime?: Date;
|
|
462
|
+
expirationTime?: Date | undefined;
|
|
463
463
|
}
|
|
464
464
|
/**
|
|
465
465
|
* @public
|
|
@@ -469,7 +469,7 @@ export interface CreateParticipantTokenResponse {
|
|
|
469
469
|
* <p>The participant token that was created.</p>
|
|
470
470
|
* @public
|
|
471
471
|
*/
|
|
472
|
-
participantToken?: ParticipantToken;
|
|
472
|
+
participantToken?: ParticipantToken | undefined;
|
|
473
473
|
}
|
|
474
474
|
/**
|
|
475
475
|
* @public
|
|
@@ -497,7 +497,7 @@ export interface AutoParticipantRecordingConfiguration {
|
|
|
497
497
|
* <p>Types of media to be recorded. Default: <code>AUDIO_VIDEO</code>.</p>
|
|
498
498
|
* @public
|
|
499
499
|
*/
|
|
500
|
-
mediaTypes?: ParticipantRecordingMediaType[];
|
|
500
|
+
mediaTypes?: ParticipantRecordingMediaType[] | undefined;
|
|
501
501
|
}
|
|
502
502
|
/**
|
|
503
503
|
* <p>Object specifying a participant token configuration in a stage.</p>
|
|
@@ -509,7 +509,7 @@ export interface ParticipantTokenConfiguration {
|
|
|
509
509
|
* 720 (12 hours).</p>
|
|
510
510
|
* @public
|
|
511
511
|
*/
|
|
512
|
-
duration?: number;
|
|
512
|
+
duration?: number | undefined;
|
|
513
513
|
/**
|
|
514
514
|
* <p>Customer-assigned name to help identify the token; this can be used to link a
|
|
515
515
|
* participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
|
|
@@ -518,7 +518,7 @@ export interface ParticipantTokenConfiguration {
|
|
|
518
518
|
* </p>
|
|
519
519
|
* @public
|
|
520
520
|
*/
|
|
521
|
-
userId?: string;
|
|
521
|
+
userId?: string | undefined;
|
|
522
522
|
/**
|
|
523
523
|
* <p>Application-provided attributes to encode into the corresponding participant token and
|
|
524
524
|
* attach to a stage. Map keys and values can contain UTF-8 encoded text. The maximum length
|
|
@@ -528,12 +528,12 @@ export interface ParticipantTokenConfiguration {
|
|
|
528
528
|
* </p>
|
|
529
529
|
* @public
|
|
530
530
|
*/
|
|
531
|
-
attributes?: Record<string, string
|
|
531
|
+
attributes?: Record<string, string> | undefined;
|
|
532
532
|
/**
|
|
533
533
|
* <p>Set of capabilities that the user is allowed to perform in the stage.</p>
|
|
534
534
|
* @public
|
|
535
535
|
*/
|
|
536
|
-
capabilities?: ParticipantTokenCapability[];
|
|
536
|
+
capabilities?: ParticipantTokenCapability[] | undefined;
|
|
537
537
|
}
|
|
538
538
|
/**
|
|
539
539
|
* @public
|
|
@@ -543,12 +543,12 @@ export interface CreateStageRequest {
|
|
|
543
543
|
* <p>Optional name that can be specified for the stage being created.</p>
|
|
544
544
|
* @public
|
|
545
545
|
*/
|
|
546
|
-
name?: string;
|
|
546
|
+
name?: string | undefined;
|
|
547
547
|
/**
|
|
548
548
|
* <p>Array of participant token configuration objects to attach to the new stage.</p>
|
|
549
549
|
* @public
|
|
550
550
|
*/
|
|
551
|
-
participantTokenConfigurations?: ParticipantTokenConfiguration[];
|
|
551
|
+
participantTokenConfigurations?: ParticipantTokenConfiguration[] | undefined;
|
|
552
552
|
/**
|
|
553
553
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
554
554
|
* (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>
|
|
@@ -557,12 +557,12 @@ export interface CreateStageRequest {
|
|
|
557
557
|
* there. </p>
|
|
558
558
|
* @public
|
|
559
559
|
*/
|
|
560
|
-
tags?: Record<string, string
|
|
560
|
+
tags?: Record<string, string> | undefined;
|
|
561
561
|
/**
|
|
562
562
|
* <p>Configuration object for individual participant recording, to attach to the new stage.</p>
|
|
563
563
|
* @public
|
|
564
564
|
*/
|
|
565
|
-
autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
|
|
565
|
+
autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration | undefined;
|
|
566
566
|
}
|
|
567
567
|
/**
|
|
568
568
|
* <p>Summary information about various endpoints for a stage. We recommend that you cache these values at stage
|
|
@@ -574,22 +574,22 @@ export interface StageEndpoints {
|
|
|
574
574
|
* <p>Events endpoint.</p>
|
|
575
575
|
* @public
|
|
576
576
|
*/
|
|
577
|
-
events?: string;
|
|
577
|
+
events?: string | undefined;
|
|
578
578
|
/**
|
|
579
579
|
* <p>The endpoint to be used for IVS real-time streaming using the WHIP protocol.</p>
|
|
580
580
|
* @public
|
|
581
581
|
*/
|
|
582
|
-
whip?: string;
|
|
582
|
+
whip?: string | undefined;
|
|
583
583
|
/**
|
|
584
584
|
* <p>The endpoint to be used for IVS real-time streaming using the RTMP protocol.</p>
|
|
585
585
|
* @public
|
|
586
586
|
*/
|
|
587
|
-
rtmp?: string;
|
|
587
|
+
rtmp?: string | undefined;
|
|
588
588
|
/**
|
|
589
589
|
* <p>The endpoint to be used for IVS real-time streaming using the RTMPS protocol.</p>
|
|
590
590
|
* @public
|
|
591
591
|
*/
|
|
592
|
-
rtmps?: string;
|
|
592
|
+
rtmps?: string | undefined;
|
|
593
593
|
}
|
|
594
594
|
/**
|
|
595
595
|
* <p>Object specifying a stage.</p>
|
|
@@ -605,12 +605,12 @@ export interface Stage {
|
|
|
605
605
|
* <p>Stage name.</p>
|
|
606
606
|
* @public
|
|
607
607
|
*/
|
|
608
|
-
name?: string;
|
|
608
|
+
name?: string | undefined;
|
|
609
609
|
/**
|
|
610
610
|
* <p>ID of the active session within the stage.</p>
|
|
611
611
|
* @public
|
|
612
612
|
*/
|
|
613
|
-
activeSessionId?: string;
|
|
613
|
+
activeSessionId?: string | undefined;
|
|
614
614
|
/**
|
|
615
615
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
616
616
|
* (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>
|
|
@@ -618,17 +618,17 @@ export interface Stage {
|
|
|
618
618
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
619
619
|
* @public
|
|
620
620
|
*/
|
|
621
|
-
tags?: Record<string, string
|
|
621
|
+
tags?: Record<string, string> | undefined;
|
|
622
622
|
/**
|
|
623
623
|
* <p>Configuration object for individual participant recording, attached to the stage.</p>
|
|
624
624
|
* @public
|
|
625
625
|
*/
|
|
626
|
-
autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
|
|
626
|
+
autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration | undefined;
|
|
627
627
|
/**
|
|
628
628
|
* <p>Summary information about various endpoints for a stage.</p>
|
|
629
629
|
* @public
|
|
630
630
|
*/
|
|
631
|
-
endpoints?: StageEndpoints;
|
|
631
|
+
endpoints?: StageEndpoints | undefined;
|
|
632
632
|
}
|
|
633
633
|
/**
|
|
634
634
|
* @public
|
|
@@ -638,13 +638,13 @@ export interface CreateStageResponse {
|
|
|
638
638
|
* <p>The stage that was created.</p>
|
|
639
639
|
* @public
|
|
640
640
|
*/
|
|
641
|
-
stage?: Stage;
|
|
641
|
+
stage?: Stage | undefined;
|
|
642
642
|
/**
|
|
643
643
|
* <p>Participant tokens attached to the stage. These correspond to the
|
|
644
644
|
* <code>participants</code> in the request.</p>
|
|
645
645
|
* @public
|
|
646
646
|
*/
|
|
647
|
-
participantTokens?: ParticipantToken[];
|
|
647
|
+
participantTokens?: ParticipantToken[] | undefined;
|
|
648
648
|
}
|
|
649
649
|
/**
|
|
650
650
|
* <p>A complex type that describes an S3 location where recorded videos will be stored.</p>
|
|
@@ -666,7 +666,7 @@ export interface CreateStorageConfigurationRequest {
|
|
|
666
666
|
* <p>Storage configuration name. The value does not need to be unique.</p>
|
|
667
667
|
* @public
|
|
668
668
|
*/
|
|
669
|
-
name?: string;
|
|
669
|
+
name?: string | undefined;
|
|
670
670
|
/**
|
|
671
671
|
* <p>A complex type that contains a storage configuration for where recorded video will be stored.</p>
|
|
672
672
|
* @public
|
|
@@ -680,7 +680,7 @@ export interface CreateStorageConfigurationRequest {
|
|
|
680
680
|
* there.</p>
|
|
681
681
|
* @public
|
|
682
682
|
*/
|
|
683
|
-
tags?: Record<string, string
|
|
683
|
+
tags?: Record<string, string> | undefined;
|
|
684
684
|
}
|
|
685
685
|
/**
|
|
686
686
|
* <p>A complex type that describes a location where recorded videos will be stored.</p>
|
|
@@ -696,12 +696,12 @@ export interface StorageConfiguration {
|
|
|
696
696
|
* <p>Name of the storage configuration.</p>
|
|
697
697
|
* @public
|
|
698
698
|
*/
|
|
699
|
-
name?: string;
|
|
699
|
+
name?: string | undefined;
|
|
700
700
|
/**
|
|
701
701
|
* <p>An S3 destination configuration where recorded videos will be stored.</p>
|
|
702
702
|
* @public
|
|
703
703
|
*/
|
|
704
|
-
s3?: S3StorageConfiguration;
|
|
704
|
+
s3?: S3StorageConfiguration | undefined;
|
|
705
705
|
/**
|
|
706
706
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
707
707
|
* (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>
|
|
@@ -709,7 +709,7 @@ export interface StorageConfiguration {
|
|
|
709
709
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
710
710
|
* @public
|
|
711
711
|
*/
|
|
712
|
-
tags?: Record<string, string
|
|
712
|
+
tags?: Record<string, string> | undefined;
|
|
713
713
|
}
|
|
714
714
|
/**
|
|
715
715
|
* @public
|
|
@@ -719,7 +719,7 @@ export interface CreateStorageConfigurationResponse {
|
|
|
719
719
|
* <p>The StorageConfiguration that was created.</p>
|
|
720
720
|
* @public
|
|
721
721
|
*/
|
|
722
|
-
storageConfiguration?: StorageConfiguration;
|
|
722
|
+
storageConfiguration?: StorageConfiguration | undefined;
|
|
723
723
|
}
|
|
724
724
|
/**
|
|
725
725
|
* @public
|
|
@@ -749,7 +749,7 @@ export interface DeleteIngestConfigurationRequest {
|
|
|
749
749
|
* <p>Optional field to force deletion of the IngestConfiguration. If this is set to <code>true</code> when a participant is actively publishing, the participant is disconnected from the stage, followed by deletion of the IngestConfiguration. Default: <code>false</code>.</p>
|
|
750
750
|
* @public
|
|
751
751
|
*/
|
|
752
|
-
force?: boolean;
|
|
752
|
+
force?: boolean | undefined;
|
|
753
753
|
}
|
|
754
754
|
/**
|
|
755
755
|
* @public
|
|
@@ -821,7 +821,7 @@ export interface DisconnectParticipantRequest {
|
|
|
821
821
|
* <p>Description of why this participant is being disconnected.</p>
|
|
822
822
|
* @public
|
|
823
823
|
*/
|
|
824
|
-
reason?: string;
|
|
824
|
+
reason?: string | undefined;
|
|
825
825
|
}
|
|
826
826
|
/**
|
|
827
827
|
* @public
|
|
@@ -854,7 +854,7 @@ export interface ChannelDestinationConfiguration {
|
|
|
854
854
|
* and stage resources must be in the same AWS account and region.</p>
|
|
855
855
|
* @public
|
|
856
856
|
*/
|
|
857
|
-
encoderConfigurationArn?: string;
|
|
857
|
+
encoderConfigurationArn?: string | undefined;
|
|
858
858
|
}
|
|
859
859
|
/**
|
|
860
860
|
* @public
|
|
@@ -876,7 +876,7 @@ export interface RecordingConfiguration {
|
|
|
876
876
|
* <p>The recording format for storing a recording in Amazon S3.</p>
|
|
877
877
|
* @public
|
|
878
878
|
*/
|
|
879
|
-
format?: RecordingConfigurationFormat;
|
|
879
|
+
format?: RecordingConfigurationFormat | undefined;
|
|
880
880
|
}
|
|
881
881
|
/**
|
|
882
882
|
* <p>A complex type that describes an S3 location where recorded videos will be stored.</p>
|
|
@@ -900,7 +900,7 @@ export interface S3DestinationConfiguration {
|
|
|
900
900
|
* the recording format for storing a recording in Amazon S3.</p>
|
|
901
901
|
* @public
|
|
902
902
|
*/
|
|
903
|
-
recordingConfiguration?: RecordingConfiguration;
|
|
903
|
+
recordingConfiguration?: RecordingConfiguration | undefined;
|
|
904
904
|
}
|
|
905
905
|
/**
|
|
906
906
|
* <p>Complex data type that defines destination-configuration objects.</p>
|
|
@@ -911,19 +911,19 @@ export interface DestinationConfiguration {
|
|
|
911
911
|
* <p>Name that can be specified to help identify the destination.</p>
|
|
912
912
|
* @public
|
|
913
913
|
*/
|
|
914
|
-
name?: string;
|
|
914
|
+
name?: string | undefined;
|
|
915
915
|
/**
|
|
916
916
|
* <p>An IVS channel to be used for broadcasting, for server-side composition. Either a <code>channel</code> or an
|
|
917
917
|
* <code>s3</code> must be specified. </p>
|
|
918
918
|
* @public
|
|
919
919
|
*/
|
|
920
|
-
channel?: ChannelDestinationConfiguration;
|
|
920
|
+
channel?: ChannelDestinationConfiguration | undefined;
|
|
921
921
|
/**
|
|
922
922
|
* <p>An S3 storage configuration to be used for recording video data. Either a <code>channel</code>
|
|
923
923
|
* or an <code>s3</code> must be specified.</p>
|
|
924
924
|
* @public
|
|
925
925
|
*/
|
|
926
|
-
s3?: S3DestinationConfiguration;
|
|
926
|
+
s3?: S3DestinationConfiguration | undefined;
|
|
927
927
|
}
|
|
928
928
|
/**
|
|
929
929
|
* <p>Complex data type that defines S3Detail objects.</p>
|
|
@@ -945,7 +945,7 @@ export interface DestinationDetail {
|
|
|
945
945
|
* <p>An S3 detail object to return information about the S3 destination.</p>
|
|
946
946
|
* @public
|
|
947
947
|
*/
|
|
948
|
-
s3?: S3Detail;
|
|
948
|
+
s3?: S3Detail | undefined;
|
|
949
949
|
}
|
|
950
950
|
/**
|
|
951
951
|
* @public
|
|
@@ -983,13 +983,13 @@ export interface Destination {
|
|
|
983
983
|
* this is returned as a string</i>.</p>
|
|
984
984
|
* @public
|
|
985
985
|
*/
|
|
986
|
-
startTime?: Date;
|
|
986
|
+
startTime?: Date | undefined;
|
|
987
987
|
/**
|
|
988
988
|
* <p>UTC time of the destination end. This is an ISO 8601 timestamp; <i>note that this
|
|
989
989
|
* is returned as a string</i>.</p>
|
|
990
990
|
* @public
|
|
991
991
|
*/
|
|
992
|
-
endTime?: Date;
|
|
992
|
+
endTime?: Date | undefined;
|
|
993
993
|
/**
|
|
994
994
|
* <p>Configuration used to create this destination.</p>
|
|
995
995
|
* @public
|
|
@@ -999,7 +999,7 @@ export interface Destination {
|
|
|
999
999
|
* <p>Optional details regarding the status of the destination.</p>
|
|
1000
1000
|
* @public
|
|
1001
1001
|
*/
|
|
1002
|
-
detail?: DestinationDetail;
|
|
1002
|
+
detail?: DestinationDetail | undefined;
|
|
1003
1003
|
}
|
|
1004
1004
|
/**
|
|
1005
1005
|
* @public
|
|
@@ -1041,17 +1041,17 @@ export interface GridConfiguration {
|
|
|
1041
1041
|
* slot. Default: <code>""</code> (no featured participant).</p>
|
|
1042
1042
|
* @public
|
|
1043
1043
|
*/
|
|
1044
|
-
featuredParticipantAttribute?: string;
|
|
1044
|
+
featuredParticipantAttribute?: string | undefined;
|
|
1045
1045
|
/**
|
|
1046
1046
|
* <p>Determines whether to omit participants with stopped video in the composition. Default: <code>false</code>.</p>
|
|
1047
1047
|
* @public
|
|
1048
1048
|
*/
|
|
1049
|
-
omitStoppedVideo?: boolean;
|
|
1049
|
+
omitStoppedVideo?: boolean | undefined;
|
|
1050
1050
|
/**
|
|
1051
1051
|
* <p>Sets the non-featured participant display mode, to control the aspect ratio of video tiles. <code>VIDEO</code> is 16:9, <code>SQUARE</code> is 1:1, and <code>PORTRAIT</code> is 3:4. Default: <code>VIDEO</code>.</p>
|
|
1052
1052
|
* @public
|
|
1053
1053
|
*/
|
|
1054
|
-
videoAspectRatio?: VideoAspectRatio;
|
|
1054
|
+
videoAspectRatio?: VideoAspectRatio | undefined;
|
|
1055
1055
|
/**
|
|
1056
1056
|
* <p>Defines how video content fits within the participant tile: <code>FILL</code> (stretched), <code>COVER</code> (cropped),
|
|
1057
1057
|
* or <code>CONTAIN</code> (letterboxed). When not set,
|
|
@@ -1059,12 +1059,12 @@ export interface GridConfiguration {
|
|
|
1059
1059
|
* and to <code>CONTAIN</code> fill mode for featured participants.</p>
|
|
1060
1060
|
* @public
|
|
1061
1061
|
*/
|
|
1062
|
-
videoFillMode?: VideoFillMode;
|
|
1062
|
+
videoFillMode?: VideoFillMode | undefined;
|
|
1063
1063
|
/**
|
|
1064
1064
|
* <p>Specifies the spacing between participant tiles in pixels. Default: <code>2</code>.</p>
|
|
1065
1065
|
* @public
|
|
1066
1066
|
*/
|
|
1067
|
-
gridGap?: number;
|
|
1067
|
+
gridGap?: number | undefined;
|
|
1068
1068
|
}
|
|
1069
1069
|
/**
|
|
1070
1070
|
* @public
|
|
@@ -1105,60 +1105,60 @@ export interface PipConfiguration {
|
|
|
1105
1105
|
* slot. Default: <code>""</code> (no featured participant).</p>
|
|
1106
1106
|
* @public
|
|
1107
1107
|
*/
|
|
1108
|
-
featuredParticipantAttribute?: string;
|
|
1108
|
+
featuredParticipantAttribute?: string | undefined;
|
|
1109
1109
|
/**
|
|
1110
1110
|
* <p>Determines whether to omit participants with stopped video in the composition. Default: <code>false</code>.</p>
|
|
1111
1111
|
* @public
|
|
1112
1112
|
*/
|
|
1113
|
-
omitStoppedVideo?: boolean;
|
|
1113
|
+
omitStoppedVideo?: boolean | undefined;
|
|
1114
1114
|
/**
|
|
1115
1115
|
* <p>Defines how video content fits within the participant tile: <code>FILL</code> (stretched),
|
|
1116
1116
|
* <code>COVER</code> (cropped), or <code>CONTAIN</code> (letterboxed). Default: <code>COVER</code>.</p>
|
|
1117
1117
|
* @public
|
|
1118
1118
|
*/
|
|
1119
|
-
videoFillMode?: VideoFillMode;
|
|
1119
|
+
videoFillMode?: VideoFillMode | undefined;
|
|
1120
1120
|
/**
|
|
1121
1121
|
* <p>Specifies the spacing between participant tiles in pixels. Default: <code>0</code>.</p>
|
|
1122
1122
|
* @public
|
|
1123
1123
|
*/
|
|
1124
|
-
gridGap?: number;
|
|
1124
|
+
gridGap?: number | undefined;
|
|
1125
1125
|
/**
|
|
1126
1126
|
* <p>Specifies the participant for the PiP window. A participant with this attribute set
|
|
1127
1127
|
* to <code>"true"</code> (as a string value) in <a>ParticipantTokenConfiguration</a>
|
|
1128
1128
|
* is placed in the PiP slot. Default: <code>""</code> (no PiP participant).</p>
|
|
1129
1129
|
* @public
|
|
1130
1130
|
*/
|
|
1131
|
-
pipParticipantAttribute?: string;
|
|
1131
|
+
pipParticipantAttribute?: string | undefined;
|
|
1132
1132
|
/**
|
|
1133
1133
|
* <p>Defines PiP behavior when all participants have left: <code>STATIC</code> (maintains original position/size) or <code>DYNAMIC</code> (expands to full composition). Default: <code>STATIC</code>.</p>
|
|
1134
1134
|
* @public
|
|
1135
1135
|
*/
|
|
1136
|
-
pipBehavior?: PipBehavior;
|
|
1136
|
+
pipBehavior?: PipBehavior | undefined;
|
|
1137
1137
|
/**
|
|
1138
1138
|
* <p>Sets the PiP window’s offset position in pixels from the closest edges determined by <code>PipPosition</code>.
|
|
1139
1139
|
* Default: <code>0</code>.</p>
|
|
1140
1140
|
* @public
|
|
1141
1141
|
*/
|
|
1142
|
-
pipOffset?: number;
|
|
1142
|
+
pipOffset?: number | undefined;
|
|
1143
1143
|
/**
|
|
1144
1144
|
* <p>Determines the corner position of the PiP window. Default: <code>BOTTOM_RIGHT</code>.</p>
|
|
1145
1145
|
* @public
|
|
1146
1146
|
*/
|
|
1147
|
-
pipPosition?: PipPosition;
|
|
1147
|
+
pipPosition?: PipPosition | undefined;
|
|
1148
1148
|
/**
|
|
1149
1149
|
* <p>Specifies the width of the PiP window in pixels. When this is not set explicitly,
|
|
1150
1150
|
* <code>pipWidth</code>’s value will be based on the size of the composition and the
|
|
1151
1151
|
* aspect ratio of the participant’s video.</p>
|
|
1152
1152
|
* @public
|
|
1153
1153
|
*/
|
|
1154
|
-
pipWidth?: number;
|
|
1154
|
+
pipWidth?: number | undefined;
|
|
1155
1155
|
/**
|
|
1156
1156
|
* <p>Specifies the height of the PiP window in pixels. When this is not set explicitly,
|
|
1157
1157
|
* <code>pipHeight</code>’s value will be based on the size of the composition and the
|
|
1158
1158
|
* aspect ratio of the participant’s video.</p>
|
|
1159
1159
|
* @public
|
|
1160
1160
|
*/
|
|
1161
|
-
pipHeight?: number;
|
|
1161
|
+
pipHeight?: number | undefined;
|
|
1162
1162
|
}
|
|
1163
1163
|
/**
|
|
1164
1164
|
* <p>Configuration information of supported layouts for server-side composition.</p>
|
|
@@ -1169,12 +1169,12 @@ export interface LayoutConfiguration {
|
|
|
1169
1169
|
* <p>Configuration related to grid layout. Default: Grid layout.</p>
|
|
1170
1170
|
* @public
|
|
1171
1171
|
*/
|
|
1172
|
-
grid?: GridConfiguration;
|
|
1172
|
+
grid?: GridConfiguration | undefined;
|
|
1173
1173
|
/**
|
|
1174
1174
|
* <p>Configuration related to PiP layout.</p>
|
|
1175
1175
|
* @public
|
|
1176
1176
|
*/
|
|
1177
|
-
pip?: PipConfiguration;
|
|
1177
|
+
pip?: PipConfiguration | undefined;
|
|
1178
1178
|
}
|
|
1179
1179
|
/**
|
|
1180
1180
|
* @public
|
|
@@ -1229,19 +1229,19 @@ export interface Composition {
|
|
|
1229
1229
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
1230
1230
|
* @public
|
|
1231
1231
|
*/
|
|
1232
|
-
tags?: Record<string, string
|
|
1232
|
+
tags?: Record<string, string> | undefined;
|
|
1233
1233
|
/**
|
|
1234
1234
|
* <p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that
|
|
1235
1235
|
* this is returned as a string</i>.</p>
|
|
1236
1236
|
* @public
|
|
1237
1237
|
*/
|
|
1238
|
-
startTime?: Date;
|
|
1238
|
+
startTime?: Date | undefined;
|
|
1239
1239
|
/**
|
|
1240
1240
|
* <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that
|
|
1241
1241
|
* this is returned as a string</i>.</p>
|
|
1242
1242
|
* @public
|
|
1243
1243
|
*/
|
|
1244
|
-
endTime?: Date;
|
|
1244
|
+
endTime?: Date | undefined;
|
|
1245
1245
|
}
|
|
1246
1246
|
/**
|
|
1247
1247
|
* @public
|
|
@@ -1251,7 +1251,7 @@ export interface GetCompositionResponse {
|
|
|
1251
1251
|
* <p>The Composition that was returned.</p>
|
|
1252
1252
|
* @public
|
|
1253
1253
|
*/
|
|
1254
|
-
composition?: Composition;
|
|
1254
|
+
composition?: Composition | undefined;
|
|
1255
1255
|
}
|
|
1256
1256
|
/**
|
|
1257
1257
|
* @public
|
|
@@ -1271,7 +1271,7 @@ export interface GetEncoderConfigurationResponse {
|
|
|
1271
1271
|
* <p>The EncoderConfiguration that was returned.</p>
|
|
1272
1272
|
* @public
|
|
1273
1273
|
*/
|
|
1274
|
-
encoderConfiguration?: EncoderConfiguration;
|
|
1274
|
+
encoderConfiguration?: EncoderConfiguration | undefined;
|
|
1275
1275
|
}
|
|
1276
1276
|
/**
|
|
1277
1277
|
* @public
|
|
@@ -1291,7 +1291,7 @@ export interface GetIngestConfigurationResponse {
|
|
|
1291
1291
|
* <p>The IngestConfiguration that was returned.</p>
|
|
1292
1292
|
* @public
|
|
1293
1293
|
*/
|
|
1294
|
-
ingestConfiguration?: IngestConfiguration;
|
|
1294
|
+
ingestConfiguration?: IngestConfiguration | undefined;
|
|
1295
1295
|
}
|
|
1296
1296
|
/**
|
|
1297
1297
|
* @public
|
|
@@ -1364,7 +1364,7 @@ export interface Participant {
|
|
|
1364
1364
|
* <p>Unique identifier for this participant, assigned by IVS.</p>
|
|
1365
1365
|
* @public
|
|
1366
1366
|
*/
|
|
1367
|
-
participantId?: string;
|
|
1367
|
+
participantId?: string | undefined;
|
|
1368
1368
|
/**
|
|
1369
1369
|
* <p>Customer-assigned name to help identify the token; this can be used to link a
|
|
1370
1370
|
* participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
|
|
@@ -1372,18 +1372,18 @@ export interface Participant {
|
|
|
1372
1372
|
* personally identifying, confidential, or sensitive information</i>.</p>
|
|
1373
1373
|
* @public
|
|
1374
1374
|
*/
|
|
1375
|
-
userId?: string;
|
|
1375
|
+
userId?: string | undefined;
|
|
1376
1376
|
/**
|
|
1377
1377
|
* <p>Whether the participant is connected to or disconnected from the stage.</p>
|
|
1378
1378
|
* @public
|
|
1379
1379
|
*/
|
|
1380
|
-
state?: ParticipantState;
|
|
1380
|
+
state?: ParticipantState | undefined;
|
|
1381
1381
|
/**
|
|
1382
1382
|
* <p>ISO 8601 timestamp (returned as a string) when the participant first joined the stage
|
|
1383
1383
|
* session.</p>
|
|
1384
1384
|
* @public
|
|
1385
1385
|
*/
|
|
1386
|
-
firstJoinTime?: Date;
|
|
1386
|
+
firstJoinTime?: Date | undefined;
|
|
1387
1387
|
/**
|
|
1388
1388
|
* <p>Application-provided attributes to encode into the token and attach to a stage. Map keys
|
|
1389
1389
|
* and values can contain UTF-8 encoded text. The maximum length of this field is 1 KB total.
|
|
@@ -1391,62 +1391,62 @@ export interface Participant {
|
|
|
1391
1391
|
* personally identifying, confidential, or sensitive information</i>.</p>
|
|
1392
1392
|
* @public
|
|
1393
1393
|
*/
|
|
1394
|
-
attributes?: Record<string, string
|
|
1394
|
+
attributes?: Record<string, string> | undefined;
|
|
1395
1395
|
/**
|
|
1396
1396
|
* <p>Whether the participant ever published to the stage session.</p>
|
|
1397
1397
|
* @public
|
|
1398
1398
|
*/
|
|
1399
|
-
published?: boolean;
|
|
1399
|
+
published?: boolean | undefined;
|
|
1400
1400
|
/**
|
|
1401
1401
|
* <p>The participant’s Internet Service Provider.</p>
|
|
1402
1402
|
* @public
|
|
1403
1403
|
*/
|
|
1404
|
-
ispName?: string;
|
|
1404
|
+
ispName?: string | undefined;
|
|
1405
1405
|
/**
|
|
1406
1406
|
* <p>The participant’s operating system.</p>
|
|
1407
1407
|
* @public
|
|
1408
1408
|
*/
|
|
1409
|
-
osName?: string;
|
|
1409
|
+
osName?: string | undefined;
|
|
1410
1410
|
/**
|
|
1411
1411
|
* <p>The participant’s operating system version.</p>
|
|
1412
1412
|
* @public
|
|
1413
1413
|
*/
|
|
1414
|
-
osVersion?: string;
|
|
1414
|
+
osVersion?: string | undefined;
|
|
1415
1415
|
/**
|
|
1416
1416
|
* <p>The participant’s browser.</p>
|
|
1417
1417
|
* @public
|
|
1418
1418
|
*/
|
|
1419
|
-
browserName?: string;
|
|
1419
|
+
browserName?: string | undefined;
|
|
1420
1420
|
/**
|
|
1421
1421
|
* <p>The participant’s browser version.</p>
|
|
1422
1422
|
* @public
|
|
1423
1423
|
*/
|
|
1424
|
-
browserVersion?: string;
|
|
1424
|
+
browserVersion?: string | undefined;
|
|
1425
1425
|
/**
|
|
1426
1426
|
* <p>The participant’s SDK version.</p>
|
|
1427
1427
|
* @public
|
|
1428
1428
|
*/
|
|
1429
|
-
sdkVersion?: string;
|
|
1429
|
+
sdkVersion?: string | undefined;
|
|
1430
1430
|
/**
|
|
1431
1431
|
* <p>Name of the S3 bucket to where the participant is being recorded, if individual participant recording is enabled, or <code>""</code> (empty string), if recording is not enabled.</p>
|
|
1432
1432
|
* @public
|
|
1433
1433
|
*/
|
|
1434
|
-
recordingS3BucketName?: string;
|
|
1434
|
+
recordingS3BucketName?: string | undefined;
|
|
1435
1435
|
/**
|
|
1436
1436
|
* <p>S3 prefix of the S3 bucket where the participant is being recorded, if individual participant recording is enabled, or <code>""</code> (empty string), if recording is not enabled.</p>
|
|
1437
1437
|
* @public
|
|
1438
1438
|
*/
|
|
1439
|
-
recordingS3Prefix?: string;
|
|
1439
|
+
recordingS3Prefix?: string | undefined;
|
|
1440
1440
|
/**
|
|
1441
1441
|
* <p>The participant’s recording state.</p>
|
|
1442
1442
|
* @public
|
|
1443
1443
|
*/
|
|
1444
|
-
recordingState?: ParticipantRecordingState;
|
|
1444
|
+
recordingState?: ParticipantRecordingState | undefined;
|
|
1445
1445
|
/**
|
|
1446
1446
|
* <p>Type of ingest protocol that the participant employs for broadcasting.</p>
|
|
1447
1447
|
* @public
|
|
1448
1448
|
*/
|
|
1449
|
-
protocol?: ParticipantProtocol;
|
|
1449
|
+
protocol?: ParticipantProtocol | undefined;
|
|
1450
1450
|
}
|
|
1451
1451
|
/**
|
|
1452
1452
|
* @public
|
|
@@ -1456,7 +1456,7 @@ export interface GetParticipantResponse {
|
|
|
1456
1456
|
* <p>The participant that is returned.</p>
|
|
1457
1457
|
* @public
|
|
1458
1458
|
*/
|
|
1459
|
-
participant?: Participant;
|
|
1459
|
+
participant?: Participant | undefined;
|
|
1460
1460
|
}
|
|
1461
1461
|
/**
|
|
1462
1462
|
* @public
|
|
@@ -1477,22 +1477,22 @@ export interface PublicKey {
|
|
|
1477
1477
|
* <p>Public key ARN.</p>
|
|
1478
1478
|
* @public
|
|
1479
1479
|
*/
|
|
1480
|
-
arn?: string;
|
|
1480
|
+
arn?: string | undefined;
|
|
1481
1481
|
/**
|
|
1482
1482
|
* <p>Public key name.</p>
|
|
1483
1483
|
* @public
|
|
1484
1484
|
*/
|
|
1485
|
-
name?: string;
|
|
1485
|
+
name?: string | undefined;
|
|
1486
1486
|
/**
|
|
1487
1487
|
* <p>Public key material.</p>
|
|
1488
1488
|
* @public
|
|
1489
1489
|
*/
|
|
1490
|
-
publicKeyMaterial?: string;
|
|
1490
|
+
publicKeyMaterial?: string | undefined;
|
|
1491
1491
|
/**
|
|
1492
1492
|
* <p>The public key fingerprint, a short string used to identify or verify the full public key.</p>
|
|
1493
1493
|
* @public
|
|
1494
1494
|
*/
|
|
1495
|
-
fingerprint?: string;
|
|
1495
|
+
fingerprint?: string | undefined;
|
|
1496
1496
|
/**
|
|
1497
1497
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1498
1498
|
* (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>
|
|
@@ -1500,7 +1500,7 @@ export interface PublicKey {
|
|
|
1500
1500
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
1501
1501
|
* @public
|
|
1502
1502
|
*/
|
|
1503
|
-
tags?: Record<string, string
|
|
1503
|
+
tags?: Record<string, string> | undefined;
|
|
1504
1504
|
}
|
|
1505
1505
|
/**
|
|
1506
1506
|
* @public
|
|
@@ -1510,7 +1510,7 @@ export interface GetPublicKeyResponse {
|
|
|
1510
1510
|
* <p>The public key that is returned.</p>
|
|
1511
1511
|
* @public
|
|
1512
1512
|
*/
|
|
1513
|
-
publicKey?: PublicKey;
|
|
1513
|
+
publicKey?: PublicKey | undefined;
|
|
1514
1514
|
}
|
|
1515
1515
|
/**
|
|
1516
1516
|
* @public
|
|
@@ -1530,7 +1530,7 @@ export interface GetStageResponse {
|
|
|
1530
1530
|
* <p>The stage that is returned.</p>
|
|
1531
1531
|
* @public
|
|
1532
1532
|
*/
|
|
1533
|
-
stage?: Stage;
|
|
1533
|
+
stage?: Stage | undefined;
|
|
1534
1534
|
}
|
|
1535
1535
|
/**
|
|
1536
1536
|
* @public
|
|
@@ -1559,18 +1559,18 @@ export interface StageSession {
|
|
|
1559
1559
|
* <p>ID of the session within the stage.</p>
|
|
1560
1560
|
* @public
|
|
1561
1561
|
*/
|
|
1562
|
-
sessionId?: string;
|
|
1562
|
+
sessionId?: string | undefined;
|
|
1563
1563
|
/**
|
|
1564
1564
|
* <p> ISO 8601 timestamp (returned as a string) when this stage session began.</p>
|
|
1565
1565
|
* @public
|
|
1566
1566
|
*/
|
|
1567
|
-
startTime?: Date;
|
|
1567
|
+
startTime?: Date | undefined;
|
|
1568
1568
|
/**
|
|
1569
1569
|
* <p>ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if
|
|
1570
1570
|
* the stage is active.</p>
|
|
1571
1571
|
* @public
|
|
1572
1572
|
*/
|
|
1573
|
-
endTime?: Date;
|
|
1573
|
+
endTime?: Date | undefined;
|
|
1574
1574
|
}
|
|
1575
1575
|
/**
|
|
1576
1576
|
* @public
|
|
@@ -1580,7 +1580,7 @@ export interface GetStageSessionResponse {
|
|
|
1580
1580
|
* <p>The stage session that is returned.</p>
|
|
1581
1581
|
* @public
|
|
1582
1582
|
*/
|
|
1583
|
-
stageSession?: StageSession;
|
|
1583
|
+
stageSession?: StageSession | undefined;
|
|
1584
1584
|
}
|
|
1585
1585
|
/**
|
|
1586
1586
|
* @public
|
|
@@ -1600,7 +1600,7 @@ export interface GetStorageConfigurationResponse {
|
|
|
1600
1600
|
* <p>The StorageConfiguration that was returned.</p>
|
|
1601
1601
|
* @public
|
|
1602
1602
|
*/
|
|
1603
|
-
storageConfiguration?: StorageConfiguration;
|
|
1603
|
+
storageConfiguration?: StorageConfiguration | undefined;
|
|
1604
1604
|
}
|
|
1605
1605
|
/**
|
|
1606
1606
|
* @public
|
|
@@ -1615,7 +1615,7 @@ export interface ImportPublicKeyRequest {
|
|
|
1615
1615
|
* <p>Name of the public key to be imported.</p>
|
|
1616
1616
|
* @public
|
|
1617
1617
|
*/
|
|
1618
|
-
name?: string;
|
|
1618
|
+
name?: string | undefined;
|
|
1619
1619
|
/**
|
|
1620
1620
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1621
1621
|
* (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>
|
|
@@ -1624,7 +1624,7 @@ export interface ImportPublicKeyRequest {
|
|
|
1624
1624
|
* there.</p>
|
|
1625
1625
|
* @public
|
|
1626
1626
|
*/
|
|
1627
|
-
tags?: Record<string, string
|
|
1627
|
+
tags?: Record<string, string> | undefined;
|
|
1628
1628
|
}
|
|
1629
1629
|
/**
|
|
1630
1630
|
* @public
|
|
@@ -1634,7 +1634,7 @@ export interface ImportPublicKeyResponse {
|
|
|
1634
1634
|
* <p>The public key that was imported.</p>
|
|
1635
1635
|
* @public
|
|
1636
1636
|
*/
|
|
1637
|
-
publicKey?: PublicKey;
|
|
1637
|
+
publicKey?: PublicKey | undefined;
|
|
1638
1638
|
}
|
|
1639
1639
|
/**
|
|
1640
1640
|
* @public
|
|
@@ -1644,24 +1644,24 @@ export interface ListCompositionsRequest {
|
|
|
1644
1644
|
* <p>Filters the Composition list to match the specified Stage ARN.</p>
|
|
1645
1645
|
* @public
|
|
1646
1646
|
*/
|
|
1647
|
-
filterByStageArn?: string;
|
|
1647
|
+
filterByStageArn?: string | undefined;
|
|
1648
1648
|
/**
|
|
1649
1649
|
* <p>Filters the Composition list to match the specified EncoderConfiguration attached to at
|
|
1650
1650
|
* least one of its output.</p>
|
|
1651
1651
|
* @public
|
|
1652
1652
|
*/
|
|
1653
|
-
filterByEncoderConfigurationArn?: string;
|
|
1653
|
+
filterByEncoderConfigurationArn?: string | undefined;
|
|
1654
1654
|
/**
|
|
1655
1655
|
* <p>The first Composition to retrieve. This is used for pagination; see the
|
|
1656
1656
|
* <code>nextToken</code> response field.</p>
|
|
1657
1657
|
* @public
|
|
1658
1658
|
*/
|
|
1659
|
-
nextToken?: string;
|
|
1659
|
+
nextToken?: string | undefined;
|
|
1660
1660
|
/**
|
|
1661
1661
|
* <p>Maximum number of results to return. Default: 100.</p>
|
|
1662
1662
|
* @public
|
|
1663
1663
|
*/
|
|
1664
|
-
maxResults?: number;
|
|
1664
|
+
maxResults?: number | undefined;
|
|
1665
1665
|
}
|
|
1666
1666
|
/**
|
|
1667
1667
|
* <p>Summary information about a Destination.</p>
|
|
@@ -1683,13 +1683,13 @@ export interface DestinationSummary {
|
|
|
1683
1683
|
* this is returned as a string</i>.</p>
|
|
1684
1684
|
* @public
|
|
1685
1685
|
*/
|
|
1686
|
-
startTime?: Date;
|
|
1686
|
+
startTime?: Date | undefined;
|
|
1687
1687
|
/**
|
|
1688
1688
|
* <p>UTC time of the destination end. This is an ISO 8601 timestamp; <i>note that this
|
|
1689
1689
|
* is returned as a string</i>.</p>
|
|
1690
1690
|
* @public
|
|
1691
1691
|
*/
|
|
1692
|
-
endTime?: Date;
|
|
1692
|
+
endTime?: Date | undefined;
|
|
1693
1693
|
}
|
|
1694
1694
|
/**
|
|
1695
1695
|
* <p>Summary information about a Composition.</p>
|
|
@@ -1723,19 +1723,19 @@ export interface CompositionSummary {
|
|
|
1723
1723
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
1724
1724
|
* @public
|
|
1725
1725
|
*/
|
|
1726
|
-
tags?: Record<string, string
|
|
1726
|
+
tags?: Record<string, string> | undefined;
|
|
1727
1727
|
/**
|
|
1728
1728
|
* <p>UTC time of the Composition start. This is an ISO 8601 timestamp; <i>note that
|
|
1729
1729
|
* this is returned as a string</i>.</p>
|
|
1730
1730
|
* @public
|
|
1731
1731
|
*/
|
|
1732
|
-
startTime?: Date;
|
|
1732
|
+
startTime?: Date | undefined;
|
|
1733
1733
|
/**
|
|
1734
1734
|
* <p>UTC time of the Composition end. This is an ISO 8601 timestamp; <i>note that
|
|
1735
1735
|
* this is returned as a string</i>.</p>
|
|
1736
1736
|
* @public
|
|
1737
1737
|
*/
|
|
1738
|
-
endTime?: Date;
|
|
1738
|
+
endTime?: Date | undefined;
|
|
1739
1739
|
}
|
|
1740
1740
|
/**
|
|
1741
1741
|
* @public
|
|
@@ -1751,7 +1751,7 @@ export interface ListCompositionsResponse {
|
|
|
1751
1751
|
* in the request to get the next set.</p>
|
|
1752
1752
|
* @public
|
|
1753
1753
|
*/
|
|
1754
|
-
nextToken?: string;
|
|
1754
|
+
nextToken?: string | undefined;
|
|
1755
1755
|
}
|
|
1756
1756
|
/**
|
|
1757
1757
|
* @public
|
|
@@ -1762,12 +1762,12 @@ export interface ListEncoderConfigurationsRequest {
|
|
|
1762
1762
|
* <code>nextToken</code> response field.</p>
|
|
1763
1763
|
* @public
|
|
1764
1764
|
*/
|
|
1765
|
-
nextToken?: string;
|
|
1765
|
+
nextToken?: string | undefined;
|
|
1766
1766
|
/**
|
|
1767
1767
|
* <p>Maximum number of results to return. Default: 100.</p>
|
|
1768
1768
|
* @public
|
|
1769
1769
|
*/
|
|
1770
|
-
maxResults?: number;
|
|
1770
|
+
maxResults?: number | undefined;
|
|
1771
1771
|
}
|
|
1772
1772
|
/**
|
|
1773
1773
|
* <p>Summary information about an EncoderConfiguration.</p>
|
|
@@ -1783,7 +1783,7 @@ export interface EncoderConfigurationSummary {
|
|
|
1783
1783
|
* <p>Optional name to identify the resource.</p>
|
|
1784
1784
|
* @public
|
|
1785
1785
|
*/
|
|
1786
|
-
name?: string;
|
|
1786
|
+
name?: string | undefined;
|
|
1787
1787
|
/**
|
|
1788
1788
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1789
1789
|
* (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>
|
|
@@ -1791,7 +1791,7 @@ export interface EncoderConfigurationSummary {
|
|
|
1791
1791
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
1792
1792
|
* @public
|
|
1793
1793
|
*/
|
|
1794
|
-
tags?: Record<string, string
|
|
1794
|
+
tags?: Record<string, string> | undefined;
|
|
1795
1795
|
}
|
|
1796
1796
|
/**
|
|
1797
1797
|
* @public
|
|
@@ -1807,7 +1807,7 @@ export interface ListEncoderConfigurationsResponse {
|
|
|
1807
1807
|
* <code>nextToken</code> in the request to get the next set.</p>
|
|
1808
1808
|
* @public
|
|
1809
1809
|
*/
|
|
1810
|
-
nextToken?: string;
|
|
1810
|
+
nextToken?: string | undefined;
|
|
1811
1811
|
}
|
|
1812
1812
|
/**
|
|
1813
1813
|
* @public
|
|
@@ -1817,22 +1817,22 @@ export interface ListIngestConfigurationsRequest {
|
|
|
1817
1817
|
* <p>Filters the response list to match the specified stage ARN. Only one filter (by stage ARN or by state) can be used at a time.</p>
|
|
1818
1818
|
* @public
|
|
1819
1819
|
*/
|
|
1820
|
-
filterByStageArn?: string;
|
|
1820
|
+
filterByStageArn?: string | undefined;
|
|
1821
1821
|
/**
|
|
1822
1822
|
* <p>Filters the response list to match the specified state. Only one filter (by stage ARN or by state) can be used at a time.</p>
|
|
1823
1823
|
* @public
|
|
1824
1824
|
*/
|
|
1825
|
-
filterByState?: IngestConfigurationState;
|
|
1825
|
+
filterByState?: IngestConfigurationState | undefined;
|
|
1826
1826
|
/**
|
|
1827
1827
|
* <p>The first IngestConfiguration to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
|
|
1828
1828
|
* @public
|
|
1829
1829
|
*/
|
|
1830
|
-
nextToken?: string;
|
|
1830
|
+
nextToken?: string | undefined;
|
|
1831
1831
|
/**
|
|
1832
1832
|
* <p>Maximum number of results to return. Default: 50.</p>
|
|
1833
1833
|
* @public
|
|
1834
1834
|
*/
|
|
1835
|
-
maxResults?: number;
|
|
1835
|
+
maxResults?: number | undefined;
|
|
1836
1836
|
}
|
|
1837
1837
|
/**
|
|
1838
1838
|
* <p>Summary information about an IngestConfiguration.</p>
|
|
@@ -1843,7 +1843,7 @@ export interface IngestConfigurationSummary {
|
|
|
1843
1843
|
* <p>Ingest name.</p>
|
|
1844
1844
|
* @public
|
|
1845
1845
|
*/
|
|
1846
|
-
name?: string;
|
|
1846
|
+
name?: string | undefined;
|
|
1847
1847
|
/**
|
|
1848
1848
|
* <p>Ingest configuration ARN.</p>
|
|
1849
1849
|
* @public
|
|
@@ -1875,7 +1875,7 @@ export interface IngestConfigurationSummary {
|
|
|
1875
1875
|
* </p>
|
|
1876
1876
|
* @public
|
|
1877
1877
|
*/
|
|
1878
|
-
userId?: string;
|
|
1878
|
+
userId?: string | undefined;
|
|
1879
1879
|
}
|
|
1880
1880
|
/**
|
|
1881
1881
|
* @public
|
|
@@ -1890,7 +1890,7 @@ export interface ListIngestConfigurationsResponse {
|
|
|
1890
1890
|
* <p>If there are more IngestConfigurations than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
|
|
1891
1891
|
* @public
|
|
1892
1892
|
*/
|
|
1893
|
-
nextToken?: string;
|
|
1893
|
+
nextToken?: string | undefined;
|
|
1894
1894
|
}
|
|
1895
1895
|
/**
|
|
1896
1896
|
* @public
|
|
@@ -1916,12 +1916,12 @@ export interface ListParticipantEventsRequest {
|
|
|
1916
1916
|
* <code>nextToken</code> response field.</p>
|
|
1917
1917
|
* @public
|
|
1918
1918
|
*/
|
|
1919
|
-
nextToken?: string;
|
|
1919
|
+
nextToken?: string | undefined;
|
|
1920
1920
|
/**
|
|
1921
1921
|
* <p>Maximum number of results to return. Default: 50.</p>
|
|
1922
1922
|
* @public
|
|
1923
1923
|
*/
|
|
1924
|
-
maxResults?: number;
|
|
1924
|
+
maxResults?: number | undefined;
|
|
1925
1925
|
}
|
|
1926
1926
|
/**
|
|
1927
1927
|
* @public
|
|
@@ -1975,24 +1975,24 @@ export interface Event {
|
|
|
1975
1975
|
* <p>The name of the event.</p>
|
|
1976
1976
|
* @public
|
|
1977
1977
|
*/
|
|
1978
|
-
name?: EventName;
|
|
1978
|
+
name?: EventName | undefined;
|
|
1979
1979
|
/**
|
|
1980
1980
|
* <p>Unique identifier for the participant who triggered the event. This is assigned by
|
|
1981
1981
|
* IVS.</p>
|
|
1982
1982
|
* @public
|
|
1983
1983
|
*/
|
|
1984
|
-
participantId?: string;
|
|
1984
|
+
participantId?: string | undefined;
|
|
1985
1985
|
/**
|
|
1986
1986
|
* <p>ISO 8601 timestamp (returned as a string) for when the event occurred.</p>
|
|
1987
1987
|
* @public
|
|
1988
1988
|
*/
|
|
1989
|
-
eventTime?: Date;
|
|
1989
|
+
eventTime?: Date | undefined;
|
|
1990
1990
|
/**
|
|
1991
1991
|
* <p>Unique identifier for the remote participant. For a subscribe event, this is the
|
|
1992
1992
|
* publisher. For a publish or join event, this is null. This is assigned by IVS.</p>
|
|
1993
1993
|
* @public
|
|
1994
1994
|
*/
|
|
1995
|
-
remoteParticipantId?: string;
|
|
1995
|
+
remoteParticipantId?: string | undefined;
|
|
1996
1996
|
/**
|
|
1997
1997
|
* <p>If the event is an error event, the error code is provided to give insight into the
|
|
1998
1998
|
* specific error that occurred. If the event is not an error event, this field is null.</p>
|
|
@@ -2090,7 +2090,7 @@ export interface Event {
|
|
|
2090
2090
|
* </ul>
|
|
2091
2091
|
* @public
|
|
2092
2092
|
*/
|
|
2093
|
-
errorCode?: EventErrorCode;
|
|
2093
|
+
errorCode?: EventErrorCode | undefined;
|
|
2094
2094
|
}
|
|
2095
2095
|
/**
|
|
2096
2096
|
* @public
|
|
@@ -2106,7 +2106,7 @@ export interface ListParticipantEventsResponse {
|
|
|
2106
2106
|
* request to get the next set. </p>
|
|
2107
2107
|
* @public
|
|
2108
2108
|
*/
|
|
2109
|
-
nextToken?: string;
|
|
2109
|
+
nextToken?: string | undefined;
|
|
2110
2110
|
}
|
|
2111
2111
|
/**
|
|
2112
2112
|
* @public
|
|
@@ -2146,39 +2146,39 @@ export interface ListParticipantsRequest {
|
|
|
2146
2146
|
* to a user in the customer’s own systems.</p>
|
|
2147
2147
|
* @public
|
|
2148
2148
|
*/
|
|
2149
|
-
filterByUserId?: string;
|
|
2149
|
+
filterByUserId?: string | undefined;
|
|
2150
2150
|
/**
|
|
2151
2151
|
* <p>Filters the response list to only show participants who published during the stage session.
|
|
2152
2152
|
* Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
|
|
2153
2153
|
* <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
|
|
2154
2154
|
* @public
|
|
2155
2155
|
*/
|
|
2156
|
-
filterByPublished?: boolean;
|
|
2156
|
+
filterByPublished?: boolean | undefined;
|
|
2157
2157
|
/**
|
|
2158
2158
|
* <p>Filters the response list to only show participants in the specified state.
|
|
2159
2159
|
* Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
|
|
2160
2160
|
* <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
|
|
2161
2161
|
* @public
|
|
2162
2162
|
*/
|
|
2163
|
-
filterByState?: ParticipantState;
|
|
2163
|
+
filterByState?: ParticipantState | undefined;
|
|
2164
2164
|
/**
|
|
2165
2165
|
* <p>The first participant to retrieve. This is used for pagination; see the
|
|
2166
2166
|
* <code>nextToken</code> response field.</p>
|
|
2167
2167
|
* @public
|
|
2168
2168
|
*/
|
|
2169
|
-
nextToken?: string;
|
|
2169
|
+
nextToken?: string | undefined;
|
|
2170
2170
|
/**
|
|
2171
2171
|
* <p>Maximum number of results to return. Default: 50.</p>
|
|
2172
2172
|
* @public
|
|
2173
2173
|
*/
|
|
2174
|
-
maxResults?: number;
|
|
2174
|
+
maxResults?: number | undefined;
|
|
2175
2175
|
/**
|
|
2176
2176
|
* <p>Filters the response list to only show participants with the specified recording state.
|
|
2177
2177
|
* Only one of <code>filterByUserId</code>, <code>filterByPublished</code>,
|
|
2178
2178
|
* <code>filterByState</code>, or <code>filterByRecordingState</code> can be provided per request.</p>
|
|
2179
2179
|
* @public
|
|
2180
2180
|
*/
|
|
2181
|
-
filterByRecordingState?: ParticipantRecordingFilterByRecordingState;
|
|
2181
|
+
filterByRecordingState?: ParticipantRecordingFilterByRecordingState | undefined;
|
|
2182
2182
|
}
|
|
2183
2183
|
/**
|
|
2184
2184
|
* <p>Summary object describing a participant that has joined a stage.</p>
|
|
@@ -2189,7 +2189,7 @@ export interface ParticipantSummary {
|
|
|
2189
2189
|
* <p>Unique identifier for this participant, assigned by IVS.</p>
|
|
2190
2190
|
* @public
|
|
2191
2191
|
*/
|
|
2192
|
-
participantId?: string;
|
|
2192
|
+
participantId?: string | undefined;
|
|
2193
2193
|
/**
|
|
2194
2194
|
* <p>Customer-assigned name to help identify the token; this can be used to link a
|
|
2195
2195
|
* participant to a user in the customer’s own systems. This can be any UTF-8 encoded text.
|
|
@@ -2197,28 +2197,28 @@ export interface ParticipantSummary {
|
|
|
2197
2197
|
* personally identifying, confidential, or sensitive information</i>.</p>
|
|
2198
2198
|
* @public
|
|
2199
2199
|
*/
|
|
2200
|
-
userId?: string;
|
|
2200
|
+
userId?: string | undefined;
|
|
2201
2201
|
/**
|
|
2202
2202
|
* <p>Whether the participant is connected to or disconnected from the stage.</p>
|
|
2203
2203
|
* @public
|
|
2204
2204
|
*/
|
|
2205
|
-
state?: ParticipantState;
|
|
2205
|
+
state?: ParticipantState | undefined;
|
|
2206
2206
|
/**
|
|
2207
2207
|
* <p>ISO 8601 timestamp (returned as a string) when the participant first joined the stage
|
|
2208
2208
|
* session.</p>
|
|
2209
2209
|
* @public
|
|
2210
2210
|
*/
|
|
2211
|
-
firstJoinTime?: Date;
|
|
2211
|
+
firstJoinTime?: Date | undefined;
|
|
2212
2212
|
/**
|
|
2213
2213
|
* <p>Whether the participant ever published to the stage session.</p>
|
|
2214
2214
|
* @public
|
|
2215
2215
|
*/
|
|
2216
|
-
published?: boolean;
|
|
2216
|
+
published?: boolean | undefined;
|
|
2217
2217
|
/**
|
|
2218
2218
|
* <p>The participant’s recording state.</p>
|
|
2219
2219
|
* @public
|
|
2220
2220
|
*/
|
|
2221
|
-
recordingState?: ParticipantRecordingState;
|
|
2221
|
+
recordingState?: ParticipantRecordingState | undefined;
|
|
2222
2222
|
}
|
|
2223
2223
|
/**
|
|
2224
2224
|
* @public
|
|
@@ -2234,7 +2234,7 @@ export interface ListParticipantsResponse {
|
|
|
2234
2234
|
* in the request to get the next set.</p>
|
|
2235
2235
|
* @public
|
|
2236
2236
|
*/
|
|
2237
|
-
nextToken?: string;
|
|
2237
|
+
nextToken?: string | undefined;
|
|
2238
2238
|
}
|
|
2239
2239
|
/**
|
|
2240
2240
|
* @public
|
|
@@ -2244,12 +2244,12 @@ export interface ListPublicKeysRequest {
|
|
|
2244
2244
|
* <p>The first public key to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
|
|
2245
2245
|
* @public
|
|
2246
2246
|
*/
|
|
2247
|
-
nextToken?: string;
|
|
2247
|
+
nextToken?: string | undefined;
|
|
2248
2248
|
/**
|
|
2249
2249
|
* <p>Maximum number of results to return. Default: 50.</p>
|
|
2250
2250
|
* @public
|
|
2251
2251
|
*/
|
|
2252
|
-
maxResults?: number;
|
|
2252
|
+
maxResults?: number | undefined;
|
|
2253
2253
|
}
|
|
2254
2254
|
/**
|
|
2255
2255
|
* <p>Summary information about a public key.</p>
|
|
@@ -2260,12 +2260,12 @@ export interface PublicKeySummary {
|
|
|
2260
2260
|
* <p>Public key ARN.</p>
|
|
2261
2261
|
* @public
|
|
2262
2262
|
*/
|
|
2263
|
-
arn?: string;
|
|
2263
|
+
arn?: string | undefined;
|
|
2264
2264
|
/**
|
|
2265
2265
|
* <p>Public key name.</p>
|
|
2266
2266
|
* @public
|
|
2267
2267
|
*/
|
|
2268
|
-
name?: string;
|
|
2268
|
+
name?: string | undefined;
|
|
2269
2269
|
/**
|
|
2270
2270
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
2271
2271
|
* (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>
|
|
@@ -2273,7 +2273,7 @@ export interface PublicKeySummary {
|
|
|
2273
2273
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
2274
2274
|
* @public
|
|
2275
2275
|
*/
|
|
2276
|
-
tags?: Record<string, string
|
|
2276
|
+
tags?: Record<string, string> | undefined;
|
|
2277
2277
|
}
|
|
2278
2278
|
/**
|
|
2279
2279
|
* @public
|
|
@@ -2288,7 +2288,7 @@ export interface ListPublicKeysResponse {
|
|
|
2288
2288
|
* <p>If there are more public keys than <code>maxResults</code>, use <code>nextToken</code> in the request to get the next set.</p>
|
|
2289
2289
|
* @public
|
|
2290
2290
|
*/
|
|
2291
|
-
nextToken?: string;
|
|
2291
|
+
nextToken?: string | undefined;
|
|
2292
2292
|
}
|
|
2293
2293
|
/**
|
|
2294
2294
|
* @public
|
|
@@ -2299,12 +2299,12 @@ export interface ListStagesRequest {
|
|
|
2299
2299
|
* response field.</p>
|
|
2300
2300
|
* @public
|
|
2301
2301
|
*/
|
|
2302
|
-
nextToken?: string;
|
|
2302
|
+
nextToken?: string | undefined;
|
|
2303
2303
|
/**
|
|
2304
2304
|
* <p>Maximum number of results to return. Default: 50.</p>
|
|
2305
2305
|
* @public
|
|
2306
2306
|
*/
|
|
2307
|
-
maxResults?: number;
|
|
2307
|
+
maxResults?: number | undefined;
|
|
2308
2308
|
}
|
|
2309
2309
|
/**
|
|
2310
2310
|
* <p>Summary information about a stage.</p>
|
|
@@ -2320,12 +2320,12 @@ export interface StageSummary {
|
|
|
2320
2320
|
* <p>Stage name.</p>
|
|
2321
2321
|
* @public
|
|
2322
2322
|
*/
|
|
2323
|
-
name?: string;
|
|
2323
|
+
name?: string | undefined;
|
|
2324
2324
|
/**
|
|
2325
2325
|
* <p>ID of the active session within the stage.</p>
|
|
2326
2326
|
* @public
|
|
2327
2327
|
*/
|
|
2328
|
-
activeSessionId?: string;
|
|
2328
|
+
activeSessionId?: string | undefined;
|
|
2329
2329
|
/**
|
|
2330
2330
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
2331
2331
|
* (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>
|
|
@@ -2333,7 +2333,7 @@ export interface StageSummary {
|
|
|
2333
2333
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
2334
2334
|
* @public
|
|
2335
2335
|
*/
|
|
2336
|
-
tags?: Record<string, string
|
|
2336
|
+
tags?: Record<string, string> | undefined;
|
|
2337
2337
|
}
|
|
2338
2338
|
/**
|
|
2339
2339
|
* @public
|
|
@@ -2349,7 +2349,7 @@ export interface ListStagesResponse {
|
|
|
2349
2349
|
* request to get the next set.</p>
|
|
2350
2350
|
* @public
|
|
2351
2351
|
*/
|
|
2352
|
-
nextToken?: string;
|
|
2352
|
+
nextToken?: string | undefined;
|
|
2353
2353
|
}
|
|
2354
2354
|
/**
|
|
2355
2355
|
* @public
|
|
@@ -2365,12 +2365,12 @@ export interface ListStageSessionsRequest {
|
|
|
2365
2365
|
* <code>nextToken</code> response field.</p>
|
|
2366
2366
|
* @public
|
|
2367
2367
|
*/
|
|
2368
|
-
nextToken?: string;
|
|
2368
|
+
nextToken?: string | undefined;
|
|
2369
2369
|
/**
|
|
2370
2370
|
* <p>Maximum number of results to return. Default: 50.</p>
|
|
2371
2371
|
* @public
|
|
2372
2372
|
*/
|
|
2373
|
-
maxResults?: number;
|
|
2373
|
+
maxResults?: number | undefined;
|
|
2374
2374
|
}
|
|
2375
2375
|
/**
|
|
2376
2376
|
* <p>Summary information about a stage session.</p>
|
|
@@ -2381,18 +2381,18 @@ export interface StageSessionSummary {
|
|
|
2381
2381
|
* <p>ID of the session within the stage.</p>
|
|
2382
2382
|
* @public
|
|
2383
2383
|
*/
|
|
2384
|
-
sessionId?: string;
|
|
2384
|
+
sessionId?: string | undefined;
|
|
2385
2385
|
/**
|
|
2386
2386
|
* <p> ISO 8601 timestamp (returned as a string) when this stage session began.</p>
|
|
2387
2387
|
* @public
|
|
2388
2388
|
*/
|
|
2389
|
-
startTime?: Date;
|
|
2389
|
+
startTime?: Date | undefined;
|
|
2390
2390
|
/**
|
|
2391
2391
|
* <p>ISO 8601 timestamp (returned as a string) when the stage session ended. This is null if
|
|
2392
2392
|
* the stage is active.</p>
|
|
2393
2393
|
* @public
|
|
2394
2394
|
*/
|
|
2395
|
-
endTime?: Date;
|
|
2395
|
+
endTime?: Date | undefined;
|
|
2396
2396
|
}
|
|
2397
2397
|
/**
|
|
2398
2398
|
* @public
|
|
@@ -2408,7 +2408,7 @@ export interface ListStageSessionsResponse {
|
|
|
2408
2408
|
* <code>nextToken</code> in the request to get the next set.</p>
|
|
2409
2409
|
* @public
|
|
2410
2410
|
*/
|
|
2411
|
-
nextToken?: string;
|
|
2411
|
+
nextToken?: string | undefined;
|
|
2412
2412
|
}
|
|
2413
2413
|
/**
|
|
2414
2414
|
* @public
|
|
@@ -2419,13 +2419,13 @@ export interface ListStorageConfigurationsRequest {
|
|
|
2419
2419
|
* see the <code>nextToken</code> response field.</p>
|
|
2420
2420
|
* @public
|
|
2421
2421
|
*/
|
|
2422
|
-
nextToken?: string;
|
|
2422
|
+
nextToken?: string | undefined;
|
|
2423
2423
|
/**
|
|
2424
2424
|
* <p>Maximum number of storage configurations to return. Default: your service quota or 100,
|
|
2425
2425
|
* whichever is smaller.</p>
|
|
2426
2426
|
* @public
|
|
2427
2427
|
*/
|
|
2428
|
-
maxResults?: number;
|
|
2428
|
+
maxResults?: number | undefined;
|
|
2429
2429
|
}
|
|
2430
2430
|
/**
|
|
2431
2431
|
* <p>Summary information about a storage configuration.</p>
|
|
@@ -2441,12 +2441,12 @@ export interface StorageConfigurationSummary {
|
|
|
2441
2441
|
* <p>Name of the storage configuration.</p>
|
|
2442
2442
|
* @public
|
|
2443
2443
|
*/
|
|
2444
|
-
name?: string;
|
|
2444
|
+
name?: string | undefined;
|
|
2445
2445
|
/**
|
|
2446
2446
|
* <p>An S3 destination configuration where recorded videos will be stored.</p>
|
|
2447
2447
|
* @public
|
|
2448
2448
|
*/
|
|
2449
|
-
s3?: S3StorageConfiguration;
|
|
2449
|
+
s3?: S3StorageConfiguration | undefined;
|
|
2450
2450
|
/**
|
|
2451
2451
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
2452
2452
|
* (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>
|
|
@@ -2454,7 +2454,7 @@ export interface StorageConfigurationSummary {
|
|
|
2454
2454
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
2455
2455
|
* @public
|
|
2456
2456
|
*/
|
|
2457
|
-
tags?: Record<string, string
|
|
2457
|
+
tags?: Record<string, string> | undefined;
|
|
2458
2458
|
}
|
|
2459
2459
|
/**
|
|
2460
2460
|
* @public
|
|
@@ -2470,7 +2470,7 @@ export interface ListStorageConfigurationsResponse {
|
|
|
2470
2470
|
* in the request to get the next set.</p>
|
|
2471
2471
|
* @public
|
|
2472
2472
|
*/
|
|
2473
|
-
nextToken?: string;
|
|
2473
|
+
nextToken?: string | undefined;
|
|
2474
2474
|
}
|
|
2475
2475
|
/**
|
|
2476
2476
|
* @public
|
|
@@ -2506,12 +2506,12 @@ export interface StartCompositionRequest {
|
|
|
2506
2506
|
* <p>Idempotency token.</p>
|
|
2507
2507
|
* @public
|
|
2508
2508
|
*/
|
|
2509
|
-
idempotencyToken?: string;
|
|
2509
|
+
idempotencyToken?: string | undefined;
|
|
2510
2510
|
/**
|
|
2511
2511
|
* <p>Layout object to configure composition parameters.</p>
|
|
2512
2512
|
* @public
|
|
2513
2513
|
*/
|
|
2514
|
-
layout?: LayoutConfiguration;
|
|
2514
|
+
layout?: LayoutConfiguration | undefined;
|
|
2515
2515
|
/**
|
|
2516
2516
|
* <p>Array of destination configuration.</p>
|
|
2517
2517
|
* @public
|
|
@@ -2525,7 +2525,7 @@ export interface StartCompositionRequest {
|
|
|
2525
2525
|
* there.</p>
|
|
2526
2526
|
* @public
|
|
2527
2527
|
*/
|
|
2528
|
-
tags?: Record<string, string
|
|
2528
|
+
tags?: Record<string, string> | undefined;
|
|
2529
2529
|
}
|
|
2530
2530
|
/**
|
|
2531
2531
|
* @public
|
|
@@ -2535,7 +2535,7 @@ export interface StartCompositionResponse {
|
|
|
2535
2535
|
* <p>The Composition that was created.</p>
|
|
2536
2536
|
* @public
|
|
2537
2537
|
*/
|
|
2538
|
-
composition?: Composition;
|
|
2538
|
+
composition?: Composition | undefined;
|
|
2539
2539
|
}
|
|
2540
2540
|
/**
|
|
2541
2541
|
* @public
|
|
@@ -2613,7 +2613,7 @@ export interface UpdateIngestConfigurationRequest {
|
|
|
2613
2613
|
* <p>Stage ARN that needs to be updated.</p>
|
|
2614
2614
|
* @public
|
|
2615
2615
|
*/
|
|
2616
|
-
stageArn?: string;
|
|
2616
|
+
stageArn?: string | undefined;
|
|
2617
2617
|
}
|
|
2618
2618
|
/**
|
|
2619
2619
|
* @public
|
|
@@ -2623,7 +2623,7 @@ export interface UpdateIngestConfigurationResponse {
|
|
|
2623
2623
|
* <p>The updated IngestConfiguration.</p>
|
|
2624
2624
|
* @public
|
|
2625
2625
|
*/
|
|
2626
|
-
ingestConfiguration?: IngestConfiguration;
|
|
2626
|
+
ingestConfiguration?: IngestConfiguration | undefined;
|
|
2627
2627
|
}
|
|
2628
2628
|
/**
|
|
2629
2629
|
* @public
|
|
@@ -2638,12 +2638,12 @@ export interface UpdateStageRequest {
|
|
|
2638
2638
|
* <p>Name of the stage to be updated.</p>
|
|
2639
2639
|
* @public
|
|
2640
2640
|
*/
|
|
2641
|
-
name?: string;
|
|
2641
|
+
name?: string | undefined;
|
|
2642
2642
|
/**
|
|
2643
2643
|
* <p>Configuration object for individual participant recording, to attach to the stage. Note that this cannot be updated while recording is active.</p>
|
|
2644
2644
|
* @public
|
|
2645
2645
|
*/
|
|
2646
|
-
autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
|
|
2646
|
+
autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration | undefined;
|
|
2647
2647
|
}
|
|
2648
2648
|
/**
|
|
2649
2649
|
* @public
|
|
@@ -2653,7 +2653,7 @@ export interface UpdateStageResponse {
|
|
|
2653
2653
|
* <p>The updated stage.</p>
|
|
2654
2654
|
* @public
|
|
2655
2655
|
*/
|
|
2656
|
-
stage?: Stage;
|
|
2656
|
+
stage?: Stage | undefined;
|
|
2657
2657
|
}
|
|
2658
2658
|
/**
|
|
2659
2659
|
* @internal
|