@aws-sdk/client-ivs 3.36.0 → 3.36.1

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 (75) hide show
  1. package/CHANGELOG.md +11 -0
  2. package/dist-cjs/Ivs.js +0 -362
  3. package/dist-cjs/IvsClient.js +0 -367
  4. package/dist-cjs/commands/BatchGetChannelCommand.js +0 -24
  5. package/dist-cjs/commands/BatchGetStreamKeyCommand.js +0 -24
  6. package/dist-cjs/commands/CreateChannelCommand.js +0 -24
  7. package/dist-cjs/commands/CreateRecordingConfigurationCommand.js +0 -35
  8. package/dist-cjs/commands/CreateStreamKeyCommand.js +0 -27
  9. package/dist-cjs/commands/DeleteChannelCommand.js +0 -28
  10. package/dist-cjs/commands/DeletePlaybackKeyPairCommand.js +0 -26
  11. package/dist-cjs/commands/DeleteRecordingConfigurationCommand.js +0 -29
  12. package/dist-cjs/commands/DeleteStreamKeyCommand.js +0 -25
  13. package/dist-cjs/commands/GetChannelCommand.js +0 -24
  14. package/dist-cjs/commands/GetPlaybackKeyPairCommand.js +0 -28
  15. package/dist-cjs/commands/GetRecordingConfigurationCommand.js +0 -24
  16. package/dist-cjs/commands/GetStreamCommand.js +0 -24
  17. package/dist-cjs/commands/GetStreamKeyCommand.js +0 -24
  18. package/dist-cjs/commands/ImportPlaybackKeyPairCommand.js +0 -28
  19. package/dist-cjs/commands/ListChannelsCommand.js +0 -27
  20. package/dist-cjs/commands/ListPlaybackKeyPairsCommand.js +0 -25
  21. package/dist-cjs/commands/ListRecordingConfigurationsCommand.js +0 -25
  22. package/dist-cjs/commands/ListStreamKeysCommand.js +0 -24
  23. package/dist-cjs/commands/ListStreamsCommand.js +0 -25
  24. package/dist-cjs/commands/ListTagsForResourceCommand.js +0 -24
  25. package/dist-cjs/commands/PutMetadataCommand.js +0 -30
  26. package/dist-cjs/commands/StopStreamCommand.js +0 -31
  27. package/dist-cjs/commands/TagResourceCommand.js +0 -24
  28. package/dist-cjs/commands/UntagResourceCommand.js +0 -24
  29. package/dist-cjs/commands/UpdateChannelCommand.js +0 -25
  30. package/dist-cjs/models/models_0.js +0 -213
  31. package/dist-cjs/pagination/ListChannelsPaginator.js +0 -10
  32. package/dist-cjs/pagination/ListPlaybackKeyPairsPaginator.js +0 -10
  33. package/dist-cjs/pagination/ListRecordingConfigurationsPaginator.js +0 -10
  34. package/dist-cjs/pagination/ListStreamKeysPaginator.js +0 -10
  35. package/dist-cjs/pagination/ListStreamsPaginator.js +0 -10
  36. package/dist-cjs/pagination/ListTagsForResourcePaginator.js +0 -10
  37. package/dist-cjs/protocols/Aws_restJson1.js +0 -5
  38. package/dist-cjs/runtimeConfig.browser.js +1 -5
  39. package/dist-cjs/runtimeConfig.js +1 -5
  40. package/dist-cjs/runtimeConfig.native.js +0 -3
  41. package/dist-cjs/runtimeConfig.shared.js +0 -3
  42. package/dist-types/ts3.4/Ivs.d.ts +27 -494
  43. package/dist-types/ts3.4/IvsClient.d.ts +24 -448
  44. package/dist-types/ts3.4/commands/BatchGetChannelCommand.d.ts +2 -20
  45. package/dist-types/ts3.4/commands/BatchGetStreamKeyCommand.d.ts +2 -20
  46. package/dist-types/ts3.4/commands/CreateChannelCommand.d.ts +2 -20
  47. package/dist-types/ts3.4/commands/CreateRecordingConfigurationCommand.d.ts +2 -31
  48. package/dist-types/ts3.4/commands/CreateStreamKeyCommand.d.ts +2 -23
  49. package/dist-types/ts3.4/commands/DeleteChannelCommand.d.ts +2 -24
  50. package/dist-types/ts3.4/commands/DeletePlaybackKeyPairCommand.d.ts +2 -22
  51. package/dist-types/ts3.4/commands/DeleteRecordingConfigurationCommand.d.ts +2 -25
  52. package/dist-types/ts3.4/commands/DeleteStreamKeyCommand.d.ts +2 -21
  53. package/dist-types/ts3.4/commands/GetChannelCommand.d.ts +2 -20
  54. package/dist-types/ts3.4/commands/GetPlaybackKeyPairCommand.d.ts +2 -24
  55. package/dist-types/ts3.4/commands/GetRecordingConfigurationCommand.d.ts +2 -20
  56. package/dist-types/ts3.4/commands/GetStreamCommand.d.ts +2 -20
  57. package/dist-types/ts3.4/commands/GetStreamKeyCommand.d.ts +2 -20
  58. package/dist-types/ts3.4/commands/ImportPlaybackKeyPairCommand.d.ts +2 -24
  59. package/dist-types/ts3.4/commands/ListChannelsCommand.d.ts +2 -23
  60. package/dist-types/ts3.4/commands/ListPlaybackKeyPairsCommand.d.ts +2 -21
  61. package/dist-types/ts3.4/commands/ListRecordingConfigurationsCommand.d.ts +2 -21
  62. package/dist-types/ts3.4/commands/ListStreamKeysCommand.d.ts +2 -20
  63. package/dist-types/ts3.4/commands/ListStreamsCommand.d.ts +2 -21
  64. package/dist-types/ts3.4/commands/ListTagsForResourceCommand.d.ts +2 -20
  65. package/dist-types/ts3.4/commands/PutMetadataCommand.d.ts +2 -26
  66. package/dist-types/ts3.4/commands/StopStreamCommand.d.ts +2 -27
  67. package/dist-types/ts3.4/commands/TagResourceCommand.d.ts +2 -20
  68. package/dist-types/ts3.4/commands/UntagResourceCommand.d.ts +2 -20
  69. package/dist-types/ts3.4/commands/UpdateChannelCommand.d.ts +2 -21
  70. package/dist-types/ts3.4/models/models_0.d.ts +226 -768
  71. package/dist-types/ts3.4/runtimeConfig.browser.d.ts +1 -3
  72. package/dist-types/ts3.4/runtimeConfig.d.ts +1 -3
  73. package/dist-types/ts3.4/runtimeConfig.native.d.ts +1 -3
  74. package/dist-types/ts3.4/runtimeConfig.shared.d.ts +1 -3
  75. package/package.json +3 -3
