quicksight.d.ts 792 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131713271337134713571367137713871397140714171427143714471457146714771487149715071517152715371547155715671577158715971607161716271637164716571667167716871697170717171727173717471757176717771787179718071817182718371847185718671877188718971907191719271937194719571967197719871997200720172027203720472057206720772087209721072117212721372147215721672177218721972207221722272237224722572267227722872297230723172327233723472357236723772387239724072417242724372447245724672477248724972507251725272537254725572567257725872597260726172627263726472657266726772687269727072717272727372747275727672777278727972807281728272837284728572867287728872897290729172927293729472957296729772987299730073017302730373047305730673077308730973107311731273137314731573167317731873197320732173227323732473257326732773287329733073317332733373347335733673377338733973407341734273437344734573467347734873497350735173527353735473557356735773587359736073617362736373647365736673677368736973707371737273737374737573767377737873797380738173827383738473857386738773887389739073917392739373947395739673977398739974007401740274037404740574067407740874097410741174127413741474157416741774187419742074217422742374247425742674277428742974307431743274337434743574367437743874397440744174427443744474457446744774487449745074517452745374547455745674577458745974607461746274637464746574667467746874697470747174727473747474757476747774787479748074817482748374847485748674877488748974907491749274937494749574967497749874997500750175027503750475057506750775087509751075117512751375147515751675177518751975207521752275237524752575267527752875297530753175327533753475357536753775387539754075417542754375447545754675477548754975507551755275537554755575567557755875597560756175627563756475657566756775687569757075717572757375747575757675777578757975807581758275837584758575867587758875897590759175927593759475957596759775987599760076017602760376047605760676077608760976107611761276137614761576167617761876197620762176227623762476257626762776287629763076317632763376347635763676377638763976407641764276437644764576467647764876497650765176527653765476557656765776587659766076617662766376647665766676677668766976707671767276737674767576767677767876797680768176827683768476857686768776887689769076917692769376947695769676977698769977007701770277037704770577067707770877097710771177127713771477157716771777187719772077217722772377247725772677277728772977307731773277337734773577367737773877397740774177427743774477457746774777487749775077517752775377547755775677577758775977607761776277637764776577667767776877697770777177727773777477757776777777787779778077817782778377847785778677877788778977907791779277937794779577967797779877997800780178027803780478057806780778087809781078117812781378147815781678177818781978207821782278237824782578267827782878297830783178327833783478357836783778387839784078417842784378447845784678477848784978507851785278537854785578567857785878597860786178627863786478657866786778687869787078717872787378747875787678777878787978807881788278837884788578867887788878897890789178927893789478957896789778987899790079017902790379047905790679077908790979107911791279137914791579167917791879197920792179227923792479257926792779287929793079317932793379347935793679377938793979407941794279437944794579467947794879497950795179527953795479557956795779587959796079617962796379647965796679677968796979707971797279737974797579767977797879797980798179827983798479857986798779887989799079917992799379947995799679977998799980008001800280038004800580068007800880098010801180128013801480158016801780188019802080218022802380248025802680278028802980308031803280338034803580368037803880398040804180428043804480458046804780488049805080518052805380548055805680578058805980608061806280638064806580668067806880698070807180728073807480758076807780788079808080818082808380848085808680878088808980908091809280938094809580968097809880998100810181028103810481058106810781088109811081118112811381148115811681178118811981208121812281238124812581268127812881298130813181328133813481358136813781388139814081418142814381448145814681478148814981508151815281538154815581568157815881598160816181628163816481658166816781688169817081718172817381748175817681778178817981808181818281838184818581868187818881898190819181928193819481958196819781988199820082018202820382048205820682078208820982108211821282138214821582168217821882198220822182228223822482258226822782288229823082318232823382348235823682378238823982408241824282438244824582468247824882498250825182528253825482558256825782588259826082618262826382648265826682678268826982708271827282738274827582768277827882798280828182828283828482858286828782888289829082918292829382948295829682978298829983008301830283038304830583068307830883098310831183128313831483158316831783188319832083218322832383248325832683278328832983308331833283338334833583368337833883398340834183428343834483458346834783488349835083518352835383548355835683578358835983608361836283638364836583668367836883698370837183728373837483758376837783788379838083818382838383848385838683878388838983908391839283938394839583968397839883998400840184028403840484058406840784088409841084118412841384148415841684178418841984208421842284238424842584268427842884298430843184328433843484358436843784388439844084418442844384448445844684478448844984508451845284538454845584568457845884598460846184628463846484658466846784688469847084718472847384748475847684778478847984808481848284838484848584868487848884898490849184928493849484958496849784988499850085018502850385048505850685078508850985108511851285138514851585168517851885198520852185228523852485258526852785288529853085318532853385348535853685378538853985408541854285438544854585468547854885498550855185528553855485558556855785588559856085618562856385648565856685678568856985708571857285738574857585768577857885798580858185828583858485858586858785888589859085918592859385948595859685978598859986008601860286038604860586068607860886098610861186128613861486158616861786188619862086218622862386248625862686278628862986308631863286338634863586368637863886398640864186428643864486458646864786488649865086518652865386548655865686578658865986608661866286638664866586668667866886698670867186728673867486758676867786788679868086818682868386848685868686878688868986908691869286938694869586968697869886998700870187028703870487058706870787088709871087118712871387148715871687178718871987208721872287238724872587268727872887298730873187328733873487358736873787388739874087418742874387448745874687478748874987508751875287538754875587568757875887598760876187628763876487658766876787688769877087718772877387748775877687778778877987808781878287838784878587868787878887898790879187928793879487958796879787988799880088018802880388048805880688078808880988108811881288138814881588168817881888198820882188228823882488258826882788288829883088318832883388348835883688378838883988408841884288438844884588468847884888498850885188528853885488558856885788588859886088618862886388648865886688678868886988708871887288738874887588768877887888798880888188828883888488858886888788888889889088918892889388948895889688978898889989008901890289038904890589068907890889098910891189128913891489158916891789188919892089218922892389248925892689278928892989308931893289338934893589368937893889398940894189428943894489458946894789488949895089518952895389548955895689578958895989608961896289638964896589668967896889698970897189728973897489758976897789788979898089818982898389848985898689878988898989908991899289938994899589968997899889999000900190029003900490059006900790089009901090119012901390149015901690179018901990209021902290239024902590269027902890299030903190329033903490359036903790389039904090419042904390449045904690479048904990509051905290539054905590569057905890599060906190629063906490659066906790689069907090719072907390749075907690779078907990809081908290839084908590869087908890899090909190929093909490959096909790989099910091019102910391049105910691079108910991109111911291139114911591169117911891199120912191229123912491259126912791289129913091319132913391349135913691379138913991409141914291439144914591469147914891499150915191529153915491559156915791589159916091619162916391649165916691679168916991709171917291739174917591769177917891799180918191829183918491859186918791889189919091919192919391949195919691979198919992009201920292039204920592069207920892099210921192129213921492159216921792189219922092219222922392249225922692279228922992309231923292339234923592369237923892399240924192429243924492459246924792489249925092519252925392549255925692579258925992609261926292639264926592669267926892699270927192729273927492759276927792789279928092819282928392849285928692879288928992909291929292939294929592969297929892999300930193029303930493059306930793089309931093119312931393149315931693179318931993209321932293239324932593269327932893299330933193329333933493359336933793389339934093419342934393449345934693479348934993509351935293539354935593569357935893599360936193629363936493659366936793689369937093719372937393749375937693779378937993809381938293839384938593869387938893899390939193929393939493959396939793989399940094019402940394049405940694079408940994109411941294139414941594169417941894199420942194229423942494259426942794289429943094319432943394349435943694379438943994409441944294439444944594469447944894499450945194529453945494559456945794589459946094619462946394649465946694679468946994709471947294739474947594769477947894799480948194829483948494859486948794889489949094919492949394949495949694979498949995009501950295039504950595069507950895099510951195129513951495159516951795189519952095219522952395249525952695279528952995309531953295339534953595369537953895399540954195429543954495459546954795489549955095519552955395549555955695579558955995609561956295639564956595669567956895699570957195729573957495759576957795789579958095819582958395849585958695879588958995909591959295939594959595969597959895999600960196029603960496059606960796089609961096119612961396149615961696179618961996209621962296239624962596269627962896299630963196329633963496359636963796389639964096419642964396449645964696479648964996509651965296539654965596569657965896599660966196629663966496659666966796689669967096719672967396749675967696779678967996809681968296839684968596869687968896899690969196929693969496959696969796989699970097019702970397049705970697079708970997109711971297139714971597169717971897199720972197229723972497259726972797289729973097319732973397349735973697379738973997409741974297439744974597469747974897499750975197529753975497559756975797589759976097619762976397649765976697679768976997709771977297739774977597769777977897799780978197829783978497859786978797889789979097919792979397949795979697979798979998009801980298039804980598069807980898099810981198129813981498159816981798189819982098219822982398249825982698279828982998309831983298339834983598369837983898399840984198429843984498459846984798489849985098519852985398549855985698579858985998609861986298639864986598669867986898699870987198729873987498759876987798789879988098819882988398849885988698879888988998909891989298939894989598969897989898999900990199029903990499059906990799089909991099119912991399149915991699179918991999209921992299239924992599269927992899299930993199329933993499359936993799389939994099419942994399449945994699479948994999509951995299539954995599569957995899599960996199629963996499659966996799689969997099719972997399749975997699779978997999809981998299839984998599869987998899899990999199929993999499959996999799989999100001000110002100031000410005100061000710008100091001010011100121001310014100151001610017100181001910020100211002210023100241002510026100271002810029100301003110032100331003410035100361003710038100391004010041100421004310044100451004610047100481004910050100511005210053100541005510056100571005810059100601006110062100631006410065100661006710068100691007010071100721007310074100751007610077100781007910080100811008210083100841008510086100871008810089100901009110092100931009410095100961009710098100991010010101101021010310104101051010610107101081010910110101111011210113101141011510116101171011810119101201012110122101231012410125101261012710128101291013010131101321013310134101351013610137101381013910140101411014210143101441014510146101471014810149101501015110152101531015410155101561015710158101591016010161101621016310164101651016610167101681016910170101711017210173101741017510176101771017810179101801018110182101831018410185101861018710188101891019010191101921019310194101951019610197101981019910200102011020210203102041020510206102071020810209102101021110212102131021410215102161021710218102191022010221102221022310224102251022610227102281022910230102311023210233102341023510236102371023810239102401024110242102431024410245102461024710248102491025010251102521025310254102551025610257102581025910260102611026210263102641026510266102671026810269102701027110272102731027410275102761027710278102791028010281102821028310284102851028610287102881028910290102911029210293102941029510296102971029810299103001030110302103031030410305103061030710308103091031010311103121031310314103151031610317103181031910320103211032210323103241032510326103271032810329103301033110332103331033410335103361033710338103391034010341103421034310344103451034610347103481034910350103511035210353103541035510356103571035810359103601036110362103631036410365103661036710368103691037010371103721037310374103751037610377103781037910380103811038210383103841038510386103871038810389103901039110392103931039410395103961039710398103991040010401104021040310404104051040610407104081040910410104111041210413104141041510416104171041810419104201042110422104231042410425104261042710428104291043010431104321043310434104351043610437104381043910440104411044210443104441044510446104471044810449104501045110452104531045410455104561045710458104591046010461104621046310464104651046610467104681046910470104711047210473104741047510476104771047810479104801048110482104831048410485104861048710488104891049010491104921049310494104951049610497104981049910500105011050210503105041050510506105071050810509105101051110512105131051410515105161051710518105191052010521105221052310524105251052610527105281052910530105311053210533105341053510536105371053810539105401054110542105431054410545105461054710548105491055010551105521055310554105551055610557105581055910560105611056210563105641056510566105671056810569105701057110572105731057410575105761057710578105791058010581105821058310584105851058610587105881058910590105911059210593105941059510596105971059810599106001060110602106031060410605106061060710608106091061010611106121061310614106151061610617106181061910620106211062210623106241062510626106271062810629106301063110632106331063410635106361063710638106391064010641106421064310644106451064610647106481064910650106511065210653106541065510656106571065810659106601066110662106631066410665106661066710668106691067010671106721067310674106751067610677106781067910680106811068210683106841068510686106871068810689106901069110692106931069410695106961069710698106991070010701107021070310704107051070610707107081070910710107111071210713107141071510716107171071810719107201072110722107231072410725107261072710728107291073010731107321073310734107351073610737107381073910740107411074210743107441074510746107471074810749107501075110752107531075410755107561075710758107591076010761107621076310764107651076610767107681076910770107711077210773107741077510776107771077810779107801078110782107831078410785107861078710788107891079010791107921079310794107951079610797107981079910800108011080210803108041080510806108071080810809108101081110812108131081410815108161081710818108191082010821108221082310824108251082610827108281082910830108311083210833108341083510836108371083810839108401084110842108431084410845108461084710848108491085010851108521085310854108551085610857108581085910860108611086210863108641086510866108671086810869108701087110872108731087410875108761087710878108791088010881108821088310884108851088610887108881088910890108911089210893108941089510896108971089810899109001090110902109031090410905109061090710908109091091010911109121091310914109151091610917109181091910920109211092210923109241092510926109271092810929109301093110932109331093410935109361093710938109391094010941109421094310944109451094610947109481094910950109511095210953109541095510956109571095810959109601096110962109631096410965109661096710968109691097010971109721097310974109751097610977109781097910980109811098210983109841098510986109871098810989109901099110992109931099410995109961099710998109991100011001110021100311004110051100611007110081100911010110111101211013110141101511016110171101811019110201102111022110231102411025110261102711028110291103011031110321103311034110351103611037110381103911040110411104211043110441104511046110471104811049110501105111052110531105411055110561105711058110591106011061110621106311064110651106611067110681106911070110711107211073110741107511076110771107811079110801108111082110831108411085110861108711088110891109011091110921109311094110951109611097110981109911100111011110211103111041110511106111071110811109111101111111112111131111411115111161111711118111191112011121111221112311124111251112611127111281112911130111311113211133111341113511136111371113811139111401114111142111431114411145111461114711148111491115011151111521115311154111551115611157111581115911160111611116211163111641116511166111671116811169111701117111172111731117411175111761117711178111791118011181111821118311184111851118611187111881118911190111911119211193111941119511196111971119811199112001120111202112031120411205112061120711208112091121011211112121121311214112151121611217112181121911220112211122211223112241122511226112271122811229112301123111232112331123411235112361123711238112391124011241112421124311244112451124611247112481124911250112511125211253112541125511256112571125811259112601126111262112631126411265112661126711268112691127011271112721127311274112751127611277112781127911280112811128211283112841128511286112871128811289112901129111292112931129411295112961129711298112991130011301113021130311304113051130611307113081130911310113111131211313113141131511316113171131811319113201132111322113231132411325113261132711328113291133011331113321133311334113351133611337113381133911340113411134211343113441134511346113471134811349113501135111352113531135411355113561135711358113591136011361113621136311364113651136611367113681136911370113711137211373113741137511376113771137811379113801138111382113831138411385113861138711388113891139011391113921139311394113951139611397113981139911400114011140211403114041140511406114071140811409114101141111412114131141411415114161141711418114191142011421114221142311424114251142611427114281142911430114311143211433114341143511436114371143811439114401144111442114431144411445114461144711448114491145011451114521145311454114551145611457114581145911460114611146211463114641146511466114671146811469114701147111472114731147411475114761147711478114791148011481114821148311484114851148611487114881148911490114911149211493114941149511496114971149811499115001150111502115031150411505115061150711508115091151011511115121151311514115151151611517115181151911520115211152211523115241152511526115271152811529115301153111532115331153411535115361153711538115391154011541115421154311544115451154611547115481154911550115511155211553115541155511556115571155811559115601156111562115631156411565115661156711568115691157011571115721157311574115751157611577115781157911580115811158211583115841158511586115871158811589115901159111592115931159411595115961159711598115991160011601116021160311604116051160611607116081160911610116111161211613116141161511616116171161811619116201162111622116231162411625116261162711628116291163011631116321163311634116351163611637116381163911640116411164211643116441164511646116471164811649116501165111652116531165411655116561165711658116591166011661116621166311664116651166611667116681166911670116711167211673116741167511676116771167811679116801168111682116831168411685116861168711688116891169011691116921169311694116951169611697116981169911700117011170211703117041170511706117071170811709117101171111712117131171411715117161171711718117191172011721117221172311724117251172611727117281172911730117311173211733117341173511736117371173811739117401174111742117431174411745117461174711748117491175011751117521175311754117551175611757117581175911760117611176211763117641176511766117671176811769117701177111772117731177411775117761177711778117791178011781117821178311784117851178611787117881178911790117911179211793117941179511796117971179811799118001180111802118031180411805118061180711808118091181011811118121181311814118151181611817118181181911820118211182211823118241182511826118271182811829118301183111832118331183411835118361183711838118391184011841118421184311844118451184611847118481184911850118511185211853118541185511856118571185811859118601186111862118631186411865118661186711868118691187011871118721187311874118751187611877118781187911880118811188211883118841188511886118871188811889118901189111892118931189411895118961189711898118991190011901119021190311904119051190611907119081190911910119111191211913119141191511916119171191811919119201192111922119231192411925119261192711928119291193011931119321193311934119351193611937119381193911940119411194211943119441194511946119471194811949119501195111952119531195411955119561195711958119591196011961119621196311964119651196611967119681196911970119711197211973119741197511976119771197811979119801198111982119831198411985119861198711988119891199011991119921199311994119951199611997119981199912000120011200212003120041200512006120071200812009120101201112012120131201412015120161201712018120191202012021120221202312024120251202612027120281202912030120311203212033120341203512036120371203812039120401204112042120431204412045120461204712048120491205012051120521205312054120551205612057120581205912060120611206212063120641206512066120671206812069120701207112072120731207412075120761207712078120791208012081120821208312084120851208612087120881208912090120911209212093120941209512096120971209812099121001210112102121031210412105121061210712108121091211012111121121211312114121151211612117121181211912120121211212212123121241212512126121271212812129121301213112132121331213412135121361213712138121391214012141121421214312144121451214612147121481214912150121511215212153121541215512156121571215812159121601216112162121631216412165121661216712168121691217012171121721217312174121751217612177121781217912180121811218212183121841218512186121871218812189121901219112192121931219412195121961219712198121991220012201122021220312204122051220612207122081220912210122111221212213122141221512216122171221812219122201222112222122231222412225122261222712228122291223012231122321223312234122351223612237122381223912240122411224212243122441224512246122471224812249122501225112252122531225412255122561225712258122591226012261122621226312264122651226612267122681226912270122711227212273122741227512276122771227812279122801228112282122831228412285122861228712288122891229012291122921229312294122951229612297122981229912300123011230212303123041230512306123071230812309123101231112312123131231412315123161231712318123191232012321123221232312324123251232612327123281232912330123311233212333123341233512336123371233812339123401234112342123431234412345123461234712348123491235012351123521235312354123551235612357123581235912360123611236212363123641236512366123671236812369123701237112372123731237412375123761237712378123791238012381123821238312384123851238612387123881238912390123911239212393123941239512396123971239812399124001240112402124031240412405124061240712408124091241012411124121241312414124151241612417124181241912420124211242212423124241242512426124271242812429124301243112432124331243412435124361243712438124391244012441124421244312444124451244612447124481244912450124511245212453124541245512456124571245812459124601246112462124631246412465124661246712468124691247012471124721247312474124751247612477124781247912480124811248212483124841248512486124871248812489124901249112492124931249412495124961249712498124991250012501125021250312504125051250612507125081250912510125111251212513125141251512516125171251812519125201252112522125231252412525125261252712528125291253012531125321253312534125351253612537125381253912540125411254212543125441254512546125471254812549125501255112552125531255412555125561255712558125591256012561125621256312564125651256612567125681256912570125711257212573125741257512576125771257812579125801258112582125831258412585125861258712588125891259012591125921259312594125951259612597125981259912600126011260212603126041260512606126071260812609126101261112612126131261412615126161261712618126191262012621126221262312624126251262612627126281262912630126311263212633126341263512636126371263812639126401264112642126431264412645126461264712648126491265012651126521265312654126551265612657126581265912660126611266212663126641266512666126671266812669126701267112672126731267412675126761267712678126791268012681126821268312684126851268612687126881268912690126911269212693126941269512696126971269812699127001270112702127031270412705127061270712708127091271012711127121271312714127151271612717127181271912720127211272212723127241272512726127271272812729127301273112732127331273412735127361273712738127391274012741127421274312744127451274612747127481274912750127511275212753127541275512756127571275812759127601276112762127631276412765127661276712768127691277012771127721277312774127751277612777127781277912780127811278212783127841278512786127871278812789127901279112792127931279412795127961279712798127991280012801128021280312804128051280612807128081280912810128111281212813128141281512816128171281812819128201282112822128231282412825128261282712828128291283012831128321283312834128351283612837128381283912840128411284212843128441284512846128471284812849128501285112852128531285412855128561285712858128591286012861128621286312864128651286612867128681286912870128711287212873128741287512876128771287812879128801288112882128831288412885128861288712888128891289012891128921289312894128951289612897128981289912900129011290212903129041290512906129071290812909129101291112912129131291412915129161291712918129191292012921129221292312924129251292612927129281292912930129311293212933129341293512936129371293812939129401294112942129431294412945129461294712948129491295012951129521295312954129551295612957129581295912960129611296212963129641296512966129671296812969129701297112972129731297412975129761297712978129791298012981129821298312984129851298612987129881298912990129911299212993129941299512996129971299812999130001300113002130031300413005130061300713008130091301013011130121301313014130151301613017130181301913020130211302213023130241302513026130271302813029130301303113032130331303413035130361303713038130391304013041130421304313044130451304613047130481304913050130511305213053130541305513056130571305813059130601306113062130631306413065130661306713068130691307013071130721307313074130751307613077130781307913080130811308213083130841308513086130871308813089130901309113092130931309413095130961309713098130991310013101131021310313104131051310613107131081310913110131111311213113131141311513116131171311813119131201312113122131231312413125131261312713128131291313013131131321313313134131351313613137131381313913140131411314213143131441314513146131471314813149131501315113152131531315413155131561315713158131591316013161131621316313164131651316613167131681316913170131711317213173131741317513176131771317813179131801318113182131831318413185131861318713188131891319013191131921319313194131951319613197131981319913200132011320213203132041320513206132071320813209132101321113212132131321413215132161321713218132191322013221132221322313224132251322613227132281322913230132311323213233132341323513236132371323813239132401324113242132431324413245132461324713248132491325013251132521325313254132551325613257132581325913260132611326213263132641326513266132671326813269132701327113272132731327413275132761327713278132791328013281132821328313284132851328613287132881328913290132911329213293132941329513296132971329813299133001330113302133031330413305133061330713308133091331013311133121331313314133151331613317133181331913320133211332213323133241332513326133271332813329133301333113332133331333413335133361333713338133391334013341133421334313344133451334613347133481334913350133511335213353133541335513356133571335813359133601336113362133631336413365133661336713368133691337013371133721337313374133751337613377133781337913380133811338213383133841338513386133871338813389133901339113392133931339413395133961339713398133991340013401134021340313404134051340613407134081340913410134111341213413134141341513416134171341813419134201342113422134231342413425134261342713428134291343013431134321343313434134351343613437134381343913440134411344213443134441344513446134471344813449134501345113452134531345413455134561345713458134591346013461134621346313464134651346613467134681346913470134711347213473134741347513476134771347813479134801348113482134831348413485134861348713488134891349013491134921349313494134951349613497134981349913500135011350213503135041350513506135071350813509135101351113512135131351413515135161351713518135191352013521135221352313524135251352613527135281352913530135311353213533135341353513536135371353813539135401354113542135431354413545135461354713548135491355013551135521355313554135551355613557135581355913560135611356213563135641356513566135671356813569135701357113572135731357413575135761357713578135791358013581135821358313584135851358613587135881358913590135911359213593135941359513596135971359813599136001360113602136031360413605136061360713608136091361013611136121361313614136151361613617136181361913620136211362213623136241362513626136271362813629136301363113632136331363413635136361363713638136391364013641136421364313644136451364613647136481364913650136511365213653136541365513656136571365813659136601366113662136631366413665136661366713668136691367013671136721367313674136751367613677136781367913680136811368213683136841368513686136871368813689136901369113692136931369413695136961369713698136991370013701137021370313704137051370613707137081370913710137111371213713137141371513716137171371813719137201372113722137231372413725137261372713728137291373013731137321373313734137351373613737137381373913740137411374213743137441374513746137471374813749137501375113752137531375413755137561375713758137591376013761137621376313764137651376613767137681376913770137711377213773137741377513776137771377813779137801378113782137831378413785137861378713788137891379013791137921379313794137951379613797137981379913800138011380213803138041380513806138071380813809138101381113812138131381413815138161381713818138191382013821138221382313824138251382613827138281382913830138311383213833138341383513836138371383813839138401384113842138431384413845138461384713848138491385013851138521385313854138551385613857138581385913860138611386213863138641386513866138671386813869138701387113872138731387413875138761387713878138791388013881138821388313884138851388613887138881388913890138911389213893138941389513896138971389813899139001390113902139031390413905139061390713908139091391013911139121391313914139151391613917139181391913920139211392213923139241392513926139271392813929139301393113932139331393413935139361393713938139391394013941139421394313944139451394613947139481394913950139511395213953139541395513956139571395813959139601396113962139631396413965139661396713968139691397013971139721397313974139751397613977139781397913980139811398213983139841398513986139871398813989139901399113992139931399413995139961399713998139991400014001140021400314004140051400614007140081400914010140111401214013140141401514016140171401814019140201402114022140231402414025140261402714028140291403014031140321403314034140351403614037140381403914040140411404214043140441404514046140471404814049140501405114052140531405414055140561405714058140591406014061140621406314064140651406614067140681406914070140711407214073140741407514076140771407814079140801408114082140831408414085140861408714088140891409014091140921409314094140951409614097140981409914100141011410214103141041410514106141071410814109141101411114112141131411414115141161411714118141191412014121141221412314124141251412614127141281412914130141311413214133141341413514136141371413814139141401414114142141431414414145141461414714148141491415014151141521415314154141551415614157141581415914160141611416214163141641416514166141671416814169141701417114172141731417414175141761417714178141791418014181141821418314184141851418614187141881418914190141911419214193141941419514196141971419814199142001420114202142031420414205142061420714208142091421014211142121421314214142151421614217142181421914220142211422214223142241422514226142271422814229142301423114232142331423414235142361423714238142391424014241142421424314244142451424614247142481424914250142511425214253142541425514256142571425814259142601426114262142631426414265142661426714268142691427014271142721427314274142751427614277142781427914280142811428214283142841428514286142871428814289142901429114292142931429414295142961429714298142991430014301143021430314304143051430614307143081430914310143111431214313143141431514316143171431814319143201432114322143231432414325143261432714328143291433014331143321433314334143351433614337143381433914340143411434214343143441434514346143471434814349143501435114352143531435414355143561435714358143591436014361143621436314364143651436614367143681436914370143711437214373143741437514376143771437814379143801438114382143831438414385143861438714388143891439014391143921439314394143951439614397143981439914400144011440214403144041440514406144071440814409144101441114412144131441414415144161441714418144191442014421144221442314424144251442614427144281442914430144311443214433144341443514436144371443814439144401444114442144431444414445144461444714448144491445014451144521445314454144551445614457144581445914460144611446214463144641446514466144671446814469144701447114472144731447414475144761447714478144791448014481144821448314484144851448614487144881448914490144911449214493144941449514496144971449814499145001450114502145031450414505145061450714508145091451014511145121451314514145151451614517145181451914520145211452214523145241452514526145271452814529145301453114532145331453414535145361453714538145391454014541145421454314544145451454614547145481454914550145511455214553145541455514556145571455814559145601456114562145631456414565145661456714568145691457014571145721457314574145751457614577145781457914580145811458214583145841458514586145871458814589145901459114592145931459414595145961459714598145991460014601146021460314604146051460614607146081460914610146111461214613146141461514616146171461814619146201462114622146231462414625146261462714628146291463014631146321463314634146351463614637146381463914640146411464214643146441464514646146471464814649146501465114652146531465414655146561465714658146591466014661146621466314664146651466614667146681466914670146711467214673146741467514676146771467814679146801468114682146831468414685146861468714688146891469014691146921469314694146951469614697146981469914700147011470214703147041470514706147071470814709147101471114712147131471414715147161471714718147191472014721147221472314724147251472614727147281472914730147311473214733147341473514736147371473814739147401474114742147431474414745147461474714748147491475014751147521475314754147551475614757147581475914760147611476214763147641476514766147671476814769147701477114772147731477414775147761477714778147791478014781147821478314784147851478614787147881478914790147911479214793147941479514796147971479814799148001480114802148031480414805148061480714808148091481014811148121481314814148151481614817148181481914820148211482214823148241482514826148271482814829148301483114832148331483414835148361483714838148391484014841148421484314844148451484614847148481484914850148511485214853148541485514856148571485814859148601486114862148631486414865148661486714868148691487014871148721487314874148751487614877148781487914880148811488214883148841488514886148871488814889148901489114892148931489414895148961489714898148991490014901149021490314904149051490614907149081490914910149111491214913149141491514916149171491814919149201492114922149231492414925149261492714928149291493014931149321493314934149351493614937149381493914940149411494214943149441494514946149471494814949149501495114952149531495414955149561495714958149591496014961149621496314964149651496614967149681496914970149711497214973149741497514976149771497814979149801498114982149831498414985149861498714988149891499014991149921499314994149951499614997149981499915000150011500215003150041500515006150071500815009150101501115012150131501415015150161501715018150191502015021150221502315024150251502615027150281502915030150311503215033150341503515036150371503815039150401504115042150431504415045150461504715048150491505015051150521505315054150551505615057150581505915060150611506215063150641506515066150671506815069150701507115072150731507415075150761507715078150791508015081150821508315084150851508615087150881508915090150911509215093150941509515096150971509815099151001510115102151031510415105151061510715108151091511015111151121511315114151151511615117151181511915120151211512215123151241512515126151271512815129151301513115132151331513415135151361513715138151391514015141151421514315144151451514615147151481514915150151511515215153151541515515156151571515815159151601516115162151631516415165151661516715168151691517015171151721517315174151751517615177151781517915180151811518215183151841518515186151871518815189151901519115192151931519415195151961519715198151991520015201152021520315204152051520615207152081520915210152111521215213152141521515216152171521815219152201522115222152231522415225152261522715228152291523015231152321523315234152351523615237152381523915240152411524215243152441524515246152471524815249152501525115252152531525415255152561525715258152591526015261152621526315264152651526615267152681526915270152711527215273152741527515276152771527815279152801528115282152831528415285152861528715288152891529015291152921529315294152951529615297152981529915300153011530215303153041530515306153071530815309153101531115312153131531415315153161531715318153191532015321153221532315324153251532615327153281532915330153311533215333153341533515336153371533815339153401534115342153431534415345153461534715348153491535015351153521535315354153551535615357153581535915360153611536215363153641536515366153671536815369153701537115372153731537415375153761537715378153791538015381153821538315384153851538615387153881538915390153911539215393153941539515396153971539815399154001540115402154031540415405154061540715408154091541015411154121541315414154151541615417154181541915420154211542215423154241542515426154271542815429154301543115432154331543415435154361543715438154391544015441154421544315444154451544615447154481544915450154511545215453154541545515456154571545815459154601546115462154631546415465154661546715468154691547015471154721547315474154751547615477154781547915480154811548215483154841548515486154871548815489154901549115492154931549415495154961549715498154991550015501155021550315504155051550615507155081550915510155111551215513155141551515516155171551815519155201552115522155231552415525155261552715528155291553015531155321553315534155351553615537155381553915540155411554215543155441554515546155471554815549155501555115552155531555415555155561555715558155591556015561155621556315564155651556615567155681556915570155711557215573155741557515576155771557815579155801558115582155831558415585155861558715588155891559015591155921559315594155951559615597155981559915600156011560215603156041560515606156071560815609156101561115612156131561415615156161561715618156191562015621156221562315624156251562615627156281562915630156311563215633156341563515636156371563815639156401564115642156431564415645156461564715648156491565015651156521565315654156551565615657156581565915660156611566215663156641566515666156671566815669156701567115672156731567415675156761567715678156791568015681156821568315684156851568615687156881568915690156911569215693156941569515696156971569815699157001570115702157031570415705157061570715708157091571015711157121571315714157151571615717157181571915720157211572215723157241572515726157271572815729157301573115732157331573415735157361573715738157391574015741157421574315744157451574615747157481574915750157511575215753157541575515756157571575815759157601576115762157631576415765157661576715768157691577015771157721577315774157751577615777157781577915780157811578215783157841578515786157871578815789157901579115792157931579415795157961579715798157991580015801158021580315804158051580615807158081580915810158111581215813158141581515816158171581815819158201582115822158231582415825158261582715828158291583015831158321583315834158351583615837158381583915840158411584215843158441584515846158471584815849158501585115852158531585415855158561585715858158591586015861158621586315864158651586615867158681586915870158711587215873158741587515876158771587815879158801588115882158831588415885158861588715888158891589015891158921589315894158951589615897158981589915900159011590215903159041590515906159071590815909159101591115912159131591415915159161591715918159191592015921159221592315924159251592615927159281592915930159311593215933159341593515936159371593815939159401594115942159431594415945159461594715948159491595015951159521595315954159551595615957159581595915960159611596215963159641596515966159671596815969159701597115972159731597415975159761597715978159791598015981159821598315984159851598615987159881598915990159911599215993159941599515996159971599815999160001600116002160031600416005160061600716008160091601016011160121601316014160151601616017160181601916020160211602216023160241602516026160271602816029160301603116032160331603416035160361603716038160391604016041160421604316044160451604616047160481604916050160511605216053160541605516056160571605816059160601606116062160631606416065160661606716068160691607016071160721607316074160751607616077160781607916080160811608216083160841608516086160871608816089160901609116092160931609416095160961609716098160991610016101161021610316104161051610616107161081610916110161111611216113161141611516116161171611816119161201612116122161231612416125161261612716128161291613016131161321613316134161351613616137161381613916140161411614216143161441614516146161471614816149161501615116152161531615416155161561615716158161591616016161161621616316164161651616616167161681616916170161711617216173161741617516176161771617816179161801618116182161831618416185161861618716188161891619016191161921619316194161951619616197161981619916200162011620216203162041620516206162071620816209162101621116212162131621416215162161621716218162191622016221162221622316224162251622616227162281622916230162311623216233162341623516236162371623816239162401624116242162431624416245162461624716248162491625016251162521625316254162551625616257162581625916260162611626216263162641626516266162671626816269162701627116272162731627416275162761627716278162791628016281162821628316284162851628616287162881628916290162911629216293162941629516296162971629816299163001630116302163031630416305163061630716308163091631016311163121631316314163151631616317163181631916320163211632216323163241632516326163271632816329163301633116332163331633416335163361633716338163391634016341163421634316344163451634616347163481634916350163511635216353163541635516356163571635816359163601636116362163631636416365163661636716368163691637016371163721637316374163751637616377163781637916380163811638216383163841638516386163871638816389163901639116392163931639416395163961639716398163991640016401164021640316404164051640616407164081640916410164111641216413164141641516416164171641816419164201642116422164231642416425164261642716428164291643016431164321643316434164351643616437164381643916440164411644216443164441644516446164471644816449164501645116452164531645416455164561645716458164591646016461164621646316464164651646616467164681646916470164711647216473164741647516476164771647816479164801648116482164831648416485164861648716488164891649016491164921649316494164951649616497164981649916500165011650216503165041650516506165071650816509165101651116512165131651416515165161651716518165191652016521165221652316524165251652616527165281652916530165311653216533165341653516536165371653816539165401654116542165431654416545165461654716548165491655016551165521655316554165551655616557165581655916560165611656216563165641656516566165671656816569165701657116572165731657416575165761657716578165791658016581165821658316584165851658616587165881658916590165911659216593165941659516596165971659816599166001660116602166031660416605166061660716608166091661016611166121661316614166151661616617166181661916620166211662216623166241662516626166271662816629166301663116632166331663416635166361663716638166391664016641166421664316644166451664616647166481664916650166511665216653166541665516656166571665816659166601666116662166631666416665166661666716668166691667016671166721667316674166751667616677166781667916680166811668216683166841668516686166871668816689166901669116692166931669416695166961669716698166991670016701167021670316704167051670616707167081670916710167111671216713167141671516716167171671816719167201672116722167231672416725167261672716728167291673016731167321673316734167351673616737167381673916740167411674216743167441674516746167471674816749167501675116752167531675416755167561675716758167591676016761167621676316764167651676616767167681676916770167711677216773167741677516776167771677816779167801678116782167831678416785167861678716788167891679016791167921679316794167951679616797167981679916800168011680216803168041680516806168071680816809168101681116812168131681416815168161681716818168191682016821168221682316824168251682616827168281682916830168311683216833168341683516836168371683816839168401684116842168431684416845168461684716848168491685016851168521685316854168551685616857168581685916860168611686216863168641686516866168671686816869168701687116872168731687416875168761687716878168791688016881168821688316884168851688616887168881688916890168911689216893168941689516896168971689816899169001690116902169031690416905169061690716908169091691016911169121691316914169151691616917169181691916920169211692216923169241692516926169271692816929169301693116932169331693416935169361693716938169391694016941169421694316944169451694616947169481694916950169511695216953169541695516956169571695816959169601696116962169631696416965169661696716968169691697016971169721697316974169751697616977169781697916980169811698216983169841698516986169871698816989169901699116992169931699416995169961699716998169991700017001170021700317004170051700617007170081700917010170111701217013170141701517016170171701817019170201702117022170231702417025170261702717028170291703017031170321703317034170351703617037170381703917040170411704217043170441704517046170471704817049170501705117052170531705417055170561705717058170591706017061170621706317064170651706617067170681706917070170711707217073170741707517076170771707817079170801708117082170831708417085170861708717088170891709017091170921709317094170951709617097170981709917100171011710217103171041710517106171071710817109171101711117112171131711417115171161711717118171191712017121171221712317124171251712617127171281712917130171311713217133171341713517136171371713817139171401714117142171431714417145171461714717148171491715017151171521715317154171551715617157171581715917160171611716217163171641716517166171671716817169171701717117172171731717417175171761717717178171791718017181171821718317184171851718617187171881718917190171911719217193171941719517196171971719817199172001720117202172031720417205172061720717208172091721017211172121721317214172151721617217172181721917220172211722217223172241722517226172271722817229172301723117232172331723417235172361723717238172391724017241172421724317244172451724617247172481724917250172511725217253172541725517256172571725817259172601726117262172631726417265172661726717268172691727017271172721727317274172751727617277172781727917280172811728217283172841728517286172871728817289172901729117292172931729417295172961729717298172991730017301173021730317304173051730617307173081730917310173111731217313173141731517316173171731817319173201732117322173231732417325173261732717328173291733017331173321733317334173351733617337173381733917340173411734217343173441734517346173471734817349173501735117352173531735417355173561735717358173591736017361173621736317364173651736617367173681736917370173711737217373173741737517376173771737817379173801738117382173831738417385173861738717388173891739017391173921739317394173951739617397173981739917400174011740217403174041740517406174071740817409174101741117412174131741417415174161741717418174191742017421174221742317424174251742617427174281742917430174311743217433174341743517436174371743817439174401744117442174431744417445174461744717448174491745017451174521745317454174551745617457174581745917460174611746217463174641746517466174671746817469174701747117472174731747417475174761747717478174791748017481174821748317484174851748617487174881748917490174911749217493174941749517496174971749817499175001750117502175031750417505175061750717508175091751017511175121751317514175151751617517175181751917520175211752217523175241752517526175271752817529175301753117532175331753417535175361753717538175391754017541175421754317544175451754617547175481754917550175511755217553175541755517556175571755817559175601756117562175631756417565175661756717568175691757017571175721757317574175751757617577175781757917580175811758217583175841758517586175871758817589175901759117592175931759417595175961759717598175991760017601176021760317604176051760617607176081760917610176111761217613176141761517616176171761817619176201762117622176231762417625176261762717628176291763017631176321763317634176351763617637176381763917640176411764217643176441764517646176471764817649176501765117652176531765417655176561765717658176591766017661176621766317664176651766617667176681766917670176711767217673176741767517676176771767817679176801768117682176831768417685176861768717688176891769017691176921769317694176951769617697176981769917700177011770217703177041770517706177071770817709177101771117712177131771417715177161771717718177191772017721177221772317724177251772617727177281772917730177311773217733177341773517736177371773817739177401774117742177431774417745177461774717748177491775017751177521775317754177551775617757177581775917760177611776217763177641776517766177671776817769177701777117772177731777417775177761777717778177791778017781177821778317784177851778617787177881778917790177911779217793177941779517796177971779817799178001780117802178031780417805178061780717808178091781017811178121781317814178151781617817178181781917820178211782217823178241782517826178271782817829178301783117832178331783417835178361783717838178391784017841178421784317844178451784617847178481784917850178511785217853178541785517856178571785817859178601786117862178631786417865178661786717868178691787017871178721787317874178751787617877178781787917880178811788217883178841788517886178871788817889178901789117892178931789417895178961789717898178991790017901179021790317904179051790617907179081790917910179111791217913179141791517916179171791817919179201792117922179231792417925179261792717928179291793017931179321793317934179351793617937179381793917940179411794217943179441794517946179471794817949179501795117952179531795417955179561795717958179591796017961179621796317964179651796617967179681796917970179711797217973179741797517976179771797817979179801798117982179831798417985179861798717988179891799017991179921799317994179951799617997179981799918000180011800218003180041800518006180071800818009180101801118012180131801418015180161801718018180191802018021180221802318024180251802618027180281802918030180311803218033180341803518036180371803818039180401804118042180431804418045180461804718048180491805018051180521805318054180551805618057180581805918060180611806218063180641806518066180671806818069180701807118072180731807418075180761807718078180791808018081180821808318084180851808618087180881808918090180911809218093180941809518096180971809818099181001810118102181031810418105181061810718108181091811018111181121811318114181151811618117181181811918120181211812218123181241812518126181271812818129181301813118132181331813418135181361813718138181391814018141181421814318144181451814618147181481814918150181511815218153181541815518156181571815818159181601816118162181631816418165181661816718168181691817018171181721817318174181751817618177181781817918180181811818218183181841818518186181871818818189181901819118192181931819418195181961819718198181991820018201182021820318204182051820618207182081820918210182111821218213182141821518216182171821818219182201822118222182231822418225182261822718228182291823018231182321823318234182351823618237182381823918240182411824218243182441824518246182471824818249182501825118252182531825418255182561825718258182591826018261182621826318264182651826618267182681826918270182711827218273182741827518276182771827818279182801828118282182831828418285182861828718288182891829018291182921829318294182951829618297182981829918300183011830218303183041830518306183071830818309183101831118312183131831418315183161831718318183191832018321183221832318324183251832618327183281832918330183311833218333183341833518336183371833818339183401834118342183431834418345183461834718348183491835018351183521835318354183551835618357183581835918360183611836218363183641836518366183671836818369183701837118372183731837418375183761837718378183791838018381183821838318384183851838618387183881838918390183911839218393183941839518396183971839818399184001840118402184031840418405184061840718408184091841018411184121841318414184151841618417184181841918420184211842218423184241842518426184271842818429184301843118432184331843418435184361843718438184391844018441184421844318444184451844618447184481844918450184511845218453184541845518456184571845818459184601846118462184631846418465184661846718468184691847018471184721847318474184751847618477184781847918480184811848218483184841848518486184871848818489184901849118492184931849418495184961849718498184991850018501185021850318504185051850618507185081850918510185111851218513185141851518516185171851818519185201852118522185231852418525185261852718528185291853018531185321853318534185351853618537185381853918540185411854218543185441854518546185471854818549185501855118552185531855418555185561855718558185591856018561185621856318564185651856618567185681856918570185711857218573185741857518576185771857818579185801858118582185831858418585185861858718588185891859018591185921859318594185951859618597185981859918600186011860218603186041860518606186071860818609186101861118612186131861418615186161861718618186191862018621186221862318624186251862618627186281862918630186311863218633186341863518636186371863818639186401864118642186431864418645186461864718648186491865018651186521865318654186551865618657186581865918660186611866218663186641866518666186671866818669186701867118672186731867418675186761867718678186791868018681186821868318684186851868618687186881868918690186911869218693186941869518696186971869818699187001870118702187031870418705187061870718708187091871018711187121871318714187151871618717187181871918720187211872218723187241872518726187271872818729187301873118732187331873418735187361873718738187391874018741187421874318744187451874618747187481874918750187511875218753187541875518756187571875818759187601876118762187631876418765187661876718768187691877018771187721877318774187751877618777187781877918780187811878218783187841878518786187871878818789187901879118792187931879418795187961879718798187991880018801188021880318804188051880618807188081880918810188111881218813188141881518816188171881818819188201882118822188231882418825188261882718828188291883018831188321883318834188351883618837188381883918840188411884218843188441884518846188471884818849188501885118852188531885418855188561885718858188591886018861188621886318864188651886618867188681886918870188711887218873188741887518876188771887818879188801888118882188831888418885188861888718888188891889018891188921889318894188951889618897188981889918900189011890218903189041890518906189071890818909189101891118912189131891418915189161891718918189191892018921189221892318924189251892618927189281892918930189311893218933189341893518936189371893818939189401894118942189431894418945189461894718948189491895018951189521895318954189551895618957189581895918960189611896218963189641896518966189671896818969189701897118972189731897418975189761897718978189791898018981189821898318984189851898618987189881898918990189911899218993189941899518996189971899818999190001900119002190031900419005190061900719008190091901019011190121901319014190151901619017190181901919020190211902219023190241902519026190271902819029190301903119032190331903419035190361903719038190391904019041190421904319044190451904619047190481904919050190511905219053190541905519056190571905819059190601906119062190631906419065190661906719068190691907019071190721907319074190751907619077190781907919080190811908219083190841908519086190871908819089190901909119092190931909419095190961909719098190991910019101191021910319104191051910619107191081910919110191111911219113191141911519116191171911819119191201912119122191231912419125191261912719128191291913019131191321913319134191351913619137191381913919140191411914219143191441914519146191471914819149191501915119152191531915419155191561915719158191591916019161191621916319164191651916619167191681916919170191711917219173191741917519176191771917819179191801918119182191831918419185191861918719188191891919019191191921919319194191951919619197191981919919200192011920219203192041920519206192071920819209192101921119212192131921419215192161921719218192191922019221192221922319224192251922619227192281922919230192311923219233192341923519236192371923819239192401924119242192431924419245192461924719248192491925019251192521925319254192551925619257192581925919260192611926219263192641926519266192671926819269192701927119272192731927419275192761927719278192791928019281192821928319284192851928619287192881928919290192911929219293192941929519296192971929819299193001930119302193031930419305193061930719308193091931019311193121931319314193151931619317193181931919320193211932219323193241932519326193271932819329193301933119332193331933419335193361933719338193391934019341193421934319344193451934619347193481934919350193511935219353193541935519356193571935819359193601936119362193631936419365193661936719368193691937019371193721937319374193751937619377193781937919380193811938219383193841938519386193871938819389193901939119392193931939419395193961939719398193991940019401194021940319404194051940619407194081940919410194111941219413194141941519416194171941819419194201942119422194231942419425194261942719428194291943019431194321943319434194351943619437194381943919440194411944219443194441944519446194471944819449194501945119452194531945419455194561945719458194591946019461194621946319464194651946619467194681946919470194711947219473194741947519476194771947819479194801948119482194831948419485194861948719488194891949019491194921949319494194951949619497194981949919500195011950219503195041950519506195071950819509195101951119512195131951419515195161951719518195191952019521195221952319524195251952619527195281952919530195311953219533195341953519536195371953819539195401954119542195431954419545195461954719548195491955019551195521955319554195551955619557195581955919560195611956219563195641956519566195671956819569195701957119572195731957419575195761957719578195791958019581195821958319584195851958619587195881958919590195911959219593195941959519596195971959819599196001960119602196031960419605196061960719608196091961019611196121961319614196151961619617196181961919620196211962219623196241962519626196271962819629196301963119632196331963419635196361963719638196391964019641196421964319644196451964619647196481964919650196511965219653196541965519656196571965819659196601966119662196631966419665196661966719668196691967019671196721967319674196751967619677196781967919680196811968219683196841968519686196871968819689196901969119692196931969419695196961969719698196991970019701197021970319704197051970619707197081970919710197111971219713197141971519716197171971819719197201972119722197231972419725197261972719728197291973019731197321973319734197351973619737197381973919740197411974219743197441974519746197471974819749197501975119752197531975419755197561975719758197591976019761197621976319764197651976619767197681976919770197711977219773197741977519776197771977819779197801978119782197831978419785197861978719788197891979019791197921979319794197951979619797197981979919800198011980219803198041980519806198071980819809198101981119812198131981419815198161981719818198191982019821198221982319824198251982619827198281982919830198311983219833198341983519836198371983819839198401984119842198431984419845198461984719848198491985019851198521985319854198551985619857198581985919860198611986219863198641986519866198671986819869198701987119872198731987419875198761987719878198791988019881198821988319884198851988619887198881988919890198911989219893198941989519896198971989819899199001990119902199031990419905199061990719908199091991019911199121991319914199151991619917199181991919920199211992219923199241992519926199271992819929199301993119932199331993419935199361993719938199391994019941199421994319944199451994619947199481994919950199511995219953199541995519956199571995819959199601996119962199631996419965199661996719968199691997019971199721997319974199751997619977199781997919980199811998219983199841998519986199871998819989199901999119992199931999419995199961999719998199992000020001200022000320004200052000620007200082000920010200112001220013200142001520016200172001820019200202002120022200232002420025200262002720028200292003020031200322003320034200352003620037200382003920040200412004220043200442004520046200472004820049200502005120052200532005420055200562005720058200592006020061200622006320064200652006620067200682006920070200712007220073200742007520076200772007820079200802008120082200832008420085200862008720088200892009020091200922009320094200952009620097200982009920100201012010220103201042010520106201072010820109201102011120112201132011420115201162011720118201192012020121201222012320124201252012620127201282012920130201312013220133201342013520136201372013820139201402014120142201432014420145201462014720148201492015020151201522015320154201552015620157201582015920160201612016220163201642016520166201672016820169201702017120172201732017420175201762017720178201792018020181201822018320184201852018620187201882018920190201912019220193201942019520196201972019820199202002020120202202032020420205202062020720208202092021020211202122021320214202152021620217202182021920220202212022220223202242022520226202272022820229202302023120232202332023420235202362023720238202392024020241202422024320244202452024620247202482024920250202512025220253202542025520256202572025820259202602026120262202632026420265202662026720268202692027020271202722027320274202752027620277202782027920280202812028220283202842028520286202872028820289202902029120292202932029420295202962029720298202992030020301203022030320304203052030620307203082030920310203112031220313203142031520316203172031820319203202032120322203232032420325203262032720328203292033020331203322033320334203352033620337203382033920340203412034220343
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class QuickSight extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: QuickSight.Types.ClientConfiguration)
  13. config: Config & QuickSight.Types.ClientConfiguration;
  14. /**
  15. * Cancels an ongoing ingestion of data into SPICE.
  16. */
  17. cancelIngestion(params: QuickSight.Types.CancelIngestionRequest, callback?: (err: AWSError, data: QuickSight.Types.CancelIngestionResponse) => void): Request<QuickSight.Types.CancelIngestionResponse, AWSError>;
  18. /**
  19. * Cancels an ongoing ingestion of data into SPICE.
  20. */
  21. cancelIngestion(callback?: (err: AWSError, data: QuickSight.Types.CancelIngestionResponse) => void): Request<QuickSight.Types.CancelIngestionResponse, AWSError>;
  22. /**
  23. * Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
  24. */
  25. createAccountCustomization(params: QuickSight.Types.CreateAccountCustomizationRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateAccountCustomizationResponse) => void): Request<QuickSight.Types.CreateAccountCustomizationResponse, AWSError>;
  26. /**
  27. * Creates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, you can add a custom default theme by using the CreateAccountCustomization or UpdateAccountCustomization API operation. To further customize Amazon QuickSight by removing Amazon QuickSight sample assets and videos for all new users, see Customizing Amazon QuickSight in the Amazon QuickSight User Guide. You can create customizations for your Amazon Web Services account or, if you specify a namespace, for a QuickSight namespace instead. Customizations that apply to a namespace always override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation. Before you use the CreateAccountCustomization API operation to add a theme as the namespace default, make sure that you first share the theme with the namespace. If you don't share it with the namespace, the theme isn't visible to your users even if you make it the default theme. To check if the theme is shared, view the current permissions by using the DescribeThemePermissions API operation. To share the theme, grant permissions by using the UpdateThemePermissions API operation.
  28. */
  29. createAccountCustomization(callback?: (err: AWSError, data: QuickSight.Types.CreateAccountCustomizationResponse) => void): Request<QuickSight.Types.CreateAccountCustomizationResponse, AWSError>;
  30. /**
  31. * Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide. If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails. You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide. You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.
  32. */
  33. createAccountSubscription(params: QuickSight.Types.CreateAccountSubscriptionRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateAccountSubscriptionResponse) => void): Request<QuickSight.Types.CreateAccountSubscriptionResponse, AWSError>;
  34. /**
  35. * Creates an Amazon QuickSight account, or subscribes to Amazon QuickSight Q. The Amazon Web Services Region for the account is derived from what is configured in the CLI or SDK. Before you use this operation, make sure that you can connect to an existing Amazon Web Services account. If you don't have an Amazon Web Services account, see Sign up for Amazon Web Services in the Amazon QuickSight User Guide. The person who signs up for Amazon QuickSight needs to have the correct Identity and Access Management (IAM) permissions. For more information, see IAM Policy Examples for Amazon QuickSight in the Amazon QuickSight User Guide. If your IAM policy includes both the Subscribe and CreateAccountSubscription actions, make sure that both actions are set to Allow. If either action is set to Deny, the Deny action prevails and your API call fails. You can't pass an existing IAM role to access other Amazon Web Services services using this API operation. To pass your existing IAM role to Amazon QuickSight, see Passing IAM roles to Amazon QuickSight in the Amazon QuickSight User Guide. You can't set default resource access on the new account from the Amazon QuickSight API. Instead, add default resource access from the Amazon QuickSight console. For more information about setting default resource access to Amazon Web Services services, see Setting default resource access to Amazon Web Services services in the Amazon QuickSight User Guide.
  36. */
  37. createAccountSubscription(callback?: (err: AWSError, data: QuickSight.Types.CreateAccountSubscriptionResponse) => void): Request<QuickSight.Types.CreateAccountSubscriptionResponse, AWSError>;
  38. /**
  39. * Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.
  40. */
  41. createAnalysis(params: QuickSight.Types.CreateAnalysisRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateAnalysisResponse) => void): Request<QuickSight.Types.CreateAnalysisResponse, AWSError>;
  42. /**
  43. * Creates an analysis in Amazon QuickSight. Analyses can be created either from a template or from an AnalysisDefinition.
  44. */
  45. createAnalysis(callback?: (err: AWSError, data: QuickSight.Types.CreateAnalysisResponse) => void): Request<QuickSight.Types.CreateAnalysisResponse, AWSError>;
  46. /**
  47. * Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
  48. */
  49. createDashboard(params: QuickSight.Types.CreateDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateDashboardResponse) => void): Request<QuickSight.Types.CreateDashboardResponse, AWSError>;
  50. /**
  51. * Creates a dashboard from either a template or directly with a DashboardDefinition. To first create a template, see the CreateTemplate API operation. A dashboard is an entity in Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon QuickSight dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.
  52. */
  53. createDashboard(callback?: (err: AWSError, data: QuickSight.Types.CreateDashboardResponse) => void): Request<QuickSight.Types.CreateDashboardResponse, AWSError>;
  54. /**
  55. * Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
  56. */
  57. createDataSet(params: QuickSight.Types.CreateDataSetRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateDataSetResponse) => void): Request<QuickSight.Types.CreateDataSetResponse, AWSError>;
  58. /**
  59. * Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.
  60. */
  61. createDataSet(callback?: (err: AWSError, data: QuickSight.Types.CreateDataSetResponse) => void): Request<QuickSight.Types.CreateDataSetResponse, AWSError>;
  62. /**
  63. * Creates a data source.
  64. */
  65. createDataSource(params: QuickSight.Types.CreateDataSourceRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateDataSourceResponse) => void): Request<QuickSight.Types.CreateDataSourceResponse, AWSError>;
  66. /**
  67. * Creates a data source.
  68. */
  69. createDataSource(callback?: (err: AWSError, data: QuickSight.Types.CreateDataSourceResponse) => void): Request<QuickSight.Types.CreateDataSourceResponse, AWSError>;
  70. /**
  71. * Creates an empty shared folder.
  72. */
  73. createFolder(params: QuickSight.Types.CreateFolderRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateFolderResponse) => void): Request<QuickSight.Types.CreateFolderResponse, AWSError>;
  74. /**
  75. * Creates an empty shared folder.
  76. */
  77. createFolder(callback?: (err: AWSError, data: QuickSight.Types.CreateFolderResponse) => void): Request<QuickSight.Types.CreateFolderResponse, AWSError>;
  78. /**
  79. * Adds an asset, such as a dashboard, analysis, or dataset into a folder.
  80. */
  81. createFolderMembership(params: QuickSight.Types.CreateFolderMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateFolderMembershipResponse) => void): Request<QuickSight.Types.CreateFolderMembershipResponse, AWSError>;
  82. /**
  83. * Adds an asset, such as a dashboard, analysis, or dataset into a folder.
  84. */
  85. createFolderMembership(callback?: (err: AWSError, data: QuickSight.Types.CreateFolderMembershipResponse) => void): Request<QuickSight.Types.CreateFolderMembershipResponse, AWSError>;
  86. /**
  87. * Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support. The permissions resource is arn:aws:quicksight:&lt;your-region&gt;:&lt;relevant-aws-account-id&gt;:group/default/&lt;group-name&gt; . The response is a group object.
  88. */
  89. createGroup(params: QuickSight.Types.CreateGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateGroupResponse) => void): Request<QuickSight.Types.CreateGroupResponse, AWSError>;
  90. /**
  91. * Use the CreateGroup operation to create a group in Amazon QuickSight. You can create up to 10,000 groups in a namespace. If you want to create more than 10,000 groups in a namespace, contact Amazon Web Services Support. The permissions resource is arn:aws:quicksight:&lt;your-region&gt;:&lt;relevant-aws-account-id&gt;:group/default/&lt;group-name&gt; . The response is a group object.
  92. */
  93. createGroup(callback?: (err: AWSError, data: QuickSight.Types.CreateGroupResponse) => void): Request<QuickSight.Types.CreateGroupResponse, AWSError>;
  94. /**
  95. * Adds an Amazon QuickSight user to an Amazon QuickSight group.
  96. */
  97. createGroupMembership(params: QuickSight.Types.CreateGroupMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateGroupMembershipResponse) => void): Request<QuickSight.Types.CreateGroupMembershipResponse, AWSError>;
  98. /**
  99. * Adds an Amazon QuickSight user to an Amazon QuickSight group.
  100. */
  101. createGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.CreateGroupMembershipResponse) => void): Request<QuickSight.Types.CreateGroupMembershipResponse, AWSError>;
  102. /**
  103. * Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
  104. */
  105. createIAMPolicyAssignment(params: QuickSight.Types.CreateIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.CreateIAMPolicyAssignmentResponse, AWSError>;
  106. /**
  107. * Creates an assignment with one specified IAM policy, identified by its Amazon Resource Name (ARN). This policy assignment is attached to the specified groups or users of Amazon QuickSight. Assignment names are unique per Amazon Web Services account. To avoid overwriting rules in other namespaces, use assignment names that are unique.
  108. */
  109. createIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.CreateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.CreateIAMPolicyAssignmentResponse, AWSError>;
  110. /**
  111. * Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time. Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
  112. */
  113. createIngestion(params: QuickSight.Types.CreateIngestionRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateIngestionResponse) => void): Request<QuickSight.Types.CreateIngestionResponse, AWSError>;
  114. /**
  115. * Creates and starts a new SPICE ingestion for a dataset. You can manually refresh datasets in an Enterprise edition account 32 times in a 24-hour period. You can manually refresh datasets in a Standard edition account 8 times in a 24-hour period. Each 24-hour period is measured starting 24 hours before the current date and time. Any ingestions operating on tagged datasets inherit the same tags automatically for use in access control. For an example, see How do I create an IAM policy to control access to Amazon EC2 resources using tags? in the Amazon Web Services Knowledge Center. Tags are visible on the tagged dataset, but not on the ingestion resource.
  116. */
  117. createIngestion(callback?: (err: AWSError, data: QuickSight.Types.CreateIngestionResponse) => void): Request<QuickSight.Types.CreateIngestionResponse, AWSError>;
  118. /**
  119. * (Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight. A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
  120. */
  121. createNamespace(params: QuickSight.Types.CreateNamespaceRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateNamespaceResponse) => void): Request<QuickSight.Types.CreateNamespaceResponse, AWSError>;
  122. /**
  123. * (Enterprise edition only) Creates a new namespace for you to use with Amazon QuickSight. A namespace allows you to isolate the Amazon QuickSight users and groups that are registered for that namespace. Users that access the namespace can share assets only with other users or groups in the same namespace. They can't see users and groups in other namespaces. You can create a namespace after your Amazon Web Services account is subscribed to Amazon QuickSight. The namespace must be unique within the Amazon Web Services account. By default, there is a limit of 100 namespaces per Amazon Web Services account. To increase your limit, create a ticket with Amazon Web Services Support.
  124. */
  125. createNamespace(callback?: (err: AWSError, data: QuickSight.Types.CreateNamespaceResponse) => void): Request<QuickSight.Types.CreateNamespaceResponse, AWSError>;
  126. /**
  127. * Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
  128. */
  129. createRefreshSchedule(params: QuickSight.Types.CreateRefreshScheduleRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateRefreshScheduleResponse) => void): Request<QuickSight.Types.CreateRefreshScheduleResponse, AWSError>;
  130. /**
  131. * Creates a refresh schedule for a dataset. You can create up to 5 different schedules for a single dataset.
  132. */
  133. createRefreshSchedule(callback?: (err: AWSError, data: QuickSight.Types.CreateRefreshScheduleResponse) => void): Request<QuickSight.Types.CreateRefreshScheduleResponse, AWSError>;
  134. /**
  135. * Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.
  136. */
  137. createRoleMembership(params: QuickSight.Types.CreateRoleMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateRoleMembershipResponse) => void): Request<QuickSight.Types.CreateRoleMembershipResponse, AWSError>;
  138. /**
  139. * Use CreateRoleMembership to add an existing Amazon QuickSight group to an existing role.
  140. */
  141. createRoleMembership(callback?: (err: AWSError, data: QuickSight.Types.CreateRoleMembershipResponse) => void): Request<QuickSight.Types.CreateRoleMembershipResponse, AWSError>;
  142. /**
  143. * Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses. A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
  144. */
  145. createTemplate(params: QuickSight.Types.CreateTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateResponse) => void): Request<QuickSight.Types.CreateTemplateResponse, AWSError>;
  146. /**
  147. * Creates a template either from a TemplateDefinition or from an existing Amazon QuickSight analysis or template. You can use the resulting template to create additional dashboards, templates, or analyses. A template is an entity in Amazon QuickSight that encapsulates the metadata required to create an analysis and that you can use to create s dashboard. A template adds a layer of abstraction by using placeholders to replace the dataset associated with the analysis. You can use templates to create dashboards by replacing dataset placeholders with datasets that follow the same schema that was used to create the source analysis and template.
  148. */
  149. createTemplate(callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateResponse) => void): Request<QuickSight.Types.CreateTemplateResponse, AWSError>;
  150. /**
  151. * Creates a template alias for a template.
  152. */
  153. createTemplateAlias(params: QuickSight.Types.CreateTemplateAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateAliasResponse) => void): Request<QuickSight.Types.CreateTemplateAliasResponse, AWSError>;
  154. /**
  155. * Creates a template alias for a template.
  156. */
  157. createTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.CreateTemplateAliasResponse) => void): Request<QuickSight.Types.CreateTemplateAliasResponse, AWSError>;
  158. /**
  159. * Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
  160. */
  161. createTheme(params: QuickSight.Types.CreateThemeRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateThemeResponse) => void): Request<QuickSight.Types.CreateThemeResponse, AWSError>;
  162. /**
  163. * Creates a theme. A theme is set of configuration options for color and layout. Themes apply to analyses and dashboards. For more information, see Using Themes in Amazon QuickSight in the Amazon QuickSight User Guide.
  164. */
  165. createTheme(callback?: (err: AWSError, data: QuickSight.Types.CreateThemeResponse) => void): Request<QuickSight.Types.CreateThemeResponse, AWSError>;
  166. /**
  167. * Creates a theme alias for a theme.
  168. */
  169. createThemeAlias(params: QuickSight.Types.CreateThemeAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateThemeAliasResponse) => void): Request<QuickSight.Types.CreateThemeAliasResponse, AWSError>;
  170. /**
  171. * Creates a theme alias for a theme.
  172. */
  173. createThemeAlias(callback?: (err: AWSError, data: QuickSight.Types.CreateThemeAliasResponse) => void): Request<QuickSight.Types.CreateThemeAliasResponse, AWSError>;
  174. /**
  175. * Creates a new Q topic.
  176. */
  177. createTopic(params: QuickSight.Types.CreateTopicRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateTopicResponse) => void): Request<QuickSight.Types.CreateTopicResponse, AWSError>;
  178. /**
  179. * Creates a new Q topic.
  180. */
  181. createTopic(callback?: (err: AWSError, data: QuickSight.Types.CreateTopicResponse) => void): Request<QuickSight.Types.CreateTopicResponse, AWSError>;
  182. /**
  183. * Creates a topic refresh schedule.
  184. */
  185. createTopicRefreshSchedule(params: QuickSight.Types.CreateTopicRefreshScheduleRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateTopicRefreshScheduleResponse) => void): Request<QuickSight.Types.CreateTopicRefreshScheduleResponse, AWSError>;
  186. /**
  187. * Creates a topic refresh schedule.
  188. */
  189. createTopicRefreshSchedule(callback?: (err: AWSError, data: QuickSight.Types.CreateTopicRefreshScheduleResponse) => void): Request<QuickSight.Types.CreateTopicRefreshScheduleResponse, AWSError>;
  190. /**
  191. * Creates a new VPC connection.
  192. */
  193. createVPCConnection(params: QuickSight.Types.CreateVPCConnectionRequest, callback?: (err: AWSError, data: QuickSight.Types.CreateVPCConnectionResponse) => void): Request<QuickSight.Types.CreateVPCConnectionResponse, AWSError>;
  194. /**
  195. * Creates a new VPC connection.
  196. */
  197. createVPCConnection(callback?: (err: AWSError, data: QuickSight.Types.CreateVPCConnectionResponse) => void): Request<QuickSight.Types.CreateVPCConnectionResponse, AWSError>;
  198. /**
  199. * Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
  200. */
  201. deleteAccountCustomization(params: QuickSight.Types.DeleteAccountCustomizationRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteAccountCustomizationResponse) => void): Request<QuickSight.Types.DeleteAccountCustomizationResponse, AWSError>;
  202. /**
  203. * Deletes all Amazon QuickSight customizations in this Amazon Web Services Region for the specified Amazon Web Services account and Amazon QuickSight namespace.
  204. */
  205. deleteAccountCustomization(callback?: (err: AWSError, data: QuickSight.Types.DeleteAccountCustomizationResponse) => void): Request<QuickSight.Types.DeleteAccountCustomizationResponse, AWSError>;
  206. /**
  207. * Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.
  208. */
  209. deleteAccountSubscription(params: QuickSight.Types.DeleteAccountSubscriptionRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteAccountSubscriptionResponse) => void): Request<QuickSight.Types.DeleteAccountSubscriptionResponse, AWSError>;
  210. /**
  211. * Use the DeleteAccountSubscription operation to delete an Amazon QuickSight account. This operation will result in an error message if you have configured your account termination protection settings to True. To change this setting and delete your account, call the UpdateAccountSettings API and set the value of the TerminationProtectionEnabled parameter to False, then make another call to the DeleteAccountSubscription API.
  212. */
  213. deleteAccountSubscription(callback?: (err: AWSError, data: QuickSight.Types.DeleteAccountSubscriptionResponse) => void): Request<QuickSight.Types.DeleteAccountSubscriptionResponse, AWSError>;
  214. /**
  215. * Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
  216. */
  217. deleteAnalysis(params: QuickSight.Types.DeleteAnalysisRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteAnalysisResponse) => void): Request<QuickSight.Types.DeleteAnalysisResponse, AWSError>;
  218. /**
  219. * Deletes an analysis from Amazon QuickSight. You can optionally include a recovery window during which you can restore the analysis. If you don't specify a recovery window value, the operation defaults to 30 days. Amazon QuickSight attaches a DeletionTime stamp to the response that specifies the end of the recovery window. At the end of the recovery window, Amazon QuickSight deletes the analysis permanently. At any time before recovery window ends, you can use the RestoreAnalysis API operation to remove the DeletionTime stamp and cancel the deletion of the analysis. The analysis remains visible in the API until it's deleted, so you can describe it but you can't make a template from it. An analysis that's scheduled for deletion isn't accessible in the Amazon QuickSight console. To access it in the console, restore it. Deleting an analysis doesn't delete the dashboards that you publish from it.
  220. */
  221. deleteAnalysis(callback?: (err: AWSError, data: QuickSight.Types.DeleteAnalysisResponse) => void): Request<QuickSight.Types.DeleteAnalysisResponse, AWSError>;
  222. /**
  223. * Deletes a dashboard.
  224. */
  225. deleteDashboard(params: QuickSight.Types.DeleteDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteDashboardResponse) => void): Request<QuickSight.Types.DeleteDashboardResponse, AWSError>;
  226. /**
  227. * Deletes a dashboard.
  228. */
  229. deleteDashboard(callback?: (err: AWSError, data: QuickSight.Types.DeleteDashboardResponse) => void): Request<QuickSight.Types.DeleteDashboardResponse, AWSError>;
  230. /**
  231. * Deletes a dataset.
  232. */
  233. deleteDataSet(params: QuickSight.Types.DeleteDataSetRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteDataSetResponse) => void): Request<QuickSight.Types.DeleteDataSetResponse, AWSError>;
  234. /**
  235. * Deletes a dataset.
  236. */
  237. deleteDataSet(callback?: (err: AWSError, data: QuickSight.Types.DeleteDataSetResponse) => void): Request<QuickSight.Types.DeleteDataSetResponse, AWSError>;
  238. /**
  239. * Deletes the dataset refresh properties of the dataset.
  240. */
  241. deleteDataSetRefreshProperties(params: QuickSight.Types.DeleteDataSetRefreshPropertiesRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteDataSetRefreshPropertiesResponse) => void): Request<QuickSight.Types.DeleteDataSetRefreshPropertiesResponse, AWSError>;
  242. /**
  243. * Deletes the dataset refresh properties of the dataset.
  244. */
  245. deleteDataSetRefreshProperties(callback?: (err: AWSError, data: QuickSight.Types.DeleteDataSetRefreshPropertiesResponse) => void): Request<QuickSight.Types.DeleteDataSetRefreshPropertiesResponse, AWSError>;
  246. /**
  247. * Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
  248. */
  249. deleteDataSource(params: QuickSight.Types.DeleteDataSourceRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteDataSourceResponse) => void): Request<QuickSight.Types.DeleteDataSourceResponse, AWSError>;
  250. /**
  251. * Deletes the data source permanently. This operation breaks all the datasets that reference the deleted data source.
  252. */
  253. deleteDataSource(callback?: (err: AWSError, data: QuickSight.Types.DeleteDataSourceResponse) => void): Request<QuickSight.Types.DeleteDataSourceResponse, AWSError>;
  254. /**
  255. * Deletes an empty folder.
  256. */
  257. deleteFolder(params: QuickSight.Types.DeleteFolderRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteFolderResponse) => void): Request<QuickSight.Types.DeleteFolderResponse, AWSError>;
  258. /**
  259. * Deletes an empty folder.
  260. */
  261. deleteFolder(callback?: (err: AWSError, data: QuickSight.Types.DeleteFolderResponse) => void): Request<QuickSight.Types.DeleteFolderResponse, AWSError>;
  262. /**
  263. * Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
  264. */
  265. deleteFolderMembership(params: QuickSight.Types.DeleteFolderMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteFolderMembershipResponse) => void): Request<QuickSight.Types.DeleteFolderMembershipResponse, AWSError>;
  266. /**
  267. * Removes an asset, such as a dashboard, analysis, or dataset, from a folder.
  268. */
  269. deleteFolderMembership(callback?: (err: AWSError, data: QuickSight.Types.DeleteFolderMembershipResponse) => void): Request<QuickSight.Types.DeleteFolderMembershipResponse, AWSError>;
  270. /**
  271. * Removes a user group from Amazon QuickSight.
  272. */
  273. deleteGroup(params: QuickSight.Types.DeleteGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupResponse) => void): Request<QuickSight.Types.DeleteGroupResponse, AWSError>;
  274. /**
  275. * Removes a user group from Amazon QuickSight.
  276. */
  277. deleteGroup(callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupResponse) => void): Request<QuickSight.Types.DeleteGroupResponse, AWSError>;
  278. /**
  279. * Removes a user from a group so that the user is no longer a member of the group.
  280. */
  281. deleteGroupMembership(params: QuickSight.Types.DeleteGroupMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupMembershipResponse) => void): Request<QuickSight.Types.DeleteGroupMembershipResponse, AWSError>;
  282. /**
  283. * Removes a user from a group so that the user is no longer a member of the group.
  284. */
  285. deleteGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.DeleteGroupMembershipResponse) => void): Request<QuickSight.Types.DeleteGroupMembershipResponse, AWSError>;
  286. /**
  287. * Deletes an existing IAM policy assignment.
  288. */
  289. deleteIAMPolicyAssignment(params: QuickSight.Types.DeleteIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DeleteIAMPolicyAssignmentResponse, AWSError>;
  290. /**
  291. * Deletes an existing IAM policy assignment.
  292. */
  293. deleteIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.DeleteIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DeleteIAMPolicyAssignmentResponse, AWSError>;
  294. /**
  295. * Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application. This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
  296. */
  297. deleteIdentityPropagationConfig(params: QuickSight.Types.DeleteIdentityPropagationConfigRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteIdentityPropagationConfigResponse) => void): Request<QuickSight.Types.DeleteIdentityPropagationConfigResponse, AWSError>;
  298. /**
  299. * Deletes all access scopes and authorized targets that are associated with a service from the Amazon QuickSight IAM Identity Center application. This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
  300. */
  301. deleteIdentityPropagationConfig(callback?: (err: AWSError, data: QuickSight.Types.DeleteIdentityPropagationConfigResponse) => void): Request<QuickSight.Types.DeleteIdentityPropagationConfigResponse, AWSError>;
  302. /**
  303. * Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
  304. */
  305. deleteNamespace(params: QuickSight.Types.DeleteNamespaceRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteNamespaceResponse) => void): Request<QuickSight.Types.DeleteNamespaceResponse, AWSError>;
  306. /**
  307. * Deletes a namespace and the users and groups that are associated with the namespace. This is an asynchronous process. Assets including dashboards, analyses, datasets and data sources are not deleted. To delete these assets, you use the API operations for the relevant asset.
  308. */
  309. deleteNamespace(callback?: (err: AWSError, data: QuickSight.Types.DeleteNamespaceResponse) => void): Request<QuickSight.Types.DeleteNamespaceResponse, AWSError>;
  310. /**
  311. * Deletes a refresh schedule from a dataset.
  312. */
  313. deleteRefreshSchedule(params: QuickSight.Types.DeleteRefreshScheduleRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteRefreshScheduleResponse) => void): Request<QuickSight.Types.DeleteRefreshScheduleResponse, AWSError>;
  314. /**
  315. * Deletes a refresh schedule from a dataset.
  316. */
  317. deleteRefreshSchedule(callback?: (err: AWSError, data: QuickSight.Types.DeleteRefreshScheduleResponse) => void): Request<QuickSight.Types.DeleteRefreshScheduleResponse, AWSError>;
  318. /**
  319. * Removes custom permissions from the role.
  320. */
  321. deleteRoleCustomPermission(params: QuickSight.Types.DeleteRoleCustomPermissionRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteRoleCustomPermissionResponse) => void): Request<QuickSight.Types.DeleteRoleCustomPermissionResponse, AWSError>;
  322. /**
  323. * Removes custom permissions from the role.
  324. */
  325. deleteRoleCustomPermission(callback?: (err: AWSError, data: QuickSight.Types.DeleteRoleCustomPermissionResponse) => void): Request<QuickSight.Types.DeleteRoleCustomPermissionResponse, AWSError>;
  326. /**
  327. * Removes a group from a role.
  328. */
  329. deleteRoleMembership(params: QuickSight.Types.DeleteRoleMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteRoleMembershipResponse) => void): Request<QuickSight.Types.DeleteRoleMembershipResponse, AWSError>;
  330. /**
  331. * Removes a group from a role.
  332. */
  333. deleteRoleMembership(callback?: (err: AWSError, data: QuickSight.Types.DeleteRoleMembershipResponse) => void): Request<QuickSight.Types.DeleteRoleMembershipResponse, AWSError>;
  334. /**
  335. * Deletes a template.
  336. */
  337. deleteTemplate(params: QuickSight.Types.DeleteTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateResponse) => void): Request<QuickSight.Types.DeleteTemplateResponse, AWSError>;
  338. /**
  339. * Deletes a template.
  340. */
  341. deleteTemplate(callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateResponse) => void): Request<QuickSight.Types.DeleteTemplateResponse, AWSError>;
  342. /**
  343. * Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
  344. */
  345. deleteTemplateAlias(params: QuickSight.Types.DeleteTemplateAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateAliasResponse) => void): Request<QuickSight.Types.DeleteTemplateAliasResponse, AWSError>;
  346. /**
  347. * Deletes the item that the specified template alias points to. If you provide a specific alias, you delete the version of the template that the alias points to.
  348. */
  349. deleteTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.DeleteTemplateAliasResponse) => void): Request<QuickSight.Types.DeleteTemplateAliasResponse, AWSError>;
  350. /**
  351. * Deletes a theme.
  352. */
  353. deleteTheme(params: QuickSight.Types.DeleteThemeRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteThemeResponse) => void): Request<QuickSight.Types.DeleteThemeResponse, AWSError>;
  354. /**
  355. * Deletes a theme.
  356. */
  357. deleteTheme(callback?: (err: AWSError, data: QuickSight.Types.DeleteThemeResponse) => void): Request<QuickSight.Types.DeleteThemeResponse, AWSError>;
  358. /**
  359. * Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
  360. */
  361. deleteThemeAlias(params: QuickSight.Types.DeleteThemeAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteThemeAliasResponse) => void): Request<QuickSight.Types.DeleteThemeAliasResponse, AWSError>;
  362. /**
  363. * Deletes the version of the theme that the specified theme alias points to. If you provide a specific alias, you delete the version of the theme that the alias points to.
  364. */
  365. deleteThemeAlias(callback?: (err: AWSError, data: QuickSight.Types.DeleteThemeAliasResponse) => void): Request<QuickSight.Types.DeleteThemeAliasResponse, AWSError>;
  366. /**
  367. * Deletes a topic.
  368. */
  369. deleteTopic(params: QuickSight.Types.DeleteTopicRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteTopicResponse) => void): Request<QuickSight.Types.DeleteTopicResponse, AWSError>;
  370. /**
  371. * Deletes a topic.
  372. */
  373. deleteTopic(callback?: (err: AWSError, data: QuickSight.Types.DeleteTopicResponse) => void): Request<QuickSight.Types.DeleteTopicResponse, AWSError>;
  374. /**
  375. * Deletes a topic refresh schedule.
  376. */
  377. deleteTopicRefreshSchedule(params: QuickSight.Types.DeleteTopicRefreshScheduleRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteTopicRefreshScheduleResponse) => void): Request<QuickSight.Types.DeleteTopicRefreshScheduleResponse, AWSError>;
  378. /**
  379. * Deletes a topic refresh schedule.
  380. */
  381. deleteTopicRefreshSchedule(callback?: (err: AWSError, data: QuickSight.Types.DeleteTopicRefreshScheduleResponse) => void): Request<QuickSight.Types.DeleteTopicRefreshScheduleResponse, AWSError>;
  382. /**
  383. * Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.
  384. */
  385. deleteUser(params: QuickSight.Types.DeleteUserRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteUserResponse) => void): Request<QuickSight.Types.DeleteUserResponse, AWSError>;
  386. /**
  387. * Deletes the Amazon QuickSight user that is associated with the identity of the IAM user or role that's making the call. The IAM user isn't deleted as a result of this call.
  388. */
  389. deleteUser(callback?: (err: AWSError, data: QuickSight.Types.DeleteUserResponse) => void): Request<QuickSight.Types.DeleteUserResponse, AWSError>;
  390. /**
  391. * Deletes a user identified by its principal ID.
  392. */
  393. deleteUserByPrincipalId(params: QuickSight.Types.DeleteUserByPrincipalIdRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteUserByPrincipalIdResponse) => void): Request<QuickSight.Types.DeleteUserByPrincipalIdResponse, AWSError>;
  394. /**
  395. * Deletes a user identified by its principal ID.
  396. */
  397. deleteUserByPrincipalId(callback?: (err: AWSError, data: QuickSight.Types.DeleteUserByPrincipalIdResponse) => void): Request<QuickSight.Types.DeleteUserByPrincipalIdResponse, AWSError>;
  398. /**
  399. * Deletes a VPC connection.
  400. */
  401. deleteVPCConnection(params: QuickSight.Types.DeleteVPCConnectionRequest, callback?: (err: AWSError, data: QuickSight.Types.DeleteVPCConnectionResponse) => void): Request<QuickSight.Types.DeleteVPCConnectionResponse, AWSError>;
  402. /**
  403. * Deletes a VPC connection.
  404. */
  405. deleteVPCConnection(callback?: (err: AWSError, data: QuickSight.Types.DeleteVPCConnectionResponse) => void): Request<QuickSight.Types.DeleteVPCConnectionResponse, AWSError>;
  406. /**
  407. * Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included. To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region. Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace. To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options: Use command line options. Use named profiles. Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI. Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region. Applied customizations - Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the same customizations.
  408. */
  409. describeAccountCustomization(params: QuickSight.Types.DescribeAccountCustomizationRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountCustomizationResponse) => void): Request<QuickSight.Types.DescribeAccountCustomizationResponse, AWSError>;
  410. /**
  411. * Describes the customizations associated with the provided Amazon Web Services account and Amazon Amazon QuickSight namespace in an Amazon Web Services Region. The Amazon QuickSight console evaluates which customizations to apply by running this API operation with the Resolved flag included. To determine what customizations display when you run this command, it can help to visualize the relationship of the entities involved. Amazon Web Services account - The Amazon Web Services account exists at the top of the hierarchy. It has the potential to use all of the Amazon Web Services Regions and Amazon Web Services Services. When you subscribe to Amazon QuickSight, you choose one Amazon Web Services Region to use as your home Region. That's where your free SPICE capacity is located. You can use Amazon QuickSight in any supported Amazon Web Services Region. Amazon Web Services Region - In each Amazon Web Services Region where you sign in to Amazon QuickSight at least once, Amazon QuickSight acts as a separate instance of the same service. If you have a user directory, it resides in us-east-1, which is the US East (N. Virginia). Generally speaking, these users have access to Amazon QuickSight in any Amazon Web Services Region, unless they are constrained to a namespace. To run the command in a different Amazon Web Services Region, you change your Region settings. If you're using the CLI, you can use one of the following options: Use command line options. Use named profiles. Run aws configure to change your default Amazon Web Services Region. Use Enter to key the same settings for your keys. For more information, see Configuring the CLI. Namespace - A QuickSight namespace is a partition that contains users and assets (data sources, datasets, dashboards, and so on). To access assets that are in a specific namespace, users and groups must also be part of the same namespace. People who share a namespace are completely isolated from users and assets in other namespaces, even if they are in the same Amazon Web Services account and Amazon Web Services Region. Applied customizations - Within an Amazon Web Services Region, a set of Amazon QuickSight customizations can apply to an Amazon Web Services account or to a namespace. Settings that you apply to a namespace override settings that you apply to an Amazon Web Services account. All settings are isolated to a single Amazon Web Services Region. To apply them in other Amazon Web Services Regions, run the CreateAccountCustomization command in each Amazon Web Services Region where you want to apply the same customizations.
  412. */
  413. describeAccountCustomization(callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountCustomizationResponse) => void): Request<QuickSight.Types.DescribeAccountCustomizationResponse, AWSError>;
  414. /**
  415. * Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
  416. */
  417. describeAccountSettings(params: QuickSight.Types.DescribeAccountSettingsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountSettingsResponse) => void): Request<QuickSight.Types.DescribeAccountSettingsResponse, AWSError>;
  418. /**
  419. * Describes the settings that were used when your Amazon QuickSight subscription was first created in this Amazon Web Services account.
  420. */
  421. describeAccountSettings(callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountSettingsResponse) => void): Request<QuickSight.Types.DescribeAccountSettingsResponse, AWSError>;
  422. /**
  423. * Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.
  424. */
  425. describeAccountSubscription(params: QuickSight.Types.DescribeAccountSubscriptionRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountSubscriptionResponse) => void): Request<QuickSight.Types.DescribeAccountSubscriptionResponse, AWSError>;
  426. /**
  427. * Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.
  428. */
  429. describeAccountSubscription(callback?: (err: AWSError, data: QuickSight.Types.DescribeAccountSubscriptionResponse) => void): Request<QuickSight.Types.DescribeAccountSubscriptionResponse, AWSError>;
  430. /**
  431. * Provides a summary of the metadata for an analysis.
  432. */
  433. describeAnalysis(params: QuickSight.Types.DescribeAnalysisRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAnalysisResponse) => void): Request<QuickSight.Types.DescribeAnalysisResponse, AWSError>;
  434. /**
  435. * Provides a summary of the metadata for an analysis.
  436. */
  437. describeAnalysis(callback?: (err: AWSError, data: QuickSight.Types.DescribeAnalysisResponse) => void): Request<QuickSight.Types.DescribeAnalysisResponse, AWSError>;
  438. /**
  439. * Provides a detailed description of the definition of an analysis. If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.
  440. */
  441. describeAnalysisDefinition(params: QuickSight.Types.DescribeAnalysisDefinitionRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAnalysisDefinitionResponse) => void): Request<QuickSight.Types.DescribeAnalysisDefinitionResponse, AWSError>;
  442. /**
  443. * Provides a detailed description of the definition of an analysis. If you do not need to know details about the content of an Analysis, for instance if you are trying to check the status of a recently created or updated Analysis, use the DescribeAnalysis instead.
  444. */
  445. describeAnalysisDefinition(callback?: (err: AWSError, data: QuickSight.Types.DescribeAnalysisDefinitionResponse) => void): Request<QuickSight.Types.DescribeAnalysisDefinitionResponse, AWSError>;
  446. /**
  447. * Provides the read and write permissions for an analysis.
  448. */
  449. describeAnalysisPermissions(params: QuickSight.Types.DescribeAnalysisPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAnalysisPermissionsResponse) => void): Request<QuickSight.Types.DescribeAnalysisPermissionsResponse, AWSError>;
  450. /**
  451. * Provides the read and write permissions for an analysis.
  452. */
  453. describeAnalysisPermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeAnalysisPermissionsResponse) => void): Request<QuickSight.Types.DescribeAnalysisPermissionsResponse, AWSError>;
  454. /**
  455. * Describes an existing export job. Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed. Job descriptions are available for 14 days after the job starts.
  456. */
  457. describeAssetBundleExportJob(params: QuickSight.Types.DescribeAssetBundleExportJobRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAssetBundleExportJobResponse) => void): Request<QuickSight.Types.DescribeAssetBundleExportJobResponse, AWSError>;
  458. /**
  459. * Describes an existing export job. Poll job descriptions after a job starts to know the status of the job. When a job succeeds, a URL is provided to download the exported assets' data from. Download URLs are valid for five minutes after they are generated. You can call the DescribeAssetBundleExportJob API for a new download URL as needed. Job descriptions are available for 14 days after the job starts.
  460. */
  461. describeAssetBundleExportJob(callback?: (err: AWSError, data: QuickSight.Types.DescribeAssetBundleExportJobResponse) => void): Request<QuickSight.Types.DescribeAssetBundleExportJobResponse, AWSError>;
  462. /**
  463. * Describes an existing import job. Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
  464. */
  465. describeAssetBundleImportJob(params: QuickSight.Types.DescribeAssetBundleImportJobRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeAssetBundleImportJobResponse) => void): Request<QuickSight.Types.DescribeAssetBundleImportJobResponse, AWSError>;
  466. /**
  467. * Describes an existing import job. Poll job descriptions after starting a job to know when it has succeeded or failed. Job descriptions are available for 14 days after job starts.
  468. */
  469. describeAssetBundleImportJob(callback?: (err: AWSError, data: QuickSight.Types.DescribeAssetBundleImportJobResponse) => void): Request<QuickSight.Types.DescribeAssetBundleImportJobResponse, AWSError>;
  470. /**
  471. * Provides a summary for a dashboard.
  472. */
  473. describeDashboard(params: QuickSight.Types.DescribeDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardResponse) => void): Request<QuickSight.Types.DescribeDashboardResponse, AWSError>;
  474. /**
  475. * Provides a summary for a dashboard.
  476. */
  477. describeDashboard(callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardResponse) => void): Request<QuickSight.Types.DescribeDashboardResponse, AWSError>;
  478. /**
  479. * Provides a detailed description of the definition of a dashboard. If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.
  480. */
  481. describeDashboardDefinition(params: QuickSight.Types.DescribeDashboardDefinitionRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardDefinitionResponse) => void): Request<QuickSight.Types.DescribeDashboardDefinitionResponse, AWSError>;
  482. /**
  483. * Provides a detailed description of the definition of a dashboard. If you do not need to know details about the content of a dashboard, for instance if you are trying to check the status of a recently created or updated dashboard, use the DescribeDashboard instead.
  484. */
  485. describeDashboardDefinition(callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardDefinitionResponse) => void): Request<QuickSight.Types.DescribeDashboardDefinitionResponse, AWSError>;
  486. /**
  487. * Describes read and write permissions for a dashboard.
  488. */
  489. describeDashboardPermissions(params: QuickSight.Types.DescribeDashboardPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardPermissionsResponse) => void): Request<QuickSight.Types.DescribeDashboardPermissionsResponse, AWSError>;
  490. /**
  491. * Describes read and write permissions for a dashboard.
  492. */
  493. describeDashboardPermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardPermissionsResponse) => void): Request<QuickSight.Types.DescribeDashboardPermissionsResponse, AWSError>;
  494. /**
  495. * Describes an existing snapshot job. Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.
  496. */
  497. describeDashboardSnapshotJob(params: QuickSight.Types.DescribeDashboardSnapshotJobRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardSnapshotJobResponse) => void): Request<QuickSight.Types.DescribeDashboardSnapshotJobResponse, AWSError>;
  498. /**
  499. * Describes an existing snapshot job. Poll job descriptions after a job starts to know the status of the job. For information on available status codes, see JobStatus.
  500. */
  501. describeDashboardSnapshotJob(callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardSnapshotJobResponse) => void): Request<QuickSight.Types.DescribeDashboardSnapshotJobResponse, AWSError>;
  502. /**
  503. * Describes the result of an existing snapshot job that has finished running. A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call. If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id &lt;SnapshotjobId&gt; has not reached a terminal state..
  504. */
  505. describeDashboardSnapshotJobResult(params: QuickSight.Types.DescribeDashboardSnapshotJobResultRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardSnapshotJobResultResponse) => void): Request<QuickSight.Types.DescribeDashboardSnapshotJobResultResponse, AWSError>;
  506. /**
  507. * Describes the result of an existing snapshot job that has finished running. A finished snapshot job will return a COMPLETED or FAILED status when you poll the job with a DescribeDashboardSnapshotJob API call. If the job has not finished running, this operation returns a message that says Dashboard Snapshot Job with id &lt;SnapshotjobId&gt; has not reached a terminal state..
  508. */
  509. describeDashboardSnapshotJobResult(callback?: (err: AWSError, data: QuickSight.Types.DescribeDashboardSnapshotJobResultResponse) => void): Request<QuickSight.Types.DescribeDashboardSnapshotJobResultResponse, AWSError>;
  510. /**
  511. * Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
  512. */
  513. describeDataSet(params: QuickSight.Types.DescribeDataSetRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSetResponse) => void): Request<QuickSight.Types.DescribeDataSetResponse, AWSError>;
  514. /**
  515. * Describes a dataset. This operation doesn't support datasets that include uploaded files as a source.
  516. */
  517. describeDataSet(callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSetResponse) => void): Request<QuickSight.Types.DescribeDataSetResponse, AWSError>;
  518. /**
  519. * Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
  520. */
  521. describeDataSetPermissions(params: QuickSight.Types.DescribeDataSetPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSetPermissionsResponse) => void): Request<QuickSight.Types.DescribeDataSetPermissionsResponse, AWSError>;
  522. /**
  523. * Describes the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
  524. */
  525. describeDataSetPermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSetPermissionsResponse) => void): Request<QuickSight.Types.DescribeDataSetPermissionsResponse, AWSError>;
  526. /**
  527. * Describes the refresh properties of a dataset.
  528. */
  529. describeDataSetRefreshProperties(params: QuickSight.Types.DescribeDataSetRefreshPropertiesRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSetRefreshPropertiesResponse) => void): Request<QuickSight.Types.DescribeDataSetRefreshPropertiesResponse, AWSError>;
  530. /**
  531. * Describes the refresh properties of a dataset.
  532. */
  533. describeDataSetRefreshProperties(callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSetRefreshPropertiesResponse) => void): Request<QuickSight.Types.DescribeDataSetRefreshPropertiesResponse, AWSError>;
  534. /**
  535. * Describes a data source.
  536. */
  537. describeDataSource(params: QuickSight.Types.DescribeDataSourceRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSourceResponse) => void): Request<QuickSight.Types.DescribeDataSourceResponse, AWSError>;
  538. /**
  539. * Describes a data source.
  540. */
  541. describeDataSource(callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSourceResponse) => void): Request<QuickSight.Types.DescribeDataSourceResponse, AWSError>;
  542. /**
  543. * Describes the resource permissions for a data source.
  544. */
  545. describeDataSourcePermissions(params: QuickSight.Types.DescribeDataSourcePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSourcePermissionsResponse) => void): Request<QuickSight.Types.DescribeDataSourcePermissionsResponse, AWSError>;
  546. /**
  547. * Describes the resource permissions for a data source.
  548. */
  549. describeDataSourcePermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeDataSourcePermissionsResponse) => void): Request<QuickSight.Types.DescribeDataSourcePermissionsResponse, AWSError>;
  550. /**
  551. * Describes a folder.
  552. */
  553. describeFolder(params: QuickSight.Types.DescribeFolderRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeFolderResponse) => void): Request<QuickSight.Types.DescribeFolderResponse, AWSError>;
  554. /**
  555. * Describes a folder.
  556. */
  557. describeFolder(callback?: (err: AWSError, data: QuickSight.Types.DescribeFolderResponse) => void): Request<QuickSight.Types.DescribeFolderResponse, AWSError>;
  558. /**
  559. * Describes permissions for a folder.
  560. */
  561. describeFolderPermissions(params: QuickSight.Types.DescribeFolderPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeFolderPermissionsResponse) => void): Request<QuickSight.Types.DescribeFolderPermissionsResponse, AWSError>;
  562. /**
  563. * Describes permissions for a folder.
  564. */
  565. describeFolderPermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeFolderPermissionsResponse) => void): Request<QuickSight.Types.DescribeFolderPermissionsResponse, AWSError>;
  566. /**
  567. * Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
  568. */
  569. describeFolderResolvedPermissions(params: QuickSight.Types.DescribeFolderResolvedPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeFolderResolvedPermissionsResponse) => void): Request<QuickSight.Types.DescribeFolderResolvedPermissionsResponse, AWSError>;
  570. /**
  571. * Describes the folder resolved permissions. Permissions consists of both folder direct permissions and the inherited permissions from the ancestor folders.
  572. */
  573. describeFolderResolvedPermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeFolderResolvedPermissionsResponse) => void): Request<QuickSight.Types.DescribeFolderResolvedPermissionsResponse, AWSError>;
  574. /**
  575. * Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
  576. */
  577. describeGroup(params: QuickSight.Types.DescribeGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeGroupResponse) => void): Request<QuickSight.Types.DescribeGroupResponse, AWSError>;
  578. /**
  579. * Returns an Amazon QuickSight group's description and Amazon Resource Name (ARN).
  580. */
  581. describeGroup(callback?: (err: AWSError, data: QuickSight.Types.DescribeGroupResponse) => void): Request<QuickSight.Types.DescribeGroupResponse, AWSError>;
  582. /**
  583. * Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.
  584. */
  585. describeGroupMembership(params: QuickSight.Types.DescribeGroupMembershipRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeGroupMembershipResponse) => void): Request<QuickSight.Types.DescribeGroupMembershipResponse, AWSError>;
  586. /**
  587. * Use the DescribeGroupMembership operation to determine if a user is a member of the specified group. If the user exists and is a member of the specified group, an associated GroupMember object is returned.
  588. */
  589. describeGroupMembership(callback?: (err: AWSError, data: QuickSight.Types.DescribeGroupMembershipResponse) => void): Request<QuickSight.Types.DescribeGroupMembershipResponse, AWSError>;
  590. /**
  591. * Describes an existing IAM policy assignment, as specified by the assignment name.
  592. */
  593. describeIAMPolicyAssignment(params: QuickSight.Types.DescribeIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DescribeIAMPolicyAssignmentResponse, AWSError>;
  594. /**
  595. * Describes an existing IAM policy assignment, as specified by the assignment name.
  596. */
  597. describeIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.DescribeIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.DescribeIAMPolicyAssignmentResponse, AWSError>;
  598. /**
  599. * Describes a SPICE ingestion.
  600. */
  601. describeIngestion(params: QuickSight.Types.DescribeIngestionRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeIngestionResponse) => void): Request<QuickSight.Types.DescribeIngestionResponse, AWSError>;
  602. /**
  603. * Describes a SPICE ingestion.
  604. */
  605. describeIngestion(callback?: (err: AWSError, data: QuickSight.Types.DescribeIngestionResponse) => void): Request<QuickSight.Types.DescribeIngestionResponse, AWSError>;
  606. /**
  607. * Provides a summary and status of IP rules.
  608. */
  609. describeIpRestriction(params: QuickSight.Types.DescribeIpRestrictionRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeIpRestrictionResponse) => void): Request<QuickSight.Types.DescribeIpRestrictionResponse, AWSError>;
  610. /**
  611. * Provides a summary and status of IP rules.
  612. */
  613. describeIpRestriction(callback?: (err: AWSError, data: QuickSight.Types.DescribeIpRestrictionResponse) => void): Request<QuickSight.Types.DescribeIpRestrictionResponse, AWSError>;
  614. /**
  615. * Describes the current namespace.
  616. */
  617. describeNamespace(params: QuickSight.Types.DescribeNamespaceRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeNamespaceResponse) => void): Request<QuickSight.Types.DescribeNamespaceResponse, AWSError>;
  618. /**
  619. * Describes the current namespace.
  620. */
  621. describeNamespace(callback?: (err: AWSError, data: QuickSight.Types.DescribeNamespaceResponse) => void): Request<QuickSight.Types.DescribeNamespaceResponse, AWSError>;
  622. /**
  623. * Provides a summary of a refresh schedule.
  624. */
  625. describeRefreshSchedule(params: QuickSight.Types.DescribeRefreshScheduleRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeRefreshScheduleResponse) => void): Request<QuickSight.Types.DescribeRefreshScheduleResponse, AWSError>;
  626. /**
  627. * Provides a summary of a refresh schedule.
  628. */
  629. describeRefreshSchedule(callback?: (err: AWSError, data: QuickSight.Types.DescribeRefreshScheduleResponse) => void): Request<QuickSight.Types.DescribeRefreshScheduleResponse, AWSError>;
  630. /**
  631. * Describes all custom permissions that are mapped to a role.
  632. */
  633. describeRoleCustomPermission(params: QuickSight.Types.DescribeRoleCustomPermissionRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeRoleCustomPermissionResponse) => void): Request<QuickSight.Types.DescribeRoleCustomPermissionResponse, AWSError>;
  634. /**
  635. * Describes all custom permissions that are mapped to a role.
  636. */
  637. describeRoleCustomPermission(callback?: (err: AWSError, data: QuickSight.Types.DescribeRoleCustomPermissionResponse) => void): Request<QuickSight.Types.DescribeRoleCustomPermissionResponse, AWSError>;
  638. /**
  639. * Describes a template's metadata.
  640. */
  641. describeTemplate(params: QuickSight.Types.DescribeTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateResponse) => void): Request<QuickSight.Types.DescribeTemplateResponse, AWSError>;
  642. /**
  643. * Describes a template's metadata.
  644. */
  645. describeTemplate(callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateResponse) => void): Request<QuickSight.Types.DescribeTemplateResponse, AWSError>;
  646. /**
  647. * Describes the template alias for a template.
  648. */
  649. describeTemplateAlias(params: QuickSight.Types.DescribeTemplateAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateAliasResponse) => void): Request<QuickSight.Types.DescribeTemplateAliasResponse, AWSError>;
  650. /**
  651. * Describes the template alias for a template.
  652. */
  653. describeTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateAliasResponse) => void): Request<QuickSight.Types.DescribeTemplateAliasResponse, AWSError>;
  654. /**
  655. * Provides a detailed description of the definition of a template. If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.
  656. */
  657. describeTemplateDefinition(params: QuickSight.Types.DescribeTemplateDefinitionRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateDefinitionResponse) => void): Request<QuickSight.Types.DescribeTemplateDefinitionResponse, AWSError>;
  658. /**
  659. * Provides a detailed description of the definition of a template. If you do not need to know details about the content of a template, for instance if you are trying to check the status of a recently created or updated template, use the DescribeTemplate instead.
  660. */
  661. describeTemplateDefinition(callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplateDefinitionResponse) => void): Request<QuickSight.Types.DescribeTemplateDefinitionResponse, AWSError>;
  662. /**
  663. * Describes read and write permissions on a template.
  664. */
  665. describeTemplatePermissions(params: QuickSight.Types.DescribeTemplatePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplatePermissionsResponse) => void): Request<QuickSight.Types.DescribeTemplatePermissionsResponse, AWSError>;
  666. /**
  667. * Describes read and write permissions on a template.
  668. */
  669. describeTemplatePermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeTemplatePermissionsResponse) => void): Request<QuickSight.Types.DescribeTemplatePermissionsResponse, AWSError>;
  670. /**
  671. * Describes a theme.
  672. */
  673. describeTheme(params: QuickSight.Types.DescribeThemeRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeThemeResponse) => void): Request<QuickSight.Types.DescribeThemeResponse, AWSError>;
  674. /**
  675. * Describes a theme.
  676. */
  677. describeTheme(callback?: (err: AWSError, data: QuickSight.Types.DescribeThemeResponse) => void): Request<QuickSight.Types.DescribeThemeResponse, AWSError>;
  678. /**
  679. * Describes the alias for a theme.
  680. */
  681. describeThemeAlias(params: QuickSight.Types.DescribeThemeAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeThemeAliasResponse) => void): Request<QuickSight.Types.DescribeThemeAliasResponse, AWSError>;
  682. /**
  683. * Describes the alias for a theme.
  684. */
  685. describeThemeAlias(callback?: (err: AWSError, data: QuickSight.Types.DescribeThemeAliasResponse) => void): Request<QuickSight.Types.DescribeThemeAliasResponse, AWSError>;
  686. /**
  687. * Describes the read and write permissions for a theme.
  688. */
  689. describeThemePermissions(params: QuickSight.Types.DescribeThemePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeThemePermissionsResponse) => void): Request<QuickSight.Types.DescribeThemePermissionsResponse, AWSError>;
  690. /**
  691. * Describes the read and write permissions for a theme.
  692. */
  693. describeThemePermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeThemePermissionsResponse) => void): Request<QuickSight.Types.DescribeThemePermissionsResponse, AWSError>;
  694. /**
  695. * Describes a topic.
  696. */
  697. describeTopic(params: QuickSight.Types.DescribeTopicRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTopicResponse) => void): Request<QuickSight.Types.DescribeTopicResponse, AWSError>;
  698. /**
  699. * Describes a topic.
  700. */
  701. describeTopic(callback?: (err: AWSError, data: QuickSight.Types.DescribeTopicResponse) => void): Request<QuickSight.Types.DescribeTopicResponse, AWSError>;
  702. /**
  703. * Describes the permissions of a topic.
  704. */
  705. describeTopicPermissions(params: QuickSight.Types.DescribeTopicPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTopicPermissionsResponse) => void): Request<QuickSight.Types.DescribeTopicPermissionsResponse, AWSError>;
  706. /**
  707. * Describes the permissions of a topic.
  708. */
  709. describeTopicPermissions(callback?: (err: AWSError, data: QuickSight.Types.DescribeTopicPermissionsResponse) => void): Request<QuickSight.Types.DescribeTopicPermissionsResponse, AWSError>;
  710. /**
  711. * Describes the status of a topic refresh.
  712. */
  713. describeTopicRefresh(params: QuickSight.Types.DescribeTopicRefreshRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTopicRefreshResponse) => void): Request<QuickSight.Types.DescribeTopicRefreshResponse, AWSError>;
  714. /**
  715. * Describes the status of a topic refresh.
  716. */
  717. describeTopicRefresh(callback?: (err: AWSError, data: QuickSight.Types.DescribeTopicRefreshResponse) => void): Request<QuickSight.Types.DescribeTopicRefreshResponse, AWSError>;
  718. /**
  719. * Deletes a topic refresh schedule.
  720. */
  721. describeTopicRefreshSchedule(params: QuickSight.Types.DescribeTopicRefreshScheduleRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeTopicRefreshScheduleResponse) => void): Request<QuickSight.Types.DescribeTopicRefreshScheduleResponse, AWSError>;
  722. /**
  723. * Deletes a topic refresh schedule.
  724. */
  725. describeTopicRefreshSchedule(callback?: (err: AWSError, data: QuickSight.Types.DescribeTopicRefreshScheduleResponse) => void): Request<QuickSight.Types.DescribeTopicRefreshScheduleResponse, AWSError>;
  726. /**
  727. * Returns information about a user, given the user name.
  728. */
  729. describeUser(params: QuickSight.Types.DescribeUserRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeUserResponse) => void): Request<QuickSight.Types.DescribeUserResponse, AWSError>;
  730. /**
  731. * Returns information about a user, given the user name.
  732. */
  733. describeUser(callback?: (err: AWSError, data: QuickSight.Types.DescribeUserResponse) => void): Request<QuickSight.Types.DescribeUserResponse, AWSError>;
  734. /**
  735. * Describes a VPC connection.
  736. */
  737. describeVPCConnection(params: QuickSight.Types.DescribeVPCConnectionRequest, callback?: (err: AWSError, data: QuickSight.Types.DescribeVPCConnectionResponse) => void): Request<QuickSight.Types.DescribeVPCConnectionResponse, AWSError>;
  738. /**
  739. * Describes a VPC connection.
  740. */
  741. describeVPCConnection(callback?: (err: AWSError, data: QuickSight.Types.DescribeVPCConnectionResponse) => void): Request<QuickSight.Types.DescribeVPCConnectionResponse, AWSError>;
  742. /**
  743. * Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions. The following rules apply to the generated URL: It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. You are charged only when the URL is used or there is interaction with Amazon QuickSight. For more information, see Embedded Analytics in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
  744. */
  745. generateEmbedUrlForAnonymousUser(params: QuickSight.Types.GenerateEmbedUrlForAnonymousUserRequest, callback?: (err: AWSError, data: QuickSight.Types.GenerateEmbedUrlForAnonymousUserResponse) => void): Request<QuickSight.Types.GenerateEmbedUrlForAnonymousUserResponse, AWSError>;
  746. /**
  747. * Generates an embed URL that you can use to embed an Amazon QuickSight dashboard or visual in your website, without having to register any reader users. Before you use this action, make sure that you have configured the dashboards and permissions. The following rules apply to the generated URL: It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. You are charged only when the URL is used or there is interaction with Amazon QuickSight. For more information, see Embedded Analytics in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
  748. */
  749. generateEmbedUrlForAnonymousUser(callback?: (err: AWSError, data: QuickSight.Types.GenerateEmbedUrlForAnonymousUserResponse) => void): Request<QuickSight.Types.GenerateEmbedUrlForAnonymousUserResponse, AWSError>;
  750. /**
  751. * Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions. The following rules apply to the generated URL: It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. You are charged only when the URL is used or there is interaction with Amazon QuickSight. For more information, see Embedded Analytics in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
  752. */
  753. generateEmbedUrlForRegisteredUser(params: QuickSight.Types.GenerateEmbedUrlForRegisteredUserRequest, callback?: (err: AWSError, data: QuickSight.Types.GenerateEmbedUrlForRegisteredUserResponse) => void): Request<QuickSight.Types.GenerateEmbedUrlForRegisteredUserResponse, AWSError>;
  754. /**
  755. * Generates an embed URL that you can use to embed an Amazon QuickSight experience in your website. This action can be used for any type of user registered in an Amazon QuickSight account. Before you use this action, make sure that you have configured the relevant Amazon QuickSight resource and permissions. The following rules apply to the generated URL: It contains a temporary bearer token. It is valid for 5 minutes after it is generated. Once redeemed within this period, it cannot be re-used again. The URL validity period should not be confused with the actual session lifetime that can be customized using the SessionLifetimeInMinutes parameter. The resulting user session is valid for 15 minutes (minimum) to 10 hours (maximum). The default session duration is 10 hours. You are charged only when the URL is used or there is interaction with Amazon QuickSight. For more information, see Embedded Analytics in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
  756. */
  757. generateEmbedUrlForRegisteredUser(callback?: (err: AWSError, data: QuickSight.Types.GenerateEmbedUrlForRegisteredUserResponse) => void): Request<QuickSight.Types.GenerateEmbedUrlForRegisteredUserResponse, AWSError>;
  758. /**
  759. * Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL: They must be used together. They can be used one time only. They are valid for 5 minutes after you run this command. You are charged only when the URL is used or there is interaction with Amazon QuickSight. The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration. For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
  760. */
  761. getDashboardEmbedUrl(params: QuickSight.Types.GetDashboardEmbedUrlRequest, callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request<QuickSight.Types.GetDashboardEmbedUrlResponse, AWSError>;
  762. /**
  763. * Generates a temporary session URL and authorization code(bearer token) that you can use to embed an Amazon QuickSight read-only dashboard in your website or application. Before you use this command, make sure that you have configured the dashboards and permissions. Currently, you can use GetDashboardEmbedURL only from the server, not from the user's browser. The following rules apply to the generated URL: They must be used together. They can be used one time only. They are valid for 5 minutes after you run this command. You are charged only when the URL is used or there is interaction with Amazon QuickSight. The resulting user session is valid for 15 minutes (default) up to 10 hours (maximum). You can use the optional SessionLifetimeInMinutes parameter to customize session duration. For more information, see Embedding Analytics Using GetDashboardEmbedUrl in the Amazon QuickSight User Guide. For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
  764. */
  765. getDashboardEmbedUrl(callback?: (err: AWSError, data: QuickSight.Types.GetDashboardEmbedUrlResponse) => void): Request<QuickSight.Types.GetDashboardEmbedUrlResponse, AWSError>;
  766. /**
  767. * Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide: Embedding Analytics Customizing Access to the Amazon QuickSight Console
  768. */
  769. getSessionEmbedUrl(params: QuickSight.Types.GetSessionEmbedUrlRequest, callback?: (err: AWSError, data: QuickSight.Types.GetSessionEmbedUrlResponse) => void): Request<QuickSight.Types.GetSessionEmbedUrlResponse, AWSError>;
  770. /**
  771. * Generates a session URL and authorization code that you can use to embed the Amazon Amazon QuickSight console in your web server code. Use GetSessionEmbedUrl where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who access an embedded Amazon QuickSight console need belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide: Embedding Analytics Customizing Access to the Amazon QuickSight Console
  772. */
  773. getSessionEmbedUrl(callback?: (err: AWSError, data: QuickSight.Types.GetSessionEmbedUrlResponse) => void): Request<QuickSight.Types.GetSessionEmbedUrlResponse, AWSError>;
  774. /**
  775. * Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
  776. */
  777. listAnalyses(params: QuickSight.Types.ListAnalysesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListAnalysesResponse) => void): Request<QuickSight.Types.ListAnalysesResponse, AWSError>;
  778. /**
  779. * Lists Amazon QuickSight analyses that exist in the specified Amazon Web Services account.
  780. */
  781. listAnalyses(callback?: (err: AWSError, data: QuickSight.Types.ListAnalysesResponse) => void): Request<QuickSight.Types.ListAnalysesResponse, AWSError>;
  782. /**
  783. * Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.
  784. */
  785. listAssetBundleExportJobs(params: QuickSight.Types.ListAssetBundleExportJobsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListAssetBundleExportJobsResponse) => void): Request<QuickSight.Types.ListAssetBundleExportJobsResponse, AWSError>;
  786. /**
  787. * Lists all asset bundle export jobs that have been taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleExportJobs only returns the most recent job that uses the repeated job ID.
  788. */
  789. listAssetBundleExportJobs(callback?: (err: AWSError, data: QuickSight.Types.ListAssetBundleExportJobsResponse) => void): Request<QuickSight.Types.ListAssetBundleExportJobsResponse, AWSError>;
  790. /**
  791. * Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.
  792. */
  793. listAssetBundleImportJobs(params: QuickSight.Types.ListAssetBundleImportJobsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListAssetBundleImportJobsResponse) => void): Request<QuickSight.Types.ListAssetBundleImportJobsResponse, AWSError>;
  794. /**
  795. * Lists all asset bundle import jobs that have taken place in the last 14 days. Jobs created more than 14 days ago are deleted forever and are not returned. If you are using the same job ID for multiple jobs, ListAssetBundleImportJobs only returns the most recent job that uses the repeated job ID.
  796. */
  797. listAssetBundleImportJobs(callback?: (err: AWSError, data: QuickSight.Types.ListAssetBundleImportJobsResponse) => void): Request<QuickSight.Types.ListAssetBundleImportJobsResponse, AWSError>;
  798. /**
  799. * Lists all the versions of the dashboards in the Amazon QuickSight subscription.
  800. */
  801. listDashboardVersions(params: QuickSight.Types.ListDashboardVersionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDashboardVersionsResponse) => void): Request<QuickSight.Types.ListDashboardVersionsResponse, AWSError>;
  802. /**
  803. * Lists all the versions of the dashboards in the Amazon QuickSight subscription.
  804. */
  805. listDashboardVersions(callback?: (err: AWSError, data: QuickSight.Types.ListDashboardVersionsResponse) => void): Request<QuickSight.Types.ListDashboardVersionsResponse, AWSError>;
  806. /**
  807. * Lists dashboards in an Amazon Web Services account.
  808. */
  809. listDashboards(params: QuickSight.Types.ListDashboardsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDashboardsResponse) => void): Request<QuickSight.Types.ListDashboardsResponse, AWSError>;
  810. /**
  811. * Lists dashboards in an Amazon Web Services account.
  812. */
  813. listDashboards(callback?: (err: AWSError, data: QuickSight.Types.ListDashboardsResponse) => void): Request<QuickSight.Types.ListDashboardsResponse, AWSError>;
  814. /**
  815. * Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
  816. */
  817. listDataSets(params: QuickSight.Types.ListDataSetsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDataSetsResponse) => void): Request<QuickSight.Types.ListDataSetsResponse, AWSError>;
  818. /**
  819. * Lists all of the datasets belonging to the current Amazon Web Services account in an Amazon Web Services Region. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/*.
  820. */
  821. listDataSets(callback?: (err: AWSError, data: QuickSight.Types.ListDataSetsResponse) => void): Request<QuickSight.Types.ListDataSetsResponse, AWSError>;
  822. /**
  823. * Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
  824. */
  825. listDataSources(params: QuickSight.Types.ListDataSourcesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListDataSourcesResponse) => void): Request<QuickSight.Types.ListDataSourcesResponse, AWSError>;
  826. /**
  827. * Lists data sources in current Amazon Web Services Region that belong to this Amazon Web Services account.
  828. */
  829. listDataSources(callback?: (err: AWSError, data: QuickSight.Types.ListDataSourcesResponse) => void): Request<QuickSight.Types.ListDataSourcesResponse, AWSError>;
  830. /**
  831. * List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
  832. */
  833. listFolderMembers(params: QuickSight.Types.ListFolderMembersRequest, callback?: (err: AWSError, data: QuickSight.Types.ListFolderMembersResponse) => void): Request<QuickSight.Types.ListFolderMembersResponse, AWSError>;
  834. /**
  835. * List all assets (DASHBOARD, ANALYSIS, and DATASET) in a folder.
  836. */
  837. listFolderMembers(callback?: (err: AWSError, data: QuickSight.Types.ListFolderMembersResponse) => void): Request<QuickSight.Types.ListFolderMembersResponse, AWSError>;
  838. /**
  839. * Lists all folders in an account.
  840. */
  841. listFolders(params: QuickSight.Types.ListFoldersRequest, callback?: (err: AWSError, data: QuickSight.Types.ListFoldersResponse) => void): Request<QuickSight.Types.ListFoldersResponse, AWSError>;
  842. /**
  843. * Lists all folders in an account.
  844. */
  845. listFolders(callback?: (err: AWSError, data: QuickSight.Types.ListFoldersResponse) => void): Request<QuickSight.Types.ListFoldersResponse, AWSError>;
  846. /**
  847. * Lists member users in a group.
  848. */
  849. listGroupMemberships(params: QuickSight.Types.ListGroupMembershipsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListGroupMembershipsResponse) => void): Request<QuickSight.Types.ListGroupMembershipsResponse, AWSError>;
  850. /**
  851. * Lists member users in a group.
  852. */
  853. listGroupMemberships(callback?: (err: AWSError, data: QuickSight.Types.ListGroupMembershipsResponse) => void): Request<QuickSight.Types.ListGroupMembershipsResponse, AWSError>;
  854. /**
  855. * Lists all user groups in Amazon QuickSight.
  856. */
  857. listGroups(params: QuickSight.Types.ListGroupsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListGroupsResponse) => void): Request<QuickSight.Types.ListGroupsResponse, AWSError>;
  858. /**
  859. * Lists all user groups in Amazon QuickSight.
  860. */
  861. listGroups(callback?: (err: AWSError, data: QuickSight.Types.ListGroupsResponse) => void): Request<QuickSight.Types.ListGroupsResponse, AWSError>;
  862. /**
  863. * Lists the IAM policy assignments in the current Amazon QuickSight account.
  864. */
  865. listIAMPolicyAssignments(params: QuickSight.Types.ListIAMPolicyAssignmentsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsResponse, AWSError>;
  866. /**
  867. * Lists the IAM policy assignments in the current Amazon QuickSight account.
  868. */
  869. listIAMPolicyAssignments(callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsResponse, AWSError>;
  870. /**
  871. * Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
  872. */
  873. listIAMPolicyAssignmentsForUser(params: QuickSight.Types.ListIAMPolicyAssignmentsForUserRequest, callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse, AWSError>;
  874. /**
  875. * Lists all of the IAM policy assignments, including the Amazon Resource Names (ARNs), for the IAM policies assigned to the specified user and group, or groups that the user belongs to.
  876. */
  877. listIAMPolicyAssignmentsForUser(callback?: (err: AWSError, data: QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse) => void): Request<QuickSight.Types.ListIAMPolicyAssignmentsForUserResponse, AWSError>;
  878. /**
  879. * Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access. This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
  880. */
  881. listIdentityPropagationConfigs(params: QuickSight.Types.ListIdentityPropagationConfigsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListIdentityPropagationConfigsResponse) => void): Request<QuickSight.Types.ListIdentityPropagationConfigsResponse, AWSError>;
  882. /**
  883. * Lists all services and authorized targets that the Amazon QuickSight IAM Identity Center application can access. This operation is only supported for Amazon QuickSight accounts that use IAM Identity Center.
  884. */
  885. listIdentityPropagationConfigs(callback?: (err: AWSError, data: QuickSight.Types.ListIdentityPropagationConfigsResponse) => void): Request<QuickSight.Types.ListIdentityPropagationConfigsResponse, AWSError>;
  886. /**
  887. * Lists the history of SPICE ingestions for a dataset.
  888. */
  889. listIngestions(params: QuickSight.Types.ListIngestionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListIngestionsResponse) => void): Request<QuickSight.Types.ListIngestionsResponse, AWSError>;
  890. /**
  891. * Lists the history of SPICE ingestions for a dataset.
  892. */
  893. listIngestions(callback?: (err: AWSError, data: QuickSight.Types.ListIngestionsResponse) => void): Request<QuickSight.Types.ListIngestionsResponse, AWSError>;
  894. /**
  895. * Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
  896. */
  897. listNamespaces(params: QuickSight.Types.ListNamespacesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListNamespacesResponse) => void): Request<QuickSight.Types.ListNamespacesResponse, AWSError>;
  898. /**
  899. * Lists the namespaces for the specified Amazon Web Services account. This operation doesn't list deleted namespaces.
  900. */
  901. listNamespaces(callback?: (err: AWSError, data: QuickSight.Types.ListNamespacesResponse) => void): Request<QuickSight.Types.ListNamespacesResponse, AWSError>;
  902. /**
  903. * Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
  904. */
  905. listRefreshSchedules(params: QuickSight.Types.ListRefreshSchedulesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListRefreshSchedulesResponse) => void): Request<QuickSight.Types.ListRefreshSchedulesResponse, AWSError>;
  906. /**
  907. * Lists the refresh schedules of a dataset. Each dataset can have up to 5 schedules.
  908. */
  909. listRefreshSchedules(callback?: (err: AWSError, data: QuickSight.Types.ListRefreshSchedulesResponse) => void): Request<QuickSight.Types.ListRefreshSchedulesResponse, AWSError>;
  910. /**
  911. * Lists all groups that are associated with a role.
  912. */
  913. listRoleMemberships(params: QuickSight.Types.ListRoleMembershipsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListRoleMembershipsResponse) => void): Request<QuickSight.Types.ListRoleMembershipsResponse, AWSError>;
  914. /**
  915. * Lists all groups that are associated with a role.
  916. */
  917. listRoleMemberships(callback?: (err: AWSError, data: QuickSight.Types.ListRoleMembershipsResponse) => void): Request<QuickSight.Types.ListRoleMembershipsResponse, AWSError>;
  918. /**
  919. * Lists the tags assigned to a resource.
  920. */
  921. listTagsForResource(params: QuickSight.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTagsForResourceResponse) => void): Request<QuickSight.Types.ListTagsForResourceResponse, AWSError>;
  922. /**
  923. * Lists the tags assigned to a resource.
  924. */
  925. listTagsForResource(callback?: (err: AWSError, data: QuickSight.Types.ListTagsForResourceResponse) => void): Request<QuickSight.Types.ListTagsForResourceResponse, AWSError>;
  926. /**
  927. * Lists all the aliases of a template.
  928. */
  929. listTemplateAliases(params: QuickSight.Types.ListTemplateAliasesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTemplateAliasesResponse) => void): Request<QuickSight.Types.ListTemplateAliasesResponse, AWSError>;
  930. /**
  931. * Lists all the aliases of a template.
  932. */
  933. listTemplateAliases(callback?: (err: AWSError, data: QuickSight.Types.ListTemplateAliasesResponse) => void): Request<QuickSight.Types.ListTemplateAliasesResponse, AWSError>;
  934. /**
  935. * Lists all the versions of the templates in the current Amazon QuickSight account.
  936. */
  937. listTemplateVersions(params: QuickSight.Types.ListTemplateVersionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTemplateVersionsResponse) => void): Request<QuickSight.Types.ListTemplateVersionsResponse, AWSError>;
  938. /**
  939. * Lists all the versions of the templates in the current Amazon QuickSight account.
  940. */
  941. listTemplateVersions(callback?: (err: AWSError, data: QuickSight.Types.ListTemplateVersionsResponse) => void): Request<QuickSight.Types.ListTemplateVersionsResponse, AWSError>;
  942. /**
  943. * Lists all the templates in the current Amazon QuickSight account.
  944. */
  945. listTemplates(params: QuickSight.Types.ListTemplatesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTemplatesResponse) => void): Request<QuickSight.Types.ListTemplatesResponse, AWSError>;
  946. /**
  947. * Lists all the templates in the current Amazon QuickSight account.
  948. */
  949. listTemplates(callback?: (err: AWSError, data: QuickSight.Types.ListTemplatesResponse) => void): Request<QuickSight.Types.ListTemplatesResponse, AWSError>;
  950. /**
  951. * Lists all the aliases of a theme.
  952. */
  953. listThemeAliases(params: QuickSight.Types.ListThemeAliasesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListThemeAliasesResponse) => void): Request<QuickSight.Types.ListThemeAliasesResponse, AWSError>;
  954. /**
  955. * Lists all the aliases of a theme.
  956. */
  957. listThemeAliases(callback?: (err: AWSError, data: QuickSight.Types.ListThemeAliasesResponse) => void): Request<QuickSight.Types.ListThemeAliasesResponse, AWSError>;
  958. /**
  959. * Lists all the versions of the themes in the current Amazon Web Services account.
  960. */
  961. listThemeVersions(params: QuickSight.Types.ListThemeVersionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListThemeVersionsResponse) => void): Request<QuickSight.Types.ListThemeVersionsResponse, AWSError>;
  962. /**
  963. * Lists all the versions of the themes in the current Amazon Web Services account.
  964. */
  965. listThemeVersions(callback?: (err: AWSError, data: QuickSight.Types.ListThemeVersionsResponse) => void): Request<QuickSight.Types.ListThemeVersionsResponse, AWSError>;
  966. /**
  967. * Lists all the themes in the current Amazon Web Services account.
  968. */
  969. listThemes(params: QuickSight.Types.ListThemesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListThemesResponse) => void): Request<QuickSight.Types.ListThemesResponse, AWSError>;
  970. /**
  971. * Lists all the themes in the current Amazon Web Services account.
  972. */
  973. listThemes(callback?: (err: AWSError, data: QuickSight.Types.ListThemesResponse) => void): Request<QuickSight.Types.ListThemesResponse, AWSError>;
  974. /**
  975. * Lists all of the refresh schedules for a topic.
  976. */
  977. listTopicRefreshSchedules(params: QuickSight.Types.ListTopicRefreshSchedulesRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTopicRefreshSchedulesResponse) => void): Request<QuickSight.Types.ListTopicRefreshSchedulesResponse, AWSError>;
  978. /**
  979. * Lists all of the refresh schedules for a topic.
  980. */
  981. listTopicRefreshSchedules(callback?: (err: AWSError, data: QuickSight.Types.ListTopicRefreshSchedulesResponse) => void): Request<QuickSight.Types.ListTopicRefreshSchedulesResponse, AWSError>;
  982. /**
  983. * Lists all of the topics within an account.
  984. */
  985. listTopics(params: QuickSight.Types.ListTopicsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListTopicsResponse) => void): Request<QuickSight.Types.ListTopicsResponse, AWSError>;
  986. /**
  987. * Lists all of the topics within an account.
  988. */
  989. listTopics(callback?: (err: AWSError, data: QuickSight.Types.ListTopicsResponse) => void): Request<QuickSight.Types.ListTopicsResponse, AWSError>;
  990. /**
  991. * Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
  992. */
  993. listUserGroups(params: QuickSight.Types.ListUserGroupsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListUserGroupsResponse) => void): Request<QuickSight.Types.ListUserGroupsResponse, AWSError>;
  994. /**
  995. * Lists the Amazon QuickSight groups that an Amazon QuickSight user is a member of.
  996. */
  997. listUserGroups(callback?: (err: AWSError, data: QuickSight.Types.ListUserGroupsResponse) => void): Request<QuickSight.Types.ListUserGroupsResponse, AWSError>;
  998. /**
  999. * Returns a list of all of the Amazon QuickSight users belonging to this account.
  1000. */
  1001. listUsers(params: QuickSight.Types.ListUsersRequest, callback?: (err: AWSError, data: QuickSight.Types.ListUsersResponse) => void): Request<QuickSight.Types.ListUsersResponse, AWSError>;
  1002. /**
  1003. * Returns a list of all of the Amazon QuickSight users belonging to this account.
  1004. */
  1005. listUsers(callback?: (err: AWSError, data: QuickSight.Types.ListUsersResponse) => void): Request<QuickSight.Types.ListUsersResponse, AWSError>;
  1006. /**
  1007. * Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
  1008. */
  1009. listVPCConnections(params: QuickSight.Types.ListVPCConnectionsRequest, callback?: (err: AWSError, data: QuickSight.Types.ListVPCConnectionsResponse) => void): Request<QuickSight.Types.ListVPCConnectionsResponse, AWSError>;
  1010. /**
  1011. * Lists all of the VPC connections in the current set Amazon Web Services Region of an Amazon Web Services account.
  1012. */
  1013. listVPCConnections(callback?: (err: AWSError, data: QuickSight.Types.ListVPCConnectionsResponse) => void): Request<QuickSight.Types.ListVPCConnectionsResponse, AWSError>;
  1014. /**
  1015. * Creates or updates the dataset refresh properties for the dataset.
  1016. */
  1017. putDataSetRefreshProperties(params: QuickSight.Types.PutDataSetRefreshPropertiesRequest, callback?: (err: AWSError, data: QuickSight.Types.PutDataSetRefreshPropertiesResponse) => void): Request<QuickSight.Types.PutDataSetRefreshPropertiesResponse, AWSError>;
  1018. /**
  1019. * Creates or updates the dataset refresh properties for the dataset.
  1020. */
  1021. putDataSetRefreshProperties(callback?: (err: AWSError, data: QuickSight.Types.PutDataSetRefreshPropertiesResponse) => void): Request<QuickSight.Types.PutDataSetRefreshPropertiesResponse, AWSError>;
  1022. /**
  1023. * Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.
  1024. */
  1025. registerUser(params: QuickSight.Types.RegisterUserRequest, callback?: (err: AWSError, data: QuickSight.Types.RegisterUserResponse) => void): Request<QuickSight.Types.RegisterUserResponse, AWSError>;
  1026. /**
  1027. * Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.
  1028. */
  1029. registerUser(callback?: (err: AWSError, data: QuickSight.Types.RegisterUserResponse) => void): Request<QuickSight.Types.RegisterUserResponse, AWSError>;
  1030. /**
  1031. * Restores an analysis.
  1032. */
  1033. restoreAnalysis(params: QuickSight.Types.RestoreAnalysisRequest, callback?: (err: AWSError, data: QuickSight.Types.RestoreAnalysisResponse) => void): Request<QuickSight.Types.RestoreAnalysisResponse, AWSError>;
  1034. /**
  1035. * Restores an analysis.
  1036. */
  1037. restoreAnalysis(callback?: (err: AWSError, data: QuickSight.Types.RestoreAnalysisResponse) => void): Request<QuickSight.Types.RestoreAnalysisResponse, AWSError>;
  1038. /**
  1039. * Searches for analyses that belong to the user specified in the filter. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
  1040. */
  1041. searchAnalyses(params: QuickSight.Types.SearchAnalysesRequest, callback?: (err: AWSError, data: QuickSight.Types.SearchAnalysesResponse) => void): Request<QuickSight.Types.SearchAnalysesResponse, AWSError>;
  1042. /**
  1043. * Searches for analyses that belong to the user specified in the filter. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
  1044. */
  1045. searchAnalyses(callback?: (err: AWSError, data: QuickSight.Types.SearchAnalysesResponse) => void): Request<QuickSight.Types.SearchAnalysesResponse, AWSError>;
  1046. /**
  1047. * Searches for dashboards that belong to a user. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
  1048. */
  1049. searchDashboards(params: QuickSight.Types.SearchDashboardsRequest, callback?: (err: AWSError, data: QuickSight.Types.SearchDashboardsResponse) => void): Request<QuickSight.Types.SearchDashboardsResponse, AWSError>;
  1050. /**
  1051. * Searches for dashboards that belong to a user. This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.
  1052. */
  1053. searchDashboards(callback?: (err: AWSError, data: QuickSight.Types.SearchDashboardsResponse) => void): Request<QuickSight.Types.SearchDashboardsResponse, AWSError>;
  1054. /**
  1055. * Use the SearchDataSets operation to search for datasets that belong to an account.
  1056. */
  1057. searchDataSets(params: QuickSight.Types.SearchDataSetsRequest, callback?: (err: AWSError, data: QuickSight.Types.SearchDataSetsResponse) => void): Request<QuickSight.Types.SearchDataSetsResponse, AWSError>;
  1058. /**
  1059. * Use the SearchDataSets operation to search for datasets that belong to an account.
  1060. */
  1061. searchDataSets(callback?: (err: AWSError, data: QuickSight.Types.SearchDataSetsResponse) => void): Request<QuickSight.Types.SearchDataSetsResponse, AWSError>;
  1062. /**
  1063. * Use the SearchDataSources operation to search for data sources that belong to an account.
  1064. */
  1065. searchDataSources(params: QuickSight.Types.SearchDataSourcesRequest, callback?: (err: AWSError, data: QuickSight.Types.SearchDataSourcesResponse) => void): Request<QuickSight.Types.SearchDataSourcesResponse, AWSError>;
  1066. /**
  1067. * Use the SearchDataSources operation to search for data sources that belong to an account.
  1068. */
  1069. searchDataSources(callback?: (err: AWSError, data: QuickSight.Types.SearchDataSourcesResponse) => void): Request<QuickSight.Types.SearchDataSourcesResponse, AWSError>;
  1070. /**
  1071. * Searches the subfolders in a folder.
  1072. */
  1073. searchFolders(params: QuickSight.Types.SearchFoldersRequest, callback?: (err: AWSError, data: QuickSight.Types.SearchFoldersResponse) => void): Request<QuickSight.Types.SearchFoldersResponse, AWSError>;
  1074. /**
  1075. * Searches the subfolders in a folder.
  1076. */
  1077. searchFolders(callback?: (err: AWSError, data: QuickSight.Types.SearchFoldersResponse) => void): Request<QuickSight.Types.SearchFoldersResponse, AWSError>;
  1078. /**
  1079. * Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.
  1080. */
  1081. searchGroups(params: QuickSight.Types.SearchGroupsRequest, callback?: (err: AWSError, data: QuickSight.Types.SearchGroupsResponse) => void): Request<QuickSight.Types.SearchGroupsResponse, AWSError>;
  1082. /**
  1083. * Use the SearchGroups operation to search groups in a specified Amazon QuickSight namespace using the supplied filters.
  1084. */
  1085. searchGroups(callback?: (err: AWSError, data: QuickSight.Types.SearchGroupsResponse) => void): Request<QuickSight.Types.SearchGroupsResponse, AWSError>;
  1086. /**
  1087. * Starts an Asset Bundle export job. An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently. The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
  1088. */
  1089. startAssetBundleExportJob(params: QuickSight.Types.StartAssetBundleExportJobRequest, callback?: (err: AWSError, data: QuickSight.Types.StartAssetBundleExportJobResponse) => void): Request<QuickSight.Types.StartAssetBundleExportJobResponse, AWSError>;
  1090. /**
  1091. * Starts an Asset Bundle export job. An Asset Bundle export job exports specified Amazon QuickSight assets. You can also choose to export any asset dependencies in the same job. Export jobs run asynchronously and can be polled with a DescribeAssetBundleExportJob API call. When a job is successfully completed, a download URL that contains the exported assets is returned. The URL is valid for 5 minutes and can be refreshed with a DescribeAssetBundleExportJob API call. Each Amazon QuickSight account can run up to 5 export jobs concurrently. The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
  1092. */
  1093. startAssetBundleExportJob(callback?: (err: AWSError, data: QuickSight.Types.StartAssetBundleExportJobResponse) => void): Request<QuickSight.Types.StartAssetBundleExportJobResponse, AWSError>;
  1094. /**
  1095. * Starts an Asset Bundle import job. An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently. The API caller must have the necessary "create", "describe", and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
  1096. */
  1097. startAssetBundleImportJob(params: QuickSight.Types.StartAssetBundleImportJobRequest, callback?: (err: AWSError, data: QuickSight.Types.StartAssetBundleImportJobResponse) => void): Request<QuickSight.Types.StartAssetBundleImportJobResponse, AWSError>;
  1098. /**
  1099. * Starts an Asset Bundle import job. An Asset Bundle import job imports specified Amazon QuickSight assets into an Amazon QuickSight account. You can also choose to import a naming prefix and specified configuration overrides. The assets that are contained in the bundle file that you provide are used to create or update a new or existing asset in your Amazon QuickSight account. Each Amazon QuickSight account can run up to 5 import jobs concurrently. The API caller must have the necessary "create", "describe", and "update" permissions in their IAM role to access each resource type that is contained in the bundle file before the resources can be imported.
  1100. */
  1101. startAssetBundleImportJob(callback?: (err: AWSError, data: QuickSight.Types.StartAssetBundleImportJobResponse) => void): Request<QuickSight.Types.StartAssetBundleImportJobResponse, AWSError>;
  1102. /**
  1103. * Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call. 1 Paginated PDF 1 Excel workbook that includes up to 5 table or pivot table visuals 5 CSVs from table or pivot table visuals The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred. StartDashboardSnapshotJob API throttling Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users. Common throttling scenarios The following list provides information about the most commin throttling scenarios that can occur. A large number of SnapshotExport API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job. A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a ThrottlingException is returned. If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account. Best practices to handle throttling If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline. The time that it takes to process a job can be impacted by the following factors: The dataset type (Direct Query or SPICE). The size of the dataset. The complexity of the calculated fields that are used in the dashboard. The number of visuals that are on a sheet. The types of visuals that are on the sheet. The number of formats and snapshots that are requested in the job configuration. The size of the generated snapshots.
  1104. */
  1105. startDashboardSnapshotJob(params: QuickSight.Types.StartDashboardSnapshotJobRequest, callback?: (err: AWSError, data: QuickSight.Types.StartDashboardSnapshotJobResponse) => void): Request<QuickSight.Types.StartDashboardSnapshotJobResponse, AWSError>;
  1106. /**
  1107. * Starts an asynchronous job that generates a snapshot of a dashboard's output. You can request one or several of the following format configurations in each API call. 1 Paginated PDF 1 Excel workbook that includes up to 5 table or pivot table visuals 5 CSVs from table or pivot table visuals The status of a submitted job can be polled with the DescribeDashboardSnapshotJob API. When you call the DescribeDashboardSnapshotJob API, check the JobStatus field in the response. Once the job reaches a COMPLETED or FAILED status, use the DescribeDashboardSnapshotJobResult API to obtain the URLs for the generated files. If the job fails, the DescribeDashboardSnapshotJobResult API returns detailed information about the error that occurred. StartDashboardSnapshotJob API throttling Amazon QuickSight utilizes API throttling to create a more consistent user experience within a time span for customers when they call the StartDashboardSnapshotJob. By default, 12 jobs can run simlutaneously in one Amazon Web Services account and users can submit up 10 API requests per second before an account is throttled. If an overwhelming number of API requests are made by the same user in a short period of time, Amazon QuickSight throttles the API calls to maintin an optimal experience and reliability for all Amazon QuickSight users. Common throttling scenarios The following list provides information about the most commin throttling scenarios that can occur. A large number of SnapshotExport API jobs are running simultaneously on an Amazon Web Services account. When a new StartDashboardSnapshotJob is created and there are already 12 jobs with the RUNNING status, the new job request fails and returns a LimitExceededException error. Wait for a current job to comlpete before you resubmit the new job. A large number of API requests are submitted on an Amazon Web Services account. When a user makes more than 10 API calls to the Amazon QuickSight API in one second, a ThrottlingException is returned. If your use case requires a higher throttling limit, contact your account admin or Amazon Web ServicesSupport to explore options to tailor a more optimal expereince for your account. Best practices to handle throttling If your use case projects high levels of API traffic, try to reduce the degree of frequency and parallelism of API calls as much as you can to avoid throttling. You can also perform a timing test to calculate an estimate for the total processing time of your projected load that stays within the throttling limits of the Amazon QuickSight APIs. For example, if your projected traffic is 100 snapshot jobs before 12:00 PM per day, start 12 jobs in parallel and measure the amount of time it takes to proccess all 12 jobs. Once you obtain the result, multiply the duration by 9, for example (12 minutes * 9 = 108 minutes). Use the new result to determine the latest time at which the jobs need to be started to meet your target deadline. The time that it takes to process a job can be impacted by the following factors: The dataset type (Direct Query or SPICE). The size of the dataset. The complexity of the calculated fields that are used in the dashboard. The number of visuals that are on a sheet. The types of visuals that are on the sheet. The number of formats and snapshots that are requested in the job configuration. The size of the generated snapshots.
  1108. */
  1109. startDashboardSnapshotJob(callback?: (err: AWSError, data: QuickSight.Types.StartDashboardSnapshotJobResponse) => void): Request<QuickSight.Types.StartDashboardSnapshotJobResponse, AWSError>;
  1110. /**
  1111. * Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, topic, and user. Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following: Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units. Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
  1112. */
  1113. tagResource(params: QuickSight.Types.TagResourceRequest, callback?: (err: AWSError, data: QuickSight.Types.TagResourceResponse) => void): Request<QuickSight.Types.TagResourceResponse, AWSError>;
  1114. /**
  1115. * Assigns one or more tags (key-value pairs) to the specified Amazon QuickSight resource. Tags can help you organize and categorize your resources. You can also use them to scope user permissions, by granting a user permission to access or change only resources with certain tag values. You can use the TagResource operation with a resource that already has tags. If you specify a new tag key for the resource, this tag is appended to the list of tags associated with the resource. If you specify a tag key that is already associated with the resource, the new tag value that you specify replaces the previous value for that tag. You can associate as many as 50 tags with a resource. Amazon QuickSight supports tagging on data set, data source, dashboard, template, topic, and user. Tagging for Amazon QuickSight works in a similar way to tagging for other Amazon Web Services services, except for the following: Tags are used to track costs for users in Amazon QuickSight. You can't tag other resources that Amazon QuickSight costs are based on, such as storage capacoty (SPICE), session usage, alert consumption, or reporting units. Amazon QuickSight doesn't currently support the tag editor for Resource Groups.
  1116. */
  1117. tagResource(callback?: (err: AWSError, data: QuickSight.Types.TagResourceResponse) => void): Request<QuickSight.Types.TagResourceResponse, AWSError>;
  1118. /**
  1119. * Removes a tag or tags from a resource.
  1120. */
  1121. untagResource(params: QuickSight.Types.UntagResourceRequest, callback?: (err: AWSError, data: QuickSight.Types.UntagResourceResponse) => void): Request<QuickSight.Types.UntagResourceResponse, AWSError>;
  1122. /**
  1123. * Removes a tag or tags from a resource.
  1124. */
  1125. untagResource(callback?: (err: AWSError, data: QuickSight.Types.UntagResourceResponse) => void): Request<QuickSight.Types.UntagResourceResponse, AWSError>;
  1126. /**
  1127. * Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
  1128. */
  1129. updateAccountCustomization(params: QuickSight.Types.UpdateAccountCustomizationRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateAccountCustomizationResponse) => void): Request<QuickSight.Types.UpdateAccountCustomizationResponse, AWSError>;
  1130. /**
  1131. * Updates Amazon QuickSight customizations for the current Amazon Web Services Region. Currently, the only customization that you can use is a theme. You can use customizations for your Amazon Web Services account or, if you specify a namespace, for a Amazon QuickSight namespace instead. Customizations that apply to a namespace override customizations that apply to an Amazon Web Services account. To find out which customizations apply, use the DescribeAccountCustomization API operation.
  1132. */
  1133. updateAccountCustomization(callback?: (err: AWSError, data: QuickSight.Types.UpdateAccountCustomizationResponse) => void): Request<QuickSight.Types.UpdateAccountCustomizationResponse, AWSError>;
  1134. /**
  1135. * Updates the Amazon QuickSight settings in your Amazon Web Services account.
  1136. */
  1137. updateAccountSettings(params: QuickSight.Types.UpdateAccountSettingsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateAccountSettingsResponse) => void): Request<QuickSight.Types.UpdateAccountSettingsResponse, AWSError>;
  1138. /**
  1139. * Updates the Amazon QuickSight settings in your Amazon Web Services account.
  1140. */
  1141. updateAccountSettings(callback?: (err: AWSError, data: QuickSight.Types.UpdateAccountSettingsResponse) => void): Request<QuickSight.Types.UpdateAccountSettingsResponse, AWSError>;
  1142. /**
  1143. * Updates an analysis in Amazon QuickSight
  1144. */
  1145. updateAnalysis(params: QuickSight.Types.UpdateAnalysisRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateAnalysisResponse) => void): Request<QuickSight.Types.UpdateAnalysisResponse, AWSError>;
  1146. /**
  1147. * Updates an analysis in Amazon QuickSight
  1148. */
  1149. updateAnalysis(callback?: (err: AWSError, data: QuickSight.Types.UpdateAnalysisResponse) => void): Request<QuickSight.Types.UpdateAnalysisResponse, AWSError>;
  1150. /**
  1151. * Updates the read and write permissions for an analysis.
  1152. */
  1153. updateAnalysisPermissions(params: QuickSight.Types.UpdateAnalysisPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateAnalysisPermissionsResponse) => void): Request<QuickSight.Types.UpdateAnalysisPermissionsResponse, AWSError>;
  1154. /**
  1155. * Updates the read and write permissions for an analysis.
  1156. */
  1157. updateAnalysisPermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateAnalysisPermissionsResponse) => void): Request<QuickSight.Types.UpdateAnalysisPermissionsResponse, AWSError>;
  1158. /**
  1159. * Updates a dashboard in an Amazon Web Services account. Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.
  1160. */
  1161. updateDashboard(params: QuickSight.Types.UpdateDashboardRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardResponse) => void): Request<QuickSight.Types.UpdateDashboardResponse, AWSError>;
  1162. /**
  1163. * Updates a dashboard in an Amazon Web Services account. Updating a Dashboard creates a new dashboard version but does not immediately publish the new version. You can update the published version of a dashboard by using the UpdateDashboardPublishedVersion API operation.
  1164. */
  1165. updateDashboard(callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardResponse) => void): Request<QuickSight.Types.UpdateDashboardResponse, AWSError>;
  1166. /**
  1167. * Updates the linked analyses on a dashboard.
  1168. */
  1169. updateDashboardLinks(params: QuickSight.Types.UpdateDashboardLinksRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardLinksResponse) => void): Request<QuickSight.Types.UpdateDashboardLinksResponse, AWSError>;
  1170. /**
  1171. * Updates the linked analyses on a dashboard.
  1172. */
  1173. updateDashboardLinks(callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardLinksResponse) => void): Request<QuickSight.Types.UpdateDashboardLinksResponse, AWSError>;
  1174. /**
  1175. * Updates read and write permissions on a dashboard.
  1176. */
  1177. updateDashboardPermissions(params: QuickSight.Types.UpdateDashboardPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardPermissionsResponse) => void): Request<QuickSight.Types.UpdateDashboardPermissionsResponse, AWSError>;
  1178. /**
  1179. * Updates read and write permissions on a dashboard.
  1180. */
  1181. updateDashboardPermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardPermissionsResponse) => void): Request<QuickSight.Types.UpdateDashboardPermissionsResponse, AWSError>;
  1182. /**
  1183. * Updates the published version of a dashboard.
  1184. */
  1185. updateDashboardPublishedVersion(params: QuickSight.Types.UpdateDashboardPublishedVersionRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardPublishedVersionResponse) => void): Request<QuickSight.Types.UpdateDashboardPublishedVersionResponse, AWSError>;
  1186. /**
  1187. * Updates the published version of a dashboard.
  1188. */
  1189. updateDashboardPublishedVersion(callback?: (err: AWSError, data: QuickSight.Types.UpdateDashboardPublishedVersionResponse) => void): Request<QuickSight.Types.UpdateDashboardPublishedVersionResponse, AWSError>;
  1190. /**
  1191. * Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
  1192. */
  1193. updateDataSet(params: QuickSight.Types.UpdateDataSetRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSetResponse) => void): Request<QuickSight.Types.UpdateDataSetResponse, AWSError>;
  1194. /**
  1195. * Updates a dataset. This operation doesn't support datasets that include uploaded files as a source. Partial updates are not supported by this operation.
  1196. */
  1197. updateDataSet(callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSetResponse) => void): Request<QuickSight.Types.UpdateDataSetResponse, AWSError>;
  1198. /**
  1199. * Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
  1200. */
  1201. updateDataSetPermissions(params: QuickSight.Types.UpdateDataSetPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSetPermissionsResponse) => void): Request<QuickSight.Types.UpdateDataSetPermissionsResponse, AWSError>;
  1202. /**
  1203. * Updates the permissions on a dataset. The permissions resource is arn:aws:quicksight:region:aws-account-id:dataset/data-set-id.
  1204. */
  1205. updateDataSetPermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSetPermissionsResponse) => void): Request<QuickSight.Types.UpdateDataSetPermissionsResponse, AWSError>;
  1206. /**
  1207. * Updates a data source.
  1208. */
  1209. updateDataSource(params: QuickSight.Types.UpdateDataSourceRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSourceResponse) => void): Request<QuickSight.Types.UpdateDataSourceResponse, AWSError>;
  1210. /**
  1211. * Updates a data source.
  1212. */
  1213. updateDataSource(callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSourceResponse) => void): Request<QuickSight.Types.UpdateDataSourceResponse, AWSError>;
  1214. /**
  1215. * Updates the permissions to a data source.
  1216. */
  1217. updateDataSourcePermissions(params: QuickSight.Types.UpdateDataSourcePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSourcePermissionsResponse) => void): Request<QuickSight.Types.UpdateDataSourcePermissionsResponse, AWSError>;
  1218. /**
  1219. * Updates the permissions to a data source.
  1220. */
  1221. updateDataSourcePermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateDataSourcePermissionsResponse) => void): Request<QuickSight.Types.UpdateDataSourcePermissionsResponse, AWSError>;
  1222. /**
  1223. * Updates the name of a folder.
  1224. */
  1225. updateFolder(params: QuickSight.Types.UpdateFolderRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateFolderResponse) => void): Request<QuickSight.Types.UpdateFolderResponse, AWSError>;
  1226. /**
  1227. * Updates the name of a folder.
  1228. */
  1229. updateFolder(callback?: (err: AWSError, data: QuickSight.Types.UpdateFolderResponse) => void): Request<QuickSight.Types.UpdateFolderResponse, AWSError>;
  1230. /**
  1231. * Updates permissions of a folder.
  1232. */
  1233. updateFolderPermissions(params: QuickSight.Types.UpdateFolderPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateFolderPermissionsResponse) => void): Request<QuickSight.Types.UpdateFolderPermissionsResponse, AWSError>;
  1234. /**
  1235. * Updates permissions of a folder.
  1236. */
  1237. updateFolderPermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateFolderPermissionsResponse) => void): Request<QuickSight.Types.UpdateFolderPermissionsResponse, AWSError>;
  1238. /**
  1239. * Changes a group description.
  1240. */
  1241. updateGroup(params: QuickSight.Types.UpdateGroupRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateGroupResponse) => void): Request<QuickSight.Types.UpdateGroupResponse, AWSError>;
  1242. /**
  1243. * Changes a group description.
  1244. */
  1245. updateGroup(callback?: (err: AWSError, data: QuickSight.Types.UpdateGroupResponse) => void): Request<QuickSight.Types.UpdateGroupResponse, AWSError>;
  1246. /**
  1247. * Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.
  1248. */
  1249. updateIAMPolicyAssignment(params: QuickSight.Types.UpdateIAMPolicyAssignmentRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.UpdateIAMPolicyAssignmentResponse, AWSError>;
  1250. /**
  1251. * Updates an existing IAM policy assignment. This operation updates only the optional parameter or parameters that are specified in the request. This overwrites all of the users included in Identities.
  1252. */
  1253. updateIAMPolicyAssignment(callback?: (err: AWSError, data: QuickSight.Types.UpdateIAMPolicyAssignmentResponse) => void): Request<QuickSight.Types.UpdateIAMPolicyAssignmentResponse, AWSError>;
  1254. /**
  1255. * Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access. This operation is only supported for Amazon QuickSight accounts using IAM Identity Center
  1256. */
  1257. updateIdentityPropagationConfig(params: QuickSight.Types.UpdateIdentityPropagationConfigRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateIdentityPropagationConfigResponse) => void): Request<QuickSight.Types.UpdateIdentityPropagationConfigResponse, AWSError>;
  1258. /**
  1259. * Adds or updates services and authorized targets to configure what the Amazon QuickSight IAM Identity Center application can access. This operation is only supported for Amazon QuickSight accounts using IAM Identity Center
  1260. */
  1261. updateIdentityPropagationConfig(callback?: (err: AWSError, data: QuickSight.Types.UpdateIdentityPropagationConfigResponse) => void): Request<QuickSight.Types.UpdateIdentityPropagationConfigResponse, AWSError>;
  1262. /**
  1263. * Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.
  1264. */
  1265. updateIpRestriction(params: QuickSight.Types.UpdateIpRestrictionRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateIpRestrictionResponse) => void): Request<QuickSight.Types.UpdateIpRestrictionResponse, AWSError>;
  1266. /**
  1267. * Updates the content and status of IP rules. Traffic from a source is allowed when the source satisfies either the IpRestrictionRule, VpcIdRestrictionRule, or VpcEndpointIdRestrictionRule. To use this operation, you must provide the entire map of rules. You can use the DescribeIpRestriction operation to get the current rule map.
  1268. */
  1269. updateIpRestriction(callback?: (err: AWSError, data: QuickSight.Types.UpdateIpRestrictionResponse) => void): Request<QuickSight.Types.UpdateIpRestrictionResponse, AWSError>;
  1270. /**
  1271. * Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard. To use this operation, turn on session capacity pricing for your Amazon QuickSight account. Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
  1272. */
  1273. updatePublicSharingSettings(params: QuickSight.Types.UpdatePublicSharingSettingsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdatePublicSharingSettingsResponse) => void): Request<QuickSight.Types.UpdatePublicSharingSettingsResponse, AWSError>;
  1274. /**
  1275. * Use the UpdatePublicSharingSettings operation to turn on or turn off the public sharing settings of an Amazon QuickSight dashboard. To use this operation, turn on session capacity pricing for your Amazon QuickSight account. Before you can turn on public sharing on your account, make sure to give public sharing permissions to an administrative user in the Identity and Access Management (IAM) console. For more information on using IAM with Amazon QuickSight, see Using Amazon QuickSight with IAM in the Amazon QuickSight User Guide.
  1276. */
  1277. updatePublicSharingSettings(callback?: (err: AWSError, data: QuickSight.Types.UpdatePublicSharingSettingsResponse) => void): Request<QuickSight.Types.UpdatePublicSharingSettingsResponse, AWSError>;
  1278. /**
  1279. * Updates a refresh schedule for a dataset.
  1280. */
  1281. updateRefreshSchedule(params: QuickSight.Types.UpdateRefreshScheduleRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateRefreshScheduleResponse) => void): Request<QuickSight.Types.UpdateRefreshScheduleResponse, AWSError>;
  1282. /**
  1283. * Updates a refresh schedule for a dataset.
  1284. */
  1285. updateRefreshSchedule(callback?: (err: AWSError, data: QuickSight.Types.UpdateRefreshScheduleResponse) => void): Request<QuickSight.Types.UpdateRefreshScheduleResponse, AWSError>;
  1286. /**
  1287. * Updates the custom permissions that are associated with a role.
  1288. */
  1289. updateRoleCustomPermission(params: QuickSight.Types.UpdateRoleCustomPermissionRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateRoleCustomPermissionResponse) => void): Request<QuickSight.Types.UpdateRoleCustomPermissionResponse, AWSError>;
  1290. /**
  1291. * Updates the custom permissions that are associated with a role.
  1292. */
  1293. updateRoleCustomPermission(callback?: (err: AWSError, data: QuickSight.Types.UpdateRoleCustomPermissionResponse) => void): Request<QuickSight.Types.UpdateRoleCustomPermissionResponse, AWSError>;
  1294. /**
  1295. * Updates the SPICE capacity configuration for a Amazon QuickSight account.
  1296. */
  1297. updateSPICECapacityConfiguration(params: QuickSight.Types.UpdateSPICECapacityConfigurationRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateSPICECapacityConfigurationResponse) => void): Request<QuickSight.Types.UpdateSPICECapacityConfigurationResponse, AWSError>;
  1298. /**
  1299. * Updates the SPICE capacity configuration for a Amazon QuickSight account.
  1300. */
  1301. updateSPICECapacityConfiguration(callback?: (err: AWSError, data: QuickSight.Types.UpdateSPICECapacityConfigurationResponse) => void): Request<QuickSight.Types.UpdateSPICECapacityConfigurationResponse, AWSError>;
  1302. /**
  1303. * Updates a template from an existing Amazon QuickSight analysis or another template.
  1304. */
  1305. updateTemplate(params: QuickSight.Types.UpdateTemplateRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateResponse) => void): Request<QuickSight.Types.UpdateTemplateResponse, AWSError>;
  1306. /**
  1307. * Updates a template from an existing Amazon QuickSight analysis or another template.
  1308. */
  1309. updateTemplate(callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateResponse) => void): Request<QuickSight.Types.UpdateTemplateResponse, AWSError>;
  1310. /**
  1311. * Updates the template alias of a template.
  1312. */
  1313. updateTemplateAlias(params: QuickSight.Types.UpdateTemplateAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateAliasResponse) => void): Request<QuickSight.Types.UpdateTemplateAliasResponse, AWSError>;
  1314. /**
  1315. * Updates the template alias of a template.
  1316. */
  1317. updateTemplateAlias(callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplateAliasResponse) => void): Request<QuickSight.Types.UpdateTemplateAliasResponse, AWSError>;
  1318. /**
  1319. * Updates the resource permissions for a template.
  1320. */
  1321. updateTemplatePermissions(params: QuickSight.Types.UpdateTemplatePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplatePermissionsResponse) => void): Request<QuickSight.Types.UpdateTemplatePermissionsResponse, AWSError>;
  1322. /**
  1323. * Updates the resource permissions for a template.
  1324. */
  1325. updateTemplatePermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateTemplatePermissionsResponse) => void): Request<QuickSight.Types.UpdateTemplatePermissionsResponse, AWSError>;
  1326. /**
  1327. * Updates a theme.
  1328. */
  1329. updateTheme(params: QuickSight.Types.UpdateThemeRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateThemeResponse) => void): Request<QuickSight.Types.UpdateThemeResponse, AWSError>;
  1330. /**
  1331. * Updates a theme.
  1332. */
  1333. updateTheme(callback?: (err: AWSError, data: QuickSight.Types.UpdateThemeResponse) => void): Request<QuickSight.Types.UpdateThemeResponse, AWSError>;
  1334. /**
  1335. * Updates an alias of a theme.
  1336. */
  1337. updateThemeAlias(params: QuickSight.Types.UpdateThemeAliasRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateThemeAliasResponse) => void): Request<QuickSight.Types.UpdateThemeAliasResponse, AWSError>;
  1338. /**
  1339. * Updates an alias of a theme.
  1340. */
  1341. updateThemeAlias(callback?: (err: AWSError, data: QuickSight.Types.UpdateThemeAliasResponse) => void): Request<QuickSight.Types.UpdateThemeAliasResponse, AWSError>;
  1342. /**
  1343. * Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme". Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions: User "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" Owner "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" "quicksight:DeleteTheme" "quicksight:UpdateTheme" "quicksight:CreateThemeAlias" "quicksight:DeleteThemeAlias" "quicksight:UpdateThemeAlias" "quicksight:UpdateThemePermissions" "quicksight:DescribeThemePermissions" To specify no permissions, omit the permissions list.
  1344. */
  1345. updateThemePermissions(params: QuickSight.Types.UpdateThemePermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateThemePermissionsResponse) => void): Request<QuickSight.Types.UpdateThemePermissionsResponse, AWSError>;
  1346. /**
  1347. * Updates the resource permissions for a theme. Permissions apply to the action to grant or revoke permissions on, for example "quicksight:DescribeTheme". Theme permissions apply in groupings. Valid groupings include the following for the three levels of permissions, which are user, owner, or no permissions: User "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" Owner "quicksight:DescribeTheme" "quicksight:DescribeThemeAlias" "quicksight:ListThemeAliases" "quicksight:ListThemeVersions" "quicksight:DeleteTheme" "quicksight:UpdateTheme" "quicksight:CreateThemeAlias" "quicksight:DeleteThemeAlias" "quicksight:UpdateThemeAlias" "quicksight:UpdateThemePermissions" "quicksight:DescribeThemePermissions" To specify no permissions, omit the permissions list.
  1348. */
  1349. updateThemePermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateThemePermissionsResponse) => void): Request<QuickSight.Types.UpdateThemePermissionsResponse, AWSError>;
  1350. /**
  1351. * Updates a topic.
  1352. */
  1353. updateTopic(params: QuickSight.Types.UpdateTopicRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateTopicResponse) => void): Request<QuickSight.Types.UpdateTopicResponse, AWSError>;
  1354. /**
  1355. * Updates a topic.
  1356. */
  1357. updateTopic(callback?: (err: AWSError, data: QuickSight.Types.UpdateTopicResponse) => void): Request<QuickSight.Types.UpdateTopicResponse, AWSError>;
  1358. /**
  1359. * Updates the permissions of a topic.
  1360. */
  1361. updateTopicPermissions(params: QuickSight.Types.UpdateTopicPermissionsRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateTopicPermissionsResponse) => void): Request<QuickSight.Types.UpdateTopicPermissionsResponse, AWSError>;
  1362. /**
  1363. * Updates the permissions of a topic.
  1364. */
  1365. updateTopicPermissions(callback?: (err: AWSError, data: QuickSight.Types.UpdateTopicPermissionsResponse) => void): Request<QuickSight.Types.UpdateTopicPermissionsResponse, AWSError>;
  1366. /**
  1367. * Updates a topic refresh schedule.
  1368. */
  1369. updateTopicRefreshSchedule(params: QuickSight.Types.UpdateTopicRefreshScheduleRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateTopicRefreshScheduleResponse) => void): Request<QuickSight.Types.UpdateTopicRefreshScheduleResponse, AWSError>;
  1370. /**
  1371. * Updates a topic refresh schedule.
  1372. */
  1373. updateTopicRefreshSchedule(callback?: (err: AWSError, data: QuickSight.Types.UpdateTopicRefreshScheduleResponse) => void): Request<QuickSight.Types.UpdateTopicRefreshScheduleResponse, AWSError>;
  1374. /**
  1375. * Updates an Amazon QuickSight user.
  1376. */
  1377. updateUser(params: QuickSight.Types.UpdateUserRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateUserResponse) => void): Request<QuickSight.Types.UpdateUserResponse, AWSError>;
  1378. /**
  1379. * Updates an Amazon QuickSight user.
  1380. */
  1381. updateUser(callback?: (err: AWSError, data: QuickSight.Types.UpdateUserResponse) => void): Request<QuickSight.Types.UpdateUserResponse, AWSError>;
  1382. /**
  1383. * Updates a VPC connection.
  1384. */
  1385. updateVPCConnection(params: QuickSight.Types.UpdateVPCConnectionRequest, callback?: (err: AWSError, data: QuickSight.Types.UpdateVPCConnectionResponse) => void): Request<QuickSight.Types.UpdateVPCConnectionResponse, AWSError>;
  1386. /**
  1387. * Updates a VPC connection.
  1388. */
  1389. updateVPCConnection(callback?: (err: AWSError, data: QuickSight.Types.UpdateVPCConnectionResponse) => void): Request<QuickSight.Types.UpdateVPCConnectionResponse, AWSError>;
  1390. }
  1391. declare namespace QuickSight {
  1392. export interface AccountCustomization {
  1393. /**
  1394. * The default theme for this Amazon QuickSight subscription.
  1395. */
  1396. DefaultTheme?: Arn;
  1397. /**
  1398. * The default email customization template.
  1399. */
  1400. DefaultEmailCustomizationTemplate?: Arn;
  1401. }
  1402. export interface AccountInfo {
  1403. /**
  1404. * The account name that you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It's unique over all of Amazon Web Services, and it appears only when users sign in.
  1405. */
  1406. AccountName?: String;
  1407. /**
  1408. * The edition of your Amazon QuickSight account.
  1409. */
  1410. Edition?: Edition;
  1411. /**
  1412. * The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.
  1413. */
  1414. NotificationEmail?: String;
  1415. /**
  1416. * The way that your Amazon QuickSight account is authenticated.
  1417. */
  1418. AuthenticationType?: String;
  1419. /**
  1420. * The status of your account subscription.
  1421. */
  1422. AccountSubscriptionStatus?: String;
  1423. /**
  1424. * The Amazon Resource Name (ARN) for the IAM Identity Center instance.
  1425. */
  1426. IAMIdentityCenterInstanceArn?: String;
  1427. }
  1428. export type AccountName = string;
  1429. export interface AccountSettings {
  1430. /**
  1431. * The "account name" you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It is unique in all of Amazon Web Services and it appears only when users sign in.
  1432. */
  1433. AccountName?: String;
  1434. /**
  1435. * The edition of Amazon QuickSight that you're currently subscribed to: Enterprise edition or Standard edition.
  1436. */
  1437. Edition?: Edition;
  1438. /**
  1439. * The default Amazon QuickSight namespace for your Amazon Web Services account.
  1440. */
  1441. DefaultNamespace?: Namespace;
  1442. /**
  1443. * The main notification email for your Amazon QuickSight subscription.
  1444. */
  1445. NotificationEmail?: String;
  1446. /**
  1447. * A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account. For more information about turning on public sharing, see UpdatePublicSharingSettings.
  1448. */
  1449. PublicSharingEnabled?: Boolean;
  1450. /**
  1451. * A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubsctiption request. A False value will allow the ccount to be deleted.
  1452. */
  1453. TerminationProtectionEnabled?: Boolean;
  1454. }
  1455. export type ActionList = String[];
  1456. export interface ActiveIAMPolicyAssignment {
  1457. /**
  1458. * A name for the IAM policy assignment.
  1459. */
  1460. AssignmentName?: IAMPolicyAssignmentName;
  1461. /**
  1462. * The Amazon Resource Name (ARN) of the resource.
  1463. */
  1464. PolicyArn?: Arn;
  1465. }
  1466. export type ActiveIAMPolicyAssignmentList = ActiveIAMPolicyAssignment[];
  1467. export interface AdHocFilteringOption {
  1468. /**
  1469. * Availability status.
  1470. */
  1471. AvailabilityStatus?: DashboardBehavior;
  1472. }
  1473. export type AdditionalDashboardIdList = ShortRestrictiveResourceId[];
  1474. export interface AggregationFunction {
  1475. /**
  1476. * Aggregation for numerical values.
  1477. */
  1478. NumericalAggregationFunction?: NumericalAggregationFunction;
  1479. /**
  1480. * Aggregation for categorical values. COUNT: Aggregate by the total number of values, including duplicates. DISTINCT_COUNT: Aggregate by the total number of distinct values.
  1481. */
  1482. CategoricalAggregationFunction?: CategoricalAggregationFunction;
  1483. /**
  1484. * Aggregation for date values. COUNT: Aggregate by the total number of values, including duplicates. DISTINCT_COUNT: Aggregate by the total number of distinct values. MIN: Select the smallest date value. MAX: Select the largest date value.
  1485. */
  1486. DateAggregationFunction?: DateAggregationFunction;
  1487. /**
  1488. * Aggregation for attributes.
  1489. */
  1490. AttributeAggregationFunction?: AttributeAggregationFunction;
  1491. }
  1492. export type AggregationFunctionParameters = {[key: string]: LimitedString};
  1493. export interface AggregationSortConfiguration {
  1494. /**
  1495. * The column that determines the sort order of aggregated values.
  1496. */
  1497. Column: ColumnIdentifier;
  1498. /**
  1499. * The sort direction of values. ASC: Sort in ascending order. DESC: Sort in descending order.
  1500. */
  1501. SortDirection: SortDirection;
  1502. /**
  1503. * The function that aggregates the values in Column.
  1504. */
  1505. AggregationFunction?: AggregationFunction;
  1506. }
  1507. export type AggregationSortConfigurationList = AggregationSortConfiguration[];
  1508. export type AliasName = string;
  1509. export interface AllSheetsFilterScopeConfiguration {
  1510. }
  1511. export interface AmazonElasticsearchParameters {
  1512. /**
  1513. * The OpenSearch domain.
  1514. */
  1515. Domain: Domain;
  1516. }
  1517. export interface AmazonOpenSearchParameters {
  1518. /**
  1519. * The OpenSearch domain.
  1520. */
  1521. Domain: Domain;
  1522. }
  1523. export interface Analysis {
  1524. /**
  1525. * The ID of the analysis.
  1526. */
  1527. AnalysisId?: ShortRestrictiveResourceId;
  1528. /**
  1529. * The Amazon Resource Name (ARN) of the analysis.
  1530. */
  1531. Arn?: Arn;
  1532. /**
  1533. * The descriptive name of the analysis.
  1534. */
  1535. Name?: AnalysisName;
  1536. /**
  1537. * Status associated with the analysis.
  1538. */
  1539. Status?: ResourceStatus;
  1540. /**
  1541. * Errors associated with the analysis.
  1542. */
  1543. Errors?: AnalysisErrorList;
  1544. /**
  1545. * The ARNs of the datasets of the analysis.
  1546. */
  1547. DataSetArns?: DataSetArnsList;
  1548. /**
  1549. * The ARN of the theme of the analysis.
  1550. */
  1551. ThemeArn?: Arn;
  1552. /**
  1553. * The time that the analysis was created.
  1554. */
  1555. CreatedTime?: Timestamp;
  1556. /**
  1557. * The time that the analysis was last updated.
  1558. */
  1559. LastUpdatedTime?: Timestamp;
  1560. /**
  1561. * A list of the associated sheets with the unique identifier and name of each sheet.
  1562. */
  1563. Sheets?: SheetList;
  1564. }
  1565. export interface AnalysisDefaults {
  1566. /**
  1567. * The configuration for default new sheet settings.
  1568. */
  1569. DefaultNewSheetConfiguration: DefaultNewSheetConfiguration;
  1570. }
  1571. export interface AnalysisDefinition {
  1572. /**
  1573. * An array of dataset identifier declarations. This mapping allows the usage of dataset identifiers instead of dataset ARNs throughout analysis sub-structures.
  1574. */
  1575. DataSetIdentifierDeclarations: DataSetIdentifierDeclarationList;
  1576. /**
  1577. * An array of sheet definitions for an analysis. Each SheetDefinition provides detailed information about a sheet within this analysis.
  1578. */
  1579. Sheets?: SheetDefinitionList;
  1580. /**
  1581. * An array of calculated field definitions for the analysis.
  1582. */
  1583. CalculatedFields?: CalculatedFields;
  1584. /**
  1585. * An array of parameter declarations for an analysis. Parameters are named variables that can transfer a value for use by an action or an object. For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
  1586. */
  1587. ParameterDeclarations?: ParameterDeclarationList;
  1588. /**
  1589. * Filter definitions for an analysis. For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
  1590. */
  1591. FilterGroups?: FilterGroupList;
  1592. /**
  1593. * An array of analysis-level column configurations. Column configurations can be used to set default formatting for a column to be used throughout an analysis.
  1594. */
  1595. ColumnConfigurations?: ColumnConfigurationList;
  1596. AnalysisDefaults?: AnalysisDefaults;
  1597. /**
  1598. * An array of option definitions for an analysis.
  1599. */
  1600. Options?: AssetOptions;
  1601. }
  1602. export interface AnalysisError {
  1603. /**
  1604. * The type of the analysis error.
  1605. */
  1606. Type?: AnalysisErrorType;
  1607. /**
  1608. * The message associated with the analysis error.
  1609. */
  1610. Message?: NonEmptyString;
  1611. /**
  1612. * Lists the violated entities that caused the analysis error
  1613. */
  1614. ViolatedEntities?: EntityList;
  1615. }
  1616. export type AnalysisErrorList = AnalysisError[];
  1617. export type AnalysisErrorType = "ACCESS_DENIED"|"SOURCE_NOT_FOUND"|"DATA_SET_NOT_FOUND"|"INTERNAL_FAILURE"|"PARAMETER_VALUE_INCOMPATIBLE"|"PARAMETER_TYPE_INVALID"|"PARAMETER_NOT_FOUND"|"COLUMN_TYPE_MISMATCH"|"COLUMN_GEOGRAPHIC_ROLE_MISMATCH"|"COLUMN_REPLACEMENT_MISSING"|string;
  1618. export type AnalysisFilterAttribute = "QUICKSIGHT_USER"|"QUICKSIGHT_VIEWER_OR_OWNER"|"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"|"QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_SOLE_OWNER"|"ANALYSIS_NAME"|string;
  1619. export type AnalysisName = string;
  1620. export interface AnalysisSearchFilter {
  1621. /**
  1622. * The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike". If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1". If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"ANALYSIS_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value ANALYSIS_NAME.
  1623. */
  1624. Operator?: FilterOperator;
  1625. /**
  1626. * The name of the value that you want to use as a filter, for example "Name": "QUICKSIGHT_OWNER". Valid values are defined as follows: QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the analysis' owners or viewers are returned. Implicit permissions from folders or groups are considered. QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are considered. DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as the only owner of the analysis are returned. Implicit permissions from folders or groups are not considered. DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners of the analyses are returned. Implicit permissions from folders or groups are not considered. DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any analyses with that ARN listed as one of the owners or viewers of the analyses are returned. Implicit permissions from folders or groups are not considered. ANALYSIS_NAME: Any analyses whose names have a substring match to this value will be returned.
  1627. */
  1628. Name?: AnalysisFilterAttribute;
  1629. /**
  1630. * The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example "Value". An example is "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
  1631. */
  1632. Value?: String;
  1633. }
  1634. export type AnalysisSearchFilterList = AnalysisSearchFilter[];
  1635. export interface AnalysisSourceEntity {
  1636. /**
  1637. * The source template for the source entity of the analysis.
  1638. */
  1639. SourceTemplate?: AnalysisSourceTemplate;
  1640. }
  1641. export interface AnalysisSourceTemplate {
  1642. /**
  1643. * The dataset references of the source template of an analysis.
  1644. */
  1645. DataSetReferences: DataSetReferenceList;
  1646. /**
  1647. * The Amazon Resource Name (ARN) of the source template of an analysis.
  1648. */
  1649. Arn: Arn;
  1650. }
  1651. export interface AnalysisSummary {
  1652. /**
  1653. * The Amazon Resource Name (ARN) for the analysis.
  1654. */
  1655. Arn?: Arn;
  1656. /**
  1657. * The ID of the analysis. This ID displays in the URL.
  1658. */
  1659. AnalysisId?: ShortRestrictiveResourceId;
  1660. /**
  1661. * The name of the analysis. This name is displayed in the Amazon QuickSight console.
  1662. */
  1663. Name?: AnalysisName;
  1664. /**
  1665. * The last known status for the analysis.
  1666. */
  1667. Status?: ResourceStatus;
  1668. /**
  1669. * The time that the analysis was created.
  1670. */
  1671. CreatedTime?: Timestamp;
  1672. /**
  1673. * The time that the analysis was last updated.
  1674. */
  1675. LastUpdatedTime?: Timestamp;
  1676. }
  1677. export type AnalysisSummaryList = AnalysisSummary[];
  1678. export interface AnchorDateConfiguration {
  1679. /**
  1680. * The options for the date configuration. Choose one of the options below: NOW
  1681. */
  1682. AnchorOption?: AnchorOption;
  1683. /**
  1684. * The name of the parameter that is used for the anchor date configuration.
  1685. */
  1686. ParameterName?: ParameterName;
  1687. }
  1688. export type AnchorOption = "NOW"|string;
  1689. export interface AnonymousUserDashboardEmbeddingConfiguration {
  1690. /**
  1691. * The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard. The Amazon Resource Name (ARN) of this dashboard must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.
  1692. */
  1693. InitialDashboardId: ShortRestrictiveResourceId;
  1694. }
  1695. export interface AnonymousUserDashboardVisualEmbeddingConfiguration {
  1696. /**
  1697. * The visual ID for the visual that you want the user to see. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual. The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.
  1698. */
  1699. InitialDashboardVisualId: DashboardVisualId;
  1700. }
  1701. export interface AnonymousUserEmbeddingExperienceConfiguration {
  1702. /**
  1703. * The type of embedding experience. In this case, Amazon QuickSight dashboards.
  1704. */
  1705. Dashboard?: AnonymousUserDashboardEmbeddingConfiguration;
  1706. /**
  1707. * The type of embedding experience. In this case, Amazon QuickSight visuals.
  1708. */
  1709. DashboardVisual?: AnonymousUserDashboardVisualEmbeddingConfiguration;
  1710. /**
  1711. * The Q search bar that you want to use for anonymous user embedding.
  1712. */
  1713. QSearchBar?: AnonymousUserQSearchBarEmbeddingConfiguration;
  1714. /**
  1715. * The Generative Q&amp;A experience that you want to use for anonymous user embedding.
  1716. */
  1717. GenerativeQnA?: AnonymousUserGenerativeQnAEmbeddingConfiguration;
  1718. }
  1719. export interface AnonymousUserGenerativeQnAEmbeddingConfiguration {
  1720. /**
  1721. * The Amazon QuickSight Q topic ID of the new reader experience topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Generative Q&amp;A experience with this new reader experience topic pre selected. The Amazon Resource Name (ARN) of this Q new reader experience topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.
  1722. */
  1723. InitialTopicId: RestrictiveResourceId;
  1724. }
  1725. export interface AnonymousUserQSearchBarEmbeddingConfiguration {
  1726. /**
  1727. * The Amazon QuickSight Q topic ID of the legacy topic that you want the anonymous user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders the Q search bar with this legacy topic pre-selected. The Amazon Resource Name (ARN) of this Q legacy topic must be included in the AuthorizedResourceArns parameter. Otherwise, the request fails with an InvalidParameterValueException error.
  1728. */
  1729. InitialTopicId: RestrictiveResourceId;
  1730. }
  1731. export interface AnonymousUserSnapshotJobResult {
  1732. /**
  1733. * A list of SnapshotJobResultFileGroup objects that contain information on the files that are requested during a StartDashboardSnapshotJob API call. If the job succeeds, these objects contain the location where the snapshot artifacts are stored. If the job fails, the objects contain information about the error that caused the job to fail.
  1734. */
  1735. FileGroups?: SnapshotJobResultFileGroupList;
  1736. }
  1737. export type AnonymousUserSnapshotJobResultList = AnonymousUserSnapshotJobResult[];
  1738. export interface ArcAxisConfiguration {
  1739. /**
  1740. * The arc axis range of a GaugeChartVisual.
  1741. */
  1742. Range?: ArcAxisDisplayRange;
  1743. /**
  1744. * The reserved range of the arc axis.
  1745. */
  1746. ReserveRange?: Integer;
  1747. }
  1748. export interface ArcAxisDisplayRange {
  1749. /**
  1750. * The minimum value of the arc axis range.
  1751. */
  1752. Min?: Double;
  1753. /**
  1754. * The maximum value of the arc axis range.
  1755. */
  1756. Max?: Double;
  1757. }
  1758. export interface ArcConfiguration {
  1759. /**
  1760. * The option that determines the arc angle of a GaugeChartVisual.
  1761. */
  1762. ArcAngle?: Double;
  1763. /**
  1764. * The options that determine the arc thickness of a GaugeChartVisual.
  1765. */
  1766. ArcThickness?: ArcThicknessOptions;
  1767. }
  1768. export interface ArcOptions {
  1769. /**
  1770. * The arc thickness of a GaugeChartVisual.
  1771. */
  1772. ArcThickness?: ArcThickness;
  1773. }
  1774. export type ArcThickness = "SMALL"|"MEDIUM"|"LARGE"|"WHOLE"|string;
  1775. export type ArcThicknessOptions = "SMALL"|"MEDIUM"|"LARGE"|string;
  1776. export type Arn = string;
  1777. export type ArnList = Arn[];
  1778. export interface AssetBundleCloudFormationOverridePropertyConfiguration {
  1779. /**
  1780. * An optional list of structures that control how resource IDs are parameterized in the returned CloudFormation template.
  1781. */
  1782. ResourceIdOverrideConfiguration?: AssetBundleExportJobResourceIdOverrideConfiguration;
  1783. /**
  1784. * An optional list of structures that control how VPCConnection resources are parameterized in the returned CloudFormation template.
  1785. */
  1786. VPCConnections?: AssetBundleExportJobVPCConnectionOverridePropertiesList;
  1787. /**
  1788. * An optional list of structures that control how RefreshSchedule resources are parameterized in the returned CloudFormation template.
  1789. */
  1790. RefreshSchedules?: AssetBundleExportJobRefreshScheduleOverridePropertiesList;
  1791. /**
  1792. * An optional list of structures that control how DataSource resources are parameterized in the returned CloudFormation template.
  1793. */
  1794. DataSources?: AssetBundleExportJobDataSourceOverridePropertiesList;
  1795. /**
  1796. * An optional list of structures that control how DataSet resources are parameterized in the returned CloudFormation template.
  1797. */
  1798. DataSets?: AssetBundleExportJobDataSetOverridePropertiesList;
  1799. /**
  1800. * An optional list of structures that control how Theme resources are parameterized in the returned CloudFormation template.
  1801. */
  1802. Themes?: AssetBundleExportJobThemeOverridePropertiesList;
  1803. /**
  1804. * An optional list of structures that control how Analysis resources are parameterized in the returned CloudFormation template.
  1805. */
  1806. Analyses?: AssetBundleExportJobAnalysisOverridePropertiesList;
  1807. /**
  1808. * An optional list of structures that control how Dashboard resources are parameterized in the returned CloudFormation template.
  1809. */
  1810. Dashboards?: AssetBundleExportJobDashboardOverridePropertiesList;
  1811. }
  1812. export type AssetBundleExportFormat = "CLOUDFORMATION_JSON"|"QUICKSIGHT_JSON"|string;
  1813. export interface AssetBundleExportJobAnalysisOverrideProperties {
  1814. /**
  1815. * The ARN of the specific Analysis resource whose override properties are configured in this structure.
  1816. */
  1817. Arn: Arn;
  1818. /**
  1819. * A list of Analysis resource properties to generate variables for in the returned CloudFormation template.
  1820. */
  1821. Properties: AssetBundleExportJobAnalysisPropertyToOverrideList;
  1822. }
  1823. export type AssetBundleExportJobAnalysisOverridePropertiesList = AssetBundleExportJobAnalysisOverrideProperties[];
  1824. export type AssetBundleExportJobAnalysisPropertyToOverride = "Name"|string;
  1825. export type AssetBundleExportJobAnalysisPropertyToOverrideList = AssetBundleExportJobAnalysisPropertyToOverride[];
  1826. export interface AssetBundleExportJobDashboardOverrideProperties {
  1827. /**
  1828. * The ARN of the specific Dashboard resource whose override properties are configured in this structure.
  1829. */
  1830. Arn: Arn;
  1831. /**
  1832. * A list of Dashboard resource properties to generate variables for in the returned CloudFormation template.
  1833. */
  1834. Properties: AssetBundleExportJobDashboardPropertyToOverrideList;
  1835. }
  1836. export type AssetBundleExportJobDashboardOverridePropertiesList = AssetBundleExportJobDashboardOverrideProperties[];
  1837. export type AssetBundleExportJobDashboardPropertyToOverride = "Name"|string;
  1838. export type AssetBundleExportJobDashboardPropertyToOverrideList = AssetBundleExportJobDashboardPropertyToOverride[];
  1839. export interface AssetBundleExportJobDataSetOverrideProperties {
  1840. /**
  1841. * The ARN of the specific DataSet resource whose override properties are configured in this structure.
  1842. */
  1843. Arn: Arn;
  1844. /**
  1845. * A list of DataSet resource properties to generate variables for in the returned CloudFormation template.
  1846. */
  1847. Properties: AssetBundleExportJobDataSetPropertyToOverrideList;
  1848. }
  1849. export type AssetBundleExportJobDataSetOverridePropertiesList = AssetBundleExportJobDataSetOverrideProperties[];
  1850. export type AssetBundleExportJobDataSetPropertyToOverride = "Name"|string;
  1851. export type AssetBundleExportJobDataSetPropertyToOverrideList = AssetBundleExportJobDataSetPropertyToOverride[];
  1852. export interface AssetBundleExportJobDataSourceOverrideProperties {
  1853. /**
  1854. * The ARN of the specific DataSource resource whose override properties are configured in this structure.
  1855. */
  1856. Arn: Arn;
  1857. /**
  1858. * A list of DataSource resource properties to generate variables for in the returned CloudFormation template.
  1859. */
  1860. Properties: AssetBundleExportJobDataSourcePropertyToOverrideList;
  1861. }
  1862. export type AssetBundleExportJobDataSourceOverridePropertiesList = AssetBundleExportJobDataSourceOverrideProperties[];
  1863. export type AssetBundleExportJobDataSourcePropertyToOverride = "Name"|"DisableSsl"|"SecretArn"|"Username"|"Password"|"Domain"|"WorkGroup"|"Host"|"Port"|"Database"|"DataSetName"|"Catalog"|"InstanceId"|"ClusterId"|"ManifestFileLocation"|"Warehouse"|"RoleArn"|"ProductType"|string;
  1864. export type AssetBundleExportJobDataSourcePropertyToOverrideList = AssetBundleExportJobDataSourcePropertyToOverride[];
  1865. export interface AssetBundleExportJobError {
  1866. /**
  1867. * The ARN of the resource whose processing caused an error.
  1868. */
  1869. Arn?: Arn;
  1870. /**
  1871. * The specific error type of the error that occurred.
  1872. */
  1873. Type?: NonEmptyString;
  1874. /**
  1875. * A description of the error.
  1876. */
  1877. Message?: NonEmptyString;
  1878. }
  1879. export type AssetBundleExportJobErrorList = AssetBundleExportJobError[];
  1880. export interface AssetBundleExportJobRefreshScheduleOverrideProperties {
  1881. /**
  1882. * The ARN of the specific RefreshSchedule resource whose override properties are configured in this structure.
  1883. */
  1884. Arn: Arn;
  1885. /**
  1886. * A list of RefreshSchedule resource properties to generate variables for in the returned CloudFormation template.
  1887. */
  1888. Properties: AssetBundleExportJobRefreshSchedulePropertyToOverrideList;
  1889. }
  1890. export type AssetBundleExportJobRefreshScheduleOverridePropertiesList = AssetBundleExportJobRefreshScheduleOverrideProperties[];
  1891. export type AssetBundleExportJobRefreshSchedulePropertyToOverride = "StartAfterDateTime"|string;
  1892. export type AssetBundleExportJobRefreshSchedulePropertyToOverrideList = AssetBundleExportJobRefreshSchedulePropertyToOverride[];
  1893. export interface AssetBundleExportJobResourceIdOverrideConfiguration {
  1894. /**
  1895. * An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
  1896. */
  1897. PrefixForAllResources?: Boolean;
  1898. }
  1899. export type AssetBundleExportJobStatus = "QUEUED_FOR_IMMEDIATE_EXECUTION"|"IN_PROGRESS"|"SUCCESSFUL"|"FAILED"|string;
  1900. export interface AssetBundleExportJobSummary {
  1901. /**
  1902. * The current status of the export job.
  1903. */
  1904. JobStatus?: AssetBundleExportJobStatus;
  1905. /**
  1906. * The ARN of the export job.
  1907. */
  1908. Arn?: Arn;
  1909. /**
  1910. * The time that the export job was created.
  1911. */
  1912. CreatedTime?: Timestamp;
  1913. /**
  1914. * The ID of the export job.
  1915. */
  1916. AssetBundleExportJobId?: ShortRestrictiveResourceId;
  1917. /**
  1918. * The flag that determines the inclusion of resource dependencies in the returned asset bundle.
  1919. */
  1920. IncludeAllDependencies?: Boolean;
  1921. /**
  1922. * The format for the export job.
  1923. */
  1924. ExportFormat?: AssetBundleExportFormat;
  1925. /**
  1926. * The flag that determines the inclusion of permissions associated with each resource ARN.
  1927. */
  1928. IncludePermissions?: Boolean;
  1929. /**
  1930. * The flag that determines the inclusion of tags associated with each resource ARN.
  1931. */
  1932. IncludeTags?: Boolean;
  1933. }
  1934. export type AssetBundleExportJobSummaryList = AssetBundleExportJobSummary[];
  1935. export interface AssetBundleExportJobThemeOverrideProperties {
  1936. /**
  1937. * The ARN of the specific Theme resource whose override properties are configured in this structure.
  1938. */
  1939. Arn: Arn;
  1940. /**
  1941. * A list of Theme resource properties to generate variables for in the returned CloudFormation template.
  1942. */
  1943. Properties: AssetBundleExportJobThemePropertyToOverrideList;
  1944. }
  1945. export type AssetBundleExportJobThemeOverridePropertiesList = AssetBundleExportJobThemeOverrideProperties[];
  1946. export type AssetBundleExportJobThemePropertyToOverride = "Name"|string;
  1947. export type AssetBundleExportJobThemePropertyToOverrideList = AssetBundleExportJobThemePropertyToOverride[];
  1948. export interface AssetBundleExportJobVPCConnectionOverrideProperties {
  1949. /**
  1950. * The ARN of the specific VPCConnection resource whose override properties are configured in this structure.
  1951. */
  1952. Arn: Arn;
  1953. /**
  1954. * A list of VPCConnection resource properties to generate variables for in the returned CloudFormation template.
  1955. */
  1956. Properties: AssetBundleExportJobVPCConnectionPropertyToOverrideList;
  1957. }
  1958. export type AssetBundleExportJobVPCConnectionOverridePropertiesList = AssetBundleExportJobVPCConnectionOverrideProperties[];
  1959. export type AssetBundleExportJobVPCConnectionPropertyToOverride = "Name"|"DnsResolvers"|"RoleArn"|string;
  1960. export type AssetBundleExportJobVPCConnectionPropertyToOverrideList = AssetBundleExportJobVPCConnectionPropertyToOverride[];
  1961. export interface AssetBundleExportJobValidationStrategy {
  1962. /**
  1963. * A Boolean value that indicates whether to export resources under strict or lenient mode.
  1964. */
  1965. StrictModeForAllResources?: Boolean;
  1966. }
  1967. export interface AssetBundleExportJobWarning {
  1968. /**
  1969. * The ARN of the resource whose processing caused a warning.
  1970. */
  1971. Arn?: Arn;
  1972. /**
  1973. * A description of the warning.
  1974. */
  1975. Message?: NonEmptyString;
  1976. }
  1977. export type AssetBundleExportJobWarningList = AssetBundleExportJobWarning[];
  1978. export type AssetBundleImportBodyBlob = Buffer|Uint8Array|Blob|string;
  1979. export type AssetBundleImportFailureAction = "DO_NOTHING"|"ROLLBACK"|string;
  1980. export interface AssetBundleImportJobAnalysisOverrideParameters {
  1981. /**
  1982. * The ID of the analysis that you ant to apply overrides to.
  1983. */
  1984. AnalysisId: ResourceId;
  1985. /**
  1986. * A new name for the analysis.
  1987. */
  1988. Name?: ResourceName;
  1989. }
  1990. export type AssetBundleImportJobAnalysisOverrideParametersList = AssetBundleImportJobAnalysisOverrideParameters[];
  1991. export interface AssetBundleImportJobAnalysisOverridePermissions {
  1992. /**
  1993. * A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
  1994. */
  1995. AnalysisIds: AssetBundleRestrictiveResourceIdList;
  1996. /**
  1997. * A list of permissions for the analyses that you want to apply overrides to.
  1998. */
  1999. Permissions: AssetBundleResourcePermissions;
  2000. }
  2001. export type AssetBundleImportJobAnalysisOverridePermissionsList = AssetBundleImportJobAnalysisOverridePermissions[];
  2002. export interface AssetBundleImportJobAnalysisOverrideTags {
  2003. /**
  2004. * A list of analysis IDs that you want to apply overrides to. You can use * to override all analyses in this asset bundle.
  2005. */
  2006. AnalysisIds: AssetBundleRestrictiveResourceIdList;
  2007. /**
  2008. * A list of tags for the analyses that you want to apply overrides to.
  2009. */
  2010. Tags: TagList;
  2011. }
  2012. export type AssetBundleImportJobAnalysisOverrideTagsList = AssetBundleImportJobAnalysisOverrideTags[];
  2013. export interface AssetBundleImportJobDashboardOverrideParameters {
  2014. /**
  2015. * The ID of the dashboard that you want to apply overrides to.
  2016. */
  2017. DashboardId: ResourceId;
  2018. /**
  2019. * A new name for the dashboard.
  2020. */
  2021. Name?: ResourceName;
  2022. }
  2023. export type AssetBundleImportJobDashboardOverrideParametersList = AssetBundleImportJobDashboardOverrideParameters[];
  2024. export interface AssetBundleImportJobDashboardOverridePermissions {
  2025. /**
  2026. * A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
  2027. */
  2028. DashboardIds: AssetBundleRestrictiveResourceIdList;
  2029. /**
  2030. * A list of permissions for the dashboards that you want to apply overrides to.
  2031. */
  2032. Permissions?: AssetBundleResourcePermissions;
  2033. /**
  2034. * A structure that contains the link sharing configurations that you want to apply overrides to.
  2035. */
  2036. LinkSharingConfiguration?: AssetBundleResourceLinkSharingConfiguration;
  2037. }
  2038. export type AssetBundleImportJobDashboardOverridePermissionsList = AssetBundleImportJobDashboardOverridePermissions[];
  2039. export interface AssetBundleImportJobDashboardOverrideTags {
  2040. /**
  2041. * A list of dashboard IDs that you want to apply overrides to. You can use * to override all dashboards in this asset bundle.
  2042. */
  2043. DashboardIds: AssetBundleRestrictiveResourceIdList;
  2044. /**
  2045. * A list of tags for the dashboards that you want to apply overrides to.
  2046. */
  2047. Tags: TagList;
  2048. }
  2049. export type AssetBundleImportJobDashboardOverrideTagsList = AssetBundleImportJobDashboardOverrideTags[];
  2050. export interface AssetBundleImportJobDataSetOverrideParameters {
  2051. /**
  2052. * The ID of the dataset to apply overrides to.
  2053. */
  2054. DataSetId: ResourceId;
  2055. /**
  2056. * A new name for the dataset.
  2057. */
  2058. Name?: ResourceName;
  2059. }
  2060. export type AssetBundleImportJobDataSetOverrideParametersList = AssetBundleImportJobDataSetOverrideParameters[];
  2061. export interface AssetBundleImportJobDataSetOverridePermissions {
  2062. /**
  2063. * A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
  2064. */
  2065. DataSetIds: AssetBundleRestrictiveResourceIdList;
  2066. /**
  2067. * A list of permissions for the datasets that you want to apply overrides to.
  2068. */
  2069. Permissions: AssetBundleResourcePermissions;
  2070. }
  2071. export type AssetBundleImportJobDataSetOverridePermissionsList = AssetBundleImportJobDataSetOverridePermissions[];
  2072. export interface AssetBundleImportJobDataSetOverrideTags {
  2073. /**
  2074. * A list of dataset IDs that you want to apply overrides to. You can use * to override all datasets in this asset bundle.
  2075. */
  2076. DataSetIds: AssetBundleRestrictiveResourceIdList;
  2077. /**
  2078. * A list of tags for the datasets that you want to apply overrides to.
  2079. */
  2080. Tags: TagList;
  2081. }
  2082. export type AssetBundleImportJobDataSetOverrideTagsList = AssetBundleImportJobDataSetOverrideTags[];
  2083. export interface AssetBundleImportJobDataSourceCredentialPair {
  2084. /**
  2085. * The username for the data source connection.
  2086. */
  2087. Username: DbUsername;
  2088. /**
  2089. * The password for the data source connection.
  2090. */
  2091. Password: Password;
  2092. }
  2093. export interface AssetBundleImportJobDataSourceCredentials {
  2094. /**
  2095. * A username and password credential pair to be used to create the imported data source. Keep this field blank if you are using a Secrets Manager secret to provide credentials.
  2096. */
  2097. CredentialPair?: AssetBundleImportJobDataSourceCredentialPair;
  2098. /**
  2099. * The ARN of the Secrets Manager secret that's used to create the imported data source. Keep this field blank, unless you are using a secret in place of a credential pair.
  2100. */
  2101. SecretArn?: SecretArn;
  2102. }
  2103. export interface AssetBundleImportJobDataSourceOverrideParameters {
  2104. /**
  2105. * The ID of the data source to apply overrides to.
  2106. */
  2107. DataSourceId: ResourceId;
  2108. /**
  2109. * A new name for the data source.
  2110. */
  2111. Name?: ResourceName;
  2112. DataSourceParameters?: DataSourceParameters;
  2113. VpcConnectionProperties?: VpcConnectionProperties;
  2114. SslProperties?: SslProperties;
  2115. /**
  2116. * An optional structure that provides the credentials to be used to create the imported data source.
  2117. */
  2118. Credentials?: AssetBundleImportJobDataSourceCredentials;
  2119. }
  2120. export type AssetBundleImportJobDataSourceOverrideParametersList = AssetBundleImportJobDataSourceOverrideParameters[];
  2121. export interface AssetBundleImportJobDataSourceOverridePermissions {
  2122. /**
  2123. * A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
  2124. */
  2125. DataSourceIds: AssetBundleRestrictiveResourceIdList;
  2126. /**
  2127. * A list of permissions for the data source that you want to apply overrides to.
  2128. */
  2129. Permissions: AssetBundleResourcePermissions;
  2130. }
  2131. export type AssetBundleImportJobDataSourceOverridePermissionsList = AssetBundleImportJobDataSourceOverridePermissions[];
  2132. export interface AssetBundleImportJobDataSourceOverrideTags {
  2133. /**
  2134. * A list of data source IDs that you want to apply overrides to. You can use * to override all data sources in this asset bundle.
  2135. */
  2136. DataSourceIds: AssetBundleRestrictiveResourceIdList;
  2137. /**
  2138. * A list of tags for the data source that you want to apply overrides to.
  2139. */
  2140. Tags: TagList;
  2141. }
  2142. export type AssetBundleImportJobDataSourceOverrideTagsList = AssetBundleImportJobDataSourceOverrideTags[];
  2143. export interface AssetBundleImportJobError {
  2144. /**
  2145. * The ARN of the resource whose processing caused an error.
  2146. */
  2147. Arn?: Arn;
  2148. /**
  2149. * The specific error type or the error that occurred.
  2150. */
  2151. Type?: NonEmptyString;
  2152. /**
  2153. * A description of the error.
  2154. */
  2155. Message?: NonEmptyString;
  2156. }
  2157. export type AssetBundleImportJobErrorList = AssetBundleImportJobError[];
  2158. export interface AssetBundleImportJobOverrideParameters {
  2159. /**
  2160. * An optional structure that configures resource ID overrides to be applied within the import job.
  2161. */
  2162. ResourceIdOverrideConfiguration?: AssetBundleImportJobResourceIdOverrideConfiguration;
  2163. /**
  2164. * A list of overrides for any VPCConnection resources that are present in the asset bundle that is imported.
  2165. */
  2166. VPCConnections?: AssetBundleImportJobVPCConnectionOverrideParametersList;
  2167. /**
  2168. * A list of overrides for any RefreshSchedule resources that are present in the asset bundle that is imported.
  2169. */
  2170. RefreshSchedules?: AssetBundleImportJobRefreshScheduleOverrideParametersList;
  2171. /**
  2172. * A list of overrides for any DataSource resources that are present in the asset bundle that is imported.
  2173. */
  2174. DataSources?: AssetBundleImportJobDataSourceOverrideParametersList;
  2175. /**
  2176. * A list of overrides for any DataSet resources that are present in the asset bundle that is imported.
  2177. */
  2178. DataSets?: AssetBundleImportJobDataSetOverrideParametersList;
  2179. /**
  2180. * A list of overrides for any Theme resources that are present in the asset bundle that is imported.
  2181. */
  2182. Themes?: AssetBundleImportJobThemeOverrideParametersList;
  2183. /**
  2184. * A list of overrides for any Analysis resources that are present in the asset bundle that is imported.
  2185. */
  2186. Analyses?: AssetBundleImportJobAnalysisOverrideParametersList;
  2187. /**
  2188. * A list of overrides for any Dashboard resources that are present in the asset bundle that is imported.
  2189. */
  2190. Dashboards?: AssetBundleImportJobDashboardOverrideParametersList;
  2191. }
  2192. export interface AssetBundleImportJobOverridePermissions {
  2193. /**
  2194. * A list of permissions overrides for any DataSource resources that are present in the asset bundle that is imported.
  2195. */
  2196. DataSources?: AssetBundleImportJobDataSourceOverridePermissionsList;
  2197. /**
  2198. * A list of permissions overrides for any DataSet resources that are present in the asset bundle that is imported.
  2199. */
  2200. DataSets?: AssetBundleImportJobDataSetOverridePermissionsList;
  2201. /**
  2202. * A list of permissions overrides for any Theme resources that are present in the asset bundle that is imported.
  2203. */
  2204. Themes?: AssetBundleImportJobThemeOverridePermissionsList;
  2205. /**
  2206. * A list of permissions overrides for any Analysis resources that are present in the asset bundle that is imported.
  2207. */
  2208. Analyses?: AssetBundleImportJobAnalysisOverridePermissionsList;
  2209. /**
  2210. * A list of permissions overrides for any Dashboard resources that are present in the asset bundle that is imported.
  2211. */
  2212. Dashboards?: AssetBundleImportJobDashboardOverridePermissionsList;
  2213. }
  2214. export interface AssetBundleImportJobOverrideTags {
  2215. /**
  2216. * A list of tag overrides for any VPCConnection resources that are present in the asset bundle that is imported.
  2217. */
  2218. VPCConnections?: AssetBundleImportJobVPCConnectionOverrideTagsList;
  2219. /**
  2220. * A list of tag overrides for any DataSource resources that are present in the asset bundle that is imported.
  2221. */
  2222. DataSources?: AssetBundleImportJobDataSourceOverrideTagsList;
  2223. /**
  2224. * A list of tag overrides for any DataSet resources that are present in the asset bundle that is imported.
  2225. */
  2226. DataSets?: AssetBundleImportJobDataSetOverrideTagsList;
  2227. /**
  2228. * A list of tag overrides for any Theme resources that are present in the asset bundle that is imported.
  2229. */
  2230. Themes?: AssetBundleImportJobThemeOverrideTagsList;
  2231. /**
  2232. * A list of tag overrides for any Analysis resources that are present in the asset bundle that is imported.
  2233. */
  2234. Analyses?: AssetBundleImportJobAnalysisOverrideTagsList;
  2235. /**
  2236. * A list of tag overrides for any Dashboard resources that are present in the asset bundle that is imported.
  2237. */
  2238. Dashboards?: AssetBundleImportJobDashboardOverrideTagsList;
  2239. }
  2240. export interface AssetBundleImportJobOverrideValidationStrategy {
  2241. /**
  2242. * A Boolean value that indicates whether to import all analyses and dashboards under strict or lenient mode.
  2243. */
  2244. StrictModeForAllResources?: Boolean;
  2245. }
  2246. export interface AssetBundleImportJobRefreshScheduleOverrideParameters {
  2247. /**
  2248. * A partial identifier for the specific RefreshSchedule resource that is being overridden. This structure is used together with the ScheduleID structure.
  2249. */
  2250. DataSetId: ResourceId;
  2251. /**
  2252. * A partial identifier for the specific RefreshSchedule resource being overridden. This structure is used together with the DataSetId structure.
  2253. */
  2254. ScheduleId: String;
  2255. /**
  2256. * An override for the StartAfterDateTime of a RefreshSchedule. Make sure that the StartAfterDateTime is set to a time that takes place in the future.
  2257. */
  2258. StartAfterDateTime?: Timestamp;
  2259. }
  2260. export type AssetBundleImportJobRefreshScheduleOverrideParametersList = AssetBundleImportJobRefreshScheduleOverrideParameters[];
  2261. export interface AssetBundleImportJobResourceIdOverrideConfiguration {
  2262. /**
  2263. * An option to request a CloudFormation variable for a prefix to be prepended to each resource's ID before import. The prefix is only added to the asset IDs and does not change the name of the asset.
  2264. */
  2265. PrefixForAllResources?: String;
  2266. }
  2267. export type AssetBundleImportJobStatus = "QUEUED_FOR_IMMEDIATE_EXECUTION"|"IN_PROGRESS"|"SUCCESSFUL"|"FAILED"|"FAILED_ROLLBACK_IN_PROGRESS"|"FAILED_ROLLBACK_COMPLETED"|"FAILED_ROLLBACK_ERROR"|string;
  2268. export interface AssetBundleImportJobSummary {
  2269. /**
  2270. * The current status of the import job.
  2271. */
  2272. JobStatus?: AssetBundleImportJobStatus;
  2273. /**
  2274. * The ARN of the import job.
  2275. */
  2276. Arn?: Arn;
  2277. /**
  2278. * The time that the import job was created.
  2279. */
  2280. CreatedTime?: Timestamp;
  2281. /**
  2282. * The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
  2283. */
  2284. AssetBundleImportJobId?: ShortRestrictiveResourceId;
  2285. /**
  2286. * The failure action for the import job.
  2287. */
  2288. FailureAction?: AssetBundleImportFailureAction;
  2289. }
  2290. export type AssetBundleImportJobSummaryList = AssetBundleImportJobSummary[];
  2291. export interface AssetBundleImportJobThemeOverrideParameters {
  2292. /**
  2293. * The ID of the theme to apply overrides to.
  2294. */
  2295. ThemeId: ResourceId;
  2296. /**
  2297. * A new name for the theme.
  2298. */
  2299. Name?: ResourceName;
  2300. }
  2301. export type AssetBundleImportJobThemeOverrideParametersList = AssetBundleImportJobThemeOverrideParameters[];
  2302. export interface AssetBundleImportJobThemeOverridePermissions {
  2303. /**
  2304. * A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
  2305. */
  2306. ThemeIds: AssetBundleRestrictiveResourceIdList;
  2307. /**
  2308. * A list of permissions for the themes that you want to apply overrides to.
  2309. */
  2310. Permissions: AssetBundleResourcePermissions;
  2311. }
  2312. export type AssetBundleImportJobThemeOverridePermissionsList = AssetBundleImportJobThemeOverridePermissions[];
  2313. export interface AssetBundleImportJobThemeOverrideTags {
  2314. /**
  2315. * A list of theme IDs that you want to apply overrides to. You can use * to override all themes in this asset bundle.
  2316. */
  2317. ThemeIds: AssetBundleRestrictiveResourceIdList;
  2318. /**
  2319. * A list of tags for the themes that you want to apply overrides to.
  2320. */
  2321. Tags: TagList;
  2322. }
  2323. export type AssetBundleImportJobThemeOverrideTagsList = AssetBundleImportJobThemeOverrideTags[];
  2324. export interface AssetBundleImportJobVPCConnectionOverrideParameters {
  2325. /**
  2326. * The ID of the VPC Connection to apply overrides to.
  2327. */
  2328. VPCConnectionId: VPCConnectionResourceIdUnrestricted;
  2329. /**
  2330. * A new name for the VPC connection.
  2331. */
  2332. Name?: ResourceName;
  2333. /**
  2334. * A list of new subnet IDs for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
  2335. */
  2336. SubnetIds?: SubnetIdList;
  2337. /**
  2338. * A new security group ID for the VPC connection you are importing. This field is required if you are importing the VPC connection from another Amazon Web Services account or Region.
  2339. */
  2340. SecurityGroupIds?: SecurityGroupIdList;
  2341. /**
  2342. * An optional override of DNS resolvers to be used by the VPC connection.
  2343. */
  2344. DnsResolvers?: DnsResolverList;
  2345. /**
  2346. * An optional override of the role ARN to be used by the VPC connection.
  2347. */
  2348. RoleArn?: RoleArn;
  2349. }
  2350. export type AssetBundleImportJobVPCConnectionOverrideParametersList = AssetBundleImportJobVPCConnectionOverrideParameters[];
  2351. export interface AssetBundleImportJobVPCConnectionOverrideTags {
  2352. /**
  2353. * A list of VPC connection IDs that you want to apply overrides to. You can use * to override all VPC connections in this asset bundle.
  2354. */
  2355. VPCConnectionIds: AssetBundleRestrictiveResourceIdList;
  2356. /**
  2357. * A list of tags for the VPC connections that you want to apply overrides to.
  2358. */
  2359. Tags: TagList;
  2360. }
  2361. export type AssetBundleImportJobVPCConnectionOverrideTagsList = AssetBundleImportJobVPCConnectionOverrideTags[];
  2362. export interface AssetBundleImportJobWarning {
  2363. /**
  2364. * The ARN of the resource that the warning occurred for.
  2365. */
  2366. Arn?: Arn;
  2367. /**
  2368. * A description of the warning that occurred during an Asset Bundle import job.
  2369. */
  2370. Message?: NonEmptyString;
  2371. }
  2372. export type AssetBundleImportJobWarningList = AssetBundleImportJobWarning[];
  2373. export interface AssetBundleImportSource {
  2374. /**
  2375. * The bytes of the base64 encoded asset bundle import zip file. This file can't exceed 20 MB. If you are calling the API operations from the Amazon Web Services SDK for Java, JavaScript, Python, or PHP, the SDK encodes base64 automatically to allow the direct setting of the zip file's bytes. If you are using an SDK for a different language or receiving related errors, try to base64 encode your data.
  2376. */
  2377. Body?: AssetBundleImportBodyBlob;
  2378. /**
  2379. * The Amazon S3 URI for an asset bundle import file that exists in an Amazon S3 bucket that the caller has read access to. The file must be a zip format file and can't exceed 20 MB.
  2380. */
  2381. S3Uri?: S3Uri;
  2382. }
  2383. export interface AssetBundleImportSourceDescription {
  2384. /**
  2385. * An HTTPS download URL for the provided asset bundle that you optionally provided at the start of the import job. This URL is valid for five minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a .qs zip file.
  2386. */
  2387. Body?: SensitiveS3Uri;
  2388. /**
  2389. * The Amazon S3 URI that you provided at the start of the import job.
  2390. */
  2391. S3Uri?: S3Uri;
  2392. }
  2393. export type AssetBundlePrincipalList = Principal[];
  2394. export type AssetBundleResourceArns = Arn[];
  2395. export interface AssetBundleResourceLinkSharingConfiguration {
  2396. /**
  2397. * A list of link sharing permissions for the dashboards that you want to apply overrides to.
  2398. */
  2399. Permissions?: AssetBundleResourcePermissions;
  2400. }
  2401. export interface AssetBundleResourcePermissions {
  2402. /**
  2403. * A list of principals to grant permissions on.
  2404. */
  2405. Principals: AssetBundlePrincipalList;
  2406. /**
  2407. * A list of IAM actions to grant permissions on.
  2408. */
  2409. Actions: ActionList;
  2410. }
  2411. export type AssetBundleRestrictiveResourceId = string;
  2412. export type AssetBundleRestrictiveResourceIdList = AssetBundleRestrictiveResourceId[];
  2413. export interface AssetOptions {
  2414. /**
  2415. * Determines the timezone for the analysis.
  2416. */
  2417. Timezone?: String;
  2418. /**
  2419. * Determines the week start day for an analysis.
  2420. */
  2421. WeekStart?: DayOfTheWeek;
  2422. }
  2423. export type AssignmentStatus = "ENABLED"|"DRAFT"|"DISABLED"|string;
  2424. export interface AthenaParameters {
  2425. /**
  2426. * The workgroup that Amazon Athena uses.
  2427. */
  2428. WorkGroup?: WorkGroup;
  2429. /**
  2430. * Use the RoleArn structure to override an account-wide role for a specific Athena data source. For example, say an account administrator has turned off all Athena access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow Athena access for the single Athena data source that is specified in the structure, even if the account-wide role forbidding Athena access is still active.
  2431. */
  2432. RoleArn?: RoleArn;
  2433. }
  2434. export interface AttributeAggregationFunction {
  2435. /**
  2436. * The built-in aggregation functions for attributes. UNIQUE_VALUE: Returns the unique value for a field, aggregated by the dimension fields.
  2437. */
  2438. SimpleAttributeAggregation?: SimpleAttributeAggregationFunction;
  2439. /**
  2440. * Used by the UNIQUE_VALUE aggregation function. If there are multiple values for the field used by the aggregation, the value for this property will be returned instead. Defaults to '*'.
  2441. */
  2442. ValueForMultipleValues?: String;
  2443. }
  2444. export interface AuroraParameters {
  2445. /**
  2446. * Host.
  2447. */
  2448. Host: Host;
  2449. /**
  2450. * Port.
  2451. */
  2452. Port: Port;
  2453. /**
  2454. * Database.
  2455. */
  2456. Database: Database;
  2457. }
  2458. export interface AuroraPostgreSqlParameters {
  2459. /**
  2460. * The Amazon Aurora PostgreSQL-Compatible host to connect to.
  2461. */
  2462. Host: Host;
  2463. /**
  2464. * The port that Amazon Aurora PostgreSQL is listening on.
  2465. */
  2466. Port: Port;
  2467. /**
  2468. * The Amazon Aurora PostgreSQL database to connect to.
  2469. */
  2470. Database: Database;
  2471. }
  2472. export type AuthenticationMethodOption = "IAM_AND_QUICKSIGHT"|"IAM_ONLY"|"ACTIVE_DIRECTORY"|"IAM_IDENTITY_CENTER"|string;
  2473. export type AuthorSpecifiedAggregation = "COUNT"|"DISTINCT_COUNT"|"MIN"|"MAX"|"MEDIAN"|"SUM"|"AVERAGE"|"STDEV"|"STDEVP"|"VAR"|"VARP"|"PERCENTILE"|string;
  2474. export type AuthorSpecifiedAggregations = AuthorSpecifiedAggregation[];
  2475. export interface AuthorizedTargetsByService {
  2476. /**
  2477. * The name of the Amazon Web Services service.
  2478. */
  2479. Service?: ServiceType;
  2480. /**
  2481. * Aist of authorized targets that are represented by IAM Identity Center application ARNs.
  2482. */
  2483. AuthorizedTargets?: AuthorizedTargetsList;
  2484. }
  2485. export type AuthorizedTargetsByServices = AuthorizedTargetsByService[];
  2486. export type AuthorizedTargetsList = String[];
  2487. export type AwsAccountId = string;
  2488. export type AwsAndAccountId = string;
  2489. export interface AwsIotAnalyticsParameters {
  2490. /**
  2491. * Dataset name.
  2492. */
  2493. DataSetName: DataSetName;
  2494. }
  2495. export type AxisBinding = "PRIMARY_YAXIS"|"SECONDARY_YAXIS"|string;
  2496. export interface AxisDataOptions {
  2497. /**
  2498. * The options for an axis with a numeric field.
  2499. */
  2500. NumericAxisOptions?: NumericAxisOptions;
  2501. /**
  2502. * The options for an axis with a date field.
  2503. */
  2504. DateAxisOptions?: DateAxisOptions;
  2505. }
  2506. export interface AxisDisplayDataDrivenRange {
  2507. }
  2508. export interface AxisDisplayMinMaxRange {
  2509. /**
  2510. * The minimum setup for an axis display range.
  2511. */
  2512. Minimum?: Double;
  2513. /**
  2514. * The maximum setup for an axis display range.
  2515. */
  2516. Maximum?: Double;
  2517. }
  2518. export interface AxisDisplayOptions {
  2519. /**
  2520. * The tick label options of an axis.
  2521. */
  2522. TickLabelOptions?: AxisTickLabelOptions;
  2523. /**
  2524. * Determines whether or not the axis line is visible.
  2525. */
  2526. AxisLineVisibility?: Visibility;
  2527. /**
  2528. * Determines whether or not the grid line is visible.
  2529. */
  2530. GridLineVisibility?: Visibility;
  2531. /**
  2532. * The data options for an axis.
  2533. */
  2534. DataOptions?: AxisDataOptions;
  2535. /**
  2536. * The scroll bar options for an axis.
  2537. */
  2538. ScrollbarOptions?: ScrollBarOptions;
  2539. /**
  2540. * The offset value that determines the starting placement of the axis within a visual's bounds.
  2541. */
  2542. AxisOffset?: PixelLength;
  2543. }
  2544. export interface AxisDisplayRange {
  2545. /**
  2546. * The minimum and maximum setup of an axis display range.
  2547. */
  2548. MinMax?: AxisDisplayMinMaxRange;
  2549. /**
  2550. * The data-driven setup of an axis display range.
  2551. */
  2552. DataDriven?: AxisDisplayDataDrivenRange;
  2553. }
  2554. export interface AxisLabelOptions {
  2555. /**
  2556. * The font configuration of the axis label.
  2557. */
  2558. FontConfiguration?: FontConfiguration;
  2559. /**
  2560. * The text for the axis label.
  2561. */
  2562. CustomLabel?: String;
  2563. /**
  2564. * The options that indicate which field the label belongs to.
  2565. */
  2566. ApplyTo?: AxisLabelReferenceOptions;
  2567. }
  2568. export type AxisLabelOptionsList = AxisLabelOptions[];
  2569. export interface AxisLabelReferenceOptions {
  2570. /**
  2571. * The field that the axis label is targeted to.
  2572. */
  2573. FieldId: FieldId;
  2574. /**
  2575. * The column that the axis label is targeted to.
  2576. */
  2577. Column: ColumnIdentifier;
  2578. }
  2579. export interface AxisLinearScale {
  2580. /**
  2581. * The step count setup of a linear axis.
  2582. */
  2583. StepCount?: Integer;
  2584. /**
  2585. * The step size setup of a linear axis.
  2586. */
  2587. StepSize?: Double;
  2588. }
  2589. export interface AxisLogarithmicScale {
  2590. /**
  2591. * The base setup of a logarithmic axis scale.
  2592. */
  2593. Base?: Double;
  2594. }
  2595. export interface AxisScale {
  2596. /**
  2597. * The linear axis scale setup.
  2598. */
  2599. Linear?: AxisLinearScale;
  2600. /**
  2601. * The logarithmic axis scale setup.
  2602. */
  2603. Logarithmic?: AxisLogarithmicScale;
  2604. }
  2605. export interface AxisTickLabelOptions {
  2606. /**
  2607. * Determines whether or not the axis ticks are visible.
  2608. */
  2609. LabelOptions?: LabelOptions;
  2610. /**
  2611. * The rotation angle of the axis tick labels.
  2612. */
  2613. RotationAngle?: Double;
  2614. }
  2615. export interface BarChartAggregatedFieldWells {
  2616. /**
  2617. * The category (y-axis) field well of a bar chart.
  2618. */
  2619. Category?: DimensionFieldList;
  2620. /**
  2621. * The value field wells of a bar chart. Values are aggregated by category.
  2622. */
  2623. Values?: MeasureFieldList;
  2624. /**
  2625. * The color (group/color) field well of a bar chart.
  2626. */
  2627. Colors?: DimensionFieldList;
  2628. /**
  2629. * The small multiples field well of a bar chart.
  2630. */
  2631. SmallMultiples?: SmallMultiplesDimensionFieldList;
  2632. }
  2633. export interface BarChartConfiguration {
  2634. /**
  2635. * The field wells of the visual.
  2636. */
  2637. FieldWells?: BarChartFieldWells;
  2638. /**
  2639. * The sort configuration of a BarChartVisual.
  2640. */
  2641. SortConfiguration?: BarChartSortConfiguration;
  2642. /**
  2643. * The orientation of the bars in a bar chart visual. There are two valid values in this structure: HORIZONTAL: Used for charts that have horizontal bars. Visuals that use this value are horizontal bar charts, horizontal stacked bar charts, and horizontal stacked 100% bar charts. VERTICAL: Used for charts that have vertical bars. Visuals that use this value are vertical bar charts, vertical stacked bar charts, and vertical stacked 100% bar charts.
  2644. */
  2645. Orientation?: BarChartOrientation;
  2646. /**
  2647. * Determines the arrangement of the bars. The orientation and arrangement of bars determine the type of bar that is used in the visual.
  2648. */
  2649. BarsArrangement?: BarsArrangement;
  2650. /**
  2651. * The palette (chart color) display setup of the visual.
  2652. */
  2653. VisualPalette?: VisualPalette;
  2654. /**
  2655. * The small multiples setup for the visual.
  2656. */
  2657. SmallMultiplesOptions?: SmallMultiplesOptions;
  2658. /**
  2659. * The label display options (grid line, range, scale, axis step) for bar chart category.
  2660. */
  2661. CategoryAxis?: AxisDisplayOptions;
  2662. /**
  2663. * The label options (label text, label visibility and sort icon visibility) for a bar chart.
  2664. */
  2665. CategoryLabelOptions?: ChartAxisLabelOptions;
  2666. /**
  2667. * The label display options (grid line, range, scale, axis step) for a bar chart value.
  2668. */
  2669. ValueAxis?: AxisDisplayOptions;
  2670. /**
  2671. * The label options (label text, label visibility and sort icon visibility) for a bar chart value.
  2672. */
  2673. ValueLabelOptions?: ChartAxisLabelOptions;
  2674. /**
  2675. * The label options (label text, label visibility and sort icon visibility) for a color that is used in a bar chart.
  2676. */
  2677. ColorLabelOptions?: ChartAxisLabelOptions;
  2678. /**
  2679. * The legend display setup of the visual.
  2680. */
  2681. Legend?: LegendOptions;
  2682. /**
  2683. * The options that determine if visual data labels are displayed.
  2684. */
  2685. DataLabels?: DataLabelOptions;
  2686. /**
  2687. * The tooltip display setup of the visual.
  2688. */
  2689. Tooltip?: TooltipOptions;
  2690. /**
  2691. * The reference line setup of the visual.
  2692. */
  2693. ReferenceLines?: ReferenceLineList;
  2694. /**
  2695. * The contribution analysis (anomaly configuration) setup of the visual.
  2696. */
  2697. ContributionAnalysisDefaults?: ContributionAnalysisDefaultList;
  2698. /**
  2699. * The general visual interactions setup for a visual.
  2700. */
  2701. Interactions?: VisualInteractionOptions;
  2702. }
  2703. export interface BarChartFieldWells {
  2704. /**
  2705. * The aggregated field wells of a bar chart.
  2706. */
  2707. BarChartAggregatedFieldWells?: BarChartAggregatedFieldWells;
  2708. }
  2709. export type BarChartOrientation = "HORIZONTAL"|"VERTICAL"|string;
  2710. export interface BarChartSortConfiguration {
  2711. /**
  2712. * The sort configuration of category fields.
  2713. */
  2714. CategorySort?: FieldSortOptionsList;
  2715. /**
  2716. * The limit on the number of categories displayed in a bar chart.
  2717. */
  2718. CategoryItemsLimit?: ItemsLimitConfiguration;
  2719. /**
  2720. * The sort configuration of color fields in a bar chart.
  2721. */
  2722. ColorSort?: FieldSortOptionsList;
  2723. /**
  2724. * The limit on the number of values displayed in a bar chart.
  2725. */
  2726. ColorItemsLimit?: ItemsLimitConfiguration;
  2727. /**
  2728. * The sort configuration of the small multiples field.
  2729. */
  2730. SmallMultiplesSort?: FieldSortOptionsList;
  2731. /**
  2732. * The limit on the number of small multiples panels that are displayed.
  2733. */
  2734. SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration;
  2735. }
  2736. export interface BarChartVisual {
  2737. /**
  2738. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  2739. */
  2740. VisualId: ShortRestrictiveResourceId;
  2741. /**
  2742. * The title that is displayed on the visual.
  2743. */
  2744. Title?: VisualTitleLabelOptions;
  2745. /**
  2746. * The subtitle that is displayed on the visual.
  2747. */
  2748. Subtitle?: VisualSubtitleLabelOptions;
  2749. /**
  2750. * The configuration settings of the visual.
  2751. */
  2752. ChartConfiguration?: BarChartConfiguration;
  2753. /**
  2754. * The list of custom actions that are configured for a visual.
  2755. */
  2756. Actions?: VisualCustomActionList;
  2757. /**
  2758. * The column hierarchy that is used during drill-downs and drill-ups.
  2759. */
  2760. ColumnHierarchies?: ColumnHierarchyList;
  2761. }
  2762. export type BarsArrangement = "CLUSTERED"|"STACKED"|"STACKED_PERCENT"|string;
  2763. export type BaseMapStyleType = "LIGHT_GRAY"|"DARK_GRAY"|"STREET"|"IMAGERY"|string;
  2764. export interface BigQueryParameters {
  2765. /**
  2766. * The Google Cloud Platform project ID where your datasource was created.
  2767. */
  2768. ProjectId: ProjectId;
  2769. /**
  2770. * The storage location where you create a Google BigQuery data source.
  2771. */
  2772. DataSetRegion?: DataSetRegion;
  2773. }
  2774. export type BinCountLimit = number;
  2775. export interface BinCountOptions {
  2776. /**
  2777. * The options that determine the bin count value.
  2778. */
  2779. Value?: BinCountValue;
  2780. }
  2781. export type BinCountValue = number;
  2782. export interface BinWidthOptions {
  2783. /**
  2784. * The options that determine the bin width value.
  2785. */
  2786. Value?: BinWidthValue;
  2787. /**
  2788. * The options that determine the bin count limit.
  2789. */
  2790. BinCountLimit?: BinCountLimit;
  2791. }
  2792. export type BinWidthValue = number;
  2793. export interface BodySectionConfiguration {
  2794. /**
  2795. * The unique identifier of a body section.
  2796. */
  2797. SectionId: ShortRestrictiveResourceId;
  2798. /**
  2799. * The configuration of content in a body section.
  2800. */
  2801. Content: BodySectionContent;
  2802. /**
  2803. * The style options of a body section.
  2804. */
  2805. Style?: SectionStyle;
  2806. /**
  2807. * The configuration of a page break for a section.
  2808. */
  2809. PageBreakConfiguration?: SectionPageBreakConfiguration;
  2810. }
  2811. export type BodySectionConfigurationList = BodySectionConfiguration[];
  2812. export interface BodySectionContent {
  2813. /**
  2814. * The layout configuration of a body section.
  2815. */
  2816. Layout?: SectionLayoutConfiguration;
  2817. }
  2818. export interface BookmarksConfigurations {
  2819. /**
  2820. * A Boolean value that determines whether a user can bookmark an embedded dashboard.
  2821. */
  2822. Enabled: Boolean;
  2823. }
  2824. export type Boolean = boolean;
  2825. export type BooleanObject = boolean;
  2826. export interface BorderStyle {
  2827. /**
  2828. * The option to enable display of borders for visuals.
  2829. */
  2830. Show?: Boolean;
  2831. }
  2832. export interface BoxPlotAggregatedFieldWells {
  2833. /**
  2834. * The group by field well of a box plot chart. Values are grouped based on group by fields.
  2835. */
  2836. GroupBy?: BoxPlotDimensionFieldList;
  2837. /**
  2838. * The value field well of a box plot chart. Values are aggregated based on group by fields.
  2839. */
  2840. Values?: BoxPlotMeasureFieldList;
  2841. }
  2842. export interface BoxPlotChartConfiguration {
  2843. /**
  2844. * The field wells of the visual.
  2845. */
  2846. FieldWells?: BoxPlotFieldWells;
  2847. /**
  2848. * The sort configuration of a BoxPlotVisual.
  2849. */
  2850. SortConfiguration?: BoxPlotSortConfiguration;
  2851. /**
  2852. * The box plot chart options for a box plot visual
  2853. */
  2854. BoxPlotOptions?: BoxPlotOptions;
  2855. /**
  2856. * The label display options (grid line, range, scale, axis step) of a box plot category.
  2857. */
  2858. CategoryAxis?: AxisDisplayOptions;
  2859. /**
  2860. * The label options (label text, label visibility and sort Icon visibility) of a box plot category.
  2861. */
  2862. CategoryLabelOptions?: ChartAxisLabelOptions;
  2863. /**
  2864. * The label display options (grid line, range, scale, axis step) of a box plot category.
  2865. */
  2866. PrimaryYAxisDisplayOptions?: AxisDisplayOptions;
  2867. /**
  2868. * The label options (label text, label visibility and sort icon visibility) of a box plot value.
  2869. */
  2870. PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
  2871. Legend?: LegendOptions;
  2872. /**
  2873. * The tooltip display setup of the visual.
  2874. */
  2875. Tooltip?: TooltipOptions;
  2876. /**
  2877. * The reference line setup of the visual.
  2878. */
  2879. ReferenceLines?: ReferenceLineList;
  2880. /**
  2881. * The palette (chart color) display setup of the visual.
  2882. */
  2883. VisualPalette?: VisualPalette;
  2884. /**
  2885. * The general visual interactions setup for a visual.
  2886. */
  2887. Interactions?: VisualInteractionOptions;
  2888. }
  2889. export type BoxPlotDimensionFieldList = DimensionField[];
  2890. export interface BoxPlotFieldWells {
  2891. /**
  2892. * The aggregated field wells of a box plot.
  2893. */
  2894. BoxPlotAggregatedFieldWells?: BoxPlotAggregatedFieldWells;
  2895. }
  2896. export type BoxPlotFillStyle = "SOLID"|"TRANSPARENT"|string;
  2897. export type BoxPlotMeasureFieldList = MeasureField[];
  2898. export interface BoxPlotOptions {
  2899. /**
  2900. * The style options of the box plot.
  2901. */
  2902. StyleOptions?: BoxPlotStyleOptions;
  2903. /**
  2904. * Determines the visibility of the outlier in a box plot.
  2905. */
  2906. OutlierVisibility?: Visibility;
  2907. /**
  2908. * Determines the visibility of all data points of the box plot.
  2909. */
  2910. AllDataPointsVisibility?: Visibility;
  2911. }
  2912. export interface BoxPlotSortConfiguration {
  2913. /**
  2914. * The sort configuration of a group by fields.
  2915. */
  2916. CategorySort?: FieldSortOptionsList;
  2917. /**
  2918. * The pagination configuration of a table visual or box plot.
  2919. */
  2920. PaginationConfiguration?: PaginationConfiguration;
  2921. }
  2922. export interface BoxPlotStyleOptions {
  2923. /**
  2924. * The fill styles (solid, transparent) of the box plot.
  2925. */
  2926. FillStyle?: BoxPlotFillStyle;
  2927. }
  2928. export interface BoxPlotVisual {
  2929. /**
  2930. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
  2931. */
  2932. VisualId: ShortRestrictiveResourceId;
  2933. /**
  2934. * The title that is displayed on the visual.
  2935. */
  2936. Title?: VisualTitleLabelOptions;
  2937. /**
  2938. * The subtitle that is displayed on the visual.
  2939. */
  2940. Subtitle?: VisualSubtitleLabelOptions;
  2941. /**
  2942. * The configuration settings of the visual.
  2943. */
  2944. ChartConfiguration?: BoxPlotChartConfiguration;
  2945. /**
  2946. * The list of custom actions that are configured for a visual.
  2947. */
  2948. Actions?: VisualCustomActionList;
  2949. /**
  2950. * The column hierarchy that is used during drill-downs and drill-ups.
  2951. */
  2952. ColumnHierarchies?: ColumnHierarchyList;
  2953. }
  2954. export type CIDR = string;
  2955. export interface CalculatedColumn {
  2956. /**
  2957. * Column name.
  2958. */
  2959. ColumnName: ColumnName;
  2960. /**
  2961. * A unique ID to identify a calculated column. During a dataset update, if the column ID of a calculated column matches that of an existing calculated column, Amazon QuickSight preserves the existing calculated column.
  2962. */
  2963. ColumnId: ColumnId;
  2964. /**
  2965. * An expression that defines the calculated column.
  2966. */
  2967. Expression: Expression;
  2968. }
  2969. export type CalculatedColumnList = CalculatedColumn[];
  2970. export interface CalculatedField {
  2971. /**
  2972. * The data set that is used in this calculated field.
  2973. */
  2974. DataSetIdentifier: DataSetIdentifier;
  2975. /**
  2976. * The name of the calculated field.
  2977. */
  2978. Name: ColumnName;
  2979. /**
  2980. * The expression of the calculated field.
  2981. */
  2982. Expression: CalculatedFieldExpression;
  2983. }
  2984. export type CalculatedFieldExpression = string;
  2985. export type CalculatedFields = CalculatedField[];
  2986. export interface CalculatedMeasureField {
  2987. /**
  2988. * The custom field ID.
  2989. */
  2990. FieldId: FieldId;
  2991. /**
  2992. * The expression in the table calculation.
  2993. */
  2994. Expression: Expression;
  2995. }
  2996. export interface CancelIngestionRequest {
  2997. /**
  2998. * The Amazon Web Services account ID.
  2999. */
  3000. AwsAccountId: AwsAccountId;
  3001. /**
  3002. * The ID of the dataset used in the ingestion.
  3003. */
  3004. DataSetId: String;
  3005. /**
  3006. * An ID for the ingestion.
  3007. */
  3008. IngestionId: IngestionId;
  3009. }
  3010. export interface CancelIngestionResponse {
  3011. /**
  3012. * The Amazon Resource Name (ARN) for the data ingestion.
  3013. */
  3014. Arn?: Arn;
  3015. /**
  3016. * An ID for the ingestion.
  3017. */
  3018. IngestionId?: IngestionId;
  3019. /**
  3020. * The Amazon Web Services request ID for this operation.
  3021. */
  3022. RequestId?: String;
  3023. /**
  3024. * The HTTP status of the request.
  3025. */
  3026. Status?: StatusCode;
  3027. }
  3028. export interface CascadingControlConfiguration {
  3029. /**
  3030. * A list of source controls that determine the values that are used in the current control.
  3031. */
  3032. SourceControls?: CascadingControlSourceList;
  3033. }
  3034. export interface CascadingControlSource {
  3035. /**
  3036. * The source sheet control ID of a CascadingControlSource.
  3037. */
  3038. SourceSheetControlId?: String;
  3039. /**
  3040. * The column identifier that determines which column to look up for the source sheet control.
  3041. */
  3042. ColumnToMatch?: ColumnIdentifier;
  3043. }
  3044. export type CascadingControlSourceList = CascadingControlSource[];
  3045. export interface CastColumnTypeOperation {
  3046. /**
  3047. * Column name.
  3048. */
  3049. ColumnName: ColumnName;
  3050. /**
  3051. * New column data type.
  3052. */
  3053. NewColumnType: ColumnDataType;
  3054. /**
  3055. * The sub data type of the new column. Sub types are only available for decimal columns that are part of a SPICE dataset.
  3056. */
  3057. SubType?: ColumnDataSubType;
  3058. /**
  3059. * When casting a column from string to datetime type, you can supply a string in a format supported by Amazon QuickSight to denote the source data format.
  3060. */
  3061. Format?: TypeCastFormat;
  3062. }
  3063. export type Catalog = string;
  3064. export type CategoricalAggregationFunction = "COUNT"|"DISTINCT_COUNT"|string;
  3065. export interface CategoricalDimensionField {
  3066. /**
  3067. * The custom field ID.
  3068. */
  3069. FieldId: FieldId;
  3070. /**
  3071. * The column that is used in the CategoricalDimensionField.
  3072. */
  3073. Column: ColumnIdentifier;
  3074. /**
  3075. * The custom hierarchy ID.
  3076. */
  3077. HierarchyId?: HierarchyId;
  3078. /**
  3079. * The format configuration of the field.
  3080. */
  3081. FormatConfiguration?: StringFormatConfiguration;
  3082. }
  3083. export interface CategoricalMeasureField {
  3084. /**
  3085. * The custom field ID.
  3086. */
  3087. FieldId: FieldId;
  3088. /**
  3089. * The column that is used in the CategoricalMeasureField.
  3090. */
  3091. Column: ColumnIdentifier;
  3092. /**
  3093. * The aggregation function of the measure field.
  3094. */
  3095. AggregationFunction?: CategoricalAggregationFunction;
  3096. /**
  3097. * The format configuration of the field.
  3098. */
  3099. FormatConfiguration?: StringFormatConfiguration;
  3100. }
  3101. export interface CategoryDrillDownFilter {
  3102. /**
  3103. * The column that the filter is applied to.
  3104. */
  3105. Column: ColumnIdentifier;
  3106. /**
  3107. * A list of the string inputs that are the values of the category drill down filter.
  3108. */
  3109. CategoryValues: CategoryValueList;
  3110. }
  3111. export interface CategoryFilter {
  3112. /**
  3113. * An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
  3114. */
  3115. FilterId: ShortRestrictiveResourceId;
  3116. /**
  3117. * The column that the filter is applied to.
  3118. */
  3119. Column: ColumnIdentifier;
  3120. /**
  3121. * The configuration for a CategoryFilter.
  3122. */
  3123. Configuration: CategoryFilterConfiguration;
  3124. /**
  3125. * The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
  3126. */
  3127. DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
  3128. }
  3129. export interface CategoryFilterConfiguration {
  3130. /**
  3131. * A list of filter configurations. In the Amazon QuickSight console, this filter type is called a filter list.
  3132. */
  3133. FilterListConfiguration?: FilterListConfiguration;
  3134. /**
  3135. * A list of custom filter values. In the Amazon QuickSight console, this filter type is called a custom filter list.
  3136. */
  3137. CustomFilterListConfiguration?: CustomFilterListConfiguration;
  3138. /**
  3139. * A custom filter that filters based on a single value. This filter can be partially matched.
  3140. */
  3141. CustomFilterConfiguration?: CustomFilterConfiguration;
  3142. }
  3143. export type CategoryFilterFunction = "EXACT"|"CONTAINS"|string;
  3144. export type CategoryFilterMatchOperator = "EQUALS"|"DOES_NOT_EQUAL"|"CONTAINS"|"DOES_NOT_CONTAIN"|"STARTS_WITH"|"ENDS_WITH"|string;
  3145. export type CategoryFilterSelectAllOptions = "FILTER_ALL_VALUES"|string;
  3146. export type CategoryFilterType = "CUSTOM_FILTER"|"CUSTOM_FILTER_LIST"|"FILTER_LIST"|string;
  3147. export type CategoryValue = string;
  3148. export type CategoryValueList = CategoryValue[];
  3149. export interface CellValueSynonym {
  3150. /**
  3151. * The cell value.
  3152. */
  3153. CellValue?: LimitedString;
  3154. /**
  3155. * Other names or aliases for the cell value.
  3156. */
  3157. Synonyms?: StringList;
  3158. }
  3159. export type CellValueSynonyms = CellValueSynonym[];
  3160. export interface ChartAxisLabelOptions {
  3161. /**
  3162. * The visibility of an axis label on a chart. Choose one of the following options: VISIBLE: Shows the axis. HIDDEN: Hides the axis.
  3163. */
  3164. Visibility?: Visibility;
  3165. /**
  3166. * The visibility configuration of the sort icon on a chart's axis label.
  3167. */
  3168. SortIconVisibility?: Visibility;
  3169. /**
  3170. * The label options for a chart axis.
  3171. */
  3172. AxisLabelOptions?: AxisLabelOptionsList;
  3173. }
  3174. export type ClusterId = string;
  3175. export interface ClusterMarker {
  3176. /**
  3177. * The simple cluster marker of the cluster marker.
  3178. */
  3179. SimpleClusterMarker?: SimpleClusterMarker;
  3180. }
  3181. export interface ClusterMarkerConfiguration {
  3182. /**
  3183. * The cluster marker that is a part of the cluster marker configuration.
  3184. */
  3185. ClusterMarker?: ClusterMarker;
  3186. }
  3187. export interface CollectiveConstant {
  3188. /**
  3189. * A list of values for the collective constant.
  3190. */
  3191. ValueList?: StringList;
  3192. }
  3193. export type ColorFillType = "DISCRETE"|"GRADIENT"|string;
  3194. export type ColorList = HexColor[];
  3195. export interface ColorScale {
  3196. /**
  3197. * Determines the list of colors that are applied to the visual.
  3198. */
  3199. Colors: ColorScaleColorList;
  3200. /**
  3201. * Determines the color fill type.
  3202. */
  3203. ColorFillType: ColorFillType;
  3204. /**
  3205. * Determines the color that is applied to null values.
  3206. */
  3207. NullValueColor?: DataColor;
  3208. }
  3209. export type ColorScaleColorList = DataColor[];
  3210. export interface ColorsConfiguration {
  3211. /**
  3212. * A list of up to 50 custom colors.
  3213. */
  3214. CustomColors?: CustomColorsList;
  3215. }
  3216. export interface ColumnConfiguration {
  3217. /**
  3218. * The column.
  3219. */
  3220. Column: ColumnIdentifier;
  3221. /**
  3222. * The format configuration of a column.
  3223. */
  3224. FormatConfiguration?: FormatConfiguration;
  3225. /**
  3226. * The role of the column.
  3227. */
  3228. Role?: ColumnRole;
  3229. /**
  3230. * The color configurations of the column.
  3231. */
  3232. ColorsConfiguration?: ColorsConfiguration;
  3233. }
  3234. export type ColumnConfigurationList = ColumnConfiguration[];
  3235. export type ColumnDataRole = "DIMENSION"|"MEASURE"|string;
  3236. export type ColumnDataSubType = "FLOAT"|"FIXED"|string;
  3237. export type ColumnDataType = "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|string;
  3238. export interface ColumnDescription {
  3239. /**
  3240. * The text of a description for a column.
  3241. */
  3242. Text?: ColumnDescriptiveText;
  3243. }
  3244. export type ColumnDescriptiveText = string;
  3245. export interface ColumnGroup {
  3246. /**
  3247. * Geospatial column group that denotes a hierarchy.
  3248. */
  3249. GeoSpatialColumnGroup?: GeoSpatialColumnGroup;
  3250. }
  3251. export interface ColumnGroupColumnSchema {
  3252. /**
  3253. * The name of the column group's column schema.
  3254. */
  3255. Name?: String;
  3256. }
  3257. export type ColumnGroupColumnSchemaList = ColumnGroupColumnSchema[];
  3258. export type ColumnGroupList = ColumnGroup[];
  3259. export type ColumnGroupName = string;
  3260. export interface ColumnGroupSchema {
  3261. /**
  3262. * The name of the column group schema.
  3263. */
  3264. Name?: String;
  3265. /**
  3266. * A structure containing the list of schemas for column group columns.
  3267. */
  3268. ColumnGroupColumnSchemaList?: ColumnGroupColumnSchemaList;
  3269. }
  3270. export type ColumnGroupSchemaList = ColumnGroupSchema[];
  3271. export interface ColumnHierarchy {
  3272. /**
  3273. * The option that determines the hierarchy of the fields that are built within a visual's field wells. These fields can't be duplicated to other visuals.
  3274. */
  3275. ExplicitHierarchy?: ExplicitHierarchy;
  3276. /**
  3277. * The option that determines the hierarchy of any DateTime fields.
  3278. */
  3279. DateTimeHierarchy?: DateTimeHierarchy;
  3280. /**
  3281. * The option that determines the hierarchy of the fields that are defined during data preparation. These fields are available to use in any analysis that uses the data source.
  3282. */
  3283. PredefinedHierarchy?: PredefinedHierarchy;
  3284. }
  3285. export type ColumnHierarchyList = ColumnHierarchy[];
  3286. export type ColumnId = string;
  3287. export interface ColumnIdentifier {
  3288. /**
  3289. * The data set that the column belongs to.
  3290. */
  3291. DataSetIdentifier: DataSetIdentifier;
  3292. /**
  3293. * The name of the column.
  3294. */
  3295. ColumnName: ColumnName;
  3296. }
  3297. export interface ColumnLevelPermissionRule {
  3298. /**
  3299. * An array of Amazon Resource Names (ARNs) for Amazon QuickSight users or groups.
  3300. */
  3301. Principals?: PrincipalList;
  3302. /**
  3303. * An array of column names.
  3304. */
  3305. ColumnNames?: ColumnNameList;
  3306. }
  3307. export type ColumnLevelPermissionRuleList = ColumnLevelPermissionRule[];
  3308. export type ColumnList = ColumnName[];
  3309. export type ColumnName = string;
  3310. export type ColumnNameList = String[];
  3311. export type ColumnOrderingType = "GREATER_IS_BETTER"|"LESSER_IS_BETTER"|"SPECIFIED"|string;
  3312. export type ColumnRole = "DIMENSION"|"MEASURE"|string;
  3313. export interface ColumnSchema {
  3314. /**
  3315. * The name of the column schema.
  3316. */
  3317. Name?: String;
  3318. /**
  3319. * The data type of the column schema.
  3320. */
  3321. DataType?: String;
  3322. /**
  3323. * The geographic role of the column schema.
  3324. */
  3325. GeographicRole?: String;
  3326. }
  3327. export type ColumnSchemaList = ColumnSchema[];
  3328. export interface ColumnSort {
  3329. SortBy: ColumnIdentifier;
  3330. /**
  3331. * The sort direction.
  3332. */
  3333. Direction: SortDirection;
  3334. /**
  3335. * The aggregation function that is defined in the column sort.
  3336. */
  3337. AggregationFunction?: AggregationFunction;
  3338. }
  3339. export interface ColumnTag {
  3340. /**
  3341. * A geospatial role for a column.
  3342. */
  3343. ColumnGeographicRole?: GeoSpatialDataRole;
  3344. /**
  3345. * A description for a column.
  3346. */
  3347. ColumnDescription?: ColumnDescription;
  3348. }
  3349. export type ColumnTagList = ColumnTag[];
  3350. export type ColumnTagName = "COLUMN_GEOGRAPHIC_ROLE"|"COLUMN_DESCRIPTION"|string;
  3351. export type ColumnTagNames = ColumnTagName[];
  3352. export interface ColumnTooltipItem {
  3353. /**
  3354. * The target column of the tooltip item.
  3355. */
  3356. Column: ColumnIdentifier;
  3357. /**
  3358. * The label of the tooltip item.
  3359. */
  3360. Label?: String;
  3361. /**
  3362. * The visibility of the tooltip item.
  3363. */
  3364. Visibility?: Visibility;
  3365. /**
  3366. * The aggregation function of the column tooltip item.
  3367. */
  3368. Aggregation?: AggregationFunction;
  3369. /**
  3370. * Determines the target of the column tooltip item in a combo chart visual.
  3371. */
  3372. TooltipTarget?: TooltipTarget;
  3373. }
  3374. export interface ComboChartAggregatedFieldWells {
  3375. /**
  3376. * The aggregated category field wells of a combo chart.
  3377. */
  3378. Category?: DimensionFieldList;
  3379. /**
  3380. * The aggregated BarValues field well of a combo chart.
  3381. */
  3382. BarValues?: MeasureFieldList;
  3383. /**
  3384. * The aggregated colors field well of a combo chart.
  3385. */
  3386. Colors?: DimensionFieldList;
  3387. /**
  3388. * The aggregated LineValues field well of a combo chart.
  3389. */
  3390. LineValues?: MeasureFieldList;
  3391. }
  3392. export interface ComboChartConfiguration {
  3393. /**
  3394. * The field wells of the visual.
  3395. */
  3396. FieldWells?: ComboChartFieldWells;
  3397. /**
  3398. * The sort configuration of a ComboChartVisual.
  3399. */
  3400. SortConfiguration?: ComboChartSortConfiguration;
  3401. /**
  3402. * Determines the bar arrangement in a combo chart. The following are valid values in this structure: CLUSTERED: For clustered bar combo charts. STACKED: For stacked bar combo charts. STACKED_PERCENT: Do not use. If you use this value, the operation returns a validation error.
  3403. */
  3404. BarsArrangement?: BarsArrangement;
  3405. /**
  3406. * The category axis of a combo chart.
  3407. */
  3408. CategoryAxis?: AxisDisplayOptions;
  3409. /**
  3410. * The label options (label text, label visibility, and sort icon visibility) of a combo chart category (group/color) field well.
  3411. */
  3412. CategoryLabelOptions?: ChartAxisLabelOptions;
  3413. /**
  3414. * The label display options (grid line, range, scale, and axis step) of a combo chart's primary y-axis (bar) field well.
  3415. */
  3416. PrimaryYAxisDisplayOptions?: AxisDisplayOptions;
  3417. /**
  3418. * The label options (label text, label visibility, and sort icon visibility) of a combo chart's primary y-axis (bar) field well.
  3419. */
  3420. PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
  3421. /**
  3422. * The label display options (grid line, range, scale, axis step) of a combo chart's secondary y-axis (line) field well.
  3423. */
  3424. SecondaryYAxisDisplayOptions?: AxisDisplayOptions;
  3425. /**
  3426. * The label options (label text, label visibility, and sort icon visibility) of a combo chart's secondary y-axis(line) field well.
  3427. */
  3428. SecondaryYAxisLabelOptions?: ChartAxisLabelOptions;
  3429. SingleAxisOptions?: SingleAxisOptions;
  3430. /**
  3431. * The label options (label text, label visibility, and sort icon visibility) of a combo chart's color field well.
  3432. */
  3433. ColorLabelOptions?: ChartAxisLabelOptions;
  3434. /**
  3435. * The legend display setup of the visual.
  3436. */
  3437. Legend?: LegendOptions;
  3438. /**
  3439. * The options that determine if visual data labels are displayed. The data label options for a bar in a combo chart.
  3440. */
  3441. BarDataLabels?: DataLabelOptions;
  3442. /**
  3443. * The options that determine if visual data labels are displayed. The data label options for a line in a combo chart.
  3444. */
  3445. LineDataLabels?: DataLabelOptions;
  3446. /**
  3447. * The legend display setup of the visual.
  3448. */
  3449. Tooltip?: TooltipOptions;
  3450. /**
  3451. * The reference line setup of the visual.
  3452. */
  3453. ReferenceLines?: ReferenceLineList;
  3454. /**
  3455. * The palette (chart color) display setup of the visual.
  3456. */
  3457. VisualPalette?: VisualPalette;
  3458. /**
  3459. * The general visual interactions setup for a visual.
  3460. */
  3461. Interactions?: VisualInteractionOptions;
  3462. }
  3463. export interface ComboChartFieldWells {
  3464. /**
  3465. * The aggregated field wells of a combo chart. Combo charts only have aggregated field wells. Columns in a combo chart are aggregated by category.
  3466. */
  3467. ComboChartAggregatedFieldWells?: ComboChartAggregatedFieldWells;
  3468. }
  3469. export interface ComboChartSortConfiguration {
  3470. /**
  3471. * The sort configuration of the category field well in a combo chart.
  3472. */
  3473. CategorySort?: FieldSortOptionsList;
  3474. /**
  3475. * The item limit configuration for the category field well of a combo chart.
  3476. */
  3477. CategoryItemsLimit?: ItemsLimitConfiguration;
  3478. /**
  3479. * The sort configuration of the color field well in a combo chart.
  3480. */
  3481. ColorSort?: FieldSortOptionsList;
  3482. /**
  3483. * The item limit configuration of the color field well in a combo chart.
  3484. */
  3485. ColorItemsLimit?: ItemsLimitConfiguration;
  3486. }
  3487. export interface ComboChartVisual {
  3488. /**
  3489. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  3490. */
  3491. VisualId: ShortRestrictiveResourceId;
  3492. /**
  3493. * The title that is displayed on the visual.
  3494. */
  3495. Title?: VisualTitleLabelOptions;
  3496. /**
  3497. * The subtitle that is displayed on the visual.
  3498. */
  3499. Subtitle?: VisualSubtitleLabelOptions;
  3500. /**
  3501. * The configuration settings of the visual.
  3502. */
  3503. ChartConfiguration?: ComboChartConfiguration;
  3504. /**
  3505. * The list of custom actions that are configured for a visual.
  3506. */
  3507. Actions?: VisualCustomActionList;
  3508. /**
  3509. * The column hierarchy that is used during drill-downs and drill-ups.
  3510. */
  3511. ColumnHierarchies?: ColumnHierarchyList;
  3512. }
  3513. export interface ComparativeOrder {
  3514. /**
  3515. * The ordering type for a column. Valid values for this structure are GREATER_IS_BETTER, LESSER_IS_BETTER and SPECIFIED.
  3516. */
  3517. UseOrdering?: ColumnOrderingType;
  3518. /**
  3519. * The list of columns to be used in the ordering.
  3520. */
  3521. SpecifedOrder?: StringList;
  3522. /**
  3523. * The treat of undefined specified values. Valid values for this structure are LEAST and MOST.
  3524. */
  3525. TreatUndefinedSpecifiedValues?: UndefinedSpecifiedValueType;
  3526. }
  3527. export interface ComparisonConfiguration {
  3528. /**
  3529. * The method of the comparison. Choose from the following options: DIFFERENCE PERCENT_DIFFERENCE PERCENT
  3530. */
  3531. ComparisonMethod?: ComparisonMethod;
  3532. /**
  3533. * The format of the comparison.
  3534. */
  3535. ComparisonFormat?: ComparisonFormatConfiguration;
  3536. }
  3537. export interface ComparisonFormatConfiguration {
  3538. /**
  3539. * The number display format.
  3540. */
  3541. NumberDisplayFormatConfiguration?: NumberDisplayFormatConfiguration;
  3542. /**
  3543. * The percentage display format.
  3544. */
  3545. PercentageDisplayFormatConfiguration?: PercentageDisplayFormatConfiguration;
  3546. }
  3547. export type ComparisonMethod = "DIFFERENCE"|"PERCENT_DIFFERENCE"|"PERCENT"|string;
  3548. export interface Computation {
  3549. /**
  3550. * The top ranked and bottom ranked computation configuration.
  3551. */
  3552. TopBottomRanked?: TopBottomRankedComputation;
  3553. /**
  3554. * The top movers and bottom movers computation configuration.
  3555. */
  3556. TopBottomMovers?: TopBottomMoversComputation;
  3557. /**
  3558. * The total aggregation computation configuration.
  3559. */
  3560. TotalAggregation?: TotalAggregationComputation;
  3561. /**
  3562. * The maximum and minimum computation configuration.
  3563. */
  3564. MaximumMinimum?: MaximumMinimumComputation;
  3565. /**
  3566. * The metric comparison computation configuration.
  3567. */
  3568. MetricComparison?: MetricComparisonComputation;
  3569. /**
  3570. * The period over period computation configuration.
  3571. */
  3572. PeriodOverPeriod?: PeriodOverPeriodComputation;
  3573. /**
  3574. * The period to DataSetIdentifier computation configuration.
  3575. */
  3576. PeriodToDate?: PeriodToDateComputation;
  3577. /**
  3578. * The growth rate computation configuration.
  3579. */
  3580. GrowthRate?: GrowthRateComputation;
  3581. /**
  3582. * The unique values computation configuration.
  3583. */
  3584. UniqueValues?: UniqueValuesComputation;
  3585. /**
  3586. * The forecast computation configuration.
  3587. */
  3588. Forecast?: ForecastComputation;
  3589. }
  3590. export type ComputationList = Computation[];
  3591. export interface ConditionalFormattingColor {
  3592. /**
  3593. * Formatting configuration for solid color.
  3594. */
  3595. Solid?: ConditionalFormattingSolidColor;
  3596. /**
  3597. * Formatting configuration for gradient color.
  3598. */
  3599. Gradient?: ConditionalFormattingGradientColor;
  3600. }
  3601. export interface ConditionalFormattingCustomIconCondition {
  3602. /**
  3603. * The expression that determines the condition of the icon set.
  3604. */
  3605. Expression: Expression;
  3606. /**
  3607. * Custom icon options for an icon set.
  3608. */
  3609. IconOptions: ConditionalFormattingCustomIconOptions;
  3610. /**
  3611. * Determines the color of the icon.
  3612. */
  3613. Color?: HexColor;
  3614. /**
  3615. * Determines the icon display configuration.
  3616. */
  3617. DisplayConfiguration?: ConditionalFormattingIconDisplayConfiguration;
  3618. }
  3619. export interface ConditionalFormattingCustomIconOptions {
  3620. /**
  3621. * Determines the type of icon.
  3622. */
  3623. Icon?: Icon;
  3624. /**
  3625. * Determines the Unicode icon type.
  3626. */
  3627. UnicodeIcon?: UnicodeIcon;
  3628. }
  3629. export interface ConditionalFormattingGradientColor {
  3630. /**
  3631. * The expression that determines the formatting configuration for gradient color.
  3632. */
  3633. Expression: Expression;
  3634. /**
  3635. * Determines the color.
  3636. */
  3637. Color: GradientColor;
  3638. }
  3639. export interface ConditionalFormattingIcon {
  3640. /**
  3641. * Formatting configuration for icon set.
  3642. */
  3643. IconSet?: ConditionalFormattingIconSet;
  3644. /**
  3645. * Determines the custom condition for an icon set.
  3646. */
  3647. CustomCondition?: ConditionalFormattingCustomIconCondition;
  3648. }
  3649. export interface ConditionalFormattingIconDisplayConfiguration {
  3650. /**
  3651. * Determines the icon display configuration.
  3652. */
  3653. IconDisplayOption?: ConditionalFormattingIconDisplayOption;
  3654. }
  3655. export type ConditionalFormattingIconDisplayOption = "ICON_ONLY"|string;
  3656. export interface ConditionalFormattingIconSet {
  3657. /**
  3658. * The expression that determines the formatting configuration for the icon set.
  3659. */
  3660. Expression: Expression;
  3661. /**
  3662. * Determines the icon set type.
  3663. */
  3664. IconSetType?: ConditionalFormattingIconSetType;
  3665. }
  3666. export type ConditionalFormattingIconSetType = "PLUS_MINUS"|"CHECK_X"|"THREE_COLOR_ARROW"|"THREE_GRAY_ARROW"|"CARET_UP_MINUS_DOWN"|"THREE_SHAPE"|"THREE_CIRCLE"|"FLAGS"|"BARS"|"FOUR_COLOR_ARROW"|"FOUR_GRAY_ARROW"|string;
  3667. export interface ConditionalFormattingSolidColor {
  3668. /**
  3669. * The expression that determines the formatting configuration for solid color.
  3670. */
  3671. Expression: Expression;
  3672. /**
  3673. * Determines the color.
  3674. */
  3675. Color?: HexColor;
  3676. }
  3677. export type ConstantType = "SINGULAR"|"RANGE"|"COLLECTIVE"|string;
  3678. export interface ContextMenuOption {
  3679. /**
  3680. * The availability status of the context menu options. If the value of this property is set to ENABLED, dashboard readers can interact with the context menu.
  3681. */
  3682. AvailabilityStatus?: DashboardBehavior;
  3683. }
  3684. export interface ContributionAnalysisDefault {
  3685. /**
  3686. * The measure field that is used in the contribution analysis.
  3687. */
  3688. MeasureFieldId: FieldId;
  3689. /**
  3690. * The dimensions columns that are used in the contribution analysis, usually a list of ColumnIdentifiers.
  3691. */
  3692. ContributorDimensions: ContributorDimensionList;
  3693. }
  3694. export type ContributionAnalysisDefaultList = ContributionAnalysisDefault[];
  3695. export type ContributorDimensionList = ColumnIdentifier[];
  3696. export type CopySourceArn = string;
  3697. export interface CreateAccountCustomizationRequest {
  3698. /**
  3699. * The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
  3700. */
  3701. AwsAccountId: AwsAccountId;
  3702. /**
  3703. * The Amazon QuickSight namespace that you want to add customizations to.
  3704. */
  3705. Namespace?: Namespace;
  3706. /**
  3707. * The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region. You can add these to an Amazon Web Services account and a QuickSight namespace. For example, you can add a default theme by setting AccountCustomization to the midnight theme: "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight::aws:theme/MIDNIGHT" }. Or, you can add a custom theme by specifying "AccountCustomization": { "DefaultTheme": "arn:aws:quicksight:us-west-2:111122223333:theme/bdb844d0-0fe9-4d9d-b520-0fe602d93639" }.
  3708. */
  3709. AccountCustomization: AccountCustomization;
  3710. /**
  3711. * A list of the tags that you want to attach to this resource.
  3712. */
  3713. Tags?: TagList;
  3714. }
  3715. export interface CreateAccountCustomizationResponse {
  3716. /**
  3717. * The Amazon Resource Name (ARN) for the customization that you created for this Amazon Web Services account.
  3718. */
  3719. Arn?: Arn;
  3720. /**
  3721. * The ID for the Amazon Web Services account that you want to customize Amazon QuickSight for.
  3722. */
  3723. AwsAccountId?: AwsAccountId;
  3724. /**
  3725. * The namespace associated with the customization you're creating.
  3726. */
  3727. Namespace?: Namespace;
  3728. /**
  3729. * The Amazon QuickSight customizations you're adding in the current Amazon Web Services Region.
  3730. */
  3731. AccountCustomization?: AccountCustomization;
  3732. /**
  3733. * The Amazon Web Services request ID for this operation.
  3734. */
  3735. RequestId?: String;
  3736. /**
  3737. * The HTTP status of the request.
  3738. */
  3739. Status?: StatusCode;
  3740. }
  3741. export interface CreateAccountSubscriptionRequest {
  3742. /**
  3743. * The edition of Amazon QuickSight that you want your account to have. Currently, you can choose from ENTERPRISE or ENTERPRISE_AND_Q. If you choose ENTERPRISE_AND_Q, the following parameters are required: FirstName LastName EmailAddress ContactNumber
  3744. */
  3745. Edition?: Edition;
  3746. /**
  3747. * The method that you want to use to authenticate your Amazon QuickSight account. If you choose ACTIVE_DIRECTORY, provide an ActiveDirectoryName and an AdminGroup associated with your Active Directory. If you choose IAM_IDENTITY_CENTER, provide an AdminGroup associated with your IAM Identity Center account.
  3748. */
  3749. AuthenticationMethod: AuthenticationMethodOption;
  3750. /**
  3751. * The Amazon Web Services account ID of the account that you're using to create your Amazon QuickSight account.
  3752. */
  3753. AwsAccountId: AwsAccountId;
  3754. /**
  3755. * The name of your Amazon QuickSight account. This name is unique over all of Amazon Web Services, and it appears only when users sign in. You can't change AccountName value after the Amazon QuickSight account is created.
  3756. */
  3757. AccountName: AccountName;
  3758. /**
  3759. * The email address that you want Amazon QuickSight to send notifications to regarding your Amazon QuickSight account or Amazon QuickSight subscription.
  3760. */
  3761. NotificationEmail: String;
  3762. /**
  3763. * The name of your Active Directory. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
  3764. */
  3765. ActiveDirectoryName?: String;
  3766. /**
  3767. * The realm of the Active Directory that is associated with your Amazon QuickSight account. This field is required if ACTIVE_DIRECTORY is the selected authentication method of the new Amazon QuickSight account.
  3768. */
  3769. Realm?: String;
  3770. /**
  3771. * The ID of the Active Directory that is associated with your Amazon QuickSight account.
  3772. */
  3773. DirectoryId?: String;
  3774. /**
  3775. * The admin group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminProGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account. For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
  3776. */
  3777. AdminGroup?: GroupsList;
  3778. /**
  3779. * The author group associated with your Active Directory or IAM Identity Center account. For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
  3780. */
  3781. AuthorGroup?: GroupsList;
  3782. /**
  3783. * The reader group associated with your Active Directory or IAM Identity Center account. For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
  3784. */
  3785. ReaderGroup?: GroupsList;
  3786. /**
  3787. * The admin pro group associated with your Active Directory or IAM Identity Center account. Either this field or the AdminGroup field is required if ACTIVE_DIRECTORY or IAM_IDENTITY_CENTER is the selected authentication method of the new Amazon QuickSight account. For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
  3788. */
  3789. AdminProGroup?: GroupsList;
  3790. /**
  3791. * The author pro group associated with your Active Directory or IAM Identity Center account. For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
  3792. */
  3793. AuthorProGroup?: GroupsList;
  3794. /**
  3795. * The reader pro group associated with your Active Directory or IAM Identity Center account. For more information about using IAM Identity Center in Amazon QuickSight, see Using IAM Identity Center with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide. For more information about using Active Directory in Amazon QuickSight, see Using Active Directory with Amazon QuickSight Enterprise Edition in the Amazon QuickSight User Guide.
  3796. */
  3797. ReaderProGroup?: GroupsList;
  3798. /**
  3799. * The first name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
  3800. */
  3801. FirstName?: String;
  3802. /**
  3803. * The last name of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
  3804. */
  3805. LastName?: String;
  3806. /**
  3807. * The email address of the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
  3808. */
  3809. EmailAddress?: String;
  3810. /**
  3811. * A 10-digit phone number for the author of the Amazon QuickSight account to use for future communications. This field is required if ENTERPPRISE_AND_Q is the selected edition of the new Amazon QuickSight account.
  3812. */
  3813. ContactNumber?: String;
  3814. /**
  3815. * The Amazon Resource Name (ARN) for the IAM Identity Center instance.
  3816. */
  3817. IAMIdentityCenterInstanceArn?: String;
  3818. }
  3819. export interface CreateAccountSubscriptionResponse {
  3820. /**
  3821. * A SignupResponse object that returns information about a newly created Amazon QuickSight account.
  3822. */
  3823. SignupResponse?: SignupResponse;
  3824. /**
  3825. * The HTTP status of the request.
  3826. */
  3827. Status?: StatusCode;
  3828. /**
  3829. * The Amazon Web Services request ID for this operation.
  3830. */
  3831. RequestId?: String;
  3832. }
  3833. export interface CreateAnalysisRequest {
  3834. /**
  3835. * The ID of the Amazon Web Services account where you are creating an analysis.
  3836. */
  3837. AwsAccountId: AwsAccountId;
  3838. /**
  3839. * The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
  3840. */
  3841. AnalysisId: ShortRestrictiveResourceId;
  3842. /**
  3843. * A descriptive name for the analysis that you're creating. This name displays for the analysis in the Amazon QuickSight console.
  3844. */
  3845. Name: AnalysisName;
  3846. /**
  3847. * The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
  3848. */
  3849. Parameters?: Parameters;
  3850. /**
  3851. * A structure that describes the principals and the resource-level permissions on an analysis. You can use the Permissions structure to grant permissions by providing a list of Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN). To specify no permissions, omit Permissions.
  3852. */
  3853. Permissions?: ResourcePermissionList;
  3854. /**
  3855. * A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets. Either a SourceEntity or a Definition must be provided in order for the request to be valid.
  3856. */
  3857. SourceEntity?: AnalysisSourceEntity;
  3858. /**
  3859. * The ARN for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.
  3860. */
  3861. ThemeArn?: Arn;
  3862. /**
  3863. * Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
  3864. */
  3865. Tags?: TagList;
  3866. /**
  3867. * The definition of an analysis. A definition is the data model of all features in a Dashboard, Template, or Analysis. Either a SourceEntity or a Definition must be provided in order for the request to be valid.
  3868. */
  3869. Definition?: AnalysisDefinition;
  3870. /**
  3871. * The option to relax the validation needed to create an analysis with definition objects. This skips the validation step for specific errors.
  3872. */
  3873. ValidationStrategy?: ValidationStrategy;
  3874. /**
  3875. * When you create the analysis, Amazon QuickSight adds the analysis to these folders.
  3876. */
  3877. FolderArns?: FolderArnList;
  3878. }
  3879. export interface CreateAnalysisResponse {
  3880. /**
  3881. * The ARN for the analysis.
  3882. */
  3883. Arn?: Arn;
  3884. /**
  3885. * The ID of the analysis.
  3886. */
  3887. AnalysisId?: ShortRestrictiveResourceId;
  3888. /**
  3889. * The status of the creation of the analysis.
  3890. */
  3891. CreationStatus?: ResourceStatus;
  3892. /**
  3893. * The HTTP status of the request.
  3894. */
  3895. Status?: StatusCode;
  3896. /**
  3897. * The Amazon Web Services request ID for this operation.
  3898. */
  3899. RequestId?: String;
  3900. }
  3901. export interface CreateColumnsOperation {
  3902. /**
  3903. * Calculated columns to create.
  3904. */
  3905. Columns: CalculatedColumnList;
  3906. }
  3907. export interface CreateDashboardRequest {
  3908. /**
  3909. * The ID of the Amazon Web Services account where you want to create the dashboard.
  3910. */
  3911. AwsAccountId: AwsAccountId;
  3912. /**
  3913. * The ID for the dashboard, also added to the IAM policy.
  3914. */
  3915. DashboardId: ShortRestrictiveResourceId;
  3916. /**
  3917. * The display name of the dashboard.
  3918. */
  3919. Name: DashboardName;
  3920. /**
  3921. * The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
  3922. */
  3923. Parameters?: Parameters;
  3924. /**
  3925. * A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN. To specify no permissions, omit the permissions list.
  3926. */
  3927. Permissions?: ResourcePermissionList;
  3928. /**
  3929. * The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region. Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. Either a SourceEntity or a Definition must be provided in order for the request to be valid.
  3930. */
  3931. SourceEntity?: DashboardSourceEntity;
  3932. /**
  3933. * Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
  3934. */
  3935. Tags?: TagList;
  3936. /**
  3937. * A description for the first version of the dashboard being created.
  3938. */
  3939. VersionDescription?: VersionDescription;
  3940. /**
  3941. * Options for publishing the dashboard when you create it: AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default. AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default. VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
  3942. */
  3943. DashboardPublishOptions?: DashboardPublishOptions;
  3944. /**
  3945. * The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
  3946. */
  3947. ThemeArn?: Arn;
  3948. /**
  3949. * The definition of a dashboard. A definition is the data model of all features in a Dashboard, Template, or Analysis. Either a SourceEntity or a Definition must be provided in order for the request to be valid.
  3950. */
  3951. Definition?: DashboardVersionDefinition;
  3952. /**
  3953. * The option to relax the validation needed to create a dashboard with definition objects. This option skips the validation step for specific errors.
  3954. */
  3955. ValidationStrategy?: ValidationStrategy;
  3956. /**
  3957. * When you create the dashboard, Amazon QuickSight adds the dashboard to these folders.
  3958. */
  3959. FolderArns?: FolderArnList;
  3960. /**
  3961. * A structure that contains the permissions of a shareable link to the dashboard.
  3962. */
  3963. LinkSharingConfiguration?: LinkSharingConfiguration;
  3964. /**
  3965. * A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
  3966. */
  3967. LinkEntities?: LinkEntityArnList;
  3968. }
  3969. export interface CreateDashboardResponse {
  3970. /**
  3971. * The ARN of the dashboard.
  3972. */
  3973. Arn?: Arn;
  3974. /**
  3975. * The ARN of the dashboard, including the version number of the first version that is created.
  3976. */
  3977. VersionArn?: Arn;
  3978. /**
  3979. * The ID for the dashboard.
  3980. */
  3981. DashboardId?: ShortRestrictiveResourceId;
  3982. /**
  3983. * The status of the dashboard creation request.
  3984. */
  3985. CreationStatus?: ResourceStatus;
  3986. /**
  3987. * The HTTP status of the request.
  3988. */
  3989. Status?: StatusCode;
  3990. /**
  3991. * The Amazon Web Services request ID for this operation.
  3992. */
  3993. RequestId?: String;
  3994. }
  3995. export interface CreateDataSetRequest {
  3996. /**
  3997. * The Amazon Web Services account ID.
  3998. */
  3999. AwsAccountId: AwsAccountId;
  4000. /**
  4001. * An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  4002. */
  4003. DataSetId: ResourceId;
  4004. /**
  4005. * The display name for the dataset.
  4006. */
  4007. Name: ResourceName;
  4008. /**
  4009. * Declares the physical tables that are available in the underlying data sources.
  4010. */
  4011. PhysicalTableMap: PhysicalTableMap;
  4012. /**
  4013. * Configures the combination and transformation of the data from the physical tables.
  4014. */
  4015. LogicalTableMap?: LogicalTableMap;
  4016. /**
  4017. * Indicates whether you want to import the data into SPICE.
  4018. */
  4019. ImportMode: DataSetImportMode;
  4020. /**
  4021. * Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
  4022. */
  4023. ColumnGroups?: ColumnGroupList;
  4024. /**
  4025. * The folder that contains fields and nested subfolders for your dataset.
  4026. */
  4027. FieldFolders?: FieldFolderMap;
  4028. /**
  4029. * A list of resource permissions on the dataset.
  4030. */
  4031. Permissions?: ResourcePermissionList;
  4032. /**
  4033. * The row-level security configuration for the data that you want to create.
  4034. */
  4035. RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
  4036. /**
  4037. * The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
  4038. */
  4039. RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration;
  4040. /**
  4041. * A set of one or more definitions of a ColumnLevelPermissionRule .
  4042. */
  4043. ColumnLevelPermissionRules?: ColumnLevelPermissionRuleList;
  4044. /**
  4045. * Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
  4046. */
  4047. Tags?: TagList;
  4048. DataSetUsageConfiguration?: DataSetUsageConfiguration;
  4049. /**
  4050. * The parameter declarations of the dataset.
  4051. */
  4052. DatasetParameters?: DatasetParameterList;
  4053. /**
  4054. * When you create the dataset, Amazon QuickSight adds the dataset to these folders.
  4055. */
  4056. FolderArns?: FolderArnList;
  4057. }
  4058. export interface CreateDataSetResponse {
  4059. /**
  4060. * The Amazon Resource Name (ARN) of the dataset.
  4061. */
  4062. Arn?: Arn;
  4063. /**
  4064. * The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  4065. */
  4066. DataSetId?: ResourceId;
  4067. /**
  4068. * The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
  4069. */
  4070. IngestionArn?: Arn;
  4071. /**
  4072. * The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
  4073. */
  4074. IngestionId?: ResourceId;
  4075. /**
  4076. * The Amazon Web Services request ID for this operation.
  4077. */
  4078. RequestId?: String;
  4079. /**
  4080. * The HTTP status of the request.
  4081. */
  4082. Status?: StatusCode;
  4083. }
  4084. export interface CreateDataSourceRequest {
  4085. /**
  4086. * The Amazon Web Services account ID.
  4087. */
  4088. AwsAccountId: AwsAccountId;
  4089. /**
  4090. * An ID for the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  4091. */
  4092. DataSourceId: ResourceId;
  4093. /**
  4094. * A display name for the data source.
  4095. */
  4096. Name: ResourceName;
  4097. /**
  4098. * The type of the data source. To return a list of all data sources, use ListDataSources. Use AMAZON_ELASTICSEARCH for Amazon OpenSearch Service.
  4099. */
  4100. Type: DataSourceType;
  4101. /**
  4102. * The parameters that Amazon QuickSight uses to connect to your underlying source.
  4103. */
  4104. DataSourceParameters?: DataSourceParameters;
  4105. /**
  4106. * The credentials Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
  4107. */
  4108. Credentials?: DataSourceCredentials;
  4109. /**
  4110. * A list of resource permissions on the data source.
  4111. */
  4112. Permissions?: ResourcePermissionList;
  4113. /**
  4114. * Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
  4115. */
  4116. VpcConnectionProperties?: VpcConnectionProperties;
  4117. /**
  4118. * Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
  4119. */
  4120. SslProperties?: SslProperties;
  4121. /**
  4122. * Contains a map of the key-value pairs for the resource tag or tags assigned to the data source.
  4123. */
  4124. Tags?: TagList;
  4125. /**
  4126. * When you create the data source, Amazon QuickSight adds the data source to these folders.
  4127. */
  4128. FolderArns?: FolderArnList;
  4129. }
  4130. export interface CreateDataSourceResponse {
  4131. /**
  4132. * The Amazon Resource Name (ARN) of the data source.
  4133. */
  4134. Arn?: Arn;
  4135. /**
  4136. * The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  4137. */
  4138. DataSourceId?: ResourceId;
  4139. /**
  4140. * The status of creating the data source.
  4141. */
  4142. CreationStatus?: ResourceStatus;
  4143. /**
  4144. * The Amazon Web Services request ID for this operation.
  4145. */
  4146. RequestId?: String;
  4147. /**
  4148. * The HTTP status of the request.
  4149. */
  4150. Status?: StatusCode;
  4151. }
  4152. export interface CreateFolderMembershipRequest {
  4153. /**
  4154. * The ID for the Amazon Web Services account that contains the folder.
  4155. */
  4156. AwsAccountId: AwsAccountId;
  4157. /**
  4158. * The ID of the folder.
  4159. */
  4160. FolderId: RestrictiveResourceId;
  4161. /**
  4162. * The ID of the asset that you want to add to the folder.
  4163. */
  4164. MemberId: RestrictiveResourceId;
  4165. /**
  4166. * The member type of the asset that you want to add to a folder.
  4167. */
  4168. MemberType: MemberType;
  4169. }
  4170. export interface CreateFolderMembershipResponse {
  4171. /**
  4172. * The HTTP status of the request.
  4173. */
  4174. Status?: StatusCode;
  4175. /**
  4176. * Information about the member in the folder.
  4177. */
  4178. FolderMember?: FolderMember;
  4179. /**
  4180. * The Amazon Web Services request ID for this operation.
  4181. */
  4182. RequestId?: String;
  4183. }
  4184. export interface CreateFolderRequest {
  4185. /**
  4186. * The ID for the Amazon Web Services account where you want to create the folder.
  4187. */
  4188. AwsAccountId: AwsAccountId;
  4189. /**
  4190. * The ID of the folder.
  4191. */
  4192. FolderId: RestrictiveResourceId;
  4193. /**
  4194. * The name of the folder.
  4195. */
  4196. Name?: FolderName;
  4197. /**
  4198. * The type of folder. By default, folderType is SHARED.
  4199. */
  4200. FolderType?: FolderType;
  4201. /**
  4202. * The Amazon Resource Name (ARN) for the parent folder. ParentFolderArn can be null. An empty parentFolderArn creates a root-level folder.
  4203. */
  4204. ParentFolderArn?: Arn;
  4205. /**
  4206. * A structure that describes the principals and the resource-level permissions of a folder. To specify no permissions, omit Permissions.
  4207. */
  4208. Permissions?: ResourcePermissionList;
  4209. /**
  4210. * Tags for the folder.
  4211. */
  4212. Tags?: TagList;
  4213. /**
  4214. * An optional parameter that determines the sharing scope of the folder. The default value for this parameter is ACCOUNT.
  4215. */
  4216. SharingModel?: SharingModel;
  4217. }
  4218. export interface CreateFolderResponse {
  4219. /**
  4220. * The HTTP status of the request.
  4221. */
  4222. Status?: StatusCode;
  4223. /**
  4224. * The Amazon Resource Name (ARN) for the newly created folder.
  4225. */
  4226. Arn?: Arn;
  4227. /**
  4228. * The folder ID for the newly created folder.
  4229. */
  4230. FolderId?: RestrictiveResourceId;
  4231. /**
  4232. * The request ID for the newly created folder.
  4233. */
  4234. RequestId?: String;
  4235. }
  4236. export interface CreateGroupMembershipRequest {
  4237. /**
  4238. * The name of the user that you want to add to the group membership.
  4239. */
  4240. MemberName: GroupMemberName;
  4241. /**
  4242. * The name of the group that you want to add the user to.
  4243. */
  4244. GroupName: GroupName;
  4245. /**
  4246. * The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  4247. */
  4248. AwsAccountId: AwsAccountId;
  4249. /**
  4250. * The namespace that you want the user to be a part of.
  4251. */
  4252. Namespace: Namespace;
  4253. }
  4254. export interface CreateGroupMembershipResponse {
  4255. /**
  4256. * The group member.
  4257. */
  4258. GroupMember?: GroupMember;
  4259. /**
  4260. * The Amazon Web Services request ID for this operation.
  4261. */
  4262. RequestId?: String;
  4263. /**
  4264. * The HTTP status of the request.
  4265. */
  4266. Status?: StatusCode;
  4267. }
  4268. export interface CreateGroupRequest {
  4269. /**
  4270. * A name for the group that you want to create.
  4271. */
  4272. GroupName: GroupName;
  4273. /**
  4274. * A description for the group that you want to create.
  4275. */
  4276. Description?: GroupDescription;
  4277. /**
  4278. * The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  4279. */
  4280. AwsAccountId: AwsAccountId;
  4281. /**
  4282. * The namespace that you want the group to be a part of.
  4283. */
  4284. Namespace: Namespace;
  4285. }
  4286. export interface CreateGroupResponse {
  4287. /**
  4288. * The name of the group.
  4289. */
  4290. Group?: Group;
  4291. /**
  4292. * The Amazon Web Services request ID for this operation.
  4293. */
  4294. RequestId?: String;
  4295. /**
  4296. * The HTTP status of the request.
  4297. */
  4298. Status?: StatusCode;
  4299. }
  4300. export interface CreateIAMPolicyAssignmentRequest {
  4301. /**
  4302. * The ID of the Amazon Web Services account where you want to assign an IAM policy to Amazon QuickSight users or groups.
  4303. */
  4304. AwsAccountId: AwsAccountId;
  4305. /**
  4306. * The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account.
  4307. */
  4308. AssignmentName: IAMPolicyAssignmentName;
  4309. /**
  4310. * The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
  4311. */
  4312. AssignmentStatus: AssignmentStatus;
  4313. /**
  4314. * The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.
  4315. */
  4316. PolicyArn?: Arn;
  4317. /**
  4318. * The Amazon QuickSight users, groups, or both that you want to assign the policy to.
  4319. */
  4320. Identities?: IdentityMap;
  4321. /**
  4322. * The namespace that contains the assignment.
  4323. */
  4324. Namespace: Namespace;
  4325. }
  4326. export interface CreateIAMPolicyAssignmentResponse {
  4327. /**
  4328. * The name of the assignment. The name must be unique within the Amazon Web Services account.
  4329. */
  4330. AssignmentName?: IAMPolicyAssignmentName;
  4331. /**
  4332. * The ID for the assignment.
  4333. */
  4334. AssignmentId?: String;
  4335. /**
  4336. * The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
  4337. */
  4338. AssignmentStatus?: AssignmentStatus;
  4339. /**
  4340. * The ARN for the IAM policy that is applied to the Amazon QuickSight users and groups specified in this assignment.
  4341. */
  4342. PolicyArn?: Arn;
  4343. /**
  4344. * The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.
  4345. */
  4346. Identities?: IdentityMap;
  4347. /**
  4348. * The Amazon Web Services request ID for this operation.
  4349. */
  4350. RequestId?: String;
  4351. /**
  4352. * The HTTP status of the request.
  4353. */
  4354. Status?: StatusCode;
  4355. }
  4356. export interface CreateIngestionRequest {
  4357. /**
  4358. * The ID of the dataset used in the ingestion.
  4359. */
  4360. DataSetId: String;
  4361. /**
  4362. * An ID for the ingestion.
  4363. */
  4364. IngestionId: IngestionId;
  4365. /**
  4366. * The Amazon Web Services account ID.
  4367. */
  4368. AwsAccountId: AwsAccountId;
  4369. /**
  4370. * The type of ingestion that you want to create.
  4371. */
  4372. IngestionType?: IngestionType;
  4373. }
  4374. export interface CreateIngestionResponse {
  4375. /**
  4376. * The Amazon Resource Name (ARN) for the data ingestion.
  4377. */
  4378. Arn?: Arn;
  4379. /**
  4380. * An ID for the ingestion.
  4381. */
  4382. IngestionId?: IngestionId;
  4383. /**
  4384. * The ingestion status.
  4385. */
  4386. IngestionStatus?: IngestionStatus;
  4387. /**
  4388. * The Amazon Web Services request ID for this operation.
  4389. */
  4390. RequestId?: String;
  4391. /**
  4392. * The HTTP status of the request.
  4393. */
  4394. Status?: StatusCode;
  4395. }
  4396. export interface CreateNamespaceRequest {
  4397. /**
  4398. * The ID for the Amazon Web Services account that you want to create the Amazon QuickSight namespace in.
  4399. */
  4400. AwsAccountId: AwsAccountId;
  4401. /**
  4402. * The name that you want to use to describe the new namespace.
  4403. */
  4404. Namespace: Namespace;
  4405. /**
  4406. * Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.
  4407. */
  4408. IdentityStore: IdentityStore;
  4409. /**
  4410. * The tags that you want to associate with the namespace that you're creating.
  4411. */
  4412. Tags?: TagList;
  4413. }
  4414. export interface CreateNamespaceResponse {
  4415. /**
  4416. * The ARN of the Amazon QuickSight namespace you created.
  4417. */
  4418. Arn?: Arn;
  4419. /**
  4420. * The name of the new namespace that you created.
  4421. */
  4422. Name?: Namespace;
  4423. /**
  4424. * The Amazon Web Services Region; that you want to use for the free SPICE capacity for the new namespace. This is set to the region that you run CreateNamespace in.
  4425. */
  4426. CapacityRegion?: String;
  4427. /**
  4428. * The status of the creation of the namespace. This is an asynchronous process. A status of CREATED means that your namespace is ready to use. If an error occurs, it indicates if the process is retryable or non-retryable. In the case of a non-retryable error, refer to the error message for follow-up tasks.
  4429. */
  4430. CreationStatus?: NamespaceStatus;
  4431. /**
  4432. * Specifies the type of your user identity directory. Currently, this supports users with an identity type of QUICKSIGHT.
  4433. */
  4434. IdentityStore?: IdentityStore;
  4435. /**
  4436. * The Amazon Web Services request ID for this operation.
  4437. */
  4438. RequestId?: String;
  4439. /**
  4440. * The HTTP status of the request.
  4441. */
  4442. Status?: StatusCode;
  4443. }
  4444. export interface CreateRefreshScheduleRequest {
  4445. /**
  4446. * The ID of the dataset.
  4447. */
  4448. DataSetId: ResourceId;
  4449. /**
  4450. * The Amazon Web Services account ID.
  4451. */
  4452. AwsAccountId: AwsAccountId;
  4453. /**
  4454. * The refresh schedule.
  4455. */
  4456. Schedule: RefreshSchedule;
  4457. }
  4458. export interface CreateRefreshScheduleResponse {
  4459. /**
  4460. * The HTTP status of the request.
  4461. */
  4462. Status?: StatusCode;
  4463. /**
  4464. * The Amazon Web Services request ID for this operation.
  4465. */
  4466. RequestId?: String;
  4467. /**
  4468. * The ID of the refresh schedule.
  4469. */
  4470. ScheduleId?: String;
  4471. /**
  4472. * The Amazon Resource Name (ARN) for the refresh schedule.
  4473. */
  4474. Arn?: Arn;
  4475. }
  4476. export interface CreateRoleMembershipRequest {
  4477. /**
  4478. * The name of the group that you want to add to the role.
  4479. */
  4480. MemberName: GroupName;
  4481. /**
  4482. * The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
  4483. */
  4484. AwsAccountId: AwsAccountId;
  4485. /**
  4486. * The namespace that the role belongs to.
  4487. */
  4488. Namespace: Namespace;
  4489. /**
  4490. * The role that you want to add a group to.
  4491. */
  4492. Role: Role;
  4493. }
  4494. export interface CreateRoleMembershipResponse {
  4495. /**
  4496. * The Amazon Web Services request ID for this operation.
  4497. */
  4498. RequestId?: String;
  4499. /**
  4500. * The HTTP status of the request.
  4501. */
  4502. Status?: StatusCode;
  4503. }
  4504. export interface CreateTemplateAliasRequest {
  4505. /**
  4506. * The ID of the Amazon Web Services account that contains the template that you creating an alias for.
  4507. */
  4508. AwsAccountId: AwsAccountId;
  4509. /**
  4510. * An ID for the template.
  4511. */
  4512. TemplateId: ShortRestrictiveResourceId;
  4513. /**
  4514. * The name that you want to give to the template alias that you're creating. Don't start the alias name with the $ character. Alias names that start with $ are reserved by Amazon QuickSight.
  4515. */
  4516. AliasName: AliasName;
  4517. /**
  4518. * The version number of the template.
  4519. */
  4520. TemplateVersionNumber: VersionNumber;
  4521. }
  4522. export interface CreateTemplateAliasResponse {
  4523. /**
  4524. * Information about the template alias.
  4525. */
  4526. TemplateAlias?: TemplateAlias;
  4527. /**
  4528. * The HTTP status of the request.
  4529. */
  4530. Status?: StatusCode;
  4531. /**
  4532. * The Amazon Web Services request ID for this operation.
  4533. */
  4534. RequestId?: String;
  4535. }
  4536. export interface CreateTemplateRequest {
  4537. /**
  4538. * The ID for the Amazon Web Services account that the group is in. You use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  4539. */
  4540. AwsAccountId: AwsAccountId;
  4541. /**
  4542. * An ID for the template that you want to create. This template is unique per Amazon Web Services Region; in each Amazon Web Services account.
  4543. */
  4544. TemplateId: ShortRestrictiveResourceId;
  4545. /**
  4546. * A display name for the template.
  4547. */
  4548. Name?: TemplateName;
  4549. /**
  4550. * A list of resource permissions to be set on the template.
  4551. */
  4552. Permissions?: ResourcePermissionList;
  4553. /**
  4554. * The entity that you are using as a source when you create the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region. Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder. Either a SourceEntity or a Definition must be provided in order for the request to be valid.
  4555. */
  4556. SourceEntity?: TemplateSourceEntity;
  4557. /**
  4558. * Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
  4559. */
  4560. Tags?: TagList;
  4561. /**
  4562. * A description of the current template version being created. This API operation creates the first version of the template. Every time UpdateTemplate is called, a new version is created. Each version of the template maintains a description of the version in the VersionDescription field.
  4563. */
  4564. VersionDescription?: VersionDescription;
  4565. /**
  4566. * The definition of a template. A definition is the data model of all features in a Dashboard, Template, or Analysis. Either a SourceEntity or a Definition must be provided in order for the request to be valid.
  4567. */
  4568. Definition?: TemplateVersionDefinition;
  4569. /**
  4570. * TThe option to relax the validation needed to create a template with definition objects. This skips the validation step for specific errors.
  4571. */
  4572. ValidationStrategy?: ValidationStrategy;
  4573. }
  4574. export interface CreateTemplateResponse {
  4575. /**
  4576. * The ARN for the template.
  4577. */
  4578. Arn?: Arn;
  4579. /**
  4580. * The ARN for the template, including the version information of the first version.
  4581. */
  4582. VersionArn?: Arn;
  4583. /**
  4584. * The ID of the template.
  4585. */
  4586. TemplateId?: ShortRestrictiveResourceId;
  4587. /**
  4588. * The template creation status.
  4589. */
  4590. CreationStatus?: ResourceStatus;
  4591. /**
  4592. * The HTTP status of the request.
  4593. */
  4594. Status?: StatusCode;
  4595. /**
  4596. * The Amazon Web Services request ID for this operation.
  4597. */
  4598. RequestId?: String;
  4599. }
  4600. export interface CreateThemeAliasRequest {
  4601. /**
  4602. * The ID of the Amazon Web Services account that contains the theme for the new theme alias.
  4603. */
  4604. AwsAccountId: AwsAccountId;
  4605. /**
  4606. * An ID for the theme alias.
  4607. */
  4608. ThemeId: ShortRestrictiveResourceId;
  4609. /**
  4610. * The name that you want to give to the theme alias that you are creating. The alias name can't begin with a $. Alias names that start with $ are reserved by Amazon QuickSight.
  4611. */
  4612. AliasName: AliasName;
  4613. /**
  4614. * The version number of the theme.
  4615. */
  4616. ThemeVersionNumber: VersionNumber;
  4617. }
  4618. export interface CreateThemeAliasResponse {
  4619. /**
  4620. * Information about the theme alias.
  4621. */
  4622. ThemeAlias?: ThemeAlias;
  4623. /**
  4624. * The HTTP status of the request.
  4625. */
  4626. Status?: StatusCode;
  4627. /**
  4628. * The Amazon Web Services request ID for this operation.
  4629. */
  4630. RequestId?: String;
  4631. }
  4632. export interface CreateThemeRequest {
  4633. /**
  4634. * The ID of the Amazon Web Services account where you want to store the new theme.
  4635. */
  4636. AwsAccountId: AwsAccountId;
  4637. /**
  4638. * An ID for the theme that you want to create. The theme ID is unique per Amazon Web Services Region in each Amazon Web Services account.
  4639. */
  4640. ThemeId: ShortRestrictiveResourceId;
  4641. /**
  4642. * A display name for the theme.
  4643. */
  4644. Name: ThemeName;
  4645. /**
  4646. * The ID of the theme that a custom theme will inherit from. All themes inherit from one of the starting themes defined by Amazon QuickSight. For a list of the starting themes, use ListThemes or choose Themes from within an analysis.
  4647. */
  4648. BaseThemeId: ShortRestrictiveResourceId;
  4649. /**
  4650. * A description of the first version of the theme that you're creating. Every time UpdateTheme is called, a new version is created. Each version of the theme has a description of the version in the VersionDescription field.
  4651. */
  4652. VersionDescription?: VersionDescription;
  4653. /**
  4654. * The theme configuration, which contains the theme display properties.
  4655. */
  4656. Configuration: ThemeConfiguration;
  4657. /**
  4658. * A valid grouping of resource permissions to apply to the new theme.
  4659. */
  4660. Permissions?: ResourcePermissionList;
  4661. /**
  4662. * A map of the key-value pairs for the resource tag or tags that you want to add to the resource.
  4663. */
  4664. Tags?: TagList;
  4665. }
  4666. export interface CreateThemeResponse {
  4667. /**
  4668. * The Amazon Resource Name (ARN) for the theme.
  4669. */
  4670. Arn?: Arn;
  4671. /**
  4672. * The Amazon Resource Name (ARN) for the new theme.
  4673. */
  4674. VersionArn?: Arn;
  4675. /**
  4676. * The ID of the theme.
  4677. */
  4678. ThemeId?: ShortRestrictiveResourceId;
  4679. /**
  4680. * The theme creation status.
  4681. */
  4682. CreationStatus?: ResourceStatus;
  4683. /**
  4684. * The HTTP status of the request.
  4685. */
  4686. Status?: StatusCode;
  4687. /**
  4688. * The Amazon Web Services request ID for this operation.
  4689. */
  4690. RequestId?: String;
  4691. }
  4692. export interface CreateTopicRefreshScheduleRequest {
  4693. /**
  4694. * The ID of the Amazon Web Services account that contains the topic you're creating a refresh schedule for.
  4695. */
  4696. AwsAccountId: AwsAccountId;
  4697. /**
  4698. * The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  4699. */
  4700. TopicId: TopicId;
  4701. /**
  4702. * The Amazon Resource Name (ARN) of the dataset.
  4703. */
  4704. DatasetArn: Arn;
  4705. /**
  4706. * The name of the dataset.
  4707. */
  4708. DatasetName?: String;
  4709. /**
  4710. * The definition of a refresh schedule.
  4711. */
  4712. RefreshSchedule: TopicRefreshSchedule;
  4713. }
  4714. export interface CreateTopicRefreshScheduleResponse {
  4715. /**
  4716. * The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  4717. */
  4718. TopicId?: TopicId;
  4719. /**
  4720. * The Amazon Resource Name (ARN) of the topic.
  4721. */
  4722. TopicArn?: Arn;
  4723. /**
  4724. * The Amazon Resource Name (ARN) of the dataset.
  4725. */
  4726. DatasetArn?: Arn;
  4727. /**
  4728. * The HTTP status of the request.
  4729. */
  4730. Status?: StatusCode;
  4731. /**
  4732. * The Amazon Web Services request ID for this operation.
  4733. */
  4734. RequestId?: String;
  4735. }
  4736. export interface CreateTopicRequest {
  4737. /**
  4738. * The ID of the Amazon Web Services account that you want to create a topic in.
  4739. */
  4740. AwsAccountId: AwsAccountId;
  4741. /**
  4742. * The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  4743. */
  4744. TopicId: TopicId;
  4745. /**
  4746. * The definition of a topic to create.
  4747. */
  4748. Topic: TopicDetails;
  4749. /**
  4750. * Contains a map of the key-value pairs for the resource tag or tags that are assigned to the dataset.
  4751. */
  4752. Tags?: TagList;
  4753. }
  4754. export interface CreateTopicResponse {
  4755. /**
  4756. * The Amazon Resource Name (ARN) of the topic.
  4757. */
  4758. Arn?: Arn;
  4759. /**
  4760. * The ID for the topic that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  4761. */
  4762. TopicId?: TopicId;
  4763. /**
  4764. * The Amazon Resource Name (ARN) of the topic refresh.
  4765. */
  4766. RefreshArn?: Arn;
  4767. /**
  4768. * The Amazon Web Services request ID for this operation.
  4769. */
  4770. RequestId?: String;
  4771. /**
  4772. * The HTTP status of the request.
  4773. */
  4774. Status?: StatusCode;
  4775. }
  4776. export interface CreateVPCConnectionRequest {
  4777. /**
  4778. * The Amazon Web Services account ID of the account where you want to create a new VPC connection.
  4779. */
  4780. AwsAccountId: AwsAccountId;
  4781. /**
  4782. * The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
  4783. */
  4784. VPCConnectionId: VPCConnectionResourceIdRestricted;
  4785. /**
  4786. * The display name for the VPC connection.
  4787. */
  4788. Name: ResourceName;
  4789. /**
  4790. * A list of subnet IDs for the VPC connection.
  4791. */
  4792. SubnetIds: SubnetIdList;
  4793. /**
  4794. * A list of security group IDs for the VPC connection.
  4795. */
  4796. SecurityGroupIds: SecurityGroupIdList;
  4797. /**
  4798. * A list of IP addresses of DNS resolver endpoints for the VPC connection.
  4799. */
  4800. DnsResolvers?: DnsResolverList;
  4801. /**
  4802. * The IAM role to associate with the VPC connection.
  4803. */
  4804. RoleArn: RoleArn;
  4805. /**
  4806. * A map of the key-value pairs for the resource tag or tags assigned to the VPC connection.
  4807. */
  4808. Tags?: TagList;
  4809. }
  4810. export interface CreateVPCConnectionResponse {
  4811. /**
  4812. * The Amazon Resource Name (ARN) of the VPC connection.
  4813. */
  4814. Arn?: Arn;
  4815. /**
  4816. * The ID for the VPC connection that you're creating. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  4817. */
  4818. VPCConnectionId?: VPCConnectionResourceIdRestricted;
  4819. /**
  4820. * The status of the creation of the VPC connection.
  4821. */
  4822. CreationStatus?: VPCConnectionResourceStatus;
  4823. /**
  4824. * The availability status of the VPC connection.
  4825. */
  4826. AvailabilityStatus?: VPCConnectionAvailabilityStatus;
  4827. /**
  4828. * The Amazon Web Services request ID for this operation.
  4829. */
  4830. RequestId?: String;
  4831. /**
  4832. * The HTTP status of the request.
  4833. */
  4834. Status?: StatusCode;
  4835. }
  4836. export interface CredentialPair {
  4837. /**
  4838. * User name.
  4839. */
  4840. Username: DbUsername;
  4841. /**
  4842. * Password.
  4843. */
  4844. Password: Password;
  4845. /**
  4846. * A set of alternate data source parameters that you want to share for these credentials. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the new data source with the existing credentials. If the AlternateDataSourceParameters list is null, the DataSourceParameters originally used with these Credentials is automatically allowed.
  4847. */
  4848. AlternateDataSourceParameters?: DataSourceParametersList;
  4849. }
  4850. export type CrossDatasetTypes = "ALL_DATASETS"|"SINGLE_DATASET"|string;
  4851. export type CurrencyCode = string;
  4852. export interface CurrencyDisplayFormatConfiguration {
  4853. /**
  4854. * Determines the prefix value of the currency format.
  4855. */
  4856. Prefix?: Prefix;
  4857. /**
  4858. * Determines the suffix value of the currency format.
  4859. */
  4860. Suffix?: Suffix;
  4861. /**
  4862. * The options that determine the numeric separator configuration.
  4863. */
  4864. SeparatorConfiguration?: NumericSeparatorConfiguration;
  4865. /**
  4866. * Determines the symbol for the currency format.
  4867. */
  4868. Symbol?: CurrencyCode;
  4869. /**
  4870. * The option that determines the decimal places configuration.
  4871. */
  4872. DecimalPlacesConfiguration?: DecimalPlacesConfiguration;
  4873. /**
  4874. * Determines the number scale value for the currency format.
  4875. */
  4876. NumberScale?: NumberScale;
  4877. /**
  4878. * The options that determine the negative value configuration.
  4879. */
  4880. NegativeValueConfiguration?: NegativeValueConfiguration;
  4881. /**
  4882. * The options that determine the null value format configuration.
  4883. */
  4884. NullValueFormatConfiguration?: NullValueFormatConfiguration;
  4885. }
  4886. export type CustomActionColumnList = ColumnIdentifier[];
  4887. export interface CustomActionFilterOperation {
  4888. /**
  4889. * The configuration that chooses the fields to be filtered.
  4890. */
  4891. SelectedFieldsConfiguration: FilterOperationSelectedFieldsConfiguration;
  4892. /**
  4893. * The configuration that chooses the target visuals to be filtered.
  4894. */
  4895. TargetVisualsConfiguration: FilterOperationTargetVisualsConfiguration;
  4896. }
  4897. export interface CustomActionNavigationOperation {
  4898. /**
  4899. * The configuration that chooses the navigation target.
  4900. */
  4901. LocalNavigationConfiguration?: LocalNavigationConfiguration;
  4902. }
  4903. export interface CustomActionSetParametersOperation {
  4904. /**
  4905. * The parameter that determines the value configuration.
  4906. */
  4907. ParameterValueConfigurations: SetParameterValueConfigurationList;
  4908. }
  4909. export interface CustomActionURLOperation {
  4910. /**
  4911. * THe URL link of the CustomActionURLOperation.
  4912. */
  4913. URLTemplate: URLOperationTemplate;
  4914. /**
  4915. * The target of the CustomActionURLOperation. Valid values are defined as follows: NEW_TAB: Opens the target URL in a new browser tab. NEW_WINDOW: Opens the target URL in a new browser window. SAME_TAB: Opens the target URL in the same browser tab.
  4916. */
  4917. URLTarget: URLTargetConfiguration;
  4918. }
  4919. export interface CustomColor {
  4920. /**
  4921. * The data value that the color is applied to.
  4922. */
  4923. FieldValue?: FieldValue;
  4924. /**
  4925. * The color that is applied to the data value.
  4926. */
  4927. Color: HexColor;
  4928. /**
  4929. * The value of a special data value.
  4930. */
  4931. SpecialValue?: SpecialValue;
  4932. }
  4933. export type CustomColorsList = CustomColor[];
  4934. export interface CustomContentConfiguration {
  4935. /**
  4936. * The input URL that links to the custom content that you want in the custom visual.
  4937. */
  4938. ContentUrl?: URLOperationTemplate;
  4939. /**
  4940. * The content type of the custom content visual. You can use this to have the visual render as an image.
  4941. */
  4942. ContentType?: CustomContentType;
  4943. /**
  4944. * The sizing options for the size of the custom content visual. This structure is required when the ContentType of the visual is 'IMAGE'.
  4945. */
  4946. ImageScaling?: CustomContentImageScalingConfiguration;
  4947. /**
  4948. * The general visual interactions setup for a visual.
  4949. */
  4950. Interactions?: VisualInteractionOptions;
  4951. }
  4952. export type CustomContentImageScalingConfiguration = "FIT_TO_HEIGHT"|"FIT_TO_WIDTH"|"DO_NOT_SCALE"|"SCALE_TO_VISUAL"|string;
  4953. export type CustomContentType = "IMAGE"|"OTHER_EMBEDDED_CONTENT"|string;
  4954. export interface CustomContentVisual {
  4955. /**
  4956. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  4957. */
  4958. VisualId: ShortRestrictiveResourceId;
  4959. /**
  4960. * The title that is displayed on the visual.
  4961. */
  4962. Title?: VisualTitleLabelOptions;
  4963. /**
  4964. * The subtitle that is displayed on the visual.
  4965. */
  4966. Subtitle?: VisualSubtitleLabelOptions;
  4967. /**
  4968. * The configuration of a CustomContentVisual.
  4969. */
  4970. ChartConfiguration?: CustomContentConfiguration;
  4971. /**
  4972. * The list of custom actions that are configured for a visual.
  4973. */
  4974. Actions?: VisualCustomActionList;
  4975. /**
  4976. * The dataset that is used to create the custom content visual. You can't create a visual without a dataset.
  4977. */
  4978. DataSetIdentifier: DataSetIdentifier;
  4979. }
  4980. export interface CustomFilterConfiguration {
  4981. /**
  4982. * The match operator that is used to determine if a filter should be applied.
  4983. */
  4984. MatchOperator: CategoryFilterMatchOperator;
  4985. /**
  4986. * The category value for the filter. This field is mutually exclusive to ParameterName.
  4987. */
  4988. CategoryValue?: CategoryValue;
  4989. /**
  4990. * Select all of the values. Null is not the assigned value of select all. FILTER_ALL_VALUES
  4991. */
  4992. SelectAllOptions?: CategoryFilterSelectAllOptions;
  4993. /**
  4994. * The parameter whose value should be used for the filter value. This field is mutually exclusive to CategoryValue.
  4995. */
  4996. ParameterName?: ParameterName;
  4997. /**
  4998. * This option determines how null values should be treated when filtering data. ALL_VALUES: Include null values in filtered results. NULLS_ONLY: Only include null values in filtered results. NON_NULLS_ONLY: Exclude null values from filtered results.
  4999. */
  5000. NullOption: FilterNullOption;
  5001. }
  5002. export interface CustomFilterListConfiguration {
  5003. /**
  5004. * The match operator that is used to determine if a filter should be applied.
  5005. */
  5006. MatchOperator: CategoryFilterMatchOperator;
  5007. /**
  5008. * The list of category values for the filter.
  5009. */
  5010. CategoryValues?: CategoryValueList;
  5011. /**
  5012. * Select all of the values. Null is not the assigned value of select all. FILTER_ALL_VALUES
  5013. */
  5014. SelectAllOptions?: CategoryFilterSelectAllOptions;
  5015. /**
  5016. * This option determines how null values should be treated when filtering data. ALL_VALUES: Include null values in filtered results. NULLS_ONLY: Only include null values in filtered results. NON_NULLS_ONLY: Exclude null values from filtered results.
  5017. */
  5018. NullOption: FilterNullOption;
  5019. }
  5020. export type CustomLabel = string;
  5021. export interface CustomNarrativeOptions {
  5022. /**
  5023. * The string input of custom narrative.
  5024. */
  5025. Narrative: NarrativeString;
  5026. }
  5027. export interface CustomParameterValues {
  5028. /**
  5029. * A list of string-type parameter values.
  5030. */
  5031. StringValues?: StringDefaultValueList;
  5032. /**
  5033. * A list of integer-type parameter values.
  5034. */
  5035. IntegerValues?: IntegerDefaultValueList;
  5036. /**
  5037. * A list of decimal-type parameter values.
  5038. */
  5039. DecimalValues?: DecimalDefaultValueList;
  5040. /**
  5041. * A list of datetime-type parameter values.
  5042. */
  5043. DateTimeValues?: DateTimeDefaultValueList;
  5044. }
  5045. export interface CustomSql {
  5046. /**
  5047. * The Amazon Resource Name (ARN) of the data source.
  5048. */
  5049. DataSourceArn: Arn;
  5050. /**
  5051. * A display name for the SQL query result.
  5052. */
  5053. Name: CustomSqlName;
  5054. /**
  5055. * The SQL query.
  5056. */
  5057. SqlQuery: SqlQuery;
  5058. /**
  5059. * The column schema from the SQL query result set.
  5060. */
  5061. Columns?: InputColumnList;
  5062. }
  5063. export type CustomSqlName = string;
  5064. export interface CustomValuesConfiguration {
  5065. /**
  5066. * Includes the null value in custom action parameter values.
  5067. */
  5068. IncludeNullValue?: BooleanObject;
  5069. CustomValues: CustomParameterValues;
  5070. }
  5071. export interface Dashboard {
  5072. /**
  5073. * Dashboard ID.
  5074. */
  5075. DashboardId?: ShortRestrictiveResourceId;
  5076. /**
  5077. * The Amazon Resource Name (ARN) of the resource.
  5078. */
  5079. Arn?: Arn;
  5080. /**
  5081. * A display name for the dashboard.
  5082. */
  5083. Name?: DashboardName;
  5084. /**
  5085. * Version.
  5086. */
  5087. Version?: DashboardVersion;
  5088. /**
  5089. * The time that this dashboard was created.
  5090. */
  5091. CreatedTime?: Timestamp;
  5092. /**
  5093. * The last time that this dashboard was published.
  5094. */
  5095. LastPublishedTime?: Timestamp;
  5096. /**
  5097. * The last time that this dashboard was updated.
  5098. */
  5099. LastUpdatedTime?: Timestamp;
  5100. /**
  5101. * A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
  5102. */
  5103. LinkEntities?: LinkEntityArnList;
  5104. }
  5105. export type DashboardBehavior = "ENABLED"|"DISABLED"|string;
  5106. export interface DashboardError {
  5107. /**
  5108. * Type.
  5109. */
  5110. Type?: DashboardErrorType;
  5111. /**
  5112. * Message.
  5113. */
  5114. Message?: NonEmptyString;
  5115. /**
  5116. * Lists the violated entities that caused the dashboard error.
  5117. */
  5118. ViolatedEntities?: EntityList;
  5119. }
  5120. export type DashboardErrorList = DashboardError[];
  5121. export type DashboardErrorType = "ACCESS_DENIED"|"SOURCE_NOT_FOUND"|"DATA_SET_NOT_FOUND"|"INTERNAL_FAILURE"|"PARAMETER_VALUE_INCOMPATIBLE"|"PARAMETER_TYPE_INVALID"|"PARAMETER_NOT_FOUND"|"COLUMN_TYPE_MISMATCH"|"COLUMN_GEOGRAPHIC_ROLE_MISMATCH"|"COLUMN_REPLACEMENT_MISSING"|string;
  5122. export type DashboardFilterAttribute = "QUICKSIGHT_USER"|"QUICKSIGHT_VIEWER_OR_OWNER"|"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"|"QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_SOLE_OWNER"|"DASHBOARD_NAME"|string;
  5123. export type DashboardName = string;
  5124. export interface DashboardPublishOptions {
  5125. /**
  5126. * Ad hoc (one-time) filtering option.
  5127. */
  5128. AdHocFilteringOption?: AdHocFilteringOption;
  5129. /**
  5130. * Export to .csv option.
  5131. */
  5132. ExportToCSVOption?: ExportToCSVOption;
  5133. /**
  5134. * Sheet controls option.
  5135. */
  5136. SheetControlsOption?: SheetControlsOption;
  5137. /**
  5138. * The visual publish options of a visual in a dashboard.
  5139. */
  5140. VisualPublishOptions?: DashboardVisualPublishOptions;
  5141. /**
  5142. * The sheet layout maximization options of a dashbaord.
  5143. */
  5144. SheetLayoutElementMaximizationOption?: SheetLayoutElementMaximizationOption;
  5145. /**
  5146. * The menu options of a visual in a dashboard.
  5147. */
  5148. VisualMenuOption?: VisualMenuOption;
  5149. /**
  5150. * The axis sort options of a dashboard.
  5151. */
  5152. VisualAxisSortOption?: VisualAxisSortOption;
  5153. /**
  5154. * Determines if hidden fields are exported with a dashboard.
  5155. */
  5156. ExportWithHiddenFieldsOption?: ExportWithHiddenFieldsOption;
  5157. /**
  5158. * The drill-down options of data points in a dashboard.
  5159. */
  5160. DataPointDrillUpDownOption?: DataPointDrillUpDownOption;
  5161. /**
  5162. * The data point menu label options of a dashboard.
  5163. */
  5164. DataPointMenuLabelOption?: DataPointMenuLabelOption;
  5165. /**
  5166. * The data point tool tip options of a dashboard.
  5167. */
  5168. DataPointTooltipOption?: DataPointTooltipOption;
  5169. }
  5170. export interface DashboardSearchFilter {
  5171. /**
  5172. * The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike". If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1". If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"DASHBOARD_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DASHBOARD_NAME.
  5173. */
  5174. Operator: FilterOperator;
  5175. /**
  5176. * The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER". Valid values are defined as follows: QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the dashboards's owners or viewers are returned. Implicit permissions from folders or groups are considered. QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are considered. DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as the only owner of the dashboard are returned. Implicit permissions from folders or groups are not considered. DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners of the dashboards are returned. Implicit permissions from folders or groups are not considered. DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any dashboards with that ARN listed as one of the owners or viewers of the dashboards are returned. Implicit permissions from folders or groups are not considered. DASHBOARD_NAME: Any dashboards whose names have a substring match to this value will be returned.
  5177. */
  5178. Name?: DashboardFilterAttribute;
  5179. /**
  5180. * The value of the named item, in this case QUICKSIGHT_USER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
  5181. */
  5182. Value?: String;
  5183. }
  5184. export type DashboardSearchFilterList = DashboardSearchFilter[];
  5185. export interface DashboardSourceEntity {
  5186. /**
  5187. * Source template.
  5188. */
  5189. SourceTemplate?: DashboardSourceTemplate;
  5190. }
  5191. export interface DashboardSourceTemplate {
  5192. /**
  5193. * Dataset references.
  5194. */
  5195. DataSetReferences: DataSetReferenceList;
  5196. /**
  5197. * The Amazon Resource Name (ARN) of the resource.
  5198. */
  5199. Arn: Arn;
  5200. }
  5201. export interface DashboardSummary {
  5202. /**
  5203. * The Amazon Resource Name (ARN) of the resource.
  5204. */
  5205. Arn?: Arn;
  5206. /**
  5207. * Dashboard ID.
  5208. */
  5209. DashboardId?: ShortRestrictiveResourceId;
  5210. /**
  5211. * A display name for the dashboard.
  5212. */
  5213. Name?: DashboardName;
  5214. /**
  5215. * The time that this dashboard was created.
  5216. */
  5217. CreatedTime?: Timestamp;
  5218. /**
  5219. * The last time that this dashboard was updated.
  5220. */
  5221. LastUpdatedTime?: Timestamp;
  5222. /**
  5223. * Published version number.
  5224. */
  5225. PublishedVersionNumber?: VersionNumber;
  5226. /**
  5227. * The last time that this dashboard was published.
  5228. */
  5229. LastPublishedTime?: Timestamp;
  5230. }
  5231. export type DashboardSummaryList = DashboardSummary[];
  5232. export type DashboardUIState = "EXPANDED"|"COLLAPSED"|string;
  5233. export interface DashboardVersion {
  5234. /**
  5235. * The time that this dashboard version was created.
  5236. */
  5237. CreatedTime?: Timestamp;
  5238. /**
  5239. * Errors associated with this dashboard version.
  5240. */
  5241. Errors?: DashboardErrorList;
  5242. /**
  5243. * Version number for this version of the dashboard.
  5244. */
  5245. VersionNumber?: VersionNumber;
  5246. /**
  5247. * The HTTP status of the request.
  5248. */
  5249. Status?: ResourceStatus;
  5250. /**
  5251. * The Amazon Resource Name (ARN) of the resource.
  5252. */
  5253. Arn?: Arn;
  5254. /**
  5255. * Source entity ARN.
  5256. */
  5257. SourceEntityArn?: Arn;
  5258. /**
  5259. * The Amazon Resource Numbers (ARNs) for the datasets that are associated with this version of the dashboard.
  5260. */
  5261. DataSetArns?: DataSetArnsList;
  5262. /**
  5263. * Description.
  5264. */
  5265. Description?: VersionDescription;
  5266. /**
  5267. * The ARN of the theme associated with a version of the dashboard.
  5268. */
  5269. ThemeArn?: Arn;
  5270. /**
  5271. * A list of the associated sheets with the unique identifier and name of each sheet.
  5272. */
  5273. Sheets?: SheetList;
  5274. }
  5275. export interface DashboardVersionDefinition {
  5276. /**
  5277. * An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.
  5278. */
  5279. DataSetIdentifierDeclarations: DataSetIdentifierDeclarationList;
  5280. /**
  5281. * An array of sheet definitions for a dashboard.
  5282. */
  5283. Sheets?: SheetDefinitionList;
  5284. /**
  5285. * An array of calculated field definitions for the dashboard.
  5286. */
  5287. CalculatedFields?: CalculatedFields;
  5288. /**
  5289. * The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object. For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
  5290. */
  5291. ParameterDeclarations?: ParameterDeclarationList;
  5292. /**
  5293. * The filter definitions for a dashboard. For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
  5294. */
  5295. FilterGroups?: FilterGroupList;
  5296. /**
  5297. * An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.
  5298. */
  5299. ColumnConfigurations?: ColumnConfigurationList;
  5300. AnalysisDefaults?: AnalysisDefaults;
  5301. /**
  5302. * An array of option definitions for a dashboard.
  5303. */
  5304. Options?: AssetOptions;
  5305. }
  5306. export interface DashboardVersionSummary {
  5307. /**
  5308. * The Amazon Resource Name (ARN) of the resource.
  5309. */
  5310. Arn?: Arn;
  5311. /**
  5312. * The time that this dashboard version was created.
  5313. */
  5314. CreatedTime?: Timestamp;
  5315. /**
  5316. * Version number.
  5317. */
  5318. VersionNumber?: VersionNumber;
  5319. /**
  5320. * The HTTP status of the request.
  5321. */
  5322. Status?: ResourceStatus;
  5323. /**
  5324. * Source entity ARN.
  5325. */
  5326. SourceEntityArn?: Arn;
  5327. /**
  5328. * Description.
  5329. */
  5330. Description?: VersionDescription;
  5331. }
  5332. export type DashboardVersionSummaryList = DashboardVersionSummary[];
  5333. export interface DashboardVisualId {
  5334. /**
  5335. * The ID of the dashboard that has the visual that you want to embed. The DashboardId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console. You can also get the DashboardId with a ListDashboards API operation.
  5336. */
  5337. DashboardId: ShortRestrictiveResourceId;
  5338. /**
  5339. * The ID of the sheet that the has visual that you want to embed. The SheetId can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.
  5340. */
  5341. SheetId: ShortRestrictiveResourceId;
  5342. /**
  5343. * The ID of the visual that you want to embed. The VisualID can be found in the IDs for developers section of the Embed visual pane of the visual's on-visual menu of the Amazon QuickSight console.
  5344. */
  5345. VisualId: ShortRestrictiveResourceId;
  5346. }
  5347. export interface DashboardVisualPublishOptions {
  5348. /**
  5349. * Determines if hidden fields are included in an exported dashboard.
  5350. */
  5351. ExportHiddenFieldsOption?: ExportHiddenFieldsOption;
  5352. }
  5353. export interface DataAggregation {
  5354. /**
  5355. * The level of time precision that is used to aggregate DateTime values.
  5356. */
  5357. DatasetRowDateGranularity?: TopicTimeGranularity;
  5358. /**
  5359. * The column name for the default date.
  5360. */
  5361. DefaultDateColumnName?: LimitedString;
  5362. }
  5363. export interface DataBarsOptions {
  5364. /**
  5365. * The field ID for the data bars options.
  5366. */
  5367. FieldId: FieldId;
  5368. /**
  5369. * The color of the positive data bar.
  5370. */
  5371. PositiveColor?: HexColor;
  5372. /**
  5373. * The color of the negative data bar.
  5374. */
  5375. NegativeColor?: HexColor;
  5376. }
  5377. export interface DataColor {
  5378. /**
  5379. * The color that is applied to the data value.
  5380. */
  5381. Color?: HexColor;
  5382. /**
  5383. * The data value that the color is applied to.
  5384. */
  5385. DataValue?: Double;
  5386. }
  5387. export interface DataColorPalette {
  5388. /**
  5389. * The hexadecimal codes for the colors.
  5390. */
  5391. Colors?: ColorList;
  5392. /**
  5393. * The minimum and maximum hexadecimal codes that describe a color gradient.
  5394. */
  5395. MinMaxGradient?: ColorList;
  5396. /**
  5397. * The hexadecimal code of a color that applies to charts where a lack of data is highlighted.
  5398. */
  5399. EmptyFillColor?: HexColor;
  5400. }
  5401. export interface DataFieldSeriesItem {
  5402. /**
  5403. * The field ID of the field that you are setting the axis binding to.
  5404. */
  5405. FieldId: FieldId;
  5406. /**
  5407. * The field value of the field that you are setting the axis binding to.
  5408. */
  5409. FieldValue?: SensitiveString;
  5410. /**
  5411. * The axis that you are binding the field to.
  5412. */
  5413. AxisBinding: AxisBinding;
  5414. /**
  5415. * The options that determine the presentation of line series associated to the field.
  5416. */
  5417. Settings?: LineChartSeriesSettings;
  5418. }
  5419. export type DataLabelContent = "VALUE"|"PERCENT"|"VALUE_AND_PERCENT"|string;
  5420. export interface DataLabelOptions {
  5421. /**
  5422. * Determines the visibility of the data labels.
  5423. */
  5424. Visibility?: Visibility;
  5425. /**
  5426. * Determines the visibility of the category field labels.
  5427. */
  5428. CategoryLabelVisibility?: Visibility;
  5429. /**
  5430. * Determines the visibility of the measure field labels.
  5431. */
  5432. MeasureLabelVisibility?: Visibility;
  5433. /**
  5434. * The option that determines the data label type.
  5435. */
  5436. DataLabelTypes?: DataLabelTypes;
  5437. /**
  5438. * Determines the position of the data labels.
  5439. */
  5440. Position?: DataLabelPosition;
  5441. /**
  5442. * Determines the content of the data labels.
  5443. */
  5444. LabelContent?: DataLabelContent;
  5445. /**
  5446. * Determines the font configuration of the data labels.
  5447. */
  5448. LabelFontConfiguration?: FontConfiguration;
  5449. /**
  5450. * Determines the color of the data labels.
  5451. */
  5452. LabelColor?: HexColor;
  5453. /**
  5454. * Determines whether overlap is enabled or disabled for the data labels.
  5455. */
  5456. Overlap?: DataLabelOverlap;
  5457. /**
  5458. * Determines the visibility of the total.
  5459. */
  5460. TotalsVisibility?: Visibility;
  5461. }
  5462. export type DataLabelOverlap = "DISABLE_OVERLAP"|"ENABLE_OVERLAP"|string;
  5463. export type DataLabelPosition = "INSIDE"|"OUTSIDE"|"LEFT"|"TOP"|"BOTTOM"|"RIGHT"|string;
  5464. export interface DataLabelType {
  5465. /**
  5466. * Determines the label configuration for the entire field.
  5467. */
  5468. FieldLabelType?: FieldLabelType;
  5469. /**
  5470. * The option that specifies individual data values for labels.
  5471. */
  5472. DataPathLabelType?: DataPathLabelType;
  5473. /**
  5474. * Determines the label configuration for range end value in a visual.
  5475. */
  5476. RangeEndsLabelType?: RangeEndsLabelType;
  5477. /**
  5478. * Determines the label configuration for the minimum value in a visual.
  5479. */
  5480. MinimumLabelType?: MinimumLabelType;
  5481. /**
  5482. * Determines the label configuration for the maximum value in a visual.
  5483. */
  5484. MaximumLabelType?: MaximumLabelType;
  5485. }
  5486. export type DataLabelTypes = DataLabelType[];
  5487. export interface DataPathColor {
  5488. /**
  5489. * The element that the color needs to be applied to.
  5490. */
  5491. Element: DataPathValue;
  5492. /**
  5493. * The color that needs to be applied to the element.
  5494. */
  5495. Color: HexColor;
  5496. /**
  5497. * The time granularity of the field that the color needs to be applied to.
  5498. */
  5499. TimeGranularity?: TimeGranularity;
  5500. }
  5501. export type DataPathColorList = DataPathColor[];
  5502. export interface DataPathLabelType {
  5503. /**
  5504. * The field ID of the field that the data label needs to be applied to.
  5505. */
  5506. FieldId?: FieldId;
  5507. /**
  5508. * The actual value of the field that is labeled.
  5509. */
  5510. FieldValue?: FieldValue;
  5511. /**
  5512. * The visibility of the data label.
  5513. */
  5514. Visibility?: Visibility;
  5515. }
  5516. export interface DataPathSort {
  5517. /**
  5518. * Determines the sort direction.
  5519. */
  5520. Direction: SortDirection;
  5521. /**
  5522. * The list of data paths that need to be sorted.
  5523. */
  5524. SortPaths: DataPathValueList;
  5525. }
  5526. export interface DataPathType {
  5527. /**
  5528. * The type of data path value utilized in a pivot table. Choose one of the following options: HIERARCHY_ROWS_LAYOUT_COLUMN - The type of data path for the rows layout column, when RowsLayout is set to HIERARCHY. MULTIPLE_ROW_METRICS_COLUMN - The type of data path for the metric column when the row is set to Metric Placement. EMPTY_COLUMN_HEADER - The type of data path for the column with empty column header, when there is no field in ColumnsFieldWell and the row is set to Metric Placement. COUNT_METRIC_COLUMN - The type of data path for the column with COUNT as the metric, when there is no field in the ValuesFieldWell.
  5529. */
  5530. PivotTableDataPathType?: PivotTableDataPathType;
  5531. }
  5532. export interface DataPathValue {
  5533. /**
  5534. * The field ID of the field that needs to be sorted.
  5535. */
  5536. FieldId?: FieldId;
  5537. /**
  5538. * The actual value of the field that needs to be sorted.
  5539. */
  5540. FieldValue?: FieldValue;
  5541. /**
  5542. * The type configuration of the field.
  5543. */
  5544. DataPathType?: DataPathType;
  5545. }
  5546. export type DataPathValueList = DataPathValue[];
  5547. export interface DataPointDrillUpDownOption {
  5548. /**
  5549. * The status of the drill down options of data points.
  5550. */
  5551. AvailabilityStatus?: DashboardBehavior;
  5552. }
  5553. export interface DataPointMenuLabelOption {
  5554. /**
  5555. * The status of the data point menu options.
  5556. */
  5557. AvailabilityStatus?: DashboardBehavior;
  5558. }
  5559. export interface DataPointTooltipOption {
  5560. /**
  5561. * The status of the data point tool tip options.
  5562. */
  5563. AvailabilityStatus?: DashboardBehavior;
  5564. }
  5565. export interface DataSet {
  5566. /**
  5567. * The Amazon Resource Name (ARN) of the resource.
  5568. */
  5569. Arn?: Arn;
  5570. /**
  5571. * The ID of the dataset.
  5572. */
  5573. DataSetId?: ResourceId;
  5574. /**
  5575. * A display name for the dataset.
  5576. */
  5577. Name?: ResourceName;
  5578. /**
  5579. * The time that this dataset was created.
  5580. */
  5581. CreatedTime?: Timestamp;
  5582. /**
  5583. * The last time that this dataset was updated.
  5584. */
  5585. LastUpdatedTime?: Timestamp;
  5586. /**
  5587. * Declares the physical tables that are available in the underlying data sources.
  5588. */
  5589. PhysicalTableMap?: PhysicalTableMap;
  5590. /**
  5591. * Configures the combination and transformation of the data from the physical tables.
  5592. */
  5593. LogicalTableMap?: LogicalTableMap;
  5594. /**
  5595. * The list of columns after all transforms. These columns are available in templates, analyses, and dashboards.
  5596. */
  5597. OutputColumns?: OutputColumnList;
  5598. /**
  5599. * A value that indicates whether you want to import the data into SPICE.
  5600. */
  5601. ImportMode?: DataSetImportMode;
  5602. /**
  5603. * The amount of SPICE capacity used by this dataset. This is 0 if the dataset isn't imported into SPICE.
  5604. */
  5605. ConsumedSpiceCapacityInBytes?: Long;
  5606. /**
  5607. * Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
  5608. */
  5609. ColumnGroups?: ColumnGroupList;
  5610. /**
  5611. * The folder that contains fields and nested subfolders for your dataset.
  5612. */
  5613. FieldFolders?: FieldFolderMap;
  5614. /**
  5615. * The row-level security configuration for the dataset.
  5616. */
  5617. RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
  5618. /**
  5619. * The element you can use to define tags for row-level security.
  5620. */
  5621. RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration;
  5622. /**
  5623. * A set of one or more definitions of a ColumnLevelPermissionRule .
  5624. */
  5625. ColumnLevelPermissionRules?: ColumnLevelPermissionRuleList;
  5626. /**
  5627. * The usage configuration to apply to child datasets that reference this dataset as a source.
  5628. */
  5629. DataSetUsageConfiguration?: DataSetUsageConfiguration;
  5630. /**
  5631. * The parameters that are declared in a dataset.
  5632. */
  5633. DatasetParameters?: DatasetParameterList;
  5634. }
  5635. export type DataSetArnsList = Arn[];
  5636. export interface DataSetConfiguration {
  5637. /**
  5638. * Placeholder.
  5639. */
  5640. Placeholder?: String;
  5641. /**
  5642. * Dataset schema.
  5643. */
  5644. DataSetSchema?: DataSetSchema;
  5645. /**
  5646. * A structure containing the list of column group schemas.
  5647. */
  5648. ColumnGroupSchemaList?: ColumnGroupSchemaList;
  5649. }
  5650. export type DataSetConfigurationList = DataSetConfiguration[];
  5651. export type DataSetFilterAttribute = "QUICKSIGHT_VIEWER_OR_OWNER"|"QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"|"DIRECT_QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_SOLE_OWNER"|"DATASET_NAME"|string;
  5652. export type DataSetIdentifier = string;
  5653. export interface DataSetIdentifierDeclaration {
  5654. /**
  5655. * The identifier of the data set, typically the data set's name.
  5656. */
  5657. Identifier: DataSetIdentifier;
  5658. /**
  5659. * The Amazon Resource Name (ARN) of the data set.
  5660. */
  5661. DataSetArn: Arn;
  5662. }
  5663. export type DataSetIdentifierDeclarationList = DataSetIdentifierDeclaration[];
  5664. export type DataSetImportMode = "SPICE"|"DIRECT_QUERY"|string;
  5665. export type DataSetName = string;
  5666. export interface DataSetReference {
  5667. /**
  5668. * Dataset placeholder.
  5669. */
  5670. DataSetPlaceholder: NonEmptyString;
  5671. /**
  5672. * Dataset Amazon Resource Name (ARN).
  5673. */
  5674. DataSetArn: Arn;
  5675. }
  5676. export type DataSetReferenceList = DataSetReference[];
  5677. export interface DataSetRefreshProperties {
  5678. /**
  5679. * The refresh configuration for a dataset.
  5680. */
  5681. RefreshConfiguration: RefreshConfiguration;
  5682. }
  5683. export type DataSetRegion = string;
  5684. export interface DataSetSchema {
  5685. /**
  5686. * A structure containing the list of column schemas.
  5687. */
  5688. ColumnSchemaList?: ColumnSchemaList;
  5689. }
  5690. export interface DataSetSearchFilter {
  5691. /**
  5692. * The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike". If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose datasets you want to search in the "Value" field. For example, "Name":"QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east- 1:1:user/default/UserName1". If you set the value to "StringLike", you need to provide the name of the datasets you are searching for. For example, "Name":"DATASET_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASET_NAME.
  5693. */
  5694. Operator: FilterOperator;
  5695. /**
  5696. * The name of the value that you want to use as a filter, for example, "Name": "QUICKSIGHT_OWNER". Valid values are defined as follows: QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the dataset owners or viewers are returned. Implicit permissions from folders or groups are considered. QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners of the dataset are returned. Implicit permissions from folders or groups are considered. DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as the only owner of the dataset are returned. Implicit permissions from folders or groups are not considered. DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners if the dataset are returned. Implicit permissions from folders or groups are not considered. DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any datasets with that ARN listed as one of the owners or viewers of the dataset are returned. Implicit permissions from folders or groups are not considered. DATASET_NAME: Any datasets whose names have a substring match to this value will be returned.
  5697. */
  5698. Name: DataSetFilterAttribute;
  5699. /**
  5700. * The value of the named item, in this case QUICKSIGHT_OWNER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
  5701. */
  5702. Value: String;
  5703. }
  5704. export type DataSetSearchFilterList = DataSetSearchFilter[];
  5705. export interface DataSetSummary {
  5706. /**
  5707. * The Amazon Resource Name (ARN) of the dataset.
  5708. */
  5709. Arn?: Arn;
  5710. /**
  5711. * The ID of the dataset.
  5712. */
  5713. DataSetId?: ResourceId;
  5714. /**
  5715. * A display name for the dataset.
  5716. */
  5717. Name?: ResourceName;
  5718. /**
  5719. * The time that this dataset was created.
  5720. */
  5721. CreatedTime?: Timestamp;
  5722. /**
  5723. * The last time that this dataset was updated.
  5724. */
  5725. LastUpdatedTime?: Timestamp;
  5726. /**
  5727. * A value that indicates whether you want to import the data into SPICE.
  5728. */
  5729. ImportMode?: DataSetImportMode;
  5730. /**
  5731. * The row-level security configuration for the dataset.
  5732. */
  5733. RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
  5734. /**
  5735. * Whether or not the row level permission tags are applied.
  5736. */
  5737. RowLevelPermissionTagConfigurationApplied?: Boolean;
  5738. /**
  5739. * A value that indicates if the dataset has column level permission configured.
  5740. */
  5741. ColumnLevelPermissionRulesApplied?: Boolean;
  5742. }
  5743. export type DataSetSummaryList = DataSetSummary[];
  5744. export interface DataSetUsageConfiguration {
  5745. /**
  5746. * An option that controls whether a child dataset of a direct query can use this dataset as a source.
  5747. */
  5748. DisableUseAsDirectQuerySource?: Boolean;
  5749. /**
  5750. * An option that controls whether a child dataset that's stored in QuickSight can use this dataset as a source.
  5751. */
  5752. DisableUseAsImportedSource?: Boolean;
  5753. }
  5754. export interface DataSource {
  5755. /**
  5756. * The Amazon Resource Name (ARN) of the data source.
  5757. */
  5758. Arn?: Arn;
  5759. /**
  5760. * The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  5761. */
  5762. DataSourceId?: ResourceId;
  5763. /**
  5764. * A display name for the data source.
  5765. */
  5766. Name?: ResourceName;
  5767. /**
  5768. * The type of the data source. This type indicates which database engine the data source connects to.
  5769. */
  5770. Type?: DataSourceType;
  5771. /**
  5772. * The HTTP status of the request.
  5773. */
  5774. Status?: ResourceStatus;
  5775. /**
  5776. * The time that this data source was created.
  5777. */
  5778. CreatedTime?: Timestamp;
  5779. /**
  5780. * The last time that this data source was updated.
  5781. */
  5782. LastUpdatedTime?: Timestamp;
  5783. /**
  5784. * The parameters that Amazon QuickSight uses to connect to your underlying source. This is a variant type structure. For this structure to be valid, only one of the attributes can be non-null.
  5785. */
  5786. DataSourceParameters?: DataSourceParameters;
  5787. /**
  5788. * A set of alternate data source parameters that you want to share for the credentials stored with this data source. The credentials are applied in tandem with the data source parameters when you copy a data source by using a create or update request. The API operation compares the DataSourceParameters structure that's in the request with the structures in the AlternateDataSourceParameters allow list. If the structures are an exact match, the request is allowed to use the credentials from this existing data source. If the AlternateDataSourceParameters list is null, the Credentials originally used with this DataSourceParameters are automatically allowed.
  5789. */
  5790. AlternateDataSourceParameters?: DataSourceParametersList;
  5791. /**
  5792. * The VPC connection information. You need to use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
  5793. */
  5794. VpcConnectionProperties?: VpcConnectionProperties;
  5795. /**
  5796. * Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
  5797. */
  5798. SslProperties?: SslProperties;
  5799. /**
  5800. * Error information from the last update or the creation of the data source.
  5801. */
  5802. ErrorInfo?: DataSourceErrorInfo;
  5803. /**
  5804. * The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
  5805. */
  5806. SecretArn?: SecretArn;
  5807. }
  5808. export interface DataSourceCredentials {
  5809. /**
  5810. * Credential pair. For more information, see CredentialPair .
  5811. */
  5812. CredentialPair?: CredentialPair;
  5813. /**
  5814. * The Amazon Resource Name (ARN) of a data source that has the credential pair that you want to use. When CopySourceArn is not null, the credential pair from the data source in the ARN is used as the credentials for the DataSourceCredentials structure.
  5815. */
  5816. CopySourceArn?: CopySourceArn;
  5817. /**
  5818. * The Amazon Resource Name (ARN) of the secret associated with the data source in Amazon Secrets Manager.
  5819. */
  5820. SecretArn?: SecretArn;
  5821. }
  5822. export interface DataSourceErrorInfo {
  5823. /**
  5824. * Error type.
  5825. */
  5826. Type?: DataSourceErrorInfoType;
  5827. /**
  5828. * Error message.
  5829. */
  5830. Message?: String;
  5831. }
  5832. export type DataSourceErrorInfoType = "ACCESS_DENIED"|"COPY_SOURCE_NOT_FOUND"|"TIMEOUT"|"ENGINE_VERSION_NOT_SUPPORTED"|"UNKNOWN_HOST"|"GENERIC_SQL_FAILURE"|"CONFLICT"|"UNKNOWN"|string;
  5833. export type DataSourceFilterAttribute = "DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"|"DIRECT_QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_SOLE_OWNER"|"DATASOURCE_NAME"|string;
  5834. export type DataSourceList = DataSource[];
  5835. export interface DataSourceParameters {
  5836. /**
  5837. * The parameters for OpenSearch.
  5838. */
  5839. AmazonElasticsearchParameters?: AmazonElasticsearchParameters;
  5840. /**
  5841. * The parameters for Amazon Athena.
  5842. */
  5843. AthenaParameters?: AthenaParameters;
  5844. /**
  5845. * The parameters for Amazon Aurora MySQL.
  5846. */
  5847. AuroraParameters?: AuroraParameters;
  5848. /**
  5849. * The parameters for Amazon Aurora.
  5850. */
  5851. AuroraPostgreSqlParameters?: AuroraPostgreSqlParameters;
  5852. /**
  5853. * The parameters for IoT Analytics.
  5854. */
  5855. AwsIotAnalyticsParameters?: AwsIotAnalyticsParameters;
  5856. /**
  5857. * The parameters for Jira.
  5858. */
  5859. JiraParameters?: JiraParameters;
  5860. /**
  5861. * The parameters for MariaDB.
  5862. */
  5863. MariaDbParameters?: MariaDbParameters;
  5864. /**
  5865. * The parameters for MySQL.
  5866. */
  5867. MySqlParameters?: MySqlParameters;
  5868. /**
  5869. * The parameters for Oracle.
  5870. */
  5871. OracleParameters?: OracleParameters;
  5872. /**
  5873. * The parameters for PostgreSQL.
  5874. */
  5875. PostgreSqlParameters?: PostgreSqlParameters;
  5876. /**
  5877. * The parameters for Presto.
  5878. */
  5879. PrestoParameters?: PrestoParameters;
  5880. /**
  5881. * The parameters for Amazon RDS.
  5882. */
  5883. RdsParameters?: RdsParameters;
  5884. /**
  5885. * The parameters for Amazon Redshift.
  5886. */
  5887. RedshiftParameters?: RedshiftParameters;
  5888. /**
  5889. * The parameters for S3.
  5890. */
  5891. S3Parameters?: S3Parameters;
  5892. /**
  5893. * The parameters for ServiceNow.
  5894. */
  5895. ServiceNowParameters?: ServiceNowParameters;
  5896. /**
  5897. * The parameters for Snowflake.
  5898. */
  5899. SnowflakeParameters?: SnowflakeParameters;
  5900. /**
  5901. * The parameters for Spark.
  5902. */
  5903. SparkParameters?: SparkParameters;
  5904. /**
  5905. * The parameters for SQL Server.
  5906. */
  5907. SqlServerParameters?: SqlServerParameters;
  5908. /**
  5909. * The parameters for Teradata.
  5910. */
  5911. TeradataParameters?: TeradataParameters;
  5912. /**
  5913. * The parameters for Twitter.
  5914. */
  5915. TwitterParameters?: TwitterParameters;
  5916. /**
  5917. * The parameters for OpenSearch.
  5918. */
  5919. AmazonOpenSearchParameters?: AmazonOpenSearchParameters;
  5920. /**
  5921. * The parameters for Exasol.
  5922. */
  5923. ExasolParameters?: ExasolParameters;
  5924. /**
  5925. * The parameters that are required to connect to a Databricks data source.
  5926. */
  5927. DatabricksParameters?: DatabricksParameters;
  5928. /**
  5929. * The parameters that are required to connect to a Starburst data source.
  5930. */
  5931. StarburstParameters?: StarburstParameters;
  5932. /**
  5933. * The parameters that are required to connect to a Trino data source.
  5934. */
  5935. TrinoParameters?: TrinoParameters;
  5936. /**
  5937. * The parameters that are required to connect to a Google BigQuery data source.
  5938. */
  5939. BigQueryParameters?: BigQueryParameters;
  5940. }
  5941. export type DataSourceParametersList = DataSourceParameters[];
  5942. export interface DataSourceSearchFilter {
  5943. /**
  5944. * The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike". If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose data sources you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1". If you set the value to "StringLike", you need to provide the name of the data sources you are searching for. For example, "Name":"DATASOURCE_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value DATASOURCE_NAME.
  5945. */
  5946. Operator: FilterOperator;
  5947. /**
  5948. * The name of the value that you want to use as a filter, for example, "Name": "DIRECT_QUICKSIGHT_OWNER". Valid values are defined as follows: DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners or viewers of the data sources are returned. Implicit permissions from folders or groups are not considered. DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as one of the owners if the data source are returned. Implicit permissions from folders or groups are not considered. DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any data sources with that ARN listed as the only owner of the data source are returned. Implicit permissions from folders or groups are not considered. DATASOURCE_NAME: Any data sources whose names have a substring match to the provided value are returned.
  5949. */
  5950. Name: DataSourceFilterAttribute;
  5951. /**
  5952. * The value of the named item, for example DIRECT_QUICKSIGHT_OWNER, that you want to use as a filter, for example, "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1".
  5953. */
  5954. Value: String;
  5955. }
  5956. export type DataSourceSearchFilterList = DataSourceSearchFilter[];
  5957. export interface DataSourceSummary {
  5958. /**
  5959. * The arn of the datasource.
  5960. */
  5961. Arn?: Arn;
  5962. /**
  5963. * The unique ID of the data source.
  5964. */
  5965. DataSourceId?: ResourceId;
  5966. /**
  5967. * The name of the data source.
  5968. */
  5969. Name?: ResourceName;
  5970. /**
  5971. * The type of the data source.
  5972. */
  5973. Type?: DataSourceType;
  5974. /**
  5975. * The date and time that the data source was created. This value is expressed in MM-DD-YYYY HH:MM:SS format.
  5976. */
  5977. CreatedTime?: Timestamp;
  5978. /**
  5979. * The date and time the data source was last updated. This value is expressed in MM-DD-YYYY HH:MM:SS format.
  5980. */
  5981. LastUpdatedTime?: Timestamp;
  5982. }
  5983. export type DataSourceSummaryList = DataSourceSummary[];
  5984. export type DataSourceType = "ADOBE_ANALYTICS"|"AMAZON_ELASTICSEARCH"|"ATHENA"|"AURORA"|"AURORA_POSTGRESQL"|"AWS_IOT_ANALYTICS"|"GITHUB"|"JIRA"|"MARIADB"|"MYSQL"|"ORACLE"|"POSTGRESQL"|"PRESTO"|"REDSHIFT"|"S3"|"SALESFORCE"|"SERVICENOW"|"SNOWFLAKE"|"SPARK"|"SQLSERVER"|"TERADATA"|"TWITTER"|"TIMESTREAM"|"AMAZON_OPENSEARCH"|"EXASOL"|"DATABRICKS"|"STARBURST"|"TRINO"|"BIGQUERY"|string;
  5985. export type Database = string;
  5986. export type DatabaseGroup = string;
  5987. export type DatabaseGroupList = DatabaseGroup[];
  5988. export type DatabaseUser = string;
  5989. export interface DatabricksParameters {
  5990. /**
  5991. * The host name of the Databricks data source.
  5992. */
  5993. Host: Host;
  5994. /**
  5995. * The port for the Databricks data source.
  5996. */
  5997. Port: Port;
  5998. /**
  5999. * The HTTP path of the Databricks data source.
  6000. */
  6001. SqlEndpointPath: SqlEndpointPath;
  6002. }
  6003. export interface DatasetMetadata {
  6004. /**
  6005. * The Amazon Resource Name (ARN) of the dataset.
  6006. */
  6007. DatasetArn: Arn;
  6008. /**
  6009. * The name of the dataset.
  6010. */
  6011. DatasetName?: LimitedString;
  6012. /**
  6013. * The description of the dataset.
  6014. */
  6015. DatasetDescription?: LimitedString;
  6016. /**
  6017. * The definition of a data aggregation.
  6018. */
  6019. DataAggregation?: DataAggregation;
  6020. /**
  6021. * The list of filter definitions.
  6022. */
  6023. Filters?: TopicFilters;
  6024. /**
  6025. * The list of column definitions.
  6026. */
  6027. Columns?: TopicColumns;
  6028. /**
  6029. * The list of calculated field definitions.
  6030. */
  6031. CalculatedFields?: TopicCalculatedFields;
  6032. /**
  6033. * The list of named entities definitions.
  6034. */
  6035. NamedEntities?: TopicNamedEntities;
  6036. }
  6037. export interface DatasetParameter {
  6038. /**
  6039. * A string parameter that is created in the dataset.
  6040. */
  6041. StringDatasetParameter?: StringDatasetParameter;
  6042. /**
  6043. * A decimal parameter that is created in the dataset.
  6044. */
  6045. DecimalDatasetParameter?: DecimalDatasetParameter;
  6046. /**
  6047. * An integer parameter that is created in the dataset.
  6048. */
  6049. IntegerDatasetParameter?: IntegerDatasetParameter;
  6050. /**
  6051. * A date time parameter that is created in the dataset.
  6052. */
  6053. DateTimeDatasetParameter?: DateTimeDatasetParameter;
  6054. }
  6055. export type DatasetParameterId = string;
  6056. export type DatasetParameterList = DatasetParameter[];
  6057. export type DatasetParameterName = string;
  6058. export type DatasetParameterValueType = "MULTI_VALUED"|"SINGLE_VALUED"|string;
  6059. export type Datasets = DatasetMetadata[];
  6060. export type DateAggregationFunction = "COUNT"|"DISTINCT_COUNT"|"MIN"|"MAX"|string;
  6061. export interface DateAxisOptions {
  6062. /**
  6063. * Determines whether or not missing dates are displayed.
  6064. */
  6065. MissingDateVisibility?: Visibility;
  6066. }
  6067. export interface DateDimensionField {
  6068. /**
  6069. * The custom field ID.
  6070. */
  6071. FieldId: FieldId;
  6072. /**
  6073. * The column that is used in the DateDimensionField.
  6074. */
  6075. Column: ColumnIdentifier;
  6076. /**
  6077. * The date granularity of the DateDimensionField. Choose one of the following options: YEAR QUARTER MONTH WEEK DAY HOUR MINUTE SECOND MILLISECOND
  6078. */
  6079. DateGranularity?: TimeGranularity;
  6080. /**
  6081. * The custom hierarchy ID.
  6082. */
  6083. HierarchyId?: HierarchyId;
  6084. /**
  6085. * The format configuration of the field.
  6086. */
  6087. FormatConfiguration?: DateTimeFormatConfiguration;
  6088. }
  6089. export interface DateMeasureField {
  6090. /**
  6091. * The custom field ID.
  6092. */
  6093. FieldId: FieldId;
  6094. /**
  6095. * The column that is used in the DateMeasureField.
  6096. */
  6097. Column: ColumnIdentifier;
  6098. /**
  6099. * The aggregation function of the measure field.
  6100. */
  6101. AggregationFunction?: DateAggregationFunction;
  6102. /**
  6103. * The format configuration of the field.
  6104. */
  6105. FormatConfiguration?: DateTimeFormatConfiguration;
  6106. }
  6107. export interface DateTimeDatasetParameter {
  6108. /**
  6109. * An identifier for the parameter that is created in the dataset.
  6110. */
  6111. Id: DatasetParameterId;
  6112. /**
  6113. * The name of the date time parameter that is created in the dataset.
  6114. */
  6115. Name: DatasetParameterName;
  6116. /**
  6117. * The value type of the dataset parameter. Valid values are single value or multi value.
  6118. */
  6119. ValueType: DatasetParameterValueType;
  6120. /**
  6121. * The time granularity of the date time parameter.
  6122. */
  6123. TimeGranularity?: TimeGranularity;
  6124. /**
  6125. * A list of default values for a given date time parameter. This structure only accepts static values.
  6126. */
  6127. DefaultValues?: DateTimeDatasetParameterDefaultValues;
  6128. }
  6129. export type DateTimeDatasetParameterDefaultValue = Date;
  6130. export interface DateTimeDatasetParameterDefaultValues {
  6131. /**
  6132. * A list of static default values for a given date time parameter.
  6133. */
  6134. StaticValues?: DateTimeDatasetParameterValueList;
  6135. }
  6136. export type DateTimeDatasetParameterValueList = DateTimeDatasetParameterDefaultValue[];
  6137. export type DateTimeDefaultValueList = SensitiveTimestamp[];
  6138. export interface DateTimeDefaultValues {
  6139. /**
  6140. * The dynamic value of the DataTimeDefaultValues. Different defaults are displayed according to users, groups, and values mapping.
  6141. */
  6142. DynamicValue?: DynamicDefaultValue;
  6143. /**
  6144. * The static values of the DataTimeDefaultValues.
  6145. */
  6146. StaticValues?: DateTimeDefaultValueList;
  6147. /**
  6148. * The rolling date of the DataTimeDefaultValues. The date is determined from the dataset based on input expression.
  6149. */
  6150. RollingDate?: RollingDateConfiguration;
  6151. }
  6152. export type DateTimeFormat = string;
  6153. export interface DateTimeFormatConfiguration {
  6154. /**
  6155. * Determines the DateTime format.
  6156. */
  6157. DateTimeFormat?: DateTimeFormat;
  6158. /**
  6159. * The options that determine the null value format configuration.
  6160. */
  6161. NullValueFormatConfiguration?: NullValueFormatConfiguration;
  6162. /**
  6163. * The formatting configuration for numeric DateTime fields.
  6164. */
  6165. NumericFormatConfiguration?: NumericFormatConfiguration;
  6166. }
  6167. export interface DateTimeHierarchy {
  6168. /**
  6169. * The hierarchy ID of the DateTime hierarchy.
  6170. */
  6171. HierarchyId: HierarchyId;
  6172. /**
  6173. * The option that determines the drill down filters for the DateTime hierarchy.
  6174. */
  6175. DrillDownFilters?: DrillDownFilterList;
  6176. }
  6177. export interface DateTimeParameter {
  6178. /**
  6179. * A display name for the date-time parameter.
  6180. */
  6181. Name: NonEmptyString;
  6182. /**
  6183. * The values for the date-time parameter.
  6184. */
  6185. Values: SensitiveTimestampList;
  6186. }
  6187. export interface DateTimeParameterDeclaration {
  6188. /**
  6189. * The name of the parameter that is being declared.
  6190. */
  6191. Name: ParameterName;
  6192. /**
  6193. * The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
  6194. */
  6195. DefaultValues?: DateTimeDefaultValues;
  6196. /**
  6197. * The level of time precision that is used to aggregate DateTime values.
  6198. */
  6199. TimeGranularity?: TimeGranularity;
  6200. /**
  6201. * The configuration that defines the default value of a DateTime parameter when a value has not been set.
  6202. */
  6203. ValueWhenUnset?: DateTimeValueWhenUnsetConfiguration;
  6204. MappedDataSetParameters?: MappedDataSetParameters;
  6205. }
  6206. export type DateTimeParameterList = DateTimeParameter[];
  6207. export interface DateTimePickerControlDisplayOptions {
  6208. /**
  6209. * The options to configure the title visibility, name, and font size.
  6210. */
  6211. TitleOptions?: LabelOptions;
  6212. /**
  6213. * Customize how dates are formatted in controls.
  6214. */
  6215. DateTimeFormat?: DateTimeFormat;
  6216. /**
  6217. * The configuration of info icon label options.
  6218. */
  6219. InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
  6220. }
  6221. export interface DateTimeValueWhenUnsetConfiguration {
  6222. /**
  6223. * The built-in options for default values. The value can be one of the following: RECOMMENDED: The recommended value. NULL: The NULL value.
  6224. */
  6225. ValueWhenUnsetOption?: ValueWhenUnsetOption;
  6226. /**
  6227. * A custom value that's used when the value of a parameter isn't set.
  6228. */
  6229. CustomValue?: SensitiveTimestamp;
  6230. }
  6231. export type DayOfMonth = string;
  6232. export type DayOfTheWeek = "SUNDAY"|"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|string;
  6233. export type DayOfWeek = "SUNDAY"|"MONDAY"|"TUESDAY"|"WEDNESDAY"|"THURSDAY"|"FRIDAY"|"SATURDAY"|string;
  6234. export type DbUsername = string;
  6235. export interface DecimalDatasetParameter {
  6236. /**
  6237. * An identifier for the decimal parameter created in the dataset.
  6238. */
  6239. Id: DatasetParameterId;
  6240. /**
  6241. * The name of the decimal parameter that is created in the dataset.
  6242. */
  6243. Name: DatasetParameterName;
  6244. /**
  6245. * The value type of the dataset parameter. Valid values are single value or multi value.
  6246. */
  6247. ValueType: DatasetParameterValueType;
  6248. /**
  6249. * A list of default values for a given decimal parameter. This structure only accepts static values.
  6250. */
  6251. DefaultValues?: DecimalDatasetParameterDefaultValues;
  6252. }
  6253. export type DecimalDatasetParameterDefaultValue = number;
  6254. export interface DecimalDatasetParameterDefaultValues {
  6255. /**
  6256. * A list of static default values for a given decimal parameter.
  6257. */
  6258. StaticValues?: DecimalDatasetParameterValueList;
  6259. }
  6260. export type DecimalDatasetParameterValueList = DecimalDatasetParameterDefaultValue[];
  6261. export type DecimalDefaultValueList = SensitiveDoubleObject[];
  6262. export interface DecimalDefaultValues {
  6263. /**
  6264. * The dynamic value of the DecimalDefaultValues. Different defaults are displayed according to users, groups, and values mapping.
  6265. */
  6266. DynamicValue?: DynamicDefaultValue;
  6267. /**
  6268. * The static values of the DecimalDefaultValues.
  6269. */
  6270. StaticValues?: DecimalDefaultValueList;
  6271. }
  6272. export interface DecimalParameter {
  6273. /**
  6274. * A display name for the decimal parameter.
  6275. */
  6276. Name: NonEmptyString;
  6277. /**
  6278. * The values for the decimal parameter.
  6279. */
  6280. Values: SensitiveDoubleList;
  6281. }
  6282. export interface DecimalParameterDeclaration {
  6283. /**
  6284. * The value type determines whether the parameter is a single-value or multi-value parameter.
  6285. */
  6286. ParameterValueType: ParameterValueType;
  6287. /**
  6288. * The name of the parameter that is being declared.
  6289. */
  6290. Name: ParameterName;
  6291. /**
  6292. * The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
  6293. */
  6294. DefaultValues?: DecimalDefaultValues;
  6295. /**
  6296. * The configuration that defines the default value of a Decimal parameter when a value has not been set.
  6297. */
  6298. ValueWhenUnset?: DecimalValueWhenUnsetConfiguration;
  6299. MappedDataSetParameters?: MappedDataSetParameters;
  6300. }
  6301. export type DecimalParameterList = DecimalParameter[];
  6302. export type DecimalPlaces = number;
  6303. export interface DecimalPlacesConfiguration {
  6304. /**
  6305. * The values of the decimal places.
  6306. */
  6307. DecimalPlaces: DecimalPlaces;
  6308. }
  6309. export interface DecimalValueWhenUnsetConfiguration {
  6310. /**
  6311. * The built-in options for default values. The value can be one of the following: RECOMMENDED: The recommended value. NULL: The NULL value.
  6312. */
  6313. ValueWhenUnsetOption?: ValueWhenUnsetOption;
  6314. /**
  6315. * A custom value that's used when the value of a parameter isn't set.
  6316. */
  6317. CustomValue?: SensitiveDouble;
  6318. }
  6319. export type DefaultAggregation = "SUM"|"MAX"|"MIN"|"COUNT"|"DISTINCT_COUNT"|"AVERAGE"|"MEDIAN"|"STDEV"|"STDEVP"|"VAR"|"VARP"|string;
  6320. export interface DefaultDateTimePickerControlOptions {
  6321. /**
  6322. * The date time picker type of the DefaultDateTimePickerControlOptions. Choose one of the following options: SINGLE_VALUED: The filter condition is a fixed date. DATE_RANGE: The filter condition is a date time range.
  6323. */
  6324. Type?: SheetControlDateTimePickerType;
  6325. /**
  6326. * The display options of a control.
  6327. */
  6328. DisplayOptions?: DateTimePickerControlDisplayOptions;
  6329. }
  6330. export interface DefaultFilterControlConfiguration {
  6331. /**
  6332. * The title of the DefaultFilterControlConfiguration. This title is shared by all controls that are tied to this filter.
  6333. */
  6334. Title: SheetControlTitle;
  6335. /**
  6336. * The control option for the DefaultFilterControlConfiguration.
  6337. */
  6338. ControlOptions: DefaultFilterControlOptions;
  6339. }
  6340. export interface DefaultFilterControlOptions {
  6341. /**
  6342. * The default options that correspond to the filter control type of a DateTimePicker.
  6343. */
  6344. DefaultDateTimePickerOptions?: DefaultDateTimePickerControlOptions;
  6345. /**
  6346. * The default options that correspond to the List filter control type.
  6347. */
  6348. DefaultListOptions?: DefaultFilterListControlOptions;
  6349. /**
  6350. * The default options that correspond to the Dropdown filter control type.
  6351. */
  6352. DefaultDropdownOptions?: DefaultFilterDropDownControlOptions;
  6353. /**
  6354. * The default options that correspond to the TextField filter control type.
  6355. */
  6356. DefaultTextFieldOptions?: DefaultTextFieldControlOptions;
  6357. /**
  6358. * The default options that correspond to the TextArea filter control type.
  6359. */
  6360. DefaultTextAreaOptions?: DefaultTextAreaControlOptions;
  6361. /**
  6362. * The default options that correspond to the Slider filter control type.
  6363. */
  6364. DefaultSliderOptions?: DefaultSliderControlOptions;
  6365. /**
  6366. * The default options that correspond to the RelativeDateTime filter control type.
  6367. */
  6368. DefaultRelativeDateTimeOptions?: DefaultRelativeDateTimeControlOptions;
  6369. }
  6370. export interface DefaultFilterDropDownControlOptions {
  6371. /**
  6372. * The display options of a control.
  6373. */
  6374. DisplayOptions?: DropDownControlDisplayOptions;
  6375. /**
  6376. * The type of the FilterDropDownControl. Choose one of the following options: MULTI_SELECT: The user can select multiple entries from a dropdown menu. SINGLE_SELECT: The user can select a single entry from a dropdown menu.
  6377. */
  6378. Type?: SheetControlListType;
  6379. /**
  6380. * A list of selectable values that are used in a control.
  6381. */
  6382. SelectableValues?: FilterSelectableValues;
  6383. }
  6384. export interface DefaultFilterListControlOptions {
  6385. /**
  6386. * The display options of a control.
  6387. */
  6388. DisplayOptions?: ListControlDisplayOptions;
  6389. /**
  6390. * The type of the DefaultFilterListControlOptions. Choose one of the following options: MULTI_SELECT: The user can select multiple entries from the list. SINGLE_SELECT: The user can select a single entry from the list.
  6391. */
  6392. Type?: SheetControlListType;
  6393. /**
  6394. * A list of selectable values that are used in a control.
  6395. */
  6396. SelectableValues?: FilterSelectableValues;
  6397. }
  6398. export interface DefaultFormatting {
  6399. /**
  6400. * The display format. Valid values for this structure are AUTO, PERCENT, CURRENCY, NUMBER, DATE, and STRING.
  6401. */
  6402. DisplayFormat?: DisplayFormat;
  6403. /**
  6404. * The additional options for display formatting.
  6405. */
  6406. DisplayFormatOptions?: DisplayFormatOptions;
  6407. }
  6408. export interface DefaultFreeFormLayoutConfiguration {
  6409. /**
  6410. * Determines the screen canvas size options for a free-form layout.
  6411. */
  6412. CanvasSizeOptions: FreeFormLayoutCanvasSizeOptions;
  6413. }
  6414. export interface DefaultGridLayoutConfiguration {
  6415. /**
  6416. * Determines the screen canvas size options for a grid layout.
  6417. */
  6418. CanvasSizeOptions: GridLayoutCanvasSizeOptions;
  6419. }
  6420. export interface DefaultInteractiveLayoutConfiguration {
  6421. /**
  6422. * The options that determine the default settings for a grid layout configuration.
  6423. */
  6424. Grid?: DefaultGridLayoutConfiguration;
  6425. /**
  6426. * The options that determine the default settings of a free-form layout configuration.
  6427. */
  6428. FreeForm?: DefaultFreeFormLayoutConfiguration;
  6429. }
  6430. export interface DefaultNewSheetConfiguration {
  6431. /**
  6432. * The options that determine the default settings for interactive layout configuration.
  6433. */
  6434. InteractiveLayoutConfiguration?: DefaultInteractiveLayoutConfiguration;
  6435. /**
  6436. * The options that determine the default settings for a paginated layout configuration.
  6437. */
  6438. PaginatedLayoutConfiguration?: DefaultPaginatedLayoutConfiguration;
  6439. /**
  6440. * The option that determines the sheet content type.
  6441. */
  6442. SheetContentType?: SheetContentType;
  6443. }
  6444. export interface DefaultPaginatedLayoutConfiguration {
  6445. /**
  6446. * The options that determine the default settings for a section-based layout configuration.
  6447. */
  6448. SectionBased?: DefaultSectionBasedLayoutConfiguration;
  6449. }
  6450. export interface DefaultRelativeDateTimeControlOptions {
  6451. /**
  6452. * The display options of a control.
  6453. */
  6454. DisplayOptions?: RelativeDateTimeControlDisplayOptions;
  6455. }
  6456. export interface DefaultSectionBasedLayoutConfiguration {
  6457. /**
  6458. * Determines the screen canvas size options for a section-based layout.
  6459. */
  6460. CanvasSizeOptions: SectionBasedLayoutCanvasSizeOptions;
  6461. }
  6462. export interface DefaultSliderControlOptions {
  6463. /**
  6464. * The display options of a control.
  6465. */
  6466. DisplayOptions?: SliderControlDisplayOptions;
  6467. /**
  6468. * The type of the DefaultSliderControlOptions. Choose one of the following options: SINGLE_POINT: Filter against(equals) a single data point. RANGE: Filter data that is in a specified range.
  6469. */
  6470. Type?: SheetControlSliderType;
  6471. /**
  6472. * The larger value that is displayed at the right of the slider.
  6473. */
  6474. MaximumValue: Double;
  6475. /**
  6476. * The smaller value that is displayed at the left of the slider.
  6477. */
  6478. MinimumValue: Double;
  6479. /**
  6480. * The number of increments that the slider bar is divided into.
  6481. */
  6482. StepSize: Double;
  6483. }
  6484. export interface DefaultTextAreaControlOptions {
  6485. /**
  6486. * The delimiter that is used to separate the lines in text.
  6487. */
  6488. Delimiter?: TextAreaControlDelimiter;
  6489. /**
  6490. * The display options of a control.
  6491. */
  6492. DisplayOptions?: TextAreaControlDisplayOptions;
  6493. }
  6494. export interface DefaultTextFieldControlOptions {
  6495. /**
  6496. * The display options of a control.
  6497. */
  6498. DisplayOptions?: TextFieldControlDisplayOptions;
  6499. }
  6500. export interface DeleteAccountCustomizationRequest {
  6501. /**
  6502. * The ID for the Amazon Web Services account that you want to delete Amazon QuickSight customizations from in this Amazon Web Services Region.
  6503. */
  6504. AwsAccountId: AwsAccountId;
  6505. /**
  6506. * The Amazon QuickSight namespace that you're deleting the customizations from.
  6507. */
  6508. Namespace?: Namespace;
  6509. }
  6510. export interface DeleteAccountCustomizationResponse {
  6511. /**
  6512. * The Amazon Web Services request ID for this operation.
  6513. */
  6514. RequestId?: String;
  6515. /**
  6516. * The HTTP status of the request.
  6517. */
  6518. Status?: StatusCode;
  6519. }
  6520. export interface DeleteAccountSubscriptionRequest {
  6521. /**
  6522. * The Amazon Web Services account ID of the account that you want to delete.
  6523. */
  6524. AwsAccountId: AwsAccountId;
  6525. }
  6526. export interface DeleteAccountSubscriptionResponse {
  6527. /**
  6528. * The Amazon Web Services request ID for this operation.
  6529. */
  6530. RequestId?: String;
  6531. /**
  6532. * The HTTP status of the request.
  6533. */
  6534. Status?: StatusCode;
  6535. }
  6536. export interface DeleteAnalysisRequest {
  6537. /**
  6538. * The ID of the Amazon Web Services account where you want to delete an analysis.
  6539. */
  6540. AwsAccountId: AwsAccountId;
  6541. /**
  6542. * The ID of the analysis that you're deleting.
  6543. */
  6544. AnalysisId: ShortRestrictiveResourceId;
  6545. /**
  6546. * A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. You can't use this parameter with the ForceDeleteWithoutRecovery option in the same API call. The default value is 30.
  6547. */
  6548. RecoveryWindowInDays?: RecoveryWindowInDays;
  6549. /**
  6550. * This option defaults to the value NoForceDeleteWithoutRecovery. To immediately delete the analysis, add the ForceDeleteWithoutRecovery option. You can't restore an analysis after it's deleted.
  6551. */
  6552. ForceDeleteWithoutRecovery?: Boolean;
  6553. }
  6554. export interface DeleteAnalysisResponse {
  6555. /**
  6556. * The HTTP status of the request.
  6557. */
  6558. Status?: StatusCode;
  6559. /**
  6560. * The Amazon Resource Name (ARN) of the deleted analysis.
  6561. */
  6562. Arn?: Arn;
  6563. /**
  6564. * The ID of the deleted analysis.
  6565. */
  6566. AnalysisId?: ShortRestrictiveResourceId;
  6567. /**
  6568. * The date and time that the analysis is scheduled to be deleted.
  6569. */
  6570. DeletionTime?: Timestamp;
  6571. /**
  6572. * The Amazon Web Services request ID for this operation.
  6573. */
  6574. RequestId?: String;
  6575. }
  6576. export interface DeleteDashboardRequest {
  6577. /**
  6578. * The ID of the Amazon Web Services account that contains the dashboard that you're deleting.
  6579. */
  6580. AwsAccountId: AwsAccountId;
  6581. /**
  6582. * The ID for the dashboard.
  6583. */
  6584. DashboardId: ShortRestrictiveResourceId;
  6585. /**
  6586. * The version number of the dashboard. If the version number property is provided, only the specified version of the dashboard is deleted.
  6587. */
  6588. VersionNumber?: VersionNumber;
  6589. }
  6590. export interface DeleteDashboardResponse {
  6591. /**
  6592. * The HTTP status of the request.
  6593. */
  6594. Status?: StatusCode;
  6595. /**
  6596. * The Secure Socket Layer (SSL) properties that apply for the resource.
  6597. */
  6598. Arn?: Arn;
  6599. /**
  6600. * The ID of the dashboard.
  6601. */
  6602. DashboardId?: ShortRestrictiveResourceId;
  6603. /**
  6604. * The Amazon Web Services request ID for this operation.
  6605. */
  6606. RequestId?: String;
  6607. }
  6608. export interface DeleteDataSetRefreshPropertiesRequest {
  6609. /**
  6610. * The Amazon Web Services account ID.
  6611. */
  6612. AwsAccountId: AwsAccountId;
  6613. /**
  6614. * The ID of the dataset.
  6615. */
  6616. DataSetId: ResourceId;
  6617. }
  6618. export interface DeleteDataSetRefreshPropertiesResponse {
  6619. /**
  6620. * The Amazon Web Services request ID for this operation.
  6621. */
  6622. RequestId?: String;
  6623. /**
  6624. * The HTTP status of the request.
  6625. */
  6626. Status?: StatusCode;
  6627. }
  6628. export interface DeleteDataSetRequest {
  6629. /**
  6630. * The Amazon Web Services account ID.
  6631. */
  6632. AwsAccountId: AwsAccountId;
  6633. /**
  6634. * The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  6635. */
  6636. DataSetId: ResourceId;
  6637. }
  6638. export interface DeleteDataSetResponse {
  6639. /**
  6640. * The Amazon Resource Name (ARN) of the dataset.
  6641. */
  6642. Arn?: Arn;
  6643. /**
  6644. * The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  6645. */
  6646. DataSetId?: ResourceId;
  6647. /**
  6648. * The Amazon Web Services request ID for this operation.
  6649. */
  6650. RequestId?: String;
  6651. /**
  6652. * The HTTP status of the request.
  6653. */
  6654. Status?: StatusCode;
  6655. }
  6656. export interface DeleteDataSourceRequest {
  6657. /**
  6658. * The Amazon Web Services account ID.
  6659. */
  6660. AwsAccountId: AwsAccountId;
  6661. /**
  6662. * The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  6663. */
  6664. DataSourceId: ResourceId;
  6665. }
  6666. export interface DeleteDataSourceResponse {
  6667. /**
  6668. * The Amazon Resource Name (ARN) of the data source that you deleted.
  6669. */
  6670. Arn?: Arn;
  6671. /**
  6672. * The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  6673. */
  6674. DataSourceId?: ResourceId;
  6675. /**
  6676. * The Amazon Web Services request ID for this operation.
  6677. */
  6678. RequestId?: String;
  6679. /**
  6680. * The HTTP status of the request.
  6681. */
  6682. Status?: StatusCode;
  6683. }
  6684. export interface DeleteFolderMembershipRequest {
  6685. /**
  6686. * The ID for the Amazon Web Services account that contains the folder.
  6687. */
  6688. AwsAccountId: AwsAccountId;
  6689. /**
  6690. * The Folder ID.
  6691. */
  6692. FolderId: RestrictiveResourceId;
  6693. /**
  6694. * The ID of the asset that you want to delete.
  6695. */
  6696. MemberId: RestrictiveResourceId;
  6697. /**
  6698. * The member type of the asset that you want to delete from a folder.
  6699. */
  6700. MemberType: MemberType;
  6701. }
  6702. export interface DeleteFolderMembershipResponse {
  6703. /**
  6704. * The HTTP status of the request.
  6705. */
  6706. Status?: StatusCode;
  6707. /**
  6708. * The Amazon Web Services request ID for this operation.
  6709. */
  6710. RequestId?: String;
  6711. }
  6712. export interface DeleteFolderRequest {
  6713. /**
  6714. * The ID for the Amazon Web Services account that contains the folder.
  6715. */
  6716. AwsAccountId: AwsAccountId;
  6717. /**
  6718. * The ID of the folder.
  6719. */
  6720. FolderId: RestrictiveResourceId;
  6721. }
  6722. export interface DeleteFolderResponse {
  6723. /**
  6724. * The HTTP status of the request.
  6725. */
  6726. Status?: StatusCode;
  6727. /**
  6728. * The Amazon Resource Name of the deleted folder.
  6729. */
  6730. Arn?: Arn;
  6731. /**
  6732. * The ID of the folder.
  6733. */
  6734. FolderId?: RestrictiveResourceId;
  6735. /**
  6736. * The Amazon Web Services request ID for this operation.
  6737. */
  6738. RequestId?: String;
  6739. }
  6740. export interface DeleteGroupMembershipRequest {
  6741. /**
  6742. * The name of the user that you want to delete from the group membership.
  6743. */
  6744. MemberName: GroupMemberName;
  6745. /**
  6746. * The name of the group that you want to delete the user from.
  6747. */
  6748. GroupName: GroupName;
  6749. /**
  6750. * The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  6751. */
  6752. AwsAccountId: AwsAccountId;
  6753. /**
  6754. * The namespace of the group that you want to remove a user from.
  6755. */
  6756. Namespace: Namespace;
  6757. }
  6758. export interface DeleteGroupMembershipResponse {
  6759. /**
  6760. * The Amazon Web Services request ID for this operation.
  6761. */
  6762. RequestId?: String;
  6763. /**
  6764. * The HTTP status of the request.
  6765. */
  6766. Status?: StatusCode;
  6767. }
  6768. export interface DeleteGroupRequest {
  6769. /**
  6770. * The name of the group that you want to delete.
  6771. */
  6772. GroupName: GroupName;
  6773. /**
  6774. * The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  6775. */
  6776. AwsAccountId: AwsAccountId;
  6777. /**
  6778. * The namespace of the group that you want to delete.
  6779. */
  6780. Namespace: Namespace;
  6781. }
  6782. export interface DeleteGroupResponse {
  6783. /**
  6784. * The Amazon Web Services request ID for this operation.
  6785. */
  6786. RequestId?: String;
  6787. /**
  6788. * The HTTP status of the request.
  6789. */
  6790. Status?: StatusCode;
  6791. }
  6792. export interface DeleteIAMPolicyAssignmentRequest {
  6793. /**
  6794. * The Amazon Web Services account ID where you want to delete the IAM policy assignment.
  6795. */
  6796. AwsAccountId: AwsAccountId;
  6797. /**
  6798. * The name of the assignment.
  6799. */
  6800. AssignmentName: IAMPolicyAssignmentName;
  6801. /**
  6802. * The namespace that contains the assignment.
  6803. */
  6804. Namespace: Namespace;
  6805. }
  6806. export interface DeleteIAMPolicyAssignmentResponse {
  6807. /**
  6808. * The name of the assignment.
  6809. */
  6810. AssignmentName?: IAMPolicyAssignmentName;
  6811. /**
  6812. * The Amazon Web Services request ID for this operation.
  6813. */
  6814. RequestId?: String;
  6815. /**
  6816. * The HTTP status of the request.
  6817. */
  6818. Status?: StatusCode;
  6819. }
  6820. export interface DeleteIdentityPropagationConfigRequest {
  6821. /**
  6822. * The ID of the Amazon Web Services account that you want to delete an identity propagation configuration from.
  6823. */
  6824. AwsAccountId: AwsAccountId;
  6825. /**
  6826. * The name of the Amazon Web Services service that you want to delete the associated access scopes and authorized targets from.
  6827. */
  6828. Service: ServiceType;
  6829. }
  6830. export interface DeleteIdentityPropagationConfigResponse {
  6831. /**
  6832. * The Amazon Web Services request ID for this operation.
  6833. */
  6834. RequestId?: String;
  6835. /**
  6836. * The HTTP status of the request.
  6837. */
  6838. Status?: StatusCode;
  6839. }
  6840. export interface DeleteNamespaceRequest {
  6841. /**
  6842. * The ID for the Amazon Web Services account that you want to delete the Amazon QuickSight namespace from.
  6843. */
  6844. AwsAccountId: AwsAccountId;
  6845. /**
  6846. * The namespace that you want to delete.
  6847. */
  6848. Namespace: Namespace;
  6849. }
  6850. export interface DeleteNamespaceResponse {
  6851. /**
  6852. * The Amazon Web Services request ID for this operation.
  6853. */
  6854. RequestId?: String;
  6855. /**
  6856. * The HTTP status of the request.
  6857. */
  6858. Status?: StatusCode;
  6859. }
  6860. export interface DeleteRefreshScheduleRequest {
  6861. /**
  6862. * The ID of the dataset.
  6863. */
  6864. DataSetId: ResourceId;
  6865. /**
  6866. * The Amazon Web Services account ID.
  6867. */
  6868. AwsAccountId: AwsAccountId;
  6869. /**
  6870. * The ID of the refresh schedule.
  6871. */
  6872. ScheduleId: String;
  6873. }
  6874. export interface DeleteRefreshScheduleResponse {
  6875. /**
  6876. * The HTTP status of the request.
  6877. */
  6878. Status?: StatusCode;
  6879. /**
  6880. * The Amazon Web Services request ID for this operation.
  6881. */
  6882. RequestId?: String;
  6883. /**
  6884. * The ID of the refresh schedule.
  6885. */
  6886. ScheduleId?: String;
  6887. /**
  6888. * The Amazon Resource Name (ARN) for the refresh schedule.
  6889. */
  6890. Arn?: Arn;
  6891. }
  6892. export interface DeleteRoleCustomPermissionRequest {
  6893. /**
  6894. * The role that you want to remove permissions from.
  6895. */
  6896. Role: Role;
  6897. /**
  6898. * The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  6899. */
  6900. AwsAccountId: AwsAccountId;
  6901. /**
  6902. * The namespace that includes the role.
  6903. */
  6904. Namespace: Namespace;
  6905. }
  6906. export interface DeleteRoleCustomPermissionResponse {
  6907. /**
  6908. * The Amazon Web Services request ID for this operation.
  6909. */
  6910. RequestId?: String;
  6911. /**
  6912. * The HTTP status of the request.
  6913. */
  6914. Status?: StatusCode;
  6915. }
  6916. export interface DeleteRoleMembershipRequest {
  6917. /**
  6918. * The name of the group.
  6919. */
  6920. MemberName: GroupName;
  6921. /**
  6922. * The role that you want to remove permissions from.
  6923. */
  6924. Role: Role;
  6925. /**
  6926. * The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
  6927. */
  6928. AwsAccountId: AwsAccountId;
  6929. /**
  6930. * The namespace that contains the role.
  6931. */
  6932. Namespace: Namespace;
  6933. }
  6934. export interface DeleteRoleMembershipResponse {
  6935. /**
  6936. * The Amazon Web Services request ID for this operation.
  6937. */
  6938. RequestId?: String;
  6939. /**
  6940. * The HTTP status of the request.
  6941. */
  6942. Status?: StatusCode;
  6943. }
  6944. export interface DeleteTemplateAliasRequest {
  6945. /**
  6946. * The ID of the Amazon Web Services account that contains the item to delete.
  6947. */
  6948. AwsAccountId: AwsAccountId;
  6949. /**
  6950. * The ID for the template that the specified alias is for.
  6951. */
  6952. TemplateId: ShortRestrictiveResourceId;
  6953. /**
  6954. * The name for the template alias. To delete a specific alias, you delete the version that the alias points to. You can specify the alias name, or specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter.
  6955. */
  6956. AliasName: AliasName;
  6957. }
  6958. export interface DeleteTemplateAliasResponse {
  6959. /**
  6960. * The HTTP status of the request.
  6961. */
  6962. Status?: StatusCode;
  6963. /**
  6964. * An ID for the template associated with the deletion.
  6965. */
  6966. TemplateId?: ShortRestrictiveResourceId;
  6967. /**
  6968. * The name for the template alias.
  6969. */
  6970. AliasName?: AliasName;
  6971. /**
  6972. * The Amazon Resource Name (ARN) of the template you want to delete.
  6973. */
  6974. Arn?: Arn;
  6975. /**
  6976. * The Amazon Web Services request ID for this operation.
  6977. */
  6978. RequestId?: String;
  6979. }
  6980. export interface DeleteTemplateRequest {
  6981. /**
  6982. * The ID of the Amazon Web Services account that contains the template that you're deleting.
  6983. */
  6984. AwsAccountId: AwsAccountId;
  6985. /**
  6986. * An ID for the template you want to delete.
  6987. */
  6988. TemplateId: ShortRestrictiveResourceId;
  6989. /**
  6990. * Specifies the version of the template that you want to delete. If you don't provide a version number, DeleteTemplate deletes all versions of the template.
  6991. */
  6992. VersionNumber?: VersionNumber;
  6993. }
  6994. export interface DeleteTemplateResponse {
  6995. /**
  6996. * The Amazon Web Services request ID for this operation.
  6997. */
  6998. RequestId?: String;
  6999. /**
  7000. * The Amazon Resource Name (ARN) of the resource.
  7001. */
  7002. Arn?: Arn;
  7003. /**
  7004. * An ID for the template.
  7005. */
  7006. TemplateId?: ShortRestrictiveResourceId;
  7007. /**
  7008. * The HTTP status of the request.
  7009. */
  7010. Status?: StatusCode;
  7011. }
  7012. export interface DeleteThemeAliasRequest {
  7013. /**
  7014. * The ID of the Amazon Web Services account that contains the theme alias to delete.
  7015. */
  7016. AwsAccountId: AwsAccountId;
  7017. /**
  7018. * The ID for the theme that the specified alias is for.
  7019. */
  7020. ThemeId: ShortRestrictiveResourceId;
  7021. /**
  7022. * The unique name for the theme alias to delete.
  7023. */
  7024. AliasName: AliasName;
  7025. }
  7026. export interface DeleteThemeAliasResponse {
  7027. /**
  7028. * The name for the theme alias.
  7029. */
  7030. AliasName?: AliasName;
  7031. /**
  7032. * The Amazon Resource Name (ARN) of the theme resource using the deleted alias.
  7033. */
  7034. Arn?: Arn;
  7035. /**
  7036. * The Amazon Web Services request ID for this operation.
  7037. */
  7038. RequestId?: String;
  7039. /**
  7040. * The HTTP status of the request.
  7041. */
  7042. Status?: StatusCode;
  7043. /**
  7044. * An ID for the theme associated with the deletion.
  7045. */
  7046. ThemeId?: ShortRestrictiveResourceId;
  7047. }
  7048. export interface DeleteThemeRequest {
  7049. /**
  7050. * The ID of the Amazon Web Services account that contains the theme that you're deleting.
  7051. */
  7052. AwsAccountId: AwsAccountId;
  7053. /**
  7054. * An ID for the theme that you want to delete.
  7055. */
  7056. ThemeId: ShortRestrictiveResourceId;
  7057. /**
  7058. * The version of the theme that you want to delete. Note: If you don't provide a version number, you're using this call to DeleteTheme to delete all versions of the theme.
  7059. */
  7060. VersionNumber?: VersionNumber;
  7061. }
  7062. export interface DeleteThemeResponse {
  7063. /**
  7064. * The Amazon Resource Name (ARN) of the resource.
  7065. */
  7066. Arn?: Arn;
  7067. /**
  7068. * The Amazon Web Services request ID for this operation.
  7069. */
  7070. RequestId?: String;
  7071. /**
  7072. * The HTTP status of the request.
  7073. */
  7074. Status?: StatusCode;
  7075. /**
  7076. * An ID for the theme.
  7077. */
  7078. ThemeId?: ShortRestrictiveResourceId;
  7079. }
  7080. export interface DeleteTopicRefreshScheduleRequest {
  7081. /**
  7082. * The Amazon Web Services account ID.
  7083. */
  7084. AwsAccountId: AwsAccountId;
  7085. /**
  7086. * The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  7087. */
  7088. TopicId: TopicId;
  7089. /**
  7090. * The ID of the dataset.
  7091. */
  7092. DatasetId: String;
  7093. }
  7094. export interface DeleteTopicRefreshScheduleResponse {
  7095. /**
  7096. * The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  7097. */
  7098. TopicId?: TopicId;
  7099. /**
  7100. * The Amazon Resource Name (ARN) of the topic.
  7101. */
  7102. TopicArn?: Arn;
  7103. /**
  7104. * The Amazon Resource Name (ARN) of the dataset.
  7105. */
  7106. DatasetArn?: Arn;
  7107. /**
  7108. * The HTTP status of the request.
  7109. */
  7110. Status?: StatusCode;
  7111. /**
  7112. * The Amazon Web Services request ID for this operation.
  7113. */
  7114. RequestId?: String;
  7115. }
  7116. export interface DeleteTopicRequest {
  7117. /**
  7118. * The ID of the Amazon Web Services account that contains the topic that you want to delete.
  7119. */
  7120. AwsAccountId: AwsAccountId;
  7121. /**
  7122. * The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  7123. */
  7124. TopicId: TopicId;
  7125. }
  7126. export interface DeleteTopicResponse {
  7127. /**
  7128. * The Amazon Resource Name (ARN) of the topic.
  7129. */
  7130. Arn?: Arn;
  7131. /**
  7132. * The ID of the topic that you want to delete. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  7133. */
  7134. TopicId?: TopicId;
  7135. /**
  7136. * The Amazon Web Services request ID for this operation.
  7137. */
  7138. RequestId?: String;
  7139. /**
  7140. * The HTTP status of the request.
  7141. */
  7142. Status?: StatusCode;
  7143. }
  7144. export interface DeleteUserByPrincipalIdRequest {
  7145. /**
  7146. * The principal ID of the user.
  7147. */
  7148. PrincipalId: String;
  7149. /**
  7150. * The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  7151. */
  7152. AwsAccountId: AwsAccountId;
  7153. /**
  7154. * The namespace. Currently, you should set this to default.
  7155. */
  7156. Namespace: Namespace;
  7157. }
  7158. export interface DeleteUserByPrincipalIdResponse {
  7159. /**
  7160. * The Amazon Web Services request ID for this operation.
  7161. */
  7162. RequestId?: String;
  7163. /**
  7164. * The HTTP status of the request.
  7165. */
  7166. Status?: StatusCode;
  7167. }
  7168. export interface DeleteUserRequest {
  7169. /**
  7170. * The name of the user that you want to delete.
  7171. */
  7172. UserName: UserName;
  7173. /**
  7174. * The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  7175. */
  7176. AwsAccountId: AwsAccountId;
  7177. /**
  7178. * The namespace. Currently, you should set this to default.
  7179. */
  7180. Namespace: Namespace;
  7181. }
  7182. export interface DeleteUserResponse {
  7183. /**
  7184. * The Amazon Web Services request ID for this operation.
  7185. */
  7186. RequestId?: String;
  7187. /**
  7188. * The HTTP status of the request.
  7189. */
  7190. Status?: StatusCode;
  7191. }
  7192. export interface DeleteVPCConnectionRequest {
  7193. /**
  7194. * The Amazon Web Services account ID of the account where you want to delete a VPC connection.
  7195. */
  7196. AwsAccountId: AwsAccountId;
  7197. /**
  7198. * The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
  7199. */
  7200. VPCConnectionId: VPCConnectionResourceIdUnrestricted;
  7201. }
  7202. export interface DeleteVPCConnectionResponse {
  7203. /**
  7204. * The Amazon Resource Name (ARN) of the deleted VPC connection.
  7205. */
  7206. Arn?: Arn;
  7207. /**
  7208. * The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
  7209. */
  7210. VPCConnectionId?: VPCConnectionResourceIdUnrestricted;
  7211. /**
  7212. * The deletion status of the VPC connection.
  7213. */
  7214. DeletionStatus?: VPCConnectionResourceStatus;
  7215. /**
  7216. * The availability status of the VPC connection.
  7217. */
  7218. AvailabilityStatus?: VPCConnectionAvailabilityStatus;
  7219. /**
  7220. * The Amazon Web Services request ID for this operation.
  7221. */
  7222. RequestId?: String;
  7223. /**
  7224. * The HTTP status of the request.
  7225. */
  7226. Status?: StatusCode;
  7227. }
  7228. export type Delimiter = string;
  7229. export interface DescribeAccountCustomizationRequest {
  7230. /**
  7231. * The ID for the Amazon Web Services account that you want to describe Amazon QuickSight customizations for.
  7232. */
  7233. AwsAccountId: AwsAccountId;
  7234. /**
  7235. * The Amazon QuickSight namespace that you want to describe Amazon QuickSight customizations for.
  7236. */
  7237. Namespace?: Namespace;
  7238. /**
  7239. * The Resolved flag works with the other parameters to determine which view of Amazon QuickSight customizations is returned. You can add this flag to your command to use the same view that Amazon QuickSight uses to identify which customizations to apply to the console. Omit this flag, or set it to no-resolved, to reveal customizations that are configured at different levels.
  7240. */
  7241. Resolved?: boolean;
  7242. }
  7243. export interface DescribeAccountCustomizationResponse {
  7244. /**
  7245. * The Amazon Resource Name (ARN) of the customization that's associated with this Amazon Web Services account.
  7246. */
  7247. Arn?: Arn;
  7248. /**
  7249. * The ID for the Amazon Web Services account that you're describing.
  7250. */
  7251. AwsAccountId?: AwsAccountId;
  7252. /**
  7253. * The Amazon QuickSight namespace that you're describing.
  7254. */
  7255. Namespace?: Namespace;
  7256. /**
  7257. * The Amazon QuickSight customizations that exist in the current Amazon Web Services Region.
  7258. */
  7259. AccountCustomization?: AccountCustomization;
  7260. /**
  7261. * The Amazon Web Services request ID for this operation.
  7262. */
  7263. RequestId?: String;
  7264. /**
  7265. * The HTTP status of the request.
  7266. */
  7267. Status?: StatusCode;
  7268. }
  7269. export interface DescribeAccountSettingsRequest {
  7270. /**
  7271. * The ID for the Amazon Web Services account that contains the settings that you want to list.
  7272. */
  7273. AwsAccountId: AwsAccountId;
  7274. }
  7275. export interface DescribeAccountSettingsResponse {
  7276. /**
  7277. * The Amazon QuickSight settings for this Amazon Web Services account. This information includes the edition of Amazon Amazon QuickSight that you subscribed to (Standard or Enterprise) and the notification email for the Amazon QuickSight subscription. In the QuickSight console, the Amazon QuickSight subscription is sometimes referred to as a QuickSight "account" even though it's technically not an account by itself. Instead, it's a subscription to the Amazon QuickSight service for your Amazon Web Services account. The edition that you subscribe to applies to Amazon QuickSight in every Amazon Web Services Region where you use it.
  7278. */
  7279. AccountSettings?: AccountSettings;
  7280. /**
  7281. * The Amazon Web Services request ID for this operation.
  7282. */
  7283. RequestId?: String;
  7284. /**
  7285. * The HTTP status of the request.
  7286. */
  7287. Status?: StatusCode;
  7288. }
  7289. export interface DescribeAccountSubscriptionRequest {
  7290. /**
  7291. * The Amazon Web Services account ID associated with your Amazon QuickSight account.
  7292. */
  7293. AwsAccountId: AwsAccountId;
  7294. }
  7295. export interface DescribeAccountSubscriptionResponse {
  7296. /**
  7297. * A structure that contains the following elements: Your Amazon QuickSight account name. The edition of Amazon QuickSight that your account is using. The notification email address that is associated with the Amazon QuickSight account. The authentication type of the Amazon QuickSight account. The status of the Amazon QuickSight account's subscription.
  7298. */
  7299. AccountInfo?: AccountInfo;
  7300. /**
  7301. * The HTTP status of the request.
  7302. */
  7303. Status?: StatusCode;
  7304. /**
  7305. * The Amazon Web Services request ID for this operation.
  7306. */
  7307. RequestId?: String;
  7308. }
  7309. export interface DescribeAnalysisDefinitionRequest {
  7310. /**
  7311. * The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
  7312. */
  7313. AwsAccountId: AwsAccountId;
  7314. /**
  7315. * The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
  7316. */
  7317. AnalysisId: ShortRestrictiveResourceId;
  7318. }
  7319. export interface DescribeAnalysisDefinitionResponse {
  7320. /**
  7321. * The ID of the analysis described.
  7322. */
  7323. AnalysisId?: ShortRestrictiveResourceId;
  7324. /**
  7325. * The descriptive name of the analysis.
  7326. */
  7327. Name?: AnalysisName;
  7328. /**
  7329. * Errors associated with the analysis.
  7330. */
  7331. Errors?: AnalysisErrorList;
  7332. /**
  7333. * Status associated with the analysis. CREATION_IN_PROGRESS CREATION_SUCCESSFUL CREATION_FAILED UPDATE_IN_PROGRESS UPDATE_SUCCESSFUL UPDATE_FAILED DELETED
  7334. */
  7335. ResourceStatus?: ResourceStatus;
  7336. /**
  7337. * The ARN of the theme of the analysis.
  7338. */
  7339. ThemeArn?: Arn;
  7340. /**
  7341. * The definition of an analysis. A definition is the data model of all features in a Dashboard, Template, or Analysis.
  7342. */
  7343. Definition?: AnalysisDefinition;
  7344. /**
  7345. * The HTTP status of the request.
  7346. */
  7347. Status?: StatusCode;
  7348. /**
  7349. * The Amazon Web Services request ID for this operation.
  7350. */
  7351. RequestId?: String;
  7352. }
  7353. export interface DescribeAnalysisPermissionsRequest {
  7354. /**
  7355. * The ID of the Amazon Web Services account that contains the analysis whose permissions you're describing. You must be using the Amazon Web Services account that the analysis is in.
  7356. */
  7357. AwsAccountId: AwsAccountId;
  7358. /**
  7359. * The ID of the analysis whose permissions you're describing. The ID is part of the analysis URL.
  7360. */
  7361. AnalysisId: ShortRestrictiveResourceId;
  7362. }
  7363. export interface DescribeAnalysisPermissionsResponse {
  7364. /**
  7365. * The ID of the analysis whose permissions you're describing.
  7366. */
  7367. AnalysisId?: ShortRestrictiveResourceId;
  7368. /**
  7369. * The Amazon Resource Name (ARN) of the analysis whose permissions you're describing.
  7370. */
  7371. AnalysisArn?: Arn;
  7372. /**
  7373. * A structure that describes the principals and the resource-level permissions on an analysis.
  7374. */
  7375. Permissions?: ResourcePermissionList;
  7376. /**
  7377. * The HTTP status of the request.
  7378. */
  7379. Status?: StatusCode;
  7380. /**
  7381. * The Amazon Web Services request ID for this operation.
  7382. */
  7383. RequestId?: String;
  7384. }
  7385. export interface DescribeAnalysisRequest {
  7386. /**
  7387. * The ID of the Amazon Web Services account that contains the analysis. You must be using the Amazon Web Services account that the analysis is in.
  7388. */
  7389. AwsAccountId: AwsAccountId;
  7390. /**
  7391. * The ID of the analysis that you're describing. The ID is part of the URL of the analysis.
  7392. */
  7393. AnalysisId: ShortRestrictiveResourceId;
  7394. }
  7395. export interface DescribeAnalysisResponse {
  7396. /**
  7397. * A metadata structure that contains summary information for the analysis that you're describing.
  7398. */
  7399. Analysis?: Analysis;
  7400. /**
  7401. * The HTTP status of the request.
  7402. */
  7403. Status?: StatusCode;
  7404. /**
  7405. * The Amazon Web Services request ID for this operation.
  7406. */
  7407. RequestId?: String;
  7408. }
  7409. export interface DescribeAssetBundleExportJobRequest {
  7410. /**
  7411. * The ID of the Amazon Web Services account the export job is executed in.
  7412. */
  7413. AwsAccountId: AwsAccountId;
  7414. /**
  7415. * The ID of the job that you want described. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.
  7416. */
  7417. AssetBundleExportJobId: ShortRestrictiveResourceId;
  7418. }
  7419. export interface DescribeAssetBundleExportJobResponse {
  7420. /**
  7421. * Indicates the status of a job through its queuing and execution. Poll this DescribeAssetBundleExportApi until JobStatus is either SUCCESSFUL or FAILED.
  7422. */
  7423. JobStatus?: AssetBundleExportJobStatus;
  7424. /**
  7425. * The URL to download the exported asset bundle data from. This URL is available only after the job has succeeded. This URL is valid for 5 minutes after issuance. Call DescribeAssetBundleExportJob again for a fresh URL if needed. The downloaded asset bundle is a zip file named assetbundle-{jobId}.qs. The file has a .qs extension. This URL can't be used in a StartAssetBundleImportJob API call and should only be used for download purposes.
  7426. */
  7427. DownloadUrl?: SensitiveS3Uri;
  7428. /**
  7429. * An array of error records that describes any failures that occurred during the export job processing. Error records accumulate while the job runs. The complete set of error records is available after the job has completed and failed.
  7430. */
  7431. Errors?: AssetBundleExportJobErrorList;
  7432. /**
  7433. * The Amazon Resource Name (ARN) for the export job.
  7434. */
  7435. Arn?: Arn;
  7436. /**
  7437. * The time that the export job was created.
  7438. */
  7439. CreatedTime?: Timestamp;
  7440. /**
  7441. * The ID of the job. The job ID is set when you start a new job with a StartAssetBundleExportJob API call.
  7442. */
  7443. AssetBundleExportJobId?: ShortRestrictiveResourceId;
  7444. /**
  7445. * The ID of the Amazon Web Services account that the export job was executed in.
  7446. */
  7447. AwsAccountId?: AwsAccountId;
  7448. /**
  7449. * A list of resource ARNs that exported with the job.
  7450. */
  7451. ResourceArns?: AssetBundleResourceArns;
  7452. /**
  7453. * The include dependencies flag.
  7454. */
  7455. IncludeAllDependencies?: Boolean;
  7456. /**
  7457. * The format of the exported asset bundle. A QUICKSIGHT_JSON formatted file can be used to make a StartAssetBundleImportJob API call. A CLOUDFORMATION_JSON formatted file can be used in the CloudFormation console and with the CloudFormation APIs.
  7458. */
  7459. ExportFormat?: AssetBundleExportFormat;
  7460. /**
  7461. * The CloudFormation override property configuration for the export job.
  7462. */
  7463. CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration;
  7464. /**
  7465. * The Amazon Web Services request ID for this operation.
  7466. */
  7467. RequestId?: NonEmptyString;
  7468. /**
  7469. * The HTTP status of the response.
  7470. */
  7471. Status?: StatusCode;
  7472. /**
  7473. * The include permissions flag.
  7474. */
  7475. IncludePermissions?: Boolean;
  7476. /**
  7477. * The include tags flag.
  7478. */
  7479. IncludeTags?: Boolean;
  7480. /**
  7481. * The validation strategy that is used to export the analysis or dashboard.
  7482. */
  7483. ValidationStrategy?: AssetBundleExportJobValidationStrategy;
  7484. /**
  7485. * An array of warning records that describe the analysis or dashboard that is exported. This array includes UI errors that can be skipped during the validation process. This property only appears if StrictModeForAllResources in ValidationStrategy is set to FALSE.
  7486. */
  7487. Warnings?: AssetBundleExportJobWarningList;
  7488. }
  7489. export interface DescribeAssetBundleImportJobRequest {
  7490. /**
  7491. * The ID of the Amazon Web Services account the import job was executed in.
  7492. */
  7493. AwsAccountId: AwsAccountId;
  7494. /**
  7495. * The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.
  7496. */
  7497. AssetBundleImportJobId: ShortRestrictiveResourceId;
  7498. }
  7499. export interface DescribeAssetBundleImportJobResponse {
  7500. /**
  7501. * Indicates the status of a job through its queuing and execution. Poll the DescribeAssetBundleImport API until JobStatus returns one of the following values: SUCCESSFUL FAILED FAILED_ROLLBACK_COMPLETED FAILED_ROLLBACK_ERROR
  7502. */
  7503. JobStatus?: AssetBundleImportJobStatus;
  7504. /**
  7505. * An array of error records that describes any failures that occurred during the export job processing. Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.
  7506. */
  7507. Errors?: AssetBundleImportJobErrorList;
  7508. /**
  7509. * An array of error records that describes any failures that occurred while an import job was attempting a rollback. Error records accumulate while the job is still running. The complete set of error records is available after the job has completed and failed.
  7510. */
  7511. RollbackErrors?: AssetBundleImportJobErrorList;
  7512. /**
  7513. * The Amazon Resource Name (ARN) for the import job.
  7514. */
  7515. Arn?: Arn;
  7516. /**
  7517. * The time that the import job was created.
  7518. */
  7519. CreatedTime?: Timestamp;
  7520. /**
  7521. * The ID of the job. The job ID is set when you start a new job with a StartAssetBundleImportJob API call.
  7522. */
  7523. AssetBundleImportJobId?: ShortRestrictiveResourceId;
  7524. /**
  7525. * The ID of the Amazon Web Services account the import job was executed in.
  7526. */
  7527. AwsAccountId?: AwsAccountId;
  7528. /**
  7529. * The source of the asset bundle zip file that contains the data that is imported by the job.
  7530. */
  7531. AssetBundleImportSource?: AssetBundleImportSourceDescription;
  7532. /**
  7533. * Optional overrides that are applied to the resource configuration before import.
  7534. */
  7535. OverrideParameters?: AssetBundleImportJobOverrideParameters;
  7536. /**
  7537. * The failure action for the import job.
  7538. */
  7539. FailureAction?: AssetBundleImportFailureAction;
  7540. /**
  7541. * The Amazon Web Services request ID for this operation.
  7542. */
  7543. RequestId?: NonEmptyString;
  7544. /**
  7545. * The HTTP status of the response.
  7546. */
  7547. Status?: StatusCode;
  7548. /**
  7549. * Optional permission overrides that are applied to the resource configuration before import.
  7550. */
  7551. OverridePermissions?: AssetBundleImportJobOverridePermissions;
  7552. /**
  7553. * Optional tag overrides that are applied to the resource configuration before import.
  7554. */
  7555. OverrideTags?: AssetBundleImportJobOverrideTags;
  7556. /**
  7557. * An optional validation strategy override for all analyses and dashboards to be applied to the resource configuration before import.
  7558. */
  7559. OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy;
  7560. /**
  7561. * An array of warning records that describe all permitted errors that are encountered during the import job.
  7562. */
  7563. Warnings?: AssetBundleImportJobWarningList;
  7564. }
  7565. export interface DescribeDashboardDefinitionRequest {
  7566. /**
  7567. * The ID of the Amazon Web Services account that contains the dashboard that you're describing.
  7568. */
  7569. AwsAccountId: AwsAccountId;
  7570. /**
  7571. * The ID for the dashboard.
  7572. */
  7573. DashboardId: ShortRestrictiveResourceId;
  7574. /**
  7575. * The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
  7576. */
  7577. VersionNumber?: VersionNumber;
  7578. /**
  7579. * The alias name.
  7580. */
  7581. AliasName?: AliasName;
  7582. }
  7583. export interface DescribeDashboardDefinitionResponse {
  7584. /**
  7585. * The ID of the dashboard described.
  7586. */
  7587. DashboardId?: ShortRestrictiveResourceId;
  7588. /**
  7589. * Errors associated with this dashboard version.
  7590. */
  7591. Errors?: DashboardErrorList;
  7592. /**
  7593. * The display name of the dashboard.
  7594. */
  7595. Name?: DashboardName;
  7596. /**
  7597. * Status associated with the dashboard version. CREATION_IN_PROGRESS CREATION_SUCCESSFUL CREATION_FAILED UPDATE_IN_PROGRESS UPDATE_SUCCESSFUL UPDATE_FAILED DELETED
  7598. */
  7599. ResourceStatus?: ResourceStatus;
  7600. /**
  7601. * The ARN of the theme of the dashboard.
  7602. */
  7603. ThemeArn?: Arn;
  7604. /**
  7605. * The definition of a dashboard. A definition is the data model of all features in a Dashboard, Template, or Analysis.
  7606. */
  7607. Definition?: DashboardVersionDefinition;
  7608. /**
  7609. * The HTTP status of the request.
  7610. */
  7611. Status?: StatusCode;
  7612. /**
  7613. * The Amazon Web Services request ID for this operation.
  7614. */
  7615. RequestId?: String;
  7616. /**
  7617. * Options for publishing the dashboard: AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default. AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default. VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
  7618. */
  7619. DashboardPublishOptions?: DashboardPublishOptions;
  7620. }
  7621. export interface DescribeDashboardPermissionsRequest {
  7622. /**
  7623. * The ID of the Amazon Web Services account that contains the dashboard that you're describing permissions for.
  7624. */
  7625. AwsAccountId: AwsAccountId;
  7626. /**
  7627. * The ID for the dashboard, also added to the IAM policy.
  7628. */
  7629. DashboardId: ShortRestrictiveResourceId;
  7630. }
  7631. export interface DescribeDashboardPermissionsResponse {
  7632. /**
  7633. * The ID for the dashboard.
  7634. */
  7635. DashboardId?: ShortRestrictiveResourceId;
  7636. /**
  7637. * The Amazon Resource Name (ARN) of the dashboard.
  7638. */
  7639. DashboardArn?: Arn;
  7640. /**
  7641. * A structure that contains the permissions for the dashboard.
  7642. */
  7643. Permissions?: ResourcePermissionList;
  7644. /**
  7645. * The HTTP status of the request.
  7646. */
  7647. Status?: StatusCode;
  7648. /**
  7649. * The Amazon Web Services request ID for this operation.
  7650. */
  7651. RequestId?: String;
  7652. /**
  7653. * A structure that contains the configuration of a shareable link that grants access to the dashboard. Your users can use the link to view and interact with the dashboard, if the dashboard has been shared with them. For more information about sharing dashboards, see Sharing Dashboards.
  7654. */
  7655. LinkSharingConfiguration?: LinkSharingConfiguration;
  7656. }
  7657. export interface DescribeDashboardRequest {
  7658. /**
  7659. * The ID of the Amazon Web Services account that contains the dashboard that you're describing.
  7660. */
  7661. AwsAccountId: AwsAccountId;
  7662. /**
  7663. * The ID for the dashboard.
  7664. */
  7665. DashboardId: ShortRestrictiveResourceId;
  7666. /**
  7667. * The version number for the dashboard. If a version number isn't passed, the latest published dashboard version is described.
  7668. */
  7669. VersionNumber?: VersionNumber;
  7670. /**
  7671. * The alias name.
  7672. */
  7673. AliasName?: AliasName;
  7674. }
  7675. export interface DescribeDashboardResponse {
  7676. /**
  7677. * Information about the dashboard.
  7678. */
  7679. Dashboard?: Dashboard;
  7680. /**
  7681. * The HTTP status of this request.
  7682. */
  7683. Status?: StatusCode;
  7684. /**
  7685. * The Amazon Web Services request ID for this operation.
  7686. */
  7687. RequestId?: String;
  7688. }
  7689. export interface DescribeDashboardSnapshotJobRequest {
  7690. /**
  7691. * The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
  7692. */
  7693. AwsAccountId: AwsAccountId;
  7694. /**
  7695. * The ID of the dashboard that you have started a snapshot job for.
  7696. */
  7697. DashboardId: ShortRestrictiveResourceId;
  7698. /**
  7699. * The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
  7700. */
  7701. SnapshotJobId: ShortRestrictiveResourceId;
  7702. }
  7703. export interface DescribeDashboardSnapshotJobResponse {
  7704. /**
  7705. * The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
  7706. */
  7707. AwsAccountId?: AwsAccountId;
  7708. /**
  7709. * The ID of the dashboard that you have started a snapshot job for.
  7710. */
  7711. DashboardId?: ShortRestrictiveResourceId;
  7712. /**
  7713. * The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
  7714. */
  7715. SnapshotJobId?: ShortRestrictiveResourceId;
  7716. /**
  7717. * The user configuration for the snapshot job. This information is provided when you make a StartDashboardSnapshotJob API call.
  7718. */
  7719. UserConfiguration?: SnapshotUserConfigurationRedacted;
  7720. /**
  7721. * The snapshot configuration of the job. This information is provided when you make a StartDashboardSnapshotJob API call.
  7722. */
  7723. SnapshotConfiguration?: SnapshotConfiguration;
  7724. /**
  7725. * The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.
  7726. */
  7727. Arn?: Arn;
  7728. /**
  7729. * Indicates the status of a job. The status updates as the job executes. This shows one of the following values. COMPLETED - The job was completed successfully. FAILED - The job failed to execute. QUEUED - The job is queued and hasn't started yet. RUNNING - The job is still running.
  7730. */
  7731. JobStatus?: SnapshotJobStatus;
  7732. /**
  7733. * The time that the snapshot job was created.
  7734. */
  7735. CreatedTime?: Timestamp;
  7736. /**
  7737. * The time that the snapshot job status was last updated.
  7738. */
  7739. LastUpdatedTime?: Timestamp;
  7740. /**
  7741. * The Amazon Web Services request ID for this operation.
  7742. */
  7743. RequestId?: NonEmptyString;
  7744. /**
  7745. * The HTTP status of the request
  7746. */
  7747. Status?: StatusCode;
  7748. }
  7749. export interface DescribeDashboardSnapshotJobResultRequest {
  7750. /**
  7751. * The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
  7752. */
  7753. AwsAccountId: AwsAccountId;
  7754. /**
  7755. * The ID of the dashboard that you have started a snapshot job for.
  7756. */
  7757. DashboardId: ShortRestrictiveResourceId;
  7758. /**
  7759. * The ID of the job to be described. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
  7760. */
  7761. SnapshotJobId: ShortRestrictiveResourceId;
  7762. }
  7763. export interface DescribeDashboardSnapshotJobResultResponse {
  7764. /**
  7765. * The Amazon Resource Name (ARN) for the snapshot job. The job ARN is generated when you start a new job with a StartDashboardSnapshotJob API call.
  7766. */
  7767. Arn?: Arn;
  7768. /**
  7769. * Indicates the status of a job after it has reached a terminal state. A finished snapshot job will retuen a COMPLETED or FAILED status.
  7770. */
  7771. JobStatus?: SnapshotJobStatus;
  7772. /**
  7773. * The time that a snapshot job was created.
  7774. */
  7775. CreatedTime?: Timestamp;
  7776. /**
  7777. * The time that a snapshot job status was last updated.
  7778. */
  7779. LastUpdatedTime?: Timestamp;
  7780. /**
  7781. * The result of the snapshot job. Jobs that have successfully completed will return the S3Uri where they are located. Jobs that have failedwill return information on the error that caused the job to fail.
  7782. */
  7783. Result?: SnapshotJobResult;
  7784. /**
  7785. * Displays information for the error that caused a job to fail.
  7786. */
  7787. ErrorInfo?: SnapshotJobErrorInfo;
  7788. /**
  7789. * The Amazon Web Services request ID for this operation.
  7790. */
  7791. RequestId?: NonEmptyString;
  7792. /**
  7793. * The HTTP status of the request
  7794. */
  7795. Status?: StatusCode;
  7796. }
  7797. export interface DescribeDataSetPermissionsRequest {
  7798. /**
  7799. * The Amazon Web Services account ID.
  7800. */
  7801. AwsAccountId: AwsAccountId;
  7802. /**
  7803. * The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  7804. */
  7805. DataSetId: ResourceId;
  7806. }
  7807. export interface DescribeDataSetPermissionsResponse {
  7808. /**
  7809. * The Amazon Resource Name (ARN) of the dataset.
  7810. */
  7811. DataSetArn?: Arn;
  7812. /**
  7813. * The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  7814. */
  7815. DataSetId?: ResourceId;
  7816. /**
  7817. * A list of resource permissions on the dataset.
  7818. */
  7819. Permissions?: ResourcePermissionList;
  7820. /**
  7821. * The Amazon Web Services request ID for this operation.
  7822. */
  7823. RequestId?: String;
  7824. /**
  7825. * The HTTP status of the request.
  7826. */
  7827. Status?: StatusCode;
  7828. }
  7829. export interface DescribeDataSetRefreshPropertiesRequest {
  7830. /**
  7831. * The Amazon Web Services account ID.
  7832. */
  7833. AwsAccountId: AwsAccountId;
  7834. /**
  7835. * The ID of the dataset.
  7836. */
  7837. DataSetId: ResourceId;
  7838. }
  7839. export interface DescribeDataSetRefreshPropertiesResponse {
  7840. /**
  7841. * The Amazon Web Services request ID for this operation.
  7842. */
  7843. RequestId?: String;
  7844. /**
  7845. * The HTTP status of the request.
  7846. */
  7847. Status?: StatusCode;
  7848. /**
  7849. * The dataset refresh properties.
  7850. */
  7851. DataSetRefreshProperties?: DataSetRefreshProperties;
  7852. }
  7853. export interface DescribeDataSetRequest {
  7854. /**
  7855. * The Amazon Web Services account ID.
  7856. */
  7857. AwsAccountId: AwsAccountId;
  7858. /**
  7859. * The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  7860. */
  7861. DataSetId: ResourceId;
  7862. }
  7863. export interface DescribeDataSetResponse {
  7864. /**
  7865. * Information on the dataset.
  7866. */
  7867. DataSet?: DataSet;
  7868. /**
  7869. * The Amazon Web Services request ID for this operation.
  7870. */
  7871. RequestId?: String;
  7872. /**
  7873. * The HTTP status of the request.
  7874. */
  7875. Status?: StatusCode;
  7876. }
  7877. export interface DescribeDataSourcePermissionsRequest {
  7878. /**
  7879. * The Amazon Web Services account ID.
  7880. */
  7881. AwsAccountId: AwsAccountId;
  7882. /**
  7883. * The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  7884. */
  7885. DataSourceId: ResourceId;
  7886. }
  7887. export interface DescribeDataSourcePermissionsResponse {
  7888. /**
  7889. * The Amazon Resource Name (ARN) of the data source.
  7890. */
  7891. DataSourceArn?: Arn;
  7892. /**
  7893. * The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  7894. */
  7895. DataSourceId?: ResourceId;
  7896. /**
  7897. * A list of resource permissions on the data source.
  7898. */
  7899. Permissions?: ResourcePermissionList;
  7900. /**
  7901. * The Amazon Web Services request ID for this operation.
  7902. */
  7903. RequestId?: String;
  7904. /**
  7905. * The HTTP status of the request.
  7906. */
  7907. Status?: StatusCode;
  7908. }
  7909. export interface DescribeDataSourceRequest {
  7910. /**
  7911. * The Amazon Web Services account ID.
  7912. */
  7913. AwsAccountId: AwsAccountId;
  7914. /**
  7915. * The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  7916. */
  7917. DataSourceId: ResourceId;
  7918. }
  7919. export interface DescribeDataSourceResponse {
  7920. /**
  7921. * The information on the data source.
  7922. */
  7923. DataSource?: DataSource;
  7924. /**
  7925. * The Amazon Web Services request ID for this operation.
  7926. */
  7927. RequestId?: String;
  7928. /**
  7929. * The HTTP status of the request.
  7930. */
  7931. Status?: StatusCode;
  7932. }
  7933. export interface DescribeFolderPermissionsRequest {
  7934. /**
  7935. * The ID for the Amazon Web Services account that contains the folder.
  7936. */
  7937. AwsAccountId: AwsAccountId;
  7938. /**
  7939. * The ID of the folder.
  7940. */
  7941. FolderId: RestrictiveResourceId;
  7942. /**
  7943. * The namespace of the folder whose permissions you want described.
  7944. */
  7945. Namespace?: Namespace;
  7946. /**
  7947. * The maximum number of results to be returned per request.
  7948. */
  7949. MaxResults?: MaxResults;
  7950. /**
  7951. * A pagination token for the next set of results.
  7952. */
  7953. NextToken?: String;
  7954. }
  7955. export interface DescribeFolderPermissionsResponse {
  7956. /**
  7957. * The HTTP status of the request.
  7958. */
  7959. Status?: StatusCode;
  7960. /**
  7961. * The ID of the folder.
  7962. */
  7963. FolderId?: RestrictiveResourceId;
  7964. /**
  7965. * The Amazon Resource Name (ARN) for the folder.
  7966. */
  7967. Arn?: Arn;
  7968. /**
  7969. * Information about the permissions on the folder.
  7970. */
  7971. Permissions?: ResourcePermissionList;
  7972. /**
  7973. * The Amazon Web Services request ID for this operation.
  7974. */
  7975. RequestId?: String;
  7976. /**
  7977. * The pagination token for the next set of results, or null if there are no more results.
  7978. */
  7979. NextToken?: String;
  7980. }
  7981. export interface DescribeFolderRequest {
  7982. /**
  7983. * The ID for the Amazon Web Services account that contains the folder.
  7984. */
  7985. AwsAccountId: AwsAccountId;
  7986. /**
  7987. * The ID of the folder.
  7988. */
  7989. FolderId: RestrictiveResourceId;
  7990. }
  7991. export interface DescribeFolderResolvedPermissionsRequest {
  7992. /**
  7993. * The ID for the Amazon Web Services account that contains the folder.
  7994. */
  7995. AwsAccountId: AwsAccountId;
  7996. /**
  7997. * The ID of the folder.
  7998. */
  7999. FolderId: RestrictiveResourceId;
  8000. /**
  8001. * The namespace of the folder whose permissions you want described.
  8002. */
  8003. Namespace?: Namespace;
  8004. /**
  8005. * The maximum number of results to be returned per request.
  8006. */
  8007. MaxResults?: MaxResults;
  8008. /**
  8009. * A pagination token for the next set of results.
  8010. */
  8011. NextToken?: String;
  8012. }
  8013. export interface DescribeFolderResolvedPermissionsResponse {
  8014. /**
  8015. * The HTTP status of the request.
  8016. */
  8017. Status?: StatusCode;
  8018. /**
  8019. * The ID of the folder.
  8020. */
  8021. FolderId?: RestrictiveResourceId;
  8022. /**
  8023. * The Amazon Resource Name (ARN) of the folder.
  8024. */
  8025. Arn?: Arn;
  8026. /**
  8027. * Information about the permissions for the folder.
  8028. */
  8029. Permissions?: ResourcePermissionList;
  8030. /**
  8031. * The Amazon Web Services request ID for this operation.
  8032. */
  8033. RequestId?: String;
  8034. /**
  8035. * A pagination token for the next set of results, or null if there are no more results.
  8036. */
  8037. NextToken?: String;
  8038. }
  8039. export interface DescribeFolderResponse {
  8040. /**
  8041. * The HTTP status of the request.
  8042. */
  8043. Status?: StatusCode;
  8044. /**
  8045. * Information about the folder.
  8046. */
  8047. Folder?: Folder;
  8048. /**
  8049. * The Amazon Web Services request ID for this operation.
  8050. */
  8051. RequestId?: String;
  8052. }
  8053. export interface DescribeGroupMembershipRequest {
  8054. /**
  8055. * The user name of the user that you want to search for.
  8056. */
  8057. MemberName: GroupMemberName;
  8058. /**
  8059. * The name of the group that you want to search.
  8060. */
  8061. GroupName: GroupName;
  8062. /**
  8063. * The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  8064. */
  8065. AwsAccountId: AwsAccountId;
  8066. /**
  8067. * The namespace that includes the group you are searching within.
  8068. */
  8069. Namespace: Namespace;
  8070. }
  8071. export interface DescribeGroupMembershipResponse {
  8072. GroupMember?: GroupMember;
  8073. /**
  8074. * The Amazon Web Services request ID for this operation.
  8075. */
  8076. RequestId?: String;
  8077. /**
  8078. * The HTTP status of the request.
  8079. */
  8080. Status?: StatusCode;
  8081. }
  8082. export interface DescribeGroupRequest {
  8083. /**
  8084. * The name of the group that you want to describe.
  8085. */
  8086. GroupName: GroupName;
  8087. /**
  8088. * The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  8089. */
  8090. AwsAccountId: AwsAccountId;
  8091. /**
  8092. * The namespace of the group that you want described.
  8093. */
  8094. Namespace: Namespace;
  8095. }
  8096. export interface DescribeGroupResponse {
  8097. /**
  8098. * The name of the group.
  8099. */
  8100. Group?: Group;
  8101. /**
  8102. * The Amazon Web Services request ID for this operation.
  8103. */
  8104. RequestId?: String;
  8105. /**
  8106. * The HTTP status of the request.
  8107. */
  8108. Status?: StatusCode;
  8109. }
  8110. export interface DescribeIAMPolicyAssignmentRequest {
  8111. /**
  8112. * The ID of the Amazon Web Services account that contains the assignment that you want to describe.
  8113. */
  8114. AwsAccountId: AwsAccountId;
  8115. /**
  8116. * The name of the assignment, also called a rule.
  8117. */
  8118. AssignmentName: IAMPolicyAssignmentName;
  8119. /**
  8120. * The namespace that contains the assignment.
  8121. */
  8122. Namespace: Namespace;
  8123. }
  8124. export interface DescribeIAMPolicyAssignmentResponse {
  8125. /**
  8126. * Information describing the IAM policy assignment.
  8127. */
  8128. IAMPolicyAssignment?: IAMPolicyAssignment;
  8129. /**
  8130. * The Amazon Web Services request ID for this operation.
  8131. */
  8132. RequestId?: String;
  8133. /**
  8134. * The HTTP status of the request.
  8135. */
  8136. Status?: StatusCode;
  8137. }
  8138. export interface DescribeIngestionRequest {
  8139. /**
  8140. * The Amazon Web Services account ID.
  8141. */
  8142. AwsAccountId: AwsAccountId;
  8143. /**
  8144. * The ID of the dataset used in the ingestion.
  8145. */
  8146. DataSetId: String;
  8147. /**
  8148. * An ID for the ingestion.
  8149. */
  8150. IngestionId: IngestionId;
  8151. }
  8152. export interface DescribeIngestionResponse {
  8153. /**
  8154. * Information about the ingestion.
  8155. */
  8156. Ingestion?: Ingestion;
  8157. /**
  8158. * The Amazon Web Services request ID for this operation.
  8159. */
  8160. RequestId?: String;
  8161. /**
  8162. * The HTTP status of the request.
  8163. */
  8164. Status?: StatusCode;
  8165. }
  8166. export interface DescribeIpRestrictionRequest {
  8167. /**
  8168. * The ID of the Amazon Web Services account that contains the IP rules.
  8169. */
  8170. AwsAccountId: AwsAccountId;
  8171. }
  8172. export interface DescribeIpRestrictionResponse {
  8173. /**
  8174. * The ID of the Amazon Web Services account that contains the IP rules.
  8175. */
  8176. AwsAccountId?: AwsAccountId;
  8177. /**
  8178. * A map that describes the IP rules with CIDR range and description.
  8179. */
  8180. IpRestrictionRuleMap?: IpRestrictionRuleMap;
  8181. /**
  8182. * A map of allowed VPC IDs and their rule descriptions.
  8183. */
  8184. VpcIdRestrictionRuleMap?: VpcIdRestrictionRuleMap;
  8185. /**
  8186. * A map of allowed VPC endpoint IDs and their rule descriptions.
  8187. */
  8188. VpcEndpointIdRestrictionRuleMap?: VpcEndpointIdRestrictionRuleMap;
  8189. /**
  8190. * A value that specifies whether IP rules are turned on.
  8191. */
  8192. Enabled?: NullableBoolean;
  8193. /**
  8194. * The Amazon Web Services request ID for this operation.
  8195. */
  8196. RequestId?: String;
  8197. /**
  8198. * The HTTP status of the request.
  8199. */
  8200. Status?: StatusCode;
  8201. }
  8202. export interface DescribeNamespaceRequest {
  8203. /**
  8204. * The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.
  8205. */
  8206. AwsAccountId: AwsAccountId;
  8207. /**
  8208. * The namespace that you want to describe.
  8209. */
  8210. Namespace: Namespace;
  8211. }
  8212. export interface DescribeNamespaceResponse {
  8213. /**
  8214. * The information about the namespace that you're describing. The response includes the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.
  8215. */
  8216. Namespace?: NamespaceInfoV2;
  8217. /**
  8218. * The Amazon Web Services request ID for this operation.
  8219. */
  8220. RequestId?: String;
  8221. /**
  8222. * The HTTP status of the request.
  8223. */
  8224. Status?: StatusCode;
  8225. }
  8226. export interface DescribeRefreshScheduleRequest {
  8227. /**
  8228. * The Amazon Web Services account ID.
  8229. */
  8230. AwsAccountId: AwsAccountId;
  8231. /**
  8232. * The ID of the dataset.
  8233. */
  8234. DataSetId: ResourceId;
  8235. /**
  8236. * The ID of the refresh schedule.
  8237. */
  8238. ScheduleId: String;
  8239. }
  8240. export interface DescribeRefreshScheduleResponse {
  8241. /**
  8242. * The refresh schedule.
  8243. */
  8244. RefreshSchedule?: RefreshSchedule;
  8245. /**
  8246. * The HTTP status of the request.
  8247. */
  8248. Status?: StatusCode;
  8249. /**
  8250. * The Amazon Web Services request ID for this operation.
  8251. */
  8252. RequestId?: String;
  8253. /**
  8254. * The Amazon Resource Name (ARN) for the refresh schedule.
  8255. */
  8256. Arn?: Arn;
  8257. }
  8258. export interface DescribeRoleCustomPermissionRequest {
  8259. /**
  8260. * The name of the role whose permissions you want described.
  8261. */
  8262. Role: Role;
  8263. /**
  8264. * The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
  8265. */
  8266. AwsAccountId: AwsAccountId;
  8267. /**
  8268. * The namespace that contains the role.
  8269. */
  8270. Namespace: Namespace;
  8271. }
  8272. export interface DescribeRoleCustomPermissionResponse {
  8273. /**
  8274. * The name of the custom permission that is described.
  8275. */
  8276. CustomPermissionsName?: RoleName;
  8277. /**
  8278. * The Amazon Web Services request ID for this operation.
  8279. */
  8280. RequestId?: String;
  8281. /**
  8282. * The HTTP status of the request.
  8283. */
  8284. Status?: StatusCode;
  8285. }
  8286. export interface DescribeTemplateAliasRequest {
  8287. /**
  8288. * The ID of the Amazon Web Services account that contains the template alias that you're describing.
  8289. */
  8290. AwsAccountId: AwsAccountId;
  8291. /**
  8292. * The ID for the template.
  8293. */
  8294. TemplateId: ShortRestrictiveResourceId;
  8295. /**
  8296. * The name of the template alias that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
  8297. */
  8298. AliasName: AliasName;
  8299. }
  8300. export interface DescribeTemplateAliasResponse {
  8301. /**
  8302. * Information about the template alias.
  8303. */
  8304. TemplateAlias?: TemplateAlias;
  8305. /**
  8306. * The HTTP status of the request.
  8307. */
  8308. Status?: StatusCode;
  8309. /**
  8310. * The Amazon Web Services request ID for this operation.
  8311. */
  8312. RequestId?: String;
  8313. }
  8314. export interface DescribeTemplateDefinitionRequest {
  8315. /**
  8316. * The ID of the Amazon Web Services account that contains the template. You must be using the Amazon Web Services account that the template is in.
  8317. */
  8318. AwsAccountId: AwsAccountId;
  8319. /**
  8320. * The ID of the template that you're describing.
  8321. */
  8322. TemplateId: ShortRestrictiveResourceId;
  8323. /**
  8324. * The version number of the template.
  8325. */
  8326. VersionNumber?: VersionNumber;
  8327. /**
  8328. * The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
  8329. */
  8330. AliasName?: AliasName;
  8331. }
  8332. export interface DescribeTemplateDefinitionResponse {
  8333. /**
  8334. * The descriptive name of the template.
  8335. */
  8336. Name?: TemplateName;
  8337. /**
  8338. * The ID of the template described.
  8339. */
  8340. TemplateId?: ShortRestrictiveResourceId;
  8341. /**
  8342. * Errors associated with the template version.
  8343. */
  8344. Errors?: TemplateErrorList;
  8345. /**
  8346. * Status associated with the template. CREATION_IN_PROGRESS CREATION_SUCCESSFUL CREATION_FAILED UPDATE_IN_PROGRESS UPDATE_SUCCESSFUL UPDATE_FAILED DELETED
  8347. */
  8348. ResourceStatus?: ResourceStatus;
  8349. /**
  8350. * The ARN of the theme of the template.
  8351. */
  8352. ThemeArn?: Arn;
  8353. /**
  8354. * The definition of the template. A definition is the data model of all features in a Dashboard, Template, or Analysis.
  8355. */
  8356. Definition?: TemplateVersionDefinition;
  8357. /**
  8358. * The HTTP status of the request.
  8359. */
  8360. Status?: StatusCode;
  8361. /**
  8362. * The Amazon Web Services request ID for this operation.
  8363. */
  8364. RequestId?: String;
  8365. }
  8366. export interface DescribeTemplatePermissionsRequest {
  8367. /**
  8368. * The ID of the Amazon Web Services account that contains the template that you're describing.
  8369. */
  8370. AwsAccountId: AwsAccountId;
  8371. /**
  8372. * The ID for the template.
  8373. */
  8374. TemplateId: ShortRestrictiveResourceId;
  8375. }
  8376. export interface DescribeTemplatePermissionsResponse {
  8377. /**
  8378. * The ID for the template.
  8379. */
  8380. TemplateId?: ShortRestrictiveResourceId;
  8381. /**
  8382. * The Amazon Resource Name (ARN) of the template.
  8383. */
  8384. TemplateArn?: Arn;
  8385. /**
  8386. * A list of resource permissions to be set on the template.
  8387. */
  8388. Permissions?: ResourcePermissionList;
  8389. /**
  8390. * The Amazon Web Services request ID for this operation.
  8391. */
  8392. RequestId?: String;
  8393. /**
  8394. * The HTTP status of the request.
  8395. */
  8396. Status?: StatusCode;
  8397. }
  8398. export interface DescribeTemplateRequest {
  8399. /**
  8400. * The ID of the Amazon Web Services account that contains the template that you're describing.
  8401. */
  8402. AwsAccountId: AwsAccountId;
  8403. /**
  8404. * The ID for the template.
  8405. */
  8406. TemplateId: ShortRestrictiveResourceId;
  8407. /**
  8408. * (Optional) The number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the template is described.
  8409. */
  8410. VersionNumber?: VersionNumber;
  8411. /**
  8412. * The alias of the template that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
  8413. */
  8414. AliasName?: AliasName;
  8415. }
  8416. export interface DescribeTemplateResponse {
  8417. /**
  8418. * The template structure for the object you want to describe.
  8419. */
  8420. Template?: Template;
  8421. /**
  8422. * The HTTP status of the request.
  8423. */
  8424. Status?: StatusCode;
  8425. /**
  8426. * The Amazon Web Services request ID for this operation.
  8427. */
  8428. RequestId?: String;
  8429. }
  8430. export interface DescribeThemeAliasRequest {
  8431. /**
  8432. * The ID of the Amazon Web Services account that contains the theme alias that you're describing.
  8433. */
  8434. AwsAccountId: AwsAccountId;
  8435. /**
  8436. * The ID for the theme.
  8437. */
  8438. ThemeId: ShortRestrictiveResourceId;
  8439. /**
  8440. * The name of the theme alias that you want to describe.
  8441. */
  8442. AliasName: AliasName;
  8443. }
  8444. export interface DescribeThemeAliasResponse {
  8445. /**
  8446. * Information about the theme alias.
  8447. */
  8448. ThemeAlias?: ThemeAlias;
  8449. /**
  8450. * The HTTP status of the request.
  8451. */
  8452. Status?: StatusCode;
  8453. /**
  8454. * The Amazon Web Services request ID for this operation.
  8455. */
  8456. RequestId?: String;
  8457. }
  8458. export interface DescribeThemePermissionsRequest {
  8459. /**
  8460. * The ID of the Amazon Web Services account that contains the theme that you're describing.
  8461. */
  8462. AwsAccountId: AwsAccountId;
  8463. /**
  8464. * The ID for the theme that you want to describe permissions for.
  8465. */
  8466. ThemeId: ShortRestrictiveResourceId;
  8467. }
  8468. export interface DescribeThemePermissionsResponse {
  8469. /**
  8470. * The ID for the theme.
  8471. */
  8472. ThemeId?: ShortRestrictiveResourceId;
  8473. /**
  8474. * The Amazon Resource Name (ARN) of the theme.
  8475. */
  8476. ThemeArn?: Arn;
  8477. /**
  8478. * A list of resource permissions set on the theme.
  8479. */
  8480. Permissions?: ResourcePermissionList;
  8481. /**
  8482. * The Amazon Web Services request ID for this operation.
  8483. */
  8484. RequestId?: String;
  8485. /**
  8486. * The HTTP status of the request.
  8487. */
  8488. Status?: StatusCode;
  8489. }
  8490. export interface DescribeThemeRequest {
  8491. /**
  8492. * The ID of the Amazon Web Services account that contains the theme that you're describing.
  8493. */
  8494. AwsAccountId: AwsAndAccountId;
  8495. /**
  8496. * The ID for the theme.
  8497. */
  8498. ThemeId: ShortRestrictiveResourceId;
  8499. /**
  8500. * The version number for the version to describe. If a VersionNumber parameter value isn't provided, the latest version of the theme is described.
  8501. */
  8502. VersionNumber?: VersionNumber;
  8503. /**
  8504. * The alias of the theme that you want to describe. If you name a specific alias, you describe the version that the alias points to. You can specify the latest version of the theme by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to themes.
  8505. */
  8506. AliasName?: AliasName;
  8507. }
  8508. export interface DescribeThemeResponse {
  8509. /**
  8510. * The information about the theme that you are describing.
  8511. */
  8512. Theme?: Theme;
  8513. /**
  8514. * The HTTP status of the request.
  8515. */
  8516. Status?: StatusCode;
  8517. /**
  8518. * The Amazon Web Services request ID for this operation.
  8519. */
  8520. RequestId?: String;
  8521. }
  8522. export interface DescribeTopicPermissionsRequest {
  8523. /**
  8524. * The ID of the Amazon Web Services account that contains the topic that you want described.
  8525. */
  8526. AwsAccountId: AwsAccountId;
  8527. /**
  8528. * The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  8529. */
  8530. TopicId: TopicId;
  8531. }
  8532. export interface DescribeTopicPermissionsResponse {
  8533. /**
  8534. * The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  8535. */
  8536. TopicId?: TopicId;
  8537. /**
  8538. * The Amazon Resource Name (ARN) of the topic.
  8539. */
  8540. TopicArn?: Arn;
  8541. /**
  8542. * A list of resource permissions that are configured to the topic.
  8543. */
  8544. Permissions?: ResourcePermissionList;
  8545. /**
  8546. * The HTTP status of the request.
  8547. */
  8548. Status?: StatusCode;
  8549. /**
  8550. * The Amazon Web Services request ID for this operation.
  8551. */
  8552. RequestId?: String;
  8553. }
  8554. export interface DescribeTopicRefreshRequest {
  8555. /**
  8556. * The ID of the Amazon Web Services account that contains the topic whose refresh you want to describe.
  8557. */
  8558. AwsAccountId: AwsAccountId;
  8559. /**
  8560. * The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  8561. */
  8562. TopicId: TopicId;
  8563. /**
  8564. * The ID of the refresh, which is performed when the topic is created or updated.
  8565. */
  8566. RefreshId: ResourceId;
  8567. }
  8568. export interface DescribeTopicRefreshResponse {
  8569. /**
  8570. * Details of the refresh, which is performed when the topic is created or updated.
  8571. */
  8572. RefreshDetails?: TopicRefreshDetails;
  8573. /**
  8574. * The Amazon Web Services request ID for this operation.
  8575. */
  8576. RequestId?: String;
  8577. /**
  8578. * The HTTP status of the request.
  8579. */
  8580. Status?: StatusCode;
  8581. }
  8582. export interface DescribeTopicRefreshScheduleRequest {
  8583. /**
  8584. * The Amazon Web Services account ID.
  8585. */
  8586. AwsAccountId: AwsAccountId;
  8587. /**
  8588. * The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  8589. */
  8590. TopicId: TopicId;
  8591. /**
  8592. * The ID of the dataset.
  8593. */
  8594. DatasetId: String;
  8595. }
  8596. export interface DescribeTopicRefreshScheduleResponse {
  8597. /**
  8598. * The ID of the topic that contains the refresh schedule that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  8599. */
  8600. TopicId?: TopicId;
  8601. /**
  8602. * The Amazon Resource Name (ARN) of the topic.
  8603. */
  8604. TopicArn?: Arn;
  8605. /**
  8606. * The Amazon Resource Name (ARN) of the dataset.
  8607. */
  8608. DatasetArn?: Arn;
  8609. /**
  8610. * The definition of a refresh schedule.
  8611. */
  8612. RefreshSchedule?: TopicRefreshSchedule;
  8613. /**
  8614. * The HTTP status of the request.
  8615. */
  8616. Status?: StatusCode;
  8617. /**
  8618. * The Amazon Web Services request ID for this operation.
  8619. */
  8620. RequestId?: String;
  8621. }
  8622. export interface DescribeTopicRequest {
  8623. /**
  8624. * The Amazon Web Services account ID.
  8625. */
  8626. AwsAccountId: AwsAccountId;
  8627. /**
  8628. * The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  8629. */
  8630. TopicId: TopicId;
  8631. }
  8632. export interface DescribeTopicResponse {
  8633. /**
  8634. * The Amazon Resource Name (ARN) of the topic.
  8635. */
  8636. Arn?: Arn;
  8637. /**
  8638. * The ID of the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  8639. */
  8640. TopicId?: TopicId;
  8641. /**
  8642. * The definition of a topic.
  8643. */
  8644. Topic?: TopicDetails;
  8645. /**
  8646. * The Amazon Web Services request ID for this operation.
  8647. */
  8648. RequestId?: String;
  8649. /**
  8650. * The HTTP status of the request.
  8651. */
  8652. Status?: StatusCode;
  8653. }
  8654. export interface DescribeUserRequest {
  8655. /**
  8656. * The name of the user that you want to describe.
  8657. */
  8658. UserName: UserName;
  8659. /**
  8660. * The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  8661. */
  8662. AwsAccountId: AwsAccountId;
  8663. /**
  8664. * The namespace. Currently, you should set this to default.
  8665. */
  8666. Namespace: Namespace;
  8667. }
  8668. export interface DescribeUserResponse {
  8669. /**
  8670. * The user name.
  8671. */
  8672. User?: User;
  8673. /**
  8674. * The Amazon Web Services request ID for this operation.
  8675. */
  8676. RequestId?: String;
  8677. /**
  8678. * The HTTP status of the request.
  8679. */
  8680. Status?: StatusCode;
  8681. }
  8682. export interface DescribeVPCConnectionRequest {
  8683. /**
  8684. * The Amazon Web Services account ID of the account that contains the VPC connection that you want described.
  8685. */
  8686. AwsAccountId: AwsAccountId;
  8687. /**
  8688. * The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
  8689. */
  8690. VPCConnectionId: VPCConnectionResourceIdUnrestricted;
  8691. }
  8692. export interface DescribeVPCConnectionResponse {
  8693. /**
  8694. * A response object that provides information for the specified VPC connection.
  8695. */
  8696. VPCConnection?: VPCConnection;
  8697. /**
  8698. * The Amazon Web Services request ID for this operation.
  8699. */
  8700. RequestId?: String;
  8701. /**
  8702. * The HTTP status of the request.
  8703. */
  8704. Status?: StatusCode;
  8705. }
  8706. export interface DestinationParameterValueConfiguration {
  8707. /**
  8708. * The configuration of custom values for destination parameter in DestinationParameterValueConfiguration.
  8709. */
  8710. CustomValuesConfiguration?: CustomValuesConfiguration;
  8711. /**
  8712. * The configuration that selects all options.
  8713. */
  8714. SelectAllValueOptions?: SelectAllValueOptions;
  8715. /**
  8716. * The source parameter name of the destination parameter.
  8717. */
  8718. SourceParameterName?: String;
  8719. /**
  8720. * The source field ID of the destination parameter.
  8721. */
  8722. SourceField?: FieldId;
  8723. SourceColumn?: ColumnIdentifier;
  8724. }
  8725. export interface DimensionField {
  8726. /**
  8727. * The dimension type field with numerical type columns.
  8728. */
  8729. NumericalDimensionField?: NumericalDimensionField;
  8730. /**
  8731. * The dimension type field with categorical type columns.
  8732. */
  8733. CategoricalDimensionField?: CategoricalDimensionField;
  8734. /**
  8735. * The dimension type field with date type columns.
  8736. */
  8737. DateDimensionField?: DateDimensionField;
  8738. }
  8739. export type DimensionFieldList = DimensionField[];
  8740. export type DisplayFormat = "AUTO"|"PERCENT"|"CURRENCY"|"NUMBER"|"DATE"|"STRING"|string;
  8741. export interface DisplayFormatOptions {
  8742. /**
  8743. * A Boolean value that indicates whether to use blank cell format.
  8744. */
  8745. UseBlankCellFormat?: Boolean;
  8746. /**
  8747. * Determines the blank cell format.
  8748. */
  8749. BlankCellFormat?: LimitedString;
  8750. /**
  8751. * Determines the DateTime format.
  8752. */
  8753. DateFormat?: LimitedString;
  8754. /**
  8755. * Determines the decimal separator.
  8756. */
  8757. DecimalSeparator?: TopicNumericSeparatorSymbol;
  8758. /**
  8759. * Determines the grouping separator.
  8760. */
  8761. GroupingSeparator?: LimitedString;
  8762. /**
  8763. * A Boolean value that indicates whether to use grouping.
  8764. */
  8765. UseGrouping?: Boolean;
  8766. /**
  8767. * Determines the number of fraction digits.
  8768. */
  8769. FractionDigits?: Integer;
  8770. /**
  8771. * The prefix value for a display format.
  8772. */
  8773. Prefix?: LimitedString;
  8774. /**
  8775. * The suffix value for a display format.
  8776. */
  8777. Suffix?: LimitedString;
  8778. /**
  8779. * The unit scaler. Valid values for this structure are: NONE, AUTO, THOUSANDS, MILLIONS, BILLIONS, and TRILLIONS.
  8780. */
  8781. UnitScaler?: NumberScale;
  8782. /**
  8783. * The negative format.
  8784. */
  8785. NegativeFormat?: NegativeFormat;
  8786. /**
  8787. * The currency symbol, such as USD.
  8788. */
  8789. CurrencySymbol?: LimitedString;
  8790. }
  8791. export type DnsResolverList = IPv4Address[];
  8792. export type Domain = string;
  8793. export interface DonutCenterOptions {
  8794. /**
  8795. * Determines the visibility of the label in a donut chart. In the Amazon QuickSight console, this option is called 'Show total'.
  8796. */
  8797. LabelVisibility?: Visibility;
  8798. }
  8799. export interface DonutOptions {
  8800. /**
  8801. * The option for define the arc of the chart shape. Valid values are as follows: WHOLE - A pie chart SMALL- A small-sized donut chart MEDIUM- A medium-sized donut chart LARGE- A large-sized donut chart
  8802. */
  8803. ArcOptions?: ArcOptions;
  8804. /**
  8805. * The label options of the label that is displayed in the center of a donut chart. This option isn't available for pie charts.
  8806. */
  8807. DonutCenterOptions?: DonutCenterOptions;
  8808. }
  8809. export type Double = number;
  8810. export interface DrillDownFilter {
  8811. /**
  8812. * The numeric equality type drill down filter. This filter is used for number type columns.
  8813. */
  8814. NumericEqualityFilter?: NumericEqualityDrillDownFilter;
  8815. /**
  8816. * The category type drill down filter. This filter is used for string type columns.
  8817. */
  8818. CategoryFilter?: CategoryDrillDownFilter;
  8819. /**
  8820. * The time range drill down filter. This filter is used for date time columns.
  8821. */
  8822. TimeRangeFilter?: TimeRangeDrillDownFilter;
  8823. }
  8824. export type DrillDownFilterList = DrillDownFilter[];
  8825. export interface DropDownControlDisplayOptions {
  8826. /**
  8827. * The configuration of the Select all options in a dropdown control.
  8828. */
  8829. SelectAllOptions?: ListControlSelectAllOptions;
  8830. /**
  8831. * The options to configure the title visibility, name, and font size.
  8832. */
  8833. TitleOptions?: LabelOptions;
  8834. /**
  8835. * The configuration of info icon label options.
  8836. */
  8837. InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
  8838. }
  8839. export interface DynamicDefaultValue {
  8840. /**
  8841. * The column that contains the username.
  8842. */
  8843. UserNameColumn?: ColumnIdentifier;
  8844. /**
  8845. * The column that contains the group name.
  8846. */
  8847. GroupNameColumn?: ColumnIdentifier;
  8848. /**
  8849. * The column that contains the default value of each user or group.
  8850. */
  8851. DefaultValueColumn: ColumnIdentifier;
  8852. }
  8853. export type Edition = "STANDARD"|"ENTERPRISE"|"ENTERPRISE_AND_Q"|string;
  8854. export type EmbeddingIdentityType = "IAM"|"QUICKSIGHT"|"ANONYMOUS"|string;
  8855. export type EmbeddingUrl = string;
  8856. export interface EmptyVisual {
  8857. /**
  8858. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  8859. */
  8860. VisualId: ShortRestrictiveResourceId;
  8861. /**
  8862. * The data set that is used in the empty visual. Every visual requires a dataset to render.
  8863. */
  8864. DataSetIdentifier: DataSetIdentifier;
  8865. /**
  8866. * The list of custom actions that are configured for a visual.
  8867. */
  8868. Actions?: VisualCustomActionList;
  8869. }
  8870. export interface Entity {
  8871. /**
  8872. * The hierarchical path of the entity within the analysis, template, or dashboard definition tree.
  8873. */
  8874. Path?: NonEmptyString;
  8875. }
  8876. export type EntityList = Entity[];
  8877. export type EntryPath = string;
  8878. export type EntryPoint = string;
  8879. export interface ErrorInfo {
  8880. /**
  8881. * Error type.
  8882. */
  8883. Type?: IngestionErrorType;
  8884. /**
  8885. * Error message.
  8886. */
  8887. Message?: String;
  8888. }
  8889. export interface ExasolParameters {
  8890. /**
  8891. * The hostname or IP address of the Exasol data source.
  8892. */
  8893. Host: Host;
  8894. /**
  8895. * The port for the Exasol data source.
  8896. */
  8897. Port: Port;
  8898. }
  8899. export interface ExcludePeriodConfiguration {
  8900. /**
  8901. * The amount or number of the exclude period.
  8902. */
  8903. Amount: Integer;
  8904. /**
  8905. * The granularity or unit (day, month, year) of the exclude period.
  8906. */
  8907. Granularity: TimeGranularity;
  8908. /**
  8909. * The status of the exclude period. Choose from the following options: ENABLED DISABLED
  8910. */
  8911. Status?: WidgetStatus;
  8912. }
  8913. export interface ExplicitHierarchy {
  8914. /**
  8915. * The hierarchy ID of the explicit hierarchy.
  8916. */
  8917. HierarchyId: HierarchyId;
  8918. /**
  8919. * The list of columns that define the explicit hierarchy.
  8920. */
  8921. Columns: ExplicitHierarchyColumnList;
  8922. /**
  8923. * The option that determines the drill down filters for the explicit hierarchy.
  8924. */
  8925. DrillDownFilters?: DrillDownFilterList;
  8926. }
  8927. export type ExplicitHierarchyColumnList = ColumnIdentifier[];
  8928. export interface ExportHiddenFieldsOption {
  8929. /**
  8930. * The status of the export hidden fields options of a dashbaord.
  8931. */
  8932. AvailabilityStatus?: DashboardBehavior;
  8933. }
  8934. export interface ExportToCSVOption {
  8935. /**
  8936. * Availability status.
  8937. */
  8938. AvailabilityStatus?: DashboardBehavior;
  8939. }
  8940. export interface ExportWithHiddenFieldsOption {
  8941. /**
  8942. * The status of the export with hidden fields options.
  8943. */
  8944. AvailabilityStatus?: DashboardBehavior;
  8945. }
  8946. export type Expression = string;
  8947. export interface FieldBasedTooltip {
  8948. /**
  8949. * The visibility of Show aggregations.
  8950. */
  8951. AggregationVisibility?: Visibility;
  8952. /**
  8953. * The type for the &gt;tooltip title. Choose one of the following options: NONE: Doesn't use the primary value as the title. PRIMARY_VALUE: Uses primary value as the title.
  8954. */
  8955. TooltipTitleType?: TooltipTitleType;
  8956. /**
  8957. * The fields configuration in the tooltip.
  8958. */
  8959. TooltipFields?: TooltipItemList;
  8960. }
  8961. export interface FieldFolder {
  8962. /**
  8963. * The description for a field folder.
  8964. */
  8965. description?: FieldFolderDescription;
  8966. /**
  8967. * A folder has a list of columns. A column can only be in one folder.
  8968. */
  8969. columns?: FolderColumnList;
  8970. }
  8971. export type FieldFolderDescription = string;
  8972. export type FieldFolderMap = {[key: string]: FieldFolder};
  8973. export type FieldFolderPath = string;
  8974. export type FieldId = string;
  8975. export interface FieldLabelType {
  8976. /**
  8977. * Indicates the field that is targeted by the field label.
  8978. */
  8979. FieldId?: FieldId;
  8980. /**
  8981. * The visibility of the field label.
  8982. */
  8983. Visibility?: Visibility;
  8984. }
  8985. export type FieldOrderList = FieldId[];
  8986. export interface FieldSeriesItem {
  8987. /**
  8988. * The field ID of the field for which you are setting the axis binding.
  8989. */
  8990. FieldId: FieldId;
  8991. /**
  8992. * The axis that you are binding the field to.
  8993. */
  8994. AxisBinding: AxisBinding;
  8995. /**
  8996. * The options that determine the presentation of line series associated to the field.
  8997. */
  8998. Settings?: LineChartSeriesSettings;
  8999. }
  9000. export interface FieldSort {
  9001. /**
  9002. * The sort configuration target field.
  9003. */
  9004. FieldId: FieldId;
  9005. /**
  9006. * The sort direction. Choose one of the following options: ASC: Ascending DESC: Descending
  9007. */
  9008. Direction: SortDirection;
  9009. }
  9010. export interface FieldSortOptions {
  9011. /**
  9012. * The sort configuration for a field in a field well.
  9013. */
  9014. FieldSort?: FieldSort;
  9015. /**
  9016. * The sort configuration for a column that is not used in a field well.
  9017. */
  9018. ColumnSort?: ColumnSort;
  9019. }
  9020. export type FieldSortOptionsList = FieldSortOptions[];
  9021. export interface FieldTooltipItem {
  9022. /**
  9023. * The unique ID of the field that is targeted by the tooltip.
  9024. */
  9025. FieldId: FieldId;
  9026. /**
  9027. * The label of the tooltip item.
  9028. */
  9029. Label?: String;
  9030. /**
  9031. * The visibility of the tooltip item.
  9032. */
  9033. Visibility?: Visibility;
  9034. /**
  9035. * Determines the target of the field tooltip item in a combo chart visual.
  9036. */
  9037. TooltipTarget?: TooltipTarget;
  9038. }
  9039. export type FieldValue = string;
  9040. export type FileFormat = "CSV"|"TSV"|"CLF"|"ELF"|"XLSX"|"JSON"|string;
  9041. export interface FilledMapAggregatedFieldWells {
  9042. /**
  9043. * The aggregated location field well of the filled map. Values are grouped by location fields.
  9044. */
  9045. Geospatial?: FilledMapDimensionFieldList;
  9046. /**
  9047. * The aggregated color field well of a filled map. Values are aggregated based on location fields.
  9048. */
  9049. Values?: FilledMapMeasureFieldList;
  9050. }
  9051. export interface FilledMapConditionalFormatting {
  9052. /**
  9053. * Conditional formatting options of a FilledMapVisual.
  9054. */
  9055. ConditionalFormattingOptions: FilledMapConditionalFormattingOptionList;
  9056. }
  9057. export interface FilledMapConditionalFormattingOption {
  9058. /**
  9059. * The conditional formatting that determines the shape of the filled map.
  9060. */
  9061. Shape: FilledMapShapeConditionalFormatting;
  9062. }
  9063. export type FilledMapConditionalFormattingOptionList = FilledMapConditionalFormattingOption[];
  9064. export interface FilledMapConfiguration {
  9065. /**
  9066. * The field wells of the visual.
  9067. */
  9068. FieldWells?: FilledMapFieldWells;
  9069. /**
  9070. * The sort configuration of a FilledMapVisual.
  9071. */
  9072. SortConfiguration?: FilledMapSortConfiguration;
  9073. /**
  9074. * The legend display setup of the visual.
  9075. */
  9076. Legend?: LegendOptions;
  9077. /**
  9078. * The tooltip display setup of the visual.
  9079. */
  9080. Tooltip?: TooltipOptions;
  9081. /**
  9082. * The window options of the filled map visual.
  9083. */
  9084. WindowOptions?: GeospatialWindowOptions;
  9085. /**
  9086. * The map style options of the filled map visual.
  9087. */
  9088. MapStyleOptions?: GeospatialMapStyleOptions;
  9089. /**
  9090. * The general visual interactions setup for a visual.
  9091. */
  9092. Interactions?: VisualInteractionOptions;
  9093. }
  9094. export type FilledMapDimensionFieldList = DimensionField[];
  9095. export interface FilledMapFieldWells {
  9096. /**
  9097. * The aggregated field well of the filled map.
  9098. */
  9099. FilledMapAggregatedFieldWells?: FilledMapAggregatedFieldWells;
  9100. }
  9101. export type FilledMapMeasureFieldList = MeasureField[];
  9102. export interface FilledMapShapeConditionalFormatting {
  9103. /**
  9104. * The field ID of the filled map shape.
  9105. */
  9106. FieldId: FieldId;
  9107. /**
  9108. * The conditional formatting that determines the background color of a filled map's shape.
  9109. */
  9110. Format?: ShapeConditionalFormat;
  9111. }
  9112. export interface FilledMapSortConfiguration {
  9113. /**
  9114. * The sort configuration of the location fields.
  9115. */
  9116. CategorySort?: FieldSortOptionsList;
  9117. }
  9118. export interface FilledMapVisual {
  9119. /**
  9120. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
  9121. */
  9122. VisualId: ShortRestrictiveResourceId;
  9123. /**
  9124. * The title that is displayed on the visual.
  9125. */
  9126. Title?: VisualTitleLabelOptions;
  9127. /**
  9128. * The subtitle that is displayed on the visual.
  9129. */
  9130. Subtitle?: VisualSubtitleLabelOptions;
  9131. /**
  9132. * The configuration settings of the visual.
  9133. */
  9134. ChartConfiguration?: FilledMapConfiguration;
  9135. /**
  9136. * The conditional formatting of a FilledMapVisual.
  9137. */
  9138. ConditionalFormatting?: FilledMapConditionalFormatting;
  9139. /**
  9140. * The column hierarchy that is used during drill-downs and drill-ups.
  9141. */
  9142. ColumnHierarchies?: ColumnHierarchyList;
  9143. /**
  9144. * The list of custom actions that are configured for a visual.
  9145. */
  9146. Actions?: VisualCustomActionList;
  9147. }
  9148. export interface Filter {
  9149. /**
  9150. * A CategoryFilter filters text values. For more information, see Adding text filters in the Amazon QuickSight User Guide.
  9151. */
  9152. CategoryFilter?: CategoryFilter;
  9153. /**
  9154. * A NumericRangeFilter filters numeric values that are either inside or outside a given numeric range.
  9155. */
  9156. NumericRangeFilter?: NumericRangeFilter;
  9157. /**
  9158. * A NumericEqualityFilter filters numeric values that equal or do not equal a given numeric value.
  9159. */
  9160. NumericEqualityFilter?: NumericEqualityFilter;
  9161. /**
  9162. * A TimeEqualityFilter filters date-time values that equal or do not equal a given date/time value.
  9163. */
  9164. TimeEqualityFilter?: TimeEqualityFilter;
  9165. /**
  9166. * A TimeRangeFilter filters date-time values that are either inside or outside a given date/time range.
  9167. */
  9168. TimeRangeFilter?: TimeRangeFilter;
  9169. /**
  9170. * A RelativeDatesFilter filters date values that are relative to a given date.
  9171. */
  9172. RelativeDatesFilter?: RelativeDatesFilter;
  9173. /**
  9174. * A TopBottomFilter filters data to the top or bottom values for a given column.
  9175. */
  9176. TopBottomFilter?: TopBottomFilter;
  9177. }
  9178. export type FilterClass = "ENFORCED_VALUE_FILTER"|"CONDITIONAL_VALUE_FILTER"|"NAMED_VALUE_FILTER"|string;
  9179. export interface FilterControl {
  9180. /**
  9181. * A control from a date filter that is used to specify date and time.
  9182. */
  9183. DateTimePicker?: FilterDateTimePickerControl;
  9184. /**
  9185. * A control to display a list of buttons or boxes. This is used to select either a single value or multiple values.
  9186. */
  9187. List?: FilterListControl;
  9188. /**
  9189. * A control to display a dropdown list with buttons that are used to select a single value.
  9190. */
  9191. Dropdown?: FilterDropDownControl;
  9192. /**
  9193. * A control to display a text box that is used to enter a single entry.
  9194. */
  9195. TextField?: FilterTextFieldControl;
  9196. /**
  9197. * A control to display a text box that is used to enter multiple entries.
  9198. */
  9199. TextArea?: FilterTextAreaControl;
  9200. /**
  9201. * A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
  9202. */
  9203. Slider?: FilterSliderControl;
  9204. /**
  9205. * A control from a date filter that is used to specify the relative date.
  9206. */
  9207. RelativeDateTime?: FilterRelativeDateTimeControl;
  9208. /**
  9209. * A control from a filter that is scoped across more than one sheet. This represents your filter control on a sheet
  9210. */
  9211. CrossSheet?: FilterCrossSheetControl;
  9212. }
  9213. export type FilterControlList = FilterControl[];
  9214. export interface FilterCrossSheetControl {
  9215. /**
  9216. * The ID of the FilterCrossSheetControl.
  9217. */
  9218. FilterControlId: ShortRestrictiveResourceId;
  9219. /**
  9220. * The source filter ID of the FilterCrossSheetControl.
  9221. */
  9222. SourceFilterId: ShortRestrictiveResourceId;
  9223. /**
  9224. * The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
  9225. */
  9226. CascadingControlConfiguration?: CascadingControlConfiguration;
  9227. }
  9228. export interface FilterDateTimePickerControl {
  9229. /**
  9230. * The ID of the FilterDateTimePickerControl.
  9231. */
  9232. FilterControlId: ShortRestrictiveResourceId;
  9233. /**
  9234. * The title of the FilterDateTimePickerControl.
  9235. */
  9236. Title: SheetControlTitle;
  9237. /**
  9238. * The source filter ID of the FilterDateTimePickerControl.
  9239. */
  9240. SourceFilterId: ShortRestrictiveResourceId;
  9241. /**
  9242. * The display options of a control.
  9243. */
  9244. DisplayOptions?: DateTimePickerControlDisplayOptions;
  9245. /**
  9246. * The type of the FilterDropDownControl. Choose one of the following options: MULTI_SELECT: The user can select multiple entries from a dropdown menu. SINGLE_SELECT: The user can select a single entry from a dropdown menu.
  9247. */
  9248. Type?: SheetControlDateTimePickerType;
  9249. }
  9250. export interface FilterDropDownControl {
  9251. /**
  9252. * The ID of the FilterDropDownControl.
  9253. */
  9254. FilterControlId: ShortRestrictiveResourceId;
  9255. /**
  9256. * The title of the FilterDropDownControl.
  9257. */
  9258. Title: SheetControlTitle;
  9259. /**
  9260. * The source filter ID of the FilterDropDownControl.
  9261. */
  9262. SourceFilterId: ShortRestrictiveResourceId;
  9263. /**
  9264. * The display options of the FilterDropDownControl.
  9265. */
  9266. DisplayOptions?: DropDownControlDisplayOptions;
  9267. /**
  9268. * The type of the FilterDropDownControl. Choose one of the following options: MULTI_SELECT: The user can select multiple entries from a dropdown menu. SINGLE_SELECT: The user can select a single entry from a dropdown menu.
  9269. */
  9270. Type?: SheetControlListType;
  9271. /**
  9272. * A list of selectable values that are used in a control.
  9273. */
  9274. SelectableValues?: FilterSelectableValues;
  9275. /**
  9276. * The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
  9277. */
  9278. CascadingControlConfiguration?: CascadingControlConfiguration;
  9279. }
  9280. export interface FilterGroup {
  9281. /**
  9282. * The value that uniquely identifies a FilterGroup within a dashboard, template, or analysis.
  9283. */
  9284. FilterGroupId: ShortRestrictiveResourceId;
  9285. /**
  9286. * The list of filters that are present in a FilterGroup.
  9287. */
  9288. Filters: FilterList;
  9289. /**
  9290. * The configuration that specifies what scope to apply to a FilterGroup. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
  9291. */
  9292. ScopeConfiguration: FilterScopeConfiguration;
  9293. /**
  9294. * The status of the FilterGroup.
  9295. */
  9296. Status?: WidgetStatus;
  9297. /**
  9298. * The filter new feature which can apply filter group to all data sets. Choose one of the following options: ALL_DATASETS SINGLE_DATASET
  9299. */
  9300. CrossDataset: CrossDatasetTypes;
  9301. }
  9302. export type FilterGroupList = FilterGroup[];
  9303. export type FilterList = Filter[];
  9304. export interface FilterListConfiguration {
  9305. /**
  9306. * The match operator that is used to determine if a filter should be applied.
  9307. */
  9308. MatchOperator: CategoryFilterMatchOperator;
  9309. /**
  9310. * The list of category values for the filter.
  9311. */
  9312. CategoryValues?: CategoryValueList;
  9313. /**
  9314. * Select all of the values. Null is not the assigned value of select all. FILTER_ALL_VALUES
  9315. */
  9316. SelectAllOptions?: CategoryFilterSelectAllOptions;
  9317. /**
  9318. * This option determines how null values should be treated when filtering data. ALL_VALUES: Include null values in filtered results. NULLS_ONLY: Only include null values in filtered results. NON_NULLS_ONLY: Exclude null values from filtered results.
  9319. */
  9320. NullOption?: FilterNullOption;
  9321. }
  9322. export interface FilterListControl {
  9323. /**
  9324. * The ID of the FilterListControl.
  9325. */
  9326. FilterControlId: ShortRestrictiveResourceId;
  9327. /**
  9328. * The title of the FilterListControl.
  9329. */
  9330. Title: SheetControlTitle;
  9331. /**
  9332. * The source filter ID of the FilterListControl.
  9333. */
  9334. SourceFilterId: ShortRestrictiveResourceId;
  9335. /**
  9336. * The display options of a control.
  9337. */
  9338. DisplayOptions?: ListControlDisplayOptions;
  9339. /**
  9340. * The type of the FilterListControl. Choose one of the following options: MULTI_SELECT: The user can select multiple entries from the list. SINGLE_SELECT: The user can select a single entry from the list.
  9341. */
  9342. Type?: SheetControlListType;
  9343. /**
  9344. * A list of selectable values that are used in a control.
  9345. */
  9346. SelectableValues?: FilterSelectableValues;
  9347. /**
  9348. * The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
  9349. */
  9350. CascadingControlConfiguration?: CascadingControlConfiguration;
  9351. }
  9352. export type FilterNullOption = "ALL_VALUES"|"NULLS_ONLY"|"NON_NULLS_ONLY"|string;
  9353. export interface FilterOperation {
  9354. /**
  9355. * An expression that must evaluate to a Boolean value. Rows for which the expression evaluates to true are kept in the dataset.
  9356. */
  9357. ConditionExpression: Expression;
  9358. }
  9359. export interface FilterOperationSelectedFieldsConfiguration {
  9360. /**
  9361. * Chooses the fields that are filtered in CustomActionFilterOperation.
  9362. */
  9363. SelectedFields?: SelectedFieldList;
  9364. /**
  9365. * A structure that contains the options that choose which fields are filtered in the CustomActionFilterOperation. Valid values are defined as follows: ALL_FIELDS: Applies the filter operation to all fields.
  9366. */
  9367. SelectedFieldOptions?: SelectedFieldOptions;
  9368. /**
  9369. * The selected columns of a dataset.
  9370. */
  9371. SelectedColumns?: CustomActionColumnList;
  9372. }
  9373. export interface FilterOperationTargetVisualsConfiguration {
  9374. /**
  9375. * The configuration of the same-sheet target visuals that you want to be filtered.
  9376. */
  9377. SameSheetTargetVisualConfiguration?: SameSheetTargetVisualConfiguration;
  9378. }
  9379. export type FilterOperator = "StringEquals"|"StringLike"|string;
  9380. export interface FilterRelativeDateTimeControl {
  9381. /**
  9382. * The ID of the FilterTextAreaControl.
  9383. */
  9384. FilterControlId: ShortRestrictiveResourceId;
  9385. /**
  9386. * The title of the FilterTextAreaControl.
  9387. */
  9388. Title: SheetControlTitle;
  9389. /**
  9390. * The source filter ID of the FilterTextAreaControl.
  9391. */
  9392. SourceFilterId: ShortRestrictiveResourceId;
  9393. /**
  9394. * The display options of a control.
  9395. */
  9396. DisplayOptions?: RelativeDateTimeControlDisplayOptions;
  9397. }
  9398. export interface FilterScopeConfiguration {
  9399. /**
  9400. * The configuration for applying a filter to specific sheets.
  9401. */
  9402. SelectedSheets?: SelectedSheetsFilterScopeConfiguration;
  9403. /**
  9404. * The configuration that applies a filter to all sheets. When you choose AllSheets as the value for a FilterScopeConfiguration, this filter is applied to all visuals of all sheets in an Analysis, Dashboard, or Template. The AllSheetsFilterScopeConfiguration is chosen.
  9405. */
  9406. AllSheets?: AllSheetsFilterScopeConfiguration;
  9407. }
  9408. export interface FilterSelectableValues {
  9409. /**
  9410. * The values that are used in the FilterSelectableValues.
  9411. */
  9412. Values?: ParameterSelectableValueList;
  9413. }
  9414. export interface FilterSliderControl {
  9415. /**
  9416. * The ID of the FilterSliderControl.
  9417. */
  9418. FilterControlId: ShortRestrictiveResourceId;
  9419. /**
  9420. * The title of the FilterSliderControl.
  9421. */
  9422. Title: SheetControlTitle;
  9423. /**
  9424. * The source filter ID of the FilterSliderControl.
  9425. */
  9426. SourceFilterId: ShortRestrictiveResourceId;
  9427. /**
  9428. * The display options of a control.
  9429. */
  9430. DisplayOptions?: SliderControlDisplayOptions;
  9431. /**
  9432. * The type of the FilterSliderControl. Choose one of the following options: SINGLE_POINT: Filter against(equals) a single data point. RANGE: Filter data that is in a specified range.
  9433. */
  9434. Type?: SheetControlSliderType;
  9435. /**
  9436. * The larger value that is displayed at the right of the slider.
  9437. */
  9438. MaximumValue: Double;
  9439. /**
  9440. * The smaller value that is displayed at the left of the slider.
  9441. */
  9442. MinimumValue: Double;
  9443. /**
  9444. * The number of increments that the slider bar is divided into.
  9445. */
  9446. StepSize: Double;
  9447. }
  9448. export interface FilterTextAreaControl {
  9449. /**
  9450. * The ID of the FilterTextAreaControl.
  9451. */
  9452. FilterControlId: ShortRestrictiveResourceId;
  9453. /**
  9454. * The title of the FilterTextAreaControl.
  9455. */
  9456. Title: SheetControlTitle;
  9457. /**
  9458. * The source filter ID of the FilterTextAreaControl.
  9459. */
  9460. SourceFilterId: ShortRestrictiveResourceId;
  9461. /**
  9462. * The delimiter that is used to separate the lines in text.
  9463. */
  9464. Delimiter?: TextAreaControlDelimiter;
  9465. /**
  9466. * The display options of a control.
  9467. */
  9468. DisplayOptions?: TextAreaControlDisplayOptions;
  9469. }
  9470. export interface FilterTextFieldControl {
  9471. /**
  9472. * The ID of the FilterTextFieldControl.
  9473. */
  9474. FilterControlId: ShortRestrictiveResourceId;
  9475. /**
  9476. * The title of the FilterTextFieldControl.
  9477. */
  9478. Title: SheetControlTitle;
  9479. /**
  9480. * The source filter ID of the FilterTextFieldControl.
  9481. */
  9482. SourceFilterId: ShortRestrictiveResourceId;
  9483. /**
  9484. * The display options of a control.
  9485. */
  9486. DisplayOptions?: TextFieldControlDisplayOptions;
  9487. }
  9488. export type FilterVisualScope = "ALL_VISUALS"|"SELECTED_VISUALS"|string;
  9489. export type FilteredVisualsList = ShortRestrictiveResourceId[];
  9490. export interface Folder {
  9491. /**
  9492. * The ID of the folder.
  9493. */
  9494. FolderId?: RestrictiveResourceId;
  9495. /**
  9496. * The Amazon Resource Name (ARN) for the folder.
  9497. */
  9498. Arn?: Arn;
  9499. /**
  9500. * A display name for the folder.
  9501. */
  9502. Name?: FolderName;
  9503. /**
  9504. * The type of folder it is.
  9505. */
  9506. FolderType?: FolderType;
  9507. /**
  9508. * An array of ancestor ARN strings for the folder.
  9509. */
  9510. FolderPath?: Path;
  9511. /**
  9512. * The time that the folder was created.
  9513. */
  9514. CreatedTime?: Timestamp;
  9515. /**
  9516. * The time that the folder was last updated.
  9517. */
  9518. LastUpdatedTime?: Timestamp;
  9519. /**
  9520. * The sharing scope of the folder.
  9521. */
  9522. SharingModel?: SharingModel;
  9523. }
  9524. export type FolderArnList = Arn[];
  9525. export type FolderColumnList = String[];
  9526. export type FolderFilterAttribute = "PARENT_FOLDER_ARN"|"DIRECT_QUICKSIGHT_OWNER"|"DIRECT_QUICKSIGHT_SOLE_OWNER"|"DIRECT_QUICKSIGHT_VIEWER_OR_OWNER"|"QUICKSIGHT_OWNER"|"QUICKSIGHT_VIEWER_OR_OWNER"|"FOLDER_NAME"|string;
  9527. export interface FolderMember {
  9528. /**
  9529. * The ID of an asset in the folder.
  9530. */
  9531. MemberId?: RestrictiveResourceId;
  9532. /**
  9533. * The type of asset that it is.
  9534. */
  9535. MemberType?: MemberType;
  9536. }
  9537. export type FolderMemberList = MemberIdArnPair[];
  9538. export type FolderName = string;
  9539. export interface FolderSearchFilter {
  9540. /**
  9541. * The comparison operator that you want to use as a filter, for example "Operator": "StringEquals". Valid values are "StringEquals" and "StringLike". If you set the operator value to "StringEquals", you need to provide an ownership related filter in the "NAME" field and the arn of the user or group whose folders you want to search in the "Value" field. For example, "Name":"DIRECT_QUICKSIGHT_OWNER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1". If you set the value to "StringLike", you need to provide the name of the folders you are searching for. For example, "Name":"FOLDER_NAME", "Operator": "StringLike", "Value": "Test". The "StringLike" operator only supports the NAME value FOLDER_NAME.
  9542. */
  9543. Operator?: FilterOperator;
  9544. /**
  9545. * The name of a value that you want to use in the filter. For example, "Name": "QUICKSIGHT_OWNER". Valid values are defined as follows: QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the folder's owners or viewers are returned. Implicit permissions from folders or groups are considered. QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are considered. DIRECT_QUICKSIGHT_SOLE_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as the only owner of the folder are returned. Implicit permissions from folders or groups are not considered. DIRECT_QUICKSIGHT_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners of the folders are returned. Implicit permissions from folders or groups are not considered. DIRECT_QUICKSIGHT_VIEWER_OR_OWNER: Provide an ARN of a user or group, and any folders with that ARN listed as one of the owners or viewers of the folders are returned. Implicit permissions from folders or groups are not considered. FOLDER_NAME: Any folders whose names have a substring match to this value will be returned. PARENT_FOLDER_ARN: Provide an ARN of a folder, and any folders that are directly under that parent folder are returned. If you choose to use this option and leave the value blank, all root-level folders in the account are returned.
  9546. */
  9547. Name?: FolderFilterAttribute;
  9548. /**
  9549. * The value of the named item (in this example, PARENT_FOLDER_ARN), that you want to use as a filter. For example, "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId".
  9550. */
  9551. Value?: String;
  9552. }
  9553. export type FolderSearchFilterList = FolderSearchFilter[];
  9554. export interface FolderSummary {
  9555. /**
  9556. * The Amazon Resource Name (ARN) of the folder.
  9557. */
  9558. Arn?: Arn;
  9559. /**
  9560. * The ID of the folder.
  9561. */
  9562. FolderId?: RestrictiveResourceId;
  9563. /**
  9564. * The display name of the folder.
  9565. */
  9566. Name?: FolderName;
  9567. /**
  9568. * The type of folder.
  9569. */
  9570. FolderType?: FolderType;
  9571. /**
  9572. * The time that the folder was created.
  9573. */
  9574. CreatedTime?: Timestamp;
  9575. /**
  9576. * The time that the folder was last updated.
  9577. */
  9578. LastUpdatedTime?: Timestamp;
  9579. /**
  9580. * The sharing scope of the folder.
  9581. */
  9582. SharingModel?: SharingModel;
  9583. }
  9584. export type FolderSummaryList = FolderSummary[];
  9585. export type FolderType = "SHARED"|"RESTRICTED"|string;
  9586. export interface Font {
  9587. /**
  9588. * Determines the font family settings.
  9589. */
  9590. FontFamily?: String;
  9591. }
  9592. export interface FontConfiguration {
  9593. /**
  9594. * The option that determines the text display size.
  9595. */
  9596. FontSize?: FontSize;
  9597. /**
  9598. * Determines the appearance of decorative lines on the text.
  9599. */
  9600. FontDecoration?: FontDecoration;
  9601. /**
  9602. * Determines the color of the text.
  9603. */
  9604. FontColor?: HexColor;
  9605. /**
  9606. * The option that determines the text display weight, or boldness.
  9607. */
  9608. FontWeight?: FontWeight;
  9609. /**
  9610. * Determines the text display face that is inherited by the given font family.
  9611. */
  9612. FontStyle?: FontStyle;
  9613. }
  9614. export type FontDecoration = "UNDERLINE"|"NONE"|string;
  9615. export type FontList = Font[];
  9616. export interface FontSize {
  9617. /**
  9618. * The lexical name for the text size, proportional to its surrounding context.
  9619. */
  9620. Relative?: RelativeFontSize;
  9621. }
  9622. export type FontStyle = "NORMAL"|"ITALIC"|string;
  9623. export interface FontWeight {
  9624. /**
  9625. * The lexical name for the level of boldness of the text display.
  9626. */
  9627. Name?: FontWeightName;
  9628. }
  9629. export type FontWeightName = "NORMAL"|"BOLD"|string;
  9630. export interface ForecastComputation {
  9631. /**
  9632. * The ID for a computation.
  9633. */
  9634. ComputationId: ShortRestrictiveResourceId;
  9635. /**
  9636. * The name of a computation.
  9637. */
  9638. Name?: String;
  9639. /**
  9640. * The time field that is used in a computation.
  9641. */
  9642. Time?: DimensionField;
  9643. /**
  9644. * The value field that is used in a computation.
  9645. */
  9646. Value?: MeasureField;
  9647. /**
  9648. * The periods forward setup of a forecast computation.
  9649. */
  9650. PeriodsForward?: PeriodsForward;
  9651. /**
  9652. * The periods backward setup of a forecast computation.
  9653. */
  9654. PeriodsBackward?: PeriodsBackward;
  9655. /**
  9656. * The upper boundary setup of a forecast computation.
  9657. */
  9658. UpperBoundary?: Double;
  9659. /**
  9660. * The lower boundary setup of a forecast computation.
  9661. */
  9662. LowerBoundary?: Double;
  9663. /**
  9664. * The prediction interval setup of a forecast computation.
  9665. */
  9666. PredictionInterval?: PredictionInterval;
  9667. /**
  9668. * The seasonality setup of a forecast computation. Choose one of the following options: AUTOMATIC CUSTOM: Checks the custom seasonality value.
  9669. */
  9670. Seasonality?: ForecastComputationSeasonality;
  9671. /**
  9672. * The custom seasonality value setup of a forecast computation.
  9673. */
  9674. CustomSeasonalityValue?: ForecastComputationCustomSeasonalityValue;
  9675. }
  9676. export type ForecastComputationCustomSeasonalityValue = number;
  9677. export type ForecastComputationSeasonality = "AUTOMATIC"|"CUSTOM"|string;
  9678. export interface ForecastConfiguration {
  9679. /**
  9680. * The forecast properties setup of a forecast in the line chart.
  9681. */
  9682. ForecastProperties?: TimeBasedForecastProperties;
  9683. /**
  9684. * The forecast scenario of a forecast in the line chart.
  9685. */
  9686. Scenario?: ForecastScenario;
  9687. }
  9688. export type ForecastConfigurationList = ForecastConfiguration[];
  9689. export interface ForecastScenario {
  9690. /**
  9691. * The what-if analysis forecast setup with the target date.
  9692. */
  9693. WhatIfPointScenario?: WhatIfPointScenario;
  9694. /**
  9695. * The what-if analysis forecast setup with the date range.
  9696. */
  9697. WhatIfRangeScenario?: WhatIfRangeScenario;
  9698. }
  9699. export interface FormatConfiguration {
  9700. /**
  9701. * Formatting configuration for string fields.
  9702. */
  9703. StringFormatConfiguration?: StringFormatConfiguration;
  9704. /**
  9705. * Formatting configuration for number fields.
  9706. */
  9707. NumberFormatConfiguration?: NumberFormatConfiguration;
  9708. /**
  9709. * Formatting configuration for DateTime fields.
  9710. */
  9711. DateTimeFormatConfiguration?: DateTimeFormatConfiguration;
  9712. }
  9713. export interface FreeFormLayoutCanvasSizeOptions {
  9714. /**
  9715. * The options that determine the sizing of the canvas used in a free-form layout.
  9716. */
  9717. ScreenCanvasSizeOptions?: FreeFormLayoutScreenCanvasSizeOptions;
  9718. }
  9719. export interface FreeFormLayoutConfiguration {
  9720. /**
  9721. * The elements that are included in a free-form layout.
  9722. */
  9723. Elements: FreeFromLayoutElementList;
  9724. CanvasSizeOptions?: FreeFormLayoutCanvasSizeOptions;
  9725. }
  9726. export interface FreeFormLayoutElement {
  9727. /**
  9728. * A unique identifier for an element within a free-form layout.
  9729. */
  9730. ElementId: ShortRestrictiveResourceId;
  9731. /**
  9732. * The type of element.
  9733. */
  9734. ElementType: LayoutElementType;
  9735. /**
  9736. * The x-axis coordinate of the element.
  9737. */
  9738. XAxisLocation: PixelLength;
  9739. /**
  9740. * The y-axis coordinate of the element.
  9741. */
  9742. YAxisLocation: UnlimitedPixelLength;
  9743. /**
  9744. * The width of an element within a free-form layout.
  9745. */
  9746. Width: PixelLength;
  9747. /**
  9748. * The height of an element within a free-form layout.
  9749. */
  9750. Height: PixelLength;
  9751. /**
  9752. * The visibility of an element within a free-form layout.
  9753. */
  9754. Visibility?: Visibility;
  9755. /**
  9756. * The rendering rules that determine when an element should be displayed within a free-form layout.
  9757. */
  9758. RenderingRules?: SheetElementRenderingRuleList;
  9759. /**
  9760. * The border style configuration of a free-form layout element.
  9761. */
  9762. BorderStyle?: FreeFormLayoutElementBorderStyle;
  9763. /**
  9764. * The border style configuration of a free-form layout element. This border style is used when the element is selected.
  9765. */
  9766. SelectedBorderStyle?: FreeFormLayoutElementBorderStyle;
  9767. /**
  9768. * The background style configuration of a free-form layout element.
  9769. */
  9770. BackgroundStyle?: FreeFormLayoutElementBackgroundStyle;
  9771. /**
  9772. * The loading animation configuration of a free-form layout element.
  9773. */
  9774. LoadingAnimation?: LoadingAnimation;
  9775. }
  9776. export interface FreeFormLayoutElementBackgroundStyle {
  9777. /**
  9778. * The background visibility of a free-form layout element.
  9779. */
  9780. Visibility?: Visibility;
  9781. /**
  9782. * The background color of a free-form layout element.
  9783. */
  9784. Color?: HexColorWithTransparency;
  9785. }
  9786. export interface FreeFormLayoutElementBorderStyle {
  9787. /**
  9788. * The border visibility of a free-form layout element.
  9789. */
  9790. Visibility?: Visibility;
  9791. /**
  9792. * The border color of a free-form layout element.
  9793. */
  9794. Color?: HexColorWithTransparency;
  9795. }
  9796. export interface FreeFormLayoutScreenCanvasSizeOptions {
  9797. /**
  9798. * The width that the view port will be optimized for when the layout renders.
  9799. */
  9800. OptimizedViewPortWidth: PixelLength;
  9801. }
  9802. export interface FreeFormSectionLayoutConfiguration {
  9803. /**
  9804. * The elements that are included in the free-form layout.
  9805. */
  9806. Elements: FreeFromLayoutElementList;
  9807. }
  9808. export type FreeFromLayoutElementList = FreeFormLayoutElement[];
  9809. export interface FunnelChartAggregatedFieldWells {
  9810. /**
  9811. * The category field wells of a funnel chart. Values are grouped by category fields.
  9812. */
  9813. Category?: FunnelChartDimensionFieldList;
  9814. /**
  9815. * The value field wells of a funnel chart. Values are aggregated based on categories.
  9816. */
  9817. Values?: FunnelChartMeasureFieldList;
  9818. }
  9819. export interface FunnelChartConfiguration {
  9820. /**
  9821. * The field well configuration of a FunnelChartVisual.
  9822. */
  9823. FieldWells?: FunnelChartFieldWells;
  9824. /**
  9825. * The sort configuration of a FunnelChartVisual.
  9826. */
  9827. SortConfiguration?: FunnelChartSortConfiguration;
  9828. /**
  9829. * The label options of the categories that are displayed in a FunnelChartVisual.
  9830. */
  9831. CategoryLabelOptions?: ChartAxisLabelOptions;
  9832. /**
  9833. * The label options for the values that are displayed in a FunnelChartVisual.
  9834. */
  9835. ValueLabelOptions?: ChartAxisLabelOptions;
  9836. /**
  9837. * The tooltip configuration of a FunnelChartVisual.
  9838. */
  9839. Tooltip?: TooltipOptions;
  9840. /**
  9841. * The options that determine the presentation of the data labels.
  9842. */
  9843. DataLabelOptions?: FunnelChartDataLabelOptions;
  9844. /**
  9845. * The visual palette configuration of a FunnelChartVisual.
  9846. */
  9847. VisualPalette?: VisualPalette;
  9848. /**
  9849. * The general visual interactions setup for a visual.
  9850. */
  9851. Interactions?: VisualInteractionOptions;
  9852. }
  9853. export interface FunnelChartDataLabelOptions {
  9854. /**
  9855. * The visibility option that determines if data labels are displayed.
  9856. */
  9857. Visibility?: Visibility;
  9858. /**
  9859. * The visibility of the category labels within the data labels.
  9860. */
  9861. CategoryLabelVisibility?: Visibility;
  9862. /**
  9863. * The visibility of the measure labels within the data labels.
  9864. */
  9865. MeasureLabelVisibility?: Visibility;
  9866. /**
  9867. * Determines the positioning of the data label relative to a section of the funnel.
  9868. */
  9869. Position?: DataLabelPosition;
  9870. /**
  9871. * The font configuration for the data labels. Only the FontSize attribute of the font configuration is used for data labels.
  9872. */
  9873. LabelFontConfiguration?: FontConfiguration;
  9874. /**
  9875. * The color of the data label text.
  9876. */
  9877. LabelColor?: HexColor;
  9878. /**
  9879. * Determines the style of the metric labels.
  9880. */
  9881. MeasureDataLabelStyle?: FunnelChartMeasureDataLabelStyle;
  9882. }
  9883. export type FunnelChartDimensionFieldList = DimensionField[];
  9884. export interface FunnelChartFieldWells {
  9885. /**
  9886. * The field well configuration of a FunnelChartVisual.
  9887. */
  9888. FunnelChartAggregatedFieldWells?: FunnelChartAggregatedFieldWells;
  9889. }
  9890. export type FunnelChartMeasureDataLabelStyle = "VALUE_ONLY"|"PERCENTAGE_BY_FIRST_STAGE"|"PERCENTAGE_BY_PREVIOUS_STAGE"|"VALUE_AND_PERCENTAGE_BY_FIRST_STAGE"|"VALUE_AND_PERCENTAGE_BY_PREVIOUS_STAGE"|string;
  9891. export type FunnelChartMeasureFieldList = MeasureField[];
  9892. export interface FunnelChartSortConfiguration {
  9893. /**
  9894. * The sort configuration of the category fields.
  9895. */
  9896. CategorySort?: FieldSortOptionsList;
  9897. /**
  9898. * The limit on the number of categories displayed.
  9899. */
  9900. CategoryItemsLimit?: ItemsLimitConfiguration;
  9901. }
  9902. export interface FunnelChartVisual {
  9903. /**
  9904. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
  9905. */
  9906. VisualId: ShortRestrictiveResourceId;
  9907. /**
  9908. * The title that is displayed on the visual.
  9909. */
  9910. Title?: VisualTitleLabelOptions;
  9911. /**
  9912. * The subtitle that is displayed on the visual.
  9913. */
  9914. Subtitle?: VisualSubtitleLabelOptions;
  9915. /**
  9916. * The configuration of a FunnelChartVisual.
  9917. */
  9918. ChartConfiguration?: FunnelChartConfiguration;
  9919. /**
  9920. * The list of custom actions that are configured for a visual.
  9921. */
  9922. Actions?: VisualCustomActionList;
  9923. /**
  9924. * The column hierarchy that is used during drill-downs and drill-ups.
  9925. */
  9926. ColumnHierarchies?: ColumnHierarchyList;
  9927. }
  9928. export interface GaugeChartArcConditionalFormatting {
  9929. /**
  9930. * The conditional formatting of the arc foreground color.
  9931. */
  9932. ForegroundColor?: ConditionalFormattingColor;
  9933. }
  9934. export interface GaugeChartColorConfiguration {
  9935. /**
  9936. * The foreground color configuration of a GaugeChartVisual.
  9937. */
  9938. ForegroundColor?: HexColor;
  9939. /**
  9940. * The background color configuration of a GaugeChartVisual.
  9941. */
  9942. BackgroundColor?: HexColor;
  9943. }
  9944. export interface GaugeChartConditionalFormatting {
  9945. /**
  9946. * Conditional formatting options of a GaugeChartVisual.
  9947. */
  9948. ConditionalFormattingOptions?: GaugeChartConditionalFormattingOptionList;
  9949. }
  9950. export interface GaugeChartConditionalFormattingOption {
  9951. /**
  9952. * The conditional formatting for the primary value of a GaugeChartVisual.
  9953. */
  9954. PrimaryValue?: GaugeChartPrimaryValueConditionalFormatting;
  9955. /**
  9956. * The options that determine the presentation of the arc of a GaugeChartVisual.
  9957. */
  9958. Arc?: GaugeChartArcConditionalFormatting;
  9959. }
  9960. export type GaugeChartConditionalFormattingOptionList = GaugeChartConditionalFormattingOption[];
  9961. export interface GaugeChartConfiguration {
  9962. /**
  9963. * The field well configuration of a GaugeChartVisual.
  9964. */
  9965. FieldWells?: GaugeChartFieldWells;
  9966. /**
  9967. * The options that determine the presentation of the GaugeChartVisual.
  9968. */
  9969. GaugeChartOptions?: GaugeChartOptions;
  9970. /**
  9971. * The data label configuration of a GaugeChartVisual.
  9972. */
  9973. DataLabels?: DataLabelOptions;
  9974. /**
  9975. * The tooltip configuration of a GaugeChartVisual.
  9976. */
  9977. TooltipOptions?: TooltipOptions;
  9978. /**
  9979. * The visual palette configuration of a GaugeChartVisual.
  9980. */
  9981. VisualPalette?: VisualPalette;
  9982. /**
  9983. * The color configuration of a GaugeChartVisual.
  9984. */
  9985. ColorConfiguration?: GaugeChartColorConfiguration;
  9986. /**
  9987. * The general visual interactions setup for a visual.
  9988. */
  9989. Interactions?: VisualInteractionOptions;
  9990. }
  9991. export interface GaugeChartFieldWells {
  9992. /**
  9993. * The value field wells of a GaugeChartVisual.
  9994. */
  9995. Values?: MeasureFieldList;
  9996. /**
  9997. * The target value field wells of a GaugeChartVisual.
  9998. */
  9999. TargetValues?: MeasureFieldList;
  10000. }
  10001. export interface GaugeChartOptions {
  10002. /**
  10003. * The options that determine the primary value display type.
  10004. */
  10005. PrimaryValueDisplayType?: PrimaryValueDisplayType;
  10006. /**
  10007. * The comparison configuration of a GaugeChartVisual.
  10008. */
  10009. Comparison?: ComparisonConfiguration;
  10010. /**
  10011. * The arc axis configuration of a GaugeChartVisual.
  10012. */
  10013. ArcAxis?: ArcAxisConfiguration;
  10014. /**
  10015. * The arc configuration of a GaugeChartVisual.
  10016. */
  10017. Arc?: ArcConfiguration;
  10018. /**
  10019. * The options that determine the primary value font configuration.
  10020. */
  10021. PrimaryValueFontConfiguration?: FontConfiguration;
  10022. }
  10023. export interface GaugeChartPrimaryValueConditionalFormatting {
  10024. /**
  10025. * The conditional formatting of the primary value text color.
  10026. */
  10027. TextColor?: ConditionalFormattingColor;
  10028. /**
  10029. * The conditional formatting of the primary value icon.
  10030. */
  10031. Icon?: ConditionalFormattingIcon;
  10032. }
  10033. export interface GaugeChartVisual {
  10034. /**
  10035. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  10036. */
  10037. VisualId: ShortRestrictiveResourceId;
  10038. /**
  10039. * The title that is displayed on the visual.
  10040. */
  10041. Title?: VisualTitleLabelOptions;
  10042. /**
  10043. * The subtitle that is displayed on the visual.
  10044. */
  10045. Subtitle?: VisualSubtitleLabelOptions;
  10046. /**
  10047. * The configuration of a GaugeChartVisual.
  10048. */
  10049. ChartConfiguration?: GaugeChartConfiguration;
  10050. /**
  10051. * The conditional formatting of a GaugeChartVisual.
  10052. */
  10053. ConditionalFormatting?: GaugeChartConditionalFormatting;
  10054. /**
  10055. * The list of custom actions that are configured for a visual.
  10056. */
  10057. Actions?: VisualCustomActionList;
  10058. }
  10059. export interface GenerateEmbedUrlForAnonymousUserRequest {
  10060. /**
  10061. * The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
  10062. */
  10063. AwsAccountId: AwsAccountId;
  10064. /**
  10065. * How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
  10066. */
  10067. SessionLifetimeInMinutes?: SessionLifetimeInMinutes;
  10068. /**
  10069. * The Amazon QuickSight namespace that the anonymous user virtually belongs to. If you are not using an Amazon QuickSight custom namespace, set this to default.
  10070. */
  10071. Namespace: Namespace;
  10072. /**
  10073. * The session tags used for row-level security. Before you use this parameter, make sure that you have configured the relevant datasets using the DataSet$RowLevelPermissionTagConfiguration parameter so that session tags can be used to provide row-level security. These are not the tags used for the Amazon Web Services resource tagging feature. For more information, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
  10074. */
  10075. SessionTags?: SessionTagList;
  10076. /**
  10077. * The Amazon Resource Names (ARNs) for the Amazon QuickSight resources that the user is authorized to access during the lifetime of the session. If you choose Dashboard embedding experience, pass the list of dashboard ARNs in the account that you want the user to be able to view. If you want to make changes to the theme of your embedded content, pass a list of theme ARNs that the anonymous users need access to. Currently, you can pass up to 25 theme ARNs in each API call.
  10078. */
  10079. AuthorizedResourceArns: ArnList;
  10080. /**
  10081. * The configuration of the experience that you are embedding.
  10082. */
  10083. ExperienceConfiguration: AnonymousUserEmbeddingExperienceConfiguration;
  10084. /**
  10085. * The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call. To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.
  10086. */
  10087. AllowedDomains?: StringList;
  10088. }
  10089. export interface GenerateEmbedUrlForAnonymousUserResponse {
  10090. /**
  10091. * The embed URL for the dashboard.
  10092. */
  10093. EmbedUrl: EmbeddingUrl;
  10094. /**
  10095. * The HTTP status of the request.
  10096. */
  10097. Status: StatusCode;
  10098. /**
  10099. * The Amazon Web Services request ID for this operation.
  10100. */
  10101. RequestId: String;
  10102. /**
  10103. * The Amazon Resource Name (ARN) to use for the anonymous Amazon QuickSight user.
  10104. */
  10105. AnonymousUserArn: Arn;
  10106. }
  10107. export interface GenerateEmbedUrlForRegisteredUserRequest {
  10108. /**
  10109. * The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
  10110. */
  10111. AwsAccountId: AwsAccountId;
  10112. /**
  10113. * How many minutes the session is valid. The session lifetime must be in [15-600] minutes range.
  10114. */
  10115. SessionLifetimeInMinutes?: SessionLifetimeInMinutes;
  10116. /**
  10117. * The Amazon Resource Name for the registered user.
  10118. */
  10119. UserArn: Arn;
  10120. /**
  10121. * The experience that you want to embed. For registered users, you can embed Amazon QuickSight dashboards, Amazon QuickSight visuals, the Amazon QuickSight Q search bar, the Amazon QuickSight Generative Q&amp;A experience, or the entire Amazon QuickSight console.
  10122. */
  10123. ExperienceConfiguration: RegisteredUserEmbeddingExperienceConfiguration;
  10124. /**
  10125. * The domains that you want to add to the allow list for access to the generated URL that is then embedded. This optional parameter overrides the static domains that are configured in the Manage QuickSight menu in the Amazon QuickSight console. Instead, it allows only the domains that you include in this parameter. You can list up to three domains or subdomains in each API call. To include all subdomains under a specific domain to the allow list, use *. For example, https://*.sapp.amazon.com includes all subdomains under https://sapp.amazon.com.
  10126. */
  10127. AllowedDomains?: StringList;
  10128. }
  10129. export interface GenerateEmbedUrlForRegisteredUserResponse {
  10130. /**
  10131. * The embed URL for the Amazon QuickSight dashboard, visual, Q search bar, Generative Q&amp;A experience, or console.
  10132. */
  10133. EmbedUrl: EmbeddingUrl;
  10134. /**
  10135. * The HTTP status of the request.
  10136. */
  10137. Status: StatusCode;
  10138. /**
  10139. * The Amazon Web Services request ID for this operation.
  10140. */
  10141. RequestId: String;
  10142. }
  10143. export interface GeoSpatialColumnGroup {
  10144. /**
  10145. * A display name for the hierarchy.
  10146. */
  10147. Name: ColumnGroupName;
  10148. /**
  10149. * Country code.
  10150. */
  10151. CountryCode?: GeoSpatialCountryCode;
  10152. /**
  10153. * Columns in this hierarchy.
  10154. */
  10155. Columns: ColumnList;
  10156. }
  10157. export type GeoSpatialCountryCode = "US"|string;
  10158. export type GeoSpatialDataRole = "COUNTRY"|"STATE"|"COUNTY"|"CITY"|"POSTCODE"|"LONGITUDE"|"LATITUDE"|string;
  10159. export interface GeospatialCoordinateBounds {
  10160. /**
  10161. * The latitude of the north bound of the geospatial coordinate bounds.
  10162. */
  10163. North: Latitude;
  10164. /**
  10165. * The latitude of the south bound of the geospatial coordinate bounds.
  10166. */
  10167. South: Latitude;
  10168. /**
  10169. * The longitude of the west bound of the geospatial coordinate bounds.
  10170. */
  10171. West: Longitude;
  10172. /**
  10173. * The longitude of the east bound of the geospatial coordinate bounds.
  10174. */
  10175. East: Longitude;
  10176. }
  10177. export interface GeospatialHeatmapColorScale {
  10178. /**
  10179. * The list of colors to be used in heatmap point style.
  10180. */
  10181. Colors?: GeospatialHeatmapDataColorList;
  10182. }
  10183. export interface GeospatialHeatmapConfiguration {
  10184. /**
  10185. * The color scale specification for the heatmap point style.
  10186. */
  10187. HeatmapColor?: GeospatialHeatmapColorScale;
  10188. }
  10189. export interface GeospatialHeatmapDataColor {
  10190. /**
  10191. * The hex color to be used in the heatmap point style.
  10192. */
  10193. Color: HexColor;
  10194. }
  10195. export type GeospatialHeatmapDataColorList = GeospatialHeatmapDataColor[];
  10196. export interface GeospatialMapAggregatedFieldWells {
  10197. /**
  10198. * The geospatial field wells of a geospatial map. Values are grouped by geospatial fields.
  10199. */
  10200. Geospatial?: DimensionFieldList;
  10201. /**
  10202. * The size field wells of a geospatial map. Values are aggregated based on geospatial fields.
  10203. */
  10204. Values?: MeasureFieldList;
  10205. /**
  10206. * The color field wells of a geospatial map.
  10207. */
  10208. Colors?: DimensionFieldList;
  10209. }
  10210. export interface GeospatialMapConfiguration {
  10211. /**
  10212. * The field wells of the visual.
  10213. */
  10214. FieldWells?: GeospatialMapFieldWells;
  10215. /**
  10216. * The legend display setup of the visual.
  10217. */
  10218. Legend?: LegendOptions;
  10219. /**
  10220. * The tooltip display setup of the visual.
  10221. */
  10222. Tooltip?: TooltipOptions;
  10223. /**
  10224. * The window options of the geospatial map.
  10225. */
  10226. WindowOptions?: GeospatialWindowOptions;
  10227. /**
  10228. * The map style options of the geospatial map.
  10229. */
  10230. MapStyleOptions?: GeospatialMapStyleOptions;
  10231. /**
  10232. * The point style options of the geospatial map.
  10233. */
  10234. PointStyleOptions?: GeospatialPointStyleOptions;
  10235. VisualPalette?: VisualPalette;
  10236. /**
  10237. * The general visual interactions setup for a visual.
  10238. */
  10239. Interactions?: VisualInteractionOptions;
  10240. }
  10241. export interface GeospatialMapFieldWells {
  10242. /**
  10243. * The aggregated field well for a geospatial map.
  10244. */
  10245. GeospatialMapAggregatedFieldWells?: GeospatialMapAggregatedFieldWells;
  10246. }
  10247. export interface GeospatialMapStyleOptions {
  10248. /**
  10249. * The base map style of the geospatial map.
  10250. */
  10251. BaseMapStyle?: BaseMapStyleType;
  10252. }
  10253. export interface GeospatialMapVisual {
  10254. /**
  10255. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
  10256. */
  10257. VisualId: ShortRestrictiveResourceId;
  10258. /**
  10259. * The title that is displayed on the visual.
  10260. */
  10261. Title?: VisualTitleLabelOptions;
  10262. /**
  10263. * The subtitle that is displayed on the visual.
  10264. */
  10265. Subtitle?: VisualSubtitleLabelOptions;
  10266. /**
  10267. * The configuration settings of the visual.
  10268. */
  10269. ChartConfiguration?: GeospatialMapConfiguration;
  10270. /**
  10271. * The column hierarchy that is used during drill-downs and drill-ups.
  10272. */
  10273. ColumnHierarchies?: ColumnHierarchyList;
  10274. /**
  10275. * The list of custom actions that are configured for a visual.
  10276. */
  10277. Actions?: VisualCustomActionList;
  10278. }
  10279. export interface GeospatialPointStyleOptions {
  10280. /**
  10281. * The selected point styles (point, cluster) of the geospatial map.
  10282. */
  10283. SelectedPointStyle?: GeospatialSelectedPointStyle;
  10284. /**
  10285. * The cluster marker configuration of the geospatial point style.
  10286. */
  10287. ClusterMarkerConfiguration?: ClusterMarkerConfiguration;
  10288. /**
  10289. * The heatmap configuration of the geospatial point style.
  10290. */
  10291. HeatmapConfiguration?: GeospatialHeatmapConfiguration;
  10292. }
  10293. export type GeospatialSelectedPointStyle = "POINT"|"CLUSTER"|"HEATMAP"|string;
  10294. export interface GeospatialWindowOptions {
  10295. /**
  10296. * The bounds options (north, south, west, east) of the geospatial window options.
  10297. */
  10298. Bounds?: GeospatialCoordinateBounds;
  10299. /**
  10300. * The map zoom modes (manual, auto) of the geospatial window options.
  10301. */
  10302. MapZoomMode?: MapZoomMode;
  10303. }
  10304. export interface GetDashboardEmbedUrlRequest {
  10305. /**
  10306. * The ID for the Amazon Web Services account that contains the dashboard that you're embedding.
  10307. */
  10308. AwsAccountId: AwsAccountId;
  10309. /**
  10310. * The ID for the dashboard, also added to the Identity and Access Management (IAM) policy.
  10311. */
  10312. DashboardId: ShortRestrictiveResourceId;
  10313. /**
  10314. * The authentication method that the user uses to sign in.
  10315. */
  10316. IdentityType: EmbeddingIdentityType;
  10317. /**
  10318. * How many minutes the session is valid. The session lifetime must be 15-600 minutes.
  10319. */
  10320. SessionLifetimeInMinutes?: SessionLifetimeInMinutes;
  10321. /**
  10322. * Remove the undo/redo button on the embedded dashboard. The default is FALSE, which enables the undo/redo button.
  10323. */
  10324. UndoRedoDisabled?: Boolean;
  10325. /**
  10326. * Remove the reset button on the embedded dashboard. The default is FALSE, which enables the reset button.
  10327. */
  10328. ResetDisabled?: Boolean;
  10329. /**
  10330. * Adds persistence of state for the user session in an embedded dashboard. Persistence applies to the sheet and the parameter settings. These are control settings that the dashboard subscriber (Amazon QuickSight reader) chooses while viewing the dashboard. If this is set to TRUE, the settings are the same when the subscriber reopens the same dashboard URL. The state is stored in Amazon QuickSight, not in a browser cookie. If this is set to FALSE, the state of the user session is not persisted. The default is FALSE.
  10331. */
  10332. StatePersistenceEnabled?: Boolean;
  10333. /**
  10334. * The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any Amazon QuickSight users in your account (readers, authors, or admins) authenticated as one of the following: Active Directory (AD) users or group members Invited nonfederated users IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation. Omit this parameter for users in the third group – IAM users and IAM role-based sessions.
  10335. */
  10336. UserArn?: Arn;
  10337. /**
  10338. * The Amazon QuickSight namespace that contains the dashboard IDs in this request. If you're not using a custom namespace, set Namespace = default.
  10339. */
  10340. Namespace?: Namespace;
  10341. /**
  10342. * A list of one or more dashboard IDs that you want anonymous users to have tempporary access to. Currently, the IdentityType parameter must be set to ANONYMOUS because other identity types authenticate as Amazon QuickSight or IAM users. For example, if you set "--dashboard-id dash_id1 --dashboard-id dash_id2 dash_id3 identity-type ANONYMOUS", the session can access all three dashboards.
  10343. */
  10344. AdditionalDashboardIds?: AdditionalDashboardIdList;
  10345. }
  10346. export interface GetDashboardEmbedUrlResponse {
  10347. /**
  10348. * A single-use URL that you can put into your server-side webpage to embed your dashboard. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
  10349. */
  10350. EmbedUrl?: EmbeddingUrl;
  10351. /**
  10352. * The HTTP status of the request.
  10353. */
  10354. Status?: StatusCode;
  10355. /**
  10356. * The Amazon Web Services request ID for this operation.
  10357. */
  10358. RequestId?: String;
  10359. }
  10360. export interface GetSessionEmbedUrlRequest {
  10361. /**
  10362. * The ID for the Amazon Web Services account associated with your Amazon QuickSight subscription.
  10363. */
  10364. AwsAccountId: AwsAccountId;
  10365. /**
  10366. * The URL you use to access the embedded session. The entry point URL is constrained to the following paths: /start /start/analyses /start/dashboards /start/favorites /dashboards/DashboardId - where DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard /analyses/AnalysisId - where AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis
  10367. */
  10368. EntryPoint?: EntryPoint;
  10369. /**
  10370. * How many minutes the session is valid. The session lifetime must be 15-600 minutes.
  10371. */
  10372. SessionLifetimeInMinutes?: SessionLifetimeInMinutes;
  10373. /**
  10374. * The Amazon QuickSight user's Amazon Resource Name (ARN), for use with QUICKSIGHT identity type. You can use this for any type of Amazon QuickSight users in your account (readers, authors, or admins). They need to be authenticated as one of the following: Active Directory (AD) users or group members Invited nonfederated users IAM users and IAM role-based sessions authenticated through Federated Single Sign-On using SAML, OpenID Connect, or IAM federation Omit this parameter for users in the third group, IAM users and IAM role-based sessions.
  10375. */
  10376. UserArn?: Arn;
  10377. }
  10378. export interface GetSessionEmbedUrlResponse {
  10379. /**
  10380. * A single-use URL that you can put into your server-side web page to embed your Amazon QuickSight session. This URL is valid for 5 minutes. The API operation provides the URL with an auth_code value that enables one (and only one) sign-on to a user session that is valid for 10 hours.
  10381. */
  10382. EmbedUrl?: EmbeddingUrl;
  10383. /**
  10384. * The HTTP status of the request.
  10385. */
  10386. Status?: StatusCode;
  10387. /**
  10388. * The Amazon Web Services request ID for this operation.
  10389. */
  10390. RequestId?: String;
  10391. }
  10392. export interface GlobalTableBorderOptions {
  10393. /**
  10394. * Determines the options for uniform border.
  10395. */
  10396. UniformBorder?: TableBorderOptions;
  10397. /**
  10398. * Determines the options for side specific border.
  10399. */
  10400. SideSpecificBorder?: TableSideBorderOptions;
  10401. }
  10402. export interface GradientColor {
  10403. /**
  10404. * The list of gradient color stops.
  10405. */
  10406. Stops?: GradientStopList;
  10407. }
  10408. export interface GradientStop {
  10409. /**
  10410. * Determines gradient offset value.
  10411. */
  10412. GradientOffset: Double;
  10413. /**
  10414. * Determines the data value.
  10415. */
  10416. DataValue?: Double;
  10417. /**
  10418. * Determines the color.
  10419. */
  10420. Color?: HexColor;
  10421. }
  10422. export type GradientStopList = GradientStop[];
  10423. export interface GridLayoutCanvasSizeOptions {
  10424. /**
  10425. * The options that determine the sizing of the canvas used in a grid layout.
  10426. */
  10427. ScreenCanvasSizeOptions?: GridLayoutScreenCanvasSizeOptions;
  10428. }
  10429. export interface GridLayoutConfiguration {
  10430. /**
  10431. * The elements that are included in a grid layout.
  10432. */
  10433. Elements: GridLayoutElementList;
  10434. CanvasSizeOptions?: GridLayoutCanvasSizeOptions;
  10435. }
  10436. export interface GridLayoutElement {
  10437. /**
  10438. * A unique identifier for an element within a grid layout.
  10439. */
  10440. ElementId: ShortRestrictiveResourceId;
  10441. /**
  10442. * The type of element.
  10443. */
  10444. ElementType: LayoutElementType;
  10445. /**
  10446. * The column index for the upper left corner of an element.
  10447. */
  10448. ColumnIndex?: GridLayoutElementColumnIndex;
  10449. /**
  10450. * The width of a grid element expressed as a number of grid columns.
  10451. */
  10452. ColumnSpan: GridLayoutElementColumnSpan;
  10453. /**
  10454. * The row index for the upper left corner of an element.
  10455. */
  10456. RowIndex?: GridLayoutElementRowIndex;
  10457. /**
  10458. * The height of a grid element expressed as a number of grid rows.
  10459. */
  10460. RowSpan: GridLayoutElementRowSpan;
  10461. }
  10462. export type GridLayoutElementColumnIndex = number;
  10463. export type GridLayoutElementColumnSpan = number;
  10464. export type GridLayoutElementList = GridLayoutElement[];
  10465. export type GridLayoutElementRowIndex = number;
  10466. export type GridLayoutElementRowSpan = number;
  10467. export interface GridLayoutScreenCanvasSizeOptions {
  10468. /**
  10469. * This value determines the layout behavior when the viewport is resized. FIXED: A fixed width will be used when optimizing the layout. In the Amazon QuickSight console, this option is called Classic. RESPONSIVE: The width of the canvas will be responsive and optimized to the view port. In the Amazon QuickSight console, this option is called Tiled.
  10470. */
  10471. ResizeOption: ResizeOption;
  10472. /**
  10473. * The width that the view port will be optimized for when the layout renders.
  10474. */
  10475. OptimizedViewPortWidth?: PixelLength;
  10476. }
  10477. export interface Group {
  10478. /**
  10479. * The Amazon Resource Name (ARN) for the group.
  10480. */
  10481. Arn?: Arn;
  10482. /**
  10483. * The name of the group.
  10484. */
  10485. GroupName?: GroupName;
  10486. /**
  10487. * The group description.
  10488. */
  10489. Description?: GroupDescription;
  10490. /**
  10491. * The principal ID of the group.
  10492. */
  10493. PrincipalId?: String;
  10494. }
  10495. export type GroupDescription = string;
  10496. export type GroupFilterAttribute = "GROUP_NAME"|string;
  10497. export type GroupFilterOperator = "StartsWith"|string;
  10498. export type GroupList = Group[];
  10499. export interface GroupMember {
  10500. /**
  10501. * The Amazon Resource Name (ARN) for the group member (user).
  10502. */
  10503. Arn?: Arn;
  10504. /**
  10505. * The name of the group member (user).
  10506. */
  10507. MemberName?: GroupMemberName;
  10508. }
  10509. export type GroupMemberList = GroupMember[];
  10510. export type GroupMemberName = string;
  10511. export type GroupName = string;
  10512. export interface GroupSearchFilter {
  10513. /**
  10514. * The comparison operator that you want to use as a filter, for example "Operator": "StartsWith". Currently, the only supported operator is StartsWith.
  10515. */
  10516. Operator: GroupFilterOperator;
  10517. /**
  10518. * The name of the value that you want to use as a filter, for example "Name": "GROUP_NAME". Currently, the only supported name is GROUP_NAME.
  10519. */
  10520. Name: GroupFilterAttribute;
  10521. /**
  10522. * The value of the named item, in this case GROUP_NAME, that you want to use as a filter.
  10523. */
  10524. Value: String;
  10525. }
  10526. export type GroupSearchFilterList = GroupSearchFilter[];
  10527. export type GroupsList = String[];
  10528. export interface GrowthRateComputation {
  10529. /**
  10530. * The ID for a computation.
  10531. */
  10532. ComputationId: ShortRestrictiveResourceId;
  10533. /**
  10534. * The name of a computation.
  10535. */
  10536. Name?: String;
  10537. /**
  10538. * The time field that is used in a computation.
  10539. */
  10540. Time?: DimensionField;
  10541. /**
  10542. * The value field that is used in a computation.
  10543. */
  10544. Value?: MeasureField;
  10545. /**
  10546. * The period size setup of a growth rate computation.
  10547. */
  10548. PeriodSize?: GrowthRatePeriodSize;
  10549. }
  10550. export type GrowthRatePeriodSize = number;
  10551. export interface GutterStyle {
  10552. /**
  10553. * This Boolean value controls whether to display a gutter space between sheet tiles.
  10554. */
  10555. Show?: Boolean;
  10556. }
  10557. export interface HeaderFooterSectionConfiguration {
  10558. /**
  10559. * The unique identifier of the header or footer section.
  10560. */
  10561. SectionId: ShortRestrictiveResourceId;
  10562. /**
  10563. * The layout configuration of the header or footer section.
  10564. */
  10565. Layout: SectionLayoutConfiguration;
  10566. /**
  10567. * The style options of a header or footer section.
  10568. */
  10569. Style?: SectionStyle;
  10570. }
  10571. export type HeaderFooterSectionConfigurationList = HeaderFooterSectionConfiguration[];
  10572. export interface HeatMapAggregatedFieldWells {
  10573. /**
  10574. * The rows field well of a heat map.
  10575. */
  10576. Rows?: HeatMapDimensionFieldList;
  10577. /**
  10578. * The columns field well of a heat map.
  10579. */
  10580. Columns?: HeatMapDimensionFieldList;
  10581. /**
  10582. * The values field well of a heat map.
  10583. */
  10584. Values?: HeatMapMeasureFieldList;
  10585. }
  10586. export interface HeatMapConfiguration {
  10587. /**
  10588. * The field wells of the visual.
  10589. */
  10590. FieldWells?: HeatMapFieldWells;
  10591. /**
  10592. * The sort configuration of a heat map.
  10593. */
  10594. SortConfiguration?: HeatMapSortConfiguration;
  10595. /**
  10596. * The label options of the row that is displayed in a heat map.
  10597. */
  10598. RowLabelOptions?: ChartAxisLabelOptions;
  10599. /**
  10600. * The label options of the column that is displayed in a heat map.
  10601. */
  10602. ColumnLabelOptions?: ChartAxisLabelOptions;
  10603. /**
  10604. * The color options (gradient color, point of divergence) in a heat map.
  10605. */
  10606. ColorScale?: ColorScale;
  10607. /**
  10608. * The legend display setup of the visual.
  10609. */
  10610. Legend?: LegendOptions;
  10611. /**
  10612. * The options that determine if visual data labels are displayed.
  10613. */
  10614. DataLabels?: DataLabelOptions;
  10615. /**
  10616. * The tooltip display setup of the visual.
  10617. */
  10618. Tooltip?: TooltipOptions;
  10619. /**
  10620. * The general visual interactions setup for a visual.
  10621. */
  10622. Interactions?: VisualInteractionOptions;
  10623. }
  10624. export type HeatMapDimensionFieldList = DimensionField[];
  10625. export interface HeatMapFieldWells {
  10626. /**
  10627. * The aggregated field wells of a heat map.
  10628. */
  10629. HeatMapAggregatedFieldWells?: HeatMapAggregatedFieldWells;
  10630. }
  10631. export type HeatMapMeasureFieldList = MeasureField[];
  10632. export interface HeatMapSortConfiguration {
  10633. /**
  10634. * The field sort configuration of the rows fields.
  10635. */
  10636. HeatMapRowSort?: FieldSortOptionsList;
  10637. /**
  10638. * The column sort configuration for heat map for columns that aren't a part of a field well.
  10639. */
  10640. HeatMapColumnSort?: FieldSortOptionsList;
  10641. /**
  10642. * The limit on the number of rows that are displayed in a heat map.
  10643. */
  10644. HeatMapRowItemsLimitConfiguration?: ItemsLimitConfiguration;
  10645. /**
  10646. * The limit on the number of columns that are displayed in a heat map.
  10647. */
  10648. HeatMapColumnItemsLimitConfiguration?: ItemsLimitConfiguration;
  10649. }
  10650. export interface HeatMapVisual {
  10651. /**
  10652. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  10653. */
  10654. VisualId: ShortRestrictiveResourceId;
  10655. /**
  10656. * The title that is displayed on the visual.
  10657. */
  10658. Title?: VisualTitleLabelOptions;
  10659. /**
  10660. * The subtitle that is displayed on the visual.
  10661. */
  10662. Subtitle?: VisualSubtitleLabelOptions;
  10663. /**
  10664. * The configuration of a heat map.
  10665. */
  10666. ChartConfiguration?: HeatMapConfiguration;
  10667. /**
  10668. * The column hierarchy that is used during drill-downs and drill-ups.
  10669. */
  10670. ColumnHierarchies?: ColumnHierarchyList;
  10671. /**
  10672. * The list of custom actions that are configured for a visual.
  10673. */
  10674. Actions?: VisualCustomActionList;
  10675. }
  10676. export type HexColor = string;
  10677. export type HexColorWithTransparency = string;
  10678. export type HierarchyId = string;
  10679. export interface HistogramAggregatedFieldWells {
  10680. /**
  10681. * The value field wells of a histogram. Values are aggregated by COUNT or DISTINCT_COUNT.
  10682. */
  10683. Values?: HistogramMeasureFieldList;
  10684. }
  10685. export interface HistogramBinOptions {
  10686. /**
  10687. * The options that determine the selected bin type.
  10688. */
  10689. SelectedBinType?: HistogramBinType;
  10690. /**
  10691. * The options that determine the bin count of a histogram.
  10692. */
  10693. BinCount?: BinCountOptions;
  10694. /**
  10695. * The options that determine the bin width of a histogram.
  10696. */
  10697. BinWidth?: BinWidthOptions;
  10698. /**
  10699. * The options that determine the bin start value.
  10700. */
  10701. StartValue?: Double;
  10702. }
  10703. export type HistogramBinType = "BIN_COUNT"|"BIN_WIDTH"|string;
  10704. export interface HistogramConfiguration {
  10705. /**
  10706. * The field well configuration of a histogram.
  10707. */
  10708. FieldWells?: HistogramFieldWells;
  10709. /**
  10710. * The options that determine the presentation of the x-axis.
  10711. */
  10712. XAxisDisplayOptions?: AxisDisplayOptions;
  10713. /**
  10714. * The options that determine the presentation of the x-axis label.
  10715. */
  10716. XAxisLabelOptions?: ChartAxisLabelOptions;
  10717. /**
  10718. * The options that determine the presentation of the y-axis.
  10719. */
  10720. YAxisDisplayOptions?: AxisDisplayOptions;
  10721. /**
  10722. * The options that determine the presentation of histogram bins.
  10723. */
  10724. BinOptions?: HistogramBinOptions;
  10725. /**
  10726. * The data label configuration of a histogram.
  10727. */
  10728. DataLabels?: DataLabelOptions;
  10729. /**
  10730. * The tooltip configuration of a histogram.
  10731. */
  10732. Tooltip?: TooltipOptions;
  10733. /**
  10734. * The visual palette configuration of a histogram.
  10735. */
  10736. VisualPalette?: VisualPalette;
  10737. /**
  10738. * The general visual interactions setup for a visual.
  10739. */
  10740. Interactions?: VisualInteractionOptions;
  10741. }
  10742. export interface HistogramFieldWells {
  10743. /**
  10744. * The field well configuration of a histogram.
  10745. */
  10746. HistogramAggregatedFieldWells?: HistogramAggregatedFieldWells;
  10747. }
  10748. export type HistogramMeasureFieldList = MeasureField[];
  10749. export interface HistogramVisual {
  10750. /**
  10751. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  10752. */
  10753. VisualId: ShortRestrictiveResourceId;
  10754. /**
  10755. * The title that is displayed on the visual.
  10756. */
  10757. Title?: VisualTitleLabelOptions;
  10758. /**
  10759. * The subtitle that is displayed on the visual.
  10760. */
  10761. Subtitle?: VisualSubtitleLabelOptions;
  10762. /**
  10763. * The configuration for a HistogramVisual.
  10764. */
  10765. ChartConfiguration?: HistogramConfiguration;
  10766. /**
  10767. * The list of custom actions that are configured for a visual.
  10768. */
  10769. Actions?: VisualCustomActionList;
  10770. }
  10771. export type HorizontalTextAlignment = "LEFT"|"CENTER"|"RIGHT"|"AUTO"|string;
  10772. export type Host = string;
  10773. export interface IAMPolicyAssignment {
  10774. /**
  10775. * The Amazon Web Services account ID.
  10776. */
  10777. AwsAccountId?: AwsAccountId;
  10778. /**
  10779. * Assignment ID.
  10780. */
  10781. AssignmentId?: String;
  10782. /**
  10783. * Assignment name.
  10784. */
  10785. AssignmentName?: IAMPolicyAssignmentName;
  10786. /**
  10787. * The Amazon Resource Name (ARN) for the IAM policy.
  10788. */
  10789. PolicyArn?: Arn;
  10790. /**
  10791. * Identities.
  10792. */
  10793. Identities?: IdentityMap;
  10794. /**
  10795. * Assignment status.
  10796. */
  10797. AssignmentStatus?: AssignmentStatus;
  10798. }
  10799. export type IAMPolicyAssignmentName = string;
  10800. export interface IAMPolicyAssignmentSummary {
  10801. /**
  10802. * Assignment name.
  10803. */
  10804. AssignmentName?: IAMPolicyAssignmentName;
  10805. /**
  10806. * Assignment status.
  10807. */
  10808. AssignmentStatus?: AssignmentStatus;
  10809. }
  10810. export type IAMPolicyAssignmentSummaryList = IAMPolicyAssignmentSummary[];
  10811. export type IPv4Address = string;
  10812. export type Icon = "CARET_UP"|"CARET_DOWN"|"PLUS"|"MINUS"|"ARROW_UP"|"ARROW_DOWN"|"ARROW_LEFT"|"ARROW_UP_LEFT"|"ARROW_DOWN_LEFT"|"ARROW_RIGHT"|"ARROW_UP_RIGHT"|"ARROW_DOWN_RIGHT"|"FACE_UP"|"FACE_DOWN"|"FACE_FLAT"|"ONE_BAR"|"TWO_BAR"|"THREE_BAR"|"CIRCLE"|"TRIANGLE"|"SQUARE"|"FLAG"|"THUMBS_UP"|"THUMBS_DOWN"|"CHECKMARK"|"X"|string;
  10813. export interface IdentityCenterConfiguration {
  10814. /**
  10815. * A Boolean option that controls whether Trusted Identity Propagation should be used.
  10816. */
  10817. EnableIdentityPropagation?: Boolean;
  10818. }
  10819. export type IdentityMap = {[key: string]: IdentityNameList};
  10820. export type IdentityName = string;
  10821. export type IdentityNameList = IdentityName[];
  10822. export type IdentityStore = "QUICKSIGHT"|string;
  10823. export type IdentityType = "IAM"|"QUICKSIGHT"|"IAM_IDENTITY_CENTER"|string;
  10824. export interface IncrementalRefresh {
  10825. /**
  10826. * The lookback window setup for an incremental refresh configuration.
  10827. */
  10828. LookbackWindow: LookbackWindow;
  10829. }
  10830. export interface Ingestion {
  10831. /**
  10832. * The Amazon Resource Name (ARN) of the resource.
  10833. */
  10834. Arn: Arn;
  10835. /**
  10836. * Ingestion ID.
  10837. */
  10838. IngestionId?: IngestionId;
  10839. /**
  10840. * Ingestion status.
  10841. */
  10842. IngestionStatus: IngestionStatus;
  10843. /**
  10844. * Error information for this ingestion.
  10845. */
  10846. ErrorInfo?: ErrorInfo;
  10847. RowInfo?: RowInfo;
  10848. QueueInfo?: QueueInfo;
  10849. /**
  10850. * The time that this ingestion started.
  10851. */
  10852. CreatedTime: Timestamp;
  10853. /**
  10854. * The time that this ingestion took, measured in seconds.
  10855. */
  10856. IngestionTimeInSeconds?: Long;
  10857. /**
  10858. * The size of the data ingested, in bytes.
  10859. */
  10860. IngestionSizeInBytes?: Long;
  10861. /**
  10862. * Event source for this ingestion.
  10863. */
  10864. RequestSource?: IngestionRequestSource;
  10865. /**
  10866. * Type of this ingestion.
  10867. */
  10868. RequestType?: IngestionRequestType;
  10869. }
  10870. export type IngestionErrorType = "FAILURE_TO_ASSUME_ROLE"|"INGESTION_SUPERSEDED"|"INGESTION_CANCELED"|"DATA_SET_DELETED"|"DATA_SET_NOT_SPICE"|"S3_UPLOADED_FILE_DELETED"|"S3_MANIFEST_ERROR"|"DATA_TOLERANCE_EXCEPTION"|"SPICE_TABLE_NOT_FOUND"|"DATA_SET_SIZE_LIMIT_EXCEEDED"|"ROW_SIZE_LIMIT_EXCEEDED"|"ACCOUNT_CAPACITY_LIMIT_EXCEEDED"|"CUSTOMER_ERROR"|"DATA_SOURCE_NOT_FOUND"|"IAM_ROLE_NOT_AVAILABLE"|"CONNECTION_FAILURE"|"SQL_TABLE_NOT_FOUND"|"PERMISSION_DENIED"|"SSL_CERTIFICATE_VALIDATION_FAILURE"|"OAUTH_TOKEN_FAILURE"|"SOURCE_API_LIMIT_EXCEEDED_FAILURE"|"PASSWORD_AUTHENTICATION_FAILURE"|"SQL_SCHEMA_MISMATCH_ERROR"|"INVALID_DATE_FORMAT"|"INVALID_DATAPREP_SYNTAX"|"SOURCE_RESOURCE_LIMIT_EXCEEDED"|"SQL_INVALID_PARAMETER_VALUE"|"QUERY_TIMEOUT"|"SQL_NUMERIC_OVERFLOW"|"UNRESOLVABLE_HOST"|"UNROUTABLE_HOST"|"SQL_EXCEPTION"|"S3_FILE_INACCESSIBLE"|"IOT_FILE_NOT_FOUND"|"IOT_DATA_SET_FILE_EMPTY"|"INVALID_DATA_SOURCE_CONFIG"|"DATA_SOURCE_AUTH_FAILED"|"DATA_SOURCE_CONNECTION_FAILED"|"FAILURE_TO_PROCESS_JSON_FILE"|"INTERNAL_SERVICE_ERROR"|"REFRESH_SUPPRESSED_BY_EDIT"|"PERMISSION_NOT_FOUND"|"ELASTICSEARCH_CURSOR_NOT_ENABLED"|"CURSOR_NOT_ENABLED"|"DUPLICATE_COLUMN_NAMES_FOUND"|string;
  10871. export type IngestionId = string;
  10872. export type IngestionMaxResults = number;
  10873. export type IngestionRequestSource = "MANUAL"|"SCHEDULED"|string;
  10874. export type IngestionRequestType = "INITIAL_INGESTION"|"EDIT"|"INCREMENTAL_REFRESH"|"FULL_REFRESH"|string;
  10875. export type IngestionStatus = "INITIALIZED"|"QUEUED"|"RUNNING"|"FAILED"|"COMPLETED"|"CANCELLED"|string;
  10876. export type IngestionType = "INCREMENTAL_REFRESH"|"FULL_REFRESH"|string;
  10877. export type Ingestions = Ingestion[];
  10878. export interface InputColumn {
  10879. /**
  10880. * The name of this column in the underlying data source.
  10881. */
  10882. Name: ColumnName;
  10883. /**
  10884. * The data type of the column.
  10885. */
  10886. Type: InputColumnDataType;
  10887. /**
  10888. * The sub data type of the column. Sub types are only available for decimal columns that are part of a SPICE dataset.
  10889. */
  10890. SubType?: ColumnDataSubType;
  10891. }
  10892. export type InputColumnDataType = "STRING"|"INTEGER"|"DECIMAL"|"DATETIME"|"BIT"|"BOOLEAN"|"JSON"|string;
  10893. export type InputColumnList = InputColumn[];
  10894. export interface InsightConfiguration {
  10895. /**
  10896. * The computations configurations of the insight visual
  10897. */
  10898. Computations?: ComputationList;
  10899. /**
  10900. * The custom narrative of the insight visual.
  10901. */
  10902. CustomNarrative?: CustomNarrativeOptions;
  10903. /**
  10904. * The general visual interactions setup for a visual.
  10905. */
  10906. Interactions?: VisualInteractionOptions;
  10907. }
  10908. export interface InsightVisual {
  10909. /**
  10910. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  10911. */
  10912. VisualId: ShortRestrictiveResourceId;
  10913. /**
  10914. * The title that is displayed on the visual.
  10915. */
  10916. Title?: VisualTitleLabelOptions;
  10917. /**
  10918. * The subtitle that is displayed on the visual.
  10919. */
  10920. Subtitle?: VisualSubtitleLabelOptions;
  10921. /**
  10922. * The configuration of an insight visual.
  10923. */
  10924. InsightConfiguration?: InsightConfiguration;
  10925. /**
  10926. * The list of custom actions that are configured for a visual.
  10927. */
  10928. Actions?: VisualCustomActionList;
  10929. /**
  10930. * The dataset that is used in the insight visual.
  10931. */
  10932. DataSetIdentifier: DataSetIdentifier;
  10933. }
  10934. export type InstanceId = string;
  10935. export type Integer = number;
  10936. export interface IntegerDatasetParameter {
  10937. /**
  10938. * An identifier for the integer parameter created in the dataset.
  10939. */
  10940. Id: DatasetParameterId;
  10941. /**
  10942. * The name of the integer parameter that is created in the dataset.
  10943. */
  10944. Name: DatasetParameterName;
  10945. /**
  10946. * The value type of the dataset parameter. Valid values are single value or multi value.
  10947. */
  10948. ValueType: DatasetParameterValueType;
  10949. /**
  10950. * A list of default values for a given integer parameter. This structure only accepts static values.
  10951. */
  10952. DefaultValues?: IntegerDatasetParameterDefaultValues;
  10953. }
  10954. export type IntegerDatasetParameterDefaultValue = number;
  10955. export interface IntegerDatasetParameterDefaultValues {
  10956. /**
  10957. * A list of static default values for a given integer parameter.
  10958. */
  10959. StaticValues?: IntegerDatasetParameterValueList;
  10960. }
  10961. export type IntegerDatasetParameterValueList = IntegerDatasetParameterDefaultValue[];
  10962. export type IntegerDefaultValueList = SensitiveLongObject[];
  10963. export interface IntegerDefaultValues {
  10964. /**
  10965. * The dynamic value of the IntegerDefaultValues. Different defaults are displayed according to users, groups, and values mapping.
  10966. */
  10967. DynamicValue?: DynamicDefaultValue;
  10968. /**
  10969. * The static values of the IntegerDefaultValues.
  10970. */
  10971. StaticValues?: IntegerDefaultValueList;
  10972. }
  10973. export interface IntegerParameter {
  10974. /**
  10975. * The name of the integer parameter.
  10976. */
  10977. Name: NonEmptyString;
  10978. /**
  10979. * The values for the integer parameter.
  10980. */
  10981. Values: SensitiveLongList;
  10982. }
  10983. export interface IntegerParameterDeclaration {
  10984. /**
  10985. * The value type determines whether the parameter is a single-value or multi-value parameter.
  10986. */
  10987. ParameterValueType: ParameterValueType;
  10988. /**
  10989. * The name of the parameter that is being declared.
  10990. */
  10991. Name: ParameterName;
  10992. /**
  10993. * The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
  10994. */
  10995. DefaultValues?: IntegerDefaultValues;
  10996. /**
  10997. * A parameter declaration for the Integer data type.
  10998. */
  10999. ValueWhenUnset?: IntegerValueWhenUnsetConfiguration;
  11000. MappedDataSetParameters?: MappedDataSetParameters;
  11001. }
  11002. export type IntegerParameterList = IntegerParameter[];
  11003. export interface IntegerValueWhenUnsetConfiguration {
  11004. /**
  11005. * The built-in options for default values. The value can be one of the following: RECOMMENDED: The recommended value. NULL: The NULL value.
  11006. */
  11007. ValueWhenUnsetOption?: ValueWhenUnsetOption;
  11008. /**
  11009. * A custom value that's used when the value of a parameter isn't set.
  11010. */
  11011. CustomValue?: SensitiveLong;
  11012. }
  11013. export type IpRestrictionRuleDescription = string;
  11014. export type IpRestrictionRuleMap = {[key: string]: IpRestrictionRuleDescription};
  11015. export interface ItemsLimitConfiguration {
  11016. /**
  11017. * The limit on how many items of a field are showed in the chart. For example, the number of slices that are displayed in a pie chart.
  11018. */
  11019. ItemsLimit?: Long;
  11020. /**
  11021. * The Show other of an axis in the chart. Choose one of the following options: INCLUDE EXCLUDE
  11022. */
  11023. OtherCategories?: OtherCategories;
  11024. }
  11025. export interface JiraParameters {
  11026. /**
  11027. * The base URL of the Jira site.
  11028. */
  11029. SiteBaseUrl: SiteBaseUrl;
  11030. }
  11031. export interface JoinInstruction {
  11032. /**
  11033. * The operand on the left side of a join.
  11034. */
  11035. LeftOperand: LogicalTableId;
  11036. /**
  11037. * The operand on the right side of a join.
  11038. */
  11039. RightOperand: LogicalTableId;
  11040. /**
  11041. * Join key properties of the left operand.
  11042. */
  11043. LeftJoinKeyProperties?: JoinKeyProperties;
  11044. /**
  11045. * Join key properties of the right operand.
  11046. */
  11047. RightJoinKeyProperties?: JoinKeyProperties;
  11048. /**
  11049. * The type of join that it is.
  11050. */
  11051. Type: JoinType;
  11052. /**
  11053. * The join instructions provided in the ON clause of a join.
  11054. */
  11055. OnClause: OnClause;
  11056. }
  11057. export interface JoinKeyProperties {
  11058. /**
  11059. * A value that indicates that a row in a table is uniquely identified by the columns in a join key. This is used by Amazon QuickSight to optimize query performance.
  11060. */
  11061. UniqueKey?: Boolean;
  11062. }
  11063. export type JoinType = "INNER"|"OUTER"|"LEFT"|"RIGHT"|string;
  11064. export interface KPIActualValueConditionalFormatting {
  11065. /**
  11066. * The conditional formatting of the actual value's text color.
  11067. */
  11068. TextColor?: ConditionalFormattingColor;
  11069. /**
  11070. * The conditional formatting of the actual value's icon.
  11071. */
  11072. Icon?: ConditionalFormattingIcon;
  11073. }
  11074. export interface KPIComparisonValueConditionalFormatting {
  11075. /**
  11076. * The conditional formatting of the comparison value's text color.
  11077. */
  11078. TextColor?: ConditionalFormattingColor;
  11079. /**
  11080. * The conditional formatting of the comparison value's icon.
  11081. */
  11082. Icon?: ConditionalFormattingIcon;
  11083. }
  11084. export interface KPIConditionalFormatting {
  11085. /**
  11086. * The conditional formatting options of a KPI visual.
  11087. */
  11088. ConditionalFormattingOptions?: KPIConditionalFormattingOptionList;
  11089. }
  11090. export interface KPIConditionalFormattingOption {
  11091. /**
  11092. * The conditional formatting for the primary value of a KPI visual.
  11093. */
  11094. PrimaryValue?: KPIPrimaryValueConditionalFormatting;
  11095. /**
  11096. * The conditional formatting for the progress bar of a KPI visual.
  11097. */
  11098. ProgressBar?: KPIProgressBarConditionalFormatting;
  11099. /**
  11100. * The conditional formatting for the actual value of a KPI visual.
  11101. */
  11102. ActualValue?: KPIActualValueConditionalFormatting;
  11103. /**
  11104. * The conditional formatting for the comparison value of a KPI visual.
  11105. */
  11106. ComparisonValue?: KPIComparisonValueConditionalFormatting;
  11107. }
  11108. export type KPIConditionalFormattingOptionList = KPIConditionalFormattingOption[];
  11109. export interface KPIConfiguration {
  11110. /**
  11111. * The field well configuration of a KPI visual.
  11112. */
  11113. FieldWells?: KPIFieldWells;
  11114. /**
  11115. * The sort configuration of a KPI visual.
  11116. */
  11117. SortConfiguration?: KPISortConfiguration;
  11118. /**
  11119. * The options that determine the presentation of a KPI visual.
  11120. */
  11121. KPIOptions?: KPIOptions;
  11122. /**
  11123. * The general visual interactions setup for a visual.
  11124. */
  11125. Interactions?: VisualInteractionOptions;
  11126. }
  11127. export interface KPIFieldWells {
  11128. /**
  11129. * The value field wells of a KPI visual.
  11130. */
  11131. Values?: MeasureFieldList;
  11132. /**
  11133. * The target value field wells of a KPI visual.
  11134. */
  11135. TargetValues?: MeasureFieldList;
  11136. /**
  11137. * The trend group field wells of a KPI visual.
  11138. */
  11139. TrendGroups?: DimensionFieldList;
  11140. }
  11141. export interface KPIOptions {
  11142. /**
  11143. * The options that determine the presentation of the progress bar of a KPI visual.
  11144. */
  11145. ProgressBar?: ProgressBarOptions;
  11146. /**
  11147. * The options that determine the presentation of trend arrows in a KPI visual.
  11148. */
  11149. TrendArrows?: TrendArrowOptions;
  11150. /**
  11151. * The options that determine the presentation of the secondary value of a KPI visual.
  11152. */
  11153. SecondaryValue?: SecondaryValueOptions;
  11154. /**
  11155. * The comparison configuration of a KPI visual.
  11156. */
  11157. Comparison?: ComparisonConfiguration;
  11158. /**
  11159. * The options that determine the primary value display type.
  11160. */
  11161. PrimaryValueDisplayType?: PrimaryValueDisplayType;
  11162. /**
  11163. * The options that determine the primary value font configuration.
  11164. */
  11165. PrimaryValueFontConfiguration?: FontConfiguration;
  11166. /**
  11167. * The options that determine the secondary value font configuration.
  11168. */
  11169. SecondaryValueFontConfiguration?: FontConfiguration;
  11170. /**
  11171. * The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.
  11172. */
  11173. Sparkline?: KPISparklineOptions;
  11174. /**
  11175. * The options that determine the layout a KPI visual.
  11176. */
  11177. VisualLayoutOptions?: KPIVisualLayoutOptions;
  11178. }
  11179. export interface KPIPrimaryValueConditionalFormatting {
  11180. /**
  11181. * The conditional formatting of the primary value's text color.
  11182. */
  11183. TextColor?: ConditionalFormattingColor;
  11184. /**
  11185. * The conditional formatting of the primary value's icon.
  11186. */
  11187. Icon?: ConditionalFormattingIcon;
  11188. }
  11189. export interface KPIProgressBarConditionalFormatting {
  11190. /**
  11191. * The conditional formatting of the progress bar's foreground color.
  11192. */
  11193. ForegroundColor?: ConditionalFormattingColor;
  11194. }
  11195. export interface KPISortConfiguration {
  11196. /**
  11197. * The sort configuration of the trend group fields.
  11198. */
  11199. TrendGroupSort?: FieldSortOptionsList;
  11200. }
  11201. export interface KPISparklineOptions {
  11202. /**
  11203. * The visibility of the sparkline.
  11204. */
  11205. Visibility?: Visibility;
  11206. /**
  11207. * The type of the sparkline.
  11208. */
  11209. Type: KPISparklineType;
  11210. /**
  11211. * The color of the sparkline.
  11212. */
  11213. Color?: HexColor;
  11214. /**
  11215. * The tooltip visibility of the sparkline.
  11216. */
  11217. TooltipVisibility?: Visibility;
  11218. }
  11219. export type KPISparklineType = "LINE"|"AREA"|string;
  11220. export interface KPIVisual {
  11221. /**
  11222. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  11223. */
  11224. VisualId: ShortRestrictiveResourceId;
  11225. /**
  11226. * The title that is displayed on the visual.
  11227. */
  11228. Title?: VisualTitleLabelOptions;
  11229. /**
  11230. * The subtitle that is displayed on the visual.
  11231. */
  11232. Subtitle?: VisualSubtitleLabelOptions;
  11233. /**
  11234. * The configuration of a KPI visual.
  11235. */
  11236. ChartConfiguration?: KPIConfiguration;
  11237. /**
  11238. * The conditional formatting of a KPI visual.
  11239. */
  11240. ConditionalFormatting?: KPIConditionalFormatting;
  11241. /**
  11242. * The list of custom actions that are configured for a visual.
  11243. */
  11244. Actions?: VisualCustomActionList;
  11245. /**
  11246. * The column hierarchy that is used during drill-downs and drill-ups.
  11247. */
  11248. ColumnHierarchies?: ColumnHierarchyList;
  11249. }
  11250. export interface KPIVisualLayoutOptions {
  11251. /**
  11252. * The standard layout of the KPI visual.
  11253. */
  11254. StandardLayout?: KPIVisualStandardLayout;
  11255. }
  11256. export interface KPIVisualStandardLayout {
  11257. /**
  11258. * The standard layout type.
  11259. */
  11260. Type: KPIVisualStandardLayoutType;
  11261. }
  11262. export type KPIVisualStandardLayoutType = "CLASSIC"|"VERTICAL"|string;
  11263. export interface LabelOptions {
  11264. /**
  11265. * Determines whether or not the label is visible.
  11266. */
  11267. Visibility?: Visibility;
  11268. /**
  11269. * The font configuration of the label.
  11270. */
  11271. FontConfiguration?: FontConfiguration;
  11272. /**
  11273. * The text for the label.
  11274. */
  11275. CustomLabel?: String;
  11276. }
  11277. export type Latitude = number;
  11278. export interface Layout {
  11279. /**
  11280. * The configuration that determines what the type of layout for a sheet.
  11281. */
  11282. Configuration: LayoutConfiguration;
  11283. }
  11284. export interface LayoutConfiguration {
  11285. /**
  11286. * A type of layout that can be used on a sheet. In a grid layout, visuals snap to a grid with standard spacing and alignment. Dashboards are displayed as designed, with options to fit to screen or view at actual size. A grid layout can be configured to behave in one of two ways when the viewport is resized: FIXED or RESPONSIVE.
  11287. */
  11288. GridLayout?: GridLayoutConfiguration;
  11289. /**
  11290. * A free-form is optimized for a fixed width and has more control over the exact placement of layout elements.
  11291. */
  11292. FreeFormLayout?: FreeFormLayoutConfiguration;
  11293. /**
  11294. * A section based layout organizes visuals into multiple sections and has customized header, footer and page break.
  11295. */
  11296. SectionBasedLayout?: SectionBasedLayoutConfiguration;
  11297. }
  11298. export type LayoutElementType = "VISUAL"|"FILTER_CONTROL"|"PARAMETER_CONTROL"|"TEXT_BOX"|string;
  11299. export type LayoutList = Layout[];
  11300. export interface LegendOptions {
  11301. /**
  11302. * Determines whether or not the legend is visible.
  11303. */
  11304. Visibility?: Visibility;
  11305. /**
  11306. * The custom title for the legend.
  11307. */
  11308. Title?: LabelOptions;
  11309. /**
  11310. * The positions for the legend. Choose one of the following options: AUTO RIGHT BOTTOM LEFT
  11311. */
  11312. Position?: LegendPosition;
  11313. /**
  11314. * The width of the legend. If this value is omitted, a default width is used when rendering.
  11315. */
  11316. Width?: PixelLength;
  11317. /**
  11318. * The height of the legend. If this value is omitted, a default height is used when rendering.
  11319. */
  11320. Height?: PixelLength;
  11321. }
  11322. export type LegendPosition = "AUTO"|"RIGHT"|"BOTTOM"|"TOP"|string;
  11323. export type Length = string;
  11324. export type LimitedString = string;
  11325. export interface LineChartAggregatedFieldWells {
  11326. /**
  11327. * The category field wells of a line chart. Values are grouped by category fields.
  11328. */
  11329. Category?: DimensionFieldList;
  11330. /**
  11331. * The value field wells of a line chart. Values are aggregated based on categories.
  11332. */
  11333. Values?: MeasureFieldList;
  11334. /**
  11335. * The color field wells of a line chart. Values are grouped by category fields.
  11336. */
  11337. Colors?: DimensionFieldList;
  11338. /**
  11339. * The small multiples field well of a line chart.
  11340. */
  11341. SmallMultiples?: SmallMultiplesDimensionFieldList;
  11342. }
  11343. export interface LineChartConfiguration {
  11344. /**
  11345. * The field well configuration of a line chart.
  11346. */
  11347. FieldWells?: LineChartFieldWells;
  11348. /**
  11349. * The sort configuration of a line chart.
  11350. */
  11351. SortConfiguration?: LineChartSortConfiguration;
  11352. /**
  11353. * The forecast configuration of a line chart.
  11354. */
  11355. ForecastConfigurations?: ForecastConfigurationList;
  11356. /**
  11357. * Determines the type of the line chart.
  11358. */
  11359. Type?: LineChartType;
  11360. /**
  11361. * The small multiples setup for the visual.
  11362. */
  11363. SmallMultiplesOptions?: SmallMultiplesOptions;
  11364. /**
  11365. * The options that determine the presentation of the x-axis.
  11366. */
  11367. XAxisDisplayOptions?: AxisDisplayOptions;
  11368. /**
  11369. * The options that determine the presentation of the x-axis label.
  11370. */
  11371. XAxisLabelOptions?: ChartAxisLabelOptions;
  11372. /**
  11373. * The series axis configuration of a line chart.
  11374. */
  11375. PrimaryYAxisDisplayOptions?: LineSeriesAxisDisplayOptions;
  11376. /**
  11377. * The options that determine the presentation of the y-axis label.
  11378. */
  11379. PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
  11380. /**
  11381. * The series axis configuration of a line chart.
  11382. */
  11383. SecondaryYAxisDisplayOptions?: LineSeriesAxisDisplayOptions;
  11384. /**
  11385. * The options that determine the presentation of the secondary y-axis label.
  11386. */
  11387. SecondaryYAxisLabelOptions?: ChartAxisLabelOptions;
  11388. SingleAxisOptions?: SingleAxisOptions;
  11389. /**
  11390. * The options that determine the default presentation of all line series in LineChartVisual.
  11391. */
  11392. DefaultSeriesSettings?: LineChartDefaultSeriesSettings;
  11393. /**
  11394. * The series item configuration of a line chart.
  11395. */
  11396. Series?: SeriesItemList;
  11397. /**
  11398. * The legend configuration of a line chart.
  11399. */
  11400. Legend?: LegendOptions;
  11401. /**
  11402. * The data label configuration of a line chart.
  11403. */
  11404. DataLabels?: DataLabelOptions;
  11405. /**
  11406. * The reference lines configuration of a line chart.
  11407. */
  11408. ReferenceLines?: ReferenceLineList;
  11409. /**
  11410. * The tooltip configuration of a line chart.
  11411. */
  11412. Tooltip?: TooltipOptions;
  11413. /**
  11414. * The default configuration of a line chart's contribution analysis.
  11415. */
  11416. ContributionAnalysisDefaults?: ContributionAnalysisDefaultList;
  11417. /**
  11418. * The visual palette configuration of a line chart.
  11419. */
  11420. VisualPalette?: VisualPalette;
  11421. /**
  11422. * The general visual interactions setup for a visual.
  11423. */
  11424. Interactions?: VisualInteractionOptions;
  11425. }
  11426. export interface LineChartDefaultSeriesSettings {
  11427. /**
  11428. * The axis to which you are binding all line series to.
  11429. */
  11430. AxisBinding?: AxisBinding;
  11431. /**
  11432. * Line styles options for all line series in the visual.
  11433. */
  11434. LineStyleSettings?: LineChartLineStyleSettings;
  11435. /**
  11436. * Marker styles options for all line series in the visual.
  11437. */
  11438. MarkerStyleSettings?: LineChartMarkerStyleSettings;
  11439. }
  11440. export interface LineChartFieldWells {
  11441. /**
  11442. * The field well configuration of a line chart.
  11443. */
  11444. LineChartAggregatedFieldWells?: LineChartAggregatedFieldWells;
  11445. }
  11446. export type LineChartLineStyle = "SOLID"|"DOTTED"|"DASHED"|string;
  11447. export interface LineChartLineStyleSettings {
  11448. /**
  11449. * Configuration option that determines whether to show the line for the series.
  11450. */
  11451. LineVisibility?: Visibility;
  11452. /**
  11453. * Interpolation style for line series. LINEAR: Show as default, linear style. SMOOTH: Show as a smooth curve. STEPPED: Show steps in line.
  11454. */
  11455. LineInterpolation?: LineInterpolation;
  11456. /**
  11457. * Line style for line series. SOLID: Show as a solid line. DOTTED: Show as a dotted line. DASHED: Show as a dashed line.
  11458. */
  11459. LineStyle?: LineChartLineStyle;
  11460. /**
  11461. * Width that determines the line thickness.
  11462. */
  11463. LineWidth?: PixelLength;
  11464. }
  11465. export type LineChartMarkerShape = "CIRCLE"|"TRIANGLE"|"SQUARE"|"DIAMOND"|"ROUNDED_SQUARE"|string;
  11466. export interface LineChartMarkerStyleSettings {
  11467. /**
  11468. * Configuration option that determines whether to show the markers in the series.
  11469. */
  11470. MarkerVisibility?: Visibility;
  11471. /**
  11472. * Shape option for markers in the series. CIRCLE: Show marker as a circle. TRIANGLE: Show marker as a triangle. SQUARE: Show marker as a square. DIAMOND: Show marker as a diamond. ROUNDED_SQUARE: Show marker as a rounded square.
  11473. */
  11474. MarkerShape?: LineChartMarkerShape;
  11475. /**
  11476. * Size of marker in the series.
  11477. */
  11478. MarkerSize?: PixelLength;
  11479. /**
  11480. * Color of marker in the series.
  11481. */
  11482. MarkerColor?: HexColor;
  11483. }
  11484. export interface LineChartSeriesSettings {
  11485. /**
  11486. * Line styles options for a line series in LineChartVisual.
  11487. */
  11488. LineStyleSettings?: LineChartLineStyleSettings;
  11489. /**
  11490. * Marker styles options for a line series in LineChartVisual.
  11491. */
  11492. MarkerStyleSettings?: LineChartMarkerStyleSettings;
  11493. }
  11494. export interface LineChartSortConfiguration {
  11495. /**
  11496. * The sort configuration of the category fields.
  11497. */
  11498. CategorySort?: FieldSortOptionsList;
  11499. /**
  11500. * The limit on the number of categories that are displayed in a line chart.
  11501. */
  11502. CategoryItemsLimitConfiguration?: ItemsLimitConfiguration;
  11503. /**
  11504. * The limit on the number of lines that are displayed in a line chart.
  11505. */
  11506. ColorItemsLimitConfiguration?: ItemsLimitConfiguration;
  11507. /**
  11508. * The sort configuration of the small multiples field.
  11509. */
  11510. SmallMultiplesSort?: FieldSortOptionsList;
  11511. /**
  11512. * The limit on the number of small multiples panels that are displayed.
  11513. */
  11514. SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration;
  11515. }
  11516. export type LineChartType = "LINE"|"AREA"|"STACKED_AREA"|string;
  11517. export interface LineChartVisual {
  11518. /**
  11519. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  11520. */
  11521. VisualId: ShortRestrictiveResourceId;
  11522. /**
  11523. * The title that is displayed on the visual.
  11524. */
  11525. Title?: VisualTitleLabelOptions;
  11526. /**
  11527. * The subtitle that is displayed on the visual.
  11528. */
  11529. Subtitle?: VisualSubtitleLabelOptions;
  11530. /**
  11531. * The configuration of a line chart.
  11532. */
  11533. ChartConfiguration?: LineChartConfiguration;
  11534. /**
  11535. * The list of custom actions that are configured for a visual.
  11536. */
  11537. Actions?: VisualCustomActionList;
  11538. /**
  11539. * The column hierarchy that is used during drill-downs and drill-ups.
  11540. */
  11541. ColumnHierarchies?: ColumnHierarchyList;
  11542. }
  11543. export type LineInterpolation = "LINEAR"|"SMOOTH"|"STEPPED"|string;
  11544. export interface LineSeriesAxisDisplayOptions {
  11545. /**
  11546. * The options that determine the presentation of the line series axis.
  11547. */
  11548. AxisOptions?: AxisDisplayOptions;
  11549. /**
  11550. * The configuration options that determine how missing data is treated during the rendering of a line chart.
  11551. */
  11552. MissingDataConfigurations?: MissingDataConfigurationList;
  11553. }
  11554. export type LinkEntityArn = string;
  11555. export type LinkEntityArnList = LinkEntityArn[];
  11556. export interface LinkSharingConfiguration {
  11557. /**
  11558. * A structure that contains the permissions of a shareable link.
  11559. */
  11560. Permissions?: ResourcePermissionList;
  11561. }
  11562. export interface ListAnalysesRequest {
  11563. /**
  11564. * The ID of the Amazon Web Services account that contains the analyses.
  11565. */
  11566. AwsAccountId: AwsAccountId;
  11567. /**
  11568. * A pagination token that can be used in a subsequent request.
  11569. */
  11570. NextToken?: String;
  11571. /**
  11572. * The maximum number of results to return.
  11573. */
  11574. MaxResults?: MaxResults;
  11575. }
  11576. export interface ListAnalysesResponse {
  11577. /**
  11578. * Metadata describing each of the analyses that are listed.
  11579. */
  11580. AnalysisSummaryList?: AnalysisSummaryList;
  11581. /**
  11582. * A pagination token that can be used in a subsequent request.
  11583. */
  11584. NextToken?: String;
  11585. /**
  11586. * The HTTP status of the request.
  11587. */
  11588. Status?: StatusCode;
  11589. /**
  11590. * The Amazon Web Services request ID for this operation.
  11591. */
  11592. RequestId?: String;
  11593. }
  11594. export interface ListAssetBundleExportJobsRequest {
  11595. /**
  11596. * The ID of the Amazon Web Services account that the export jobs were executed in.
  11597. */
  11598. AwsAccountId: AwsAccountId;
  11599. /**
  11600. * The token for the next set of results, or null if there are no more results.
  11601. */
  11602. NextToken?: String;
  11603. /**
  11604. * The maximum number of results to be returned per request.
  11605. */
  11606. MaxResults?: MaxResults;
  11607. }
  11608. export interface ListAssetBundleExportJobsResponse {
  11609. /**
  11610. * A list of export job summaries.
  11611. */
  11612. AssetBundleExportJobSummaryList?: AssetBundleExportJobSummaryList;
  11613. /**
  11614. * The token for the next set of results, or null if there are no more results.
  11615. */
  11616. NextToken?: String;
  11617. /**
  11618. * The Amazon Web Services request ID for this operation.
  11619. */
  11620. RequestId?: NonEmptyString;
  11621. /**
  11622. * The HTTP status of the request.
  11623. */
  11624. Status?: StatusCode;
  11625. }
  11626. export interface ListAssetBundleImportJobsRequest {
  11627. /**
  11628. * The ID of the Amazon Web Services account that the import jobs were executed in.
  11629. */
  11630. AwsAccountId: AwsAccountId;
  11631. /**
  11632. * The token for the next set of results, or null if there are no more results.
  11633. */
  11634. NextToken?: String;
  11635. /**
  11636. * The maximum number of results to be returned per request.
  11637. */
  11638. MaxResults?: MaxResults;
  11639. }
  11640. export interface ListAssetBundleImportJobsResponse {
  11641. /**
  11642. * A list of import job summaries.
  11643. */
  11644. AssetBundleImportJobSummaryList?: AssetBundleImportJobSummaryList;
  11645. /**
  11646. * The token for the next set of results, or null if there are no more results.
  11647. */
  11648. NextToken?: String;
  11649. /**
  11650. * The Amazon Web Services request ID for this operation.
  11651. */
  11652. RequestId?: NonEmptyString;
  11653. /**
  11654. * The HTTP status of the response.
  11655. */
  11656. Status?: StatusCode;
  11657. }
  11658. export interface ListControlDisplayOptions {
  11659. /**
  11660. * The configuration of the search options in a list control.
  11661. */
  11662. SearchOptions?: ListControlSearchOptions;
  11663. /**
  11664. * The configuration of the Select all options in a list control.
  11665. */
  11666. SelectAllOptions?: ListControlSelectAllOptions;
  11667. /**
  11668. * The options to configure the title visibility, name, and font size.
  11669. */
  11670. TitleOptions?: LabelOptions;
  11671. /**
  11672. * The configuration of info icon label options.
  11673. */
  11674. InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
  11675. }
  11676. export interface ListControlSearchOptions {
  11677. /**
  11678. * The visibility configuration of the search options in a list control.
  11679. */
  11680. Visibility?: Visibility;
  11681. }
  11682. export interface ListControlSelectAllOptions {
  11683. /**
  11684. * The visibility configuration of the Select all options in a list control.
  11685. */
  11686. Visibility?: Visibility;
  11687. }
  11688. export interface ListDashboardVersionsRequest {
  11689. /**
  11690. * The ID of the Amazon Web Services account that contains the dashboard that you're listing versions for.
  11691. */
  11692. AwsAccountId: AwsAccountId;
  11693. /**
  11694. * The ID for the dashboard.
  11695. */
  11696. DashboardId: ShortRestrictiveResourceId;
  11697. /**
  11698. * The token for the next set of results, or null if there are no more results.
  11699. */
  11700. NextToken?: String;
  11701. /**
  11702. * The maximum number of results to be returned per request.
  11703. */
  11704. MaxResults?: MaxResults;
  11705. }
  11706. export interface ListDashboardVersionsResponse {
  11707. /**
  11708. * A structure that contains information about each version of the dashboard.
  11709. */
  11710. DashboardVersionSummaryList?: DashboardVersionSummaryList;
  11711. /**
  11712. * The token for the next set of results, or null if there are no more results.
  11713. */
  11714. NextToken?: String;
  11715. /**
  11716. * The HTTP status of the request.
  11717. */
  11718. Status?: StatusCode;
  11719. /**
  11720. * The Amazon Web Services request ID for this operation.
  11721. */
  11722. RequestId?: String;
  11723. }
  11724. export interface ListDashboardsRequest {
  11725. /**
  11726. * The ID of the Amazon Web Services account that contains the dashboards that you're listing.
  11727. */
  11728. AwsAccountId: AwsAccountId;
  11729. /**
  11730. * The token for the next set of results, or null if there are no more results.
  11731. */
  11732. NextToken?: String;
  11733. /**
  11734. * The maximum number of results to be returned per request.
  11735. */
  11736. MaxResults?: MaxResults;
  11737. }
  11738. export interface ListDashboardsResponse {
  11739. /**
  11740. * A structure that contains all of the dashboards in your Amazon Web Services account. This structure provides basic information about the dashboards.
  11741. */
  11742. DashboardSummaryList?: DashboardSummaryList;
  11743. /**
  11744. * The token for the next set of results, or null if there are no more results.
  11745. */
  11746. NextToken?: String;
  11747. /**
  11748. * The HTTP status of the request.
  11749. */
  11750. Status?: StatusCode;
  11751. /**
  11752. * The Amazon Web Services request ID for this operation.
  11753. */
  11754. RequestId?: String;
  11755. }
  11756. export interface ListDataSetsRequest {
  11757. /**
  11758. * The Amazon Web Services account ID.
  11759. */
  11760. AwsAccountId: AwsAccountId;
  11761. /**
  11762. * The token for the next set of results, or null if there are no more results.
  11763. */
  11764. NextToken?: String;
  11765. /**
  11766. * The maximum number of results to be returned per request.
  11767. */
  11768. MaxResults?: MaxResults;
  11769. }
  11770. export interface ListDataSetsResponse {
  11771. /**
  11772. * The list of dataset summaries.
  11773. */
  11774. DataSetSummaries?: DataSetSummaryList;
  11775. /**
  11776. * The token for the next set of results, or null if there are no more results.
  11777. */
  11778. NextToken?: String;
  11779. /**
  11780. * The Amazon Web Services request ID for this operation.
  11781. */
  11782. RequestId?: String;
  11783. /**
  11784. * The HTTP status of the request.
  11785. */
  11786. Status?: StatusCode;
  11787. }
  11788. export interface ListDataSourcesRequest {
  11789. /**
  11790. * The Amazon Web Services account ID.
  11791. */
  11792. AwsAccountId: AwsAccountId;
  11793. /**
  11794. * The token for the next set of results, or null if there are no more results.
  11795. */
  11796. NextToken?: String;
  11797. /**
  11798. * The maximum number of results to be returned per request.
  11799. */
  11800. MaxResults?: MaxResults;
  11801. }
  11802. export interface ListDataSourcesResponse {
  11803. /**
  11804. * A list of data sources.
  11805. */
  11806. DataSources?: DataSourceList;
  11807. /**
  11808. * The token for the next set of results, or null if there are no more results.
  11809. */
  11810. NextToken?: String;
  11811. /**
  11812. * The Amazon Web Services request ID for this operation.
  11813. */
  11814. RequestId?: String;
  11815. /**
  11816. * The HTTP status of the request.
  11817. */
  11818. Status?: StatusCode;
  11819. }
  11820. export interface ListFolderMembersRequest {
  11821. /**
  11822. * The ID for the Amazon Web Services account that contains the folder.
  11823. */
  11824. AwsAccountId: AwsAccountId;
  11825. /**
  11826. * The ID of the folder.
  11827. */
  11828. FolderId: RestrictiveResourceId;
  11829. /**
  11830. * The token for the next set of results, or null if there are no more results.
  11831. */
  11832. NextToken?: String;
  11833. /**
  11834. * The maximum number of results to be returned per request.
  11835. */
  11836. MaxResults?: MaxResults;
  11837. }
  11838. export interface ListFolderMembersResponse {
  11839. /**
  11840. * The HTTP status of the request.
  11841. */
  11842. Status?: StatusCode;
  11843. /**
  11844. * A structure that contains all of the folder members (dashboards, analyses, and datasets) in the folder.
  11845. */
  11846. FolderMemberList?: FolderMemberList;
  11847. /**
  11848. * The token for the next set of results, or null if there are no more results.
  11849. */
  11850. NextToken?: String;
  11851. /**
  11852. * The Amazon Web Services request ID for this operation.
  11853. */
  11854. RequestId?: String;
  11855. }
  11856. export interface ListFoldersRequest {
  11857. /**
  11858. * The ID for the Amazon Web Services account that contains the folder.
  11859. */
  11860. AwsAccountId: AwsAccountId;
  11861. /**
  11862. * The token for the next set of results, or null if there are no more results.
  11863. */
  11864. NextToken?: String;
  11865. /**
  11866. * The maximum number of results to be returned per request.
  11867. */
  11868. MaxResults?: MaxResults;
  11869. }
  11870. export interface ListFoldersResponse {
  11871. /**
  11872. * The HTTP status of the request.
  11873. */
  11874. Status?: StatusCode;
  11875. /**
  11876. * A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
  11877. */
  11878. FolderSummaryList?: FolderSummaryList;
  11879. /**
  11880. * The token for the next set of results, or null if there are no more results.
  11881. */
  11882. NextToken?: String;
  11883. /**
  11884. * The Amazon Web Services request ID for this operation.
  11885. */
  11886. RequestId?: String;
  11887. }
  11888. export interface ListGroupMembershipsRequest {
  11889. /**
  11890. * The name of the group that you want to see a membership list of.
  11891. */
  11892. GroupName: GroupName;
  11893. /**
  11894. * A pagination token that can be used in a subsequent request.
  11895. */
  11896. NextToken?: String;
  11897. /**
  11898. * The maximum number of results to return from this request.
  11899. */
  11900. MaxResults?: MaxResults;
  11901. /**
  11902. * The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  11903. */
  11904. AwsAccountId: AwsAccountId;
  11905. /**
  11906. * The namespace of the group that you want a list of users from.
  11907. */
  11908. Namespace: Namespace;
  11909. }
  11910. export interface ListGroupMembershipsResponse {
  11911. /**
  11912. * The list of the members of the group.
  11913. */
  11914. GroupMemberList?: GroupMemberList;
  11915. /**
  11916. * A pagination token that can be used in a subsequent request.
  11917. */
  11918. NextToken?: String;
  11919. /**
  11920. * The Amazon Web Services request ID for this operation.
  11921. */
  11922. RequestId?: String;
  11923. /**
  11924. * The HTTP status of the request.
  11925. */
  11926. Status?: StatusCode;
  11927. }
  11928. export interface ListGroupsRequest {
  11929. /**
  11930. * The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  11931. */
  11932. AwsAccountId: AwsAccountId;
  11933. /**
  11934. * A pagination token that can be used in a subsequent request.
  11935. */
  11936. NextToken?: String;
  11937. /**
  11938. * The maximum number of results to return.
  11939. */
  11940. MaxResults?: MaxResults;
  11941. /**
  11942. * The namespace that you want a list of groups from.
  11943. */
  11944. Namespace: Namespace;
  11945. }
  11946. export interface ListGroupsResponse {
  11947. /**
  11948. * The list of the groups.
  11949. */
  11950. GroupList?: GroupList;
  11951. /**
  11952. * A pagination token that can be used in a subsequent request.
  11953. */
  11954. NextToken?: String;
  11955. /**
  11956. * The Amazon Web Services request ID for this operation.
  11957. */
  11958. RequestId?: String;
  11959. /**
  11960. * The HTTP status of the request.
  11961. */
  11962. Status?: StatusCode;
  11963. }
  11964. export interface ListIAMPolicyAssignmentsForUserRequest {
  11965. /**
  11966. * The ID of the Amazon Web Services account that contains the assignments.
  11967. */
  11968. AwsAccountId: AwsAccountId;
  11969. /**
  11970. * The name of the user.
  11971. */
  11972. UserName: UserName;
  11973. /**
  11974. * The token for the next set of results, or null if there are no more results.
  11975. */
  11976. NextToken?: String;
  11977. /**
  11978. * The maximum number of results to be returned per request.
  11979. */
  11980. MaxResults?: MaxResults;
  11981. /**
  11982. * The namespace of the assignment.
  11983. */
  11984. Namespace: Namespace;
  11985. }
  11986. export interface ListIAMPolicyAssignmentsForUserResponse {
  11987. /**
  11988. * The active assignments for this user.
  11989. */
  11990. ActiveAssignments?: ActiveIAMPolicyAssignmentList;
  11991. /**
  11992. * The Amazon Web Services request ID for this operation.
  11993. */
  11994. RequestId?: String;
  11995. /**
  11996. * The token for the next set of results, or null if there are no more results.
  11997. */
  11998. NextToken?: String;
  11999. /**
  12000. * The HTTP status of the request.
  12001. */
  12002. Status?: StatusCode;
  12003. }
  12004. export interface ListIAMPolicyAssignmentsRequest {
  12005. /**
  12006. * The ID of the Amazon Web Services account that contains these IAM policy assignments.
  12007. */
  12008. AwsAccountId: AwsAccountId;
  12009. /**
  12010. * The status of the assignments.
  12011. */
  12012. AssignmentStatus?: AssignmentStatus;
  12013. /**
  12014. * The namespace for the assignments.
  12015. */
  12016. Namespace: Namespace;
  12017. /**
  12018. * The token for the next set of results, or null if there are no more results.
  12019. */
  12020. NextToken?: String;
  12021. /**
  12022. * The maximum number of results to be returned per request.
  12023. */
  12024. MaxResults?: MaxResults;
  12025. }
  12026. export interface ListIAMPolicyAssignmentsResponse {
  12027. /**
  12028. * Information describing the IAM policy assignments.
  12029. */
  12030. IAMPolicyAssignments?: IAMPolicyAssignmentSummaryList;
  12031. /**
  12032. * The token for the next set of results, or null if there are no more results.
  12033. */
  12034. NextToken?: String;
  12035. /**
  12036. * The Amazon Web Services request ID for this operation.
  12037. */
  12038. RequestId?: String;
  12039. /**
  12040. * The HTTP status of the request.
  12041. */
  12042. Status?: StatusCode;
  12043. }
  12044. export interface ListIdentityPropagationConfigsRequest {
  12045. /**
  12046. * The ID of the Amazon Web Services account that contain the identity propagation configurations of.
  12047. */
  12048. AwsAccountId: AwsAccountId;
  12049. /**
  12050. * The maximum number of results to be returned.
  12051. */
  12052. MaxResults?: ListIdentityPropagationMaxResults;
  12053. /**
  12054. * The token for the next set of results, or null if there are no more results.
  12055. */
  12056. NextToken?: String;
  12057. }
  12058. export interface ListIdentityPropagationConfigsResponse {
  12059. /**
  12060. * A list of services and their authorized targets that the Amazon QuickSight IAM Identity Center application can access.
  12061. */
  12062. Services?: AuthorizedTargetsByServices;
  12063. /**
  12064. * The token for the next set of results, or null if there are no more results.
  12065. */
  12066. NextToken?: String;
  12067. /**
  12068. * The HTTP status of the request.
  12069. */
  12070. Status?: StatusCode;
  12071. /**
  12072. * The Amazon Web Services request ID for this operation.
  12073. */
  12074. RequestId?: String;
  12075. }
  12076. export type ListIdentityPropagationMaxResults = number;
  12077. export interface ListIngestionsRequest {
  12078. /**
  12079. * The ID of the dataset used in the ingestion.
  12080. */
  12081. DataSetId: String;
  12082. /**
  12083. * The token for the next set of results, or null if there are no more results.
  12084. */
  12085. NextToken?: String;
  12086. /**
  12087. * The Amazon Web Services account ID.
  12088. */
  12089. AwsAccountId: AwsAccountId;
  12090. /**
  12091. * The maximum number of results to be returned per request.
  12092. */
  12093. MaxResults?: IngestionMaxResults;
  12094. }
  12095. export interface ListIngestionsResponse {
  12096. /**
  12097. * A list of the ingestions.
  12098. */
  12099. Ingestions?: Ingestions;
  12100. /**
  12101. * The token for the next set of results, or null if there are no more results.
  12102. */
  12103. NextToken?: String;
  12104. /**
  12105. * The Amazon Web Services request ID for this operation.
  12106. */
  12107. RequestId?: String;
  12108. /**
  12109. * The HTTP status of the request.
  12110. */
  12111. Status?: StatusCode;
  12112. }
  12113. export interface ListNamespacesRequest {
  12114. /**
  12115. * The ID for the Amazon Web Services account that contains the Amazon QuickSight namespaces that you want to list.
  12116. */
  12117. AwsAccountId: AwsAccountId;
  12118. /**
  12119. * A unique pagination token that can be used in a subsequent request. You will receive a pagination token in the response body of a previous ListNameSpaces API call if there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.
  12120. */
  12121. NextToken?: String;
  12122. /**
  12123. * The maximum number of results to return.
  12124. */
  12125. MaxResults?: MaxResults;
  12126. }
  12127. export interface ListNamespacesResponse {
  12128. /**
  12129. * The information about the namespaces in this Amazon Web Services account. The response includes the namespace ARN, name, Amazon Web Services Region, notification email address, creation status, and identity store.
  12130. */
  12131. Namespaces?: Namespaces;
  12132. /**
  12133. * A unique pagination token that can be used in a subsequent request. Receiving NextToken in your response inticates that there is more data that can be returned. To receive the data, make another ListNamespaces API call with the returned token to retrieve the next page of data. Each token is valid for 24 hours. If you try to make a ListNamespaces API call with an expired token, you will receive a HTTP 400 InvalidNextTokenException error.
  12134. */
  12135. NextToken?: String;
  12136. /**
  12137. * The Amazon Web Services request ID for this operation.
  12138. */
  12139. RequestId?: String;
  12140. /**
  12141. * The HTTP status of the request.
  12142. */
  12143. Status?: StatusCode;
  12144. }
  12145. export interface ListRefreshSchedulesRequest {
  12146. /**
  12147. * The Amazon Web Services account ID.
  12148. */
  12149. AwsAccountId: AwsAccountId;
  12150. /**
  12151. * The ID of the dataset.
  12152. */
  12153. DataSetId: ResourceId;
  12154. }
  12155. export interface ListRefreshSchedulesResponse {
  12156. /**
  12157. * The list of refresh schedules for the dataset.
  12158. */
  12159. RefreshSchedules?: RefreshSchedules;
  12160. /**
  12161. * The HTTP status of the request.
  12162. */
  12163. Status?: StatusCode;
  12164. /**
  12165. * The Amazon Web Services request ID for this operation.
  12166. */
  12167. RequestId?: String;
  12168. }
  12169. export interface ListRoleMembershipsRequest {
  12170. /**
  12171. * The name of the role.
  12172. */
  12173. Role: Role;
  12174. /**
  12175. * A pagination token that can be used in a subsequent request.
  12176. */
  12177. NextToken?: String;
  12178. /**
  12179. * The maximum number of results to return.
  12180. */
  12181. MaxResults?: MaxResults;
  12182. /**
  12183. * The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
  12184. */
  12185. AwsAccountId: AwsAccountId;
  12186. /**
  12187. * The namespace that includes the role.
  12188. */
  12189. Namespace: Namespace;
  12190. }
  12191. export interface ListRoleMembershipsResponse {
  12192. /**
  12193. * The list of groups associated with a role
  12194. */
  12195. MembersList?: GroupsList;
  12196. /**
  12197. * A pagination token that can be used in a subsequent request.
  12198. */
  12199. NextToken?: String;
  12200. /**
  12201. * The Amazon Web Services request ID for this operation.
  12202. */
  12203. RequestId?: String;
  12204. /**
  12205. * The HTTP status of the request.
  12206. */
  12207. Status?: StatusCode;
  12208. }
  12209. export interface ListTagsForResourceRequest {
  12210. /**
  12211. * The Amazon Resource Name (ARN) of the resource that you want a list of tags for.
  12212. */
  12213. ResourceArn: Arn;
  12214. }
  12215. export interface ListTagsForResourceResponse {
  12216. /**
  12217. * Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
  12218. */
  12219. Tags?: TagList;
  12220. /**
  12221. * The Amazon Web Services request ID for this operation.
  12222. */
  12223. RequestId?: String;
  12224. /**
  12225. * The HTTP status of the request.
  12226. */
  12227. Status?: StatusCode;
  12228. }
  12229. export interface ListTemplateAliasesRequest {
  12230. /**
  12231. * The ID of the Amazon Web Services account that contains the template aliases that you're listing.
  12232. */
  12233. AwsAccountId: AwsAccountId;
  12234. /**
  12235. * The ID for the template.
  12236. */
  12237. TemplateId: ShortRestrictiveResourceId;
  12238. /**
  12239. * The token for the next set of results, or null if there are no more results.
  12240. */
  12241. NextToken?: String;
  12242. /**
  12243. * The maximum number of results to be returned per request.
  12244. */
  12245. MaxResults?: MaxResults;
  12246. }
  12247. export interface ListTemplateAliasesResponse {
  12248. /**
  12249. * A structure containing the list of the template's aliases.
  12250. */
  12251. TemplateAliasList?: TemplateAliasList;
  12252. /**
  12253. * The HTTP status of the request.
  12254. */
  12255. Status?: StatusCode;
  12256. /**
  12257. * The Amazon Web Services request ID for this operation.
  12258. */
  12259. RequestId?: String;
  12260. /**
  12261. * The token for the next set of results, or null if there are no more results.
  12262. */
  12263. NextToken?: String;
  12264. }
  12265. export interface ListTemplateVersionsRequest {
  12266. /**
  12267. * The ID of the Amazon Web Services account that contains the templates that you're listing.
  12268. */
  12269. AwsAccountId: AwsAccountId;
  12270. /**
  12271. * The ID for the template.
  12272. */
  12273. TemplateId: ShortRestrictiveResourceId;
  12274. /**
  12275. * The token for the next set of results, or null if there are no more results.
  12276. */
  12277. NextToken?: String;
  12278. /**
  12279. * The maximum number of results to be returned per request.
  12280. */
  12281. MaxResults?: MaxResults;
  12282. }
  12283. export interface ListTemplateVersionsResponse {
  12284. /**
  12285. * A structure containing a list of all the versions of the specified template.
  12286. */
  12287. TemplateVersionSummaryList?: TemplateVersionSummaryList;
  12288. /**
  12289. * The token for the next set of results, or null if there are no more results.
  12290. */
  12291. NextToken?: String;
  12292. /**
  12293. * The HTTP status of the request.
  12294. */
  12295. Status?: StatusCode;
  12296. /**
  12297. * The Amazon Web Services request ID for this operation.
  12298. */
  12299. RequestId?: String;
  12300. }
  12301. export interface ListTemplatesRequest {
  12302. /**
  12303. * The ID of the Amazon Web Services account that contains the templates that you're listing.
  12304. */
  12305. AwsAccountId: AwsAccountId;
  12306. /**
  12307. * The token for the next set of results, or null if there are no more results.
  12308. */
  12309. NextToken?: String;
  12310. /**
  12311. * The maximum number of results to be returned per request.
  12312. */
  12313. MaxResults?: MaxResults;
  12314. }
  12315. export interface ListTemplatesResponse {
  12316. /**
  12317. * A structure containing information about the templates in the list.
  12318. */
  12319. TemplateSummaryList?: TemplateSummaryList;
  12320. /**
  12321. * The token for the next set of results, or null if there are no more results.
  12322. */
  12323. NextToken?: String;
  12324. /**
  12325. * The HTTP status of the request.
  12326. */
  12327. Status?: StatusCode;
  12328. /**
  12329. * The Amazon Web Services request ID for this operation.
  12330. */
  12331. RequestId?: String;
  12332. }
  12333. export interface ListThemeAliasesRequest {
  12334. /**
  12335. * The ID of the Amazon Web Services account that contains the theme aliases that you're listing.
  12336. */
  12337. AwsAccountId: AwsAccountId;
  12338. /**
  12339. * The ID for the theme.
  12340. */
  12341. ThemeId: ShortRestrictiveResourceId;
  12342. /**
  12343. * The token for the next set of results, or null if there are no more results.
  12344. */
  12345. NextToken?: String;
  12346. /**
  12347. * The maximum number of results to be returned per request.
  12348. */
  12349. MaxResults?: MaxResults;
  12350. }
  12351. export interface ListThemeAliasesResponse {
  12352. /**
  12353. * A structure containing the list of the theme's aliases.
  12354. */
  12355. ThemeAliasList?: ThemeAliasList;
  12356. /**
  12357. * The HTTP status of the request.
  12358. */
  12359. Status?: StatusCode;
  12360. /**
  12361. * The Amazon Web Services request ID for this operation.
  12362. */
  12363. RequestId?: String;
  12364. /**
  12365. * The token for the next set of results, or null if there are no more results.
  12366. */
  12367. NextToken?: String;
  12368. }
  12369. export interface ListThemeVersionsRequest {
  12370. /**
  12371. * The ID of the Amazon Web Services account that contains the themes that you're listing.
  12372. */
  12373. AwsAccountId: AwsAccountId;
  12374. /**
  12375. * The ID for the theme.
  12376. */
  12377. ThemeId: ShortRestrictiveResourceId;
  12378. /**
  12379. * The token for the next set of results, or null if there are no more results.
  12380. */
  12381. NextToken?: String;
  12382. /**
  12383. * The maximum number of results to be returned per request.
  12384. */
  12385. MaxResults?: MaxResults;
  12386. }
  12387. export interface ListThemeVersionsResponse {
  12388. /**
  12389. * A structure containing a list of all the versions of the specified theme.
  12390. */
  12391. ThemeVersionSummaryList?: ThemeVersionSummaryList;
  12392. /**
  12393. * The token for the next set of results, or null if there are no more results.
  12394. */
  12395. NextToken?: String;
  12396. /**
  12397. * The HTTP status of the request.
  12398. */
  12399. Status?: StatusCode;
  12400. /**
  12401. * The Amazon Web Services request ID for this operation.
  12402. */
  12403. RequestId?: String;
  12404. }
  12405. export interface ListThemesRequest {
  12406. /**
  12407. * The ID of the Amazon Web Services account that contains the themes that you're listing.
  12408. */
  12409. AwsAccountId: AwsAccountId;
  12410. /**
  12411. * The token for the next set of results, or null if there are no more results.
  12412. */
  12413. NextToken?: String;
  12414. /**
  12415. * The maximum number of results to be returned per request.
  12416. */
  12417. MaxResults?: MaxResults;
  12418. /**
  12419. * The type of themes that you want to list. Valid options include the following: ALL (default)- Display all existing themes. CUSTOM - Display only the themes created by people using Amazon QuickSight. QUICKSIGHT - Display only the starting themes defined by Amazon QuickSight.
  12420. */
  12421. Type?: ThemeType;
  12422. }
  12423. export interface ListThemesResponse {
  12424. /**
  12425. * Information about the themes in the list.
  12426. */
  12427. ThemeSummaryList?: ThemeSummaryList;
  12428. /**
  12429. * The token for the next set of results, or null if there are no more results.
  12430. */
  12431. NextToken?: String;
  12432. /**
  12433. * The HTTP status of the request.
  12434. */
  12435. Status?: StatusCode;
  12436. /**
  12437. * The Amazon Web Services request ID for this operation.
  12438. */
  12439. RequestId?: String;
  12440. }
  12441. export interface ListTopicRefreshSchedulesRequest {
  12442. /**
  12443. * The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want described.
  12444. */
  12445. AwsAccountId: AwsAccountId;
  12446. /**
  12447. * The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  12448. */
  12449. TopicId: TopicId;
  12450. }
  12451. export interface ListTopicRefreshSchedulesResponse {
  12452. /**
  12453. * The ID for the topic that you want to describe. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  12454. */
  12455. TopicId?: TopicId;
  12456. /**
  12457. * The Amazon Resource Name (ARN) of the topic.
  12458. */
  12459. TopicArn?: Arn;
  12460. /**
  12461. * The list of topic refresh schedules.
  12462. */
  12463. RefreshSchedules?: TopicRefreshScheduleSummaries;
  12464. /**
  12465. * The HTTP status of the request.
  12466. */
  12467. Status?: StatusCode;
  12468. /**
  12469. * The Amazon Web Services request ID for this operation.
  12470. */
  12471. RequestId?: String;
  12472. }
  12473. export interface ListTopicsRequest {
  12474. /**
  12475. * The ID of the Amazon Web Services account that contains the topics that you want to list.
  12476. */
  12477. AwsAccountId: AwsAccountId;
  12478. /**
  12479. * The token for the next set of results, or null if there are no more results.
  12480. */
  12481. NextToken?: String;
  12482. /**
  12483. * The maximum number of results to be returned per request.
  12484. */
  12485. MaxResults?: MaxResults;
  12486. }
  12487. export interface ListTopicsResponse {
  12488. /**
  12489. * A list of topic summaries.
  12490. */
  12491. TopicsSummaries?: TopicSummaries;
  12492. /**
  12493. * The token for the next set of results, or null if there are no more results.
  12494. */
  12495. NextToken?: String;
  12496. /**
  12497. * The Amazon Web Services request ID for this operation.
  12498. */
  12499. RequestId?: String;
  12500. /**
  12501. * The HTTP status of the request.
  12502. */
  12503. Status?: StatusCode;
  12504. }
  12505. export interface ListUserGroupsRequest {
  12506. /**
  12507. * The Amazon QuickSight user name that you want to list group memberships for.
  12508. */
  12509. UserName: UserName;
  12510. /**
  12511. * The Amazon Web Services account ID that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  12512. */
  12513. AwsAccountId: AwsAccountId;
  12514. /**
  12515. * The namespace. Currently, you should set this to default.
  12516. */
  12517. Namespace: Namespace;
  12518. /**
  12519. * A pagination token that can be used in a subsequent request.
  12520. */
  12521. NextToken?: String;
  12522. /**
  12523. * The maximum number of results to return from this request.
  12524. */
  12525. MaxResults?: MaxResults;
  12526. }
  12527. export interface ListUserGroupsResponse {
  12528. /**
  12529. * The list of groups the user is a member of.
  12530. */
  12531. GroupList?: GroupList;
  12532. /**
  12533. * A pagination token that can be used in a subsequent request.
  12534. */
  12535. NextToken?: String;
  12536. /**
  12537. * The Amazon Web Services request ID for this operation.
  12538. */
  12539. RequestId?: String;
  12540. /**
  12541. * The HTTP status of the request.
  12542. */
  12543. Status?: StatusCode;
  12544. }
  12545. export interface ListUsersRequest {
  12546. /**
  12547. * The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  12548. */
  12549. AwsAccountId: AwsAccountId;
  12550. /**
  12551. * A pagination token that can be used in a subsequent request.
  12552. */
  12553. NextToken?: String;
  12554. /**
  12555. * The maximum number of results to return from this request.
  12556. */
  12557. MaxResults?: MaxResults;
  12558. /**
  12559. * The namespace. Currently, you should set this to default.
  12560. */
  12561. Namespace: Namespace;
  12562. }
  12563. export interface ListUsersResponse {
  12564. /**
  12565. * The list of users.
  12566. */
  12567. UserList?: UserList;
  12568. /**
  12569. * A pagination token that can be used in a subsequent request.
  12570. */
  12571. NextToken?: String;
  12572. /**
  12573. * The Amazon Web Services request ID for this operation.
  12574. */
  12575. RequestId?: String;
  12576. /**
  12577. * The HTTP status of the request.
  12578. */
  12579. Status?: StatusCode;
  12580. }
  12581. export interface ListVPCConnectionsRequest {
  12582. /**
  12583. * The Amazon Web Services account ID of the account that contains the VPC connections that you want to list.
  12584. */
  12585. AwsAccountId: AwsAccountId;
  12586. /**
  12587. * The token for the next set of results, or null if there are no more results.
  12588. */
  12589. NextToken?: String;
  12590. /**
  12591. * The maximum number of results to be returned per request.
  12592. */
  12593. MaxResults?: MaxResults;
  12594. }
  12595. export interface ListVPCConnectionsResponse {
  12596. /**
  12597. * A VPCConnectionSummaries object that returns a summary of VPC connection objects.
  12598. */
  12599. VPCConnectionSummaries?: VPCConnectionSummaryList;
  12600. /**
  12601. * The token for the next set of results, or null if there are no more results.
  12602. */
  12603. NextToken?: String;
  12604. /**
  12605. * The Amazon Web Services request ID for this operation.
  12606. */
  12607. RequestId?: String;
  12608. /**
  12609. * The HTTP status of the request.
  12610. */
  12611. Status?: StatusCode;
  12612. }
  12613. export interface LoadingAnimation {
  12614. /**
  12615. * The visibility configuration of LoadingAnimation.
  12616. */
  12617. Visibility?: Visibility;
  12618. }
  12619. export interface LocalNavigationConfiguration {
  12620. /**
  12621. * The sheet that is targeted for navigation in the same analysis.
  12622. */
  12623. TargetSheetId: ShortRestrictiveResourceId;
  12624. }
  12625. export interface LogicalTable {
  12626. /**
  12627. * A display name for the logical table.
  12628. */
  12629. Alias: LogicalTableAlias;
  12630. /**
  12631. * Transform operations that act on this logical table. For this structure to be valid, only one of the attributes can be non-null.
  12632. */
  12633. DataTransforms?: TransformOperationList;
  12634. /**
  12635. * Source of this logical table.
  12636. */
  12637. Source: LogicalTableSource;
  12638. }
  12639. export type LogicalTableAlias = string;
  12640. export type LogicalTableId = string;
  12641. export type LogicalTableMap = {[key: string]: LogicalTable};
  12642. export interface LogicalTableSource {
  12643. /**
  12644. * Specifies the result of a join of two logical tables.
  12645. */
  12646. JoinInstruction?: JoinInstruction;
  12647. /**
  12648. * Physical table ID.
  12649. */
  12650. PhysicalTableId?: PhysicalTableId;
  12651. /**
  12652. * The Amazon Resource Number (ARN) of the parent dataset.
  12653. */
  12654. DataSetArn?: Arn;
  12655. }
  12656. export type Long = number;
  12657. export interface LongFormatText {
  12658. /**
  12659. * Plain text format.
  12660. */
  12661. PlainText?: LongPlainText;
  12662. /**
  12663. * Rich text. Examples of rich text include bold, underline, and italics.
  12664. */
  12665. RichText?: LongRichText;
  12666. }
  12667. export type LongPlainText = string;
  12668. export type LongRichText = string;
  12669. export type Longitude = number;
  12670. export interface LookbackWindow {
  12671. /**
  12672. * The name of the lookback window column.
  12673. */
  12674. ColumnName: String;
  12675. /**
  12676. * The lookback window column size.
  12677. */
  12678. Size: PositiveLong;
  12679. /**
  12680. * The size unit that is used for the lookback window column. Valid values for this structure are HOUR, DAY, and WEEK.
  12681. */
  12682. SizeUnit: LookbackWindowSizeUnit;
  12683. }
  12684. export type LookbackWindowSizeUnit = "HOUR"|"DAY"|"WEEK"|string;
  12685. export interface ManifestFileLocation {
  12686. /**
  12687. * Amazon S3 bucket.
  12688. */
  12689. Bucket: S3Bucket;
  12690. /**
  12691. * Amazon S3 key that identifies an object.
  12692. */
  12693. Key: S3Key;
  12694. }
  12695. export type MapZoomMode = "AUTO"|"MANUAL"|string;
  12696. export interface MappedDataSetParameter {
  12697. /**
  12698. * A unique name that identifies a dataset within the analysis or dashboard.
  12699. */
  12700. DataSetIdentifier: DataSetIdentifier;
  12701. /**
  12702. * The name of the dataset parameter.
  12703. */
  12704. DataSetParameterName: ParameterName;
  12705. }
  12706. export type MappedDataSetParameters = MappedDataSetParameter[];
  12707. export interface MarginStyle {
  12708. /**
  12709. * This Boolean value controls whether to display sheet margins.
  12710. */
  12711. Show?: Boolean;
  12712. }
  12713. export interface MariaDbParameters {
  12714. /**
  12715. * Host.
  12716. */
  12717. Host: Host;
  12718. /**
  12719. * Port.
  12720. */
  12721. Port: Port;
  12722. /**
  12723. * Database.
  12724. */
  12725. Database: Database;
  12726. }
  12727. export type MaxResults = number;
  12728. export interface MaximumLabelType {
  12729. /**
  12730. * The visibility of the maximum label.
  12731. */
  12732. Visibility?: Visibility;
  12733. }
  12734. export interface MaximumMinimumComputation {
  12735. /**
  12736. * The ID for a computation.
  12737. */
  12738. ComputationId: ShortRestrictiveResourceId;
  12739. /**
  12740. * The name of a computation.
  12741. */
  12742. Name?: String;
  12743. /**
  12744. * The time field that is used in a computation.
  12745. */
  12746. Time?: DimensionField;
  12747. /**
  12748. * The value field that is used in a computation.
  12749. */
  12750. Value?: MeasureField;
  12751. /**
  12752. * The type of computation. Choose one of the following options: MAXIMUM: A maximum computation. MINIMUM: A minimum computation.
  12753. */
  12754. Type: MaximumMinimumComputationType;
  12755. }
  12756. export type MaximumMinimumComputationType = "MAXIMUM"|"MINIMUM"|string;
  12757. export interface MeasureField {
  12758. /**
  12759. * The measure type field with numerical type columns.
  12760. */
  12761. NumericalMeasureField?: NumericalMeasureField;
  12762. /**
  12763. * The measure type field with categorical type columns.
  12764. */
  12765. CategoricalMeasureField?: CategoricalMeasureField;
  12766. /**
  12767. * The measure type field with date type columns.
  12768. */
  12769. DateMeasureField?: DateMeasureField;
  12770. /**
  12771. * The calculated measure field only used in pivot tables.
  12772. */
  12773. CalculatedMeasureField?: CalculatedMeasureField;
  12774. }
  12775. export type MeasureFieldList = MeasureField[];
  12776. export interface MemberIdArnPair {
  12777. /**
  12778. * The ID of the member.
  12779. */
  12780. MemberId?: RestrictiveResourceId;
  12781. /**
  12782. * The Amazon Resource Name (ARN) of the member.
  12783. */
  12784. MemberArn?: Arn;
  12785. }
  12786. export type MemberType = "DASHBOARD"|"ANALYSIS"|"DATASET"|"DATASOURCE"|"TOPIC"|string;
  12787. export interface MetricComparisonComputation {
  12788. /**
  12789. * The ID for a computation.
  12790. */
  12791. ComputationId: ShortRestrictiveResourceId;
  12792. /**
  12793. * The name of a computation.
  12794. */
  12795. Name?: String;
  12796. /**
  12797. * The time field that is used in a computation.
  12798. */
  12799. Time?: DimensionField;
  12800. /**
  12801. * The field that is used in a metric comparison from value setup.
  12802. */
  12803. FromValue?: MeasureField;
  12804. /**
  12805. * The field that is used in a metric comparison to value setup.
  12806. */
  12807. TargetValue?: MeasureField;
  12808. }
  12809. export interface MinimumLabelType {
  12810. /**
  12811. * The visibility of the minimum label.
  12812. */
  12813. Visibility?: Visibility;
  12814. }
  12815. export interface MissingDataConfiguration {
  12816. /**
  12817. * The treatment option that determines how missing data should be rendered. Choose from the following options: INTERPOLATE: Interpolate missing values between the prior and the next known value. SHOW_AS_ZERO: Show missing values as the value 0. SHOW_AS_BLANK: Display a blank space when rendering missing data.
  12818. */
  12819. TreatmentOption?: MissingDataTreatmentOption;
  12820. }
  12821. export type MissingDataConfigurationList = MissingDataConfiguration[];
  12822. export type MissingDataTreatmentOption = "INTERPOLATE"|"SHOW_AS_ZERO"|"SHOW_AS_BLANK"|string;
  12823. export interface MySqlParameters {
  12824. /**
  12825. * Host.
  12826. */
  12827. Host: Host;
  12828. /**
  12829. * Port.
  12830. */
  12831. Port: Port;
  12832. /**
  12833. * Database.
  12834. */
  12835. Database: Database;
  12836. }
  12837. export type NamedEntityAggType = "SUM"|"MIN"|"MAX"|"COUNT"|"AVERAGE"|"DISTINCT_COUNT"|"STDEV"|"STDEVP"|"VAR"|"VARP"|"PERCENTILE"|"MEDIAN"|"CUSTOM"|string;
  12838. export interface NamedEntityDefinition {
  12839. /**
  12840. * The name of the entity.
  12841. */
  12842. FieldName?: LimitedString;
  12843. /**
  12844. * The property name to be used for the named entity.
  12845. */
  12846. PropertyName?: LimitedString;
  12847. /**
  12848. * The property role. Valid values for this structure are PRIMARY and ID.
  12849. */
  12850. PropertyRole?: PropertyRole;
  12851. /**
  12852. * The property usage. Valid values for this structure are INHERIT, DIMENSION, and MEASURE.
  12853. */
  12854. PropertyUsage?: PropertyUsage;
  12855. /**
  12856. * The definition of a metric.
  12857. */
  12858. Metric?: NamedEntityDefinitionMetric;
  12859. }
  12860. export interface NamedEntityDefinitionMetric {
  12861. /**
  12862. * The aggregation of a named entity. Valid values for this structure are SUM, MIN, MAX, COUNT, AVERAGE, DISTINCT_COUNT, STDEV, STDEVP, VAR, VARP, PERCENTILE, MEDIAN, and CUSTOM.
  12863. */
  12864. Aggregation?: NamedEntityAggType;
  12865. /**
  12866. * The additional parameters for an aggregation function.
  12867. */
  12868. AggregationFunctionParameters?: AggregationFunctionParameters;
  12869. }
  12870. export type NamedEntityDefinitions = NamedEntityDefinition[];
  12871. export type NamedFilterAggType = "NO_AGGREGATION"|"SUM"|"AVERAGE"|"COUNT"|"DISTINCT_COUNT"|"MAX"|"MEDIAN"|"MIN"|"STDEV"|"STDEVP"|"VAR"|"VARP"|string;
  12872. export type NamedFilterType = "CATEGORY_FILTER"|"NUMERIC_EQUALITY_FILTER"|"NUMERIC_RANGE_FILTER"|"DATE_RANGE_FILTER"|"RELATIVE_DATE_FILTER"|string;
  12873. export type Namespace = string;
  12874. export interface NamespaceError {
  12875. /**
  12876. * The error type.
  12877. */
  12878. Type?: NamespaceErrorType;
  12879. /**
  12880. * The message for the error.
  12881. */
  12882. Message?: String;
  12883. }
  12884. export type NamespaceErrorType = "PERMISSION_DENIED"|"INTERNAL_SERVICE_ERROR"|string;
  12885. export interface NamespaceInfoV2 {
  12886. /**
  12887. * The name of the error.
  12888. */
  12889. Name?: Namespace;
  12890. /**
  12891. * The namespace ARN.
  12892. */
  12893. Arn?: Arn;
  12894. /**
  12895. * The namespace Amazon Web Services Region.
  12896. */
  12897. CapacityRegion?: String;
  12898. /**
  12899. * The creation status of a namespace that is not yet completely created.
  12900. */
  12901. CreationStatus?: NamespaceStatus;
  12902. /**
  12903. * The identity store used for the namespace.
  12904. */
  12905. IdentityStore?: IdentityStore;
  12906. /**
  12907. * An error that occurred when the namespace was created.
  12908. */
  12909. NamespaceError?: NamespaceError;
  12910. }
  12911. export type NamespaceStatus = "CREATED"|"CREATING"|"DELETING"|"RETRYABLE_FAILURE"|"NON_RETRYABLE_FAILURE"|string;
  12912. export type Namespaces = NamespaceInfoV2[];
  12913. export type NarrativeString = string;
  12914. export interface NegativeFormat {
  12915. /**
  12916. * The prefix for a negative format.
  12917. */
  12918. Prefix?: LimitedString;
  12919. /**
  12920. * The suffix for a negative format.
  12921. */
  12922. Suffix?: LimitedString;
  12923. }
  12924. export interface NegativeValueConfiguration {
  12925. /**
  12926. * Determines the display mode of the negative value configuration.
  12927. */
  12928. DisplayMode: NegativeValueDisplayMode;
  12929. }
  12930. export type NegativeValueDisplayMode = "POSITIVE"|"NEGATIVE"|string;
  12931. export interface NetworkInterface {
  12932. /**
  12933. * The subnet ID associated with the network interface.
  12934. */
  12935. SubnetId?: SubnetId;
  12936. /**
  12937. * The availability zone that the network interface resides in.
  12938. */
  12939. AvailabilityZone?: String;
  12940. /**
  12941. * An error message.
  12942. */
  12943. ErrorMessage?: String;
  12944. /**
  12945. * The status of the network interface.
  12946. */
  12947. Status?: NetworkInterfaceStatus;
  12948. /**
  12949. * The network interface ID.
  12950. */
  12951. NetworkInterfaceId?: NetworkInterfaceId;
  12952. }
  12953. export type NetworkInterfaceId = string;
  12954. export type NetworkInterfaceList = NetworkInterface[];
  12955. export type NetworkInterfaceStatus = "CREATING"|"AVAILABLE"|"CREATION_FAILED"|"UPDATING"|"UPDATE_FAILED"|"DELETING"|"DELETED"|"DELETION_FAILED"|"DELETION_SCHEDULED"|"ATTACHMENT_FAILED_ROLLBACK_FAILED"|string;
  12956. export interface NewDefaultValues {
  12957. /**
  12958. * A list of static default values for a given string parameter.
  12959. */
  12960. StringStaticValues?: StringDatasetParameterValueList;
  12961. /**
  12962. * A list of static default values for a given decimal parameter.
  12963. */
  12964. DecimalStaticValues?: DecimalDatasetParameterValueList;
  12965. /**
  12966. * A list of static default values for a given date time parameter.
  12967. */
  12968. DateTimeStaticValues?: DateTimeDatasetParameterValueList;
  12969. /**
  12970. * A list of static default values for a given integer parameter.
  12971. */
  12972. IntegerStaticValues?: IntegerDatasetParameterValueList;
  12973. }
  12974. export type NonEmptyString = string;
  12975. export type NullString = string;
  12976. export interface NullValueFormatConfiguration {
  12977. /**
  12978. * Determines the null string of null values.
  12979. */
  12980. NullString: NullString;
  12981. }
  12982. export type NullableBoolean = boolean;
  12983. export interface NumberDisplayFormatConfiguration {
  12984. /**
  12985. * Determines the prefix value of the number format.
  12986. */
  12987. Prefix?: Prefix;
  12988. /**
  12989. * Determines the suffix value of the number format.
  12990. */
  12991. Suffix?: Suffix;
  12992. /**
  12993. * The options that determine the numeric separator configuration.
  12994. */
  12995. SeparatorConfiguration?: NumericSeparatorConfiguration;
  12996. /**
  12997. * The option that determines the decimal places configuration.
  12998. */
  12999. DecimalPlacesConfiguration?: DecimalPlacesConfiguration;
  13000. /**
  13001. * Determines the number scale value of the number format.
  13002. */
  13003. NumberScale?: NumberScale;
  13004. /**
  13005. * The options that determine the negative value configuration.
  13006. */
  13007. NegativeValueConfiguration?: NegativeValueConfiguration;
  13008. /**
  13009. * The options that determine the null value format configuration.
  13010. */
  13011. NullValueFormatConfiguration?: NullValueFormatConfiguration;
  13012. }
  13013. export interface NumberFormatConfiguration {
  13014. /**
  13015. * The options that determine the numeric format configuration.
  13016. */
  13017. FormatConfiguration?: NumericFormatConfiguration;
  13018. }
  13019. export type NumberScale = "NONE"|"AUTO"|"THOUSANDS"|"MILLIONS"|"BILLIONS"|"TRILLIONS"|string;
  13020. export interface NumericAxisOptions {
  13021. /**
  13022. * The scale setup of a numeric axis.
  13023. */
  13024. Scale?: AxisScale;
  13025. /**
  13026. * The range setup of a numeric axis.
  13027. */
  13028. Range?: AxisDisplayRange;
  13029. }
  13030. export interface NumericEqualityDrillDownFilter {
  13031. /**
  13032. * The column that the filter is applied to.
  13033. */
  13034. Column: ColumnIdentifier;
  13035. /**
  13036. * The value of the double input numeric drill down filter.
  13037. */
  13038. Value: Double;
  13039. }
  13040. export interface NumericEqualityFilter {
  13041. /**
  13042. * An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
  13043. */
  13044. FilterId: ShortRestrictiveResourceId;
  13045. /**
  13046. * The column that the filter is applied to.
  13047. */
  13048. Column: ColumnIdentifier;
  13049. /**
  13050. * The input value.
  13051. */
  13052. Value?: Double;
  13053. /**
  13054. * Select all of the values. Null is not the assigned value of select all. FILTER_ALL_VALUES
  13055. */
  13056. SelectAllOptions?: NumericFilterSelectAllOptions;
  13057. /**
  13058. * The match operator that is used to determine if a filter should be applied.
  13059. */
  13060. MatchOperator: NumericEqualityMatchOperator;
  13061. /**
  13062. * The aggregation function of the filter.
  13063. */
  13064. AggregationFunction?: AggregationFunction;
  13065. /**
  13066. * The parameter whose value should be used for the filter value.
  13067. */
  13068. ParameterName?: ParameterName;
  13069. /**
  13070. * This option determines how null values should be treated when filtering data. ALL_VALUES: Include null values in filtered results. NULLS_ONLY: Only include null values in filtered results. NON_NULLS_ONLY: Exclude null values from filtered results.
  13071. */
  13072. NullOption: FilterNullOption;
  13073. /**
  13074. * The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
  13075. */
  13076. DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
  13077. }
  13078. export type NumericEqualityMatchOperator = "EQUALS"|"DOES_NOT_EQUAL"|string;
  13079. export type NumericFilterSelectAllOptions = "FILTER_ALL_VALUES"|string;
  13080. export interface NumericFormatConfiguration {
  13081. /**
  13082. * The options that determine the number display format configuration.
  13083. */
  13084. NumberDisplayFormatConfiguration?: NumberDisplayFormatConfiguration;
  13085. /**
  13086. * The options that determine the currency display format configuration.
  13087. */
  13088. CurrencyDisplayFormatConfiguration?: CurrencyDisplayFormatConfiguration;
  13089. /**
  13090. * The options that determine the percentage display format configuration.
  13091. */
  13092. PercentageDisplayFormatConfiguration?: PercentageDisplayFormatConfiguration;
  13093. }
  13094. export interface NumericRangeFilter {
  13095. /**
  13096. * An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
  13097. */
  13098. FilterId: ShortRestrictiveResourceId;
  13099. /**
  13100. * The column that the filter is applied to.
  13101. */
  13102. Column: ColumnIdentifier;
  13103. /**
  13104. * Determines whether the minimum value in the filter value range should be included in the filtered results.
  13105. */
  13106. IncludeMinimum?: Boolean;
  13107. /**
  13108. * Determines whether the maximum value in the filter value range should be included in the filtered results.
  13109. */
  13110. IncludeMaximum?: Boolean;
  13111. /**
  13112. * The minimum value for the filter value range.
  13113. */
  13114. RangeMinimum?: NumericRangeFilterValue;
  13115. /**
  13116. * The maximum value for the filter value range.
  13117. */
  13118. RangeMaximum?: NumericRangeFilterValue;
  13119. /**
  13120. * Select all of the values. Null is not the assigned value of select all. FILTER_ALL_VALUES
  13121. */
  13122. SelectAllOptions?: NumericFilterSelectAllOptions;
  13123. /**
  13124. * The aggregation function of the filter.
  13125. */
  13126. AggregationFunction?: AggregationFunction;
  13127. /**
  13128. * This option determines how null values should be treated when filtering data. ALL_VALUES: Include null values in filtered results. NULLS_ONLY: Only include null values in filtered results. NON_NULLS_ONLY: Exclude null values from filtered results.
  13129. */
  13130. NullOption: FilterNullOption;
  13131. /**
  13132. * The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
  13133. */
  13134. DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
  13135. }
  13136. export interface NumericRangeFilterValue {
  13137. /**
  13138. * The static value of the numeric range filter.
  13139. */
  13140. StaticValue?: Double;
  13141. /**
  13142. * The parameter that is used in the numeric range.
  13143. */
  13144. Parameter?: ParameterName;
  13145. }
  13146. export interface NumericSeparatorConfiguration {
  13147. /**
  13148. * Determines the decimal separator.
  13149. */
  13150. DecimalSeparator?: NumericSeparatorSymbol;
  13151. /**
  13152. * The options that determine the thousands separator configuration.
  13153. */
  13154. ThousandsSeparator?: ThousandSeparatorOptions;
  13155. }
  13156. export type NumericSeparatorSymbol = "COMMA"|"DOT"|"SPACE"|string;
  13157. export interface NumericalAggregationFunction {
  13158. /**
  13159. * Built-in aggregation functions for numerical values. SUM: The sum of a dimension or measure. AVERAGE: The average of a dimension or measure. MIN: The minimum value of a dimension or measure. MAX: The maximum value of a dimension or measure. COUNT: The count of a dimension or measure. DISTINCT_COUNT: The count of distinct values in a dimension or measure. VAR: The variance of a dimension or measure. VARP: The partitioned variance of a dimension or measure. STDEV: The standard deviation of a dimension or measure. STDEVP: The partitioned standard deviation of a dimension or measure. MEDIAN: The median value of a dimension or measure.
  13160. */
  13161. SimpleNumericalAggregation?: SimpleNumericalAggregationFunction;
  13162. /**
  13163. * An aggregation based on the percentile of values in a dimension or measure.
  13164. */
  13165. PercentileAggregation?: PercentileAggregation;
  13166. }
  13167. export interface NumericalDimensionField {
  13168. /**
  13169. * The custom field ID.
  13170. */
  13171. FieldId: FieldId;
  13172. /**
  13173. * The column that is used in the NumericalDimensionField.
  13174. */
  13175. Column: ColumnIdentifier;
  13176. /**
  13177. * The custom hierarchy ID.
  13178. */
  13179. HierarchyId?: HierarchyId;
  13180. /**
  13181. * The format configuration of the field.
  13182. */
  13183. FormatConfiguration?: NumberFormatConfiguration;
  13184. }
  13185. export interface NumericalMeasureField {
  13186. /**
  13187. * The custom field ID.
  13188. */
  13189. FieldId: FieldId;
  13190. /**
  13191. * The column that is used in the NumericalMeasureField.
  13192. */
  13193. Column: ColumnIdentifier;
  13194. /**
  13195. * The aggregation function of the measure field.
  13196. */
  13197. AggregationFunction?: NumericalAggregationFunction;
  13198. /**
  13199. * The format configuration of the field.
  13200. */
  13201. FormatConfiguration?: NumberFormatConfiguration;
  13202. }
  13203. export type OnClause = string;
  13204. export type OptionalPort = number;
  13205. export interface OracleParameters {
  13206. /**
  13207. * An Oracle host.
  13208. */
  13209. Host: Host;
  13210. /**
  13211. * The port.
  13212. */
  13213. Port: Port;
  13214. /**
  13215. * The database.
  13216. */
  13217. Database: Database;
  13218. }
  13219. export type OtherCategories = "INCLUDE"|"EXCLUDE"|string;
  13220. export interface OutputColumn {
  13221. /**
  13222. * The display name of the column..
  13223. */
  13224. Name?: ColumnName;
  13225. /**
  13226. * A description for a column.
  13227. */
  13228. Description?: ColumnDescriptiveText;
  13229. /**
  13230. * The data type of the column.
  13231. */
  13232. Type?: ColumnDataType;
  13233. /**
  13234. * The sub data type of the column.
  13235. */
  13236. SubType?: ColumnDataSubType;
  13237. }
  13238. export type OutputColumnList = OutputColumn[];
  13239. export interface OverrideDatasetParameterOperation {
  13240. /**
  13241. * The name of the parameter to be overridden with different values.
  13242. */
  13243. ParameterName: DatasetParameterName;
  13244. /**
  13245. * The new name for the parameter.
  13246. */
  13247. NewParameterName?: DatasetParameterName;
  13248. /**
  13249. * The new default values for the parameter.
  13250. */
  13251. NewDefaultValues?: NewDefaultValues;
  13252. }
  13253. export type PageNumber = number;
  13254. export interface PaginationConfiguration {
  13255. /**
  13256. * Indicates how many items render in one page.
  13257. */
  13258. PageSize: Long;
  13259. /**
  13260. * Indicates the page number.
  13261. */
  13262. PageNumber: PageNumber;
  13263. }
  13264. export type PanelBorderStyle = "SOLID"|"DASHED"|"DOTTED"|string;
  13265. export interface PanelConfiguration {
  13266. /**
  13267. * Configures the title display within each small multiples panel.
  13268. */
  13269. Title?: PanelTitleOptions;
  13270. /**
  13271. * Determines whether or not each panel displays a border.
  13272. */
  13273. BorderVisibility?: Visibility;
  13274. /**
  13275. * Sets the line thickness of panel borders.
  13276. */
  13277. BorderThickness?: PixelLength;
  13278. /**
  13279. * Sets the line style of panel borders.
  13280. */
  13281. BorderStyle?: PanelBorderStyle;
  13282. /**
  13283. * Sets the line color of panel borders.
  13284. */
  13285. BorderColor?: HexColorWithTransparency;
  13286. /**
  13287. * Determines whether or not negative space between sibling panels is rendered.
  13288. */
  13289. GutterVisibility?: Visibility;
  13290. /**
  13291. * Sets the total amount of negative space to display between sibling panels.
  13292. */
  13293. GutterSpacing?: PixelLength;
  13294. /**
  13295. * Determines whether or not a background for each small multiples panel is rendered.
  13296. */
  13297. BackgroundVisibility?: Visibility;
  13298. /**
  13299. * Sets the background color for each panel.
  13300. */
  13301. BackgroundColor?: HexColorWithTransparency;
  13302. }
  13303. export interface PanelTitleOptions {
  13304. /**
  13305. * Determines whether or not panel titles are displayed.
  13306. */
  13307. Visibility?: Visibility;
  13308. FontConfiguration?: FontConfiguration;
  13309. /**
  13310. * Sets the horizontal text alignment of the title within each panel.
  13311. */
  13312. HorizontalTextAlignment?: HorizontalTextAlignment;
  13313. }
  13314. export type PaperOrientation = "PORTRAIT"|"LANDSCAPE"|string;
  13315. export type PaperSize = "US_LETTER"|"US_LEGAL"|"US_TABLOID_LEDGER"|"A0"|"A1"|"A2"|"A3"|"A4"|"A5"|"JIS_B4"|"JIS_B5"|string;
  13316. export interface ParameterControl {
  13317. /**
  13318. * A control from a date parameter that specifies date and time.
  13319. */
  13320. DateTimePicker?: ParameterDateTimePickerControl;
  13321. /**
  13322. * A control to display a list with buttons or boxes that are used to select either a single value or multiple values.
  13323. */
  13324. List?: ParameterListControl;
  13325. /**
  13326. * A control to display a dropdown list with buttons that are used to select a single value.
  13327. */
  13328. Dropdown?: ParameterDropDownControl;
  13329. /**
  13330. * A control to display a text box that is used to enter a single entry.
  13331. */
  13332. TextField?: ParameterTextFieldControl;
  13333. /**
  13334. * A control to display a text box that is used to enter multiple entries.
  13335. */
  13336. TextArea?: ParameterTextAreaControl;
  13337. /**
  13338. * A control to display a horizontal toggle bar. This is used to change a value by sliding the toggle.
  13339. */
  13340. Slider?: ParameterSliderControl;
  13341. }
  13342. export type ParameterControlList = ParameterControl[];
  13343. export interface ParameterDateTimePickerControl {
  13344. /**
  13345. * The ID of the ParameterDateTimePickerControl.
  13346. */
  13347. ParameterControlId: ShortRestrictiveResourceId;
  13348. /**
  13349. * The title of the ParameterDateTimePickerControl.
  13350. */
  13351. Title: SheetControlTitle;
  13352. /**
  13353. * The name of the ParameterDateTimePickerControl.
  13354. */
  13355. SourceParameterName: ParameterName;
  13356. /**
  13357. * The display options of a control.
  13358. */
  13359. DisplayOptions?: DateTimePickerControlDisplayOptions;
  13360. }
  13361. export interface ParameterDeclaration {
  13362. /**
  13363. * A parameter declaration for the String data type.
  13364. */
  13365. StringParameterDeclaration?: StringParameterDeclaration;
  13366. /**
  13367. * A parameter declaration for the Decimal data type.
  13368. */
  13369. DecimalParameterDeclaration?: DecimalParameterDeclaration;
  13370. /**
  13371. * A parameter declaration for the Integer data type.
  13372. */
  13373. IntegerParameterDeclaration?: IntegerParameterDeclaration;
  13374. /**
  13375. * A parameter declaration for the DateTime data type.
  13376. */
  13377. DateTimeParameterDeclaration?: DateTimeParameterDeclaration;
  13378. }
  13379. export type ParameterDeclarationList = ParameterDeclaration[];
  13380. export interface ParameterDropDownControl {
  13381. /**
  13382. * The ID of the ParameterDropDownControl.
  13383. */
  13384. ParameterControlId: ShortRestrictiveResourceId;
  13385. /**
  13386. * The title of the ParameterDropDownControl.
  13387. */
  13388. Title: SheetControlTitle;
  13389. /**
  13390. * The source parameter name of the ParameterDropDownControl.
  13391. */
  13392. SourceParameterName: ParameterName;
  13393. /**
  13394. * The display options of a control.
  13395. */
  13396. DisplayOptions?: DropDownControlDisplayOptions;
  13397. /**
  13398. * The type parameter name of the ParameterDropDownControl.
  13399. */
  13400. Type?: SheetControlListType;
  13401. /**
  13402. * A list of selectable values that are used in a control.
  13403. */
  13404. SelectableValues?: ParameterSelectableValues;
  13405. /**
  13406. * The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
  13407. */
  13408. CascadingControlConfiguration?: CascadingControlConfiguration;
  13409. }
  13410. export interface ParameterListControl {
  13411. /**
  13412. * The ID of the ParameterListControl.
  13413. */
  13414. ParameterControlId: ShortRestrictiveResourceId;
  13415. /**
  13416. * The title of the ParameterListControl.
  13417. */
  13418. Title: SheetControlTitle;
  13419. /**
  13420. * The source parameter name of the ParameterListControl.
  13421. */
  13422. SourceParameterName: ParameterName;
  13423. /**
  13424. * The display options of a control.
  13425. */
  13426. DisplayOptions?: ListControlDisplayOptions;
  13427. /**
  13428. * The type of ParameterListControl.
  13429. */
  13430. Type?: SheetControlListType;
  13431. /**
  13432. * A list of selectable values that are used in a control.
  13433. */
  13434. SelectableValues?: ParameterSelectableValues;
  13435. /**
  13436. * The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.
  13437. */
  13438. CascadingControlConfiguration?: CascadingControlConfiguration;
  13439. }
  13440. export type ParameterName = string;
  13441. export type ParameterSelectableValueList = String[];
  13442. export interface ParameterSelectableValues {
  13443. /**
  13444. * The values that are used in ParameterSelectableValues.
  13445. */
  13446. Values?: ParameterSelectableValueList;
  13447. /**
  13448. * The column identifier that fetches values from the data set.
  13449. */
  13450. LinkToDataSetColumn?: ColumnIdentifier;
  13451. }
  13452. export interface ParameterSliderControl {
  13453. /**
  13454. * The ID of the ParameterSliderControl.
  13455. */
  13456. ParameterControlId: ShortRestrictiveResourceId;
  13457. /**
  13458. * The title of the ParameterSliderControl.
  13459. */
  13460. Title: SheetControlTitle;
  13461. /**
  13462. * The source parameter name of the ParameterSliderControl.
  13463. */
  13464. SourceParameterName: ParameterName;
  13465. /**
  13466. * The display options of a control.
  13467. */
  13468. DisplayOptions?: SliderControlDisplayOptions;
  13469. /**
  13470. * The larger value that is displayed at the right of the slider.
  13471. */
  13472. MaximumValue: Double;
  13473. /**
  13474. * The smaller value that is displayed at the left of the slider.
  13475. */
  13476. MinimumValue: Double;
  13477. /**
  13478. * The number of increments that the slider bar is divided into.
  13479. */
  13480. StepSize: Double;
  13481. }
  13482. export interface ParameterTextAreaControl {
  13483. /**
  13484. * The ID of the ParameterTextAreaControl.
  13485. */
  13486. ParameterControlId: ShortRestrictiveResourceId;
  13487. /**
  13488. * The title of the ParameterTextAreaControl.
  13489. */
  13490. Title: SheetControlTitle;
  13491. /**
  13492. * The source parameter name of the ParameterTextAreaControl.
  13493. */
  13494. SourceParameterName: ParameterName;
  13495. /**
  13496. * The delimiter that is used to separate the lines in text.
  13497. */
  13498. Delimiter?: TextAreaControlDelimiter;
  13499. /**
  13500. * The display options of a control.
  13501. */
  13502. DisplayOptions?: TextAreaControlDisplayOptions;
  13503. }
  13504. export interface ParameterTextFieldControl {
  13505. /**
  13506. * The ID of the ParameterTextFieldControl.
  13507. */
  13508. ParameterControlId: ShortRestrictiveResourceId;
  13509. /**
  13510. * The title of the ParameterTextFieldControl.
  13511. */
  13512. Title: SheetControlTitle;
  13513. /**
  13514. * The source parameter name of the ParameterTextFieldControl.
  13515. */
  13516. SourceParameterName: ParameterName;
  13517. /**
  13518. * The display options of a control.
  13519. */
  13520. DisplayOptions?: TextFieldControlDisplayOptions;
  13521. }
  13522. export type ParameterValueType = "MULTI_VALUED"|"SINGLE_VALUED"|string;
  13523. export interface Parameters {
  13524. /**
  13525. * The parameters that have a data type of string.
  13526. */
  13527. StringParameters?: StringParameterList;
  13528. /**
  13529. * The parameters that have a data type of integer.
  13530. */
  13531. IntegerParameters?: IntegerParameterList;
  13532. /**
  13533. * The parameters that have a data type of decimal.
  13534. */
  13535. DecimalParameters?: DecimalParameterList;
  13536. /**
  13537. * The parameters that have a data type of date-time.
  13538. */
  13539. DateTimeParameters?: DateTimeParameterList;
  13540. }
  13541. export type Password = string;
  13542. export type Path = Arn[];
  13543. export type PercentNumber = number;
  13544. export interface PercentVisibleRange {
  13545. /**
  13546. * The lower bound of the range.
  13547. */
  13548. From?: PercentNumber;
  13549. /**
  13550. * The top bound of the range.
  13551. */
  13552. To?: PercentNumber;
  13553. }
  13554. export interface PercentageDisplayFormatConfiguration {
  13555. /**
  13556. * Determines the prefix value of the percentage format.
  13557. */
  13558. Prefix?: Prefix;
  13559. /**
  13560. * Determines the suffix value of the percentage format.
  13561. */
  13562. Suffix?: Suffix;
  13563. /**
  13564. * The options that determine the numeric separator configuration.
  13565. */
  13566. SeparatorConfiguration?: NumericSeparatorConfiguration;
  13567. /**
  13568. * The option that determines the decimal places configuration.
  13569. */
  13570. DecimalPlacesConfiguration?: DecimalPlacesConfiguration;
  13571. /**
  13572. * The options that determine the negative value configuration.
  13573. */
  13574. NegativeValueConfiguration?: NegativeValueConfiguration;
  13575. /**
  13576. * The options that determine the null value format configuration.
  13577. */
  13578. NullValueFormatConfiguration?: NullValueFormatConfiguration;
  13579. }
  13580. export interface PercentileAggregation {
  13581. /**
  13582. * The percentile value. This value can be any numeric constant 0–100. A percentile value of 50 computes the median value of the measure.
  13583. */
  13584. PercentileValue?: PercentileValue;
  13585. }
  13586. export type PercentileValue = number;
  13587. export interface PeriodOverPeriodComputation {
  13588. /**
  13589. * The ID for a computation.
  13590. */
  13591. ComputationId: ShortRestrictiveResourceId;
  13592. /**
  13593. * The name of a computation.
  13594. */
  13595. Name?: String;
  13596. /**
  13597. * The time field that is used in a computation.
  13598. */
  13599. Time?: DimensionField;
  13600. /**
  13601. * The value field that is used in a computation.
  13602. */
  13603. Value?: MeasureField;
  13604. }
  13605. export interface PeriodToDateComputation {
  13606. /**
  13607. * The ID for a computation.
  13608. */
  13609. ComputationId: ShortRestrictiveResourceId;
  13610. /**
  13611. * The name of a computation.
  13612. */
  13613. Name?: String;
  13614. /**
  13615. * The time field that is used in a computation.
  13616. */
  13617. Time?: DimensionField;
  13618. /**
  13619. * The value field that is used in a computation.
  13620. */
  13621. Value?: MeasureField;
  13622. /**
  13623. * The time granularity setup of period to date computation. Choose from the following options: YEAR: Year to date. MONTH: Month to date.
  13624. */
  13625. PeriodTimeGranularity?: TimeGranularity;
  13626. }
  13627. export type PeriodsBackward = number;
  13628. export type PeriodsForward = number;
  13629. export interface PhysicalTable {
  13630. /**
  13631. * A physical table type for relational data sources.
  13632. */
  13633. RelationalTable?: RelationalTable;
  13634. /**
  13635. * A physical table type built from the results of the custom SQL query.
  13636. */
  13637. CustomSql?: CustomSql;
  13638. /**
  13639. * A physical table type for as S3 data source.
  13640. */
  13641. S3Source?: S3Source;
  13642. }
  13643. export type PhysicalTableId = string;
  13644. export type PhysicalTableMap = {[key: string]: PhysicalTable};
  13645. export interface PieChartAggregatedFieldWells {
  13646. /**
  13647. * The category (group/color) field wells of a pie chart.
  13648. */
  13649. Category?: DimensionFieldList;
  13650. /**
  13651. * The value field wells of a pie chart. Values are aggregated based on categories.
  13652. */
  13653. Values?: MeasureFieldList;
  13654. /**
  13655. * The small multiples field well of a pie chart.
  13656. */
  13657. SmallMultiples?: SmallMultiplesDimensionFieldList;
  13658. }
  13659. export interface PieChartConfiguration {
  13660. /**
  13661. * The field wells of the visual.
  13662. */
  13663. FieldWells?: PieChartFieldWells;
  13664. /**
  13665. * The sort configuration of a pie chart.
  13666. */
  13667. SortConfiguration?: PieChartSortConfiguration;
  13668. /**
  13669. * The options that determine the shape of the chart. This option determines whether the chart is a pie chart or a donut chart.
  13670. */
  13671. DonutOptions?: DonutOptions;
  13672. /**
  13673. * The small multiples setup for the visual.
  13674. */
  13675. SmallMultiplesOptions?: SmallMultiplesOptions;
  13676. /**
  13677. * The label options of the group/color that is displayed in a pie chart.
  13678. */
  13679. CategoryLabelOptions?: ChartAxisLabelOptions;
  13680. /**
  13681. * The label options for the value that is displayed in a pie chart.
  13682. */
  13683. ValueLabelOptions?: ChartAxisLabelOptions;
  13684. /**
  13685. * The legend display setup of the visual.
  13686. */
  13687. Legend?: LegendOptions;
  13688. /**
  13689. * The options that determine if visual data labels are displayed.
  13690. */
  13691. DataLabels?: DataLabelOptions;
  13692. /**
  13693. * The tooltip display setup of the visual.
  13694. */
  13695. Tooltip?: TooltipOptions;
  13696. /**
  13697. * The palette (chart color) display setup of the visual.
  13698. */
  13699. VisualPalette?: VisualPalette;
  13700. /**
  13701. * The contribution analysis (anomaly configuration) setup of the visual.
  13702. */
  13703. ContributionAnalysisDefaults?: ContributionAnalysisDefaultList;
  13704. /**
  13705. * The general visual interactions setup for a visual.
  13706. */
  13707. Interactions?: VisualInteractionOptions;
  13708. }
  13709. export interface PieChartFieldWells {
  13710. /**
  13711. * The field well configuration of a pie chart.
  13712. */
  13713. PieChartAggregatedFieldWells?: PieChartAggregatedFieldWells;
  13714. }
  13715. export interface PieChartSortConfiguration {
  13716. /**
  13717. * The sort configuration of the category fields.
  13718. */
  13719. CategorySort?: FieldSortOptionsList;
  13720. /**
  13721. * The limit on the number of categories that are displayed in a pie chart.
  13722. */
  13723. CategoryItemsLimit?: ItemsLimitConfiguration;
  13724. /**
  13725. * The sort configuration of the small multiples field.
  13726. */
  13727. SmallMultiplesSort?: FieldSortOptionsList;
  13728. /**
  13729. * The limit on the number of small multiples panels that are displayed.
  13730. */
  13731. SmallMultiplesLimitConfiguration?: ItemsLimitConfiguration;
  13732. }
  13733. export interface PieChartVisual {
  13734. /**
  13735. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  13736. */
  13737. VisualId: ShortRestrictiveResourceId;
  13738. /**
  13739. * The title that is displayed on the visual.
  13740. */
  13741. Title?: VisualTitleLabelOptions;
  13742. /**
  13743. * The subtitle that is displayed on the visual.
  13744. */
  13745. Subtitle?: VisualSubtitleLabelOptions;
  13746. /**
  13747. * The configuration of a pie chart.
  13748. */
  13749. ChartConfiguration?: PieChartConfiguration;
  13750. /**
  13751. * The list of custom actions that are configured for a visual.
  13752. */
  13753. Actions?: VisualCustomActionList;
  13754. /**
  13755. * The column hierarchy that is used during drill-downs and drill-ups.
  13756. */
  13757. ColumnHierarchies?: ColumnHierarchyList;
  13758. }
  13759. export interface PivotFieldSortOptions {
  13760. /**
  13761. * The field ID for the field sort options.
  13762. */
  13763. FieldId: FieldId;
  13764. /**
  13765. * The sort by field for the field sort options.
  13766. */
  13767. SortBy: PivotTableSortBy;
  13768. }
  13769. export type PivotFieldSortOptionsList = PivotFieldSortOptions[];
  13770. export type PivotMeasureFieldList = MeasureField[];
  13771. export interface PivotTableAggregatedFieldWells {
  13772. /**
  13773. * The rows field well for a pivot table. Values are grouped by rows fields.
  13774. */
  13775. Rows?: PivotTableDimensionList;
  13776. /**
  13777. * The columns field well for a pivot table. Values are grouped by columns fields.
  13778. */
  13779. Columns?: PivotTableDimensionList;
  13780. /**
  13781. * The values field well for a pivot table. Values are aggregated based on rows and columns fields.
  13782. */
  13783. Values?: PivotMeasureFieldList;
  13784. }
  13785. export interface PivotTableCellConditionalFormatting {
  13786. /**
  13787. * The field ID of the cell for conditional formatting.
  13788. */
  13789. FieldId: FieldId;
  13790. /**
  13791. * The text format of the cell for conditional formatting.
  13792. */
  13793. TextFormat?: TextConditionalFormat;
  13794. /**
  13795. * The scope of the cell for conditional formatting.
  13796. */
  13797. Scope?: PivotTableConditionalFormattingScope;
  13798. /**
  13799. * A list of cell scopes for conditional formatting.
  13800. */
  13801. Scopes?: PivotTableConditionalFormattingScopeList;
  13802. }
  13803. export interface PivotTableConditionalFormatting {
  13804. /**
  13805. * Conditional formatting options for a PivotTableVisual.
  13806. */
  13807. ConditionalFormattingOptions?: PivotTableConditionalFormattingOptionList;
  13808. }
  13809. export interface PivotTableConditionalFormattingOption {
  13810. /**
  13811. * The cell conditional formatting option for a pivot table.
  13812. */
  13813. Cell?: PivotTableCellConditionalFormatting;
  13814. }
  13815. export type PivotTableConditionalFormattingOptionList = PivotTableConditionalFormattingOption[];
  13816. export interface PivotTableConditionalFormattingScope {
  13817. /**
  13818. * The role (field, field total, grand total) of the cell for conditional formatting.
  13819. */
  13820. Role?: PivotTableConditionalFormattingScopeRole;
  13821. }
  13822. export type PivotTableConditionalFormattingScopeList = PivotTableConditionalFormattingScope[];
  13823. export type PivotTableConditionalFormattingScopeRole = "FIELD"|"FIELD_TOTAL"|"GRAND_TOTAL"|string;
  13824. export interface PivotTableConfiguration {
  13825. /**
  13826. * The field wells of the visual.
  13827. */
  13828. FieldWells?: PivotTableFieldWells;
  13829. /**
  13830. * The sort configuration for a PivotTableVisual.
  13831. */
  13832. SortConfiguration?: PivotTableSortConfiguration;
  13833. /**
  13834. * The table options for a pivot table visual.
  13835. */
  13836. TableOptions?: PivotTableOptions;
  13837. /**
  13838. * The total options for a pivot table visual.
  13839. */
  13840. TotalOptions?: PivotTableTotalOptions;
  13841. /**
  13842. * The field options for a pivot table visual.
  13843. */
  13844. FieldOptions?: PivotTableFieldOptions;
  13845. /**
  13846. * The paginated report options for a pivot table visual.
  13847. */
  13848. PaginatedReportOptions?: PivotTablePaginatedReportOptions;
  13849. /**
  13850. * The general visual interactions setup for a visual.
  13851. */
  13852. Interactions?: VisualInteractionOptions;
  13853. }
  13854. export interface PivotTableDataPathOption {
  13855. /**
  13856. * The list of data path values for the data path options.
  13857. */
  13858. DataPathList: DataPathValueList;
  13859. /**
  13860. * The width of the data path option.
  13861. */
  13862. Width?: PixelLength;
  13863. }
  13864. export type PivotTableDataPathOptionList = PivotTableDataPathOption[];
  13865. export type PivotTableDataPathType = "HIERARCHY_ROWS_LAYOUT_COLUMN"|"MULTIPLE_ROW_METRICS_COLUMN"|"EMPTY_COLUMN_HEADER"|"COUNT_METRIC_COLUMN"|string;
  13866. export type PivotTableDimensionList = DimensionField[];
  13867. export type PivotTableFieldCollapseState = "COLLAPSED"|"EXPANDED"|string;
  13868. export interface PivotTableFieldCollapseStateOption {
  13869. /**
  13870. * A tagged-union object that sets the collapse state.
  13871. */
  13872. Target: PivotTableFieldCollapseStateTarget;
  13873. /**
  13874. * The state of the field target of a pivot table. Choose one of the following options: COLLAPSED EXPANDED
  13875. */
  13876. State?: PivotTableFieldCollapseState;
  13877. }
  13878. export type PivotTableFieldCollapseStateOptionList = PivotTableFieldCollapseStateOption[];
  13879. export interface PivotTableFieldCollapseStateTarget {
  13880. /**
  13881. * The field ID of the pivot table that the collapse state needs to be set to.
  13882. */
  13883. FieldId?: String;
  13884. /**
  13885. * The data path of the pivot table's header. Used to set the collapse state.
  13886. */
  13887. FieldDataPathValues?: DataPathValueList;
  13888. }
  13889. export interface PivotTableFieldOption {
  13890. /**
  13891. * The field ID of the pivot table field.
  13892. */
  13893. FieldId: FieldId;
  13894. /**
  13895. * The custom label of the pivot table field.
  13896. */
  13897. CustomLabel?: CustomLabel;
  13898. /**
  13899. * The visibility of the pivot table field.
  13900. */
  13901. Visibility?: Visibility;
  13902. }
  13903. export type PivotTableFieldOptionList = PivotTableFieldOption[];
  13904. export interface PivotTableFieldOptions {
  13905. /**
  13906. * The selected field options for the pivot table field options.
  13907. */
  13908. SelectedFieldOptions?: PivotTableFieldOptionList;
  13909. /**
  13910. * The data path options for the pivot table field options.
  13911. */
  13912. DataPathOptions?: PivotTableDataPathOptionList;
  13913. /**
  13914. * The collapse state options for the pivot table field options.
  13915. */
  13916. CollapseStateOptions?: PivotTableFieldCollapseStateOptionList;
  13917. }
  13918. export interface PivotTableFieldSubtotalOptions {
  13919. /**
  13920. * The field ID of the subtotal options.
  13921. */
  13922. FieldId?: FieldId;
  13923. }
  13924. export type PivotTableFieldSubtotalOptionsList = PivotTableFieldSubtotalOptions[];
  13925. export interface PivotTableFieldWells {
  13926. /**
  13927. * The aggregated field well for the pivot table.
  13928. */
  13929. PivotTableAggregatedFieldWells?: PivotTableAggregatedFieldWells;
  13930. }
  13931. export type PivotTableMetricPlacement = "ROW"|"COLUMN"|string;
  13932. export interface PivotTableOptions {
  13933. /**
  13934. * The metric placement (row, column) options.
  13935. */
  13936. MetricPlacement?: PivotTableMetricPlacement;
  13937. /**
  13938. * The visibility of the single metric options.
  13939. */
  13940. SingleMetricVisibility?: Visibility;
  13941. /**
  13942. * The visibility of the column names.
  13943. */
  13944. ColumnNamesVisibility?: Visibility;
  13945. /**
  13946. * Determines the visibility of the pivot table.
  13947. */
  13948. ToggleButtonsVisibility?: Visibility;
  13949. /**
  13950. * The table cell style of the column header.
  13951. */
  13952. ColumnHeaderStyle?: TableCellStyle;
  13953. /**
  13954. * The table cell style of the row headers.
  13955. */
  13956. RowHeaderStyle?: TableCellStyle;
  13957. /**
  13958. * The table cell style of cells.
  13959. */
  13960. CellStyle?: TableCellStyle;
  13961. /**
  13962. * The table cell style of row field names.
  13963. */
  13964. RowFieldNamesStyle?: TableCellStyle;
  13965. /**
  13966. * The row alternate color options (widget status, row alternate colors).
  13967. */
  13968. RowAlternateColorOptions?: RowAlternateColorOptions;
  13969. /**
  13970. * The visibility setting of a pivot table's collapsed row dimension fields. If the value of this structure is HIDDEN, all collapsed columns in a pivot table are automatically hidden. The default value is VISIBLE.
  13971. */
  13972. CollapsedRowDimensionsVisibility?: Visibility;
  13973. /**
  13974. * The layout for the row dimension headers of a pivot table. Choose one of the following options. TABULAR: (Default) Each row field is displayed in a separate column. HIERARCHY: All row fields are displayed in a single column. Indentation is used to differentiate row headers of different fields.
  13975. */
  13976. RowsLayout?: PivotTableRowsLayout;
  13977. /**
  13978. * The options for the label that is located above the row headers. This option is only applicable when RowsLayout is set to HIERARCHY.
  13979. */
  13980. RowsLabelOptions?: PivotTableRowsLabelOptions;
  13981. /**
  13982. * The default cell width of the pivot table.
  13983. */
  13984. DefaultCellWidth?: PixelLength;
  13985. }
  13986. export interface PivotTablePaginatedReportOptions {
  13987. /**
  13988. * The visibility of the printing table overflow across pages.
  13989. */
  13990. VerticalOverflowVisibility?: Visibility;
  13991. /**
  13992. * The visibility of the repeating header rows on each page.
  13993. */
  13994. OverflowColumnHeaderVisibility?: Visibility;
  13995. }
  13996. export interface PivotTableRowsLabelOptions {
  13997. /**
  13998. * The visibility of the rows label.
  13999. */
  14000. Visibility?: Visibility;
  14001. /**
  14002. * The custom label string for the rows label.
  14003. */
  14004. CustomLabel?: PivotTableRowsLabelText;
  14005. }
  14006. export type PivotTableRowsLabelText = string;
  14007. export type PivotTableRowsLayout = "TABULAR"|"HIERARCHY"|string;
  14008. export interface PivotTableSortBy {
  14009. /**
  14010. * The field sort (field id, direction) for the pivot table sort by options.
  14011. */
  14012. Field?: FieldSort;
  14013. /**
  14014. * The column sort (field id, direction) for the pivot table sort by options.
  14015. */
  14016. Column?: ColumnSort;
  14017. /**
  14018. * The data path sort (data path value, direction) for the pivot table sort by options.
  14019. */
  14020. DataPath?: DataPathSort;
  14021. }
  14022. export interface PivotTableSortConfiguration {
  14023. /**
  14024. * The field sort options for a pivot table sort configuration.
  14025. */
  14026. FieldSortOptions?: PivotFieldSortOptionsList;
  14027. }
  14028. export type PivotTableSubtotalLevel = "ALL"|"CUSTOM"|"LAST"|string;
  14029. export interface PivotTableTotalOptions {
  14030. /**
  14031. * The row subtotal options.
  14032. */
  14033. RowSubtotalOptions?: SubtotalOptions;
  14034. /**
  14035. * The column subtotal options.
  14036. */
  14037. ColumnSubtotalOptions?: SubtotalOptions;
  14038. /**
  14039. * The row total options.
  14040. */
  14041. RowTotalOptions?: PivotTotalOptions;
  14042. /**
  14043. * The column total options.
  14044. */
  14045. ColumnTotalOptions?: PivotTotalOptions;
  14046. }
  14047. export interface PivotTableVisual {
  14048. /**
  14049. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
  14050. */
  14051. VisualId: ShortRestrictiveResourceId;
  14052. /**
  14053. * The title that is displayed on the visual.
  14054. */
  14055. Title?: VisualTitleLabelOptions;
  14056. /**
  14057. * The subtitle that is displayed on the visual.
  14058. */
  14059. Subtitle?: VisualSubtitleLabelOptions;
  14060. /**
  14061. * The configuration settings of the visual.
  14062. */
  14063. ChartConfiguration?: PivotTableConfiguration;
  14064. /**
  14065. * The conditional formatting for a PivotTableVisual.
  14066. */
  14067. ConditionalFormatting?: PivotTableConditionalFormatting;
  14068. /**
  14069. * The list of custom actions that are configured for a visual.
  14070. */
  14071. Actions?: VisualCustomActionList;
  14072. }
  14073. export interface PivotTotalOptions {
  14074. /**
  14075. * The visibility configuration for the total cells.
  14076. */
  14077. TotalsVisibility?: Visibility;
  14078. /**
  14079. * The placement (start, end) for the total cells.
  14080. */
  14081. Placement?: TableTotalsPlacement;
  14082. /**
  14083. * The scroll status (pinned, scrolled) for the total cells.
  14084. */
  14085. ScrollStatus?: TableTotalsScrollStatus;
  14086. /**
  14087. * The custom label string for the total cells.
  14088. */
  14089. CustomLabel?: String;
  14090. /**
  14091. * The cell styling options for the total cells.
  14092. */
  14093. TotalCellStyle?: TableCellStyle;
  14094. /**
  14095. * The cell styling options for the totals of value cells.
  14096. */
  14097. ValueCellStyle?: TableCellStyle;
  14098. /**
  14099. * The cell styling options for the total of header cells.
  14100. */
  14101. MetricHeaderCellStyle?: TableCellStyle;
  14102. /**
  14103. * The total aggregation options for each value field.
  14104. */
  14105. TotalAggregationOptions?: TotalAggregationOptionList;
  14106. }
  14107. export type PixelLength = string;
  14108. export type Port = number;
  14109. export type PositiveInteger = number;
  14110. export type PositiveLong = number;
  14111. export interface PostgreSqlParameters {
  14112. /**
  14113. * Host.
  14114. */
  14115. Host: Host;
  14116. /**
  14117. * Port.
  14118. */
  14119. Port: Port;
  14120. /**
  14121. * Database.
  14122. */
  14123. Database: Database;
  14124. }
  14125. export interface PredefinedHierarchy {
  14126. /**
  14127. * The hierarchy ID of the predefined hierarchy.
  14128. */
  14129. HierarchyId: HierarchyId;
  14130. /**
  14131. * The list of columns that define the predefined hierarchy.
  14132. */
  14133. Columns: PredefinedHierarchyColumnList;
  14134. /**
  14135. * The option that determines the drill down filters for the predefined hierarchy.
  14136. */
  14137. DrillDownFilters?: DrillDownFilterList;
  14138. }
  14139. export type PredefinedHierarchyColumnList = ColumnIdentifier[];
  14140. export type PredictionInterval = number;
  14141. export type Prefix = string;
  14142. export interface PrestoParameters {
  14143. /**
  14144. * Host.
  14145. */
  14146. Host: Host;
  14147. /**
  14148. * Port.
  14149. */
  14150. Port: Port;
  14151. /**
  14152. * Catalog.
  14153. */
  14154. Catalog: Catalog;
  14155. }
  14156. export type PrimaryValueDisplayType = "HIDDEN"|"COMPARISON"|"ACTUAL"|string;
  14157. export type Principal = string;
  14158. export type PrincipalList = String[];
  14159. export interface ProgressBarOptions {
  14160. /**
  14161. * The visibility of the progress bar.
  14162. */
  14163. Visibility?: Visibility;
  14164. }
  14165. export type ProjectId = string;
  14166. export interface ProjectOperation {
  14167. /**
  14168. * Projected columns.
  14169. */
  14170. ProjectedColumns: ProjectedColumnList;
  14171. }
  14172. export type ProjectedColumnList = String[];
  14173. export type PropertyRole = "PRIMARY"|"ID"|string;
  14174. export type PropertyUsage = "INHERIT"|"DIMENSION"|"MEASURE"|string;
  14175. export type PurchaseMode = "MANUAL"|"AUTO_PURCHASE"|string;
  14176. export interface PutDataSetRefreshPropertiesRequest {
  14177. /**
  14178. * The Amazon Web Services account ID.
  14179. */
  14180. AwsAccountId: AwsAccountId;
  14181. /**
  14182. * The ID of the dataset.
  14183. */
  14184. DataSetId: ResourceId;
  14185. /**
  14186. * The dataset refresh properties.
  14187. */
  14188. DataSetRefreshProperties: DataSetRefreshProperties;
  14189. }
  14190. export interface PutDataSetRefreshPropertiesResponse {
  14191. /**
  14192. * The Amazon Web Services request ID for this operation.
  14193. */
  14194. RequestId?: String;
  14195. /**
  14196. * The HTTP status of the request.
  14197. */
  14198. Status?: StatusCode;
  14199. }
  14200. export type Query = string;
  14201. export interface QueueInfo {
  14202. /**
  14203. * The ID of the queued ingestion.
  14204. */
  14205. WaitingOnIngestion: String;
  14206. /**
  14207. * The ID of the ongoing ingestion. The queued ingestion is waiting for the ongoing ingestion to complete.
  14208. */
  14209. QueuedIngestion: String;
  14210. }
  14211. export interface RadarChartAggregatedFieldWells {
  14212. /**
  14213. * The aggregated field well categories of a radar chart.
  14214. */
  14215. Category?: RadarChartCategoryFieldList;
  14216. /**
  14217. * The color that are assigned to the aggregated field wells of a radar chart.
  14218. */
  14219. Color?: RadarChartColorFieldList;
  14220. /**
  14221. * The values that are assigned to the aggregated field wells of a radar chart.
  14222. */
  14223. Values?: RadarChartValuesFieldList;
  14224. }
  14225. export interface RadarChartAreaStyleSettings {
  14226. /**
  14227. * The visibility settings of a radar chart.
  14228. */
  14229. Visibility?: Visibility;
  14230. }
  14231. export type RadarChartAxesRangeScale = "AUTO"|"INDEPENDENT"|"SHARED"|string;
  14232. export type RadarChartCategoryFieldList = DimensionField[];
  14233. export type RadarChartColorFieldList = DimensionField[];
  14234. export interface RadarChartConfiguration {
  14235. /**
  14236. * The field well configuration of a RadarChartVisual.
  14237. */
  14238. FieldWells?: RadarChartFieldWells;
  14239. /**
  14240. * The sort configuration of a RadarChartVisual.
  14241. */
  14242. SortConfiguration?: RadarChartSortConfiguration;
  14243. /**
  14244. * The shape of the radar chart.
  14245. */
  14246. Shape?: RadarChartShape;
  14247. /**
  14248. * The base sreies settings of a radar chart.
  14249. */
  14250. BaseSeriesSettings?: RadarChartSeriesSettings;
  14251. /**
  14252. * The start angle of a radar chart's axis.
  14253. */
  14254. StartAngle?: RadarChartStartAngle;
  14255. /**
  14256. * The palette (chart color) display setup of the visual.
  14257. */
  14258. VisualPalette?: VisualPalette;
  14259. /**
  14260. * Determines the visibility of the colors of alternatign bands in a radar chart.
  14261. */
  14262. AlternateBandColorsVisibility?: Visibility;
  14263. /**
  14264. * The color of the even-numbered alternate bands of a radar chart.
  14265. */
  14266. AlternateBandEvenColor?: HexColor;
  14267. /**
  14268. * The color of the odd-numbered alternate bands of a radar chart.
  14269. */
  14270. AlternateBandOddColor?: HexColor;
  14271. /**
  14272. * The category axis of a radar chart.
  14273. */
  14274. CategoryAxis?: AxisDisplayOptions;
  14275. /**
  14276. * The category label options of a radar chart.
  14277. */
  14278. CategoryLabelOptions?: ChartAxisLabelOptions;
  14279. /**
  14280. * The color axis of a radar chart.
  14281. */
  14282. ColorAxis?: AxisDisplayOptions;
  14283. /**
  14284. * The color label options of a radar chart.
  14285. */
  14286. ColorLabelOptions?: ChartAxisLabelOptions;
  14287. /**
  14288. * The legend display setup of the visual.
  14289. */
  14290. Legend?: LegendOptions;
  14291. /**
  14292. * The axis behavior options of a radar chart.
  14293. */
  14294. AxesRangeScale?: RadarChartAxesRangeScale;
  14295. /**
  14296. * The general visual interactions setup for a visual.
  14297. */
  14298. Interactions?: VisualInteractionOptions;
  14299. }
  14300. export interface RadarChartFieldWells {
  14301. /**
  14302. * The aggregated field wells of a radar chart visual.
  14303. */
  14304. RadarChartAggregatedFieldWells?: RadarChartAggregatedFieldWells;
  14305. }
  14306. export interface RadarChartSeriesSettings {
  14307. /**
  14308. * The area style settings of a radar chart.
  14309. */
  14310. AreaStyleSettings?: RadarChartAreaStyleSettings;
  14311. }
  14312. export type RadarChartShape = "CIRCLE"|"POLYGON"|string;
  14313. export interface RadarChartSortConfiguration {
  14314. /**
  14315. * The category sort options of a radar chart.
  14316. */
  14317. CategorySort?: FieldSortOptionsList;
  14318. /**
  14319. * The category items limit for a radar chart.
  14320. */
  14321. CategoryItemsLimit?: ItemsLimitConfiguration;
  14322. /**
  14323. * The color sort configuration of a radar chart.
  14324. */
  14325. ColorSort?: FieldSortOptionsList;
  14326. /**
  14327. * The color items limit of a radar chart.
  14328. */
  14329. ColorItemsLimit?: ItemsLimitConfiguration;
  14330. }
  14331. export type RadarChartStartAngle = number;
  14332. export type RadarChartValuesFieldList = MeasureField[];
  14333. export interface RadarChartVisual {
  14334. /**
  14335. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  14336. */
  14337. VisualId: ShortRestrictiveResourceId;
  14338. /**
  14339. * The title that is displayed on the visual.
  14340. */
  14341. Title?: VisualTitleLabelOptions;
  14342. /**
  14343. * The subtitle that is displayed on the visual.
  14344. */
  14345. Subtitle?: VisualSubtitleLabelOptions;
  14346. /**
  14347. * The configuration settings of the visual.
  14348. */
  14349. ChartConfiguration?: RadarChartConfiguration;
  14350. /**
  14351. * The list of custom actions that are configured for a visual.
  14352. */
  14353. Actions?: VisualCustomActionList;
  14354. /**
  14355. * The column hierarchy that is used during drill-downs and drill-ups.
  14356. */
  14357. ColumnHierarchies?: ColumnHierarchyList;
  14358. }
  14359. export interface RangeConstant {
  14360. /**
  14361. * The minimum value for a range constant.
  14362. */
  14363. Minimum?: LimitedString;
  14364. /**
  14365. * The maximum value for a range constant.
  14366. */
  14367. Maximum?: LimitedString;
  14368. }
  14369. export interface RangeEndsLabelType {
  14370. /**
  14371. * The visibility of the range ends label.
  14372. */
  14373. Visibility?: Visibility;
  14374. }
  14375. export interface RdsParameters {
  14376. /**
  14377. * Instance ID.
  14378. */
  14379. InstanceId: InstanceId;
  14380. /**
  14381. * Database.
  14382. */
  14383. Database: Database;
  14384. }
  14385. export type RecoveryWindowInDays = number;
  14386. export interface RedshiftIAMParameters {
  14387. /**
  14388. * Use the RoleArn structure to allow Amazon QuickSight to call redshift:GetClusterCredentials on your cluster. The calling principal must have iam:PassRole access to pass the role to Amazon QuickSight. The role's trust policy must allow the Amazon QuickSight service principal to assume the role.
  14389. */
  14390. RoleArn: RoleArn;
  14391. /**
  14392. * The user whose permissions and group memberships will be used by Amazon QuickSight to access the cluster. If this user already exists in your database, Amazon QuickSight is granted the same permissions that the user has. If the user doesn't exist, set the value of AutoCreateDatabaseUser to True to create a new user with PUBLIC permissions.
  14393. */
  14394. DatabaseUser: DatabaseUser;
  14395. /**
  14396. * A list of groups whose permissions will be granted to Amazon QuickSight to access the cluster. These permissions are combined with the permissions granted to Amazon QuickSight by the DatabaseUser. If you choose to include this parameter, the RoleArn must grant access to redshift:JoinGroup.
  14397. */
  14398. DatabaseGroups?: DatabaseGroupList;
  14399. /**
  14400. * Automatically creates a database user. If your database doesn't have a DatabaseUser, set this parameter to True. If there is no DatabaseUser, Amazon QuickSight can't connect to your cluster. The RoleArn that you use for this operation must grant access to redshift:CreateClusterUser to successfully create the user.
  14401. */
  14402. AutoCreateDatabaseUser?: Boolean;
  14403. }
  14404. export interface RedshiftParameters {
  14405. /**
  14406. * Host. This field can be blank if ClusterId is provided.
  14407. */
  14408. Host?: Host;
  14409. /**
  14410. * Port. This field can be blank if the ClusterId is provided.
  14411. */
  14412. Port?: OptionalPort;
  14413. /**
  14414. * Database.
  14415. */
  14416. Database: Database;
  14417. /**
  14418. * Cluster ID. This field can be blank if the Host and Port are provided.
  14419. */
  14420. ClusterId?: ClusterId;
  14421. /**
  14422. * An optional parameter that uses IAM authentication to grant Amazon QuickSight access to your cluster. This parameter can be used instead of DataSourceCredentials.
  14423. */
  14424. IAMParameters?: RedshiftIAMParameters;
  14425. /**
  14426. * An optional parameter that configures IAM Identity Center authentication to grant Amazon QuickSight access to your cluster. This parameter can only be specified if your Amazon QuickSight account is configured with IAM Identity Center.
  14427. */
  14428. IdentityCenterConfiguration?: IdentityCenterConfiguration;
  14429. }
  14430. export interface ReferenceLine {
  14431. /**
  14432. * The status of the reference line. Choose one of the following options: ENABLE DISABLE
  14433. */
  14434. Status?: WidgetStatus;
  14435. /**
  14436. * The data configuration of the reference line.
  14437. */
  14438. DataConfiguration: ReferenceLineDataConfiguration;
  14439. /**
  14440. * The style configuration of the reference line.
  14441. */
  14442. StyleConfiguration?: ReferenceLineStyleConfiguration;
  14443. /**
  14444. * The label configuration of the reference line.
  14445. */
  14446. LabelConfiguration?: ReferenceLineLabelConfiguration;
  14447. }
  14448. export interface ReferenceLineCustomLabelConfiguration {
  14449. /**
  14450. * The string text of the custom label.
  14451. */
  14452. CustomLabel: NonEmptyString;
  14453. }
  14454. export interface ReferenceLineDataConfiguration {
  14455. /**
  14456. * The static data configuration of the reference line data configuration.
  14457. */
  14458. StaticConfiguration?: ReferenceLineStaticDataConfiguration;
  14459. /**
  14460. * The dynamic configuration of the reference line data configuration.
  14461. */
  14462. DynamicConfiguration?: ReferenceLineDynamicDataConfiguration;
  14463. /**
  14464. * The axis binding type of the reference line. Choose one of the following options: PrimaryY SecondaryY
  14465. */
  14466. AxisBinding?: AxisBinding;
  14467. /**
  14468. * The series type of the reference line data configuration. Choose one of the following options: BAR LINE
  14469. */
  14470. SeriesType?: ReferenceLineSeriesType;
  14471. }
  14472. export interface ReferenceLineDynamicDataConfiguration {
  14473. /**
  14474. * The column that the dynamic data targets.
  14475. */
  14476. Column: ColumnIdentifier;
  14477. /**
  14478. * The aggregation function that is used in the dynamic data.
  14479. */
  14480. MeasureAggregationFunction?: AggregationFunction;
  14481. /**
  14482. * The calculation that is used in the dynamic data.
  14483. */
  14484. Calculation: NumericalAggregationFunction;
  14485. }
  14486. export interface ReferenceLineLabelConfiguration {
  14487. /**
  14488. * The value label configuration of the label in a reference line.
  14489. */
  14490. ValueLabelConfiguration?: ReferenceLineValueLabelConfiguration;
  14491. /**
  14492. * The custom label configuration of the label in a reference line.
  14493. */
  14494. CustomLabelConfiguration?: ReferenceLineCustomLabelConfiguration;
  14495. /**
  14496. * The font configuration of the label in a reference line.
  14497. */
  14498. FontConfiguration?: FontConfiguration;
  14499. /**
  14500. * The font color configuration of the label in a reference line.
  14501. */
  14502. FontColor?: HexColor;
  14503. /**
  14504. * The horizontal position configuration of the label in a reference line. Choose one of the following options: LEFT CENTER RIGHT
  14505. */
  14506. HorizontalPosition?: ReferenceLineLabelHorizontalPosition;
  14507. /**
  14508. * The vertical position configuration of the label in a reference line. Choose one of the following options: ABOVE BELOW
  14509. */
  14510. VerticalPosition?: ReferenceLineLabelVerticalPosition;
  14511. }
  14512. export type ReferenceLineLabelHorizontalPosition = "LEFT"|"CENTER"|"RIGHT"|string;
  14513. export type ReferenceLineLabelVerticalPosition = "ABOVE"|"BELOW"|string;
  14514. export type ReferenceLineList = ReferenceLine[];
  14515. export type ReferenceLinePatternType = "SOLID"|"DASHED"|"DOTTED"|string;
  14516. export type ReferenceLineSeriesType = "BAR"|"LINE"|string;
  14517. export interface ReferenceLineStaticDataConfiguration {
  14518. /**
  14519. * The double input of the static data.
  14520. */
  14521. Value: SensitiveDouble;
  14522. }
  14523. export interface ReferenceLineStyleConfiguration {
  14524. /**
  14525. * The pattern type of the line style. Choose one of the following options: SOLID DASHED DOTTED
  14526. */
  14527. Pattern?: ReferenceLinePatternType;
  14528. /**
  14529. * The hex color of the reference line.
  14530. */
  14531. Color?: HexColor;
  14532. }
  14533. export interface ReferenceLineValueLabelConfiguration {
  14534. /**
  14535. * The relative position of the value label. Choose one of the following options: BEFORE_CUSTOM_LABEL AFTER_CUSTOM_LABEL
  14536. */
  14537. RelativePosition?: ReferenceLineValueLabelRelativePosition;
  14538. /**
  14539. * The format configuration of the value label.
  14540. */
  14541. FormatConfiguration?: NumericFormatConfiguration;
  14542. }
  14543. export type ReferenceLineValueLabelRelativePosition = "BEFORE_CUSTOM_LABEL"|"AFTER_CUSTOM_LABEL"|string;
  14544. export interface RefreshConfiguration {
  14545. /**
  14546. * The incremental refresh for the dataset.
  14547. */
  14548. IncrementalRefresh: IncrementalRefresh;
  14549. }
  14550. export interface RefreshFrequency {
  14551. /**
  14552. * The interval between scheduled refreshes. Valid values are as follows: MINUTE15: The dataset refreshes every 15 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset. MINUTE30:The dataset refreshes every 30 minutes. This value is only supported for incremental refreshes. This interval can only be used for one schedule per dataset. HOURLY: The dataset refreshes every hour. This interval can only be used for one schedule per dataset. DAILY: The dataset refreshes every day. WEEKLY: The dataset refreshes every week. MONTHLY: The dataset refreshes every month.
  14553. */
  14554. Interval: RefreshInterval;
  14555. /**
  14556. * The day of the week that you want to schedule the refresh on. This value is required for weekly and monthly refresh intervals.
  14557. */
  14558. RefreshOnDay?: ScheduleRefreshOnEntity;
  14559. /**
  14560. * The timezone that you want the refresh schedule to use. The timezone ID must match a corresponding ID found on java.util.time.getAvailableIDs().
  14561. */
  14562. Timezone?: String;
  14563. /**
  14564. * The time of day that you want the datset to refresh. This value is expressed in HH:MM format. This field is not required for schedules that refresh hourly.
  14565. */
  14566. TimeOfTheDay?: String;
  14567. }
  14568. export type RefreshInterval = "MINUTE15"|"MINUTE30"|"HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|string;
  14569. export interface RefreshSchedule {
  14570. /**
  14571. * An identifier for the refresh schedule.
  14572. */
  14573. ScheduleId: String;
  14574. /**
  14575. * The frequency for the refresh schedule.
  14576. */
  14577. ScheduleFrequency: RefreshFrequency;
  14578. /**
  14579. * Time after which the refresh schedule can be started, expressed in YYYY-MM-DDTHH:MM:SS format.
  14580. */
  14581. StartAfterDateTime?: Timestamp;
  14582. /**
  14583. * The type of refresh that a datset undergoes. Valid values are as follows: FULL_REFRESH: A complete refresh of a dataset. INCREMENTAL_REFRESH: A partial refresh of some rows of a dataset, based on the time window specified. For more information on full and incremental refreshes, see Refreshing SPICE data in the Amazon QuickSight User Guide.
  14584. */
  14585. RefreshType: IngestionType;
  14586. /**
  14587. * The Amazon Resource Name (ARN) for the refresh schedule.
  14588. */
  14589. Arn?: Arn;
  14590. }
  14591. export type RefreshSchedules = RefreshSchedule[];
  14592. export interface RegisterUserRequest {
  14593. /**
  14594. * The identity type that your Amazon QuickSight account uses to manage the identity of users.
  14595. */
  14596. IdentityType: IdentityType;
  14597. /**
  14598. * The email address of the user that you want to register.
  14599. */
  14600. Email: String;
  14601. /**
  14602. * The Amazon QuickSight role for the user. The user role can be one of the following: READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, datasets, analyses, and dashboards. ADMIN: A user who is an author, who can also manage Amazon QuickSight settings. RESTRICTED_READER: This role isn't currently available for use. RESTRICTED_AUTHOR: This role isn't currently available for use.
  14603. */
  14604. UserRole: UserRole;
  14605. /**
  14606. * The ARN of the IAM user or role that you are registering with Amazon QuickSight.
  14607. */
  14608. IamArn?: String;
  14609. /**
  14610. * You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the CLI Reference.
  14611. */
  14612. SessionName?: RoleSessionName;
  14613. /**
  14614. * The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  14615. */
  14616. AwsAccountId: AwsAccountId;
  14617. /**
  14618. * The namespace. Currently, you should set this to default.
  14619. */
  14620. Namespace: Namespace;
  14621. /**
  14622. * The Amazon QuickSight user name that you want to create for the user you are registering.
  14623. */
  14624. UserName?: UserName;
  14625. /**
  14626. * (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations: Create and update data sources Create and update datasets Create and update email reports Subscribe to email reports To add custom permissions to an existing user, use UpdateUser instead. A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user. Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader, admin pro, author pro, reader pro). This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
  14627. */
  14628. CustomPermissionsName?: RoleName;
  14629. /**
  14630. * The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following. COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom. CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.
  14631. */
  14632. ExternalLoginFederationProviderType?: String;
  14633. /**
  14634. * The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
  14635. */
  14636. CustomFederationProviderUrl?: String;
  14637. /**
  14638. * The identity ID for a user in the external login provider.
  14639. */
  14640. ExternalLoginId?: String;
  14641. /**
  14642. * The tags to associate with the user.
  14643. */
  14644. Tags?: TagList;
  14645. }
  14646. export interface RegisterUserResponse {
  14647. /**
  14648. * The user's user name.
  14649. */
  14650. User?: User;
  14651. /**
  14652. * The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.
  14653. */
  14654. UserInvitationUrl?: String;
  14655. /**
  14656. * The Amazon Web Services request ID for this operation.
  14657. */
  14658. RequestId?: String;
  14659. /**
  14660. * The HTTP status of the request.
  14661. */
  14662. Status?: StatusCode;
  14663. }
  14664. export interface RegisteredUserConsoleFeatureConfigurations {
  14665. /**
  14666. * The state persistence configurations of an embedded Amazon QuickSight console.
  14667. */
  14668. StatePersistence?: StatePersistenceConfigurations;
  14669. }
  14670. export interface RegisteredUserDashboardEmbeddingConfiguration {
  14671. /**
  14672. * The dashboard ID for the dashboard that you want the user to see first. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this dashboard if the user has permissions to view it. If the user does not have permission to view this dashboard, they see a permissions error message.
  14673. */
  14674. InitialDashboardId: ShortRestrictiveResourceId;
  14675. /**
  14676. * The feature configurations of an embbedded Amazon QuickSight dashboard.
  14677. */
  14678. FeatureConfigurations?: RegisteredUserDashboardFeatureConfigurations;
  14679. }
  14680. export interface RegisteredUserDashboardFeatureConfigurations {
  14681. /**
  14682. * The state persistence settings of an embedded dashboard.
  14683. */
  14684. StatePersistence?: StatePersistenceConfigurations;
  14685. /**
  14686. * The bookmarks configuration for an embedded dashboard in Amazon QuickSight.
  14687. */
  14688. Bookmarks?: BookmarksConfigurations;
  14689. }
  14690. export interface RegisteredUserDashboardVisualEmbeddingConfiguration {
  14691. /**
  14692. * The visual ID for the visual that you want the user to embed. This ID is included in the output URL. When the URL in response is accessed, Amazon QuickSight renders this visual. The Amazon Resource Name (ARN) of the dashboard that the visual belongs to must be included in the AuthorizedResourceArns parameter. Otherwise, the request will fail with InvalidParameterValueException.
  14693. */
  14694. InitialDashboardVisualId: DashboardVisualId;
  14695. }
  14696. export interface RegisteredUserEmbeddingExperienceConfiguration {
  14697. /**
  14698. * The configuration details for providing a dashboard embedding experience.
  14699. */
  14700. Dashboard?: RegisteredUserDashboardEmbeddingConfiguration;
  14701. /**
  14702. * The configuration details for providing each Amazon QuickSight console embedding experience. This can be used along with custom permissions to restrict access to certain features. For more information, see Customizing Access to the Amazon QuickSight Console in the Amazon QuickSight User Guide. Use GenerateEmbedUrlForRegisteredUser where you want to provide an authoring portal that allows users to create data sources, datasets, analyses, and dashboards. The users who accesses an embedded Amazon QuickSight console needs to belong to the author or admin security cohort. If you want to restrict permissions to some of these features, add a custom permissions profile to the user with the UpdateUser API operation. Use the RegisterUser API operation to add a new user with a custom permission profile attached. For more information, see the following sections in the Amazon QuickSight User Guide: Embedding the Full Functionality of the Amazon QuickSight Console for Authenticated Users Customizing Access to the Amazon QuickSight Console For more information about the high-level steps for embedding and for an interactive demo of the ways you can customize embedding, visit the Amazon QuickSight Developer Portal.
  14703. */
  14704. QuickSightConsole?: RegisteredUserQuickSightConsoleEmbeddingConfiguration;
  14705. /**
  14706. * The configuration details for embedding the Q search bar. For more information about embedding the Q search bar, see Embedding Overview in the Amazon QuickSight User Guide.
  14707. */
  14708. QSearchBar?: RegisteredUserQSearchBarEmbeddingConfiguration;
  14709. /**
  14710. * The type of embedding experience. In this case, Amazon QuickSight visuals.
  14711. */
  14712. DashboardVisual?: RegisteredUserDashboardVisualEmbeddingConfiguration;
  14713. /**
  14714. * The configuration details for embedding the Generative Q&amp;A experience. For more information about embedding the Generative Q&amp;A experience, see Embedding Overview in the Amazon QuickSight User Guide.
  14715. */
  14716. GenerativeQnA?: RegisteredUserGenerativeQnAEmbeddingConfiguration;
  14717. }
  14718. export interface RegisteredUserGenerativeQnAEmbeddingConfiguration {
  14719. /**
  14720. * The ID of the new Q reader experience topic that you want to make the starting topic in the Generative Q&amp;A experience. You can find a topic ID by navigating to the Topics pane in the Amazon QuickSight application and opening a topic. The ID is in the URL for the topic that you open. If you don't specify an initial topic or you specify a legacy topic, a list of all shared new reader experience topics is shown in the Generative Q&amp;A experience for your readers. When you select an initial new reader experience topic, you can specify whether or not readers are allowed to select other new reader experience topics from the available ones in the list.
  14721. */
  14722. InitialTopicId?: RestrictiveResourceId;
  14723. }
  14724. export interface RegisteredUserQSearchBarEmbeddingConfiguration {
  14725. /**
  14726. * The ID of the legacy Q topic that you want to use as the starting topic in the Q search bar. To locate the topic ID of the topic that you want to use, open the Amazon QuickSight console, navigate to the Topics pane, and choose thre topic that you want to use. The TopicID is located in the URL of the topic that opens. When you select an initial topic, you can specify whether or not readers are allowed to select other topics from the list of available topics. If you don't specify an initial topic or if you specify a new reader experience topic, a list of all shared legacy topics is shown in the Q bar.
  14727. */
  14728. InitialTopicId?: RestrictiveResourceId;
  14729. }
  14730. export interface RegisteredUserQuickSightConsoleEmbeddingConfiguration {
  14731. /**
  14732. * The initial URL path for the Amazon QuickSight console. InitialPath is required. The entry point URL is constrained to the following paths: /start /start/analyses /start/dashboards /start/favorites /dashboards/DashboardId. DashboardId is the actual ID key from the Amazon QuickSight console URL of the dashboard. /analyses/AnalysisId. AnalysisId is the actual ID key from the Amazon QuickSight console URL of the analysis.
  14733. */
  14734. InitialPath?: EntryPath;
  14735. /**
  14736. * The embedding configuration of an embedded Amazon QuickSight console.
  14737. */
  14738. FeatureConfigurations?: RegisteredUserConsoleFeatureConfigurations;
  14739. }
  14740. export interface RelationalTable {
  14741. /**
  14742. * The Amazon Resource Name (ARN) for the data source.
  14743. */
  14744. DataSourceArn: Arn;
  14745. /**
  14746. * The catalog associated with a table.
  14747. */
  14748. Catalog?: RelationalTableCatalog;
  14749. /**
  14750. * The schema name. This name applies to certain relational database engines.
  14751. */
  14752. Schema?: RelationalTableSchema;
  14753. /**
  14754. * The name of the relational table.
  14755. */
  14756. Name: RelationalTableName;
  14757. /**
  14758. * The column schema of the table.
  14759. */
  14760. InputColumns: InputColumnList;
  14761. }
  14762. export type RelationalTableCatalog = string;
  14763. export type RelationalTableName = string;
  14764. export type RelationalTableSchema = string;
  14765. export interface RelativeDateTimeControlDisplayOptions {
  14766. /**
  14767. * The options to configure the title visibility, name, and font size.
  14768. */
  14769. TitleOptions?: LabelOptions;
  14770. /**
  14771. * Customize how dates are formatted in controls.
  14772. */
  14773. DateTimeFormat?: DateTimeFormat;
  14774. /**
  14775. * The configuration of info icon label options.
  14776. */
  14777. InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
  14778. }
  14779. export type RelativeDateType = "PREVIOUS"|"THIS"|"LAST"|"NOW"|"NEXT"|string;
  14780. export interface RelativeDatesFilter {
  14781. /**
  14782. * An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
  14783. */
  14784. FilterId: ShortRestrictiveResourceId;
  14785. /**
  14786. * The column that the filter is applied to.
  14787. */
  14788. Column: ColumnIdentifier;
  14789. /**
  14790. * The date configuration of the filter.
  14791. */
  14792. AnchorDateConfiguration: AnchorDateConfiguration;
  14793. /**
  14794. * The minimum granularity (period granularity) of the relative dates filter.
  14795. */
  14796. MinimumGranularity?: TimeGranularity;
  14797. /**
  14798. * The level of time precision that is used to aggregate DateTime values.
  14799. */
  14800. TimeGranularity: TimeGranularity;
  14801. /**
  14802. * The range date type of the filter. Choose one of the options below: PREVIOUS THIS LAST NOW NEXT
  14803. */
  14804. RelativeDateType: RelativeDateType;
  14805. /**
  14806. * The date value of the filter.
  14807. */
  14808. RelativeDateValue?: Integer;
  14809. /**
  14810. * The parameter whose value should be used for the filter value.
  14811. */
  14812. ParameterName?: ParameterName;
  14813. /**
  14814. * This option determines how null values should be treated when filtering data. ALL_VALUES: Include null values in filtered results. NULLS_ONLY: Only include null values in filtered results. NON_NULLS_ONLY: Exclude null values from filtered results.
  14815. */
  14816. NullOption: FilterNullOption;
  14817. /**
  14818. * The configuration for the exclude period of the filter.
  14819. */
  14820. ExcludePeriodConfiguration?: ExcludePeriodConfiguration;
  14821. /**
  14822. * The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
  14823. */
  14824. DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
  14825. }
  14826. export type RelativeFontSize = "EXTRA_SMALL"|"SMALL"|"MEDIUM"|"LARGE"|"EXTRA_LARGE"|string;
  14827. export interface RenameColumnOperation {
  14828. /**
  14829. * The name of the column to be renamed.
  14830. */
  14831. ColumnName: ColumnName;
  14832. /**
  14833. * The new name for the column.
  14834. */
  14835. NewColumnName: ColumnName;
  14836. }
  14837. export type ResizeOption = "FIXED"|"RESPONSIVE"|string;
  14838. export type ResourceId = string;
  14839. export type ResourceName = string;
  14840. export interface ResourcePermission {
  14841. /**
  14842. * The Amazon Resource Name (ARN) of the principal. This can be one of the following: The ARN of an Amazon QuickSight user or group associated with a data source or dataset. (This is common.) The ARN of an Amazon QuickSight user, group, or namespace associated with an analysis, dashboard, template, or theme. (This is common.) The ARN of an Amazon Web Services account root: This is an IAM ARN rather than a QuickSight ARN. Use this option only to share resources (templates) across Amazon Web Services accounts. (This is less common.)
  14843. */
  14844. Principal: Principal;
  14845. /**
  14846. * The IAM action to grant or revoke permissions on.
  14847. */
  14848. Actions: ActionList;
  14849. }
  14850. export type ResourcePermissionList = ResourcePermission[];
  14851. export type ResourceStatus = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|"DELETED"|string;
  14852. export interface RestoreAnalysisRequest {
  14853. /**
  14854. * The ID of the Amazon Web Services account that contains the analysis.
  14855. */
  14856. AwsAccountId: AwsAccountId;
  14857. /**
  14858. * The ID of the analysis that you're restoring.
  14859. */
  14860. AnalysisId: ShortRestrictiveResourceId;
  14861. }
  14862. export interface RestoreAnalysisResponse {
  14863. /**
  14864. * The HTTP status of the request.
  14865. */
  14866. Status?: StatusCode;
  14867. /**
  14868. * The Amazon Resource Name (ARN) of the analysis that you're restoring.
  14869. */
  14870. Arn?: Arn;
  14871. /**
  14872. * The ID of the analysis that you're restoring.
  14873. */
  14874. AnalysisId?: ShortRestrictiveResourceId;
  14875. /**
  14876. * The Amazon Web Services request ID for this operation.
  14877. */
  14878. RequestId?: String;
  14879. }
  14880. export type RestrictiveResourceId = string;
  14881. export type Role = "ADMIN"|"AUTHOR"|"READER"|"ADMIN_PRO"|"AUTHOR_PRO"|"READER_PRO"|string;
  14882. export type RoleArn = string;
  14883. export type RoleName = string;
  14884. export type RoleSessionName = string;
  14885. export interface RollingDateConfiguration {
  14886. /**
  14887. * The data set that is used in the rolling date configuration.
  14888. */
  14889. DataSetIdentifier?: DataSetIdentifier;
  14890. /**
  14891. * The expression of the rolling date configuration.
  14892. */
  14893. Expression: Expression;
  14894. }
  14895. export type RowAlternateColorList = HexColor[];
  14896. export interface RowAlternateColorOptions {
  14897. /**
  14898. * Determines the widget status.
  14899. */
  14900. Status?: WidgetStatus;
  14901. /**
  14902. * Determines the list of row alternate colors.
  14903. */
  14904. RowAlternateColors?: RowAlternateColorList;
  14905. /**
  14906. * The primary background color options for alternate rows.
  14907. */
  14908. UsePrimaryBackgroundColor?: WidgetStatus;
  14909. }
  14910. export interface RowInfo {
  14911. /**
  14912. * The number of rows that were ingested.
  14913. */
  14914. RowsIngested?: Long;
  14915. /**
  14916. * The number of rows that were not ingested.
  14917. */
  14918. RowsDropped?: Long;
  14919. /**
  14920. * The total number of rows in the dataset.
  14921. */
  14922. TotalRowsInDataset?: Long;
  14923. }
  14924. export interface RowLevelPermissionDataSet {
  14925. /**
  14926. * The namespace associated with the dataset that contains permissions for RLS.
  14927. */
  14928. Namespace?: Namespace;
  14929. /**
  14930. * The Amazon Resource Name (ARN) of the dataset that contains permissions for RLS.
  14931. */
  14932. Arn: Arn;
  14933. /**
  14934. * The type of permissions to use when interpreting the permissions for RLS. DENY_ACCESS is included for backward compatibility only.
  14935. */
  14936. PermissionPolicy: RowLevelPermissionPolicy;
  14937. /**
  14938. * The user or group rules associated with the dataset that contains permissions for RLS. By default, FormatVersion is VERSION_1. When FormatVersion is VERSION_1, UserName and GroupName are required. When FormatVersion is VERSION_2, UserARN and GroupARN are required, and Namespace must not exist.
  14939. */
  14940. FormatVersion?: RowLevelPermissionFormatVersion;
  14941. /**
  14942. * The status of the row-level security permission dataset. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
  14943. */
  14944. Status?: Status;
  14945. }
  14946. export type RowLevelPermissionFormatVersion = "VERSION_1"|"VERSION_2"|string;
  14947. export type RowLevelPermissionPolicy = "GRANT_ACCESS"|"DENY_ACCESS"|string;
  14948. export interface RowLevelPermissionTagConfiguration {
  14949. /**
  14950. * The status of row-level security tags. If enabled, the status is ENABLED. If disabled, the status is DISABLED.
  14951. */
  14952. Status?: Status;
  14953. /**
  14954. * A set of rules associated with row-level security, such as the tag names and columns that they are assigned to.
  14955. */
  14956. TagRules: RowLevelPermissionTagRuleList;
  14957. /**
  14958. * A list of tag configuration rules to apply to a dataset. All tag configurations have the OR condition. Tags within each tile will be joined (AND). At least one rule in this structure must have all tag values assigned to it to apply Row-level security (RLS) to the dataset.
  14959. */
  14960. TagRuleConfigurations?: RowLevelPermissionTagRuleConfigurationList;
  14961. }
  14962. export type RowLevelPermissionTagDelimiter = string;
  14963. export interface RowLevelPermissionTagRule {
  14964. /**
  14965. * The unique key for a tag.
  14966. */
  14967. TagKey: SessionTagKey;
  14968. /**
  14969. * The column name that a tag key is assigned to.
  14970. */
  14971. ColumnName: String;
  14972. /**
  14973. * A string that you want to use to delimit the values when you pass the values at run time. For example, you can delimit the values with a comma.
  14974. */
  14975. TagMultiValueDelimiter?: RowLevelPermissionTagDelimiter;
  14976. /**
  14977. * A string that you want to use to filter by all the values in a column in the dataset and don’t want to list the values one by one. For example, you can use an asterisk as your match all value.
  14978. */
  14979. MatchAllValue?: SessionTagValue;
  14980. }
  14981. export type RowLevelPermissionTagRuleConfiguration = SessionTagKey[];
  14982. export type RowLevelPermissionTagRuleConfigurationList = RowLevelPermissionTagRuleConfiguration[];
  14983. export type RowLevelPermissionTagRuleList = RowLevelPermissionTagRule[];
  14984. export type RowSortList = FieldSortOptions[];
  14985. export type S3Bucket = string;
  14986. export interface S3BucketConfiguration {
  14987. /**
  14988. * The name of an existing Amazon S3 bucket where the generated snapshot artifacts are sent.
  14989. */
  14990. BucketName: NonEmptyString;
  14991. /**
  14992. * The prefix of the Amazon S3 bucket that the generated snapshots are stored in.
  14993. */
  14994. BucketPrefix: NonEmptyString;
  14995. /**
  14996. * The region that the Amazon S3 bucket is located in. The bucket must be located in the same region that the StartDashboardSnapshotJob API call is made.
  14997. */
  14998. BucketRegion: NonEmptyString;
  14999. }
  15000. export type S3Key = string;
  15001. export interface S3Parameters {
  15002. /**
  15003. * Location of the Amazon S3 manifest file. This is NULL if the manifest file was uploaded into Amazon QuickSight.
  15004. */
  15005. ManifestFileLocation: ManifestFileLocation;
  15006. /**
  15007. * Use the RoleArn structure to override an account-wide role for a specific S3 data source. For example, say an account administrator has turned off all S3 access with an account-wide role. The administrator can then use RoleArn to bypass the account-wide role and allow S3 access for the single S3 data source that is specified in the structure, even if the account-wide role forbidding S3 access is still active.
  15008. */
  15009. RoleArn?: RoleArn;
  15010. }
  15011. export interface S3Source {
  15012. /**
  15013. * The Amazon Resource Name (ARN) for the data source.
  15014. */
  15015. DataSourceArn: Arn;
  15016. /**
  15017. * Information about the format for the S3 source file or files.
  15018. */
  15019. UploadSettings?: UploadSettings;
  15020. /**
  15021. * A physical table type for an S3 data source. For files that aren't JSON, only STRING data types are supported in input columns.
  15022. */
  15023. InputColumns: InputColumnList;
  15024. }
  15025. export type S3Uri = string;
  15026. export interface SameSheetTargetVisualConfiguration {
  15027. /**
  15028. * A list of the target visual IDs that are located in the same sheet of the analysis.
  15029. */
  15030. TargetVisuals?: TargetVisualList;
  15031. /**
  15032. * The options that choose the target visual in the same sheet. Valid values are defined as follows: ALL_VISUALS: Applies the filter operation to all visuals in the same sheet.
  15033. */
  15034. TargetVisualOptions?: TargetVisualOptions;
  15035. }
  15036. export interface SankeyDiagramAggregatedFieldWells {
  15037. /**
  15038. * The source field wells of a sankey diagram.
  15039. */
  15040. Source?: DimensionFieldList;
  15041. /**
  15042. * The destination field wells of a sankey diagram.
  15043. */
  15044. Destination?: DimensionFieldList;
  15045. /**
  15046. * The weight field wells of a sankey diagram.
  15047. */
  15048. Weight?: MeasureFieldList;
  15049. }
  15050. export interface SankeyDiagramChartConfiguration {
  15051. /**
  15052. * The field well configuration of a sankey diagram.
  15053. */
  15054. FieldWells?: SankeyDiagramFieldWells;
  15055. /**
  15056. * The sort configuration of a sankey diagram.
  15057. */
  15058. SortConfiguration?: SankeyDiagramSortConfiguration;
  15059. /**
  15060. * The data label configuration of a sankey diagram.
  15061. */
  15062. DataLabels?: DataLabelOptions;
  15063. /**
  15064. * The general visual interactions setup for a visual.
  15065. */
  15066. Interactions?: VisualInteractionOptions;
  15067. }
  15068. export interface SankeyDiagramFieldWells {
  15069. /**
  15070. * The field well configuration of a sankey diagram.
  15071. */
  15072. SankeyDiagramAggregatedFieldWells?: SankeyDiagramAggregatedFieldWells;
  15073. }
  15074. export interface SankeyDiagramSortConfiguration {
  15075. /**
  15076. * The sort configuration of the weight fields.
  15077. */
  15078. WeightSort?: FieldSortOptionsList;
  15079. /**
  15080. * The limit on the number of source nodes that are displayed in a sankey diagram.
  15081. */
  15082. SourceItemsLimit?: ItemsLimitConfiguration;
  15083. /**
  15084. * The limit on the number of destination nodes that are displayed in a sankey diagram.
  15085. */
  15086. DestinationItemsLimit?: ItemsLimitConfiguration;
  15087. }
  15088. export interface SankeyDiagramVisual {
  15089. /**
  15090. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  15091. */
  15092. VisualId: ShortRestrictiveResourceId;
  15093. /**
  15094. * The title that is displayed on the visual.
  15095. */
  15096. Title?: VisualTitleLabelOptions;
  15097. /**
  15098. * The subtitle that is displayed on the visual.
  15099. */
  15100. Subtitle?: VisualSubtitleLabelOptions;
  15101. /**
  15102. * The configuration of a sankey diagram.
  15103. */
  15104. ChartConfiguration?: SankeyDiagramChartConfiguration;
  15105. /**
  15106. * The list of custom actions that are configured for a visual.
  15107. */
  15108. Actions?: VisualCustomActionList;
  15109. }
  15110. export interface ScatterPlotCategoricallyAggregatedFieldWells {
  15111. /**
  15112. * The x-axis field well of a scatter plot. The x-axis is aggregated by category.
  15113. */
  15114. XAxis?: MeasureFieldList;
  15115. /**
  15116. * The y-axis field well of a scatter plot. The y-axis is aggregated by category.
  15117. */
  15118. YAxis?: MeasureFieldList;
  15119. /**
  15120. * The category field well of a scatter plot.
  15121. */
  15122. Category?: DimensionFieldList;
  15123. /**
  15124. * The size field well of a scatter plot.
  15125. */
  15126. Size?: MeasureFieldList;
  15127. /**
  15128. * The label field well of a scatter plot.
  15129. */
  15130. Label?: DimensionFieldList;
  15131. }
  15132. export interface ScatterPlotConfiguration {
  15133. /**
  15134. * The field wells of the visual.
  15135. */
  15136. FieldWells?: ScatterPlotFieldWells;
  15137. /**
  15138. * The sort configuration of a scatter plot.
  15139. */
  15140. SortConfiguration?: ScatterPlotSortConfiguration;
  15141. /**
  15142. * The label options (label text, label visibility, and sort icon visibility) of the scatter plot's x-axis.
  15143. */
  15144. XAxisLabelOptions?: ChartAxisLabelOptions;
  15145. /**
  15146. * The label display options (grid line, range, scale, and axis step) of the scatter plot's x-axis.
  15147. */
  15148. XAxisDisplayOptions?: AxisDisplayOptions;
  15149. /**
  15150. * The label options (label text, label visibility, and sort icon visibility) of the scatter plot's y-axis.
  15151. */
  15152. YAxisLabelOptions?: ChartAxisLabelOptions;
  15153. /**
  15154. * The label display options (grid line, range, scale, and axis step) of the scatter plot's y-axis.
  15155. */
  15156. YAxisDisplayOptions?: AxisDisplayOptions;
  15157. /**
  15158. * The legend display setup of the visual.
  15159. */
  15160. Legend?: LegendOptions;
  15161. /**
  15162. * The options that determine if visual data labels are displayed.
  15163. */
  15164. DataLabels?: DataLabelOptions;
  15165. /**
  15166. * The legend display setup of the visual.
  15167. */
  15168. Tooltip?: TooltipOptions;
  15169. /**
  15170. * The palette (chart color) display setup of the visual.
  15171. */
  15172. VisualPalette?: VisualPalette;
  15173. /**
  15174. * The general visual interactions setup for a visual.
  15175. */
  15176. Interactions?: VisualInteractionOptions;
  15177. }
  15178. export interface ScatterPlotFieldWells {
  15179. /**
  15180. * The aggregated field wells of a scatter plot. The x and y-axes of scatter plots with aggregated field wells are aggregated by category, label, or both.
  15181. */
  15182. ScatterPlotCategoricallyAggregatedFieldWells?: ScatterPlotCategoricallyAggregatedFieldWells;
  15183. /**
  15184. * The unaggregated field wells of a scatter plot. The x and y-axes of these scatter plots are unaggregated.
  15185. */
  15186. ScatterPlotUnaggregatedFieldWells?: ScatterPlotUnaggregatedFieldWells;
  15187. }
  15188. export interface ScatterPlotSortConfiguration {
  15189. ScatterPlotLimitConfiguration?: ItemsLimitConfiguration;
  15190. }
  15191. export interface ScatterPlotUnaggregatedFieldWells {
  15192. /**
  15193. * The x-axis field well of a scatter plot. The x-axis is a dimension field and cannot be aggregated.
  15194. */
  15195. XAxis?: DimensionFieldList;
  15196. /**
  15197. * The y-axis field well of a scatter plot. The y-axis is a dimension field and cannot be aggregated.
  15198. */
  15199. YAxis?: DimensionFieldList;
  15200. /**
  15201. * The size field well of a scatter plot.
  15202. */
  15203. Size?: MeasureFieldList;
  15204. /**
  15205. * The category field well of a scatter plot.
  15206. */
  15207. Category?: DimensionFieldList;
  15208. /**
  15209. * The label field well of a scatter plot.
  15210. */
  15211. Label?: DimensionFieldList;
  15212. }
  15213. export interface ScatterPlotVisual {
  15214. /**
  15215. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  15216. */
  15217. VisualId: ShortRestrictiveResourceId;
  15218. /**
  15219. * The title that is displayed on the visual.
  15220. */
  15221. Title?: VisualTitleLabelOptions;
  15222. /**
  15223. * The subtitle that is displayed on the visual.
  15224. */
  15225. Subtitle?: VisualSubtitleLabelOptions;
  15226. /**
  15227. * The configuration settings of the visual.
  15228. */
  15229. ChartConfiguration?: ScatterPlotConfiguration;
  15230. /**
  15231. * The list of custom actions that are configured for a visual.
  15232. */
  15233. Actions?: VisualCustomActionList;
  15234. /**
  15235. * The column hierarchy that is used during drill-downs and drill-ups.
  15236. */
  15237. ColumnHierarchies?: ColumnHierarchyList;
  15238. }
  15239. export interface ScheduleRefreshOnEntity {
  15240. /**
  15241. * The day of the week that you want to schedule a refresh on.
  15242. */
  15243. DayOfWeek?: DayOfWeek;
  15244. /**
  15245. * The day of the month that you want to schedule refresh on.
  15246. */
  15247. DayOfMonth?: DayOfMonth;
  15248. }
  15249. export interface ScrollBarOptions {
  15250. /**
  15251. * The visibility of the data zoom scroll bar.
  15252. */
  15253. Visibility?: Visibility;
  15254. /**
  15255. * The visibility range for the data zoom scroll bar.
  15256. */
  15257. VisibleRange?: VisibleRangeOptions;
  15258. }
  15259. export interface SearchAnalysesRequest {
  15260. /**
  15261. * The ID of the Amazon Web Services account that contains the analyses that you're searching for.
  15262. */
  15263. AwsAccountId: AwsAccountId;
  15264. /**
  15265. * The structure for the search filters that you want to apply to your search.
  15266. */
  15267. Filters: AnalysisSearchFilterList;
  15268. /**
  15269. * A pagination token that can be used in a subsequent request.
  15270. */
  15271. NextToken?: String;
  15272. /**
  15273. * The maximum number of results to return.
  15274. */
  15275. MaxResults?: MaxResults;
  15276. }
  15277. export interface SearchAnalysesResponse {
  15278. /**
  15279. * Metadata describing the analyses that you searched for.
  15280. */
  15281. AnalysisSummaryList?: AnalysisSummaryList;
  15282. /**
  15283. * A pagination token that can be used in a subsequent request.
  15284. */
  15285. NextToken?: String;
  15286. /**
  15287. * The HTTP status of the request.
  15288. */
  15289. Status?: StatusCode;
  15290. /**
  15291. * The Amazon Web Services request ID for this operation.
  15292. */
  15293. RequestId?: String;
  15294. }
  15295. export interface SearchDashboardsRequest {
  15296. /**
  15297. * The ID of the Amazon Web Services account that contains the user whose dashboards you're searching for.
  15298. */
  15299. AwsAccountId: AwsAccountId;
  15300. /**
  15301. * The filters to apply to the search. Currently, you can search only by user name, for example, "Filters": [ { "Name": "QUICKSIGHT_USER", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:user/default/UserName1" } ]
  15302. */
  15303. Filters: DashboardSearchFilterList;
  15304. /**
  15305. * The token for the next set of results, or null if there are no more results.
  15306. */
  15307. NextToken?: String;
  15308. /**
  15309. * The maximum number of results to be returned per request.
  15310. */
  15311. MaxResults?: MaxResults;
  15312. }
  15313. export interface SearchDashboardsResponse {
  15314. /**
  15315. * The list of dashboards owned by the user specified in Filters in your request.
  15316. */
  15317. DashboardSummaryList?: DashboardSummaryList;
  15318. /**
  15319. * The token for the next set of results, or null if there are no more results.
  15320. */
  15321. NextToken?: String;
  15322. /**
  15323. * The HTTP status of the request.
  15324. */
  15325. Status?: StatusCode;
  15326. /**
  15327. * The Amazon Web Services request ID for this operation.
  15328. */
  15329. RequestId?: String;
  15330. }
  15331. export interface SearchDataSetsRequest {
  15332. /**
  15333. * The Amazon Web Services account ID.
  15334. */
  15335. AwsAccountId: AwsAccountId;
  15336. /**
  15337. * The filters to apply to the search.
  15338. */
  15339. Filters: DataSetSearchFilterList;
  15340. /**
  15341. * A pagination token that can be used in a subsequent request.
  15342. */
  15343. NextToken?: String;
  15344. /**
  15345. * The maximum number of results to be returned per request.
  15346. */
  15347. MaxResults?: MaxResults;
  15348. }
  15349. export interface SearchDataSetsResponse {
  15350. /**
  15351. * A DataSetSummaries object that returns a summary of a dataset.
  15352. */
  15353. DataSetSummaries?: DataSetSummaryList;
  15354. /**
  15355. * A pagination token that can be used in a subsequent request.
  15356. */
  15357. NextToken?: String;
  15358. /**
  15359. * The HTTP status of the request.
  15360. */
  15361. Status?: StatusCode;
  15362. /**
  15363. * The Amazon Web Services request ID for this operation.
  15364. */
  15365. RequestId?: String;
  15366. }
  15367. export interface SearchDataSourcesRequest {
  15368. /**
  15369. * The Amazon Web Services account ID.
  15370. */
  15371. AwsAccountId: AwsAccountId;
  15372. /**
  15373. * The filters to apply to the search.
  15374. */
  15375. Filters: DataSourceSearchFilterList;
  15376. /**
  15377. * A pagination token that can be used in a subsequent request.
  15378. */
  15379. NextToken?: String;
  15380. /**
  15381. * The maximum number of results to be returned per request.
  15382. */
  15383. MaxResults?: MaxResults;
  15384. }
  15385. export interface SearchDataSourcesResponse {
  15386. /**
  15387. * A DataSourceSummaries object that returns a summary of a data source.
  15388. */
  15389. DataSourceSummaries?: DataSourceSummaryList;
  15390. /**
  15391. * A pagination token that can be used in a subsequent request.
  15392. */
  15393. NextToken?: String;
  15394. /**
  15395. * The HTTP status of the request.
  15396. */
  15397. Status?: StatusCode;
  15398. /**
  15399. * The Amazon Web Services request ID for this operation.
  15400. */
  15401. RequestId?: String;
  15402. }
  15403. export interface SearchFoldersRequest {
  15404. /**
  15405. * The ID for the Amazon Web Services account that contains the folder.
  15406. */
  15407. AwsAccountId: AwsAccountId;
  15408. /**
  15409. * The filters to apply to the search. Currently, you can search only by the parent folder ARN. For example, "Filters": [ { "Name": "PARENT_FOLDER_ARN", "Operator": "StringEquals", "Value": "arn:aws:quicksight:us-east-1:1:folder/folderId" } ].
  15410. */
  15411. Filters: FolderSearchFilterList;
  15412. /**
  15413. * The token for the next set of results, or null if there are no more results.
  15414. */
  15415. NextToken?: String;
  15416. /**
  15417. * The maximum number of results to be returned per request.
  15418. */
  15419. MaxResults?: MaxResults;
  15420. }
  15421. export interface SearchFoldersResponse {
  15422. /**
  15423. * The HTTP status of the request.
  15424. */
  15425. Status?: StatusCode;
  15426. /**
  15427. * A structure that contains all of the folders in the Amazon Web Services account. This structure provides basic information about the folders.
  15428. */
  15429. FolderSummaryList?: FolderSummaryList;
  15430. /**
  15431. * The token for the next set of results, or null if there are no more results.
  15432. */
  15433. NextToken?: String;
  15434. /**
  15435. * The Amazon Web Services request ID for this operation.
  15436. */
  15437. RequestId?: String;
  15438. }
  15439. export interface SearchGroupsRequest {
  15440. /**
  15441. * The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  15442. */
  15443. AwsAccountId: AwsAccountId;
  15444. /**
  15445. * A pagination token that can be used in a subsequent request.
  15446. */
  15447. NextToken?: String;
  15448. /**
  15449. * The maximum number of results to return from this request.
  15450. */
  15451. MaxResults?: MaxResults;
  15452. /**
  15453. * The namespace that you want to search.
  15454. */
  15455. Namespace: Namespace;
  15456. /**
  15457. * The structure for the search filters that you want to apply to your search.
  15458. */
  15459. Filters: GroupSearchFilterList;
  15460. }
  15461. export interface SearchGroupsResponse {
  15462. /**
  15463. * A list of groups in a specified namespace that match the filters you set in your SearchGroups request.
  15464. */
  15465. GroupList?: GroupList;
  15466. /**
  15467. * A pagination token that can be used in a subsequent request.
  15468. */
  15469. NextToken?: String;
  15470. /**
  15471. * The Amazon Web Services request ID for this operation.
  15472. */
  15473. RequestId?: String;
  15474. /**
  15475. * The HTTP status of the request.
  15476. */
  15477. Status?: StatusCode;
  15478. }
  15479. export type Seasonality = number;
  15480. export interface SecondaryValueOptions {
  15481. /**
  15482. * Determines the visibility of the secondary value.
  15483. */
  15484. Visibility?: Visibility;
  15485. }
  15486. export type SecretArn = string;
  15487. export interface SectionAfterPageBreak {
  15488. /**
  15489. * The option that enables or disables a page break at the end of a section.
  15490. */
  15491. Status?: SectionPageBreakStatus;
  15492. }
  15493. export interface SectionBasedLayoutCanvasSizeOptions {
  15494. /**
  15495. * The options for a paper canvas of a section-based layout.
  15496. */
  15497. PaperCanvasSizeOptions?: SectionBasedLayoutPaperCanvasSizeOptions;
  15498. }
  15499. export interface SectionBasedLayoutConfiguration {
  15500. /**
  15501. * A list of header section configurations.
  15502. */
  15503. HeaderSections: HeaderFooterSectionConfigurationList;
  15504. /**
  15505. * A list of body section configurations.
  15506. */
  15507. BodySections: BodySectionConfigurationList;
  15508. /**
  15509. * A list of footer section configurations.
  15510. */
  15511. FooterSections: HeaderFooterSectionConfigurationList;
  15512. /**
  15513. * The options for the canvas of a section-based layout.
  15514. */
  15515. CanvasSizeOptions: SectionBasedLayoutCanvasSizeOptions;
  15516. }
  15517. export interface SectionBasedLayoutPaperCanvasSizeOptions {
  15518. /**
  15519. * The paper size that is used to define canvas dimensions.
  15520. */
  15521. PaperSize?: PaperSize;
  15522. /**
  15523. * The paper orientation that is used to define canvas dimensions. Choose one of the following options: PORTRAIT LANDSCAPE
  15524. */
  15525. PaperOrientation?: PaperOrientation;
  15526. /**
  15527. * Defines the spacing between the canvas content and the top, bottom, left, and right edges.
  15528. */
  15529. PaperMargin?: Spacing;
  15530. }
  15531. export interface SectionLayoutConfiguration {
  15532. /**
  15533. * The free-form layout configuration of a section.
  15534. */
  15535. FreeFormLayout: FreeFormSectionLayoutConfiguration;
  15536. }
  15537. export interface SectionPageBreakConfiguration {
  15538. /**
  15539. * The configuration of a page break after a section.
  15540. */
  15541. After?: SectionAfterPageBreak;
  15542. }
  15543. export type SectionPageBreakStatus = "ENABLED"|"DISABLED"|string;
  15544. export interface SectionStyle {
  15545. /**
  15546. * The height of a section. Heights can only be defined for header and footer sections. The default height margin is 0.5 inches.
  15547. */
  15548. Height?: PixelLength;
  15549. /**
  15550. * The spacing between section content and its top, bottom, left, and right edges. There is no padding by default.
  15551. */
  15552. Padding?: Spacing;
  15553. }
  15554. export type SecurityGroupId = string;
  15555. export type SecurityGroupIdList = SecurityGroupId[];
  15556. export type SelectAllValueOptions = "ALL_VALUES"|string;
  15557. export type SelectedFieldList = FieldId[];
  15558. export type SelectedFieldOptions = "ALL_FIELDS"|string;
  15559. export interface SelectedSheetsFilterScopeConfiguration {
  15560. /**
  15561. * The sheet ID and visual IDs of the sheet and visuals that the filter is applied to.
  15562. */
  15563. SheetVisualScopingConfigurations?: SheetVisualScopingConfigurations;
  15564. }
  15565. export type SelectedTooltipType = "BASIC"|"DETAILED"|string;
  15566. export interface SemanticEntityType {
  15567. /**
  15568. * The semantic entity type name.
  15569. */
  15570. TypeName?: LimitedString;
  15571. /**
  15572. * The semantic entity sub type name.
  15573. */
  15574. SubTypeName?: LimitedString;
  15575. /**
  15576. * The semantic entity type parameters.
  15577. */
  15578. TypeParameters?: TypeParameters;
  15579. }
  15580. export interface SemanticType {
  15581. /**
  15582. * The semantic type name.
  15583. */
  15584. TypeName?: LimitedString;
  15585. /**
  15586. * The semantic type sub type name.
  15587. */
  15588. SubTypeName?: LimitedString;
  15589. /**
  15590. * The semantic type parameters.
  15591. */
  15592. TypeParameters?: TypeParameters;
  15593. /**
  15594. * The semantic type truthy cell value.
  15595. */
  15596. TruthyCellValue?: SensitiveString;
  15597. /**
  15598. * The other names or aliases for the true cell value.
  15599. */
  15600. TruthyCellValueSynonyms?: SensitiveStringList;
  15601. /**
  15602. * The semantic type falsey cell value.
  15603. */
  15604. FalseyCellValue?: SensitiveString;
  15605. /**
  15606. * The other names or aliases for the false cell value.
  15607. */
  15608. FalseyCellValueSynonyms?: SensitiveStringList;
  15609. }
  15610. export type SensitiveDouble = number;
  15611. export type SensitiveDoubleList = SensitiveDouble[];
  15612. export type SensitiveDoubleObject = number;
  15613. export type SensitiveLong = number;
  15614. export type SensitiveLongList = SensitiveLong[];
  15615. export type SensitiveLongObject = number;
  15616. export type SensitiveS3Uri = string;
  15617. export type SensitiveString = string;
  15618. export type SensitiveStringList = SensitiveString[];
  15619. export type SensitiveStringObject = string;
  15620. export type SensitiveTimestamp = Date;
  15621. export type SensitiveTimestampList = SensitiveTimestamp[];
  15622. export interface SeriesItem {
  15623. /**
  15624. * The field series item configuration of a line chart.
  15625. */
  15626. FieldSeriesItem?: FieldSeriesItem;
  15627. /**
  15628. * The data field series item configuration of a line chart.
  15629. */
  15630. DataFieldSeriesItem?: DataFieldSeriesItem;
  15631. }
  15632. export type SeriesItemList = SeriesItem[];
  15633. export interface ServiceNowParameters {
  15634. /**
  15635. * URL of the base site.
  15636. */
  15637. SiteBaseUrl: SiteBaseUrl;
  15638. }
  15639. export type ServiceType = "REDSHIFT"|string;
  15640. export type SessionLifetimeInMinutes = number;
  15641. export interface SessionTag {
  15642. /**
  15643. * The key for the tag.
  15644. */
  15645. Key: SessionTagKey;
  15646. /**
  15647. * The value that you want to assign the tag.
  15648. */
  15649. Value: SessionTagValue;
  15650. }
  15651. export type SessionTagKey = string;
  15652. export type SessionTagKeyList = SessionTagKey[];
  15653. export type SessionTagList = SessionTag[];
  15654. export type SessionTagValue = string;
  15655. export interface SetParameterValueConfiguration {
  15656. /**
  15657. * The destination parameter name of the SetParameterValueConfiguration.
  15658. */
  15659. DestinationParameterName: ParameterName;
  15660. Value: DestinationParameterValueConfiguration;
  15661. }
  15662. export type SetParameterValueConfigurationList = SetParameterValueConfiguration[];
  15663. export interface ShapeConditionalFormat {
  15664. /**
  15665. * The conditional formatting for the shape background color of a filled map visual.
  15666. */
  15667. BackgroundColor: ConditionalFormattingColor;
  15668. }
  15669. export type SharingModel = "ACCOUNT"|"NAMESPACE"|string;
  15670. export interface Sheet {
  15671. /**
  15672. * The unique identifier associated with a sheet.
  15673. */
  15674. SheetId?: ShortRestrictiveResourceId;
  15675. /**
  15676. * The name of a sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
  15677. */
  15678. Name?: SheetName;
  15679. }
  15680. export type SheetContentType = "PAGINATED"|"INTERACTIVE"|string;
  15681. export type SheetControlDateTimePickerType = "SINGLE_VALUED"|"DATE_RANGE"|string;
  15682. export interface SheetControlInfoIconLabelOptions {
  15683. /**
  15684. * The visibility configuration of info icon label options.
  15685. */
  15686. Visibility?: Visibility;
  15687. /**
  15688. * The text content of info icon.
  15689. */
  15690. InfoIconText?: SheetControlInfoIconText;
  15691. }
  15692. export type SheetControlInfoIconText = string;
  15693. export interface SheetControlLayout {
  15694. /**
  15695. * The configuration that determines the elements and canvas size options of sheet control.
  15696. */
  15697. Configuration: SheetControlLayoutConfiguration;
  15698. }
  15699. export interface SheetControlLayoutConfiguration {
  15700. /**
  15701. * The configuration that determines the elements and canvas size options of sheet control.
  15702. */
  15703. GridLayout?: GridLayoutConfiguration;
  15704. }
  15705. export type SheetControlLayoutList = SheetControlLayout[];
  15706. export type SheetControlListType = "MULTI_SELECT"|"SINGLE_SELECT"|string;
  15707. export type SheetControlSliderType = "SINGLE_POINT"|"RANGE"|string;
  15708. export type SheetControlTitle = string;
  15709. export interface SheetControlsOption {
  15710. /**
  15711. * Visibility state.
  15712. */
  15713. VisibilityState?: DashboardUIState;
  15714. }
  15715. export interface SheetDefinition {
  15716. /**
  15717. * The unique identifier of a sheet.
  15718. */
  15719. SheetId: ShortRestrictiveResourceId;
  15720. /**
  15721. * The title of the sheet.
  15722. */
  15723. Title?: SheetTitle;
  15724. /**
  15725. * A description of the sheet.
  15726. */
  15727. Description?: SheetDescription;
  15728. /**
  15729. * The name of the sheet. This name is displayed on the sheet's tab in the Amazon QuickSight console.
  15730. */
  15731. Name?: SheetName;
  15732. /**
  15733. * The list of parameter controls that are on a sheet. For more information, see Using a Control with a Parameter in Amazon QuickSight in the Amazon QuickSight User Guide.
  15734. */
  15735. ParameterControls?: ParameterControlList;
  15736. /**
  15737. * The list of filter controls that are on a sheet. For more information, see Adding filter controls to analysis sheets in the Amazon QuickSight User Guide.
  15738. */
  15739. FilterControls?: FilterControlList;
  15740. /**
  15741. * A list of the visuals that are on a sheet. Visual placement is determined by the layout of the sheet.
  15742. */
  15743. Visuals?: VisualList;
  15744. /**
  15745. * The text boxes that are on a sheet.
  15746. */
  15747. TextBoxes?: SheetTextBoxList;
  15748. /**
  15749. * Layouts define how the components of a sheet are arranged. For more information, see Types of layout in the Amazon QuickSight User Guide.
  15750. */
  15751. Layouts?: LayoutList;
  15752. /**
  15753. * The control layouts of the sheet.
  15754. */
  15755. SheetControlLayouts?: SheetControlLayoutList;
  15756. /**
  15757. * The layout content type of the sheet. Choose one of the following options: PAGINATED: Creates a sheet for a paginated report. INTERACTIVE: Creates a sheet for an interactive dashboard.
  15758. */
  15759. ContentType?: SheetContentType;
  15760. }
  15761. export type SheetDefinitionList = SheetDefinition[];
  15762. export type SheetDescription = string;
  15763. export interface SheetElementConfigurationOverrides {
  15764. /**
  15765. * Determines whether or not the overrides are visible. Choose one of the following options: VISIBLE HIDDEN
  15766. */
  15767. Visibility?: Visibility;
  15768. }
  15769. export interface SheetElementRenderingRule {
  15770. /**
  15771. * The expression of the rendering rules of a sheet.
  15772. */
  15773. Expression: Expression;
  15774. /**
  15775. * The override configuration of the rendering rules of a sheet.
  15776. */
  15777. ConfigurationOverrides: SheetElementConfigurationOverrides;
  15778. }
  15779. export type SheetElementRenderingRuleList = SheetElementRenderingRule[];
  15780. export interface SheetLayoutElementMaximizationOption {
  15781. /**
  15782. * The status of the sheet layout maximization options of a dashbaord.
  15783. */
  15784. AvailabilityStatus?: DashboardBehavior;
  15785. }
  15786. export type SheetList = Sheet[];
  15787. export type SheetName = string;
  15788. export interface SheetStyle {
  15789. /**
  15790. * The display options for tiles.
  15791. */
  15792. Tile?: TileStyle;
  15793. /**
  15794. * The layout options for tiles.
  15795. */
  15796. TileLayout?: TileLayoutStyle;
  15797. }
  15798. export interface SheetTextBox {
  15799. /**
  15800. * The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.
  15801. */
  15802. SheetTextBoxId: ShortRestrictiveResourceId;
  15803. /**
  15804. * The content that is displayed in the text box.
  15805. */
  15806. Content?: SheetTextBoxContent;
  15807. }
  15808. export type SheetTextBoxContent = string;
  15809. export type SheetTextBoxList = SheetTextBox[];
  15810. export type SheetTitle = string;
  15811. export interface SheetVisualScopingConfiguration {
  15812. /**
  15813. * The selected sheet that the filter is applied to.
  15814. */
  15815. SheetId: ShortRestrictiveResourceId;
  15816. /**
  15817. * The scope of the applied entities. Choose one of the following options: ALL_VISUALS SELECTED_VISUALS
  15818. */
  15819. Scope: FilterVisualScope;
  15820. /**
  15821. * The selected visuals that the filter is applied to.
  15822. */
  15823. VisualIds?: FilteredVisualsList;
  15824. }
  15825. export type SheetVisualScopingConfigurations = SheetVisualScopingConfiguration[];
  15826. export interface ShortFormatText {
  15827. /**
  15828. * Plain text format.
  15829. */
  15830. PlainText?: ShortPlainText;
  15831. /**
  15832. * Rich text. Examples of rich text include bold, underline, and italics.
  15833. */
  15834. RichText?: ShortRichText;
  15835. }
  15836. export type ShortPlainText = string;
  15837. export type ShortRestrictiveResourceId = string;
  15838. export type ShortRichText = string;
  15839. export interface SignupResponse {
  15840. /**
  15841. * A Boolean that is TRUE if the Amazon QuickSight uses IAM as an authentication method.
  15842. */
  15843. IAMUser?: Boolean;
  15844. /**
  15845. * The user login name for your Amazon QuickSight account.
  15846. */
  15847. userLoginName?: String;
  15848. /**
  15849. * The name of your Amazon QuickSight account.
  15850. */
  15851. accountName?: String;
  15852. /**
  15853. * The type of Active Directory that is being used to authenticate the Amazon QuickSight account. Valid values are SIMPLE_AD, AD_CONNECTOR, and MICROSOFT_AD.
  15854. */
  15855. directoryType?: String;
  15856. }
  15857. export type SimpleAttributeAggregationFunction = "UNIQUE_VALUE"|string;
  15858. export interface SimpleClusterMarker {
  15859. /**
  15860. * The color of the simple cluster marker.
  15861. */
  15862. Color?: HexColor;
  15863. }
  15864. export type SimpleNumericalAggregationFunction = "SUM"|"AVERAGE"|"MIN"|"MAX"|"COUNT"|"DISTINCT_COUNT"|"VAR"|"VARP"|"STDEV"|"STDEVP"|"MEDIAN"|string;
  15865. export type SimpleTotalAggregationFunction = "DEFAULT"|"SUM"|"AVERAGE"|"MIN"|"MAX"|"NONE"|string;
  15866. export interface SingleAxisOptions {
  15867. /**
  15868. * The Y axis options of a single axis configuration.
  15869. */
  15870. YAxisOptions?: YAxisOptions;
  15871. }
  15872. export type SingleYAxisOption = "PRIMARY_Y_AXIS"|string;
  15873. export type SiteBaseUrl = string;
  15874. export interface SliderControlDisplayOptions {
  15875. /**
  15876. * The options to configure the title visibility, name, and font size.
  15877. */
  15878. TitleOptions?: LabelOptions;
  15879. /**
  15880. * The configuration of info icon label options.
  15881. */
  15882. InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
  15883. }
  15884. export type SmallMultiplesAxisPlacement = "OUTSIDE"|"INSIDE"|string;
  15885. export interface SmallMultiplesAxisProperties {
  15886. /**
  15887. * Determines whether scale of the axes are shared or independent. The default value is SHARED.
  15888. */
  15889. Scale?: SmallMultiplesAxisScale;
  15890. /**
  15891. * Defines the placement of the axis. By default, axes are rendered OUTSIDE of the panels. Axes with INDEPENDENT scale are rendered INSIDE the panels.
  15892. */
  15893. Placement?: SmallMultiplesAxisPlacement;
  15894. }
  15895. export type SmallMultiplesAxisScale = "SHARED"|"INDEPENDENT"|string;
  15896. export type SmallMultiplesDimensionFieldList = DimensionField[];
  15897. export interface SmallMultiplesOptions {
  15898. /**
  15899. * Sets the maximum number of visible rows to display in the grid of small multiples panels. The default value is Auto, which automatically adjusts the rows in the grid to fit the overall layout and size of the given chart.
  15900. */
  15901. MaxVisibleRows?: VisiblePanelRows;
  15902. /**
  15903. * Sets the maximum number of visible columns to display in the grid of small multiples panels. The default is Auto, which automatically adjusts the columns in the grid to fit the overall layout and size of the given chart.
  15904. */
  15905. MaxVisibleColumns?: VisiblePanelColumns;
  15906. /**
  15907. * Configures the display options for each small multiples panel.
  15908. */
  15909. PanelConfiguration?: PanelConfiguration;
  15910. /**
  15911. * The properties of a small multiples X axis.
  15912. */
  15913. XAxis?: SmallMultiplesAxisProperties;
  15914. /**
  15915. * The properties of a small multiples Y axis.
  15916. */
  15917. YAxis?: SmallMultiplesAxisProperties;
  15918. }
  15919. export interface SnapshotAnonymousUser {
  15920. /**
  15921. * The tags to be used for row-level security (RLS). Make sure that the relevant datasets have RLS tags configured before you start a snapshot export job. You can configure the RLS tags of a dataset with a DataSet$RowLevelPermissionTagConfiguration API call. These are not the tags that are used for Amazon Web Services resource tagging. For more information on row level security in Amazon QuickSight, see Using Row-Level Security (RLS) with Tagsin the Amazon QuickSight User Guide.
  15922. */
  15923. RowLevelPermissionTags?: SessionTagList;
  15924. }
  15925. export type SnapshotAnonymousUserList = SnapshotAnonymousUser[];
  15926. export interface SnapshotAnonymousUserRedacted {
  15927. /**
  15928. * The tag keys for the RowLevelPermissionTags.
  15929. */
  15930. RowLevelPermissionTagKeys?: SessionTagKeyList;
  15931. }
  15932. export type SnapshotAnonymousUserRedactedList = SnapshotAnonymousUserRedacted[];
  15933. export interface SnapshotConfiguration {
  15934. /**
  15935. * A list of SnapshotJobResultFileGroup objects that contain information about the snapshot that is generated. This list can hold a maximum of 6 FileGroup configurations.
  15936. */
  15937. FileGroups: SnapshotFileGroupList;
  15938. /**
  15939. * A structure that contains information on the Amazon S3 bucket that the generated snapshot is stored in.
  15940. */
  15941. DestinationConfiguration?: SnapshotDestinationConfiguration;
  15942. Parameters?: Parameters;
  15943. }
  15944. export interface SnapshotDestinationConfiguration {
  15945. /**
  15946. * A list of SnapshotS3DestinationConfiguration objects that contain Amazon S3 destination configurations. This structure can hold a maximum of 1 S3DestinationConfiguration.
  15947. */
  15948. S3Destinations?: SnapshotS3DestinationConfigurationList;
  15949. }
  15950. export interface SnapshotFile {
  15951. /**
  15952. * A list of SnapshotFileSheetSelection objects that contain information on the dashboard sheet that is exported. These objects provide information about the snapshot artifacts that are generated during the job. This structure can hold a maximum of 5 CSV configurations, 5 Excel configurations, or 1 configuration for PDF.
  15953. */
  15954. SheetSelections: SnapshotFileSheetSelectionList;
  15955. /**
  15956. * The format of the snapshot file to be generated. You can choose between CSV, Excel, or PDF.
  15957. */
  15958. FormatType: SnapshotFileFormatType;
  15959. }
  15960. export type SnapshotFileFormatType = "CSV"|"PDF"|"EXCEL"|string;
  15961. export interface SnapshotFileGroup {
  15962. /**
  15963. * A list of SnapshotFile objects that contain the information on the snapshot files that need to be generated. This structure can hold 1 configuration at a time.
  15964. */
  15965. Files?: SnapshotFileList;
  15966. }
  15967. export type SnapshotFileGroupList = SnapshotFileGroup[];
  15968. export type SnapshotFileList = SnapshotFile[];
  15969. export interface SnapshotFileSheetSelection {
  15970. /**
  15971. * The sheet ID of the dashboard to generate the snapshot artifact from. This value is required for CSV, Excel, and PDF format types.
  15972. */
  15973. SheetId: ShortRestrictiveResourceId;
  15974. /**
  15975. * The selection scope of the visuals on a sheet of a dashboard that you are generating a snapthot of. You can choose one of the following options. ALL_VISUALS - Selects all visuals that are on the sheet. This value is required if the snapshot is a PDF. SELECTED_VISUALS - Select the visual that you want to add to the snapshot. This value is required if the snapshot is a CSV or Excel workbook.
  15976. */
  15977. SelectionScope: SnapshotFileSheetSelectionScope;
  15978. /**
  15979. * A structure that lists the IDs of the visuals in the selected sheet. Supported visual types are table, pivot table visuals. This value is required if you are generating a CSV or Excel workbook. This value supports a maximum of 1 visual ID for CSV and 5 visual IDs across up to 5 sheet selections for Excel. If you are generating an Excel workbook, the order of the visual IDs provided in this structure determines the order of the worksheets in the Excel file.
  15980. */
  15981. VisualIds?: SnapshotFileSheetSelectionVisualIdList;
  15982. }
  15983. export type SnapshotFileSheetSelectionList = SnapshotFileSheetSelection[];
  15984. export type SnapshotFileSheetSelectionScope = "ALL_VISUALS"|"SELECTED_VISUALS"|string;
  15985. export type SnapshotFileSheetSelectionVisualIdList = ShortRestrictiveResourceId[];
  15986. export interface SnapshotJobErrorInfo {
  15987. /**
  15988. * The error message.
  15989. */
  15990. ErrorMessage?: String;
  15991. /**
  15992. * The error type.
  15993. */
  15994. ErrorType?: String;
  15995. }
  15996. export interface SnapshotJobResult {
  15997. /**
  15998. * A list of AnonymousUserSnapshotJobResult objects that contain information on anonymous users and their user configurations. This data provided by you when you make a StartDashboardSnapshotJob API call.
  15999. */
  16000. AnonymousUsers?: AnonymousUserSnapshotJobResultList;
  16001. }
  16002. export interface SnapshotJobResultErrorInfo {
  16003. /**
  16004. * The error message.
  16005. */
  16006. ErrorMessage?: String;
  16007. /**
  16008. * The error type.
  16009. */
  16010. ErrorType?: String;
  16011. }
  16012. export type SnapshotJobResultErrorInfoList = SnapshotJobResultErrorInfo[];
  16013. export interface SnapshotJobResultFileGroup {
  16014. /**
  16015. * A list of SnapshotFile objects.
  16016. */
  16017. Files?: SnapshotFileList;
  16018. /**
  16019. * A list of SnapshotJobS3Result objects.
  16020. */
  16021. S3Results?: SnapshotJobS3ResultList;
  16022. }
  16023. export type SnapshotJobResultFileGroupList = SnapshotJobResultFileGroup[];
  16024. export interface SnapshotJobS3Result {
  16025. /**
  16026. * A list of Amazon S3 bucket configurations that are provided when you make a StartDashboardSnapshotJob API call.
  16027. */
  16028. S3DestinationConfiguration?: SnapshotS3DestinationConfiguration;
  16029. /**
  16030. * The Amazon S3 Uri.
  16031. */
  16032. S3Uri?: SensitiveS3Uri;
  16033. /**
  16034. * An array of error records that describe any failures that occur while the dashboard snapshot job runs.
  16035. */
  16036. ErrorInfo?: SnapshotJobResultErrorInfoList;
  16037. }
  16038. export type SnapshotJobS3ResultList = SnapshotJobS3Result[];
  16039. export type SnapshotJobStatus = "QUEUED"|"RUNNING"|"COMPLETED"|"FAILED"|string;
  16040. export interface SnapshotS3DestinationConfiguration {
  16041. /**
  16042. * A structure that contains details about the Amazon S3 bucket that the generated dashboard snapshot is saved in.
  16043. */
  16044. BucketConfiguration: S3BucketConfiguration;
  16045. }
  16046. export type SnapshotS3DestinationConfigurationList = SnapshotS3DestinationConfiguration[];
  16047. export interface SnapshotUserConfiguration {
  16048. /**
  16049. * An array of records that describe the anonymous users that the dashboard snapshot is generated for.
  16050. */
  16051. AnonymousUsers?: SnapshotAnonymousUserList;
  16052. }
  16053. export interface SnapshotUserConfigurationRedacted {
  16054. /**
  16055. * An array of records that describe anonymous users that the dashboard snapshot is generated for. Sensitive user information is excluded.
  16056. */
  16057. AnonymousUsers?: SnapshotAnonymousUserRedactedList;
  16058. }
  16059. export interface SnowflakeParameters {
  16060. /**
  16061. * Host.
  16062. */
  16063. Host: Host;
  16064. /**
  16065. * Database.
  16066. */
  16067. Database: Database;
  16068. /**
  16069. * Warehouse.
  16070. */
  16071. Warehouse: Warehouse;
  16072. }
  16073. export type SortDirection = "ASC"|"DESC"|string;
  16074. export interface Spacing {
  16075. /**
  16076. * Define the top spacing.
  16077. */
  16078. Top?: Length;
  16079. /**
  16080. * Define the bottom spacing.
  16081. */
  16082. Bottom?: Length;
  16083. /**
  16084. * Define the left spacing.
  16085. */
  16086. Left?: Length;
  16087. /**
  16088. * Define the right spacing.
  16089. */
  16090. Right?: Length;
  16091. }
  16092. export interface SparkParameters {
  16093. /**
  16094. * Host.
  16095. */
  16096. Host: Host;
  16097. /**
  16098. * Port.
  16099. */
  16100. Port: Port;
  16101. }
  16102. export type SpecialValue = "EMPTY"|"NULL"|"OTHER"|string;
  16103. export type SqlEndpointPath = string;
  16104. export type SqlQuery = string;
  16105. export interface SqlServerParameters {
  16106. /**
  16107. * Host.
  16108. */
  16109. Host: Host;
  16110. /**
  16111. * Port.
  16112. */
  16113. Port: Port;
  16114. /**
  16115. * Database.
  16116. */
  16117. Database: Database;
  16118. }
  16119. export interface SslProperties {
  16120. /**
  16121. * A Boolean option to control whether SSL should be disabled.
  16122. */
  16123. DisableSsl?: Boolean;
  16124. }
  16125. export interface StarburstParameters {
  16126. /**
  16127. * The host name of the Starburst data source.
  16128. */
  16129. Host: Host;
  16130. /**
  16131. * The port for the Starburst data source.
  16132. */
  16133. Port: Port;
  16134. /**
  16135. * The catalog name for the Starburst data source.
  16136. */
  16137. Catalog: Catalog;
  16138. /**
  16139. * The product type for the Starburst data source.
  16140. */
  16141. ProductType?: StarburstProductType;
  16142. }
  16143. export type StarburstProductType = "GALAXY"|"ENTERPRISE"|string;
  16144. export interface StartAssetBundleExportJobRequest {
  16145. /**
  16146. * The ID of the Amazon Web Services account to export assets from.
  16147. */
  16148. AwsAccountId: AwsAccountId;
  16149. /**
  16150. * The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
  16151. */
  16152. AssetBundleExportJobId: ShortRestrictiveResourceId;
  16153. /**
  16154. * An array of resource ARNs to export. The following resources are supported. Analysis Dashboard DataSet DataSource RefreshSchedule Theme VPCConnection The API caller must have the necessary permissions in their IAM role to access each resource before the resources can be exported.
  16155. */
  16156. ResourceArns: AssetBundleResourceArns;
  16157. /**
  16158. * A Boolean that determines whether all dependencies of each resource ARN are recursively exported with the job. For example, say you provided a Dashboard ARN to the ResourceArns parameter. If you set IncludeAllDependencies to TRUE, any theme, dataset, and data source resource that is a dependency of the dashboard is also exported.
  16159. */
  16160. IncludeAllDependencies?: Boolean;
  16161. /**
  16162. * The export data format.
  16163. */
  16164. ExportFormat: AssetBundleExportFormat;
  16165. /**
  16166. * An optional collection of structures that generate CloudFormation parameters to override the existing resource property values when the resource is exported to a new CloudFormation template. Use this field if the ExportFormat field of a StartAssetBundleExportJobRequest API call is set to CLOUDFORMATION_JSON.
  16167. */
  16168. CloudFormationOverridePropertyConfiguration?: AssetBundleCloudFormationOverridePropertyConfiguration;
  16169. /**
  16170. * A Boolean that determines whether all permissions for each resource ARN are exported with the job. If you set IncludePermissions to TRUE, any permissions associated with each resource are exported.
  16171. */
  16172. IncludePermissions?: Boolean;
  16173. /**
  16174. * A Boolean that determines whether all tags for each resource ARN are exported with the job. If you set IncludeTags to TRUE, any tags associated with each resource are exported.
  16175. */
  16176. IncludeTags?: Boolean;
  16177. /**
  16178. * An optional parameter that determines which validation strategy to use for the export job. If StrictModeForAllResources is set to TRUE, strict validation for every error is enforced. If it is set to FALSE, validation is skipped for specific UI errors that are shown as warnings. The default value for StrictModeForAllResources is FALSE.
  16179. */
  16180. ValidationStrategy?: AssetBundleExportJobValidationStrategy;
  16181. }
  16182. export interface StartAssetBundleExportJobResponse {
  16183. /**
  16184. * The Amazon Resource Name (ARN) for the export job.
  16185. */
  16186. Arn?: Arn;
  16187. /**
  16188. * The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
  16189. */
  16190. AssetBundleExportJobId?: ShortRestrictiveResourceId;
  16191. /**
  16192. * The Amazon Web Services response ID for this operation.
  16193. */
  16194. RequestId?: NonEmptyString;
  16195. /**
  16196. * The HTTP status of the response.
  16197. */
  16198. Status?: StatusCode;
  16199. }
  16200. export interface StartAssetBundleImportJobRequest {
  16201. /**
  16202. * The ID of the Amazon Web Services account to import assets into.
  16203. */
  16204. AwsAccountId: AwsAccountId;
  16205. /**
  16206. * The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
  16207. */
  16208. AssetBundleImportJobId: ShortRestrictiveResourceId;
  16209. /**
  16210. * The source of the asset bundle zip file that contains the data that you want to import. The file must be in QUICKSIGHT_JSON format.
  16211. */
  16212. AssetBundleImportSource: AssetBundleImportSource;
  16213. /**
  16214. * Optional overrides that are applied to the resource configuration before import.
  16215. */
  16216. OverrideParameters?: AssetBundleImportJobOverrideParameters;
  16217. /**
  16218. * The failure action for the import job. If you choose ROLLBACK, failed import jobs will attempt to undo any asset changes caused by the failed job. If you choose DO_NOTHING, failed import jobs will not attempt to roll back any asset changes caused by the failed job, possibly keeping the Amazon QuickSight account in an inconsistent state.
  16219. */
  16220. FailureAction?: AssetBundleImportFailureAction;
  16221. /**
  16222. * Optional permission overrides that are applied to the resource configuration before import.
  16223. */
  16224. OverridePermissions?: AssetBundleImportJobOverridePermissions;
  16225. /**
  16226. * Optional tag overrides that are applied to the resource configuration before import.
  16227. */
  16228. OverrideTags?: AssetBundleImportJobOverrideTags;
  16229. /**
  16230. * An optional validation strategy override for all analyses and dashboards that is applied to the resource configuration before import.
  16231. */
  16232. OverrideValidationStrategy?: AssetBundleImportJobOverrideValidationStrategy;
  16233. }
  16234. export interface StartAssetBundleImportJobResponse {
  16235. /**
  16236. * The Amazon Resource Name (ARN) for the import job.
  16237. */
  16238. Arn?: Arn;
  16239. /**
  16240. * The ID of the job. This ID is unique while the job is running. After the job is completed, you can reuse this ID for another job.
  16241. */
  16242. AssetBundleImportJobId?: ShortRestrictiveResourceId;
  16243. /**
  16244. * The Amazon Web Services response ID for this operation.
  16245. */
  16246. RequestId?: NonEmptyString;
  16247. /**
  16248. * The HTTP status of the response.
  16249. */
  16250. Status?: StatusCode;
  16251. }
  16252. export interface StartDashboardSnapshotJobRequest {
  16253. /**
  16254. * The ID of the Amazon Web Services account that the dashboard snapshot job is executed in.
  16255. */
  16256. AwsAccountId: AwsAccountId;
  16257. /**
  16258. * The ID of the dashboard that you want to start a snapshot job for.
  16259. */
  16260. DashboardId: ShortRestrictiveResourceId;
  16261. /**
  16262. * An ID for the dashboard snapshot job. This ID is unique to the dashboard while the job is running. This ID can be used to poll the status of a job with a DescribeDashboardSnapshotJob while the job runs. You can reuse this ID for another job 24 hours after the current job is completed.
  16263. */
  16264. SnapshotJobId: ShortRestrictiveResourceId;
  16265. /**
  16266. * A structure that contains information about the anonymous users that the generated snapshot is for. This API will not return information about registered Amazon QuickSight.
  16267. */
  16268. UserConfiguration: SnapshotUserConfiguration;
  16269. /**
  16270. * A structure that describes the configuration of the dashboard snapshot.
  16271. */
  16272. SnapshotConfiguration: SnapshotConfiguration;
  16273. }
  16274. export interface StartDashboardSnapshotJobResponse {
  16275. /**
  16276. * The Amazon Resource Name (ARN) for the dashboard snapshot job.
  16277. */
  16278. Arn?: Arn;
  16279. /**
  16280. * The ID of the job. The job ID is set when you start a new job with a StartDashboardSnapshotJob API call.
  16281. */
  16282. SnapshotJobId?: ShortRestrictiveResourceId;
  16283. /**
  16284. * The Amazon Web Services request ID for this operation.
  16285. */
  16286. RequestId?: NonEmptyString;
  16287. /**
  16288. * The HTTP status of the request
  16289. */
  16290. Status?: StatusCode;
  16291. }
  16292. export interface StatePersistenceConfigurations {
  16293. /**
  16294. * Determines if a Amazon QuickSight dashboard's state persistence settings are turned on or off.
  16295. */
  16296. Enabled: Boolean;
  16297. }
  16298. export type Status = "ENABLED"|"DISABLED"|string;
  16299. export type StatusCode = number;
  16300. export type String = string;
  16301. export interface StringDatasetParameter {
  16302. /**
  16303. * An identifier for the string parameter that is created in the dataset.
  16304. */
  16305. Id: DatasetParameterId;
  16306. /**
  16307. * The name of the string parameter that is created in the dataset.
  16308. */
  16309. Name: DatasetParameterName;
  16310. /**
  16311. * The value type of the dataset parameter. Valid values are single value or multi value.
  16312. */
  16313. ValueType: DatasetParameterValueType;
  16314. /**
  16315. * A list of default values for a given string dataset parameter type. This structure only accepts static values.
  16316. */
  16317. DefaultValues?: StringDatasetParameterDefaultValues;
  16318. }
  16319. export type StringDatasetParameterDefaultValue = string;
  16320. export interface StringDatasetParameterDefaultValues {
  16321. /**
  16322. * A list of static default values for a given string parameter.
  16323. */
  16324. StaticValues?: StringDatasetParameterValueList;
  16325. }
  16326. export type StringDatasetParameterValueList = StringDatasetParameterDefaultValue[];
  16327. export type StringDefaultValueList = SensitiveStringObject[];
  16328. export interface StringDefaultValues {
  16329. /**
  16330. * The dynamic value of the StringDefaultValues. Different defaults displayed according to users, groups, and values mapping.
  16331. */
  16332. DynamicValue?: DynamicDefaultValue;
  16333. /**
  16334. * The static values of the DecimalDefaultValues.
  16335. */
  16336. StaticValues?: StringDefaultValueList;
  16337. }
  16338. export interface StringFormatConfiguration {
  16339. /**
  16340. * The options that determine the null value format configuration.
  16341. */
  16342. NullValueFormatConfiguration?: NullValueFormatConfiguration;
  16343. /**
  16344. * The formatting configuration for numeric strings.
  16345. */
  16346. NumericFormatConfiguration?: NumericFormatConfiguration;
  16347. }
  16348. export type StringList = String[];
  16349. export interface StringParameter {
  16350. /**
  16351. * A display name for a string parameter.
  16352. */
  16353. Name: NonEmptyString;
  16354. /**
  16355. * The values of a string parameter.
  16356. */
  16357. Values: SensitiveStringList;
  16358. }
  16359. export interface StringParameterDeclaration {
  16360. /**
  16361. * The value type determines whether the parameter is a single-value or multi-value parameter.
  16362. */
  16363. ParameterValueType: ParameterValueType;
  16364. /**
  16365. * The name of the parameter that is being declared.
  16366. */
  16367. Name: ParameterName;
  16368. /**
  16369. * The default values of a parameter. If the parameter is a single-value parameter, a maximum of one default value can be provided.
  16370. */
  16371. DefaultValues?: StringDefaultValues;
  16372. /**
  16373. * The configuration that defines the default value of a String parameter when a value has not been set.
  16374. */
  16375. ValueWhenUnset?: StringValueWhenUnsetConfiguration;
  16376. MappedDataSetParameters?: MappedDataSetParameters;
  16377. }
  16378. export type StringParameterList = StringParameter[];
  16379. export interface StringValueWhenUnsetConfiguration {
  16380. /**
  16381. * The built-in options for default values. The value can be one of the following: RECOMMENDED: The recommended value. NULL: The NULL value.
  16382. */
  16383. ValueWhenUnsetOption?: ValueWhenUnsetOption;
  16384. /**
  16385. * A custom value that's used when the value of a parameter isn't set.
  16386. */
  16387. CustomValue?: SensitiveString;
  16388. }
  16389. export type StyledCellType = "TOTAL"|"METRIC_HEADER"|"VALUE"|string;
  16390. export type SubnetId = string;
  16391. export type SubnetIdList = SubnetId[];
  16392. export interface SubtotalOptions {
  16393. /**
  16394. * The visibility configuration for the subtotal cells.
  16395. */
  16396. TotalsVisibility?: Visibility;
  16397. /**
  16398. * The custom label string for the subtotal cells.
  16399. */
  16400. CustomLabel?: String;
  16401. /**
  16402. * The field level (all, custom, last) for the subtotal cells.
  16403. */
  16404. FieldLevel?: PivotTableSubtotalLevel;
  16405. /**
  16406. * The optional configuration of subtotal cells.
  16407. */
  16408. FieldLevelOptions?: PivotTableFieldSubtotalOptionsList;
  16409. /**
  16410. * The cell styling options for the subtotal cells.
  16411. */
  16412. TotalCellStyle?: TableCellStyle;
  16413. /**
  16414. * The cell styling options for the subtotals of value cells.
  16415. */
  16416. ValueCellStyle?: TableCellStyle;
  16417. /**
  16418. * The cell styling options for the subtotals of header cells.
  16419. */
  16420. MetricHeaderCellStyle?: TableCellStyle;
  16421. /**
  16422. * The style targets options for subtotals.
  16423. */
  16424. StyleTargets?: TableStyleTargetList;
  16425. }
  16426. export type Suffix = string;
  16427. export type Synonyms = LimitedString[];
  16428. export interface TableAggregatedFieldWells {
  16429. /**
  16430. * The group by field well for a pivot table. Values are grouped by group by fields.
  16431. */
  16432. GroupBy?: DimensionFieldList;
  16433. /**
  16434. * The values field well for a pivot table. Values are aggregated based on group by fields.
  16435. */
  16436. Values?: MeasureFieldList;
  16437. }
  16438. export interface TableBorderOptions {
  16439. /**
  16440. * The color of a table border.
  16441. */
  16442. Color?: HexColor;
  16443. /**
  16444. * The thickness of a table border.
  16445. */
  16446. Thickness?: TableBorderThickness;
  16447. /**
  16448. * The style (none, solid) of a table border.
  16449. */
  16450. Style?: TableBorderStyle;
  16451. }
  16452. export type TableBorderStyle = "NONE"|"SOLID"|string;
  16453. export type TableBorderThickness = number;
  16454. export interface TableCellConditionalFormatting {
  16455. /**
  16456. * The field ID of the cell for conditional formatting.
  16457. */
  16458. FieldId: FieldId;
  16459. /**
  16460. * The text format of the cell for conditional formatting.
  16461. */
  16462. TextFormat?: TextConditionalFormat;
  16463. }
  16464. export type TableCellImageScalingConfiguration = "FIT_TO_CELL_HEIGHT"|"FIT_TO_CELL_WIDTH"|"DO_NOT_SCALE"|string;
  16465. export interface TableCellImageSizingConfiguration {
  16466. /**
  16467. * The cell scaling configuration of the sizing options for the table image configuration.
  16468. */
  16469. TableCellImageScalingConfiguration?: TableCellImageScalingConfiguration;
  16470. }
  16471. export interface TableCellStyle {
  16472. /**
  16473. * The visibility of the table cells.
  16474. */
  16475. Visibility?: Visibility;
  16476. /**
  16477. * The font configuration of the table cells.
  16478. */
  16479. FontConfiguration?: FontConfiguration;
  16480. /**
  16481. * The text wrap (none, wrap) for the table cells.
  16482. */
  16483. TextWrap?: TextWrap;
  16484. /**
  16485. * The horizontal text alignment (left, center, right, auto) for the table cells.
  16486. */
  16487. HorizontalTextAlignment?: HorizontalTextAlignment;
  16488. /**
  16489. * The vertical text alignment (top, middle, bottom) for the table cells.
  16490. */
  16491. VerticalTextAlignment?: VerticalTextAlignment;
  16492. /**
  16493. * The background color for the table cells.
  16494. */
  16495. BackgroundColor?: HexColor;
  16496. /**
  16497. * The height color for the table cells.
  16498. */
  16499. Height?: TableFieldHeight;
  16500. /**
  16501. * The borders for the table cells.
  16502. */
  16503. Border?: GlobalTableBorderOptions;
  16504. }
  16505. export interface TableConditionalFormatting {
  16506. /**
  16507. * Conditional formatting options for a PivotTableVisual.
  16508. */
  16509. ConditionalFormattingOptions?: TableConditionalFormattingOptionList;
  16510. }
  16511. export interface TableConditionalFormattingOption {
  16512. /**
  16513. * The cell conditional formatting option for a table.
  16514. */
  16515. Cell?: TableCellConditionalFormatting;
  16516. /**
  16517. * The row conditional formatting option for a table.
  16518. */
  16519. Row?: TableRowConditionalFormatting;
  16520. }
  16521. export type TableConditionalFormattingOptionList = TableConditionalFormattingOption[];
  16522. export interface TableConfiguration {
  16523. /**
  16524. * The field wells of the visual.
  16525. */
  16526. FieldWells?: TableFieldWells;
  16527. /**
  16528. * The sort configuration for a TableVisual.
  16529. */
  16530. SortConfiguration?: TableSortConfiguration;
  16531. /**
  16532. * The table options for a table visual.
  16533. */
  16534. TableOptions?: TableOptions;
  16535. /**
  16536. * The total options for a table visual.
  16537. */
  16538. TotalOptions?: TotalOptions;
  16539. /**
  16540. * The field options for a table visual.
  16541. */
  16542. FieldOptions?: TableFieldOptions;
  16543. /**
  16544. * The paginated report options for a table visual.
  16545. */
  16546. PaginatedReportOptions?: TablePaginatedReportOptions;
  16547. /**
  16548. * A collection of inline visualizations to display within a chart.
  16549. */
  16550. TableInlineVisualizations?: TableInlineVisualizationList;
  16551. /**
  16552. * The general visual interactions setup for a visual.
  16553. */
  16554. Interactions?: VisualInteractionOptions;
  16555. }
  16556. export interface TableFieldCustomIconContent {
  16557. /**
  16558. * The icon set type (link) of the custom icon content for table URL link content.
  16559. */
  16560. Icon?: TableFieldIconSetType;
  16561. }
  16562. export interface TableFieldCustomTextContent {
  16563. /**
  16564. * The string value of the custom text content for the table URL link content.
  16565. */
  16566. Value?: String;
  16567. /**
  16568. * The font configuration of the custom text content for the table URL link content.
  16569. */
  16570. FontConfiguration: FontConfiguration;
  16571. }
  16572. export type TableFieldHeight = number;
  16573. export type TableFieldIconSetType = "LINK"|string;
  16574. export interface TableFieldImageConfiguration {
  16575. /**
  16576. * The sizing options for the table image configuration.
  16577. */
  16578. SizingOptions?: TableCellImageSizingConfiguration;
  16579. }
  16580. export interface TableFieldLinkConfiguration {
  16581. /**
  16582. * The URL target (new tab, new window, same tab) for the table link configuration.
  16583. */
  16584. Target: URLTargetConfiguration;
  16585. /**
  16586. * The URL content (text, icon) for the table link configuration.
  16587. */
  16588. Content: TableFieldLinkContentConfiguration;
  16589. }
  16590. export interface TableFieldLinkContentConfiguration {
  16591. /**
  16592. * The custom text content (value, font configuration) for the table link content configuration.
  16593. */
  16594. CustomTextContent?: TableFieldCustomTextContent;
  16595. /**
  16596. * The custom icon content for the table link content configuration.
  16597. */
  16598. CustomIconContent?: TableFieldCustomIconContent;
  16599. }
  16600. export interface TableFieldOption {
  16601. /**
  16602. * The field ID for a table field.
  16603. */
  16604. FieldId: FieldId;
  16605. /**
  16606. * The width for a table field.
  16607. */
  16608. Width?: PixelLength;
  16609. /**
  16610. * The custom label for a table field.
  16611. */
  16612. CustomLabel?: CustomLabel;
  16613. /**
  16614. * The visibility of a table field.
  16615. */
  16616. Visibility?: Visibility;
  16617. /**
  16618. * The URL configuration for a table field.
  16619. */
  16620. URLStyling?: TableFieldURLConfiguration;
  16621. }
  16622. export type TableFieldOptionList = TableFieldOption[];
  16623. export interface TableFieldOptions {
  16624. /**
  16625. * The field options to be configured to a table.
  16626. */
  16627. SelectedFieldOptions?: TableFieldOptionList;
  16628. /**
  16629. * The order of the field IDs that are configured as field options for a table visual.
  16630. */
  16631. Order?: FieldOrderList;
  16632. /**
  16633. * The settings for the pinned columns of a table visual.
  16634. */
  16635. PinnedFieldOptions?: TablePinnedFieldOptions;
  16636. }
  16637. export type TableFieldOrderList = FieldId[];
  16638. export interface TableFieldURLConfiguration {
  16639. /**
  16640. * The link configuration of a table field URL.
  16641. */
  16642. LinkConfiguration?: TableFieldLinkConfiguration;
  16643. /**
  16644. * The image configuration of a table field URL.
  16645. */
  16646. ImageConfiguration?: TableFieldImageConfiguration;
  16647. }
  16648. export interface TableFieldWells {
  16649. /**
  16650. * The aggregated field well for the table.
  16651. */
  16652. TableAggregatedFieldWells?: TableAggregatedFieldWells;
  16653. /**
  16654. * The unaggregated field well for the table.
  16655. */
  16656. TableUnaggregatedFieldWells?: TableUnaggregatedFieldWells;
  16657. }
  16658. export interface TableInlineVisualization {
  16659. /**
  16660. * The configuration of the inline visualization of the data bars within a chart.
  16661. */
  16662. DataBars?: DataBarsOptions;
  16663. }
  16664. export type TableInlineVisualizationList = TableInlineVisualization[];
  16665. export interface TableOptions {
  16666. /**
  16667. * The orientation (vertical, horizontal) for a table.
  16668. */
  16669. Orientation?: TableOrientation;
  16670. /**
  16671. * The table cell style of a table header.
  16672. */
  16673. HeaderStyle?: TableCellStyle;
  16674. /**
  16675. * The table cell style of table cells.
  16676. */
  16677. CellStyle?: TableCellStyle;
  16678. /**
  16679. * The row alternate color options (widget status, row alternate colors) for a table.
  16680. */
  16681. RowAlternateColorOptions?: RowAlternateColorOptions;
  16682. }
  16683. export type TableOrientation = "VERTICAL"|"HORIZONTAL"|string;
  16684. export interface TablePaginatedReportOptions {
  16685. /**
  16686. * The visibility of printing table overflow across pages.
  16687. */
  16688. VerticalOverflowVisibility?: Visibility;
  16689. /**
  16690. * The visibility of repeating header rows on each page.
  16691. */
  16692. OverflowColumnHeaderVisibility?: Visibility;
  16693. }
  16694. export interface TablePinnedFieldOptions {
  16695. /**
  16696. * A list of columns to be pinned to the left of a table visual.
  16697. */
  16698. PinnedLeftFields?: TableFieldOrderList;
  16699. }
  16700. export interface TableRowConditionalFormatting {
  16701. /**
  16702. * The conditional formatting color (solid, gradient) of the background for a table row.
  16703. */
  16704. BackgroundColor?: ConditionalFormattingColor;
  16705. /**
  16706. * The conditional formatting color (solid, gradient) of the text for a table row.
  16707. */
  16708. TextColor?: ConditionalFormattingColor;
  16709. }
  16710. export interface TableSideBorderOptions {
  16711. /**
  16712. * The table border options of the inner vertical border.
  16713. */
  16714. InnerVertical?: TableBorderOptions;
  16715. /**
  16716. * The table border options of the inner horizontal border.
  16717. */
  16718. InnerHorizontal?: TableBorderOptions;
  16719. /**
  16720. * The table border options of the left border.
  16721. */
  16722. Left?: TableBorderOptions;
  16723. /**
  16724. * The table border options of the right border.
  16725. */
  16726. Right?: TableBorderOptions;
  16727. /**
  16728. * The table border options of the top border.
  16729. */
  16730. Top?: TableBorderOptions;
  16731. /**
  16732. * The table border options of the bottom border.
  16733. */
  16734. Bottom?: TableBorderOptions;
  16735. }
  16736. export interface TableSortConfiguration {
  16737. /**
  16738. * The field sort options for rows in the table.
  16739. */
  16740. RowSort?: RowSortList;
  16741. /**
  16742. * The pagination configuration (page size, page number) for the table.
  16743. */
  16744. PaginationConfiguration?: PaginationConfiguration;
  16745. }
  16746. export interface TableStyleTarget {
  16747. /**
  16748. * The cell type of the table style target.
  16749. */
  16750. CellType: StyledCellType;
  16751. }
  16752. export type TableStyleTargetList = TableStyleTarget[];
  16753. export type TableTotalsPlacement = "START"|"END"|"AUTO"|string;
  16754. export type TableTotalsScrollStatus = "PINNED"|"SCROLLED"|string;
  16755. export interface TableUnaggregatedFieldWells {
  16756. /**
  16757. * The values field well for a pivot table. Values are unaggregated for an unaggregated table.
  16758. */
  16759. Values?: UnaggregatedFieldList;
  16760. }
  16761. export interface TableVisual {
  16762. /**
  16763. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
  16764. */
  16765. VisualId: ShortRestrictiveResourceId;
  16766. /**
  16767. * The title that is displayed on the visual.
  16768. */
  16769. Title?: VisualTitleLabelOptions;
  16770. /**
  16771. * The subtitle that is displayed on the visual.
  16772. */
  16773. Subtitle?: VisualSubtitleLabelOptions;
  16774. /**
  16775. * The configuration settings of the visual.
  16776. */
  16777. ChartConfiguration?: TableConfiguration;
  16778. /**
  16779. * The conditional formatting for a PivotTableVisual.
  16780. */
  16781. ConditionalFormatting?: TableConditionalFormatting;
  16782. /**
  16783. * The list of custom actions that are configured for a visual.
  16784. */
  16785. Actions?: VisualCustomActionList;
  16786. }
  16787. export interface Tag {
  16788. /**
  16789. * Tag key.
  16790. */
  16791. Key: TagKey;
  16792. /**
  16793. * Tag value.
  16794. */
  16795. Value: TagValue;
  16796. }
  16797. export interface TagColumnOperation {
  16798. /**
  16799. * The column that this operation acts on.
  16800. */
  16801. ColumnName: ColumnName;
  16802. /**
  16803. * The dataset column tag, currently only used for geospatial type tagging. This is not tags for the Amazon Web Services tagging feature.
  16804. */
  16805. Tags: ColumnTagList;
  16806. }
  16807. export type TagKey = string;
  16808. export type TagKeyList = TagKey[];
  16809. export type TagList = Tag[];
  16810. export interface TagResourceRequest {
  16811. /**
  16812. * The Amazon Resource Name (ARN) of the resource that you want to tag.
  16813. */
  16814. ResourceArn: Arn;
  16815. /**
  16816. * Contains a map of the key-value pairs for the resource tag or tags assigned to the resource.
  16817. */
  16818. Tags: TagList;
  16819. }
  16820. export interface TagResourceResponse {
  16821. /**
  16822. * The Amazon Web Services request ID for this operation.
  16823. */
  16824. RequestId?: String;
  16825. /**
  16826. * The HTTP status of the request.
  16827. */
  16828. Status?: StatusCode;
  16829. }
  16830. export type TagValue = string;
  16831. export type TargetVisualList = ShortRestrictiveResourceId[];
  16832. export type TargetVisualOptions = "ALL_VISUALS"|string;
  16833. export interface Template {
  16834. /**
  16835. * The Amazon Resource Name (ARN) of the template.
  16836. */
  16837. Arn?: Arn;
  16838. /**
  16839. * The display name of the template.
  16840. */
  16841. Name?: TemplateName;
  16842. /**
  16843. * A structure describing the versions of the template.
  16844. */
  16845. Version?: TemplateVersion;
  16846. /**
  16847. * The ID for the template. This is unique per Amazon Web Services Region for each Amazon Web Services account.
  16848. */
  16849. TemplateId?: ShortRestrictiveResourceId;
  16850. /**
  16851. * Time when this was last updated.
  16852. */
  16853. LastUpdatedTime?: Timestamp;
  16854. /**
  16855. * Time when this was created.
  16856. */
  16857. CreatedTime?: Timestamp;
  16858. }
  16859. export interface TemplateAlias {
  16860. /**
  16861. * The display name of the template alias.
  16862. */
  16863. AliasName?: AliasName;
  16864. /**
  16865. * The Amazon Resource Name (ARN) of the template alias.
  16866. */
  16867. Arn?: Arn;
  16868. /**
  16869. * The version number of the template alias.
  16870. */
  16871. TemplateVersionNumber?: VersionNumber;
  16872. }
  16873. export type TemplateAliasList = TemplateAlias[];
  16874. export interface TemplateError {
  16875. /**
  16876. * Type of error.
  16877. */
  16878. Type?: TemplateErrorType;
  16879. /**
  16880. * Description of the error type.
  16881. */
  16882. Message?: NonEmptyString;
  16883. /**
  16884. * An error path that shows which entities caused the template error.
  16885. */
  16886. ViolatedEntities?: EntityList;
  16887. }
  16888. export type TemplateErrorList = TemplateError[];
  16889. export type TemplateErrorType = "SOURCE_NOT_FOUND"|"DATA_SET_NOT_FOUND"|"INTERNAL_FAILURE"|"ACCESS_DENIED"|string;
  16890. export type TemplateName = string;
  16891. export interface TemplateSourceAnalysis {
  16892. /**
  16893. * The Amazon Resource Name (ARN) of the resource.
  16894. */
  16895. Arn: Arn;
  16896. /**
  16897. * A structure containing information about the dataset references used as placeholders in the template.
  16898. */
  16899. DataSetReferences: DataSetReferenceList;
  16900. }
  16901. export interface TemplateSourceEntity {
  16902. /**
  16903. * The source analysis, if it is based on an analysis.
  16904. */
  16905. SourceAnalysis?: TemplateSourceAnalysis;
  16906. /**
  16907. * The source template, if it is based on an template.
  16908. */
  16909. SourceTemplate?: TemplateSourceTemplate;
  16910. }
  16911. export interface TemplateSourceTemplate {
  16912. /**
  16913. * The Amazon Resource Name (ARN) of the resource.
  16914. */
  16915. Arn: Arn;
  16916. }
  16917. export interface TemplateSummary {
  16918. /**
  16919. * A summary of a template.
  16920. */
  16921. Arn?: Arn;
  16922. /**
  16923. * The ID of the template. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  16924. */
  16925. TemplateId?: ShortRestrictiveResourceId;
  16926. /**
  16927. * A display name for the template.
  16928. */
  16929. Name?: TemplateName;
  16930. /**
  16931. * A structure containing a list of version numbers for the template summary.
  16932. */
  16933. LatestVersionNumber?: VersionNumber;
  16934. /**
  16935. * The last time that this template was created.
  16936. */
  16937. CreatedTime?: Timestamp;
  16938. /**
  16939. * The last time that this template was updated.
  16940. */
  16941. LastUpdatedTime?: Timestamp;
  16942. }
  16943. export type TemplateSummaryList = TemplateSummary[];
  16944. export interface TemplateVersion {
  16945. /**
  16946. * The time that this template version was created.
  16947. */
  16948. CreatedTime?: Timestamp;
  16949. /**
  16950. * Errors associated with this template version.
  16951. */
  16952. Errors?: TemplateErrorList;
  16953. /**
  16954. * The version number of the template version.
  16955. */
  16956. VersionNumber?: VersionNumber;
  16957. /**
  16958. * The status that is associated with the template. CREATION_IN_PROGRESS CREATION_SUCCESSFUL CREATION_FAILED UPDATE_IN_PROGRESS UPDATE_SUCCESSFUL UPDATE_FAILED DELETED
  16959. */
  16960. Status?: ResourceStatus;
  16961. /**
  16962. * Schema of the dataset identified by the placeholder. Any dashboard created from this template should be bound to new datasets matching the same schema described through this API operation.
  16963. */
  16964. DataSetConfigurations?: DataSetConfigurationList;
  16965. /**
  16966. * The description of the template.
  16967. */
  16968. Description?: VersionDescription;
  16969. /**
  16970. * The Amazon Resource Name (ARN) of an analysis or template that was used to create this template.
  16971. */
  16972. SourceEntityArn?: Arn;
  16973. /**
  16974. * The ARN of the theme associated with this version of the template.
  16975. */
  16976. ThemeArn?: Arn;
  16977. /**
  16978. * A list of the associated sheets with the unique identifier and name of each sheet.
  16979. */
  16980. Sheets?: SheetList;
  16981. }
  16982. export interface TemplateVersionDefinition {
  16983. /**
  16984. * An array of dataset configurations. These configurations define the required columns for each dataset used within a template.
  16985. */
  16986. DataSetConfigurations: DataSetConfigurationList;
  16987. /**
  16988. * An array of sheet definitions for a template.
  16989. */
  16990. Sheets?: SheetDefinitionList;
  16991. /**
  16992. * An array of calculated field definitions for the template.
  16993. */
  16994. CalculatedFields?: CalculatedFields;
  16995. /**
  16996. * An array of parameter declarations for a template. Parameters are named variables that can transfer a value for use by an action or an object. For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
  16997. */
  16998. ParameterDeclarations?: ParameterDeclarationList;
  16999. /**
  17000. * Filter definitions for a template. For more information, see Filtering Data in the Amazon QuickSight User Guide.
  17001. */
  17002. FilterGroups?: FilterGroupList;
  17003. /**
  17004. * An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.
  17005. */
  17006. ColumnConfigurations?: ColumnConfigurationList;
  17007. AnalysisDefaults?: AnalysisDefaults;
  17008. /**
  17009. * An array of option definitions for a template.
  17010. */
  17011. Options?: AssetOptions;
  17012. }
  17013. export interface TemplateVersionSummary {
  17014. /**
  17015. * The Amazon Resource Name (ARN) of the template version.
  17016. */
  17017. Arn?: Arn;
  17018. /**
  17019. * The version number of the template version.
  17020. */
  17021. VersionNumber?: VersionNumber;
  17022. /**
  17023. * The time that this template version was created.
  17024. */
  17025. CreatedTime?: Timestamp;
  17026. /**
  17027. * The status of the template version.
  17028. */
  17029. Status?: ResourceStatus;
  17030. /**
  17031. * The description of the template version.
  17032. */
  17033. Description?: VersionDescription;
  17034. }
  17035. export type TemplateVersionSummaryList = TemplateVersionSummary[];
  17036. export interface TeradataParameters {
  17037. /**
  17038. * Host.
  17039. */
  17040. Host: Host;
  17041. /**
  17042. * Port.
  17043. */
  17044. Port: Port;
  17045. /**
  17046. * Database.
  17047. */
  17048. Database: Database;
  17049. }
  17050. export type TextAreaControlDelimiter = string;
  17051. export interface TextAreaControlDisplayOptions {
  17052. /**
  17053. * The options to configure the title visibility, name, and font size.
  17054. */
  17055. TitleOptions?: LabelOptions;
  17056. /**
  17057. * The configuration of the placeholder options in a text area control.
  17058. */
  17059. PlaceholderOptions?: TextControlPlaceholderOptions;
  17060. /**
  17061. * The configuration of info icon label options.
  17062. */
  17063. InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
  17064. }
  17065. export interface TextConditionalFormat {
  17066. /**
  17067. * The conditional formatting for the text background color.
  17068. */
  17069. BackgroundColor?: ConditionalFormattingColor;
  17070. /**
  17071. * The conditional formatting for the text color.
  17072. */
  17073. TextColor?: ConditionalFormattingColor;
  17074. /**
  17075. * The conditional formatting for the icon.
  17076. */
  17077. Icon?: ConditionalFormattingIcon;
  17078. }
  17079. export interface TextControlPlaceholderOptions {
  17080. /**
  17081. * The visibility configuration of the placeholder options in a text control.
  17082. */
  17083. Visibility?: Visibility;
  17084. }
  17085. export interface TextFieldControlDisplayOptions {
  17086. /**
  17087. * The options to configure the title visibility, name, and font size.
  17088. */
  17089. TitleOptions?: LabelOptions;
  17090. /**
  17091. * The configuration of the placeholder options in a text field control.
  17092. */
  17093. PlaceholderOptions?: TextControlPlaceholderOptions;
  17094. /**
  17095. * The configuration of info icon label options.
  17096. */
  17097. InfoIconLabelOptions?: SheetControlInfoIconLabelOptions;
  17098. }
  17099. export type TextQualifier = "DOUBLE_QUOTE"|"SINGLE_QUOTE"|string;
  17100. export type TextWrap = "NONE"|"WRAP"|string;
  17101. export interface Theme {
  17102. /**
  17103. * The Amazon Resource Name (ARN) of the theme.
  17104. */
  17105. Arn?: Arn;
  17106. /**
  17107. * The name that the user gives to the theme.
  17108. */
  17109. Name?: ThemeName;
  17110. /**
  17111. * The identifier that the user gives to the theme.
  17112. */
  17113. ThemeId?: ShortRestrictiveResourceId;
  17114. Version?: ThemeVersion;
  17115. /**
  17116. * The date and time that the theme was created.
  17117. */
  17118. CreatedTime?: Timestamp;
  17119. /**
  17120. * The date and time that the theme was last updated.
  17121. */
  17122. LastUpdatedTime?: Timestamp;
  17123. /**
  17124. * The type of theme, based on how it was created. Valid values include: QUICKSIGHT and CUSTOM.
  17125. */
  17126. Type?: ThemeType;
  17127. }
  17128. export interface ThemeAlias {
  17129. /**
  17130. * The Amazon Resource Name (ARN) of the theme alias.
  17131. */
  17132. Arn?: Arn;
  17133. /**
  17134. * The display name of the theme alias.
  17135. */
  17136. AliasName?: AliasName;
  17137. /**
  17138. * The version number of the theme alias.
  17139. */
  17140. ThemeVersionNumber?: VersionNumber;
  17141. }
  17142. export type ThemeAliasList = ThemeAlias[];
  17143. export interface ThemeConfiguration {
  17144. /**
  17145. * Color properties that apply to chart data colors.
  17146. */
  17147. DataColorPalette?: DataColorPalette;
  17148. /**
  17149. * Color properties that apply to the UI and to charts, excluding the colors that apply to data.
  17150. */
  17151. UIColorPalette?: UIColorPalette;
  17152. /**
  17153. * Display options related to sheets.
  17154. */
  17155. Sheet?: SheetStyle;
  17156. Typography?: Typography;
  17157. }
  17158. export interface ThemeError {
  17159. /**
  17160. * The type of error.
  17161. */
  17162. Type?: ThemeErrorType;
  17163. /**
  17164. * The error message.
  17165. */
  17166. Message?: NonEmptyString;
  17167. }
  17168. export type ThemeErrorList = ThemeError[];
  17169. export type ThemeErrorType = "INTERNAL_FAILURE"|string;
  17170. export type ThemeName = string;
  17171. export interface ThemeSummary {
  17172. /**
  17173. * The Amazon Resource Name (ARN) of the resource.
  17174. */
  17175. Arn?: Arn;
  17176. /**
  17177. * the display name for the theme.
  17178. */
  17179. Name?: ThemeName;
  17180. /**
  17181. * The ID of the theme. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  17182. */
  17183. ThemeId?: ShortRestrictiveResourceId;
  17184. /**
  17185. * The latest version number for the theme.
  17186. */
  17187. LatestVersionNumber?: VersionNumber;
  17188. /**
  17189. * The date and time that this theme was created.
  17190. */
  17191. CreatedTime?: Timestamp;
  17192. /**
  17193. * The last date and time that this theme was updated.
  17194. */
  17195. LastUpdatedTime?: Timestamp;
  17196. }
  17197. export type ThemeSummaryList = ThemeSummary[];
  17198. export type ThemeType = "QUICKSIGHT"|"CUSTOM"|"ALL"|string;
  17199. export interface ThemeVersion {
  17200. /**
  17201. * The version number of the theme.
  17202. */
  17203. VersionNumber?: VersionNumber;
  17204. /**
  17205. * The Amazon Resource Name (ARN) of the resource.
  17206. */
  17207. Arn?: Arn;
  17208. /**
  17209. * The description of the theme.
  17210. */
  17211. Description?: VersionDescription;
  17212. /**
  17213. * The Amazon QuickSight-defined ID of the theme that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
  17214. */
  17215. BaseThemeId?: ShortRestrictiveResourceId;
  17216. /**
  17217. * The date and time that this theme version was created.
  17218. */
  17219. CreatedTime?: Timestamp;
  17220. /**
  17221. * The theme configuration, which contains all the theme display properties.
  17222. */
  17223. Configuration?: ThemeConfiguration;
  17224. /**
  17225. * Errors associated with the theme.
  17226. */
  17227. Errors?: ThemeErrorList;
  17228. /**
  17229. * The status of the theme version.
  17230. */
  17231. Status?: ResourceStatus;
  17232. }
  17233. export interface ThemeVersionSummary {
  17234. /**
  17235. * The version number of the theme version.
  17236. */
  17237. VersionNumber?: VersionNumber;
  17238. /**
  17239. * The Amazon Resource Name (ARN) of the theme version.
  17240. */
  17241. Arn?: Arn;
  17242. /**
  17243. * The description of the theme version.
  17244. */
  17245. Description?: VersionDescription;
  17246. /**
  17247. * The date and time that this theme version was created.
  17248. */
  17249. CreatedTime?: Timestamp;
  17250. /**
  17251. * The status of the theme version.
  17252. */
  17253. Status?: ResourceStatus;
  17254. }
  17255. export type ThemeVersionSummaryList = ThemeVersionSummary[];
  17256. export interface ThousandSeparatorOptions {
  17257. /**
  17258. * Determines the thousands separator symbol.
  17259. */
  17260. Symbol?: NumericSeparatorSymbol;
  17261. /**
  17262. * Determines the visibility of the thousands separator.
  17263. */
  17264. Visibility?: Visibility;
  17265. }
  17266. export interface TileLayoutStyle {
  17267. /**
  17268. * The gutter settings that apply between tiles.
  17269. */
  17270. Gutter?: GutterStyle;
  17271. /**
  17272. * The margin settings that apply around the outside edge of sheets.
  17273. */
  17274. Margin?: MarginStyle;
  17275. }
  17276. export interface TileStyle {
  17277. /**
  17278. * The border around a tile.
  17279. */
  17280. Border?: BorderStyle;
  17281. }
  17282. export interface TimeBasedForecastProperties {
  17283. /**
  17284. * The periods forward setup of a forecast computation.
  17285. */
  17286. PeriodsForward?: PeriodsForward;
  17287. /**
  17288. * The periods backward setup of a forecast computation.
  17289. */
  17290. PeriodsBackward?: PeriodsBackward;
  17291. /**
  17292. * The upper boundary setup of a forecast computation.
  17293. */
  17294. UpperBoundary?: Double;
  17295. /**
  17296. * The lower boundary setup of a forecast computation.
  17297. */
  17298. LowerBoundary?: Double;
  17299. /**
  17300. * The prediction interval setup of a forecast computation.
  17301. */
  17302. PredictionInterval?: PredictionInterval;
  17303. /**
  17304. * The seasonality setup of a forecast computation. Choose one of the following options: NULL: The input is set to NULL. NON_NULL: The input is set to a custom value.
  17305. */
  17306. Seasonality?: Seasonality;
  17307. }
  17308. export interface TimeEqualityFilter {
  17309. /**
  17310. * An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
  17311. */
  17312. FilterId: ShortRestrictiveResourceId;
  17313. /**
  17314. * The column that the filter is applied to.
  17315. */
  17316. Column: ColumnIdentifier;
  17317. /**
  17318. * The value of a TimeEquality filter. This field is mutually exclusive to RollingDate and ParameterName.
  17319. */
  17320. Value?: Timestamp;
  17321. /**
  17322. * The parameter whose value should be used for the filter value. This field is mutually exclusive to Value and RollingDate.
  17323. */
  17324. ParameterName?: ParameterName;
  17325. /**
  17326. * The level of time precision that is used to aggregate DateTime values.
  17327. */
  17328. TimeGranularity?: TimeGranularity;
  17329. /**
  17330. * The rolling date input for the TimeEquality filter. This field is mutually exclusive to Value and ParameterName.
  17331. */
  17332. RollingDate?: RollingDateConfiguration;
  17333. /**
  17334. * The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
  17335. */
  17336. DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
  17337. }
  17338. export type TimeGranularity = "YEAR"|"QUARTER"|"MONTH"|"WEEK"|"DAY"|"HOUR"|"MINUTE"|"SECOND"|"MILLISECOND"|string;
  17339. export interface TimeRangeDrillDownFilter {
  17340. /**
  17341. * The column that the filter is applied to.
  17342. */
  17343. Column: ColumnIdentifier;
  17344. /**
  17345. * The minimum value for the filter value range.
  17346. */
  17347. RangeMinimum: Timestamp;
  17348. /**
  17349. * The maximum value for the filter value range.
  17350. */
  17351. RangeMaximum: Timestamp;
  17352. /**
  17353. * The level of time precision that is used to aggregate DateTime values.
  17354. */
  17355. TimeGranularity: TimeGranularity;
  17356. }
  17357. export interface TimeRangeFilter {
  17358. /**
  17359. * An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
  17360. */
  17361. FilterId: ShortRestrictiveResourceId;
  17362. /**
  17363. * The column that the filter is applied to.
  17364. */
  17365. Column: ColumnIdentifier;
  17366. /**
  17367. * Determines whether the minimum value in the filter value range should be included in the filtered results.
  17368. */
  17369. IncludeMinimum?: Boolean;
  17370. /**
  17371. * Determines whether the maximum value in the filter value range should be included in the filtered results.
  17372. */
  17373. IncludeMaximum?: Boolean;
  17374. /**
  17375. * The minimum value for the filter value range.
  17376. */
  17377. RangeMinimumValue?: TimeRangeFilterValue;
  17378. /**
  17379. * The maximum value for the filter value range.
  17380. */
  17381. RangeMaximumValue?: TimeRangeFilterValue;
  17382. /**
  17383. * This option determines how null values should be treated when filtering data. ALL_VALUES: Include null values in filtered results. NULLS_ONLY: Only include null values in filtered results. NON_NULLS_ONLY: Exclude null values from filtered results.
  17384. */
  17385. NullOption: FilterNullOption;
  17386. /**
  17387. * The exclude period of the time range filter.
  17388. */
  17389. ExcludePeriodConfiguration?: ExcludePeriodConfiguration;
  17390. /**
  17391. * The level of time precision that is used to aggregate DateTime values.
  17392. */
  17393. TimeGranularity?: TimeGranularity;
  17394. /**
  17395. * The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
  17396. */
  17397. DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
  17398. }
  17399. export interface TimeRangeFilterValue {
  17400. /**
  17401. * The static input value.
  17402. */
  17403. StaticValue?: Timestamp;
  17404. /**
  17405. * The rolling date input value.
  17406. */
  17407. RollingDate?: RollingDateConfiguration;
  17408. /**
  17409. * The parameter type input value.
  17410. */
  17411. Parameter?: ParameterName;
  17412. }
  17413. export type Timestamp = Date;
  17414. export interface TooltipItem {
  17415. /**
  17416. * The tooltip item for the fields.
  17417. */
  17418. FieldTooltipItem?: FieldTooltipItem;
  17419. /**
  17420. * The tooltip item for the columns that are not part of a field well.
  17421. */
  17422. ColumnTooltipItem?: ColumnTooltipItem;
  17423. }
  17424. export type TooltipItemList = TooltipItem[];
  17425. export interface TooltipOptions {
  17426. /**
  17427. * Determines whether or not the tooltip is visible.
  17428. */
  17429. TooltipVisibility?: Visibility;
  17430. /**
  17431. * The selected type for the tooltip. Choose one of the following options: BASIC: A basic tooltip. DETAILED: A detailed tooltip.
  17432. */
  17433. SelectedTooltipType?: SelectedTooltipType;
  17434. /**
  17435. * The setup for the detailed tooltip. The tooltip setup is always saved. The display type is decided based on the tooltip type.
  17436. */
  17437. FieldBasedTooltip?: FieldBasedTooltip;
  17438. }
  17439. export type TooltipTarget = "BOTH"|"BAR"|"LINE"|string;
  17440. export type TooltipTitleType = "NONE"|"PRIMARY_VALUE"|string;
  17441. export type TopBottomComputationType = "TOP"|"BOTTOM"|string;
  17442. export interface TopBottomFilter {
  17443. /**
  17444. * An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
  17445. */
  17446. FilterId: ShortRestrictiveResourceId;
  17447. /**
  17448. * The column that the filter is applied to.
  17449. */
  17450. Column: ColumnIdentifier;
  17451. /**
  17452. * The number of items to include in the top bottom filter results.
  17453. */
  17454. Limit?: Integer;
  17455. /**
  17456. * The aggregation and sort configuration of the top bottom filter.
  17457. */
  17458. AggregationSortConfigurations: AggregationSortConfigurationList;
  17459. /**
  17460. * The level of time precision that is used to aggregate DateTime values.
  17461. */
  17462. TimeGranularity?: TimeGranularity;
  17463. /**
  17464. * The parameter whose value should be used for the filter value.
  17465. */
  17466. ParameterName?: ParameterName;
  17467. /**
  17468. * The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
  17469. */
  17470. DefaultFilterControlConfiguration?: DefaultFilterControlConfiguration;
  17471. }
  17472. export interface TopBottomMoversComputation {
  17473. /**
  17474. * The ID for a computation.
  17475. */
  17476. ComputationId: ShortRestrictiveResourceId;
  17477. /**
  17478. * The name of a computation.
  17479. */
  17480. Name?: String;
  17481. /**
  17482. * The time field that is used in a computation.
  17483. */
  17484. Time?: DimensionField;
  17485. /**
  17486. * The category field that is used in a computation.
  17487. */
  17488. Category?: DimensionField;
  17489. /**
  17490. * The value field that is used in a computation.
  17491. */
  17492. Value?: MeasureField;
  17493. /**
  17494. * The mover size setup of the top and bottom movers computation.
  17495. */
  17496. MoverSize?: TopBottomMoversComputationMoverSize;
  17497. /**
  17498. * The sort order setup of the top and bottom movers computation.
  17499. */
  17500. SortOrder?: TopBottomSortOrder;
  17501. /**
  17502. * The computation type. Choose from the following options: TOP: Top movers computation. BOTTOM: Bottom movers computation.
  17503. */
  17504. Type: TopBottomComputationType;
  17505. }
  17506. export type TopBottomMoversComputationMoverSize = number;
  17507. export interface TopBottomRankedComputation {
  17508. /**
  17509. * The ID for a computation.
  17510. */
  17511. ComputationId: ShortRestrictiveResourceId;
  17512. /**
  17513. * The name of a computation.
  17514. */
  17515. Name?: String;
  17516. /**
  17517. * The category field that is used in a computation.
  17518. */
  17519. Category?: DimensionField;
  17520. /**
  17521. * The value field that is used in a computation.
  17522. */
  17523. Value?: MeasureField;
  17524. /**
  17525. * The result size of a top and bottom ranked computation.
  17526. */
  17527. ResultSize?: TopBottomRankedComputationResultSize;
  17528. /**
  17529. * The computation type. Choose one of the following options: TOP: A top ranked computation. BOTTOM: A bottom ranked computation.
  17530. */
  17531. Type: TopBottomComputationType;
  17532. }
  17533. export type TopBottomRankedComputationResultSize = number;
  17534. export type TopBottomSortOrder = "PERCENT_DIFFERENCE"|"ABSOLUTE_DIFFERENCE"|string;
  17535. export interface TopicCalculatedField {
  17536. /**
  17537. * The calculated field name.
  17538. */
  17539. CalculatedFieldName: LimitedString;
  17540. /**
  17541. * The calculated field description.
  17542. */
  17543. CalculatedFieldDescription?: LimitedString;
  17544. /**
  17545. * The calculated field expression.
  17546. */
  17547. Expression: Expression;
  17548. /**
  17549. * The other names or aliases for the calculated field.
  17550. */
  17551. CalculatedFieldSynonyms?: Synonyms;
  17552. /**
  17553. * A boolean value that indicates if a calculated field is included in the topic.
  17554. */
  17555. IsIncludedInTopic?: Boolean;
  17556. /**
  17557. * A Boolean value that indicates if a calculated field is visible in the autocomplete.
  17558. */
  17559. DisableIndexing?: NullableBoolean;
  17560. /**
  17561. * The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.
  17562. */
  17563. ColumnDataRole?: ColumnDataRole;
  17564. /**
  17565. * The level of time precision that is used to aggregate DateTime values.
  17566. */
  17567. TimeGranularity?: TopicTimeGranularity;
  17568. /**
  17569. * The default formatting definition.
  17570. */
  17571. DefaultFormatting?: DefaultFormatting;
  17572. /**
  17573. * The default aggregation. Valid values for this structure are SUM, MAX, MIN, COUNT, DISTINCT_COUNT, and AVERAGE.
  17574. */
  17575. Aggregation?: DefaultAggregation;
  17576. /**
  17577. * The order in which data is displayed for the calculated field when it's used in a comparative context.
  17578. */
  17579. ComparativeOrder?: ComparativeOrder;
  17580. /**
  17581. * The semantic type.
  17582. */
  17583. SemanticType?: SemanticType;
  17584. /**
  17585. * The list of aggregation types that are allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
  17586. */
  17587. AllowedAggregations?: AuthorSpecifiedAggregations;
  17588. /**
  17589. * The list of aggregation types that are not allowed for the calculated field. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
  17590. */
  17591. NotAllowedAggregations?: AuthorSpecifiedAggregations;
  17592. /**
  17593. * A Boolean value that indicates whether to never aggregate calculated field in filters.
  17594. */
  17595. NeverAggregateInFilter?: Boolean;
  17596. /**
  17597. * The other names or aliases for the calculated field cell value.
  17598. */
  17599. CellValueSynonyms?: CellValueSynonyms;
  17600. /**
  17601. * The non additive for the table style target.
  17602. */
  17603. NonAdditive?: NullableBoolean;
  17604. }
  17605. export type TopicCalculatedFields = TopicCalculatedField[];
  17606. export interface TopicCategoryFilter {
  17607. /**
  17608. * The category filter function. Valid values for this structure are EXACT and CONTAINS.
  17609. */
  17610. CategoryFilterFunction?: CategoryFilterFunction;
  17611. /**
  17612. * The category filter type. This element is used to specify whether a filter is a simple category filter or an inverse category filter.
  17613. */
  17614. CategoryFilterType?: CategoryFilterType;
  17615. /**
  17616. * The constant used in a category filter.
  17617. */
  17618. Constant?: TopicCategoryFilterConstant;
  17619. /**
  17620. * A Boolean value that indicates if the filter is inverse.
  17621. */
  17622. Inverse?: Boolean;
  17623. }
  17624. export interface TopicCategoryFilterConstant {
  17625. /**
  17626. * The type of category filter constant. This element is used to specify whether a constant is a singular or collective. Valid values are SINGULAR and COLLECTIVE.
  17627. */
  17628. ConstantType?: ConstantType;
  17629. /**
  17630. * A singular constant used in a category filter. This element is used to specify a single value for the constant.
  17631. */
  17632. SingularConstant?: LimitedString;
  17633. /**
  17634. * A collective constant used in a category filter. This element is used to specify a list of values for the constant.
  17635. */
  17636. CollectiveConstant?: CollectiveConstant;
  17637. }
  17638. export interface TopicColumn {
  17639. /**
  17640. * The name of the column.
  17641. */
  17642. ColumnName: LimitedString;
  17643. /**
  17644. * A user-friendly name for the column.
  17645. */
  17646. ColumnFriendlyName?: LimitedString;
  17647. /**
  17648. * A description of the column and its contents.
  17649. */
  17650. ColumnDescription?: LimitedString;
  17651. /**
  17652. * The other names or aliases for the column.
  17653. */
  17654. ColumnSynonyms?: Synonyms;
  17655. /**
  17656. * The role of the column in the data. Valid values are DIMENSION and MEASURE.
  17657. */
  17658. ColumnDataRole?: ColumnDataRole;
  17659. /**
  17660. * The type of aggregation that is performed on the column data when it's queried.
  17661. */
  17662. Aggregation?: DefaultAggregation;
  17663. /**
  17664. * A Boolean value that indicates whether the column is included in the query results.
  17665. */
  17666. IsIncludedInTopic?: Boolean;
  17667. /**
  17668. * A Boolean value that indicates whether the column shows in the autocomplete functionality.
  17669. */
  17670. DisableIndexing?: NullableBoolean;
  17671. /**
  17672. * The order in which data is displayed for the column when it's used in a comparative context.
  17673. */
  17674. ComparativeOrder?: ComparativeOrder;
  17675. /**
  17676. * The semantic type of data contained in the column.
  17677. */
  17678. SemanticType?: SemanticType;
  17679. /**
  17680. * The level of time precision that is used to aggregate DateTime values.
  17681. */
  17682. TimeGranularity?: TopicTimeGranularity;
  17683. /**
  17684. * The list of aggregation types that are allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
  17685. */
  17686. AllowedAggregations?: AuthorSpecifiedAggregations;
  17687. /**
  17688. * The list of aggregation types that are not allowed for the column. Valid values for this structure are COUNT, DISTINCT_COUNT, MIN, MAX, MEDIAN, SUM, AVERAGE, STDEV, STDEVP, VAR, VARP, and PERCENTILE.
  17689. */
  17690. NotAllowedAggregations?: AuthorSpecifiedAggregations;
  17691. /**
  17692. * The default formatting used for values in the column.
  17693. */
  17694. DefaultFormatting?: DefaultFormatting;
  17695. /**
  17696. * A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
  17697. */
  17698. NeverAggregateInFilter?: Boolean;
  17699. /**
  17700. * The other names or aliases for the column cell value.
  17701. */
  17702. CellValueSynonyms?: CellValueSynonyms;
  17703. /**
  17704. * The non additive value for the column.
  17705. */
  17706. NonAdditive?: NullableBoolean;
  17707. }
  17708. export type TopicColumns = TopicColumn[];
  17709. export interface TopicDateRangeFilter {
  17710. /**
  17711. * A Boolean value that indicates whether the date range filter should include the boundary values. If set to true, the filter includes the start and end dates. If set to false, the filter excludes them.
  17712. */
  17713. Inclusive?: Boolean;
  17714. /**
  17715. * The constant used in a date range filter.
  17716. */
  17717. Constant?: TopicRangeFilterConstant;
  17718. }
  17719. export interface TopicDetails {
  17720. /**
  17721. * The name of the topic.
  17722. */
  17723. Name?: ResourceName;
  17724. /**
  17725. * The description of the topic.
  17726. */
  17727. Description?: LimitedString;
  17728. /**
  17729. * The user experience version of a topic.
  17730. */
  17731. UserExperienceVersion?: TopicUserExperienceVersion;
  17732. /**
  17733. * The data sets that the topic is associated with.
  17734. */
  17735. DataSets?: Datasets;
  17736. }
  17737. export interface TopicFilter {
  17738. /**
  17739. * A description of the filter used to select items for a topic.
  17740. */
  17741. FilterDescription?: LimitedString;
  17742. /**
  17743. * The class of the filter. Valid values for this structure are ENFORCED_VALUE_FILTER, CONDITIONAL_VALUE_FILTER, and NAMED_VALUE_FILTER.
  17744. */
  17745. FilterClass?: FilterClass;
  17746. /**
  17747. * The name of the filter.
  17748. */
  17749. FilterName: LimitedString;
  17750. /**
  17751. * The other names or aliases for the filter.
  17752. */
  17753. FilterSynonyms?: Synonyms;
  17754. /**
  17755. * The name of the field that the filter operates on.
  17756. */
  17757. OperandFieldName: LimitedString;
  17758. /**
  17759. * The type of the filter. Valid values for this structure are CATEGORY_FILTER, NUMERIC_EQUALITY_FILTER, NUMERIC_RANGE_FILTER, DATE_RANGE_FILTER, and RELATIVE_DATE_FILTER.
  17760. */
  17761. FilterType?: NamedFilterType;
  17762. /**
  17763. * The category filter that is associated with this filter.
  17764. */
  17765. CategoryFilter?: TopicCategoryFilter;
  17766. /**
  17767. * The numeric equality filter.
  17768. */
  17769. NumericEqualityFilter?: TopicNumericEqualityFilter;
  17770. /**
  17771. * The numeric range filter.
  17772. */
  17773. NumericRangeFilter?: TopicNumericRangeFilter;
  17774. /**
  17775. * The date range filter.
  17776. */
  17777. DateRangeFilter?: TopicDateRangeFilter;
  17778. /**
  17779. * The relative date filter.
  17780. */
  17781. RelativeDateFilter?: TopicRelativeDateFilter;
  17782. }
  17783. export type TopicFilters = TopicFilter[];
  17784. export type TopicId = string;
  17785. export type TopicNamedEntities = TopicNamedEntity[];
  17786. export interface TopicNamedEntity {
  17787. /**
  17788. * The name of the named entity.
  17789. */
  17790. EntityName: LimitedString;
  17791. /**
  17792. * The description of the named entity.
  17793. */
  17794. EntityDescription?: LimitedString;
  17795. /**
  17796. * The other names or aliases for the named entity.
  17797. */
  17798. EntitySynonyms?: Synonyms;
  17799. /**
  17800. * The type of named entity that a topic represents.
  17801. */
  17802. SemanticEntityType?: SemanticEntityType;
  17803. /**
  17804. * The definition of a named entity.
  17805. */
  17806. Definition?: NamedEntityDefinitions;
  17807. }
  17808. export interface TopicNumericEqualityFilter {
  17809. /**
  17810. * The constant used in a numeric equality filter.
  17811. */
  17812. Constant?: TopicSingularFilterConstant;
  17813. /**
  17814. * An aggregation function that specifies how to calculate the value of a numeric field for a topic. Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.
  17815. */
  17816. Aggregation?: NamedFilterAggType;
  17817. }
  17818. export interface TopicNumericRangeFilter {
  17819. /**
  17820. * A Boolean value that indicates whether the endpoints of the numeric range are included in the filter. If set to true, topics whose numeric field value is equal to the endpoint values will be included in the filter. If set to false, topics whose numeric field value is equal to the endpoint values will be excluded from the filter.
  17821. */
  17822. Inclusive?: Boolean;
  17823. /**
  17824. * The constant used in a numeric range filter.
  17825. */
  17826. Constant?: TopicRangeFilterConstant;
  17827. /**
  17828. * An aggregation function that specifies how to calculate the value of a numeric field for a topic, Valid values for this structure are NO_AGGREGATION, SUM, AVERAGE, COUNT, DISTINCT_COUNT, MAX, MEDIAN, MIN, STDEV, STDEVP, VAR, and VARP.
  17829. */
  17830. Aggregation?: NamedFilterAggType;
  17831. }
  17832. export type TopicNumericSeparatorSymbol = "COMMA"|"DOT"|string;
  17833. export interface TopicRangeFilterConstant {
  17834. /**
  17835. * The data type of the constant value that is used in a range filter. Valid values for this structure are RANGE.
  17836. */
  17837. ConstantType?: ConstantType;
  17838. /**
  17839. * The value of the constant that is used to specify the endpoints of a range filter.
  17840. */
  17841. RangeConstant?: RangeConstant;
  17842. }
  17843. export interface TopicRefreshDetails {
  17844. /**
  17845. * The Amazon Resource Name (ARN) of the topic refresh.
  17846. */
  17847. RefreshArn?: Arn;
  17848. /**
  17849. * The ID of the refresh, which occurs as a result of topic creation or topic update.
  17850. */
  17851. RefreshId?: ResourceId;
  17852. /**
  17853. * The status of the refresh job that indicates whether the job is still running, completed successfully, or failed.
  17854. */
  17855. RefreshStatus?: TopicRefreshStatus;
  17856. }
  17857. export interface TopicRefreshSchedule {
  17858. /**
  17859. * A Boolean value that controls whether to schedule is enabled.
  17860. */
  17861. IsEnabled: NullableBoolean;
  17862. /**
  17863. * A Boolean value that controls whether to schedule runs at the same schedule that is specified in SPICE dataset.
  17864. */
  17865. BasedOnSpiceSchedule: Boolean;
  17866. /**
  17867. * The starting date and time for the refresh schedule.
  17868. */
  17869. StartingAt?: Timestamp;
  17870. /**
  17871. * The timezone that you want the refresh schedule to use.
  17872. */
  17873. Timezone?: LimitedString;
  17874. /**
  17875. * The time of day when the refresh should run, for example, Monday-Sunday.
  17876. */
  17877. RepeatAt?: LimitedString;
  17878. /**
  17879. * The type of refresh schedule. Valid values for this structure are HOURLY, DAILY, WEEKLY, and MONTHLY.
  17880. */
  17881. TopicScheduleType?: TopicScheduleType;
  17882. }
  17883. export type TopicRefreshScheduleSummaries = TopicRefreshScheduleSummary[];
  17884. export interface TopicRefreshScheduleSummary {
  17885. /**
  17886. * The ID of the dataset.
  17887. */
  17888. DatasetId?: LimitedString;
  17889. /**
  17890. * The Amazon Resource Name (ARN) of the dataset.
  17891. */
  17892. DatasetArn?: Arn;
  17893. /**
  17894. * The name of the dataset.
  17895. */
  17896. DatasetName?: LimitedString;
  17897. /**
  17898. * The definition of a refresh schedule.
  17899. */
  17900. RefreshSchedule?: TopicRefreshSchedule;
  17901. }
  17902. export type TopicRefreshStatus = "INITIALIZED"|"RUNNING"|"FAILED"|"COMPLETED"|"CANCELLED"|string;
  17903. export interface TopicRelativeDateFilter {
  17904. /**
  17905. * The level of time precision that is used to aggregate DateTime values.
  17906. */
  17907. TimeGranularity?: TopicTimeGranularity;
  17908. /**
  17909. * The function to be used in a relative date filter to determine the range of dates to include in the results. Valid values for this structure are BEFORE, AFTER, and BETWEEN.
  17910. */
  17911. RelativeDateFilterFunction?: TopicRelativeDateFilterFunction;
  17912. /**
  17913. * The constant used in a relative date filter.
  17914. */
  17915. Constant?: TopicSingularFilterConstant;
  17916. }
  17917. export type TopicRelativeDateFilterFunction = "PREVIOUS"|"THIS"|"LAST"|"NEXT"|"NOW"|string;
  17918. export type TopicScheduleType = "HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|string;
  17919. export interface TopicSingularFilterConstant {
  17920. /**
  17921. * The type of the singular filter constant. Valid values for this structure are SINGULAR.
  17922. */
  17923. ConstantType?: ConstantType;
  17924. /**
  17925. * The value of the singular filter constant.
  17926. */
  17927. SingularConstant?: LimitedString;
  17928. }
  17929. export type TopicSummaries = TopicSummary[];
  17930. export interface TopicSummary {
  17931. /**
  17932. * The Amazon Resource Name (ARN) of the topic.
  17933. */
  17934. Arn?: Arn;
  17935. /**
  17936. * The ID for the topic. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  17937. */
  17938. TopicId?: TopicId;
  17939. /**
  17940. * The name of the topic.
  17941. */
  17942. Name?: ResourceName;
  17943. /**
  17944. * The user experience version of the topic.
  17945. */
  17946. UserExperienceVersion?: TopicUserExperienceVersion;
  17947. }
  17948. export type TopicTimeGranularity = "SECOND"|"MINUTE"|"HOUR"|"DAY"|"WEEK"|"MONTH"|"QUARTER"|"YEAR"|string;
  17949. export type TopicUserExperienceVersion = "LEGACY"|"NEW_READER_EXPERIENCE"|string;
  17950. export interface TotalAggregationComputation {
  17951. /**
  17952. * The ID for a computation.
  17953. */
  17954. ComputationId: ShortRestrictiveResourceId;
  17955. /**
  17956. * The name of a computation.
  17957. */
  17958. Name?: String;
  17959. /**
  17960. * The value field that is used in a computation.
  17961. */
  17962. Value?: MeasureField;
  17963. }
  17964. export interface TotalAggregationFunction {
  17965. /**
  17966. * A built in aggregation function for total values.
  17967. */
  17968. SimpleTotalAggregationFunction?: SimpleTotalAggregationFunction;
  17969. }
  17970. export interface TotalAggregationOption {
  17971. /**
  17972. * The field id that's associated with the total aggregation option.
  17973. */
  17974. FieldId: FieldId;
  17975. /**
  17976. * The total aggregation function that you want to set for a specified field id.
  17977. */
  17978. TotalAggregationFunction: TotalAggregationFunction;
  17979. }
  17980. export type TotalAggregationOptionList = TotalAggregationOption[];
  17981. export interface TotalOptions {
  17982. /**
  17983. * The visibility configuration for the total cells.
  17984. */
  17985. TotalsVisibility?: Visibility;
  17986. /**
  17987. * The placement (start, end) for the total cells.
  17988. */
  17989. Placement?: TableTotalsPlacement;
  17990. /**
  17991. * The scroll status (pinned, scrolled) for the total cells.
  17992. */
  17993. ScrollStatus?: TableTotalsScrollStatus;
  17994. /**
  17995. * The custom label string for the total cells.
  17996. */
  17997. CustomLabel?: String;
  17998. /**
  17999. * Cell styling options for the total cells.
  18000. */
  18001. TotalCellStyle?: TableCellStyle;
  18002. /**
  18003. * The total aggregation settings for each value field.
  18004. */
  18005. TotalAggregationOptions?: TotalAggregationOptionList;
  18006. }
  18007. export interface TransformOperation {
  18008. /**
  18009. * An operation that projects columns. Operations that come after a projection can only refer to projected columns.
  18010. */
  18011. ProjectOperation?: ProjectOperation;
  18012. /**
  18013. * An operation that filters rows based on some condition.
  18014. */
  18015. FilterOperation?: FilterOperation;
  18016. /**
  18017. * An operation that creates calculated columns. Columns created in one such operation form a lexical closure.
  18018. */
  18019. CreateColumnsOperation?: CreateColumnsOperation;
  18020. /**
  18021. * An operation that renames a column.
  18022. */
  18023. RenameColumnOperation?: RenameColumnOperation;
  18024. /**
  18025. * A transform operation that casts a column to a different type.
  18026. */
  18027. CastColumnTypeOperation?: CastColumnTypeOperation;
  18028. /**
  18029. * An operation that tags a column with additional information.
  18030. */
  18031. TagColumnOperation?: TagColumnOperation;
  18032. UntagColumnOperation?: UntagColumnOperation;
  18033. OverrideDatasetParameterOperation?: OverrideDatasetParameterOperation;
  18034. }
  18035. export type TransformOperationList = TransformOperation[];
  18036. export interface TreeMapAggregatedFieldWells {
  18037. /**
  18038. * The group by field well of a tree map. Values are grouped based on group by fields.
  18039. */
  18040. Groups?: TreeMapDimensionFieldList;
  18041. /**
  18042. * The size field well of a tree map. Values are aggregated based on group by fields.
  18043. */
  18044. Sizes?: TreeMapMeasureFieldList;
  18045. /**
  18046. * The color field well of a tree map. Values are grouped by aggregations based on group by fields.
  18047. */
  18048. Colors?: TreeMapMeasureFieldList;
  18049. }
  18050. export interface TreeMapConfiguration {
  18051. /**
  18052. * The field wells of the visual.
  18053. */
  18054. FieldWells?: TreeMapFieldWells;
  18055. /**
  18056. * The sort configuration of a tree map.
  18057. */
  18058. SortConfiguration?: TreeMapSortConfiguration;
  18059. /**
  18060. * The label options (label text, label visibility) of the groups that are displayed in a tree map.
  18061. */
  18062. GroupLabelOptions?: ChartAxisLabelOptions;
  18063. /**
  18064. * The label options (label text, label visibility) of the sizes that are displayed in a tree map.
  18065. */
  18066. SizeLabelOptions?: ChartAxisLabelOptions;
  18067. /**
  18068. * The label options (label text, label visibility) for the colors displayed in a tree map.
  18069. */
  18070. ColorLabelOptions?: ChartAxisLabelOptions;
  18071. /**
  18072. * The color options (gradient color, point of divergence) of a tree map.
  18073. */
  18074. ColorScale?: ColorScale;
  18075. /**
  18076. * The legend display setup of the visual.
  18077. */
  18078. Legend?: LegendOptions;
  18079. /**
  18080. * The options that determine if visual data labels are displayed.
  18081. */
  18082. DataLabels?: DataLabelOptions;
  18083. /**
  18084. * The tooltip display setup of the visual.
  18085. */
  18086. Tooltip?: TooltipOptions;
  18087. /**
  18088. * The general visual interactions setup for a visual.
  18089. */
  18090. Interactions?: VisualInteractionOptions;
  18091. }
  18092. export type TreeMapDimensionFieldList = DimensionField[];
  18093. export interface TreeMapFieldWells {
  18094. /**
  18095. * The aggregated field wells of a tree map.
  18096. */
  18097. TreeMapAggregatedFieldWells?: TreeMapAggregatedFieldWells;
  18098. }
  18099. export type TreeMapMeasureFieldList = MeasureField[];
  18100. export interface TreeMapSortConfiguration {
  18101. /**
  18102. * The sort configuration of group by fields.
  18103. */
  18104. TreeMapSort?: FieldSortOptionsList;
  18105. /**
  18106. * The limit on the number of groups that are displayed.
  18107. */
  18108. TreeMapGroupItemsLimitConfiguration?: ItemsLimitConfiguration;
  18109. }
  18110. export interface TreeMapVisual {
  18111. /**
  18112. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
  18113. */
  18114. VisualId: ShortRestrictiveResourceId;
  18115. /**
  18116. * The title that is displayed on the visual.
  18117. */
  18118. Title?: VisualTitleLabelOptions;
  18119. /**
  18120. * The subtitle that is displayed on the visual.
  18121. */
  18122. Subtitle?: VisualSubtitleLabelOptions;
  18123. /**
  18124. * The configuration settings of the visual.
  18125. */
  18126. ChartConfiguration?: TreeMapConfiguration;
  18127. /**
  18128. * The list of custom actions that are configured for a visual.
  18129. */
  18130. Actions?: VisualCustomActionList;
  18131. /**
  18132. * The column hierarchy that is used during drill-downs and drill-ups.
  18133. */
  18134. ColumnHierarchies?: ColumnHierarchyList;
  18135. }
  18136. export interface TrendArrowOptions {
  18137. /**
  18138. * The visibility of the trend arrows.
  18139. */
  18140. Visibility?: Visibility;
  18141. }
  18142. export interface TrinoParameters {
  18143. /**
  18144. * The host name of the Trino data source.
  18145. */
  18146. Host: Host;
  18147. /**
  18148. * The port for the Trino data source.
  18149. */
  18150. Port: Port;
  18151. /**
  18152. * The catalog name for the Trino data source.
  18153. */
  18154. Catalog: Catalog;
  18155. }
  18156. export interface TwitterParameters {
  18157. /**
  18158. * Twitter query string.
  18159. */
  18160. Query: Query;
  18161. /**
  18162. * Maximum number of rows to query Twitter.
  18163. */
  18164. MaxRows: PositiveInteger;
  18165. }
  18166. export type TypeCastFormat = string;
  18167. export type TypeParameters = {[key: string]: LimitedString};
  18168. export interface Typography {
  18169. /**
  18170. * Determines the list of font families.
  18171. */
  18172. FontFamilies?: FontList;
  18173. }
  18174. export interface UIColorPalette {
  18175. /**
  18176. * The color of text and other foreground elements that appear over the primary background regions, such as grid lines, borders, table banding, icons, and so on.
  18177. */
  18178. PrimaryForeground?: HexColor;
  18179. /**
  18180. * The background color that applies to visuals and other high emphasis UI.
  18181. */
  18182. PrimaryBackground?: HexColor;
  18183. /**
  18184. * The foreground color that applies to any sheet title, sheet control text, or UI that appears over the secondary background.
  18185. */
  18186. SecondaryForeground?: HexColor;
  18187. /**
  18188. * The background color that applies to the sheet background and sheet controls.
  18189. */
  18190. SecondaryBackground?: HexColor;
  18191. /**
  18192. * This color is that applies to selected states and buttons.
  18193. */
  18194. Accent?: HexColor;
  18195. /**
  18196. * The foreground color that applies to any text or other elements that appear over the accent color.
  18197. */
  18198. AccentForeground?: HexColor;
  18199. /**
  18200. * The color that applies to error messages.
  18201. */
  18202. Danger?: HexColor;
  18203. /**
  18204. * The foreground color that applies to any text or other elements that appear over the error color.
  18205. */
  18206. DangerForeground?: HexColor;
  18207. /**
  18208. * This color that applies to warning and informational messages.
  18209. */
  18210. Warning?: HexColor;
  18211. /**
  18212. * The foreground color that applies to any text or other elements that appear over the warning color.
  18213. */
  18214. WarningForeground?: HexColor;
  18215. /**
  18216. * The color that applies to success messages, for example the check mark for a successful download.
  18217. */
  18218. Success?: HexColor;
  18219. /**
  18220. * The foreground color that applies to any text or other elements that appear over the success color.
  18221. */
  18222. SuccessForeground?: HexColor;
  18223. /**
  18224. * The color that applies to the names of fields that are identified as dimensions.
  18225. */
  18226. Dimension?: HexColor;
  18227. /**
  18228. * The foreground color that applies to any text or other elements that appear over the dimension color.
  18229. */
  18230. DimensionForeground?: HexColor;
  18231. /**
  18232. * The color that applies to the names of fields that are identified as measures.
  18233. */
  18234. Measure?: HexColor;
  18235. /**
  18236. * The foreground color that applies to any text or other elements that appear over the measure color.
  18237. */
  18238. MeasureForeground?: HexColor;
  18239. }
  18240. export type URLOperationTemplate = string;
  18241. export type URLTargetConfiguration = "NEW_TAB"|"NEW_WINDOW"|"SAME_TAB"|string;
  18242. export interface UnaggregatedField {
  18243. /**
  18244. * The custom field ID.
  18245. */
  18246. FieldId: FieldId;
  18247. /**
  18248. * The column that is used in the UnaggregatedField.
  18249. */
  18250. Column: ColumnIdentifier;
  18251. /**
  18252. * The format configuration of the field.
  18253. */
  18254. FormatConfiguration?: FormatConfiguration;
  18255. }
  18256. export type UnaggregatedFieldList = UnaggregatedField[];
  18257. export type UndefinedSpecifiedValueType = "LEAST"|"MOST"|string;
  18258. export type UnicodeIcon = string;
  18259. export interface UniqueValuesComputation {
  18260. /**
  18261. * The ID for a computation.
  18262. */
  18263. ComputationId: ShortRestrictiveResourceId;
  18264. /**
  18265. * The name of a computation.
  18266. */
  18267. Name?: String;
  18268. /**
  18269. * The category field that is used in a computation.
  18270. */
  18271. Category?: DimensionField;
  18272. }
  18273. export type UnlimitedPixelLength = string;
  18274. export interface UntagColumnOperation {
  18275. /**
  18276. * The column that this operation acts on.
  18277. */
  18278. ColumnName: ColumnName;
  18279. /**
  18280. * The column tags to remove from this column.
  18281. */
  18282. TagNames: ColumnTagNames;
  18283. }
  18284. export interface UntagResourceRequest {
  18285. /**
  18286. * The Amazon Resource Name (ARN) of the resource that you want to untag.
  18287. */
  18288. ResourceArn: Arn;
  18289. /**
  18290. * The keys of the key-value pairs for the resource tag or tags assigned to the resource.
  18291. */
  18292. TagKeys: TagKeyList;
  18293. }
  18294. export interface UntagResourceResponse {
  18295. /**
  18296. * The Amazon Web Services request ID for this operation.
  18297. */
  18298. RequestId?: String;
  18299. /**
  18300. * The HTTP status of the request.
  18301. */
  18302. Status?: StatusCode;
  18303. }
  18304. export interface UpdateAccountCustomizationRequest {
  18305. /**
  18306. * The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.
  18307. */
  18308. AwsAccountId: AwsAccountId;
  18309. /**
  18310. * The namespace that you want to update Amazon QuickSight customizations for.
  18311. */
  18312. Namespace?: Namespace;
  18313. /**
  18314. * The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
  18315. */
  18316. AccountCustomization: AccountCustomization;
  18317. }
  18318. export interface UpdateAccountCustomizationResponse {
  18319. /**
  18320. * The Amazon Resource Name (ARN) for the updated customization for this Amazon Web Services account.
  18321. */
  18322. Arn?: Arn;
  18323. /**
  18324. * The ID for the Amazon Web Services account that you want to update Amazon QuickSight customizations for.
  18325. */
  18326. AwsAccountId?: AwsAccountId;
  18327. /**
  18328. * The namespace associated with the customization that you're updating.
  18329. */
  18330. Namespace?: Namespace;
  18331. /**
  18332. * The Amazon QuickSight customizations you're updating in the current Amazon Web Services Region.
  18333. */
  18334. AccountCustomization?: AccountCustomization;
  18335. /**
  18336. * The Amazon Web Services request ID for this operation.
  18337. */
  18338. RequestId?: String;
  18339. /**
  18340. * The HTTP status of the request.
  18341. */
  18342. Status?: StatusCode;
  18343. }
  18344. export interface UpdateAccountSettingsRequest {
  18345. /**
  18346. * The ID for the Amazon Web Services account that contains the Amazon QuickSight settings that you want to list.
  18347. */
  18348. AwsAccountId: AwsAccountId;
  18349. /**
  18350. * The default namespace for this Amazon Web Services account. Currently, the default is default. IAM users that register for the first time with Amazon QuickSight provide an email address that becomes associated with the default namespace.
  18351. */
  18352. DefaultNamespace: Namespace;
  18353. /**
  18354. * The email address that you want Amazon QuickSight to send notifications to regarding your Amazon Web Services account or Amazon QuickSight subscription.
  18355. */
  18356. NotificationEmail?: String;
  18357. /**
  18358. * A boolean value that determines whether or not an Amazon QuickSight account can be deleted. A True value doesn't allow the account to be deleted and results in an error message if a user tries to make a DeleteAccountSubscription request. A False value will allow the account to be deleted.
  18359. */
  18360. TerminationProtectionEnabled?: Boolean;
  18361. }
  18362. export interface UpdateAccountSettingsResponse {
  18363. /**
  18364. * The Amazon Web Services request ID for this operation.
  18365. */
  18366. RequestId?: String;
  18367. /**
  18368. * The HTTP status of the request.
  18369. */
  18370. Status?: StatusCode;
  18371. }
  18372. export interface UpdateAnalysisPermissionsRequest {
  18373. /**
  18374. * The ID of the Amazon Web Services account that contains the analysis whose permissions you're updating. You must be using the Amazon Web Services account that the analysis is in.
  18375. */
  18376. AwsAccountId: AwsAccountId;
  18377. /**
  18378. * The ID of the analysis whose permissions you're updating. The ID is part of the analysis URL.
  18379. */
  18380. AnalysisId: ShortRestrictiveResourceId;
  18381. /**
  18382. * A structure that describes the permissions to add and the principal to add them to.
  18383. */
  18384. GrantPermissions?: UpdateResourcePermissionList;
  18385. /**
  18386. * A structure that describes the permissions to remove and the principal to remove them from.
  18387. */
  18388. RevokePermissions?: UpdateResourcePermissionList;
  18389. }
  18390. export interface UpdateAnalysisPermissionsResponse {
  18391. /**
  18392. * The Amazon Resource Name (ARN) of the analysis that you updated.
  18393. */
  18394. AnalysisArn?: Arn;
  18395. /**
  18396. * The ID of the analysis that you updated permissions for.
  18397. */
  18398. AnalysisId?: ShortRestrictiveResourceId;
  18399. /**
  18400. * A structure that describes the principals and the resource-level permissions on an analysis.
  18401. */
  18402. Permissions?: ResourcePermissionList;
  18403. /**
  18404. * The Amazon Web Services request ID for this operation.
  18405. */
  18406. RequestId?: String;
  18407. /**
  18408. * The HTTP status of the request.
  18409. */
  18410. Status?: StatusCode;
  18411. }
  18412. export interface UpdateAnalysisRequest {
  18413. /**
  18414. * The ID of the Amazon Web Services account that contains the analysis that you're updating.
  18415. */
  18416. AwsAccountId: AwsAccountId;
  18417. /**
  18418. * The ID for the analysis that you're updating. This ID displays in the URL of the analysis.
  18419. */
  18420. AnalysisId: ShortRestrictiveResourceId;
  18421. /**
  18422. * A descriptive name for the analysis that you're updating. This name displays for the analysis in the Amazon QuickSight console.
  18423. */
  18424. Name: AnalysisName;
  18425. /**
  18426. * The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
  18427. */
  18428. Parameters?: Parameters;
  18429. /**
  18430. * A source entity to use for the analysis that you're updating. This metadata structure contains details that describe a source template and one or more datasets.
  18431. */
  18432. SourceEntity?: AnalysisSourceEntity;
  18433. /**
  18434. * The Amazon Resource Name (ARN) for the theme to apply to the analysis that you're creating. To see the theme in the Amazon QuickSight console, make sure that you have access to it.
  18435. */
  18436. ThemeArn?: Arn;
  18437. /**
  18438. * The definition of an analysis. A definition is the data model of all features in a Dashboard, Template, or Analysis.
  18439. */
  18440. Definition?: AnalysisDefinition;
  18441. /**
  18442. * The option to relax the validation needed to update an analysis with definition objects. This skips the validation step for specific errors.
  18443. */
  18444. ValidationStrategy?: ValidationStrategy;
  18445. }
  18446. export interface UpdateAnalysisResponse {
  18447. /**
  18448. * The ARN of the analysis that you're updating.
  18449. */
  18450. Arn?: Arn;
  18451. /**
  18452. * The ID of the analysis.
  18453. */
  18454. AnalysisId?: ShortRestrictiveResourceId;
  18455. /**
  18456. * The update status of the last update that was made to the analysis.
  18457. */
  18458. UpdateStatus?: ResourceStatus;
  18459. /**
  18460. * The HTTP status of the request.
  18461. */
  18462. Status?: StatusCode;
  18463. /**
  18464. * The Amazon Web Services request ID for this operation.
  18465. */
  18466. RequestId?: String;
  18467. }
  18468. export interface UpdateDashboardLinksRequest {
  18469. /**
  18470. * The ID of the Amazon Web Services account that contains the dashboard whose links you want to update.
  18471. */
  18472. AwsAccountId: AwsAccountId;
  18473. /**
  18474. * The ID for the dashboard.
  18475. */
  18476. DashboardId: ShortRestrictiveResourceId;
  18477. /**
  18478. * list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
  18479. */
  18480. LinkEntities: LinkEntityArnList;
  18481. }
  18482. export interface UpdateDashboardLinksResponse {
  18483. /**
  18484. * The Amazon Web Services request ID for this operation.
  18485. */
  18486. RequestId?: String;
  18487. /**
  18488. * The HTTP status of the request.
  18489. */
  18490. Status?: StatusCode;
  18491. /**
  18492. * The Amazon Resource Name (ARN) of the dashboard.
  18493. */
  18494. DashboardArn?: Arn;
  18495. /**
  18496. * A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
  18497. */
  18498. LinkEntities?: LinkEntityArnList;
  18499. }
  18500. export interface UpdateDashboardPermissionsRequest {
  18501. /**
  18502. * The ID of the Amazon Web Services account that contains the dashboard whose permissions you're updating.
  18503. */
  18504. AwsAccountId: AwsAccountId;
  18505. /**
  18506. * The ID for the dashboard.
  18507. */
  18508. DashboardId: ShortRestrictiveResourceId;
  18509. /**
  18510. * The permissions that you want to grant on this resource.
  18511. */
  18512. GrantPermissions?: UpdateResourcePermissionList;
  18513. /**
  18514. * The permissions that you want to revoke from this resource.
  18515. */
  18516. RevokePermissions?: UpdateResourcePermissionList;
  18517. /**
  18518. * Grants link permissions to all users in a defined namespace.
  18519. */
  18520. GrantLinkPermissions?: UpdateLinkPermissionList;
  18521. /**
  18522. * Revokes link permissions from all users in a defined namespace.
  18523. */
  18524. RevokeLinkPermissions?: UpdateLinkPermissionList;
  18525. }
  18526. export interface UpdateDashboardPermissionsResponse {
  18527. /**
  18528. * The Amazon Resource Name (ARN) of the dashboard.
  18529. */
  18530. DashboardArn?: Arn;
  18531. /**
  18532. * The ID for the dashboard.
  18533. */
  18534. DashboardId?: ShortRestrictiveResourceId;
  18535. /**
  18536. * Information about the permissions on the dashboard.
  18537. */
  18538. Permissions?: ResourcePermissionList;
  18539. /**
  18540. * The Amazon Web Services request ID for this operation.
  18541. */
  18542. RequestId?: String;
  18543. /**
  18544. * The HTTP status of the request.
  18545. */
  18546. Status?: StatusCode;
  18547. /**
  18548. * Updates the permissions of a shared link to an Amazon QuickSight dashboard.
  18549. */
  18550. LinkSharingConfiguration?: LinkSharingConfiguration;
  18551. }
  18552. export interface UpdateDashboardPublishedVersionRequest {
  18553. /**
  18554. * The ID of the Amazon Web Services account that contains the dashboard that you're updating.
  18555. */
  18556. AwsAccountId: AwsAccountId;
  18557. /**
  18558. * The ID for the dashboard.
  18559. */
  18560. DashboardId: ShortRestrictiveResourceId;
  18561. /**
  18562. * The version number of the dashboard.
  18563. */
  18564. VersionNumber: VersionNumber;
  18565. }
  18566. export interface UpdateDashboardPublishedVersionResponse {
  18567. /**
  18568. * The ID for the dashboard.
  18569. */
  18570. DashboardId?: ShortRestrictiveResourceId;
  18571. /**
  18572. * The Amazon Resource Name (ARN) of the dashboard.
  18573. */
  18574. DashboardArn?: Arn;
  18575. /**
  18576. * The HTTP status of the request.
  18577. */
  18578. Status?: StatusCode;
  18579. /**
  18580. * The Amazon Web Services request ID for this operation.
  18581. */
  18582. RequestId?: String;
  18583. }
  18584. export interface UpdateDashboardRequest {
  18585. /**
  18586. * The ID of the Amazon Web Services account that contains the dashboard that you're updating.
  18587. */
  18588. AwsAccountId: AwsAccountId;
  18589. /**
  18590. * The ID for the dashboard.
  18591. */
  18592. DashboardId: ShortRestrictiveResourceId;
  18593. /**
  18594. * The display name of the dashboard.
  18595. */
  18596. Name: DashboardName;
  18597. /**
  18598. * The entity that you are using as a source when you update the dashboard. In SourceEntity, you specify the type of object you're using as source. You can only update a dashboard from a template, so you use a SourceTemplate entity. If you need to update a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region. Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
  18599. */
  18600. SourceEntity?: DashboardSourceEntity;
  18601. /**
  18602. * A structure that contains the parameters of the dashboard. These are parameter overrides for a dashboard. A dashboard can have any type of parameters, and some parameters might accept multiple values.
  18603. */
  18604. Parameters?: Parameters;
  18605. /**
  18606. * A description for the first version of the dashboard being created.
  18607. */
  18608. VersionDescription?: VersionDescription;
  18609. /**
  18610. * Options for publishing the dashboard when you create it: AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default. AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default. VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.
  18611. */
  18612. DashboardPublishOptions?: DashboardPublishOptions;
  18613. /**
  18614. * The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that was originally associated with the entity. The theme ARN must exist in the same Amazon Web Services account where you create the dashboard.
  18615. */
  18616. ThemeArn?: Arn;
  18617. /**
  18618. * The definition of a dashboard. A definition is the data model of all features in a Dashboard, Template, or Analysis.
  18619. */
  18620. Definition?: DashboardVersionDefinition;
  18621. /**
  18622. * The option to relax the validation needed to update a dashboard with definition objects. This skips the validation step for specific errors.
  18623. */
  18624. ValidationStrategy?: ValidationStrategy;
  18625. }
  18626. export interface UpdateDashboardResponse {
  18627. /**
  18628. * The Amazon Resource Name (ARN) of the resource.
  18629. */
  18630. Arn?: Arn;
  18631. /**
  18632. * The ARN of the dashboard, including the version number.
  18633. */
  18634. VersionArn?: Arn;
  18635. /**
  18636. * The ID for the dashboard.
  18637. */
  18638. DashboardId?: ShortRestrictiveResourceId;
  18639. /**
  18640. * The creation status of the request.
  18641. */
  18642. CreationStatus?: ResourceStatus;
  18643. /**
  18644. * The HTTP status of the request.
  18645. */
  18646. Status?: StatusCode;
  18647. /**
  18648. * The Amazon Web Services request ID for this operation.
  18649. */
  18650. RequestId?: String;
  18651. }
  18652. export interface UpdateDataSetPermissionsRequest {
  18653. /**
  18654. * The Amazon Web Services account ID.
  18655. */
  18656. AwsAccountId: AwsAccountId;
  18657. /**
  18658. * The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  18659. */
  18660. DataSetId: ResourceId;
  18661. /**
  18662. * The resource permissions that you want to grant to the dataset.
  18663. */
  18664. GrantPermissions?: ResourcePermissionList;
  18665. /**
  18666. * The resource permissions that you want to revoke from the dataset.
  18667. */
  18668. RevokePermissions?: ResourcePermissionList;
  18669. }
  18670. export interface UpdateDataSetPermissionsResponse {
  18671. /**
  18672. * The Amazon Resource Name (ARN) of the dataset.
  18673. */
  18674. DataSetArn?: Arn;
  18675. /**
  18676. * The ID for the dataset whose permissions you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  18677. */
  18678. DataSetId?: ResourceId;
  18679. /**
  18680. * The Amazon Web Services request ID for this operation.
  18681. */
  18682. RequestId?: String;
  18683. /**
  18684. * The HTTP status of the request.
  18685. */
  18686. Status?: StatusCode;
  18687. }
  18688. export interface UpdateDataSetRequest {
  18689. /**
  18690. * The Amazon Web Services account ID.
  18691. */
  18692. AwsAccountId: AwsAccountId;
  18693. /**
  18694. * The ID for the dataset that you want to update. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  18695. */
  18696. DataSetId: ResourceId;
  18697. /**
  18698. * The display name for the dataset.
  18699. */
  18700. Name: ResourceName;
  18701. /**
  18702. * Declares the physical tables that are available in the underlying data sources.
  18703. */
  18704. PhysicalTableMap: PhysicalTableMap;
  18705. /**
  18706. * Configures the combination and transformation of the data from the physical tables.
  18707. */
  18708. LogicalTableMap?: LogicalTableMap;
  18709. /**
  18710. * Indicates whether you want to import the data into SPICE.
  18711. */
  18712. ImportMode: DataSetImportMode;
  18713. /**
  18714. * Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
  18715. */
  18716. ColumnGroups?: ColumnGroupList;
  18717. /**
  18718. * The folder that contains fields and nested subfolders for your dataset.
  18719. */
  18720. FieldFolders?: FieldFolderMap;
  18721. /**
  18722. * The row-level security configuration for the data you want to create.
  18723. */
  18724. RowLevelPermissionDataSet?: RowLevelPermissionDataSet;
  18725. /**
  18726. * The configuration of tags on a dataset to set row-level security. Row-level security tags are currently supported for anonymous embedding only.
  18727. */
  18728. RowLevelPermissionTagConfiguration?: RowLevelPermissionTagConfiguration;
  18729. /**
  18730. * A set of one or more definitions of a ColumnLevelPermissionRule .
  18731. */
  18732. ColumnLevelPermissionRules?: ColumnLevelPermissionRuleList;
  18733. DataSetUsageConfiguration?: DataSetUsageConfiguration;
  18734. /**
  18735. * The parameter declarations of the dataset.
  18736. */
  18737. DatasetParameters?: DatasetParameterList;
  18738. }
  18739. export interface UpdateDataSetResponse {
  18740. /**
  18741. * The Amazon Resource Name (ARN) of the dataset.
  18742. */
  18743. Arn?: Arn;
  18744. /**
  18745. * The ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  18746. */
  18747. DataSetId?: ResourceId;
  18748. /**
  18749. * The ARN for the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
  18750. */
  18751. IngestionArn?: Arn;
  18752. /**
  18753. * The ID of the ingestion, which is triggered as a result of dataset creation if the import mode is SPICE.
  18754. */
  18755. IngestionId?: ResourceId;
  18756. /**
  18757. * The Amazon Web Services request ID for this operation.
  18758. */
  18759. RequestId?: String;
  18760. /**
  18761. * The HTTP status of the request.
  18762. */
  18763. Status?: StatusCode;
  18764. }
  18765. export interface UpdateDataSourcePermissionsRequest {
  18766. /**
  18767. * The Amazon Web Services account ID.
  18768. */
  18769. AwsAccountId: AwsAccountId;
  18770. /**
  18771. * The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  18772. */
  18773. DataSourceId: ResourceId;
  18774. /**
  18775. * A list of resource permissions that you want to grant on the data source.
  18776. */
  18777. GrantPermissions?: ResourcePermissionList;
  18778. /**
  18779. * A list of resource permissions that you want to revoke on the data source.
  18780. */
  18781. RevokePermissions?: ResourcePermissionList;
  18782. }
  18783. export interface UpdateDataSourcePermissionsResponse {
  18784. /**
  18785. * The Amazon Resource Name (ARN) of the data source.
  18786. */
  18787. DataSourceArn?: Arn;
  18788. /**
  18789. * The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  18790. */
  18791. DataSourceId?: ResourceId;
  18792. /**
  18793. * The Amazon Web Services request ID for this operation.
  18794. */
  18795. RequestId?: String;
  18796. /**
  18797. * The HTTP status of the request.
  18798. */
  18799. Status?: StatusCode;
  18800. }
  18801. export interface UpdateDataSourceRequest {
  18802. /**
  18803. * The Amazon Web Services account ID.
  18804. */
  18805. AwsAccountId: AwsAccountId;
  18806. /**
  18807. * The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  18808. */
  18809. DataSourceId: ResourceId;
  18810. /**
  18811. * A display name for the data source.
  18812. */
  18813. Name: ResourceName;
  18814. /**
  18815. * The parameters that Amazon QuickSight uses to connect to your underlying source.
  18816. */
  18817. DataSourceParameters?: DataSourceParameters;
  18818. /**
  18819. * The credentials that Amazon QuickSight that uses to connect to your underlying source. Currently, only credentials based on user name and password are supported.
  18820. */
  18821. Credentials?: DataSourceCredentials;
  18822. /**
  18823. * Use this parameter only when you want Amazon QuickSight to use a VPC connection when connecting to your underlying source.
  18824. */
  18825. VpcConnectionProperties?: VpcConnectionProperties;
  18826. /**
  18827. * Secure Socket Layer (SSL) properties that apply when Amazon QuickSight connects to your underlying source.
  18828. */
  18829. SslProperties?: SslProperties;
  18830. }
  18831. export interface UpdateDataSourceResponse {
  18832. /**
  18833. * The Amazon Resource Name (ARN) of the data source.
  18834. */
  18835. Arn?: Arn;
  18836. /**
  18837. * The ID of the data source. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  18838. */
  18839. DataSourceId?: ResourceId;
  18840. /**
  18841. * The update status of the data source's last update.
  18842. */
  18843. UpdateStatus?: ResourceStatus;
  18844. /**
  18845. * The Amazon Web Services request ID for this operation.
  18846. */
  18847. RequestId?: String;
  18848. /**
  18849. * The HTTP status of the request.
  18850. */
  18851. Status?: StatusCode;
  18852. }
  18853. export interface UpdateFolderPermissionsRequest {
  18854. /**
  18855. * The ID for the Amazon Web Services account that contains the folder to update.
  18856. */
  18857. AwsAccountId: AwsAccountId;
  18858. /**
  18859. * The ID of the folder.
  18860. */
  18861. FolderId: RestrictiveResourceId;
  18862. /**
  18863. * The permissions that you want to grant on a resource. Namespace ARNs are not supported Principal values for folder permissions.
  18864. */
  18865. GrantPermissions?: ResourcePermissionList;
  18866. /**
  18867. * The permissions that you want to revoke from a resource. Namespace ARNs are not supported Principal values for folder permissions.
  18868. */
  18869. RevokePermissions?: ResourcePermissionList;
  18870. }
  18871. export interface UpdateFolderPermissionsResponse {
  18872. /**
  18873. * The HTTP status of the request.
  18874. */
  18875. Status?: StatusCode;
  18876. /**
  18877. * The Amazon Resource Name (ARN) of the folder.
  18878. */
  18879. Arn?: Arn;
  18880. /**
  18881. * The ID of the folder.
  18882. */
  18883. FolderId?: RestrictiveResourceId;
  18884. /**
  18885. * Information about the permissions for the folder.
  18886. */
  18887. Permissions?: ResourcePermissionList;
  18888. /**
  18889. * The Amazon Web Services request ID for this operation.
  18890. */
  18891. RequestId?: String;
  18892. }
  18893. export interface UpdateFolderRequest {
  18894. /**
  18895. * The ID for the Amazon Web Services account that contains the folder to update.
  18896. */
  18897. AwsAccountId: AwsAccountId;
  18898. /**
  18899. * The ID of the folder.
  18900. */
  18901. FolderId: RestrictiveResourceId;
  18902. /**
  18903. * The name of the folder.
  18904. */
  18905. Name: FolderName;
  18906. }
  18907. export interface UpdateFolderResponse {
  18908. /**
  18909. * The HTTP status of the request.
  18910. */
  18911. Status?: StatusCode;
  18912. /**
  18913. * The Amazon Resource Name (ARN) of the folder.
  18914. */
  18915. Arn?: Arn;
  18916. /**
  18917. * The ID of the folder.
  18918. */
  18919. FolderId?: RestrictiveResourceId;
  18920. /**
  18921. * The Amazon Web Services request ID for this operation.
  18922. */
  18923. RequestId?: String;
  18924. }
  18925. export interface UpdateGroupRequest {
  18926. /**
  18927. * The name of the group that you want to update.
  18928. */
  18929. GroupName: GroupName;
  18930. /**
  18931. * The description for the group that you want to update.
  18932. */
  18933. Description?: GroupDescription;
  18934. /**
  18935. * The ID for the Amazon Web Services account that the group is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  18936. */
  18937. AwsAccountId: AwsAccountId;
  18938. /**
  18939. * The namespace of the group that you want to update.
  18940. */
  18941. Namespace: Namespace;
  18942. }
  18943. export interface UpdateGroupResponse {
  18944. /**
  18945. * The name of the group.
  18946. */
  18947. Group?: Group;
  18948. /**
  18949. * The Amazon Web Services request ID for this operation.
  18950. */
  18951. RequestId?: String;
  18952. /**
  18953. * The HTTP status of the request.
  18954. */
  18955. Status?: StatusCode;
  18956. }
  18957. export interface UpdateIAMPolicyAssignmentRequest {
  18958. /**
  18959. * The ID of the Amazon Web Services account that contains the IAM policy assignment.
  18960. */
  18961. AwsAccountId: AwsAccountId;
  18962. /**
  18963. * The name of the assignment, also called a rule. The name must be unique within the Amazon Web Services account.
  18964. */
  18965. AssignmentName: IAMPolicyAssignmentName;
  18966. /**
  18967. * The namespace of the assignment.
  18968. */
  18969. Namespace: Namespace;
  18970. /**
  18971. * The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
  18972. */
  18973. AssignmentStatus?: AssignmentStatus;
  18974. /**
  18975. * The ARN for the IAM policy to apply to the Amazon QuickSight users and groups specified in this assignment.
  18976. */
  18977. PolicyArn?: Arn;
  18978. /**
  18979. * The Amazon QuickSight users, groups, or both that you want to assign the policy to.
  18980. */
  18981. Identities?: IdentityMap;
  18982. }
  18983. export interface UpdateIAMPolicyAssignmentResponse {
  18984. /**
  18985. * The name of the assignment or rule.
  18986. */
  18987. AssignmentName?: IAMPolicyAssignmentName;
  18988. /**
  18989. * The ID of the assignment.
  18990. */
  18991. AssignmentId?: String;
  18992. /**
  18993. * The ARN for the IAM policy applied to the Amazon QuickSight users and groups specified in this assignment.
  18994. */
  18995. PolicyArn?: Arn;
  18996. /**
  18997. * The Amazon QuickSight users, groups, or both that the IAM policy is assigned to.
  18998. */
  18999. Identities?: IdentityMap;
  19000. /**
  19001. * The status of the assignment. Possible values are as follows: ENABLED - Anything specified in this assignment is used when creating the data source. DISABLED - This assignment isn't used when creating the data source. DRAFT - This assignment is an unfinished draft and isn't used when creating the data source.
  19002. */
  19003. AssignmentStatus?: AssignmentStatus;
  19004. /**
  19005. * The Amazon Web Services request ID for this operation.
  19006. */
  19007. RequestId?: String;
  19008. /**
  19009. * The HTTP status of the request.
  19010. */
  19011. Status?: StatusCode;
  19012. }
  19013. export interface UpdateIdentityPropagationConfigRequest {
  19014. /**
  19015. * The ID of the Amazon Web Services account that contains the identity propagation configuration that you want to update.
  19016. */
  19017. AwsAccountId: AwsAccountId;
  19018. /**
  19019. * The name of the Amazon Web Services service that contains the authorized targets that you want to add or update.
  19020. */
  19021. Service: ServiceType;
  19022. /**
  19023. * Specifies a list of application ARNs that represent the authorized targets for a service.
  19024. */
  19025. AuthorizedTargets?: AuthorizedTargetsList;
  19026. }
  19027. export interface UpdateIdentityPropagationConfigResponse {
  19028. /**
  19029. * The Amazon Web Services request ID for this operation.
  19030. */
  19031. RequestId?: String;
  19032. /**
  19033. * The HTTP status of the request.
  19034. */
  19035. Status?: StatusCode;
  19036. }
  19037. export interface UpdateIpRestrictionRequest {
  19038. /**
  19039. * The ID of the Amazon Web Services account that contains the IP rules.
  19040. */
  19041. AwsAccountId: AwsAccountId;
  19042. /**
  19043. * A map that describes the updated IP rules with CIDR ranges and descriptions.
  19044. */
  19045. IpRestrictionRuleMap?: IpRestrictionRuleMap;
  19046. /**
  19047. * A map of VPC IDs and their corresponding rules. When you configure this parameter, traffic from all VPC endpoints that are present in the specified VPC is allowed.
  19048. */
  19049. VpcIdRestrictionRuleMap?: VpcIdRestrictionRuleMap;
  19050. /**
  19051. * A map of allowed VPC endpoint IDs and their corresponding rule descriptions.
  19052. */
  19053. VpcEndpointIdRestrictionRuleMap?: VpcEndpointIdRestrictionRuleMap;
  19054. /**
  19055. * A value that specifies whether IP rules are turned on.
  19056. */
  19057. Enabled?: NullableBoolean;
  19058. }
  19059. export interface UpdateIpRestrictionResponse {
  19060. /**
  19061. * The ID of the Amazon Web Services account that contains the IP rules.
  19062. */
  19063. AwsAccountId?: AwsAccountId;
  19064. /**
  19065. * The Amazon Web Services request ID for this operation.
  19066. */
  19067. RequestId?: String;
  19068. /**
  19069. * The HTTP status of the request.
  19070. */
  19071. Status?: StatusCode;
  19072. }
  19073. export type UpdateLinkPermissionList = ResourcePermission[];
  19074. export interface UpdatePublicSharingSettingsRequest {
  19075. /**
  19076. * The Amazon Web Services account ID associated with your Amazon QuickSight subscription.
  19077. */
  19078. AwsAccountId: AwsAccountId;
  19079. /**
  19080. * A Boolean value that indicates whether public sharing is turned on for an Amazon QuickSight account.
  19081. */
  19082. PublicSharingEnabled?: Boolean;
  19083. }
  19084. export interface UpdatePublicSharingSettingsResponse {
  19085. /**
  19086. * The Amazon Web Services request ID for this operation.
  19087. */
  19088. RequestId?: String;
  19089. /**
  19090. * The HTTP status of the request.
  19091. */
  19092. Status?: StatusCode;
  19093. }
  19094. export interface UpdateRefreshScheduleRequest {
  19095. /**
  19096. * The ID of the dataset.
  19097. */
  19098. DataSetId: ResourceId;
  19099. /**
  19100. * The Amazon Web Services account ID.
  19101. */
  19102. AwsAccountId: AwsAccountId;
  19103. /**
  19104. * The refresh schedule.
  19105. */
  19106. Schedule: RefreshSchedule;
  19107. }
  19108. export interface UpdateRefreshScheduleResponse {
  19109. /**
  19110. * The HTTP status of the request.
  19111. */
  19112. Status?: StatusCode;
  19113. /**
  19114. * The Amazon Web Services request ID for this operation.
  19115. */
  19116. RequestId?: String;
  19117. /**
  19118. * The ID of the refresh schedule.
  19119. */
  19120. ScheduleId?: String;
  19121. /**
  19122. * The Amazon Resource Name (ARN) for the refresh schedule.
  19123. */
  19124. Arn?: Arn;
  19125. }
  19126. export type UpdateResourcePermissionList = ResourcePermission[];
  19127. export interface UpdateRoleCustomPermissionRequest {
  19128. /**
  19129. * The name of the custom permission that you want to update the role with.
  19130. */
  19131. CustomPermissionsName: RoleName;
  19132. /**
  19133. * The name of role tht you want to update.
  19134. */
  19135. Role: Role;
  19136. /**
  19137. * The ID for the Amazon Web Services account that you want to create a group in. The Amazon Web Services account ID that you provide must be the same Amazon Web Services account that contains your Amazon QuickSight account.
  19138. */
  19139. AwsAccountId: AwsAccountId;
  19140. /**
  19141. * The namespace that contains the role that you want to update.
  19142. */
  19143. Namespace: Namespace;
  19144. }
  19145. export interface UpdateRoleCustomPermissionResponse {
  19146. /**
  19147. * The Amazon Web Services request ID for this operation.
  19148. */
  19149. RequestId?: String;
  19150. /**
  19151. * The HTTP status of the request.
  19152. */
  19153. Status?: StatusCode;
  19154. }
  19155. export interface UpdateSPICECapacityConfigurationRequest {
  19156. /**
  19157. * The ID of the Amazon Web Services account that contains the SPICE configuration that you want to update.
  19158. */
  19159. AwsAccountId: AwsAccountId;
  19160. /**
  19161. * Determines how SPICE capacity can be purchased. The following options are available. MANUAL: SPICE capacity can only be purchased manually. AUTO_PURCHASE: Extra SPICE capacity is automatically purchased on your behalf as needed. SPICE capacity can also be purchased manually with this option.
  19162. */
  19163. PurchaseMode: PurchaseMode;
  19164. }
  19165. export interface UpdateSPICECapacityConfigurationResponse {
  19166. /**
  19167. * The Amazon Web Services request ID for this operation.
  19168. */
  19169. RequestId?: String;
  19170. /**
  19171. * The HTTP status of the request.
  19172. */
  19173. Status?: StatusCode;
  19174. }
  19175. export interface UpdateTemplateAliasRequest {
  19176. /**
  19177. * The ID of the Amazon Web Services account that contains the template alias that you're updating.
  19178. */
  19179. AwsAccountId: AwsAccountId;
  19180. /**
  19181. * The ID for the template.
  19182. */
  19183. TemplateId: ShortRestrictiveResourceId;
  19184. /**
  19185. * The alias of the template that you want to update. If you name a specific alias, you update the version that the alias points to. You can specify the latest version of the template by providing the keyword $LATEST in the AliasName parameter. The keyword $PUBLISHED doesn't apply to templates.
  19186. */
  19187. AliasName: AliasName;
  19188. /**
  19189. * The version number of the template.
  19190. */
  19191. TemplateVersionNumber: VersionNumber;
  19192. }
  19193. export interface UpdateTemplateAliasResponse {
  19194. /**
  19195. * The template alias.
  19196. */
  19197. TemplateAlias?: TemplateAlias;
  19198. /**
  19199. * The HTTP status of the request.
  19200. */
  19201. Status?: StatusCode;
  19202. /**
  19203. * The Amazon Web Services request ID for this operation.
  19204. */
  19205. RequestId?: String;
  19206. }
  19207. export interface UpdateTemplatePermissionsRequest {
  19208. /**
  19209. * The ID of the Amazon Web Services account that contains the template.
  19210. */
  19211. AwsAccountId: AwsAccountId;
  19212. /**
  19213. * The ID for the template.
  19214. */
  19215. TemplateId: ShortRestrictiveResourceId;
  19216. /**
  19217. * A list of resource permissions to be granted on the template.
  19218. */
  19219. GrantPermissions?: UpdateResourcePermissionList;
  19220. /**
  19221. * A list of resource permissions to be revoked from the template.
  19222. */
  19223. RevokePermissions?: UpdateResourcePermissionList;
  19224. }
  19225. export interface UpdateTemplatePermissionsResponse {
  19226. /**
  19227. * The ID for the template.
  19228. */
  19229. TemplateId?: ShortRestrictiveResourceId;
  19230. /**
  19231. * The Amazon Resource Name (ARN) of the template.
  19232. */
  19233. TemplateArn?: Arn;
  19234. /**
  19235. * A list of resource permissions to be set on the template.
  19236. */
  19237. Permissions?: ResourcePermissionList;
  19238. /**
  19239. * The Amazon Web Services request ID for this operation.
  19240. */
  19241. RequestId?: String;
  19242. /**
  19243. * The HTTP status of the request.
  19244. */
  19245. Status?: StatusCode;
  19246. }
  19247. export interface UpdateTemplateRequest {
  19248. /**
  19249. * The ID of the Amazon Web Services account that contains the template that you're updating.
  19250. */
  19251. AwsAccountId: AwsAccountId;
  19252. /**
  19253. * The ID for the template.
  19254. */
  19255. TemplateId: ShortRestrictiveResourceId;
  19256. /**
  19257. * The entity that you are using as a source when you update the template. In SourceEntity, you specify the type of object you're using as source: SourceTemplate for a template or SourceAnalysis for an analysis. Both of these require an Amazon Resource Name (ARN). For SourceTemplate, specify the ARN of the source template. For SourceAnalysis, specify the ARN of the source analysis. The SourceTemplate ARN can contain any Amazon Web Services account and any Amazon QuickSight-supported Amazon Web Services Region;. Use the DataSetReferences entity within SourceTemplate or SourceAnalysis to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
  19258. */
  19259. SourceEntity?: TemplateSourceEntity;
  19260. /**
  19261. * A description of the current template version that is being updated. Every time you call UpdateTemplate, you create a new version of the template. Each version of the template maintains a description of the version in the VersionDescription field.
  19262. */
  19263. VersionDescription?: VersionDescription;
  19264. /**
  19265. * The name for the template.
  19266. */
  19267. Name?: TemplateName;
  19268. /**
  19269. * The definition of a template. A definition is the data model of all features in a Dashboard, Template, or Analysis.
  19270. */
  19271. Definition?: TemplateVersionDefinition;
  19272. /**
  19273. * The option to relax the validation needed to update a template with definition objects. This skips the validation step for specific errors.
  19274. */
  19275. ValidationStrategy?: ValidationStrategy;
  19276. }
  19277. export interface UpdateTemplateResponse {
  19278. /**
  19279. * The ID for the template.
  19280. */
  19281. TemplateId?: ShortRestrictiveResourceId;
  19282. /**
  19283. * The Amazon Resource Name (ARN) for the template.
  19284. */
  19285. Arn?: Arn;
  19286. /**
  19287. * The ARN for the template, including the version information of the first version.
  19288. */
  19289. VersionArn?: Arn;
  19290. /**
  19291. * The creation status of the template.
  19292. */
  19293. CreationStatus?: ResourceStatus;
  19294. /**
  19295. * The HTTP status of the request.
  19296. */
  19297. Status?: StatusCode;
  19298. /**
  19299. * The Amazon Web Services request ID for this operation.
  19300. */
  19301. RequestId?: String;
  19302. }
  19303. export interface UpdateThemeAliasRequest {
  19304. /**
  19305. * The ID of the Amazon Web Services account that contains the theme alias that you're updating.
  19306. */
  19307. AwsAccountId: AwsAccountId;
  19308. /**
  19309. * The ID for the theme.
  19310. */
  19311. ThemeId: ShortRestrictiveResourceId;
  19312. /**
  19313. * The name of the theme alias that you want to update.
  19314. */
  19315. AliasName: AliasName;
  19316. /**
  19317. * The version number of the theme that the alias should reference.
  19318. */
  19319. ThemeVersionNumber: VersionNumber;
  19320. }
  19321. export interface UpdateThemeAliasResponse {
  19322. /**
  19323. * Information about the theme alias.
  19324. */
  19325. ThemeAlias?: ThemeAlias;
  19326. /**
  19327. * The HTTP status of the request.
  19328. */
  19329. Status?: StatusCode;
  19330. /**
  19331. * The Amazon Web Services request ID for this operation.
  19332. */
  19333. RequestId?: String;
  19334. }
  19335. export interface UpdateThemePermissionsRequest {
  19336. /**
  19337. * The ID of the Amazon Web Services account that contains the theme.
  19338. */
  19339. AwsAccountId: AwsAccountId;
  19340. /**
  19341. * The ID for the theme.
  19342. */
  19343. ThemeId: ShortRestrictiveResourceId;
  19344. /**
  19345. * A list of resource permissions to be granted for the theme.
  19346. */
  19347. GrantPermissions?: UpdateResourcePermissionList;
  19348. /**
  19349. * A list of resource permissions to be revoked from the theme.
  19350. */
  19351. RevokePermissions?: UpdateResourcePermissionList;
  19352. }
  19353. export interface UpdateThemePermissionsResponse {
  19354. /**
  19355. * The ID for the theme.
  19356. */
  19357. ThemeId?: ShortRestrictiveResourceId;
  19358. /**
  19359. * The Amazon Resource Name (ARN) of the theme.
  19360. */
  19361. ThemeArn?: Arn;
  19362. /**
  19363. * The resulting list of resource permissions for the theme.
  19364. */
  19365. Permissions?: ResourcePermissionList;
  19366. /**
  19367. * The Amazon Web Services request ID for this operation.
  19368. */
  19369. RequestId?: String;
  19370. /**
  19371. * The HTTP status of the request.
  19372. */
  19373. Status?: StatusCode;
  19374. }
  19375. export interface UpdateThemeRequest {
  19376. /**
  19377. * The ID of the Amazon Web Services account that contains the theme that you're updating.
  19378. */
  19379. AwsAccountId: AwsAccountId;
  19380. /**
  19381. * The ID for the theme.
  19382. */
  19383. ThemeId: ShortRestrictiveResourceId;
  19384. /**
  19385. * The name for the theme.
  19386. */
  19387. Name?: ThemeName;
  19388. /**
  19389. * The theme ID, defined by Amazon QuickSight, that a custom theme inherits from. All themes initially inherit from a default Amazon QuickSight theme.
  19390. */
  19391. BaseThemeId: ShortRestrictiveResourceId;
  19392. /**
  19393. * A description of the theme version that you're updating Every time that you call UpdateTheme, you create a new version of the theme. Each version of the theme maintains a description of the version in VersionDescription.
  19394. */
  19395. VersionDescription?: VersionDescription;
  19396. /**
  19397. * The theme configuration, which contains the theme display properties.
  19398. */
  19399. Configuration?: ThemeConfiguration;
  19400. }
  19401. export interface UpdateThemeResponse {
  19402. /**
  19403. * The ID for the theme.
  19404. */
  19405. ThemeId?: ShortRestrictiveResourceId;
  19406. /**
  19407. * The Amazon Resource Name (ARN) for the theme.
  19408. */
  19409. Arn?: Arn;
  19410. /**
  19411. * The Amazon Resource Name (ARN) for the new version of the theme.
  19412. */
  19413. VersionArn?: Arn;
  19414. /**
  19415. * The creation status of the theme.
  19416. */
  19417. CreationStatus?: ResourceStatus;
  19418. /**
  19419. * The HTTP status of the request.
  19420. */
  19421. Status?: StatusCode;
  19422. /**
  19423. * The Amazon Web Services request ID for this operation.
  19424. */
  19425. RequestId?: String;
  19426. }
  19427. export interface UpdateTopicPermissionsRequest {
  19428. /**
  19429. * The ID of the Amazon Web Services account that contains the topic that you want to update the permissions for.
  19430. */
  19431. AwsAccountId: AwsAccountId;
  19432. /**
  19433. * The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  19434. */
  19435. TopicId: TopicId;
  19436. /**
  19437. * The resource permissions that you want to grant to the topic.
  19438. */
  19439. GrantPermissions?: UpdateResourcePermissionList;
  19440. /**
  19441. * The resource permissions that you want to revoke from the topic.
  19442. */
  19443. RevokePermissions?: UpdateResourcePermissionList;
  19444. }
  19445. export interface UpdateTopicPermissionsResponse {
  19446. /**
  19447. * The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  19448. */
  19449. TopicId?: TopicId;
  19450. /**
  19451. * The Amazon Resource Name (ARN) of the topic.
  19452. */
  19453. TopicArn?: Arn;
  19454. /**
  19455. * A list of resource permissions on the topic.
  19456. */
  19457. Permissions?: ResourcePermissionList;
  19458. /**
  19459. * The HTTP status of the request.
  19460. */
  19461. Status?: StatusCode;
  19462. /**
  19463. * The Amazon Web Services request ID for this operation.
  19464. */
  19465. RequestId?: String;
  19466. }
  19467. export interface UpdateTopicRefreshScheduleRequest {
  19468. /**
  19469. * The ID of the Amazon Web Services account that contains the topic whose refresh schedule you want to update.
  19470. */
  19471. AwsAccountId: AwsAccountId;
  19472. /**
  19473. * The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  19474. */
  19475. TopicId: TopicId;
  19476. /**
  19477. * The ID of the dataset.
  19478. */
  19479. DatasetId: String;
  19480. /**
  19481. * The definition of a refresh schedule.
  19482. */
  19483. RefreshSchedule: TopicRefreshSchedule;
  19484. }
  19485. export interface UpdateTopicRefreshScheduleResponse {
  19486. /**
  19487. * The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  19488. */
  19489. TopicId?: TopicId;
  19490. /**
  19491. * The Amazon Resource Name (ARN) of the topic.
  19492. */
  19493. TopicArn?: Arn;
  19494. /**
  19495. * The Amazon Resource Name (ARN) of the dataset.
  19496. */
  19497. DatasetArn?: Arn;
  19498. /**
  19499. * The HTTP status of the request.
  19500. */
  19501. Status?: StatusCode;
  19502. /**
  19503. * The Amazon Web Services request ID for this operation.
  19504. */
  19505. RequestId?: String;
  19506. }
  19507. export interface UpdateTopicRequest {
  19508. /**
  19509. * The ID of the Amazon Web Services account that contains the topic that you want to update.
  19510. */
  19511. AwsAccountId: AwsAccountId;
  19512. /**
  19513. * The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  19514. */
  19515. TopicId: TopicId;
  19516. /**
  19517. * The definition of the topic that you want to update.
  19518. */
  19519. Topic: TopicDetails;
  19520. }
  19521. export interface UpdateTopicResponse {
  19522. /**
  19523. * The ID of the topic that you want to modify. This ID is unique per Amazon Web Services Region for each Amazon Web Services account.
  19524. */
  19525. TopicId?: TopicId;
  19526. /**
  19527. * The Amazon Resource Name (ARN) of the topic.
  19528. */
  19529. Arn?: Arn;
  19530. /**
  19531. * The Amazon Resource Name (ARN) of the topic refresh.
  19532. */
  19533. RefreshArn?: Arn;
  19534. /**
  19535. * The Amazon Web Services request ID for this operation.
  19536. */
  19537. RequestId?: String;
  19538. /**
  19539. * The HTTP status of the request.
  19540. */
  19541. Status?: StatusCode;
  19542. }
  19543. export interface UpdateUserRequest {
  19544. /**
  19545. * The Amazon QuickSight user name that you want to update.
  19546. */
  19547. UserName: UserName;
  19548. /**
  19549. * The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.
  19550. */
  19551. AwsAccountId: AwsAccountId;
  19552. /**
  19553. * The namespace. Currently, you should set this to default.
  19554. */
  19555. Namespace: Namespace;
  19556. /**
  19557. * The email address of the user that you want to update.
  19558. */
  19559. Email: String;
  19560. /**
  19561. * The Amazon QuickSight role of the user. The role can be one of the following default security cohorts: READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, datasets, analyses, and dashboards. ADMIN: A user who is an author, who can also manage Amazon QuickSight settings. READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards. AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&amp;A, and generate executive summaries from dashboards. ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing. The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.
  19562. */
  19563. Role: UserRole;
  19564. /**
  19565. * (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations: Create and update data sources Create and update datasets Create and update email reports Subscribe to email reports A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user. Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader). This feature is available only to Amazon QuickSight Enterprise edition subscriptions.
  19566. */
  19567. CustomPermissionsName?: RoleName;
  19568. /**
  19569. * A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.
  19570. */
  19571. UnapplyCustomPermissions?: Boolean;
  19572. /**
  19573. * The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following. COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom. CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL. NONE: This clears all the previously saved external login information for a user. Use the DescribeUser API operation to check the external login information.
  19574. */
  19575. ExternalLoginFederationProviderType?: String;
  19576. /**
  19577. * The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.
  19578. */
  19579. CustomFederationProviderUrl?: String;
  19580. /**
  19581. * The identity ID for a user in the external login provider.
  19582. */
  19583. ExternalLoginId?: String;
  19584. }
  19585. export interface UpdateUserResponse {
  19586. /**
  19587. * The Amazon QuickSight user.
  19588. */
  19589. User?: User;
  19590. /**
  19591. * The Amazon Web Services request ID for this operation.
  19592. */
  19593. RequestId?: String;
  19594. /**
  19595. * The HTTP status of the request.
  19596. */
  19597. Status?: StatusCode;
  19598. }
  19599. export interface UpdateVPCConnectionRequest {
  19600. /**
  19601. * The Amazon Web Services account ID of the account that contains the VPC connection that you want to update.
  19602. */
  19603. AwsAccountId: AwsAccountId;
  19604. /**
  19605. * The ID of the VPC connection that you're updating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
  19606. */
  19607. VPCConnectionId: VPCConnectionResourceIdUnrestricted;
  19608. /**
  19609. * The display name for the VPC connection.
  19610. */
  19611. Name: ResourceName;
  19612. /**
  19613. * A list of subnet IDs for the VPC connection.
  19614. */
  19615. SubnetIds: SubnetIdList;
  19616. /**
  19617. * A list of security group IDs for the VPC connection.
  19618. */
  19619. SecurityGroupIds: SecurityGroupIdList;
  19620. /**
  19621. * A list of IP addresses of DNS resolver endpoints for the VPC connection.
  19622. */
  19623. DnsResolvers?: DnsResolverList;
  19624. /**
  19625. * An IAM role associated with the VPC connection.
  19626. */
  19627. RoleArn: RoleArn;
  19628. }
  19629. export interface UpdateVPCConnectionResponse {
  19630. /**
  19631. * The Amazon Resource Name (ARN) of the VPC connection.
  19632. */
  19633. Arn?: Arn;
  19634. /**
  19635. * The ID of the VPC connection that you are updating. This ID is a unique identifier for each Amazon Web Services Region in anAmazon Web Services account.
  19636. */
  19637. VPCConnectionId?: VPCConnectionResourceIdUnrestricted;
  19638. /**
  19639. * The update status of the VPC connection's last update.
  19640. */
  19641. UpdateStatus?: VPCConnectionResourceStatus;
  19642. /**
  19643. * The availability status of the VPC connection.
  19644. */
  19645. AvailabilityStatus?: VPCConnectionAvailabilityStatus;
  19646. /**
  19647. * The Amazon Web Services request ID for this operation.
  19648. */
  19649. RequestId?: String;
  19650. /**
  19651. * The HTTP status of the request.
  19652. */
  19653. Status?: StatusCode;
  19654. }
  19655. export interface UploadSettings {
  19656. /**
  19657. * File format.
  19658. */
  19659. Format?: FileFormat;
  19660. /**
  19661. * A row number to start reading data from.
  19662. */
  19663. StartFromRow?: PositiveInteger;
  19664. /**
  19665. * Whether the file has a header row, or the files each have a header row.
  19666. */
  19667. ContainsHeader?: Boolean;
  19668. /**
  19669. * Text qualifier.
  19670. */
  19671. TextQualifier?: TextQualifier;
  19672. /**
  19673. * The delimiter between values in the file.
  19674. */
  19675. Delimiter?: Delimiter;
  19676. }
  19677. export interface User {
  19678. /**
  19679. * The Amazon Resource Name (ARN) for the user.
  19680. */
  19681. Arn?: Arn;
  19682. /**
  19683. * The user's user name. This value is required if you are registering a user that will be managed in Amazon QuickSight. In the output, the value for UserName is N/A when the value for IdentityType is IAM and the corresponding IAM user is deleted.
  19684. */
  19685. UserName?: UserName;
  19686. /**
  19687. * The user's email address.
  19688. */
  19689. Email?: String;
  19690. /**
  19691. * The Amazon QuickSight role for the user. The user role can be one of the following:. READER: A user who has read-only access to dashboards. AUTHOR: A user who can create data sources, datasets, analyses, and dashboards. ADMIN: A user who is an author, who can also manage Amazon Amazon QuickSight settings. READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q Business, can build stories with Amazon Q, and can generate executive summaries from dashboards. AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&amp;A, and generate executive summaries from dashboards. ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing. RESTRICTED_READER: This role isn't currently available for use. RESTRICTED_AUTHOR: This role isn't currently available for use.
  19692. */
  19693. Role?: UserRole;
  19694. /**
  19695. * The type of identity authentication used by the user.
  19696. */
  19697. IdentityType?: IdentityType;
  19698. /**
  19699. * The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
  19700. */
  19701. Active?: Boolean;
  19702. /**
  19703. * The principal ID of the user.
  19704. */
  19705. PrincipalId?: String;
  19706. /**
  19707. * The custom permissions profile associated with this user.
  19708. */
  19709. CustomPermissionsName?: RoleName;
  19710. /**
  19711. * The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following. COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider.
  19712. */
  19713. ExternalLoginFederationProviderType?: String;
  19714. /**
  19715. * The URL of the external login provider.
  19716. */
  19717. ExternalLoginFederationProviderUrl?: String;
  19718. /**
  19719. * The identity ID for the user in the external login provider.
  19720. */
  19721. ExternalLoginId?: String;
  19722. }
  19723. export type UserList = User[];
  19724. export type UserName = string;
  19725. export type UserRole = "ADMIN"|"AUTHOR"|"READER"|"RESTRICTED_AUTHOR"|"RESTRICTED_READER"|"ADMIN_PRO"|"AUTHOR_PRO"|"READER_PRO"|string;
  19726. export interface VPCConnection {
  19727. /**
  19728. * The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
  19729. */
  19730. VPCConnectionId?: VPCConnectionResourceIdUnrestricted;
  19731. /**
  19732. * The Amazon Resource Name (ARN) of the VPC connection.
  19733. */
  19734. Arn?: Arn;
  19735. /**
  19736. * The display name for the VPC connection.
  19737. */
  19738. Name?: ResourceName;
  19739. /**
  19740. * The Amazon EC2 VPC ID associated with the VPC connection.
  19741. */
  19742. VPCId?: String;
  19743. /**
  19744. * The Amazon EC2 security group IDs associated with the VPC connection.
  19745. */
  19746. SecurityGroupIds?: SecurityGroupIdList;
  19747. /**
  19748. * A list of IP addresses of DNS resolver endpoints for the VPC connection.
  19749. */
  19750. DnsResolvers?: StringList;
  19751. /**
  19752. * The status of the VPC connection.
  19753. */
  19754. Status?: VPCConnectionResourceStatus;
  19755. /**
  19756. * The availability status of the VPC connection.
  19757. */
  19758. AvailabilityStatus?: VPCConnectionAvailabilityStatus;
  19759. /**
  19760. * A list of network interfaces.
  19761. */
  19762. NetworkInterfaces?: NetworkInterfaceList;
  19763. /**
  19764. * The ARN of the IAM role associated with the VPC connection.
  19765. */
  19766. RoleArn?: String;
  19767. /**
  19768. * The time that the VPC connection was created.
  19769. */
  19770. CreatedTime?: Timestamp;
  19771. /**
  19772. * The time that the VPC connection was last updated.
  19773. */
  19774. LastUpdatedTime?: Timestamp;
  19775. }
  19776. export type VPCConnectionAvailabilityStatus = "AVAILABLE"|"UNAVAILABLE"|"PARTIALLY_AVAILABLE"|string;
  19777. export type VPCConnectionResourceIdRestricted = string;
  19778. export type VPCConnectionResourceIdUnrestricted = string;
  19779. export type VPCConnectionResourceStatus = "CREATION_IN_PROGRESS"|"CREATION_SUCCESSFUL"|"CREATION_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCESSFUL"|"UPDATE_FAILED"|"DELETION_IN_PROGRESS"|"DELETION_FAILED"|"DELETED"|string;
  19780. export interface VPCConnectionSummary {
  19781. /**
  19782. * The ID of the VPC connection that you're creating. This ID is a unique identifier for each Amazon Web Services Region in an Amazon Web Services account.
  19783. */
  19784. VPCConnectionId?: VPCConnectionResourceIdUnrestricted;
  19785. /**
  19786. * The Amazon Resource Name (ARN) of the VPC connection.
  19787. */
  19788. Arn?: Arn;
  19789. /**
  19790. * The display name for the VPC connection.
  19791. */
  19792. Name?: ResourceName;
  19793. /**
  19794. * The Amazon EC2 VPC ID associated with the VPC connection.
  19795. */
  19796. VPCId?: String;
  19797. /**
  19798. * The Amazon EC2 security group IDs associated with the VPC connection.
  19799. */
  19800. SecurityGroupIds?: SecurityGroupIdList;
  19801. /**
  19802. * A list of IP addresses of DNS resolver endpoints for the VPC connection.
  19803. */
  19804. DnsResolvers?: StringList;
  19805. /**
  19806. * The status of the VPC connection.
  19807. */
  19808. Status?: VPCConnectionResourceStatus;
  19809. /**
  19810. * The availability status of the VPC connection.
  19811. */
  19812. AvailabilityStatus?: VPCConnectionAvailabilityStatus;
  19813. /**
  19814. * A list of network interfaces.
  19815. */
  19816. NetworkInterfaces?: NetworkInterfaceList;
  19817. /**
  19818. * The ARN of the IAM role associated with the VPC connection.
  19819. */
  19820. RoleArn?: String;
  19821. /**
  19822. * The time that the VPC connection was created.
  19823. */
  19824. CreatedTime?: Timestamp;
  19825. /**
  19826. * The time that the VPC connection was last updated.
  19827. */
  19828. LastUpdatedTime?: Timestamp;
  19829. }
  19830. export type VPCConnectionSummaryList = VPCConnectionSummary[];
  19831. export interface ValidationStrategy {
  19832. /**
  19833. * The mode of validation for the asset to be created or updated. When you set this value to STRICT, strict validation for every error is enforced. When you set this value to LENIENT, validation is skipped for specific UI errors.
  19834. */
  19835. Mode: ValidationStrategyMode;
  19836. }
  19837. export type ValidationStrategyMode = "STRICT"|"LENIENT"|string;
  19838. export type ValueWhenUnsetOption = "RECOMMENDED_VALUE"|"NULL"|string;
  19839. export type VersionDescription = string;
  19840. export type VersionNumber = number;
  19841. export type VerticalTextAlignment = "TOP"|"MIDDLE"|"BOTTOM"|"AUTO"|string;
  19842. export type Visibility = "HIDDEN"|"VISIBLE"|string;
  19843. export type VisiblePanelColumns = number;
  19844. export type VisiblePanelRows = number;
  19845. export interface VisibleRangeOptions {
  19846. /**
  19847. * The percent range in the visible range.
  19848. */
  19849. PercentRange?: PercentVisibleRange;
  19850. }
  19851. export interface Visual {
  19852. /**
  19853. * A table visual. For more information, see Using tables as visuals in the Amazon QuickSight User Guide.
  19854. */
  19855. TableVisual?: TableVisual;
  19856. /**
  19857. * A pivot table. For more information, see Using pivot tables in the Amazon QuickSight User Guide.
  19858. */
  19859. PivotTableVisual?: PivotTableVisual;
  19860. /**
  19861. * A bar chart. For more information, see Using bar charts in the Amazon QuickSight User Guide.
  19862. */
  19863. BarChartVisual?: BarChartVisual;
  19864. /**
  19865. * A key performance indicator (KPI). For more information, see Using KPIs in the Amazon QuickSight User Guide.
  19866. */
  19867. KPIVisual?: KPIVisual;
  19868. /**
  19869. * A pie or donut chart. For more information, see Using pie charts in the Amazon QuickSight User Guide.
  19870. */
  19871. PieChartVisual?: PieChartVisual;
  19872. /**
  19873. * A gauge chart. For more information, see Using gauge charts in the Amazon QuickSight User Guide.
  19874. */
  19875. GaugeChartVisual?: GaugeChartVisual;
  19876. /**
  19877. * A line chart. For more information, see Using line charts in the Amazon QuickSight User Guide.
  19878. */
  19879. LineChartVisual?: LineChartVisual;
  19880. /**
  19881. * A heat map. For more information, see Using heat maps in the Amazon QuickSight User Guide.
  19882. */
  19883. HeatMapVisual?: HeatMapVisual;
  19884. /**
  19885. * A tree map. For more information, see Using tree maps in the Amazon QuickSight User Guide.
  19886. */
  19887. TreeMapVisual?: TreeMapVisual;
  19888. /**
  19889. * A geospatial map or a points on map visual. For more information, see Creating point maps in the Amazon QuickSight User Guide.
  19890. */
  19891. GeospatialMapVisual?: GeospatialMapVisual;
  19892. /**
  19893. * A filled map. For more information, see Creating filled maps in the Amazon QuickSight User Guide.
  19894. */
  19895. FilledMapVisual?: FilledMapVisual;
  19896. /**
  19897. * A funnel chart. For more information, see Using funnel charts in the Amazon QuickSight User Guide.
  19898. */
  19899. FunnelChartVisual?: FunnelChartVisual;
  19900. /**
  19901. * A scatter plot. For more information, see Using scatter plots in the Amazon QuickSight User Guide.
  19902. */
  19903. ScatterPlotVisual?: ScatterPlotVisual;
  19904. /**
  19905. * A combo chart. For more information, see Using combo charts in the Amazon QuickSight User Guide.
  19906. */
  19907. ComboChartVisual?: ComboChartVisual;
  19908. /**
  19909. * A box plot. For more information, see Using box plots in the Amazon QuickSight User Guide.
  19910. */
  19911. BoxPlotVisual?: BoxPlotVisual;
  19912. /**
  19913. * A waterfall chart. For more information, see Using waterfall charts in the Amazon QuickSight User Guide.
  19914. */
  19915. WaterfallVisual?: WaterfallVisual;
  19916. /**
  19917. * A histogram. For more information, see Using histograms in the Amazon QuickSight User Guide.
  19918. */
  19919. HistogramVisual?: HistogramVisual;
  19920. /**
  19921. * A word cloud. For more information, see Using word clouds in the Amazon QuickSight User Guide.
  19922. */
  19923. WordCloudVisual?: WordCloudVisual;
  19924. /**
  19925. * An insight visual. For more information, see Working with insights in the Amazon QuickSight User Guide.
  19926. */
  19927. InsightVisual?: InsightVisual;
  19928. /**
  19929. * A sankey diagram. For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.
  19930. */
  19931. SankeyDiagramVisual?: SankeyDiagramVisual;
  19932. /**
  19933. * A visual that contains custom content. For more information, see Using custom visual content in the Amazon QuickSight User Guide.
  19934. */
  19935. CustomContentVisual?: CustomContentVisual;
  19936. /**
  19937. * An empty visual.
  19938. */
  19939. EmptyVisual?: EmptyVisual;
  19940. /**
  19941. * A radar chart visual. For more information, see Using radar charts in the Amazon QuickSight User Guide.
  19942. */
  19943. RadarChartVisual?: RadarChartVisual;
  19944. }
  19945. export interface VisualAxisSortOption {
  19946. /**
  19947. * The availaiblity status of a visual's axis sort options.
  19948. */
  19949. AvailabilityStatus?: DashboardBehavior;
  19950. }
  19951. export interface VisualCustomAction {
  19952. /**
  19953. * The ID of the VisualCustomAction.
  19954. */
  19955. CustomActionId: ShortRestrictiveResourceId;
  19956. /**
  19957. * The name of the VisualCustomAction.
  19958. */
  19959. Name: VisualCustomActionName;
  19960. /**
  19961. * The status of the VisualCustomAction.
  19962. */
  19963. Status?: WidgetStatus;
  19964. /**
  19965. * The trigger of the VisualCustomAction. Valid values are defined as follows: DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point. DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.
  19966. */
  19967. Trigger: VisualCustomActionTrigger;
  19968. /**
  19969. * A list of VisualCustomActionOperations. This is a union type structure. For this structure to be valid, only one of the attributes can be defined.
  19970. */
  19971. ActionOperations: VisualCustomActionOperationList;
  19972. }
  19973. export type VisualCustomActionList = VisualCustomAction[];
  19974. export type VisualCustomActionName = string;
  19975. export interface VisualCustomActionOperation {
  19976. /**
  19977. * The filter operation that filters data included in a visual or in an entire sheet.
  19978. */
  19979. FilterOperation?: CustomActionFilterOperation;
  19980. /**
  19981. * The navigation operation that navigates between different sheets in the same analysis.
  19982. */
  19983. NavigationOperation?: CustomActionNavigationOperation;
  19984. /**
  19985. * The URL operation that opens a link to another webpage.
  19986. */
  19987. URLOperation?: CustomActionURLOperation;
  19988. /**
  19989. * The set parameter operation that sets parameters in custom action.
  19990. */
  19991. SetParametersOperation?: CustomActionSetParametersOperation;
  19992. }
  19993. export type VisualCustomActionOperationList = VisualCustomActionOperation[];
  19994. export type VisualCustomActionTrigger = "DATA_POINT_CLICK"|"DATA_POINT_MENU"|string;
  19995. export interface VisualInteractionOptions {
  19996. /**
  19997. * The on-visual menu options for a visual.
  19998. */
  19999. VisualMenuOption?: VisualMenuOption;
  20000. /**
  20001. * The context menu options for a visual.
  20002. */
  20003. ContextMenuOption?: ContextMenuOption;
  20004. }
  20005. export type VisualList = Visual[];
  20006. export interface VisualMenuOption {
  20007. /**
  20008. * The availaiblity status of a visual's menu options.
  20009. */
  20010. AvailabilityStatus?: DashboardBehavior;
  20011. }
  20012. export interface VisualPalette {
  20013. /**
  20014. * The chart color options for the visual palette.
  20015. */
  20016. ChartColor?: HexColor;
  20017. /**
  20018. * The color map options for the visual palette.
  20019. */
  20020. ColorMap?: DataPathColorList;
  20021. }
  20022. export interface VisualSubtitleLabelOptions {
  20023. /**
  20024. * The visibility of the subtitle label.
  20025. */
  20026. Visibility?: Visibility;
  20027. /**
  20028. * The long text format of the subtitle label, such as plain text or rich text.
  20029. */
  20030. FormatText?: LongFormatText;
  20031. }
  20032. export interface VisualTitleLabelOptions {
  20033. /**
  20034. * The visibility of the title label.
  20035. */
  20036. Visibility?: Visibility;
  20037. /**
  20038. * The short text format of the title label, such as plain text or rich text.
  20039. */
  20040. FormatText?: ShortFormatText;
  20041. }
  20042. export interface VpcConnectionProperties {
  20043. /**
  20044. * The Amazon Resource Name (ARN) for the VPC connection.
  20045. */
  20046. VpcConnectionArn: Arn;
  20047. }
  20048. export type VpcEndpointId = string;
  20049. export type VpcEndpointIdRestrictionRuleDescription = string;
  20050. export type VpcEndpointIdRestrictionRuleMap = {[key: string]: VpcEndpointIdRestrictionRuleDescription};
  20051. export type VpcId = string;
  20052. export type VpcIdRestrictionRuleDescription = string;
  20053. export type VpcIdRestrictionRuleMap = {[key: string]: VpcIdRestrictionRuleDescription};
  20054. export type Warehouse = string;
  20055. export interface WaterfallChartAggregatedFieldWells {
  20056. /**
  20057. * The category field wells of a waterfall visual.
  20058. */
  20059. Categories?: DimensionFieldList;
  20060. /**
  20061. * The value field wells of a waterfall visual.
  20062. */
  20063. Values?: MeasureFieldList;
  20064. /**
  20065. * The breakdown field wells of a waterfall visual.
  20066. */
  20067. Breakdowns?: DimensionFieldList;
  20068. }
  20069. export interface WaterfallChartColorConfiguration {
  20070. /**
  20071. * The color configuration for individual groups within a waterfall visual.
  20072. */
  20073. GroupColorConfiguration?: WaterfallChartGroupColorConfiguration;
  20074. }
  20075. export interface WaterfallChartConfiguration {
  20076. /**
  20077. * The field well configuration of a waterfall visual.
  20078. */
  20079. FieldWells?: WaterfallChartFieldWells;
  20080. /**
  20081. * The sort configuration of a waterfall visual.
  20082. */
  20083. SortConfiguration?: WaterfallChartSortConfiguration;
  20084. /**
  20085. * The options that determine the presentation of a waterfall visual.
  20086. */
  20087. WaterfallChartOptions?: WaterfallChartOptions;
  20088. /**
  20089. * The options that determine the presentation of the category axis label.
  20090. */
  20091. CategoryAxisLabelOptions?: ChartAxisLabelOptions;
  20092. /**
  20093. * The options that determine the presentation of the category axis.
  20094. */
  20095. CategoryAxisDisplayOptions?: AxisDisplayOptions;
  20096. /**
  20097. * The options that determine the presentation of the y-axis label.
  20098. */
  20099. PrimaryYAxisLabelOptions?: ChartAxisLabelOptions;
  20100. /**
  20101. * The options that determine the presentation of the y-axis.
  20102. */
  20103. PrimaryYAxisDisplayOptions?: AxisDisplayOptions;
  20104. /**
  20105. * The legend configuration of a waterfall visual.
  20106. */
  20107. Legend?: LegendOptions;
  20108. /**
  20109. * The data label configuration of a waterfall visual.
  20110. */
  20111. DataLabels?: DataLabelOptions;
  20112. /**
  20113. * The visual palette configuration of a waterfall visual.
  20114. */
  20115. VisualPalette?: VisualPalette;
  20116. /**
  20117. * The color configuration of a waterfall visual.
  20118. */
  20119. ColorConfiguration?: WaterfallChartColorConfiguration;
  20120. /**
  20121. * The general visual interactions setup for a visual.
  20122. */
  20123. Interactions?: VisualInteractionOptions;
  20124. }
  20125. export interface WaterfallChartFieldWells {
  20126. /**
  20127. * The field well configuration of a waterfall visual.
  20128. */
  20129. WaterfallChartAggregatedFieldWells?: WaterfallChartAggregatedFieldWells;
  20130. }
  20131. export interface WaterfallChartGroupColorConfiguration {
  20132. /**
  20133. * Defines the color for the positive bars of a waterfall chart.
  20134. */
  20135. PositiveBarColor?: HexColor;
  20136. /**
  20137. * Defines the color for the negative bars of a waterfall chart.
  20138. */
  20139. NegativeBarColor?: HexColor;
  20140. /**
  20141. * Defines the color for the total bars of a waterfall chart.
  20142. */
  20143. TotalBarColor?: HexColor;
  20144. }
  20145. export interface WaterfallChartOptions {
  20146. /**
  20147. * This option determines the total bar label of a waterfall visual.
  20148. */
  20149. TotalBarLabel?: String;
  20150. }
  20151. export interface WaterfallChartSortConfiguration {
  20152. /**
  20153. * The sort configuration of the category fields.
  20154. */
  20155. CategorySort?: FieldSortOptionsList;
  20156. /**
  20157. * The limit on the number of bar groups that are displayed.
  20158. */
  20159. BreakdownItemsLimit?: ItemsLimitConfiguration;
  20160. }
  20161. export interface WaterfallVisual {
  20162. /**
  20163. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
  20164. */
  20165. VisualId: ShortRestrictiveResourceId;
  20166. /**
  20167. * The title that is displayed on the visual.
  20168. */
  20169. Title?: VisualTitleLabelOptions;
  20170. /**
  20171. * The subtitle that is displayed on the visual.
  20172. */
  20173. Subtitle?: VisualSubtitleLabelOptions;
  20174. /**
  20175. * The configuration for a waterfall visual.
  20176. */
  20177. ChartConfiguration?: WaterfallChartConfiguration;
  20178. /**
  20179. * The list of custom actions that are configured for a visual.
  20180. */
  20181. Actions?: VisualCustomActionList;
  20182. /**
  20183. * The column hierarchy that is used during drill-downs and drill-ups.
  20184. */
  20185. ColumnHierarchies?: ColumnHierarchyList;
  20186. }
  20187. export interface WhatIfPointScenario {
  20188. /**
  20189. * The date that you need the forecast results for.
  20190. */
  20191. Date: Timestamp;
  20192. /**
  20193. * The target value that you want to meet for the provided date.
  20194. */
  20195. Value: Double;
  20196. }
  20197. export interface WhatIfRangeScenario {
  20198. /**
  20199. * The start date in the date range that you need the forecast results for.
  20200. */
  20201. StartDate: Timestamp;
  20202. /**
  20203. * The end date in the date range that you need the forecast results for.
  20204. */
  20205. EndDate: Timestamp;
  20206. /**
  20207. * The target value that you want to meet for the provided date range.
  20208. */
  20209. Value: Double;
  20210. }
  20211. export type WidgetStatus = "ENABLED"|"DISABLED"|string;
  20212. export interface WordCloudAggregatedFieldWells {
  20213. /**
  20214. * The group by field well of a word cloud. Values are grouped by group by fields.
  20215. */
  20216. GroupBy?: WordCloudDimensionFieldList;
  20217. /**
  20218. * The size field well of a word cloud. Values are aggregated based on group by fields.
  20219. */
  20220. Size?: WordCloudMeasureFieldList;
  20221. }
  20222. export interface WordCloudChartConfiguration {
  20223. /**
  20224. * The field wells of the visual.
  20225. */
  20226. FieldWells?: WordCloudFieldWells;
  20227. /**
  20228. * The sort configuration of a word cloud visual.
  20229. */
  20230. SortConfiguration?: WordCloudSortConfiguration;
  20231. /**
  20232. * The label options (label text, label visibility, and sort icon visibility) for the word cloud category.
  20233. */
  20234. CategoryLabelOptions?: ChartAxisLabelOptions;
  20235. /**
  20236. * The options for a word cloud visual.
  20237. */
  20238. WordCloudOptions?: WordCloudOptions;
  20239. /**
  20240. * The general visual interactions setup for a visual.
  20241. */
  20242. Interactions?: VisualInteractionOptions;
  20243. }
  20244. export type WordCloudCloudLayout = "FLUID"|"NORMAL"|string;
  20245. export type WordCloudDimensionFieldList = DimensionField[];
  20246. export interface WordCloudFieldWells {
  20247. /**
  20248. * The aggregated field wells of a word cloud.
  20249. */
  20250. WordCloudAggregatedFieldWells?: WordCloudAggregatedFieldWells;
  20251. }
  20252. export type WordCloudMaximumStringLength = number;
  20253. export type WordCloudMeasureFieldList = MeasureField[];
  20254. export interface WordCloudOptions {
  20255. /**
  20256. * The word orientation options (horizontal, horizontal_and_vertical) for the words in a word cloud.
  20257. */
  20258. WordOrientation?: WordCloudWordOrientation;
  20259. /**
  20260. * The word scaling options (emphasize, normal) for the words in a word cloud.
  20261. */
  20262. WordScaling?: WordCloudWordScaling;
  20263. /**
  20264. * The cloud layout options (fluid, normal) of a word cloud.
  20265. */
  20266. CloudLayout?: WordCloudCloudLayout;
  20267. /**
  20268. * The word casing options (lower_case, existing_case) for the words in a word cloud.
  20269. */
  20270. WordCasing?: WordCloudWordCasing;
  20271. /**
  20272. * The word padding options (none, small, medium, large) for the words in a word cloud.
  20273. */
  20274. WordPadding?: WordCloudWordPadding;
  20275. /**
  20276. * The length limit of each word from 1-100.
  20277. */
  20278. MaximumStringLength?: WordCloudMaximumStringLength;
  20279. }
  20280. export interface WordCloudSortConfiguration {
  20281. /**
  20282. * The limit on the number of groups that are displayed in a word cloud.
  20283. */
  20284. CategoryItemsLimit?: ItemsLimitConfiguration;
  20285. /**
  20286. * The sort configuration of group by fields.
  20287. */
  20288. CategorySort?: FieldSortOptionsList;
  20289. }
  20290. export interface WordCloudVisual {
  20291. /**
  20292. * The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers..
  20293. */
  20294. VisualId: ShortRestrictiveResourceId;
  20295. /**
  20296. * The title that is displayed on the visual.
  20297. */
  20298. Title?: VisualTitleLabelOptions;
  20299. /**
  20300. * The subtitle that is displayed on the visual.
  20301. */
  20302. Subtitle?: VisualSubtitleLabelOptions;
  20303. /**
  20304. * The configuration settings of the visual.
  20305. */
  20306. ChartConfiguration?: WordCloudChartConfiguration;
  20307. /**
  20308. * The list of custom actions that are configured for a visual.
  20309. */
  20310. Actions?: VisualCustomActionList;
  20311. /**
  20312. * The column hierarchy that is used during drill-downs and drill-ups.
  20313. */
  20314. ColumnHierarchies?: ColumnHierarchyList;
  20315. }
  20316. export type WordCloudWordCasing = "LOWER_CASE"|"EXISTING_CASE"|string;
  20317. export type WordCloudWordOrientation = "HORIZONTAL"|"HORIZONTAL_AND_VERTICAL"|string;
  20318. export type WordCloudWordPadding = "NONE"|"SMALL"|"MEDIUM"|"LARGE"|string;
  20319. export type WordCloudWordScaling = "EMPHASIZE"|"NORMAL"|string;
  20320. export type WorkGroup = string;
  20321. export interface YAxisOptions {
  20322. /**
  20323. * The Y axis type to be used in the chart. If you choose PRIMARY_Y_AXIS, the primary Y Axis is located on the leftmost vertical axis of the chart.
  20324. */
  20325. YAxis: SingleYAxisOption;
  20326. }
  20327. /**
  20328. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  20329. */
  20330. export type apiVersion = "2018-04-01"|"latest"|string;
  20331. export interface ClientApiVersions {
  20332. /**
  20333. * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
  20334. */
  20335. apiVersion?: apiVersion;
  20336. }
  20337. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  20338. /**
  20339. * Contains interfaces for use with the QuickSight client.
  20340. */
  20341. export import Types = QuickSight;
  20342. }
  20343. export = QuickSight;