@aws-sdk/client-machine-learning 3.34.0 → 3.37.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 (380) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/{dist/cjs → dist-cjs}/MachineLearning.js +1 -6
  3. package/{dist/cjs → dist-cjs}/MachineLearningClient.js +8 -18
  4. package/{dist/cjs → dist-cjs}/commands/AddTagsCommand.js +2 -29
  5. package/dist-cjs/commands/CreateBatchPredictionCommand.js +36 -0
  6. package/dist-cjs/commands/CreateDataSourceFromRDSCommand.js +36 -0
  7. package/dist-cjs/commands/CreateDataSourceFromRedshiftCommand.js +36 -0
  8. package/dist-cjs/commands/CreateDataSourceFromS3Command.js +36 -0
  9. package/dist-cjs/commands/CreateEvaluationCommand.js +36 -0
  10. package/dist-cjs/commands/CreateMLModelCommand.js +36 -0
  11. package/{dist/cjs → dist-cjs}/commands/CreateRealtimeEndpointCommand.js +2 -27
  12. package/{dist/cjs → dist-cjs}/commands/DeleteBatchPredictionCommand.js +2 -32
  13. package/{dist/cjs → dist-cjs}/commands/DeleteDataSourceCommand.js +2 -30
  14. package/{dist/cjs → dist-cjs}/commands/DeleteEvaluationCommand.js +2 -32
  15. package/{dist/cjs → dist-cjs}/commands/DeleteMLModelCommand.js +2 -32
  16. package/{dist/cjs → dist-cjs}/commands/DeleteRealtimeEndpointCommand.js +2 -27
  17. package/{dist/cjs → dist-cjs}/commands/DeleteTagsCommand.js +2 -28
  18. package/{dist/cjs → dist-cjs}/commands/DescribeBatchPredictionsCommand.js +2 -27
  19. package/{dist/cjs → dist-cjs}/commands/DescribeDataSourcesCommand.js +2 -27
  20. package/{dist/cjs → dist-cjs}/commands/DescribeEvaluationsCommand.js +2 -27
  21. package/{dist/cjs → dist-cjs}/commands/DescribeMLModelsCommand.js +2 -27
  22. package/{dist/cjs → dist-cjs}/commands/DescribeTagsCommand.js +2 -27
  23. package/{dist/cjs → dist-cjs}/commands/GetBatchPredictionCommand.js +2 -28
  24. package/{dist/cjs → dist-cjs}/commands/GetDataSourceCommand.js +2 -30
  25. package/{dist/cjs → dist-cjs}/commands/GetEvaluationCommand.js +2 -27
  26. package/{dist/cjs → dist-cjs}/commands/GetMLModelCommand.js +2 -29
  27. package/{dist/cjs → dist-cjs}/commands/PredictCommand.js +2 -30
  28. package/{dist/cjs → dist-cjs}/commands/UpdateBatchPredictionCommand.js +2 -28
  29. package/{dist/cjs → dist-cjs}/commands/UpdateDataSourceCommand.js +2 -28
  30. package/{dist/cjs → dist-cjs}/commands/UpdateEvaluationCommand.js +2 -28
  31. package/{dist/cjs → dist-cjs}/commands/UpdateMLModelCommand.js +2 -28
  32. package/{dist/cjs → dist-cjs}/endpoints.js +1 -2
  33. package/{dist/cjs → dist-cjs}/index.js +0 -1
  34. package/{dist/cjs → dist-cjs}/models/index.js +0 -1
  35. package/{dist/cjs → dist-cjs}/models/models_0.js +0 -244
  36. package/{dist/cjs → dist-cjs}/pagination/DescribeBatchPredictionsPaginator.js +1 -12
  37. package/{dist/cjs → dist-cjs}/pagination/DescribeDataSourcesPaginator.js +1 -12
  38. package/{dist/cjs → dist-cjs}/pagination/DescribeEvaluationsPaginator.js +1 -12
  39. package/{dist/cjs → dist-cjs}/pagination/DescribeMLModelsPaginator.js +1 -12
  40. package/{dist/cjs → dist-cjs}/pagination/Interfaces.js +0 -1
  41. package/{dist/cjs → dist-cjs}/protocols/Aws_json1_1.js +0 -6
  42. package/{dist/cjs → dist-cjs}/runtimeConfig.browser.js +1 -5
  43. package/{dist/cjs → dist-cjs}/runtimeConfig.js +1 -5
  44. package/{dist/cjs → dist-cjs}/runtimeConfig.native.js +0 -4
  45. package/{dist/cjs → dist-cjs}/runtimeConfig.shared.js +1 -5
  46. package/{dist/cjs → dist-cjs}/waiters/waitForBatchPredictionAvailable.js +10 -20
  47. package/{dist/cjs → dist-cjs}/waiters/waitForDataSourceAvailable.js +10 -20
  48. package/{dist/cjs → dist-cjs}/waiters/waitForEvaluationAvailable.js +10 -20
  49. package/{dist/cjs → dist-cjs}/waiters/waitForMLModelAvailable.js +10 -20
  50. package/{dist/es → dist-es}/MachineLearning.js +1 -2
  51. package/{dist/es → dist-es}/MachineLearningClient.js +1 -2
  52. package/{dist/es → dist-es}/commands/AddTagsCommand.js +2 -3
  53. package/{dist/es → dist-es}/commands/CreateBatchPredictionCommand.js +2 -3
  54. package/{dist/es → dist-es}/commands/CreateDataSourceFromRDSCommand.js +2 -3
  55. package/{dist/es → dist-es}/commands/CreateDataSourceFromRedshiftCommand.js +2 -3
  56. package/{dist/es → dist-es}/commands/CreateDataSourceFromS3Command.js +2 -3
  57. package/{dist/es → dist-es}/commands/CreateEvaluationCommand.js +2 -3
  58. package/{dist/es → dist-es}/commands/CreateMLModelCommand.js +2 -3
  59. package/{dist/es → dist-es}/commands/CreateRealtimeEndpointCommand.js +2 -3
  60. package/{dist/es → dist-es}/commands/DeleteBatchPredictionCommand.js +2 -3
  61. package/{dist/es → dist-es}/commands/DeleteDataSourceCommand.js +2 -3
  62. package/{dist/es → dist-es}/commands/DeleteEvaluationCommand.js +2 -3
  63. package/{dist/es → dist-es}/commands/DeleteMLModelCommand.js +2 -3
  64. package/{dist/es → dist-es}/commands/DeleteRealtimeEndpointCommand.js +2 -3
  65. package/{dist/es → dist-es}/commands/DeleteTagsCommand.js +2 -3
  66. package/{dist/es → dist-es}/commands/DescribeBatchPredictionsCommand.js +2 -3
  67. package/{dist/es → dist-es}/commands/DescribeDataSourcesCommand.js +2 -3
  68. package/{dist/es → dist-es}/commands/DescribeEvaluationsCommand.js +2 -3
  69. package/{dist/es → dist-es}/commands/DescribeMLModelsCommand.js +2 -3
  70. package/{dist/es → dist-es}/commands/DescribeTagsCommand.js +2 -3
  71. package/{dist/es → dist-es}/commands/GetBatchPredictionCommand.js +2 -3
  72. package/{dist/es → dist-es}/commands/GetDataSourceCommand.js +2 -3
  73. package/{dist/es → dist-es}/commands/GetEvaluationCommand.js +2 -3
  74. package/{dist/es → dist-es}/commands/GetMLModelCommand.js +2 -3
  75. package/{dist/es → dist-es}/commands/PredictCommand.js +2 -3
  76. package/{dist/es → dist-es}/commands/UpdateBatchPredictionCommand.js +2 -3
  77. package/{dist/es → dist-es}/commands/UpdateDataSourceCommand.js +2 -3
  78. package/{dist/es → dist-es}/commands/UpdateEvaluationCommand.js +2 -3
  79. package/{dist/es → dist-es}/commands/UpdateMLModelCommand.js +2 -3
  80. package/{dist/es → dist-es}/endpoints.js +1 -2
  81. package/{dist/types/index.d.ts → dist-es/index.js} +0 -0
  82. package/{dist/types/models/index.d.ts → dist-es/models/index.js} +0 -0
  83. package/{dist/es → dist-es}/models/models_0.js +0 -1
  84. package/{dist/es → dist-es}/pagination/DescribeBatchPredictionsPaginator.js +1 -2
  85. package/{dist/es → dist-es}/pagination/DescribeDataSourcesPaginator.js +1 -2
  86. package/{dist/es → dist-es}/pagination/DescribeEvaluationsPaginator.js +1 -2
  87. package/{dist/es → dist-es}/pagination/DescribeMLModelsPaginator.js +1 -2
  88. package/dist-es/pagination/Interfaces.js +1 -0
  89. package/{dist/es → dist-es}/protocols/Aws_json1_1.js +0 -1
  90. package/{dist/es → dist-es}/runtimeConfig.browser.js +1 -2
  91. package/{dist/es → dist-es}/runtimeConfig.js +1 -2
  92. package/{dist/es → dist-es}/runtimeConfig.native.js +0 -1
  93. package/{dist/es → dist-es}/runtimeConfig.shared.js +1 -2
  94. package/{dist/es → dist-es}/waiters/waitForBatchPredictionAvailable.js +1 -2
  95. package/{dist/es → dist-es}/waiters/waitForDataSourceAvailable.js +1 -2
  96. package/{dist/es → dist-es}/waiters/waitForEvaluationAvailable.js +1 -2
  97. package/{dist/es → dist-es}/waiters/waitForMLModelAvailable.js +1 -2
  98. package/{dist/types → dist-types}/MachineLearning.d.ts +2 -2
  99. package/{dist/types → dist-types}/MachineLearningClient.d.ts +8 -8
  100. package/{dist/types → dist-types}/commands/AddTagsCommand.d.ts +2 -2
  101. package/{dist/types → dist-types}/commands/CreateBatchPredictionCommand.d.ts +2 -2
  102. package/{dist/types → dist-types}/commands/CreateDataSourceFromRDSCommand.d.ts +2 -2
  103. package/{dist/types → dist-types}/commands/CreateDataSourceFromRedshiftCommand.d.ts +2 -2
  104. package/{dist/types → dist-types}/commands/CreateDataSourceFromS3Command.d.ts +2 -2
  105. package/{dist/types → dist-types}/commands/CreateEvaluationCommand.d.ts +2 -2
  106. package/{dist/types → dist-types}/commands/CreateMLModelCommand.d.ts +2 -2
  107. package/{dist/types → dist-types}/commands/CreateRealtimeEndpointCommand.d.ts +2 -2
  108. package/{dist/types → dist-types}/commands/DeleteBatchPredictionCommand.d.ts +2 -2
  109. package/{dist/types → dist-types}/commands/DeleteDataSourceCommand.d.ts +2 -2
  110. package/{dist/types → dist-types}/commands/DeleteEvaluationCommand.d.ts +2 -2
  111. package/{dist/types → dist-types}/commands/DeleteMLModelCommand.d.ts +2 -2
  112. package/{dist/types → dist-types}/commands/DeleteRealtimeEndpointCommand.d.ts +2 -2
  113. package/{dist/types → dist-types}/commands/DeleteTagsCommand.d.ts +2 -2
  114. package/{dist/types → dist-types}/commands/DescribeBatchPredictionsCommand.d.ts +2 -2
  115. package/{dist/types → dist-types}/commands/DescribeDataSourcesCommand.d.ts +2 -2
  116. package/{dist/types → dist-types}/commands/DescribeEvaluationsCommand.d.ts +2 -2
  117. package/{dist/types → dist-types}/commands/DescribeMLModelsCommand.d.ts +2 -2
  118. package/{dist/types → dist-types}/commands/DescribeTagsCommand.d.ts +2 -2
  119. package/{dist/types → dist-types}/commands/GetBatchPredictionCommand.d.ts +2 -2
  120. package/{dist/types → dist-types}/commands/GetDataSourceCommand.d.ts +2 -2
  121. package/{dist/types → dist-types}/commands/GetEvaluationCommand.d.ts +2 -2
  122. package/{dist/types → dist-types}/commands/GetMLModelCommand.d.ts +2 -2
  123. package/{dist/types → dist-types}/commands/PredictCommand.d.ts +2 -2
  124. package/{dist/types → dist-types}/commands/UpdateBatchPredictionCommand.d.ts +2 -2
  125. package/{dist/types → dist-types}/commands/UpdateDataSourceCommand.d.ts +2 -2
  126. package/{dist/types → dist-types}/commands/UpdateEvaluationCommand.d.ts +2 -2
  127. package/{dist/types → dist-types}/commands/UpdateMLModelCommand.d.ts +2 -2
  128. package/{dist/types → dist-types}/endpoints.d.ts +0 -0
  129. package/{index.ts → dist-types/index.d.ts} +0 -0
  130. package/{models/index.ts → dist-types/models/index.d.ts} +0 -0
  131. package/{dist/types → dist-types}/models/models_0.d.ts +0 -0
  132. package/{dist/types → dist-types}/pagination/DescribeBatchPredictionsPaginator.d.ts +1 -1
  133. package/{dist/types → dist-types}/pagination/DescribeDataSourcesPaginator.d.ts +1 -1
  134. package/{dist/types → dist-types}/pagination/DescribeEvaluationsPaginator.d.ts +1 -1
  135. package/{dist/types → dist-types}/pagination/DescribeMLModelsPaginator.d.ts +1 -1
  136. package/{dist/types → dist-types}/pagination/Interfaces.d.ts +1 -1
  137. package/{dist/types → dist-types}/protocols/Aws_json1_1.d.ts +2 -2
  138. package/{dist/types → dist-types}/runtimeConfig.browser.d.ts +0 -0
  139. package/{dist/types → dist-types}/runtimeConfig.d.ts +1 -1
  140. package/{dist/types → dist-types}/runtimeConfig.native.d.ts +0 -0
  141. package/{dist/types → dist-types}/runtimeConfig.shared.d.ts +0 -0
  142. package/dist-types/ts3.4/MachineLearning.d.ts +145 -0
  143. package/{dist/types → dist-types}/ts3.4/MachineLearningClient.d.ts +32 -98
  144. package/dist-types/ts3.4/commands/AddTagsCommand.d.ts +17 -0
  145. package/dist-types/ts3.4/commands/CreateBatchPredictionCommand.d.ts +17 -0
  146. package/dist-types/ts3.4/commands/CreateDataSourceFromRDSCommand.d.ts +17 -0
  147. package/dist-types/ts3.4/commands/CreateDataSourceFromRedshiftCommand.d.ts +17 -0
  148. package/dist-types/ts3.4/commands/CreateDataSourceFromS3Command.d.ts +17 -0
  149. package/dist-types/ts3.4/commands/CreateEvaluationCommand.d.ts +17 -0
  150. package/dist-types/ts3.4/commands/CreateMLModelCommand.d.ts +17 -0
  151. package/dist-types/ts3.4/commands/CreateRealtimeEndpointCommand.d.ts +17 -0
  152. package/dist-types/ts3.4/commands/DeleteBatchPredictionCommand.d.ts +17 -0
  153. package/dist-types/ts3.4/commands/DeleteDataSourceCommand.d.ts +17 -0
  154. package/dist-types/ts3.4/commands/DeleteEvaluationCommand.d.ts +17 -0
  155. package/dist-types/ts3.4/commands/DeleteMLModelCommand.d.ts +17 -0
  156. package/{dist/types → dist-types}/ts3.4/commands/DeleteRealtimeEndpointCommand.d.ts +4 -22
  157. package/dist-types/ts3.4/commands/DeleteTagsCommand.d.ts +17 -0
  158. package/dist-types/ts3.4/commands/DescribeBatchPredictionsCommand.d.ts +17 -0
  159. package/dist-types/ts3.4/commands/DescribeDataSourcesCommand.d.ts +17 -0
  160. package/dist-types/ts3.4/commands/DescribeEvaluationsCommand.d.ts +17 -0
  161. package/dist-types/ts3.4/commands/DescribeMLModelsCommand.d.ts +17 -0
  162. package/dist-types/ts3.4/commands/DescribeTagsCommand.d.ts +17 -0
  163. package/dist-types/ts3.4/commands/GetBatchPredictionCommand.d.ts +17 -0
  164. package/dist-types/ts3.4/commands/GetDataSourceCommand.d.ts +17 -0
  165. package/dist-types/ts3.4/commands/GetEvaluationCommand.d.ts +17 -0
  166. package/dist-types/ts3.4/commands/GetMLModelCommand.d.ts +17 -0
  167. package/dist-types/ts3.4/commands/PredictCommand.d.ts +17 -0
  168. package/dist-types/ts3.4/commands/UpdateBatchPredictionCommand.d.ts +17 -0
  169. package/dist-types/ts3.4/commands/UpdateDataSourceCommand.d.ts +17 -0
  170. package/dist-types/ts3.4/commands/UpdateEvaluationCommand.d.ts +17 -0
  171. package/dist-types/ts3.4/commands/UpdateMLModelCommand.d.ts +17 -0
  172. package/{dist/types → dist-types}/ts3.4/endpoints.d.ts +0 -0
  173. package/{dist/types → dist-types}/ts3.4/index.d.ts +0 -0
  174. package/{dist/types → dist-types}/ts3.4/models/index.d.ts +0 -0
  175. package/dist-types/ts3.4/models/models_0.d.ts +1312 -0
  176. package/{dist/types → dist-types}/ts3.4/pagination/DescribeBatchPredictionsPaginator.d.ts +1 -1
  177. package/{dist/types → dist-types}/ts3.4/pagination/DescribeDataSourcesPaginator.d.ts +1 -1
  178. package/{dist/types → dist-types}/ts3.4/pagination/DescribeEvaluationsPaginator.d.ts +1 -1
  179. package/{dist/types → dist-types}/ts3.4/pagination/DescribeMLModelsPaginator.d.ts +1 -1
  180. package/{dist/types → dist-types}/ts3.4/pagination/Interfaces.d.ts +1 -1
  181. package/{dist/types → dist-types}/ts3.4/protocols/Aws_json1_1.d.ts +2 -2
  182. package/{dist/types → dist-types}/ts3.4/runtimeConfig.browser.d.ts +1 -3
  183. package/{dist/types → dist-types}/ts3.4/runtimeConfig.d.ts +2 -4
  184. package/{dist/types → dist-types}/ts3.4/runtimeConfig.native.d.ts +1 -3
  185. package/{dist/types → dist-types}/ts3.4/runtimeConfig.shared.d.ts +1 -3
  186. package/{dist/types → dist-types}/ts3.4/waiters/waitForBatchPredictionAvailable.d.ts +4 -11
  187. package/{dist/types → dist-types}/ts3.4/waiters/waitForDataSourceAvailable.d.ts +4 -11
  188. package/{dist/types → dist-types}/ts3.4/waiters/waitForEvaluationAvailable.d.ts +4 -11
  189. package/{dist/types → dist-types}/ts3.4/waiters/waitForMLModelAvailable.d.ts +4 -11
  190. package/{dist/types → dist-types}/waiters/waitForBatchPredictionAvailable.d.ts +2 -2
  191. package/{dist/types → dist-types}/waiters/waitForDataSourceAvailable.d.ts +2 -2
  192. package/{dist/types → dist-types}/waiters/waitForEvaluationAvailable.d.ts +2 -2
  193. package/{dist/types → dist-types}/waiters/waitForMLModelAvailable.d.ts +2 -2
  194. package/package.json +47 -44
  195. package/MachineLearning.ts +0 -1149
  196. package/MachineLearningClient.ts +0 -353
  197. package/commands/AddTagsCommand.ts +0 -93
  198. package/commands/CreateBatchPredictionCommand.ts +0 -105
  199. package/commands/CreateDataSourceFromRDSCommand.ts +0 -105
  200. package/commands/CreateDataSourceFromRedshiftCommand.ts +0 -131
  201. package/commands/CreateDataSourceFromS3Command.ts +0 -124
  202. package/commands/CreateEvaluationCommand.ts +0 -105
  203. package/commands/CreateMLModelCommand.ts +0 -113
  204. package/commands/CreateRealtimeEndpointCommand.ts +0 -94
  205. package/commands/DeleteBatchPredictionCommand.ts +0 -99
  206. package/commands/DeleteDataSourceCommand.ts +0 -97
  207. package/commands/DeleteEvaluationCommand.ts +0 -99
  208. package/commands/DeleteMLModelCommand.ts +0 -99
  209. package/commands/DeleteRealtimeEndpointCommand.ts +0 -94
  210. package/commands/DeleteTagsCommand.ts +0 -95
  211. package/commands/DescribeBatchPredictionsCommand.ts +0 -94
  212. package/commands/DescribeDataSourcesCommand.ts +0 -94
  213. package/commands/DescribeEvaluationsCommand.ts +0 -94
  214. package/commands/DescribeMLModelsCommand.ts +0 -94
  215. package/commands/DescribeTagsCommand.ts +0 -94
  216. package/commands/GetBatchPredictionCommand.ts +0 -95
  217. package/commands/GetDataSourceCommand.ts +0 -97
  218. package/commands/GetEvaluationCommand.ts +0 -94
  219. package/commands/GetMLModelCommand.ts +0 -96
  220. package/commands/PredictCommand.ts +0 -96
  221. package/commands/UpdateBatchPredictionCommand.ts +0 -95
  222. package/commands/UpdateDataSourceCommand.ts +0 -95
  223. package/commands/UpdateEvaluationCommand.ts +0 -95
  224. package/commands/UpdateMLModelCommand.ts +0 -95
  225. package/dist/cjs/MachineLearning.js.map +0 -1
  226. package/dist/cjs/MachineLearningClient.js.map +0 -1
  227. package/dist/cjs/commands/AddTagsCommand.js.map +0 -1
  228. package/dist/cjs/commands/CreateBatchPredictionCommand.js +0 -72
  229. package/dist/cjs/commands/CreateBatchPredictionCommand.js.map +0 -1
  230. package/dist/cjs/commands/CreateDataSourceFromRDSCommand.js +0 -72
  231. package/dist/cjs/commands/CreateDataSourceFromRDSCommand.js.map +0 -1
  232. package/dist/cjs/commands/CreateDataSourceFromRedshiftCommand.js +0 -93
  233. package/dist/cjs/commands/CreateDataSourceFromRedshiftCommand.js.map +0 -1
  234. package/dist/cjs/commands/CreateDataSourceFromS3Command.js +0 -91
  235. package/dist/cjs/commands/CreateDataSourceFromS3Command.js.map +0 -1
  236. package/dist/cjs/commands/CreateEvaluationCommand.js +0 -72
  237. package/dist/cjs/commands/CreateEvaluationCommand.js.map +0 -1
  238. package/dist/cjs/commands/CreateMLModelCommand.js +0 -80
  239. package/dist/cjs/commands/CreateMLModelCommand.js.map +0 -1
  240. package/dist/cjs/commands/CreateRealtimeEndpointCommand.js.map +0 -1
  241. package/dist/cjs/commands/DeleteBatchPredictionCommand.js.map +0 -1
  242. package/dist/cjs/commands/DeleteDataSourceCommand.js.map +0 -1
  243. package/dist/cjs/commands/DeleteEvaluationCommand.js.map +0 -1
  244. package/dist/cjs/commands/DeleteMLModelCommand.js.map +0 -1
  245. package/dist/cjs/commands/DeleteRealtimeEndpointCommand.js.map +0 -1
  246. package/dist/cjs/commands/DeleteTagsCommand.js.map +0 -1
  247. package/dist/cjs/commands/DescribeBatchPredictionsCommand.js.map +0 -1
  248. package/dist/cjs/commands/DescribeDataSourcesCommand.js.map +0 -1
  249. package/dist/cjs/commands/DescribeEvaluationsCommand.js.map +0 -1
  250. package/dist/cjs/commands/DescribeMLModelsCommand.js.map +0 -1
  251. package/dist/cjs/commands/DescribeTagsCommand.js.map +0 -1
  252. package/dist/cjs/commands/GetBatchPredictionCommand.js.map +0 -1
  253. package/dist/cjs/commands/GetDataSourceCommand.js.map +0 -1
  254. package/dist/cjs/commands/GetEvaluationCommand.js.map +0 -1
  255. package/dist/cjs/commands/GetMLModelCommand.js.map +0 -1
  256. package/dist/cjs/commands/PredictCommand.js.map +0 -1
  257. package/dist/cjs/commands/UpdateBatchPredictionCommand.js.map +0 -1
  258. package/dist/cjs/commands/UpdateDataSourceCommand.js.map +0 -1
  259. package/dist/cjs/commands/UpdateEvaluationCommand.js.map +0 -1
  260. package/dist/cjs/commands/UpdateMLModelCommand.js.map +0 -1
  261. package/dist/cjs/endpoints.js.map +0 -1
  262. package/dist/cjs/index.js.map +0 -1
  263. package/dist/cjs/models/index.js.map +0 -1
  264. package/dist/cjs/models/models_0.js.map +0 -1
  265. package/dist/cjs/package.json +0 -93
  266. package/dist/cjs/pagination/DescribeBatchPredictionsPaginator.js.map +0 -1
  267. package/dist/cjs/pagination/DescribeDataSourcesPaginator.js.map +0 -1
  268. package/dist/cjs/pagination/DescribeEvaluationsPaginator.js.map +0 -1
  269. package/dist/cjs/pagination/DescribeMLModelsPaginator.js.map +0 -1
  270. package/dist/cjs/pagination/Interfaces.js.map +0 -1
  271. package/dist/cjs/protocols/Aws_json1_1.js.map +0 -1
  272. package/dist/cjs/runtimeConfig.browser.js.map +0 -1
  273. package/dist/cjs/runtimeConfig.js.map +0 -1
  274. package/dist/cjs/runtimeConfig.native.js.map +0 -1
  275. package/dist/cjs/runtimeConfig.shared.js.map +0 -1
  276. package/dist/cjs/waiters/waitForBatchPredictionAvailable.js.map +0 -1
  277. package/dist/cjs/waiters/waitForDataSourceAvailable.js.map +0 -1
  278. package/dist/cjs/waiters/waitForEvaluationAvailable.js.map +0 -1
  279. package/dist/cjs/waiters/waitForMLModelAvailable.js.map +0 -1
  280. package/dist/es/MachineLearning.js.map +0 -1
  281. package/dist/es/MachineLearningClient.js.map +0 -1
  282. package/dist/es/commands/AddTagsCommand.js.map +0 -1
  283. package/dist/es/commands/CreateBatchPredictionCommand.js.map +0 -1
  284. package/dist/es/commands/CreateDataSourceFromRDSCommand.js.map +0 -1
  285. package/dist/es/commands/CreateDataSourceFromRedshiftCommand.js.map +0 -1
  286. package/dist/es/commands/CreateDataSourceFromS3Command.js.map +0 -1
  287. package/dist/es/commands/CreateEvaluationCommand.js.map +0 -1
  288. package/dist/es/commands/CreateMLModelCommand.js.map +0 -1
  289. package/dist/es/commands/CreateRealtimeEndpointCommand.js.map +0 -1
  290. package/dist/es/commands/DeleteBatchPredictionCommand.js.map +0 -1
  291. package/dist/es/commands/DeleteDataSourceCommand.js.map +0 -1
  292. package/dist/es/commands/DeleteEvaluationCommand.js.map +0 -1
  293. package/dist/es/commands/DeleteMLModelCommand.js.map +0 -1
  294. package/dist/es/commands/DeleteRealtimeEndpointCommand.js.map +0 -1
  295. package/dist/es/commands/DeleteTagsCommand.js.map +0 -1
  296. package/dist/es/commands/DescribeBatchPredictionsCommand.js.map +0 -1
  297. package/dist/es/commands/DescribeDataSourcesCommand.js.map +0 -1
  298. package/dist/es/commands/DescribeEvaluationsCommand.js.map +0 -1
  299. package/dist/es/commands/DescribeMLModelsCommand.js.map +0 -1
  300. package/dist/es/commands/DescribeTagsCommand.js.map +0 -1
  301. package/dist/es/commands/GetBatchPredictionCommand.js.map +0 -1
  302. package/dist/es/commands/GetDataSourceCommand.js.map +0 -1
  303. package/dist/es/commands/GetEvaluationCommand.js.map +0 -1
  304. package/dist/es/commands/GetMLModelCommand.js.map +0 -1
  305. package/dist/es/commands/PredictCommand.js.map +0 -1
  306. package/dist/es/commands/UpdateBatchPredictionCommand.js.map +0 -1
  307. package/dist/es/commands/UpdateDataSourceCommand.js.map +0 -1
  308. package/dist/es/commands/UpdateEvaluationCommand.js.map +0 -1
  309. package/dist/es/commands/UpdateMLModelCommand.js.map +0 -1
  310. package/dist/es/endpoints.js.map +0 -1
  311. package/dist/es/index.js +0 -41
  312. package/dist/es/index.js.map +0 -1
  313. package/dist/es/models/index.js +0 -2
  314. package/dist/es/models/index.js.map +0 -1
  315. package/dist/es/models/models_0.js.map +0 -1
  316. package/dist/es/package.json +0 -93
  317. package/dist/es/pagination/DescribeBatchPredictionsPaginator.js.map +0 -1
  318. package/dist/es/pagination/DescribeDataSourcesPaginator.js.map +0 -1
  319. package/dist/es/pagination/DescribeEvaluationsPaginator.js.map +0 -1
  320. package/dist/es/pagination/DescribeMLModelsPaginator.js.map +0 -1
  321. package/dist/es/pagination/Interfaces.js +0 -2
  322. package/dist/es/pagination/Interfaces.js.map +0 -1
  323. package/dist/es/protocols/Aws_json1_1.js.map +0 -1
  324. package/dist/es/runtimeConfig.browser.js.map +0 -1
  325. package/dist/es/runtimeConfig.js.map +0 -1
  326. package/dist/es/runtimeConfig.native.js.map +0 -1
  327. package/dist/es/runtimeConfig.shared.js.map +0 -1
  328. package/dist/es/waiters/waitForBatchPredictionAvailable.js.map +0 -1
  329. package/dist/es/waiters/waitForDataSourceAvailable.js.map +0 -1
  330. package/dist/es/waiters/waitForEvaluationAvailable.js.map +0 -1
  331. package/dist/es/waiters/waitForMLModelAvailable.js.map +0 -1
  332. package/dist/types/ts3.4/MachineLearning.d.ts +0 -352
  333. package/dist/types/ts3.4/commands/AddTagsCommand.d.ts +0 -37
  334. package/dist/types/ts3.4/commands/CreateBatchPredictionCommand.d.ts +0 -46
  335. package/dist/types/ts3.4/commands/CreateDataSourceFromRDSCommand.d.ts +0 -46
  336. package/dist/types/ts3.4/commands/CreateDataSourceFromRedshiftCommand.d.ts +0 -67
  337. package/dist/types/ts3.4/commands/CreateDataSourceFromS3Command.d.ts +0 -65
  338. package/dist/types/ts3.4/commands/CreateEvaluationCommand.d.ts +0 -46
  339. package/dist/types/ts3.4/commands/CreateMLModelCommand.d.ts +0 -54
  340. package/dist/types/ts3.4/commands/CreateRealtimeEndpointCommand.d.ts +0 -35
  341. package/dist/types/ts3.4/commands/DeleteBatchPredictionCommand.d.ts +0 -40
  342. package/dist/types/ts3.4/commands/DeleteDataSourceCommand.d.ts +0 -38
  343. package/dist/types/ts3.4/commands/DeleteEvaluationCommand.d.ts +0 -40
  344. package/dist/types/ts3.4/commands/DeleteMLModelCommand.d.ts +0 -40
  345. package/dist/types/ts3.4/commands/DeleteTagsCommand.d.ts +0 -36
  346. package/dist/types/ts3.4/commands/DescribeBatchPredictionsCommand.d.ts +0 -35
  347. package/dist/types/ts3.4/commands/DescribeDataSourcesCommand.d.ts +0 -35
  348. package/dist/types/ts3.4/commands/DescribeEvaluationsCommand.d.ts +0 -35
  349. package/dist/types/ts3.4/commands/DescribeMLModelsCommand.d.ts +0 -35
  350. package/dist/types/ts3.4/commands/DescribeTagsCommand.d.ts +0 -35
  351. package/dist/types/ts3.4/commands/GetBatchPredictionCommand.d.ts +0 -36
  352. package/dist/types/ts3.4/commands/GetDataSourceCommand.d.ts +0 -38
  353. package/dist/types/ts3.4/commands/GetEvaluationCommand.d.ts +0 -35
  354. package/dist/types/ts3.4/commands/GetMLModelCommand.d.ts +0 -37
  355. package/dist/types/ts3.4/commands/PredictCommand.d.ts +0 -38
  356. package/dist/types/ts3.4/commands/UpdateBatchPredictionCommand.d.ts +0 -36
  357. package/dist/types/ts3.4/commands/UpdateDataSourceCommand.d.ts +0 -36
  358. package/dist/types/ts3.4/commands/UpdateEvaluationCommand.d.ts +0 -36
  359. package/dist/types/ts3.4/commands/UpdateMLModelCommand.d.ts +0 -36
  360. package/dist/types/ts3.4/models/models_0.d.ts +0 -3489
  361. package/endpoints.ts +0 -57
  362. package/jest.config.js +0 -4
  363. package/models/models_0.ts +0 -4066
  364. package/pagination/DescribeBatchPredictionsPaginator.ts +0 -58
  365. package/pagination/DescribeDataSourcesPaginator.ts +0 -58
  366. package/pagination/DescribeEvaluationsPaginator.ts +0 -58
  367. package/pagination/DescribeMLModelsPaginator.ts +0 -58
  368. package/pagination/Interfaces.ts +0 -7
  369. package/protocols/Aws_json1_1.ts +0 -3957
  370. package/runtimeConfig.browser.ts +0 -40
  371. package/runtimeConfig.native.ts +0 -16
  372. package/runtimeConfig.shared.ts +0 -16
  373. package/runtimeConfig.ts +0 -45
  374. package/tsconfig.es.json +0 -10
  375. package/tsconfig.json +0 -31
  376. package/tsconfig.types.json +0 -8
  377. package/waiters/waitForBatchPredictionAvailable.ts +0 -74
  378. package/waiters/waitForDataSourceAvailable.ts +0 -71
  379. package/waiters/waitForEvaluationAvailable.ts +0 -71
  380. package/waiters/waitForMLModelAvailable.ts +0 -71