@@ -26,576 +26,109 @@ import { TagResourceCommandInput, TagResourceCommandOutput } from "./commands/Ta
26
26
  import { UntagResourceCommandInput, UntagResourceCommandOutput } from "./commands/UntagResourceCommand";
27
27
  import { UpdateChannelCommandInput, UpdateChannelCommandOutput } from "./commands/UpdateChannelCommand";
28
28
  import { IvsClient } from "./IvsClient";
29
- /**
30
- * <p>
31
- * <b>Introduction</b>
32
- * </p>
33
- *
34
- * <p>The Amazon Interactive Video Service (IVS) API is REST compatible, using a standard HTTP
35
- * API and an AWS EventBridge event stream for responses. JSON is used for both requests and
36
- * responses, including errors.</p>
37
- *
38
- * <p>The API is an AWS regional service, currently in these regions: us-west-2, us-east-1, and
39
- * eu-west-1.</p>
40
- * <p>
41
- * <i>
42
- * <b>All API request parameters and URLs are case sensitive.
43
- * </b>
44
- * </i>
45
- * </p>
46
- *
47
- * <p>For a summary of notable documentation changes in each release, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/doc-history.html"> Document
48
- * History</a>.</p>
49
- *
50
- * <p>
51
- * <b>Service Endpoints</b>
52
- * </p>
53
- * <p>The following are the Amazon IVS service endpoints (all HTTPS): </p>
54
- * <p>Region name: US West (Oregon)</p>
55
- * <ul>
56
- * <li>
57
- * <p>Region: <code>us-west-2</code>
58
- * </p>
59
- * </li>
60
- * <li>
61
- * <p>Endpoint: <code>ivs.us-west-2.amazonaws.com</code>
62
- * </p>
63
- * </li>
64
- * </ul>
65
- * <p>Region name: US East (Virginia)</p>
66
- * <ul>
67
- * <li>
68
- * <p>Region: <code>us-east-1</code>
69
- * </p>
70
- * </li>
71
- * <li>
72
- * <p>Endpoint: <code>ivs.us-east-1.amazonaws.com</code>
73
- * </p>
74
- * </li>
75
- * </ul>
76
- * <p>Region name: EU West (Dublin)</p>
77
- * <ul>
78
- * <li>
79
- * <p>Region: <code>eu-west-1</code>
80
- * </p>
81
- * </li>
82
- * <li>
83
- * <p>Endpoint: <code>ivs.eu-west-1.amazonaws.com</code>
84
- * </p>
85
- * </li>
86
- * </ul>
87
- *
88
- * <p>
89
- * <b>Allowed Header Values</b>
90
- * </p>
91
- *
92
- * <ul>
93
- * <li>
94
- * <p>
95
- * <code>
96
- * <b>Accept:</b>
97
- * </code> application/json</p>
98
- * </li>
99
- * <li>
100
- * <p>
101
- * <code>
102
- * <b>Accept-Encoding:</b>
103
- * </code> gzip, deflate</p>
104
- * </li>
105
- * <li>
106
- * <p>
107
- * <code>
108
- * <b>Content-Type:</b>
109
- * </code>application/json</p>
110
- * </li>
111
- * </ul>
112
- *
113
- * <p>
114
- * <b>Resources</b>
115
- * </p>
116
- * <p>The following resources contain information about your IVS live stream (see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/getting-started.html"> Getting Started with Amazon
117
- * IVS</a>):</p>
118
- *
119
- * <ul>
120
- * <li>
121
- * <p>Channel — Stores configuration data related to your live stream. You first create a
122
- * channel and then use the channel’s stream key to start your live stream. See the Channel
123
- * endpoints for more information. </p>
124
- * </li>
125
- * <li>
126
- * <p>Stream key — An identifier assigned by Amazon IVS when you create a channel, which is
127
- * then used to authorize streaming. See the StreamKey endpoints for more information.
128
- * <i>
129
- * <b>Treat the stream key like a secret, since it allows
130
- * anyone to stream to the channel.</b>
131
- * </i>
132
- * </p>
133
- * </li>
134
- * <li>
135
- * <p>Playback key pair — Video playback may be restricted using playback-authorization
136
- * tokens, which use public-key encryption. A playback key pair is the public-private pair of
137
- * keys used to sign and validate the playback-authorization token. See the PlaybackKeyPair
138
- * endpoints for more information.</p>
139
- * </li>
140
- * <li>
141
- * <p>Recording configuration — Stores configuration related to recording a live stream and
142
- * where to store the recorded content. Multiple channels can reference the same recording
143
- * configuration. See the Recording Configuration endpoints for more information.</p>
144
- * </li>
145
- * </ul>
146
- *
147
- *
148
- *
149
- * <p>
150
- * <b>Tagging</b>
151
- * </p>
152
- *
153
- * <p>A <i>tag</i> is a metadata label that you assign to an AWS resource. A tag
154
- * comprises a <i>key</i> and a <i>value</i>, both set by you. For
155
- * example, you might set a tag as <code>topic:nature</code> to label a particular video
156
- * category. See <a href="https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html">Tagging AWS
157
- * Resources</a> for more information, including restrictions that apply to tags.</p>
158
- *
159
- * <p>Tags can help you identify and organize your AWS resources. For example, you can use the
160
- * same tag for different resources to indicate that they are related. You can also use tags to
161
- * manage access (see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/access_tags.html">
162
- * Access Tags</a>). </p>
163
- *
164
- * <p>The Amazon IVS API has these tag-related endpoints: <a>TagResource</a>, <a>UntagResource</a>, and <a>ListTagsForResource</a>. The following
165
- * resources support tagging: Channels, Stream Keys, Playback Key Pairs, and Recording
166
- * Configurations.</p>
167
- *
168
- * <p>
169
- * <b>Authentication versus Authorization</b>
170
- * </p>
171
- * <p>Note the differences between these concepts:</p>
172
- * <ul>
173
- * <li>
174
- * <p>
175
- * <i>Authentication</i> is about verifying identity. You need to be authenticated to sign Amazon IVS
176
- * API requests.</p>
177
- * </li>
178
- * <li>
179
- * <p>
180
- * <i>Authorization</i> is about granting permissions. You need to be authorized to
181
- * view <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Amazon IVS private channels</a>. (Private channels are channels that are enabled for
182
- * "playback authorization.")</p>
183
- * </li>
184
- * </ul>
185
- *
186
- * <p>
187
- * <b>Authentication</b>
188
- * </p>
189
- * <p>All Amazon IVS API requests must be authenticated with a signature. The AWS Command-Line
190
- * Interface (CLI) and Amazon IVS Player SDKs take care of signing the underlying API calls for
191
- * you. However, if your application calls the Amazon IVS API directly, it’s your responsibility
192
- * to sign the requests.</p>
193
- * <p>You generate a signature using valid AWS credentials that have permission to perform the
194
- * requested action. For example, you must sign PutMetadata requests with a signature generated
195
- * from an IAM user account that has the <code>ivs:PutMetadata</code> permission.</p>
196
- * <p>For more information:</p>
197
- * <ul>
198
- * <li>
199
- * <p>Authentication and generating signatures — See <a href="https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html">Authenticating Requests (AWS Signature Version
200
- * 4)</a> in the <i>AWS General Reference</i>.</p>
201
- * </li>
202
- * <li>
203
- * <p>Managing Amazon IVS permissions — See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/security-iam.html">Identity and Access Management</a> on the Security page of
204
- * the <i>Amazon IVS User Guide</i>.</p>
205
- * </li>
206
- * </ul>
207
- *
208
- *
209
- * <p>
210
- * <b>Channel Endpoints</b>
211
- * </p>
212
- * <ul>
213
- * <li>
214
- * <p>
215
- * <a>CreateChannel</a> — Creates a new channel and an associated stream
216
- * key to start streaming.</p>
217
- * </li>
218
- * <li>
219
- * <p>
220
- * <a>GetChannel</a> — Gets the channel configuration for the specified
221
- * channel ARN (Amazon Resource Name).</p>
222
- * </li>
223
- * <li>
224
- * <p>
225
- * <a>BatchGetChannel</a> — Performs <a>GetChannel</a> on
226
- * multiple ARNs simultaneously.</p>
227
- * </li>
228
- * <li>
229
- * <p>
230
- * <a>ListChannels</a> — Gets summary information about all channels in
231
- * your account, in the AWS region where the API request is processed. This list can be
232
- * filtered to match a specified name or recording-configuration ARN. Filters are mutually
233
- * exclusive and cannot be used together. If you try to use both filters, you will get an
234
- * error (409 Conflict Exception).</p>
235
- * </li>
236
- * <li>
237
- * <p>
238
- * <a>UpdateChannel</a> — Updates a channel's configuration. This does
239
- * not affect an ongoing stream of this channel. You must stop and restart the stream for the
240
- * changes to take effect.</p>
241
- * </li>
242
- * <li>
243
- * <p>
244
- * <a>DeleteChannel</a> — Deletes the specified channel.</p>
245
- * </li>
246
- * </ul>
247
- *
248
- * <p>
249
- * <b>StreamKey Endpoints</b>
250
- * </p>
251
- * <ul>
252
- * <li>
253
- * <p>
254
- * <a>CreateStreamKey</a> — Creates a stream key, used to initiate a
255
- * stream, for the specified channel ARN.</p>
256
- * </li>
257
- * <li>
258
- * <p>
259
- * <a>GetStreamKey</a> — Gets stream key information for the specified
260
- * ARN.</p>
261
- * </li>
262
- * <li>
263
- * <p>
264
- * <a>BatchGetStreamKey</a> — Performs <a>GetStreamKey</a> on
265
- * multiple ARNs simultaneously.</p>
266
- * </li>
267
- * <li>
268
- * <p>
269
- * <a>ListStreamKeys</a> — Gets summary information about stream keys
270
- * for the specified channel.</p>
271
- * </li>
272
- * <li>
273
- * <p>
274
- * <a>DeleteStreamKey</a> — Deletes the stream key for the specified
275
- * ARN, so it can no longer be used to stream.</p>
276
- * </li>
277
- * </ul>
278
- *
279
- *
280
- * <p>
281
- * <b>Stream Endpoints</b>
282
- * </p>
283
- * <ul>
284
- * <li>
285
- * <p>
286
- * <a>GetStream</a> — Gets information about the active (live) stream on
287
- * a specified channel.</p>
288
- * </li>
289
- * <li>
290
- * <p>
291
- * <a>ListStreams</a> — Gets summary information about live streams in
292
- * your account, in the AWS region where the API request is processed.</p>
293
- * </li>
294
- * <li>
295
- * <p>
296
- * <a>StopStream</a> — Disconnects the incoming RTMPS stream for the
297
- * specified channel. Can be used in conjunction with <a>DeleteStreamKey</a> to
298
- * prevent further streaming to a channel.</p>
299
- * </li>
300
- * <li>
301
- * <p>
302
- * <a>PutMetadata</a> — Inserts metadata into the active stream of the
303
- * specified channel. A maximum of 5 requests per second per channel is allowed, each with a
304
- * maximum 1 KB payload. (If 5 TPS is not sufficient for your needs, we recommend batching
305
- * your data into a single PutMetadata call.)</p>
306
- * </li>
307
- * </ul>
308
- *
309
- * <p>
310
- * <b>PlaybackKeyPair Endpoints</b>
311
- * </p>
312
- * <p>For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the
313
- * <i>Amazon IVS User Guide</i>.</p>
314
- * <ul>
315
- * <li>
316
- * <p>
317
- * <a>ImportPlaybackKeyPair</a> — Imports the public portion of a new
318
- * key pair and returns its <code>arn</code> and <code>fingerprint</code>. The
319
- * <code>privateKey</code> can then be used to generate viewer authorization tokens, to
320
- * grant viewers access to private channels (channels enabled for playback
321
- * authorization).</p>
322
- * </li>
323
- * <li>
324
- * <p>
325
- * <a>GetPlaybackKeyPair</a> — Gets a specified playback authorization
326
- * key pair and returns the <code>arn</code> and <code>fingerprint</code>. The
327
- * <code>privateKey</code> held by the caller can be used to generate viewer authorization
328
- * tokens, to grant viewers access to private channels.</p>
329
- * </li>
330
- * <li>
331
- * <p>
332
- * <a>ListPlaybackKeyPairs</a> — Gets summary information about playback
333
- * key pairs.</p>
334
- * </li>
335
- * <li>
336
- * <p>
337
- * <a>DeletePlaybackKeyPair</a> — Deletes a specified authorization key
338
- * pair. This invalidates future viewer tokens generated using the key pair’s
339
- * <code>privateKey</code>.</p>
340
- * </li>
341
- * </ul>
342
- *
343
- * <p>
344
- * <b>RecordingConfiguration Endpoints</b>
345
- * </p>
346
- * <ul>
347
- * <li>
348
- * <p>
349
- * <a>CreateRecordingConfiguration</a> — Creates a new recording configuration,
350
- * used to enable recording to Amazon S3.</p>
351
- * </li>
352
- * <li>
353
- * <p>
354
- * <a>GetRecordingConfiguration</a> — Gets the recording-configuration metadata
355
- * for the specified ARN.</p>
356
- * </li>
357
- * <li>
358
- * <p>
359
- * <a>ListRecordingConfigurations</a> — Gets summary information about all
360
- * recording configurations in your account, in the AWS region where the API request is
361
- * processed.</p>
362
- * </li>
363
- * <li>
364
- * <p>
365
- * <a>DeleteRecordingConfiguration</a> — Deletes the recording
366
- * configuration for the specified ARN.</p>
367
- * </li>
368
- * </ul>
369
- *
370
- * <p>
371
- * <b>AWS Tags Endpoints</b>
372
- * </p>
373
- * <ul>
374
- * <li>
375
- * <p>
376
- * <a>TagResource</a> — Adds or updates tags for the AWS resource with
377
- * the specified ARN.</p>
378
- * </li>
379
- * <li>
380
- * <p>
381
- * <a>UntagResource</a> — Removes tags from the resource with the
382
- * specified ARN.</p>
383
- * </li>
384
- * <li>
385
- * <p>
386
- * <a>ListTagsForResource</a> — Gets information about AWS tags for the
387
- * specified ARN.</p>
388
- * </li>
389
- * </ul>
390
- */
29
+
391
30
  export declare class Ivs extends IvsClient {
392
- /**
393
- * <p>Performs <a>GetChannel</a> on multiple ARNs simultaneously.</p>
394
- */
31
+
395
32
  batchGetChannel(args: BatchGetChannelCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetChannelCommandOutput>;
396
33
  batchGetChannel(args: BatchGetChannelCommandInput, cb: (err: any, data?: BatchGetChannelCommandOutput) => void): void;
397
34
  batchGetChannel(args: BatchGetChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetChannelCommandOutput) => void): void;
398
- /**
399
- * <p>Performs <a>GetStreamKey</a> on multiple ARNs simultaneously.</p>
400
- */
35
+
401
36
  batchGetStreamKey(args: BatchGetStreamKeyCommandInput, options?: __HttpHandlerOptions): Promise<BatchGetStreamKeyCommandOutput>;
402
37
  batchGetStreamKey(args: BatchGetStreamKeyCommandInput, cb: (err: any, data?: BatchGetStreamKeyCommandOutput) => void): void;
403
38
  batchGetStreamKey(args: BatchGetStreamKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: BatchGetStreamKeyCommandOutput) => void): void;
