@aws-sdk/client-cloudsearch 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 (296) hide show
  1. package/CHANGELOG.md +47 -0
  2. package/{dist/cjs → dist-cjs}/CloudSearch.js +0 -10
  3. package/dist-cjs/CloudSearchClient.js +35 -0
  4. package/{dist/cjs → dist-cjs}/commands/BuildSuggestersCommand.js +2 -27
  5. package/{dist/cjs → dist-cjs}/commands/CreateDomainCommand.js +2 -28
  6. package/{dist/cjs → dist-cjs}/commands/DefineAnalysisSchemeCommand.js +2 -27
  7. package/{dist/cjs → dist-cjs}/commands/DefineExpressionCommand.js +2 -27
  8. package/dist-cjs/commands/DefineIndexFieldCommand.js +36 -0
  9. package/{dist/cjs → dist-cjs}/commands/DefineSuggesterCommand.js +2 -27
  10. package/{dist/cjs → dist-cjs}/commands/DeleteAnalysisSchemeCommand.js +2 -27
  11. package/{dist/cjs → dist-cjs}/commands/DeleteDomainCommand.js +2 -28
  12. package/{dist/cjs → dist-cjs}/commands/DeleteExpressionCommand.js +2 -27
  13. package/{dist/cjs → dist-cjs}/commands/DeleteIndexFieldCommand.js +2 -27
  14. package/{dist/cjs → dist-cjs}/commands/DeleteSuggesterCommand.js +2 -27
  15. package/{dist/cjs → dist-cjs}/commands/DescribeAnalysisSchemesCommand.js +2 -27
  16. package/{dist/cjs → dist-cjs}/commands/DescribeAvailabilityOptionsCommand.js +2 -27
  17. package/{dist/cjs → dist-cjs}/commands/DescribeDomainEndpointOptionsCommand.js +2 -27
  18. package/{dist/cjs → dist-cjs}/commands/DescribeDomainsCommand.js +2 -29
  19. package/{dist/cjs → dist-cjs}/commands/DescribeExpressionsCommand.js +2 -27
  20. package/{dist/cjs → dist-cjs}/commands/DescribeIndexFieldsCommand.js +2 -29
  21. package/{dist/cjs → dist-cjs}/commands/DescribeScalingParametersCommand.js +2 -27
  22. package/{dist/cjs → dist-cjs}/commands/DescribeServiceAccessPoliciesCommand.js +2 -28
  23. package/{dist/cjs → dist-cjs}/commands/DescribeSuggestersCommand.js +2 -27
  24. package/{dist/cjs → dist-cjs}/commands/IndexDocumentsCommand.js +2 -27
  25. package/{dist/cjs → dist-cjs}/commands/ListDomainNamesCommand.js +2 -27
  26. package/{dist/cjs → dist-cjs}/commands/UpdateAvailabilityOptionsCommand.js +2 -27
  27. package/{dist/cjs → dist-cjs}/commands/UpdateDomainEndpointOptionsCommand.js +2 -27
  28. package/{dist/cjs → dist-cjs}/commands/UpdateScalingParametersCommand.js +2 -27
  29. package/{dist/cjs → dist-cjs}/commands/UpdateServiceAccessPoliciesCommand.js +2 -29
  30. package/{dist/cjs → dist-cjs}/endpoints.js +1 -2
  31. package/{dist/cjs → dist-cjs}/index.js +0 -1
  32. package/{dist/cjs → dist-cjs}/models/index.js +0 -1
  33. package/{dist/cjs → dist-cjs}/models/models_0.js +7 -278
  34. package/{dist/cjs → dist-cjs}/protocols/Aws_query.js +164 -71
  35. package/{dist/cjs → dist-cjs}/runtimeConfig.browser.js +1 -5
  36. package/{dist/cjs → dist-cjs}/runtimeConfig.js +1 -5
  37. package/{dist/cjs → dist-cjs}/runtimeConfig.native.js +0 -4
  38. package/{dist/cjs → dist-cjs}/runtimeConfig.shared.js +1 -5
  39. package/{dist/es → dist-es}/CloudSearch.js +0 -1
  40. package/{dist/es → dist-es}/CloudSearchClient.js +1 -2
  41. package/{dist/es → dist-es}/commands/BuildSuggestersCommand.js +2 -3
  42. package/{dist/es → dist-es}/commands/CreateDomainCommand.js +2 -3
  43. package/{dist/es → dist-es}/commands/DefineAnalysisSchemeCommand.js +2 -3
  44. package/{dist/es → dist-es}/commands/DefineExpressionCommand.js +2 -3
  45. package/{dist/es → dist-es}/commands/DefineIndexFieldCommand.js +2 -3
  46. package/{dist/es → dist-es}/commands/DefineSuggesterCommand.js +2 -3
  47. package/{dist/es → dist-es}/commands/DeleteAnalysisSchemeCommand.js +2 -3
  48. package/{dist/es → dist-es}/commands/DeleteDomainCommand.js +2 -3
  49. package/{dist/es → dist-es}/commands/DeleteExpressionCommand.js +2 -3
  50. package/{dist/es → dist-es}/commands/DeleteIndexFieldCommand.js +2 -3
  51. package/{dist/es → dist-es}/commands/DeleteSuggesterCommand.js +2 -3
  52. package/{dist/es → dist-es}/commands/DescribeAnalysisSchemesCommand.js +2 -3
  53. package/{dist/es → dist-es}/commands/DescribeAvailabilityOptionsCommand.js +2 -3
  54. package/{dist/es → dist-es}/commands/DescribeDomainEndpointOptionsCommand.js +2 -3
  55. package/{dist/es → dist-es}/commands/DescribeDomainsCommand.js +2 -3
  56. package/{dist/es → dist-es}/commands/DescribeExpressionsCommand.js +2 -3
  57. package/{dist/es → dist-es}/commands/DescribeIndexFieldsCommand.js +2 -3
  58. package/{dist/es → dist-es}/commands/DescribeScalingParametersCommand.js +2 -3
  59. package/{dist/es → dist-es}/commands/DescribeServiceAccessPoliciesCommand.js +2 -3
  60. package/{dist/es → dist-es}/commands/DescribeSuggestersCommand.js +2 -3
  61. package/{dist/es → dist-es}/commands/IndexDocumentsCommand.js +2 -3
  62. package/{dist/es → dist-es}/commands/ListDomainNamesCommand.js +2 -3
  63. package/{dist/es → dist-es}/commands/UpdateAvailabilityOptionsCommand.js +2 -3
  64. package/{dist/es → dist-es}/commands/UpdateDomainEndpointOptionsCommand.js +2 -3
  65. package/{dist/es → dist-es}/commands/UpdateScalingParametersCommand.js +2 -3
  66. package/{dist/es → dist-es}/commands/UpdateServiceAccessPoliciesCommand.js +2 -3
  67. package/{dist/es → dist-es}/endpoints.js +1 -2
  68. package/{dist/types/index.d.ts → dist-es/index.js} +0 -0
  69. package/{dist/types/models/index.d.ts → dist-es/models/index.js} +0 -0
  70. package/{dist/es → dist-es}/models/models_0.js +4 -5
  71. package/{dist/es → dist-es}/protocols/Aws_query.js +308 -213
  72. package/{dist/es → dist-es}/runtimeConfig.browser.js +1 -2
  73. package/{dist/es → dist-es}/runtimeConfig.js +1 -2
  74. package/{dist/es → dist-es}/runtimeConfig.native.js +0 -1
  75. package/{dist/es → dist-es}/runtimeConfig.shared.js +1 -2
  76. package/{dist/types → dist-types}/CloudSearch.d.ts +1 -1
  77. package/{dist/types → dist-types}/CloudSearchClient.d.ts +8 -8
  78. package/{dist/types → dist-types}/commands/BuildSuggestersCommand.d.ts +2 -2
  79. package/{dist/types → dist-types}/commands/CreateDomainCommand.d.ts +2 -2
  80. package/{dist/types → dist-types}/commands/DefineAnalysisSchemeCommand.d.ts +2 -2
  81. package/{dist/types → dist-types}/commands/DefineExpressionCommand.d.ts +2 -2
  82. package/{dist/types → dist-types}/commands/DefineIndexFieldCommand.d.ts +2 -2
  83. package/{dist/types → dist-types}/commands/DefineSuggesterCommand.d.ts +2 -2
  84. package/{dist/types → dist-types}/commands/DeleteAnalysisSchemeCommand.d.ts +2 -2
  85. package/{dist/types → dist-types}/commands/DeleteDomainCommand.d.ts +2 -2
  86. package/{dist/types → dist-types}/commands/DeleteExpressionCommand.d.ts +2 -2
  87. package/{dist/types → dist-types}/commands/DeleteIndexFieldCommand.d.ts +2 -2
  88. package/{dist/types → dist-types}/commands/DeleteSuggesterCommand.d.ts +2 -2
  89. package/{dist/types → dist-types}/commands/DescribeAnalysisSchemesCommand.d.ts +2 -2
  90. package/{dist/types → dist-types}/commands/DescribeAvailabilityOptionsCommand.d.ts +2 -2
  91. package/{dist/types → dist-types}/commands/DescribeDomainEndpointOptionsCommand.d.ts +2 -2
  92. package/{dist/types → dist-types}/commands/DescribeDomainsCommand.d.ts +2 -2
  93. package/{dist/types → dist-types}/commands/DescribeExpressionsCommand.d.ts +2 -2
  94. package/{dist/types → dist-types}/commands/DescribeIndexFieldsCommand.d.ts +2 -2
  95. package/{dist/types → dist-types}/commands/DescribeScalingParametersCommand.d.ts +2 -2
  96. package/{dist/types → dist-types}/commands/DescribeServiceAccessPoliciesCommand.d.ts +2 -2
  97. package/{dist/types → dist-types}/commands/DescribeSuggestersCommand.d.ts +2 -2
  98. package/{dist/types → dist-types}/commands/IndexDocumentsCommand.d.ts +2 -2
  99. package/{dist/types → dist-types}/commands/ListDomainNamesCommand.d.ts +2 -2
  100. package/{dist/types → dist-types}/commands/UpdateAvailabilityOptionsCommand.d.ts +2 -2
  101. package/{dist/types → dist-types}/commands/UpdateDomainEndpointOptionsCommand.d.ts +2 -2
  102. package/{dist/types → dist-types}/commands/UpdateScalingParametersCommand.d.ts +2 -2
  103. package/{dist/types → dist-types}/commands/UpdateServiceAccessPoliciesCommand.d.ts +2 -2
  104. package/{dist/types → dist-types}/endpoints.d.ts +0 -0
  105. package/{index.ts → dist-types/index.d.ts} +0 -0
  106. package/{models/index.ts → dist-types/models/index.d.ts} +0 -0
  107. package/{dist/types → dist-types}/models/models_0.d.ts +21 -21
  108. package/{dist/types → dist-types}/protocols/Aws_query.d.ts +2 -2
  109. package/{dist/types → dist-types}/runtimeConfig.browser.d.ts +0 -0
  110. package/{dist/types → dist-types}/runtimeConfig.d.ts +1 -1
  111. package/{dist/types → dist-types}/runtimeConfig.native.d.ts +0 -0
  112. package/{dist/types → dist-types}/runtimeConfig.shared.d.ts +0 -0
  113. package/{dist/types → dist-types}/ts3.4/CloudSearch.d.ts +28 -97
  114. package/{dist/types → dist-types}/ts3.4/CloudSearchClient.d.ts +32 -103
  115. package/dist-types/ts3.4/commands/BuildSuggestersCommand.d.ts +17 -0
  116. package/dist-types/ts3.4/commands/CreateDomainCommand.d.ts +17 -0
  117. package/dist-types/ts3.4/commands/DefineAnalysisSchemeCommand.d.ts +17 -0
  118. package/dist-types/ts3.4/commands/DefineExpressionCommand.d.ts +17 -0
  119. package/dist-types/ts3.4/commands/DefineIndexFieldCommand.d.ts +17 -0
  120. package/dist-types/ts3.4/commands/DefineSuggesterCommand.d.ts +17 -0
  121. package/dist-types/ts3.4/commands/DeleteAnalysisSchemeCommand.d.ts +17 -0
  122. package/dist-types/ts3.4/commands/DeleteDomainCommand.d.ts +17 -0
  123. package/dist-types/ts3.4/commands/DeleteExpressionCommand.d.ts +17 -0
  124. package/dist-types/ts3.4/commands/DeleteIndexFieldCommand.d.ts +17 -0
  125. package/dist-types/ts3.4/commands/DeleteSuggesterCommand.d.ts +17 -0
  126. package/dist-types/ts3.4/commands/DescribeAnalysisSchemesCommand.d.ts +17 -0
  127. package/dist-types/ts3.4/commands/DescribeAvailabilityOptionsCommand.d.ts +17 -0
  128. package/dist-types/ts3.4/commands/DescribeDomainEndpointOptionsCommand.d.ts +17 -0
  129. package/dist-types/ts3.4/commands/DescribeDomainsCommand.d.ts +17 -0
  130. package/dist-types/ts3.4/commands/DescribeExpressionsCommand.d.ts +17 -0
  131. package/dist-types/ts3.4/commands/DescribeIndexFieldsCommand.d.ts +17 -0
  132. package/dist-types/ts3.4/commands/DescribeScalingParametersCommand.d.ts +17 -0
  133. package/dist-types/ts3.4/commands/DescribeServiceAccessPoliciesCommand.d.ts +17 -0
  134. package/dist-types/ts3.4/commands/DescribeSuggestersCommand.d.ts +17 -0
  135. package/dist-types/ts3.4/commands/IndexDocumentsCommand.d.ts +17 -0
  136. package/dist-types/ts3.4/commands/ListDomainNamesCommand.d.ts +17 -0
  137. package/dist-types/ts3.4/commands/UpdateAvailabilityOptionsCommand.d.ts +17 -0
  138. package/dist-types/ts3.4/commands/UpdateDomainEndpointOptionsCommand.d.ts +17 -0
  139. package/dist-types/ts3.4/commands/UpdateScalingParametersCommand.d.ts +17 -0
  140. package/dist-types/ts3.4/commands/UpdateServiceAccessPoliciesCommand.d.ts +17 -0
  141. package/{dist/types → dist-types}/ts3.4/endpoints.d.ts +0 -0
  142. package/{dist/types → dist-types}/ts3.4/index.d.ts +0 -0
  143. package/{dist/types → dist-types}/ts3.4/models/index.d.ts +0 -0
  144. package/dist-types/ts3.4/models/models_0.d.ts +1097 -0
  145. package/{dist/types → dist-types}/ts3.4/protocols/Aws_query.d.ts +2 -2
  146. package/{dist/types → dist-types}/ts3.4/runtimeConfig.browser.d.ts +1 -3
  147. package/{dist/types → dist-types}/ts3.4/runtimeConfig.d.ts +2 -4
  148. package/{dist/types → dist-types}/ts3.4/runtimeConfig.native.d.ts +1 -3
  149. package/{dist/types → dist-types}/ts3.4/runtimeConfig.shared.d.ts +1 -3
  150. package/package.json +45 -42
  151. package/CloudSearch.ts +0 -978
  152. package/CloudSearchClient.ts +0 -358
  153. package/commands/BuildSuggestersCommand.ts +0 -94
  154. package/commands/CreateDomainCommand.ts +0 -92
  155. package/commands/DefineAnalysisSchemeCommand.ts +0 -94
  156. package/commands/DefineExpressionCommand.ts +0 -94
  157. package/commands/DefineIndexFieldCommand.ts +0 -94
  158. package/commands/DefineSuggesterCommand.ts +0 -94
  159. package/commands/DeleteAnalysisSchemeCommand.ts +0 -94
  160. package/commands/DeleteDomainCommand.ts +0 -92
  161. package/commands/DeleteExpressionCommand.ts +0 -94
  162. package/commands/DeleteIndexFieldCommand.ts +0 -94
  163. package/commands/DeleteSuggesterCommand.ts +0 -94
  164. package/commands/DescribeAnalysisSchemesCommand.ts +0 -94
  165. package/commands/DescribeAvailabilityOptionsCommand.ts +0 -99
  166. package/commands/DescribeDomainEndpointOptionsCommand.ts +0 -99
  167. package/commands/DescribeDomainsCommand.ts +0 -96
  168. package/commands/DescribeExpressionsCommand.ts +0 -94
  169. package/commands/DescribeIndexFieldsCommand.ts +0 -96
  170. package/commands/DescribeScalingParametersCommand.ts +0 -97
  171. package/commands/DescribeServiceAccessPoliciesCommand.ts +0 -100
  172. package/commands/DescribeSuggestersCommand.ts +0 -94
  173. package/commands/IndexDocumentsCommand.ts +0 -94
  174. package/commands/ListDomainNamesCommand.ts +0 -94
  175. package/commands/UpdateAvailabilityOptionsCommand.ts +0 -97
  176. package/commands/UpdateDomainEndpointOptionsCommand.ts +0 -99
  177. package/commands/UpdateScalingParametersCommand.ts +0 -94
  178. package/commands/UpdateServiceAccessPoliciesCommand.ts +0 -101
  179. package/dist/cjs/CloudSearch.js.map +0 -1
  180. package/dist/cjs/CloudSearchClient.js +0 -50
  181. package/dist/cjs/CloudSearchClient.js.map +0 -1
  182. package/dist/cjs/commands/BuildSuggestersCommand.js.map +0 -1
  183. package/dist/cjs/commands/CreateDomainCommand.js.map +0 -1
  184. package/dist/cjs/commands/DefineAnalysisSchemeCommand.js.map +0 -1
  185. package/dist/cjs/commands/DefineExpressionCommand.js.map +0 -1
  186. package/dist/cjs/commands/DefineIndexFieldCommand.js +0 -61
  187. package/dist/cjs/commands/DefineIndexFieldCommand.js.map +0 -1
  188. package/dist/cjs/commands/DefineSuggesterCommand.js.map +0 -1
  189. package/dist/cjs/commands/DeleteAnalysisSchemeCommand.js.map +0 -1
  190. package/dist/cjs/commands/DeleteDomainCommand.js.map +0 -1
  191. package/dist/cjs/commands/DeleteExpressionCommand.js.map +0 -1
  192. package/dist/cjs/commands/DeleteIndexFieldCommand.js.map +0 -1
  193. package/dist/cjs/commands/DeleteSuggesterCommand.js.map +0 -1
  194. package/dist/cjs/commands/DescribeAnalysisSchemesCommand.js.map +0 -1
  195. package/dist/cjs/commands/DescribeAvailabilityOptionsCommand.js.map +0 -1
  196. package/dist/cjs/commands/DescribeDomainEndpointOptionsCommand.js.map +0 -1
  197. package/dist/cjs/commands/DescribeDomainsCommand.js.map +0 -1
  198. package/dist/cjs/commands/DescribeExpressionsCommand.js.map +0 -1
  199. package/dist/cjs/commands/DescribeIndexFieldsCommand.js.map +0 -1
  200. package/dist/cjs/commands/DescribeScalingParametersCommand.js.map +0 -1
  201. package/dist/cjs/commands/DescribeServiceAccessPoliciesCommand.js.map +0 -1
  202. package/dist/cjs/commands/DescribeSuggestersCommand.js.map +0 -1
  203. package/dist/cjs/commands/IndexDocumentsCommand.js.map +0 -1
  204. package/dist/cjs/commands/ListDomainNamesCommand.js.map +0 -1
  205. package/dist/cjs/commands/UpdateAvailabilityOptionsCommand.js.map +0 -1
  206. package/dist/cjs/commands/UpdateDomainEndpointOptionsCommand.js.map +0 -1
  207. package/dist/cjs/commands/UpdateScalingParametersCommand.js.map +0 -1
  208. package/dist/cjs/commands/UpdateServiceAccessPoliciesCommand.js.map +0 -1
  209. package/dist/cjs/endpoints.js.map +0 -1
  210. package/dist/cjs/index.js.map +0 -1
  211. package/dist/cjs/models/index.js.map +0 -1
  212. package/dist/cjs/models/models_0.js.map +0 -1
  213. package/dist/cjs/package.json +0 -93
  214. package/dist/cjs/protocols/Aws_query.js.map +0 -1
  215. package/dist/cjs/runtimeConfig.browser.js.map +0 -1
  216. package/dist/cjs/runtimeConfig.js.map +0 -1
  217. package/dist/cjs/runtimeConfig.native.js.map +0 -1
  218. package/dist/cjs/runtimeConfig.shared.js.map +0 -1
  219. package/dist/es/CloudSearch.js.map +0 -1
  220. package/dist/es/CloudSearchClient.js.map +0 -1
  221. package/dist/es/commands/BuildSuggestersCommand.js.map +0 -1
  222. package/dist/es/commands/CreateDomainCommand.js.map +0 -1
  223. package/dist/es/commands/DefineAnalysisSchemeCommand.js.map +0 -1
  224. package/dist/es/commands/DefineExpressionCommand.js.map +0 -1
  225. package/dist/es/commands/DefineIndexFieldCommand.js.map +0 -1
  226. package/dist/es/commands/DefineSuggesterCommand.js.map +0 -1
  227. package/dist/es/commands/DeleteAnalysisSchemeCommand.js.map +0 -1
  228. package/dist/es/commands/DeleteDomainCommand.js.map +0 -1
  229. package/dist/es/commands/DeleteExpressionCommand.js.map +0 -1
  230. package/dist/es/commands/DeleteIndexFieldCommand.js.map +0 -1
  231. package/dist/es/commands/DeleteSuggesterCommand.js.map +0 -1
  232. package/dist/es/commands/DescribeAnalysisSchemesCommand.js.map +0 -1
  233. package/dist/es/commands/DescribeAvailabilityOptionsCommand.js.map +0 -1
  234. package/dist/es/commands/DescribeDomainEndpointOptionsCommand.js.map +0 -1
  235. package/dist/es/commands/DescribeDomainsCommand.js.map +0 -1
  236. package/dist/es/commands/DescribeExpressionsCommand.js.map +0 -1
  237. package/dist/es/commands/DescribeIndexFieldsCommand.js.map +0 -1
  238. package/dist/es/commands/DescribeScalingParametersCommand.js.map +0 -1
  239. package/dist/es/commands/DescribeServiceAccessPoliciesCommand.js.map +0 -1
  240. package/dist/es/commands/DescribeSuggestersCommand.js.map +0 -1
  241. package/dist/es/commands/IndexDocumentsCommand.js.map +0 -1
  242. package/dist/es/commands/ListDomainNamesCommand.js.map +0 -1
  243. package/dist/es/commands/UpdateAvailabilityOptionsCommand.js.map +0 -1
  244. package/dist/es/commands/UpdateDomainEndpointOptionsCommand.js.map +0 -1
  245. package/dist/es/commands/UpdateScalingParametersCommand.js.map +0 -1
  246. package/dist/es/commands/UpdateServiceAccessPoliciesCommand.js.map +0 -1
  247. package/dist/es/endpoints.js.map +0 -1
  248. package/dist/es/index.js +0 -30
  249. package/dist/es/index.js.map +0 -1
  250. package/dist/es/models/index.js +0 -2
  251. package/dist/es/models/index.js.map +0 -1
  252. package/dist/es/models/models_0.js.map +0 -1
  253. package/dist/es/package.json +0 -93
  254. package/dist/es/protocols/Aws_query.js.map +0 -1
  255. package/dist/es/runtimeConfig.browser.js.map +0 -1
  256. package/dist/es/runtimeConfig.js.map +0 -1
  257. package/dist/es/runtimeConfig.native.js.map +0 -1
  258. package/dist/es/runtimeConfig.shared.js.map +0 -1
  259. package/dist/types/ts3.4/commands/BuildSuggestersCommand.d.ts +0 -35
  260. package/dist/types/ts3.4/commands/CreateDomainCommand.d.ts +0 -36
  261. package/dist/types/ts3.4/commands/DefineAnalysisSchemeCommand.d.ts +0 -35
  262. package/dist/types/ts3.4/commands/DefineExpressionCommand.d.ts +0 -35
  263. package/dist/types/ts3.4/commands/DefineIndexFieldCommand.d.ts +0 -35
  264. package/dist/types/ts3.4/commands/DefineSuggesterCommand.d.ts +0 -35
  265. package/dist/types/ts3.4/commands/DeleteAnalysisSchemeCommand.d.ts +0 -35
  266. package/dist/types/ts3.4/commands/DeleteDomainCommand.d.ts +0 -36
  267. package/dist/types/ts3.4/commands/DeleteExpressionCommand.d.ts +0 -35
  268. package/dist/types/ts3.4/commands/DeleteIndexFieldCommand.d.ts +0 -35
  269. package/dist/types/ts3.4/commands/DeleteSuggesterCommand.d.ts +0 -35
  270. package/dist/types/ts3.4/commands/DescribeAnalysisSchemesCommand.d.ts +0 -35
  271. package/dist/types/ts3.4/commands/DescribeAvailabilityOptionsCommand.d.ts +0 -35
  272. package/dist/types/ts3.4/commands/DescribeDomainEndpointOptionsCommand.d.ts +0 -35
  273. package/dist/types/ts3.4/commands/DescribeDomainsCommand.d.ts +0 -37
  274. package/dist/types/ts3.4/commands/DescribeExpressionsCommand.d.ts +0 -35
  275. package/dist/types/ts3.4/commands/DescribeIndexFieldsCommand.d.ts +0 -37
  276. package/dist/types/ts3.4/commands/DescribeScalingParametersCommand.d.ts +0 -35
  277. package/dist/types/ts3.4/commands/DescribeServiceAccessPoliciesCommand.d.ts +0 -36
  278. package/dist/types/ts3.4/commands/DescribeSuggestersCommand.d.ts +0 -35
  279. package/dist/types/ts3.4/commands/IndexDocumentsCommand.d.ts +0 -35
  280. package/dist/types/ts3.4/commands/ListDomainNamesCommand.d.ts +0 -35
  281. package/dist/types/ts3.4/commands/UpdateAvailabilityOptionsCommand.d.ts +0 -35
  282. package/dist/types/ts3.4/commands/UpdateDomainEndpointOptionsCommand.d.ts +0 -35
  283. package/dist/types/ts3.4/commands/UpdateScalingParametersCommand.d.ts +0 -35
  284. package/dist/types/ts3.4/commands/UpdateServiceAccessPoliciesCommand.d.ts +0 -37
  285. package/dist/types/ts3.4/models/models_0.d.ts +0 -1973
  286. package/endpoints.ts +0 -57
  287. package/jest.config.js +0 -4
  288. package/models/models_0.ts +0 -2531
  289. package/protocols/Aws_query.ts +0 -4956
  290. package/runtimeConfig.browser.ts +0 -40
  291. package/runtimeConfig.native.ts +0 -16
  292. package/runtimeConfig.shared.ts +0 -16
  293. package/runtimeConfig.ts +0 -45
  294. package/tsconfig.es.json +0 -10
  295. package/tsconfig.json +0 -31
  296. package/tsconfig.types.json +0 -8
