@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.
Files changed (50) hide show
  1. package/README.md +148 -72
  2. package/dist-cjs/commands/CreatePlaybackRestrictionPolicyCommand.js +1 -0
  3. package/dist-cjs/commands/DeletePlaybackRestrictionPolicyCommand.js +1 -0
  4. package/dist-cjs/commands/GetPlaybackRestrictionPolicyCommand.js +1 -0
  5. package/dist-cjs/commands/ListPlaybackRestrictionPoliciesCommand.js +1 -0
  6. package/dist-cjs/commands/UpdatePlaybackRestrictionPolicyCommand.js +1 -0
  7. package/dist-cjs/index.js +410 -1
  8. package/dist-cjs/pagination/ListPlaybackRestrictionPoliciesPaginator.js +1 -0
  9. package/dist-es/Ivs.js +10 -0
  10. package/dist-es/commands/CreatePlaybackRestrictionPolicyCommand.js +24 -0
  11. package/dist-es/commands/DeletePlaybackRestrictionPolicyCommand.js +24 -0
  12. package/dist-es/commands/GetPlaybackRestrictionPolicyCommand.js +24 -0
  13. package/dist-es/commands/ListPlaybackRestrictionPoliciesCommand.js +24 -0
  14. package/dist-es/commands/UpdatePlaybackRestrictionPolicyCommand.js +24 -0
  15. package/dist-es/commands/index.js +5 -0
  16. package/dist-es/pagination/ListPlaybackRestrictionPoliciesPaginator.js +4 -0
  17. package/dist-es/pagination/index.js +1 -0
  18. package/dist-es/protocols/Aws_restJson1.js +293 -0
  19. package/dist-types/Ivs.d.ts +143 -72
  20. package/dist-types/IvsClient.d.ts +115 -74
  21. package/dist-types/commands/BatchGetChannelCommand.d.ts +1 -0
  22. package/dist-types/commands/CreateChannelCommand.d.ts +2 -0
  23. package/dist-types/commands/CreatePlaybackRestrictionPolicyCommand.d.ts +97 -0
  24. package/dist-types/commands/DeletePlaybackRestrictionPolicyCommand.d.ts +71 -0
  25. package/dist-types/commands/GetChannelCommand.d.ts +1 -0
  26. package/dist-types/commands/GetPlaybackRestrictionPolicyCommand.d.ts +83 -0
  27. package/dist-types/commands/GetStreamSessionCommand.d.ts +1 -0
  28. package/dist-types/commands/ListChannelsCommand.d.ts +2 -0
  29. package/dist-types/commands/ListPlaybackRestrictionPoliciesCommand.d.ts +87 -0
  30. package/dist-types/commands/UpdateChannelCommand.d.ts +2 -0
  31. package/dist-types/commands/UpdatePlaybackRestrictionPolicyCommand.d.ts +94 -0
  32. package/dist-types/commands/index.d.ts +5 -0
  33. package/dist-types/index.d.ts +108 -72
  34. package/dist-types/models/models_0.d.ts +290 -16
  35. package/dist-types/pagination/ListPlaybackRestrictionPoliciesPaginator.d.ts +7 -0
  36. package/dist-types/pagination/index.d.ts +1 -0
  37. package/dist-types/protocols/Aws_restJson1.d.ts +45 -0
  38. package/dist-types/ts3.4/Ivs.d.ts +85 -0
  39. package/dist-types/ts3.4/IvsClient.d.ts +32 -2
  40. package/dist-types/ts3.4/commands/CreatePlaybackRestrictionPolicyCommand.d.ts +30 -0
  41. package/dist-types/ts3.4/commands/DeletePlaybackRestrictionPolicyCommand.d.ts +26 -0
  42. package/dist-types/ts3.4/commands/GetPlaybackRestrictionPolicyCommand.d.ts +30 -0
  43. package/dist-types/ts3.4/commands/ListPlaybackRestrictionPoliciesCommand.d.ts +30 -0
  44. package/dist-types/ts3.4/commands/UpdatePlaybackRestrictionPolicyCommand.d.ts +30 -0
  45. package/dist-types/ts3.4/commands/index.d.ts +5 -0
  46. package/dist-types/ts3.4/models/models_0.d.ts +58 -0
  47. package/dist-types/ts3.4/pagination/ListPlaybackRestrictionPoliciesPaginator.d.ts +11 -0
  48. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  49. package/dist-types/ts3.4/protocols/Aws_restJson1.d.ts +60 -0
  50. package/package.json +1 -1
package/README.md CHANGED
@@ -54,32 +54,40 @@ Amazon IVS</a>):</p>
54
54
  <ul>
55
55
  <li>
56
56
  <p>