404
- /**
405
- * <p>Creates a new channel and an associated stream key to start streaming.</p>
406
- */
39
+
407
40
  createChannel(args: CreateChannelCommandInput, options?: __HttpHandlerOptions): Promise<CreateChannelCommandOutput>;
408
41
  createChannel(args: CreateChannelCommandInput, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
409
42
  createChannel(args: CreateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateChannelCommandOutput) => void): void;
410
- /**
411
- * <p>Creates a new recording configuration, used to enable recording to Amazon S3.</p>
412
- * <p>
413
- * <b>Known issue:</b> In the us-east-1 region, if you use the AWS
414
- * CLI to create a recording configuration, it returns success even if the S3 bucket is in a
415
- * different region. In this case, the <code>state</code> of the recording configuration is
416
- * <code>CREATE_FAILED</code> (instead of <code>ACTIVE</code>). (In other regions, the CLI
417
- * correctly returns failure if the bucket is in a different region.)</p>
418
- * <p>
419
- * <b>Workaround:</b> Ensure that your S3 bucket is in the same region as the recording
420
- * configuration. If you create a recording configuration in a different region as your S3
421
- * bucket, delete that recording configuration and create a new one with an S3 bucket from the
422
- * correct region.</p>
423
- */
43
+
424
44
  createRecordingConfiguration(args: CreateRecordingConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<CreateRecordingConfigurationCommandOutput>;
425
45
  createRecordingConfiguration(args: CreateRecordingConfigurationCommandInput, cb: (err: any, data?: CreateRecordingConfigurationCommandOutput) => void): void;
426
46
  createRecordingConfiguration(args: CreateRecordingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateRecordingConfigurationCommandOutput) => void): void;
