@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
@@ -2,27 +2,19 @@ import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException
2
2
  export interface AccessDeniedException extends __SmithyException, $MetadataBearer {
3
3
  name: "AccessDeniedException";
4
4
  $fault: "client";
5
- /**
6
- * <p>User does not have sufficient access to perform this action.</p>
7
- */
5
+
8
6
  exceptionMessage?: string;
9
7
  }
10
8
  export declare namespace AccessDeniedException {
11
- /**
12
- * @internal
13
- */
9
+
14
10
  const filterSensitiveLog: (obj: AccessDeniedException) => any;
15
11
  }
16
12
  export interface BatchGetChannelRequest {
17
- /**
18
- * <p>Array of ARNs, one per channel.</p>
19
- */
13
+
20
14
  arns: string[] | undefined;
21
15
  }
22
16
  export declare namespace BatchGetChannelRequest {
23
- /**
24
- * @internal
25
- */
17
+
26
18
  const filterSensitiveLog: (obj: BatchGetChannelRequest) => any;
27
19
  }
28
20
  export declare enum ChannelLatencyMode {
@@ -33,151 +25,78 @@ export declare enum ChannelType {
33
25
  BasicChannelType = "BASIC",
34
26
  StandardChannelType = "STANDARD"
35
27
  }
36
- /**
37
- * <p>Object specifying a channel.</p>
38
- */
28
+
39
29
  export interface Channel {
40
- /**
41
- * <p>Channel ARN.</p>
42
- */
30
+
43
31
  arn?: string;
44
- /**
45
- * <p>Channel name.</p>
46
- */
32
+
47
33
  name?: string;
48
- /**
49
- * <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to
50
- * Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. Default: <code>LOW</code>. (Note: In the Amazon IVS console, <code>LOW</code> and
51
- * <code>NORMAL</code> correspond to Ultra-low and Standard, respectively.)</p>
52
- */
34
+
53
35
  latencyMode?: ChannelLatencyMode | string;
54
- /**
55
- * <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
56
- * exceed the allowable resolution or bitrate, the stream probably will disconnect
57
- * immediately.</i> Default: <code>STANDARD</code>. Valid values:</p>
58
- * <ul>
59
- * <li>
60
- * <p>
61
- * <code>STANDARD</code>: Multiple qualities are generated from the original input, to
62
- * automatically give viewers the best experience for their devices and network conditions.
63
- * Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.</p>
64
- * </li>
65
- * <li>
66
- * <p>
67
- * <code>BASIC</code>: Amazon IVS delivers the original input to viewers. The viewer’s
68
- * video-quality choice is limited to the original input. Vertical resolution can be up to
69
- * 480 and bitrate can be up to 1.5 Mbps.</p>
70
- * </li>
71
- * </ul>
72
- */
36
+
73
37
  type?: ChannelType | string;
74
- /**
75
- * <p>Recording-configuration ARN. A value other than an empty string indicates that recording
76
- * is enabled. Default: "" (empty string, recording is disabled).</p>
77
- */
38
+
78
39
  recordingConfigurationArn?: string;
79
- /**
80
- * <p>Channel ingest endpoint, part of the definition of an ingest server, used when you set up
81
- * streaming software.</p>
82
- */
40
+
83
41
  ingestEndpoint?: string;
84
- /**
85
- * <p>Channel playback URL.</p>
86
- */
42
+
87
43
  playbackUrl?: string;
88
- /**
89
- * <p>Whether the channel is private (enabled for playback authorization). Default:
90
- * <code>false</code>.</p>
91
- */
44
+
92
45
  authorized?: boolean;
93
- /**
94
- * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
95
- */
46
+
96
47
  tags?: {
97
48
  [key: string]: string;
98
49
  };
99
50
  }
100
51
  export declare namespace Channel {
101
- /**
102
- * @internal
103
- */
52
+
104
53
  const filterSensitiveLog: (obj: Channel) => any;
105
54
  }
106
- /**
107
- * <p>Error related to a specific channel, specified by its ARN.</p>
108
- */
55
+
109
56
  export interface BatchError {
110
- /**
111
- * <p>Channel ARN.</p>
112
- */
57
+
113
58
  arn?: string;
114
- /**
115
- * <p>Error code.</p>
116
- */
59
+
117
60
  code?: string;
118
- /**
119
- * <p>Error message, determined by the application.</p>
120
- */
61
+
121
62
  message?: string;
122
63
  }
123
64
  export declare namespace BatchError {
124
- /**
125
- * @internal
126
- */
65
+
127
66
  const filterSensitiveLog: (obj: BatchError) => any;
128
67
  }
129
68
  export interface BatchGetChannelResponse {
130
69
  channels?: Channel[];
131
- /**
132
- * <p>Each error object is related to a specific ARN in the request.</p>
133
- */
70
+
134
71
  errors?: BatchError[];
135
72
  }
136
73
  export declare namespace BatchGetChannelResponse {
137
- /**
138
- * @internal
139
- */
74
+
140
75
  const filterSensitiveLog: (obj: BatchGetChannelResponse) => any;
141
76
  }
142
77
  export interface BatchGetStreamKeyRequest {
143
- /**
144
- * <p>Array of ARNs, one per channel.</p>
145
- */
78
+
146
79
  arns: string[] | undefined;
147
80
  }
148
81
  export declare namespace BatchGetStreamKeyRequest {
149
- /**
150
- * @internal
151
- */
82
+
152
83
  const filterSensitiveLog: (obj: BatchGetStreamKeyRequest) => any;
153
84
  }
154
- /**
155
- * <p>Object specifying a stream key.</p>
156
- */
85
+
157
86
  export interface StreamKey {
158
- /**
159
- * <p>Stream-key ARN.</p>
160
- */
87
+
161
88
  arn?: string;
162
- /**
163
- * <p>Stream-key value.</p>
164
- */
89
+
165
90
  value?: string;
166
- /**
167
- * <p>Channel ARN for the stream.</p>
168
- */
91
+
169
92
  channelArn?: string;
170
- /**
171
- * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
172
- */
93
+
173
94
  tags?: {
174
95
  [key: string]: string;
175
96
  };
176
97
  }
177
98
  export declare namespace StreamKey {
178
- /**
179
- * @internal
180
- */
99
+
181
100
  const filterSensitiveLog: (obj: StreamKey) => any;
182
101
  }
183
102
  export interface BatchGetStreamKeyResponse {
@@ -185,205 +104,119 @@ export interface BatchGetStreamKeyResponse {
185
104
  errors?: BatchError[];
186
105
  }
187
106
  export declare namespace BatchGetStreamKeyResponse {
188
- /**
189
- * @internal
190
- */
107
+
191
108
  const filterSensitiveLog: (obj: BatchGetStreamKeyResponse) => any;
192
109
  }
193
110
  export interface CreateChannelRequest {
194
- /**
195
- * <p>Channel name.</p>
196
- */
111
+
197
112
  name?: string;
198
- /**
199
- * <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to
200
- * Full HD. Use <code>LOW</code> for near-real-time interaction with viewers. (Note: In the
201
- * Amazon IVS console, <code>LOW</code> and <code>NORMAL</code> correspond to Ultra-low and Standard, respectively.)
202
- * Default: <code>LOW</code>.</p>
203
- */
113
+
204
114
  latencyMode?: ChannelLatencyMode | string;
205
- /**
206
- * <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
207
- * exceed the allowable resolution or bitrate, the stream probably will disconnect
208
- * immediately.</i> Default: <code>STANDARD</code>. Valid values:</p>
209
- * <ul>
210
- * <li>
211
- * <p>
212
- * <code>STANDARD</code>: Multiple qualities are generated from the original input, to
213
- * automatically give viewers the best experience for their devices and network conditions.
214
- * Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.</p>
215
- * </li>
216
- * <li>
217
- * <p>
218
- * <code>BASIC</code>: Amazon IVS delivers the original input to viewers. The viewer’s
219
- * video-quality choice is limited to the original input. Vertical resolution can be up to
220
- * 480 and bitrate can be up to 1.5 Mbps.</p>
221
- * </li>
222
- * </ul>
223
- */
115
+
224
116
  type?: ChannelType | string;
225
- /**
226
- * <p>Whether the channel is private (enabled for playback authorization). Default:
227
- * <code>false</code>.</p>
228
- */
117
+
229
118
  authorized?: boolean;
230
- /**
231
- * <p>Recording-configuration ARN. Default: "" (empty string, recording is disabled).</p>
232
- */
119
+
233
120
  recordingConfigurationArn?: string;
234
- /**
235
- * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
236
- */
121
+
237
122
  tags?: {
238
123
  [key: string]: string;
239
124
  };
240
125
  }
241
126
  export declare namespace CreateChannelRequest {
242
- /**
243
- * @internal
244
- */
127
+
245
128
  const filterSensitiveLog: (obj: CreateChannelRequest) => any;
246
129
  }
247
130
  export interface CreateChannelResponse {
248
- /**
249
- * <p>Object specifying a channel.</p>
250
- */
131
+
251
132
  channel?: Channel;
252
- /**
253
- * <p>Object specifying a stream key.</p>
254
- */
133
+
255
134
  streamKey?: StreamKey;
256
135
  }
257
136
  export declare namespace CreateChannelResponse {
258
- /**
259
- * @internal
260
- */
137
+
261
138
  const filterSensitiveLog: (obj: CreateChannelResponse) => any;
262
139
  }
263
140
  export interface PendingVerification extends __SmithyException, $MetadataBearer {
264
141
  name: "PendingVerification";
265
142
  $fault: "client";
266
- /**
267
- * <p> Your account is pending verification. </p>
268
- */
143
+
269
144
  exceptionMessage?: string;
270
145
  }
271
146
  export declare namespace PendingVerification {
272
- /**
273
- * @internal
274
- */
147
+
275
148
  const filterSensitiveLog: (obj: PendingVerification) => any;
276
149
  }
277
150
  export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
278
151
  name: "ResourceNotFoundException";
279
152
  $fault: "client";
280
- /**
281
- * <p>Request references a resource which does not exist.</p>
282
- */
153
+
283
154
  exceptionMessage?: string;
284
155
  }
285
156
  export declare namespace ResourceNotFoundException {
286
- /**
287
- * @internal
288
- */
157
+
289
158
  const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
290
159
  }
291
160
  export interface ServiceQuotaExceededException extends __SmithyException, $MetadataBearer {
292
161
  name: "ServiceQuotaExceededException";
293
162
  $fault: "client";
294
- /**
295
- * <p>Request would cause a service quota to be exceeded.</p>
296
- */
163
+
297
164
  exceptionMessage?: string;
298
165
  }
299
166
  export declare namespace ServiceQuotaExceededException {
300
- /**
301
- * @internal
302
- */
167
+
303
168
  const filterSensitiveLog: (obj: ServiceQuotaExceededException) => any;
304
169
  }
305
170
  export interface ValidationException extends __SmithyException, $MetadataBearer {
306
171
  name: "ValidationException";
307
172
  $fault: "client";
308
- /**
309
- * <p>The input fails to satisfy the constraints specified by an AWS service.</p>
310
- */
173
+
311
174
  exceptionMessage?: string;
312
175
  }
313
176
  export declare namespace ValidationException {
314
- /**
315
- * @internal
316
- */
177
+
317
178
  const filterSensitiveLog: (obj: ValidationException) => any;
318
179
  }
319
180
  export interface ConflictException extends __SmithyException, $MetadataBearer {
320
181
  name: "ConflictException";
321
182
  $fault: "client";
322
- /**
323
- * <p>Updating or deleting a resource can cause an inconsistent state.</p>
324
- */
183
+
325
184
  exceptionMessage?: string;
326
185
  }
327
186
  export declare namespace ConflictException {
328
- /**
329
- * @internal
330
- */
187
+
331
188
  const filterSensitiveLog: (obj: ConflictException) => any;
332
189
  }
333
- /**
334
- * <p>A complex type that describes an S3 location where recorded videos will be stored.</p>
335
- */
190
+
336
191
  export interface S3DestinationConfiguration {
337
- /**
338
- * <p>Location (S3 bucket name) where recorded videos will be stored.</p>
339
- */
192
+
340
193
  bucketName: string | undefined;
341
194
  }
342
195
  export declare namespace S3DestinationConfiguration {
343
- /**
344
- * @internal
345
- */
196
+
346
197
  const filterSensitiveLog: (obj: S3DestinationConfiguration) => any;
347
198
  }
348
- /**
349
- * <p>A complex type that describes a location where recorded videos will be stored. Each member
350
- * represents a type of destination configuration. For recording, you define one and only one
351
- * type of destination configuration.</p>
352
- */
199
+
353
200
  export interface DestinationConfiguration {
354
- /**
355
- * <p>An S3 destination configuration where recorded videos will be stored.</p>
356
- */
201
+
357
202
  s3?: S3DestinationConfiguration;
358
203
  }
359
204
  export declare namespace DestinationConfiguration {
360
- /**
361
- * @internal
362
- */
205
+
363
206
  const filterSensitiveLog: (obj: DestinationConfiguration) => any;
364
207
  }
365
208
  export interface CreateRecordingConfigurationRequest {
366
- /**
367
- * <p>An arbitrary string (a nickname) that helps the customer identify that resource. The value
368
- * does not need to be unique.</p>
369
- */
209
+
370
210
  name?: string;
371
- /**
372
- * <p>A complex type that contains a destination configuration for where recorded video will be
373
- * stored.</p>
374
- */
211
+
375
212
  destinationConfiguration: DestinationConfiguration | undefined;
376
- /**
377
- * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
378
- */
213
+
379
214
  tags?: {
380
215
  [key: string]: string;
381
216
  };
382
217
  }
383
218
  export declare namespace CreateRecordingConfigurationRequest {
384
- /**
385
- * @internal
386
- */
219
+
387
220
  const filterSensitiveLog: (obj: CreateRecordingConfigurationRequest) => any;
388
221
  }
389
222
  export declare enum RecordingConfigurationState {
@@ -391,279 +224,182 @@ export declare enum RecordingConfigurationState {
391
224
  CreateFailed = "CREATE_FAILED",
392
225
  Creating = "CREATING"
393
226
  }
394
- /**
395
- * <p>An object representing a configuration to record a channel stream.</p>
396
- */
227
+
397
228
  export interface RecordingConfiguration {
398
- /**
399
- * <p>Recording-configuration ARN.</p>
400
- */
229
+
401
230
  arn: string | undefined;
402
- /**
403
- * <p>An arbitrary string (a nickname) assigned to a recording configuration that helps the
404
- * customer identify that resource. The value does not need to be unique.</p>
405
- */
231
+
406
232
  name?: string;
407
- /**
408
- * <p>A complex type that contains information about where recorded video will be stored.</p>
409
- */
233
+
410
234
  destinationConfiguration: DestinationConfiguration | undefined;
411
- /**
412
- * <p>Indicates the current state of the recording configuration. When the state is
413
- * <code>ACTIVE</code>, the configuration is ready for recording a channel stream.</p>
414
- */
235
+
415
236
  state: RecordingConfigurationState | string | undefined;
416
- /**
417
- * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
418
- */
237
+
419
238
  tags?: {
420
239
  [key: string]: string;
421
240
  };
422
241
  }
423
242
  export declare namespace RecordingConfiguration {
424
- /**
425
- * @internal
426
- */
243
+
427
244
  const filterSensitiveLog: (obj: RecordingConfiguration) => any;
428
245
  }
429
246
  export interface CreateRecordingConfigurationResponse {
430
- /**
431
- * <p>An object representing a configuration to record a channel stream.</p>
432
- */
247
+
433
248
  recordingConfiguration?: RecordingConfiguration;
434
249
  }
435
250
  export declare namespace CreateRecordingConfigurationResponse {
436
- /**
437
- * @internal
438
- */
251
+
439
252
  const filterSensitiveLog: (obj: CreateRecordingConfigurationResponse) => any;
440
253
  }
441
254
  export interface InternalServerException extends __SmithyException, $MetadataBearer {
442
255
  name: "InternalServerException";
443
256
  $fault: "server";
444
- /**
445
- * <p>Unexpected error during processing of request.</p>
446
- */
257
+
447
258
  exceptionMessage?: string;
448
259
  }
449
260
  export declare namespace InternalServerException {
450
- /**
451
- * @internal
452
- */
261
+
453
262
  const filterSensitiveLog: (obj: InternalServerException) => any;
454
263
  }
455
264
  export interface CreateStreamKeyRequest {
456
- /**
457
- * <p>ARN of the channel for which to create the stream key.</p>
458
- */
265
+
459
266
  channelArn: string | undefined;
460
- /**
461
- * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
462
- */
267
+
463
268
  tags?: {
464
269
  [key: string]: string;
465
270
  };
466
271
  }
467
272
  export declare namespace CreateStreamKeyRequest {
468
- /**
469
- * @internal
470
- */
273
+
471
274
  const filterSensitiveLog: (obj: CreateStreamKeyRequest) => any;
472
275
  }
473
276
  export interface CreateStreamKeyResponse {
474
- /**
475
- * <p>Stream key used to authenticate an RTMPS stream for ingestion.</p>
476
- */
277
+
477
278
  streamKey?: StreamKey;
478
279
  }
479
280
  export declare namespace CreateStreamKeyResponse {
480
- /**
481
- * @internal
482
- */
281
+
483
282
  const filterSensitiveLog: (obj: CreateStreamKeyResponse) => any;
484
283
  }
485
284
  export interface DeleteChannelRequest {
486
- /**
487
- * <p>ARN of the channel to be deleted.</p>
488
- */
285
+
489
286
  arn: string | undefined;
490
287
  }
491
288
  export declare namespace DeleteChannelRequest {
492
- /**
493
- * @internal
494
- */
289
+
495
290
  const filterSensitiveLog: (obj: DeleteChannelRequest) => any;
496
291
  }
497
292
  export interface DeletePlaybackKeyPairRequest {
498
- /**
499
- * <p>ARN of the key pair to be deleted.</p>
500
- */
293
+
501
294
  arn: string | undefined;
502
295
  }
503
296
  export declare namespace DeletePlaybackKeyPairRequest {
504
- /**
505
- * @internal
506
- */
297
+
507
298
  const filterSensitiveLog: (obj: DeletePlaybackKeyPairRequest) => any;
508
299
  }
509
300
  export interface DeletePlaybackKeyPairResponse {
510
301
  }
511
302
  export declare namespace DeletePlaybackKeyPairResponse {
512
- /**
513
- * @internal
514
- */
303
+
515
304
  const filterSensitiveLog: (obj: DeletePlaybackKeyPairResponse) => any;
516
305
  }
517
306
  export interface DeleteRecordingConfigurationRequest {
518
- /**
519
- * <p>ARN of the recording configuration to be deleted.</p>
520
- */
307
+
521
308
  arn: string | undefined;
522
309
  }
523
310
  export declare namespace DeleteRecordingConfigurationRequest {
524
- /**
525
- * @internal
526
- */
311
+
527
312
  const filterSensitiveLog: (obj: DeleteRecordingConfigurationRequest) => any;
528
313
  }
529
314
  export interface DeleteStreamKeyRequest {
530
- /**
531
- * <p>ARN of the stream key to be deleted.</p>
532
- */
315
+
533
316
  arn: string | undefined;
534
317
  }
535
318
  export declare namespace DeleteStreamKeyRequest {
536
- /**
537
- * @internal
538
- */
319
+
539
320
  const filterSensitiveLog: (obj: DeleteStreamKeyRequest) => any;
540
321
  }
541
322
  export interface GetChannelRequest {
542
- /**
543
- * <p>ARN of the channel for which the configuration is to be retrieved.</p>
544
- */
323
+
545
324
  arn: string | undefined;
546
325
  }
547
326
  export declare namespace GetChannelRequest {
548
- /**
549
- * @internal
550
- */
327
+
551
328
  const filterSensitiveLog: (obj: GetChannelRequest) => any;
552
329
  }
553
330
  export interface GetChannelResponse {
554
- /**
555
- * <p>Object specifying a channel.</p>
556
- */
331
+
557
332
  channel?: Channel;
558
333
  }
559
334
  export declare namespace GetChannelResponse {
560
- /**
561
- * @internal
562
- */
335
+
563
336
  const filterSensitiveLog: (obj: GetChannelResponse) => any;
564
337
  }
565
338
  export interface GetPlaybackKeyPairRequest {
566
- /**
567
- * <p>ARN of the key pair to be returned.</p>
568
- */
339
+
569
340
  arn: string | undefined;
570
341
  }
571
342
  export declare namespace GetPlaybackKeyPairRequest {
572
- /**
573
- * @internal
574
- */
343
+
575
344
  const filterSensitiveLog: (obj: GetPlaybackKeyPairRequest) => any;
576
345
  }
577
- /**
578
- * <p>A key pair used to sign and validate a playback authorization token.</p>
579
- */
346
+
580
347
  export interface PlaybackKeyPair {
581
- /**
582
- * <p>Key-pair ARN.</p>
583
- */
348
+
584
349
  arn?: string;
585
- /**
586
- * <p>An arbitrary string (a nickname) assigned to a playback key pair that helps the customer
587
- * identify that resource. The value does not need to be unique.</p>
588
- */
350
+
589
351
  name?: string;
590
- /**
591
- * <p>Key-pair identifier.</p>
592
- */
352
+
593
353
  fingerprint?: string;
594
- /**
595
- * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
596
- */
354
+
597
355
  tags?: {
598
356
  [key: string]: string;
599
357
  };
600
358
  }
601
359
  export declare namespace PlaybackKeyPair {
602
- /**
603
- * @internal
604
- */
360
+
605
361
  const filterSensitiveLog: (obj: PlaybackKeyPair) => any;
606
362
  }
607
363
  export interface GetPlaybackKeyPairResponse {
608
- /**
609
- * <p>A key pair used to sign and validate a playback authorization token.</p>
610
- */
364
+
611
365
  keyPair?: PlaybackKeyPair;
612
366
  }
613
367
  export declare namespace GetPlaybackKeyPairResponse {
614
- /**
615
- * @internal
616
- */
368
+
617
369
  const filterSensitiveLog: (obj: GetPlaybackKeyPairResponse) => any;
618
370
  }
619
371
  export interface GetRecordingConfigurationRequest {
620
- /**
621
- * <p>ARN of the recording configuration to be retrieved.</p>
622
- */
372
+
623
373
  arn: string | undefined;
624
374
  }
625
375
  export declare namespace GetRecordingConfigurationRequest {
626
- /**
627
- * @internal
628
- */
376
+
629
377
  const filterSensitiveLog: (obj: GetRecordingConfigurationRequest) => any;
630
378
  }
631
379
  export interface GetRecordingConfigurationResponse {
632
- /**
633
- * <p>An object representing a configuration to record a channel stream.</p>
634
- */
380
+
635
381
  recordingConfiguration?: RecordingConfiguration;
636
382
  }
637
383
  export declare namespace GetRecordingConfigurationResponse {
638
- /**
639
- * @internal
640
- */
384
+
641
385
  const filterSensitiveLog: (obj: GetRecordingConfigurationResponse) => any;
642
386
  }
643
387
  export interface ChannelNotBroadcasting extends __SmithyException, $MetadataBearer {
644
388
  name: "ChannelNotBroadcasting";
645
389
  $fault: "client";
646
- /**
647
- * <p>The stream is offline for the given channel ARN.</p>
648
- */
390
+
649
391
  exceptionMessage?: string;
650
392
  }
651
393
  export declare namespace ChannelNotBroadcasting {
652
- /**
653
- * @internal
654
- */
394
+
655
395
  const filterSensitiveLog: (obj: ChannelNotBroadcasting) => any;
656
396
  }
657
397
  export interface GetStreamRequest {
658
- /**
659
- * <p>Channel ARN for stream to be accessed.</p>
660
- */
398
+
661
399
  channelArn: string | undefined;
662
400
  }
663
401
  export declare namespace GetStreamRequest {
664
- /**
665
- * @internal
666
- */
402
+
667
403
  const filterSensitiveLog: (obj: GetStreamRequest) => any;
668
404
  }
669
405
  export declare enum StreamHealth {
@@ -675,666 +411,388 @@ export declare enum StreamState {
675
411
  StreamLive = "LIVE",
676
412
  StreamOffline = "OFFLINE"
677
413
  }
678
- /**
679
- * <p>Specifies a live video stream that has been ingested and distributed.</p>
680
- */
414
+
681
415
  export interface _Stream {
682
- /**
683
- * <p>Channel ARN for the stream.</p>
684
- */
416
+
685
417
  channelArn?: string;
686
- /**
687
- * <p>URL of the master playlist, required by the video player to play the HLS stream.</p>
688
- */
418
+
689
419
  playbackUrl?: string;
690
- /**
691
- * <p>ISO-8601 formatted timestamp of the stream’s start.</p>
692
- */
420
+
693
421
  startTime?: Date;
694
- /**
695
- * <p>The stream’s state.</p>
696
- */
422
+
697
423
  state?: StreamState | string;
698
- /**
699
- * <p>The stream’s health.</p>
700
- */
424
+
701
425
  health?: StreamHealth | string;
702
- /**
703
- * <p>Number of current viewers of the stream. A value of -1 indicates that the request timed
704
- * out; in this case, retry.</p>
705
- */
426
+
706
427
  viewerCount?: number;
707
428
  }
708
429
  export declare namespace _Stream {
709
- /**
710
- * @internal
711
- */
430
+
712
431
  const filterSensitiveLog: (obj: _Stream) => any;
713
432
  }
714
433
  export interface GetStreamResponse {
715
- /**
716
- * <p>Specifies a live video stream that has been ingested and distributed.</p>
717
- */
434
+
718
435
  stream?: _Stream;
719
436
  }
720
437
  export declare namespace GetStreamResponse {
721
- /**
722
- * @internal
723
- */
438
+
724
439
  const filterSensitiveLog: (obj: GetStreamResponse) => any;
725
440
  }
726
441
  export interface GetStreamKeyRequest {
727
- /**
728
- * <p>ARN for the stream key to be retrieved.</p>
729
- */
442
+
730
443
  arn: string | undefined;
731
444
  }
732
445
  export declare namespace GetStreamKeyRequest {
733
- /**
734
- * @internal
735
- */
446
+
736
447
  const filterSensitiveLog: (obj: GetStreamKeyRequest) => any;
737
448
  }
738
449
  export interface GetStreamKeyResponse {
739
- /**
740
- * <p>Object specifying a stream key.</p>
741
- */
450
+
742
451
  streamKey?: StreamKey;
743
452
  }
744
453
  export declare namespace GetStreamKeyResponse {
745
- /**
746
- * @internal
747
- */
454
+
748
455
  const filterSensitiveLog: (obj: GetStreamKeyResponse) => any;
749
456
  }
750
457
  export interface ImportPlaybackKeyPairRequest {
751
- /**
752
- * <p>The public portion of a customer-generated key pair.</p>
753
- */
458
+
754
459
  publicKeyMaterial: string | undefined;
755
- /**
756
- * <p>An arbitrary string (a nickname) assigned to a playback key pair that helps the customer
757
- * identify that resource. The value does not need to be unique.</p>
758
- */
460
+
759
461
  name?: string;
760
- /**
761
- * <p>Any tags provided with the request are added to the playback key pair tags.</p>
762
- */
462
+
763
463
  tags?: {
764
464
  [key: string]: string;
765
465
  };
766
466
  }
767
467
  export declare namespace ImportPlaybackKeyPairRequest {
768
- /**
769
- * @internal
770
- */
468
+
771
469
  const filterSensitiveLog: (obj: ImportPlaybackKeyPairRequest) => any;
772
470
  }
773
471
  export interface ImportPlaybackKeyPairResponse {
774
- /**
775
- * <p>A key pair used to sign and validate a playback authorization token.</p>
776
- */
472
+
777
473
  keyPair?: PlaybackKeyPair;
778
474
  }
779
475
  export declare namespace ImportPlaybackKeyPairResponse {
780
- /**
781
- * @internal
782
- */
476
+
783
477
  const filterSensitiveLog: (obj: ImportPlaybackKeyPairResponse) => any;
784
478
  }
785
479
  export interface ListChannelsRequest {
786
- /**
787
- * <p>Filters the channel list to match the specified name.</p>
788
- */
480
+
789
481
  filterByName?: string;
790
- /**
791
- * <p>Filters the channel list to match the specified recording-configuration ARN.</p>
792
- */
482
+
793
483
  filterByRecordingConfigurationArn?: string;
794
- /**
795
- * <p>The first channel to retrieve. This is used for pagination; see the <code>nextToken</code>
796
- * response field.</p>
797
- */
484
+
798
485
  nextToken?: string;
799
- /**
800
- * <p>Maximum number of channels to return. Default: 50.</p>
801
- */
486
+
802
487
  maxResults?: number;
803
488
  }
804
489
  export declare namespace ListChannelsRequest {
805
- /**
806
- * @internal
807
- */
490
+
808
491
  const filterSensitiveLog: (obj: ListChannelsRequest) => any;
809
492
  }
810
- /**
811
- * <p>Summary information about a channel.</p>
812
- */
493
+
813
494
  export interface ChannelSummary {
814
- /**
815
- * <p>Channel ARN.</p>
816
- */
495
+
817
496
  arn?: string;
818
- /**
819
- * <p>Channel name.</p>
820
- */
497
+
821
498
  name?: string;
822
- /**
823
- * <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to Full HD. Use
824
- * <code>LOW</code> for near-real-time interaction with viewers. Default: <code>LOW</code>. (Note: In the Amazon IVS
825
- * console, <code>LOW</code> and <code>NORMAL</code> correspond to Ultra-low and Standard, respectively.)</p>
826
- */
499
+
827
500
  latencyMode?: ChannelLatencyMode | string;
828
- /**
829
- * <p>Whether the channel is private (enabled for playback authorization). Default: <code>false</code>.</p>
830
- */
501
+
831
502
  authorized?: boolean;
832
- /**
833
- * <p>Recording-configuration ARN. A value other than an empty string indicates that recording
834
- * is enabled. Default: "" (empty string, recording is disabled).</p>
835
- */
503
+
836
504
  recordingConfigurationArn?: string;
837
- /**
838
- * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
839
- */
505
+
840
506
  tags?: {
841
507
  [key: string]: string;
842
508
  };
843
509
  }
844
510
  export declare namespace ChannelSummary {
845
- /**
846
- * @internal
847
- */
511
+
848
512
  const filterSensitiveLog: (obj: ChannelSummary) => any;
849
513
  }
850
514
  export interface ListChannelsResponse {
851
- /**
852
- * <p>List of the matching channels.</p>
853
- */
515
+
854
516
  channels: ChannelSummary[] | undefined;
855
- /**
856
- * <p>If there are more channels than <code>maxResults</code>, use <code>nextToken</code> in the
857
- * request to get the next set.</p>
858
- */
517
+
859
518
  nextToken?: string;
860
519
  }
861
520
  export declare namespace ListChannelsResponse {
862
- /**
863
- * @internal
864
- */
521
+
865
522
  const filterSensitiveLog: (obj: ListChannelsResponse) => any;
866
523
  }
867
524
  export interface ListPlaybackKeyPairsRequest {
868
- /**
869
- * <p>Maximum number of key pairs to return.</p>
870
- */
525
+
871
526
  nextToken?: string;
872
- /**
873
- * <p>The first key pair to retrieve. This is used for pagination; see the
874
- * <code>nextToken</code> response field. Default: 50.</p>
875
- */
527
+
876
528
  maxResults?: number;
877
529
  }
878
530
  export declare namespace ListPlaybackKeyPairsRequest {
879
- /**
880
- * @internal
881
- */
531
+
882
532
  const filterSensitiveLog: (obj: ListPlaybackKeyPairsRequest) => any;
883
533
  }
884
- /**
885
- * <p>Summary information about a playback key pair.</p>
886
- */
534
+
887
535
  export interface PlaybackKeyPairSummary {
888
- /**
889
- * <p>Key-pair ARN.</p>
890
- */
536
+
891
537
  arn?: string;
892
- /**
893
- * <p>An arbitrary string (a nickname) assigned to a playback key pair that helps the customer
894
- * identify that resource. The value does not need to be unique.</p>
895
- */
538
+
896
539
  name?: string;
897
- /**
898
- * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
899
- */
540
+
900
541
  tags?: {
901
542
  [key: string]: string;
902
543
  };
903
544
  }
904
545
  export declare namespace PlaybackKeyPairSummary {
905
- /**
906
- * @internal
907
- */
546
+
908
547
  const filterSensitiveLog: (obj: PlaybackKeyPairSummary) => any;
909
548
  }
910
549
  export interface ListPlaybackKeyPairsResponse {
911
- /**
912
- * <p>List of key pairs.</p>
913
- */
550
+
914
551
  keyPairs: PlaybackKeyPairSummary[] | undefined;
915
- /**
916
- * <p>If there are more key pairs than <code>maxResults</code>, use <code>nextToken</code> in
917
- * the request to get the next set.</p>
918
- */
552
+
919
553
  nextToken?: string;
920
554
  }
921
555
  export declare namespace ListPlaybackKeyPairsResponse {
922
- /**
923
- * @internal
924
- */
556
+
925
557
  const filterSensitiveLog: (obj: ListPlaybackKeyPairsResponse) => any;
926
558
  }
927
559
  export interface ListRecordingConfigurationsRequest {
928
- /**
929
- * <p>The first recording configuration to retrieve. This is used for pagination; see the
930
- * <code>nextToken</code> response field.</p>
931
- */
560
+
932
561
  nextToken?: string;
933
- /**
934
- * <p>Maximum number of recording configurations to return. Default: 50. </p>
935
- */
562
+
936
563
  maxResults?: number;
937
564
  }
938
565
  export declare namespace ListRecordingConfigurationsRequest {
939
- /**
940
- * @internal
941
- */
566
+
942
567
  const filterSensitiveLog: (obj: ListRecordingConfigurationsRequest) => any;
943
568
  }
944
- /**
945
- * <p>Summary information about a RecordingConfiguration.</p>
946
- */
569
+
947
570
  export interface RecordingConfigurationSummary {
948
- /**
949
- * <p>Recording-configuration ARN.</p>
950
- */
571
+
951
572
  arn: string | undefined;
952
- /**
953
- * <p>An arbitrary string (a nickname) assigned to a recording configuration that helps the
954
- * customer identify that resource. The value does not need to be unique.</p>
955
- */
573
+
956
574
  name?: string;
957
- /**
958
- * <p>A complex type that contains information about where recorded video will be stored.</p>
959
- */
575
+
960
576
  destinationConfiguration: DestinationConfiguration | undefined;
961
- /**
962
- * <p>Indicates the current state of the recording configuration. When the state is
963
- * <code>ACTIVE</code>, the configuration is ready for recording a channel stream.</p>
964
- */
577
+
965
578
  state: RecordingConfigurationState | string | undefined;
966
- /**
967
- * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
968
- */
579
+
969
580
  tags?: {
970
581
  [key: string]: string;
971
582
  };
972
583
  }
973
584
  export declare namespace RecordingConfigurationSummary {
974
- /**
975
- * @internal
976
- */
585
+
977
586
  const filterSensitiveLog: (obj: RecordingConfigurationSummary) => any;
978
587
  }
979
588
  export interface ListRecordingConfigurationsResponse {
980
- /**
981
- * <p>List of the matching recording configurations.</p>
982
- */
589
+
983
590
  recordingConfigurations: RecordingConfigurationSummary[] | undefined;
984
- /**
985
- * <p>If there are more recording configurations than <code>maxResults</code>, use
986
- * <code>nextToken</code> in the request to get the next set.</p>
987
- */
591
+
988
592
  nextToken?: string;
989
593
  }
990
594
  export declare namespace ListRecordingConfigurationsResponse {
991
- /**
992
- * @internal
993
- */
595
+
994
596
  const filterSensitiveLog: (obj: ListRecordingConfigurationsResponse) => any;
995
597
  }
996
598
  export interface ListStreamKeysRequest {
997
- /**
998
- * <p>Channel ARN used to filter the list.</p>
999
- */
599
+
1000
600
  channelArn: string | undefined;
1001
- /**
1002
- * <p>The first stream key to retrieve. This is used for pagination; see the
1003
- * <code>nextToken</code> response field.</p>
1004
- */
601
+
1005
602
  nextToken?: string;
1006
- /**
1007
- * <p>Maximum number of streamKeys to return. Default: 50.</p>
1008
- */
603
+
1009
604
  maxResults?: number;
1010
605
  }
1011
606
  export declare namespace ListStreamKeysRequest {
1012
- /**
1013
- * @internal
1014
- */
607
+
1015
608
  const filterSensitiveLog: (obj: ListStreamKeysRequest) => any;
1016
609
  }
1017
- /**
1018
- * <p>Summary information about a stream key.</p>
1019
- */
610
+
1020
611
  export interface StreamKeySummary {
1021
- /**
1022
- * <p>Stream-key ARN.</p>
1023
- */
612
+
1024
613
  arn?: string;
1025
- /**
1026
- * <p>Channel ARN for the stream.</p>
1027
- */
614
+
1028
615
  channelArn?: string;
1029
- /**
1030
- * <p>Array of 1-50 maps, each of the form <code>string:string (key:value)</code>.</p>
1031
- */
616
+
1032
617
  tags?: {
1033
618
  [key: string]: string;
1034
619
  };
1035
620
  }
1036
621
  export declare namespace StreamKeySummary {
1037
- /**
1038
- * @internal
1039
- */
622
+
1040
623
  const filterSensitiveLog: (obj: StreamKeySummary) => any;
1041
624
  }
1042
625
  export interface ListStreamKeysResponse {
1043
- /**
1044
- * <p>List of stream keys.</p>
1045
- */
626
+
1046
627
  streamKeys: StreamKeySummary[] | undefined;
1047
- /**
1048
- * <p>If there are more stream keys than <code>maxResults</code>, use <code>nextToken</code> in
1049
- * the request to get the next set.</p>
1050
- */
628
+
1051
629
  nextToken?: string;
1052
630
  }
1053
631
  export declare namespace ListStreamKeysResponse {
1054
- /**
1055
- * @internal
1056
- */
632
+
1057
633
  const filterSensitiveLog: (obj: ListStreamKeysResponse) => any;
1058
634
  }
1059
635
  export interface ListStreamsRequest {
1060
- /**
1061
- * <p>The first stream to retrieve. This is used for pagination; see the <code>nextToken</code>
1062
- * response field.</p>
1063
- */
636
+
1064
637
  nextToken?: string;
1065
- /**
1066
- * <p>Maximum number of streams to return. Default: 50.</p>
1067
- */
638
+
1068
639
  maxResults?: number;
1069
640
  }
1070
641
  export declare namespace ListStreamsRequest {
1071
- /**
1072
- * @internal
1073
- */
642
+
1074
643
  const filterSensitiveLog: (obj: ListStreamsRequest) => any;
1075
644
  }
1076
- /**
1077
- * <p>Summary information about a stream.</p>
1078
- */
645
+
1079
646
  export interface StreamSummary {
1080
- /**
1081
- * <p>Channel ARN for the stream.</p>
1082
- */
647
+
1083
648
  channelArn?: string;
1084
- /**
1085
- * <p>The stream’s state.</p>
1086
- */
649
+
1087
650
  state?: StreamState | string;
1088
- /**
1089
- * <p>The stream’s health.</p>
1090
- */
651
+
1091
652
  health?: StreamHealth | string;
1092
- /**
1093
- * <p>Number of current viewers of the stream. A value of -1 indicates that the request timed
1094
- * out; in this case, retry.</p>
1095
- */
653
+
1096
654
  viewerCount?: number;
1097
- /**
1098
- * <p>ISO-8601 formatted timestamp of the stream’s start.</p>
1099
- */
655
+
1100
656
  startTime?: Date;
1101
657
  }
1102
658
  export declare namespace StreamSummary {
1103
- /**
1104
- * @internal
1105
- */
659
+
1106
660
  const filterSensitiveLog: (obj: StreamSummary) => any;
1107
661
  }
1108
662
  export interface ListStreamsResponse {
1109
- /**
1110
- * <p>List of streams.</p>
1111
- */
663
+
1112
664
  streams: StreamSummary[] | undefined;
1113
- /**
1114
- * <p>If there are more streams than <code>maxResults</code>, use <code>nextToken</code> in the
1115
- * request to get the next set.</p>
1116
- */
665
+
1117
666
  nextToken?: string;
1118
667
  }
1119
668
  export declare namespace ListStreamsResponse {
1120
- /**
1121
- * @internal
1122
- */
669
+
1123
670
  const filterSensitiveLog: (obj: ListStreamsResponse) => any;
1124
671
  }
1125
672
  export interface ListTagsForResourceRequest {
1126
- /**
1127
- * <p>The ARN of the resource to be retrieved.</p>
1128
- */
673
+
1129
674
  resourceArn: string | undefined;
1130
- /**
1131
- * <p>The first tag to retrieve. This is used for pagination; see the <code>nextToken</code>
1132
- * response field.</p>
1133
- */
675
+
1134
676
  nextToken?: string;
1135
- /**
1136
- * <p>Maximum number of tags to return. Default: 50.</p>
1137
- */
677
+
1138
678
  maxResults?: number;
1139
679
  }
1140
680
  export declare namespace ListTagsForResourceRequest {
1141
- /**
1142
- * @internal
1143
- */
681
+
1144
682
  const filterSensitiveLog: (obj: ListTagsForResourceRequest) => any;
1145
683
  }
1146
684
  export interface ListTagsForResourceResponse {
1147
685
  tags: {
1148
686
  [key: string]: string;
1149
687
  } | undefined;
1150
- /**
1151
- * <p>If there are more tags than <code>maxResults</code>, use <code>nextToken</code> in the
1152
- * request to get the next set.</p>
1153
- */
688
+
1154
689
  nextToken?: string;
1155
690
  }
1156
691
  export declare namespace ListTagsForResourceResponse {
1157
- /**
1158
- * @internal
1159
- */
692
+
1160
693
  const filterSensitiveLog: (obj: ListTagsForResourceResponse) => any;
1161
694
  }
1162
695
  export interface PutMetadataRequest {
1163
- /**
1164
- * <p>ARN of the channel into which metadata is inserted. This channel must have an active
1165
- * stream.</p>
1166
- */
696
+
1167
697
  channelArn: string | undefined;
1168
- /**
1169
- * <p>Metadata to insert into the stream. Maximum: 1 KB per request.</p>
1170
- */
698
+
1171
699
  metadata: string | undefined;
1172
700
  }
1173
701
  export declare namespace PutMetadataRequest {
1174
- /**
1175
- * @internal
1176
- */
702
+
1177
703
  const filterSensitiveLog: (obj: PutMetadataRequest) => any;
1178
704
  }
1179
705
  export interface ThrottlingException extends __SmithyException, $MetadataBearer {
1180
706
  name: "ThrottlingException";
1181
707
  $fault: "client";
1182
- /**
1183
- * <p>Request was denied due to request throttling.</p>
1184
- */
708
+
1185
709
  exceptionMessage?: string;
1186
710
  }
1187
711
  export declare namespace ThrottlingException {
1188
- /**
1189
- * @internal
1190
- */
712
+
1191
713
  const filterSensitiveLog: (obj: ThrottlingException) => any;
1192
714
  }
1193
715
  export interface StopStreamRequest {
1194
- /**
1195
- * <p>ARN of the channel for which the stream is to be stopped.</p>
1196
- */
716
+
1197
717
  channelArn: string | undefined;
1198
718
  }
1199
719
  export declare namespace StopStreamRequest {
1200
- /**
1201
- * @internal
1202
- */
720
+
1203
721
  const filterSensitiveLog: (obj: StopStreamRequest) => any;
1204
722
  }
1205
723
  export interface StopStreamResponse {
1206
724
  }
1207
725
  export declare namespace StopStreamResponse {
1208
- /**
1209
- * @internal
1210
- */
726
+
1211
727
  const filterSensitiveLog: (obj: StopStreamResponse) => any;
1212
728
  }
1213
729
  export interface StreamUnavailable extends __SmithyException, $MetadataBearer {
1214
730
  name: "StreamUnavailable";
1215
731
  $fault: "server";
1216
- /**
1217
- * <p>The stream is temporarily unavailable.</p>
1218
- */
732
+
1219
733
  exceptionMessage?: string;
1220
734
  }
1221
735
  export declare namespace StreamUnavailable {
1222
- /**
1223
- * @internal
1224
- */
736
+
1225
737
  const filterSensitiveLog: (obj: StreamUnavailable) => any;
1226
738
  }
1227
739
  export interface TagResourceRequest {
1228
- /**
1229
- * <p>ARN of the resource for which tags are to be added or updated.</p>
1230
- */
740
+
1231
741
  resourceArn: string | undefined;
1232
- /**
1233
- * <p>Array of tags to be added or updated.</p>
1234
- */
742
+
1235
743
  tags: {
1236
744
  [key: string]: string;
1237
745
  } | undefined;
1238
746
  }
1239
747
  export declare namespace TagResourceRequest {
1240
- /**
1241
- * @internal
1242
- */
748
+
1243
749
  const filterSensitiveLog: (obj: TagResourceRequest) => any;
1244
750
  }
1245
751
  export interface TagResourceResponse {
1246
752
  }
1247
753
  export declare namespace TagResourceResponse {
1248
- /**
1249
- * @internal
1250
- */
754
+
1251
755
  const filterSensitiveLog: (obj: TagResourceResponse) => any;
1252
756
  }
1253
757
  export interface UntagResourceRequest {
1254
- /**
1255
- * <p>ARN of the resource for which tags are to be removed.</p>
1256
- */
758
+
1257
759
  resourceArn: string | undefined;
1258
- /**
1259
- * <p>Array of tags to be removed.</p>
1260
- */
760
+
1261
761
  tagKeys: string[] | undefined;
1262
762
  }
1263
763
  export declare namespace UntagResourceRequest {
1264
- /**
1265
- * @internal
1266
- */
764
+
1267
765
  const filterSensitiveLog: (obj: UntagResourceRequest) => any;
1268
766
  }
1269
767
  export interface UntagResourceResponse {
1270
768
  }
1271
769
  export declare namespace UntagResourceResponse {
1272
- /**
1273
- * @internal
1274
- */
770
+
1275
771
  const filterSensitiveLog: (obj: UntagResourceResponse) => any;
1276
772
  }
1277
773
  export interface UpdateChannelRequest {
1278
- /**
1279
- * <p>ARN of the channel to be updated.</p>
1280
- */
774
+
1281
775
  arn: string | undefined;
1282
- /**
1283
- * <p>Channel name.</p>
1284
- */
776
+
1285
777
  name?: string;
1286
- /**
1287
- * <p>Channel latency mode. Use <code>NORMAL</code> to broadcast and deliver live video up to Full HD. Use
1288
- * <code>LOW</code> for near-real-time interaction with viewers. (Note: In the Amazon IVS console,
1289
- * <code>LOW</code> and <code>NORMAL</code> correspond to Ultra-low and Standard,
1290
- * respectively.)</p>
1291
- */
778
+
1292
779
  latencyMode?: ChannelLatencyMode | string;
1293
- /**
1294
- * <p>Channel type, which determines the allowable resolution and bitrate. <i>If you
1295
- * exceed the allowable resolution or bitrate, the stream probably will disconnect
1296
- * immediately</i>. Valid values:</p>
1297
- * <ul>
1298
- * <li>
1299
- * <p>
1300
- * <code>STANDARD</code>: Multiple qualities are generated from the original input, to
1301
- * automatically give viewers the best experience for their devices and network conditions.
1302
- * Vertical resolution can be up to 1080 and bitrate can be up to 8.5 Mbps.</p>
1303
- * </li>
1304
- * <li>
1305
- * <p>
1306
- * <code>BASIC</code>: Amazon IVS delivers the original input to viewers. The viewer’s
1307
- * video-quality choice is limited to the original input. Vertical resolution can be up to
1308
- * 480 and bitrate can be up to 1.5 Mbps.</p>
1309
- * </li>
1310
- * </ul>
1311
- */
780
+
1312
781
  type?: ChannelType | string;
1313
- /**
1314
- * <p>Whether the channel is private (enabled for playback authorization).</p>
1315
- */
782
+
1316
783
  authorized?: boolean;
1317
- /**
1318
- * <p>Recording-configuration ARN. If this is set to an empty string, recording is disabled. A
1319
- * value other than an empty string indicates that recording is enabled</p>
1320
- */
784
+
1321
785
  recordingConfigurationArn?: string;
1322
786
  }
1323
787
  export declare namespace UpdateChannelRequest {
1324
- /**
1325
- * @internal
1326
- */
788
+
1327
789
  const filterSensitiveLog: (obj: UpdateChannelRequest) => any;
1328
790
  }
1329
791
  export interface UpdateChannelResponse {
1330
- /**
1331
- * <p>Object specifying a channel.</p>
1332
- */
792
+
1333
793
  channel?: Channel;
1334
794
  }
1335
795
  export declare namespace UpdateChannelResponse {
1336
- /**
1337
- * @internal
1338
- */
796
+
1339
797
  const filterSensitiveLog: (obj: UpdateChannelResponse) => any;
1340
798
  }