57
- <b>Channel</b> — Stores configuration data related to your live stream. You first create a
58
- channel and then use the channel’s stream key to start your live stream. See the Channel
59
- endpoints for more information. </p>
57
+ <b>Channel</b> — Stores configuration data related to your
58
+ live stream. You first create a channel and then use the channel’s stream key to start
59
+ your live stream. See the Channel endpoints for more information. </p>
60
60
  </li>
61
61
  <li>
62
62
  <p>
63
- <b>Stream key</b> — An identifier assigned by Amazon IVS when you create a channel, which is
64
- then used to authorize streaming. See the StreamKey endpoints for more information.
65
- <i>
66
- <b>Treat the stream key like a secret, since it allows
67
- anyone to stream to the channel.</b>
63
+ <b>Stream key</b> — An identifier assigned by Amazon IVS
64
+ when you create a channel, which is then used to authorize streaming. See the StreamKey
65
+ endpoints for more information. <i>
66
+ <b>Treat the stream key like
67
+ a secret, since it allows anyone to stream to the
68
+ channel.</b>
68
69
  </i>
69
70
  </p>
70
71
  </li>
71
72
  <li>
72
73
  <p>
73
- <b>Playback key pair</b> — Video playback may be restricted using playback-authorization
74
- tokens, which use public-key encryption. A playback key pair is the public-private pair of
75
- keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair
74
+ <b>Playback key pair</b> — Video playback may be restricted
75
+ using playback-authorization tokens, which use public-key encryption. A playback key pair
76
+ is the public-private pair of keys used to sign and validate the playback-authorization
77
+ token. See the PlaybackKeyPair endpoints for more information.</p>
78
+ </li>
79
+ <li>
80
+ <p>
81
+ <b>Recording configuration</b> — Stores configuration
82
+ related to recording a live stream and where to store the recorded content. Multiple
83
+ channels can reference the same recording configuration. See the Recording Configuration
76
84
  endpoints for more information.</p>
77
85
  </li>
78
86
  <li>
79
87
  <p>
80
- <b>Recording configuration</b> — Stores configuration related to recording a live stream and
81
- where to store the recorded content. Multiple channels can reference the same recording
82
- configuration. See the Recording Configuration endpoints for more information.</p>
88
+ <b>Playback restriction policy</b> — Restricts playback by
89
+ countries and/or origin sites. See the Playback Restriction Policy endpoints for more
90
+ information.</p>
83
91
  </li>
84
92
  </ul>
85
93
  <p>
@@ -111,11 +119,9 @@ authenticated to sign Amazon IVS API requests.</p>
111
119
  </li>
112
120
  <li>
113
121
  <p>
114
- <i>Authorization</i> is about granting permissions. Your IAM roles need
115
- to have permissions for Amazon IVS API requests. In addition, authorization is needed to
116
- view <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Amazon
117
- IVS private channels</a>. (Private channels are channels that are enabled for
118
- "playback authorization.")</p>
122
+ <i>Authorization</i> is about granting permissions. Your IAM roles need to have permissions for Amazon IVS API requests. In addition,
123
+ authorization is needed to view <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Amazon IVS private channels</a>.
124
+ (Private channels are channels that are enabled for "playback authorization.")</p>
119
125
  </li>
120
126
  </ul>
121
127
  <p>
@@ -145,9 +151,9 @@ the Security page of the <i>Amazon IVS User Guide</i>.</p>
145
151
  <b>Amazon Resource Names (ARNs)</b>
146
152
  </p>
147
153
  <p>ARNs uniquely identify AWS resources. An ARN is required when you need to specify a
148
- resource unambiguously across all of AWS, such as in IAM policies and API calls. For more
149
- information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon Resource Names</a> in the <i>AWS General
150
- Reference</i>.</p>
154
+ resource unambiguously across all of AWS, such as in IAM policies and API
155
+ calls. For more information, see <a href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
156
+ Resource Names</a> in the <i>AWS General Reference</i>.</p>
151
157
  <p>
152
158
  <b>Channel Endpoints</b>
153
159
  </p>
@@ -187,72 +193,33 @@ changes to take effect.</p>
187
193
  </li>
188
194
  </ul>
189
195
  <p>
190
- <b>StreamKey Endpoints</b>
196
+ <b>Playback Restriction Policy Endpoints</b>
191
197
  </p>
192
198
  <ul>
193
199
  <li>
194
200
  <p>
195
- <a>CreateStreamKey</a> — Creates a stream key, used to initiate a
196
- stream, for the specified channel ARN.</p>
201
+ <a>CreatePlaybackRestrictionPolicy</a> — Creates a new playback
202
+ restriction policy, for constraining playback by countries and/or origins.</p>
197
203
  </li>
