@aws-sdk/client-ivs-realtime 3.645.0 → 3.649.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/README.md +45 -5
- package/dist-cjs/endpoint/endpointResolver.js +6 -2
- package/dist-cjs/index.js +315 -2
- package/dist-es/IVSRealTime.js +10 -0
- package/dist-es/commands/CreateIngestConfigurationCommand.js +25 -0
- package/dist-es/commands/DeleteIngestConfigurationCommand.js +24 -0
- package/dist-es/commands/GetIngestConfigurationCommand.js +25 -0
- package/dist-es/commands/ListIngestConfigurationsCommand.js +24 -0
- package/dist-es/commands/UpdateIngestConfigurationCommand.js +25 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/endpoint/endpointResolver.js +7 -3
- package/dist-es/models/models_0.js +44 -0
- package/dist-es/pagination/ListIngestConfigurationsPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +144 -0
- package/dist-types/IVSRealTime.d.ts +41 -5
- package/dist-types/IVSRealTimeClient.d.ts +12 -7
- package/dist-types/commands/CreateIngestConfigurationCommand.d.ts +97 -0
- package/dist-types/commands/CreateStageCommand.d.ts +2 -0
- package/dist-types/commands/DeleteIngestConfigurationCommand.d.ts +74 -0
- package/dist-types/commands/DeleteStageCommand.d.ts +3 -1
- package/dist-types/commands/DisconnectParticipantCommand.d.ts +3 -2
- package/dist-types/commands/GetIngestConfigurationCommand.d.ts +84 -0
- package/dist-types/commands/GetParticipantCommand.d.ts +1 -0
- package/dist-types/commands/GetStageCommand.d.ts +2 -0
- package/dist-types/commands/ListIngestConfigurationsCommand.d.ts +80 -0
- package/dist-types/commands/ListParticipantEventsCommand.d.ts +1 -1
- package/dist-types/commands/StartCompositionCommand.d.ts +1 -1
- package/dist-types/commands/UpdateIngestConfigurationCommand.d.ts +91 -0
- package/dist-types/commands/UpdateStageCommand.d.ts +2 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/index.d.ts +5 -5
- package/dist-types/models/models_0.d.ts +398 -60
- package/dist-types/pagination/ListIngestConfigurationsPaginator.d.ts +7 -0
- package/dist-types/pagination/index.d.ts +1 -0
- package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
- package/dist-types/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/runtimeConfig.d.ts +2 -0
- package/dist-types/runtimeConfig.native.d.ts +2 -0
- package/dist-types/ts3.4/IVSRealTime.d.ts +86 -0
- package/dist-types/ts3.4/IVSRealTimeClient.d.ts +30 -0
- package/dist-types/ts3.4/commands/CreateIngestConfigurationCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/DeleteIngestConfigurationCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/GetIngestConfigurationCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/ListIngestConfigurationsCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/UpdateIngestConfigurationCommand.d.ts +40 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +104 -0
- package/dist-types/ts3.4/pagination/ListIngestConfigurationsPaginator.d.ts +11 -0
- package/dist-types/ts3.4/pagination/index.d.ts +1 -0
- package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
- package/dist-types/ts3.4/runtimeConfig.browser.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.d.ts +2 -0
- package/dist-types/ts3.4/runtimeConfig.native.d.ts +2 -0
- package/package.json +35 -35
|
@@ -81,8 +81,8 @@ export interface CreateEncoderConfigurationRequest {
|
|
|
81
81
|
video?: Video;
|
|
82
82
|
/**
|
|
83
83
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
84
|
-
*
|
|
85
|
-
*
|
|
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>
|
|
85
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
86
86
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
87
87
|
* there.</p>
|
|
88
88
|
* @public
|
|
@@ -112,10 +112,9 @@ export interface EncoderConfiguration {
|
|
|
112
112
|
video?: Video;
|
|
113
113
|
/**
|
|
114
114
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
115
|
-
*
|
|
116
|
-
*
|
|
117
|
-
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
118
|
-
* there.</p>
|
|
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>
|
|
116
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
117
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
119
118
|
* @public
|
|
120
119
|
*/
|
|
121
120
|
tags?: Record<string, string>;
|
|
@@ -215,6 +214,151 @@ export declare class ValidationException extends __BaseException {
|
|
|
215
214
|
*/
|
|
216
215
|
constructor(opts: __ExceptionOptionType<ValidationException, __BaseException>);
|
|
217
216
|
}
|
|
217
|
+
/**
|
|
218
|
+
* @public
|
|
219
|
+
* @enum
|
|
220
|
+
*/
|
|
221
|
+
export declare const IngestProtocol: {
|
|
222
|
+
readonly RTMP: "RTMP";
|
|
223
|
+
readonly RTMPS: "RTMPS";
|
|
224
|
+
};
|
|
225
|
+
/**
|
|
226
|
+
* @public
|
|
227
|
+
*/
|
|
228
|
+
export type IngestProtocol = (typeof IngestProtocol)[keyof typeof IngestProtocol];
|
|
229
|
+
/**
|
|
230
|
+
* @public
|
|
231
|
+
*/
|
|
232
|
+
export interface CreateIngestConfigurationRequest {
|
|
233
|
+
/**
|
|
234
|
+
* <p>Optional name that can be specified for the IngestConfiguration being created.</p>
|
|
235
|
+
* @public
|
|
236
|
+
*/
|
|
237
|
+
name?: string;
|
|
238
|
+
/**
|
|
239
|
+
* <p>ARN of the stage with which the IngestConfiguration is associated.</p>
|
|
240
|
+
* @public
|
|
241
|
+
*/
|
|
242
|
+
stageArn?: string;
|
|
243
|
+
/**
|
|
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
|
+
* <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
|
|
246
|
+
* </p>
|
|
247
|
+
* @public
|
|
248
|
+
*/
|
|
249
|
+
userId?: string;
|
|
250
|
+
/**
|
|
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
|
+
* <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
|
|
253
|
+
* </p>
|
|
254
|
+
* @public
|
|
255
|
+
*/
|
|
256
|
+
attributes?: Record<string, string>;
|
|
257
|
+
/**
|
|
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
|
+
* @public
|
|
260
|
+
*/
|
|
261
|
+
ingestProtocol: IngestProtocol | undefined;
|
|
262
|
+
/**
|
|
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
|
+
* @public
|
|
265
|
+
*/
|
|
266
|
+
insecureIngest?: boolean;
|
|
267
|
+
/**
|
|
268
|
+
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
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>
|
|
270
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
271
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
272
|
+
* there.</p>
|
|
273
|
+
* @public
|
|
274
|
+
*/
|
|
275
|
+
tags?: Record<string, string>;
|
|
276
|
+
}
|
|
277
|
+
/**
|
|
278
|
+
* @public
|
|
279
|
+
* @enum
|
|
280
|
+
*/
|
|
281
|
+
export declare const IngestConfigurationState: {
|
|
282
|
+
readonly ACTIVE: "ACTIVE";
|
|
283
|
+
readonly INACTIVE: "INACTIVE";
|
|
284
|
+
};
|
|
285
|
+
/**
|
|
286
|
+
* @public
|
|
287
|
+
*/
|
|
288
|
+
export type IngestConfigurationState = (typeof IngestConfigurationState)[keyof typeof IngestConfigurationState];
|
|
289
|
+
/**
|
|
290
|
+
* <p>Object specifying an ingest configuration.</p>
|
|
291
|
+
* @public
|
|
292
|
+
*/
|
|
293
|
+
export interface IngestConfiguration {
|
|
294
|
+
/**
|
|
295
|
+
* <p>Ingest name</p>
|
|
296
|
+
* @public
|
|
297
|
+
*/
|
|
298
|
+
name?: string;
|
|
299
|
+
/**
|
|
300
|
+
* <p>Ingest configuration ARN.</p>
|
|
301
|
+
* @public
|
|
302
|
+
*/
|
|
303
|
+
arn: string | undefined;
|
|
304
|
+
/**
|
|
305
|
+
* <p>Type of ingest protocol that the user employs for broadcasting.</p>
|
|
306
|
+
* @public
|
|
307
|
+
*/
|
|
308
|
+
ingestProtocol: IngestProtocol | undefined;
|
|
309
|
+
/**
|
|
310
|
+
* <p>Ingest-key value for the RTMP(S) protocol.</p>
|
|
311
|
+
* @public
|
|
312
|
+
*/
|
|
313
|
+
streamKey: string | undefined;
|
|
314
|
+
/**
|
|
315
|
+
* <p>ARN of the stage with which the IngestConfiguration is associated.</p>
|
|
316
|
+
* @public
|
|
317
|
+
*/
|
|
318
|
+
stageArn: string | undefined;
|
|
319
|
+
/**
|
|
320
|
+
* <p>ID of the participant within the stage.</p>
|
|
321
|
+
* @public
|
|
322
|
+
*/
|
|
323
|
+
participantId: string | undefined;
|
|
324
|
+
/**
|
|
325
|
+
* <p>State of the ingest configuration. It is <code>ACTIVE</code> if a publisher currently is publishing to the stage associated with the ingest configuration.</p>
|
|
326
|
+
* @public
|
|
327
|
+
*/
|
|
328
|
+
state: IngestConfigurationState | undefined;
|
|
329
|
+
/**
|
|
330
|
+
* <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.
|
|
331
|
+
* <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
|
|
332
|
+
* </p>
|
|
333
|
+
* @public
|
|
334
|
+
*/
|
|
335
|
+
userId?: string;
|
|
336
|
+
/**
|
|
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
|
+
* <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
|
|
339
|
+
* </p>
|
|
340
|
+
* @public
|
|
341
|
+
*/
|
|
342
|
+
attributes?: Record<string, string>;
|
|
343
|
+
/**
|
|
344
|
+
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
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>
|
|
346
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
347
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
348
|
+
* @public
|
|
349
|
+
*/
|
|
350
|
+
tags?: Record<string, string>;
|
|
351
|
+
}
|
|
352
|
+
/**
|
|
353
|
+
* @public
|
|
354
|
+
*/
|
|
355
|
+
export interface CreateIngestConfigurationResponse {
|
|
356
|
+
/**
|
|
357
|
+
* <p>The IngestConfiguration that was created.</p>
|
|
358
|
+
* @public
|
|
359
|
+
*/
|
|
360
|
+
ingestConfiguration?: IngestConfiguration;
|
|
361
|
+
}
|
|
218
362
|
/**
|
|
219
363
|
* @public
|
|
220
364
|
* @enum
|
|
@@ -407,8 +551,8 @@ export interface CreateStageRequest {
|
|
|
407
551
|
participantTokenConfigurations?: ParticipantTokenConfiguration[];
|
|
408
552
|
/**
|
|
409
553
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
410
|
-
*
|
|
411
|
-
*
|
|
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>
|
|
555
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
412
556
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
413
557
|
* there. </p>
|
|
414
558
|
* @public
|
|
@@ -421,7 +565,8 @@ export interface CreateStageRequest {
|
|
|
421
565
|
autoParticipantRecordingConfiguration?: AutoParticipantRecordingConfiguration;
|
|
422
566
|
}
|
|
423
567
|
/**
|
|
424
|
-
* <p>Summary information about various endpoints for a stage
|
|
568
|
+
* <p>Summary information about various endpoints for a stage. We recommend that you cache these values at stage
|
|
569
|
+
* creation; the values can be cached for up to 14 days.</p>
|
|
425
570
|
* @public
|
|
426
571
|
*/
|
|
427
572
|
export interface StageEndpoints {
|
|
@@ -431,10 +576,20 @@ export interface StageEndpoints {
|
|
|
431
576
|
*/
|
|
432
577
|
events?: string;
|
|
433
578
|
/**
|
|
434
|
-
* <p>WHIP
|
|
579
|
+
* <p>The endpoint to be used for IVS real-time streaming using the WHIP protocol.</p>
|
|
435
580
|
* @public
|
|
436
581
|
*/
|
|
437
582
|
whip?: string;
|
|
583
|
+
/**
|
|
584
|
+
* <p>The endpoint to be used for IVS real-time streaming using the RTMP protocol.</p>
|
|
585
|
+
* @public
|
|
586
|
+
*/
|
|
587
|
+
rtmp?: string;
|
|
588
|
+
/**
|
|
589
|
+
* <p>The endpoint to be used for IVS real-time streaming using the RTMPS protocol.</p>
|
|
590
|
+
* @public
|
|
591
|
+
*/
|
|
592
|
+
rtmps?: string;
|
|
438
593
|
}
|
|
439
594
|
/**
|
|
440
595
|
* <p>Object specifying a stage.</p>
|
|
@@ -458,10 +613,9 @@ export interface Stage {
|
|
|
458
613
|
activeSessionId?: string;
|
|
459
614
|
/**
|
|
460
615
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
461
|
-
*
|
|
462
|
-
*
|
|
463
|
-
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
464
|
-
* there.</p>
|
|
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>
|
|
617
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
618
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
465
619
|
* @public
|
|
466
620
|
*/
|
|
467
621
|
tags?: Record<string, string>;
|
|
@@ -520,8 +674,8 @@ export interface CreateStorageConfigurationRequest {
|
|
|
520
674
|
s3: S3StorageConfiguration | undefined;
|
|
521
675
|
/**
|
|
522
676
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
523
|
-
*
|
|
524
|
-
*
|
|
677
|
+
* (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>
|
|
678
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
525
679
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
526
680
|
* there.</p>
|
|
527
681
|
* @public
|
|
@@ -550,10 +704,9 @@ export interface StorageConfiguration {
|
|
|
550
704
|
s3?: S3StorageConfiguration;
|
|
551
705
|
/**
|
|
552
706
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
553
|
-
*
|
|
554
|
-
*
|
|
555
|
-
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
556
|
-
* there.</p>
|
|
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>
|
|
708
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
709
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
557
710
|
* @public
|
|
558
711
|
*/
|
|
559
712
|
tags?: Record<string, string>;
|
|
@@ -583,6 +736,26 @@ export interface DeleteEncoderConfigurationRequest {
|
|
|
583
736
|
*/
|
|
584
737
|
export interface DeleteEncoderConfigurationResponse {
|
|
585
738
|
}
|
|
739
|
+
/**
|
|
740
|
+
* @public
|
|
741
|
+
*/
|
|
742
|
+
export interface DeleteIngestConfigurationRequest {
|
|
743
|
+
/**
|
|
744
|
+
* <p>ARN of the IngestConfiguration.</p>
|
|
745
|
+
* @public
|
|
746
|
+
*/
|
|
747
|
+
arn: string | undefined;
|
|
748
|
+
/**
|
|
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
|
+
* @public
|
|
751
|
+
*/
|
|
752
|
+
force?: boolean;
|
|
753
|
+
}
|
|
754
|
+
/**
|
|
755
|
+
* @public
|
|
756
|
+
*/
|
|
757
|
+
export interface DeleteIngestConfigurationResponse {
|
|
758
|
+
}
|
|
586
759
|
/**
|
|
587
760
|
* @public
|
|
588
761
|
*/
|
|
@@ -638,8 +811,9 @@ export interface DisconnectParticipantRequest {
|
|
|
638
811
|
*/
|
|
639
812
|
stageArn: string | undefined;
|
|
640
813
|
/**
|
|
641
|
-
* <p>Identifier of the participant to be disconnected.
|
|
642
|
-
*
|
|
814
|
+
* <p>Identifier of the participant to be disconnected. IVS assigns this; it is returned
|
|
815
|
+
* by <a>CreateParticipantToken</a> (for streams using WebRTC ingest) or <a>CreateIngestConfiguration</a> (for
|
|
816
|
+
* streams using RTMP ingest).</p>
|
|
643
817
|
* @public
|
|
644
818
|
*/
|
|
645
819
|
participantId: string | undefined;
|
|
@@ -1050,10 +1224,9 @@ export interface Composition {
|
|
|
1050
1224
|
destinations: Destination[] | undefined;
|
|
1051
1225
|
/**
|
|
1052
1226
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1053
|
-
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/
|
|
1054
|
-
*
|
|
1055
|
-
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1056
|
-
* there.</p>
|
|
1227
|
+
* (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>
|
|
1228
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
1229
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
1057
1230
|
* @public
|
|
1058
1231
|
*/
|
|
1059
1232
|
tags?: Record<string, string>;
|
|
@@ -1100,6 +1273,26 @@ export interface GetEncoderConfigurationResponse {
|
|
|
1100
1273
|
*/
|
|
1101
1274
|
encoderConfiguration?: EncoderConfiguration;
|
|
1102
1275
|
}
|
|
1276
|
+
/**
|
|
1277
|
+
* @public
|
|
1278
|
+
*/
|
|
1279
|
+
export interface GetIngestConfigurationRequest {
|
|
1280
|
+
/**
|
|
1281
|
+
* <p>ARN of the ingest for which the information is to be retrieved.</p>
|
|
1282
|
+
* @public
|
|
1283
|
+
*/
|
|
1284
|
+
arn: string | undefined;
|
|
1285
|
+
}
|
|
1286
|
+
/**
|
|
1287
|
+
* @public
|
|
1288
|
+
*/
|
|
1289
|
+
export interface GetIngestConfigurationResponse {
|
|
1290
|
+
/**
|
|
1291
|
+
* <p>The IngestConfiguration that was returned.</p>
|
|
1292
|
+
* @public
|
|
1293
|
+
*/
|
|
1294
|
+
ingestConfiguration?: IngestConfiguration;
|
|
1295
|
+
}
|
|
1103
1296
|
/**
|
|
1104
1297
|
* @public
|
|
1105
1298
|
*/
|
|
@@ -1120,6 +1313,20 @@ export interface GetParticipantRequest {
|
|
|
1120
1313
|
*/
|
|
1121
1314
|
participantId: string | undefined;
|
|
1122
1315
|
}
|
|
1316
|
+
/**
|
|
1317
|
+
* @public
|
|
1318
|
+
* @enum
|
|
1319
|
+
*/
|
|
1320
|
+
export declare const ParticipantProtocol: {
|
|
1321
|
+
readonly RTMP: "RTMP";
|
|
1322
|
+
readonly RTMPS: "RTMPS";
|
|
1323
|
+
readonly UNKNOWN: "UNKNOWN";
|
|
1324
|
+
readonly WHIP: "WHIP";
|
|
1325
|
+
};
|
|
1326
|
+
/**
|
|
1327
|
+
* @public
|
|
1328
|
+
*/
|
|
1329
|
+
export type ParticipantProtocol = (typeof ParticipantProtocol)[keyof typeof ParticipantProtocol];
|
|
1123
1330
|
/**
|
|
1124
1331
|
* @public
|
|
1125
1332
|
* @enum
|
|
@@ -1235,6 +1442,11 @@ export interface Participant {
|
|
|
1235
1442
|
* @public
|
|
1236
1443
|
*/
|
|
1237
1444
|
recordingState?: ParticipantRecordingState;
|
|
1445
|
+
/**
|
|
1446
|
+
* <p>Type of ingest protocol that the participant employs for broadcasting.</p>
|
|
1447
|
+
* @public
|
|
1448
|
+
*/
|
|
1449
|
+
protocol?: ParticipantProtocol;
|
|
1238
1450
|
}
|
|
1239
1451
|
/**
|
|
1240
1452
|
* @public
|
|
@@ -1283,10 +1495,9 @@ export interface PublicKey {
|
|
|
1283
1495
|
fingerprint?: string;
|
|
1284
1496
|
/**
|
|
1285
1497
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1286
|
-
*
|
|
1287
|
-
*
|
|
1288
|
-
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1289
|
-
* there.</p>
|
|
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>
|
|
1499
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
1500
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
1290
1501
|
* @public
|
|
1291
1502
|
*/
|
|
1292
1503
|
tags?: Record<string, string>;
|
|
@@ -1407,8 +1618,8 @@ export interface ImportPublicKeyRequest {
|
|
|
1407
1618
|
name?: string;
|
|
1408
1619
|
/**
|
|
1409
1620
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1410
|
-
*
|
|
1411
|
-
*
|
|
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>
|
|
1622
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
1412
1623
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1413
1624
|
* there.</p>
|
|
1414
1625
|
* @public
|
|
@@ -1507,10 +1718,9 @@ export interface CompositionSummary {
|
|
|
1507
1718
|
state: CompositionState | undefined;
|
|
1508
1719
|
/**
|
|
1509
1720
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1510
|
-
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/
|
|
1511
|
-
*
|
|
1512
|
-
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1513
|
-
* there.</p>
|
|
1721
|
+
* (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>
|
|
1722
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
1723
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
1514
1724
|
* @public
|
|
1515
1725
|
*/
|
|
1516
1726
|
tags?: Record<string, string>;
|
|
@@ -1576,10 +1786,9 @@ export interface EncoderConfigurationSummary {
|
|
|
1576
1786
|
name?: string;
|
|
1577
1787
|
/**
|
|
1578
1788
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1579
|
-
*
|
|
1580
|
-
*
|
|
1581
|
-
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1582
|
-
* there.</p>
|
|
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>
|
|
1790
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
1791
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
1583
1792
|
* @public
|
|
1584
1793
|
*/
|
|
1585
1794
|
tags?: Record<string, string>;
|
|
@@ -1600,6 +1809,89 @@ export interface ListEncoderConfigurationsResponse {
|
|
|
1600
1809
|
*/
|
|
1601
1810
|
nextToken?: string;
|
|
1602
1811
|
}
|
|
1812
|
+
/**
|
|
1813
|
+
* @public
|
|
1814
|
+
*/
|
|
1815
|
+
export interface ListIngestConfigurationsRequest {
|
|
1816
|
+
/**
|
|
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
|
+
* @public
|
|
1819
|
+
*/
|
|
1820
|
+
filterByStageArn?: string;
|
|
1821
|
+
/**
|
|
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
|
+
* @public
|
|
1824
|
+
*/
|
|
1825
|
+
filterByState?: IngestConfigurationState;
|
|
1826
|
+
/**
|
|
1827
|
+
* <p>The first IngestConfiguration to retrieve. This is used for pagination; see the <code>nextToken</code> response field.</p>
|
|
1828
|
+
* @public
|
|
1829
|
+
*/
|
|
1830
|
+
nextToken?: string;
|
|
1831
|
+
/**
|
|
1832
|
+
* <p>Maximum number of results to return. Default: 50.</p>
|
|
1833
|
+
* @public
|
|
1834
|
+
*/
|
|
1835
|
+
maxResults?: number;
|
|
1836
|
+
}
|
|
1837
|
+
/**
|
|
1838
|
+
* <p>Summary information about an IngestConfiguration.</p>
|
|
1839
|
+
* @public
|
|
1840
|
+
*/
|
|
1841
|
+
export interface IngestConfigurationSummary {
|
|
1842
|
+
/**
|
|
1843
|
+
* <p>Ingest name.</p>
|
|
1844
|
+
* @public
|
|
1845
|
+
*/
|
|
1846
|
+
name?: string;
|
|
1847
|
+
/**
|
|
1848
|
+
* <p>Ingest configuration ARN.</p>
|
|
1849
|
+
* @public
|
|
1850
|
+
*/
|
|
1851
|
+
arn: string | undefined;
|
|
1852
|
+
/**
|
|
1853
|
+
* <p>Type of ingest protocol that the user employs for broadcasting.</p>
|
|
1854
|
+
* @public
|
|
1855
|
+
*/
|
|
1856
|
+
ingestProtocol: IngestProtocol | undefined;
|
|
1857
|
+
/**
|
|
1858
|
+
* <p>ARN of the stage with which the IngestConfiguration is associated.</p>
|
|
1859
|
+
* @public
|
|
1860
|
+
*/
|
|
1861
|
+
stageArn: string | undefined;
|
|
1862
|
+
/**
|
|
1863
|
+
* <p>ID of the participant within the stage.</p>
|
|
1864
|
+
* @public
|
|
1865
|
+
*/
|
|
1866
|
+
participantId: string | undefined;
|
|
1867
|
+
/**
|
|
1868
|
+
* <p>State of the ingest configuration. It is <code>ACTIVE</code> if a publisher currently is publishing to the stage associated with the ingest configuration.</p>
|
|
1869
|
+
* @public
|
|
1870
|
+
*/
|
|
1871
|
+
state: IngestConfigurationState | undefined;
|
|
1872
|
+
/**
|
|
1873
|
+
* <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.
|
|
1874
|
+
* <i>This field is exposed to all stage participants and should not be used for personally identifying, confidential, or sensitive information.</i>
|
|
1875
|
+
* </p>
|
|
1876
|
+
* @public
|
|
1877
|
+
*/
|
|
1878
|
+
userId?: string;
|
|
1879
|
+
}
|
|
1880
|
+
/**
|
|
1881
|
+
* @public
|
|
1882
|
+
*/
|
|
1883
|
+
export interface ListIngestConfigurationsResponse {
|
|
1884
|
+
/**
|
|
1885
|
+
* <p>List of the matching ingest configurations (summary information only).</p>
|
|
1886
|
+
* @public
|
|
1887
|
+
*/
|
|
1888
|
+
ingestConfigurations: IngestConfigurationSummary[] | undefined;
|
|
1889
|
+
/**
|
|
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
|
+
* @public
|
|
1892
|
+
*/
|
|
1893
|
+
nextToken?: string;
|
|
1894
|
+
}
|
|
1603
1895
|
/**
|
|
1604
1896
|
* @public
|
|
1605
1897
|
*/
|
|
@@ -1636,9 +1928,17 @@ export interface ListParticipantEventsRequest {
|
|
|
1636
1928
|
* @enum
|
|
1637
1929
|
*/
|
|
1638
1930
|
export declare const EventErrorCode: {
|
|
1931
|
+
readonly BITRATE_EXCEEDED: "BITRATE_EXCEEDED";
|
|
1639
1932
|
readonly INSUFFICIENT_CAPABILITIES: "INSUFFICIENT_CAPABILITIES";
|
|
1933
|
+
readonly INVALID_AUDIO_CODEC: "INVALID_AUDIO_CODEC";
|
|
1934
|
+
readonly INVALID_PROTOCOL: "INVALID_PROTOCOL";
|
|
1935
|
+
readonly INVALID_STREAM_KEY: "INVALID_STREAM_KEY";
|
|
1936
|
+
readonly INVALID_VIDEO_CODEC: "INVALID_VIDEO_CODEC";
|
|
1640
1937
|
readonly PUBLISHER_NOT_FOUND: "PUBLISHER_NOT_FOUND";
|
|
1641
1938
|
readonly QUOTA_EXCEEDED: "QUOTA_EXCEEDED";
|
|
1939
|
+
readonly RESOLUTION_EXCEEDED: "RESOLUTION_EXCEEDED";
|
|
1940
|
+
readonly REUSE_OF_STREAM_KEY: "REUSE_OF_STREAM_KEY";
|
|
1941
|
+
readonly STREAM_DURATION_EXCEEDED: "STREAM_DURATION_EXCEEDED";
|
|
1642
1942
|
};
|
|
1643
1943
|
/**
|
|
1644
1944
|
* @public
|
|
@@ -1880,10 +2180,9 @@ export interface PublicKeySummary {
|
|
|
1880
2180
|
name?: string;
|
|
1881
2181
|
/**
|
|
1882
2182
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1883
|
-
*
|
|
1884
|
-
*
|
|
1885
|
-
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1886
|
-
* there.</p>
|
|
2183
|
+
* (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>
|
|
2184
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
2185
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
1887
2186
|
* @public
|
|
1888
2187
|
*/
|
|
1889
2188
|
tags?: Record<string, string>;
|
|
@@ -1941,10 +2240,9 @@ export interface StageSummary {
|
|
|
1941
2240
|
activeSessionId?: string;
|
|
1942
2241
|
/**
|
|
1943
2242
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
1944
|
-
*
|
|
1945
|
-
*
|
|
1946
|
-
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
1947
|
-
* there.</p>
|
|
2243
|
+
* (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>
|
|
2244
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
2245
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
1948
2246
|
* @public
|
|
1949
2247
|
*/
|
|
1950
2248
|
tags?: Record<string, string>;
|
|
@@ -2063,10 +2361,9 @@ export interface StorageConfigurationSummary {
|
|
|
2063
2361
|
s3?: S3StorageConfiguration;
|
|
2064
2362
|
/**
|
|
2065
2363
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
2066
|
-
*
|
|
2067
|
-
*
|
|
2068
|
-
*
|
|
2069
|
-
* there.</p>
|
|
2364
|
+
* (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>
|
|
2365
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
2366
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented there.</p>
|
|
2070
2367
|
* @public
|
|
2071
2368
|
*/
|
|
2072
2369
|
tags?: Record<string, string>;
|
|
@@ -2134,8 +2431,8 @@ export interface StartCompositionRequest {
|
|
|
2134
2431
|
destinations: DestinationConfiguration[] | undefined;
|
|
2135
2432
|
/**
|
|
2136
2433
|
* <p>Tags attached to the resource. Array of maps, each of the form <code>string:string
|
|
2137
|
-
*
|
|
2138
|
-
*
|
|
2434
|
+
* (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>
|
|
2435
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
2139
2436
|
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
2140
2437
|
* there.</p>
|
|
2141
2438
|
* @public
|
|
@@ -2178,9 +2475,9 @@ export interface TagResourceRequest {
|
|
|
2178
2475
|
resourceArn: string | undefined;
|
|
2179
2476
|
/**
|
|
2180
2477
|
* <p>Array of tags to be added or updated. Array of maps, each of the form
|
|
2181
|
-
*
|
|
2182
|
-
*
|
|
2183
|
-
* limits and requirements"; Amazon IVS has no constraints beyond what is documented
|
|
2478
|
+
* <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>
|
|
2479
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
2480
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
2184
2481
|
* there.</p>
|
|
2185
2482
|
* @public
|
|
2186
2483
|
*/
|
|
@@ -2202,9 +2499,9 @@ export interface UntagResourceRequest {
|
|
|
2202
2499
|
resourceArn: string | undefined;
|
|
2203
2500
|
/**
|
|
2204
2501
|
* <p>Array of tags to be removed. Array of maps, each of the form <code>string:string
|
|
2205
|
-
*
|
|
2206
|
-
*
|
|
2207
|
-
* limits and requirements"; Amazon IVS has no constraints beyond what is documented
|
|
2502
|
+
* (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>
|
|
2503
|
+
* in <i>Tagging AWS Resources and Tag Editor</i> for details, including restrictions that apply to tags and "Tag naming
|
|
2504
|
+
* limits and requirements"; Amazon IVS has no constraints on tags beyond what is documented
|
|
2208
2505
|
* there.</p>
|
|
2209
2506
|
* @public
|
|
2210
2507
|
*/
|
|
@@ -2215,6 +2512,31 @@ export interface UntagResourceRequest {
|
|
|
2215
2512
|
*/
|
|
2216
2513
|
export interface UntagResourceResponse {
|
|
2217
2514
|
}
|
|
2515
|
+
/**
|
|
2516
|
+
* @public
|
|
2517
|
+
*/
|
|
2518
|
+
export interface UpdateIngestConfigurationRequest {
|
|
2519
|
+
/**
|
|
2520
|
+
* <p>ARN of the IngestConfiguration, for which the related stage ARN needs to be updated.</p>
|
|
2521
|
+
* @public
|
|
2522
|
+
*/
|
|
2523
|
+
arn: string | undefined;
|
|
2524
|
+
/**
|
|
2525
|
+
* <p>Stage ARN that needs to be updated.</p>
|
|
2526
|
+
* @public
|
|
2527
|
+
*/
|
|
2528
|
+
stageArn?: string;
|
|
2529
|
+
}
|
|
2530
|
+
/**
|
|
2531
|
+
* @public
|
|
2532
|
+
*/
|
|
2533
|
+
export interface UpdateIngestConfigurationResponse {
|
|
2534
|
+
/**
|
|
2535
|
+
* <p>The updated IngestConfiguration.</p>
|
|
2536
|
+
* @public
|
|
2537
|
+
*/
|
|
2538
|
+
ingestConfiguration?: IngestConfiguration;
|
|
2539
|
+
}
|
|
2218
2540
|
/**
|
|
2219
2541
|
* @public
|
|
2220
2542
|
*/
|
|
@@ -2245,6 +2567,14 @@ export interface UpdateStageResponse {
|
|
|
2245
2567
|
*/
|
|
2246
2568
|
stage?: Stage;
|
|
2247
2569
|
}
|
|
2570
|
+
/**
|
|
2571
|
+
* @internal
|
|
2572
|
+
*/
|
|
2573
|
+
export declare const IngestConfigurationFilterSensitiveLog: (obj: IngestConfiguration) => any;
|
|
2574
|
+
/**
|
|
2575
|
+
* @internal
|
|
2576
|
+
*/
|
|
2577
|
+
export declare const CreateIngestConfigurationResponseFilterSensitiveLog: (obj: CreateIngestConfigurationResponse) => any;
|
|
2248
2578
|
/**
|
|
2249
2579
|
* @internal
|
|
2250
2580
|
*/
|
|
@@ -2257,3 +2587,11 @@ export declare const CreateParticipantTokenResponseFilterSensitiveLog: (obj: Cre
|
|
|
2257
2587
|
* @internal
|
|
2258
2588
|
*/
|
|
2259
2589
|
export declare const CreateStageResponseFilterSensitiveLog: (obj: CreateStageResponse) => any;
|
|
2590
|
+
/**
|
|
2591
|
+
* @internal
|
|
2592
|
+
*/
|
|
2593
|
+
export declare const GetIngestConfigurationResponseFilterSensitiveLog: (obj: GetIngestConfigurationResponse) => any;
|
|
2594
|
+
/**
|
|
2595
|
+
* @internal
|
|
2596
|
+
*/
|
|
2597
|
+
export declare const UpdateIngestConfigurationResponseFilterSensitiveLog: (obj: UpdateIngestConfigurationResponse) => any;
|