@@ -1,2531 +0,0 @@
1
- import { MetadataBearer as $MetadataBearer, SmithyException as __SmithyException } from "@aws-sdk/types";
2
-
3
- /**
4
- * <p>An error occurred while processing the request.</p>
5
- */
6
- export interface BaseException extends __SmithyException, $MetadataBearer {
7
- name: "BaseException";
8
- $fault: "client";
9
- /**
10
- * <p>A machine-parsable string error or warning code.</p>
11
- */
12
- Code?: string;
13
-
14
- /**
15
- * <p>A human-readable string error or warning message.</p>
16
- */
17
- Message?: string;
18
- }
19
-
20
- export namespace BaseException {
21
- /**
22
- * @internal
23
- */
24
- export const filterSensitiveLog = (obj: BaseException): any => ({
25
- ...obj,
26
- });
27
- }
28
-
29
- /**
30
- * <p>Container for the parameters to the <code><a>BuildSuggester</a></code> operation. Specifies the name of the domain you want to update.</p>
31
- */
32
- export interface BuildSuggestersRequest {
33
- /**
34
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
35
- */
36
- DomainName: string | undefined;
37
- }
38
-
39
- export namespace BuildSuggestersRequest {
40
- /**
41
- * @internal
42
- */
43
- export const filterSensitiveLog = (obj: BuildSuggestersRequest): any => ({
44
- ...obj,
45
- });
46
- }
47
-
48
- /**
49
- * <p>The result of a <code>BuildSuggester</code> request. Contains a list of the fields used for suggestions.</p>
50
- */
51
- export interface BuildSuggestersResponse {
52
- /**
53
- * <p>A list of field names.</p>
54
- */
55
- FieldNames?: string[];
56
- }
57
-
58
- export namespace BuildSuggestersResponse {
59
- /**
60
- * @internal
61
- */
62
- export const filterSensitiveLog = (obj: BuildSuggestersResponse): any => ({
63
- ...obj,
64
- });
65
- }
66
-
67
- /**
68
- * <p>An internal error occurred while processing the request. If this problem persists,
69
- * report an issue from the <a href="http://status.aws.amazon.com/" target="_blank">Service Health Dashboard</a>.</p>
70
- */
71
- export interface InternalException extends __SmithyException, $MetadataBearer {
72
- name: "InternalException";
73
- $fault: "server";
74
- /**
75
- * <p>A machine-parsable string error or warning code.</p>
76
- */
77
- Code?: string;
78
-
79
- /**
80
- * <p>A human-readable string error or warning message.</p>
81
- */
82
- Message?: string;
83
- }
84
-
85
- export namespace InternalException {
86
- /**
87
- * @internal
88
- */
89
- export const filterSensitiveLog = (obj: InternalException): any => ({
90
- ...obj,
91
- });
92
- }
93
-
94
- /**
95
- * <p>The request was rejected because it attempted to reference a resource that does not exist.</p>
96
- */
97
- export interface ResourceNotFoundException extends __SmithyException, $MetadataBearer {
98
- name: "ResourceNotFoundException";
99
- $fault: "client";
100
- /**
101
- * <p>A machine-parsable string error or warning code.</p>
102
- */
103
- Code?: string;
104
-
105
- /**
106
- * <p>A human-readable string error or warning message.</p>
107
- */
108
- Message?: string;
109
- }
110
-
111
- export namespace ResourceNotFoundException {
112
- /**
113
- * @internal
114
- */
115
- export const filterSensitiveLog = (obj: ResourceNotFoundException): any => ({
116
- ...obj,
117
- });
118
- }
119
-
120
- /**
121
- * <p>Container for the parameters to the <code><a>CreateDomain</a></code> operation. Specifies a name for the new search domain.</p>
122
- */
123
- export interface CreateDomainRequest {
124
- /**
125
- * <p>A name for the domain you are creating. Allowed characters are a-z (lower-case letters), 0-9, and hyphen (-). Domain names must start with a letter or number and be at least 3 and no more than 28 characters long.</p>
126
- */
127
- DomainName: string | undefined;
128
- }
129
-
130
- export namespace CreateDomainRequest {
131
- /**
132
- * @internal
133
- */
134
- export const filterSensitiveLog = (obj: CreateDomainRequest): any => ({
135
- ...obj,
136
- });
137
- }
138
-
139
- /**
140
- * <p>The endpoint to which service requests can be submitted.</p>
141
- */
142
- export interface ServiceEndpoint {
143
- /**
144
- * <p>The endpoint to which service requests can be submitted. For example, <code>search-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code> or <code>doc-imdb-movies-oopcnjfn6ugofer3zx5iadxxca.eu-west-1.cloudsearch.amazonaws.com</code>.</p>
145
- */
146
- Endpoint?: string;
147
- }
148
-
149
- export namespace ServiceEndpoint {
150
- /**
151
- * @internal
152
- */
153
- export const filterSensitiveLog = (obj: ServiceEndpoint): any => ({
154
- ...obj,
155
- });
156
- }
157
-
158
- export interface Limits {
159
- MaximumReplicationCount: number | undefined;
160
- MaximumPartitionCount: number | undefined;
161
- }
162
-
163
- export namespace Limits {
164
- /**
165
- * @internal
166
- */
167
- export const filterSensitiveLog = (obj: Limits): any => ({
168
- ...obj,
169
- });
170
- }
171
-
172
- /**
173
- * <p>The current status of the search domain.</p>
174
- */
175
- export interface DomainStatus {
176
- /**
177
- * <p>An internally generated unique identifier for a domain.</p>
178
- */
179
- DomainId: string | undefined;
180
-
181
- /**
182
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
183
- */
184
- DomainName: string | undefined;
185
-
186
- /**
187
- * <p>The Amazon Resource Name (ARN) of the search domain. See <a href="http://docs.aws.amazon.com/IAM/latest/UserGuide/index.html?Using_Identifiers.html" target="_blank">Identifiers for IAM Entities</a> in <i>Using AWS Identity and Access Management</i> for more information.</p>
188
- */
189
- ARN?: string;
190
-
191
- /**
192
- * <p>True if the search domain is created. It can take several minutes to initialize a domain when <a>CreateDomain</a> is called. Newly created search domains are returned from <a>DescribeDomains</a> with a false value for Created until domain creation is complete.</p>
193
- */
194
- Created?: boolean;
195
-
196
- /**
197
- * <p>True if the search domain has been deleted. The system must clean up resources dedicated to the search domain when <a>DeleteDomain</a> is called. Newly deleted search domains are returned from <a>DescribeDomains</a> with a true value for IsDeleted for several minutes until resource cleanup is complete.</p>
198
- */
199
- Deleted?: boolean;
200
-
201
- /**
202
- * <p>The service endpoint for updating documents in a search domain.</p>
203
- */
204
- DocService?: ServiceEndpoint;
205
-
206
- /**
207
- * <p>The service endpoint for requesting search results from a search domain.</p>
208
- */
209
- SearchService?: ServiceEndpoint;
210
-
211
- /**
212
- * <p>True if <a>IndexDocuments</a> needs to be called to activate the current domain configuration.</p>
213
- */
214
- RequiresIndexDocuments: boolean | undefined;
215
-
216
- /**
217
- * <p>True if processing is being done to activate the current domain configuration.</p>
218
- */
219
- Processing?: boolean;
220
-
221
- /**
222
- * <p>The instance type that is being used to process search requests.</p>
223
- */
224
- SearchInstanceType?: string;
225
-
226
- /**
227
- * <p>The number of partitions across which the search index is spread.</p>
228
- */
229
- SearchPartitionCount?: number;
230
-
231
- /**
232
- * <p>The number of search instances that are available to process search requests.</p>
233
- */
234
- SearchInstanceCount?: number;
235
-
236
- Limits?: Limits;
237
- }
238
-
239
- export namespace DomainStatus {
240
- /**
241
- * @internal
242
- */
243
- export const filterSensitiveLog = (obj: DomainStatus): any => ({
244
- ...obj,
245
- });
246
- }
247
-
248
- /**
249
- * <p>The result of a <code>CreateDomainRequest</code>. Contains the status of a newly created domain.</p>
250
- */
251
- export interface CreateDomainResponse {
252
- /**
253
- * <p>The current status of the search domain.</p>
254
- */
255
- DomainStatus?: DomainStatus;
256
- }
257
-
258
- export namespace CreateDomainResponse {
259
- /**
260
- * @internal
261
- */
262
- export const filterSensitiveLog = (obj: CreateDomainResponse): any => ({
263
- ...obj,
264
- });
265
- }
266
-
267
- /**
268
- * <p>The request was rejected because a resource limit has already been met.</p>
269
- */
270
- export interface LimitExceededException extends __SmithyException, $MetadataBearer {
271
- name: "LimitExceededException";
272
- $fault: "client";
273
- /**
274
- * <p>A machine-parsable string error or warning code.</p>
275
- */
276
- Code?: string;
277
-
278
- /**
279
- * <p>A human-readable string error or warning message.</p>
280
- */
281
- Message?: string;
282
- }
283
-
284
- export namespace LimitExceededException {
285
- /**
286
- * @internal
287
- */
288
- export const filterSensitiveLog = (obj: LimitExceededException): any => ({
289
- ...obj,
290
- });
291
- }
292
-
293
- /**
294
- * <p>The request was rejected because it attempted to create a resource that already exists.</p>
295
- */
296
- export interface ResourceAlreadyExistsException extends __SmithyException, $MetadataBearer {
297
- name: "ResourceAlreadyExistsException";
298
- $fault: "client";
299
- /**
300
- * <p>A machine-parsable string error or warning code.</p>
301
- */
302
- Code?: string;
303
-
304
- /**
305
- * <p>A human-readable string error or warning message.</p>
306
- */
307
- Message?: string;
308
- }
309
-
310
- export namespace ResourceAlreadyExistsException {
311
- /**
312
- * @internal
313
- */
314
- export const filterSensitiveLog = (obj: ResourceAlreadyExistsException): any => ({
315
- ...obj,
316
- });
317
- }
318
-
319
- /**
320
- * <p>The request was rejected because it has invalid parameters.</p>
321
- */
322
- export interface ValidationException extends __SmithyException, $MetadataBearer {
323
- name: "ValidationException";
324
- $fault: "client";
325
- /**
326
- * <p>A machine-parsable string error or warning code.</p>
327
- */
328
- Code?: string;
329
-
330
- /**
331
- * <p>A human-readable string error or warning message.</p>
332
- */
333
- Message?: string;
334
- }
335
-
336
- export namespace ValidationException {
337
- /**
338
- * @internal
339
- */
340
- export const filterSensitiveLog = (obj: ValidationException): any => ({
341
- ...obj,
342
- });
343
- }
344
-
345
- export type AlgorithmicStemming = "full" | "light" | "minimal" | "none";
346
-
347
- /**
348
- * <p>Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.</p>
349
- */
350
- export interface AnalysisOptions {
351
- /**
352
- * <p>A JSON object that defines synonym groups and aliases. A synonym group is an array of arrays, where each sub-array is a group of terms where each term in the group is considered a synonym of every other term in the group. The aliases value is an object that contains a collection of string:value pairs where the string specifies a term and the array of values specifies each of the aliases for that term. An alias is considered a synonym of the specified term, but the term is not considered a synonym of the alias. For more information about specifying synonyms, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-analysis-schemes.html#synonyms">Synonyms</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
353
- */
354
- Synonyms?: string;
355
-
356
- /**
357
- * <p>A JSON array of terms to ignore during indexing and searching. For example, <code>["a", "an", "the", "of"]</code>. The stopwords dictionary must explicitly list each word you want to ignore. Wildcards and regular expressions are not supported. </p>
358
- */
359
- Stopwords?: string;
360
-
361
- /**
362
- * <p>A JSON object that contains a collection of string:value pairs that each map a term to its stem. For example, <code>{"term1": "stem1", "term2": "stem2", "term3": "stem3"}</code>. The stemming dictionary is applied in addition to any algorithmic stemming. This enables you to override the results of the algorithmic stemming to correct specific cases of overstemming or understemming. The maximum size of a stemming dictionary is 500 KB.</p>
363
- */
364
- StemmingDictionary?: string;
365
-
366
- /**
367
- * <p>A JSON array that contains a collection of terms, tokens, readings and part of speech for Japanese Tokenizaiton. The Japanese tokenization dictionary enables you to override the default tokenization for selected terms. This is only valid for Japanese language fields.</p>
368
- */
369
- JapaneseTokenizationDictionary?: string;
370
-
371
- /**
372
- * <p>The level of algorithmic stemming to perform: <code>none</code>, <code>minimal</code>, <code>light</code>, or <code>full</code>. The available levels vary depending on the language. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/text-processing.html#text-processing-settings" target="_blank">Language Specific Text Processing Settings</a> in the <i>Amazon CloudSearch Developer Guide</i> </p>
373
- */
374
- AlgorithmicStemming?: AlgorithmicStemming | string;
375
- }
376
-
377
- export namespace AnalysisOptions {
378
- /**
379
- * @internal
380
- */
381
- export const filterSensitiveLog = (obj: AnalysisOptions): any => ({
382
- ...obj,
383
- });
384
- }
385
-
386
- export type AnalysisSchemeLanguage =
387
- | "ar"
388
- | "bg"
389
- | "ca"
390
- | "cs"
391
- | "da"
392
- | "de"
393
- | "el"
394
- | "en"
395
- | "es"
396
- | "eu"
397
- | "fa"
398
- | "fi"
399
- | "fr"
400
- | "ga"
401
- | "gl"
402
- | "he"
403
- | "hi"
404
- | "hu"
405
- | "hy"
406
- | "id"
407
- | "it"
408
- | "ja"
409
- | "ko"
410
- | "lv"
411
- | "mul"
412
- | "nl"
413
- | "no"
414
- | "pt"
415
- | "ro"
416
- | "ru"
417
- | "sv"
418
- | "th"
419
- | "tr"
420
- | "zh-Hans"
421
- | "zh-Hant";
422
-
423
- /**
424
- * <p>Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: <code>Synonyms</code>, <code>Stopwords</code>, <code>StemmingDictionary</code>, <code>JapaneseTokenizationDictionary</code> and <code>AlgorithmicStemming</code>.</p>
425
- */
426
- export interface AnalysisScheme {
427
- /**
428
- * <p>Names must begin with a letter and can contain the following characters:
429
- * a-z (lowercase), 0-9, and _ (underscore).</p>
430
- */
431
- AnalysisSchemeName: string | undefined;
432
-
433
- /**
434
- * <p>An <a href="http://tools.ietf.org/html/rfc4646" target="_blank">IETF RFC 4646</a> language code or <code>mul</code> for multiple languages.</p>
435
- */
436
- AnalysisSchemeLanguage: AnalysisSchemeLanguage | string | undefined;
437
-
438
- /**
439
- * <p>Synonyms, stopwords, and stemming options for an analysis scheme. Includes tokenization dictionary for Japanese.</p>
440
- */
441
- AnalysisOptions?: AnalysisOptions;
442
- }
443
-
444
- export namespace AnalysisScheme {
445
- /**
446
- * @internal
447
- */
448
- export const filterSensitiveLog = (obj: AnalysisScheme): any => ({
449
- ...obj,
450
- });
451
- }
452
-
453
- /**
454
- * <p>Container for the parameters to the <code><a>DefineAnalysisScheme</a></code> operation. Specifies the name of the domain you want to update and the analysis scheme configuration.</p>
455
- */
456
- export interface DefineAnalysisSchemeRequest {
457
- /**
458
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
459
- */
460
- DomainName: string | undefined;
461
-
462
- /**
463
- * <p>Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: <code>Synonyms</code>, <code>Stopwords</code>, <code>StemmingDictionary</code>, <code>JapaneseTokenizationDictionary</code> and <code>AlgorithmicStemming</code>.</p>
464
- */
465
- AnalysisScheme: AnalysisScheme | undefined;
466
- }
467
-
468
- export namespace DefineAnalysisSchemeRequest {
469
- /**
470
- * @internal
471
- */
472
- export const filterSensitiveLog = (obj: DefineAnalysisSchemeRequest): any => ({
473
- ...obj,
474
- });
475
- }
476
-
477
- export type OptionState = "Active" | "FailedToValidate" | "Processing" | "RequiresIndexDocuments";
478
-
479
- /**
480
- * <p>The status of domain configuration option.</p>
481
- */
482
- export interface OptionStatus {
483
- /**
484
- * <p>A timestamp for when this option was created.</p>
485
- */
486
- CreationDate: Date | undefined;
487
-
488
- /**
489
- * <p>A timestamp for when this option was last updated.</p>
490
- */
491
- UpdateDate: Date | undefined;
492
-
493
- /**
494
- * <p>A unique integer that indicates when this option was last updated.</p>
495
- */
496
- UpdateVersion?: number;
497
-
498
- /**
499
- * <p>The state of processing a change to an option. Possible values:</p><ul>
500
- * <li><code>RequiresIndexDocuments</code>: the option's latest value will not be deployed until <a>IndexDocuments</a> has been called and indexing is complete.</li>
501
- * <li><code>Processing</code>: the option's latest value is in the process of being activated. </li>
502
- * <li><code>Active</code>: the option's latest value is completely deployed.</li>
503
- * <li><code>FailedToValidate</code>: the option value is not compatible with the domain's data and cannot be used to index the data. You must either modify the option value or update or remove the incompatible documents.</li>
504
- * </ul>
505
- */
506
- State: OptionState | string | undefined;
507
-
508
- /**
509
- * <p>Indicates that the option will be deleted once processing is complete.</p>
510
- */
511
- PendingDeletion?: boolean;
512
- }
513
-
514
- export namespace OptionStatus {
515
- /**
516
- * @internal
517
- */
518
- export const filterSensitiveLog = (obj: OptionStatus): any => ({
519
- ...obj,
520
- });
521
- }
522
-
523
- /**
524
- * <p>The status and configuration of an <code>AnalysisScheme</code>.</p>
525
- */
526
- export interface AnalysisSchemeStatus {
527
- /**
528
- * <p>Configuration information for an analysis scheme. Each analysis scheme has a unique name and specifies the language of the text to be processed. The following options can be configured for an analysis scheme: <code>Synonyms</code>, <code>Stopwords</code>, <code>StemmingDictionary</code>, <code>JapaneseTokenizationDictionary</code> and <code>AlgorithmicStemming</code>.</p>
529
- */
530
- Options: AnalysisScheme | undefined;
531
-
532
- /**
533
- * <p>The status of domain configuration option.</p>
534
- */
535
- Status: OptionStatus | undefined;
536
- }
537
-
538
- export namespace AnalysisSchemeStatus {
539
- /**
540
- * @internal
541
- */
542
- export const filterSensitiveLog = (obj: AnalysisSchemeStatus): any => ({
543
- ...obj,
544
- });
545
- }
546
-
547
- /**
548
- * <p>The result of a <code><a>DefineAnalysisScheme</a></code> request. Contains the status of the newly-configured analysis scheme.</p>
549
- */
550
- export interface DefineAnalysisSchemeResponse {
551
- /**
552
- * <p>The status and configuration of an <code>AnalysisScheme</code>.</p>
553
- */
554
- AnalysisScheme: AnalysisSchemeStatus | undefined;
555
- }
556
-
557
- export namespace DefineAnalysisSchemeResponse {
558
- /**
559
- * @internal
560
- */
561
- export const filterSensitiveLog = (obj: DefineAnalysisSchemeResponse): any => ({
562
- ...obj,
563
- });
564
- }
565
-
566
- /**
567
- * <p>The request was rejected because it specified an invalid type definition.</p>
568
- */
569
- export interface InvalidTypeException extends __SmithyException, $MetadataBearer {
570
- name: "InvalidTypeException";
571
- $fault: "client";
572
- /**
573
- * <p>A machine-parsable string error or warning code.</p>
574
- */
575
- Code?: string;
576
-
577
- /**
578
- * <p>A human-readable string error or warning message.</p>
579
- */
580
- Message?: string;
581
- }
582
-
583
- export namespace InvalidTypeException {
584
- /**
585
- * @internal
586
- */
587
- export const filterSensitiveLog = (obj: InvalidTypeException): any => ({
588
- ...obj,
589
- });
590
- }
591
-
592
- /**
593
- * <p>A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results. </p>
594
- */
595
- export interface Expression {
596
- /**
597
- * <p>Names must begin with a letter and can contain the following characters:
598
- * a-z (lowercase), 0-9, and _ (underscore).</p>
599
- */
600
- ExpressionName: string | undefined;
601
-
602
- /**
603
- * <p>The expression to evaluate for sorting while processing a search request. The <code>Expression</code> syntax is based on JavaScript expressions. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-expressions.html" target="_blank">Configuring Expressions</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
604
- */
605
- ExpressionValue: string | undefined;
606
- }
607
-
608
- export namespace Expression {
609
- /**
610
- * @internal
611
- */
612
- export const filterSensitiveLog = (obj: Expression): any => ({
613
- ...obj,
614
- });
615
- }
616
-
617
- /**
618
- * <p>Container for the parameters to the <code><a>DefineExpression</a></code> operation. Specifies the name of the domain you want to update and the expression you want to configure.</p>
619
- */
620
- export interface DefineExpressionRequest {
621
- /**
622
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
623
- */
624
- DomainName: string | undefined;
625
-
626
- /**
627
- * <p>A named expression that can be evaluated at search time. Can be used to sort the search results, define other expressions, or return computed information in the search results. </p>
628
- */
629
- Expression: Expression | undefined;
630
- }
631
-
632
- export namespace DefineExpressionRequest {
633
- /**
634
- * @internal
635
- */
636
- export const filterSensitiveLog = (obj: DefineExpressionRequest): any => ({
637
- ...obj,
638
- });
639
- }
640
-
641
- /**
642
- * <p>The value of an <code>Expression</code> and its current status.</p>
643
- */
644
- export interface ExpressionStatus {
645
- /**
646
- * <p>The expression that is evaluated for sorting while processing a search request.</p>
647
- */
648
- Options: Expression | undefined;
649
-
650
- /**
651
- * <p>The status of domain configuration option.</p>
652
- */
653
- Status: OptionStatus | undefined;
654
- }
655
-
656
- export namespace ExpressionStatus {
657
- /**
658
- * @internal
659
- */
660
- export const filterSensitiveLog = (obj: ExpressionStatus): any => ({
661
- ...obj,
662
- });
663
- }
664
-
665
- /**
666
- * <p>The result of a <code>DefineExpression</code> request. Contains the status of the newly-configured expression.</p>
667
- */
668
- export interface DefineExpressionResponse {
669
- /**
670
- * <p>The value of an <code>Expression</code> and its current status.</p>
671
- */
672
- Expression: ExpressionStatus | undefined;
673
- }
674
-
675
- export namespace DefineExpressionResponse {
676
- /**
677
- * @internal
678
- */
679
- export const filterSensitiveLog = (obj: DefineExpressionResponse): any => ({
680
- ...obj,
681
- });
682
- }
683
-
684
- /**
685
- * <p>Options for a field that contains an array of dates. Present if <code>IndexFieldType</code> specifies the field is of type <code>date-array</code>. All options are enabled by default.</p>
686
- */
687
- export interface DateArrayOptions {
688
- /**
689
- * A value to use for the field if the field isn't specified for a document.
690
- */
691
- DefaultValue?: string;
692
-
693
- /**
694
- * <p>A list of source fields to map to the field. </p>
695
- */
696
- SourceFields?: string;
697
-
698
- /**
699
- * <p>Whether facet information can be returned for the field.</p>
700
- */
701
- FacetEnabled?: boolean;
702
-
703
- /**
704
- * <p>Whether the contents of the field are searchable.</p>
705
- */
706
- SearchEnabled?: boolean;
707
-
708
- /**
709
- * <p>Whether the contents of the field can be returned in the search results.</p>
710
- */
711
- ReturnEnabled?: boolean;
712
- }
713
-
714
- export namespace DateArrayOptions {
715
- /**
716
- * @internal
717
- */
718
- export const filterSensitiveLog = (obj: DateArrayOptions): any => ({
719
- ...obj,
720
- });
721
- }
722
-
723
- /**
724
- * <p>Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if <code>IndexFieldType</code> specifies the field is of type <code>date</code>. All options are enabled by default.</p>
725
- */
726
- export interface DateOptions {
727
- /**
728
- * A value to use for the field if the field isn't specified for a document.
729
- */
730
- DefaultValue?: string;
731
-
732
- /**
733
- * <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
734
- * A dynamic field's name defines a pattern that begins or ends with a wildcard.
735
- * Any document fields that don't map to a regular index field but do match a
736
- * dynamic field's pattern are configured with the dynamic field's indexing options.
737
- * </p>
738
- * <p>Regular field names begin with a letter and can contain the following characters:
739
- * a-z (lowercase), 0-9, and _ (underscore).
740
- * Dynamic field names must begin or end with a wildcard (*).
741
- * The wildcard can also be the only character in a dynamic field name.
742
- * Multiple wildcards, and wildcards embedded within a string are not supported.
743
- * </p>
744
- * <p>The name <code>score</code> is reserved and cannot be used as a field name.
745
- * To reference a document's ID, you can use the name <code>_id</code>.
746
- * </p>
747
- */
748
- SourceField?: string;
749
-
750
- /**
751
- * <p>Whether facet information can be returned for the field.</p>
752
- */
753
- FacetEnabled?: boolean;
754
-
755
- /**
756
- * <p>Whether the contents of the field are searchable.</p>
757
- */
758
- SearchEnabled?: boolean;
759
-
760
- /**
761
- * <p>Whether the contents of the field can be returned in the search results.</p>
762
- */
763
- ReturnEnabled?: boolean;
764
-
765
- /**
766
- * <p>Whether the field can be used to sort the search results.</p>
767
- */
768
- SortEnabled?: boolean;
769
- }
770
-
771
- export namespace DateOptions {
772
- /**
773
- * @internal
774
- */
775
- export const filterSensitiveLog = (obj: DateOptions): any => ({
776
- ...obj,
777
- });
778
- }
779
-
780
- /**
781
- * <p>Options for a field that contains an array of double-precision 64-bit floating point values. Present if <code>IndexFieldType</code> specifies the field is of type <code>double-array</code>. All options are enabled by default.</p>
782
- */
783
- export interface DoubleArrayOptions {
784
- /**
785
- * A value to use for the field if the field isn't specified for a document.
786
- */
787
- DefaultValue?: number;
788
-
789
- /**
790
- * <p>A list of source fields to map to the field. </p>
791
- */
792
- SourceFields?: string;
793
-
794
- /**
795
- * <p>Whether facet information can be returned for the field.</p>
796
- */
797
- FacetEnabled?: boolean;
798
-
799
- /**
800
- * <p>Whether the contents of the field are searchable.</p>
801
- */
802
- SearchEnabled?: boolean;
803
-
804
- /**
805
- * <p>Whether the contents of the field can be returned in the search results.</p>
806
- */
807
- ReturnEnabled?: boolean;
808
- }
809
-
810
- export namespace DoubleArrayOptions {
811
- /**
812
- * @internal
813
- */
814
- export const filterSensitiveLog = (obj: DoubleArrayOptions): any => ({
815
- ...obj,
816
- });
817
- }
818
-
819
- /**
820
- * <p>Options for a double-precision 64-bit floating point field. Present if <code>IndexFieldType</code> specifies the field is of type <code>double</code>. All options are enabled by default.</p>
821
- */
822
- export interface DoubleOptions {
823
- /**
824
- * <p>A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.</p>
825
- */
826
- DefaultValue?: number;
827
-
828
- /**
829
- * <p>The name of the source field to map to the field. </p>
830
- */
831
- SourceField?: string;
832
-
833
- /**
834
- * <p>Whether facet information can be returned for the field.</p>
835
- */
836
- FacetEnabled?: boolean;
837
-
838
- /**
839
- * <p>Whether the contents of the field are searchable.</p>
840
- */
841
- SearchEnabled?: boolean;
842
-
843
- /**
844
- * <p>Whether the contents of the field can be returned in the search results.</p>
845
- */
846
- ReturnEnabled?: boolean;
847
-
848
- /**
849
- * <p>Whether the field can be used to sort the search results.</p>
850
- */
851
- SortEnabled?: boolean;
852
- }
853
-
854
- export namespace DoubleOptions {
855
- /**
856
- * @internal
857
- */
858
- export const filterSensitiveLog = (obj: DoubleOptions): any => ({
859
- ...obj,
860
- });
861
- }
862
-
863
- export type IndexFieldType =
864
- | "date"
865
- | "date-array"
866
- | "double"
867
- | "double-array"
868
- | "int"
869
- | "int-array"
870
- | "latlon"
871
- | "literal"
872
- | "literal-array"
873
- | "text"
874
- | "text-array";
875
-
876
- /**
877
- * <p>Options for a field that contains an array of 64-bit signed integers. Present if <code>IndexFieldType</code> specifies the field is of type <code>int-array</code>. All options are enabled by default.</p>
878
- */
879
- export interface IntArrayOptions {
880
- /**
881
- * A value to use for the field if the field isn't specified for a document.
882
- */
883
- DefaultValue?: number;
884
-
885
- /**
886
- * <p>A list of source fields to map to the field. </p>
887
- */
888
- SourceFields?: string;
889
-
890
- /**
891
- * <p>Whether facet information can be returned for the field.</p>
892
- */
893
- FacetEnabled?: boolean;
894
-
895
- /**
896
- * <p>Whether the contents of the field are searchable.</p>
897
- */
898
- SearchEnabled?: boolean;
899
-
900
- /**
901
- * <p>Whether the contents of the field can be returned in the search results.</p>
902
- */
903
- ReturnEnabled?: boolean;
904
- }
905
-
906
- export namespace IntArrayOptions {
907
- /**
908
- * @internal
909
- */
910
- export const filterSensitiveLog = (obj: IntArrayOptions): any => ({
911
- ...obj,
912
- });
913
- }
914
-
915
- /**
916
- * <p>Options for a 64-bit signed integer field. Present if <code>IndexFieldType</code> specifies the field is of type <code>int</code>. All options are enabled by default.</p>
917
- */
918
- export interface IntOptions {
919
- /**
920
- * A value to use for the field if the field isn't specified for a document. This can be important if you are using the field in an expression and that field is not present in every document.
921
- */
922
- DefaultValue?: number;
923
-
924
- /**
925
- * <p>The name of the source field to map to the field. </p>
926
- */
927
- SourceField?: string;
928
-
929
- /**
930
- * <p>Whether facet information can be returned for the field.</p>
931
- */
932
- FacetEnabled?: boolean;
933
-
934
- /**
935
- * <p>Whether the contents of the field are searchable.</p>
936
- */
937
- SearchEnabled?: boolean;
938
-
939
- /**
940
- * <p>Whether the contents of the field can be returned in the search results.</p>
941
- */
942
- ReturnEnabled?: boolean;
943
-
944
- /**
945
- * <p>Whether the field can be used to sort the search results.</p>
946
- */
947
- SortEnabled?: boolean;
948
- }
949
-
950
- export namespace IntOptions {
951
- /**
952
- * @internal
953
- */
954
- export const filterSensitiveLog = (obj: IntOptions): any => ({
955
- ...obj,
956
- });
957
- }
958
-
959
- /**
960
- * <p>Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if <code>IndexFieldType</code> specifies the field is of type <code>latlon</code>. All options are enabled by default.</p>
961
- */
962
- export interface LatLonOptions {
963
- /**
964
- * A value to use for the field if the field isn't specified for a document.
965
- */
966
- DefaultValue?: string;
967
-
968
- /**
969
- * <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
970
- * A dynamic field's name defines a pattern that begins or ends with a wildcard.
971
- * Any document fields that don't map to a regular index field but do match a
972
- * dynamic field's pattern are configured with the dynamic field's indexing options.
973
- * </p>
974
- * <p>Regular field names begin with a letter and can contain the following characters:
975
- * a-z (lowercase), 0-9, and _ (underscore).
976
- * Dynamic field names must begin or end with a wildcard (*).
977
- * The wildcard can also be the only character in a dynamic field name.
978
- * Multiple wildcards, and wildcards embedded within a string are not supported.
979
- * </p>
980
- * <p>The name <code>score</code> is reserved and cannot be used as a field name.
981
- * To reference a document's ID, you can use the name <code>_id</code>.
982
- * </p>
983
- */
984
- SourceField?: string;
985
-
986
- /**
987
- * <p>Whether facet information can be returned for the field.</p>
988
- */
989
- FacetEnabled?: boolean;
990
-
991
- /**
992
- * <p>Whether the contents of the field are searchable.</p>
993
- */
994
- SearchEnabled?: boolean;
995
-
996
- /**
997
- * <p>Whether the contents of the field can be returned in the search results.</p>
998
- */
999
- ReturnEnabled?: boolean;
1000
-
1001
- /**
1002
- * <p>Whether the field can be used to sort the search results.</p>
1003
- */
1004
- SortEnabled?: boolean;
1005
- }
1006
-
1007
- export namespace LatLonOptions {
1008
- /**
1009
- * @internal
1010
- */
1011
- export const filterSensitiveLog = (obj: LatLonOptions): any => ({
1012
- ...obj,
1013
- });
1014
- }
1015
-
1016
- /**
1017
- * <p>Options for a field that contains an array of literal strings. Present if <code>IndexFieldType</code> specifies the field is of type <code>literal-array</code>. All options are enabled by default.</p>
1018
- */
1019
- export interface LiteralArrayOptions {
1020
- /**
1021
- * A value to use for the field if the field isn't specified for a document.
1022
- */
1023
- DefaultValue?: string;
1024
-
1025
- /**
1026
- * <p>A list of source fields to map to the field. </p>
1027
- */
1028
- SourceFields?: string;
1029
-
1030
- /**
1031
- * <p>Whether facet information can be returned for the field.</p>
1032
- */
1033
- FacetEnabled?: boolean;
1034
-
1035
- /**
1036
- * <p>Whether the contents of the field are searchable.</p>
1037
- */
1038
- SearchEnabled?: boolean;
1039
-
1040
- /**
1041
- * <p>Whether the contents of the field can be returned in the search results.</p>
1042
- */
1043
- ReturnEnabled?: boolean;
1044
- }
1045
-
1046
- export namespace LiteralArrayOptions {
1047
- /**
1048
- * @internal
1049
- */
1050
- export const filterSensitiveLog = (obj: LiteralArrayOptions): any => ({
1051
- ...obj,
1052
- });
1053
- }
1054
-
1055
- /**
1056
- * <p>Options for literal field. Present if <code>IndexFieldType</code> specifies the field is of type <code>literal</code>. All options are enabled by default.</p>
1057
- */
1058
- export interface LiteralOptions {
1059
- /**
1060
- * A value to use for the field if the field isn't specified for a document.
1061
- */
1062
- DefaultValue?: string;
1063
-
1064
- /**
1065
- * <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
1066
- * A dynamic field's name defines a pattern that begins or ends with a wildcard.
1067
- * Any document fields that don't map to a regular index field but do match a
1068
- * dynamic field's pattern are configured with the dynamic field's indexing options.
1069
- * </p>
1070
- * <p>Regular field names begin with a letter and can contain the following characters:
1071
- * a-z (lowercase), 0-9, and _ (underscore).
1072
- * Dynamic field names must begin or end with a wildcard (*).
1073
- * The wildcard can also be the only character in a dynamic field name.
1074
- * Multiple wildcards, and wildcards embedded within a string are not supported.
1075
- * </p>
1076
- * <p>The name <code>score</code> is reserved and cannot be used as a field name.
1077
- * To reference a document's ID, you can use the name <code>_id</code>.
1078
- * </p>
1079
- */
1080
- SourceField?: string;
1081
-
1082
- /**
1083
- * <p>Whether facet information can be returned for the field.</p>
1084
- */
1085
- FacetEnabled?: boolean;
1086
-
1087
- /**
1088
- * <p>Whether the contents of the field are searchable.</p>
1089
- */
1090
- SearchEnabled?: boolean;
1091
-
1092
- /**
1093
- * <p>Whether the contents of the field can be returned in the search results.</p>
1094
- */
1095
- ReturnEnabled?: boolean;
1096
-
1097
- /**
1098
- * <p>Whether the field can be used to sort the search results.</p>
1099
- */
1100
- SortEnabled?: boolean;
1101
- }
1102
-
1103
- export namespace LiteralOptions {
1104
- /**
1105
- * @internal
1106
- */
1107
- export const filterSensitiveLog = (obj: LiteralOptions): any => ({
1108
- ...obj,
1109
- });
1110
- }
1111
-
1112
- /**
1113
- * <p>Options for a field that contains an array of text strings. Present if <code>IndexFieldType</code> specifies the field is of type <code>text-array</code>. A <code>text-array</code> field is always searchable. All options are enabled by default.</p>
1114
- */
1115
- export interface TextArrayOptions {
1116
- /**
1117
- * A value to use for the field if the field isn't specified for a document.
1118
- */
1119
- DefaultValue?: string;
1120
-
1121
- /**
1122
- * <p>A list of source fields to map to the field. </p>
1123
- */
1124
- SourceFields?: string;
1125
-
1126
- /**
1127
- * <p>Whether the contents of the field can be returned in the search results.</p>
1128
- */
1129
- ReturnEnabled?: boolean;
1130
-
1131
- /**
1132
- * <p>Whether highlights can be returned for the field.</p>
1133
- */
1134
- HighlightEnabled?: boolean;
1135
-
1136
- /**
1137
- * <p>The name of an analysis scheme for a <code>text-array</code> field.</p>
1138
- */
1139
- AnalysisScheme?: string;
1140
- }
1141
-
1142
- export namespace TextArrayOptions {
1143
- /**
1144
- * @internal
1145
- */
1146
- export const filterSensitiveLog = (obj: TextArrayOptions): any => ({
1147
- ...obj,
1148
- });
1149
- }
1150
-
1151
- /**
1152
- * <p>Options for text field. Present if <code>IndexFieldType</code> specifies the field is of type <code>text</code>. A <code>text</code> field is always searchable. All options are enabled by default.</p>
1153
- */
1154
- export interface TextOptions {
1155
- /**
1156
- * A value to use for the field if the field isn't specified for a document.
1157
- */
1158
- DefaultValue?: string;
1159
-
1160
- /**
1161
- * <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
1162
- * A dynamic field's name defines a pattern that begins or ends with a wildcard.
1163
- * Any document fields that don't map to a regular index field but do match a
1164
- * dynamic field's pattern are configured with the dynamic field's indexing options.
1165
- * </p>
1166
- * <p>Regular field names begin with a letter and can contain the following characters:
1167
- * a-z (lowercase), 0-9, and _ (underscore).
1168
- * Dynamic field names must begin or end with a wildcard (*).
1169
- * The wildcard can also be the only character in a dynamic field name.
1170
- * Multiple wildcards, and wildcards embedded within a string are not supported.
1171
- * </p>
1172
- * <p>The name <code>score</code> is reserved and cannot be used as a field name.
1173
- * To reference a document's ID, you can use the name <code>_id</code>.
1174
- * </p>
1175
- */
1176
- SourceField?: string;
1177
-
1178
- /**
1179
- * <p>Whether the contents of the field can be returned in the search results.</p>
1180
- */
1181
- ReturnEnabled?: boolean;
1182
-
1183
- /**
1184
- * <p>Whether the field can be used to sort the search results.</p>
1185
- */
1186
- SortEnabled?: boolean;
1187
-
1188
- /**
1189
- * <p>Whether highlights can be returned for the field.</p>
1190
- */
1191
- HighlightEnabled?: boolean;
1192
-
1193
- /**
1194
- * <p>The name of an analysis scheme for a <code>text</code> field.</p>
1195
- */
1196
- AnalysisScheme?: string;
1197
- }
1198
-
1199
- export namespace TextOptions {
1200
- /**
1201
- * @internal
1202
- */
1203
- export const filterSensitiveLog = (obj: TextOptions): any => ({
1204
- ...obj,
1205
- });
1206
- }
1207
-
1208
- /**
1209
- * <p>Configuration information for a field in the index, including its name, type, and options. The supported options depend on the <code><a>IndexFieldType</a></code>.</p>
1210
- */
1211
- export interface IndexField {
1212
- /**
1213
- * <p>A string that represents the name of an index field. CloudSearch supports regular index fields as well as dynamic fields.
1214
- * A dynamic field's name defines a pattern that begins or ends with a wildcard.
1215
- * Any document fields that don't map to a regular index field but do match a
1216
- * dynamic field's pattern are configured with the dynamic field's indexing options.
1217
- * </p>
1218
- * <p>Regular field names begin with a letter and can contain the following characters:
1219
- * a-z (lowercase), 0-9, and _ (underscore).
1220
- * Dynamic field names must begin or end with a wildcard (*).
1221
- * The wildcard can also be the only character in a dynamic field name.
1222
- * Multiple wildcards, and wildcards embedded within a string are not supported.
1223
- * </p>
1224
- * <p>The name <code>score</code> is reserved and cannot be used as a field name.
1225
- * To reference a document's ID, you can use the name <code>_id</code>.
1226
- * </p>
1227
- */
1228
- IndexFieldName: string | undefined;
1229
-
1230
- /**
1231
- * <p>The type of field. The valid options for a field depend on the field type. For more information about the supported field types, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-index-fields.html" target="_blank">Configuring Index Fields</a> in the <i>Amazon CloudSearch Developer Guide</i>.</p>
1232
- */
1233
- IndexFieldType: IndexFieldType | string | undefined;
1234
-
1235
- /**
1236
- * <p>Options for a 64-bit signed integer field. Present if <code>IndexFieldType</code> specifies the field is of type <code>int</code>. All options are enabled by default.</p>
1237
- */
1238
- IntOptions?: IntOptions;
1239
-
1240
- /**
1241
- * <p>Options for a double-precision 64-bit floating point field. Present if <code>IndexFieldType</code> specifies the field is of type <code>double</code>. All options are enabled by default.</p>
1242
- */
1243
- DoubleOptions?: DoubleOptions;
1244
-
1245
- /**
1246
- * <p>Options for literal field. Present if <code>IndexFieldType</code> specifies the field is of type <code>literal</code>. All options are enabled by default.</p>
1247
- */
1248
- LiteralOptions?: LiteralOptions;
1249
-
1250
- /**
1251
- * <p>Options for text field. Present if <code>IndexFieldType</code> specifies the field is of type <code>text</code>. A <code>text</code> field is always searchable. All options are enabled by default.</p>
1252
- */
1253
- TextOptions?: TextOptions;
1254
-
1255
- /**
1256
- * <p>Options for a date field. Dates and times are specified in UTC (Coordinated Universal Time) according to IETF RFC3339: yyyy-mm-ddT00:00:00Z. Present if <code>IndexFieldType</code> specifies the field is of type <code>date</code>. All options are enabled by default.</p>
1257
- */
1258
- DateOptions?: DateOptions;
1259
-
1260
- /**
1261
- * <p>Options for a latlon field. A latlon field contains a location stored as a latitude and longitude value pair. Present if <code>IndexFieldType</code> specifies the field is of type <code>latlon</code>. All options are enabled by default.</p>
1262
- */
1263
- LatLonOptions?: LatLonOptions;
1264
-
1265
- /**
1266
- * <p>Options for a field that contains an array of 64-bit signed integers. Present if <code>IndexFieldType</code> specifies the field is of type <code>int-array</code>. All options are enabled by default.</p>
1267
- */
1268
- IntArrayOptions?: IntArrayOptions;
1269
-
1270
- /**
1271
- * <p>Options for a field that contains an array of double-precision 64-bit floating point values. Present if <code>IndexFieldType</code> specifies the field is of type <code>double-array</code>. All options are enabled by default.</p>
1272
- */
1273
- DoubleArrayOptions?: DoubleArrayOptions;
1274
-
1275
- /**
1276
- * <p>Options for a field that contains an array of literal strings. Present if <code>IndexFieldType</code> specifies the field is of type <code>literal-array</code>. All options are enabled by default.</p>
1277
- */
1278
- LiteralArrayOptions?: LiteralArrayOptions;
1279
-
1280
- /**
1281
- * <p>Options for a field that contains an array of text strings. Present if <code>IndexFieldType</code> specifies the field is of type <code>text-array</code>. A <code>text-array</code> field is always searchable. All options are enabled by default.</p>
1282
- */
1283
- TextArrayOptions?: TextArrayOptions;
1284
-
1285
- /**
1286
- * <p>Options for a field that contains an array of dates. Present if <code>IndexFieldType</code> specifies the field is of type <code>date-array</code>. All options are enabled by default.</p>
1287
- */
1288
- DateArrayOptions?: DateArrayOptions;
1289
- }
1290
-
1291
- export namespace IndexField {
1292
- /**
1293
- * @internal
1294
- */
1295
- export const filterSensitiveLog = (obj: IndexField): any => ({
1296
- ...obj,
1297
- });
1298
- }
1299
-
1300
- /**
1301
- * <p>Container for the parameters to the <code><a>DefineIndexField</a></code> operation. Specifies the name of the domain you want to update and the index field configuration.</p>
1302
- */
1303
- export interface DefineIndexFieldRequest {
1304
- /**
1305
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
1306
- */
1307
- DomainName: string | undefined;
1308
-
1309
- /**
1310
- * <p>The index field and field options you want to configure. </p>
1311
- */
1312
- IndexField: IndexField | undefined;
1313
- }
1314
-
1315
- export namespace DefineIndexFieldRequest {
1316
- /**
1317
- * @internal
1318
- */
1319
- export const filterSensitiveLog = (obj: DefineIndexFieldRequest): any => ({
1320
- ...obj,
1321
- });
1322
- }
1323
-
1324
- /**
1325
- * <p>The value of an <code>IndexField</code> and its current status.</p>
1326
- */
1327
- export interface IndexFieldStatus {
1328
- /**
1329
- * <p>Configuration information for a field in the index, including its name, type, and options. The supported options depend on the <code><a>IndexFieldType</a></code>.</p>
1330
- */
1331
- Options: IndexField | undefined;
1332
-
1333
- /**
1334
- * <p>The status of domain configuration option.</p>
1335
- */
1336
- Status: OptionStatus | undefined;
1337
- }
1338
-
1339
- export namespace IndexFieldStatus {
1340
- /**
1341
- * @internal
1342
- */
1343
- export const filterSensitiveLog = (obj: IndexFieldStatus): any => ({
1344
- ...obj,
1345
- });
1346
- }
1347
-
1348
- /**
1349
- * <p>The result of a <code><a>DefineIndexField</a></code> request. Contains the status of the newly-configured index field.</p>
1350
- */
1351
- export interface DefineIndexFieldResponse {
1352
- /**
1353
- * <p>The value of an <code>IndexField</code> and its current status.</p>
1354
- */
1355
- IndexField: IndexFieldStatus | undefined;
1356
- }
1357
-
1358
- export namespace DefineIndexFieldResponse {
1359
- /**
1360
- * @internal
1361
- */
1362
- export const filterSensitiveLog = (obj: DefineIndexFieldResponse): any => ({
1363
- ...obj,
1364
- });
1365
- }
1366
-
1367
- export type SuggesterFuzzyMatching = "high" | "low" | "none";
1368
-
1369
- /**
1370
- * <p>Options for a search suggester.</p>
1371
- */
1372
- export interface DocumentSuggesterOptions {
1373
- /**
1374
- * <p>The name of the index field you want to use for suggestions.
1375
- * </p>
1376
- */
1377
- SourceField: string | undefined;
1378
-
1379
- /**
1380
- * <p>The level of fuzziness allowed when suggesting matches for a string: <code>none</code>, <code>low</code>, or <code>high</code>. With none, the specified string is treated as an exact prefix. With low, suggestions must differ from the specified string by no more than one character. With high, suggestions can differ by up to two characters. The default is none. </p>
1381
- */
1382
- FuzzyMatching?: SuggesterFuzzyMatching | string;
1383
-
1384
- /**
1385
- * <p>An expression that computes a score for each suggestion to control how they are sorted. The scores are rounded to the nearest
1386
- * integer, with a floor of 0 and a ceiling of 2^31-1. A document's relevance score is not computed
1387
- * for suggestions, so sort expressions cannot reference the <code>_score</code> value.
1388
- * To sort suggestions using a numeric field or existing expression, simply specify
1389
- * the name of the field or expression. If no expression is configured for the suggester, the
1390
- * suggestions are sorted with the closest matches listed first.</p>
1391
- */
1392
- SortExpression?: string;
1393
- }
1394
-
1395
- export namespace DocumentSuggesterOptions {
1396
- /**
1397
- * @internal
1398
- */
1399
- export const filterSensitiveLog = (obj: DocumentSuggesterOptions): any => ({
1400
- ...obj,
1401
- });
1402
- }
1403
-
1404
- /**
1405
- * <p>Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: <code>FuzzyMatching</code>, <code>SortExpression</code>. </p>
1406
- */
1407
- export interface Suggester {
1408
- /**
1409
- * <p>Names must begin with a letter and can contain the following characters:
1410
- * a-z (lowercase), 0-9, and _ (underscore).</p>
1411
- */
1412
- SuggesterName: string | undefined;
1413
-
1414
- /**
1415
- * <p>Options for a search suggester.</p>
1416
- */
1417
- DocumentSuggesterOptions: DocumentSuggesterOptions | undefined;
1418
- }
1419
-
1420
- export namespace Suggester {
1421
- /**
1422
- * @internal
1423
- */
1424
- export const filterSensitiveLog = (obj: Suggester): any => ({
1425
- ...obj,
1426
- });
1427
- }
1428
-
1429
- /**
1430
- * <p>Container for the parameters to the <code><a>DefineSuggester</a></code> operation. Specifies the name of the domain you want to update and the suggester configuration.</p>
1431
- */
1432
- export interface DefineSuggesterRequest {
1433
- /**
1434
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
1435
- */
1436
- DomainName: string | undefined;
1437
-
1438
- /**
1439
- * <p>Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: <code>FuzzyMatching</code>, <code>SortExpression</code>. </p>
1440
- */
1441
- Suggester: Suggester | undefined;
1442
- }
1443
-
1444
- export namespace DefineSuggesterRequest {
1445
- /**
1446
- * @internal
1447
- */
1448
- export const filterSensitiveLog = (obj: DefineSuggesterRequest): any => ({
1449
- ...obj,
1450
- });
1451
- }
1452
-
1453
- /**
1454
- * <p>The value of a <code>Suggester</code> and its current status.</p>
1455
- */
1456
- export interface SuggesterStatus {
1457
- /**
1458
- * <p>Configuration information for a search suggester. Each suggester has a unique name and specifies the text field you want to use for suggestions. The following options can be configured for a suggester: <code>FuzzyMatching</code>, <code>SortExpression</code>. </p>
1459
- */
1460
- Options: Suggester | undefined;
1461
-
1462
- /**
1463
- * <p>The status of domain configuration option.</p>
1464
- */
1465
- Status: OptionStatus | undefined;
1466
- }
1467
-
1468
- export namespace SuggesterStatus {
1469
- /**
1470
- * @internal
1471
- */
1472
- export const filterSensitiveLog = (obj: SuggesterStatus): any => ({
1473
- ...obj,
1474
- });
1475
- }
1476
-
1477
- /**
1478
- * <p>The result of a <code>DefineSuggester</code> request. Contains the status of the newly-configured suggester.</p>
1479
- */
1480
- export interface DefineSuggesterResponse {
1481
- /**
1482
- * <p>The value of a <code>Suggester</code> and its current status.</p>
1483
- */
1484
- Suggester: SuggesterStatus | undefined;
1485
- }
1486
-
1487
- export namespace DefineSuggesterResponse {
1488
- /**
1489
- * @internal
1490
- */
1491
- export const filterSensitiveLog = (obj: DefineSuggesterResponse): any => ({
1492
- ...obj,
1493
- });
1494
- }
1495
-
1496
- /**
1497
- * <p>Container for the parameters to the <code><a>DeleteAnalysisScheme</a></code> operation. Specifies the name of the domain you want to update and the analysis scheme you want to delete. </p>
1498
- */
1499
- export interface DeleteAnalysisSchemeRequest {
1500
- /**
1501
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
1502
- */
1503
- DomainName: string | undefined;
1504
-
1505
- /**
1506
- * <p>The name of the analysis scheme you want to delete.</p>
1507
- */
1508
- AnalysisSchemeName: string | undefined;
1509
- }
1510
-
1511
- export namespace DeleteAnalysisSchemeRequest {
1512
- /**
1513
- * @internal
1514
- */
1515
- export const filterSensitiveLog = (obj: DeleteAnalysisSchemeRequest): any => ({
1516
- ...obj,
1517
- });
1518
- }
1519
-
1520
- /**
1521
- * <p>The result of a <code>DeleteAnalysisScheme</code> request. Contains the status of the deleted analysis scheme.</p>
1522
- */
1523
- export interface DeleteAnalysisSchemeResponse {
1524
- /**
1525
- * <p>The status of the analysis scheme being deleted.</p>
1526
- */
1527
- AnalysisScheme: AnalysisSchemeStatus | undefined;
1528
- }
1529
-
1530
- export namespace DeleteAnalysisSchemeResponse {
1531
- /**
1532
- * @internal
1533
- */
1534
- export const filterSensitiveLog = (obj: DeleteAnalysisSchemeResponse): any => ({
1535
- ...obj,
1536
- });
1537
- }
1538
-
1539
- /**
1540
- * <p>Container for the parameters to the <code><a>DeleteDomain</a></code> operation. Specifies the name of the domain you want to delete.</p>
1541
- */
1542
- export interface DeleteDomainRequest {
1543
- /**
1544
- * <p>The name of the domain you want to permanently delete.</p>
1545
- */
1546
- DomainName: string | undefined;
1547
- }
1548
-
1549
- export namespace DeleteDomainRequest {
1550
- /**
1551
- * @internal
1552
- */
1553
- export const filterSensitiveLog = (obj: DeleteDomainRequest): any => ({
1554
- ...obj,
1555
- });
1556
- }
1557
-
1558
- /**
1559
- * <p>The result of a <code>DeleteDomain</code> request. Contains the status of a newly deleted domain, or no status if the domain has already been completely deleted.</p>
1560
- */
1561
- export interface DeleteDomainResponse {
1562
- /**
1563
- * <p>The current status of the search domain.</p>
1564
- */
1565
- DomainStatus?: DomainStatus;
1566
- }
1567
-
1568
- export namespace DeleteDomainResponse {
1569
- /**
1570
- * @internal
1571
- */
1572
- export const filterSensitiveLog = (obj: DeleteDomainResponse): any => ({
1573
- ...obj,
1574
- });
1575
- }
1576
-
1577
- /**
1578
- * <p>Container for the parameters to the <code><a>DeleteExpression</a></code> operation. Specifies the name of the domain you want to update and the name of the expression you want to delete.</p>
1579
- */
1580
- export interface DeleteExpressionRequest {
1581
- /**
1582
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
1583
- */
1584
- DomainName: string | undefined;
1585
-
1586
- /**
1587
- * <p>The name of the <code><a>Expression</a></code> to delete.</p>
1588
- */
1589
- ExpressionName: string | undefined;
1590
- }
1591
-
1592
- export namespace DeleteExpressionRequest {
1593
- /**
1594
- * @internal
1595
- */
1596
- export const filterSensitiveLog = (obj: DeleteExpressionRequest): any => ({
1597
- ...obj,
1598
- });
1599
- }
1600
-
1601
- /**
1602
- * <p>The result of a <code><a>DeleteExpression</a></code> request. Specifies the expression being deleted.</p>
1603
- */
1604
- export interface DeleteExpressionResponse {
1605
- /**
1606
- * <p>The status of the expression being deleted.</p>
1607
- */
1608
- Expression: ExpressionStatus | undefined;
1609
- }
1610
-
1611
- export namespace DeleteExpressionResponse {
1612
- /**
1613
- * @internal
1614
- */
1615
- export const filterSensitiveLog = (obj: DeleteExpressionResponse): any => ({
1616
- ...obj,
1617
- });
1618
- }
1619
-
1620
- /**
1621
- * <p>Container for the parameters to the <code><a>DeleteIndexField</a></code> operation. Specifies the name of the domain you want to update and the name of the index field you want to delete.</p>
1622
- */
1623
- export interface DeleteIndexFieldRequest {
1624
- /**
1625
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
1626
- */
1627
- DomainName: string | undefined;
1628
-
1629
- /**
1630
- * <p>The name of the index field your want to remove from the domain's indexing options.</p>
1631
- */
1632
- IndexFieldName: string | undefined;
1633
- }
1634
-
1635
- export namespace DeleteIndexFieldRequest {
1636
- /**
1637
- * @internal
1638
- */
1639
- export const filterSensitiveLog = (obj: DeleteIndexFieldRequest): any => ({
1640
- ...obj,
1641
- });
1642
- }
1643
-
1644
- /**
1645
- * <p>The result of a <code><a>DeleteIndexField</a></code> request.</p>
1646
- */
1647
- export interface DeleteIndexFieldResponse {
1648
- /**
1649
- * <p>The status of the index field being deleted.</p>
1650
- */
1651
- IndexField: IndexFieldStatus | undefined;
1652
- }
1653
-
1654
- export namespace DeleteIndexFieldResponse {
1655
- /**
1656
- * @internal
1657
- */
1658
- export const filterSensitiveLog = (obj: DeleteIndexFieldResponse): any => ({
1659
- ...obj,
1660
- });
1661
- }
1662
-
1663
- /**
1664
- * <p>Container for the parameters to the <code><a>DeleteSuggester</a></code> operation. Specifies the name of the domain you want to update and name of the suggester you want to delete.</p>
1665
- */
1666
- export interface DeleteSuggesterRequest {
1667
- /**
1668
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
1669
- */
1670
- DomainName: string | undefined;
1671
-
1672
- /**
1673
- * <p>Specifies the name of the suggester you want to delete.</p>
1674
- */
1675
- SuggesterName: string | undefined;
1676
- }
1677
-
1678
- export namespace DeleteSuggesterRequest {
1679
- /**
1680
- * @internal
1681
- */
1682
- export const filterSensitiveLog = (obj: DeleteSuggesterRequest): any => ({
1683
- ...obj,
1684
- });
1685
- }
1686
-
1687
- /**
1688
- * <p>The result of a <code>DeleteSuggester</code> request. Contains the status of the deleted suggester.</p>
1689
- */
1690
- export interface DeleteSuggesterResponse {
1691
- /**
1692
- * <p>The status of the suggester being deleted.</p>
1693
- */
1694
- Suggester: SuggesterStatus | undefined;
1695
- }
1696
-
1697
- export namespace DeleteSuggesterResponse {
1698
- /**
1699
- * @internal
1700
- */
1701
- export const filterSensitiveLog = (obj: DeleteSuggesterResponse): any => ({
1702
- ...obj,
1703
- });
1704
- }
1705
-
1706
- /**
1707
- * <p>Container for the parameters to the <code><a>DescribeAnalysisSchemes</a></code> operation. Specifies the name of the domain you want to describe. To limit the response to particular analysis schemes, specify the names of the analysis schemes you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>. </p>
1708
- */
1709
- export interface DescribeAnalysisSchemesRequest {
1710
- /**
1711
- * <p>The name of the domain you want to describe.</p>
1712
- */
1713
- DomainName: string | undefined;
1714
-
1715
- /**
1716
- * <p>The analysis schemes you want to describe.</p>
1717
- */
1718
- AnalysisSchemeNames?: string[];
1719
-
1720
- /**
1721
- * <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
1722
- */
1723
- Deployed?: boolean;
1724
- }
1725
-
1726
- export namespace DescribeAnalysisSchemesRequest {
1727
- /**
1728
- * @internal
1729
- */
1730
- export const filterSensitiveLog = (obj: DescribeAnalysisSchemesRequest): any => ({
1731
- ...obj,
1732
- });
1733
- }
1734
-
1735
- /**
1736
- * <p>The result of a <code>DescribeAnalysisSchemes</code> request. Contains the analysis schemes configured for the domain specified in the request.</p>
1737
- */
1738
- export interface DescribeAnalysisSchemesResponse {
1739
- /**
1740
- * <p>The analysis scheme descriptions.</p>
1741
- */
1742
- AnalysisSchemes: AnalysisSchemeStatus[] | undefined;
1743
- }
1744
-
1745
- export namespace DescribeAnalysisSchemesResponse {
1746
- /**
1747
- * @internal
1748
- */
1749
- export const filterSensitiveLog = (obj: DescribeAnalysisSchemesResponse): any => ({
1750
- ...obj,
1751
- });
1752
- }
1753
-
1754
- /**
1755
- * <p>Container for the parameters to the <code><a>DescribeAvailabilityOptions</a></code> operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to <code>true</code>.</p>
1756
- */
1757
- export interface DescribeAvailabilityOptionsRequest {
1758
- /**
1759
- * <p>The name of the domain you want to describe.</p>
1760
- */
1761
- DomainName: string | undefined;
1762
-
1763
- /**
1764
- * <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
1765
- */
1766
- Deployed?: boolean;
1767
- }
1768
-
1769
- export namespace DescribeAvailabilityOptionsRequest {
1770
- /**
1771
- * @internal
1772
- */
1773
- export const filterSensitiveLog = (obj: DescribeAvailabilityOptionsRequest): any => ({
1774
- ...obj,
1775
- });
1776
- }
1777
-
1778
- /**
1779
- * <p>The status and configuration of the domain's availability options.</p>
1780
- */
1781
- export interface AvailabilityOptionsStatus {
1782
- /**
1783
- * <p>The availability options configured for the domain.</p>
1784
- */
1785
- Options: boolean | undefined;
1786
-
1787
- /**
1788
- * <p>The status of domain configuration option.</p>
1789
- */
1790
- Status: OptionStatus | undefined;
1791
- }
1792
-
1793
- export namespace AvailabilityOptionsStatus {
1794
- /**
1795
- * @internal
1796
- */
1797
- export const filterSensitiveLog = (obj: AvailabilityOptionsStatus): any => ({
1798
- ...obj,
1799
- });
1800
- }
1801
-
1802
- /**
1803
- * <p>The result of a <code>DescribeAvailabilityOptions</code> request. Indicates whether or not the Multi-AZ option is enabled for the domain specified in the request. </p>
1804
- */
1805
- export interface DescribeAvailabilityOptionsResponse {
1806
- /**
1807
- * <p>The availability options configured for the domain. Indicates whether Multi-AZ is enabled for the domain. </p>
1808
- */
1809
- AvailabilityOptions?: AvailabilityOptionsStatus;
1810
- }
1811
-
1812
- export namespace DescribeAvailabilityOptionsResponse {
1813
- /**
1814
- * @internal
1815
- */
1816
- export const filterSensitiveLog = (obj: DescribeAvailabilityOptionsResponse): any => ({
1817
- ...obj,
1818
- });
1819
- }
1820
-
1821
- /**
1822
- * <p>The request was rejected because it attempted an operation which is not enabled.</p>
1823
- */
1824
- export interface DisabledOperationException extends __SmithyException, $MetadataBearer {
1825
- name: "DisabledOperationException";
1826
- $fault: "client";
1827
- /**
1828
- * <p>A machine-parsable string error or warning code.</p>
1829
- */
1830
- Code?: string;
1831
-
1832
- /**
1833
- * <p>A human-readable string error or warning message.</p>
1834
- */
1835
- Message?: string;
1836
- }
1837
-
1838
- export namespace DisabledOperationException {
1839
- /**
1840
- * @internal
1841
- */
1842
- export const filterSensitiveLog = (obj: DisabledOperationException): any => ({
1843
- ...obj,
1844
- });
1845
- }
1846
-
1847
- /**
1848
- * <p>Container for the parameters to the <code><a>DescribeDomainEndpointOptions</a></code> operation. Specify the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the Deployed option to <code>true</code>.</p>
1849
- */
1850
- export interface DescribeDomainEndpointOptionsRequest {
1851
- /**
1852
- * <p>A string that represents the name of a domain.</p>
1853
- */
1854
- DomainName: string | undefined;
1855
-
1856
- /**
1857
- * <p>Whether to retrieve the latest configuration (which might be in a Processing state) or the current, active configuration. Defaults to <code>false</code>.</p>
1858
- */
1859
- Deployed?: boolean;
1860
- }
1861
-
1862
- export namespace DescribeDomainEndpointOptionsRequest {
1863
- /**
1864
- * @internal
1865
- */
1866
- export const filterSensitiveLog = (obj: DescribeDomainEndpointOptionsRequest): any => ({
1867
- ...obj,
1868
- });
1869
- }
1870
-
1871
- export enum TLSSecurityPolicy {
1872
- POLICY_MIN_TLS_1_0_2019_07 = "Policy-Min-TLS-1-0-2019-07",
1873
- POLICY_MIN_TLS_1_2_2019_07 = "Policy-Min-TLS-1-2-2019-07",
1874
- }
1875
-
1876
- /**
1877
- * <p>The domain's endpoint options.</p>
1878
- */
1879
- export interface DomainEndpointOptions {
1880
- /**
1881
- * <p>Whether the domain is HTTPS only enabled.</p>
1882
- */
1883
- EnforceHTTPS?: boolean;
1884
-
1885
- /**
1886
- * <p>The minimum required TLS version</p>
1887
- */
1888
- TLSSecurityPolicy?: TLSSecurityPolicy | string;
1889
- }
1890
-
1891
- export namespace DomainEndpointOptions {
1892
- /**
1893
- * @internal
1894
- */
1895
- export const filterSensitiveLog = (obj: DomainEndpointOptions): any => ({
1896
- ...obj,
1897
- });
1898
- }
1899
-
1900
- /**
1901
- * <p>The configuration and status of the domain's endpoint options.</p>
1902
- */
1903
- export interface DomainEndpointOptionsStatus {
1904
- /**
1905
- * <p>The domain endpoint options configured for the domain.</p>
1906
- */
1907
- Options: DomainEndpointOptions | undefined;
1908
-
1909
- /**
1910
- * <p>The status of the configured domain endpoint options.</p>
1911
- */
1912
- Status: OptionStatus | undefined;
1913
- }
1914
-
1915
- export namespace DomainEndpointOptionsStatus {
1916
- /**
1917
- * @internal
1918
- */
1919
- export const filterSensitiveLog = (obj: DomainEndpointOptionsStatus): any => ({
1920
- ...obj,
1921
- });
1922
- }
1923
-
1924
- /**
1925
- * <p>The result of a <code>DescribeDomainEndpointOptions</code> request. Contains the status and configuration of a search domain's endpoint options. </p>
1926
- */
1927
- export interface DescribeDomainEndpointOptionsResponse {
1928
- /**
1929
- * <p>The status and configuration of a search domain's endpoint options.</p>
1930
- */
1931
- DomainEndpointOptions?: DomainEndpointOptionsStatus;
1932
- }
1933
-
1934
- export namespace DescribeDomainEndpointOptionsResponse {
1935
- /**
1936
- * @internal
1937
- */
1938
- export const filterSensitiveLog = (obj: DescribeDomainEndpointOptionsResponse): any => ({
1939
- ...obj,
1940
- });
1941
- }
1942
-
1943
- /**
1944
- * <p>Container for the parameters to the <code><a>DescribeDomains</a></code> operation. By default shows the status of all domains. To restrict the response to particular domains, specify the names of the domains you want to describe.</p>
1945
- */
1946
- export interface DescribeDomainsRequest {
1947
- /**
1948
- * <p>The names of the domains you want to include in the response.</p>
1949
- */
1950
- DomainNames?: string[];
1951
- }
1952
-
1953
- export namespace DescribeDomainsRequest {
1954
- /**
1955
- * @internal
1956
- */
1957
- export const filterSensitiveLog = (obj: DescribeDomainsRequest): any => ({
1958
- ...obj,
1959
- });
1960
- }
1961
-
1962
- /**
1963
- * <p>The result of a <code>DescribeDomains</code> request. Contains the status of the domains specified in the request or all domains owned by the account.</p>
1964
- */
1965
- export interface DescribeDomainsResponse {
1966
- /**
1967
- * <p>A list that contains the status of each requested domain.</p>
1968
- */
1969
- DomainStatusList: DomainStatus[] | undefined;
1970
- }
1971
-
1972
- export namespace DescribeDomainsResponse {
1973
- /**
1974
- * @internal
1975
- */
1976
- export const filterSensitiveLog = (obj: DescribeDomainsResponse): any => ({
1977
- ...obj,
1978
- });
1979
- }
1980
-
1981
- /**
1982
- * <p>Container for the parameters to the <code><a>DescribeDomains</a></code> operation.
1983
- * Specifies the name of the domain you want to describe. To restrict the response to particular expressions, specify the names of the expressions you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>
1984
- */
1985
- export interface DescribeExpressionsRequest {
1986
- /**
1987
- * <p>The name of the domain you want to describe.</p>
1988
- */
1989
- DomainName: string | undefined;
1990
-
1991
- /**
1992
- * <p>Limits the <code><a>DescribeExpressions</a></code> response to the specified expressions. If not specified, all expressions are shown.</p>
1993
- */
1994
- ExpressionNames?: string[];
1995
-
1996
- /**
1997
- * <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
1998
- */
1999
- Deployed?: boolean;
2000
- }
2001
-
2002
- export namespace DescribeExpressionsRequest {
2003
- /**
2004
- * @internal
2005
- */
2006
- export const filterSensitiveLog = (obj: DescribeExpressionsRequest): any => ({
2007
- ...obj,
2008
- });
2009
- }
2010
-
2011
- /**
2012
- * <p>The result of a <code>DescribeExpressions</code> request. Contains the expressions configured for the domain specified in the request.</p>
2013
- */
2014
- export interface DescribeExpressionsResponse {
2015
- /**
2016
- * <p>The expressions configured for the domain.</p>
2017
- */
2018
- Expressions: ExpressionStatus[] | undefined;
2019
- }
2020
-
2021
- export namespace DescribeExpressionsResponse {
2022
- /**
2023
- * @internal
2024
- */
2025
- export const filterSensitiveLog = (obj: DescribeExpressionsResponse): any => ({
2026
- ...obj,
2027
- });
2028
- }
2029
-
2030
- /**
2031
- * <p>Container for the parameters to the <code><a>DescribeIndexFields</a></code> operation. Specifies the name of the domain you want to describe. To restrict the response to particular index fields, specify the names of the index fields you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>
2032
- */
2033
- export interface DescribeIndexFieldsRequest {
2034
- /**
2035
- * <p>The name of the domain you want to describe.</p>
2036
- */
2037
- DomainName: string | undefined;
2038
-
2039
- /**
2040
- * <p>A list of the index fields you want to describe. If not specified, information is returned for all configured index fields.</p>
2041
- */
2042
- FieldNames?: string[];
2043
-
2044
- /**
2045
- * <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
2046
- */
2047
- Deployed?: boolean;
2048
- }
2049
-
2050
- export namespace DescribeIndexFieldsRequest {
2051
- /**
2052
- * @internal
2053
- */
2054
- export const filterSensitiveLog = (obj: DescribeIndexFieldsRequest): any => ({
2055
- ...obj,
2056
- });
2057
- }
2058
-
2059
- /**
2060
- * <p>The result of a <code>DescribeIndexFields</code> request. Contains the index fields configured for the domain specified in the request.</p>
2061
- */
2062
- export interface DescribeIndexFieldsResponse {
2063
- /**
2064
- * <p>The index fields configured for the domain.</p>
2065
- */
2066
- IndexFields: IndexFieldStatus[] | undefined;
2067
- }
2068
-
2069
- export namespace DescribeIndexFieldsResponse {
2070
- /**
2071
- * @internal
2072
- */
2073
- export const filterSensitiveLog = (obj: DescribeIndexFieldsResponse): any => ({
2074
- ...obj,
2075
- });
2076
- }
2077
-
2078
- /**
2079
- * <p>Container for the parameters to the <code><a>DescribeScalingParameters</a></code> operation. Specifies the name of the domain you want to describe. </p>
2080
- */
2081
- export interface DescribeScalingParametersRequest {
2082
- /**
2083
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
2084
- */
2085
- DomainName: string | undefined;
2086
- }
2087
-
2088
- export namespace DescribeScalingParametersRequest {
2089
- /**
2090
- * @internal
2091
- */
2092
- export const filterSensitiveLog = (obj: DescribeScalingParametersRequest): any => ({
2093
- ...obj,
2094
- });
2095
- }
2096
-
2097
- export type PartitionInstanceType =
2098
- | "search.2xlarge"
2099
- | "search.large"
2100
- | "search.m1.large"
2101
- | "search.m1.small"
2102
- | "search.m2.2xlarge"
2103
- | "search.m2.xlarge"
2104
- | "search.m3.2xlarge"
2105
- | "search.m3.large"
2106
- | "search.m3.medium"
2107
- | "search.m3.xlarge"
2108
- | "search.medium"
2109
- | "search.previousgeneration.2xlarge"
2110
- | "search.previousgeneration.large"
2111
- | "search.previousgeneration.small"
2112
- | "search.previousgeneration.xlarge"
2113
- | "search.small"
2114
- | "search.xlarge";
2115
-
2116
- /**
2117
- * <p>The desired instance type and desired number of replicas of each index partition.</p>
2118
- */
2119
- export interface ScalingParameters {
2120
- /**
2121
- * <p>The instance type that you want to preconfigure for your domain. For example, <code>search.m1.small</code>.</p>
2122
- */
2123
- DesiredInstanceType?: PartitionInstanceType | string;
2124
-
2125
- /**
2126
- * <p>The number of replicas you want to preconfigure for each index partition.</p>
2127
- */
2128
- DesiredReplicationCount?: number;
2129
-
2130
- /**
2131
- * <p>The number of partitions you want to preconfigure for your domain. Only valid when
2132
- * you select <code>m2.2xlarge</code> as the desired instance type.</p>
2133
- */
2134
- DesiredPartitionCount?: number;
2135
- }
2136
-
2137
- export namespace ScalingParameters {
2138
- /**
2139
- * @internal
2140
- */
2141
- export const filterSensitiveLog = (obj: ScalingParameters): any => ({
2142
- ...obj,
2143
- });
2144
- }
2145
-
2146
- /**
2147
- * <p>The status and configuration of a search domain's scaling parameters. </p>
2148
- */
2149
- export interface ScalingParametersStatus {
2150
- /**
2151
- * <p>The desired instance type and desired number of replicas of each index partition.</p>
2152
- */
2153
- Options: ScalingParameters | undefined;
2154
-
2155
- /**
2156
- * <p>The status of domain configuration option.</p>
2157
- */
2158
- Status: OptionStatus | undefined;
2159
- }
2160
-
2161
- export namespace ScalingParametersStatus {
2162
- /**
2163
- * @internal
2164
- */
2165
- export const filterSensitiveLog = (obj: ScalingParametersStatus): any => ({
2166
- ...obj,
2167
- });
2168
- }
2169
-
2170
- /**
2171
- * <p>The result of a <code>DescribeScalingParameters</code> request. Contains the scaling parameters configured for the domain specified in the request.</p>
2172
- */
2173
- export interface DescribeScalingParametersResponse {
2174
- /**
2175
- * <p>The status and configuration of a search domain's scaling parameters. </p>
2176
- */
2177
- ScalingParameters: ScalingParametersStatus | undefined;
2178
- }
2179
-
2180
- export namespace DescribeScalingParametersResponse {
2181
- /**
2182
- * @internal
2183
- */
2184
- export const filterSensitiveLog = (obj: DescribeScalingParametersResponse): any => ({
2185
- ...obj,
2186
- });
2187
- }
2188
-
2189
- /**
2190
- * <p>Container for the parameters to the <code><a>DescribeServiceAccessPolicies</a></code> operation. Specifies the name of the domain you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>
2191
- */
2192
- export interface DescribeServiceAccessPoliciesRequest {
2193
- /**
2194
- * <p>The name of the domain you want to describe.</p>
2195
- */
2196
- DomainName: string | undefined;
2197
-
2198
- /**
2199
- * <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
2200
- */
2201
- Deployed?: boolean;
2202
- }
2203
-
2204
- export namespace DescribeServiceAccessPoliciesRequest {
2205
- /**
2206
- * @internal
2207
- */
2208
- export const filterSensitiveLog = (obj: DescribeServiceAccessPoliciesRequest): any => ({
2209
- ...obj,
2210
- });
2211
- }
2212
-
2213
- /**
2214
- * <p>The configured access rules for the domain's document and search endpoints, and the current status of those rules.</p>
2215
- */
2216
- export interface AccessPoliciesStatus {
2217
- /**
2218
- * <p>Access rules for a domain's document or search service endpoints. For more information, see <a href="http://docs.aws.amazon.com/cloudsearch/latest/developerguide/configuring-access.html" target="_blank">Configuring Access for a Search Domain</a> in the <i>Amazon CloudSearch Developer Guide</i>. The maximum size of a policy document is 100 KB.</p>
2219
- */
2220
- Options: string | undefined;
2221
-
2222
- /**
2223
- * <p>The status of domain configuration option.</p>
2224
- */
2225
- Status: OptionStatus | undefined;
2226
- }
2227
-
2228
- export namespace AccessPoliciesStatus {
2229
- /**
2230
- * @internal
2231
- */
2232
- export const filterSensitiveLog = (obj: AccessPoliciesStatus): any => ({
2233
- ...obj,
2234
- });
2235
- }
2236
-
2237
- /**
2238
- * <p>The result of a <code>DescribeServiceAccessPolicies</code> request.</p>
2239
- */
2240
- export interface DescribeServiceAccessPoliciesResponse {
2241
- /**
2242
- * <p>The access rules configured for the domain specified in the request.</p>
2243
- */
2244
- AccessPolicies: AccessPoliciesStatus | undefined;
2245
- }
2246
-
2247
- export namespace DescribeServiceAccessPoliciesResponse {
2248
- /**
2249
- * @internal
2250
- */
2251
- export const filterSensitiveLog = (obj: DescribeServiceAccessPoliciesResponse): any => ({
2252
- ...obj,
2253
- });
2254
- }
2255
-
2256
- /**
2257
- * <p>Container for the parameters to the <code><a>DescribeSuggester</a></code> operation. Specifies the name of the domain you want to describe. To restrict the response to particular suggesters, specify the names of the suggesters you want to describe. To show the active configuration and exclude any pending changes, set the <code>Deployed</code> option to <code>true</code>.</p>
2258
- */
2259
- export interface DescribeSuggestersRequest {
2260
- /**
2261
- * <p>The name of the domain you want to describe.</p>
2262
- */
2263
- DomainName: string | undefined;
2264
-
2265
- /**
2266
- * <p>The suggesters you want to describe.</p>
2267
- */
2268
- SuggesterNames?: string[];
2269
-
2270
- /**
2271
- * <p>Whether to display the deployed configuration (<code>true</code>) or include any pending changes (<code>false</code>). Defaults to <code>false</code>.</p>
2272
- */
2273
- Deployed?: boolean;
2274
- }
2275
-
2276
- export namespace DescribeSuggestersRequest {
2277
- /**
2278
- * @internal
2279
- */
2280
- export const filterSensitiveLog = (obj: DescribeSuggestersRequest): any => ({
2281
- ...obj,
2282
- });
2283
- }
2284
-
2285
- /**
2286
- * <p>The result of a <code>DescribeSuggesters</code> request.</p>
2287
- */
2288
- export interface DescribeSuggestersResponse {
2289
- /**
2290
- * <p>The suggesters configured for the domain specified in the request.</p>
2291
- */
2292
- Suggesters: SuggesterStatus[] | undefined;
2293
- }
2294
-
2295
- export namespace DescribeSuggestersResponse {
2296
- /**
2297
- * @internal
2298
- */
2299
- export const filterSensitiveLog = (obj: DescribeSuggestersResponse): any => ({
2300
- ...obj,
2301
- });
2302
- }
2303
-
2304
- /**
2305
- * <p>Container for the parameters to the <code><a>IndexDocuments</a></code> operation. Specifies the name of the domain you want to re-index.</p>
2306
- */
2307
- export interface IndexDocumentsRequest {
2308
- /**
2309
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
2310
- */
2311
- DomainName: string | undefined;
2312
- }
2313
-
2314
- export namespace IndexDocumentsRequest {
2315
- /**
2316
- * @internal
2317
- */
2318
- export const filterSensitiveLog = (obj: IndexDocumentsRequest): any => ({
2319
- ...obj,
2320
- });
2321
- }
2322
-
2323
- /**
2324
- * <p>The result of an <code>IndexDocuments</code> request. Contains the status of the indexing operation, including the fields being indexed.</p>
2325
- */
2326
- export interface IndexDocumentsResponse {
2327
- /**
2328
- * <p>The names of the fields that are currently being indexed.</p>
2329
- */
2330
- FieldNames?: string[];
2331
- }
2332
-
2333
- export namespace IndexDocumentsResponse {
2334
- /**
2335
- * @internal
2336
- */
2337
- export const filterSensitiveLog = (obj: IndexDocumentsResponse): any => ({
2338
- ...obj,
2339
- });
2340
- }
2341
-
2342
- /**
2343
- * <p>The result of a <code>ListDomainNames</code> request. Contains a list of the domains owned by an account.</p>
2344
- */
2345
- export interface ListDomainNamesResponse {
2346
- /**
2347
- * <p>The names of the search domains owned by an account.</p>
2348
- */
2349
- DomainNames?: { [key: string]: string };
2350
- }
2351
-
2352
- export namespace ListDomainNamesResponse {
2353
- /**
2354
- * @internal
2355
- */
2356
- export const filterSensitiveLog = (obj: ListDomainNamesResponse): any => ({
2357
- ...obj,
2358
- });
2359
- }
2360
-
2361
- /**
2362
- * <p>Container for the parameters to the <code><a>UpdateAvailabilityOptions</a></code> operation. Specifies the name of the domain you want to update and the Multi-AZ availability option.</p>
2363
- */
2364
- export interface UpdateAvailabilityOptionsRequest {
2365
- /**
2366
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
2367
- */
2368
- DomainName: string | undefined;
2369
-
2370
- /**
2371
- * <p>You expand an existing search domain to a second Availability Zone by setting the Multi-AZ option to true. Similarly, you can turn off the Multi-AZ option to downgrade the domain to a single Availability Zone by setting the Multi-AZ option to <code>false</code>. </p>
2372
- */
2373
- MultiAZ: boolean | undefined;
2374
- }
2375
-
2376
- export namespace UpdateAvailabilityOptionsRequest {
2377
- /**
2378
- * @internal
2379
- */
2380
- export const filterSensitiveLog = (obj: UpdateAvailabilityOptionsRequest): any => ({
2381
- ...obj,
2382
- });
2383
- }
2384
-
2385
- /**
2386
- * <p>The result of a <code>UpdateAvailabilityOptions</code> request. Contains the status of the domain's availability options. </p>
2387
- */
2388
- export interface UpdateAvailabilityOptionsResponse {
2389
- /**
2390
- * <p>The newly-configured availability options. Indicates whether Multi-AZ is enabled for the domain. </p>
2391
- */
2392
- AvailabilityOptions?: AvailabilityOptionsStatus;
2393
- }
2394
-
2395
- export namespace UpdateAvailabilityOptionsResponse {
2396
- /**
2397
- * @internal
2398
- */
2399
- export const filterSensitiveLog = (obj: UpdateAvailabilityOptionsResponse): any => ({
2400
- ...obj,
2401
- });
2402
- }
2403
-
2404
- /**
2405
- * <p>Container for the parameters to the <code><a>UpdateDomainEndpointOptions</a></code> operation. Specifies the name of the domain you want to update and the domain endpoint options.</p>
2406
- */
2407
- export interface UpdateDomainEndpointOptionsRequest {
2408
- /**
2409
- * <p>A string that represents the name of a domain.</p>
2410
- */
2411
- DomainName: string | undefined;
2412
-
2413
- /**
2414
- * <p>Whether to require that all requests to the domain arrive over HTTPS. We recommend Policy-Min-TLS-1-2-2019-07 for TLSSecurityPolicy. For compatibility with older clients, the default is Policy-Min-TLS-1-0-2019-07. </p>
2415
- */
2416
- DomainEndpointOptions: DomainEndpointOptions | undefined;
2417
- }
2418
-
2419
- export namespace UpdateDomainEndpointOptionsRequest {
2420
- /**
2421
- * @internal
2422
- */
2423
- export const filterSensitiveLog = (obj: UpdateDomainEndpointOptionsRequest): any => ({
2424
- ...obj,
2425
- });
2426
- }
2427
-
2428
- /**
2429
- * <p>The result of a <code>UpdateDomainEndpointOptions</code> request. Contains the configuration and status of the domain's endpoint options. </p>
2430
- */
2431
- export interface UpdateDomainEndpointOptionsResponse {
2432
- /**
2433
- * <p>The newly-configured domain endpoint options.</p>
2434
- */
2435
- DomainEndpointOptions?: DomainEndpointOptionsStatus;
2436
- }
2437
-
2438
- export namespace UpdateDomainEndpointOptionsResponse {
2439
- /**
2440
- * @internal
2441
- */
2442
- export const filterSensitiveLog = (obj: UpdateDomainEndpointOptionsResponse): any => ({
2443
- ...obj,
2444
- });
2445
- }
2446
-
2447
- /**
2448
- * <p>Container for the parameters to the <code><a>UpdateScalingParameters</a></code> operation. Specifies the name of the domain you want to update and the scaling parameters you want to configure.</p>
2449
- */
2450
- export interface UpdateScalingParametersRequest {
2451
- /**
2452
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
2453
- */
2454
- DomainName: string | undefined;
2455
-
2456
- /**
2457
- * <p>The desired instance type and desired number of replicas of each index partition.</p>
2458
- */
2459
- ScalingParameters: ScalingParameters | undefined;
2460
- }
2461
-
2462
- export namespace UpdateScalingParametersRequest {
2463
- /**
2464
- * @internal
2465
- */
2466
- export const filterSensitiveLog = (obj: UpdateScalingParametersRequest): any => ({
2467
- ...obj,
2468
- });
2469
- }
2470
-
2471
- /**
2472
- * <p>The result of a <code>UpdateScalingParameters</code> request. Contains the status of the newly-configured scaling parameters.</p>
2473
- */
2474
- export interface UpdateScalingParametersResponse {
2475
- /**
2476
- * <p>The status and configuration of a search domain's scaling parameters. </p>
2477
- */
2478
- ScalingParameters: ScalingParametersStatus | undefined;
2479
- }
2480
-
2481
- export namespace UpdateScalingParametersResponse {
2482
- /**
2483
- * @internal
2484
- */
2485
- export const filterSensitiveLog = (obj: UpdateScalingParametersResponse): any => ({
2486
- ...obj,
2487
- });
2488
- }
2489
-
2490
- /**
2491
- * <p>Container for the parameters to the <code><a>UpdateServiceAccessPolicies</a></code> operation. Specifies the name of the domain you want to update and the access rules you want to configure.</p>
2492
- */
2493
- export interface UpdateServiceAccessPoliciesRequest {
2494
- /**
2495
- * <p>A string that represents the name of a domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).</p>
2496
- */
2497
- DomainName: string | undefined;
2498
-
2499
- /**
2500
- * <p>The access rules you want to configure. These rules replace any existing rules. </p>
2501
- */
2502
- AccessPolicies: string | undefined;
2503
- }
2504
-
2505
- export namespace UpdateServiceAccessPoliciesRequest {
2506
- /**
2507
- * @internal
2508
- */
2509
- export const filterSensitiveLog = (obj: UpdateServiceAccessPoliciesRequest): any => ({
2510
- ...obj,
2511
- });
2512
- }
2513
-
2514
- /**
2515
- * <p>The result of an <code>UpdateServiceAccessPolicies</code> request. Contains the new access policies.</p>
2516
- */
2517
- export interface UpdateServiceAccessPoliciesResponse {
2518
- /**
2519
- * <p>The access rules configured for the domain.</p>
2520
- */
2521
- AccessPolicies: AccessPoliciesStatus | undefined;
2522
- }
2523
-
2524
- export namespace UpdateServiceAccessPoliciesResponse {
2525
- /**
2526
- * @internal
2527
- */
2528
- export const filterSensitiveLog = (obj: UpdateServiceAccessPoliciesResponse): any => ({
2529
- ...obj,
2530
- });
2531
- }