123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445 |
- {
- "version": "2.0",
- "metadata": {
- "apiVersion": "2023-06-05",
- "endpointPrefix": "bedrock-agent",
- "jsonVersion": "1.1",
- "protocol": "rest-json",
- "serviceFullName": "Agents for Amazon Bedrock",
- "serviceId": "Bedrock Agent",
- "signatureVersion": "v4",
- "signingName": "bedrock",
- "uid": "bedrock-agent-2023-06-05"
- },
- "operations": {
- "AssociateAgentKnowledgeBase": {
- "http": {
- "method": "PUT",
- "requestUri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "agentId",
- "agentVersion",
- "description",
- "knowledgeBaseId"
- ],
- "members": {
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "agentVersion": {
- "location": "uri",
- "locationName": "agentVersion"
- },
- "description": {},
- "knowledgeBaseId": {},
- "knowledgeBaseState": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentKnowledgeBase"
- ],
- "members": {
- "agentKnowledgeBase": {
- "shape": "S7"
- }
- }
- },
- "idempotent": true
- },
- "CreateAgent": {
- "http": {
- "method": "PUT",
- "requestUri": "/agents/",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "agentName"
- ],
- "members": {
- "agentName": {},
- "agentResourceRoleArn": {},
- "clientToken": {
- "idempotencyToken": true
- },
- "customerEncryptionKeyArn": {},
- "description": {},
- "foundationModel": {},
- "idleSessionTTLInSeconds": {
- "type": "integer"
- },
- "instruction": {
- "shape": "Sh"
- },
- "promptOverrideConfiguration": {
- "shape": "Si"
- },
- "tags": {
- "shape": "Sx"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agent"
- ],
- "members": {
- "agent": {
- "shape": "S11"
- }
- }
- },
- "idempotent": true
- },
- "CreateAgentActionGroup": {
- "http": {
- "method": "PUT",
- "requestUri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "actionGroupName",
- "agentId",
- "agentVersion"
- ],
- "members": {
- "actionGroupExecutor": {
- "shape": "S19"
- },
- "actionGroupName": {},
- "actionGroupState": {},
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "agentVersion": {
- "location": "uri",
- "locationName": "agentVersion"
- },
- "apiSchema": {
- "shape": "S1c"
- },
- "clientToken": {
- "idempotencyToken": true
- },
- "description": {},
- "functionSchema": {
- "shape": "S1h"
- },
- "parentActionGroupSignature": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentActionGroup"
- ],
- "members": {
- "agentActionGroup": {
- "shape": "S1s"
- }
- }
- },
- "idempotent": true
- },
- "CreateAgentAlias": {
- "http": {
- "method": "PUT",
- "requestUri": "/agents/{agentId}/agentaliases/",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "agentAliasName",
- "agentId"
- ],
- "members": {
- "agentAliasName": {},
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "clientToken": {
- "idempotencyToken": true
- },
- "description": {},
- "routingConfiguration": {
- "shape": "S1u"
- },
- "tags": {
- "shape": "Sx"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentAlias"
- ],
- "members": {
- "agentAlias": {
- "shape": "S1y"
- }
- }
- },
- "idempotent": true
- },
- "CreateDataSource": {
- "http": {
- "method": "PUT",
- "requestUri": "/knowledgebases/{knowledgeBaseId}/datasources/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "dataSourceConfiguration",
- "knowledgeBaseId",
- "name"
- ],
- "members": {
- "clientToken": {
- "idempotencyToken": true
- },
- "dataDeletionPolicy": {},
- "dataSourceConfiguration": {
- "shape": "S26"
- },
- "description": {},
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "name": {},
- "serverSideEncryptionConfiguration": {
- "shape": "S2d"
- },
- "vectorIngestionConfiguration": {
- "shape": "S2e"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "dataSource"
- ],
- "members": {
- "dataSource": {
- "shape": "S2l"
- }
- }
- },
- "idempotent": true
- },
- "CreateKnowledgeBase": {
- "http": {
- "method": "PUT",
- "requestUri": "/knowledgebases/",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseConfiguration",
- "name",
- "roleArn",
- "storageConfiguration"
- ],
- "members": {
- "clientToken": {
- "idempotencyToken": true
- },
- "description": {},
- "knowledgeBaseConfiguration": {
- "shape": "S2o"
- },
- "name": {},
- "roleArn": {},
- "storageConfiguration": {
- "shape": "S2t"
- },
- "tags": {
- "shape": "Sx"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "knowledgeBase"
- ],
- "members": {
- "knowledgeBase": {
- "shape": "S3n"
- }
- }
- },
- "idempotent": true
- },
- "DeleteAgent": {
- "http": {
- "method": "DELETE",
- "requestUri": "/agents/{agentId}/",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "agentId"
- ],
- "members": {
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "skipResourceInUseCheck": {
- "location": "querystring",
- "locationName": "skipResourceInUseCheck",
- "type": "boolean"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentId",
- "agentStatus"
- ],
- "members": {
- "agentId": {},
- "agentStatus": {}
- }
- },
- "idempotent": true
- },
- "DeleteAgentActionGroup": {
- "http": {
- "method": "DELETE",
- "requestUri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/",
- "responseCode": 204
- },
- "input": {
- "type": "structure",
- "required": [
- "actionGroupId",
- "agentId",
- "agentVersion"
- ],
- "members": {
- "actionGroupId": {
- "location": "uri",
- "locationName": "actionGroupId"
- },
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "agentVersion": {
- "location": "uri",
- "locationName": "agentVersion"
- },
- "skipResourceInUseCheck": {
- "location": "querystring",
- "locationName": "skipResourceInUseCheck",
- "type": "boolean"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteAgentAlias": {
- "http": {
- "method": "DELETE",
- "requestUri": "/agents/{agentId}/agentaliases/{agentAliasId}/",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "agentAliasId",
- "agentId"
- ],
- "members": {
- "agentAliasId": {
- "location": "uri",
- "locationName": "agentAliasId"
- },
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentAliasId",
- "agentAliasStatus",
- "agentId"
- ],
- "members": {
- "agentAliasId": {},
- "agentAliasStatus": {},
- "agentId": {}
- }
- },
- "idempotent": true
- },
- "DeleteAgentVersion": {
- "http": {
- "method": "DELETE",
- "requestUri": "/agents/{agentId}/agentversions/{agentVersion}/",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "agentId",
- "agentVersion"
- ],
- "members": {
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "agentVersion": {
- "location": "uri",
- "locationName": "agentVersion"
- },
- "skipResourceInUseCheck": {
- "location": "querystring",
- "locationName": "skipResourceInUseCheck",
- "type": "boolean"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentId",
- "agentStatus",
- "agentVersion"
- ],
- "members": {
- "agentId": {},
- "agentStatus": {},
- "agentVersion": {}
- }
- },
- "idempotent": true
- },
- "DeleteDataSource": {
- "http": {
- "method": "DELETE",
- "requestUri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "dataSourceId",
- "knowledgeBaseId"
- ],
- "members": {
- "dataSourceId": {
- "location": "uri",
- "locationName": "dataSourceId"
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "dataSourceId",
- "knowledgeBaseId",
- "status"
- ],
- "members": {
- "dataSourceId": {},
- "knowledgeBaseId": {},
- "status": {}
- }
- },
- "idempotent": true
- },
- "DeleteKnowledgeBase": {
- "http": {
- "method": "DELETE",
- "requestUri": "/knowledgebases/{knowledgeBaseId}",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId"
- ],
- "members": {
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "knowledgeBaseId",
- "status"
- ],
- "members": {
- "knowledgeBaseId": {},
- "status": {}
- }
- },
- "idempotent": true
- },
- "DisassociateAgentKnowledgeBase": {
- "http": {
- "method": "DELETE",
- "requestUri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/",
- "responseCode": 204
- },
- "input": {
- "type": "structure",
- "required": [
- "agentId",
- "agentVersion",
- "knowledgeBaseId"
- ],
- "members": {
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "agentVersion": {
- "location": "uri",
- "locationName": "agentVersion"
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "GetAgent": {
- "http": {
- "method": "GET",
- "requestUri": "/agents/{agentId}/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "agentId"
- ],
- "members": {
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agent"
- ],
- "members": {
- "agent": {
- "shape": "S11"
- }
- }
- }
- },
- "GetAgentActionGroup": {
- "http": {
- "method": "GET",
- "requestUri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "actionGroupId",
- "agentId",
- "agentVersion"
- ],
- "members": {
- "actionGroupId": {
- "location": "uri",
- "locationName": "actionGroupId"
- },
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "agentVersion": {
- "location": "uri",
- "locationName": "agentVersion"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentActionGroup"
- ],
- "members": {
- "agentActionGroup": {
- "shape": "S1s"
- }
- }
- }
- },
- "GetAgentAlias": {
- "http": {
- "method": "GET",
- "requestUri": "/agents/{agentId}/agentaliases/{agentAliasId}/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "agentAliasId",
- "agentId"
- ],
- "members": {
- "agentAliasId": {
- "location": "uri",
- "locationName": "agentAliasId"
- },
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentAlias"
- ],
- "members": {
- "agentAlias": {
- "shape": "S1y"
- }
- }
- }
- },
- "GetAgentKnowledgeBase": {
- "http": {
- "method": "GET",
- "requestUri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "agentId",
- "agentVersion",
- "knowledgeBaseId"
- ],
- "members": {
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "agentVersion": {
- "location": "uri",
- "locationName": "agentVersion"
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentKnowledgeBase"
- ],
- "members": {
- "agentKnowledgeBase": {
- "shape": "S7"
- }
- }
- }
- },
- "GetAgentVersion": {
- "http": {
- "method": "GET",
- "requestUri": "/agents/{agentId}/agentversions/{agentVersion}/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "agentId",
- "agentVersion"
- ],
- "members": {
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "agentVersion": {
- "location": "uri",
- "locationName": "agentVersion"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentVersion"
- ],
- "members": {
- "agentVersion": {
- "type": "structure",
- "required": [
- "agentArn",
- "agentId",
- "agentName",
- "agentResourceRoleArn",
- "agentStatus",
- "createdAt",
- "idleSessionTTLInSeconds",
- "updatedAt",
- "version"
- ],
- "members": {
- "agentArn": {},
- "agentId": {},
- "agentName": {},
- "agentResourceRoleArn": {},
- "agentStatus": {},
- "createdAt": {
- "shape": "S9"
- },
- "customerEncryptionKeyArn": {},
- "description": {},
- "failureReasons": {
- "shape": "S14"
- },
- "foundationModel": {},
- "idleSessionTTLInSeconds": {
- "type": "integer"
- },
- "instruction": {
- "shape": "Sh"
- },
- "promptOverrideConfiguration": {
- "shape": "Si"
- },
- "recommendedActions": {
- "shape": "S16"
- },
- "updatedAt": {
- "shape": "S9"
- },
- "version": {}
- }
- }
- }
- }
- },
- "GetDataSource": {
- "http": {
- "method": "GET",
- "requestUri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "dataSourceId",
- "knowledgeBaseId"
- ],
- "members": {
- "dataSourceId": {
- "location": "uri",
- "locationName": "dataSourceId"
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "dataSource"
- ],
- "members": {
- "dataSource": {
- "shape": "S2l"
- }
- }
- }
- },
- "GetIngestionJob": {
- "http": {
- "method": "GET",
- "requestUri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/{ingestionJobId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "dataSourceId",
- "ingestionJobId",
- "knowledgeBaseId"
- ],
- "members": {
- "dataSourceId": {
- "location": "uri",
- "locationName": "dataSourceId"
- },
- "ingestionJobId": {
- "location": "uri",
- "locationName": "ingestionJobId"
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "ingestionJob"
- ],
- "members": {
- "ingestionJob": {
- "shape": "S4k"
- }
- }
- }
- },
- "GetKnowledgeBase": {
- "http": {
- "method": "GET",
- "requestUri": "/knowledgebases/{knowledgeBaseId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId"
- ],
- "members": {
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "knowledgeBase"
- ],
- "members": {
- "knowledgeBase": {
- "shape": "S3n"
- }
- }
- }
- },
- "ListAgentActionGroups": {
- "http": {
- "requestUri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "agentId",
- "agentVersion"
- ],
- "members": {
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "agentVersion": {
- "location": "uri",
- "locationName": "agentVersion"
- },
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "actionGroupSummaries"
- ],
- "members": {
- "actionGroupSummaries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "actionGroupId",
- "actionGroupName",
- "actionGroupState",
- "updatedAt"
- ],
- "members": {
- "actionGroupId": {},
- "actionGroupName": {},
- "actionGroupState": {},
- "description": {},
- "updatedAt": {
- "shape": "S9"
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListAgentAliases": {
- "http": {
- "requestUri": "/agents/{agentId}/agentaliases/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "agentId"
- ],
- "members": {
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentAliasSummaries"
- ],
- "members": {
- "agentAliasSummaries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "agentAliasId",
- "agentAliasName",
- "agentAliasStatus",
- "createdAt",
- "updatedAt"
- ],
- "members": {
- "agentAliasId": {},
- "agentAliasName": {},
- "agentAliasStatus": {},
- "createdAt": {
- "shape": "S9"
- },
- "description": {},
- "routingConfiguration": {
- "shape": "S1u"
- },
- "updatedAt": {
- "shape": "S9"
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListAgentKnowledgeBases": {
- "http": {
- "requestUri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "agentId",
- "agentVersion"
- ],
- "members": {
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "agentVersion": {
- "location": "uri",
- "locationName": "agentVersion"
- },
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentKnowledgeBaseSummaries"
- ],
- "members": {
- "agentKnowledgeBaseSummaries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "knowledgeBaseId",
- "knowledgeBaseState",
- "updatedAt"
- ],
- "members": {
- "description": {},
- "knowledgeBaseId": {},
- "knowledgeBaseState": {},
- "updatedAt": {
- "shape": "S9"
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListAgentVersions": {
- "http": {
- "requestUri": "/agents/{agentId}/agentversions/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "agentId"
- ],
- "members": {
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentVersionSummaries"
- ],
- "members": {
- "agentVersionSummaries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "agentName",
- "agentStatus",
- "agentVersion",
- "createdAt",
- "updatedAt"
- ],
- "members": {
- "agentName": {},
- "agentStatus": {},
- "agentVersion": {},
- "createdAt": {
- "shape": "S9"
- },
- "description": {},
- "updatedAt": {
- "shape": "S9"
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListAgents": {
- "http": {
- "requestUri": "/agents/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentSummaries"
- ],
- "members": {
- "agentSummaries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "agentId",
- "agentName",
- "agentStatus",
- "updatedAt"
- ],
- "members": {
- "agentId": {},
- "agentName": {},
- "agentStatus": {},
- "description": {},
- "latestAgentVersion": {},
- "updatedAt": {
- "shape": "S9"
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListDataSources": {
- "http": {
- "requestUri": "/knowledgebases/{knowledgeBaseId}/datasources/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseId"
- ],
- "members": {
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "dataSourceSummaries"
- ],
- "members": {
- "dataSourceSummaries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "dataSourceId",
- "knowledgeBaseId",
- "name",
- "status",
- "updatedAt"
- ],
- "members": {
- "dataSourceId": {},
- "description": {},
- "knowledgeBaseId": {},
- "name": {},
- "status": {},
- "updatedAt": {
- "shape": "S9"
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListIngestionJobs": {
- "http": {
- "requestUri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "dataSourceId",
- "knowledgeBaseId"
- ],
- "members": {
- "dataSourceId": {
- "location": "uri",
- "locationName": "dataSourceId"
- },
- "filters": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "attribute",
- "operator",
- "values"
- ],
- "members": {
- "attribute": {},
- "operator": {},
- "values": {
- "type": "list",
- "member": {}
- }
- }
- }
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {},
- "sortBy": {
- "type": "structure",
- "required": [
- "attribute",
- "order"
- ],
- "members": {
- "attribute": {},
- "order": {}
- }
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "ingestionJobSummaries"
- ],
- "members": {
- "ingestionJobSummaries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "dataSourceId",
- "ingestionJobId",
- "knowledgeBaseId",
- "startedAt",
- "status",
- "updatedAt"
- ],
- "members": {
- "dataSourceId": {},
- "description": {},
- "ingestionJobId": {},
- "knowledgeBaseId": {},
- "startedAt": {
- "shape": "S9"
- },
- "statistics": {
- "shape": "S4l"
- },
- "status": {},
- "updatedAt": {
- "shape": "S9"
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListKnowledgeBases": {
- "http": {
- "requestUri": "/knowledgebases/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "maxResults": {
- "type": "integer"
- },
- "nextToken": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "knowledgeBaseSummaries"
- ],
- "members": {
- "knowledgeBaseSummaries": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "knowledgeBaseId",
- "name",
- "status",
- "updatedAt"
- ],
- "members": {
- "description": {},
- "knowledgeBaseId": {},
- "name": {},
- "status": {},
- "updatedAt": {
- "shape": "S9"
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListTagsForResource": {
- "http": {
- "method": "GET",
- "requestUri": "/tags/{resourceArn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "resourceArn"
- ],
- "members": {
- "resourceArn": {
- "location": "uri",
- "locationName": "resourceArn"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "tags": {
- "shape": "Sx"
- }
- }
- }
- },
- "PrepareAgent": {
- "http": {
- "requestUri": "/agents/{agentId}/",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "agentId"
- ],
- "members": {
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentId",
- "agentStatus",
- "agentVersion",
- "preparedAt"
- ],
- "members": {
- "agentId": {},
- "agentStatus": {},
- "agentVersion": {},
- "preparedAt": {
- "shape": "S9"
- }
- }
- }
- },
- "StartIngestionJob": {
- "http": {
- "method": "PUT",
- "requestUri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}/ingestionjobs/",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "dataSourceId",
- "knowledgeBaseId"
- ],
- "members": {
- "clientToken": {
- "idempotencyToken": true
- },
- "dataSourceId": {
- "location": "uri",
- "locationName": "dataSourceId"
- },
- "description": {},
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "ingestionJob"
- ],
- "members": {
- "ingestionJob": {
- "shape": "S4k"
- }
- }
- },
- "idempotent": true
- },
- "TagResource": {
- "http": {
- "requestUri": "/tags/{resourceArn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "resourceArn",
- "tags"
- ],
- "members": {
- "resourceArn": {
- "location": "uri",
- "locationName": "resourceArn"
- },
- "tags": {
- "shape": "Sx"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- },
- "UntagResource": {
- "http": {
- "method": "DELETE",
- "requestUri": "/tags/{resourceArn}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "resourceArn",
- "tagKeys"
- ],
- "members": {
- "resourceArn": {
- "location": "uri",
- "locationName": "resourceArn"
- },
- "tagKeys": {
- "location": "querystring",
- "locationName": "tagKeys",
- "type": "list",
- "member": {}
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "UpdateAgent": {
- "http": {
- "method": "PUT",
- "requestUri": "/agents/{agentId}/",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "agentId",
- "agentName",
- "agentResourceRoleArn",
- "foundationModel"
- ],
- "members": {
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "agentName": {},
- "agentResourceRoleArn": {},
- "customerEncryptionKeyArn": {},
- "description": {},
- "foundationModel": {},
- "idleSessionTTLInSeconds": {
- "type": "integer"
- },
- "instruction": {
- "shape": "Sh"
- },
- "promptOverrideConfiguration": {
- "shape": "Si"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agent"
- ],
- "members": {
- "agent": {
- "shape": "S11"
- }
- }
- },
- "idempotent": true
- },
- "UpdateAgentActionGroup": {
- "http": {
- "method": "PUT",
- "requestUri": "/agents/{agentId}/agentversions/{agentVersion}/actiongroups/{actionGroupId}/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "actionGroupId",
- "actionGroupName",
- "agentId",
- "agentVersion"
- ],
- "members": {
- "actionGroupExecutor": {
- "shape": "S19"
- },
- "actionGroupId": {
- "location": "uri",
- "locationName": "actionGroupId"
- },
- "actionGroupName": {},
- "actionGroupState": {},
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "agentVersion": {
- "location": "uri",
- "locationName": "agentVersion"
- },
- "apiSchema": {
- "shape": "S1c"
- },
- "description": {},
- "functionSchema": {
- "shape": "S1h"
- },
- "parentActionGroupSignature": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentActionGroup"
- ],
- "members": {
- "agentActionGroup": {
- "shape": "S1s"
- }
- }
- },
- "idempotent": true
- },
- "UpdateAgentAlias": {
- "http": {
- "method": "PUT",
- "requestUri": "/agents/{agentId}/agentaliases/{agentAliasId}/",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "agentAliasId",
- "agentAliasName",
- "agentId"
- ],
- "members": {
- "agentAliasId": {
- "location": "uri",
- "locationName": "agentAliasId"
- },
- "agentAliasName": {},
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "description": {},
- "routingConfiguration": {
- "shape": "S1u"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentAlias"
- ],
- "members": {
- "agentAlias": {
- "shape": "S1y"
- }
- }
- },
- "idempotent": true
- },
- "UpdateAgentKnowledgeBase": {
- "http": {
- "method": "PUT",
- "requestUri": "/agents/{agentId}/agentversions/{agentVersion}/knowledgebases/{knowledgeBaseId}/",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "agentId",
- "agentVersion",
- "knowledgeBaseId"
- ],
- "members": {
- "agentId": {
- "location": "uri",
- "locationName": "agentId"
- },
- "agentVersion": {
- "location": "uri",
- "locationName": "agentVersion"
- },
- "description": {},
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "knowledgeBaseState": {}
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "agentKnowledgeBase"
- ],
- "members": {
- "agentKnowledgeBase": {
- "shape": "S7"
- }
- }
- },
- "idempotent": true
- },
- "UpdateDataSource": {
- "http": {
- "method": "PUT",
- "requestUri": "/knowledgebases/{knowledgeBaseId}/datasources/{dataSourceId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "dataSourceConfiguration",
- "dataSourceId",
- "knowledgeBaseId",
- "name"
- ],
- "members": {
- "dataDeletionPolicy": {},
- "dataSourceConfiguration": {
- "shape": "S26"
- },
- "dataSourceId": {
- "location": "uri",
- "locationName": "dataSourceId"
- },
- "description": {},
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "name": {},
- "serverSideEncryptionConfiguration": {
- "shape": "S2d"
- },
- "vectorIngestionConfiguration": {
- "shape": "S2e"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "dataSource"
- ],
- "members": {
- "dataSource": {
- "shape": "S2l"
- }
- }
- },
- "idempotent": true
- },
- "UpdateKnowledgeBase": {
- "http": {
- "method": "PUT",
- "requestUri": "/knowledgebases/{knowledgeBaseId}",
- "responseCode": 202
- },
- "input": {
- "type": "structure",
- "required": [
- "knowledgeBaseConfiguration",
- "knowledgeBaseId",
- "name",
- "roleArn",
- "storageConfiguration"
- ],
- "members": {
- "description": {},
- "knowledgeBaseConfiguration": {
- "shape": "S2o"
- },
- "knowledgeBaseId": {
- "location": "uri",
- "locationName": "knowledgeBaseId"
- },
- "name": {},
- "roleArn": {},
- "storageConfiguration": {
- "shape": "S2t"
- }
- }
- },
- "output": {
- "type": "structure",
- "required": [
- "knowledgeBase"
- ],
- "members": {
- "knowledgeBase": {
- "shape": "S3n"
- }
- }
- },
- "idempotent": true
- }
- },
- "shapes": {
- "S7": {
- "type": "structure",
- "required": [
- "agentId",
- "agentVersion",
- "createdAt",
- "description",
- "knowledgeBaseId",
- "knowledgeBaseState",
- "updatedAt"
- ],
- "members": {
- "agentId": {},
- "agentVersion": {},
- "createdAt": {
- "shape": "S9"
- },
- "description": {},
- "knowledgeBaseId": {},
- "knowledgeBaseState": {},
- "updatedAt": {
- "shape": "S9"
- }
- }
- },
- "S9": {
- "type": "timestamp",
- "timestampFormat": "iso8601"
- },
- "Sh": {
- "type": "string",
- "sensitive": true
- },
- "Si": {
- "type": "structure",
- "required": [
- "promptConfigurations"
- ],
- "members": {
- "overrideLambda": {},
- "promptConfigurations": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "basePromptTemplate": {},
- "inferenceConfiguration": {
- "type": "structure",
- "members": {
- "maximumLength": {
- "type": "integer"
- },
- "stopSequences": {
- "type": "list",
- "member": {}
- },
- "temperature": {
- "type": "float"
- },
- "topK": {
- "type": "integer"
- },
- "topP": {
- "type": "float"
- }
- }
- },
- "parserMode": {},
- "promptCreationMode": {},
- "promptState": {},
- "promptType": {}
- }
- }
- }
- },
- "sensitive": true
- },
- "Sx": {
- "type": "map",
- "key": {},
- "value": {}
- },
- "S11": {
- "type": "structure",
- "required": [
- "agentArn",
- "agentId",
- "agentName",
- "agentResourceRoleArn",
- "agentStatus",
- "agentVersion",
- "createdAt",
- "idleSessionTTLInSeconds",
- "updatedAt"
- ],
- "members": {
- "agentArn": {},
- "agentId": {},
- "agentName": {},
- "agentResourceRoleArn": {},
- "agentStatus": {},
- "agentVersion": {},
- "clientToken": {},
- "createdAt": {
- "shape": "S9"
- },
- "customerEncryptionKeyArn": {},
- "description": {},
- "failureReasons": {
- "shape": "S14"
- },
- "foundationModel": {},
- "idleSessionTTLInSeconds": {
- "type": "integer"
- },
- "instruction": {
- "shape": "Sh"
- },
- "preparedAt": {
- "shape": "S9"
- },
- "promptOverrideConfiguration": {
- "shape": "Si"
- },
- "recommendedActions": {
- "shape": "S16"
- },
- "updatedAt": {
- "shape": "S9"
- }
- }
- },
- "S14": {
- "type": "list",
- "member": {}
- },
- "S16": {
- "type": "list",
- "member": {}
- },
- "S19": {
- "type": "structure",
- "members": {
- "customControl": {},
- "lambda": {}
- },
- "union": true
- },
- "S1c": {
- "type": "structure",
- "members": {
- "payload": {
- "type": "string",
- "sensitive": true
- },
- "s3": {
- "type": "structure",
- "members": {
- "s3BucketName": {},
- "s3ObjectKey": {}
- }
- }
- },
- "union": true
- },
- "S1h": {
- "type": "structure",
- "members": {
- "functions": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "name"
- ],
- "members": {
- "description": {},
- "name": {},
- "parameters": {
- "type": "map",
- "key": {},
- "value": {
- "type": "structure",
- "required": [
- "type"
- ],
- "members": {
- "description": {},
- "required": {
- "type": "boolean"
- },
- "type": {}
- }
- }
- }
- }
- }
- }
- },
- "union": true
- },
- "S1s": {
- "type": "structure",
- "required": [
- "actionGroupId",
- "actionGroupName",
- "actionGroupState",
- "agentId",
- "agentVersion",
- "createdAt",
- "updatedAt"
- ],
- "members": {
- "actionGroupExecutor": {
- "shape": "S19"
- },
- "actionGroupId": {},
- "actionGroupName": {},
- "actionGroupState": {},
- "agentId": {},
- "agentVersion": {},
- "apiSchema": {
- "shape": "S1c"
- },
- "clientToken": {},
- "createdAt": {
- "shape": "S9"
- },
- "description": {},
- "functionSchema": {
- "shape": "S1h"
- },
- "parentActionSignature": {},
- "updatedAt": {
- "shape": "S9"
- }
- }
- },
- "S1u": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "agentVersion": {},
- "provisionedThroughput": {}
- }
- }
- },
- "S1y": {
- "type": "structure",
- "required": [
- "agentAliasArn",
- "agentAliasId",
- "agentAliasName",
- "agentAliasStatus",
- "agentId",
- "createdAt",
- "routingConfiguration",
- "updatedAt"
- ],
- "members": {
- "agentAliasArn": {},
- "agentAliasHistoryEvents": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "endDate": {
- "shape": "S9"
- },
- "routingConfiguration": {
- "shape": "S1u"
- },
- "startDate": {
- "shape": "S9"
- }
- }
- }
- },
- "agentAliasId": {},
- "agentAliasName": {},
- "agentAliasStatus": {},
- "agentId": {},
- "clientToken": {},
- "createdAt": {
- "shape": "S9"
- },
- "description": {},
- "failureReasons": {
- "shape": "S14"
- },
- "routingConfiguration": {
- "shape": "S1u"
- },
- "updatedAt": {
- "shape": "S9"
- }
- }
- },
- "S26": {
- "type": "structure",
- "required": [
- "type"
- ],
- "members": {
- "s3Configuration": {
- "type": "structure",
- "required": [
- "bucketArn"
- ],
- "members": {
- "bucketArn": {},
- "bucketOwnerAccountId": {},
- "inclusionPrefixes": {
- "type": "list",
- "member": {}
- }
- }
- },
- "type": {}
- }
- },
- "S2d": {
- "type": "structure",
- "members": {
- "kmsKeyArn": {}
- }
- },
- "S2e": {
- "type": "structure",
- "members": {
- "chunkingConfiguration": {
- "type": "structure",
- "required": [
- "chunkingStrategy"
- ],
- "members": {
- "chunkingStrategy": {},
- "fixedSizeChunkingConfiguration": {
- "type": "structure",
- "required": [
- "maxTokens",
- "overlapPercentage"
- ],
- "members": {
- "maxTokens": {
- "type": "integer"
- },
- "overlapPercentage": {
- "type": "integer"
- }
- }
- }
- }
- }
- }
- },
- "S2l": {
- "type": "structure",
- "required": [
- "createdAt",
- "dataSourceConfiguration",
- "dataSourceId",
- "knowledgeBaseId",
- "name",
- "status",
- "updatedAt"
- ],
- "members": {
- "createdAt": {
- "shape": "S9"
- },
- "dataDeletionPolicy": {},
- "dataSourceConfiguration": {
- "shape": "S26"
- },
- "dataSourceId": {},
- "description": {},
- "failureReasons": {
- "shape": "S14"
- },
- "knowledgeBaseId": {},
- "name": {},
- "serverSideEncryptionConfiguration": {
- "shape": "S2d"
- },
- "status": {},
- "updatedAt": {
- "shape": "S9"
- },
- "vectorIngestionConfiguration": {
- "shape": "S2e"
- }
- }
- },
- "S2o": {
- "type": "structure",
- "required": [
- "type"
- ],
- "members": {
- "type": {},
- "vectorKnowledgeBaseConfiguration": {
- "type": "structure",
- "required": [
- "embeddingModelArn"
- ],
- "members": {
- "embeddingModelArn": {}
- }
- }
- }
- },
- "S2t": {
- "type": "structure",
- "required": [
- "type"
- ],
- "members": {
- "mongoDbAtlasConfiguration": {
- "type": "structure",
- "required": [
- "collectionName",
- "credentialsSecretArn",
- "databaseName",
- "endpoint",
- "fieldMapping",
- "vectorIndexName"
- ],
- "members": {
- "collectionName": {},
- "credentialsSecretArn": {},
- "databaseName": {},
- "endpoint": {},
- "endpointServiceName": {},
- "fieldMapping": {
- "type": "structure",
- "required": [
- "metadataField",
- "textField",
- "vectorField"
- ],
- "members": {
- "metadataField": {},
- "textField": {},
- "vectorField": {}
- }
- },
- "vectorIndexName": {}
- }
- },
- "opensearchServerlessConfiguration": {
- "type": "structure",
- "required": [
- "collectionArn",
- "fieldMapping",
- "vectorIndexName"
- ],
- "members": {
- "collectionArn": {},
- "fieldMapping": {
- "type": "structure",
- "required": [
- "metadataField",
- "textField",
- "vectorField"
- ],
- "members": {
- "metadataField": {},
- "textField": {},
- "vectorField": {}
- }
- },
- "vectorIndexName": {}
- }
- },
- "pineconeConfiguration": {
- "type": "structure",
- "required": [
- "connectionString",
- "credentialsSecretArn",
- "fieldMapping"
- ],
- "members": {
- "connectionString": {},
- "credentialsSecretArn": {},
- "fieldMapping": {
- "type": "structure",
- "required": [
- "metadataField",
- "textField"
- ],
- "members": {
- "metadataField": {},
- "textField": {}
- }
- },
- "namespace": {}
- }
- },
- "rdsConfiguration": {
- "type": "structure",
- "required": [
- "credentialsSecretArn",
- "databaseName",
- "fieldMapping",
- "resourceArn",
- "tableName"
- ],
- "members": {
- "credentialsSecretArn": {},
- "databaseName": {},
- "fieldMapping": {
- "type": "structure",
- "required": [
- "metadataField",
- "primaryKeyField",
- "textField",
- "vectorField"
- ],
- "members": {
- "metadataField": {},
- "primaryKeyField": {},
- "textField": {},
- "vectorField": {}
- }
- },
- "resourceArn": {},
- "tableName": {}
- }
- },
- "redisEnterpriseCloudConfiguration": {
- "type": "structure",
- "required": [
- "credentialsSecretArn",
- "endpoint",
- "fieldMapping",
- "vectorIndexName"
- ],
- "members": {
- "credentialsSecretArn": {},
- "endpoint": {},
- "fieldMapping": {
- "type": "structure",
- "required": [
- "metadataField",
- "textField",
- "vectorField"
- ],
- "members": {
- "metadataField": {},
- "textField": {},
- "vectorField": {}
- }
- },
- "vectorIndexName": {}
- }
- },
- "type": {}
- }
- },
- "S3n": {
- "type": "structure",
- "required": [
- "createdAt",
- "knowledgeBaseArn",
- "knowledgeBaseConfiguration",
- "knowledgeBaseId",
- "name",
- "roleArn",
- "status",
- "storageConfiguration",
- "updatedAt"
- ],
- "members": {
- "createdAt": {
- "shape": "S9"
- },
- "description": {},
- "failureReasons": {
- "shape": "S14"
- },
- "knowledgeBaseArn": {},
- "knowledgeBaseConfiguration": {
- "shape": "S2o"
- },
- "knowledgeBaseId": {},
- "name": {},
- "roleArn": {},
- "status": {},
- "storageConfiguration": {
- "shape": "S2t"
- },
- "updatedAt": {
- "shape": "S9"
- }
- }
- },
- "S4k": {
- "type": "structure",
- "required": [
- "dataSourceId",
- "ingestionJobId",
- "knowledgeBaseId",
- "startedAt",
- "status",
- "updatedAt"
- ],
- "members": {
- "dataSourceId": {},
- "description": {},
- "failureReasons": {
- "shape": "S14"
- },
- "ingestionJobId": {},
- "knowledgeBaseId": {},
- "startedAt": {
- "shape": "S9"
- },
- "statistics": {
- "shape": "S4l"
- },
- "status": {},
- "updatedAt": {
- "shape": "S9"
- }
- }
- },
- "S4l": {
- "type": "structure",
- "members": {
- "numberOfDocumentsDeleted": {
- "type": "long"
- },
- "numberOfDocumentsFailed": {
- "type": "long"
- },
- "numberOfDocumentsScanned": {
- "type": "long"
- },
- "numberOfMetadataDocumentsModified": {
- "type": "long"
- },
- "numberOfMetadataDocumentsScanned": {
- "type": "long"
- },
- "numberOfModifiedDocumentsIndexed": {
- "type": "long"
- },
- "numberOfNewDocumentsIndexed": {
- "type": "long"
- }
- }
- }
- }
- }
|