api-2.json 8.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373
  1. {
  2. "version":"2.0",
  3. "metadata":{
  4. "apiVersion":"2013-01-01",
  5. "endpointPrefix":"cloudsearchdomain",
  6. "jsonVersion":"1.1",
  7. "protocol":"rest-json",
  8. "serviceFullName":"Amazon CloudSearch Domain",
  9. "signatureVersion":"v4",
  10. "signingName":"cloudsearch"
  11. },
  12. "operations":{
  13. "Search":{
  14. "name":"Search",
  15. "http":{
  16. "method":"GET",
  17. "requestUri":"/2013-01-01/search?format=sdk&pretty=true"
  18. },
  19. "input":{"shape":"SearchRequest"},
  20. "output":{"shape":"SearchResponse"},
  21. "errors":[
  22. {"shape":"SearchException"}
  23. ]
  24. },
  25. "Suggest":{
  26. "name":"Suggest",
  27. "http":{
  28. "method":"GET",
  29. "requestUri":"/2013-01-01/suggest?format=sdk&pretty=true"
  30. },
  31. "input":{"shape":"SuggestRequest"},
  32. "output":{"shape":"SuggestResponse"},
  33. "errors":[
  34. {"shape":"SearchException"}
  35. ]
  36. },
  37. "UploadDocuments":{
  38. "name":"UploadDocuments",
  39. "http":{
  40. "method":"POST",
  41. "requestUri":"/2013-01-01/documents/batch?format=sdk"
  42. },
  43. "input":{"shape":"UploadDocumentsRequest"},
  44. "output":{"shape":"UploadDocumentsResponse"},
  45. "errors":[
  46. {"shape":"DocumentServiceException"}
  47. ]
  48. }
  49. },
  50. "shapes":{
  51. "Adds":{"type":"long"},
  52. "Blob":{
  53. "type":"blob",
  54. "streaming":true
  55. },
  56. "Bucket":{
  57. "type":"structure",
  58. "members":{
  59. "value":{"shape":"String"},
  60. "count":{"shape":"Long"}
  61. }
  62. },
  63. "BucketInfo":{
  64. "type":"structure",
  65. "members":{
  66. "buckets":{"shape":"BucketList"}
  67. }
  68. },
  69. "BucketList":{
  70. "type":"list",
  71. "member":{"shape":"Bucket"}
  72. },
  73. "ContentType":{
  74. "type":"string",
  75. "enum":[
  76. "application/json",
  77. "application/xml"
  78. ]
  79. },
  80. "Cursor":{"type":"string"},
  81. "Deletes":{"type":"long"},
  82. "DocumentServiceException":{
  83. "type":"structure",
  84. "members":{
  85. "status":{"shape":"String"},
  86. "message":{"shape":"String"}
  87. },
  88. "exception":true
  89. },
  90. "DocumentServiceWarning":{
  91. "type":"structure",
  92. "members":{
  93. "message":{"shape":"String"}
  94. }
  95. },
  96. "DocumentServiceWarnings":{
  97. "type":"list",
  98. "member":{"shape":"DocumentServiceWarning"}
  99. },
  100. "Double":{"type":"double"},
  101. "Expr":{"type":"string"},
  102. "Exprs":{
  103. "type":"map",
  104. "key":{"shape":"String"},
  105. "value":{"shape":"String"}
  106. },
  107. "Facet":{"type":"string"},
  108. "Facets":{
  109. "type":"map",
  110. "key":{"shape":"String"},
  111. "value":{"shape":"BucketInfo"}
  112. },
  113. "FieldStats":{
  114. "type":"structure",
  115. "members":{
  116. "min":{"shape":"String"},
  117. "max":{"shape":"String"},
  118. "count":{"shape":"Long"},
  119. "missing":{"shape":"Long"},
  120. "sum":{"shape":"Double"},
  121. "sumOfSquares":{"shape":"Double"},
  122. "mean":{"shape":"String"},
  123. "stddev":{"shape":"Double"}
  124. }
  125. },
  126. "FieldValue":{
  127. "type":"list",
  128. "member":{"shape":"String"}
  129. },
  130. "Fields":{
  131. "type":"map",
  132. "key":{"shape":"String"},
  133. "value":{"shape":"FieldValue"}
  134. },
  135. "FilterQuery":{"type":"string"},
  136. "Highlight":{"type":"string"},
  137. "Highlights":{
  138. "type":"map",
  139. "key":{"shape":"String"},
  140. "value":{"shape":"String"}
  141. },
  142. "Hit":{
  143. "type":"structure",
  144. "members":{
  145. "id":{"shape":"String"},
  146. "fields":{"shape":"Fields"},
  147. "exprs":{"shape":"Exprs"},
  148. "highlights":{"shape":"Highlights"}
  149. }
  150. },
  151. "HitList":{
  152. "type":"list",
  153. "member":{"shape":"Hit"}
  154. },
  155. "Hits":{
  156. "type":"structure",
  157. "members":{
  158. "found":{"shape":"Long"},
  159. "start":{"shape":"Long"},
  160. "cursor":{"shape":"String"},
  161. "hit":{"shape":"HitList"}
  162. }
  163. },
  164. "Long":{"type":"long"},
  165. "Partial":{"type":"boolean"},
  166. "Query":{"type":"string"},
  167. "QueryOptions":{"type":"string"},
  168. "QueryParser":{
  169. "type":"string",
  170. "enum":[
  171. "simple",
  172. "structured",
  173. "lucene",
  174. "dismax"
  175. ]
  176. },
  177. "Return":{"type":"string"},
  178. "SearchException":{
  179. "type":"structure",
  180. "members":{
  181. "message":{"shape":"String"}
  182. },
  183. "exception":true
  184. },
  185. "SearchRequest":{
  186. "type":"structure",
  187. "required":["query"],
  188. "members":{
  189. "cursor":{
  190. "shape":"Cursor",
  191. "location":"querystring",
  192. "locationName":"cursor"
  193. },
  194. "expr":{
  195. "shape":"Expr",
  196. "location":"querystring",
  197. "locationName":"expr"
  198. },
  199. "facet":{
  200. "shape":"Facet",
  201. "location":"querystring",
  202. "locationName":"facet"
  203. },
  204. "filterQuery":{
  205. "shape":"FilterQuery",
  206. "location":"querystring",
  207. "locationName":"fq"
  208. },
  209. "highlight":{
  210. "shape":"Highlight",
  211. "location":"querystring",
  212. "locationName":"highlight"
  213. },
  214. "partial":{
  215. "shape":"Partial",
  216. "location":"querystring",
  217. "locationName":"partial"
  218. },
  219. "query":{
  220. "shape":"Query",
  221. "location":"querystring",
  222. "locationName":"q"
  223. },
  224. "queryOptions":{
  225. "shape":"QueryOptions",
  226. "location":"querystring",
  227. "locationName":"q.options"
  228. },
  229. "queryParser":{
  230. "shape":"QueryParser",
  231. "location":"querystring",
  232. "locationName":"q.parser"
  233. },
  234. "return":{
  235. "shape":"Return",
  236. "location":"querystring",
  237. "locationName":"return"
  238. },
  239. "size":{
  240. "shape":"Size",
  241. "location":"querystring",
  242. "locationName":"size"
  243. },
  244. "sort":{
  245. "shape":"Sort",
  246. "location":"querystring",
  247. "locationName":"sort"
  248. },
  249. "start":{
  250. "shape":"Start",
  251. "location":"querystring",
  252. "locationName":"start"
  253. },
  254. "stats":{
  255. "shape":"Stat",
  256. "location":"querystring",
  257. "locationName":"stats"
  258. }
  259. }
  260. },
  261. "SearchResponse":{
  262. "type":"structure",
  263. "members":{
  264. "status":{"shape":"SearchStatus"},
  265. "hits":{"shape":"Hits"},
  266. "facets":{"shape":"Facets"},
  267. "stats":{"shape":"Stats"}
  268. }
  269. },
  270. "SearchStatus":{
  271. "type":"structure",
  272. "members":{
  273. "timems":{"shape":"Long"},
  274. "rid":{"shape":"String"}
  275. }
  276. },
  277. "Size":{"type":"long"},
  278. "Sort":{"type":"string"},
  279. "Start":{"type":"long"},
  280. "Stat":{"type":"string"},
  281. "Stats":{
  282. "type":"map",
  283. "key":{"shape":"String"},
  284. "value":{"shape":"FieldStats"}
  285. },
  286. "String":{"type":"string"},
  287. "SuggestModel":{
  288. "type":"structure",
  289. "members":{
  290. "query":{"shape":"String"},
  291. "found":{"shape":"Long"},
  292. "suggestions":{"shape":"Suggestions"}
  293. }
  294. },
  295. "SuggestRequest":{
  296. "type":"structure",
  297. "required":[
  298. "query",
  299. "suggester"
  300. ],
  301. "members":{
  302. "query":{
  303. "shape":"Query",
  304. "location":"querystring",
  305. "locationName":"q"
  306. },
  307. "suggester":{
  308. "shape":"Suggester",
  309. "location":"querystring",
  310. "locationName":"suggester"
  311. },
  312. "size":{
  313. "shape":"SuggestionsSize",
  314. "location":"querystring",
  315. "locationName":"size"
  316. }
  317. }
  318. },
  319. "SuggestResponse":{
  320. "type":"structure",
  321. "members":{
  322. "status":{"shape":"SuggestStatus"},
  323. "suggest":{"shape":"SuggestModel"}
  324. }
  325. },
  326. "SuggestStatus":{
  327. "type":"structure",
  328. "members":{
  329. "timems":{"shape":"Long"},
  330. "rid":{"shape":"String"}
  331. }
  332. },
  333. "Suggester":{"type":"string"},
  334. "SuggestionMatch":{
  335. "type":"structure",
  336. "members":{
  337. "suggestion":{"shape":"String"},
  338. "score":{"shape":"Long"},
  339. "id":{"shape":"String"}
  340. }
  341. },
  342. "Suggestions":{
  343. "type":"list",
  344. "member":{"shape":"SuggestionMatch"}
  345. },
  346. "SuggestionsSize":{"type":"long"},
  347. "UploadDocumentsRequest":{
  348. "type":"structure",
  349. "required":[
  350. "documents",
  351. "contentType"
  352. ],
  353. "members":{
  354. "documents":{"shape":"Blob"},
  355. "contentType":{
  356. "shape":"ContentType",
  357. "location":"header",
  358. "locationName":"Content-Type"
  359. }
  360. },
  361. "payload":"documents"
  362. },
  363. "UploadDocumentsResponse":{
  364. "type":"structure",
  365. "members":{
  366. "status":{"shape":"String"},
  367. "adds":{"shape":"Adds"},
  368. "deletes":{"shape":"Deletes"},
  369. "warnings":{"shape":"DocumentServiceWarnings"}
  370. }
  371. }
  372. }
  373. }