123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198 |
- {
- "version": "2.0",
- "metadata": {
- "apiVersion": "2023-11-27",
- "endpointPrefix": "qbusiness",
- "protocol": "rest-json",
- "protocolSettings": {
- "h2": "eventstream"
- },
- "protocols": [
- "rest-json"
- ],
- "serviceFullName": "QBusiness",
- "serviceId": "QBusiness",
- "signatureVersion": "v4",
- "signingName": "qbusiness",
- "uid": "qbusiness-2023-11-27"
- },
- "operations": {
- "BatchDeleteDocument": {
- "http": {
- "requestUri": "/applications/{applicationId}/indices/{indexId}/documents/delete",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId",
- "documents"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- },
- "documents": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "documentId"
- ],
- "members": {
- "documentId": {}
- }
- }
- },
- "dataSourceSyncId": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "failedDocuments": {
- "shape": "S9"
- }
- }
- }
- },
- "BatchPutDocument": {
- "http": {
- "requestUri": "/applications/{applicationId}/indices/{indexId}/documents",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId",
- "documents"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- },
- "documents": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "id"
- ],
- "members": {
- "id": {},
- "attributes": {
- "type": "list",
- "member": {
- "shape": "Sj"
- }
- },
- "content": {
- "type": "structure",
- "members": {
- "blob": {
- "type": "blob"
- },
- "s3": {
- "shape": "St"
- }
- },
- "union": true
- },
- "contentType": {},
- "title": {},
- "accessConfiguration": {
- "type": "structure",
- "required": [
- "accessControls"
- ],
- "members": {
- "accessControls": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "principals"
- ],
- "members": {
- "principals": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "user": {
- "type": "structure",
- "required": [
- "access"
- ],
- "members": {
- "id": {},
- "access": {},
- "membershipType": {}
- }
- },
- "group": {
- "type": "structure",
- "required": [
- "access"
- ],
- "members": {
- "name": {},
- "access": {},
- "membershipType": {}
- }
- }
- },
- "union": true
- }
- },
- "memberRelation": {}
- }
- }
- },
- "memberRelation": {}
- }
- },
- "documentEnrichmentConfiguration": {
- "shape": "S1a"
- }
- }
- }
- },
- "roleArn": {},
- "dataSourceSyncId": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "failedDocuments": {
- "shape": "S9"
- }
- }
- }
- },
- "ChatSync": {
- "http": {
- "requestUri": "/applications/{applicationId}/conversations?sync",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "userId": {
- "location": "querystring",
- "locationName": "userId"
- },
- "userGroups": {
- "shape": "S1n",
- "location": "querystring",
- "locationName": "userGroups"
- },
- "userMessage": {},
- "attachments": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "name",
- "data"
- ],
- "members": {
- "name": {},
- "data": {
- "type": "blob"
- }
- }
- }
- },
- "actionExecution": {
- "shape": "S1s"
- },
- "authChallengeResponse": {
- "type": "structure",
- "required": [
- "responseMap"
- ],
- "members": {
- "responseMap": {
- "type": "map",
- "key": {},
- "value": {}
- }
- }
- },
- "conversationId": {},
- "parentMessageId": {},
- "attributeFilter": {
- "shape": "S25"
- },
- "chatMode": {},
- "chatModeConfiguration": {
- "type": "structure",
- "members": {
- "pluginConfiguration": {
- "type": "structure",
- "required": [
- "pluginId"
- ],
- "members": {
- "pluginId": {}
- }
- }
- },
- "union": true
- },
- "clientToken": {
- "idempotencyToken": true
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "conversationId": {},
- "systemMessage": {},
- "systemMessageId": {},
- "userMessageId": {},
- "actionReview": {
- "shape": "S2c"
- },
- "authChallengeRequest": {
- "type": "structure",
- "required": [
- "authorizationUrl"
- ],
- "members": {
- "authorizationUrl": {}
- }
- },
- "sourceAttributions": {
- "shape": "S2n"
- },
- "failedAttachments": {
- "shape": "S2t"
- }
- }
- }
- },
- "CreateApplication": {
- "http": {
- "requestUri": "/applications",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "displayName"
- ],
- "members": {
- "displayName": {},
- "roleArn": {},
- "identityCenterInstanceArn": {},
- "description": {},
- "encryptionConfiguration": {
- "shape": "S30"
- },
- "tags": {
- "shape": "S32"
- },
- "clientToken": {
- "idempotencyToken": true
- },
- "attachmentsConfiguration": {
- "shape": "S36"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "applicationId": {},
- "applicationArn": {}
- }
- },
- "idempotent": true
- },
- "CreateDataSource": {
- "http": {
- "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId",
- "displayName",
- "configuration"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- },
- "displayName": {},
- "configuration": {
- "shape": "S3c"
- },
- "vpcConfiguration": {
- "shape": "S3d"
- },
- "description": {},
- "tags": {
- "shape": "S32"
- },
- "syncSchedule": {},
- "roleArn": {},
- "clientToken": {
- "idempotencyToken": true
- },
- "documentEnrichmentConfiguration": {
- "shape": "S1a"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "dataSourceId": {},
- "dataSourceArn": {}
- }
- },
- "idempotent": true
- },
- "CreateIndex": {
- "http": {
- "requestUri": "/applications/{applicationId}/indices",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "displayName"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "displayName": {},
- "type": {},
- "description": {},
- "tags": {
- "shape": "S32"
- },
- "capacityConfiguration": {
- "shape": "S3o"
- },
- "clientToken": {
- "idempotencyToken": true
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "indexId": {},
- "indexArn": {}
- }
- }
- },
- "CreatePlugin": {
- "http": {
- "requestUri": "/applications/{applicationId}/plugins",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "displayName",
- "type",
- "authConfiguration"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "displayName": {},
- "type": {},
- "authConfiguration": {
- "shape": "S3u"
- },
- "serverUrl": {},
- "customPluginConfiguration": {
- "shape": "S3z"
- },
- "tags": {
- "shape": "S32"
- },
- "clientToken": {
- "idempotencyToken": true
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "pluginId": {},
- "pluginArn": {},
- "buildStatus": {}
- }
- },
- "idempotent": true
- },
- "CreateRetriever": {
- "http": {
- "requestUri": "/applications/{applicationId}/retrievers",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "type",
- "displayName",
- "configuration"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "type": {},
- "displayName": {},
- "configuration": {
- "shape": "S4a"
- },
- "roleArn": {},
- "clientToken": {
- "idempotencyToken": true
- },
- "tags": {
- "shape": "S32"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "retrieverId": {},
- "retrieverArn": {}
- }
- }
- },
- "CreateUser": {
- "http": {
- "requestUri": "/applications/{applicationId}/users",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "userId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "userId": {},
- "userAliases": {
- "type": "list",
- "member": {
- "shape": "S4u"
- }
- },
- "clientToken": {
- "idempotencyToken": true
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "CreateWebExperience": {
- "http": {
- "requestUri": "/applications/{applicationId}/experiences",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "title": {},
- "subtitle": {},
- "welcomeMessage": {},
- "samplePromptsControlMode": {},
- "roleArn": {},
- "tags": {
- "shape": "S32"
- },
- "clientToken": {
- "idempotencyToken": true
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "webExperienceId": {},
- "webExperienceArn": {}
- }
- }
- },
- "DeleteApplication": {
- "http": {
- "method": "DELETE",
- "requestUri": "/applications/{applicationId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteChatControlsConfiguration": {
- "http": {
- "method": "DELETE",
- "requestUri": "/applications/{applicationId}/chatcontrols",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteConversation": {
- "http": {
- "method": "DELETE",
- "requestUri": "/applications/{applicationId}/conversations/{conversationId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "conversationId",
- "applicationId"
- ],
- "members": {
- "conversationId": {
- "location": "uri",
- "locationName": "conversationId"
- },
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "userId": {
- "location": "querystring",
- "locationName": "userId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteDataSource": {
- "http": {
- "method": "DELETE",
- "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId",
- "dataSourceId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- },
- "dataSourceId": {
- "location": "uri",
- "locationName": "dataSourceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteGroup": {
- "http": {
- "method": "DELETE",
- "requestUri": "/applications/{applicationId}/indices/{indexId}/groups/{groupName}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId",
- "groupName"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- },
- "groupName": {
- "location": "uri",
- "locationName": "groupName"
- },
- "dataSourceId": {
- "location": "querystring",
- "locationName": "dataSourceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteIndex": {
- "http": {
- "method": "DELETE",
- "requestUri": "/applications/{applicationId}/indices/{indexId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeletePlugin": {
- "http": {
- "method": "DELETE",
- "requestUri": "/applications/{applicationId}/plugins/{pluginId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "pluginId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "pluginId": {
- "location": "uri",
- "locationName": "pluginId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteRetriever": {
- "http": {
- "method": "DELETE",
- "requestUri": "/applications/{applicationId}/retrievers/{retrieverId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "retrieverId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "retrieverId": {
- "location": "uri",
- "locationName": "retrieverId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteUser": {
- "http": {
- "method": "DELETE",
- "requestUri": "/applications/{applicationId}/users/{userId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "userId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "userId": {
- "location": "uri",
- "locationName": "userId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "DeleteWebExperience": {
- "http": {
- "method": "DELETE",
- "requestUri": "/applications/{applicationId}/experiences/{webExperienceId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "webExperienceId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "webExperienceId": {
- "location": "uri",
- "locationName": "webExperienceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "GetApplication": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "displayName": {},
- "applicationId": {},
- "applicationArn": {},
- "identityCenterApplicationArn": {},
- "roleArn": {},
- "status": {},
- "description": {},
- "encryptionConfiguration": {
- "shape": "S30"
- },
- "createdAt": {
- "type": "timestamp"
- },
- "updatedAt": {
- "type": "timestamp"
- },
- "error": {
- "shape": "Sb"
- },
- "attachmentsConfiguration": {
- "type": "structure",
- "members": {
- "attachmentsControlMode": {}
- }
- }
- }
- }
- },
- "GetChatControlsConfiguration": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/chatcontrols",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "responseScope": {},
- "blockedPhrases": {
- "type": "structure",
- "members": {
- "blockedPhrases": {
- "shape": "S5z"
- },
- "systemMessageOverride": {}
- }
- },
- "topicConfigurations": {
- "shape": "S62"
- },
- "creatorModeConfiguration": {
- "type": "structure",
- "required": [
- "creatorModeControl"
- ],
- "members": {
- "creatorModeControl": {}
- }
- },
- "nextToken": {}
- }
- }
- },
- "GetDataSource": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId",
- "dataSourceId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- },
- "dataSourceId": {
- "location": "uri",
- "locationName": "dataSourceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "applicationId": {},
- "indexId": {},
- "dataSourceId": {},
- "dataSourceArn": {},
- "displayName": {},
- "type": {},
- "configuration": {
- "shape": "S3c"
- },
- "vpcConfiguration": {
- "shape": "S3d"
- },
- "createdAt": {
- "type": "timestamp"
- },
- "updatedAt": {
- "type": "timestamp"
- },
- "description": {},
- "status": {},
- "syncSchedule": {},
- "roleArn": {},
- "error": {
- "shape": "Sb"
- },
- "documentEnrichmentConfiguration": {
- "shape": "S1a"
- }
- }
- }
- },
- "GetGroup": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/indices/{indexId}/groups/{groupName}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId",
- "groupName"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- },
- "groupName": {
- "location": "uri",
- "locationName": "groupName"
- },
- "dataSourceId": {
- "location": "querystring",
- "locationName": "dataSourceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "status": {
- "shape": "S6p"
- },
- "statusHistory": {
- "type": "list",
- "member": {
- "shape": "S6p"
- }
- }
- }
- }
- },
- "GetIndex": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/indices/{indexId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "applicationId": {},
- "indexId": {},
- "displayName": {},
- "type": {},
- "indexArn": {},
- "status": {},
- "description": {},
- "createdAt": {
- "type": "timestamp"
- },
- "updatedAt": {
- "type": "timestamp"
- },
- "capacityConfiguration": {
- "shape": "S3o"
- },
- "documentAttributeConfigurations": {
- "shape": "S6v"
- },
- "error": {
- "shape": "Sb"
- },
- "indexStatistics": {
- "type": "structure",
- "members": {
- "textDocumentStatistics": {
- "type": "structure",
- "members": {
- "indexedTextBytes": {
- "type": "long"
- },
- "indexedTextDocumentCount": {
- "type": "integer"
- }
- }
- }
- }
- }
- }
- }
- },
- "GetPlugin": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/plugins/{pluginId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "pluginId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "pluginId": {
- "location": "uri",
- "locationName": "pluginId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "applicationId": {},
- "pluginId": {},
- "displayName": {},
- "type": {},
- "serverUrl": {},
- "authConfiguration": {
- "shape": "S3u"
- },
- "customPluginConfiguration": {
- "shape": "S3z"
- },
- "buildStatus": {},
- "pluginArn": {},
- "state": {},
- "createdAt": {
- "type": "timestamp"
- },
- "updatedAt": {
- "type": "timestamp"
- }
- }
- }
- },
- "GetRetriever": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/retrievers/{retrieverId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "retrieverId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "retrieverId": {
- "location": "uri",
- "locationName": "retrieverId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "applicationId": {},
- "retrieverId": {},
- "retrieverArn": {},
- "type": {},
- "status": {},
- "displayName": {},
- "configuration": {
- "shape": "S4a"
- },
- "roleArn": {},
- "createdAt": {
- "type": "timestamp"
- },
- "updatedAt": {
- "type": "timestamp"
- }
- }
- }
- },
- "GetUser": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/users/{userId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "userId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "userId": {
- "location": "uri",
- "locationName": "userId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "userAliases": {
- "shape": "S7c"
- }
- }
- }
- },
- "GetWebExperience": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/experiences/{webExperienceId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "webExperienceId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "webExperienceId": {
- "location": "uri",
- "locationName": "webExperienceId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "applicationId": {},
- "webExperienceId": {},
- "webExperienceArn": {},
- "defaultEndpoint": {},
- "status": {},
- "createdAt": {
- "type": "timestamp"
- },
- "updatedAt": {
- "type": "timestamp"
- },
- "title": {},
- "subtitle": {},
- "welcomeMessage": {},
- "samplePromptsControlMode": {},
- "roleArn": {},
- "authenticationConfiguration": {
- "shape": "S7g",
- "deprecated": true,
- "deprecatedMessage": "Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management."
- },
- "error": {
- "shape": "Sb"
- }
- }
- }
- },
- "ListApplications": {
- "http": {
- "method": "GET",
- "requestUri": "/applications",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "members": {
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "nextToken": {},
- "applications": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "displayName": {},
- "applicationId": {},
- "createdAt": {
- "type": "timestamp"
- },
- "updatedAt": {
- "type": "timestamp"
- },
- "status": {}
- }
- }
- }
- }
- }
- },
- "ListConversations": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/conversations",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "userId": {
- "location": "querystring",
- "locationName": "userId"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "nextToken": {},
- "conversations": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "conversationId": {},
- "title": {},
- "startTime": {
- "type": "timestamp"
- }
- }
- }
- }
- }
- }
- },
- "ListDataSourceSyncJobs": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/syncjobs",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "dataSourceId",
- "applicationId",
- "indexId"
- ],
- "members": {
- "dataSourceId": {
- "location": "uri",
- "locationName": "dataSourceId"
- },
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- },
- "startTime": {
- "location": "querystring",
- "locationName": "startTime",
- "type": "timestamp"
- },
- "endTime": {
- "location": "querystring",
- "locationName": "endTime",
- "type": "timestamp"
- },
- "statusFilter": {
- "location": "querystring",
- "locationName": "syncStatus"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "history": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "executionId": {},
- "startTime": {
- "type": "timestamp"
- },
- "endTime": {
- "type": "timestamp"
- },
- "status": {},
- "error": {
- "shape": "Sb"
- },
- "dataSourceErrorCode": {},
- "metrics": {
- "type": "structure",
- "members": {
- "documentsAdded": {},
- "documentsModified": {},
- "documentsDeleted": {},
- "documentsFailed": {},
- "documentsScanned": {}
- }
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListDataSources": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "dataSources": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "displayName": {},
- "dataSourceId": {},
- "type": {},
- "createdAt": {
- "type": "timestamp"
- },
- "updatedAt": {
- "type": "timestamp"
- },
- "status": {}
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListDocuments": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/index/{indexId}/documents",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- },
- "dataSourceIds": {
- "location": "querystring",
- "locationName": "dataSourceIds",
- "type": "list",
- "member": {}
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "documentDetailList": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "documentId": {},
- "status": {},
- "error": {
- "shape": "Sb"
- },
- "createdAt": {
- "type": "timestamp"
- },
- "updatedAt": {
- "type": "timestamp"
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListGroups": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/indices/{indexId}/groups",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId",
- "updatedEarlierThan"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- },
- "updatedEarlierThan": {
- "location": "querystring",
- "locationName": "updatedEarlierThan",
- "type": "timestamp"
- },
- "dataSourceId": {
- "location": "querystring",
- "locationName": "dataSourceId"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "nextToken": {},
- "items": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "groupName": {}
- }
- }
- }
- }
- }
- },
- "ListIndices": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/indices",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "nextToken": {},
- "indices": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "displayName": {},
- "indexId": {},
- "createdAt": {
- "type": "timestamp"
- },
- "updatedAt": {
- "type": "timestamp"
- },
- "status": {}
- }
- }
- }
- }
- }
- },
- "ListMessages": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/conversations/{conversationId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "conversationId",
- "applicationId"
- ],
- "members": {
- "conversationId": {
- "location": "uri",
- "locationName": "conversationId"
- },
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "userId": {
- "location": "querystring",
- "locationName": "userId"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "messages": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "messageId": {},
- "body": {},
- "time": {
- "type": "timestamp"
- },
- "type": {},
- "attachments": {
- "shape": "S2t"
- },
- "sourceAttribution": {
- "shape": "S2n"
- },
- "actionReview": {
- "shape": "S2c"
- },
- "actionExecution": {
- "shape": "S1s"
- }
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListPlugins": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/plugins",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "nextToken": {},
- "plugins": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "pluginId": {},
- "displayName": {},
- "type": {},
- "serverUrl": {},
- "state": {},
- "buildStatus": {},
- "createdAt": {
- "type": "timestamp"
- },
- "updatedAt": {
- "type": "timestamp"
- }
- }
- }
- }
- }
- }
- },
- "ListRetrievers": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/retrievers",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "retrievers": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "applicationId": {},
- "retrieverId": {},
- "type": {},
- "status": {},
- "displayName": {}
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "ListTagsForResource": {
- "http": {
- "method": "GET",
- "requestUri": "/v1/tags/{resourceARN}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "resourceARN"
- ],
- "members": {
- "resourceARN": {
- "location": "uri",
- "locationName": "resourceARN"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "tags": {
- "shape": "S32"
- }
- }
- }
- },
- "ListWebExperiences": {
- "http": {
- "method": "GET",
- "requestUri": "/applications/{applicationId}/experiences",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "nextToken": {
- "location": "querystring",
- "locationName": "nextToken"
- },
- "maxResults": {
- "location": "querystring",
- "locationName": "maxResults",
- "type": "integer"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "webExperiences": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "webExperienceId": {},
- "createdAt": {
- "type": "timestamp"
- },
- "updatedAt": {
- "type": "timestamp"
- },
- "defaultEndpoint": {},
- "status": {}
- }
- }
- },
- "nextToken": {}
- }
- }
- },
- "PutFeedback": {
- "http": {
- "requestUri": "/applications/{applicationId}/conversations/{conversationId}/messages/{messageId}/feedback",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "conversationId",
- "messageId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "userId": {
- "location": "querystring",
- "locationName": "userId"
- },
- "conversationId": {
- "location": "uri",
- "locationName": "conversationId"
- },
- "messageId": {
- "location": "uri",
- "locationName": "messageId"
- },
- "messageCopiedAt": {
- "type": "timestamp"
- },
- "messageUsefulness": {
- "type": "structure",
- "required": [
- "usefulness",
- "submittedAt"
- ],
- "members": {
- "usefulness": {},
- "reason": {},
- "comment": {},
- "submittedAt": {
- "type": "timestamp"
- }
- }
- }
- }
- }
- },
- "PutGroup": {
- "http": {
- "method": "PUT",
- "requestUri": "/applications/{applicationId}/indices/{indexId}/groups",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId",
- "groupName",
- "type",
- "groupMembers"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- },
- "groupName": {},
- "dataSourceId": {},
- "type": {},
- "groupMembers": {
- "type": "structure",
- "members": {
- "memberGroups": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "groupName"
- ],
- "members": {
- "groupName": {},
- "type": {}
- }
- }
- },
- "memberUsers": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "userId"
- ],
- "members": {
- "userId": {},
- "type": {}
- }
- }
- }
- }
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "StartDataSourceSyncJob": {
- "http": {
- "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/startsync",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "dataSourceId",
- "applicationId",
- "indexId"
- ],
- "members": {
- "dataSourceId": {
- "location": "uri",
- "locationName": "dataSourceId"
- },
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "executionId": {}
- }
- }
- },
- "StopDataSourceSyncJob": {
- "http": {
- "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}/stopsync",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "dataSourceId",
- "applicationId",
- "indexId"
- ],
- "members": {
- "dataSourceId": {
- "location": "uri",
- "locationName": "dataSourceId"
- },
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- }
- },
- "TagResource": {
- "http": {
- "requestUri": "/v1/tags/{resourceARN}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "resourceARN",
- "tags"
- ],
- "members": {
- "resourceARN": {
- "location": "uri",
- "locationName": "resourceARN"
- },
- "tags": {
- "shape": "S32"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "UntagResource": {
- "http": {
- "method": "DELETE",
- "requestUri": "/v1/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
- },
- "UpdateApplication": {
- "http": {
- "method": "PUT",
- "requestUri": "/applications/{applicationId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "identityCenterInstanceArn": {},
- "displayName": {},
- "description": {},
- "roleArn": {},
- "attachmentsConfiguration": {
- "shape": "S36"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "UpdateChatControlsConfiguration": {
- "http": {
- "method": "PATCH",
- "requestUri": "/applications/{applicationId}/chatcontrols",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "clientToken": {
- "idempotencyToken": true
- },
- "responseScope": {},
- "blockedPhrasesConfigurationUpdate": {
- "type": "structure",
- "members": {
- "blockedPhrasesToCreateOrUpdate": {
- "shape": "S5z"
- },
- "blockedPhrasesToDelete": {
- "shape": "S5z"
- },
- "systemMessageOverride": {}
- }
- },
- "topicConfigurationsToCreateOrUpdate": {
- "shape": "S62"
- },
- "topicConfigurationsToDelete": {
- "shape": "S62"
- },
- "creatorModeConfiguration": {
- "type": "structure",
- "required": [
- "creatorModeControl"
- ],
- "members": {
- "creatorModeControl": {}
- }
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "UpdateDataSource": {
- "http": {
- "method": "PUT",
- "requestUri": "/applications/{applicationId}/indices/{indexId}/datasources/{dataSourceId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId",
- "dataSourceId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- },
- "dataSourceId": {
- "location": "uri",
- "locationName": "dataSourceId"
- },
- "displayName": {},
- "configuration": {
- "shape": "S3c"
- },
- "vpcConfiguration": {
- "shape": "S3d"
- },
- "description": {},
- "syncSchedule": {},
- "roleArn": {},
- "documentEnrichmentConfiguration": {
- "shape": "S1a"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "UpdateIndex": {
- "http": {
- "method": "PUT",
- "requestUri": "/applications/{applicationId}/indices/{indexId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "indexId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "indexId": {
- "location": "uri",
- "locationName": "indexId"
- },
- "displayName": {},
- "description": {},
- "capacityConfiguration": {
- "shape": "S3o"
- },
- "documentAttributeConfigurations": {
- "shape": "S6v"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "UpdatePlugin": {
- "http": {
- "method": "PUT",
- "requestUri": "/applications/{applicationId}/plugins/{pluginId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "pluginId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "pluginId": {
- "location": "uri",
- "locationName": "pluginId"
- },
- "displayName": {},
- "state": {},
- "serverUrl": {},
- "customPluginConfiguration": {
- "shape": "S3z"
- },
- "authConfiguration": {
- "shape": "S3u"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "UpdateRetriever": {
- "http": {
- "method": "PUT",
- "requestUri": "/applications/{applicationId}/retrievers/{retrieverId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "retrieverId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "retrieverId": {
- "location": "uri",
- "locationName": "retrieverId"
- },
- "configuration": {
- "shape": "S4a"
- },
- "displayName": {},
- "roleArn": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- },
- "UpdateUser": {
- "http": {
- "method": "PUT",
- "requestUri": "/applications/{applicationId}/users/{userId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "userId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "userId": {
- "location": "uri",
- "locationName": "userId"
- },
- "userAliasesToUpdate": {
- "shape": "S7c"
- },
- "userAliasesToDelete": {
- "shape": "S7c"
- }
- }
- },
- "output": {
- "type": "structure",
- "members": {
- "userAliasesAdded": {
- "shape": "S7c"
- },
- "userAliasesUpdated": {
- "shape": "S7c"
- },
- "userAliasesDeleted": {
- "shape": "S7c"
- }
- }
- },
- "idempotent": true
- },
- "UpdateWebExperience": {
- "http": {
- "method": "PUT",
- "requestUri": "/applications/{applicationId}/experiences/{webExperienceId}",
- "responseCode": 200
- },
- "input": {
- "type": "structure",
- "required": [
- "applicationId",
- "webExperienceId"
- ],
- "members": {
- "applicationId": {
- "location": "uri",
- "locationName": "applicationId"
- },
- "webExperienceId": {
- "location": "uri",
- "locationName": "webExperienceId"
- },
- "roleArn": {},
- "authenticationConfiguration": {
- "shape": "S7g",
- "deprecated": true,
- "deprecatedMessage": "Property associated with legacy SAML IdP flow. Deprecated in favor of using AWS IAM Identity Center for user management."
- },
- "title": {},
- "subtitle": {},
- "welcomeMessage": {},
- "samplePromptsControlMode": {}
- }
- },
- "output": {
- "type": "structure",
- "members": {}
- },
- "idempotent": true
- }
- },
- "shapes": {
- "S9": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "id": {},
- "error": {
- "shape": "Sb"
- },
- "dataSourceId": {}
- }
- }
- },
- "Sb": {
- "type": "structure",
- "members": {
- "errorMessage": {},
- "errorCode": {}
- }
- },
- "Sj": {
- "type": "structure",
- "required": [
- "name",
- "value"
- ],
- "members": {
- "name": {},
- "value": {
- "shape": "Sl"
- }
- }
- },
- "Sl": {
- "type": "structure",
- "members": {
- "stringValue": {},
- "stringListValue": {
- "type": "list",
- "member": {}
- },
- "longValue": {
- "type": "long"
- },
- "dateValue": {
- "type": "timestamp"
- }
- },
- "union": true
- },
- "St": {
- "type": "structure",
- "required": [
- "bucket",
- "key"
- ],
- "members": {
- "bucket": {},
- "key": {}
- }
- },
- "S1a": {
- "type": "structure",
- "members": {
- "inlineConfigurations": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "condition": {
- "shape": "S1d"
- },
- "target": {
- "type": "structure",
- "required": [
- "key"
- ],
- "members": {
- "key": {},
- "value": {
- "shape": "Sl"
- },
- "attributeValueOperator": {}
- }
- },
- "documentContentOperator": {}
- }
- }
- },
- "preExtractionHookConfiguration": {
- "shape": "S1i"
- },
- "postExtractionHookConfiguration": {
- "shape": "S1i"
- }
- }
- },
- "S1d": {
- "type": "structure",
- "required": [
- "key",
- "operator"
- ],
- "members": {
- "key": {},
- "operator": {},
- "value": {
- "shape": "Sl"
- }
- }
- },
- "S1i": {
- "type": "structure",
- "members": {
- "invocationCondition": {
- "shape": "S1d"
- },
- "lambdaArn": {},
- "s3BucketName": {},
- "roleArn": {}
- }
- },
- "S1n": {
- "type": "list",
- "member": {}
- },
- "S1s": {
- "type": "structure",
- "required": [
- "pluginId",
- "payload",
- "payloadFieldNameSeparator"
- ],
- "members": {
- "pluginId": {},
- "payload": {
- "type": "map",
- "key": {},
- "value": {
- "type": "structure",
- "required": [
- "value"
- ],
- "members": {
- "value": {
- "shape": "S1x"
- }
- }
- }
- },
- "payloadFieldNameSeparator": {}
- }
- },
- "S1x": {
- "type": "structure",
- "members": {},
- "document": true
- },
- "S25": {
- "type": "structure",
- "members": {
- "andAllFilters": {
- "shape": "S26"
- },
- "orAllFilters": {
- "shape": "S26"
- },
- "notFilter": {
- "shape": "S25"
- },
- "equalsTo": {
- "shape": "Sj"
- },
- "containsAll": {
- "shape": "Sj"
- },
- "containsAny": {
- "shape": "Sj"
- },
- "greaterThan": {
- "shape": "Sj"
- },
- "greaterThanOrEquals": {
- "shape": "Sj"
- },
- "lessThan": {
- "shape": "Sj"
- },
- "lessThanOrEquals": {
- "shape": "Sj"
- }
- }
- },
- "S26": {
- "type": "list",
- "member": {
- "shape": "S25"
- }
- },
- "S2c": {
- "type": "structure",
- "members": {
- "pluginId": {},
- "pluginType": {},
- "payload": {
- "type": "map",
- "key": {},
- "value": {
- "type": "structure",
- "members": {
- "displayName": {},
- "displayOrder": {
- "type": "integer"
- },
- "displayDescription": {},
- "type": {},
- "value": {
- "shape": "S1x"
- },
- "allowedValues": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "value": {
- "shape": "S1x"
- },
- "displayValue": {
- "shape": "S1x"
- }
- }
- }
- },
- "allowedFormat": {},
- "required": {
- "type": "boolean"
- }
- }
- }
- },
- "payloadFieldNameSeparator": {}
- }
- },
- "S2n": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "title": {},
- "snippet": {},
- "url": {},
- "citationNumber": {
- "type": "integer"
- },
- "updatedAt": {
- "type": "timestamp"
- },
- "textMessageSegments": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "beginOffset": {
- "type": "integer"
- },
- "endOffset": {
- "type": "integer"
- },
- "snippetExcerpt": {
- "type": "structure",
- "members": {
- "text": {}
- }
- }
- }
- }
- }
- }
- }
- },
- "S2t": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "name": {},
- "status": {},
- "error": {
- "shape": "Sb"
- }
- }
- }
- },
- "S30": {
- "type": "structure",
- "members": {
- "kmsKeyId": {
- "type": "string",
- "sensitive": true
- }
- }
- },
- "S32": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "key",
- "value"
- ],
- "members": {
- "key": {},
- "value": {}
- }
- }
- },
- "S36": {
- "type": "structure",
- "required": [
- "attachmentsControlMode"
- ],
- "members": {
- "attachmentsControlMode": {}
- }
- },
- "S3c": {
- "type": "structure",
- "members": {},
- "document": true
- },
- "S3d": {
- "type": "structure",
- "required": [
- "subnetIds",
- "securityGroupIds"
- ],
- "members": {
- "subnetIds": {
- "type": "list",
- "member": {}
- },
- "securityGroupIds": {
- "type": "list",
- "member": {}
- }
- }
- },
- "S3o": {
- "type": "structure",
- "members": {
- "units": {
- "type": "integer"
- }
- }
- },
- "S3u": {
- "type": "structure",
- "members": {
- "basicAuthConfiguration": {
- "type": "structure",
- "required": [
- "secretArn",
- "roleArn"
- ],
- "members": {
- "secretArn": {},
- "roleArn": {}
- }
- },
- "oAuth2ClientCredentialConfiguration": {
- "type": "structure",
- "required": [
- "secretArn",
- "roleArn"
- ],
- "members": {
- "secretArn": {},
- "roleArn": {}
- }
- },
- "noAuthConfiguration": {
- "type": "structure",
- "members": {}
- }
- },
- "union": true
- },
- "S3z": {
- "type": "structure",
- "required": [
- "description",
- "apiSchemaType",
- "apiSchema"
- ],
- "members": {
- "description": {},
- "apiSchemaType": {},
- "apiSchema": {
- "type": "structure",
- "members": {
- "payload": {
- "type": "string",
- "sensitive": true
- },
- "s3": {
- "shape": "St"
- }
- },
- "union": true
- }
- }
- },
- "S4a": {
- "type": "structure",
- "members": {
- "nativeIndexConfiguration": {
- "type": "structure",
- "required": [
- "indexId"
- ],
- "members": {
- "indexId": {},
- "boostingOverride": {
- "type": "map",
- "key": {},
- "value": {
- "type": "structure",
- "members": {
- "numberConfiguration": {
- "type": "structure",
- "required": [
- "boostingLevel"
- ],
- "members": {
- "boostingLevel": {},
- "boostingType": {}
- }
- },
- "stringConfiguration": {
- "type": "structure",
- "required": [
- "boostingLevel"
- ],
- "members": {
- "boostingLevel": {},
- "attributeValueBoosting": {
- "type": "map",
- "key": {},
- "value": {}
- }
- }
- },
- "dateConfiguration": {
- "type": "structure",
- "required": [
- "boostingLevel"
- ],
- "members": {
- "boostingLevel": {},
- "boostingDurationInSeconds": {
- "type": "long"
- }
- }
- },
- "stringListConfiguration": {
- "type": "structure",
- "required": [
- "boostingLevel"
- ],
- "members": {
- "boostingLevel": {}
- }
- }
- },
- "union": true
- }
- }
- }
- },
- "kendraIndexConfiguration": {
- "type": "structure",
- "required": [
- "indexId"
- ],
- "members": {
- "indexId": {}
- }
- }
- },
- "union": true
- },
- "S4u": {
- "type": "structure",
- "required": [
- "userId"
- ],
- "members": {
- "indexId": {},
- "dataSourceId": {},
- "userId": {}
- }
- },
- "S5z": {
- "type": "list",
- "member": {}
- },
- "S62": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "name",
- "rules"
- ],
- "members": {
- "name": {},
- "description": {},
- "exampleChatMessages": {
- "type": "list",
- "member": {}
- },
- "rules": {
- "type": "list",
- "member": {
- "type": "structure",
- "required": [
- "ruleType"
- ],
- "members": {
- "includedUsersAndGroups": {
- "shape": "S6a"
- },
- "excludedUsersAndGroups": {
- "shape": "S6a"
- },
- "ruleType": {},
- "ruleConfiguration": {
- "type": "structure",
- "members": {
- "contentBlockerRule": {
- "type": "structure",
- "members": {
- "systemMessageOverride": {}
- }
- },
- "contentRetrievalRule": {
- "type": "structure",
- "members": {
- "eligibleDataSources": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "indexId": {},
- "dataSourceId": {}
- }
- }
- }
- }
- }
- },
- "union": true
- }
- }
- }
- }
- }
- }
- },
- "S6a": {
- "type": "structure",
- "members": {
- "userIds": {
- "type": "list",
- "member": {}
- },
- "userGroups": {
- "shape": "S1n"
- }
- }
- },
- "S6p": {
- "type": "structure",
- "members": {
- "status": {},
- "lastUpdatedAt": {
- "type": "timestamp"
- },
- "errorDetail": {
- "shape": "Sb"
- }
- }
- },
- "S6v": {
- "type": "list",
- "member": {
- "type": "structure",
- "members": {
- "name": {},
- "type": {},
- "search": {}
- }
- }
- },
- "S7c": {
- "type": "list",
- "member": {
- "shape": "S4u"
- }
- },
- "S7g": {
- "type": "structure",
- "members": {
- "samlConfiguration": {
- "type": "structure",
- "required": [
- "metadataXML",
- "roleArn",
- "userIdAttribute"
- ],
- "members": {
- "metadataXML": {},
- "roleArn": {},
- "userIdAttribute": {},
- "userGroupAttribute": {}
- }
- }
- },
- "union": true
- }
- }
- }
|