@aws-sdk/client-ivs 3.504.0 → 3.505.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 +148 -72
- package/dist-cjs/commands/CreatePlaybackRestrictionPolicyCommand.js +1 -0
- package/dist-cjs/commands/DeletePlaybackRestrictionPolicyCommand.js +1 -0
- package/dist-cjs/commands/GetPlaybackRestrictionPolicyCommand.js +1 -0
- package/dist-cjs/commands/ListPlaybackRestrictionPoliciesCommand.js +1 -0
- package/dist-cjs/commands/UpdatePlaybackRestrictionPolicyCommand.js +1 -0
- package/dist-cjs/index.js +410 -1
- package/dist-cjs/pagination/ListPlaybackRestrictionPoliciesPaginator.js +1 -0
- package/dist-es/Ivs.js +10 -0
- package/dist-es/commands/CreatePlaybackRestrictionPolicyCommand.js +24 -0
- package/dist-es/commands/DeletePlaybackRestrictionPolicyCommand.js +24 -0
- package/dist-es/commands/GetPlaybackRestrictionPolicyCommand.js +24 -0
- package/dist-es/commands/ListPlaybackRestrictionPoliciesCommand.js +24 -0
- package/dist-es/commands/UpdatePlaybackRestrictionPolicyCommand.js +24 -0
- package/dist-es/commands/index.js +5 -0
- package/dist-es/pagination/ListPlaybackRestrictionPoliciesPaginator.js +4 -0
- package/dist-es/pagination/index.js +1 -0
- package/dist-es/protocols/Aws_restJson1.js +293 -0
- package/dist-types/Ivs.d.ts +143 -72
- package/dist-types/IvsClient.d.ts +115 -74
- package/dist-types/commands/BatchGetChannelCommand.d.ts +1 -0
- package/dist-types/commands/CreateChannelCommand.d.ts +2 -0
- package/dist-types/commands/CreatePlaybackRestrictionPolicyCommand.d.ts +97 -0
- package/dist-types/commands/DeletePlaybackRestrictionPolicyCommand.d.ts +71 -0
- package/dist-types/commands/GetChannelCommand.d.ts +1 -0
- package/dist-types/commands/GetPlaybackRestrictionPolicyCommand.d.ts +83 -0
- package/dist-types/commands/GetStreamSessionCommand.d.ts +1 -0
- package/dist-types/commands/ListChannelsCommand.d.ts +2 -0
- package/dist-types/commands/ListPlaybackRestrictionPoliciesCommand.d.ts +87 -0
- package/dist-types/commands/UpdateChannelCommand.d.ts +2 -0
- package/dist-types/commands/UpdatePlaybackRestrictionPolicyCommand.d.ts +94 -0
- package/dist-types/commands/index.d.ts +5 -0
- package/dist-types/index.d.ts +108 -72
- package/dist-types/models/models_0.d.ts +290 -16
- package/dist-types/pagination/ListPlaybackRestrictionPoliciesPaginator.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/ts3.4/Ivs.d.ts +85 -0
- package/dist-types/ts3.4/IvsClient.d.ts +32 -2
- package/dist-types/ts3.4/commands/CreatePlaybackRestrictionPolicyCommand.d.ts +30 -0
- package/dist-types/ts3.4/commands/DeletePlaybackRestrictionPolicyCommand.d.ts +26 -0
- package/dist-types/ts3.4/commands/GetPlaybackRestrictionPolicyCommand.d.ts +30 -0
- package/dist-types/ts3.4/commands/ListPlaybackRestrictionPoliciesCommand.d.ts +30 -0
- package/dist-types/ts3.4/commands/UpdatePlaybackRestrictionPolicyCommand.d.ts +30 -0
- package/dist-types/ts3.4/commands/index.d.ts +5 -0
- package/dist-types/ts3.4/models/models_0.d.ts +58 -0
- package/dist-types/ts3.4/pagination/ListPlaybackRestrictionPoliciesPaginator.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/package.json +1 -1
|
@@ -91,14 +91,15 @@ export interface Channel {
|
|
|
91
91
|
/**
|
|
92
92
|
* @public
|
|
93
93
|
* <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
|
|
94
|
-
*
|
|
95
|
-
*
|
|
94
|
+
* exceed the allowable input resolution or bitrate, the stream probably will disconnect
|
|
95
|
+
* immediately.</i> Default: <code>STANDARD</code>. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html">Channel
|
|
96
|
+
* Types</a>.</p>
|
|
96
97
|
*/
|
|
97
98
|
type?: ChannelType;
|
|
98
99
|
/**
|
|
99
100
|
* @public
|
|
100
|
-
* <p>Recording-configuration ARN. A value
|
|
101
|
-
*
|
|
101
|
+
* <p>Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording.
|
|
102
|
+
* Default: "" (empty string, recording is disabled).</p>
|
|
102
103
|
*/
|
|
103
104
|
recordingConfigurationArn?: string;
|
|
104
105
|
/**
|
|
@@ -140,6 +141,11 @@ export interface Channel {
|
|
|
140
141
|
* string (<code>""</code>).</p>
|
|
141
142
|
*/
|
|
142
143
|
preset?: TranscodePreset;
|
|
144
|
+
/**
|
|
145
|
+
* @public
|
|
146
|
+
* <p>Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction. Default: "" (empty string, no playback restriction policy is applied).</p>
|
|
147
|
+
*/
|
|
148
|
+
playbackRestrictionPolicyArn?: string;
|
|
143
149
|
}
|
|
144
150
|
/**
|
|
145
151
|
* @public
|
|
@@ -374,7 +380,8 @@ export interface CreateChannelRequest {
|
|
|
374
380
|
* @public
|
|
375
381
|
* <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
|
|
376
382
|
* exceed the allowable input resolution or bitrate, the stream probably will disconnect
|
|
377
|
-
* immediately.</i> Default: <code>STANDARD</code>. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html">Channel
|
|
383
|
+
* immediately.</i> Default: <code>STANDARD</code>. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html">Channel
|
|
384
|
+
* Types</a>.</p>
|
|
378
385
|
*/
|
|
379
386
|
type?: ChannelType;
|
|
380
387
|
/**
|
|
@@ -385,7 +392,8 @@ export interface CreateChannelRequest {
|
|
|
385
392
|
authorized?: boolean;
|
|
386
393
|
/**
|
|
387
394
|
* @public
|
|
388
|
-
* <p>Recording-configuration ARN.
|
|
395
|
+
* <p>Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording.
|
|
396
|
+
* Default: "" (empty string, recording is disabled).</p>
|
|
389
397
|
*/
|
|
390
398
|
recordingConfigurationArn?: string;
|
|
391
399
|
/**
|
|
@@ -410,6 +418,12 @@ export interface CreateChannelRequest {
|
|
|
410
418
|
* string (<code>""</code>).</p>
|
|
411
419
|
*/
|
|
412
420
|
preset?: TranscodePreset;
|
|
421
|
+
/**
|
|
422
|
+
* @public
|
|
423
|
+
* <p>Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction.
|
|
424
|
+
* Default: "" (empty string, no playback restriction policy is applied).</p>
|
|
425
|
+
*/
|
|
426
|
+
playbackRestrictionPolicyArn?: string;
|
|
413
427
|
}
|
|
414
428
|
/**
|
|
415
429
|
* @public
|
|
@@ -460,6 +474,97 @@ export declare class ServiceQuotaExceededException extends __BaseException {
|
|
|
460
474
|
*/
|
|
461
475
|
constructor(opts: __ExceptionOptionType<ServiceQuotaExceededException, __BaseException>);
|
|
462
476
|
}
|
|
477
|
+
/**
|
|
478
|
+
* @public
|
|
479
|
+
*/
|
|
480
|
+
export interface CreatePlaybackRestrictionPolicyRequest {
|
|
481
|
+
/**
|
|
482
|
+
* @public
|
|
483
|
+
* <p>A list of country codes that control geoblocking restriction. Allowed values are the
|
|
484
|
+
* officially assigned <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1
|
|
485
|
+
* alpha-2</a> codes. Default: All countries (an empty array).</p>
|
|
486
|
+
*/
|
|
487
|
+
allowedCountries?: string[];
|
|
488
|
+
/**
|
|
489
|
+
* @public
|
|
490
|
+
* <p>A list of origin sites that control CORS restriction. Allowed values are the same as valid
|
|
491
|
+
* values of the Origin header defined at <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin">https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin</a>. Default: All
|
|
492
|
+
* origins (an empty array).</p>
|
|
493
|
+
*/
|
|
494
|
+
allowedOrigins?: string[];
|
|
495
|
+
/**
|
|
496
|
+
* @public
|
|
497
|
+
* <p>Whether channel playback is constrained by origin site. Default:
|
|
498
|
+
* <code>false</code>.</p>
|
|
499
|
+
*/
|
|
500
|
+
enableStrictOriginEnforcement?: boolean;
|
|
501
|
+
/**
|
|
502
|
+
* @public
|
|
503
|
+
* <p>Playback-restriction-policy name. The value does not need to be unique.</p>
|
|
504
|
+
*/
|
|
505
|
+
name?: string;
|
|
506
|
+
/**
|
|
507
|
+
* @public
|
|
508
|
+
* <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services
|
|
509
|
+
* Resources</a> for more information, including restrictions that apply to tags and "Tag
|
|
510
|
+
* naming limits and requirements"; Amazon IVS has no service-specific constraints beyond what is
|
|
511
|
+
* documented there.</p>
|
|
512
|
+
*/
|
|
513
|
+
tags?: Record<string, string>;
|
|
514
|
+
}
|
|
515
|
+
/**
|
|
516
|
+
* @public
|
|
517
|
+
* <p>An object representing a policy to constrain playback by country and/or origin
|
|
518
|
+
* sites.</p>
|
|
519
|
+
*/
|
|
520
|
+
export interface PlaybackRestrictionPolicy {
|
|
521
|
+
/**
|
|
522
|
+
* @public
|
|
523
|
+
* <p>Playback-restriction-policy ARN</p>
|
|
524
|
+
*/
|
|
525
|
+
arn: string | undefined;
|
|
526
|
+
/**
|
|
527
|
+
* @public
|
|
528
|
+
* <p>A list of country codes that control geoblocking restriction. Allowed values are the
|
|
529
|
+
* officially assigned <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1 alpha-2</a> codes. Default: All countries (an empty array).</p>
|
|
530
|
+
*/
|
|
531
|
+
allowedCountries: string[] | undefined;
|
|
532
|
+
/**
|
|
533
|
+
* @public
|
|
534
|
+
* <p>A list of origin sites that control CORS restriction. Allowed values are the same as valid
|
|
535
|
+
* values of the Origin header defined at <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin">https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin</a>. Default: All origins (an empty array).</p>
|
|
536
|
+
*/
|
|
537
|
+
allowedOrigins: string[] | undefined;
|
|
538
|
+
/**
|
|
539
|
+
* @public
|
|
540
|
+
* <p>Whether channel playback is constrained by origin site. Default:
|
|
541
|
+
* <code>false</code>.</p>
|
|
542
|
+
*/
|
|
543
|
+
enableStrictOriginEnforcement?: boolean;
|
|
544
|
+
/**
|
|
545
|
+
* @public
|
|
546
|
+
* <p>Playback-restriction-policy name. The value does not need to be unique.</p>
|
|
547
|
+
*/
|
|
548
|
+
name?: string;
|
|
549
|
+
/**
|
|
550
|
+
* @public
|
|
551
|
+
* <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
|
|
552
|
+
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions
|
|
553
|
+
* that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
|
|
554
|
+
* service-specific constraints beyond what is documented there.</p>
|
|
555
|
+
*/
|
|
556
|
+
tags?: Record<string, string>;
|
|
557
|
+
}
|
|
558
|
+
/**
|
|
559
|
+
* @public
|
|
560
|
+
*/
|
|
561
|
+
export interface CreatePlaybackRestrictionPolicyResponse {
|
|
562
|
+
/**
|
|
563
|
+
* @public
|
|
564
|
+
* <p/>
|
|
565
|
+
*/
|
|
566
|
+
playbackRestrictionPolicy?: PlaybackRestrictionPolicy;
|
|
567
|
+
}
|
|
463
568
|
/**
|
|
464
569
|
* @public
|
|
465
570
|
* <p/>
|
|
@@ -818,6 +923,16 @@ export interface DeletePlaybackKeyPairRequest {
|
|
|
818
923
|
*/
|
|
819
924
|
export interface DeletePlaybackKeyPairResponse {
|
|
820
925
|
}
|
|
926
|
+
/**
|
|
927
|
+
* @public
|
|
928
|
+
*/
|
|
929
|
+
export interface DeletePlaybackRestrictionPolicyRequest {
|
|
930
|
+
/**
|
|
931
|
+
* @public
|
|
932
|
+
* <p>ARN of the playback restriction policy to be deleted.</p>
|
|
933
|
+
*/
|
|
934
|
+
arn: string | undefined;
|
|
935
|
+
}
|
|
821
936
|
/**
|
|
822
937
|
* @public
|
|
823
938
|
*/
|
|
@@ -907,6 +1022,26 @@ export interface GetPlaybackKeyPairResponse {
|
|
|
907
1022
|
*/
|
|
908
1023
|
keyPair?: PlaybackKeyPair;
|
|
909
1024
|
}
|
|
1025
|
+
/**
|
|
1026
|
+
* @public
|
|
1027
|
+
*/
|
|
1028
|
+
export interface GetPlaybackRestrictionPolicyRequest {
|
|
1029
|
+
/**
|
|
1030
|
+
* @public
|
|
1031
|
+
* <p>ARN of the playback restriction policy to be returned.</p>
|
|
1032
|
+
*/
|
|
1033
|
+
arn: string | undefined;
|
|
1034
|
+
}
|
|
1035
|
+
/**
|
|
1036
|
+
* @public
|
|
1037
|
+
*/
|
|
1038
|
+
export interface GetPlaybackRestrictionPolicyResponse {
|
|
1039
|
+
/**
|
|
1040
|
+
* @public
|
|
1041
|
+
* <p/>
|
|
1042
|
+
*/
|
|
1043
|
+
playbackRestrictionPolicy?: PlaybackRestrictionPolicy;
|
|
1044
|
+
}
|
|
910
1045
|
/**
|
|
911
1046
|
* @public
|
|
912
1047
|
*/
|
|
@@ -1295,6 +1430,11 @@ export interface ListChannelsRequest {
|
|
|
1295
1430
|
* <p>Filters the channel list to match the specified recording-configuration ARN.</p>
|
|
1296
1431
|
*/
|
|
1297
1432
|
filterByRecordingConfigurationArn?: string;
|
|
1433
|
+
/**
|
|
1434
|
+
* @public
|
|
1435
|
+
* <p>Filters the channel list to match the specified policy.</p>
|
|
1436
|
+
*/
|
|
1437
|
+
filterByPlaybackRestrictionPolicyArn?: string;
|
|
1298
1438
|
/**
|
|
1299
1439
|
* @public
|
|
1300
1440
|
* <p>The first channel to retrieve. This is used for pagination; see the <code>nextToken</code>
|
|
@@ -1338,8 +1478,8 @@ export interface ChannelSummary {
|
|
|
1338
1478
|
authorized?: boolean;
|
|
1339
1479
|
/**
|
|
1340
1480
|
* @public
|
|
1341
|
-
* <p>Recording-configuration ARN. A value
|
|
1342
|
-
*
|
|
1481
|
+
* <p>Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording.
|
|
1482
|
+
* Default: "" (empty string, recording is disabled).</p>
|
|
1343
1483
|
*/
|
|
1344
1484
|
recordingConfigurationArn?: string;
|
|
1345
1485
|
/**
|
|
@@ -1358,8 +1498,9 @@ export interface ChannelSummary {
|
|
|
1358
1498
|
/**
|
|
1359
1499
|
* @public
|
|
1360
1500
|
* <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
|
|
1361
|
-
*
|
|
1362
|
-
*
|
|
1501
|
+
* exceed the allowable input resolution or bitrate, the stream probably will disconnect
|
|
1502
|
+
* immediately.</i> Default: <code>STANDARD</code>. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html">Channel
|
|
1503
|
+
* Types</a>.</p>
|
|
1363
1504
|
*/
|
|
1364
1505
|
type?: ChannelType;
|
|
1365
1506
|
/**
|
|
@@ -1371,6 +1512,12 @@ export interface ChannelSummary {
|
|
|
1371
1512
|
* string (<code>""</code>).</p>
|
|
1372
1513
|
*/
|
|
1373
1514
|
preset?: TranscodePreset;
|
|
1515
|
+
/**
|
|
1516
|
+
* @public
|
|
1517
|
+
* <p>Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction.
|
|
1518
|
+
* Default: "" (empty string, no playback restriction policy is applied).</p>
|
|
1519
|
+
*/
|
|
1520
|
+
playbackRestrictionPolicyArn?: string;
|
|
1374
1521
|
}
|
|
1375
1522
|
/**
|
|
1376
1523
|
* @public
|
|
@@ -1445,6 +1592,81 @@ export interface ListPlaybackKeyPairsResponse {
|
|
|
1445
1592
|
*/
|
|
1446
1593
|
nextToken?: string;
|
|
1447
1594
|
}
|
|
1595
|
+
/**
|
|
1596
|
+
* @public
|
|
1597
|
+
*/
|
|
1598
|
+
export interface ListPlaybackRestrictionPoliciesRequest {
|
|
1599
|
+
/**
|
|
1600
|
+
* @public
|
|
1601
|
+
* <p>The first policy to retrieve. This is used for pagination; see the <code>nextToken</code>
|
|
1602
|
+
* response field.</p>
|
|
1603
|
+
*/
|
|
1604
|
+
nextToken?: string;
|
|
1605
|
+
/**
|
|
1606
|
+
* @public
|
|
1607
|
+
* <p>Maximum number of policies to return. Default: 1.</p>
|
|
1608
|
+
*/
|
|
1609
|
+
maxResults?: number;
|
|
1610
|
+
}
|
|
1611
|
+
/**
|
|
1612
|
+
* @public
|
|
1613
|
+
* <p>Summary information about a PlaybackRestrictionPolicy.</p>
|
|
1614
|
+
*/
|
|
1615
|
+
export interface PlaybackRestrictionPolicySummary {
|
|
1616
|
+
/**
|
|
1617
|
+
* @public
|
|
1618
|
+
* <p>Playback-restriction-policy ARN</p>
|
|
1619
|
+
*/
|
|
1620
|
+
arn: string | undefined;
|
|
1621
|
+
/**
|
|
1622
|
+
* @public
|
|
1623
|
+
* <p>A list of country codes that control geoblocking restriction. Allowed values are the
|
|
1624
|
+
* officially assigned <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1
|
|
1625
|
+
* alpha-2</a> codes. Default: All countries (an empty array).</p>
|
|
1626
|
+
*/
|
|
1627
|
+
allowedCountries: string[] | undefined;
|
|
1628
|
+
/**
|
|
1629
|
+
* @public
|
|
1630
|
+
* <p>A list of origin sites that control CORS restriction. Allowed values are the same as valid
|
|
1631
|
+
* values of the Origin header defined at <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin">https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin</a>. Default: All origins (an empty array).</p>
|
|
1632
|
+
*/
|
|
1633
|
+
allowedOrigins: string[] | undefined;
|
|
1634
|
+
/**
|
|
1635
|
+
* @public
|
|
1636
|
+
* <p>Whether channel playback is constrained by origin site. Default:
|
|
1637
|
+
* <code>false</code>.</p>
|
|
1638
|
+
*/
|
|
1639
|
+
enableStrictOriginEnforcement?: boolean;
|
|
1640
|
+
/**
|
|
1641
|
+
* @public
|
|
1642
|
+
* <p>Playback-restriction-policy name. The value does not need to be unique.</p>
|
|
1643
|
+
*/
|
|
1644
|
+
name?: string;
|
|
1645
|
+
/**
|
|
1646
|
+
* @public
|
|
1647
|
+
* <p>Tags attached to the resource. Array of 1-50 maps, each of the form <code>string:string
|
|
1648
|
+
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions
|
|
1649
|
+
* that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
|
|
1650
|
+
* service-specific constraints beyond what is documented there.</p>
|
|
1651
|
+
*/
|
|
1652
|
+
tags?: Record<string, string>;
|
|
1653
|
+
}
|
|
1654
|
+
/**
|
|
1655
|
+
* @public
|
|
1656
|
+
*/
|
|
1657
|
+
export interface ListPlaybackRestrictionPoliciesResponse {
|
|
1658
|
+
/**
|
|
1659
|
+
* @public
|
|
1660
|
+
* <p>List of the matching policies.</p>
|
|
1661
|
+
*/
|
|
1662
|
+
playbackRestrictionPolicies: PlaybackRestrictionPolicySummary[] | undefined;
|
|
1663
|
+
/**
|
|
1664
|
+
* @public
|
|
1665
|
+
* <p>If there are more channels than <code>maxResults</code>, use <code>nextToken</code> in the
|
|
1666
|
+
* request to get the next set.</p>
|
|
1667
|
+
*/
|
|
1668
|
+
nextToken?: string;
|
|
1669
|
+
}
|
|
1448
1670
|
/**
|
|
1449
1671
|
* @public
|
|
1450
1672
|
*/
|
|
@@ -1860,7 +2082,7 @@ export interface UntagResourceRequest {
|
|
|
1860
2082
|
resourceArn: string | undefined;
|
|
1861
2083
|
/**
|
|
1862
2084
|
* @public
|
|
1863
|
-
* <p>Array of tags to be removed. Array of maps, each of the form
|
|
2085
|
+
* <p>Array of tags to be removed. Array of maps, each of the form <code>string:string
|
|
1864
2086
|
* (key:value)</code>. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging Amazon Web Services Resources</a> for more information, including restrictions
|
|
1865
2087
|
* that apply to tags and "Tag naming limits and requirements"; Amazon IVS has no
|
|
1866
2088
|
* service-specific constraints beyond what is documented there.</p>
|
|
@@ -1897,8 +2119,9 @@ export interface UpdateChannelRequest {
|
|
|
1897
2119
|
/**
|
|
1898
2120
|
* @public
|
|
1899
2121
|
* <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
|
|
1900
|
-
*
|
|
1901
|
-
*
|
|
2122
|
+
* exceed the allowable input resolution or bitrate, the stream probably will disconnect
|
|
2123
|
+
* immediately.</i> Default: <code>STANDARD</code>. For details, see <a href="https://docs.aws.amazon.com/ivs/latest/LowLatencyAPIReference/channel-types.html">Channel
|
|
2124
|
+
* Types</a>.</p>
|
|
1902
2125
|
*/
|
|
1903
2126
|
type?: ChannelType;
|
|
1904
2127
|
/**
|
|
@@ -1908,8 +2131,8 @@ export interface UpdateChannelRequest {
|
|
|
1908
2131
|
authorized?: boolean;
|
|
1909
2132
|
/**
|
|
1910
2133
|
* @public
|
|
1911
|
-
* <p>Recording-configuration ARN.
|
|
1912
|
-
*
|
|
2134
|
+
* <p>Recording-configuration ARN. A valid ARN value here both specifies the ARN and enables recording.
|
|
2135
|
+
* If this is set to an empty string, recording is disabled.</p>
|
|
1913
2136
|
*/
|
|
1914
2137
|
recordingConfigurationArn?: string;
|
|
1915
2138
|
/**
|
|
@@ -1926,6 +2149,12 @@ export interface UpdateChannelRequest {
|
|
|
1926
2149
|
* string (<code>""</code>).</p>
|
|
1927
2150
|
*/
|
|
1928
2151
|
preset?: TranscodePreset;
|
|
2152
|
+
/**
|
|
2153
|
+
* @public
|
|
2154
|
+
* <p>Playback-restriction-policy ARN. A valid ARN value here both specifies the ARN and enables playback restriction.
|
|
2155
|
+
* If this is set to an empty string, playback restriction policy is disabled.</p>
|
|
2156
|
+
*/
|
|
2157
|
+
playbackRestrictionPolicyArn?: string;
|
|
1929
2158
|
}
|
|
1930
2159
|
/**
|
|
1931
2160
|
* @public
|
|
@@ -1933,10 +2162,55 @@ export interface UpdateChannelRequest {
|
|
|
1933
2162
|
export interface UpdateChannelResponse {
|
|
1934
2163
|
/**
|
|
1935
2164
|
* @public
|
|
1936
|
-
* <p>Object specifying
|
|
2165
|
+
* <p>Object specifying the updated channel.</p>
|
|
1937
2166
|
*/
|
|
1938
2167
|
channel?: Channel;
|
|
1939
2168
|
}
|
|
2169
|
+
/**
|
|
2170
|
+
* @public
|
|
2171
|
+
*/
|
|
2172
|
+
export interface UpdatePlaybackRestrictionPolicyRequest {
|
|
2173
|
+
/**
|
|
2174
|
+
* @public
|
|
2175
|
+
* <p>ARN of the playback-restriction-policy to be updated.</p>
|
|
2176
|
+
*/
|
|
2177
|
+
arn: string | undefined;
|
|
2178
|
+
/**
|
|
2179
|
+
* @public
|
|
2180
|
+
* <p>A list of country codes that control geoblocking restriction. Allowed values are the
|
|
2181
|
+
* officially assigned <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2">ISO 3166-1
|
|
2182
|
+
* alpha-2</a> codes. Default: All countries (an empty array).</p>
|
|
2183
|
+
*/
|
|
2184
|
+
allowedCountries?: string[];
|
|
2185
|
+
/**
|
|
2186
|
+
* @public
|
|
2187
|
+
* <p>A list of origin sites that control CORS restriction. Allowed values are the same as valid
|
|
2188
|
+
* values of the Origin header defined at <a href="https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin">https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Origin</a>. Default: All
|
|
2189
|
+
* origins (an empty array).</p>
|
|
2190
|
+
*/
|
|
2191
|
+
allowedOrigins?: string[];
|
|
2192
|
+
/**
|
|
2193
|
+
* @public
|
|
2194
|
+
* <p>Whether channel playback is constrained by origin site. Default:
|
|
2195
|
+
* <code>false</code>.</p>
|
|
2196
|
+
*/
|
|
2197
|
+
enableStrictOriginEnforcement?: boolean;
|
|
2198
|
+
/**
|
|
2199
|
+
* @public
|
|
2200
|
+
* <p>Playback-restriction-policy name. The value does not need to be unique.</p>
|
|
2201
|
+
*/
|
|
2202
|
+
name?: string;
|
|
2203
|
+
}
|
|
2204
|
+
/**
|
|
2205
|
+
* @public
|
|
2206
|
+
*/
|
|
2207
|
+
export interface UpdatePlaybackRestrictionPolicyResponse {
|
|
2208
|
+
/**
|
|
2209
|
+
* @public
|
|
2210
|
+
* <p>Object specifying the updated policy.</p>
|
|
2211
|
+
*/
|
|
2212
|
+
playbackRestrictionPolicy?: PlaybackRestrictionPolicy;
|
|
2213
|
+
}
|
|
1940
2214
|
/**
|
|
1941
2215
|
* @internal
|
|
1942
2216
|
*/
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
import { Paginator } from "@smithy/types";
|
|
2
|
+
import { ListPlaybackRestrictionPoliciesCommandInput, ListPlaybackRestrictionPoliciesCommandOutput } from "../commands/ListPlaybackRestrictionPoliciesCommand";
|
|
3
|
+
import { IvsPaginationConfiguration } from "./Interfaces";
|
|
4
|
+
/**
|
|
5
|
+
* @public
|
|
6
|
+
*/
|
|
7
|
+
export declare const paginateListPlaybackRestrictionPolicies: (config: IvsPaginationConfiguration, input: ListPlaybackRestrictionPoliciesCommandInput, ...rest: any[]) => Paginator<ListPlaybackRestrictionPoliciesCommandOutput>;
|
|
@@ -1,6 +1,7 @@
|
|
|
1
1
|
export * from "./Interfaces";
|
|
2
2
|
export * from "./ListChannelsPaginator";
|
|
3
3
|
export * from "./ListPlaybackKeyPairsPaginator";
|
|
4
|
+
export * from "./ListPlaybackRestrictionPoliciesPaginator";
|
|
4
5
|
export * from "./ListRecordingConfigurationsPaginator";
|
|
5
6
|
export * from "./ListStreamKeysPaginator";
|
|
6
7
|
export * from "./ListStreamSessionsPaginator";
|
|
@@ -4,14 +4,17 @@ import { BatchGetChannelCommandInput, BatchGetChannelCommandOutput } from "../co
|
|
|
4
4
|
import { BatchGetStreamKeyCommandInput, BatchGetStreamKeyCommandOutput } from "../commands/BatchGetStreamKeyCommand";
|
|
5
5
|
import { BatchStartViewerSessionRevocationCommandInput, BatchStartViewerSessionRevocationCommandOutput } from "../commands/BatchStartViewerSessionRevocationCommand";
|
|
6
6
|
import { CreateChannelCommandInput, CreateChannelCommandOutput } from "../commands/CreateChannelCommand";
|
|
7
|
+
import { CreatePlaybackRestrictionPolicyCommandInput, CreatePlaybackRestrictionPolicyCommandOutput } from "../commands/CreatePlaybackRestrictionPolicyCommand";
|
|
7
8
|
import { CreateRecordingConfigurationCommandInput, CreateRecordingConfigurationCommandOutput } from "../commands/CreateRecordingConfigurationCommand";
|
|
8
9
|
import { CreateStreamKeyCommandInput, CreateStreamKeyCommandOutput } from "../commands/CreateStreamKeyCommand";
|
|
9
10
|
import { DeleteChannelCommandInput, DeleteChannelCommandOutput } from "../commands/DeleteChannelCommand";
|
|
10
11
|
import { DeletePlaybackKeyPairCommandInput, DeletePlaybackKeyPairCommandOutput } from "../commands/DeletePlaybackKeyPairCommand";
|
|
12
|
+
import { DeletePlaybackRestrictionPolicyCommandInput, DeletePlaybackRestrictionPolicyCommandOutput } from "../commands/DeletePlaybackRestrictionPolicyCommand";
|
|
11
13
|
import { DeleteRecordingConfigurationCommandInput, DeleteRecordingConfigurationCommandOutput } from "../commands/DeleteRecordingConfigurationCommand";
|
|
12
14
|
import { DeleteStreamKeyCommandInput, DeleteStreamKeyCommandOutput } from "../commands/DeleteStreamKeyCommand";
|
|
13
15
|
import { GetChannelCommandInput, GetChannelCommandOutput } from "../commands/GetChannelCommand";
|
|
14
16
|
import { GetPlaybackKeyPairCommandInput, GetPlaybackKeyPairCommandOutput } from "../commands/GetPlaybackKeyPairCommand";
|
|
17
|
+
import { GetPlaybackRestrictionPolicyCommandInput, GetPlaybackRestrictionPolicyCommandOutput } from "../commands/GetPlaybackRestrictionPolicyCommand";
|
|
15
18
|
import { GetRecordingConfigurationCommandInput, GetRecordingConfigurationCommandOutput } from "../commands/GetRecordingConfigurationCommand";
|
|
16
19
|
import { GetStreamCommandInput, GetStreamCommandOutput } from "../commands/GetStreamCommand";
|
|
17
20
|
import { GetStreamKeyCommandInput, GetStreamKeyCommandOutput } from "../commands/GetStreamKeyCommand";
|
|
@@ -19,6 +22,7 @@ import { GetStreamSessionCommandInput, GetStreamSessionCommandOutput } from "../
|
|
|
19
22
|
import { ImportPlaybackKeyPairCommandInput, ImportPlaybackKeyPairCommandOutput } from "../commands/ImportPlaybackKeyPairCommand";
|
|
20
23
|
import { ListChannelsCommandInput, ListChannelsCommandOutput } from "../commands/ListChannelsCommand";
|
|
21
24
|
import { ListPlaybackKeyPairsCommandInput, ListPlaybackKeyPairsCommandOutput } from "../commands/ListPlaybackKeyPairsCommand";
|
|
25
|
+
import { ListPlaybackRestrictionPoliciesCommandInput, ListPlaybackRestrictionPoliciesCommandOutput } from "../commands/ListPlaybackRestrictionPoliciesCommand";
|
|
22
26
|
import { ListRecordingConfigurationsCommandInput, ListRecordingConfigurationsCommandOutput } from "../commands/ListRecordingConfigurationsCommand";
|
|
23
27
|
import { ListStreamKeysCommandInput, ListStreamKeysCommandOutput } from "../commands/ListStreamKeysCommand";
|
|
24
28
|
import { ListStreamsCommandInput, ListStreamsCommandOutput } from "../commands/ListStreamsCommand";
|
|
@@ -30,6 +34,7 @@ import { StopStreamCommandInput, StopStreamCommandOutput } from "../commands/Sto
|
|
|
30
34
|
import { TagResourceCommandInput, TagResourceCommandOutput } from "../commands/TagResourceCommand";
|
|
31
35
|
import { UntagResourceCommandInput, UntagResourceCommandOutput } from "../commands/UntagResourceCommand";
|
|
32
36
|
import { UpdateChannelCommandInput, UpdateChannelCommandOutput } from "../commands/UpdateChannelCommand";
|
|
37
|
+
import { UpdatePlaybackRestrictionPolicyCommandInput, UpdatePlaybackRestrictionPolicyCommandOutput } from "../commands/UpdatePlaybackRestrictionPolicyCommand";
|
|
33
38
|
/**
|
|
34
39
|
* serializeAws_restJson1BatchGetChannelCommand
|
|
35
40
|
*/
|
|
@@ -46,6 +51,10 @@ export declare const se_BatchStartViewerSessionRevocationCommand: (input: BatchS
|
|
|
46
51
|
* serializeAws_restJson1CreateChannelCommand
|
|
47
52
|
*/
|
|
48
53
|
export declare const se_CreateChannelCommand: (input: CreateChannelCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
54
|
+
/**
|
|
55
|
+
* serializeAws_restJson1CreatePlaybackRestrictionPolicyCommand
|
|
56
|
+
*/
|
|
57
|
+
export declare const se_CreatePlaybackRestrictionPolicyCommand: (input: CreatePlaybackRestrictionPolicyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
49
58
|
/**
|
|
50
59
|
* serializeAws_restJson1CreateRecordingConfigurationCommand
|
|
51
60
|
*/
|
|
@@ -62,6 +71,10 @@ export declare const se_DeleteChannelCommand: (input: DeleteChannelCommandInput,
|
|
|
62
71
|
* serializeAws_restJson1DeletePlaybackKeyPairCommand
|
|
63
72
|
*/
|
|
64
73
|
export declare const se_DeletePlaybackKeyPairCommand: (input: DeletePlaybackKeyPairCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
74
|
+
/**
|
|
75
|
+
* serializeAws_restJson1DeletePlaybackRestrictionPolicyCommand
|
|
76
|
+
*/
|
|
77
|
+
export declare const se_DeletePlaybackRestrictionPolicyCommand: (input: DeletePlaybackRestrictionPolicyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
65
78
|
/**
|
|
66
79
|
* serializeAws_restJson1DeleteRecordingConfigurationCommand
|
|
67
80
|
*/
|
|
@@ -78,6 +91,10 @@ export declare const se_GetChannelCommand: (input: GetChannelCommandInput, conte
|
|
|
78
91
|
* serializeAws_restJson1GetPlaybackKeyPairCommand
|
|
79
92
|
*/
|
|
80
93
|
export declare const se_GetPlaybackKeyPairCommand: (input: GetPlaybackKeyPairCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
94
|
+
/**
|
|
95
|
+
* serializeAws_restJson1GetPlaybackRestrictionPolicyCommand
|
|
96
|
+
*/
|
|
97
|
+
export declare const se_GetPlaybackRestrictionPolicyCommand: (input: GetPlaybackRestrictionPolicyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
81
98
|
/**
|
|
82
99
|
* serializeAws_restJson1GetRecordingConfigurationCommand
|
|
83
100
|
*/
|
|
@@ -106,6 +123,10 @@ export declare const se_ListChannelsCommand: (input: ListChannelsCommandInput, c
|
|
|
106
123
|
* serializeAws_restJson1ListPlaybackKeyPairsCommand
|
|
107
124
|
*/
|
|
108
125
|
export declare const se_ListPlaybackKeyPairsCommand: (input: ListPlaybackKeyPairsCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
126
|
+
/**
|
|
127
|
+
* serializeAws_restJson1ListPlaybackRestrictionPoliciesCommand
|
|
128
|
+
*/
|
|
129
|
+
export declare const se_ListPlaybackRestrictionPoliciesCommand: (input: ListPlaybackRestrictionPoliciesCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
109
130
|
/**
|
|
110
131
|
* serializeAws_restJson1ListRecordingConfigurationsCommand
|
|
111
132
|
*/
|
|
@@ -150,6 +171,10 @@ export declare const se_UntagResourceCommand: (input: UntagResourceCommandInput,
|
|
|
150
171
|
* serializeAws_restJson1UpdateChannelCommand
|
|
151
172
|
*/
|
|
152
173
|
export declare const se_UpdateChannelCommand: (input: UpdateChannelCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
174
|
+
/**
|
|
175
|
+
* serializeAws_restJson1UpdatePlaybackRestrictionPolicyCommand
|
|
176
|
+
*/
|
|
177
|
+
export declare const se_UpdatePlaybackRestrictionPolicyCommand: (input: UpdatePlaybackRestrictionPolicyCommandInput, context: __SerdeContext) => Promise<__HttpRequest>;
|
|
153
178
|
/**
|
|
154
179
|
* deserializeAws_restJson1BatchGetChannelCommand
|
|
155
180
|
*/
|
|
@@ -166,6 +191,10 @@ export declare const de_BatchStartViewerSessionRevocationCommand: (output: __Htt
|
|
|
166
191
|
* deserializeAws_restJson1CreateChannelCommand
|
|
167
192
|
*/
|
|
168
193
|
export declare const de_CreateChannelCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreateChannelCommandOutput>;
|
|
194
|
+
/**
|
|
195
|
+
* deserializeAws_restJson1CreatePlaybackRestrictionPolicyCommand
|
|
196
|
+
*/
|
|
197
|
+
export declare const de_CreatePlaybackRestrictionPolicyCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<CreatePlaybackRestrictionPolicyCommandOutput>;
|
|
169
198
|
/**
|
|
170
199
|
* deserializeAws_restJson1CreateRecordingConfigurationCommand
|
|
171
200
|
*/
|
|
@@ -182,6 +211,10 @@ export declare const de_DeleteChannelCommand: (output: __HttpResponse, context:
|
|
|
182
211
|
* deserializeAws_restJson1DeletePlaybackKeyPairCommand
|
|
183
212
|
*/
|
|
184
213
|
export declare const de_DeletePlaybackKeyPairCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeletePlaybackKeyPairCommandOutput>;
|
|
214
|
+
/**
|
|
215
|
+
* deserializeAws_restJson1DeletePlaybackRestrictionPolicyCommand
|
|
216
|
+
*/
|
|
217
|
+
export declare const de_DeletePlaybackRestrictionPolicyCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<DeletePlaybackRestrictionPolicyCommandOutput>;
|
|
185
218
|
/**
|
|
186
219
|
* deserializeAws_restJson1DeleteRecordingConfigurationCommand
|
|
187
220
|
*/
|
|
@@ -198,6 +231,10 @@ export declare const de_GetChannelCommand: (output: __HttpResponse, context: __S
|
|
|
198
231
|
* deserializeAws_restJson1GetPlaybackKeyPairCommand
|
|
199
232
|
*/
|
|
200
233
|
export declare const de_GetPlaybackKeyPairCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetPlaybackKeyPairCommandOutput>;
|
|
234
|
+
/**
|
|
235
|
+
* deserializeAws_restJson1GetPlaybackRestrictionPolicyCommand
|
|
236
|
+
*/
|
|
237
|
+
export declare const de_GetPlaybackRestrictionPolicyCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<GetPlaybackRestrictionPolicyCommandOutput>;
|
|
201
238
|
/**
|
|
202
239
|
* deserializeAws_restJson1GetRecordingConfigurationCommand
|
|
203
240
|
*/
|
|
@@ -226,6 +263,10 @@ export declare const de_ListChannelsCommand: (output: __HttpResponse, context: _
|
|
|
226
263
|
* deserializeAws_restJson1ListPlaybackKeyPairsCommand
|
|
227
264
|
*/
|
|
228
265
|
export declare const de_ListPlaybackKeyPairsCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListPlaybackKeyPairsCommandOutput>;
|
|
266
|
+
/**
|
|
267
|
+
* deserializeAws_restJson1ListPlaybackRestrictionPoliciesCommand
|
|
268
|
+
*/
|
|
269
|
+
export declare const de_ListPlaybackRestrictionPoliciesCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<ListPlaybackRestrictionPoliciesCommandOutput>;
|
|
229
270
|
/**
|
|
230
271
|
* deserializeAws_restJson1ListRecordingConfigurationsCommand
|
|
231
272
|
*/
|
|
@@ -270,3 +311,7 @@ export declare const de_UntagResourceCommand: (output: __HttpResponse, context:
|
|
|
270
311
|
* deserializeAws_restJson1UpdateChannelCommand
|
|
271
312
|
*/
|
|
272
313
|
export declare const de_UpdateChannelCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdateChannelCommandOutput>;
|
|
314
|
+
/**
|
|
315
|
+
* deserializeAws_restJson1UpdatePlaybackRestrictionPolicyCommand
|
|
316
|
+
*/
|
|
317
|
+
export declare const de_UpdatePlaybackRestrictionPolicyCommand: (output: __HttpResponse, context: __SerdeContext) => Promise<UpdatePlaybackRestrictionPolicyCommandOutput>;
|