427
- /**
428
- * <p>Creates a stream key, used to initiate a stream, for the specified channel ARN.</p>
429
- * <p>Note that <a>CreateChannel</a> creates a stream key. If you subsequently use
430
- * CreateStreamKey on the same channel, it will fail because a stream key already exists and
431
- * there is a limit of 1 stream key per channel. To reset the stream key on a channel, use <a>DeleteStreamKey</a> and then CreateStreamKey.</p>
432
- */
47
+
433
48
  createStreamKey(args: CreateStreamKeyCommandInput, options?: __HttpHandlerOptions): Promise<CreateStreamKeyCommandOutput>;
434
49
  createStreamKey(args: CreateStreamKeyCommandInput, cb: (err: any, data?: CreateStreamKeyCommandOutput) => void): void;
435
50
  createStreamKey(args: CreateStreamKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: CreateStreamKeyCommandOutput) => void): void;
436
- /**
437
- * <p>Deletes the specified channel and its associated stream keys.</p>
438
- * <p>If you try to delete a live channel, you will get an error (409 ConflictException). To
439
- * delete a channel that is live, call <a>StopStream</a>, wait for the Amazon
440
- * EventBridge "Stream End" event (to verify that the stream's state was changed from Live to
441
- * Offline), then call DeleteChannel. (See <a href="https://docs.aws.amazon.com/ivs/latest/userguide/eventbridge.html"> Using EventBridge with Amazon IVS</a>.) </p>
442
- */
51
+
443
52
  deleteChannel(args: DeleteChannelCommandInput, options?: __HttpHandlerOptions): Promise<DeleteChannelCommandOutput>;
