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