198
204
  <li>
199
205
  <p>
200
- <a>GetStreamKey</a> — Gets stream key information for the specified
201
- ARN.</p>
206
+ <a>DeletePlaybackRestrictionPolicy</a> — Deletes the specified
207
+ playback restriction policy</p>
202
208
  </li>
203
209
  <li>
204
210
  <p>
205
- <a>BatchGetStreamKey</a> — Performs <a>GetStreamKey</a> on
206
- multiple ARNs simultaneously.</p>
211
+ <a>GetPlaybackRestrictionPolicy</a> — Gets the specified playback
212
+ restriction policy.</p>
207
213
  </li>
208
214
  <li>
209
215
  <p>
210
- <a>ListStreamKeys</a> — Gets summary information about stream keys
211
- for the specified channel.</p>
216
+ <a>ListPlaybackRestrictionPolicies</a> — Gets summary information
217
+ about playback restriction policies.</p>
212
218
  </li>
213
219
  <li>
214
220
  <p>
215
- <a>DeleteStreamKey</a> — Deletes the stream key for the specified
216
- ARN, so it can no longer be used to stream.</p>
217
- </li>
218
- </ul>
219
- <p>
220
- <b>Stream Endpoints</b>
221
- </p>
222
- <ul>
223
- <li>
224
- <p>
225
- <a>GetStream</a> — Gets information about the active (live) stream on
226
- a specified channel.</p>
227
- </li>
228
- <li>
229
- <p>
230
- <a>GetStreamSession</a> — Gets metadata on a specified stream.</p>
231
- </li>
232
- <li>
233
- <p>
234
- <a>ListStreams</a> — Gets summary information about live streams in
235
- your account, in the Amazon Web Services region where the API request is processed.</p>
236
- </li>
237
- <li>
238
- <p>
239
- <a>ListStreamSessions</a> — Gets a summary of current and previous
240
- streams for a specified channel in your account, in the AWS region where the API request
241
- is processed.</p>
242
- </li>
243
- <li>
244
- <p>
245
- <a>StopStream</a> — Disconnects the incoming RTMPS stream for the
246
- specified channel. Can be used in conjunction with <a>DeleteStreamKey</a> to
247
- prevent further streaming to a channel.</p>
248
- </li>
249
- <li>
250
- <p>
251
- <a>PutMetadata</a> — Inserts metadata into the active stream of the
252
- specified channel. At most 5 requests per second per channel are allowed, each with a
253
- maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching
254
- your data into a single PutMetadata call.) At most 155 requests per second per account are
255
- allowed.</p>
221
+ <a>UpdatePlaybackRestrictionPolicy</a> — Updates a specified playback
222
+ restriction policy.</p>
256
223
  </li>
257
224
  </ul>
258
225
  <p>
@@ -327,6 +294,75 @@ configuration for the specified ARN.</p>
327
294
  </li>
328
295
  </ul>
329
296
  <p>
297
+ <b>Stream Endpoints</b>
298
+ </p>
299
+ <ul>
300
+ <li>
301
+ <p>
302
+ <a>GetStream</a> — Gets information about the active (live) stream on
303
+ a specified channel.</p>
304
+ </li>
305
+ <li>
306
+ <p>
307
+ <a>GetStreamSession</a> — Gets metadata on a specified stream.</p>
308
+ </li>
309
+ <li>
310
+ <p>
311
+ <a>ListStreams</a> — Gets summary information about live streams in
312
+ your account, in the Amazon Web Services region where the API request is processed.</p>
313
+ </li>
314
+ <li>
315
+ <p>
316
+ <a>ListStreamSessions</a> — Gets a summary of current and previous
317
+ streams for a specified channel in your account, in the AWS region where the API request
318
+ is processed.</p>
319
+ </li>
320
+ <li>
321
+ <p>
322
+ <a>StopStream</a> — Disconnects the incoming RTMPS stream for the
323
+ specified channel. Can be used in conjunction with <a>DeleteStreamKey</a> to
324
+ prevent further streaming to a channel.</p>
325
+ </li>
326
+ <li>
327
+ <p>
328
+ <a>PutMetadata</a> — Inserts metadata into the active stream of the
329
+ specified channel. At most 5 requests per second per channel are allowed, each with a
330
+ maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching
331
+ your data into a single PutMetadata call.) At most 155 requests per second per account are
332
+ allowed.</p>
333
+ </li>
334
+ </ul>
335
+ <p>
336
+ <b>StreamKey Endpoints</b>
337
+ </p>
338
+ <ul>
339
+ <li>
340
+ <p>
341
+ <a>CreateStreamKey</a> — Creates a stream key, used to initiate a
342
+ stream, for the specified channel ARN.</p>
343
+ </li>
344
+ <li>
345
+ <p>
346
+ <a>GetStreamKey</a> — Gets stream key information for the specified
347
+ ARN.</p>
348
+ </li>
349
+ <li>
350
+ <p>
351
+ <a>BatchGetStreamKey</a> — Performs <a>GetStreamKey</a> on
352
+ multiple ARNs simultaneously.</p>
353
+ </li>
354
+ <li>
355
+ <p>
356
+ <a>ListStreamKeys</a> — Gets summary information about stream keys
357
+ for the specified channel.</p>
358
+ </li>
359
+ <li>
360
+ <p>
361
+ <a>DeleteStreamKey</a> — Deletes the stream key for the specified
362
+ ARN, so it can no longer be used to stream.</p>
363
+ </li>
364
+ </ul>
365
+ <p>
330
366
  <b>Amazon Web Services Tags Endpoints</b>