444
53
  deleteChannel(args: DeleteChannelCommandInput, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
445
54
  deleteChannel(args: DeleteChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteChannelCommandOutput) => void): void;
446
- /**
447
- * <p>Deletes a specified authorization key pair. This invalidates future viewer tokens
448
- * generated using the key pair’s <code>privateKey</code>. For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private
449
- * Channels</a> in the <i>Amazon IVS User Guide</i>.</p>
450
- */
55
+
451
56
  deletePlaybackKeyPair(args: DeletePlaybackKeyPairCommandInput, options?: __HttpHandlerOptions): Promise<DeletePlaybackKeyPairCommandOutput>;
452
57
  deletePlaybackKeyPair(args: DeletePlaybackKeyPairCommandInput, cb: (err: any, data?: DeletePlaybackKeyPairCommandOutput) => void): void;
453
58
  deletePlaybackKeyPair(args: DeletePlaybackKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeletePlaybackKeyPairCommandOutput) => void): void;
454
- /**
455
- * <p>Deletes the recording configuration for the specified ARN.</p>
456
- * <p>If you try to delete a recording configuration that is associated with a channel, you will
457
- * get an error (409 ConflictException). To avoid this, for all channels that reference the
458
- * recording configuration, first use <a>UpdateChannel</a> to set the
459
- * <code>recordingConfigurationArn</code> field to an empty string, then use
460
- * DeleteRecordingConfiguration.</p>
461
- */
59
+
462
60
  deleteRecordingConfiguration(args: DeleteRecordingConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<DeleteRecordingConfigurationCommandOutput>;
463
61
  deleteRecordingConfiguration(args: DeleteRecordingConfigurationCommandInput, cb: (err: any, data?: DeleteRecordingConfigurationCommandOutput) => void): void;
464
62
  deleteRecordingConfiguration(args: DeleteRecordingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteRecordingConfigurationCommandOutput) => void): void;
