wisdom-2020-10-19.min.json 54 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2020-10-19",
  5. "endpointPrefix": "wisdom",
  6. "jsonVersion": "1.1",
  7. "protocol": "rest-json",
  8. "serviceFullName": "Amazon Connect Wisdom Service",
  9. "serviceId": "Wisdom",
  10. "signatureVersion": "v4",
  11. "signingName": "wisdom",
  12. "uid": "wisdom-2020-10-19"
  13. },
  14. "operations": {
  15. "CreateAssistant": {
  16. "http": {
  17. "requestUri": "/assistants",
  18. "responseCode": 200
  19. },
  20. "input": {
  21. "type": "structure",
  22. "required": [
  23. "name",
  24. "type"
  25. ],
  26. "members": {
  27. "clientToken": {
  28. "idempotencyToken": true
  29. },
  30. "description": {},
  31. "name": {},
  32. "serverSideEncryptionConfiguration": {
  33. "shape": "S5"
  34. },
  35. "tags": {
  36. "shape": "S7"
  37. },
  38. "type": {}
  39. }
  40. },
  41. "output": {
  42. "type": "structure",
  43. "members": {
  44. "assistant": {
  45. "shape": "Sc"
  46. }
  47. }
  48. },
  49. "idempotent": true
  50. },
  51. "CreateAssistantAssociation": {
  52. "http": {
  53. "requestUri": "/assistants/{assistantId}/associations",
  54. "responseCode": 200
  55. },
  56. "input": {
  57. "type": "structure",
  58. "required": [
  59. "assistantId",
  60. "association",
  61. "associationType"
  62. ],
  63. "members": {
  64. "assistantId": {
  65. "location": "uri",
  66. "locationName": "assistantId"
  67. },
  68. "association": {
  69. "type": "structure",
  70. "members": {
  71. "knowledgeBaseId": {}
  72. },
  73. "union": true
  74. },
  75. "associationType": {},
  76. "clientToken": {
  77. "idempotencyToken": true
  78. },
  79. "tags": {
  80. "shape": "S7"
  81. }
  82. }
  83. },
  84. "output": {
  85. "type": "structure",
  86. "members": {
  87. "assistantAssociation": {
  88. "shape": "Sn"
  89. }
  90. }
  91. },
  92. "idempotent": true
  93. },
  94. "CreateContent": {
  95. "http": {
  96. "requestUri": "/knowledgeBases/{knowledgeBaseId}/contents",
  97. "responseCode": 200
  98. },
  99. "input": {
  100. "type": "structure",
  101. "required": [
  102. "knowledgeBaseId",
  103. "name",
  104. "uploadId"
  105. ],
  106. "members": {
  107. "clientToken": {
  108. "idempotencyToken": true
  109. },
  110. "knowledgeBaseId": {
  111. "location": "uri",
  112. "locationName": "knowledgeBaseId"
  113. },
  114. "metadata": {
  115. "shape": "Sr"
  116. },
  117. "name": {},
  118. "overrideLinkOutUri": {},
  119. "tags": {
  120. "shape": "S7"
  121. },
  122. "title": {},
  123. "uploadId": {}
  124. }
  125. },
  126. "output": {
  127. "type": "structure",
  128. "members": {
  129. "content": {
  130. "shape": "Sw"
  131. }
  132. }
  133. },
  134. "idempotent": true
  135. },
  136. "CreateKnowledgeBase": {
  137. "http": {
  138. "requestUri": "/knowledgeBases",
  139. "responseCode": 200
  140. },
  141. "input": {
  142. "type": "structure",
  143. "required": [
  144. "knowledgeBaseType",
  145. "name"
  146. ],
  147. "members": {
  148. "clientToken": {
  149. "idempotencyToken": true
  150. },
  151. "description": {},
  152. "knowledgeBaseType": {},
  153. "name": {},
  154. "renderingConfiguration": {
  155. "shape": "S13"
  156. },
  157. "serverSideEncryptionConfiguration": {
  158. "shape": "S5"
  159. },
  160. "sourceConfiguration": {
  161. "shape": "S14"
  162. },
  163. "tags": {
  164. "shape": "S7"
  165. }
  166. }
  167. },
  168. "output": {
  169. "type": "structure",
  170. "members": {
  171. "knowledgeBase": {
  172. "shape": "S18"
  173. }
  174. }
  175. },
  176. "idempotent": true
  177. },
  178. "CreateQuickResponse": {
  179. "http": {
  180. "requestUri": "/knowledgeBases/{knowledgeBaseId}/quickResponses",
  181. "responseCode": 200
  182. },
  183. "input": {
  184. "type": "structure",
  185. "required": [
  186. "content",
  187. "knowledgeBaseId",
  188. "name"
  189. ],
  190. "members": {
  191. "channels": {
  192. "shape": "S1b"
  193. },
  194. "clientToken": {
  195. "idempotencyToken": true
  196. },
  197. "content": {
  198. "shape": "S1d"
  199. },
  200. "contentType": {},
  201. "description": {},
  202. "groupingConfiguration": {
  203. "shape": "S1h"
  204. },
  205. "isActive": {
  206. "type": "boolean"
  207. },
  208. "knowledgeBaseId": {
  209. "location": "uri",
  210. "locationName": "knowledgeBaseId"
  211. },
  212. "language": {},
  213. "name": {},
  214. "shortcutKey": {},
  215. "tags": {
  216. "shape": "S7"
  217. }
  218. }
  219. },
  220. "output": {
  221. "type": "structure",
  222. "members": {
  223. "quickResponse": {
  224. "shape": "S1q"
  225. }
  226. }
  227. },
  228. "idempotent": true
  229. },
  230. "CreateSession": {
  231. "http": {
  232. "requestUri": "/assistants/{assistantId}/sessions",
  233. "responseCode": 200
  234. },
  235. "input": {
  236. "type": "structure",
  237. "required": [
  238. "assistantId",
  239. "name"
  240. ],
  241. "members": {
  242. "assistantId": {
  243. "location": "uri",
  244. "locationName": "assistantId"
  245. },
  246. "clientToken": {
  247. "idempotencyToken": true
  248. },
  249. "description": {},
  250. "name": {},
  251. "tags": {
  252. "shape": "S7"
  253. }
  254. }
  255. },
  256. "output": {
  257. "type": "structure",
  258. "members": {
  259. "session": {
  260. "shape": "S1w"
  261. }
  262. }
  263. },
  264. "idempotent": true
  265. },
  266. "DeleteAssistant": {
  267. "http": {
  268. "method": "DELETE",
  269. "requestUri": "/assistants/{assistantId}",
  270. "responseCode": 204
  271. },
  272. "input": {
  273. "type": "structure",
  274. "required": [
  275. "assistantId"
  276. ],
  277. "members": {
  278. "assistantId": {
  279. "location": "uri",
  280. "locationName": "assistantId"
  281. }
  282. }
  283. },
  284. "output": {
  285. "type": "structure",
  286. "members": {}
  287. },
  288. "idempotent": true
  289. },
  290. "DeleteAssistantAssociation": {
  291. "http": {
  292. "method": "DELETE",
  293. "requestUri": "/assistants/{assistantId}/associations/{assistantAssociationId}",
  294. "responseCode": 204
  295. },
  296. "input": {
  297. "type": "structure",
  298. "required": [
  299. "assistantAssociationId",
  300. "assistantId"
  301. ],
  302. "members": {
  303. "assistantAssociationId": {
  304. "location": "uri",
  305. "locationName": "assistantAssociationId"
  306. },
  307. "assistantId": {
  308. "location": "uri",
  309. "locationName": "assistantId"
  310. }
  311. }
  312. },
  313. "output": {
  314. "type": "structure",
  315. "members": {}
  316. },
  317. "idempotent": true
  318. },
  319. "DeleteContent": {
  320. "http": {
  321. "method": "DELETE",
  322. "requestUri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}",
  323. "responseCode": 204
  324. },
  325. "input": {
  326. "type": "structure",
  327. "required": [
  328. "contentId",
  329. "knowledgeBaseId"
  330. ],
  331. "members": {
  332. "contentId": {
  333. "location": "uri",
  334. "locationName": "contentId"
  335. },
  336. "knowledgeBaseId": {
  337. "location": "uri",
  338. "locationName": "knowledgeBaseId"
  339. }
  340. }
  341. },
  342. "output": {
  343. "type": "structure",
  344. "members": {}
  345. },
  346. "idempotent": true
  347. },
  348. "DeleteImportJob": {
  349. "http": {
  350. "method": "DELETE",
  351. "requestUri": "/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}",
  352. "responseCode": 204
  353. },
  354. "input": {
  355. "type": "structure",
  356. "required": [
  357. "importJobId",
  358. "knowledgeBaseId"
  359. ],
  360. "members": {
  361. "importJobId": {
  362. "location": "uri",
  363. "locationName": "importJobId"
  364. },
  365. "knowledgeBaseId": {
  366. "location": "uri",
  367. "locationName": "knowledgeBaseId"
  368. }
  369. }
  370. },
  371. "output": {
  372. "type": "structure",
  373. "members": {}
  374. },
  375. "idempotent": true
  376. },
  377. "DeleteKnowledgeBase": {
  378. "http": {
  379. "method": "DELETE",
  380. "requestUri": "/knowledgeBases/{knowledgeBaseId}",
  381. "responseCode": 204
  382. },
  383. "input": {
  384. "type": "structure",
  385. "required": [
  386. "knowledgeBaseId"
  387. ],
  388. "members": {
  389. "knowledgeBaseId": {
  390. "location": "uri",
  391. "locationName": "knowledgeBaseId"
  392. }
  393. }
  394. },
  395. "output": {
  396. "type": "structure",
  397. "members": {}
  398. },
  399. "idempotent": true
  400. },
  401. "DeleteQuickResponse": {
  402. "http": {
  403. "method": "DELETE",
  404. "requestUri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}",
  405. "responseCode": 204
  406. },
  407. "input": {
  408. "type": "structure",
  409. "required": [
  410. "knowledgeBaseId",
  411. "quickResponseId"
  412. ],
  413. "members": {
  414. "knowledgeBaseId": {
  415. "location": "uri",
  416. "locationName": "knowledgeBaseId"
  417. },
  418. "quickResponseId": {
  419. "location": "uri",
  420. "locationName": "quickResponseId"
  421. }
  422. }
  423. },
  424. "output": {
  425. "type": "structure",
  426. "members": {}
  427. },
  428. "idempotent": true
  429. },
  430. "GetAssistant": {
  431. "http": {
  432. "method": "GET",
  433. "requestUri": "/assistants/{assistantId}",
  434. "responseCode": 200
  435. },
  436. "input": {
  437. "type": "structure",
  438. "required": [
  439. "assistantId"
  440. ],
  441. "members": {
  442. "assistantId": {
  443. "location": "uri",
  444. "locationName": "assistantId"
  445. }
  446. }
  447. },
  448. "output": {
  449. "type": "structure",
  450. "members": {
  451. "assistant": {
  452. "shape": "Sc"
  453. }
  454. }
  455. }
  456. },
  457. "GetAssistantAssociation": {
  458. "http": {
  459. "method": "GET",
  460. "requestUri": "/assistants/{assistantId}/associations/{assistantAssociationId}",
  461. "responseCode": 200
  462. },
  463. "input": {
  464. "type": "structure",
  465. "required": [
  466. "assistantAssociationId",
  467. "assistantId"
  468. ],
  469. "members": {
  470. "assistantAssociationId": {
  471. "location": "uri",
  472. "locationName": "assistantAssociationId"
  473. },
  474. "assistantId": {
  475. "location": "uri",
  476. "locationName": "assistantId"
  477. }
  478. }
  479. },
  480. "output": {
  481. "type": "structure",
  482. "members": {
  483. "assistantAssociation": {
  484. "shape": "Sn"
  485. }
  486. }
  487. }
  488. },
  489. "GetContent": {
  490. "http": {
  491. "method": "GET",
  492. "requestUri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}",
  493. "responseCode": 200
  494. },
  495. "input": {
  496. "type": "structure",
  497. "required": [
  498. "contentId",
  499. "knowledgeBaseId"
  500. ],
  501. "members": {
  502. "contentId": {
  503. "location": "uri",
  504. "locationName": "contentId"
  505. },
  506. "knowledgeBaseId": {
  507. "location": "uri",
  508. "locationName": "knowledgeBaseId"
  509. }
  510. }
  511. },
  512. "output": {
  513. "type": "structure",
  514. "members": {
  515. "content": {
  516. "shape": "Sw"
  517. }
  518. }
  519. }
  520. },
  521. "GetContentSummary": {
  522. "http": {
  523. "method": "GET",
  524. "requestUri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}/summary",
  525. "responseCode": 200
  526. },
  527. "input": {
  528. "type": "structure",
  529. "required": [
  530. "contentId",
  531. "knowledgeBaseId"
  532. ],
  533. "members": {
  534. "contentId": {
  535. "location": "uri",
  536. "locationName": "contentId"
  537. },
  538. "knowledgeBaseId": {
  539. "location": "uri",
  540. "locationName": "knowledgeBaseId"
  541. }
  542. }
  543. },
  544. "output": {
  545. "type": "structure",
  546. "members": {
  547. "contentSummary": {
  548. "shape": "S2i"
  549. }
  550. }
  551. }
  552. },
  553. "GetImportJob": {
  554. "http": {
  555. "method": "GET",
  556. "requestUri": "/knowledgeBases/{knowledgeBaseId}/importJobs/{importJobId}",
  557. "responseCode": 200
  558. },
  559. "input": {
  560. "type": "structure",
  561. "required": [
  562. "importJobId",
  563. "knowledgeBaseId"
  564. ],
  565. "members": {
  566. "importJobId": {
  567. "location": "uri",
  568. "locationName": "importJobId"
  569. },
  570. "knowledgeBaseId": {
  571. "location": "uri",
  572. "locationName": "knowledgeBaseId"
  573. }
  574. }
  575. },
  576. "output": {
  577. "type": "structure",
  578. "members": {
  579. "importJob": {
  580. "shape": "S2l"
  581. }
  582. }
  583. }
  584. },
  585. "GetKnowledgeBase": {
  586. "http": {
  587. "method": "GET",
  588. "requestUri": "/knowledgeBases/{knowledgeBaseId}",
  589. "responseCode": 200
  590. },
  591. "input": {
  592. "type": "structure",
  593. "required": [
  594. "knowledgeBaseId"
  595. ],
  596. "members": {
  597. "knowledgeBaseId": {
  598. "location": "uri",
  599. "locationName": "knowledgeBaseId"
  600. }
  601. }
  602. },
  603. "output": {
  604. "type": "structure",
  605. "members": {
  606. "knowledgeBase": {
  607. "shape": "S18"
  608. }
  609. }
  610. }
  611. },
  612. "GetQuickResponse": {
  613. "http": {
  614. "method": "GET",
  615. "requestUri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}",
  616. "responseCode": 200
  617. },
  618. "input": {
  619. "type": "structure",
  620. "required": [
  621. "knowledgeBaseId",
  622. "quickResponseId"
  623. ],
  624. "members": {
  625. "knowledgeBaseId": {
  626. "location": "uri",
  627. "locationName": "knowledgeBaseId"
  628. },
  629. "quickResponseId": {
  630. "location": "uri",
  631. "locationName": "quickResponseId"
  632. }
  633. }
  634. },
  635. "output": {
  636. "type": "structure",
  637. "members": {
  638. "quickResponse": {
  639. "shape": "S1q"
  640. }
  641. }
  642. }
  643. },
  644. "GetRecommendations": {
  645. "http": {
  646. "method": "GET",
  647. "requestUri": "/assistants/{assistantId}/sessions/{sessionId}/recommendations",
  648. "responseCode": 200
  649. },
  650. "input": {
  651. "type": "structure",
  652. "required": [
  653. "assistantId",
  654. "sessionId"
  655. ],
  656. "members": {
  657. "assistantId": {
  658. "location": "uri",
  659. "locationName": "assistantId"
  660. },
  661. "maxResults": {
  662. "location": "querystring",
  663. "locationName": "maxResults",
  664. "type": "integer"
  665. },
  666. "sessionId": {
  667. "location": "uri",
  668. "locationName": "sessionId"
  669. },
  670. "waitTimeSeconds": {
  671. "location": "querystring",
  672. "locationName": "waitTimeSeconds",
  673. "type": "integer"
  674. }
  675. }
  676. },
  677. "output": {
  678. "type": "structure",
  679. "required": [
  680. "recommendations"
  681. ],
  682. "members": {
  683. "recommendations": {
  684. "type": "list",
  685. "member": {
  686. "type": "structure",
  687. "required": [
  688. "document",
  689. "recommendationId"
  690. ],
  691. "members": {
  692. "document": {
  693. "shape": "S32"
  694. },
  695. "recommendationId": {},
  696. "relevanceLevel": {},
  697. "relevanceScore": {
  698. "type": "double"
  699. },
  700. "type": {}
  701. }
  702. }
  703. },
  704. "triggers": {
  705. "type": "list",
  706. "member": {
  707. "type": "structure",
  708. "required": [
  709. "data",
  710. "id",
  711. "recommendationIds",
  712. "source",
  713. "type"
  714. ],
  715. "members": {
  716. "data": {
  717. "type": "structure",
  718. "members": {
  719. "query": {
  720. "type": "structure",
  721. "members": {
  722. "text": {
  723. "shape": "S3h"
  724. }
  725. }
  726. }
  727. },
  728. "union": true
  729. },
  730. "id": {},
  731. "recommendationIds": {
  732. "shape": "S3i"
  733. },
  734. "source": {},
  735. "type": {}
  736. }
  737. }
  738. }
  739. }
  740. },
  741. "deprecated": true,
  742. "deprecatedMessage": "GetRecommendations API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications."
  743. },
  744. "GetSession": {
  745. "http": {
  746. "method": "GET",
  747. "requestUri": "/assistants/{assistantId}/sessions/{sessionId}",
  748. "responseCode": 200
  749. },
  750. "input": {
  751. "type": "structure",
  752. "required": [
  753. "assistantId",
  754. "sessionId"
  755. ],
  756. "members": {
  757. "assistantId": {
  758. "location": "uri",
  759. "locationName": "assistantId"
  760. },
  761. "sessionId": {
  762. "location": "uri",
  763. "locationName": "sessionId"
  764. }
  765. }
  766. },
  767. "output": {
  768. "type": "structure",
  769. "members": {
  770. "session": {
  771. "shape": "S1w"
  772. }
  773. }
  774. }
  775. },
  776. "ListAssistantAssociations": {
  777. "http": {
  778. "method": "GET",
  779. "requestUri": "/assistants/{assistantId}/associations",
  780. "responseCode": 200
  781. },
  782. "input": {
  783. "type": "structure",
  784. "required": [
  785. "assistantId"
  786. ],
  787. "members": {
  788. "assistantId": {
  789. "location": "uri",
  790. "locationName": "assistantId"
  791. },
  792. "maxResults": {
  793. "location": "querystring",
  794. "locationName": "maxResults",
  795. "type": "integer"
  796. },
  797. "nextToken": {
  798. "location": "querystring",
  799. "locationName": "nextToken"
  800. }
  801. }
  802. },
  803. "output": {
  804. "type": "structure",
  805. "required": [
  806. "assistantAssociationSummaries"
  807. ],
  808. "members": {
  809. "assistantAssociationSummaries": {
  810. "type": "list",
  811. "member": {
  812. "type": "structure",
  813. "required": [
  814. "assistantArn",
  815. "assistantAssociationArn",
  816. "assistantAssociationId",
  817. "assistantId",
  818. "associationData",
  819. "associationType"
  820. ],
  821. "members": {
  822. "assistantArn": {},
  823. "assistantAssociationArn": {},
  824. "assistantAssociationId": {},
  825. "assistantId": {},
  826. "associationData": {
  827. "shape": "So"
  828. },
  829. "associationType": {},
  830. "tags": {
  831. "shape": "S7"
  832. }
  833. }
  834. }
  835. },
  836. "nextToken": {}
  837. }
  838. }
  839. },
  840. "ListAssistants": {
  841. "http": {
  842. "method": "GET",
  843. "requestUri": "/assistants",
  844. "responseCode": 200
  845. },
  846. "input": {
  847. "type": "structure",
  848. "members": {
  849. "maxResults": {
  850. "location": "querystring",
  851. "locationName": "maxResults",
  852. "type": "integer"
  853. },
  854. "nextToken": {
  855. "location": "querystring",
  856. "locationName": "nextToken"
  857. }
  858. }
  859. },
  860. "output": {
  861. "type": "structure",
  862. "required": [
  863. "assistantSummaries"
  864. ],
  865. "members": {
  866. "assistantSummaries": {
  867. "type": "list",
  868. "member": {
  869. "type": "structure",
  870. "required": [
  871. "assistantArn",
  872. "assistantId",
  873. "name",
  874. "status",
  875. "type"
  876. ],
  877. "members": {
  878. "assistantArn": {},
  879. "assistantId": {},
  880. "description": {},
  881. "integrationConfiguration": {
  882. "shape": "Sf"
  883. },
  884. "name": {},
  885. "serverSideEncryptionConfiguration": {
  886. "shape": "S5"
  887. },
  888. "status": {},
  889. "tags": {
  890. "shape": "S7"
  891. },
  892. "type": {}
  893. }
  894. }
  895. },
  896. "nextToken": {}
  897. }
  898. }
  899. },
  900. "ListContents": {
  901. "http": {
  902. "method": "GET",
  903. "requestUri": "/knowledgeBases/{knowledgeBaseId}/contents",
  904. "responseCode": 200
  905. },
  906. "input": {
  907. "type": "structure",
  908. "required": [
  909. "knowledgeBaseId"
  910. ],
  911. "members": {
  912. "knowledgeBaseId": {
  913. "location": "uri",
  914. "locationName": "knowledgeBaseId"
  915. },
  916. "maxResults": {
  917. "location": "querystring",
  918. "locationName": "maxResults",
  919. "type": "integer"
  920. },
  921. "nextToken": {
  922. "location": "querystring",
  923. "locationName": "nextToken"
  924. }
  925. }
  926. },
  927. "output": {
  928. "type": "structure",
  929. "required": [
  930. "contentSummaries"
  931. ],
  932. "members": {
  933. "contentSummaries": {
  934. "shape": "S3y"
  935. },
  936. "nextToken": {}
  937. }
  938. }
  939. },
  940. "ListImportJobs": {
  941. "http": {
  942. "method": "GET",
  943. "requestUri": "/knowledgeBases/{knowledgeBaseId}/importJobs",
  944. "responseCode": 200
  945. },
  946. "input": {
  947. "type": "structure",
  948. "required": [
  949. "knowledgeBaseId"
  950. ],
  951. "members": {
  952. "knowledgeBaseId": {
  953. "location": "uri",
  954. "locationName": "knowledgeBaseId"
  955. },
  956. "maxResults": {
  957. "location": "querystring",
  958. "locationName": "maxResults",
  959. "type": "integer"
  960. },
  961. "nextToken": {
  962. "location": "querystring",
  963. "locationName": "nextToken"
  964. }
  965. }
  966. },
  967. "output": {
  968. "type": "structure",
  969. "required": [
  970. "importJobSummaries"
  971. ],
  972. "members": {
  973. "importJobSummaries": {
  974. "type": "list",
  975. "member": {
  976. "type": "structure",
  977. "required": [
  978. "createdTime",
  979. "importJobId",
  980. "importJobType",
  981. "knowledgeBaseArn",
  982. "knowledgeBaseId",
  983. "lastModifiedTime",
  984. "status",
  985. "uploadId"
  986. ],
  987. "members": {
  988. "createdTime": {
  989. "shape": "S10"
  990. },
  991. "externalSourceConfiguration": {
  992. "shape": "S2m"
  993. },
  994. "importJobId": {},
  995. "importJobType": {},
  996. "knowledgeBaseArn": {},
  997. "knowledgeBaseId": {},
  998. "lastModifiedTime": {
  999. "shape": "S10"
  1000. },
  1001. "metadata": {
  1002. "shape": "Sr"
  1003. },
  1004. "status": {},
  1005. "uploadId": {}
  1006. }
  1007. }
  1008. },
  1009. "nextToken": {}
  1010. }
  1011. }
  1012. },
  1013. "ListKnowledgeBases": {
  1014. "http": {
  1015. "method": "GET",
  1016. "requestUri": "/knowledgeBases",
  1017. "responseCode": 200
  1018. },
  1019. "input": {
  1020. "type": "structure",
  1021. "members": {
  1022. "maxResults": {
  1023. "location": "querystring",
  1024. "locationName": "maxResults",
  1025. "type": "integer"
  1026. },
  1027. "nextToken": {
  1028. "location": "querystring",
  1029. "locationName": "nextToken"
  1030. }
  1031. }
  1032. },
  1033. "output": {
  1034. "type": "structure",
  1035. "required": [
  1036. "knowledgeBaseSummaries"
  1037. ],
  1038. "members": {
  1039. "knowledgeBaseSummaries": {
  1040. "type": "list",
  1041. "member": {
  1042. "type": "structure",
  1043. "required": [
  1044. "knowledgeBaseArn",
  1045. "knowledgeBaseId",
  1046. "knowledgeBaseType",
  1047. "name",
  1048. "status"
  1049. ],
  1050. "members": {
  1051. "description": {},
  1052. "knowledgeBaseArn": {},
  1053. "knowledgeBaseId": {},
  1054. "knowledgeBaseType": {},
  1055. "name": {},
  1056. "renderingConfiguration": {
  1057. "shape": "S13"
  1058. },
  1059. "serverSideEncryptionConfiguration": {
  1060. "shape": "S5"
  1061. },
  1062. "sourceConfiguration": {
  1063. "shape": "S14"
  1064. },
  1065. "status": {},
  1066. "tags": {
  1067. "shape": "S7"
  1068. }
  1069. }
  1070. }
  1071. },
  1072. "nextToken": {}
  1073. }
  1074. }
  1075. },
  1076. "ListQuickResponses": {
  1077. "http": {
  1078. "method": "GET",
  1079. "requestUri": "/knowledgeBases/{knowledgeBaseId}/quickResponses",
  1080. "responseCode": 200
  1081. },
  1082. "input": {
  1083. "type": "structure",
  1084. "required": [
  1085. "knowledgeBaseId"
  1086. ],
  1087. "members": {
  1088. "knowledgeBaseId": {
  1089. "location": "uri",
  1090. "locationName": "knowledgeBaseId"
  1091. },
  1092. "maxResults": {
  1093. "location": "querystring",
  1094. "locationName": "maxResults",
  1095. "type": "integer"
  1096. },
  1097. "nextToken": {
  1098. "location": "querystring",
  1099. "locationName": "nextToken"
  1100. }
  1101. }
  1102. },
  1103. "output": {
  1104. "type": "structure",
  1105. "required": [
  1106. "quickResponseSummaries"
  1107. ],
  1108. "members": {
  1109. "nextToken": {},
  1110. "quickResponseSummaries": {
  1111. "type": "list",
  1112. "member": {
  1113. "type": "structure",
  1114. "required": [
  1115. "contentType",
  1116. "createdTime",
  1117. "knowledgeBaseArn",
  1118. "knowledgeBaseId",
  1119. "lastModifiedTime",
  1120. "name",
  1121. "quickResponseArn",
  1122. "quickResponseId",
  1123. "status"
  1124. ],
  1125. "members": {
  1126. "channels": {
  1127. "shape": "S1b"
  1128. },
  1129. "contentType": {},
  1130. "createdTime": {
  1131. "shape": "S10"
  1132. },
  1133. "description": {},
  1134. "isActive": {
  1135. "type": "boolean"
  1136. },
  1137. "knowledgeBaseArn": {},
  1138. "knowledgeBaseId": {},
  1139. "lastModifiedBy": {},
  1140. "lastModifiedTime": {
  1141. "shape": "S10"
  1142. },
  1143. "name": {},
  1144. "quickResponseArn": {},
  1145. "quickResponseId": {},
  1146. "status": {},
  1147. "tags": {
  1148. "shape": "S7"
  1149. }
  1150. }
  1151. }
  1152. }
  1153. }
  1154. }
  1155. },
  1156. "ListTagsForResource": {
  1157. "http": {
  1158. "method": "GET",
  1159. "requestUri": "/tags/{resourceArn}",
  1160. "responseCode": 200
  1161. },
  1162. "input": {
  1163. "type": "structure",
  1164. "required": [
  1165. "resourceArn"
  1166. ],
  1167. "members": {
  1168. "resourceArn": {
  1169. "location": "uri",
  1170. "locationName": "resourceArn"
  1171. }
  1172. }
  1173. },
  1174. "output": {
  1175. "type": "structure",
  1176. "members": {
  1177. "tags": {
  1178. "shape": "S7"
  1179. }
  1180. }
  1181. }
  1182. },
  1183. "NotifyRecommendationsReceived": {
  1184. "http": {
  1185. "requestUri": "/assistants/{assistantId}/sessions/{sessionId}/recommendations/notify",
  1186. "responseCode": 200
  1187. },
  1188. "input": {
  1189. "type": "structure",
  1190. "required": [
  1191. "assistantId",
  1192. "recommendationIds",
  1193. "sessionId"
  1194. ],
  1195. "members": {
  1196. "assistantId": {
  1197. "location": "uri",
  1198. "locationName": "assistantId"
  1199. },
  1200. "recommendationIds": {
  1201. "shape": "S3i"
  1202. },
  1203. "sessionId": {
  1204. "location": "uri",
  1205. "locationName": "sessionId"
  1206. }
  1207. }
  1208. },
  1209. "output": {
  1210. "type": "structure",
  1211. "members": {
  1212. "errors": {
  1213. "type": "list",
  1214. "member": {
  1215. "type": "structure",
  1216. "members": {
  1217. "message": {},
  1218. "recommendationId": {}
  1219. }
  1220. }
  1221. },
  1222. "recommendationIds": {
  1223. "shape": "S3i"
  1224. }
  1225. }
  1226. },
  1227. "idempotent": true
  1228. },
  1229. "QueryAssistant": {
  1230. "http": {
  1231. "requestUri": "/assistants/{assistantId}/query",
  1232. "responseCode": 200
  1233. },
  1234. "input": {
  1235. "type": "structure",
  1236. "required": [
  1237. "assistantId",
  1238. "queryText"
  1239. ],
  1240. "members": {
  1241. "assistantId": {
  1242. "location": "uri",
  1243. "locationName": "assistantId"
  1244. },
  1245. "maxResults": {
  1246. "type": "integer"
  1247. },
  1248. "nextToken": {},
  1249. "queryText": {
  1250. "shape": "S3h"
  1251. }
  1252. }
  1253. },
  1254. "output": {
  1255. "type": "structure",
  1256. "required": [
  1257. "results"
  1258. ],
  1259. "members": {
  1260. "nextToken": {},
  1261. "results": {
  1262. "type": "list",
  1263. "member": {
  1264. "type": "structure",
  1265. "required": [
  1266. "document",
  1267. "resultId"
  1268. ],
  1269. "members": {
  1270. "document": {
  1271. "shape": "S32"
  1272. },
  1273. "relevanceScore": {
  1274. "type": "double"
  1275. },
  1276. "resultId": {}
  1277. }
  1278. }
  1279. }
  1280. }
  1281. },
  1282. "deprecated": true,
  1283. "deprecatedMessage": "QueryAssistant API will be discontinued starting June 1, 2024. To receive generative responses after March 1, 2024 you will need to create a new Assistant in the Connect console and integrate the Amazon Q in Connect JavaScript library (amazon-q-connectjs) into your applications."
  1284. },
  1285. "RemoveKnowledgeBaseTemplateUri": {
  1286. "http": {
  1287. "method": "DELETE",
  1288. "requestUri": "/knowledgeBases/{knowledgeBaseId}/templateUri",
  1289. "responseCode": 204
  1290. },
  1291. "input": {
  1292. "type": "structure",
  1293. "required": [
  1294. "knowledgeBaseId"
  1295. ],
  1296. "members": {
  1297. "knowledgeBaseId": {
  1298. "location": "uri",
  1299. "locationName": "knowledgeBaseId"
  1300. }
  1301. }
  1302. },
  1303. "output": {
  1304. "type": "structure",
  1305. "members": {}
  1306. }
  1307. },
  1308. "SearchContent": {
  1309. "http": {
  1310. "requestUri": "/knowledgeBases/{knowledgeBaseId}/search",
  1311. "responseCode": 200
  1312. },
  1313. "input": {
  1314. "type": "structure",
  1315. "required": [
  1316. "knowledgeBaseId",
  1317. "searchExpression"
  1318. ],
  1319. "members": {
  1320. "knowledgeBaseId": {
  1321. "location": "uri",
  1322. "locationName": "knowledgeBaseId"
  1323. },
  1324. "maxResults": {
  1325. "location": "querystring",
  1326. "locationName": "maxResults",
  1327. "type": "integer"
  1328. },
  1329. "nextToken": {
  1330. "location": "querystring",
  1331. "locationName": "nextToken"
  1332. },
  1333. "searchExpression": {
  1334. "shape": "S4p"
  1335. }
  1336. }
  1337. },
  1338. "output": {
  1339. "type": "structure",
  1340. "required": [
  1341. "contentSummaries"
  1342. ],
  1343. "members": {
  1344. "contentSummaries": {
  1345. "shape": "S3y"
  1346. },
  1347. "nextToken": {}
  1348. }
  1349. }
  1350. },
  1351. "SearchQuickResponses": {
  1352. "http": {
  1353. "requestUri": "/knowledgeBases/{knowledgeBaseId}/search/quickResponses",
  1354. "responseCode": 200
  1355. },
  1356. "input": {
  1357. "type": "structure",
  1358. "required": [
  1359. "knowledgeBaseId",
  1360. "searchExpression"
  1361. ],
  1362. "members": {
  1363. "attributes": {
  1364. "type": "map",
  1365. "key": {},
  1366. "value": {},
  1367. "sensitive": true
  1368. },
  1369. "knowledgeBaseId": {
  1370. "location": "uri",
  1371. "locationName": "knowledgeBaseId"
  1372. },
  1373. "maxResults": {
  1374. "location": "querystring",
  1375. "locationName": "maxResults",
  1376. "type": "integer"
  1377. },
  1378. "nextToken": {
  1379. "location": "querystring",
  1380. "locationName": "nextToken"
  1381. },
  1382. "searchExpression": {
  1383. "type": "structure",
  1384. "members": {
  1385. "filters": {
  1386. "type": "list",
  1387. "member": {
  1388. "type": "structure",
  1389. "required": [
  1390. "name",
  1391. "operator"
  1392. ],
  1393. "members": {
  1394. "includeNoExistence": {
  1395. "type": "boolean"
  1396. },
  1397. "name": {},
  1398. "operator": {},
  1399. "values": {
  1400. "type": "list",
  1401. "member": {}
  1402. }
  1403. }
  1404. }
  1405. },
  1406. "orderOnField": {
  1407. "type": "structure",
  1408. "required": [
  1409. "name"
  1410. ],
  1411. "members": {
  1412. "name": {},
  1413. "order": {}
  1414. }
  1415. },
  1416. "queries": {
  1417. "type": "list",
  1418. "member": {
  1419. "type": "structure",
  1420. "required": [
  1421. "name",
  1422. "operator",
  1423. "values"
  1424. ],
  1425. "members": {
  1426. "allowFuzziness": {
  1427. "type": "boolean"
  1428. },
  1429. "name": {},
  1430. "operator": {},
  1431. "priority": {},
  1432. "values": {
  1433. "type": "list",
  1434. "member": {}
  1435. }
  1436. }
  1437. }
  1438. }
  1439. }
  1440. }
  1441. }
  1442. },
  1443. "output": {
  1444. "type": "structure",
  1445. "required": [
  1446. "results"
  1447. ],
  1448. "members": {
  1449. "nextToken": {},
  1450. "results": {
  1451. "type": "list",
  1452. "member": {
  1453. "type": "structure",
  1454. "required": [
  1455. "contentType",
  1456. "contents",
  1457. "createdTime",
  1458. "isActive",
  1459. "knowledgeBaseArn",
  1460. "knowledgeBaseId",
  1461. "lastModifiedTime",
  1462. "name",
  1463. "quickResponseArn",
  1464. "quickResponseId",
  1465. "status"
  1466. ],
  1467. "members": {
  1468. "attributesInterpolated": {
  1469. "shape": "S5g"
  1470. },
  1471. "attributesNotInterpolated": {
  1472. "shape": "S5g"
  1473. },
  1474. "channels": {
  1475. "shape": "S1b"
  1476. },
  1477. "contentType": {},
  1478. "contents": {
  1479. "shape": "S1r"
  1480. },
  1481. "createdTime": {
  1482. "shape": "S10"
  1483. },
  1484. "description": {},
  1485. "groupingConfiguration": {
  1486. "shape": "S1h"
  1487. },
  1488. "isActive": {
  1489. "type": "boolean"
  1490. },
  1491. "knowledgeBaseArn": {},
  1492. "knowledgeBaseId": {},
  1493. "language": {},
  1494. "lastModifiedBy": {},
  1495. "lastModifiedTime": {
  1496. "shape": "S10"
  1497. },
  1498. "name": {},
  1499. "quickResponseArn": {},
  1500. "quickResponseId": {},
  1501. "shortcutKey": {},
  1502. "status": {},
  1503. "tags": {
  1504. "shape": "S7"
  1505. }
  1506. }
  1507. }
  1508. }
  1509. }
  1510. }
  1511. },
  1512. "SearchSessions": {
  1513. "http": {
  1514. "requestUri": "/assistants/{assistantId}/searchSessions",
  1515. "responseCode": 200
  1516. },
  1517. "input": {
  1518. "type": "structure",
  1519. "required": [
  1520. "assistantId",
  1521. "searchExpression"
  1522. ],
  1523. "members": {
  1524. "assistantId": {
  1525. "location": "uri",
  1526. "locationName": "assistantId"
  1527. },
  1528. "maxResults": {
  1529. "location": "querystring",
  1530. "locationName": "maxResults",
  1531. "type": "integer"
  1532. },
  1533. "nextToken": {
  1534. "location": "querystring",
  1535. "locationName": "nextToken"
  1536. },
  1537. "searchExpression": {
  1538. "shape": "S4p"
  1539. }
  1540. }
  1541. },
  1542. "output": {
  1543. "type": "structure",
  1544. "required": [
  1545. "sessionSummaries"
  1546. ],
  1547. "members": {
  1548. "nextToken": {},
  1549. "sessionSummaries": {
  1550. "type": "list",
  1551. "member": {
  1552. "type": "structure",
  1553. "required": [
  1554. "assistantArn",
  1555. "assistantId",
  1556. "sessionArn",
  1557. "sessionId"
  1558. ],
  1559. "members": {
  1560. "assistantArn": {},
  1561. "assistantId": {},
  1562. "sessionArn": {},
  1563. "sessionId": {}
  1564. }
  1565. }
  1566. }
  1567. }
  1568. }
  1569. },
  1570. "StartContentUpload": {
  1571. "http": {
  1572. "requestUri": "/knowledgeBases/{knowledgeBaseId}/upload",
  1573. "responseCode": 200
  1574. },
  1575. "input": {
  1576. "type": "structure",
  1577. "required": [
  1578. "contentType",
  1579. "knowledgeBaseId"
  1580. ],
  1581. "members": {
  1582. "contentType": {},
  1583. "knowledgeBaseId": {
  1584. "location": "uri",
  1585. "locationName": "knowledgeBaseId"
  1586. },
  1587. "presignedUrlTimeToLive": {
  1588. "type": "integer"
  1589. }
  1590. }
  1591. },
  1592. "output": {
  1593. "type": "structure",
  1594. "required": [
  1595. "headersToInclude",
  1596. "uploadId",
  1597. "url",
  1598. "urlExpiry"
  1599. ],
  1600. "members": {
  1601. "headersToInclude": {
  1602. "type": "map",
  1603. "key": {},
  1604. "value": {}
  1605. },
  1606. "uploadId": {},
  1607. "url": {
  1608. "shape": "Sz"
  1609. },
  1610. "urlExpiry": {
  1611. "shape": "S10"
  1612. }
  1613. }
  1614. }
  1615. },
  1616. "StartImportJob": {
  1617. "http": {
  1618. "requestUri": "/knowledgeBases/{knowledgeBaseId}/importJobs",
  1619. "responseCode": 200
  1620. },
  1621. "input": {
  1622. "type": "structure",
  1623. "required": [
  1624. "importJobType",
  1625. "knowledgeBaseId",
  1626. "uploadId"
  1627. ],
  1628. "members": {
  1629. "clientToken": {
  1630. "idempotencyToken": true
  1631. },
  1632. "externalSourceConfiguration": {
  1633. "shape": "S2m"
  1634. },
  1635. "importJobType": {},
  1636. "knowledgeBaseId": {
  1637. "location": "uri",
  1638. "locationName": "knowledgeBaseId"
  1639. },
  1640. "metadata": {
  1641. "shape": "Sr"
  1642. },
  1643. "uploadId": {}
  1644. }
  1645. },
  1646. "output": {
  1647. "type": "structure",
  1648. "members": {
  1649. "importJob": {
  1650. "shape": "S2l"
  1651. }
  1652. }
  1653. },
  1654. "idempotent": true
  1655. },
  1656. "TagResource": {
  1657. "http": {
  1658. "requestUri": "/tags/{resourceArn}",
  1659. "responseCode": 200
  1660. },
  1661. "input": {
  1662. "type": "structure",
  1663. "required": [
  1664. "resourceArn",
  1665. "tags"
  1666. ],
  1667. "members": {
  1668. "resourceArn": {
  1669. "location": "uri",
  1670. "locationName": "resourceArn"
  1671. },
  1672. "tags": {
  1673. "shape": "S7"
  1674. }
  1675. }
  1676. },
  1677. "output": {
  1678. "type": "structure",
  1679. "members": {}
  1680. },
  1681. "idempotent": true
  1682. },
  1683. "UntagResource": {
  1684. "http": {
  1685. "method": "DELETE",
  1686. "requestUri": "/tags/{resourceArn}",
  1687. "responseCode": 200
  1688. },
  1689. "input": {
  1690. "type": "structure",
  1691. "required": [
  1692. "resourceArn",
  1693. "tagKeys"
  1694. ],
  1695. "members": {
  1696. "resourceArn": {
  1697. "location": "uri",
  1698. "locationName": "resourceArn"
  1699. },
  1700. "tagKeys": {
  1701. "location": "querystring",
  1702. "locationName": "tagKeys",
  1703. "type": "list",
  1704. "member": {}
  1705. }
  1706. }
  1707. },
  1708. "output": {
  1709. "type": "structure",
  1710. "members": {}
  1711. },
  1712. "idempotent": true
  1713. },
  1714. "UpdateContent": {
  1715. "http": {
  1716. "requestUri": "/knowledgeBases/{knowledgeBaseId}/contents/{contentId}",
  1717. "responseCode": 200
  1718. },
  1719. "input": {
  1720. "type": "structure",
  1721. "required": [
  1722. "contentId",
  1723. "knowledgeBaseId"
  1724. ],
  1725. "members": {
  1726. "contentId": {
  1727. "location": "uri",
  1728. "locationName": "contentId"
  1729. },
  1730. "knowledgeBaseId": {
  1731. "location": "uri",
  1732. "locationName": "knowledgeBaseId"
  1733. },
  1734. "metadata": {
  1735. "shape": "Sr"
  1736. },
  1737. "overrideLinkOutUri": {},
  1738. "removeOverrideLinkOutUri": {
  1739. "type": "boolean"
  1740. },
  1741. "revisionId": {},
  1742. "title": {},
  1743. "uploadId": {}
  1744. }
  1745. },
  1746. "output": {
  1747. "type": "structure",
  1748. "members": {
  1749. "content": {
  1750. "shape": "Sw"
  1751. }
  1752. }
  1753. }
  1754. },
  1755. "UpdateKnowledgeBaseTemplateUri": {
  1756. "http": {
  1757. "requestUri": "/knowledgeBases/{knowledgeBaseId}/templateUri",
  1758. "responseCode": 200
  1759. },
  1760. "input": {
  1761. "type": "structure",
  1762. "required": [
  1763. "knowledgeBaseId",
  1764. "templateUri"
  1765. ],
  1766. "members": {
  1767. "knowledgeBaseId": {
  1768. "location": "uri",
  1769. "locationName": "knowledgeBaseId"
  1770. },
  1771. "templateUri": {}
  1772. }
  1773. },
  1774. "output": {
  1775. "type": "structure",
  1776. "members": {
  1777. "knowledgeBase": {
  1778. "shape": "S18"
  1779. }
  1780. }
  1781. }
  1782. },
  1783. "UpdateQuickResponse": {
  1784. "http": {
  1785. "requestUri": "/knowledgeBases/{knowledgeBaseId}/quickResponses/{quickResponseId}",
  1786. "responseCode": 200
  1787. },
  1788. "input": {
  1789. "type": "structure",
  1790. "required": [
  1791. "knowledgeBaseId",
  1792. "quickResponseId"
  1793. ],
  1794. "members": {
  1795. "channels": {
  1796. "shape": "S1b"
  1797. },
  1798. "content": {
  1799. "shape": "S1d"
  1800. },
  1801. "contentType": {},
  1802. "description": {},
  1803. "groupingConfiguration": {
  1804. "shape": "S1h"
  1805. },
  1806. "isActive": {
  1807. "type": "boolean"
  1808. },
  1809. "knowledgeBaseId": {
  1810. "location": "uri",
  1811. "locationName": "knowledgeBaseId"
  1812. },
  1813. "language": {},
  1814. "name": {},
  1815. "quickResponseId": {
  1816. "location": "uri",
  1817. "locationName": "quickResponseId"
  1818. },
  1819. "removeDescription": {
  1820. "type": "boolean"
  1821. },
  1822. "removeGroupingConfiguration": {
  1823. "type": "boolean"
  1824. },
  1825. "removeShortcutKey": {
  1826. "type": "boolean"
  1827. },
  1828. "shortcutKey": {}
  1829. }
  1830. },
  1831. "output": {
  1832. "type": "structure",
  1833. "members": {
  1834. "quickResponse": {
  1835. "shape": "S1q"
  1836. }
  1837. }
  1838. }
  1839. }
  1840. },
  1841. "shapes": {
  1842. "S5": {
  1843. "type": "structure",
  1844. "members": {
  1845. "kmsKeyId": {}
  1846. }
  1847. },
  1848. "S7": {
  1849. "type": "map",
  1850. "key": {},
  1851. "value": {}
  1852. },
  1853. "Sc": {
  1854. "type": "structure",
  1855. "required": [
  1856. "assistantArn",
  1857. "assistantId",
  1858. "name",
  1859. "status",
  1860. "type"
  1861. ],
  1862. "members": {
  1863. "assistantArn": {},
  1864. "assistantId": {},
  1865. "description": {},
  1866. "integrationConfiguration": {
  1867. "shape": "Sf"
  1868. },
  1869. "name": {},
  1870. "serverSideEncryptionConfiguration": {
  1871. "shape": "S5"
  1872. },
  1873. "status": {},
  1874. "tags": {
  1875. "shape": "S7"
  1876. },
  1877. "type": {}
  1878. }
  1879. },
  1880. "Sf": {
  1881. "type": "structure",
  1882. "members": {
  1883. "topicIntegrationArn": {}
  1884. }
  1885. },
  1886. "Sn": {
  1887. "type": "structure",
  1888. "required": [
  1889. "assistantArn",
  1890. "assistantAssociationArn",
  1891. "assistantAssociationId",
  1892. "assistantId",
  1893. "associationData",
  1894. "associationType"
  1895. ],
  1896. "members": {
  1897. "assistantArn": {},
  1898. "assistantAssociationArn": {},
  1899. "assistantAssociationId": {},
  1900. "assistantId": {},
  1901. "associationData": {
  1902. "shape": "So"
  1903. },
  1904. "associationType": {},
  1905. "tags": {
  1906. "shape": "S7"
  1907. }
  1908. }
  1909. },
  1910. "So": {
  1911. "type": "structure",
  1912. "members": {
  1913. "knowledgeBaseAssociation": {
  1914. "type": "structure",
  1915. "members": {
  1916. "knowledgeBaseArn": {},
  1917. "knowledgeBaseId": {}
  1918. }
  1919. }
  1920. },
  1921. "union": true
  1922. },
  1923. "Sr": {
  1924. "type": "map",
  1925. "key": {},
  1926. "value": {}
  1927. },
  1928. "Sw": {
  1929. "type": "structure",
  1930. "required": [
  1931. "contentArn",
  1932. "contentId",
  1933. "contentType",
  1934. "knowledgeBaseArn",
  1935. "knowledgeBaseId",
  1936. "metadata",
  1937. "name",
  1938. "revisionId",
  1939. "status",
  1940. "title",
  1941. "url",
  1942. "urlExpiry"
  1943. ],
  1944. "members": {
  1945. "contentArn": {},
  1946. "contentId": {},
  1947. "contentType": {},
  1948. "knowledgeBaseArn": {},
  1949. "knowledgeBaseId": {},
  1950. "linkOutUri": {},
  1951. "metadata": {
  1952. "shape": "Sr"
  1953. },
  1954. "name": {},
  1955. "revisionId": {},
  1956. "status": {},
  1957. "tags": {
  1958. "shape": "S7"
  1959. },
  1960. "title": {},
  1961. "url": {
  1962. "shape": "Sz"
  1963. },
  1964. "urlExpiry": {
  1965. "shape": "S10"
  1966. }
  1967. }
  1968. },
  1969. "Sz": {
  1970. "type": "string",
  1971. "sensitive": true
  1972. },
  1973. "S10": {
  1974. "type": "timestamp",
  1975. "timestampFormat": "unixTimestamp"
  1976. },
  1977. "S13": {
  1978. "type": "structure",
  1979. "members": {
  1980. "templateUri": {}
  1981. }
  1982. },
  1983. "S14": {
  1984. "type": "structure",
  1985. "members": {
  1986. "appIntegrations": {
  1987. "type": "structure",
  1988. "required": [
  1989. "appIntegrationArn"
  1990. ],
  1991. "members": {
  1992. "appIntegrationArn": {},
  1993. "objectFields": {
  1994. "type": "list",
  1995. "member": {}
  1996. }
  1997. }
  1998. }
  1999. },
  2000. "union": true
  2001. },
  2002. "S18": {
  2003. "type": "structure",
  2004. "required": [
  2005. "knowledgeBaseArn",
  2006. "knowledgeBaseId",
  2007. "knowledgeBaseType",
  2008. "name",
  2009. "status"
  2010. ],
  2011. "members": {
  2012. "description": {},
  2013. "knowledgeBaseArn": {},
  2014. "knowledgeBaseId": {},
  2015. "knowledgeBaseType": {},
  2016. "lastContentModificationTime": {
  2017. "shape": "S10"
  2018. },
  2019. "name": {},
  2020. "renderingConfiguration": {
  2021. "shape": "S13"
  2022. },
  2023. "serverSideEncryptionConfiguration": {
  2024. "shape": "S5"
  2025. },
  2026. "sourceConfiguration": {
  2027. "shape": "S14"
  2028. },
  2029. "status": {},
  2030. "tags": {
  2031. "shape": "S7"
  2032. }
  2033. }
  2034. },
  2035. "S1b": {
  2036. "type": "list",
  2037. "member": {
  2038. "type": "string",
  2039. "sensitive": true
  2040. }
  2041. },
  2042. "S1d": {
  2043. "type": "structure",
  2044. "members": {
  2045. "content": {
  2046. "shape": "S1e"
  2047. }
  2048. },
  2049. "union": true
  2050. },
  2051. "S1e": {
  2052. "type": "string",
  2053. "sensitive": true
  2054. },
  2055. "S1h": {
  2056. "type": "structure",
  2057. "members": {
  2058. "criteria": {
  2059. "type": "string",
  2060. "sensitive": true
  2061. },
  2062. "values": {
  2063. "type": "list",
  2064. "member": {
  2065. "type": "string",
  2066. "sensitive": true
  2067. }
  2068. }
  2069. }
  2070. },
  2071. "S1q": {
  2072. "type": "structure",
  2073. "required": [
  2074. "contentType",
  2075. "createdTime",
  2076. "knowledgeBaseArn",
  2077. "knowledgeBaseId",
  2078. "lastModifiedTime",
  2079. "name",
  2080. "quickResponseArn",
  2081. "quickResponseId",
  2082. "status"
  2083. ],
  2084. "members": {
  2085. "channels": {
  2086. "shape": "S1b"
  2087. },
  2088. "contentType": {},
  2089. "contents": {
  2090. "shape": "S1r"
  2091. },
  2092. "createdTime": {
  2093. "shape": "S10"
  2094. },
  2095. "description": {},
  2096. "groupingConfiguration": {
  2097. "shape": "S1h"
  2098. },
  2099. "isActive": {
  2100. "type": "boolean"
  2101. },
  2102. "knowledgeBaseArn": {},
  2103. "knowledgeBaseId": {},
  2104. "language": {},
  2105. "lastModifiedBy": {},
  2106. "lastModifiedTime": {
  2107. "shape": "S10"
  2108. },
  2109. "name": {},
  2110. "quickResponseArn": {},
  2111. "quickResponseId": {},
  2112. "shortcutKey": {},
  2113. "status": {},
  2114. "tags": {
  2115. "shape": "S7"
  2116. }
  2117. }
  2118. },
  2119. "S1r": {
  2120. "type": "structure",
  2121. "members": {
  2122. "markdown": {
  2123. "shape": "S1s"
  2124. },
  2125. "plainText": {
  2126. "shape": "S1s"
  2127. }
  2128. }
  2129. },
  2130. "S1s": {
  2131. "type": "structure",
  2132. "members": {
  2133. "content": {
  2134. "shape": "S1e"
  2135. }
  2136. },
  2137. "union": true
  2138. },
  2139. "S1w": {
  2140. "type": "structure",
  2141. "required": [
  2142. "name",
  2143. "sessionArn",
  2144. "sessionId"
  2145. ],
  2146. "members": {
  2147. "description": {},
  2148. "integrationConfiguration": {
  2149. "type": "structure",
  2150. "members": {
  2151. "topicIntegrationArn": {}
  2152. }
  2153. },
  2154. "name": {},
  2155. "sessionArn": {},
  2156. "sessionId": {},
  2157. "tags": {
  2158. "shape": "S7"
  2159. }
  2160. }
  2161. },
  2162. "S2i": {
  2163. "type": "structure",
  2164. "required": [
  2165. "contentArn",
  2166. "contentId",
  2167. "contentType",
  2168. "knowledgeBaseArn",
  2169. "knowledgeBaseId",
  2170. "metadata",
  2171. "name",
  2172. "revisionId",
  2173. "status",
  2174. "title"
  2175. ],
  2176. "members": {
  2177. "contentArn": {},
  2178. "contentId": {},
  2179. "contentType": {},
  2180. "knowledgeBaseArn": {},
  2181. "knowledgeBaseId": {},
  2182. "metadata": {
  2183. "shape": "Sr"
  2184. },
  2185. "name": {},
  2186. "revisionId": {},
  2187. "status": {},
  2188. "tags": {
  2189. "shape": "S7"
  2190. },
  2191. "title": {}
  2192. }
  2193. },
  2194. "S2l": {
  2195. "type": "structure",
  2196. "required": [
  2197. "createdTime",
  2198. "importJobId",
  2199. "importJobType",
  2200. "knowledgeBaseArn",
  2201. "knowledgeBaseId",
  2202. "lastModifiedTime",
  2203. "status",
  2204. "uploadId",
  2205. "url",
  2206. "urlExpiry"
  2207. ],
  2208. "members": {
  2209. "createdTime": {
  2210. "shape": "S10"
  2211. },
  2212. "externalSourceConfiguration": {
  2213. "shape": "S2m"
  2214. },
  2215. "failedRecordReport": {
  2216. "shape": "Sz"
  2217. },
  2218. "importJobId": {},
  2219. "importJobType": {},
  2220. "knowledgeBaseArn": {},
  2221. "knowledgeBaseId": {},
  2222. "lastModifiedTime": {
  2223. "shape": "S10"
  2224. },
  2225. "metadata": {
  2226. "shape": "Sr"
  2227. },
  2228. "status": {},
  2229. "uploadId": {},
  2230. "url": {
  2231. "shape": "Sz"
  2232. },
  2233. "urlExpiry": {
  2234. "shape": "S10"
  2235. }
  2236. }
  2237. },
  2238. "S2m": {
  2239. "type": "structure",
  2240. "required": [
  2241. "configuration",
  2242. "source"
  2243. ],
  2244. "members": {
  2245. "configuration": {
  2246. "type": "structure",
  2247. "members": {
  2248. "connectConfiguration": {
  2249. "type": "structure",
  2250. "members": {
  2251. "instanceId": {}
  2252. }
  2253. }
  2254. },
  2255. "union": true
  2256. },
  2257. "source": {}
  2258. }
  2259. },
  2260. "S32": {
  2261. "type": "structure",
  2262. "required": [
  2263. "contentReference"
  2264. ],
  2265. "members": {
  2266. "contentReference": {
  2267. "type": "structure",
  2268. "members": {
  2269. "contentArn": {},
  2270. "contentId": {},
  2271. "knowledgeBaseArn": {},
  2272. "knowledgeBaseId": {}
  2273. }
  2274. },
  2275. "excerpt": {
  2276. "shape": "S34"
  2277. },
  2278. "title": {
  2279. "shape": "S34"
  2280. }
  2281. }
  2282. },
  2283. "S34": {
  2284. "type": "structure",
  2285. "members": {
  2286. "highlights": {
  2287. "type": "list",
  2288. "member": {
  2289. "type": "structure",
  2290. "members": {
  2291. "beginOffsetInclusive": {
  2292. "type": "integer"
  2293. },
  2294. "endOffsetExclusive": {
  2295. "type": "integer"
  2296. }
  2297. }
  2298. }
  2299. },
  2300. "text": {
  2301. "type": "string",
  2302. "sensitive": true
  2303. }
  2304. }
  2305. },
  2306. "S3h": {
  2307. "type": "string",
  2308. "sensitive": true
  2309. },
  2310. "S3i": {
  2311. "type": "list",
  2312. "member": {}
  2313. },
  2314. "S3y": {
  2315. "type": "list",
  2316. "member": {
  2317. "shape": "S2i"
  2318. }
  2319. },
  2320. "S4p": {
  2321. "type": "structure",
  2322. "required": [
  2323. "filters"
  2324. ],
  2325. "members": {
  2326. "filters": {
  2327. "type": "list",
  2328. "member": {
  2329. "type": "structure",
  2330. "required": [
  2331. "field",
  2332. "operator",
  2333. "value"
  2334. ],
  2335. "members": {
  2336. "field": {},
  2337. "operator": {},
  2338. "value": {}
  2339. }
  2340. }
  2341. }
  2342. }
  2343. },
  2344. "S5g": {
  2345. "type": "list",
  2346. "member": {},
  2347. "sensitive": true
  2348. }
  2349. }
  2350. }