bedrock-agent-2023-06-05.min.json 56 KB

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