465
- /**
466
- * <p>Deletes the stream key for the specified ARN, so it can no longer be used to
467
- * stream.</p>
468
- */
63
+
469
64
  deleteStreamKey(args: DeleteStreamKeyCommandInput, options?: __HttpHandlerOptions): Promise<DeleteStreamKeyCommandOutput>;
470
65
  deleteStreamKey(args: DeleteStreamKeyCommandInput, cb: (err: any, data?: DeleteStreamKeyCommandOutput) => void): void;
471
66
  deleteStreamKey(args: DeleteStreamKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: DeleteStreamKeyCommandOutput) => void): void;
472
- /**
473
- * <p>Gets the channel configuration for the specified channel ARN. See also <a>BatchGetChannel</a>.</p>
474
- */
67
+
475
68
  getChannel(args: GetChannelCommandInput, options?: __HttpHandlerOptions): Promise<GetChannelCommandOutput>;
476
69
  getChannel(args: GetChannelCommandInput, cb: (err: any, data?: GetChannelCommandOutput) => void): void;
477
70
  getChannel(args: GetChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetChannelCommandOutput) => void): void;
478
- /**
479
- * <p>Gets a specified playback authorization key pair and returns the <code>arn</code> and
480
- * <code>fingerprint</code>. The <code>privateKey</code> held by the caller can be used to
481
- * generate viewer authorization tokens, to grant viewers access to private channels. For more
482
- * information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private Channels</a> in the <i>Amazon IVS User
483
- * Guide</i>.</p>
484
- */
71
+
485
72
  getPlaybackKeyPair(args: GetPlaybackKeyPairCommandInput, options?: __HttpHandlerOptions): Promise<GetPlaybackKeyPairCommandOutput>;