@@ -1,3489 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
- export declare enum TaggableResourceType {
3
- BATCH_PREDICTION = "BatchPrediction",
4
- DATASOURCE = "DataSource",
5
- EVALUATION = "Evaluation",
6
- ML_MODEL = "MLModel"
7
- }
8
- /**
9
- * <p>A custom key-value pair associated with an ML object, such as an ML model.</p>
10
- */
11
- export interface Tag {
12
- /**
13
- * <p>A unique identifier for the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.</p>
14
- */
15
- Key?: string;
16
- /**
17
- * <p>An optional string, typically used to describe or define the tag. Valid characters include Unicode letters, digits, white space, _, ., /, =, +, -, %, and @.</p>
18
- */
19
- Value?: string;
20
- }
21
- export declare namespace Tag {
22
- /**
23
- * @internal
24
- */
25
- const filterSensitiveLog: (obj: Tag) => any;
26
- }
27
- export interface AddTagsInput {
28
- /**
29
- * <p>The key-value pairs to use to create tags. If you specify a key without specifying a value, Amazon ML creates a tag with the specified key and a value of null.</p>
30
- */
31
- Tags: Tag[] | undefined;
32
- /**
33
- * <p>The ID of the ML object to tag. For example, <code>exampleModelId</code>.</p>
34
- */
35
- ResourceId: string | undefined;
36
- /**
37
- * <p>The type of the ML object to tag.</p>
38
- */
39
- ResourceType: TaggableResourceType | string | undefined;
40
- }
41
- export declare namespace AddTagsInput {
42
- /**
43
- * @internal
44
- */
45
- const filterSensitiveLog: (obj: AddTagsInput) => any;
46
- }
47
- /**
48
- * <p>Amazon ML returns the following elements.</p>
49
- */
50
- export interface AddTagsOutput {
51
- /**
52
- * <p>The ID of the ML object that was tagged.</p>
53
- */
54
- ResourceId?: string;
55
- /**
56
- * <p>The type of the ML object that was tagged.</p>
57
- */
58
- ResourceType?: TaggableResourceType | string;
59
- }
60
- export declare namespace AddTagsOutput {
61
- /**
62
- * @internal
63
- */
64
- const filterSensitiveLog: (obj: AddTagsOutput) => any;
65
- }
66
- /**
67
- * <p>An error on the server occurred when trying to process a request.</p>
68
- */
69
- export interface InternalServerException extends __SmithyException, $MetadataBearer {
70
- name: "InternalServerException";
71
- $fault: "server";
72
- message?: string;
73
- code?: number;
74
- }
75
- export declare namespace InternalServerException {
76
- /**
77
- * @internal
78
- */
79
- const filterSensitiveLog: (obj: InternalServerException) => any;
80
- }
81
- /**
82
- * <p>An error on the client occurred. Typically, the cause is an invalid input value.</p>
83
- */
84
- export interface InvalidInputException extends __SmithyException, $MetadataBearer {
85
- name: "InvalidInputException";
86
- $fault: "client";
87
- message?: string;
88
- code?: number;
89
- }
90
- export declare namespace InvalidInputException {
91
- /**
92
- * @internal
93
- */
94
- const filterSensitiveLog: (obj: InvalidInputException) => any;
95
- }
96
- export interface InvalidTagException extends __SmithyException, $MetadataBearer {
97
- name: "InvalidTagException";
98
- $fault: "client";
99
- message?: string;
100
- }
101
- export declare namespace InvalidTagException {
102
- /**
103
- * @internal
104
- */
105
- const filterSensitiveLog: (obj: InvalidTagException) => any;
106
- }
107
- /**
108
- * <p>A specified resource cannot be located.</p>
109
- */
110
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
111
- name: "ResourceNotFoundException";
112
- $fault: "client";
113
- message?: string;
114
- code?: number;
115
- }
116
- export declare namespace ResourceNotFoundException {
117
- /**
118
- * @internal
119
- */
120
- const filterSensitiveLog: (obj: ResourceNotFoundException) => any;
121
- }
122
- export interface TagLimitExceededException extends __SmithyException, $MetadataBearer {
123
- name: "TagLimitExceededException";
124
- $fault: "client";
125
- message?: string;
126
- }
127
- export declare namespace TagLimitExceededException {
128
- /**
129
- * @internal
130
- */
131
- const filterSensitiveLog: (obj: TagLimitExceededException) => any;
132
- }
133
- export declare enum Algorithm {
134
- SGD = "sgd"
135
- }
136
- export interface CreateBatchPredictionInput {
137
- /**
138
- * <p>A user-supplied ID that uniquely identifies the
139
- * <code>BatchPrediction</code>.</p>
140
- */
141
- BatchPredictionId: string | undefined;
142
- /**
143
- * <p>A user-supplied name or description of the <code>BatchPrediction</code>. <code>BatchPredictionName</code> can only use the UTF-8 character set.</p>
144
- */
145
- BatchPredictionName?: string;
146
- /**
147
- * <p>The ID of the <code>MLModel</code> that will generate predictions for the group of observations. </p>
148
- */
149
- MLModelId: string | undefined;
150
- /**
151
- * <p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p>
152
- */
153
- BatchPredictionDataSourceId: string | undefined;
154
- /**
155
- * <p>The location of an Amazon Simple Storage Service (Amazon S3) bucket or directory to store the batch prediction results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p>
156
- * <p>Amazon ML needs permissions to store and retrieve the logs on your behalf. For information about how to set permissions, see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.</p>
157
- */
158
- OutputUri: string | undefined;
159
- }
160
- export declare namespace CreateBatchPredictionInput {
161
- /**
162
- * @internal
163
- */
164
- const filterSensitiveLog: (obj: CreateBatchPredictionInput) => any;
165
- }
166
- /**
167
- * <p> Represents the output of a <code>CreateBatchPrediction</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
168
- * <p>The <code>CreateBatchPrediction</code> operation is asynchronous. You can poll for status updates by using the <code>>GetBatchPrediction</code>
169
- * operation and checking the <code>Status</code> parameter of the result.
170
- * </p>
171
- */
172
- export interface CreateBatchPredictionOutput {
173
- /**
174
- * <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>. This value is identical to the value of the
175
- * <code>BatchPredictionId</code> in the request.</p>
176
- */
177
- BatchPredictionId?: string;
178
- }
179
- export declare namespace CreateBatchPredictionOutput {
180
- /**
181
- * @internal
182
- */
183
- const filterSensitiveLog: (obj: CreateBatchPredictionOutput) => any;
184
- }
185
- /**
186
- * <p>A second request to use or change an object was not allowed. This can result from retrying a request using a parameter that was not present in the original request.</p>
187
- */
188
- export interface IdempotentParameterMismatchException extends __SmithyException, $MetadataBearer {
189
- name: "IdempotentParameterMismatchException";
190
- $fault: "client";
191
- message?: string;
192
- code?: number;
193
- }
194
- export declare namespace IdempotentParameterMismatchException {
195
- /**
196
- * @internal
197
- */
198
- const filterSensitiveLog: (obj: IdempotentParameterMismatchException) => any;
199
- }
200
- /**
201
- * <p>The database credentials to connect to a database on an RDS DB instance.</p>
202
- */
203
- export interface RDSDatabaseCredentials {
204
- /**
205
- * <p>The username to be used by Amazon ML to connect to database on an Amazon RDS instance.
206
- * The username should have sufficient permissions to execute an <code>RDSSelectSqlQuery</code> query.</p>
207
- */
208
- Username: string | undefined;
209
- /**
210
- * <p>The password to be used by Amazon ML to connect to a database on an RDS DB instance.
211
- * The password should have sufficient permissions to execute the <code>RDSSelectQuery</code> query.</p>
212
- */
213
- Password: string | undefined;
214
- }
215
- export declare namespace RDSDatabaseCredentials {
216
- /**
217
- * @internal
218
- */
219
- const filterSensitiveLog: (obj: RDSDatabaseCredentials) => any;
220
- }
221
- /**
222
- * <p>The database details of an Amazon RDS database.</p>
223
- */
224
- export interface RDSDatabase {
225
- /**
226
- * <p>The ID of an RDS DB instance.</p>
227
- */
228
- InstanceIdentifier: string | undefined;
229
- /**
230
- * <p>The name of a database hosted on an RDS DB instance.</p>
231
- */
232
- DatabaseName: string | undefined;
233
- }
234
- export declare namespace RDSDatabase {
235
- /**
236
- * @internal
237
- */
238
- const filterSensitiveLog: (obj: RDSDatabase) => any;
239
- }
240
- /**
241
- * <p>The data specification of an Amazon Relational Database Service (Amazon RDS) <code>DataSource</code>.</p>
242
- */
243
- export interface RDSDataSpec {
244
- /**
245
- * <p>Describes the <code>DatabaseName</code> and <code>InstanceIdentifier</code> of an Amazon RDS database.</p>
246
- */
247
- DatabaseInformation: RDSDatabase | undefined;
248
- /**
249
- * <p>The query that is used to retrieve the observation data for the <code>DataSource</code>.</p>
250
- */
251
- SelectSqlQuery: string | undefined;
252
- /**
253
- * <p>The AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon RDS database.</p>
254
- */
255
- DatabaseCredentials: RDSDatabaseCredentials | undefined;
256
- /**
257
- * <p>The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using <code>SelectSqlQuery</code> is stored in this location.</p>
258
- */
259
- S3StagingLocation: string | undefined;
260
- /**
261
- * <p>A JSON string that represents the splitting and rearrangement
262
- * processing to be applied to a <code>DataSource</code>. If the <code>DataRearrangement</code>
263
- * parameter is not provided, all of the input data is used to create the <code>Datasource</code>.</p>
264
- *
265
- * <p>There are multiple parameters that control what data is used to create a datasource:</p>
266
- * <ul>
267
- * <li>
268
- * <p>
269
- * <b>
270
- * <code>percentBegin</code>
271
- * </b>
272
- * </p>
273
- * <p>Use <code>percentBegin</code> to indicate the beginning of the range of the data used to
274
- * create the Datasource.
275
- * If you do not include <code>percentBegin</code> and <code>percentEnd</code>, Amazon ML includes
276
- * all of the data when creating the datasource.</p>
277
- * </li>
278
- * <li>
279
- * <p>
280
- * <b>
281
- * <code>percentEnd</code>
282
- * </b>
283
- * </p>
284
- * <p>Use <code>percentEnd</code> to indicate the end of the range of the data used to create the
285
- * Datasource. If you do not
286
- * include <code>percentBegin</code> and <code>percentEnd</code>, Amazon ML
287
- * includes all of the data when creating the datasource.</p>
288
- * </li>
289
- * <li>
290
- * <p>
291
- * <b>
292
- * <code>complement</code>
293
- * </b>
294
- * </p>
295
- * <p>The <code>complement</code> parameter instructs Amazon ML to use the data that is
296
- * not included in the range of <code>percentBegin</code> to <code>percentEnd</code> to create a
297
- * datasource. The <code>complement</code> parameter is useful if you need to create
298
- * complementary datasources for training and evaluation.
299
- * To create a complementary datasource, use the same
300
- * values for <code>percentBegin</code> and <code>percentEnd</code>, along with the
301
- * <code>complement</code> parameter.</p>
302
- *
303
- * <p>For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.</p>
304
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":0, "percentEnd":25}}</code>
305
- * </p>
306
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}}</code>
307
- * </p>
308
- * </li>
309
- * <li>
310
- * <p>
311
- * <b>
312
- * <code>strategy</code>
313
- * </b>
314
- * </p>
315
- * <p>To change how Amazon ML splits the data for a datasource, use the <code>strategy</code> parameter.</p>
316
- * <p>The default value for the <code>strategy</code> parameter
317
- * is <code>sequential</code>, meaning that Amazon ML takes all of the data records between the <code>percentBegin</code>
318
- * and <code>percentEnd</code> parameters for the datasource, in the order that the records appear in the input data.</p>
319
- *
320
- * <p>The following two <code>DataRearrangement</code> lines are examples of sequentially ordered
321
- * training and evaluation datasources:</p>
322
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}}</code>
323
- * </p>
324
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}}</code>
325
- * </p>
326
- *
327
- * <p>To randomly split the input data into the proportions indicated by the percentBegin and percentEnd
328
- * parameters, set the <code>strategy</code> parameter to
329
- * <code>random</code> and provide a string that is used as the seed value for the random data splitting (for
330
- * example, you can use the S3 path to your data as the random seed string).
331
- * If you choose the random split strategy,
332
- * Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned
333
- * number between <code>percentBegin</code> and <code>percentEnd</code>. Pseudo-random numbers are assigned
334
- * using both the input seed string value and the byte offset as a seed, so changing the data results in a
335
- * different split. Any existing ordering is preserved.
336
- * The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly.
337
- * It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in
338
- * training and evaluation datasources containing non-similar data records.</p>
339
- * <p>The following two <code>DataRearrangement</code> lines are examples of non-sequentially ordered
340
- * training and evaluation datasources:</p>
341
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}</code>
342
- * </p>
343
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}</code>
344
- * </p>
345
- * </li>
346
- * </ul>
347
- */
348
- DataRearrangement?: string;
349
- /**
350
- * <p>A JSON string that represents the schema for an Amazon RDS
351
- * <code>DataSource</code>. The <code>DataSchema</code>
352
- * defines the structure of the observation data in the data file(s)
353
- * referenced in the <code>DataSource</code>.</p>
354
- * <p>A <code>DataSchema</code> is not required if you specify a
355
- * <code>DataSchemaUri</code>
356
- * </p>
357
- * <p>Define your <code>DataSchema</code> as a series of key-value pairs. <code>attributes</code>
358
- * and <code>excludedVariableNames</code> have an array of key-value pairs
359
- * for their value. Use the following format to define your <code>DataSchema</code>.</p>
360
- * <p>{ "version": "1.0",</p>
361
- * <p>"recordAnnotationFieldName": "F1",</p>
362
- * <p>"recordWeightFieldName": "F2",</p>
363
- * <p>"targetFieldName": "F3",</p>
364
- * <p>"dataFormat": "CSV",</p>
365
- * <p>"dataFileContainsHeader": true,</p>
366
- * <p>"attributes": [</p>
367
- * <p>{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],</p>
368
- * <p>"excludedVariableNames": [ "F6" ] }</p>
369
- */
370
- DataSchema?: string;
371
- /**
372
- * <p>The Amazon S3 location of the <code>DataSchema</code>. </p>
373
- */
374
- DataSchemaUri?: string;
375
- /**
376
- * <p>The role (DataPipelineDefaultResourceRole) assumed by an Amazon Elastic Compute Cloud (Amazon EC2) instance to carry out the copy operation from Amazon RDS to an Amazon S3 task. For more information, see <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p>
377
- */
378
- ResourceRole: string | undefined;
379
- /**
380
- * <p>The role (DataPipelineDefaultRole) assumed by AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p>
381
- */
382
- ServiceRole: string | undefined;
383
- /**
384
- * <p>The subnet ID to be used to access a VPC-based RDS DB instance. This attribute is used by Data Pipeline to carry out the copy task from Amazon RDS to Amazon S3.</p>
385
- */
386
- SubnetId: string | undefined;
387
- /**
388
- * <p>The security group IDs to be used to access a VPC-based RDS DB instance. Ensure that there are appropriate ingress rules set up to allow access to the RDS DB instance. This attribute is used by Data Pipeline to carry out the copy operation from Amazon RDS to an Amazon S3 task.</p>
389
- */
390
- SecurityGroupIds: string[] | undefined;
391
- }
392
- export declare namespace RDSDataSpec {
393
- /**
394
- * @internal
395
- */
396
- const filterSensitiveLog: (obj: RDSDataSpec) => any;
397
- }
398
- export interface CreateDataSourceFromRDSInput {
399
- /**
400
- * <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>. Typically, an Amazon Resource Number (ARN)
401
- * becomes the ID for a <code>DataSource</code>.</p>
402
- */
403
- DataSourceId: string | undefined;
404
- /**
405
- * <p>A user-supplied name or description of the <code>DataSource</code>.</p>
406
- */
407
- DataSourceName?: string;
408
- /**
409
- * <p>The data specification of an Amazon RDS <code>DataSource</code>:</p>
410
- * <ul>
411
- * <li>
412
- * <p>DatabaseInformation -</p>
413
- * <ul>
414
- * <li>
415
- * <p>
416
- * <code>DatabaseName</code> - The name of the Amazon RDS database.</p>
417
- * </li>
418
- * <li>
419
- * <p>
420
- * <code>InstanceIdentifier </code> - A unique identifier for the Amazon RDS database instance.</p>
421
- * </li>
422
- * </ul>
423
- * </li>
424
- * <li>
425
- * <p>DatabaseCredentials - AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon RDS database.</p>
426
- * </li>
427
- * <li>
428
- * <p>ResourceRole - A role (DataPipelineDefaultResourceRole) assumed by an EC2 instance to carry out the copy task from Amazon RDS to Amazon
429
- * Simple Storage Service (Amazon S3). For more information, see <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p>
430
- * </li>
431
- * <li>
432
- * <p>ServiceRole - A role (DataPipelineDefaultRole) assumed by the AWS Data Pipeline service to monitor the progress of the copy task from Amazon RDS
433
- * to Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p>
434
- * </li>
435
- * <li>
436
- * <p>SecurityInfo - The security information to use to access an RDS DB instance. You need to set up appropriate ingress rules for the security entity IDs provided to allow access to the Amazon RDS instance. Specify a [<code>SubnetId</code>, <code>SecurityGroupIds</code>] pair for a VPC-based RDS DB instance.</p>
437
- * </li>
438
- * <li>
439
- * <p>SelectSqlQuery - A query that is used to retrieve the observation data for the <code>Datasource</code>.</p>
440
- * </li>
441
- * <li>
442
- * <p>S3StagingLocation - The Amazon S3 location for staging Amazon RDS data. The data retrieved from Amazon RDS using <code>SelectSqlQuery</code> is stored in this location.</p>
443
- * </li>
444
- * <li>
445
- * <p>DataSchemaUri - The Amazon S3 location of the <code>DataSchema</code>.</p>
446
- * </li>
447
- * <li>
448
- * <p>DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is specified. </p>
449
- * </li>
450
- * <li>
451
- * <p>DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the <code>Datasource</code>. </p>
452
- * <p> Sample -
453
- * <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code>
454
- * </p>
455
- * </li>
456
- * </ul>
457
- */
458
- RDSData: RDSDataSpec | undefined;
459
- /**
460
- * <p>The role that Amazon ML assumes on behalf of the user to create and activate a data
461
- * pipeline in the user's account and copy data using the <code>SelectSqlQuery</code> query from Amazon RDS to Amazon S3.</p>
462
- * <p></p>
463
- */
464
- RoleARN: string | undefined;
465
- /**
466
- * <p>The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data referenced by
467
- * a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> training.
468
- * This parameter must be set to <code>true</code> if the <code></code>DataSource<code></code> needs to be used for <code>MLModel</code> training.
469
- * </p>
470
- */
471
- ComputeStatistics?: boolean;
472
- }
473
- export declare namespace CreateDataSourceFromRDSInput {
474
- /**
475
- * @internal
476
- */
477
- const filterSensitiveLog: (obj: CreateDataSourceFromRDSInput) => any;
478
- }
479
- /**
480
- * <p> Represents the output of a <code>CreateDataSourceFromRDS</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
481
- * <p>The <code>CreateDataSourceFromRDS</code>> operation is asynchronous. You can poll for updates by using
482
- * the <code>GetBatchPrediction</code> operation and checking the <code>Status</code> parameter. You can
483
- * inspect the <code>Message</code> when <code>Status</code> shows up as <code>FAILED</code>. You can
484
- * also check the progress of the copy operation by going to the <code>DataPipeline</code> console and looking up
485
- * the pipeline using the <code>pipelineId </code> from the describe call.</p>
486
- */
487
- export interface CreateDataSourceFromRDSOutput {
488
- /**
489
- * <p>A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the
490
- * <code>DataSourceID</code> in the request.
491
- * </p>
492
- */
493
- DataSourceId?: string;
494
- }
495
- export declare namespace CreateDataSourceFromRDSOutput {
496
- /**
497
- * @internal
498
- */
499
- const filterSensitiveLog: (obj: CreateDataSourceFromRDSOutput) => any;
500
- }
501
- /**
502
- * <p>Describes the database credentials for connecting to a database on an Amazon Redshift cluster.</p>
503
- */
504
- export interface RedshiftDatabaseCredentials {
505
- /**
506
- * <p>A username to be used by Amazon Machine Learning (Amazon ML)to connect to a database on an Amazon Redshift cluster.
507
- * The username should have sufficient permissions to execute the <code>RedshiftSelectSqlQuery</code> query. The username should be valid for an Amazon Redshift <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">USER</a>.</p>
508
- */
509
- Username: string | undefined;
510
- /**
511
- * <p>A password to be used by Amazon ML to connect to a database on an Amazon Redshift cluster.
512
- * The password should have sufficient permissions to execute a <code>RedshiftSelectSqlQuery</code> query. The password should be valid for an Amazon Redshift <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">USER</a>.</p>
513
- */
514
- Password: string | undefined;
515
- }
516
- export declare namespace RedshiftDatabaseCredentials {
517
- /**
518
- * @internal
519
- */
520
- const filterSensitiveLog: (obj: RedshiftDatabaseCredentials) => any;
521
- }
522
- /**
523
- * <p>Describes the database details required to connect to an Amazon Redshift database.</p>
524
- */
525
- export interface RedshiftDatabase {
526
- /**
527
- * <p>The name of a database hosted on an Amazon Redshift cluster.</p>
528
- */
529
- DatabaseName: string | undefined;
530
- /**
531
- * <p>The ID of an Amazon Redshift cluster.</p>
532
- */
533
- ClusterIdentifier: string | undefined;
534
- }
535
- export declare namespace RedshiftDatabase {
536
- /**
537
- * @internal
538
- */
539
- const filterSensitiveLog: (obj: RedshiftDatabase) => any;
540
- }
541
- /**
542
- * <p>Describes the data specification of an Amazon Redshift <code>DataSource</code>.</p>
543
- */
544
- export interface RedshiftDataSpec {
545
- /**
546
- * <p>Describes the <code>DatabaseName</code> and <code>ClusterIdentifier</code> for an Amazon Redshift <code>DataSource</code>.</p>
547
- */
548
- DatabaseInformation: RedshiftDatabase | undefined;
549
- /**
550
- * <p>Describes the SQL Query to execute on an Amazon Redshift database for an Amazon Redshift <code>DataSource</code>.</p>
551
- */
552
- SelectSqlQuery: string | undefined;
553
- /**
554
- * <p>Describes AWS Identity and Access Management (IAM) credentials that are used connect to the Amazon Redshift database.</p>
555
- */
556
- DatabaseCredentials: RedshiftDatabaseCredentials | undefined;
557
- /**
558
- * <p>Describes an Amazon S3 location to store the result set of the <code>SelectSqlQuery</code> query.</p>
559
- */
560
- S3StagingLocation: string | undefined;
561
- /**
562
- * <p>A JSON string that represents the splitting and rearrangement
563
- * processing to be applied to a <code>DataSource</code>. If the <code>DataRearrangement</code>
564
- * parameter is not provided, all of the input data is used to create the <code>Datasource</code>.</p>
565
- *
566
- * <p>There are multiple parameters that control what data is used to create a datasource:</p>
567
- * <ul>
568
- * <li>
569
- * <p>
570
- * <b>
571
- * <code>percentBegin</code>
572
- * </b>
573
- * </p>
574
- * <p>Use <code>percentBegin</code> to indicate the beginning of the range of the data used to
575
- * create the Datasource.
576
- * If you do not include <code>percentBegin</code> and <code>percentEnd</code>, Amazon ML includes
577
- * all of the data when creating the datasource.</p>
578
- * </li>
579
- * <li>
580
- * <p>
581
- * <b>
582
- * <code>percentEnd</code>
583
- * </b>
584
- * </p>
585
- * <p>Use <code>percentEnd</code> to indicate the end of the range of the data used to create the
586
- * Datasource. If you do not
587
- * include <code>percentBegin</code> and <code>percentEnd</code>, Amazon ML
588
- * includes all of the data when creating the datasource.</p>
589
- * </li>
590
- * <li>
591
- * <p>
592
- * <b>
593
- * <code>complement</code>
594
- * </b>
595
- * </p>
596
- * <p>The <code>complement</code> parameter instructs Amazon ML to use the data that is
597
- * not included in the range of <code>percentBegin</code> to <code>percentEnd</code> to create a
598
- * datasource. The <code>complement</code> parameter is useful if you need to create
599
- * complementary datasources for training and evaluation.
600
- * To create a complementary datasource, use the same
601
- * values for <code>percentBegin</code> and <code>percentEnd</code>, along with the
602
- * <code>complement</code> parameter.</p>
603
- *
604
- * <p>For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.</p>
605
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":0, "percentEnd":25}}</code>
606
- * </p>
607
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}}</code>
608
- * </p>
609
- * </li>
610
- * <li>
611
- * <p>
612
- * <b>
613
- * <code>strategy</code>
614
- * </b>
615
- * </p>
616
- * <p>To change how Amazon ML splits the data for a datasource, use the <code>strategy</code> parameter.</p>
617
- * <p>The default value for the <code>strategy</code> parameter
618
- * is <code>sequential</code>, meaning that Amazon ML takes all of the data records between the <code>percentBegin</code>
619
- * and <code>percentEnd</code> parameters for the datasource, in the order that the records appear in the input data.</p>
620
- *
621
- * <p>The following two <code>DataRearrangement</code> lines are examples of sequentially ordered
622
- * training and evaluation datasources:</p>
623
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}}</code>
624
- * </p>
625
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}}</code>
626
- * </p>
627
- *
628
- * <p>To randomly split the input data into the proportions indicated by the percentBegin and percentEnd
629
- * parameters, set the <code>strategy</code> parameter to
630
- * <code>random</code> and provide a string that is used as the seed value for the random data splitting (for
631
- * example, you can use the S3 path to your data as the random seed string).
632
- * If you choose the random split strategy,
633
- * Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned
634
- * number between <code>percentBegin</code> and <code>percentEnd</code>. Pseudo-random numbers are assigned
635
- * using both the input seed string value and the byte offset as a seed, so changing the data results in a
636
- * different split. Any existing ordering is preserved.
637
- * The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly.
638
- * It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in
639
- * training and evaluation datasources containing non-similar data records.</p>
640
- * <p>The following two <code>DataRearrangement</code> lines are examples of non-sequentially ordered
641
- * training and evaluation datasources:</p>
642
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}</code>
643
- * </p>
644
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}</code>
645
- * </p>
646
- * </li>
647
- * </ul>
648
- */
649
- DataRearrangement?: string;
650
- /**
651
- * <p>A JSON string that represents the schema for an Amazon Redshift
652
- * <code>DataSource</code>. The <code>DataSchema</code>
653
- * defines the structure of the observation data in the data file(s)
654
- * referenced in the <code>DataSource</code>.</p>
655
- * <p>A <code>DataSchema</code> is not required if you specify a
656
- * <code>DataSchemaUri</code>.</p>
657
- * <p>Define your <code>DataSchema</code> as a series of key-value pairs. <code>attributes</code>
658
- * and <code>excludedVariableNames</code> have an array of key-value pairs
659
- * for their value. Use the following format to define your <code>DataSchema</code>.</p>
660
- * <p>{ "version": "1.0",</p>
661
- * <p>"recordAnnotationFieldName": "F1",</p>
662
- * <p>"recordWeightFieldName": "F2",</p>
663
- * <p>"targetFieldName": "F3",</p>
664
- * <p>"dataFormat": "CSV",</p>
665
- * <p>"dataFileContainsHeader": true,</p>
666
- * <p>"attributes": [</p>
667
- * <p>{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],</p>
668
- * <p>"excludedVariableNames": [ "F6" ] }</p>
669
- */
670
- DataSchema?: string;
671
- /**
672
- * <p>Describes the schema location for an Amazon Redshift <code>DataSource</code>.</p>
673
- */
674
- DataSchemaUri?: string;
675
- }
676
- export declare namespace RedshiftDataSpec {
677
- /**
678
- * @internal
679
- */
680
- const filterSensitiveLog: (obj: RedshiftDataSpec) => any;
681
- }
682
- export interface CreateDataSourceFromRedshiftInput {
683
- /**
684
- * <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>.</p>
685
- */
686
- DataSourceId: string | undefined;
687
- /**
688
- * <p>A user-supplied name or description of the <code>DataSource</code>. </p>
689
- */
690
- DataSourceName?: string;
691
- /**
692
- * <p>The data specification of an Amazon Redshift <code>DataSource</code>:</p>
693
- * <ul>
694
- * <li>
695
- * <p>DatabaseInformation -</p>
696
- * <ul>
697
- * <li>
698
- * <p>
699
- * <code>DatabaseName</code> - The name of the Amazon Redshift database.</p>
700
- * </li>
701
- * <li>
702
- * <p>
703
- * <code> ClusterIdentifier</code> - The unique ID for the Amazon Redshift cluster.</p>
704
- * </li>
705
- * </ul>
706
- * </li>
707
- * <li>
708
- * <p>DatabaseCredentials - The AWS Identity and Access Management (IAM) credentials that are used to connect to the Amazon Redshift database.</p>
709
- * </li>
710
- * <li>
711
- * <p>SelectSqlQuery - The query that is used to retrieve the observation data for the
712
- * <code>Datasource</code>.</p>
713
- * </li>
714
- * <li>
715
- * <p>S3StagingLocation - The Amazon Simple Storage Service (Amazon S3) location for staging Amazon
716
- * Redshift data. The data retrieved from Amazon Redshift using
717
- * the <code>SelectSqlQuery</code> query is stored in this location.</p>
718
- * </li>
719
- * <li>
720
- * <p>DataSchemaUri - The Amazon S3 location of the <code>DataSchema</code>.</p>
721
- * </li>
722
- * <li>
723
- * <p>DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is specified. </p>
724
- * </li>
725
- * <li>
726
- * <p>DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the <code>DataSource</code>.</p>
727
- * <p> Sample -
728
- * <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code>
729
- * </p>
730
- * </li>
731
- * </ul>
732
- */
733
- DataSpec: RedshiftDataSpec | undefined;
734
- /**
735
- * <p>A fully specified role Amazon Resource Name (ARN). Amazon ML assumes the role on behalf of the user to create the following:</p>
736
- *
737
- * <ul>
738
- * <li>
739
- * <p>A security group to allow Amazon ML to execute the <code>SelectSqlQuery</code> query on an Amazon Redshift cluster</p>
740
- * </li>
741
- * <li>
742
- * <p>An Amazon S3 bucket policy to grant Amazon ML read/write permissions on the <code>S3StagingLocation</code>
743
- * </p>
744
- * </li>
745
- * </ul>
746
- */
747
- RoleARN: string | undefined;
748
- /**
749
- * <p>The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data referenced by
750
- * a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> training.
751
- * This parameter must be set to <code>true</code> if the <code>DataSource</code> needs to
752
- * be used for <code>MLModel</code> training.</p>
753
- */
754
- ComputeStatistics?: boolean;
755
- }
756
- export declare namespace CreateDataSourceFromRedshiftInput {
757
- /**
758
- * @internal
759
- */
760
- const filterSensitiveLog: (obj: CreateDataSourceFromRedshiftInput) => any;
761
- }
762
- /**
763
- * <p> Represents the output of a <code>CreateDataSourceFromRedshift</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
764
- * <p>The <code>CreateDataSourceFromRedshift</code> operation is asynchronous. You can poll for updates by using
765
- * the <code>GetBatchPrediction</code> operation and checking the <code>Status</code> parameter. </p>
766
- */
767
- export interface CreateDataSourceFromRedshiftOutput {
768
- /**
769
- * <p>A user-supplied ID that uniquely identifies the datasource. This value should be identical to the value of the
770
- * <code>DataSourceID</code> in the request.
771
- * </p>
772
- */
773
- DataSourceId?: string;
774
- }
775
- export declare namespace CreateDataSourceFromRedshiftOutput {
776
- /**
777
- * @internal
778
- */
779
- const filterSensitiveLog: (obj: CreateDataSourceFromRedshiftOutput) => any;
780
- }
781
- /**
782
- * <p> Describes the data specification of a <code>DataSource</code>.</p>
783
- */
784
- export interface S3DataSpec {
785
- /**
786
- * <p>The location of the data file(s) used by a <code>DataSource</code>. The URI specifies a data file or
787
- * an Amazon Simple Storage Service (Amazon S3) directory or bucket containing data files.</p>
788
- */
789
- DataLocationS3: string | undefined;
790
- /**
791
- * <p>A JSON string that represents the splitting and rearrangement
792
- * processing to be applied to a <code>DataSource</code>. If the <code>DataRearrangement</code>
793
- * parameter is not provided, all of the input data is used to create the <code>Datasource</code>.</p>
794
- *
795
- * <p>There are multiple parameters that control what data is used to create a datasource:</p>
796
- * <ul>
797
- * <li>
798
- * <p>
799
- * <b>
800
- * <code>percentBegin</code>
801
- * </b>
802
- * </p>
803
- * <p>Use <code>percentBegin</code> to indicate the beginning of the range of the data used to
804
- * create the Datasource.
805
- * If you do not include <code>percentBegin</code> and <code>percentEnd</code>, Amazon ML includes
806
- * all of the data when creating the datasource.</p>
807
- * </li>
808
- * <li>
809
- * <p>
810
- * <b>
811
- * <code>percentEnd</code>
812
- * </b>
813
- * </p>
814
- * <p>Use <code>percentEnd</code> to indicate the end of the range of the data used to create the
815
- * Datasource. If you do not
816
- * include <code>percentBegin</code> and <code>percentEnd</code>, Amazon ML
817
- * includes all of the data when creating the datasource.</p>
818
- * </li>
819
- * <li>
820
- * <p>
821
- * <b>
822
- * <code>complement</code>
823
- * </b>
824
- * </p>
825
- * <p>The <code>complement</code> parameter instructs Amazon ML to use the data that is
826
- * not included in the range of <code>percentBegin</code> to <code>percentEnd</code> to create a
827
- * datasource. The <code>complement</code> parameter is useful if you need to create
828
- * complementary datasources for training and evaluation.
829
- * To create a complementary datasource, use the same
830
- * values for <code>percentBegin</code> and <code>percentEnd</code>, along with the
831
- * <code>complement</code> parameter.</p>
832
- *
833
- * <p>For example, the following two datasources do not share any data, and can be used to train and evaluate a model. The first datasource has 25 percent of the data, and the second one has 75 percent of the data.</p>
834
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":0, "percentEnd":25}}</code>
835
- * </p>
836
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":0, "percentEnd":25, "complement":"true"}}</code>
837
- * </p>
838
- * </li>
839
- * <li>
840
- * <p>
841
- * <b>
842
- * <code>strategy</code>
843
- * </b>
844
- * </p>
845
- * <p>To change how Amazon ML splits the data for a datasource, use the <code>strategy</code> parameter.</p>
846
- * <p>The default value for the <code>strategy</code> parameter
847
- * is <code>sequential</code>, meaning that Amazon ML takes all of the data records between the <code>percentBegin</code>
848
- * and <code>percentEnd</code> parameters for the datasource, in the order that the records appear in the input data.</p>
849
- *
850
- * <p>The following two <code>DataRearrangement</code> lines are examples of sequentially ordered
851
- * training and evaluation datasources:</p>
852
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential"}}</code>
853
- * </p>
854
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"sequential", "complement":"true"}}</code>
855
- * </p>
856
- *
857
- * <p>To randomly split the input data into the proportions indicated by the percentBegin and percentEnd
858
- * parameters, set the <code>strategy</code> parameter to
859
- * <code>random</code> and provide a string that is used as the seed value for the random data splitting (for
860
- * example, you can use the S3 path to your data as the random seed string).
861
- * If you choose the random split strategy,
862
- * Amazon ML assigns each row of data a pseudo-random number between 0 and 100, and then selects the rows that have an assigned
863
- * number between <code>percentBegin</code> and <code>percentEnd</code>. Pseudo-random numbers are assigned
864
- * using both the input seed string value and the byte offset as a seed, so changing the data results in a
865
- * different split. Any existing ordering is preserved.
866
- * The random splitting strategy ensures that variables in the training and evaluation data are distributed similarly.
867
- * It is useful in the cases where the input data may have an implicit sort order, which would otherwise result in
868
- * training and evaluation datasources containing non-similar data records.</p>
869
- * <p>The following two <code>DataRearrangement</code> lines are examples of non-sequentially ordered
870
- * training and evaluation datasources:</p>
871
- * <p>Datasource for evaluation: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv"}}</code>
872
- * </p>
873
- * <p>Datasource for training: <code>{"splitting":{"percentBegin":70, "percentEnd":100, "strategy":"random", "randomSeed"="s3://my_s3_path/bucket/file.csv", "complement":"true"}}</code>
874
- * </p>
875
- * </li>
876
- * </ul>
877
- */
878
- DataRearrangement?: string;
879
- /**
880
- * <p> A JSON string that represents the schema for an Amazon S3
881
- * <code>DataSource</code>. The <code>DataSchema</code>
882
- * defines the structure of the observation data in the data file(s)
883
- * referenced in the <code>DataSource</code>.</p>
884
- * <p>You must provide either the <code>DataSchema</code> or the <code>DataSchemaLocationS3</code>.</p>
885
- * <p>Define your <code>DataSchema</code> as a series of key-value pairs. <code>attributes</code>
886
- * and <code>excludedVariableNames</code> have an array of key-value pairs
887
- * for their value. Use the following format to define your <code>DataSchema</code>.</p>
888
- * <p>{ "version": "1.0",</p>
889
- * <p>"recordAnnotationFieldName": "F1",</p>
890
- * <p>"recordWeightFieldName": "F2",</p>
891
- * <p>"targetFieldName": "F3",</p>
892
- * <p>"dataFormat": "CSV",</p>
893
- * <p>"dataFileContainsHeader": true,</p>
894
- * <p>"attributes": [</p>
895
- * <p>{ "fieldName": "F1", "fieldType": "TEXT" }, { "fieldName": "F2", "fieldType": "NUMERIC" }, { "fieldName": "F3", "fieldType": "CATEGORICAL" }, { "fieldName": "F4", "fieldType": "NUMERIC" }, { "fieldName": "F5", "fieldType": "CATEGORICAL" }, { "fieldName": "F6", "fieldType": "TEXT" }, { "fieldName": "F7", "fieldType": "WEIGHTED_INT_SEQUENCE" }, { "fieldName": "F8", "fieldType": "WEIGHTED_STRING_SEQUENCE" } ],</p>
896
- * <p>"excludedVariableNames": [ "F6" ] }</p>
897
- */
898
- DataSchema?: string;
899
- /**
900
- * <p>Describes the schema location in Amazon S3. You must provide either the
901
- * <code>DataSchema</code> or the <code>DataSchemaLocationS3</code>.</p>
902
- */
903
- DataSchemaLocationS3?: string;
904
- }
905
- export declare namespace S3DataSpec {
906
- /**
907
- * @internal
908
- */
909
- const filterSensitiveLog: (obj: S3DataSpec) => any;
910
- }
911
- export interface CreateDataSourceFromS3Input {
912
- /**
913
- * <p>A user-supplied identifier that uniquely identifies the <code>DataSource</code>. </p>
914
- */
915
- DataSourceId: string | undefined;
916
- /**
917
- * <p>A user-supplied name or description of the <code>DataSource</code>. </p>
918
- */
919
- DataSourceName?: string;
920
- /**
921
- * <p>The data specification of a <code>DataSource</code>:</p>
922
- * <ul>
923
- * <li>
924
- * <p>DataLocationS3 - The Amazon S3 location of the observation data.</p>
925
- * </li>
926
- * <li>
927
- * <p>DataSchemaLocationS3 - The Amazon S3 location of the <code>DataSchema</code>.</p>
928
- * </li>
929
- * <li>
930
- * <p>DataSchema - A JSON string representing the schema. This is not required if <code>DataSchemaUri</code> is specified. </p>
931
- * </li>
932
- * <li>
933
- * <p>DataRearrangement - A JSON string that represents the splitting and rearrangement requirements for the <code>Datasource</code>. </p>
934
- * <p> Sample -
935
- * <code> "{\"splitting\":{\"percentBegin\":10,\"percentEnd\":60}}"</code>
936
- * </p>
937
- * </li>
938
- * </ul>
939
- */
940
- DataSpec: S3DataSpec | undefined;
941
- /**
942
- * <p>The compute statistics for a <code>DataSource</code>. The statistics are generated from the observation data referenced by
943
- * a <code>DataSource</code>. Amazon ML uses the statistics internally during <code>MLModel</code> training.
944
- * This parameter must be set to <code>true</code> if the <code></code>DataSource<code></code> needs to be used for <code>MLModel</code> training.</p>
945
- */
946
- ComputeStatistics?: boolean;
947
- }
948
- export declare namespace CreateDataSourceFromS3Input {
949
- /**
950
- * @internal
951
- */
952
- const filterSensitiveLog: (obj: CreateDataSourceFromS3Input) => any;
953
- }
954
- /**
955
- * <p> Represents the output of a <code>CreateDataSourceFromS3</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
956
- * <p>The <code>CreateDataSourceFromS3</code> operation is asynchronous. You can poll for updates by using
957
- * the <code>GetBatchPrediction</code> operation and checking the <code>Status</code> parameter. </p>
958
- */
959
- export interface CreateDataSourceFromS3Output {
960
- /**
961
- * <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>. This value should be identical to the value of the
962
- * <code>DataSourceID</code> in the request.
963
- * </p>
964
- */
965
- DataSourceId?: string;
966
- }
967
- export declare namespace CreateDataSourceFromS3Output {
968
- /**
969
- * @internal
970
- */
971
- const filterSensitiveLog: (obj: CreateDataSourceFromS3Output) => any;
972
- }
973
- export interface CreateEvaluationInput {
974
- /**
975
- * <p>A user-supplied ID that uniquely identifies the <code>Evaluation</code>.</p>
976
- */
977
- EvaluationId: string | undefined;
978
- /**
979
- * <p>A user-supplied name or description of the <code>Evaluation</code>.</p>
980
- */
981
- EvaluationName?: string;
982
- /**
983
- * <p>The ID of the <code>MLModel</code> to evaluate.</p>
984
- * <p>The schema used in creating the <code>MLModel</code> must match the schema of the <code>DataSource</code> used in the <code>Evaluation</code>.</p>
985
- */
986
- MLModelId: string | undefined;
987
- /**
988
- * <p>The ID of the <code>DataSource</code> for the evaluation. The schema of the <code>DataSource</code>
989
- * must match the schema used to create the <code>MLModel</code>.</p>
990
- */
991
- EvaluationDataSourceId: string | undefined;
992
- }
993
- export declare namespace CreateEvaluationInput {
994
- /**
995
- * @internal
996
- */
997
- const filterSensitiveLog: (obj: CreateEvaluationInput) => any;
998
- }
999
- /**
1000
- * <p> Represents the output of a <code>CreateEvaluation</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
1001
- * <p>
1002
- * <code>CreateEvaluation</code> operation is asynchronous. You can poll for status updates
1003
- * by using the <code>GetEvcaluation</code> operation
1004
- * and checking the <code>Status</code> parameter.
1005
- * </p>
1006
- */
1007
- export interface CreateEvaluationOutput {
1008
- /**
1009
- * <p>The user-supplied ID that uniquely identifies the <code>Evaluation</code>. This value should be identical to the value of the
1010
- * <code>EvaluationId</code> in the request.</p>
1011
- */
1012
- EvaluationId?: string;
1013
- }
1014
- export declare namespace CreateEvaluationOutput {
1015
- /**
1016
- * @internal
1017
- */
1018
- const filterSensitiveLog: (obj: CreateEvaluationOutput) => any;
1019
- }
1020
- export declare enum MLModelType {
1021
- BINARY = "BINARY",
1022
- MULTICLASS = "MULTICLASS",
1023
- REGRESSION = "REGRESSION"
1024
- }
1025
- export interface CreateMLModelInput {
1026
- /**
1027
- * <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>.</p>
1028
- */
1029
- MLModelId: string | undefined;
1030
- /**
1031
- * <p>A user-supplied name or description of the <code>MLModel</code>.</p>
1032
- */
1033
- MLModelName?: string;
1034
- /**
1035
- * <p>The category of supervised learning that this <code>MLModel</code> will address. Choose from the following types:</p>
1036
- * <ul>
1037
- * <li>
1038
- * <p>Choose <code>REGRESSION</code> if the <code>MLModel</code> will be used to predict a numeric value.</p>
1039
- * </li>
1040
- * <li>
1041
- * <p>Choose <code>BINARY</code> if the <code>MLModel</code> result has two possible values.</p>
1042
- * </li>
1043
- * <li>
1044
- * <p>Choose <code>MULTICLASS</code> if the <code>MLModel</code> result has a limited number of values.</p>
1045
- * </li>
1046
- * </ul>
1047
- * <p> For more information, see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.</p>
1048
- */
1049
- MLModelType: MLModelType | string | undefined;
1050
- /**
1051
- * <p>A list of the training parameters in the <code>MLModel</code>. The list is implemented as
1052
- * a map of key-value pairs.</p>
1053
- * <p>The following is the current set of training parameters:</p>
1054
- * <ul>
1055
- * <li>
1056
- * <p>
1057
- * <code>sgd.maxMLModelSizeInBytes</code> - The maximum allowed size of the model. Depending on the
1058
- * input data, the size of the model might affect its performance.</p>
1059
- * <p> The value is an integer that ranges from <code>100000</code> to <code>2147483648</code>. The default value is <code>33554432</code>.</p>
1060
- * </li>
1061
- * <li>
1062
- * <p>
1063
- * <code>sgd.maxPasses</code> - The number of times that the training process traverses the
1064
- * observations to build the <code>MLModel</code>. The value is an integer that
1065
- * ranges from <code>1</code> to <code>10000</code>. The default value is
1066
- * <code>10</code>.</p>
1067
- * </li>
1068
- * <li>
1069
- * <p>
1070
- * <code>sgd.shuffleType</code> - Whether Amazon ML shuffles the training data. Shuffling
1071
- * the data improves a model's ability to find the optimal solution for a variety
1072
- * of data types. The valid values are <code>auto</code> and <code>none</code>. The
1073
- * default value is <code>none</code>. We strongly recommend that you shuffle your data.</p>
1074
- * </li>
1075
- * <li>
1076
- * <p>
1077
- * <code>sgd.l1RegularizationAmount</code> - The coefficient regularization L1 norm. It controls
1078
- * overfitting the data by penalizing large coefficients. This tends to drive
1079
- * coefficients to zero, resulting in a sparse feature set. If you use this
1080
- * parameter, start by specifying a small value, such as <code>1.0E-08</code>.</p>
1081
- * <p>The value is a double that ranges from <code>0</code> to <code>MAX_DOUBLE</code>.
1082
- * The default is to not use L1 normalization. This parameter can't be used when
1083
- * <code>L2</code> is specified. Use this parameter sparingly.</p>
1084
- * </li>
1085
- * <li>
1086
- * <p>
1087
- * <code>sgd.l2RegularizationAmount</code> - The coefficient regularization L2 norm. It controls
1088
- * overfitting the data by penalizing large coefficients. This tends to drive
1089
- * coefficients to small, nonzero values. If you use this parameter, start by
1090
- * specifying a small value, such as <code>1.0E-08</code>.</p>
1091
- * <p>The value is a double that ranges from <code>0</code> to <code>MAX_DOUBLE</code>.
1092
- * The default is to not use L2 normalization. This parameter can't be used when
1093
- * <code>L1</code> is specified. Use this parameter sparingly.</p>
1094
- * </li>
1095
- * </ul>
1096
- */
1097
- Parameters?: {
1098
- [key: string]: string;
1099
- };
1100
- /**
1101
- * <p>The <code>DataSource</code> that points to the training data.</p>
1102
- */
1103
- TrainingDataSourceId: string | undefined;
1104
- /**
1105
- * <p>The data recipe for creating the <code>MLModel</code>. You must specify either the recipe
1106
- * or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.</p>
1107
- */
1108
- Recipe?: string;
1109
- /**
1110
- * <p>The Amazon Simple Storage Service (Amazon S3) location and file name that contains the <code>MLModel</code> recipe. You must specify either the recipe or its URI. If you don't specify a recipe or its URI, Amazon ML creates a default.</p>
1111
- */
1112
- RecipeUri?: string;
1113
- }
1114
- export declare namespace CreateMLModelInput {
1115
- /**
1116
- * @internal
1117
- */
1118
- const filterSensitiveLog: (obj: CreateMLModelInput) => any;
1119
- }
1120
- /**
1121
- * <p> Represents the output of a <code>CreateMLModel</code> operation, and is an acknowledgement that Amazon ML received the request.</p>
1122
- * <p>The <code>CreateMLModel</code> operation is asynchronous. You can poll for status updates by using the
1123
- * <code>GetMLModel</code> operation and checking the <code>Status</code> parameter.
1124
- * </p>
1125
- */
1126
- export interface CreateMLModelOutput {
1127
- /**
1128
- * <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>. This value should be identical to the value of the
1129
- * <code>MLModelId</code> in the request.
1130
- * </p>
1131
- */
1132
- MLModelId?: string;
1133
- }
1134
- export declare namespace CreateMLModelOutput {
1135
- /**
1136
- * @internal
1137
- */
1138
- const filterSensitiveLog: (obj: CreateMLModelOutput) => any;
1139
- }
1140
- export interface CreateRealtimeEndpointInput {
1141
- /**
1142
- * <p>The ID assigned to the <code>MLModel</code> during creation.</p>
1143
- */
1144
- MLModelId: string | undefined;
1145
- }
1146
- export declare namespace CreateRealtimeEndpointInput {
1147
- /**
1148
- * @internal
1149
- */
1150
- const filterSensitiveLog: (obj: CreateRealtimeEndpointInput) => any;
1151
- }
1152
- export declare enum RealtimeEndpointStatus {
1153
- FAILED = "FAILED",
1154
- NONE = "NONE",
1155
- READY = "READY",
1156
- UPDATING = "UPDATING"
1157
- }
1158
- /**
1159
- * <p> Describes the real-time endpoint information for an <code>MLModel</code>.</p>
1160
- */
1161
- export interface RealtimeEndpointInfo {
1162
- /**
1163
- * <p> The maximum processing rate for the real-time endpoint for <code>MLModel</code>, measured in incoming requests per second.</p>
1164
- */
1165
- PeakRequestsPerSecond?: number;
1166
- /**
1167
- * <p>The time that the request to create the real-time endpoint for the <code>MLModel</code> was received. The time is expressed in epoch time.</p>
1168
- */
1169
- CreatedAt?: Date;
1170
- /**
1171
- * <p>The URI that specifies where to send real-time prediction requests for the <code>MLModel</code>.</p>
1172
- * <p>
1173
- * <b>Note:</b> The application must wait until the real-time endpoint is ready before using this URI.</p>
1174
- */
1175
- EndpointUrl?: string;
1176
- /**
1177
- * <p> The current status of the real-time endpoint for the <code>MLModel</code>. This element can have one of the following values: </p>
1178
- * <ul>
1179
- * <li>
1180
- * <p>
1181
- * <code>NONE</code> - Endpoint does not exist or was previously deleted.</p>
1182
- * </li>
1183
- * <li>
1184
- * <p>
1185
- * <code>READY</code> - Endpoint is ready to be used for real-time predictions.</p>
1186
- * </li>
1187
- * <li>
1188
- * <p>
1189
- * <code>UPDATING</code> - Updating/creating the endpoint. </p>
1190
- * </li>
1191
- * </ul>
1192
- */
1193
- EndpointStatus?: RealtimeEndpointStatus | string;
1194
- }
1195
- export declare namespace RealtimeEndpointInfo {
1196
- /**
1197
- * @internal
1198
- */
1199
- const filterSensitiveLog: (obj: RealtimeEndpointInfo) => any;
1200
- }
1201
- /**
1202
- * <p>Represents the output of an <code>CreateRealtimeEndpoint</code> operation.</p>
1203
- * <p>The result contains the <code>MLModelId</code> and the endpoint information for the <code>MLModel</code>.</p>
1204
- * <p>
1205
- * <b>Note:</b> The endpoint information includes the URI of the <code>MLModel</code>; that is, the location to send online prediction requests for the specified <code>MLModel</code>.</p>
1206
- */
1207
- export interface CreateRealtimeEndpointOutput {
1208
- /**
1209
- * <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>. This value should be identical to the value of the
1210
- * <code>MLModelId</code> in the request.</p>
1211
- */
1212
- MLModelId?: string;
1213
- /**
1214
- * <p>The endpoint information of the <code>MLModel</code>
1215
- * </p>
1216
- */
1217
- RealtimeEndpointInfo?: RealtimeEndpointInfo;
1218
- }
1219
- export declare namespace CreateRealtimeEndpointOutput {
1220
- /**
1221
- * @internal
1222
- */
1223
- const filterSensitiveLog: (obj: CreateRealtimeEndpointOutput) => any;
1224
- }
1225
- export interface DeleteBatchPredictionInput {
1226
- /**
1227
- * <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>.</p>
1228
- */
1229
- BatchPredictionId: string | undefined;
1230
- }
1231
- export declare namespace DeleteBatchPredictionInput {
1232
- /**
1233
- * @internal
1234
- */
1235
- const filterSensitiveLog: (obj: DeleteBatchPredictionInput) => any;
1236
- }
1237
- /**
1238
- * <p> Represents the output of a <code>DeleteBatchPrediction</code> operation.</p>
1239
- * <p>You can use the <code>GetBatchPrediction</code> operation and check the value of the <code>Status</code> parameter to see whether a
1240
- * <code>BatchPrediction</code> is marked as <code>DELETED</code>.</p>
1241
- */
1242
- export interface DeleteBatchPredictionOutput {
1243
- /**
1244
- * <p>A user-supplied ID that uniquely identifies the <code>BatchPrediction</code>. This value should be identical to the value of the <code>BatchPredictionID</code> in the request.</p>
1245
- */
1246
- BatchPredictionId?: string;
1247
- }
1248
- export declare namespace DeleteBatchPredictionOutput {
1249
- /**
1250
- * @internal
1251
- */
1252
- const filterSensitiveLog: (obj: DeleteBatchPredictionOutput) => any;
1253
- }
1254
- export interface DeleteDataSourceInput {
1255
- /**
1256
- * <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>.</p>
1257
- */
1258
- DataSourceId: string | undefined;
1259
- }
1260
- export declare namespace DeleteDataSourceInput {
1261
- /**
1262
- * @internal
1263
- */
1264
- const filterSensitiveLog: (obj: DeleteDataSourceInput) => any;
1265
- }
1266
- /**
1267
- * <p> Represents the output of a <code>DeleteDataSource</code> operation.</p>
1268
- */
1269
- export interface DeleteDataSourceOutput {
1270
- /**
1271
- * <p>A user-supplied ID that uniquely identifies the <code>DataSource</code>. This value should be identical to the value of the <code>DataSourceID</code> in the request.</p>
1272
- */
1273
- DataSourceId?: string;
1274
- }
1275
- export declare namespace DeleteDataSourceOutput {
1276
- /**
1277
- * @internal
1278
- */
1279
- const filterSensitiveLog: (obj: DeleteDataSourceOutput) => any;
1280
- }
1281
- export interface DeleteEvaluationInput {
1282
- /**
1283
- * <p>A user-supplied ID that uniquely identifies the <code>Evaluation</code> to delete.</p>
1284
- */
1285
- EvaluationId: string | undefined;
1286
- }
1287
- export declare namespace DeleteEvaluationInput {
1288
- /**
1289
- * @internal
1290
- */
1291
- const filterSensitiveLog: (obj: DeleteEvaluationInput) => any;
1292
- }
1293
- /**
1294
- * <p> Represents the output of a <code>DeleteEvaluation</code> operation. The output indicates that Amazon Machine Learning (Amazon ML) received the request.</p>
1295
- * <p>You can use the <code>GetEvaluation</code> operation and check the value of the <code>Status</code> parameter to see whether an
1296
- * <code>Evaluation</code> is marked as <code>DELETED</code>.</p>
1297
- */
1298
- export interface DeleteEvaluationOutput {
1299
- /**
1300
- * <p>A user-supplied ID that uniquely identifies the <code>Evaluation</code>. This value should be identical to the value of the <code>EvaluationId</code> in the request.</p>
1301
- */
1302
- EvaluationId?: string;
1303
- }
1304
- export declare namespace DeleteEvaluationOutput {
1305
- /**
1306
- * @internal
1307
- */
1308
- const filterSensitiveLog: (obj: DeleteEvaluationOutput) => any;
1309
- }
1310
- export interface DeleteMLModelInput {
1311
- /**
1312
- * <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>.</p>
1313
- */
1314
- MLModelId: string | undefined;
1315
- }
1316
- export declare namespace DeleteMLModelInput {
1317
- /**
1318
- * @internal
1319
- */
1320
- const filterSensitiveLog: (obj: DeleteMLModelInput) => any;
1321
- }
1322
- /**
1323
- * <p>Represents the output of a <code>DeleteMLModel</code> operation.</p>
1324
- * <p>You can use the <code>GetMLModel</code> operation and check the value of the <code>Status</code> parameter to see whether an
1325
- * <code>MLModel</code> is marked as <code>DELETED</code>.</p>
1326
- */
1327
- export interface DeleteMLModelOutput {
1328
- /**
1329
- * <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>. This value should be identical to the value of the <code>MLModelID</code> in the request.</p>
1330
- */
1331
- MLModelId?: string;
1332
- }
1333
- export declare namespace DeleteMLModelOutput {
1334
- /**
1335
- * @internal
1336
- */
1337
- const filterSensitiveLog: (obj: DeleteMLModelOutput) => any;
1338
- }
1339
- export interface DeleteRealtimeEndpointInput {
1340
- /**
1341
- * <p>The ID assigned to the <code>MLModel</code> during creation.</p>
1342
- */
1343
- MLModelId: string | undefined;
1344
- }
1345
- export declare namespace DeleteRealtimeEndpointInput {
1346
- /**
1347
- * @internal
1348
- */
1349
- const filterSensitiveLog: (obj: DeleteRealtimeEndpointInput) => any;
1350
- }
1351
- /**
1352
- * <p>Represents the output of an <code>DeleteRealtimeEndpoint</code> operation.</p>
1353
- * <p>The result contains the <code>MLModelId</code> and the endpoint information for the <code>MLModel</code>. </p>
1354
- */
1355
- export interface DeleteRealtimeEndpointOutput {
1356
- /**
1357
- * <p>A user-supplied ID that uniquely identifies the <code>MLModel</code>. This value should be identical to the value of the
1358
- * <code>MLModelId</code> in the request.</p>
1359
- */
1360
- MLModelId?: string;
1361
- /**
1362
- * <p>The endpoint information of the <code>MLModel</code>
1363
- * </p>
1364
- */
1365
- RealtimeEndpointInfo?: RealtimeEndpointInfo;
1366
- }
1367
- export declare namespace DeleteRealtimeEndpointOutput {
1368
- /**
1369
- * @internal
1370
- */
1371
- const filterSensitiveLog: (obj: DeleteRealtimeEndpointOutput) => any;
1372
- }
1373
- export interface DeleteTagsInput {
1374
- /**
1375
- * <p>One or more tags to delete.</p>
1376
- */
1377
- TagKeys: string[] | undefined;
1378
- /**
1379
- * <p>The ID of the tagged ML object. For example, <code>exampleModelId</code>.</p>
1380
- */
1381
- ResourceId: string | undefined;
1382
- /**
1383
- * <p>The type of the tagged ML object.</p>
1384
- */
1385
- ResourceType: TaggableResourceType | string | undefined;
1386
- }
1387
- export declare namespace DeleteTagsInput {
1388
- /**
1389
- * @internal
1390
- */
1391
- const filterSensitiveLog: (obj: DeleteTagsInput) => any;
1392
- }
1393
- /**
1394
- * <p>Amazon ML returns the following elements.</p>
1395
- */
1396
- export interface DeleteTagsOutput {
1397
- /**
1398
- * <p>The ID of the ML object from which tags were deleted.</p>
1399
- */
1400
- ResourceId?: string;
1401
- /**
1402
- * <p>The type of the ML object from which tags were deleted.</p>
1403
- */
1404
- ResourceType?: TaggableResourceType | string;
1405
- }
1406
- export declare namespace DeleteTagsOutput {
1407
- /**
1408
- * @internal
1409
- */
1410
- const filterSensitiveLog: (obj: DeleteTagsOutput) => any;
1411
- }
1412
- export declare enum BatchPredictionFilterVariable {
1413
- CREATED_AT = "CreatedAt",
1414
- DATASOURCE_ID = "DataSourceId",
1415
- DATA_URI = "DataURI",
1416
- IAM_USER = "IAMUser",
1417
- LAST_UPDATED_AT = "LastUpdatedAt",
1418
- ML_MODEL_ID = "MLModelId",
1419
- NAME = "Name",
1420
- STATUS = "Status"
1421
- }
1422
- export declare enum SortOrder {
1423
- ASC = "asc",
1424
- DSC = "dsc"
1425
- }
1426
- export interface DescribeBatchPredictionsInput {
1427
- /**
1428
- * <p>Use one of the following variables to filter a list of <code>BatchPrediction</code>:</p>
1429
- * <ul>
1430
- * <li>
1431
- * <p>
1432
- * <code>CreatedAt</code> - Sets the search criteria to the <code>BatchPrediction</code> creation date.</p>
1433
- * </li>
1434
- * <li>
1435
- * <p>
1436
- * <code>Status</code> - Sets the search criteria to the <code>BatchPrediction</code> status.</p>
1437
- * </li>
1438
- * <li>
1439
- * <p>
1440
- * <code>Name</code> - Sets the search criteria to the contents of the <code>BatchPrediction</code>
1441
- * <b> </b>
1442
- * <code>Name</code>.</p>
1443
- * </li>
1444
- * <li>
1445
- * <p>
1446
- * <code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>BatchPrediction</code> creation.</p>
1447
- * </li>
1448
- * <li>
1449
- * <p>
1450
- * <code>MLModelId</code> - Sets the search criteria to the <code>MLModel</code> used in the <code>BatchPrediction</code>.</p>
1451
- * </li>
1452
- * <li>
1453
- * <p>
1454
- * <code>DataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used in the <code>BatchPrediction</code>.</p>
1455
- * </li>
1456
- * <li>
1457
- * <p>
1458
- * <code>DataURI</code> - Sets the search criteria to the data file(s) used in the <code>BatchPrediction</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.</p>
1459
- * </li>
1460
- * </ul>
1461
- */
1462
- FilterVariable?: BatchPredictionFilterVariable | string;
1463
- /**
1464
- * <p>The equal to operator. The <code>BatchPrediction</code> results will have
1465
- * <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
1466
- */
1467
- EQ?: string;
1468
- /**
1469
- * <p>The greater than operator. The <code>BatchPrediction</code> results will
1470
- * have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
1471
- */
1472
- GT?: string;
1473
- /**
1474
- * <p>The less than operator. The <code>BatchPrediction</code> results will
1475
- * have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
1476
- */
1477
- LT?: string;
1478
- /**
1479
- * <p>The greater than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.
1480
- * </p>
1481
- */
1482
- GE?: string;
1483
- /**
1484
- * <p>The less than or equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
1485
- */
1486
- LE?: string;
1487
- /**
1488
- * <p>The not equal to operator. The <code>BatchPrediction</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
1489
- */
1490
- NE?: string;
1491
- /**
1492
- * <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
1493
- * <p>For example, a <code>Batch Prediction</code> operation could have the <code>Name</code>
1494
- * <code>2014-09-09-HolidayGiftMailer</code>. To search for
1495
- * this <code>BatchPrediction</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the
1496
- * <code>Prefix</code>:
1497
- * </p>
1498
- *
1499
- * <ul>
1500
- * <li>
1501
- * <p>2014-09</p>
1502
- * </li>
1503
- * <li>
1504
- * <p>2014-09-09</p>
1505
- * </li>
1506
- * <li>
1507
- * <p>2014-09-09-Holiday</p>
1508
- * </li>
1509
- * </ul>
1510
- */
1511
- Prefix?: string;
1512
- /**
1513
- * <p>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>s.</p>
1514
- * <ul>
1515
- * <li>
1516
- * <p>
1517
- * <code>asc</code> - Arranges the list in ascending order (A-Z, 0-9).</p>
1518
- * </li>
1519
- * <li>
1520
- * <p>
1521
- * <code>dsc</code> - Arranges the list in descending order (Z-A, 9-0).</p>
1522
- * </li>
1523
- * </ul>
1524
- * <p>Results are sorted by <code>FilterVariable</code>.</p>
1525
- */
1526
- SortOrder?: SortOrder | string;
1527
- /**
1528
- * <p>An ID of the page in the paginated results.</p>
1529
- */
1530
- NextToken?: string;
1531
- /**
1532
- * <p>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>.</p>
1533
- */
1534
- Limit?: number;
1535
- }
1536
- export declare namespace DescribeBatchPredictionsInput {
1537
- /**
1538
- * @internal
1539
- */
1540
- const filterSensitiveLog: (obj: DescribeBatchPredictionsInput) => any;
1541
- }
1542
- export declare enum EntityStatus {
1543
- COMPLETED = "COMPLETED",
1544
- DELETED = "DELETED",
1545
- FAILED = "FAILED",
1546
- INPROGRESS = "INPROGRESS",
1547
- PENDING = "PENDING"
1548
- }
1549
- /**
1550
- * <p> Represents the output of a <code>GetBatchPrediction</code> operation.</p>
1551
- * <p> The content consists of the detailed metadata, the status, and the data file information of a
1552
- * <code>Batch Prediction</code>.</p>
1553
- */
1554
- export interface BatchPrediction {
1555
- /**
1556
- * <p>The ID assigned to the <code>BatchPrediction</code> at creation. This value should be identical to the value of the <code>BatchPredictionID</code>
1557
- * in the request.
1558
- * </p>
1559
- */
1560
- BatchPredictionId?: string;
1561
- /**
1562
- * <p>The ID of the <code>MLModel</code> that generated predictions for the <code>BatchPrediction</code> request.</p>
1563
- */
1564
- MLModelId?: string;
1565
- /**
1566
- * <p>The ID of the <code>DataSource</code> that points to the group of observations to predict.</p>
1567
- */
1568
- BatchPredictionDataSourceId?: string;
1569
- /**
1570
- * <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
1571
- */
1572
- InputDataLocationS3?: string;
1573
- /**
1574
- * <p>The AWS user account that invoked the <code>BatchPrediction</code>. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
1575
- */
1576
- CreatedByIamUser?: string;
1577
- /**
1578
- * <p>The time that the <code>BatchPrediction</code> was created. The time is expressed in epoch time.</p>
1579
- */
1580
- CreatedAt?: Date;
1581
- /**
1582
- * <p>The time of the most recent edit to the <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
1583
- */
1584
- LastUpdatedAt?: Date;
1585
- /**
1586
- * <p>A user-supplied name or description of the <code>BatchPrediction</code>.</p>
1587
- */
1588
- Name?: string;
1589
- /**
1590
- * <p>The status of the <code>BatchPrediction</code>. This element can have one of the following values:</p>
1591
- * <ul>
1592
- * <li>
1593
- * <p>
1594
- * <code>PENDING</code> - Amazon Machine Learning (Amazon ML) submitted a request to generate predictions for a batch of observations.</p>
1595
- * </li>
1596
- * <li>
1597
- * <p>
1598
- * <code>INPROGRESS</code> - The process is underway.</p>
1599
- * </li>
1600
- * <li>
1601
- * <p>
1602
- * <code>FAILED</code> - The request to perform a batch prediction did not run to completion. It is not usable.</p>
1603
- * </li>
1604
- * <li>
1605
- * <p>
1606
- * <code>COMPLETED</code> - The batch prediction process completed successfully.</p>
1607
- * </li>
1608
- * <li>
1609
- * <p>
1610
- * <code>DELETED</code> - The <code>BatchPrediction</code> is marked as deleted. It is not usable.</p>
1611
- * </li>
1612
- * </ul>
1613
- */
1614
- Status?: EntityStatus | string;
1615
- /**
1616
- * <p>The location of an Amazon S3 bucket or directory to receive the operation results. The following substrings are not allowed in the <code>s3 key</code> portion of the <code>outputURI</code> field: ':', '//', '/./', '/../'.</p>
1617
- */
1618
- OutputUri?: string;
1619
- /**
1620
- * <p>A description of the most recent details about processing the batch prediction request.</p>
1621
- */
1622
- Message?: string;
1623
- /**
1624
- * <p>Long integer type that is a 64-bit signed number.</p>
1625
- */
1626
- ComputeTime?: number;
1627
- /**
1628
- * <p>A timestamp represented in epoch time.</p>
1629
- */
1630
- FinishedAt?: Date;
1631
- /**
1632
- * <p>A timestamp represented in epoch time.</p>
1633
- */
1634
- StartedAt?: Date;
1635
- /**
1636
- * <p>Long integer type that is a 64-bit signed number.</p>
1637
- */
1638
- TotalRecordCount?: number;
1639
- /**
1640
- * <p>Long integer type that is a 64-bit signed number.</p>
1641
- */
1642
- InvalidRecordCount?: number;
1643
- }
1644
- export declare namespace BatchPrediction {
1645
- /**
1646
- * @internal
1647
- */
1648
- const filterSensitiveLog: (obj: BatchPrediction) => any;
1649
- }
1650
- /**
1651
- * <p>Represents the output of a <code>DescribeBatchPredictions</code> operation. The content is essentially a list of <code>BatchPrediction</code>s.</p>
1652
- */
1653
- export interface DescribeBatchPredictionsOutput {
1654
- /**
1655
- * <p>A list of <code>BatchPrediction</code> objects that meet the search criteria.
1656
- * </p>
1657
- */
1658
- Results?: BatchPrediction[];
1659
- /**
1660
- * <p>The ID of the next page in the paginated results that indicates at least one more page follows.</p>
1661
- */
1662
- NextToken?: string;
1663
- }
1664
- export declare namespace DescribeBatchPredictionsOutput {
1665
- /**
1666
- * @internal
1667
- */
1668
- const filterSensitiveLog: (obj: DescribeBatchPredictionsOutput) => any;
1669
- }
1670
- export declare enum DataSourceFilterVariable {
1671
- CREATED_AT = "CreatedAt",
1672
- DATA_URI = "DataLocationS3",
1673
- IAM_USER = "IAMUser",
1674
- LAST_UPDATED_AT = "LastUpdatedAt",
1675
- NAME = "Name",
1676
- STATUS = "Status"
1677
- }
1678
- export interface DescribeDataSourcesInput {
1679
- /**
1680
- * <p>Use one of the following variables to filter a list of <code>DataSource</code>:</p>
1681
- * <ul>
1682
- * <li>
1683
- * <p>
1684
- * <code>CreatedAt</code> - Sets the search criteria to <code>DataSource</code> creation dates.</p>
1685
- * </li>
1686
- * <li>
1687
- * <p>
1688
- * <code>Status</code> - Sets the search criteria to <code>DataSource</code> statuses.</p>
1689
- * </li>
1690
- * <li>
1691
- * <p>
1692
- * <code>Name</code> - Sets the search criteria to the contents of <code>DataSource</code>
1693
- * <code>Name</code>.</p>
1694
- * </li>
1695
- * <li>
1696
- * <p>
1697
- * <code>DataUri</code> - Sets the search criteria to the URI of data files used to create the <code>DataSource</code>. The URI can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.</p>
1698
- * </li>
1699
- * <li>
1700
- * <p>
1701
- * <code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>DataSource</code> creation.</p>
1702
- * </li>
1703
- * </ul>
1704
- */
1705
- FilterVariable?: DataSourceFilterVariable | string;
1706
- /**
1707
- * <p>The equal to operator. The <code>DataSource</code> results will have
1708
- * <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
1709
- */
1710
- EQ?: string;
1711
- /**
1712
- * <p>The greater than operator. The <code>DataSource</code> results will
1713
- * have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
1714
- */
1715
- GT?: string;
1716
- /**
1717
- * <p>The less than operator. The <code>DataSource</code> results will
1718
- * have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
1719
- */
1720
- LT?: string;
1721
- /**
1722
- * <p>The greater than or equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.
1723
- * </p>
1724
- */
1725
- GE?: string;
1726
- /**
1727
- * <p>The less than or equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
1728
- */
1729
- LE?: string;
1730
- /**
1731
- * <p>The not equal to operator. The <code>DataSource</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
1732
- */
1733
- NE?: string;
1734
- /**
1735
- * <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
1736
- * <p>For example, a <code>DataSource</code> could have the <code>Name</code>
1737
- * <code>2014-09-09-HolidayGiftMailer</code>. To search for
1738
- * this <code>DataSource</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the
1739
- * <code>Prefix</code>:
1740
- * </p>
1741
- *
1742
- * <ul>
1743
- * <li>
1744
- * <p>2014-09</p>
1745
- * </li>
1746
- * <li>
1747
- * <p>2014-09-09</p>
1748
- * </li>
1749
- * <li>
1750
- * <p>2014-09-09-Holiday</p>
1751
- * </li>
1752
- * </ul>
1753
- */
1754
- Prefix?: string;
1755
- /**
1756
- * <p>A two-value parameter that determines the sequence of the resulting list of <code>DataSource</code>.</p>
1757
- * <ul>
1758
- * <li>
1759
- * <p>
1760
- * <code>asc</code> - Arranges the list in ascending order (A-Z, 0-9).</p>
1761
- * </li>
1762
- * <li>
1763
- * <p>
1764
- * <code>dsc</code> - Arranges the list in descending order (Z-A, 9-0).</p>
1765
- * </li>
1766
- * </ul>
1767
- * <p>Results are sorted by <code>FilterVariable</code>.</p>
1768
- */
1769
- SortOrder?: SortOrder | string;
1770
- /**
1771
- * <p>The ID of the page in the paginated results.</p>
1772
- */
1773
- NextToken?: string;
1774
- /**
1775
- * <p> The maximum number of <code>DataSource</code> to include in the result.</p>
1776
- */
1777
- Limit?: number;
1778
- }
1779
- export declare namespace DescribeDataSourcesInput {
1780
- /**
1781
- * @internal
1782
- */
1783
- const filterSensitiveLog: (obj: DescribeDataSourcesInput) => any;
1784
- }
1785
- /**
1786
- * <p>The datasource details that are specific to Amazon RDS.</p>
1787
- */
1788
- export interface RDSMetadata {
1789
- /**
1790
- * <p>The database details required to connect to an Amazon RDS.</p>
1791
- */
1792
- Database?: RDSDatabase;
1793
- /**
1794
- * <p>The username to be used by Amazon ML to connect to database on an Amazon RDS instance.
1795
- * The username should have sufficient permissions to execute an <code>RDSSelectSqlQuery</code> query.</p>
1796
- */
1797
- DatabaseUserName?: string;
1798
- /**
1799
- * <p>The SQL query that is supplied during <a>CreateDataSourceFromRDS</a>. Returns only if <code>Verbose</code> is true in <code>GetDataSourceInput</code>. </p>
1800
- */
1801
- SelectSqlQuery?: string;
1802
- /**
1803
- * <p>The role (DataPipelineDefaultResourceRole) assumed by an Amazon EC2 instance to carry out the copy task from Amazon RDS to Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p>
1804
- */
1805
- ResourceRole?: string;
1806
- /**
1807
- * <p>The role (DataPipelineDefaultRole) assumed by the Data Pipeline service to monitor the progress of the copy task from Amazon RDS to Amazon S3. For more information, see <a href="https://docs.aws.amazon.com/datapipeline/latest/DeveloperGuide/dp-iam-roles.html">Role templates</a> for data pipelines.</p>
1808
- */
1809
- ServiceRole?: string;
1810
- /**
1811
- * <p>The ID of the Data Pipeline instance that is used to carry to copy data from Amazon RDS to Amazon S3. You can use the ID to find details about the instance in the Data Pipeline console.</p>
1812
- */
1813
- DataPipelineId?: string;
1814
- }
1815
- export declare namespace RDSMetadata {
1816
- /**
1817
- * @internal
1818
- */
1819
- const filterSensitiveLog: (obj: RDSMetadata) => any;
1820
- }
1821
- /**
1822
- * <p>Describes the <code>DataSource</code> details specific to Amazon Redshift.</p>
1823
- */
1824
- export interface RedshiftMetadata {
1825
- /**
1826
- * <p>Describes the database details required to connect to an Amazon Redshift database.</p>
1827
- */
1828
- RedshiftDatabase?: RedshiftDatabase;
1829
- /**
1830
- * <p>A username to be used by Amazon Machine Learning (Amazon ML)to connect to a database on an Amazon Redshift cluster.
1831
- * The username should have sufficient permissions to execute the <code>RedshiftSelectSqlQuery</code> query. The username should be valid for an Amazon Redshift <a href="https://docs.aws.amazon.com/redshift/latest/dg/r_CREATE_USER.html">USER</a>.</p>
1832
- */
1833
- DatabaseUserName?: string;
1834
- /**
1835
- * <p> The SQL query that is specified during <a>CreateDataSourceFromRedshift</a>. Returns only if <code>Verbose</code> is true in GetDataSourceInput. </p>
1836
- */
1837
- SelectSqlQuery?: string;
1838
- }
1839
- export declare namespace RedshiftMetadata {
1840
- /**
1841
- * @internal
1842
- */
1843
- const filterSensitiveLog: (obj: RedshiftMetadata) => any;
1844
- }
1845
- /**
1846
- * <p> Represents the output of the <code>GetDataSource</code> operation. </p>
1847
- * <p> The content consists of the detailed metadata and data file information and the current status of the <code>DataSource</code>. </p>
1848
- */
1849
- export interface DataSource {
1850
- /**
1851
- * <p>The ID that is assigned to the <code>DataSource</code> during creation.</p>
1852
- */
1853
- DataSourceId?: string;
1854
- /**
1855
- * <p>The location and name of the data in Amazon Simple Storage Service (Amazon S3) that is used by a <code>DataSource</code>.</p>
1856
- */
1857
- DataLocationS3?: string;
1858
- /**
1859
- * <p>A JSON string that represents the splitting and rearrangement requirement used when this <code>DataSource</code>
1860
- * was created.</p>
1861
- */
1862
- DataRearrangement?: string;
1863
- /**
1864
- * <p>The AWS user account from which the <code>DataSource</code> was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
1865
- */
1866
- CreatedByIamUser?: string;
1867
- /**
1868
- * <p>The time that the <code>DataSource</code> was created. The time is expressed in epoch time.</p>
1869
- */
1870
- CreatedAt?: Date;
1871
- /**
1872
- * <p>The time of the most recent edit to the
1873
- * <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
1874
- */
1875
- LastUpdatedAt?: Date;
1876
- /**
1877
- * <p>The total number of observations contained in the data files that the <code>DataSource</code> references.</p>
1878
- */
1879
- DataSizeInBytes?: number;
1880
- /**
1881
- * <p>The number of data files referenced by the <code>DataSource</code>.</p>
1882
- */
1883
- NumberOfFiles?: number;
1884
- /**
1885
- * <p>A user-supplied name or description of the <code>DataSource</code>.</p>
1886
- */
1887
- Name?: string;
1888
- /**
1889
- * <p>The current status of the <code>DataSource</code>. This element can have one of the following values: </p>
1890
- * <ul>
1891
- * <li>
1892
- * <p>PENDING - Amazon Machine Learning (Amazon ML) submitted a request to create a <code>DataSource</code>.</p>
1893
- * </li>
1894
- * <li>
1895
- * <p>INPROGRESS - The creation process is underway.</p>
1896
- * </li>
1897
- * <li>
1898
- * <p>FAILED - The request to create a <code>DataSource</code> did not run to completion. It is not usable.</p>
1899
- * </li>
1900
- * <li>
1901
- * <p>COMPLETED - The creation process completed successfully.</p>
1902
- * </li>
1903
- * <li>
1904
- * <p>DELETED - The <code>DataSource</code> is marked as deleted. It is not usable.</p>
1905
- * </li>
1906
- * </ul>
1907
- */
1908
- Status?: EntityStatus | string;
1909
- /**
1910
- * <p>A description of the most recent details about creating the <code>DataSource</code>.</p>
1911
- */
1912
- Message?: string;
1913
- /**
1914
- * <p>Describes the <code>DataSource</code> details specific to Amazon Redshift.</p>
1915
- */
1916
- RedshiftMetadata?: RedshiftMetadata;
1917
- /**
1918
- * <p>The datasource details that are specific to Amazon RDS.</p>
1919
- */
1920
- RDSMetadata?: RDSMetadata;
1921
- /**
1922
- * <p>The Amazon Resource Name (ARN) of an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts">AWS IAM Role</a>, such as the following: arn:aws:iam::account:role/rolename. </p>
1923
- */
1924
- RoleARN?: string;
1925
- /**
1926
- * <p>
1927
- * The parameter is <code>true</code> if statistics need to be generated from the observation data.
1928
- * </p>
1929
- */
1930
- ComputeStatistics?: boolean;
1931
- /**
1932
- * <p>Long integer type that is a 64-bit signed number.</p>
1933
- */
1934
- ComputeTime?: number;
1935
- /**
1936
- * <p>A timestamp represented in epoch time.</p>
1937
- */
1938
- FinishedAt?: Date;
1939
- /**
1940
- * <p>A timestamp represented in epoch time.</p>
1941
- */
1942
- StartedAt?: Date;
1943
- }
1944
- export declare namespace DataSource {
1945
- /**
1946
- * @internal
1947
- */
1948
- const filterSensitiveLog: (obj: DataSource) => any;
1949
- }
1950
- /**
1951
- * <p>Represents the query results from a <a>DescribeDataSources</a> operation. The content is essentially a list of <code>DataSource</code>.</p>
1952
- */
1953
- export interface DescribeDataSourcesOutput {
1954
- /**
1955
- * <p>A list of <code>DataSource</code> that meet the search criteria.
1956
- * </p>
1957
- */
1958
- Results?: DataSource[];
1959
- /**
1960
- * <p>An ID of the next page in the paginated results that indicates at least one more page follows.</p>
1961
- */
1962
- NextToken?: string;
1963
- }
1964
- export declare namespace DescribeDataSourcesOutput {
1965
- /**
1966
- * @internal
1967
- */
1968
- const filterSensitiveLog: (obj: DescribeDataSourcesOutput) => any;
1969
- }
1970
- export declare enum EvaluationFilterVariable {
1971
- CREATED_AT = "CreatedAt",
1972
- DATASOURCE_ID = "DataSourceId",
1973
- DATA_URI = "DataURI",
1974
- IAM_USER = "IAMUser",
1975
- LAST_UPDATED_AT = "LastUpdatedAt",
1976
- ML_MODEL_ID = "MLModelId",
1977
- NAME = "Name",
1978
- STATUS = "Status"
1979
- }
1980
- export interface DescribeEvaluationsInput {
1981
- /**
1982
- * <p>Use one of the following variable to filter a list of <code>Evaluation</code> objects:</p>
1983
- * <ul>
1984
- * <li>
1985
- * <p>
1986
- * <code>CreatedAt</code> - Sets the search criteria to the <code>Evaluation</code> creation date.</p>
1987
- * </li>
1988
- * <li>
1989
- * <p>
1990
- * <code>Status</code> - Sets the search criteria to the <code>Evaluation</code> status.</p>
1991
- * </li>
1992
- * <li>
1993
- * <p>
1994
- * <code>Name</code> - Sets the search criteria to the contents of <code>Evaluation</code>
1995
- * <b> </b>
1996
- * <code>Name</code>.</p>
1997
- * </li>
1998
- * <li>
1999
- * <p>
2000
- * <code>IAMUser</code> - Sets the search criteria to the user account that invoked an <code>Evaluation</code>.</p>
2001
- * </li>
2002
- * <li>
2003
- * <p>
2004
- * <code>MLModelId</code> - Sets the search criteria to the <code>MLModel</code> that was evaluated.</p>
2005
- * </li>
2006
- * <li>
2007
- * <p>
2008
- * <code>DataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used in <code>Evaluation</code>.</p>
2009
- * </li>
2010
- * <li>
2011
- * <p>
2012
- * <code>DataUri</code> - Sets the search criteria to the data file(s) used in <code>Evaluation</code>. The URL can identify either a file or an Amazon Simple Storage Solution (Amazon S3) bucket or directory.</p>
2013
- * </li>
2014
- * </ul>
2015
- */
2016
- FilterVariable?: EvaluationFilterVariable | string;
2017
- /**
2018
- * <p>The equal to operator. The <code>Evaluation</code> results will have
2019
- * <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
2020
- */
2021
- EQ?: string;
2022
- /**
2023
- * <p>The greater than operator. The <code>Evaluation</code> results will
2024
- * have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
2025
- */
2026
- GT?: string;
2027
- /**
2028
- * <p>The less than operator. The <code>Evaluation</code> results will
2029
- * have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
2030
- */
2031
- LT?: string;
2032
- /**
2033
- * <p>The greater than or equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.
2034
- * </p>
2035
- */
2036
- GE?: string;
2037
- /**
2038
- * <p>The less than or equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
2039
- */
2040
- LE?: string;
2041
- /**
2042
- * <p>The not equal to operator. The <code>Evaluation</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
2043
- */
2044
- NE?: string;
2045
- /**
2046
- * <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
2047
- * <p>For example, an <code>Evaluation</code> could have the <code>Name</code>
2048
- * <code>2014-09-09-HolidayGiftMailer</code>. To search for
2049
- * this <code>Evaluation</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the
2050
- * <code>Prefix</code>:
2051
- * </p>
2052
- *
2053
- * <ul>
2054
- * <li>
2055
- * <p>2014-09</p>
2056
- * </li>
2057
- * <li>
2058
- * <p>2014-09-09</p>
2059
- * </li>
2060
- * <li>
2061
- * <p>2014-09-09-Holiday</p>
2062
- * </li>
2063
- * </ul>
2064
- */
2065
- Prefix?: string;
2066
- /**
2067
- * <p>A two-value parameter that determines the sequence of the resulting list of <code>Evaluation</code>.</p>
2068
- * <ul>
2069
- * <li>
2070
- * <p>
2071
- * <code>asc</code> - Arranges the list in ascending order (A-Z, 0-9).</p>
2072
- * </li>
2073
- * <li>
2074
- * <p>
2075
- * <code>dsc</code> - Arranges the list in descending order (Z-A, 9-0).</p>
2076
- * </li>
2077
- * </ul>
2078
- * <p>Results are sorted by <code>FilterVariable</code>.</p>
2079
- */
2080
- SortOrder?: SortOrder | string;
2081
- /**
2082
- * <p>The ID of the page in the paginated results.</p>
2083
- */
2084
- NextToken?: string;
2085
- /**
2086
- * <p> The maximum number of <code>Evaluation</code> to include in the result.</p>
2087
- */
2088
- Limit?: number;
2089
- }
2090
- export declare namespace DescribeEvaluationsInput {
2091
- /**
2092
- * @internal
2093
- */
2094
- const filterSensitiveLog: (obj: DescribeEvaluationsInput) => any;
2095
- }
2096
- /**
2097
- * <p>Measurements of how well the <code>MLModel</code> performed on known observations. One of the following metrics is returned, based on the type of the <code>MLModel</code>:
2098
- * </p>
2099
- * <ul>
2100
- * <li>
2101
- * <p>BinaryAUC: The binary <code>MLModel</code> uses the Area Under the Curve (AUC) technique to measure performance. </p>
2102
- * </li>
2103
- * <li>
2104
- * <p>RegressionRMSE: The regression <code>MLModel</code> uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.</p>
2105
- * </li>
2106
- * <li>
2107
- * <p>MulticlassAvgFScore: The multiclass <code>MLModel</code> uses the F1 score technique to measure performance. </p>
2108
- * </li>
2109
- * </ul>
2110
- * <p>
2111
- * For more information about performance metrics, please see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.
2112
- * </p>
2113
- */
2114
- export interface PerformanceMetrics {
2115
- Properties?: {
2116
- [key: string]: string;
2117
- };
2118
- }
2119
- export declare namespace PerformanceMetrics {
2120
- /**
2121
- * @internal
2122
- */
2123
- const filterSensitiveLog: (obj: PerformanceMetrics) => any;
2124
- }
2125
- /**
2126
- * <p> Represents the output of <code>GetEvaluation</code> operation. </p>
2127
- * <p>The content consists of the detailed metadata and data file information and the current status of the
2128
- * <code>Evaluation</code>.</p>
2129
- */
2130
- export interface Evaluation {
2131
- /**
2132
- * <p>The ID that is assigned to the <code>Evaluation</code> at creation.</p>
2133
- */
2134
- EvaluationId?: string;
2135
- /**
2136
- * <p>The ID of the <code>MLModel</code> that is the focus of the evaluation.</p>
2137
- */
2138
- MLModelId?: string;
2139
- /**
2140
- * <p>The ID of the <code>DataSource</code> that is used to evaluate the <code>MLModel</code>.</p>
2141
- */
2142
- EvaluationDataSourceId?: string;
2143
- /**
2144
- * <p>The location and name of the data in Amazon Simple Storage Server (Amazon S3) that is used in the evaluation.</p>
2145
- */
2146
- InputDataLocationS3?: string;
2147
- /**
2148
- * <p>The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
2149
- */
2150
- CreatedByIamUser?: string;
2151
- /**
2152
- * <p>The time that the <code>Evaluation</code> was created. The time is expressed in epoch time.</p>
2153
- */
2154
- CreatedAt?: Date;
2155
- /**
2156
- * <p>The time of the most recent edit to the <code>Evaluation</code>. The time is expressed in epoch time.</p>
2157
- */
2158
- LastUpdatedAt?: Date;
2159
- /**
2160
- * <p>A user-supplied name or description of the <code>Evaluation</code>. </p>
2161
- */
2162
- Name?: string;
2163
- /**
2164
- * <p>The status of the evaluation. This element can have one of the following values:</p>
2165
- * <ul>
2166
- * <li>
2167
- * <p>
2168
- * <code>PENDING</code> - Amazon Machine Learning (Amazon ML) submitted a request to evaluate an <code>MLModel</code>.</p>
2169
- * </li>
2170
- * <li>
2171
- * <p>
2172
- * <code>INPROGRESS</code> - The evaluation is underway.</p>
2173
- * </li>
2174
- * <li>
2175
- * <p>
2176
- * <code>FAILED</code> - The request to evaluate an <code>MLModel</code> did not run to completion. It is not usable.</p>
2177
- * </li>
2178
- * <li>
2179
- * <p>
2180
- * <code>COMPLETED</code> - The evaluation process completed successfully.</p>
2181
- * </li>
2182
- * <li>
2183
- * <p>
2184
- * <code>DELETED</code> - The <code>Evaluation</code> is marked as deleted. It is not usable.</p>
2185
- * </li>
2186
- * </ul>
2187
- */
2188
- Status?: EntityStatus | string;
2189
- /**
2190
- * <p>Measurements of how well the <code>MLModel</code> performed, using observations referenced
2191
- * by the <code>DataSource</code>. One of the following metrics is returned, based on the type of the <code>MLModel</code>:
2192
- * </p>
2193
- * <ul>
2194
- * <li>
2195
- * <p>BinaryAUC: A binary <code>MLModel</code> uses the Area Under the Curve (AUC) technique to measure performance. </p>
2196
- * </li>
2197
- * <li>
2198
- * <p>RegressionRMSE: A regression <code>MLModel</code> uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.</p>
2199
- * </li>
2200
- * <li>
2201
- * <p>MulticlassAvgFScore: A multiclass <code>MLModel</code> uses the F1 score technique to measure performance. </p>
2202
- * </li>
2203
- * </ul>
2204
- * <p>
2205
- * For more information about performance metrics, please see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.
2206
- * </p>
2207
- */
2208
- PerformanceMetrics?: PerformanceMetrics;
2209
- /**
2210
- * <p>A description of the most recent details about evaluating the <code>MLModel</code>.</p>
2211
- */
2212
- Message?: string;
2213
- /**
2214
- * <p>Long integer type that is a 64-bit signed number.</p>
2215
- */
2216
- ComputeTime?: number;
2217
- /**
2218
- * <p>A timestamp represented in epoch time.</p>
2219
- */
2220
- FinishedAt?: Date;
2221
- /**
2222
- * <p>A timestamp represented in epoch time.</p>
2223
- */
2224
- StartedAt?: Date;
2225
- }
2226
- export declare namespace Evaluation {
2227
- /**
2228
- * @internal
2229
- */
2230
- const filterSensitiveLog: (obj: Evaluation) => any;
2231
- }
2232
- /**
2233
- * <p>Represents the query results from a <code>DescribeEvaluations</code> operation. The content is essentially a list of <code>Evaluation</code>.</p>
2234
- */
2235
- export interface DescribeEvaluationsOutput {
2236
- /**
2237
- * <p>A list of <code>Evaluation</code> that meet the search criteria.
2238
- * </p>
2239
- */
2240
- Results?: Evaluation[];
2241
- /**
2242
- * <p>The ID of the next page in the paginated results that indicates at least one more page follows.</p>
2243
- */
2244
- NextToken?: string;
2245
- }
2246
- export declare namespace DescribeEvaluationsOutput {
2247
- /**
2248
- * @internal
2249
- */
2250
- const filterSensitiveLog: (obj: DescribeEvaluationsOutput) => any;
2251
- }
2252
- export declare enum MLModelFilterVariable {
2253
- ALGORITHM = "Algorithm",
2254
- CREATED_AT = "CreatedAt",
2255
- IAM_USER = "IAMUser",
2256
- LAST_UPDATED_AT = "LastUpdatedAt",
2257
- ML_MODEL_TYPE = "MLModelType",
2258
- NAME = "Name",
2259
- REAL_TIME_ENDPOINT_STATUS = "RealtimeEndpointStatus",
2260
- STATUS = "Status",
2261
- TRAINING_DATASOURCE_ID = "TrainingDataSourceId",
2262
- TRAINING_DATA_URI = "TrainingDataURI"
2263
- }
2264
- export interface DescribeMLModelsInput {
2265
- /**
2266
- * <p>Use one of the following variables to filter a list of <code>MLModel</code>:</p>
2267
- * <ul>
2268
- * <li>
2269
- * <p>
2270
- * <code>CreatedAt</code> - Sets the search criteria to <code>MLModel</code> creation date.</p>
2271
- * </li>
2272
- * <li>
2273
- * <p>
2274
- * <code>Status</code> - Sets the search criteria to <code>MLModel</code> status.</p>
2275
- * </li>
2276
- * <li>
2277
- * <p>
2278
- * <code>Name</code> - Sets the search criteria to the contents of <code>MLModel</code>
2279
- * <b> </b>
2280
- * <code>Name</code>.</p>
2281
- * </li>
2282
- * <li>
2283
- * <p>
2284
- * <code>IAMUser</code> - Sets the search criteria to the user account that invoked the <code>MLModel</code> creation.</p>
2285
- * </li>
2286
- * <li>
2287
- * <p>
2288
- * <code>TrainingDataSourceId</code> - Sets the search criteria to the <code>DataSource</code> used to train one or more <code>MLModel</code>.</p>
2289
- * </li>
2290
- * <li>
2291
- * <p>
2292
- * <code>RealtimeEndpointStatus</code> - Sets the search criteria to the <code>MLModel</code> real-time endpoint status.</p>
2293
- * </li>
2294
- * <li>
2295
- * <p>
2296
- * <code>MLModelType</code> - Sets the search criteria to <code>MLModel</code> type: binary, regression, or multi-class.</p>
2297
- * </li>
2298
- * <li>
2299
- * <p>
2300
- * <code>Algorithm</code> - Sets the search criteria to the algorithm that the <code>MLModel</code> uses.</p>
2301
- * </li>
2302
- * <li>
2303
- * <p>
2304
- * <code>TrainingDataURI</code> - Sets the search criteria to the data file(s) used in training a <code>MLModel</code>. The URL can identify either a file or an Amazon Simple Storage Service (Amazon S3) bucket or directory.</p>
2305
- * </li>
2306
- * </ul>
2307
- */
2308
- FilterVariable?: MLModelFilterVariable | string;
2309
- /**
2310
- * <p>The equal to operator. The <code>MLModel</code> results will have
2311
- * <code>FilterVariable</code> values that exactly match the value specified with <code>EQ</code>.</p>
2312
- */
2313
- EQ?: string;
2314
- /**
2315
- * <p>The greater than operator. The <code>MLModel</code> results will
2316
- * have <code>FilterVariable</code> values that are greater than the value specified with <code>GT</code>.</p>
2317
- */
2318
- GT?: string;
2319
- /**
2320
- * <p>The less than operator. The <code>MLModel</code> results will
2321
- * have <code>FilterVariable</code> values that are less than the value specified with <code>LT</code>.</p>
2322
- */
2323
- LT?: string;
2324
- /**
2325
- * <p>The greater than or equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are greater than or equal to the value specified with <code>GE</code>.
2326
- * </p>
2327
- */
2328
- GE?: string;
2329
- /**
2330
- * <p>The less than or equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values that are less than or equal to the value specified with <code>LE</code>.</p>
2331
- */
2332
- LE?: string;
2333
- /**
2334
- * <p>The not equal to operator. The <code>MLModel</code> results will have <code>FilterVariable</code> values not equal to the value specified with <code>NE</code>.</p>
2335
- */
2336
- NE?: string;
2337
- /**
2338
- * <p>A string that is found at the beginning of a variable, such as <code>Name</code> or <code>Id</code>.</p>
2339
- * <p>For example, an <code>MLModel</code> could have the <code>Name</code>
2340
- * <code>2014-09-09-HolidayGiftMailer</code>. To search for
2341
- * this <code>MLModel</code>, select <code>Name</code> for the <code>FilterVariable</code> and any of the following strings for the
2342
- * <code>Prefix</code>:
2343
- * </p>
2344
- *
2345
- * <ul>
2346
- * <li>
2347
- * <p>2014-09</p>
2348
- * </li>
2349
- * <li>
2350
- * <p>2014-09-09</p>
2351
- * </li>
2352
- * <li>
2353
- * <p>2014-09-09-Holiday</p>
2354
- * </li>
2355
- * </ul>
2356
- */
2357
- Prefix?: string;
2358
- /**
2359
- * <p>A two-value parameter that determines the sequence of the resulting list of <code>MLModel</code>.</p>
2360
- * <ul>
2361
- * <li>
2362
- * <p>
2363
- * <code>asc</code> - Arranges the list in ascending order (A-Z, 0-9).</p>
2364
- * </li>
2365
- * <li>
2366
- * <p>
2367
- * <code>dsc</code> - Arranges the list in descending order (Z-A, 9-0).</p>
2368
- * </li>
2369
- * </ul>
2370
- * <p>Results are sorted by <code>FilterVariable</code>.</p>
2371
- */
2372
- SortOrder?: SortOrder | string;
2373
- /**
2374
- * <p>The ID of the page in the paginated results.</p>
2375
- */
2376
- NextToken?: string;
2377
- /**
2378
- * <p>The number of pages of information to include in the result. The range of acceptable values is <code>1</code> through <code>100</code>. The default value is <code>100</code>.</p>
2379
- */
2380
- Limit?: number;
2381
- }
2382
- export declare namespace DescribeMLModelsInput {
2383
- /**
2384
- * @internal
2385
- */
2386
- const filterSensitiveLog: (obj: DescribeMLModelsInput) => any;
2387
- }
2388
- /**
2389
- * <p> Represents the output of a <code>GetMLModel</code> operation. </p>
2390
- * <p>The content consists of the detailed metadata and the current status of the <code>MLModel</code>.</p>
2391
- */
2392
- export interface MLModel {
2393
- /**
2394
- * <p>The ID assigned to the <code>MLModel</code> at creation.</p>
2395
- */
2396
- MLModelId?: string;
2397
- /**
2398
- * <p>The ID of the training <code>DataSource</code>. The <code>CreateMLModel</code> operation uses the <code>TrainingDataSourceId</code>.</p>
2399
- */
2400
- TrainingDataSourceId?: string;
2401
- /**
2402
- * <p>The AWS user account from which the <code>MLModel</code> was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
2403
- */
2404
- CreatedByIamUser?: string;
2405
- /**
2406
- * <p>The time that the <code>MLModel</code> was created. The time is expressed in epoch time.</p>
2407
- */
2408
- CreatedAt?: Date;
2409
- /**
2410
- * <p>The time of the most recent edit to the <code>MLModel</code>. The time is expressed in epoch time.</p>
2411
- */
2412
- LastUpdatedAt?: Date;
2413
- /**
2414
- * <p>A user-supplied name or description of the <code>MLModel</code>.</p>
2415
- */
2416
- Name?: string;
2417
- /**
2418
- * <p>The current status of an <code>MLModel</code>. This element can have one of the following values: </p>
2419
- * <ul>
2420
- * <li>
2421
- * <p>
2422
- * <code>PENDING</code> - Amazon Machine Learning (Amazon ML) submitted a request to create an <code>MLModel</code>.</p>
2423
- * </li>
2424
- * <li>
2425
- * <p>
2426
- * <code>INPROGRESS</code> - The creation process is underway.</p>
2427
- * </li>
2428
- * <li>
2429
- * <p>
2430
- * <code>FAILED</code> - The request to create an <code>MLModel</code> didn't run to
2431
- * completion. The model isn't usable.</p>
2432
- * </li>
2433
- * <li>
2434
- * <p>
2435
- * <code>COMPLETED</code> - The creation process completed successfully.</p>
2436
- * </li>
2437
- * <li>
2438
- * <p>
2439
- * <code>DELETED</code> - The <code>MLModel</code> is marked as deleted. It isn't
2440
- * usable.</p>
2441
- * </li>
2442
- * </ul>
2443
- */
2444
- Status?: EntityStatus | string;
2445
- /**
2446
- * <p>Long integer type that is a 64-bit signed number.</p>
2447
- */
2448
- SizeInBytes?: number;
2449
- /**
2450
- * <p>The current endpoint of the <code>MLModel</code>.</p>
2451
- */
2452
- EndpointInfo?: RealtimeEndpointInfo;
2453
- /**
2454
- * <p>A list of the training parameters in the <code>MLModel</code>. The list is implemented as
2455
- * a map of key-value pairs.</p>
2456
- * <p>The following is the current set of training parameters:</p>
2457
- * <ul>
2458
- * <li>
2459
- * <p>
2460
- * <code>sgd.maxMLModelSizeInBytes</code> - The maximum allowed size of the model. Depending on the
2461
- * input data, the size of the model might affect its performance.</p>
2462
- * <p> The value is an integer that ranges from <code>100000</code> to <code>2147483648</code>. The default value is <code>33554432</code>.</p>
2463
- * </li>
2464
- * <li>
2465
- * <p>
2466
- * <code>sgd.maxPasses</code> - The number of times that the training process traverses the
2467
- * observations to build the <code>MLModel</code>. The value is an integer that
2468
- * ranges from <code>1</code> to <code>10000</code>. The default value is
2469
- * <code>10</code>.</p>
2470
- * </li>
2471
- * <li>
2472
- * <p>
2473
- * <code>sgd.shuffleType</code> - Whether Amazon ML shuffles the training data. Shuffling the data
2474
- * improves a model's ability to find the optimal solution for a variety of data
2475
- * types. The valid values are <code>auto</code> and <code>none</code>. The default
2476
- * value is <code>none</code>.</p>
2477
- * </li>
2478
- * <li>
2479
- * <p>
2480
- * <code>sgd.l1RegularizationAmount</code> - The coefficient regularization L1 norm, which controls
2481
- * overfitting the data by penalizing large coefficients. This parameter tends to
2482
- * drive coefficients to zero, resulting in sparse feature set. If you use this
2483
- * parameter, start by specifying a small value, such as <code>1.0E-08</code>.</p>
2484
- * <p>The value is a double that ranges from <code>0</code> to <code>MAX_DOUBLE</code>.
2485
- * The default is to not use L1 normalization. This parameter can't be used when
2486
- * <code>L2</code> is specified. Use this parameter sparingly.</p>
2487
- * </li>
2488
- * <li>
2489
- * <p>
2490
- * <code>sgd.l2RegularizationAmount</code> - The coefficient regularization L2 norm, which controls
2491
- * overfitting the data by penalizing large coefficients. This tends to drive
2492
- * coefficients to small, nonzero values. If you use this parameter, start by
2493
- * specifying a small value, such as <code>1.0E-08</code>.</p>
2494
- * <p>The value is a double that ranges from <code>0</code> to <code>MAX_DOUBLE</code>.
2495
- * The default is to not use L2 normalization. This parameter can't be used when
2496
- * <code>L1</code> is specified. Use this parameter sparingly.</p>
2497
- * </li>
2498
- * </ul>
2499
- */
2500
- TrainingParameters?: {
2501
- [key: string]: string;
2502
- };
2503
- /**
2504
- * <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
2505
- */
2506
- InputDataLocationS3?: string;
2507
- /**
2508
- * <p>The algorithm used to train the <code>MLModel</code>. The following algorithm is supported:</p>
2509
- * <ul>
2510
- * <li>
2511
- * <p>
2512
- * <code>SGD</code> -- Stochastic gradient descent. The goal of <code>SGD</code> is to minimize the gradient of the loss function. </p>
2513
- * </li>
2514
- * </ul>
2515
- */
2516
- Algorithm?: Algorithm | string;
2517
- /**
2518
- * <p>Identifies the <code>MLModel</code> category. The following are the available types:</p>
2519
- * <ul>
2520
- * <li>
2521
- * <p>
2522
- * <code>REGRESSION</code> - Produces a numeric result. For example, "What price should a
2523
- * house be listed at?"</p>
2524
- * </li>
2525
- * <li>
2526
- * <p>
2527
- * <code>BINARY</code> - Produces one of two possible results. For example, "Is this a
2528
- * child-friendly web site?".</p>
2529
- * </li>
2530
- * <li>
2531
- * <p>
2532
- * <code>MULTICLASS</code> - Produces one of several possible results. For example, "Is
2533
- * this a HIGH-, LOW-, or MEDIUM-risk trade?".</p>
2534
- * </li>
2535
- * </ul>
2536
- */
2537
- MLModelType?: MLModelType | string;
2538
- ScoreThreshold?: number;
2539
- /**
2540
- * <p>The time of the most recent edit to the <code>ScoreThreshold</code>. The time is expressed in epoch time.</p>
2541
- */
2542
- ScoreThresholdLastUpdatedAt?: Date;
2543
- /**
2544
- * <p>A description of the most recent details about accessing the <code>MLModel</code>.</p>
2545
- */
2546
- Message?: string;
2547
- /**
2548
- * <p>Long integer type that is a 64-bit signed number.</p>
2549
- */
2550
- ComputeTime?: number;
2551
- /**
2552
- * <p>A timestamp represented in epoch time.</p>
2553
- */
2554
- FinishedAt?: Date;
2555
- /**
2556
- * <p>A timestamp represented in epoch time.</p>
2557
- */
2558
- StartedAt?: Date;
2559
- }
2560
- export declare namespace MLModel {
2561
- /**
2562
- * @internal
2563
- */
2564
- const filterSensitiveLog: (obj: MLModel) => any;
2565
- }
2566
- /**
2567
- * <p>Represents the output of a <code>DescribeMLModels</code> operation. The content is essentially a list of <code>MLModel</code>.</p>
2568
- */
2569
- export interface DescribeMLModelsOutput {
2570
- /**
2571
- * <p>A list of <code>MLModel</code> that meet the search criteria.</p>
2572
- */
2573
- Results?: MLModel[];
2574
- /**
2575
- * <p>The ID of the next page in the paginated results that indicates at least one more page follows.</p>
2576
- */
2577
- NextToken?: string;
2578
- }
2579
- export declare namespace DescribeMLModelsOutput {
2580
- /**
2581
- * @internal
2582
- */
2583
- const filterSensitiveLog: (obj: DescribeMLModelsOutput) => any;
2584
- }
2585
- export interface DescribeTagsInput {
2586
- /**
2587
- * <p>The ID of the ML object. For example, <code>exampleModelId</code>. </p>
2588
- */
2589
- ResourceId: string | undefined;
2590
- /**
2591
- * <p>The type of the ML object.</p>
2592
- */
2593
- ResourceType: TaggableResourceType | string | undefined;
2594
- }
2595
- export declare namespace DescribeTagsInput {
2596
- /**
2597
- * @internal
2598
- */
2599
- const filterSensitiveLog: (obj: DescribeTagsInput) => any;
2600
- }
2601
- /**
2602
- * <p>Amazon ML returns the following elements.</p>
2603
- */
2604
- export interface DescribeTagsOutput {
2605
- /**
2606
- * <p>The ID of the tagged ML object.</p>
2607
- */
2608
- ResourceId?: string;
2609
- /**
2610
- * <p>The type of the tagged ML object.</p>
2611
- */
2612
- ResourceType?: TaggableResourceType | string;
2613
- /**
2614
- * <p>A list of tags associated with the ML object.</p>
2615
- */
2616
- Tags?: Tag[];
2617
- }
2618
- export declare namespace DescribeTagsOutput {
2619
- /**
2620
- * @internal
2621
- */
2622
- const filterSensitiveLog: (obj: DescribeTagsOutput) => any;
2623
- }
2624
- export interface GetBatchPredictionInput {
2625
- /**
2626
- * <p>An ID assigned to the <code>BatchPrediction</code> at creation.</p>
2627
- */
2628
- BatchPredictionId: string | undefined;
2629
- }
2630
- export declare namespace GetBatchPredictionInput {
2631
- /**
2632
- * @internal
2633
- */
2634
- const filterSensitiveLog: (obj: GetBatchPredictionInput) => any;
2635
- }
2636
- /**
2637
- * <p>Represents the output of a <code>GetBatchPrediction</code> operation and describes a <code>BatchPrediction</code>.</p>
2638
- */
2639
- export interface GetBatchPredictionOutput {
2640
- /**
2641
- * <p>An ID assigned to the <code>BatchPrediction</code> at creation. This value should be identical to the value of the <code>BatchPredictionID</code>
2642
- * in the request.</p>
2643
- */
2644
- BatchPredictionId?: string;
2645
- /**
2646
- * <p>The ID of the <code>MLModel</code> that generated predictions for the <code>BatchPrediction</code> request.</p>
2647
- */
2648
- MLModelId?: string;
2649
- /**
2650
- * <p>The ID of the <code>DataSource</code> that was used to create the <code>BatchPrediction</code>.
2651
- * </p>
2652
- */
2653
- BatchPredictionDataSourceId?: string;
2654
- /**
2655
- * <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
2656
- */
2657
- InputDataLocationS3?: string;
2658
- /**
2659
- * <p>The AWS user account that invoked the <code>BatchPrediction</code>. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
2660
- */
2661
- CreatedByIamUser?: string;
2662
- /**
2663
- * <p>The time when the <code>BatchPrediction</code> was created. The time is expressed in epoch time.</p>
2664
- */
2665
- CreatedAt?: Date;
2666
- /**
2667
- * <p>The time of the most recent edit to <code>BatchPrediction</code>. The time is expressed in epoch time.</p>
2668
- */
2669
- LastUpdatedAt?: Date;
2670
- /**
2671
- * <p>A user-supplied name or description of the <code>BatchPrediction</code>.</p>
2672
- */
2673
- Name?: string;
2674
- /**
2675
- * <p>The status of the <code>BatchPrediction</code>, which can be one of the following values:</p>
2676
- * <ul>
2677
- * <li>
2678
- * <p>
2679
- * <code>PENDING</code> - Amazon Machine Learning (Amazon ML) submitted a request to generate batch predictions.</p>
2680
- * </li>
2681
- * <li>
2682
- * <p>
2683
- * <code>INPROGRESS</code> - The batch predictions are in progress.</p>
2684
- * </li>
2685
- * <li>
2686
- * <p>
2687
- * <code>FAILED</code> - The request to perform a batch prediction did not run to completion. It is not usable.</p>
2688
- * </li>
2689
- * <li>
2690
- * <p>
2691
- * <code>COMPLETED</code> - The batch prediction process completed successfully.</p>
2692
- * </li>
2693
- * <li>
2694
- * <p>
2695
- * <code>DELETED</code> - The <code>BatchPrediction</code> is marked as deleted. It is not usable.</p>
2696
- * </li>
2697
- * </ul>
2698
- */
2699
- Status?: EntityStatus | string;
2700
- /**
2701
- * <p>The location of an Amazon S3 bucket or directory to receive the operation results.</p>
2702
- */
2703
- OutputUri?: string;
2704
- /**
2705
- * <p>A link to the file that contains logs of the <code>CreateBatchPrediction</code> operation.</p>
2706
- */
2707
- LogUri?: string;
2708
- /**
2709
- * <p>A description of the most recent details about processing the batch prediction request.</p>
2710
- */
2711
- Message?: string;
2712
- /**
2713
- * <p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>BatchPrediction</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>BatchPrediction</code> is in the <code>COMPLETED</code> state.</p>
2714
- */
2715
- ComputeTime?: number;
2716
- /**
2717
- * <p>The epoch time when Amazon Machine Learning marked the <code>BatchPrediction</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>BatchPrediction</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>
2718
- */
2719
- FinishedAt?: Date;
2720
- /**
2721
- * <p>The epoch time when Amazon Machine Learning marked the <code>BatchPrediction</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>BatchPrediction</code> is in the <code>PENDING</code> state.</p>
2722
- */
2723
- StartedAt?: Date;
2724
- /**
2725
- * <p>The number of total records that Amazon Machine Learning saw while processing the <code>BatchPrediction</code>.</p>
2726
- */
2727
- TotalRecordCount?: number;
2728
- /**
2729
- * <p>The number of invalid records that Amazon Machine Learning saw while processing the <code>BatchPrediction</code>.</p>
2730
- */
2731
- InvalidRecordCount?: number;
2732
- }
2733
- export declare namespace GetBatchPredictionOutput {
2734
- /**
2735
- * @internal
2736
- */
2737
- const filterSensitiveLog: (obj: GetBatchPredictionOutput) => any;
2738
- }
2739
- export interface GetDataSourceInput {
2740
- /**
2741
- * <p>The ID assigned to the <code>DataSource</code> at creation.</p>
2742
- */
2743
- DataSourceId: string | undefined;
2744
- /**
2745
- * <p>Specifies whether the <code>GetDataSource</code> operation should return <code>DataSourceSchema</code>.</p>
2746
- * <p>If true, <code>DataSourceSchema</code> is returned.</p>
2747
- * <p>If false, <code>DataSourceSchema</code> is not returned.</p>
2748
- */
2749
- Verbose?: boolean;
2750
- }
2751
- export declare namespace GetDataSourceInput {
2752
- /**
2753
- * @internal
2754
- */
2755
- const filterSensitiveLog: (obj: GetDataSourceInput) => any;
2756
- }
2757
- /**
2758
- * <p>Represents the output of a <code>GetDataSource</code> operation and describes a <code>DataSource</code>.</p>
2759
- */
2760
- export interface GetDataSourceOutput {
2761
- /**
2762
- * <p>The ID assigned to the <code>DataSource</code> at creation. This value should be identical to the value of the <code>DataSourceId</code> in the request.</p>
2763
- */
2764
- DataSourceId?: string;
2765
- /**
2766
- * <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
2767
- */
2768
- DataLocationS3?: string;
2769
- /**
2770
- * <p>A JSON string that represents the splitting and rearrangement requirement used when this <code>DataSource</code>
2771
- * was created.</p>
2772
- */
2773
- DataRearrangement?: string;
2774
- /**
2775
- * <p>The AWS user account from which the <code>DataSource</code> was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
2776
- */
2777
- CreatedByIamUser?: string;
2778
- /**
2779
- * <p>The time that the <code>DataSource</code> was created. The time is expressed in epoch time.</p>
2780
- */
2781
- CreatedAt?: Date;
2782
- /**
2783
- * <p>The time of the most recent edit to the <code>DataSource</code>. The time is expressed in epoch time.</p>
2784
- */
2785
- LastUpdatedAt?: Date;
2786
- /**
2787
- * <p>The total size of observations in the data files.</p>
2788
- */
2789
- DataSizeInBytes?: number;
2790
- /**
2791
- * <p>The number of data files referenced by the <code>DataSource</code>.</p>
2792
- */
2793
- NumberOfFiles?: number;
2794
- /**
2795
- * <p>A user-supplied name or description of the <code>DataSource</code>.</p>
2796
- */
2797
- Name?: string;
2798
- /**
2799
- * <p>The current status of the <code>DataSource</code>. This element can have one of the following values:</p>
2800
- * <ul>
2801
- * <li>
2802
- * <p>
2803
- * <code>PENDING</code> - Amazon ML submitted a request to create a <code>DataSource</code>.</p>
2804
- * </li>
2805
- * <li>
2806
- * <p>
2807
- * <code>INPROGRESS</code> - The creation process is underway.</p>
2808
- * </li>
2809
- * <li>
2810
- * <p>
2811
- * <code>FAILED</code> - The request to create a <code>DataSource</code> did not run to completion. It is not usable.</p>
2812
- * </li>
2813
- * <li>
2814
- * <p>
2815
- * <code>COMPLETED</code> - The creation process completed successfully.</p>
2816
- * </li>
2817
- * <li>
2818
- * <p>
2819
- * <code>DELETED</code> - The <code>DataSource</code> is marked as deleted. It is not usable.</p>
2820
- * </li>
2821
- * </ul>
2822
- */
2823
- Status?: EntityStatus | string;
2824
- /**
2825
- * <p>A link to the file containing logs of <code>CreateDataSourceFrom*</code> operations.</p>
2826
- */
2827
- LogUri?: string;
2828
- /**
2829
- * <p>The user-supplied description of the most recent details about creating the <code>DataSource</code>.</p>
2830
- */
2831
- Message?: string;
2832
- /**
2833
- * <p>Describes the <code>DataSource</code> details specific to Amazon Redshift.</p>
2834
- */
2835
- RedshiftMetadata?: RedshiftMetadata;
2836
- /**
2837
- * <p>The datasource details that are specific to Amazon RDS.</p>
2838
- */
2839
- RDSMetadata?: RDSMetadata;
2840
- /**
2841
- * <p>The Amazon Resource Name (ARN) of an <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/roles-toplevel.html#roles-about-termsandconcepts">AWS IAM Role</a>, such as the following: arn:aws:iam::account:role/rolename. </p>
2842
- */
2843
- RoleARN?: string;
2844
- /**
2845
- * <p>
2846
- * The parameter is <code>true</code> if statistics need to be generated from the observation data.
2847
- * </p>
2848
- */
2849
- ComputeStatistics?: boolean;
2850
- /**
2851
- * <p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>DataSource</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>DataSource</code> is in the <code>COMPLETED</code> state and the <code>ComputeStatistics</code> is set to true.</p>
2852
- */
2853
- ComputeTime?: number;
2854
- /**
2855
- * <p>The epoch time when Amazon Machine Learning marked the <code>DataSource</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>DataSource</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>
2856
- */
2857
- FinishedAt?: Date;
2858
- /**
2859
- * <p>The epoch time when Amazon Machine Learning marked the <code>DataSource</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>DataSource</code> is in the <code>PENDING</code> state.</p>
2860
- */
2861
- StartedAt?: Date;
2862
- /**
2863
- * <p>The schema used by all of the data files of this <code>DataSource</code>.</p>
2864
- * <p>
2865
- * <b>Note:</b> This parameter is provided as part of the verbose format.</p>
2866
- */
2867
- DataSourceSchema?: string;
2868
- }
2869
- export declare namespace GetDataSourceOutput {
2870
- /**
2871
- * @internal
2872
- */
2873
- const filterSensitiveLog: (obj: GetDataSourceOutput) => any;
2874
- }
2875
- export interface GetEvaluationInput {
2876
- /**
2877
- * <p>The ID of the <code>Evaluation</code> to retrieve. The evaluation of each <code>MLModel</code> is recorded and cataloged. The ID provides the means to access the information. </p>
2878
- */
2879
- EvaluationId: string | undefined;
2880
- }
2881
- export declare namespace GetEvaluationInput {
2882
- /**
2883
- * @internal
2884
- */
2885
- const filterSensitiveLog: (obj: GetEvaluationInput) => any;
2886
- }
2887
- /**
2888
- * <p>Represents the output of a <code>GetEvaluation</code> operation and describes an <code>Evaluation</code>.</p>
2889
- */
2890
- export interface GetEvaluationOutput {
2891
- /**
2892
- * <p>The evaluation ID which is same as the <code>EvaluationId</code> in the request.</p>
2893
- */
2894
- EvaluationId?: string;
2895
- /**
2896
- * <p>The ID of the <code>MLModel</code> that was the focus of the evaluation.</p>
2897
- */
2898
- MLModelId?: string;
2899
- /**
2900
- * <p>The <code>DataSource</code> used for this evaluation.</p>
2901
- */
2902
- EvaluationDataSourceId?: string;
2903
- /**
2904
- * <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
2905
- */
2906
- InputDataLocationS3?: string;
2907
- /**
2908
- * <p>The AWS user account that invoked the evaluation. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
2909
- */
2910
- CreatedByIamUser?: string;
2911
- /**
2912
- * <p>The time that the <code>Evaluation</code> was created. The time is expressed in epoch time.</p>
2913
- */
2914
- CreatedAt?: Date;
2915
- /**
2916
- * <p>The time of the most recent edit to the <code>Evaluation</code>. The time is expressed in epoch time.</p>
2917
- */
2918
- LastUpdatedAt?: Date;
2919
- /**
2920
- * <p>A user-supplied name or description of the <code>Evaluation</code>. </p>
2921
- */
2922
- Name?: string;
2923
- /**
2924
- * <p>The status of the evaluation. This element can have one of the following values:</p>
2925
- * <ul>
2926
- * <li>
2927
- * <p>
2928
- * <code>PENDING</code> - Amazon Machine Language (Amazon ML) submitted a request to evaluate an <code>MLModel</code>.</p>
2929
- * </li>
2930
- * <li>
2931
- * <p>
2932
- * <code>INPROGRESS</code> - The evaluation is underway.</p>
2933
- * </li>
2934
- * <li>
2935
- * <p>
2936
- * <code>FAILED</code> - The request to evaluate an <code>MLModel</code> did not run to completion. It is not usable.</p>
2937
- * </li>
2938
- * <li>
2939
- * <p>
2940
- * <code>COMPLETED</code> - The evaluation process completed successfully.</p>
2941
- * </li>
2942
- * <li>
2943
- * <p>
2944
- * <code>DELETED</code> - The <code>Evaluation</code> is marked as deleted. It is not usable.</p>
2945
- * </li>
2946
- * </ul>
2947
- */
2948
- Status?: EntityStatus | string;
2949
- /**
2950
- * <p>Measurements of how well the <code>MLModel</code> performed using observations referenced by the <code>DataSource</code>. One of the following metric is returned based on the type of the <code>MLModel</code>:
2951
- * </p>
2952
- * <ul>
2953
- * <li>
2954
- * <p>BinaryAUC: A binary <code>MLModel</code> uses the Area Under the Curve (AUC) technique to measure performance. </p>
2955
- * </li>
2956
- * <li>
2957
- * <p>RegressionRMSE: A regression <code>MLModel</code> uses the Root Mean Square Error (RMSE) technique to measure performance. RMSE measures the difference between predicted and actual values for a single variable.</p>
2958
- * </li>
2959
- * <li>
2960
- * <p>MulticlassAvgFScore: A multiclass <code>MLModel</code> uses the F1 score technique to measure performance. </p>
2961
- * </li>
2962
- * </ul>
2963
- * <p>
2964
- * For more information about performance metrics, please see the <a href="https://docs.aws.amazon.com/machine-learning/latest/dg">Amazon Machine Learning Developer Guide</a>.
2965
- * </p>
2966
- */
2967
- PerformanceMetrics?: PerformanceMetrics;
2968
- /**
2969
- * <p>A link to the file that contains logs of the <code>CreateEvaluation</code> operation.</p>
2970
- */
2971
- LogUri?: string;
2972
- /**
2973
- * <p>A description of the most recent details about evaluating the <code>MLModel</code>.</p>
2974
- */
2975
- Message?: string;
2976
- /**
2977
- * <p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>Evaluation</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>Evaluation</code> is in the <code>COMPLETED</code> state.</p>
2978
- */
2979
- ComputeTime?: number;
2980
- /**
2981
- * <p>The epoch time when Amazon Machine Learning marked the <code>Evaluation</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>Evaluation</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>
2982
- */
2983
- FinishedAt?: Date;
2984
- /**
2985
- * <p>The epoch time when Amazon Machine Learning marked the <code>Evaluation</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>Evaluation</code> is in the <code>PENDING</code> state.</p>
2986
- */
2987
- StartedAt?: Date;
2988
- }
2989
- export declare namespace GetEvaluationOutput {
2990
- /**
2991
- * @internal
2992
- */
2993
- const filterSensitiveLog: (obj: GetEvaluationOutput) => any;
2994
- }
2995
- export interface GetMLModelInput {
2996
- /**
2997
- * <p>The ID assigned to the <code>MLModel</code> at creation.</p>
2998
- */
2999
- MLModelId: string | undefined;
3000
- /**
3001
- * <p>Specifies whether the <code>GetMLModel</code> operation should return <code>Recipe</code>.</p>
3002
- * <p>If true, <code>Recipe</code> is returned.</p>
3003
- * <p>If false, <code>Recipe</code> is not returned.</p>
3004
- */
3005
- Verbose?: boolean;
3006
- }
3007
- export declare namespace GetMLModelInput {
3008
- /**
3009
- * @internal
3010
- */
3011
- const filterSensitiveLog: (obj: GetMLModelInput) => any;
3012
- }
3013
- /**
3014
- * <p>Represents the output of a <code>GetMLModel</code> operation, and provides detailed information about a <code>MLModel</code>.</p>
3015
- */
3016
- export interface GetMLModelOutput {
3017
- /**
3018
- * <p>The MLModel ID,
3019
- * which is same as the <code>MLModelId</code> in the request.</p>
3020
- */
3021
- MLModelId?: string;
3022
- /**
3023
- * <p>The ID of the training <code>DataSource</code>.</p>
3024
- */
3025
- TrainingDataSourceId?: string;
3026
- /**
3027
- * <p>The AWS user account from which the <code>MLModel</code> was created. The account type can be either an AWS root account or an AWS Identity and Access Management (IAM) user account.</p>
3028
- */
3029
- CreatedByIamUser?: string;
3030
- /**
3031
- * <p>The time that the <code>MLModel</code> was created. The time is expressed in epoch time.</p>
3032
- */
3033
- CreatedAt?: Date;
3034
- /**
3035
- * <p>The time of the most recent edit to the <code>MLModel</code>. The time is expressed in epoch time.</p>
3036
- */
3037
- LastUpdatedAt?: Date;
3038
- /**
3039
- * <p>A user-supplied name or description of the <code>MLModel</code>.</p>
3040
- */
3041
- Name?: string;
3042
- /**
3043
- * <p>The current status of the <code>MLModel</code>. This element can have one of the following values:</p>
3044
- * <ul>
3045
- * <li>
3046
- * <p>
3047
- * <code>PENDING</code> - Amazon Machine Learning (Amazon ML) submitted a request to describe a <code>MLModel</code>.</p>
3048
- * </li>
3049
- * <li>
3050
- * <p>
3051
- * <code>INPROGRESS</code> - The request is processing.</p>
3052
- * </li>
3053
- * <li>
3054
- * <p>
3055
- * <code>FAILED</code> - The request did not run to completion. The ML model isn't
3056
- * usable.</p>
3057
- * </li>
3058
- * <li>
3059
- * <p>
3060
- * <code>COMPLETED</code> - The request completed successfully.</p>
3061
- * </li>
3062
- * <li>
3063
- * <p>
3064
- * <code>DELETED</code> - The <code>MLModel</code> is marked as deleted. It isn't
3065
- * usable.</p>
3066
- * </li>
3067
- * </ul>
3068
- */
3069
- Status?: EntityStatus | string;
3070
- /**
3071
- * <p>Long integer type that is a 64-bit signed number.</p>
3072
- */
3073
- SizeInBytes?: number;
3074
- /**
3075
- * <p>The current endpoint of the <code>MLModel</code>
3076
- * </p>
3077
- */
3078
- EndpointInfo?: RealtimeEndpointInfo;
3079
- /**
3080
- * <p>A list of the training parameters in the <code>MLModel</code>. The list is implemented as
3081
- * a map of key-value pairs.</p>
3082
- * <p>The following is the current set of training parameters:</p>
3083
- * <ul>
3084
- * <li>
3085
- * <p>
3086
- * <code>sgd.maxMLModelSizeInBytes</code> - The maximum allowed size of the model. Depending on the
3087
- * input data, the size of the model might affect its performance.</p>
3088
- * <p> The value is an integer that ranges from <code>100000</code> to <code>2147483648</code>. The default value is <code>33554432</code>.</p>
3089
- * </li>
3090
- * <li>
3091
- * <p>
3092
- * <code>sgd.maxPasses</code> - The number of times that the training process traverses the
3093
- * observations to build the <code>MLModel</code>. The value is an integer that
3094
- * ranges from <code>1</code> to <code>10000</code>. The default value is
3095
- * <code>10</code>.</p>
3096
- * </li>
3097
- * <li>
3098
- * <p>
3099
- * <code>sgd.shuffleType</code> - Whether Amazon ML shuffles the training data. Shuffling data improves a
3100
- * model's ability to find the optimal solution for a variety of data types. The
3101
- * valid values are <code>auto</code> and <code>none</code>. The default value is
3102
- * <code>none</code>. We strongly recommend that you shuffle your data.</p>
3103
- * </li>
3104
- * <li>
3105
- * <p>
3106
- * <code>sgd.l1RegularizationAmount</code> - The coefficient regularization L1 norm. It controls
3107
- * overfitting the data by penalizing large coefficients. This tends to drive
3108
- * coefficients to zero, resulting in a sparse feature set. If you use this
3109
- * parameter, start by specifying a small value, such as <code>1.0E-08</code>.</p>
3110
- * <p>The value is a double that ranges from <code>0</code> to <code>MAX_DOUBLE</code>.
3111
- * The default is to not use L1 normalization. This parameter can't be used when
3112
- * <code>L2</code> is specified. Use this parameter sparingly.</p>
3113
- * </li>
3114
- * <li>
3115
- * <p>
3116
- * <code>sgd.l2RegularizationAmount</code> - The coefficient regularization L2 norm. It controls
3117
- * overfitting the data by penalizing large coefficients. This tends to drive
3118
- * coefficients to small, nonzero values. If you use this parameter, start by
3119
- * specifying a small value, such as <code>1.0E-08</code>.</p>
3120
- * <p>The value is a double that ranges from <code>0</code> to <code>MAX_DOUBLE</code>.
3121
- * The default is to not use L2 normalization. This parameter can't be used when
3122
- * <code>L1</code> is specified. Use this parameter sparingly.</p>
3123
- * </li>
3124
- * </ul>
3125
- */
3126
- TrainingParameters?: {
3127
- [key: string]: string;
3128
- };
3129
- /**
3130
- * <p>The location of the data file or directory in Amazon Simple Storage Service (Amazon S3).</p>
3131
- */
3132
- InputDataLocationS3?: string;
3133
- /**
3134
- * <p>Identifies the <code>MLModel</code> category. The following are the available types: </p>
3135
- * <ul>
3136
- * <li>
3137
- * <p>REGRESSION -- Produces a numeric result. For example, "What price should a house be listed at?"</p>
3138
- * </li>
3139
- * <li>
3140
- * <p>BINARY -- Produces one of two possible results. For example, "Is this an e-commerce website?"</p>
3141
- * </li>
3142
- * <li>
3143
- * <p>MULTICLASS -- Produces one of several possible results. For example, "Is this a HIGH, LOW or MEDIUM risk trade?"</p>
3144
- * </li>
3145
- * </ul>
3146
- */
3147
- MLModelType?: MLModelType | string;
3148
- /**
3149
- * <p>The scoring threshold is used in binary classification <code>MLModel</code>
3150
- * models. It marks the boundary between a positive prediction and a
3151
- * negative prediction.</p>
3152
- * <p>Output values greater than or equal to the threshold receive a positive result from the MLModel, such as
3153
- * <code>true</code>. Output values less than the threshold receive a negative response from the MLModel,
3154
- * such as <code>false</code>.</p>
3155
- */
3156
- ScoreThreshold?: number;
3157
- /**
3158
- * <p>The time of the most recent edit to the <code>ScoreThreshold</code>. The time is expressed in epoch time.</p>
3159
- */
3160
- ScoreThresholdLastUpdatedAt?: Date;
3161
- /**
3162
- * <p>A link to the file that contains logs of the <code>CreateMLModel</code> operation.</p>
3163
- */
3164
- LogUri?: string;
3165
- /**
3166
- * <p>A description of the most recent details about accessing the <code>MLModel</code>.</p>
3167
- */
3168
- Message?: string;
3169
- /**
3170
- * <p>The approximate CPU time in milliseconds that Amazon Machine Learning spent processing the <code>MLModel</code>, normalized and scaled on computation resources. <code>ComputeTime</code> is only available if the <code>MLModel</code> is in the <code>COMPLETED</code> state.</p>
3171
- */
3172
- ComputeTime?: number;
3173
- /**
3174
- * <p>The epoch time when Amazon Machine Learning marked the <code>MLModel</code> as <code>COMPLETED</code> or <code>FAILED</code>. <code>FinishedAt</code> is only available when the <code>MLModel</code> is in the <code>COMPLETED</code> or <code>FAILED</code> state.</p>
3175
- */
3176
- FinishedAt?: Date;
3177
- /**
3178
- * <p>The epoch time when Amazon Machine Learning marked the <code>MLModel</code> as <code>INPROGRESS</code>. <code>StartedAt</code> isn't available if the <code>MLModel</code> is in the <code>PENDING</code> state.</p>
3179
- */
3180
- StartedAt?: Date;
3181
- /**
3182
- * <p>The recipe to use when training the <code>MLModel</code>. The <code>Recipe</code>
3183
- * provides detailed information about the observation data to use during training, and
3184
- * manipulations to perform on the observation data during training.</p>
3185
- * <p>
3186
- * <b>Note:</b> This parameter is provided as part of the verbose format.</p>
3187
- */
3188
- Recipe?: string;
3189
- /**
3190
- * <p>The schema used by all of the data files referenced by the <code>DataSource</code>.</p>
3191
- * <p>
3192
- * <b>Note:</b> This parameter is provided as part of the verbose format.</p>
3193
- */
3194
- Schema?: string;
3195
- }
3196
- export declare namespace GetMLModelOutput {
3197
- /**
3198
- * @internal
3199
- */
3200
- const filterSensitiveLog: (obj: GetMLModelOutput) => any;
3201
- }
3202
- /**
3203
- * <p>The subscriber exceeded the maximum number of operations. This exception can occur when listing objects such as <code>DataSource</code>.</p>
3204
- */
3205
- export interface LimitExceededException extends __SmithyException, $MetadataBearer {
3206
- name: "LimitExceededException";
3207
- $fault: "client";
3208
- message?: string;
3209
- code?: number;
3210
- }
3211
- export declare namespace LimitExceededException {
3212
- /**
3213
- * @internal
3214
- */
3215
- const filterSensitiveLog: (obj: LimitExceededException) => any;
3216
- }
3217
- export interface PredictInput {
3218
- /**
3219
- * <p>A unique identifier of the <code>MLModel</code>.</p>
3220
- */
3221
- MLModelId: string | undefined;
3222
- /**
3223
- * <p>A map of variable name-value pairs that represent an observation.</p>
3224
- */
3225
- Record: {
3226
- [key: string]: string;
3227
- } | undefined;
3228
- PredictEndpoint: string | undefined;
3229
- }
3230
- export declare namespace PredictInput {
3231
- /**
3232
- * @internal
3233
- */
3234
- const filterSensitiveLog: (obj: PredictInput) => any;
3235
- }
3236
- /**
3237
- * <p>The exception is thrown when a predict request is made to an unmounted <code>MLModel</code>.</p>
3238
- */
3239
- export interface PredictorNotMountedException extends __SmithyException, $MetadataBearer {
3240
- name: "PredictorNotMountedException";
3241
- $fault: "client";
3242
- message?: string;
3243
- }
3244
- export declare namespace PredictorNotMountedException {
3245
- /**
3246
- * @internal
3247
- */
3248
- const filterSensitiveLog: (obj: PredictorNotMountedException) => any;
3249
- }
3250
- export declare enum DetailsAttributes {
3251
- ALGORITHM = "Algorithm",
3252
- PREDICTIVE_MODEL_TYPE = "PredictiveModelType"
3253
- }
3254
- /**
3255
- * <p>The output from a <code>Predict</code> operation: </p>
3256
- *
3257
- * <ul>
3258
- * <li>
3259
- * <p>
3260
- * <code>Details</code> - Contains the following attributes:
3261
- * <code>DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | MULTICLASS</code>
3262
- * <code>DetailsAttributes.ALGORITHM - SGD</code>
3263
- * </p>
3264
- * </li>
3265
- * <li>
3266
- * <p>
3267
- * <code>PredictedLabel</code> - Present for either a <code>BINARY</code> or <code>MULTICLASS</code>
3268
- * <code>MLModel</code> request.
3269
- * </p>
3270
- * </li>
3271
- * <li>
3272
- * <p>
3273
- * <code>PredictedScores</code> - Contains the raw classification score corresponding to each label.
3274
- * </p>
3275
- * </li>
3276
- * <li>
3277
- * <p>
3278
- * <code>PredictedValue</code> - Present for a <code>REGRESSION</code>
3279
- * <code>MLModel</code> request.
3280
- * </p>
3281
- * </li>
3282
- * </ul>
3283
- */
3284
- export interface Prediction {
3285
- /**
3286
- * <p>The prediction label for either a <code>BINARY</code> or <code>MULTICLASS</code>
3287
- * <code>MLModel</code>.</p>
3288
- */
3289
- predictedLabel?: string;
3290
- /**
3291
- * <p>The prediction value for <code>REGRESSION</code>
3292
- * <code>MLModel</code>.</p>
3293
- */
3294
- predictedValue?: number;
3295
- /**
3296
- * <p>Provides the raw classification score corresponding to each label.</p>
3297
- */
3298
- predictedScores?: {
3299
- [key: string]: number;
3300
- };
3301
- /**
3302
- * <p>Provides any additional details regarding the prediction.</p>
3303
- */
3304
- details?: {
3305
- [key: string]: string;
3306
- };
3307
- }
3308
- export declare namespace Prediction {
3309
- /**
3310
- * @internal
3311
- */
3312
- const filterSensitiveLog: (obj: Prediction) => any;
3313
- }
3314
- export interface PredictOutput {
3315
- /**
3316
- * <p>The output from a <code>Predict</code> operation: </p>
3317
- *
3318
- * <ul>
3319
- * <li>
3320
- * <p>
3321
- * <code>Details</code> - Contains the following attributes:
3322
- * <code>DetailsAttributes.PREDICTIVE_MODEL_TYPE - REGRESSION | BINARY | MULTICLASS</code>
3323
- * <code>DetailsAttributes.ALGORITHM - SGD</code>
3324
- * </p>
3325
- * </li>
3326
- * <li>
3327
- * <p>
3328
- * <code>PredictedLabel</code> - Present for either a <code>BINARY</code> or <code>MULTICLASS</code>
3329
- * <code>MLModel</code> request.
3330
- * </p>
3331
- * </li>
3332
- * <li>
3333
- * <p>
3334
- * <code>PredictedScores</code> - Contains the raw classification score corresponding to each label.
3335
- * </p>
3336
- * </li>
3337
- * <li>
3338
- * <p>
3339
- * <code>PredictedValue</code> - Present for a <code>REGRESSION</code>
3340
- * <code>MLModel</code> request.
3341
- * </p>
3342
- * </li>
3343
- * </ul>
3344
- */
3345
- Prediction?: Prediction;
3346
- }
3347
- export declare namespace PredictOutput {
3348
- /**
3349
- * @internal
3350
- */
3351
- const filterSensitiveLog: (obj: PredictOutput) => any;
3352
- }
3353
- export interface UpdateBatchPredictionInput {
3354
- /**
3355
- * <p>The ID assigned to the <code>BatchPrediction</code> during creation.</p>
3356
- */
3357
- BatchPredictionId: string | undefined;
3358
- /**
3359
- * <p>A new user-supplied name or description of the <code>BatchPrediction</code>.</p>
3360
- */
3361
- BatchPredictionName: string | undefined;
3362
- }
3363
- export declare namespace UpdateBatchPredictionInput {
3364
- /**
3365
- * @internal
3366
- */
3367
- const filterSensitiveLog: (obj: UpdateBatchPredictionInput) => any;
3368
- }
3369
- /**
3370
- * <p>Represents the output of an <code>UpdateBatchPrediction</code> operation.</p>
3371
- * <p>You can see the updated content by using the <code>GetBatchPrediction</code> operation.</p>
3372
- */
3373
- export interface UpdateBatchPredictionOutput {
3374
- /**
3375
- * <p>The ID assigned to the <code>BatchPrediction</code> during creation. This value should be identical to the value
3376
- * of the <code>BatchPredictionId</code> in the request.</p>
3377
- */
3378
- BatchPredictionId?: string;
3379
- }
3380
- export declare namespace UpdateBatchPredictionOutput {
3381
- /**
3382
- * @internal
3383
- */
3384
- const filterSensitiveLog: (obj: UpdateBatchPredictionOutput) => any;
3385
- }
3386
- export interface UpdateDataSourceInput {
3387
- /**
3388
- * <p>The ID assigned to the <code>DataSource</code> during creation.</p>
3389
- */
3390
- DataSourceId: string | undefined;
3391
- /**
3392
- * <p>A new user-supplied name or description of the <code>DataSource</code> that will replace the current description. </p>
3393
- */
3394
- DataSourceName: string | undefined;
3395
- }
3396
- export declare namespace UpdateDataSourceInput {
3397
- /**
3398
- * @internal
3399
- */
3400
- const filterSensitiveLog: (obj: UpdateDataSourceInput) => any;
3401
- }
3402
- /**
3403
- * <p>Represents the output of an <code>UpdateDataSource</code> operation.</p>
3404
- * <p>You can see the updated content by using the <code>GetBatchPrediction</code> operation.</p>
3405
- */
3406
- export interface UpdateDataSourceOutput {
3407
- /**
3408
- * <p>The ID assigned to the <code>DataSource</code> during creation. This value should be identical to the value
3409
- * of the <code>DataSourceID</code> in the request.</p>
3410
- */
3411
- DataSourceId?: string;
3412
- }
3413
- export declare namespace UpdateDataSourceOutput {
3414
- /**
3415
- * @internal
3416
- */
3417
- const filterSensitiveLog: (obj: UpdateDataSourceOutput) => any;
3418
- }
3419
- export interface UpdateEvaluationInput {
3420
- /**
3421
- * <p>The ID assigned to the <code>Evaluation</code> during creation.</p>
3422
- */
3423
- EvaluationId: string | undefined;
3424
- /**
3425
- * <p>A new user-supplied name or description of the <code>Evaluation</code> that will replace the current content. </p>
3426
- */
3427
- EvaluationName: string | undefined;
3428
- }
3429
- export declare namespace UpdateEvaluationInput {
3430
- /**
3431
- * @internal
3432
- */
3433
- const filterSensitiveLog: (obj: UpdateEvaluationInput) => any;
3434
- }
3435
- /**
3436
- * <p>Represents the output of an <code>UpdateEvaluation</code> operation.</p>
3437
- * <p>You can see the updated content by using the <code>GetEvaluation</code> operation.</p>
3438
- */
3439
- export interface UpdateEvaluationOutput {
3440
- /**
3441
- * <p>The ID assigned to the <code>Evaluation</code> during creation. This value should be identical to the value
3442
- * of the <code>Evaluation</code> in the request.</p>
3443
- */
3444
- EvaluationId?: string;
3445
- }
3446
- export declare namespace UpdateEvaluationOutput {
3447
- /**
3448
- * @internal
3449
- */
3450
- const filterSensitiveLog: (obj: UpdateEvaluationOutput) => any;
3451
- }
3452
- export interface UpdateMLModelInput {
3453
- /**
3454
- * <p>The ID assigned to the <code>MLModel</code> during creation.</p>
3455
- */
3456
- MLModelId: string | undefined;
3457
- /**
3458
- * <p>A user-supplied name or description of the <code>MLModel</code>.</p>
3459
- */
3460
- MLModelName?: string;
3461
- /**
3462
- * <p>The <code>ScoreThreshold</code> used in binary classification <code>MLModel</code> that marks the boundary between a positive prediction and a negative prediction.</p>
3463
- * <p>Output values greater than or equal to the <code>ScoreThreshold</code> receive a positive result from the <code>MLModel</code>, such as <code>true</code>. Output values less than the <code>ScoreThreshold</code> receive a negative response from the <code>MLModel</code>, such as <code>false</code>.</p>
3464
- */
3465
- ScoreThreshold?: number;
3466
- }
3467
- export declare namespace UpdateMLModelInput {
3468
- /**
3469
- * @internal
3470
- */
3471
- const filterSensitiveLog: (obj: UpdateMLModelInput) => any;
3472
- }
3473
- /**
3474
- * <p>Represents the output of an <code>UpdateMLModel</code> operation.</p>
3475
- * <p>You can see the updated content by using the <code>GetMLModel</code> operation.</p>
3476
- */
3477
- export interface UpdateMLModelOutput {
3478
- /**
3479
- * <p>The ID assigned to the <code>MLModel</code> during creation. This value should be identical to the value
3480
- * of the <code>MLModelID</code> in the request.</p>
3481
- */
3482
- MLModelId?: string;
3483
- }
3484
- export declare namespace UpdateMLModelOutput {
3485
- /**
3486
- * @internal
3487
- */
3488
- const filterSensitiveLog: (obj: UpdateMLModelOutput) => any;
3489
- }