331
367
  </p>
332
368
  <ul>
@@ -572,6 +608,14 @@ CreateChannel
572
608
 
573
609
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs/command/CreateChannelCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/CreateChannelCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/CreateChannelCommandOutput/)
574
610
 
611
+ </details>
612
+ <details>
613
+ <summary>
614
+ CreatePlaybackRestrictionPolicy
615
+ </summary>
616
+
617
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs/command/CreatePlaybackRestrictionPolicyCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/CreatePlaybackRestrictionPolicyCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/CreatePlaybackRestrictionPolicyCommandOutput/)
618
+
575
619
  </details>
576
620
  <details>
577
621
  <summary>
@@ -604,6 +648,14 @@ DeletePlaybackKeyPair
604
648
 
605
649
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs/command/DeletePlaybackKeyPairCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/DeletePlaybackKeyPairCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/DeletePlaybackKeyPairCommandOutput/)
606
650
 
651
+ </details>
652
+ <details>
653
+ <summary>
654
+ DeletePlaybackRestrictionPolicy
655
+ </summary>
656
+
657
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs/command/DeletePlaybackRestrictionPolicyCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/DeletePlaybackRestrictionPolicyCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/DeletePlaybackRestrictionPolicyCommandOutput/)
658
+
607
659
  </details>
608
660
  <details>
609
661
  <summary>
@@ -636,6 +688,14 @@ GetPlaybackKeyPair
636
688
 
637
689
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs/command/GetPlaybackKeyPairCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/GetPlaybackKeyPairCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/GetPlaybackKeyPairCommandOutput/)
638
690
 
691
+ </details>
692
+ <details>
693
+ <summary>
694
+ GetPlaybackRestrictionPolicy
695
+ </summary>
696
+
697
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs/command/GetPlaybackRestrictionPolicyCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/GetPlaybackRestrictionPolicyCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/GetPlaybackRestrictionPolicyCommandOutput/)
698
+
639
699
  </details>
640
700
  <details>
641
701
  <summary>
@@ -692,6 +752,14 @@ ListPlaybackKeyPairs
692
752
 
693
753
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs/command/ListPlaybackKeyPairsCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/ListPlaybackKeyPairsCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/ListPlaybackKeyPairsCommandOutput/)
694
754
 
755
+ </details>
756
+ <details>
757
+ <summary>
758
+ ListPlaybackRestrictionPolicies
759
+ </summary>
760
+
761
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs/command/ListPlaybackRestrictionPoliciesCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/ListPlaybackRestrictionPoliciesCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/ListPlaybackRestrictionPoliciesCommandOutput/)
762
+
695
763
  </details>
696
764
  <details>
697
765
  <summary>
@@ -781,3 +849,11 @@ UpdateChannel
781
849
  [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs/command/UpdateChannelCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/UpdateChannelCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/UpdateChannelCommandOutput/)
782
850
 
783
851
  </details>
852
+ <details>
853
+ <summary>
854
+ UpdatePlaybackRestrictionPolicy
855
+ </summary>
856
+
857
+ [Command API Reference](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/client/ivs/command/UpdatePlaybackRestrictionPolicyCommand/) / [Input](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/UpdatePlaybackRestrictionPolicyCommandInput/) / [Output](https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-aws-sdk-client-ivs/Interface/UpdatePlaybackRestrictionPolicyCommandOutput/)
858
+
859
+ </details>
@@ -0,0 +1 @@
1
+ module.exports = require("../index.js");
@@ -0,0 +1 @@
1
+ module.exports = require("../index.js");
@@ -0,0 +1 @@
1
+ module.exports = require("../index.js");
@@ -0,0 +1 @@
1
+ module.exports = require("../index.js");
@@ -0,0 +1 @@
1
+ module.exports = require("../index.js");