486
73
  getPlaybackKeyPair(args: GetPlaybackKeyPairCommandInput, cb: (err: any, data?: GetPlaybackKeyPairCommandOutput) => void): void;
487
74
  getPlaybackKeyPair(args: GetPlaybackKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetPlaybackKeyPairCommandOutput) => void): void;
488
- /**
489
- * <p>Gets the recording configuration for the specified ARN.</p>
490
- */
75
+
491
76
  getRecordingConfiguration(args: GetRecordingConfigurationCommandInput, options?: __HttpHandlerOptions): Promise<GetRecordingConfigurationCommandOutput>;
492
77
  getRecordingConfiguration(args: GetRecordingConfigurationCommandInput, cb: (err: any, data?: GetRecordingConfigurationCommandOutput) => void): void;
493
78
  getRecordingConfiguration(args: GetRecordingConfigurationCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetRecordingConfigurationCommandOutput) => void): void;
494
- /**
495
- * <p>Gets information about the active (live) stream on a specified channel.</p>
496
- */
79
+
497
80
  getStream(args: GetStreamCommandInput, options?: __HttpHandlerOptions): Promise<GetStreamCommandOutput>;
498
81
  getStream(args: GetStreamCommandInput, cb: (err: any, data?: GetStreamCommandOutput) => void): void;
499
82
  getStream(args: GetStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStreamCommandOutput) => void): void;
500
- /**
501
- * <p>Gets stream-key information for a specified ARN.</p>
502
- */
83
+
503
84
  getStreamKey(args: GetStreamKeyCommandInput, options?: __HttpHandlerOptions): Promise<GetStreamKeyCommandOutput>;
504
85
  getStreamKey(args: GetStreamKeyCommandInput, cb: (err: any, data?: GetStreamKeyCommandOutput) => void): void;
505
86
  getStreamKey(args: GetStreamKeyCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: GetStreamKeyCommandOutput) => void): void;
506
- /**
507
- * <p>Imports the public portion of a new key pair and returns its <code>arn</code> and
508
- * <code>fingerprint</code>. The <code>privateKey</code> can then be used to generate viewer
509
- * authorization tokens, to grant viewers access to private channels. For more information, see
510
- * <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up
511
- * Private Channels</a> in the <i>Amazon IVS User Guide</i>.</p>
512
- */
87
+
513
88
  importPlaybackKeyPair(args: ImportPlaybackKeyPairCommandInput, options?: __HttpHandlerOptions): Promise<ImportPlaybackKeyPairCommandOutput>;
514
89
  importPlaybackKeyPair(args: ImportPlaybackKeyPairCommandInput, cb: (err: any, data?: ImportPlaybackKeyPairCommandOutput) => void): void;
515
90
  importPlaybackKeyPair(args: ImportPlaybackKeyPairCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ImportPlaybackKeyPairCommandOutput) => void): void;
516
- /**
517
- * <p>Gets summary information about all channels in your account, in the AWS region where the
518
- * API request is processed. This list can be filtered to match a specified name or
519
- * recording-configuration ARN. Filters are mutually exclusive and cannot be used together. If
520
- * you try to use both filters, you will get an error (409 ConflictException).</p>
521
- */
91
+
522
92
  listChannels(args: ListChannelsCommandInput, options?: __HttpHandlerOptions): Promise<ListChannelsCommandOutput>;
523
93
  listChannels(args: ListChannelsCommandInput, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
524
94
  listChannels(args: ListChannelsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListChannelsCommandOutput) => void): void;
525
- /**
526
- * <p>Gets summary information about playback key pairs. For more information, see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/private-channels.html">Setting Up Private
527
- * Channels</a> in the <i>Amazon IVS User Guide</i>.</p>
528
- */
95
+
529
96
  listPlaybackKeyPairs(args: ListPlaybackKeyPairsCommandInput, options?: __HttpHandlerOptions): Promise<ListPlaybackKeyPairsCommandOutput>;
530
97
  listPlaybackKeyPairs(args: ListPlaybackKeyPairsCommandInput, cb: (err: any, data?: ListPlaybackKeyPairsCommandOutput) => void): void;
531
98
  listPlaybackKeyPairs(args: ListPlaybackKeyPairsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListPlaybackKeyPairsCommandOutput) => void): void;
532
- /**
533
- * <p>Gets summary information about all recording configurations in your account, in the AWS
534
- * region where the API request is processed.</p>
535
- */
99
+
536
100
  listRecordingConfigurations(args: ListRecordingConfigurationsCommandInput, options?: __HttpHandlerOptions): Promise<ListRecordingConfigurationsCommandOutput>;
537
101
  listRecordingConfigurations(args: ListRecordingConfigurationsCommandInput, cb: (err: any, data?: ListRecordingConfigurationsCommandOutput) => void): void;
