qbusiness-2023-11-27.min.json 76 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198
  1. {
  2. "version": "2.0",
  3. "metadata": {
  4. "apiVersion": "2023-11-27",
  5. "endpointPrefix": "qbusiness",
  6. "protocol": "rest-json",
  7. "protocolSettings": {
  8. "h2": "eventstream"
  9. },
  10. "protocols": [
  11. "rest-json"
  12. ],
  13. "serviceFullName": "QBusiness",
  14. "serviceId": "QBusiness",
  15. "signatureVersion": "v4",
  16. "signingName": "qbusiness",
  17. "uid": "qbusiness-2023-11-27"
  18. },
  19. "operations": {
  20. "BatchDeleteDocument": {
  21. "http": {
  22. "requestUri": "/applications/{applicationId}/indices/{indexId}/documents/delete",
  23. "responseCode": 200
  24. },
  25. "input": {
  26. "type": "structure",
  27. "required": [
  28. "applicationId",
  29. "indexId",
  30. "documents"
  31. ],
  32. "members": {
  33. "applicationId": {
  34. "location": "uri",
  35. "locationName": "applicationId"
  36. },
  37. "indexId": {
  38. "location": "uri",
  39. "locationName": "indexId"
  40. },
  41. "documents": {
  42. "type": "list",
  43. "member": {
  44. "type": "structure",
  45. "required": [
  46. "documentId"
  47. ],
  48. "members": {
  49. "documentId": {}
  50. }
  51. }
  52. },
  53. "dataSourceSyncId": {}
  54. }
  55. },
  56. "output": {
  57. "type": "structure",
  58. "members": {
  59. "failedDocuments": {
  60. "shape": "S9"
  61. }
  62. }
  63. }
  64. },
  65. "BatchPutDocument": {
  66. "http": {
  67. "requestUri": "/applications/{applicationId}/indices/{indexId}/documents",
  68. "responseCode": 200
  69. },
  70. "input": {
  71. "type": "structure",
  72. "required": [
  73. "applicationId",
  74. "indexId",
  75. "documents"
  76. ],
  77. "members": {
  78. "applicationId": {
  79. "location": "uri",
  80. "locationName": "applicationId"
  81. },
  82. "indexId": {
  83. "location": "uri",
  84. "locationName": "indexId"
  85. },
  86. "documents": {
  87. "type": "list",
  88. "member": {
  89. "type": "structure",
  90. "required": [
  91. "id"
  92. ],
  93. "members": {
  94. "id": {},
  95. "attributes": {
  96. "type": "list",
  97. "member": {
  98. "shape": "Sj"
  99. }
  100. },
  101. "content": {
  102. "type": "structure",
  103. "members": {
  104. "blob": {
  105. "type": "blob"
  106. },
  107. "s3": {
  108. "shape": "St"
  109. }
  110. },
  111. "union": true
  112. },
  113. "contentType": {},
  114. "title": {},
  115. "accessConfiguration": {
  116. "type": "structure",
  117. "required": [
  118. "accessControls"
  119. ],
  120. "members": {
  121. "accessControls": {
  122. "type": "list",
  123. "member": {
  124. "type": "structure",
  125. "required": [
  126. "principals"
  127. ],
  128. "members": {
  129. "principals": {
  130. "type": "list",
  131. "member": {
  132. "type": "structure",
  133. "members": {
  134. "user": {
  135. "type": "structure",
  136. "required": [
  137. "access"
  138. ],
  139. "members": {
  140. "id": {},
  141. "access": {},
  142. "membershipType": {}
  143. }
  144. },
  145. "group": {
  146. "type": "structure",
  147. "required": [
  148. "access"
  149. ],
  150. "members": {
  151. "name": {},
  152. "access": {},
  153. "membershipType": {}
  154. }
  155. }
  156. },
  157. "union": true
  158. }
  159. },
  160. "memberRelation": {}
  161. }
  162. }
  163. },
  164. "memberRelation": {}
  165. }
  166. },
  167. "documentEnrichmentConfiguration": {
  168. "shape": "S1a"
  169. }
  170. }
  171. }
  172. },
  173. "roleArn": {},
  174. "dataSourceSyncId": {}
  175. }
  176. },
  177. "output": {
  178. "type": "structure",
  179. "members": {
  180. "failedDocuments": {
  181. "shape": "S9"
  182. }
  183. }
  184. }
  185. },
  186. "ChatSync": {
  187. "http": {
  188. "requestUri": "/applications/{applicationId}/conversations?sync",
  189. "responseCode": 200
  190. },
  191. "input": {
  192. "type": "structure",
  193. "required": [
  194. "applicationId"
  195. ],
  196. "members": {
  197. "applicationId": {
  198. "location": "uri",
  199. "locationName": "applicationId"
  200. },
  201. "userId": {
  202. "location": "querystring",
  203. "locationName": "userId"
  204. },
  205. "userGroups": {
  206. "shape": "S1n",
  207. "location": "querystring",
  208. "locationName": "userGroups"
  209. },
  210. "userMessage": {},
  211. "attachments": {
  212. "type": "list",
  213. "member": {
  214. "type": "structure",
  215. "required": [
  216. "name",
  217. "data"
  218. ],
  219. "members": {
  220. "name": {},
  221. "data": {
  222. "type": "blob"
  223. }
  224. }
  225. }
  226. },
  227. "actionExecution": {
  228. "shape": "S1s"
  229. },
  230. "authChallengeResponse": {
  231. "type": "structure",
  232. "required": [
  233. "responseMap"
  234. ],
  235. "members": {
  236. "responseMap": {
  237. "type": "map",
  238. "key": {},
  239. "value": {}
  240. }
  241. }
  242. },
  243. "conversationId": {},
  244. "parentMessageId": {},
  245. "attributeFilter": {
  246. "shape": "S25"
  247. },
  248. "chatMode": {},
  249. "chatModeConfiguration": {
  250. "type": "structure",
  251. "members": {
  252. "pluginConfiguration": {
  253. "type": "structure",
  254. "required": [
  255. "pluginId"
  256. ],
  257. "members": {
  258. "pluginId": {}
  259. }
  260. }
  261. },
  262. "union": true
  263. },
  264. "clientToken": {
  265. "idempotencyToken": true
  266. }
  267. }
  268. },
  269. "output": {
  270. "type": "structure",
  271. "members": {
  272. "conversationId": {},
  273. "systemMessage": {},
  274. "systemMessageId": {},
  275. "userMessageId": {},
  276. "actionReview": {
  277. "shape": "S2c"
  278. },
  279. "authChallengeRequest": {
  280. "type": "structure",
  281. "required": [
  282. "authorizationUrl"
  283. ],
  284. "members": {
  285. "authorizationUrl": {}
  286. }
  287. },
  288. "sourceAttributions": {
  289. "shape": "S2n"
  290. },
  291. "failedAttachments": {
  292. "shape": "S2t"
  293. }
  294. }
  295. }
  296. },
  297. "CreateApplication": {
  298. "http": {
  299. "requestUri": "/applications",
  300. "responseCode": 200
  301. },
  302. "input": {
  303. "type": "structure",
  304. "required": [
  305. "displayName"
  306. ],
  307. "members": {
  308. "displayName": {},
  309. "roleArn": {},
  310. "identityCenterInstanceArn": {},
  311. "description": {},
  312. "encryptionConfiguration": {
  313. "shape": "S30"
  314. },
  315. "tags": {
  316. "shape": "S32"
  317. },
  318. "clientToken": {
  319. "idempotencyToken": true
  320. },
  321. "attachmentsConfiguration": {
  322. "shape": "S36"
  323. }
  324. }
  325. },
  326. "output": {
  327. "type": "structure",
  328. "members": {
  329. "applicationId": {},
  330. "applicationArn": {}
  331. }
  332. },
  333. "idempotent": true
  334. },
  335. "CreateDataSource": {
  336. "http": {
  337. "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources",
  338. "responseCode": 200
  339. },
  340. "input": {
  341. "type": "structure",
  342. "required": [
  343. "applicationId",
  344. "indexId",
  345. "displayName",
  346. "configuration"
  347. ],
  348. "members": {
  349. "applicationId": {
  350. "location": "uri",
  351. "locationName": "applicationId"
  352. },
  353. "indexId": {
  354. "location": "uri",
  355. "locationName": "indexId"
  356. },
  357. "displayName": {},
  358. "configuration": {
  359. "shape": "S3c"
  360. },
  361. "vpcConfiguration": {
  362. "shape": "S3d"
  363. },
  364. "description": {},
  365. "tags": {
  366. "shape": "S32"
  367. },
  368. "syncSchedule": {},
  369. "roleArn": {},
  370. "clientToken": {
  371. "idempotencyToken": true
  372. },
  373. "documentEnrichmentConfiguration": {
  374. "shape": "S1a"
  375. }
  376. }
  377. },
  378. "output": {
  379. "type": "structure",
  380. "members": {
  381. "dataSourceId": {},
  382. "dataSourceArn": {}
  383. }
  384. },
  385. "idempotent": true
  386. },
  387. "CreateIndex": {
  388. "http": {
  389. "requestUri": "/applications/{applicationId}/indices",
  390. "responseCode": 200
  391. },
  392. "input": {
  393. "type": "structure",
  394. "required": [
  395. "applicationId",
  396. "displayName"
  397. ],
  398. "members": {
  399. "applicationId": {
  400. "location": "uri",
  401. "locationName": "applicationId"
  402. },
  403. "displayName": {},
  404. "type": {},
  405. "description": {},
  406. "tags": {
  407. "shape": "S32"
  408. },
  409. "capacityConfiguration": {
  410. "shape": "S3o"
  411. },
  412. "clientToken": {
  413. "idempotencyToken": true
  414. }
  415. }
  416. },
  417. "output": {
  418. "type": "structure",
  419. "members": {
  420. "indexId": {},
  421. "indexArn": {}
  422. }
  423. }
  424. },
  425. "CreatePlugin": {
  426. "http": {
  427. "requestUri": "/applications/{applicationId}/plugins",
  428. "responseCode": 200
  429. },
  430. "input": {
  431. "type": "structure",
  432. "required": [
  433. "applicationId",
  434. "displayName",
  435. "type",
  436. "authConfiguration"
  437. ],
  438. "members": {
  439. "applicationId": {
  440. "location": "uri",
  441. "locationName": "applicationId"
  442. },
  443. "displayName": {},
  444. "type": {},
  445. "authConfiguration": {
  446. "shape": "S3u"
  447. },
  448. "serverUrl": {},
  449. "customPluginConfiguration": {
  450. "shape": "S3z"
  451. },
  452. "tags": {
  453. "shape": "S32"
  454. },
  455. "clientToken": {
  456. "idempotencyToken": true
  457. }
  458. }
  459. },
  460. "output": {
  461. "type": "structure",
  462. "members": {
  463. "pluginId": {},
  464. "pluginArn": {},
  465. "buildStatus": {}
  466. }
  467. },
  468. "idempotent": true
  469. },
  470. "CreateRetriever": {
  471. "http": {
  472. "requestUri": "/applications/{applicationId}/retrievers",
  473. "responseCode": 200
  474. },
  475. "input": {
  476. "type": "structure",
  477. "required": [
  478. "applicationId",
  479. "type",
  480. "displayName",
  481. "configuration"
  482. ],
  483. "members": {
  484. "applicationId": {
  485. "location": "uri",
  486. "locationName": "applicationId"
  487. },
  488. "type": {},
  489. "displayName": {},
  490. "configuration": {
  491. "shape": "S4a"
  492. },
  493. "roleArn": {},
  494. "clientToken": {
  495. "idempotencyToken": true
  496. },
  497. "tags": {
  498. "shape": "S32"
  499. }
  500. }
  501. },
  502. "output": {
  503. "type": "structure",
  504. "members": {
  505. "retrieverId": {},
  506. "retrieverArn": {}
  507. }
  508. }
  509. },
  510. "CreateUser": {
  511. "http": {
  512. "requestUri": "/applications/{applicationId}/users",
  513. "responseCode": 200
  514. },
  515. "input": {
  516. "type": "structure",
  517. "required": [
  518. "applicationId",
  519. "userId"
  520. ],
  521. "members": {
  522. "applicationId": {
  523. "location": "uri",
  524. "locationName": "applicationId"
  525. },
  526. "userId": {},
  527. "userAliases": {
  528. "type": "list",
  529. "member": {
  530. "shape": "S4u"
  531. }
  532. },
  533. "clientToken": {
  534. "idempotencyToken": true
  535. }
  536. }
  537. },
  538. "output": {
  539. "type": "structure",
  540. "members": {}
  541. },
  542. "idempotent": true
  543. },
  544. "CreateWebExperience": {
  545. "http": {
  546. "requestUri": "/applications/{applicationId}/experiences",
  547. "responseCode": 200
  548. },
  549. "input": {
  550. "type": "structure",
  551. "required": [
  552. "applicationId"
  553. ],
  554. "members": {
  555. "applicationId": {
  556. "location": "uri",
  557. "locationName": "applicationId"
  558. },
  559. "title": {},
  560. "subtitle": {},
  561. "welcomeMessage": {},
  562. "samplePromptsControlMode": {},
  563. "roleArn": {},
  564. "tags": {
  565. "shape": "S32"
  566. },
  567. "clientToken": {
  568. "idempotencyToken": true
  569. }
  570. }
  571. },
  572. "output": {
  573. "type": "structure",
  574. "members": {
  575. "webExperienceId": {},
  576. "webExperienceArn": {}
  577. }
  578. }
  579. },
  580. "DeleteApplication": {
  581. "http": {
  582. "method": "DELETE",
  583. "requestUri": "/applications/{applicationId}",
  584. "responseCode": 200
  585. },
  586. "input": {
  587. "type": "structure",
  588. "required": [
  589. "applicationId"
  590. ],
  591. "members": {
  592. "applicationId": {
  593. "location": "uri",
  594. "locationName": "applicationId"
  595. }
  596. }
  597. },
  598. "output": {
  599. "type": "structure",
  600. "members": {}
  601. },
  602. "idempotent": true
  603. },
  604. "DeleteChatControlsConfiguration": {
  605. "http": {
  606. "method": "DELETE",
  607. "requestUri": "/applications/{applicationId}/chatcontrols",
  608. "responseCode": 200
  609. },
  610. "input": {
  611. "type": "structure",
  612. "required": [
  613. "applicationId"
  614. ],
  615. "members": {
  616. "applicationId": {
  617. "location": "uri",
  618. "locationName": "applicationId"
  619. }
  620. }
  621. },
  622. "output": {
  623. "type": "structure",
  624. "members": {}
  625. },
  626. "idempotent": true
  627. },
  628. "DeleteConversation": {
  629. "http": {
  630. "method": "DELETE",
  631. "requestUri": "/applications/{applicationId}/conversations/{conversationId}",
  632. "responseCode": 200
  633. },
  634. "input": {
  635. "type": "structure",
  636. "required": [
  637. "conversationId",
  638. "applicationId"
  639. ],
  640. "members": {
  641. "conversationId": {
  642. "location": "uri",
  643. "locationName": "conversationId"
  644. },
  645. "applicationId": {
  646. "location": "uri",
  647. "locationName": "applicationId"
  648. },
  649. "userId": {
  650. "location": "querystring",
  651. "locationName": "userId"
  652. }
  653. }
  654. },
  655. "output": {
  656. "type": "structure",
  657. "members": {}
  658. },
  659. "idempotent": true
  660. },
  661. "DeleteDataSource": {
  662. "http": {
  663. "method": "DELETE",
  664. "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}",
  665. "responseCode": 200
  666. },
  667. "input": {
  668. "type": "structure",
  669. "required": [
  670. "applicationId",
  671. "indexId",
  672. "dataSourceId"
  673. ],
  674. "members": {
  675. "applicationId": {
  676. "location": "uri",
  677. "locationName": "applicationId"
  678. },
  679. "indexId": {
  680. "location": "uri",
  681. "locationName": "indexId"
  682. },
  683. "dataSourceId": {
  684. "location": "uri",
  685. "locationName": "dataSourceId"
  686. }
  687. }
  688. },
  689. "output": {
  690. "type": "structure",
  691. "members": {}
  692. },
  693. "idempotent": true
  694. },
  695. "DeleteGroup": {
  696. "http": {
  697. "method": "DELETE",
  698. "requestUri": "/applications/{applicationId}/indices/{indexId}/groups/{groupName}",
  699. "responseCode": 200
  700. },
  701. "input": {
  702. "type": "structure",
  703. "required": [
  704. "applicationId",
  705. "indexId",
  706. "groupName"
  707. ],
  708. "members": {
  709. "applicationId": {
  710. "location": "uri",
  711. "locationName": "applicationId"
  712. },
  713. "indexId": {
  714. "location": "uri",
  715. "locationName": "indexId"
  716. },
  717. "groupName": {
  718. "location": "uri",
  719. "locationName": "groupName"
  720. },
  721. "dataSourceId": {
  722. "location": "querystring",
  723. "locationName": "dataSourceId"
  724. }
  725. }
  726. },
  727. "output": {
  728. "type": "structure",
  729. "members": {}
  730. },
  731. "idempotent": true
  732. },
  733. "DeleteIndex": {
  734. "http": {
  735. "method": "DELETE",
  736. "requestUri": "/applications/{applicationId}/indices/{indexId}",
  737. "responseCode": 200
  738. },
  739. "input": {
  740. "type": "structure",
  741. "required": [
  742. "applicationId",
  743. "indexId"
  744. ],
  745. "members": {
  746. "applicationId": {
  747. "location": "uri",
  748. "locationName": "applicationId"
  749. },
  750. "indexId": {
  751. "location": "uri",
  752. "locationName": "indexId"
  753. }
  754. }
  755. },
  756. "output": {
  757. "type": "structure",
  758. "members": {}
  759. },
  760. "idempotent": true
  761. },
  762. "DeletePlugin": {
  763. "http": {
  764. "method": "DELETE",
  765. "requestUri": "/applications/{applicationId}/plugins/{pluginId}",
  766. "responseCode": 200
  767. },
  768. "input": {
  769. "type": "structure",
  770. "required": [
  771. "applicationId",
  772. "pluginId"
  773. ],
  774. "members": {
  775. "applicationId": {
  776. "location": "uri",
  777. "locationName": "applicationId"
  778. },
  779. "pluginId": {
  780. "location": "uri",
  781. "locationName": "pluginId"
  782. }
  783. }
  784. },
  785. "output": {
  786. "type": "structure",
  787. "members": {}
  788. },
  789. "idempotent": true
  790. },
  791. "DeleteRetriever": {
  792. "http": {
  793. "method": "DELETE",
  794. "requestUri": "/applications/{applicationId}/retrievers/{retrieverId}",
  795. "responseCode": 200
  796. },
  797. "input": {
  798. "type": "structure",
  799. "required": [
  800. "applicationId",
  801. "retrieverId"
  802. ],
  803. "members": {
  804. "applicationId": {
  805. "location": "uri",
  806. "locationName": "applicationId"
  807. },
  808. "retrieverId": {
  809. "location": "uri",
  810. "locationName": "retrieverId"
  811. }
  812. }
  813. },
  814. "output": {
  815. "type": "structure",
  816. "members": {}
  817. },
  818. "idempotent": true
  819. },
  820. "DeleteUser": {
  821. "http": {
  822. "method": "DELETE",
  823. "requestUri": "/applications/{applicationId}/users/{userId}",
  824. "responseCode": 200
  825. },
  826. "input": {
  827. "type": "structure",
  828. "required": [
  829. "applicationId",
  830. "userId"
  831. ],
  832. "members": {
  833. "applicationId": {
  834. "location": "uri",
  835. "locationName": "applicationId"
  836. },
  837. "userId": {
  838. "location": "uri",
  839. "locationName": "userId"
  840. }
  841. }
  842. },
  843. "output": {
  844. "type": "structure",
  845. "members": {}
  846. },
  847. "idempotent": true
  848. },
  849. "DeleteWebExperience": {
  850. "http": {
  851. "method": "DELETE",
  852. "requestUri": "/applications/{applicationId}/experiences/{webExperienceId}",
  853. "responseCode": 200
  854. },
  855. "input": {
  856. "type": "structure",
  857. "required": [
  858. "applicationId",
  859. "webExperienceId"
  860. ],
  861. "members": {
  862. "applicationId": {
  863. "location": "uri",
  864. "locationName": "applicationId"
  865. },
  866. "webExperienceId": {
  867. "location": "uri",
  868. "locationName": "webExperienceId"
  869. }
  870. }
  871. },
  872. "output": {
  873. "type": "structure",
  874. "members": {}
  875. },
  876. "idempotent": true
  877. },
  878. "GetApplication": {
  879. "http": {
  880. "method": "GET",
  881. "requestUri": "/applications/{applicationId}",
  882. "responseCode": 200
  883. },
  884. "input": {
  885. "type": "structure",
  886. "required": [
  887. "applicationId"
  888. ],
  889. "members": {
  890. "applicationId": {
  891. "location": "uri",
  892. "locationName": "applicationId"
  893. }
  894. }
  895. },
  896. "output": {
  897. "type": "structure",
  898. "members": {
  899. "displayName": {},
  900. "applicationId": {},
  901. "applicationArn": {},
  902. "identityCenterApplicationArn": {},
  903. "roleArn": {},
  904. "status": {},
  905. "description": {},
  906. "encryptionConfiguration": {
  907. "shape": "S30"
  908. },
  909. "createdAt": {
  910. "type": "timestamp"
  911. },
  912. "updatedAt": {
  913. "type": "timestamp"
  914. },
  915. "error": {
  916. "shape": "Sb"
  917. },
  918. "attachmentsConfiguration": {
  919. "type": "structure",
  920. "members": {
  921. "attachmentsControlMode": {}
  922. }
  923. }
  924. }
  925. }
  926. },
  927. "GetChatControlsConfiguration": {
  928. "http": {
  929. "method": "GET",
  930. "requestUri": "/applications/{applicationId}/chatcontrols",
  931. "responseCode": 200
  932. },
  933. "input": {
  934. "type": "structure",
  935. "required": [
  936. "applicationId"
  937. ],
  938. "members": {
  939. "applicationId": {
  940. "location": "uri",
  941. "locationName": "applicationId"
  942. },
  943. "maxResults": {
  944. "location": "querystring",
  945. "locationName": "maxResults",
  946. "type": "integer"
  947. },
  948. "nextToken": {
  949. "location": "querystring",
  950. "locationName": "nextToken"
  951. }
  952. }
  953. },
  954. "output": {
  955. "type": "structure",
  956. "members": {
  957. "responseScope": {},
  958. "blockedPhrases": {
  959. "type": "structure",
  960. "members": {
  961. "blockedPhrases": {
  962. "shape": "S5z"
  963. },
  964. "systemMessageOverride": {}
  965. }
  966. },
  967. "topicConfigurations": {
  968. "shape": "S62"
  969. },
  970. "creatorModeConfiguration": {
  971. "type": "structure",
  972. "required": [
  973. "creatorModeControl"
  974. ],
  975. "members": {
  976. "creatorModeControl": {}
  977. }
  978. },
  979. "nextToken": {}
  980. }
  981. }
  982. },
  983. "GetDataSource": {
  984. "http": {
  985. "method": "GET",
  986. "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}",
  987. "responseCode": 200
  988. },
  989. "input": {
  990. "type": "structure",
  991. "required": [
  992. "applicationId",
  993. "indexId",
  994. "dataSourceId"
  995. ],
  996. "members": {
  997. "applicationId": {
  998. "location": "uri",
  999. "locationName": "applicationId"
  1000. },
  1001. "indexId": {
  1002. "location": "uri",
  1003. "locationName": "indexId"
  1004. },
  1005. "dataSourceId": {
  1006. "location": "uri",
  1007. "locationName": "dataSourceId"
  1008. }
  1009. }
  1010. },
  1011. "output": {
  1012. "type": "structure",
  1013. "members": {
  1014. "applicationId": {},
  1015. "indexId": {},
  1016. "dataSourceId": {},
  1017. "dataSourceArn": {},
  1018. "displayName": {},
  1019. "type": {},
  1020. "configuration": {
  1021. "shape": "S3c"
  1022. },
  1023. "vpcConfiguration": {
  1024. "shape": "S3d"
  1025. },
  1026. "createdAt": {
  1027. "type": "timestamp"
  1028. },
  1029. "updatedAt": {
  1030. "type": "timestamp"
  1031. },
  1032. "description": {},
  1033. "status": {},
  1034. "syncSchedule": {},
  1035. "roleArn": {},
  1036. "error": {
  1037. "shape": "Sb"
  1038. },
  1039. "documentEnrichmentConfiguration": {
  1040. "shape": "S1a"
  1041. }
  1042. }
  1043. }
  1044. },
  1045. "GetGroup": {
  1046. "http": {
  1047. "method": "GET",
  1048. "requestUri": "/applications/{applicationId}/indices/{indexId}/groups/{groupName}",
  1049. "responseCode": 200
  1050. },
  1051. "input": {
  1052. "type": "structure",
  1053. "required": [
  1054. "applicationId",
  1055. "indexId",
  1056. "groupName"
  1057. ],
  1058. "members": {
  1059. "applicationId": {
  1060. "location": "uri",
  1061. "locationName": "applicationId"
  1062. },
  1063. "indexId": {
  1064. "location": "uri",
  1065. "locationName": "indexId"
  1066. },
  1067. "groupName": {
  1068. "location": "uri",
  1069. "locationName": "groupName"
  1070. },
  1071. "dataSourceId": {
  1072. "location": "querystring",
  1073. "locationName": "dataSourceId"
  1074. }
  1075. }
  1076. },
  1077. "output": {
  1078. "type": "structure",
  1079. "members": {
  1080. "status": {
  1081. "shape": "S6p"
  1082. },
  1083. "statusHistory": {
  1084. "type": "list",
  1085. "member": {
  1086. "shape": "S6p"
  1087. }
  1088. }
  1089. }
  1090. }
  1091. },
  1092. "GetIndex": {
  1093. "http": {
  1094. "method": "GET",
  1095. "requestUri": "/applications/{applicationId}/indices/{indexId}",
  1096. "responseCode": 200
  1097. },
  1098. "input": {
  1099. "type": "structure",
  1100. "required": [
  1101. "applicationId",
  1102. "indexId"
  1103. ],
  1104. "members": {
  1105. "applicationId": {
  1106. "location": "uri",
  1107. "locationName": "applicationId"
  1108. },
  1109. "indexId": {
  1110. "location": "uri",
  1111. "locationName": "indexId"
  1112. }
  1113. }
  1114. },
  1115. "output": {
  1116. "type": "structure",
  1117. "members": {
  1118. "applicationId": {},
  1119. "indexId": {},
  1120. "displayName": {},
  1121. "type": {},
  1122. "indexArn": {},
  1123. "status": {},
  1124. "description": {},
  1125. "createdAt": {
  1126. "type": "timestamp"
  1127. },
  1128. "updatedAt": {
  1129. "type": "timestamp"
  1130. },
  1131. "capacityConfiguration": {
  1132. "shape": "S3o"
  1133. },
  1134. "documentAttributeConfigurations": {
  1135. "shape": "S6v"
  1136. },
  1137. "error": {
  1138. "shape": "Sb"
  1139. },
  1140. "indexStatistics": {
  1141. "type": "structure",
  1142. "members": {
  1143. "textDocumentStatistics": {
  1144. "type": "structure",
  1145. "members": {
  1146. "indexedTextBytes": {
  1147. "type": "long"
  1148. },
  1149. "indexedTextDocumentCount": {
  1150. "type": "integer"
  1151. }
  1152. }
  1153. }
  1154. }
  1155. }
  1156. }
  1157. }
  1158. },
  1159. "GetPlugin": {
  1160. "http": {
  1161. "method": "GET",
  1162. "requestUri": "/applications/{applicationId}/plugins/{pluginId}",
  1163. "responseCode": 200
  1164. },
  1165. "input": {
  1166. "type": "structure",
  1167. "required": [
  1168. "applicationId",
  1169. "pluginId"
  1170. ],
  1171. "members": {
  1172. "applicationId": {
  1173. "location": "uri",
  1174. "locationName": "applicationId"
  1175. },
  1176. "pluginId": {
  1177. "location": "uri",
  1178. "locationName": "pluginId"
  1179. }
  1180. }
  1181. },
  1182. "output": {
  1183. "type": "structure",
  1184. "members": {
  1185. "applicationId": {},
  1186. "pluginId": {},
  1187. "displayName": {},
  1188. "type": {},
  1189. "serverUrl": {},
  1190. "authConfiguration": {
  1191. "shape": "S3u"
  1192. },
  1193. "customPluginConfiguration": {
  1194. "shape": "S3z"
  1195. },
  1196. "buildStatus": {},
  1197. "pluginArn": {},
  1198. "state": {},
  1199. "createdAt": {
  1200. "type": "timestamp"
  1201. },
  1202. "updatedAt": {
  1203. "type": "timestamp"
  1204. }
  1205. }
  1206. }
  1207. },
  1208. "GetRetriever": {
  1209. "http": {
  1210. "method": "GET",
  1211. "requestUri": "/applications/{applicationId}/retrievers/{retrieverId}",
  1212. "responseCode": 200
  1213. },
  1214. "input": {
  1215. "type": "structure",
  1216. "required": [
  1217. "applicationId",
  1218. "retrieverId"
  1219. ],
  1220. "members": {
  1221. "applicationId": {
  1222. "location": "uri",
  1223. "locationName": "applicationId"
  1224. },
  1225. "retrieverId": {
  1226. "location": "uri",
  1227. "locationName": "retrieverId"
  1228. }
  1229. }
  1230. },
  1231. "output": {
  1232. "type": "structure",
  1233. "members": {
  1234. "applicationId": {},
  1235. "retrieverId": {},
  1236. "retrieverArn": {},
  1237. "type": {},
  1238. "status": {},
  1239. "displayName": {},
  1240. "configuration": {
  1241. "shape": "S4a"
  1242. },
  1243. "roleArn": {},
  1244. "createdAt": {
  1245. "type": "timestamp"
  1246. },
  1247. "updatedAt": {
  1248. "type": "timestamp"
  1249. }
  1250. }
  1251. }
  1252. },
  1253. "GetUser": {
  1254. "http": {
  1255. "method": "GET",
  1256. "requestUri": "/applications/{applicationId}/users/{userId}",
  1257. "responseCode": 200
  1258. },
  1259. "input": {
  1260. "type": "structure",
  1261. "required": [
  1262. "applicationId",
  1263. "userId"
  1264. ],
  1265. "members": {
  1266. "applicationId": {
  1267. "location": "uri",
  1268. "locationName": "applicationId"
  1269. },
  1270. "userId": {
  1271. "location": "uri",
  1272. "locationName": "userId"
  1273. }
  1274. }
  1275. },
  1276. "output": {
  1277. "type": "structure",
  1278. "members": {
  1279. "userAliases": {
  1280. "shape": "S7c"
  1281. }
  1282. }
  1283. }
  1284. },
  1285. "GetWebExperience": {
  1286. "http": {
  1287. "method": "GET",
  1288. "requestUri": "/applications/{applicationId}/experiences/{webExperienceId}",
  1289. "responseCode": 200
  1290. },
  1291. "input": {
  1292. "type": "structure",
  1293. "required": [
  1294. "applicationId",
  1295. "webExperienceId"
  1296. ],
  1297. "members": {
  1298. "applicationId": {
  1299. "location": "uri",
  1300. "locationName": "applicationId"
  1301. },
  1302. "webExperienceId": {
  1303. "location": "uri",
  1304. "locationName": "webExperienceId"
  1305. }
  1306. }
  1307. },
  1308. "output": {
  1309. "type": "structure",
  1310. "members": {
  1311. "applicationId": {},
  1312. "webExperienceId": {},
  1313. "webExperienceArn": {},
  1314. "defaultEndpoint": {},
  1315. "status": {},
  1316. "createdAt": {
  1317. "type": "timestamp"
  1318. },
  1319. "updatedAt": {
  1320. "type": "timestamp"
  1321. },
  1322. "title": {},
  1323. "subtitle": {},
  1324. "welcomeMessage": {},
  1325. "samplePromptsControlMode": {},
  1326. "roleArn": {},
  1327. "authenticationConfiguration": {
  1328. "shape": "S7g",
  1329. "deprecated": true,
  1330. "deprecatedMessage": "Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management."
  1331. },
  1332. "error": {
  1333. "shape": "Sb"
  1334. }
  1335. }
  1336. }
  1337. },
  1338. "ListApplications": {
  1339. "http": {
  1340. "method": "GET",
  1341. "requestUri": "/applications",
  1342. "responseCode": 200
  1343. },
  1344. "input": {
  1345. "type": "structure",
  1346. "members": {
  1347. "nextToken": {
  1348. "location": "querystring",
  1349. "locationName": "nextToken"
  1350. },
  1351. "maxResults": {
  1352. "location": "querystring",
  1353. "locationName": "maxResults",
  1354. "type": "integer"
  1355. }
  1356. }
  1357. },
  1358. "output": {
  1359. "type": "structure",
  1360. "members": {
  1361. "nextToken": {},
  1362. "applications": {
  1363. "type": "list",
  1364. "member": {
  1365. "type": "structure",
  1366. "members": {
  1367. "displayName": {},
  1368. "applicationId": {},
  1369. "createdAt": {
  1370. "type": "timestamp"
  1371. },
  1372. "updatedAt": {
  1373. "type": "timestamp"
  1374. },
  1375. "status": {}
  1376. }
  1377. }
  1378. }
  1379. }
  1380. }
  1381. },
  1382. "ListConversations": {
  1383. "http": {
  1384. "method": "GET",
  1385. "requestUri": "/applications/{applicationId}/conversations",
  1386. "responseCode": 200
  1387. },
  1388. "input": {
  1389. "type": "structure",
  1390. "required": [
  1391. "applicationId"
  1392. ],
  1393. "members": {
  1394. "applicationId": {
  1395. "location": "uri",
  1396. "locationName": "applicationId"
  1397. },
  1398. "userId": {
  1399. "location": "querystring",
  1400. "locationName": "userId"
  1401. },
  1402. "nextToken": {
  1403. "location": "querystring",
  1404. "locationName": "nextToken"
  1405. },
  1406. "maxResults": {
  1407. "location": "querystring",
  1408. "locationName": "maxResults",
  1409. "type": "integer"
  1410. }
  1411. }
  1412. },
  1413. "output": {
  1414. "type": "structure",
  1415. "members": {
  1416. "nextToken": {},
  1417. "conversations": {
  1418. "type": "list",
  1419. "member": {
  1420. "type": "structure",
  1421. "members": {
  1422. "conversationId": {},
  1423. "title": {},
  1424. "startTime": {
  1425. "type": "timestamp"
  1426. }
  1427. }
  1428. }
  1429. }
  1430. }
  1431. }
  1432. },
  1433. "ListDataSourceSyncJobs": {
  1434. "http": {
  1435. "method": "GET",
  1436. "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/syncjobs",
  1437. "responseCode": 200
  1438. },
  1439. "input": {
  1440. "type": "structure",
  1441. "required": [
  1442. "dataSourceId",
  1443. "applicationId",
  1444. "indexId"
  1445. ],
  1446. "members": {
  1447. "dataSourceId": {
  1448. "location": "uri",
  1449. "locationName": "dataSourceId"
  1450. },
  1451. "applicationId": {
  1452. "location": "uri",
  1453. "locationName": "applicationId"
  1454. },
  1455. "indexId": {
  1456. "location": "uri",
  1457. "locationName": "indexId"
  1458. },
  1459. "nextToken": {
  1460. "location": "querystring",
  1461. "locationName": "nextToken"
  1462. },
  1463. "maxResults": {
  1464. "location": "querystring",
  1465. "locationName": "maxResults",
  1466. "type": "integer"
  1467. },
  1468. "startTime": {
  1469. "location": "querystring",
  1470. "locationName": "startTime",
  1471. "type": "timestamp"
  1472. },
  1473. "endTime": {
  1474. "location": "querystring",
  1475. "locationName": "endTime",
  1476. "type": "timestamp"
  1477. },
  1478. "statusFilter": {
  1479. "location": "querystring",
  1480. "locationName": "syncStatus"
  1481. }
  1482. }
  1483. },
  1484. "output": {
  1485. "type": "structure",
  1486. "members": {
  1487. "history": {
  1488. "type": "list",
  1489. "member": {
  1490. "type": "structure",
  1491. "members": {
  1492. "executionId": {},
  1493. "startTime": {
  1494. "type": "timestamp"
  1495. },
  1496. "endTime": {
  1497. "type": "timestamp"
  1498. },
  1499. "status": {},
  1500. "error": {
  1501. "shape": "Sb"
  1502. },
  1503. "dataSourceErrorCode": {},
  1504. "metrics": {
  1505. "type": "structure",
  1506. "members": {
  1507. "documentsAdded": {},
  1508. "documentsModified": {},
  1509. "documentsDeleted": {},
  1510. "documentsFailed": {},
  1511. "documentsScanned": {}
  1512. }
  1513. }
  1514. }
  1515. }
  1516. },
  1517. "nextToken": {}
  1518. }
  1519. }
  1520. },
  1521. "ListDataSources": {
  1522. "http": {
  1523. "method": "GET",
  1524. "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources",
  1525. "responseCode": 200
  1526. },
  1527. "input": {
  1528. "type": "structure",
  1529. "required": [
  1530. "applicationId",
  1531. "indexId"
  1532. ],
  1533. "members": {
  1534. "applicationId": {
  1535. "location": "uri",
  1536. "locationName": "applicationId"
  1537. },
  1538. "indexId": {
  1539. "location": "uri",
  1540. "locationName": "indexId"
  1541. },
  1542. "nextToken": {
  1543. "location": "querystring",
  1544. "locationName": "nextToken"
  1545. },
  1546. "maxResults": {
  1547. "location": "querystring",
  1548. "locationName": "maxResults",
  1549. "type": "integer"
  1550. }
  1551. }
  1552. },
  1553. "output": {
  1554. "type": "structure",
  1555. "members": {
  1556. "dataSources": {
  1557. "type": "list",
  1558. "member": {
  1559. "type": "structure",
  1560. "members": {
  1561. "displayName": {},
  1562. "dataSourceId": {},
  1563. "type": {},
  1564. "createdAt": {
  1565. "type": "timestamp"
  1566. },
  1567. "updatedAt": {
  1568. "type": "timestamp"
  1569. },
  1570. "status": {}
  1571. }
  1572. }
  1573. },
  1574. "nextToken": {}
  1575. }
  1576. }
  1577. },
  1578. "ListDocuments": {
  1579. "http": {
  1580. "method": "GET",
  1581. "requestUri": "/applications/{applicationId}/index/{indexId}/documents",
  1582. "responseCode": 200
  1583. },
  1584. "input": {
  1585. "type": "structure",
  1586. "required": [
  1587. "applicationId",
  1588. "indexId"
  1589. ],
  1590. "members": {
  1591. "applicationId": {
  1592. "location": "uri",
  1593. "locationName": "applicationId"
  1594. },
  1595. "indexId": {
  1596. "location": "uri",
  1597. "locationName": "indexId"
  1598. },
  1599. "dataSourceIds": {
  1600. "location": "querystring",
  1601. "locationName": "dataSourceIds",
  1602. "type": "list",
  1603. "member": {}
  1604. },
  1605. "nextToken": {
  1606. "location": "querystring",
  1607. "locationName": "nextToken"
  1608. },
  1609. "maxResults": {
  1610. "location": "querystring",
  1611. "locationName": "maxResults",
  1612. "type": "integer"
  1613. }
  1614. }
  1615. },
  1616. "output": {
  1617. "type": "structure",
  1618. "members": {
  1619. "documentDetailList": {
  1620. "type": "list",
  1621. "member": {
  1622. "type": "structure",
  1623. "members": {
  1624. "documentId": {},
  1625. "status": {},
  1626. "error": {
  1627. "shape": "Sb"
  1628. },
  1629. "createdAt": {
  1630. "type": "timestamp"
  1631. },
  1632. "updatedAt": {
  1633. "type": "timestamp"
  1634. }
  1635. }
  1636. }
  1637. },
  1638. "nextToken": {}
  1639. }
  1640. }
  1641. },
  1642. "ListGroups": {
  1643. "http": {
  1644. "method": "GET",
  1645. "requestUri": "/applications/{applicationId}/indices/{indexId}/groups",
  1646. "responseCode": 200
  1647. },
  1648. "input": {
  1649. "type": "structure",
  1650. "required": [
  1651. "applicationId",
  1652. "indexId",
  1653. "updatedEarlierThan"
  1654. ],
  1655. "members": {
  1656. "applicationId": {
  1657. "location": "uri",
  1658. "locationName": "applicationId"
  1659. },
  1660. "indexId": {
  1661. "location": "uri",
  1662. "locationName": "indexId"
  1663. },
  1664. "updatedEarlierThan": {
  1665. "location": "querystring",
  1666. "locationName": "updatedEarlierThan",
  1667. "type": "timestamp"
  1668. },
  1669. "dataSourceId": {
  1670. "location": "querystring",
  1671. "locationName": "dataSourceId"
  1672. },
  1673. "nextToken": {
  1674. "location": "querystring",
  1675. "locationName": "nextToken"
  1676. },
  1677. "maxResults": {
  1678. "location": "querystring",
  1679. "locationName": "maxResults",
  1680. "type": "integer"
  1681. }
  1682. }
  1683. },
  1684. "output": {
  1685. "type": "structure",
  1686. "members": {
  1687. "nextToken": {},
  1688. "items": {
  1689. "type": "list",
  1690. "member": {
  1691. "type": "structure",
  1692. "members": {
  1693. "groupName": {}
  1694. }
  1695. }
  1696. }
  1697. }
  1698. }
  1699. },
  1700. "ListIndices": {
  1701. "http": {
  1702. "method": "GET",
  1703. "requestUri": "/applications/{applicationId}/indices",
  1704. "responseCode": 200
  1705. },
  1706. "input": {
  1707. "type": "structure",
  1708. "required": [
  1709. "applicationId"
  1710. ],
  1711. "members": {
  1712. "applicationId": {
  1713. "location": "uri",
  1714. "locationName": "applicationId"
  1715. },
  1716. "nextToken": {
  1717. "location": "querystring",
  1718. "locationName": "nextToken"
  1719. },
  1720. "maxResults": {
  1721. "location": "querystring",
  1722. "locationName": "maxResults",
  1723. "type": "integer"
  1724. }
  1725. }
  1726. },
  1727. "output": {
  1728. "type": "structure",
  1729. "members": {
  1730. "nextToken": {},
  1731. "indices": {
  1732. "type": "list",
  1733. "member": {
  1734. "type": "structure",
  1735. "members": {
  1736. "displayName": {},
  1737. "indexId": {},
  1738. "createdAt": {
  1739. "type": "timestamp"
  1740. },
  1741. "updatedAt": {
  1742. "type": "timestamp"
  1743. },
  1744. "status": {}
  1745. }
  1746. }
  1747. }
  1748. }
  1749. }
  1750. },
  1751. "ListMessages": {
  1752. "http": {
  1753. "method": "GET",
  1754. "requestUri": "/applications/{applicationId}/conversations/{conversationId}",
  1755. "responseCode": 200
  1756. },
  1757. "input": {
  1758. "type": "structure",
  1759. "required": [
  1760. "conversationId",
  1761. "applicationId"
  1762. ],
  1763. "members": {
  1764. "conversationId": {
  1765. "location": "uri",
  1766. "locationName": "conversationId"
  1767. },
  1768. "applicationId": {
  1769. "location": "uri",
  1770. "locationName": "applicationId"
  1771. },
  1772. "userId": {
  1773. "location": "querystring",
  1774. "locationName": "userId"
  1775. },
  1776. "nextToken": {
  1777. "location": "querystring",
  1778. "locationName": "nextToken"
  1779. },
  1780. "maxResults": {
  1781. "location": "querystring",
  1782. "locationName": "maxResults",
  1783. "type": "integer"
  1784. }
  1785. }
  1786. },
  1787. "output": {
  1788. "type": "structure",
  1789. "members": {
  1790. "messages": {
  1791. "type": "list",
  1792. "member": {
  1793. "type": "structure",
  1794. "members": {
  1795. "messageId": {},
  1796. "body": {},
  1797. "time": {
  1798. "type": "timestamp"
  1799. },
  1800. "type": {},
  1801. "attachments": {
  1802. "shape": "S2t"
  1803. },
  1804. "sourceAttribution": {
  1805. "shape": "S2n"
  1806. },
  1807. "actionReview": {
  1808. "shape": "S2c"
  1809. },
  1810. "actionExecution": {
  1811. "shape": "S1s"
  1812. }
  1813. }
  1814. }
  1815. },
  1816. "nextToken": {}
  1817. }
  1818. }
  1819. },
  1820. "ListPlugins": {
  1821. "http": {
  1822. "method": "GET",
  1823. "requestUri": "/applications/{applicationId}/plugins",
  1824. "responseCode": 200
  1825. },
  1826. "input": {
  1827. "type": "structure",
  1828. "required": [
  1829. "applicationId"
  1830. ],
  1831. "members": {
  1832. "applicationId": {
  1833. "location": "uri",
  1834. "locationName": "applicationId"
  1835. },
  1836. "nextToken": {
  1837. "location": "querystring",
  1838. "locationName": "nextToken"
  1839. },
  1840. "maxResults": {
  1841. "location": "querystring",
  1842. "locationName": "maxResults",
  1843. "type": "integer"
  1844. }
  1845. }
  1846. },
  1847. "output": {
  1848. "type": "structure",
  1849. "members": {
  1850. "nextToken": {},
  1851. "plugins": {
  1852. "type": "list",
  1853. "member": {
  1854. "type": "structure",
  1855. "members": {
  1856. "pluginId": {},
  1857. "displayName": {},
  1858. "type": {},
  1859. "serverUrl": {},
  1860. "state": {},
  1861. "buildStatus": {},
  1862. "createdAt": {
  1863. "type": "timestamp"
  1864. },
  1865. "updatedAt": {
  1866. "type": "timestamp"
  1867. }
  1868. }
  1869. }
  1870. }
  1871. }
  1872. }
  1873. },
  1874. "ListRetrievers": {
  1875. "http": {
  1876. "method": "GET",
  1877. "requestUri": "/applications/{applicationId}/retrievers",
  1878. "responseCode": 200
  1879. },
  1880. "input": {
  1881. "type": "structure",
  1882. "required": [
  1883. "applicationId"
  1884. ],
  1885. "members": {
  1886. "applicationId": {
  1887. "location": "uri",
  1888. "locationName": "applicationId"
  1889. },
  1890. "nextToken": {
  1891. "location": "querystring",
  1892. "locationName": "nextToken"
  1893. },
  1894. "maxResults": {
  1895. "location": "querystring",
  1896. "locationName": "maxResults",
  1897. "type": "integer"
  1898. }
  1899. }
  1900. },
  1901. "output": {
  1902. "type": "structure",
  1903. "members": {
  1904. "retrievers": {
  1905. "type": "list",
  1906. "member": {
  1907. "type": "structure",
  1908. "members": {
  1909. "applicationId": {},
  1910. "retrieverId": {},
  1911. "type": {},
  1912. "status": {},
  1913. "displayName": {}
  1914. }
  1915. }
  1916. },
  1917. "nextToken": {}
  1918. }
  1919. }
  1920. },
  1921. "ListTagsForResource": {
  1922. "http": {
  1923. "method": "GET",
  1924. "requestUri": "/v1/tags/{resourceARN}",
  1925. "responseCode": 200
  1926. },
  1927. "input": {
  1928. "type": "structure",
  1929. "required": [
  1930. "resourceARN"
  1931. ],
  1932. "members": {
  1933. "resourceARN": {
  1934. "location": "uri",
  1935. "locationName": "resourceARN"
  1936. }
  1937. }
  1938. },
  1939. "output": {
  1940. "type": "structure",
  1941. "members": {
  1942. "tags": {
  1943. "shape": "S32"
  1944. }
  1945. }
  1946. }
  1947. },
  1948. "ListWebExperiences": {
  1949. "http": {
  1950. "method": "GET",
  1951. "requestUri": "/applications/{applicationId}/experiences",
  1952. "responseCode": 200
  1953. },
  1954. "input": {
  1955. "type": "structure",
  1956. "required": [
  1957. "applicationId"
  1958. ],
  1959. "members": {
  1960. "applicationId": {
  1961. "location": "uri",
  1962. "locationName": "applicationId"
  1963. },
  1964. "nextToken": {
  1965. "location": "querystring",
  1966. "locationName": "nextToken"
  1967. },
  1968. "maxResults": {
  1969. "location": "querystring",
  1970. "locationName": "maxResults",
  1971. "type": "integer"
  1972. }
  1973. }
  1974. },
  1975. "output": {
  1976. "type": "structure",
  1977. "members": {
  1978. "webExperiences": {
  1979. "type": "list",
  1980. "member": {
  1981. "type": "structure",
  1982. "members": {
  1983. "webExperienceId": {},
  1984. "createdAt": {
  1985. "type": "timestamp"
  1986. },
  1987. "updatedAt": {
  1988. "type": "timestamp"
  1989. },
  1990. "defaultEndpoint": {},
  1991. "status": {}
  1992. }
  1993. }
  1994. },
  1995. "nextToken": {}
  1996. }
  1997. }
  1998. },
  1999. "PutFeedback": {
  2000. "http": {
  2001. "requestUri": "/applications/{applicationId}/conversations/{conversationId}/messages/{messageId}/feedback",
  2002. "responseCode": 200
  2003. },
  2004. "input": {
  2005. "type": "structure",
  2006. "required": [
  2007. "applicationId",
  2008. "conversationId",
  2009. "messageId"
  2010. ],
  2011. "members": {
  2012. "applicationId": {
  2013. "location": "uri",
  2014. "locationName": "applicationId"
  2015. },
  2016. "userId": {
  2017. "location": "querystring",
  2018. "locationName": "userId"
  2019. },
  2020. "conversationId": {
  2021. "location": "uri",
  2022. "locationName": "conversationId"
  2023. },
  2024. "messageId": {
  2025. "location": "uri",
  2026. "locationName": "messageId"
  2027. },
  2028. "messageCopiedAt": {
  2029. "type": "timestamp"
  2030. },
  2031. "messageUsefulness": {
  2032. "type": "structure",
  2033. "required": [
  2034. "usefulness",
  2035. "submittedAt"
  2036. ],
  2037. "members": {
  2038. "usefulness": {},
  2039. "reason": {},
  2040. "comment": {},
  2041. "submittedAt": {
  2042. "type": "timestamp"
  2043. }
  2044. }
  2045. }
  2046. }
  2047. }
  2048. },
  2049. "PutGroup": {
  2050. "http": {
  2051. "method": "PUT",
  2052. "requestUri": "/applications/{applicationId}/indices/{indexId}/groups",
  2053. "responseCode": 200
  2054. },
  2055. "input": {
  2056. "type": "structure",
  2057. "required": [
  2058. "applicationId",
  2059. "indexId",
  2060. "groupName",
  2061. "type",
  2062. "groupMembers"
  2063. ],
  2064. "members": {
  2065. "applicationId": {
  2066. "location": "uri",
  2067. "locationName": "applicationId"
  2068. },
  2069. "indexId": {
  2070. "location": "uri",
  2071. "locationName": "indexId"
  2072. },
  2073. "groupName": {},
  2074. "dataSourceId": {},
  2075. "type": {},
  2076. "groupMembers": {
  2077. "type": "structure",
  2078. "members": {
  2079. "memberGroups": {
  2080. "type": "list",
  2081. "member": {
  2082. "type": "structure",
  2083. "required": [
  2084. "groupName"
  2085. ],
  2086. "members": {
  2087. "groupName": {},
  2088. "type": {}
  2089. }
  2090. }
  2091. },
  2092. "memberUsers": {
  2093. "type": "list",
  2094. "member": {
  2095. "type": "structure",
  2096. "required": [
  2097. "userId"
  2098. ],
  2099. "members": {
  2100. "userId": {},
  2101. "type": {}
  2102. }
  2103. }
  2104. }
  2105. }
  2106. }
  2107. }
  2108. },
  2109. "output": {
  2110. "type": "structure",
  2111. "members": {}
  2112. },
  2113. "idempotent": true
  2114. },
  2115. "StartDataSourceSyncJob": {
  2116. "http": {
  2117. "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/startsync",
  2118. "responseCode": 200
  2119. },
  2120. "input": {
  2121. "type": "structure",
  2122. "required": [
  2123. "dataSourceId",
  2124. "applicationId",
  2125. "indexId"
  2126. ],
  2127. "members": {
  2128. "dataSourceId": {
  2129. "location": "uri",
  2130. "locationName": "dataSourceId"
  2131. },
  2132. "applicationId": {
  2133. "location": "uri",
  2134. "locationName": "applicationId"
  2135. },
  2136. "indexId": {
  2137. "location": "uri",
  2138. "locationName": "indexId"
  2139. }
  2140. }
  2141. },
  2142. "output": {
  2143. "type": "structure",
  2144. "members": {
  2145. "executionId": {}
  2146. }
  2147. }
  2148. },
  2149. "StopDataSourceSyncJob": {
  2150. "http": {
  2151. "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/stopsync",
  2152. "responseCode": 200
  2153. },
  2154. "input": {
  2155. "type": "structure",
  2156. "required": [
  2157. "dataSourceId",
  2158. "applicationId",
  2159. "indexId"
  2160. ],
  2161. "members": {
  2162. "dataSourceId": {
  2163. "location": "uri",
  2164. "locationName": "dataSourceId"
  2165. },
  2166. "applicationId": {
  2167. "location": "uri",
  2168. "locationName": "applicationId"
  2169. },
  2170. "indexId": {
  2171. "location": "uri",
  2172. "locationName": "indexId"
  2173. }
  2174. }
  2175. },
  2176. "output": {
  2177. "type": "structure",
  2178. "members": {}
  2179. }
  2180. },
  2181. "TagResource": {
  2182. "http": {
  2183. "requestUri": "/v1/tags/{resourceARN}",
  2184. "responseCode": 200
  2185. },
  2186. "input": {
  2187. "type": "structure",
  2188. "required": [
  2189. "resourceARN",
  2190. "tags"
  2191. ],
  2192. "members": {
  2193. "resourceARN": {
  2194. "location": "uri",
  2195. "locationName": "resourceARN"
  2196. },
  2197. "tags": {
  2198. "shape": "S32"
  2199. }
  2200. }
  2201. },
  2202. "output": {
  2203. "type": "structure",
  2204. "members": {}
  2205. },
  2206. "idempotent": true
  2207. },
  2208. "UntagResource": {
  2209. "http": {
  2210. "method": "DELETE",
  2211. "requestUri": "/v1/tags/{resourceARN}",
  2212. "responseCode": 200
  2213. },
  2214. "input": {
  2215. "type": "structure",
  2216. "required": [
  2217. "resourceARN",
  2218. "tagKeys"
  2219. ],
  2220. "members": {
  2221. "resourceARN": {
  2222. "location": "uri",
  2223. "locationName": "resourceARN"
  2224. },
  2225. "tagKeys": {
  2226. "location": "querystring",
  2227. "locationName": "tagKeys",
  2228. "type": "list",
  2229. "member": {}
  2230. }
  2231. }
  2232. },
  2233. "output": {
  2234. "type": "structure",
  2235. "members": {}
  2236. },
  2237. "idempotent": true
  2238. },
  2239. "UpdateApplication": {
  2240. "http": {
  2241. "method": "PUT",
  2242. "requestUri": "/applications/{applicationId}",
  2243. "responseCode": 200
  2244. },
  2245. "input": {
  2246. "type": "structure",
  2247. "required": [
  2248. "applicationId"
  2249. ],
  2250. "members": {
  2251. "applicationId": {
  2252. "location": "uri",
  2253. "locationName": "applicationId"
  2254. },
  2255. "identityCenterInstanceArn": {},
  2256. "displayName": {},
  2257. "description": {},
  2258. "roleArn": {},
  2259. "attachmentsConfiguration": {
  2260. "shape": "S36"
  2261. }
  2262. }
  2263. },
  2264. "output": {
  2265. "type": "structure",
  2266. "members": {}
  2267. },
  2268. "idempotent": true
  2269. },
  2270. "UpdateChatControlsConfiguration": {
  2271. "http": {
  2272. "method": "PATCH",
  2273. "requestUri": "/applications/{applicationId}/chatcontrols",
  2274. "responseCode": 200
  2275. },
  2276. "input": {
  2277. "type": "structure",
  2278. "required": [
  2279. "applicationId"
  2280. ],
  2281. "members": {
  2282. "applicationId": {
  2283. "location": "uri",
  2284. "locationName": "applicationId"
  2285. },
  2286. "clientToken": {
  2287. "idempotencyToken": true
  2288. },
  2289. "responseScope": {},
  2290. "blockedPhrasesConfigurationUpdate": {
  2291. "type": "structure",
  2292. "members": {
  2293. "blockedPhrasesToCreateOrUpdate": {
  2294. "shape": "S5z"
  2295. },
  2296. "blockedPhrasesToDelete": {
  2297. "shape": "S5z"
  2298. },
  2299. "systemMessageOverride": {}
  2300. }
  2301. },
  2302. "topicConfigurationsToCreateOrUpdate": {
  2303. "shape": "S62"
  2304. },
  2305. "topicConfigurationsToDelete": {
  2306. "shape": "S62"
  2307. },
  2308. "creatorModeConfiguration": {
  2309. "type": "structure",
  2310. "required": [
  2311. "creatorModeControl"
  2312. ],
  2313. "members": {
  2314. "creatorModeControl": {}
  2315. }
  2316. }
  2317. }
  2318. },
  2319. "output": {
  2320. "type": "structure",
  2321. "members": {}
  2322. },
  2323. "idempotent": true
  2324. },
  2325. "UpdateDataSource": {
  2326. "http": {
  2327. "method": "PUT",
  2328. "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}",
  2329. "responseCode": 200
  2330. },
  2331. "input": {
  2332. "type": "structure",
  2333. "required": [
  2334. "applicationId",
  2335. "indexId",
  2336. "dataSourceId"
  2337. ],
  2338. "members": {
  2339. "applicationId": {
  2340. "location": "uri",
  2341. "locationName": "applicationId"
  2342. },
  2343. "indexId": {
  2344. "location": "uri",
  2345. "locationName": "indexId"
  2346. },
  2347. "dataSourceId": {
  2348. "location": "uri",
  2349. "locationName": "dataSourceId"
  2350. },
  2351. "displayName": {},
  2352. "configuration": {
  2353. "shape": "S3c"
  2354. },
  2355. "vpcConfiguration": {
  2356. "shape": "S3d"
  2357. },
  2358. "description": {},
  2359. "syncSchedule": {},
  2360. "roleArn": {},
  2361. "documentEnrichmentConfiguration": {
  2362. "shape": "S1a"
  2363. }
  2364. }
  2365. },
  2366. "output": {
  2367. "type": "structure",
  2368. "members": {}
  2369. },
  2370. "idempotent": true
  2371. },
  2372. "UpdateIndex": {
  2373. "http": {
  2374. "method": "PUT",
  2375. "requestUri": "/applications/{applicationId}/indices/{indexId}",
  2376. "responseCode": 200
  2377. },
  2378. "input": {
  2379. "type": "structure",
  2380. "required": [
  2381. "applicationId",
  2382. "indexId"
  2383. ],
  2384. "members": {
  2385. "applicationId": {
  2386. "location": "uri",
  2387. "locationName": "applicationId"
  2388. },
  2389. "indexId": {
  2390. "location": "uri",
  2391. "locationName": "indexId"
  2392. },
  2393. "displayName": {},
  2394. "description": {},
  2395. "capacityConfiguration": {
  2396. "shape": "S3o"
  2397. },
  2398. "documentAttributeConfigurations": {
  2399. "shape": "S6v"
  2400. }
  2401. }
  2402. },
  2403. "output": {
  2404. "type": "structure",
  2405. "members": {}
  2406. },
  2407. "idempotent": true
  2408. },
  2409. "UpdatePlugin": {
  2410. "http": {
  2411. "method": "PUT",
  2412. "requestUri": "/applications/{applicationId}/plugins/{pluginId}",
  2413. "responseCode": 200
  2414. },
  2415. "input": {
  2416. "type": "structure",
  2417. "required": [
  2418. "applicationId",
  2419. "pluginId"
  2420. ],
  2421. "members": {
  2422. "applicationId": {
  2423. "location": "uri",
  2424. "locationName": "applicationId"
  2425. },
  2426. "pluginId": {
  2427. "location": "uri",
  2428. "locationName": "pluginId"
  2429. },
  2430. "displayName": {},
  2431. "state": {},
  2432. "serverUrl": {},
  2433. "customPluginConfiguration": {
  2434. "shape": "S3z"
  2435. },
  2436. "authConfiguration": {
  2437. "shape": "S3u"
  2438. }
  2439. }
  2440. },
  2441. "output": {
  2442. "type": "structure",
  2443. "members": {}
  2444. },
  2445. "idempotent": true
  2446. },
  2447. "UpdateRetriever": {
  2448. "http": {
  2449. "method": "PUT",
  2450. "requestUri": "/applications/{applicationId}/retrievers/{retrieverId}",
  2451. "responseCode": 200
  2452. },
  2453. "input": {
  2454. "type": "structure",
  2455. "required": [
  2456. "applicationId",
  2457. "retrieverId"
  2458. ],
  2459. "members": {
  2460. "applicationId": {
  2461. "location": "uri",
  2462. "locationName": "applicationId"
  2463. },
  2464. "retrieverId": {
  2465. "location": "uri",
  2466. "locationName": "retrieverId"
  2467. },
  2468. "configuration": {
  2469. "shape": "S4a"
  2470. },
  2471. "displayName": {},
  2472. "roleArn": {}
  2473. }
  2474. },
  2475. "output": {
  2476. "type": "structure",
  2477. "members": {}
  2478. },
  2479. "idempotent": true
  2480. },
  2481. "UpdateUser": {
  2482. "http": {
  2483. "method": "PUT",
  2484. "requestUri": "/applications/{applicationId}/users/{userId}",
  2485. "responseCode": 200
  2486. },
  2487. "input": {
  2488. "type": "structure",
  2489. "required": [
  2490. "applicationId",
  2491. "userId"
  2492. ],
  2493. "members": {
  2494. "applicationId": {
  2495. "location": "uri",
  2496. "locationName": "applicationId"
  2497. },
  2498. "userId": {
  2499. "location": "uri",
  2500. "locationName": "userId"
  2501. },
  2502. "userAliasesToUpdate": {
  2503. "shape": "S7c"
  2504. },
  2505. "userAliasesToDelete": {
  2506. "shape": "S7c"
  2507. }
  2508. }
  2509. },
  2510. "output": {
  2511. "type": "structure",
  2512. "members": {
  2513. "userAliasesAdded": {
  2514. "shape": "S7c"
  2515. },
  2516. "userAliasesUpdated": {
  2517. "shape": "S7c"
  2518. },
  2519. "userAliasesDeleted": {
  2520. "shape": "S7c"
  2521. }
  2522. }
  2523. },
  2524. "idempotent": true
  2525. },
  2526. "UpdateWebExperience": {
  2527. "http": {
  2528. "method": "PUT",
  2529. "requestUri": "/applications/{applicationId}/experiences/{webExperienceId}",
  2530. "responseCode": 200
  2531. },
  2532. "input": {
  2533. "type": "structure",
  2534. "required": [
  2535. "applicationId",
  2536. "webExperienceId"
  2537. ],
  2538. "members": {
  2539. "applicationId": {
  2540. "location": "uri",
  2541. "locationName": "applicationId"
  2542. },
  2543. "webExperienceId": {
  2544. "location": "uri",
  2545. "locationName": "webExperienceId"
  2546. },
  2547. "roleArn": {},
  2548. "authenticationConfiguration": {
  2549. "shape": "S7g",
  2550. "deprecated": true,
  2551. "deprecatedMessage": "Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management."
  2552. },
  2553. "title": {},
  2554. "subtitle": {},
  2555. "welcomeMessage": {},
  2556. "samplePromptsControlMode": {}
  2557. }
  2558. },
  2559. "output": {
  2560. "type": "structure",
  2561. "members": {}
  2562. },
  2563. "idempotent": true
  2564. }
  2565. },
  2566. "shapes": {
  2567. "S9": {
  2568. "type": "list",
  2569. "member": {
  2570. "type": "structure",
  2571. "members": {
  2572. "id": {},
  2573. "error": {
  2574. "shape": "Sb"
  2575. },
  2576. "dataSourceId": {}
  2577. }
  2578. }
  2579. },
  2580. "Sb": {
  2581. "type": "structure",
  2582. "members": {
  2583. "errorMessage": {},
  2584. "errorCode": {}
  2585. }
  2586. },
  2587. "Sj": {
  2588. "type": "structure",
  2589. "required": [
  2590. "name",
  2591. "value"
  2592. ],
  2593. "members": {
  2594. "name": {},
  2595. "value": {
  2596. "shape": "Sl"
  2597. }
  2598. }
  2599. },
  2600. "Sl": {
  2601. "type": "structure",
  2602. "members": {
  2603. "stringValue": {},
  2604. "stringListValue": {
  2605. "type": "list",
  2606. "member": {}
  2607. },
  2608. "longValue": {
  2609. "type": "long"
  2610. },
  2611. "dateValue": {
  2612. "type": "timestamp"
  2613. }
  2614. },
  2615. "union": true
  2616. },
  2617. "St": {
  2618. "type": "structure",
  2619. "required": [
  2620. "bucket",
  2621. "key"
  2622. ],
  2623. "members": {
  2624. "bucket": {},
  2625. "key": {}
  2626. }
  2627. },
  2628. "S1a": {
  2629. "type": "structure",
  2630. "members": {
  2631. "inlineConfigurations": {
  2632. "type": "list",
  2633. "member": {
  2634. "type": "structure",
  2635. "members": {
  2636. "condition": {
  2637. "shape": "S1d"
  2638. },
  2639. "target": {
  2640. "type": "structure",
  2641. "required": [
  2642. "key"
  2643. ],
  2644. "members": {
  2645. "key": {},
  2646. "value": {
  2647. "shape": "Sl"
  2648. },
  2649. "attributeValueOperator": {}
  2650. }
  2651. },
  2652. "documentContentOperator": {}
  2653. }
  2654. }
  2655. },
  2656. "preExtractionHookConfiguration": {
  2657. "shape": "S1i"
  2658. },
  2659. "postExtractionHookConfiguration": {
  2660. "shape": "S1i"
  2661. }
  2662. }
  2663. },
  2664. "S1d": {
  2665. "type": "structure",
  2666. "required": [
  2667. "key",
  2668. "operator"
  2669. ],
  2670. "members": {
  2671. "key": {},
  2672. "operator": {},
  2673. "value": {
  2674. "shape": "Sl"
  2675. }
  2676. }
  2677. },
  2678. "S1i": {
  2679. "type": "structure",
  2680. "members": {
  2681. "invocationCondition": {
  2682. "shape": "S1d"
  2683. },
  2684. "lambdaArn": {},
  2685. "s3BucketName": {},
  2686. "roleArn": {}
  2687. }
  2688. },
  2689. "S1n": {
  2690. "type": "list",
  2691. "member": {}
  2692. },
  2693. "S1s": {
  2694. "type": "structure",
  2695. "required": [
  2696. "pluginId",
  2697. "payload",
  2698. "payloadFieldNameSeparator"
  2699. ],
  2700. "members": {
  2701. "pluginId": {},
  2702. "payload": {
  2703. "type": "map",
  2704. "key": {},
  2705. "value": {
  2706. "type": "structure",
  2707. "required": [
  2708. "value"
  2709. ],
  2710. "members": {
  2711. "value": {
  2712. "shape": "S1x"
  2713. }
  2714. }
  2715. }
  2716. },
  2717. "payloadFieldNameSeparator": {}
  2718. }
  2719. },
  2720. "S1x": {
  2721. "type": "structure",
  2722. "members": {},
  2723. "document": true
  2724. },
  2725. "S25": {
  2726. "type": "structure",
  2727. "members": {
  2728. "andAllFilters": {
  2729. "shape": "S26"
  2730. },
  2731. "orAllFilters": {
  2732. "shape": "S26"
  2733. },
  2734. "notFilter": {
  2735. "shape": "S25"
  2736. },
  2737. "equalsTo": {
  2738. "shape": "Sj"
  2739. },
  2740. "containsAll": {
  2741. "shape": "Sj"
  2742. },
  2743. "containsAny": {
  2744. "shape": "Sj"
  2745. },
  2746. "greaterThan": {
  2747. "shape": "Sj"
  2748. },
  2749. "greaterThanOrEquals": {
  2750. "shape": "Sj"
  2751. },
  2752. "lessThan": {
  2753. "shape": "Sj"
  2754. },
  2755. "lessThanOrEquals": {
  2756. "shape": "Sj"
  2757. }
  2758. }
  2759. },
  2760. "S26": {
  2761. "type": "list",
  2762. "member": {
  2763. "shape": "S25"
  2764. }
  2765. },
  2766. "S2c": {
  2767. "type": "structure",
  2768. "members": {
  2769. "pluginId": {},
  2770. "pluginType": {},
  2771. "payload": {
  2772. "type": "map",
  2773. "key": {},
  2774. "value": {
  2775. "type": "structure",
  2776. "members": {
  2777. "displayName": {},
  2778. "displayOrder": {
  2779. "type": "integer"
  2780. },
  2781. "displayDescription": {},
  2782. "type": {},
  2783. "value": {
  2784. "shape": "S1x"
  2785. },
  2786. "allowedValues": {
  2787. "type": "list",
  2788. "member": {
  2789. "type": "structure",
  2790. "members": {
  2791. "value": {
  2792. "shape": "S1x"
  2793. },
  2794. "displayValue": {
  2795. "shape": "S1x"
  2796. }
  2797. }
  2798. }
  2799. },
  2800. "allowedFormat": {},
  2801. "required": {
  2802. "type": "boolean"
  2803. }
  2804. }
  2805. }
  2806. },
  2807. "payloadFieldNameSeparator": {}
  2808. }
  2809. },
  2810. "S2n": {
  2811. "type": "list",
  2812. "member": {
  2813. "type": "structure",
  2814. "members": {
  2815. "title": {},
  2816. "snippet": {},
  2817. "url": {},
  2818. "citationNumber": {
  2819. "type": "integer"
  2820. },
  2821. "updatedAt": {
  2822. "type": "timestamp"
  2823. },
  2824. "textMessageSegments": {
  2825. "type": "list",
  2826. "member": {
  2827. "type": "structure",
  2828. "members": {
  2829. "beginOffset": {
  2830. "type": "integer"
  2831. },
  2832. "endOffset": {
  2833. "type": "integer"
  2834. },
  2835. "snippetExcerpt": {
  2836. "type": "structure",
  2837. "members": {
  2838. "text": {}
  2839. }
  2840. }
  2841. }
  2842. }
  2843. }
  2844. }
  2845. }
  2846. },
  2847. "S2t": {
  2848. "type": "list",
  2849. "member": {
  2850. "type": "structure",
  2851. "members": {
  2852. "name": {},
  2853. "status": {},
  2854. "error": {
  2855. "shape": "Sb"
  2856. }
  2857. }
  2858. }
  2859. },
  2860. "S30": {
  2861. "type": "structure",
  2862. "members": {
  2863. "kmsKeyId": {
  2864. "type": "string",
  2865. "sensitive": true
  2866. }
  2867. }
  2868. },
  2869. "S32": {
  2870. "type": "list",
  2871. "member": {
  2872. "type": "structure",
  2873. "required": [
  2874. "key",
  2875. "value"
  2876. ],
  2877. "members": {
  2878. "key": {},
  2879. "value": {}
  2880. }
  2881. }
  2882. },
  2883. "S36": {
  2884. "type": "structure",
  2885. "required": [
  2886. "attachmentsControlMode"
  2887. ],
  2888. "members": {
  2889. "attachmentsControlMode": {}
  2890. }
  2891. },
  2892. "S3c": {
  2893. "type": "structure",
  2894. "members": {},
  2895. "document": true
  2896. },
  2897. "S3d": {
  2898. "type": "structure",
  2899. "required": [
  2900. "subnetIds",
  2901. "securityGroupIds"
  2902. ],
  2903. "members": {
  2904. "subnetIds": {
  2905. "type": "list",
  2906. "member": {}
  2907. },
  2908. "securityGroupIds": {
  2909. "type": "list",
  2910. "member": {}
  2911. }
  2912. }
  2913. },
  2914. "S3o": {
  2915. "type": "structure",
  2916. "members": {
  2917. "units": {
  2918. "type": "integer"
  2919. }
  2920. }
  2921. },
  2922. "S3u": {
  2923. "type": "structure",
  2924. "members": {
  2925. "basicAuthConfiguration": {
  2926. "type": "structure",
  2927. "required": [
  2928. "secretArn",
  2929. "roleArn"
  2930. ],
  2931. "members": {
  2932. "secretArn": {},
  2933. "roleArn": {}
  2934. }
  2935. },
  2936. "oAuth2ClientCredentialConfiguration": {
  2937. "type": "structure",
  2938. "required": [
  2939. "secretArn",
  2940. "roleArn"
  2941. ],
  2942. "members": {
  2943. "secretArn": {},
  2944. "roleArn": {}
  2945. }
  2946. },
  2947. "noAuthConfiguration": {
  2948. "type": "structure",
  2949. "members": {}
  2950. }
  2951. },
  2952. "union": true
  2953. },
  2954. "S3z": {
  2955. "type": "structure",
  2956. "required": [
  2957. "description",
  2958. "apiSchemaType",
  2959. "apiSchema"
  2960. ],
  2961. "members": {
  2962. "description": {},
  2963. "apiSchemaType": {},
  2964. "apiSchema": {
  2965. "type": "structure",
  2966. "members": {
  2967. "payload": {
  2968. "type": "string",
  2969. "sensitive": true
  2970. },
  2971. "s3": {
  2972. "shape": "St"
  2973. }
  2974. },
  2975. "union": true
  2976. }
  2977. }
  2978. },
  2979. "S4a": {
  2980. "type": "structure",
  2981. "members": {
  2982. "nativeIndexConfiguration": {
  2983. "type": "structure",
  2984. "required": [
  2985. "indexId"
  2986. ],
  2987. "members": {
  2988. "indexId": {},
  2989. "boostingOverride": {
  2990. "type": "map",
  2991. "key": {},
  2992. "value": {
  2993. "type": "structure",
  2994. "members": {
  2995. "numberConfiguration": {
  2996. "type": "structure",
  2997. "required": [
  2998. "boostingLevel"
  2999. ],
  3000. "members": {
  3001. "boostingLevel": {},
  3002. "boostingType": {}
  3003. }
  3004. },
  3005. "stringConfiguration": {
  3006. "type": "structure",
  3007. "required": [
  3008. "boostingLevel"
  3009. ],
  3010. "members": {
  3011. "boostingLevel": {},
  3012. "attributeValueBoosting": {
  3013. "type": "map",
  3014. "key": {},
  3015. "value": {}
  3016. }
  3017. }
  3018. },
  3019. "dateConfiguration": {
  3020. "type": "structure",
  3021. "required": [
  3022. "boostingLevel"
  3023. ],
  3024. "members": {
  3025. "boostingLevel": {},
  3026. "boostingDurationInSeconds": {
  3027. "type": "long"
  3028. }
  3029. }
  3030. },
  3031. "stringListConfiguration": {
  3032. "type": "structure",
  3033. "required": [
  3034. "boostingLevel"
  3035. ],
  3036. "members": {
  3037. "boostingLevel": {}
  3038. }
  3039. }
  3040. },
  3041. "union": true
  3042. }
  3043. }
  3044. }
  3045. },
  3046. "kendraIndexConfiguration": {
  3047. "type": "structure",
  3048. "required": [
  3049. "indexId"
  3050. ],
  3051. "members": {
  3052. "indexId": {}
  3053. }
  3054. }
  3055. },
  3056. "union": true
  3057. },
  3058. "S4u": {
  3059. "type": "structure",
  3060. "required": [
  3061. "userId"
  3062. ],
  3063. "members": {
  3064. "indexId": {},
  3065. "dataSourceId": {},
  3066. "userId": {}
  3067. }
  3068. },
  3069. "S5z": {
  3070. "type": "list",
  3071. "member": {}
  3072. },
  3073. "S62": {
  3074. "type": "list",
  3075. "member": {
  3076. "type": "structure",
  3077. "required": [
  3078. "name",
  3079. "rules"
  3080. ],
  3081. "members": {
  3082. "name": {},
  3083. "description": {},
  3084. "exampleChatMessages": {
  3085. "type": "list",
  3086. "member": {}
  3087. },
  3088. "rules": {
  3089. "type": "list",
  3090. "member": {
  3091. "type": "structure",
  3092. "required": [
  3093. "ruleType"
  3094. ],
  3095. "members": {
  3096. "includedUsersAndGroups": {
  3097. "shape": "S6a"
  3098. },
  3099. "excludedUsersAndGroups": {
  3100. "shape": "S6a"
  3101. },
  3102. "ruleType": {},
  3103. "ruleConfiguration": {
  3104. "type": "structure",
  3105. "members": {
  3106. "contentBlockerRule": {
  3107. "type": "structure",
  3108. "members": {
  3109. "systemMessageOverride": {}
  3110. }
  3111. },
  3112. "contentRetrievalRule": {
  3113. "type": "structure",
  3114. "members": {
  3115. "eligibleDataSources": {
  3116. "type": "list",
  3117. "member": {
  3118. "type": "structure",
  3119. "members": {
  3120. "indexId": {},
  3121. "dataSourceId": {}
  3122. }
  3123. }
  3124. }
  3125. }
  3126. }
  3127. },
  3128. "union": true
  3129. }
  3130. }
  3131. }
  3132. }
  3133. }
  3134. }
  3135. },
  3136. "S6a": {
  3137. "type": "structure",
  3138. "members": {
  3139. "userIds": {
  3140. "type": "list",
  3141. "member": {}
  3142. },
  3143. "userGroups": {
  3144. "shape": "S1n"
  3145. }
  3146. }
  3147. },
  3148. "S6p": {
  3149. "type": "structure",
  3150. "members": {
  3151. "status": {},
  3152. "lastUpdatedAt": {
  3153. "type": "timestamp"
  3154. },
  3155. "errorDetail": {
  3156. "shape": "Sb"
  3157. }
  3158. }
  3159. },
  3160. "S6v": {
  3161. "type": "list",
  3162. "member": {
  3163. "type": "structure",
  3164. "members": {
  3165. "name": {},
  3166. "type": {},
  3167. "search": {}
  3168. }
  3169. }
  3170. },
  3171. "S7c": {
  3172. "type": "list",
  3173. "member": {
  3174. "shape": "S4u"
  3175. }
  3176. },
  3177. "S7g": {
  3178. "type": "structure",
  3179. "members": {
  3180. "samlConfiguration": {
  3181. "type": "structure",
  3182. "required": [
  3183. "metadataXML",
  3184. "roleArn",
  3185. "userIdAttribute"
  3186. ],
  3187. "members": {
  3188. "metadataXML": {},
  3189. "roleArn": {},
  3190. "userIdAttribute": {},
  3191. "userGroupAttribute": {}
  3192. }
  3193. }
  3194. },
  3195. "union": true
  3196. }
  3197. }
  3198. }