538
102
  listRecordingConfigurations(args: ListRecordingConfigurationsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListRecordingConfigurationsCommandOutput) => void): void;
539
- /**
540
- * <p>Gets summary information about stream keys for the specified channel.</p>
541
- */
103
+
542
104
  listStreamKeys(args: ListStreamKeysCommandInput, options?: __HttpHandlerOptions): Promise<ListStreamKeysCommandOutput>;
543
105
  listStreamKeys(args: ListStreamKeysCommandInput, cb: (err: any, data?: ListStreamKeysCommandOutput) => void): void;
544
106
  listStreamKeys(args: ListStreamKeysCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamKeysCommandOutput) => void): void;
545
- /**
546
- * <p>Gets summary information about live streams in your account, in the AWS region where the
547
- * API request is processed.</p>
548
- */
107
+
549
108
  listStreams(args: ListStreamsCommandInput, options?: __HttpHandlerOptions): Promise<ListStreamsCommandOutput>;
550
109
  listStreams(args: ListStreamsCommandInput, cb: (err: any, data?: ListStreamsCommandOutput) => void): void;
551
110
  listStreams(args: ListStreamsCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListStreamsCommandOutput) => void): void;
552
- /**
553
- * <p>Gets information about AWS tags for the specified ARN.</p>
554
- */
111
+
555
112
  listTagsForResource(args: ListTagsForResourceCommandInput, options?: __HttpHandlerOptions): Promise<ListTagsForResourceCommandOutput>;
556
113
  listTagsForResource(args: ListTagsForResourceCommandInput, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
557
114
  listTagsForResource(args: ListTagsForResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: ListTagsForResourceCommandOutput) => void): void;
558
- /**
559
- * <p>Inserts metadata into the active stream of the specified channel. A maximum of 5 requests
560
- * per second per channel is allowed, each with a maximum 1 KB payload. (If 5 TPS is not
561
- * sufficient for your needs, we recommend batching your data into a single PutMetadata call.)
562
- *
563
- * Also see <a href="https://docs.aws.amazon.com/ivs/latest/userguide/metadata.html">Embedding Metadata
564
- *
565
- * within a Video Stream</a> in the <i>Amazon IVS User Guide</i>.</p>
566
- */
115
+
567
116
  putMetadata(args: PutMetadataCommandInput, options?: __HttpHandlerOptions): Promise<PutMetadataCommandOutput>;
568
117
  putMetadata(args: PutMetadataCommandInput, cb: (err: any, data?: PutMetadataCommandOutput) => void): void;
569
118
  putMetadata(args: PutMetadataCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: PutMetadataCommandOutput) => void): void;
570
- /**
571
- * <p>Disconnects the incoming RTMPS stream for the specified channel. Can be used in
572
- * conjunction with <a>DeleteStreamKey</a> to prevent further streaming to a
573
- * channel.</p>
574
- * <note>
575
- * <p>Many streaming client-software libraries automatically reconnect a dropped RTMPS
576
- * session, so to stop the stream permanently, you may want to first revoke the
577
- * <code>streamKey</code> attached to the channel.</p>
578
- * </note>
579
- */
119
+
580
120
  stopStream(args: StopStreamCommandInput, options?: __HttpHandlerOptions): Promise<StopStreamCommandOutput>;
581
121
  stopStream(args: StopStreamCommandInput, cb: (err: any, data?: StopStreamCommandOutput) => void): void;
582
122
  stopStream(args: StopStreamCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: StopStreamCommandOutput) => void): void;
583
- /**
584
- * <p>Adds or updates tags for the AWS resource with the specified ARN.</p>
585
- */
123
+
586
124
  tagResource(args: TagResourceCommandInput, options?: __HttpHandlerOptions): Promise<TagResourceCommandOutput>;
587
125
  tagResource(args: TagResourceCommandInput, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
588
126
  tagResource(args: TagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: TagResourceCommandOutput) => void): void;
589
- /**
590
- * <p>Removes tags from the resource with the specified ARN.</p>
591
- */
127
+
592
128
  untagResource(args: UntagResourceCommandInput, options?: __HttpHandlerOptions): Promise<UntagResourceCommandOutput>;
593
129
  untagResource(args: UntagResourceCommandInput, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
594
130
  untagResource(args: UntagResourceCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UntagResourceCommandOutput) => void): void;
595
- /**
596
- * <p>Updates a channel's configuration. This does not affect an ongoing stream of this channel.
597
- * You must stop and restart the stream for the changes to take effect.</p>
598
- */
131
+
599
132
  updateChannel(args: UpdateChannelCommandInput, options?: __HttpHandlerOptions): Promise<UpdateChannelCommandOutput>;
600
133
  updateChannel(args: UpdateChannelCommandInput, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;
601
134
  updateChannel(args: UpdateChannelCommandInput, options: __HttpHandlerOptions, cb: (err: any, data?: UpdateChannelCommandOutput) => void): void;