12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488348934903491349234933494349534963497349834993500350135023503350435053506350735083509351035113512351335143515351635173518351935203521352235233524352535263527352835293530353135323533353435353536353735383539354035413542354335443545354635473548354935503551355235533554355535563557355835593560356135623563356435653566356735683569357035713572357335743575357635773578357935803581358235833584358535863587358835893590359135923593359435953596359735983599360036013602360336043605360636073608360936103611361236133614361536163617361836193620362136223623362436253626362736283629363036313632363336343635363636373638363936403641364236433644364536463647364836493650365136523653365436553656365736583659366036613662366336643665366636673668366936703671367236733674367536763677367836793680368136823683368436853686368736883689369036913692369336943695369636973698369937003701370237033704370537063707370837093710371137123713371437153716371737183719372037213722372337243725372637273728372937303731373237333734373537363737373837393740374137423743374437453746374737483749375037513752375337543755 |
- import {Request} from '../lib/request';
- import {Response} from '../lib/response';
- import {AWSError} from '../lib/error';
- import {Service} from '../lib/service';
- import {ServiceConfigurationOptions} from '../lib/service';
- import {ConfigBase as Config} from '../lib/config-base';
- interface Blob {}
- declare class CleanRooms extends Service {
- /**
- * Constructs a service object. This object has one method for each API operation.
- */
- constructor(options?: CleanRooms.Types.ClientConfiguration)
- config: Config & CleanRooms.Types.ClientConfiguration;
- /**
- * Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
- */
- batchGetCollaborationAnalysisTemplate(params: CleanRooms.Types.BatchGetCollaborationAnalysisTemplateInput, callback?: (err: AWSError, data: CleanRooms.Types.BatchGetCollaborationAnalysisTemplateOutput) => void): Request<CleanRooms.Types.BatchGetCollaborationAnalysisTemplateOutput, AWSError>;
- /**
- * Retrieves multiple analysis templates within a collaboration by their Amazon Resource Names (ARNs).
- */
- batchGetCollaborationAnalysisTemplate(callback?: (err: AWSError, data: CleanRooms.Types.BatchGetCollaborationAnalysisTemplateOutput) => void): Request<CleanRooms.Types.BatchGetCollaborationAnalysisTemplateOutput, AWSError>;
- /**
- * Retrieves multiple schemas by their identifiers.
- */
- batchGetSchema(params: CleanRooms.Types.BatchGetSchemaInput, callback?: (err: AWSError, data: CleanRooms.Types.BatchGetSchemaOutput) => void): Request<CleanRooms.Types.BatchGetSchemaOutput, AWSError>;
- /**
- * Retrieves multiple schemas by their identifiers.
- */
- batchGetSchema(callback?: (err: AWSError, data: CleanRooms.Types.BatchGetSchemaOutput) => void): Request<CleanRooms.Types.BatchGetSchemaOutput, AWSError>;
- /**
- * Retrieves multiple analysis rule schemas.
- */
- batchGetSchemaAnalysisRule(params: CleanRooms.Types.BatchGetSchemaAnalysisRuleInput, callback?: (err: AWSError, data: CleanRooms.Types.BatchGetSchemaAnalysisRuleOutput) => void): Request<CleanRooms.Types.BatchGetSchemaAnalysisRuleOutput, AWSError>;
- /**
- * Retrieves multiple analysis rule schemas.
- */
- batchGetSchemaAnalysisRule(callback?: (err: AWSError, data: CleanRooms.Types.BatchGetSchemaAnalysisRuleOutput) => void): Request<CleanRooms.Types.BatchGetSchemaAnalysisRuleOutput, AWSError>;
- /**
- * Creates a new analysis template.
- */
- createAnalysisTemplate(params: CleanRooms.Types.CreateAnalysisTemplateInput, callback?: (err: AWSError, data: CleanRooms.Types.CreateAnalysisTemplateOutput) => void): Request<CleanRooms.Types.CreateAnalysisTemplateOutput, AWSError>;
- /**
- * Creates a new analysis template.
- */
- createAnalysisTemplate(callback?: (err: AWSError, data: CleanRooms.Types.CreateAnalysisTemplateOutput) => void): Request<CleanRooms.Types.CreateAnalysisTemplateOutput, AWSError>;
- /**
- * Creates a new collaboration.
- */
- createCollaboration(params: CleanRooms.Types.CreateCollaborationInput, callback?: (err: AWSError, data: CleanRooms.Types.CreateCollaborationOutput) => void): Request<CleanRooms.Types.CreateCollaborationOutput, AWSError>;
- /**
- * Creates a new collaboration.
- */
- createCollaboration(callback?: (err: AWSError, data: CleanRooms.Types.CreateCollaborationOutput) => void): Request<CleanRooms.Types.CreateCollaborationOutput, AWSError>;
- /**
- * Provides the details necessary to create a configured audience model association.
- */
- createConfiguredAudienceModelAssociation(params: CleanRooms.Types.CreateConfiguredAudienceModelAssociationInput, callback?: (err: AWSError, data: CleanRooms.Types.CreateConfiguredAudienceModelAssociationOutput) => void): Request<CleanRooms.Types.CreateConfiguredAudienceModelAssociationOutput, AWSError>;
- /**
- * Provides the details necessary to create a configured audience model association.
- */
- createConfiguredAudienceModelAssociation(callback?: (err: AWSError, data: CleanRooms.Types.CreateConfiguredAudienceModelAssociationOutput) => void): Request<CleanRooms.Types.CreateConfiguredAudienceModelAssociationOutput, AWSError>;
- /**
- * Creates a new configured table resource.
- */
- createConfiguredTable(params: CleanRooms.Types.CreateConfiguredTableInput, callback?: (err: AWSError, data: CleanRooms.Types.CreateConfiguredTableOutput) => void): Request<CleanRooms.Types.CreateConfiguredTableOutput, AWSError>;
- /**
- * Creates a new configured table resource.
- */
- createConfiguredTable(callback?: (err: AWSError, data: CleanRooms.Types.CreateConfiguredTableOutput) => void): Request<CleanRooms.Types.CreateConfiguredTableOutput, AWSError>;
- /**
- * Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.
- */
- createConfiguredTableAnalysisRule(params: CleanRooms.Types.CreateConfiguredTableAnalysisRuleInput, callback?: (err: AWSError, data: CleanRooms.Types.CreateConfiguredTableAnalysisRuleOutput) => void): Request<CleanRooms.Types.CreateConfiguredTableAnalysisRuleOutput, AWSError>;
- /**
- * Creates a new analysis rule for a configured table. Currently, only one analysis rule can be created for a given configured table.
- */
- createConfiguredTableAnalysisRule(callback?: (err: AWSError, data: CleanRooms.Types.CreateConfiguredTableAnalysisRuleOutput) => void): Request<CleanRooms.Types.CreateConfiguredTableAnalysisRuleOutput, AWSError>;
- /**
- * Creates a configured table association. A configured table association links a configured table with a collaboration.
- */
- createConfiguredTableAssociation(params: CleanRooms.Types.CreateConfiguredTableAssociationInput, callback?: (err: AWSError, data: CleanRooms.Types.CreateConfiguredTableAssociationOutput) => void): Request<CleanRooms.Types.CreateConfiguredTableAssociationOutput, AWSError>;
- /**
- * Creates a configured table association. A configured table association links a configured table with a collaboration.
- */
- createConfiguredTableAssociation(callback?: (err: AWSError, data: CleanRooms.Types.CreateConfiguredTableAssociationOutput) => void): Request<CleanRooms.Types.CreateConfiguredTableAssociationOutput, AWSError>;
- /**
- * Creates a membership for a specific collaboration identifier and joins the collaboration.
- */
- createMembership(params: CleanRooms.Types.CreateMembershipInput, callback?: (err: AWSError, data: CleanRooms.Types.CreateMembershipOutput) => void): Request<CleanRooms.Types.CreateMembershipOutput, AWSError>;
- /**
- * Creates a membership for a specific collaboration identifier and joins the collaboration.
- */
- createMembership(callback?: (err: AWSError, data: CleanRooms.Types.CreateMembershipOutput) => void): Request<CleanRooms.Types.CreateMembershipOutput, AWSError>;
- /**
- * Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget template, but it can be deleted and recreated. If you need to change the privacy budget template for a membership, use the UpdatePrivacyBudgetTemplate operation.
- */
- createPrivacyBudgetTemplate(params: CleanRooms.Types.CreatePrivacyBudgetTemplateInput, callback?: (err: AWSError, data: CleanRooms.Types.CreatePrivacyBudgetTemplateOutput) => void): Request<CleanRooms.Types.CreatePrivacyBudgetTemplateOutput, AWSError>;
- /**
- * Creates a privacy budget template for a specified membership. Each membership can have only one privacy budget template, but it can be deleted and recreated. If you need to change the privacy budget template for a membership, use the UpdatePrivacyBudgetTemplate operation.
- */
- createPrivacyBudgetTemplate(callback?: (err: AWSError, data: CleanRooms.Types.CreatePrivacyBudgetTemplateOutput) => void): Request<CleanRooms.Types.CreatePrivacyBudgetTemplateOutput, AWSError>;
- /**
- * Deletes an analysis template.
- */
- deleteAnalysisTemplate(params: CleanRooms.Types.DeleteAnalysisTemplateInput, callback?: (err: AWSError, data: CleanRooms.Types.DeleteAnalysisTemplateOutput) => void): Request<CleanRooms.Types.DeleteAnalysisTemplateOutput, AWSError>;
- /**
- * Deletes an analysis template.
- */
- deleteAnalysisTemplate(callback?: (err: AWSError, data: CleanRooms.Types.DeleteAnalysisTemplateOutput) => void): Request<CleanRooms.Types.DeleteAnalysisTemplateOutput, AWSError>;
- /**
- * Deletes a collaboration. It can only be called by the collaboration owner.
- */
- deleteCollaboration(params: CleanRooms.Types.DeleteCollaborationInput, callback?: (err: AWSError, data: CleanRooms.Types.DeleteCollaborationOutput) => void): Request<CleanRooms.Types.DeleteCollaborationOutput, AWSError>;
- /**
- * Deletes a collaboration. It can only be called by the collaboration owner.
- */
- deleteCollaboration(callback?: (err: AWSError, data: CleanRooms.Types.DeleteCollaborationOutput) => void): Request<CleanRooms.Types.DeleteCollaborationOutput, AWSError>;
- /**
- * Provides the information necessary to delete a configured audience model association.
- */
- deleteConfiguredAudienceModelAssociation(params: CleanRooms.Types.DeleteConfiguredAudienceModelAssociationInput, callback?: (err: AWSError, data: CleanRooms.Types.DeleteConfiguredAudienceModelAssociationOutput) => void): Request<CleanRooms.Types.DeleteConfiguredAudienceModelAssociationOutput, AWSError>;
- /**
- * Provides the information necessary to delete a configured audience model association.
- */
- deleteConfiguredAudienceModelAssociation(callback?: (err: AWSError, data: CleanRooms.Types.DeleteConfiguredAudienceModelAssociationOutput) => void): Request<CleanRooms.Types.DeleteConfiguredAudienceModelAssociationOutput, AWSError>;
- /**
- * Deletes a configured table.
- */
- deleteConfiguredTable(params: CleanRooms.Types.DeleteConfiguredTableInput, callback?: (err: AWSError, data: CleanRooms.Types.DeleteConfiguredTableOutput) => void): Request<CleanRooms.Types.DeleteConfiguredTableOutput, AWSError>;
- /**
- * Deletes a configured table.
- */
- deleteConfiguredTable(callback?: (err: AWSError, data: CleanRooms.Types.DeleteConfiguredTableOutput) => void): Request<CleanRooms.Types.DeleteConfiguredTableOutput, AWSError>;
- /**
- * Deletes a configured table analysis rule.
- */
- deleteConfiguredTableAnalysisRule(params: CleanRooms.Types.DeleteConfiguredTableAnalysisRuleInput, callback?: (err: AWSError, data: CleanRooms.Types.DeleteConfiguredTableAnalysisRuleOutput) => void): Request<CleanRooms.Types.DeleteConfiguredTableAnalysisRuleOutput, AWSError>;
- /**
- * Deletes a configured table analysis rule.
- */
- deleteConfiguredTableAnalysisRule(callback?: (err: AWSError, data: CleanRooms.Types.DeleteConfiguredTableAnalysisRuleOutput) => void): Request<CleanRooms.Types.DeleteConfiguredTableAnalysisRuleOutput, AWSError>;
- /**
- * Deletes a configured table association.
- */
- deleteConfiguredTableAssociation(params: CleanRooms.Types.DeleteConfiguredTableAssociationInput, callback?: (err: AWSError, data: CleanRooms.Types.DeleteConfiguredTableAssociationOutput) => void): Request<CleanRooms.Types.DeleteConfiguredTableAssociationOutput, AWSError>;
- /**
- * Deletes a configured table association.
- */
- deleteConfiguredTableAssociation(callback?: (err: AWSError, data: CleanRooms.Types.DeleteConfiguredTableAssociationOutput) => void): Request<CleanRooms.Types.DeleteConfiguredTableAssociationOutput, AWSError>;
- /**
- * Removes the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.
- */
- deleteMember(params: CleanRooms.Types.DeleteMemberInput, callback?: (err: AWSError, data: CleanRooms.Types.DeleteMemberOutput) => void): Request<CleanRooms.Types.DeleteMemberOutput, AWSError>;
- /**
- * Removes the specified member from a collaboration. The removed member is placed in the Removed status and can't interact with the collaboration. The removed member's data is inaccessible to active members of the collaboration.
- */
- deleteMember(callback?: (err: AWSError, data: CleanRooms.Types.DeleteMemberOutput) => void): Request<CleanRooms.Types.DeleteMemberOutput, AWSError>;
- /**
- * Deletes a specified membership. All resources under a membership must be deleted.
- */
- deleteMembership(params: CleanRooms.Types.DeleteMembershipInput, callback?: (err: AWSError, data: CleanRooms.Types.DeleteMembershipOutput) => void): Request<CleanRooms.Types.DeleteMembershipOutput, AWSError>;
- /**
- * Deletes a specified membership. All resources under a membership must be deleted.
- */
- deleteMembership(callback?: (err: AWSError, data: CleanRooms.Types.DeleteMembershipOutput) => void): Request<CleanRooms.Types.DeleteMembershipOutput, AWSError>;
- /**
- * Deletes a privacy budget template for a specified membership.
- */
- deletePrivacyBudgetTemplate(params: CleanRooms.Types.DeletePrivacyBudgetTemplateInput, callback?: (err: AWSError, data: CleanRooms.Types.DeletePrivacyBudgetTemplateOutput) => void): Request<CleanRooms.Types.DeletePrivacyBudgetTemplateOutput, AWSError>;
- /**
- * Deletes a privacy budget template for a specified membership.
- */
- deletePrivacyBudgetTemplate(callback?: (err: AWSError, data: CleanRooms.Types.DeletePrivacyBudgetTemplateOutput) => void): Request<CleanRooms.Types.DeletePrivacyBudgetTemplateOutput, AWSError>;
- /**
- * Retrieves an analysis template.
- */
- getAnalysisTemplate(params: CleanRooms.Types.GetAnalysisTemplateInput, callback?: (err: AWSError, data: CleanRooms.Types.GetAnalysisTemplateOutput) => void): Request<CleanRooms.Types.GetAnalysisTemplateOutput, AWSError>;
- /**
- * Retrieves an analysis template.
- */
- getAnalysisTemplate(callback?: (err: AWSError, data: CleanRooms.Types.GetAnalysisTemplateOutput) => void): Request<CleanRooms.Types.GetAnalysisTemplateOutput, AWSError>;
- /**
- * Returns metadata about a collaboration.
- */
- getCollaboration(params: CleanRooms.Types.GetCollaborationInput, callback?: (err: AWSError, data: CleanRooms.Types.GetCollaborationOutput) => void): Request<CleanRooms.Types.GetCollaborationOutput, AWSError>;
- /**
- * Returns metadata about a collaboration.
- */
- getCollaboration(callback?: (err: AWSError, data: CleanRooms.Types.GetCollaborationOutput) => void): Request<CleanRooms.Types.GetCollaborationOutput, AWSError>;
- /**
- * Retrieves an analysis template within a collaboration.
- */
- getCollaborationAnalysisTemplate(params: CleanRooms.Types.GetCollaborationAnalysisTemplateInput, callback?: (err: AWSError, data: CleanRooms.Types.GetCollaborationAnalysisTemplateOutput) => void): Request<CleanRooms.Types.GetCollaborationAnalysisTemplateOutput, AWSError>;
- /**
- * Retrieves an analysis template within a collaboration.
- */
- getCollaborationAnalysisTemplate(callback?: (err: AWSError, data: CleanRooms.Types.GetCollaborationAnalysisTemplateOutput) => void): Request<CleanRooms.Types.GetCollaborationAnalysisTemplateOutput, AWSError>;
- /**
- * Retrieves a configured audience model association within a collaboration.
- */
- getCollaborationConfiguredAudienceModelAssociation(params: CleanRooms.Types.GetCollaborationConfiguredAudienceModelAssociationInput, callback?: (err: AWSError, data: CleanRooms.Types.GetCollaborationConfiguredAudienceModelAssociationOutput) => void): Request<CleanRooms.Types.GetCollaborationConfiguredAudienceModelAssociationOutput, AWSError>;
- /**
- * Retrieves a configured audience model association within a collaboration.
- */
- getCollaborationConfiguredAudienceModelAssociation(callback?: (err: AWSError, data: CleanRooms.Types.GetCollaborationConfiguredAudienceModelAssociationOutput) => void): Request<CleanRooms.Types.GetCollaborationConfiguredAudienceModelAssociationOutput, AWSError>;
- /**
- * Returns details about a specified privacy budget template.
- */
- getCollaborationPrivacyBudgetTemplate(params: CleanRooms.Types.GetCollaborationPrivacyBudgetTemplateInput, callback?: (err: AWSError, data: CleanRooms.Types.GetCollaborationPrivacyBudgetTemplateOutput) => void): Request<CleanRooms.Types.GetCollaborationPrivacyBudgetTemplateOutput, AWSError>;
- /**
- * Returns details about a specified privacy budget template.
- */
- getCollaborationPrivacyBudgetTemplate(callback?: (err: AWSError, data: CleanRooms.Types.GetCollaborationPrivacyBudgetTemplateOutput) => void): Request<CleanRooms.Types.GetCollaborationPrivacyBudgetTemplateOutput, AWSError>;
- /**
- * Returns information about a configured audience model association.
- */
- getConfiguredAudienceModelAssociation(params: CleanRooms.Types.GetConfiguredAudienceModelAssociationInput, callback?: (err: AWSError, data: CleanRooms.Types.GetConfiguredAudienceModelAssociationOutput) => void): Request<CleanRooms.Types.GetConfiguredAudienceModelAssociationOutput, AWSError>;
- /**
- * Returns information about a configured audience model association.
- */
- getConfiguredAudienceModelAssociation(callback?: (err: AWSError, data: CleanRooms.Types.GetConfiguredAudienceModelAssociationOutput) => void): Request<CleanRooms.Types.GetConfiguredAudienceModelAssociationOutput, AWSError>;
- /**
- * Retrieves a configured table.
- */
- getConfiguredTable(params: CleanRooms.Types.GetConfiguredTableInput, callback?: (err: AWSError, data: CleanRooms.Types.GetConfiguredTableOutput) => void): Request<CleanRooms.Types.GetConfiguredTableOutput, AWSError>;
- /**
- * Retrieves a configured table.
- */
- getConfiguredTable(callback?: (err: AWSError, data: CleanRooms.Types.GetConfiguredTableOutput) => void): Request<CleanRooms.Types.GetConfiguredTableOutput, AWSError>;
- /**
- * Retrieves a configured table analysis rule.
- */
- getConfiguredTableAnalysisRule(params: CleanRooms.Types.GetConfiguredTableAnalysisRuleInput, callback?: (err: AWSError, data: CleanRooms.Types.GetConfiguredTableAnalysisRuleOutput) => void): Request<CleanRooms.Types.GetConfiguredTableAnalysisRuleOutput, AWSError>;
- /**
- * Retrieves a configured table analysis rule.
- */
- getConfiguredTableAnalysisRule(callback?: (err: AWSError, data: CleanRooms.Types.GetConfiguredTableAnalysisRuleOutput) => void): Request<CleanRooms.Types.GetConfiguredTableAnalysisRuleOutput, AWSError>;
- /**
- * Retrieves a configured table association.
- */
- getConfiguredTableAssociation(params: CleanRooms.Types.GetConfiguredTableAssociationInput, callback?: (err: AWSError, data: CleanRooms.Types.GetConfiguredTableAssociationOutput) => void): Request<CleanRooms.Types.GetConfiguredTableAssociationOutput, AWSError>;
- /**
- * Retrieves a configured table association.
- */
- getConfiguredTableAssociation(callback?: (err: AWSError, data: CleanRooms.Types.GetConfiguredTableAssociationOutput) => void): Request<CleanRooms.Types.GetConfiguredTableAssociationOutput, AWSError>;
- /**
- * Retrieves a specified membership for an identifier.
- */
- getMembership(params: CleanRooms.Types.GetMembershipInput, callback?: (err: AWSError, data: CleanRooms.Types.GetMembershipOutput) => void): Request<CleanRooms.Types.GetMembershipOutput, AWSError>;
- /**
- * Retrieves a specified membership for an identifier.
- */
- getMembership(callback?: (err: AWSError, data: CleanRooms.Types.GetMembershipOutput) => void): Request<CleanRooms.Types.GetMembershipOutput, AWSError>;
- /**
- * Returns details for a specified privacy budget template.
- */
- getPrivacyBudgetTemplate(params: CleanRooms.Types.GetPrivacyBudgetTemplateInput, callback?: (err: AWSError, data: CleanRooms.Types.GetPrivacyBudgetTemplateOutput) => void): Request<CleanRooms.Types.GetPrivacyBudgetTemplateOutput, AWSError>;
- /**
- * Returns details for a specified privacy budget template.
- */
- getPrivacyBudgetTemplate(callback?: (err: AWSError, data: CleanRooms.Types.GetPrivacyBudgetTemplateOutput) => void): Request<CleanRooms.Types.GetPrivacyBudgetTemplateOutput, AWSError>;
- /**
- * Returns query processing metadata.
- */
- getProtectedQuery(params: CleanRooms.Types.GetProtectedQueryInput, callback?: (err: AWSError, data: CleanRooms.Types.GetProtectedQueryOutput) => void): Request<CleanRooms.Types.GetProtectedQueryOutput, AWSError>;
- /**
- * Returns query processing metadata.
- */
- getProtectedQuery(callback?: (err: AWSError, data: CleanRooms.Types.GetProtectedQueryOutput) => void): Request<CleanRooms.Types.GetProtectedQueryOutput, AWSError>;
- /**
- * Retrieves the schema for a relation within a collaboration.
- */
- getSchema(params: CleanRooms.Types.GetSchemaInput, callback?: (err: AWSError, data: CleanRooms.Types.GetSchemaOutput) => void): Request<CleanRooms.Types.GetSchemaOutput, AWSError>;
- /**
- * Retrieves the schema for a relation within a collaboration.
- */
- getSchema(callback?: (err: AWSError, data: CleanRooms.Types.GetSchemaOutput) => void): Request<CleanRooms.Types.GetSchemaOutput, AWSError>;
- /**
- * Retrieves a schema analysis rule.
- */
- getSchemaAnalysisRule(params: CleanRooms.Types.GetSchemaAnalysisRuleInput, callback?: (err: AWSError, data: CleanRooms.Types.GetSchemaAnalysisRuleOutput) => void): Request<CleanRooms.Types.GetSchemaAnalysisRuleOutput, AWSError>;
- /**
- * Retrieves a schema analysis rule.
- */
- getSchemaAnalysisRule(callback?: (err: AWSError, data: CleanRooms.Types.GetSchemaAnalysisRuleOutput) => void): Request<CleanRooms.Types.GetSchemaAnalysisRuleOutput, AWSError>;
- /**
- * Lists analysis templates that the caller owns.
- */
- listAnalysisTemplates(params: CleanRooms.Types.ListAnalysisTemplatesInput, callback?: (err: AWSError, data: CleanRooms.Types.ListAnalysisTemplatesOutput) => void): Request<CleanRooms.Types.ListAnalysisTemplatesOutput, AWSError>;
- /**
- * Lists analysis templates that the caller owns.
- */
- listAnalysisTemplates(callback?: (err: AWSError, data: CleanRooms.Types.ListAnalysisTemplatesOutput) => void): Request<CleanRooms.Types.ListAnalysisTemplatesOutput, AWSError>;
- /**
- * Lists analysis templates within a collaboration.
- */
- listCollaborationAnalysisTemplates(params: CleanRooms.Types.ListCollaborationAnalysisTemplatesInput, callback?: (err: AWSError, data: CleanRooms.Types.ListCollaborationAnalysisTemplatesOutput) => void): Request<CleanRooms.Types.ListCollaborationAnalysisTemplatesOutput, AWSError>;
- /**
- * Lists analysis templates within a collaboration.
- */
- listCollaborationAnalysisTemplates(callback?: (err: AWSError, data: CleanRooms.Types.ListCollaborationAnalysisTemplatesOutput) => void): Request<CleanRooms.Types.ListCollaborationAnalysisTemplatesOutput, AWSError>;
- /**
- * Lists configured audience model associations within a collaboration.
- */
- listCollaborationConfiguredAudienceModelAssociations(params: CleanRooms.Types.ListCollaborationConfiguredAudienceModelAssociationsInput, callback?: (err: AWSError, data: CleanRooms.Types.ListCollaborationConfiguredAudienceModelAssociationsOutput) => void): Request<CleanRooms.Types.ListCollaborationConfiguredAudienceModelAssociationsOutput, AWSError>;
- /**
- * Lists configured audience model associations within a collaboration.
- */
- listCollaborationConfiguredAudienceModelAssociations(callback?: (err: AWSError, data: CleanRooms.Types.ListCollaborationConfiguredAudienceModelAssociationsOutput) => void): Request<CleanRooms.Types.ListCollaborationConfiguredAudienceModelAssociationsOutput, AWSError>;
- /**
- * Returns an array that summarizes each privacy budget template in a specified collaboration.
- */
- listCollaborationPrivacyBudgetTemplates(params: CleanRooms.Types.ListCollaborationPrivacyBudgetTemplatesInput, callback?: (err: AWSError, data: CleanRooms.Types.ListCollaborationPrivacyBudgetTemplatesOutput) => void): Request<CleanRooms.Types.ListCollaborationPrivacyBudgetTemplatesOutput, AWSError>;
- /**
- * Returns an array that summarizes each privacy budget template in a specified collaboration.
- */
- listCollaborationPrivacyBudgetTemplates(callback?: (err: AWSError, data: CleanRooms.Types.ListCollaborationPrivacyBudgetTemplatesOutput) => void): Request<CleanRooms.Types.ListCollaborationPrivacyBudgetTemplatesOutput, AWSError>;
- /**
- * Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.
- */
- listCollaborationPrivacyBudgets(params: CleanRooms.Types.ListCollaborationPrivacyBudgetsInput, callback?: (err: AWSError, data: CleanRooms.Types.ListCollaborationPrivacyBudgetsOutput) => void): Request<CleanRooms.Types.ListCollaborationPrivacyBudgetsOutput, AWSError>;
- /**
- * Returns an array that summarizes each privacy budget in a specified collaboration. The summary includes the collaboration ARN, creation time, creating account, and privacy budget details.
- */
- listCollaborationPrivacyBudgets(callback?: (err: AWSError, data: CleanRooms.Types.ListCollaborationPrivacyBudgetsOutput) => void): Request<CleanRooms.Types.ListCollaborationPrivacyBudgetsOutput, AWSError>;
- /**
- * Lists collaborations the caller owns, is active in, or has been invited to.
- */
- listCollaborations(params: CleanRooms.Types.ListCollaborationsInput, callback?: (err: AWSError, data: CleanRooms.Types.ListCollaborationsOutput) => void): Request<CleanRooms.Types.ListCollaborationsOutput, AWSError>;
- /**
- * Lists collaborations the caller owns, is active in, or has been invited to.
- */
- listCollaborations(callback?: (err: AWSError, data: CleanRooms.Types.ListCollaborationsOutput) => void): Request<CleanRooms.Types.ListCollaborationsOutput, AWSError>;
- /**
- * Lists information about requested configured audience model associations.
- */
- listConfiguredAudienceModelAssociations(params: CleanRooms.Types.ListConfiguredAudienceModelAssociationsInput, callback?: (err: AWSError, data: CleanRooms.Types.ListConfiguredAudienceModelAssociationsOutput) => void): Request<CleanRooms.Types.ListConfiguredAudienceModelAssociationsOutput, AWSError>;
- /**
- * Lists information about requested configured audience model associations.
- */
- listConfiguredAudienceModelAssociations(callback?: (err: AWSError, data: CleanRooms.Types.ListConfiguredAudienceModelAssociationsOutput) => void): Request<CleanRooms.Types.ListConfiguredAudienceModelAssociationsOutput, AWSError>;
- /**
- * Lists configured table associations for a membership.
- */
- listConfiguredTableAssociations(params: CleanRooms.Types.ListConfiguredTableAssociationsInput, callback?: (err: AWSError, data: CleanRooms.Types.ListConfiguredTableAssociationsOutput) => void): Request<CleanRooms.Types.ListConfiguredTableAssociationsOutput, AWSError>;
- /**
- * Lists configured table associations for a membership.
- */
- listConfiguredTableAssociations(callback?: (err: AWSError, data: CleanRooms.Types.ListConfiguredTableAssociationsOutput) => void): Request<CleanRooms.Types.ListConfiguredTableAssociationsOutput, AWSError>;
- /**
- * Lists configured tables.
- */
- listConfiguredTables(params: CleanRooms.Types.ListConfiguredTablesInput, callback?: (err: AWSError, data: CleanRooms.Types.ListConfiguredTablesOutput) => void): Request<CleanRooms.Types.ListConfiguredTablesOutput, AWSError>;
- /**
- * Lists configured tables.
- */
- listConfiguredTables(callback?: (err: AWSError, data: CleanRooms.Types.ListConfiguredTablesOutput) => void): Request<CleanRooms.Types.ListConfiguredTablesOutput, AWSError>;
- /**
- * Lists all members within a collaboration.
- */
- listMembers(params: CleanRooms.Types.ListMembersInput, callback?: (err: AWSError, data: CleanRooms.Types.ListMembersOutput) => void): Request<CleanRooms.Types.ListMembersOutput, AWSError>;
- /**
- * Lists all members within a collaboration.
- */
- listMembers(callback?: (err: AWSError, data: CleanRooms.Types.ListMembersOutput) => void): Request<CleanRooms.Types.ListMembersOutput, AWSError>;
- /**
- * Lists all memberships resources within the caller's account.
- */
- listMemberships(params: CleanRooms.Types.ListMembershipsInput, callback?: (err: AWSError, data: CleanRooms.Types.ListMembershipsOutput) => void): Request<CleanRooms.Types.ListMembershipsOutput, AWSError>;
- /**
- * Lists all memberships resources within the caller's account.
- */
- listMemberships(callback?: (err: AWSError, data: CleanRooms.Types.ListMembershipsOutput) => void): Request<CleanRooms.Types.ListMembershipsOutput, AWSError>;
- /**
- * Returns detailed information about the privacy budget templates in a specified membership.
- */
- listPrivacyBudgetTemplates(params: CleanRooms.Types.ListPrivacyBudgetTemplatesInput, callback?: (err: AWSError, data: CleanRooms.Types.ListPrivacyBudgetTemplatesOutput) => void): Request<CleanRooms.Types.ListPrivacyBudgetTemplatesOutput, AWSError>;
- /**
- * Returns detailed information about the privacy budget templates in a specified membership.
- */
- listPrivacyBudgetTemplates(callback?: (err: AWSError, data: CleanRooms.Types.ListPrivacyBudgetTemplatesOutput) => void): Request<CleanRooms.Types.ListPrivacyBudgetTemplatesOutput, AWSError>;
- /**
- * Returns detailed information about the privacy budgets in a specified membership.
- */
- listPrivacyBudgets(params: CleanRooms.Types.ListPrivacyBudgetsInput, callback?: (err: AWSError, data: CleanRooms.Types.ListPrivacyBudgetsOutput) => void): Request<CleanRooms.Types.ListPrivacyBudgetsOutput, AWSError>;
- /**
- * Returns detailed information about the privacy budgets in a specified membership.
- */
- listPrivacyBudgets(callback?: (err: AWSError, data: CleanRooms.Types.ListPrivacyBudgetsOutput) => void): Request<CleanRooms.Types.ListPrivacyBudgetsOutput, AWSError>;
- /**
- * Lists protected queries, sorted by the most recent query.
- */
- listProtectedQueries(params: CleanRooms.Types.ListProtectedQueriesInput, callback?: (err: AWSError, data: CleanRooms.Types.ListProtectedQueriesOutput) => void): Request<CleanRooms.Types.ListProtectedQueriesOutput, AWSError>;
- /**
- * Lists protected queries, sorted by the most recent query.
- */
- listProtectedQueries(callback?: (err: AWSError, data: CleanRooms.Types.ListProtectedQueriesOutput) => void): Request<CleanRooms.Types.ListProtectedQueriesOutput, AWSError>;
- /**
- * Lists the schemas for relations within a collaboration.
- */
- listSchemas(params: CleanRooms.Types.ListSchemasInput, callback?: (err: AWSError, data: CleanRooms.Types.ListSchemasOutput) => void): Request<CleanRooms.Types.ListSchemasOutput, AWSError>;
- /**
- * Lists the schemas for relations within a collaboration.
- */
- listSchemas(callback?: (err: AWSError, data: CleanRooms.Types.ListSchemasOutput) => void): Request<CleanRooms.Types.ListSchemasOutput, AWSError>;
- /**
- * Lists all of the tags that have been added to a resource.
- */
- listTagsForResource(params: CleanRooms.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: CleanRooms.Types.ListTagsForResourceOutput) => void): Request<CleanRooms.Types.ListTagsForResourceOutput, AWSError>;
- /**
- * Lists all of the tags that have been added to a resource.
- */
- listTagsForResource(callback?: (err: AWSError, data: CleanRooms.Types.ListTagsForResourceOutput) => void): Request<CleanRooms.Types.ListTagsForResourceOutput, AWSError>;
- /**
- * An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.
- */
- previewPrivacyImpact(params: CleanRooms.Types.PreviewPrivacyImpactInput, callback?: (err: AWSError, data: CleanRooms.Types.PreviewPrivacyImpactOutput) => void): Request<CleanRooms.Types.PreviewPrivacyImpactOutput, AWSError>;
- /**
- * An estimate of the number of aggregation functions that the member who can query can run given epsilon and noise parameters.
- */
- previewPrivacyImpact(callback?: (err: AWSError, data: CleanRooms.Types.PreviewPrivacyImpactOutput) => void): Request<CleanRooms.Types.PreviewPrivacyImpactOutput, AWSError>;
- /**
- * Creates a protected query that is started by Clean Rooms.
- */
- startProtectedQuery(params: CleanRooms.Types.StartProtectedQueryInput, callback?: (err: AWSError, data: CleanRooms.Types.StartProtectedQueryOutput) => void): Request<CleanRooms.Types.StartProtectedQueryOutput, AWSError>;
- /**
- * Creates a protected query that is started by Clean Rooms.
- */
- startProtectedQuery(callback?: (err: AWSError, data: CleanRooms.Types.StartProtectedQueryOutput) => void): Request<CleanRooms.Types.StartProtectedQueryOutput, AWSError>;
- /**
- * Tags a resource.
- */
- tagResource(params: CleanRooms.Types.TagResourceInput, callback?: (err: AWSError, data: CleanRooms.Types.TagResourceOutput) => void): Request<CleanRooms.Types.TagResourceOutput, AWSError>;
- /**
- * Tags a resource.
- */
- tagResource(callback?: (err: AWSError, data: CleanRooms.Types.TagResourceOutput) => void): Request<CleanRooms.Types.TagResourceOutput, AWSError>;
- /**
- * Removes a tag or list of tags from a resource.
- */
- untagResource(params: CleanRooms.Types.UntagResourceInput, callback?: (err: AWSError, data: CleanRooms.Types.UntagResourceOutput) => void): Request<CleanRooms.Types.UntagResourceOutput, AWSError>;
- /**
- * Removes a tag or list of tags from a resource.
- */
- untagResource(callback?: (err: AWSError, data: CleanRooms.Types.UntagResourceOutput) => void): Request<CleanRooms.Types.UntagResourceOutput, AWSError>;
- /**
- * Updates the analysis template metadata.
- */
- updateAnalysisTemplate(params: CleanRooms.Types.UpdateAnalysisTemplateInput, callback?: (err: AWSError, data: CleanRooms.Types.UpdateAnalysisTemplateOutput) => void): Request<CleanRooms.Types.UpdateAnalysisTemplateOutput, AWSError>;
- /**
- * Updates the analysis template metadata.
- */
- updateAnalysisTemplate(callback?: (err: AWSError, data: CleanRooms.Types.UpdateAnalysisTemplateOutput) => void): Request<CleanRooms.Types.UpdateAnalysisTemplateOutput, AWSError>;
- /**
- * Updates collaboration metadata and can only be called by the collaboration owner.
- */
- updateCollaboration(params: CleanRooms.Types.UpdateCollaborationInput, callback?: (err: AWSError, data: CleanRooms.Types.UpdateCollaborationOutput) => void): Request<CleanRooms.Types.UpdateCollaborationOutput, AWSError>;
- /**
- * Updates collaboration metadata and can only be called by the collaboration owner.
- */
- updateCollaboration(callback?: (err: AWSError, data: CleanRooms.Types.UpdateCollaborationOutput) => void): Request<CleanRooms.Types.UpdateCollaborationOutput, AWSError>;
- /**
- * Provides the details necessary to update a configured audience model association.
- */
- updateConfiguredAudienceModelAssociation(params: CleanRooms.Types.UpdateConfiguredAudienceModelAssociationInput, callback?: (err: AWSError, data: CleanRooms.Types.UpdateConfiguredAudienceModelAssociationOutput) => void): Request<CleanRooms.Types.UpdateConfiguredAudienceModelAssociationOutput, AWSError>;
- /**
- * Provides the details necessary to update a configured audience model association.
- */
- updateConfiguredAudienceModelAssociation(callback?: (err: AWSError, data: CleanRooms.Types.UpdateConfiguredAudienceModelAssociationOutput) => void): Request<CleanRooms.Types.UpdateConfiguredAudienceModelAssociationOutput, AWSError>;
- /**
- * Updates a configured table.
- */
- updateConfiguredTable(params: CleanRooms.Types.UpdateConfiguredTableInput, callback?: (err: AWSError, data: CleanRooms.Types.UpdateConfiguredTableOutput) => void): Request<CleanRooms.Types.UpdateConfiguredTableOutput, AWSError>;
- /**
- * Updates a configured table.
- */
- updateConfiguredTable(callback?: (err: AWSError, data: CleanRooms.Types.UpdateConfiguredTableOutput) => void): Request<CleanRooms.Types.UpdateConfiguredTableOutput, AWSError>;
- /**
- * Updates a configured table analysis rule.
- */
- updateConfiguredTableAnalysisRule(params: CleanRooms.Types.UpdateConfiguredTableAnalysisRuleInput, callback?: (err: AWSError, data: CleanRooms.Types.UpdateConfiguredTableAnalysisRuleOutput) => void): Request<CleanRooms.Types.UpdateConfiguredTableAnalysisRuleOutput, AWSError>;
- /**
- * Updates a configured table analysis rule.
- */
- updateConfiguredTableAnalysisRule(callback?: (err: AWSError, data: CleanRooms.Types.UpdateConfiguredTableAnalysisRuleOutput) => void): Request<CleanRooms.Types.UpdateConfiguredTableAnalysisRuleOutput, AWSError>;
- /**
- * Updates a configured table association.
- */
- updateConfiguredTableAssociation(params: CleanRooms.Types.UpdateConfiguredTableAssociationInput, callback?: (err: AWSError, data: CleanRooms.Types.UpdateConfiguredTableAssociationOutput) => void): Request<CleanRooms.Types.UpdateConfiguredTableAssociationOutput, AWSError>;
- /**
- * Updates a configured table association.
- */
- updateConfiguredTableAssociation(callback?: (err: AWSError, data: CleanRooms.Types.UpdateConfiguredTableAssociationOutput) => void): Request<CleanRooms.Types.UpdateConfiguredTableAssociationOutput, AWSError>;
- /**
- * Updates a membership.
- */
- updateMembership(params: CleanRooms.Types.UpdateMembershipInput, callback?: (err: AWSError, data: CleanRooms.Types.UpdateMembershipOutput) => void): Request<CleanRooms.Types.UpdateMembershipOutput, AWSError>;
- /**
- * Updates a membership.
- */
- updateMembership(callback?: (err: AWSError, data: CleanRooms.Types.UpdateMembershipOutput) => void): Request<CleanRooms.Types.UpdateMembershipOutput, AWSError>;
- /**
- * Updates the privacy budget template for the specified membership.
- */
- updatePrivacyBudgetTemplate(params: CleanRooms.Types.UpdatePrivacyBudgetTemplateInput, callback?: (err: AWSError, data: CleanRooms.Types.UpdatePrivacyBudgetTemplateOutput) => void): Request<CleanRooms.Types.UpdatePrivacyBudgetTemplateOutput, AWSError>;
- /**
- * Updates the privacy budget template for the specified membership.
- */
- updatePrivacyBudgetTemplate(callback?: (err: AWSError, data: CleanRooms.Types.UpdatePrivacyBudgetTemplateOutput) => void): Request<CleanRooms.Types.UpdatePrivacyBudgetTemplateOutput, AWSError>;
- /**
- * Updates the processing of a currently running query.
- */
- updateProtectedQuery(params: CleanRooms.Types.UpdateProtectedQueryInput, callback?: (err: AWSError, data: CleanRooms.Types.UpdateProtectedQueryOutput) => void): Request<CleanRooms.Types.UpdateProtectedQueryOutput, AWSError>;
- /**
- * Updates the processing of a currently running query.
- */
- updateProtectedQuery(callback?: (err: AWSError, data: CleanRooms.Types.UpdateProtectedQueryOutput) => void): Request<CleanRooms.Types.UpdateProtectedQueryOutput, AWSError>;
- }
- declare namespace CleanRooms {
- export type AccountId = string;
- export interface AggregateColumn {
- /**
- * Column names in configured table of aggregate columns.
- */
- columnNames: AggregateColumnColumnNamesList;
- /**
- * Aggregation function that can be applied to aggregate column in query.
- */
- function: AggregateFunctionName;
- }
- export type AggregateColumnColumnNamesList = AnalysisRuleColumnName[];
- export type AggregateFunctionName = "SUM"|"SUM_DISTINCT"|"COUNT"|"COUNT_DISTINCT"|"AVG"|string;
- export interface AggregationConstraint {
- /**
- * Column in aggregation constraint for which there must be a minimum number of distinct values in an output row for it to be in the query output.
- */
- columnName: AnalysisRuleColumnName;
- /**
- * The minimum number of distinct values that an output row must be an aggregation of. Minimum threshold of distinct values for a specified column that must exist in an output row for it to be in the query output.
- */
- minimum: AggregationConstraintMinimumInteger;
- /**
- * The type of aggregation the constraint allows. The only valid value is currently `COUNT_DISTINCT`.
- */
- type: AggregationType;
- }
- export type AggregationConstraintMinimumInteger = number;
- export type AggregationConstraints = AggregationConstraint[];
- export type AggregationType = "COUNT_DISTINCT"|string;
- export type AllowedColumnList = ColumnName[];
- export type AnalysisFormat = "SQL"|string;
- export type AnalysisMethod = "DIRECT_QUERY"|string;
- export interface AnalysisParameter {
- /**
- * The name of the parameter. The name must use only alphanumeric, underscore (_), or hyphen (-) characters but cannot start or end with a hyphen.
- */
- name: ParameterName;
- /**
- * The type of parameter.
- */
- type: ParameterType;
- /**
- * Optional. The default value that is applied in the analysis template. The member who can query can override this value in the query editor.
- */
- defaultValue?: ParameterValue;
- }
- export type AnalysisParameterList = AnalysisParameter[];
- export interface AnalysisRule {
- /**
- * The unique ID for the associated collaboration.
- */
- collaborationId: CollaborationIdentifier;
- /**
- * The type of analysis rule.
- */
- type: AnalysisRuleType;
- /**
- * The name for the analysis rule.
- */
- name: TableAlias;
- /**
- * The time the analysis rule was created.
- */
- createTime: Timestamp;
- /**
- * The time the analysis rule was last updated.
- */
- updateTime: Timestamp;
- /**
- * A policy that describes the associated data usage limitations.
- */
- policy: AnalysisRulePolicy;
- }
- export interface AnalysisRuleAggregation {
- /**
- * The columns that query runners are allowed to use in aggregation queries.
- */
- aggregateColumns: AnalysisRuleAggregationAggregateColumnsList;
- /**
- * Columns in configured table that can be used in join statements and/or as aggregate columns. They can never be outputted directly.
- */
- joinColumns: AnalysisRuleColumnList;
- /**
- * Control that requires member who runs query to do a join with their configured table and/or other configured table in query.
- */
- joinRequired?: JoinRequiredOption;
- /**
- * Which logical operators (if any) are to be used in an INNER JOIN match condition. Default is AND.
- */
- allowedJoinOperators?: JoinOperatorsList;
- /**
- * The columns that query runners are allowed to select, group by, or filter by.
- */
- dimensionColumns: AnalysisRuleColumnList;
- /**
- * Set of scalar functions that are allowed to be used on dimension columns and the output of aggregation of metrics.
- */
- scalarFunctions: ScalarFunctionsList;
- /**
- * Columns that must meet a specific threshold value (after an aggregation function is applied to it) for each output row to be returned.
- */
- outputConstraints: AggregationConstraints;
- }
- export type AnalysisRuleAggregationAggregateColumnsList = AggregateColumn[];
- export type AnalysisRuleColumnList = AnalysisRuleColumnName[];
- export type AnalysisRuleColumnName = string;
- export interface AnalysisRuleCustom {
- /**
- * The ARN of the analysis templates that are allowed by the custom analysis rule.
- */
- allowedAnalyses: AnalysisRuleCustomAllowedAnalysesList;
- /**
- * The IDs of the Amazon Web Services accounts that are allowed to query by the custom analysis rule. Required when allowedAnalyses is ANY_QUERY.
- */
- allowedAnalysisProviders?: AnalysisRuleCustomAllowedAnalysisProvidersList;
- /**
- * The differential privacy configuration.
- */
- differentialPrivacy?: DifferentialPrivacyConfiguration;
- }
- export type AnalysisRuleCustomAllowedAnalysesList = AnalysisTemplateArnOrQueryWildcard[];
- export type AnalysisRuleCustomAllowedAnalysisProvidersList = AccountId[];
- export interface AnalysisRuleList {
- /**
- * Columns that can be used to join a configured table with the table of the member who can query and other members' configured tables.
- */
- joinColumns: AnalysisRuleListJoinColumnsList;
- /**
- * The logical operators (if any) that are to be used in an INNER JOIN match condition. Default is AND.
- */
- allowedJoinOperators?: JoinOperatorsList;
- /**
- * Columns that can be listed in the output.
- */
- listColumns: AnalysisRuleColumnList;
- }
- export type AnalysisRuleListJoinColumnsList = AnalysisRuleColumnName[];
- export interface AnalysisRulePolicy {
- /**
- * Controls on the query specifications that can be run on configured table.
- */
- v1?: AnalysisRulePolicyV1;
- }
- export interface AnalysisRulePolicyV1 {
- /**
- * Analysis rule type that enables only list queries on a configured table.
- */
- list?: AnalysisRuleList;
- /**
- * Analysis rule type that enables only aggregation queries on a configured table.
- */
- aggregation?: AnalysisRuleAggregation;
- /**
- * Analysis rule type that enables custom SQL queries on a configured table.
- */
- custom?: AnalysisRuleCustom;
- }
- export type AnalysisRuleType = "AGGREGATION"|"LIST"|"CUSTOM"|string;
- export type AnalysisRuleTypeList = AnalysisRuleType[];
- export interface AnalysisSchema {
- /**
- * The tables referenced in the analysis schema.
- */
- referencedTables?: QueryTables;
- }
- export interface AnalysisSource {
- /**
- * The query text.
- */
- text?: AnalysisTemplateText;
- }
- export interface AnalysisTemplate {
- /**
- * The identifier for the analysis template.
- */
- id: AnalysisTemplateIdentifier;
- /**
- * The Amazon Resource Name (ARN) of the analysis template.
- */
- arn: AnalysisTemplateArn;
- /**
- * The unique ID for the associated collaboration of the analysis template.
- */
- collaborationId: UUID;
- /**
- * The unique ARN for the analysis template’s associated collaboration.
- */
- collaborationArn: CollaborationArn;
- /**
- * The identifier of a member who created the analysis template.
- */
- membershipId: UUID;
- /**
- * The Amazon Resource Name (ARN) of the member who created the analysis template.
- */
- membershipArn: MembershipArn;
- /**
- * The description of the analysis template.
- */
- description?: ResourceDescription;
- /**
- * The name of the analysis template.
- */
- name: ResourceAlias;
- /**
- * The time that the analysis template was created.
- */
- createTime: Timestamp;
- /**
- * The time that the analysis template was last updated.
- */
- updateTime: Timestamp;
- /**
- * The entire schema object.
- */
- schema: AnalysisSchema;
- /**
- * The format of the analysis template.
- */
- format: AnalysisFormat;
- /**
- * The source of the analysis template.
- */
- source: AnalysisSource;
- /**
- * The parameters of the analysis template.
- */
- analysisParameters?: AnalysisParameterList;
- /**
- * Information about the validations performed on the analysis template.
- */
- validations?: AnalysisTemplateValidationStatusDetailList;
- }
- export type AnalysisTemplateArn = string;
- export type AnalysisTemplateArnList = AnalysisTemplateArn[];
- export type AnalysisTemplateArnOrQueryWildcard = string;
- export type AnalysisTemplateIdentifier = string;
- export interface AnalysisTemplateSummary {
- /**
- * The Amazon Resource Name (ARN) of the analysis template.
- */
- arn: AnalysisTemplateArn;
- /**
- * The time that the analysis template summary was created.
- */
- createTime: Timestamp;
- /**
- * The identifier of the analysis template.
- */
- id: AnalysisTemplateIdentifier;
- /**
- * The name of the analysis template.
- */
- name: ResourceAlias;
- /**
- * The time that the analysis template summary was last updated.
- */
- updateTime: Timestamp;
- /**
- * The Amazon Resource Name (ARN) of the member who created the analysis template.
- */
- membershipArn: MembershipArn;
- /**
- * The identifier for a membership resource.
- */
- membershipId: UUID;
- /**
- * The unique ARN for the analysis template summary’s associated collaboration.
- */
- collaborationArn: CollaborationArn;
- /**
- * A unique identifier for the collaboration that the analysis template summary belongs to. Currently accepts collaboration ID.
- */
- collaborationId: UUID;
- /**
- * The description of the analysis template.
- */
- description?: ResourceDescription;
- }
- export type AnalysisTemplateSummaryList = AnalysisTemplateSummary[];
- export type AnalysisTemplateText = string;
- export type AnalysisTemplateValidationStatus = "VALID"|"INVALID"|"UNABLE_TO_VALIDATE"|string;
- export interface AnalysisTemplateValidationStatusDetail {
- /**
- * The type of validation that was performed.
- */
- type: AnalysisTemplateValidationType;
- /**
- * The status of the validation.
- */
- status: AnalysisTemplateValidationStatus;
- /**
- * The reasons for the validation results.
- */
- reasons?: AnalysisTemplateValidationStatusReasonList;
- }
- export type AnalysisTemplateValidationStatusDetailList = AnalysisTemplateValidationStatusDetail[];
- export interface AnalysisTemplateValidationStatusReason {
- /**
- * The validation message.
- */
- message: String;
- }
- export type AnalysisTemplateValidationStatusReasonList = AnalysisTemplateValidationStatusReason[];
- export type AnalysisTemplateValidationType = "DIFFERENTIAL_PRIVACY"|string;
- export interface BatchGetCollaborationAnalysisTemplateError {
- /**
- * The Amazon Resource Name (ARN) of the analysis template.
- */
- arn: AnalysisTemplateArn;
- /**
- * An error code for the error.
- */
- code: String;
- /**
- * A description of why the call failed.
- */
- message: String;
- }
- export type BatchGetCollaborationAnalysisTemplateErrorList = BatchGetCollaborationAnalysisTemplateError[];
- export interface BatchGetCollaborationAnalysisTemplateInput {
- /**
- * A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
- */
- analysisTemplateArns: AnalysisTemplateArnList;
- }
- export interface BatchGetCollaborationAnalysisTemplateOutput {
- /**
- * The retrieved list of analysis templates within a collaboration.
- */
- collaborationAnalysisTemplates: CollaborationAnalysisTemplateList;
- /**
- * Error reasons for collaboration analysis templates that could not be retrieved. One error is returned for every collaboration analysis template that could not be retrieved.
- */
- errors: BatchGetCollaborationAnalysisTemplateErrorList;
- }
- export interface BatchGetSchemaAnalysisRuleError {
- /**
- * An error name for the error.
- */
- name: TableAlias;
- /**
- * The analysis rule type.
- */
- type: AnalysisRuleType;
- /**
- * An error code for the error.
- */
- code: String;
- /**
- * A description of why the call failed.
- */
- message: String;
- }
- export type BatchGetSchemaAnalysisRuleErrorList = BatchGetSchemaAnalysisRuleError[];
- export interface BatchGetSchemaAnalysisRuleInput {
- /**
- * The unique identifier of the collaboration that contains the schema analysis rule.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * The information that's necessary to retrieve a schema analysis rule.
- */
- schemaAnalysisRuleRequests: SchemaAnalysisRuleRequestList;
- }
- export interface BatchGetSchemaAnalysisRuleOutput {
- /**
- * The retrieved list of analysis rules.
- */
- analysisRules: SchemaAnalysisRuleList;
- /**
- * Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.
- */
- errors: BatchGetSchemaAnalysisRuleErrorList;
- }
- export interface BatchGetSchemaError {
- /**
- * An error name for the error.
- */
- name: TableAlias;
- /**
- * An error code for the error.
- */
- code: String;
- /**
- * An error message for the error.
- */
- message: String;
- }
- export type BatchGetSchemaErrorList = BatchGetSchemaError[];
- export interface BatchGetSchemaInput {
- /**
- * A unique identifier for the collaboration that the schemas belong to. Currently accepts collaboration ID.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * The names for the schema objects to retrieve.
- */
- names: TableAliasList;
- }
- export interface BatchGetSchemaOutput {
- /**
- * The retrieved list of schemas.
- */
- schemas: SchemaList;
- /**
- * Error reasons for schemas that could not be retrieved. One error is returned for every schema that could not be retrieved.
- */
- errors: BatchGetSchemaErrorList;
- }
- export type Boolean = boolean;
- export type CleanroomsArn = string;
- export interface Collaboration {
- /**
- * The unique ID for the collaboration.
- */
- id: UUID;
- /**
- * The unique ARN for the collaboration.
- */
- arn: CollaborationArn;
- /**
- * A human-readable identifier provided by the collaboration owner. Display names are not unique.
- */
- name: CollaborationName;
- /**
- * A description of the collaboration provided by the collaboration owner.
- */
- description?: CollaborationDescription;
- /**
- * The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
- */
- creatorAccountId: AccountId;
- /**
- * A display name of the collaboration creator.
- */
- creatorDisplayName: DisplayName;
- /**
- * The time when the collaboration was created.
- */
- createTime: Timestamp;
- /**
- * The time the collaboration metadata was last updated.
- */
- updateTime: Timestamp;
- /**
- * The status of a member in a collaboration.
- */
- memberStatus: MemberStatus;
- /**
- * The unique ID for your membership within the collaboration.
- */
- membershipId?: UUID;
- /**
- * The unique ARN for your membership within the collaboration.
- */
- membershipArn?: MembershipArn;
- /**
- * The settings for client-side encryption for cryptographic computing.
- */
- dataEncryptionMetadata?: DataEncryptionMetadata;
- /**
- * An indicator as to whether query logging has been enabled or disabled for the collaboration.
- */
- queryLogStatus: CollaborationQueryLogStatus;
- }
- export interface CollaborationAnalysisTemplate {
- /**
- * The identifier of the analysis template.
- */
- id: AnalysisTemplateIdentifier;
- /**
- * The Amazon Resource Name (ARN) of the analysis template.
- */
- arn: AnalysisTemplateArn;
- /**
- * A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
- */
- collaborationId: UUID;
- /**
- * The unique ARN for the analysis template’s associated collaboration.
- */
- collaborationArn: CollaborationArn;
- /**
- * The description of the analysis template.
- */
- description?: ResourceDescription;
- /**
- * The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
- */
- creatorAccountId: AccountId;
- /**
- * The name of the analysis template.
- */
- name: ResourceAlias;
- /**
- * The time that the analysis template within a collaboration was created.
- */
- createTime: Timestamp;
- /**
- * The time that the analysis template in the collaboration was last updated.
- */
- updateTime: Timestamp;
- /**
- * The entire schema object.
- */
- schema: AnalysisSchema;
- /**
- * The format of the analysis template in the collaboration.
- */
- format: AnalysisFormat;
- /**
- * The source of the analysis template within a collaboration.
- */
- source: AnalysisSource;
- /**
- * The analysis parameters that have been specified in the analysis template.
- */
- analysisParameters?: AnalysisParameterList;
- /**
- * The validations that were performed.
- */
- validations?: AnalysisTemplateValidationStatusDetailList;
- }
- export type CollaborationAnalysisTemplateList = CollaborationAnalysisTemplate[];
- export interface CollaborationAnalysisTemplateSummary {
- /**
- * The Amazon Resource Name (ARN) of the analysis template.
- */
- arn: AnalysisTemplateArn;
- /**
- * The time that the summary of the analysis template in a collaboration was created.
- */
- createTime: Timestamp;
- /**
- * The identifier of the analysis template.
- */
- id: AnalysisTemplateIdentifier;
- /**
- * The name of the analysis template.
- */
- name: ResourceAlias;
- /**
- * The time that the summary of the analysis template in the collaboration was last updated.
- */
- updateTime: Timestamp;
- /**
- * The unique ARN for the analysis template’s associated collaboration.
- */
- collaborationArn: CollaborationArn;
- /**
- * A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
- */
- collaborationId: UUID;
- /**
- * The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
- */
- creatorAccountId: AccountId;
- /**
- * The description of the analysis template.
- */
- description?: ResourceDescription;
- }
- export type CollaborationAnalysisTemplateSummaryList = CollaborationAnalysisTemplateSummary[];
- export type CollaborationArn = string;
- export interface CollaborationConfiguredAudienceModelAssociation {
- /**
- * The identifier of the configured audience model association.
- */
- id: ConfiguredAudienceModelAssociationIdentifier;
- /**
- * The Amazon Resource Name (ARN) of the configured audience model association.
- */
- arn: ConfiguredAudienceModelAssociationArn;
- /**
- * A unique identifier for the collaboration that the configured audience model associations belong to. Accepts collaboration ID.
- */
- collaborationId: UUID;
- /**
- * The unique ARN for the configured audience model's associated collaboration.
- */
- collaborationArn: CollaborationArn;
- /**
- * The Amazon Resource Name (ARN) of the configure audience model.
- */
- configuredAudienceModelArn: ConfiguredAudienceModelArn;
- /**
- * The name of the configured audience model association.
- */
- name: ConfiguredAudienceModelAssociationName;
- /**
- * The description of the configured audience model association.
- */
- description?: ResourceDescription;
- /**
- * The identifier used to reference members of the collaboration. Only supports AWS account ID.
- */
- creatorAccountId: AccountId;
- /**
- * The time at which the configured audience model association was created.
- */
- createTime: Timestamp;
- /**
- * The most recent time at which the configured audience model association was updated.
- */
- updateTime: Timestamp;
- }
- export interface CollaborationConfiguredAudienceModelAssociationSummary {
- /**
- * The Amazon Resource Name (ARN) of the configured audience model association.
- */
- arn: ConfiguredAudienceModelAssociationArn;
- /**
- * The time at which the configured audience model association was created.
- */
- createTime: Timestamp;
- /**
- * The identifier of the configured audience model association.
- */
- id: ConfiguredAudienceModelAssociationIdentifier;
- /**
- * The name of the configured audience model association.
- */
- name: ConfiguredAudienceModelAssociationName;
- /**
- * The most recent time at which the configured audience model association was updated.
- */
- updateTime: Timestamp;
- /**
- * The unique ARN for the configured audience model's associated collaboration.
- */
- collaborationArn: CollaborationArn;
- /**
- * A unique identifier for the collaboration that the configured audience model associations belong to. Accepts collaboration ID.
- */
- collaborationId: UUID;
- /**
- * The identifier used to reference members of the collaboration. Only supports AWS account ID.
- */
- creatorAccountId: AccountId;
- /**
- * The description of the configured audience model association.
- */
- description?: ResourceDescription;
- }
- export type CollaborationConfiguredAudienceModelAssociationSummaryList = CollaborationConfiguredAudienceModelAssociationSummary[];
- export type CollaborationDescription = string;
- export type CollaborationIdentifier = string;
- export type CollaborationName = string;
- export interface CollaborationPrivacyBudgetSummary {
- /**
- * The unique identifier of the collaboration privacy budget.
- */
- id: UUID;
- /**
- * The unique identifier of the collaboration privacy budget template.
- */
- privacyBudgetTemplateId: PrivacyBudgetTemplateIdentifier;
- /**
- * The ARN of the collaboration privacy budget template.
- */
- privacyBudgetTemplateArn: PrivacyBudgetTemplateArn;
- /**
- * The unique identifier of the collaboration that includes this privacy budget.
- */
- collaborationId: UUID;
- /**
- * The ARN of the collaboration that includes this privacy budget.
- */
- collaborationArn: CollaborationArn;
- /**
- * The unique identifier of the account that created this privacy budget.
- */
- creatorAccountId: AccountId;
- /**
- * The type of privacy budget template.
- */
- type: PrivacyBudgetType;
- /**
- * The time at which the privacy budget was created.
- */
- createTime: Timestamp;
- /**
- * The most recent time at which the privacy budget was updated.
- */
- updateTime: Timestamp;
- /**
- * The includes epsilon provided and utility in terms of aggregations.
- */
- budget: PrivacyBudget;
- }
- export type CollaborationPrivacyBudgetSummaryList = CollaborationPrivacyBudgetSummary[];
- export interface CollaborationPrivacyBudgetTemplate {
- /**
- * The unique identifier of the collaboration privacy budget template.
- */
- id: PrivacyBudgetTemplateIdentifier;
- /**
- * The ARN of the collaboration privacy budget template.
- */
- arn: PrivacyBudgetTemplateArn;
- /**
- * The unique identifier of the collaboration that includes this collaboration privacy budget template.
- */
- collaborationId: UUID;
- /**
- * The ARN of the collaboration that includes this collaboration privacy budget template.
- */
- collaborationArn: CollaborationArn;
- /**
- * The unique identifier of the account that created this collaboration privacy budget template.
- */
- creatorAccountId: AccountId;
- /**
- * The time at which the collaboration privacy budget template was created.
- */
- createTime: Timestamp;
- /**
- * The most recent time at which the collaboration privacy budget template was updated.
- */
- updateTime: Timestamp;
- /**
- * The type of privacy budget template.
- */
- privacyBudgetType: PrivacyBudgetType;
- /**
- * How often the privacy budget refreshes. If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
- */
- autoRefresh: PrivacyBudgetTemplateAutoRefresh;
- /**
- * Specifies the epsilon and noise parameters for the privacy budget template.
- */
- parameters: PrivacyBudgetTemplateParametersOutput;
- }
- export interface CollaborationPrivacyBudgetTemplateSummary {
- /**
- * The unique identifier of the collaboration privacy budget template.
- */
- id: PrivacyBudgetTemplateIdentifier;
- /**
- * The ARN of the collaboration privacy budget template.
- */
- arn: PrivacyBudgetTemplateArn;
- /**
- * The unique identifier of the collaboration that contains this collaboration privacy budget template.
- */
- collaborationId: UUID;
- /**
- * The ARN of the collaboration that contains this collaboration privacy budget template.
- */
- collaborationArn: CollaborationArn;
- /**
- * The unique identifier of the account that created this collaboration privacy budget template.
- */
- creatorAccountId: AccountId;
- /**
- * The type of the privacy budget template.
- */
- privacyBudgetType: PrivacyBudgetType;
- /**
- * The time at which the collaboration privacy budget template was created.
- */
- createTime: Timestamp;
- /**
- * The most recent time at which the collaboration privacy budget template was updated.
- */
- updateTime: Timestamp;
- }
- export type CollaborationPrivacyBudgetTemplateSummaryList = CollaborationPrivacyBudgetTemplateSummary[];
- export type CollaborationQueryLogStatus = "ENABLED"|"DISABLED"|string;
- export interface CollaborationSummary {
- /**
- * The identifier for the collaboration.
- */
- id: UUID;
- /**
- * The ARN of the collaboration.
- */
- arn: CollaborationArn;
- /**
- * A human-readable identifier provided by the collaboration owner. Display names are not unique.
- */
- name: CollaborationName;
- /**
- * The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
- */
- creatorAccountId: AccountId;
- /**
- * The display name of the collaboration creator.
- */
- creatorDisplayName: DisplayName;
- /**
- * The time when the collaboration was created.
- */
- createTime: Timestamp;
- /**
- * The time the collaboration metadata was last updated.
- */
- updateTime: Timestamp;
- /**
- * The status of a member in a collaboration.
- */
- memberStatus: MemberStatus;
- /**
- * The identifier of a member in a collaboration.
- */
- membershipId?: UUID;
- /**
- * The ARN of a member in a collaboration.
- */
- membershipArn?: MembershipArn;
- }
- export type CollaborationSummaryList = CollaborationSummary[];
- export interface Column {
- /**
- * The name of the column.
- */
- name: ColumnName;
- /**
- * The type of the column.
- */
- type: ColumnTypeString;
- }
- export type ColumnList = Column[];
- export type ColumnName = string;
- export type ColumnTypeString = string;
- export type ConfiguredAudienceModelArn = string;
- export interface ConfiguredAudienceModelAssociation {
- /**
- * A unique identifier of the configured audience model association.
- */
- id: ConfiguredAudienceModelAssociationIdentifier;
- /**
- * The Amazon Resource Name (ARN) of the configured audience model association.
- */
- arn: ConfiguredAudienceModelAssociationArn;
- /**
- * The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association.
- */
- configuredAudienceModelArn: ConfiguredAudienceModelArn;
- /**
- * A unique identifier for the membership that contains this configured audience model association.
- */
- membershipId: UUID;
- /**
- * The Amazon Resource Name (ARN) of the membership that contains this configured audience model association.
- */
- membershipArn: MembershipArn;
- /**
- * A unique identifier of the collaboration that contains this configured audience model association.
- */
- collaborationId: UUID;
- /**
- * The Amazon Resource Name (ARN) of the collaboration that contains this configured audience model association.
- */
- collaborationArn: CollaborationArn;
- /**
- * The name of the configured audience model association.
- */
- name: ConfiguredAudienceModelAssociationName;
- /**
- * When TRUE, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE, indicates that the configured audience model resource owner will manage permissions related to the given collaboration.
- */
- manageResourcePolicies: Boolean;
- /**
- * The description of the configured audience model association.
- */
- description?: ResourceDescription;
- /**
- * The time at which the configured audience model association was created.
- */
- createTime: Timestamp;
- /**
- * The most recent time at which the configured audience model association was updated.
- */
- updateTime: Timestamp;
- }
- export type ConfiguredAudienceModelAssociationArn = string;
- export type ConfiguredAudienceModelAssociationIdentifier = string;
- export type ConfiguredAudienceModelAssociationName = string;
- export interface ConfiguredAudienceModelAssociationSummary {
- /**
- * A unique identifier of the membership that contains the configured audience model association.
- */
- membershipId: MembershipIdentifier;
- /**
- * The Amazon Resource Name (ARN) of the membership that contains the configured audience model association.
- */
- membershipArn: MembershipArn;
- /**
- * The Amazon Resource Name (ARN) of the collaboration that contains the configured audience model association.
- */
- collaborationArn: CollaborationArn;
- /**
- * A unique identifier of the collaboration that configured audience model is associated with.
- */
- collaborationId: UUID;
- /**
- * The time at which the configured audience model association was created.
- */
- createTime: Timestamp;
- /**
- * The most recent time at which the configured audience model association was updated.
- */
- updateTime: Timestamp;
- /**
- * A unique identifier of the configured audience model association.
- */
- id: UUID;
- /**
- * The Amazon Resource Name (ARN) of the configured audience model association.
- */
- arn: ConfiguredAudienceModelAssociationArn;
- /**
- * The name of the configured audience model association.
- */
- name: ConfiguredAudienceModelAssociationName;
- /**
- * The Amazon Resource Name (ARN) of the configured audience model that was used for this configured audience model association.
- */
- configuredAudienceModelArn: ConfiguredAudienceModelArn;
- /**
- * The description of the configured audience model association.
- */
- description?: ResourceDescription;
- }
- export type ConfiguredAudienceModelAssociationSummaryList = ConfiguredAudienceModelAssociationSummary[];
- export interface ConfiguredTable {
- /**
- * The unique ID for the configured table.
- */
- id: UUID;
- /**
- * The unique ARN for the configured table.
- */
- arn: ConfiguredTableArn;
- /**
- * A name for the configured table.
- */
- name: DisplayName;
- /**
- * A description for the configured table.
- */
- description?: TableDescription;
- /**
- * The Glue table that this configured table represents.
- */
- tableReference: TableReference;
- /**
- * The time the configured table was created.
- */
- createTime: Timestamp;
- /**
- * The time the configured table was last updated
- */
- updateTime: Timestamp;
- /**
- * The types of analysis rules associated with this configured table. Currently, only one analysis rule may be associated with a configured table.
- */
- analysisRuleTypes: ConfiguredTableAnalysisRuleTypeList;
- /**
- * The analysis method for the configured table. The only valid value is currently `DIRECT_QUERY`.
- */
- analysisMethod: AnalysisMethod;
- /**
- * The columns within the underlying Glue table that can be utilized within collaborations.
- */
- allowedColumns: AllowedColumnList;
- }
- export interface ConfiguredTableAnalysisRule {
- /**
- * The unique ID for the configured table.
- */
- configuredTableId: UUID;
- /**
- * The unique ARN for the configured table.
- */
- configuredTableArn: ConfiguredTableArn;
- /**
- * The policy that controls SQL query rules.
- */
- policy: ConfiguredTableAnalysisRulePolicy;
- /**
- * The type of configured table analysis rule.
- */
- type: ConfiguredTableAnalysisRuleType;
- /**
- * The time the configured table analysis rule was created.
- */
- createTime: Timestamp;
- /**
- * The time the configured table analysis rule was last updated.
- */
- updateTime: Timestamp;
- }
- export interface ConfiguredTableAnalysisRulePolicy {
- /**
- * Controls on the query specifications that can be run on a configured table.
- */
- v1?: ConfiguredTableAnalysisRulePolicyV1;
- }
- export interface ConfiguredTableAnalysisRulePolicyV1 {
- /**
- * Analysis rule type that enables only list queries on a configured table.
- */
- list?: AnalysisRuleList;
- /**
- * Analysis rule type that enables only aggregation queries on a configured table.
- */
- aggregation?: AnalysisRuleAggregation;
- custom?: AnalysisRuleCustom;
- }
- export type ConfiguredTableAnalysisRuleType = "AGGREGATION"|"LIST"|"CUSTOM"|string;
- export type ConfiguredTableAnalysisRuleTypeList = ConfiguredTableAnalysisRuleType[];
- export type ConfiguredTableArn = string;
- export interface ConfiguredTableAssociation {
- /**
- * The unique ARN for the configured table association.
- */
- arn: ConfiguredTableAssociationArn;
- /**
- * The unique ID for the configured table association.
- */
- id: UUID;
- /**
- * The unique ID for the configured table that the association refers to.
- */
- configuredTableId: UUID;
- /**
- * The unique ARN for the configured table that the association refers to.
- */
- configuredTableArn: ConfiguredTableArn;
- /**
- * The unique ID for the membership this configured table association belongs to.
- */
- membershipId: UUID;
- /**
- * The unique ARN for the membership this configured table association belongs to.
- */
- membershipArn: MembershipArn;
- /**
- * The service will assume this role to access catalog metadata and query the table.
- */
- roleArn: RoleArn;
- /**
- * The name of the configured table association, in lowercase. The table is identified by this name when running protected queries against the underlying data.
- */
- name: TableAlias;
- /**
- * A description of the configured table association.
- */
- description?: TableDescription;
- /**
- * The time the configured table association was created.
- */
- createTime: Timestamp;
- /**
- * The time the configured table association was last updated.
- */
- updateTime: Timestamp;
- }
- export type ConfiguredTableAssociationArn = string;
- export type ConfiguredTableAssociationIdentifier = string;
- export interface ConfiguredTableAssociationSummary {
- /**
- * The unique configured table ID that this configured table association refers to.
- */
- configuredTableId: UUID;
- /**
- * The unique ID for the membership that the configured table association belongs to.
- */
- membershipId: MembershipIdentifier;
- /**
- * The unique ARN for the membership that the configured table association belongs to.
- */
- membershipArn: MembershipArn;
- /**
- * The name of the configured table association. The table is identified by this name when running Protected Queries against the underlying data.
- */
- name: TableAlias;
- /**
- * The time the configured table association was created.
- */
- createTime: Timestamp;
- /**
- * The time the configured table association was last updated.
- */
- updateTime: Timestamp;
- /**
- * The unique ID for the configured table association.
- */
- id: UUID;
- /**
- * The unique ARN for the configured table association.
- */
- arn: ConfiguredTableAssociationArn;
- }
- export type ConfiguredTableAssociationSummaryList = ConfiguredTableAssociationSummary[];
- export type ConfiguredTableIdentifier = string;
- export interface ConfiguredTableSummary {
- /**
- * The unique ID of the configured table.
- */
- id: ConfiguredTableIdentifier;
- /**
- * The unique ARN of the configured table.
- */
- arn: ConfiguredTableArn;
- /**
- * The name of the configured table.
- */
- name: DisplayName;
- /**
- * The time the configured table was created.
- */
- createTime: Timestamp;
- /**
- * The time the configured table was last updated.
- */
- updateTime: Timestamp;
- /**
- * The types of analysis rules associated with this configured table.
- */
- analysisRuleTypes: ConfiguredTableAnalysisRuleTypeList;
- /**
- * The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.
- */
- analysisMethod: AnalysisMethod;
- }
- export type ConfiguredTableSummaryList = ConfiguredTableSummary[];
- export interface CreateAnalysisTemplateInput {
- /**
- * The description of the analysis template.
- */
- description?: ResourceDescription;
- /**
- * The identifier for a membership resource.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * The name of the analysis template.
- */
- name: TableAlias;
- /**
- * The format of the analysis template.
- */
- format: AnalysisFormat;
- /**
- * The information in the analysis template. Currently supports text, the query text for the analysis template.
- */
- source: AnalysisSource;
- /**
- * An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
- */
- tags?: TagMap;
- /**
- * The parameters of the analysis template.
- */
- analysisParameters?: AnalysisParameterList;
- }
- export interface CreateAnalysisTemplateOutput {
- /**
- * The analysis template.
- */
- analysisTemplate: AnalysisTemplate;
- }
- export interface CreateCollaborationInput {
- /**
- * A list of initial members, not including the creator. This list is immutable.
- */
- members: MemberList;
- /**
- * The display name for a collaboration.
- */
- name: CollaborationName;
- /**
- * A description of the collaboration provided by the collaboration owner.
- */
- description: CollaborationDescription;
- /**
- * The abilities granted to the collaboration creator.
- */
- creatorMemberAbilities: MemberAbilities;
- /**
- * The display name of the collaboration creator.
- */
- creatorDisplayName: DisplayName;
- /**
- * The settings for client-side encryption with Cryptographic Computing for Clean Rooms.
- */
- dataEncryptionMetadata?: DataEncryptionMetadata;
- /**
- * An indicator as to whether query logging has been enabled or disabled for the collaboration.
- */
- queryLogStatus: CollaborationQueryLogStatus;
- /**
- * An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
- */
- tags?: TagMap;
- /**
- * The collaboration creator's payment responsibilities set by the collaboration creator. If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
- */
- creatorPaymentConfiguration?: PaymentConfiguration;
- }
- export interface CreateCollaborationOutput {
- /**
- * The entire created collaboration object.
- */
- collaboration: Collaboration;
- }
- export interface CreateConfiguredAudienceModelAssociationInput {
- /**
- * A unique identifier for one of your memberships for a collaboration. The configured audience model is associated to the collaboration that this membership belongs to. Accepts a membership ID.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * A unique identifier for the configured audience model that you want to associate.
- */
- configuredAudienceModelArn: ConfiguredAudienceModelArn;
- /**
- * The name of the configured audience model association.
- */
- configuredAudienceModelAssociationName: ConfiguredAudienceModelAssociationName;
- /**
- * When TRUE, indicates that the resource policy for the configured audience model resource being associated is configured for Clean Rooms to manage permissions related to the given collaboration. When FALSE, indicates that the configured audience model resource owner will manage permissions related to the given collaboration. Setting this to TRUE requires you to have permissions to create, update, and delete the resource policy for the cleanrooms-ml resource when you call the DeleteConfiguredAudienceModelAssociation resource. In addition, if you are the collaboration creator and specify TRUE, you must have the same permissions when you call the DeleteMember and DeleteCollaboration APIs.
- */
- manageResourcePolicies: Boolean;
- /**
- * An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
- */
- tags?: TagMap;
- /**
- * A description of the configured audience model association.
- */
- description?: ResourceDescription;
- }
- export interface CreateConfiguredAudienceModelAssociationOutput {
- /**
- * Information about the configured audience model association.
- */
- configuredAudienceModelAssociation: ConfiguredAudienceModelAssociation;
- }
- export interface CreateConfiguredTableAnalysisRuleInput {
- /**
- * The identifier for the configured table to create the analysis rule for. Currently accepts the configured table ID.
- */
- configuredTableIdentifier: ConfiguredTableIdentifier;
- /**
- * The type of analysis rule.
- */
- analysisRuleType: ConfiguredTableAnalysisRuleType;
- /**
- * The entire created configured table analysis rule object.
- */
- analysisRulePolicy: ConfiguredTableAnalysisRulePolicy;
- }
- export interface CreateConfiguredTableAnalysisRuleOutput {
- /**
- * The entire created analysis rule.
- */
- analysisRule: ConfiguredTableAnalysisRule;
- }
- export interface CreateConfiguredTableAssociationInput {
- /**
- * The name of the configured table association. This name is used to query the underlying configured table.
- */
- name: TableAlias;
- /**
- * A description for the configured table association.
- */
- description?: TableDescription;
- /**
- * A unique identifier for one of your memberships for a collaboration. The configured table is associated to the collaboration that this membership belongs to. Currently accepts a membership ID.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * A unique identifier for the configured table to be associated to. Currently accepts a configured table ID.
- */
- configuredTableIdentifier: ConfiguredTableIdentifier;
- /**
- * The service will assume this role to access catalog metadata and query the table.
- */
- roleArn: RoleArn;
- /**
- * An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
- */
- tags?: TagMap;
- }
- export interface CreateConfiguredTableAssociationOutput {
- /**
- * The entire configured table association object.
- */
- configuredTableAssociation: ConfiguredTableAssociation;
- }
- export interface CreateConfiguredTableInput {
- /**
- * The name of the configured table.
- */
- name: DisplayName;
- /**
- * A description for the configured table.
- */
- description?: TableDescription;
- /**
- * A reference to the Glue table being configured.
- */
- tableReference: TableReference;
- /**
- * The columns of the underlying table that can be used by collaborations or analysis rules.
- */
- allowedColumns: AllowedColumnList;
- /**
- * The analysis method for the configured tables. The only valid value is currently `DIRECT_QUERY`.
- */
- analysisMethod: AnalysisMethod;
- /**
- * An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
- */
- tags?: TagMap;
- }
- export interface CreateConfiguredTableOutput {
- /**
- * The created configured table.
- */
- configuredTable: ConfiguredTable;
- }
- export interface CreateMembershipInput {
- /**
- * The unique ID for the associated collaboration.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * An indicator as to whether query logging has been enabled or disabled for the membership.
- */
- queryLogStatus: MembershipQueryLogStatus;
- /**
- * An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
- */
- tags?: TagMap;
- /**
- * The default protected query result configuration as specified by the member who can receive results.
- */
- defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration;
- /**
- * The payment responsibilities accepted by the collaboration member. Not required if the collaboration member has the member ability to run queries. Required if the collaboration member doesn't have the member ability to run queries but is configured as a payer by the collaboration creator.
- */
- paymentConfiguration?: MembershipPaymentConfiguration;
- }
- export interface CreateMembershipOutput {
- /**
- * The membership that was created.
- */
- membership: Membership;
- }
- export interface CreatePrivacyBudgetTemplateInput {
- /**
- * A unique identifier for one of your memberships for a collaboration. The privacy budget template is created in the collaboration that this membership belongs to. Accepts a membership ID.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * How often the privacy budget refreshes. If you plan to regularly bring new data into the collaboration, you can use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queries across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
- */
- autoRefresh: PrivacyBudgetTemplateAutoRefresh;
- /**
- * Specifies the type of the privacy budget template.
- */
- privacyBudgetType: PrivacyBudgetType;
- /**
- * Specifies your parameters for the privacy budget template.
- */
- parameters: PrivacyBudgetTemplateParametersInput;
- /**
- * An optional label that you can assign to a resource when you create it. Each tag consists of a key and an optional value, both of which you define. When you use tagging, you can also use tag-based access control in IAM policies to control access to this resource.
- */
- tags?: TagMap;
- }
- export interface CreatePrivacyBudgetTemplateOutput {
- /**
- * A summary of the elements in the privacy budget template.
- */
- privacyBudgetTemplate: PrivacyBudgetTemplate;
- }
- export interface DataEncryptionMetadata {
- /**
- * Indicates whether encrypted tables can contain cleartext data (TRUE) or are to cryptographically process every column (FALSE).
- */
- allowCleartext: Boolean;
- /**
- * Indicates whether Fingerprint columns can contain duplicate entries (TRUE) or are to contain only non-repeated values (FALSE).
- */
- allowDuplicates: Boolean;
- /**
- * Indicates whether Fingerprint columns can be joined on any other Fingerprint column with a different name (TRUE) or can only be joined on Fingerprint columns of the same name (FALSE).
- */
- allowJoinsOnColumnsWithDifferentNames: Boolean;
- /**
- * Indicates whether NULL values are to be copied as NULL to encrypted tables (TRUE) or cryptographically processed (FALSE).
- */
- preserveNulls: Boolean;
- }
- export interface DeleteAnalysisTemplateInput {
- /**
- * The identifier for a membership resource.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * The identifier for the analysis template resource.
- */
- analysisTemplateIdentifier: AnalysisTemplateIdentifier;
- }
- export interface DeleteAnalysisTemplateOutput {
- }
- export interface DeleteCollaborationInput {
- /**
- * The identifier for the collaboration.
- */
- collaborationIdentifier: CollaborationIdentifier;
- }
- export interface DeleteCollaborationOutput {
- }
- export interface DeleteConfiguredAudienceModelAssociationInput {
- /**
- * A unique identifier of the configured audience model association that you want to delete.
- */
- configuredAudienceModelAssociationIdentifier: ConfiguredAudienceModelAssociationIdentifier;
- /**
- * A unique identifier of the membership that contains the audience model association that you want to delete.
- */
- membershipIdentifier: MembershipIdentifier;
- }
- export interface DeleteConfiguredAudienceModelAssociationOutput {
- }
- export interface DeleteConfiguredTableAnalysisRuleInput {
- /**
- * The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
- */
- configuredTableIdentifier: ConfiguredTableIdentifier;
- /**
- * The analysis rule type to be deleted. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
- */
- analysisRuleType: ConfiguredTableAnalysisRuleType;
- }
- export interface DeleteConfiguredTableAnalysisRuleOutput {
- }
- export interface DeleteConfiguredTableAssociationInput {
- /**
- * The unique ID for the configured table association to be deleted. Currently accepts the configured table ID.
- */
- configuredTableAssociationIdentifier: ConfiguredTableAssociationIdentifier;
- /**
- * A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
- */
- membershipIdentifier: MembershipIdentifier;
- }
- export interface DeleteConfiguredTableAssociationOutput {
- }
- export interface DeleteConfiguredTableInput {
- /**
- * The unique ID for the configured table to delete.
- */
- configuredTableIdentifier: ConfiguredTableIdentifier;
- }
- export interface DeleteConfiguredTableOutput {
- }
- export interface DeleteMemberInput {
- /**
- * The unique identifier for the associated collaboration.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * The account ID of the member to remove.
- */
- accountId: AccountId;
- }
- export interface DeleteMemberOutput {
- }
- export interface DeleteMembershipInput {
- /**
- * The identifier for a membership resource.
- */
- membershipIdentifier: MembershipIdentifier;
- }
- export interface DeleteMembershipOutput {
- }
- export interface DeletePrivacyBudgetTemplateInput {
- /**
- * A unique identifier for one of your memberships for a collaboration. The privacy budget template is deleted from the collaboration that this membership belongs to. Accepts a membership ID.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * A unique identifier for your privacy budget template.
- */
- privacyBudgetTemplateIdentifier: PrivacyBudgetTemplateIdentifier;
- }
- export interface DeletePrivacyBudgetTemplateOutput {
- }
- export type DifferentialPrivacyAggregationExpression = string;
- export type DifferentialPrivacyAggregationType = "AVG"|"COUNT"|"COUNT_DISTINCT"|"SUM"|"STDDEV"|string;
- export interface DifferentialPrivacyColumn {
- /**
- * The name of the column, such as user_id, that contains the unique identifier of your users, whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.
- */
- name: String;
- }
- export type DifferentialPrivacyColumnList = DifferentialPrivacyColumn[];
- export interface DifferentialPrivacyConfiguration {
- /**
- * The name of the column (such as user_id) that contains the unique identifier of your users whose privacy you want to protect. If you want to turn on differential privacy for two or more tables in a collaboration, you must configure the same column as the user identifier column in both analysis rules.
- */
- columns: DifferentialPrivacyColumnList;
- }
- export interface DifferentialPrivacyParameters {
- /**
- * Provides the sensitivity parameters that you can use to better understand the total amount of noise in query results.
- */
- sensitivityParameters: DifferentialPrivacySensitivityParametersList;
- }
- export interface DifferentialPrivacyPreviewAggregation {
- /**
- * The type of aggregation function.
- */
- type: DifferentialPrivacyAggregationType;
- /**
- * The maximum number of aggregations that the member who can query can run given the epsilon and noise parameters.
- */
- maxCount: DifferentialPrivacyPreviewAggregationMaxCountInteger;
- }
- export type DifferentialPrivacyPreviewAggregationList = DifferentialPrivacyPreviewAggregation[];
- export type DifferentialPrivacyPreviewAggregationMaxCountInteger = number;
- export interface DifferentialPrivacyPreviewParametersInput {
- /**
- * The epsilon value that you want to preview.
- */
- epsilon: Epsilon;
- /**
- * Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
- */
- usersNoisePerQuery: UsersNoisePerQuery;
- }
- export interface DifferentialPrivacyPrivacyBudget {
- /**
- * This information includes the configured epsilon value and the utility in terms of total aggregations, as well as the remaining aggregations.
- */
- aggregations: DifferentialPrivacyPrivacyBudgetAggregationList;
- /**
- * The epsilon value that you configured.
- */
- epsilon: Epsilon;
- }
- export interface DifferentialPrivacyPrivacyBudgetAggregation {
- /**
- * The different types of aggregation functions that you can perform.
- */
- type: DifferentialPrivacyAggregationType;
- /**
- * The maximum number of aggregation functions that you can perform with the given privacy budget.
- */
- maxCount: DifferentialPrivacyPrivacyBudgetAggregationMaxCountInteger;
- /**
- * The remaining number of aggregation functions that can be run with the available privacy budget.
- */
- remainingCount: DifferentialPrivacyPrivacyBudgetAggregationRemainingCountInteger;
- }
- export type DifferentialPrivacyPrivacyBudgetAggregationList = DifferentialPrivacyPrivacyBudgetAggregation[];
- export type DifferentialPrivacyPrivacyBudgetAggregationMaxCountInteger = number;
- export type DifferentialPrivacyPrivacyBudgetAggregationRemainingCountInteger = number;
- export interface DifferentialPrivacyPrivacyImpact {
- /**
- * The number of aggregation functions that you can perform.
- */
- aggregations: DifferentialPrivacyPreviewAggregationList;
- }
- export interface DifferentialPrivacySensitivityParameters {
- /**
- * The type of aggregation function that was run.
- */
- aggregationType: DifferentialPrivacyAggregationType;
- /**
- * The aggregation expression that was run.
- */
- aggregationExpression: DifferentialPrivacyAggregationExpression;
- /**
- * The maximum number of rows contributed by a user in a SQL query.
- */
- userContributionLimit: DifferentialPrivacySensitivityParametersUserContributionLimitInteger;
- /**
- * The lower bound of the aggregation expression.
- */
- minColumnValue?: Float;
- /**
- * The upper bound of the aggregation expression.
- */
- maxColumnValue?: Float;
- }
- export type DifferentialPrivacySensitivityParametersList = DifferentialPrivacySensitivityParameters[];
- export type DifferentialPrivacySensitivityParametersUserContributionLimitInteger = number;
- export interface DifferentialPrivacyTemplateParametersInput {
- /**
- * The epsilon value that you want to use.
- */
- epsilon: Epsilon;
- /**
- * Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
- */
- usersNoisePerQuery: UsersNoisePerQuery;
- }
- export interface DifferentialPrivacyTemplateParametersOutput {
- /**
- * The epsilon value that you specified.
- */
- epsilon: Epsilon;
- /**
- * Noise added per query is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
- */
- usersNoisePerQuery: UsersNoisePerQuery;
- }
- export interface DifferentialPrivacyTemplateUpdateParameters {
- /**
- * The updated epsilon value that you want to use.
- */
- epsilon?: Epsilon;
- /**
- * The updated value of noise added per query. It is measured in terms of the number of users whose contributions you want to obscure. This value governs the rate at which the privacy budget is depleted.
- */
- usersNoisePerQuery?: UsersNoisePerQuery;
- }
- export type DisplayName = string;
- export type Epsilon = number;
- export type FilterableMemberStatus = "INVITED"|"ACTIVE"|string;
- export type Float = number;
- export interface GetAnalysisTemplateInput {
- /**
- * The identifier for a membership resource.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * The identifier for the analysis template resource.
- */
- analysisTemplateIdentifier: AnalysisTemplateIdentifier;
- }
- export interface GetAnalysisTemplateOutput {
- /**
- * The analysis template.
- */
- analysisTemplate: AnalysisTemplate;
- }
- export interface GetCollaborationAnalysisTemplateInput {
- /**
- * A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
- */
- analysisTemplateArn: AnalysisTemplateArn;
- }
- export interface GetCollaborationAnalysisTemplateOutput {
- /**
- * The analysis template within a collaboration.
- */
- collaborationAnalysisTemplate: CollaborationAnalysisTemplate;
- }
- export interface GetCollaborationConfiguredAudienceModelAssociationInput {
- /**
- * A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * A unique identifier for the configured audience model association that you want to retrieve.
- */
- configuredAudienceModelAssociationIdentifier: ConfiguredAudienceModelAssociationIdentifier;
- }
- export interface GetCollaborationConfiguredAudienceModelAssociationOutput {
- /**
- * The metadata of the configured audience model association.
- */
- collaborationConfiguredAudienceModelAssociation: CollaborationConfiguredAudienceModelAssociation;
- }
- export interface GetCollaborationInput {
- /**
- * The identifier for the collaboration.
- */
- collaborationIdentifier: CollaborationIdentifier;
- }
- export interface GetCollaborationOutput {
- /**
- * The entire collaboration for this identifier.
- */
- collaboration: Collaboration;
- }
- export interface GetCollaborationPrivacyBudgetTemplateInput {
- /**
- * A unique identifier for one of your collaborations.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * A unique identifier for one of your privacy budget templates.
- */
- privacyBudgetTemplateIdentifier: PrivacyBudgetTemplateIdentifier;
- }
- export interface GetCollaborationPrivacyBudgetTemplateOutput {
- /**
- * Returns the details of the privacy budget template that you requested.
- */
- collaborationPrivacyBudgetTemplate: CollaborationPrivacyBudgetTemplate;
- }
- export interface GetConfiguredAudienceModelAssociationInput {
- /**
- * A unique identifier for the configured audience model association that you want to retrieve.
- */
- configuredAudienceModelAssociationIdentifier: ConfiguredAudienceModelAssociationIdentifier;
- /**
- * A unique identifier for the membership that contains the configured audience model association that you want to retrieve.
- */
- membershipIdentifier: MembershipIdentifier;
- }
- export interface GetConfiguredAudienceModelAssociationOutput {
- /**
- * Information about the configured audience model association that you requested.
- */
- configuredAudienceModelAssociation: ConfiguredAudienceModelAssociation;
- }
- export interface GetConfiguredTableAnalysisRuleInput {
- /**
- * The unique identifier for the configured table to retrieve. Currently accepts the configured table ID.
- */
- configuredTableIdentifier: ConfiguredTableIdentifier;
- /**
- * The analysis rule to be retrieved. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
- */
- analysisRuleType: ConfiguredTableAnalysisRuleType;
- }
- export interface GetConfiguredTableAnalysisRuleOutput {
- /**
- * The entire analysis rule output.
- */
- analysisRule: ConfiguredTableAnalysisRule;
- }
- export interface GetConfiguredTableAssociationInput {
- /**
- * The unique ID for the configured table association to retrieve. Currently accepts the configured table ID.
- */
- configuredTableAssociationIdentifier: ConfiguredTableAssociationIdentifier;
- /**
- * A unique identifier for the membership that the configured table association belongs to. Currently accepts the membership ID.
- */
- membershipIdentifier: MembershipIdentifier;
- }
- export interface GetConfiguredTableAssociationOutput {
- /**
- * The entire configured table association object.
- */
- configuredTableAssociation: ConfiguredTableAssociation;
- }
- export interface GetConfiguredTableInput {
- /**
- * The unique ID for the configured table to retrieve.
- */
- configuredTableIdentifier: ConfiguredTableIdentifier;
- }
- export interface GetConfiguredTableOutput {
- /**
- * The retrieved configured table.
- */
- configuredTable: ConfiguredTable;
- }
- export interface GetMembershipInput {
- /**
- * The identifier for a membership resource.
- */
- membershipIdentifier: MembershipIdentifier;
- }
- export interface GetMembershipOutput {
- /**
- * The membership retrieved for the provided identifier.
- */
- membership: Membership;
- }
- export interface GetPrivacyBudgetTemplateInput {
- /**
- * A unique identifier for one of your memberships for a collaboration. The privacy budget template is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * A unique identifier for your privacy budget template.
- */
- privacyBudgetTemplateIdentifier: PrivacyBudgetTemplateIdentifier;
- }
- export interface GetPrivacyBudgetTemplateOutput {
- /**
- * Returns the details of the privacy budget template that you requested.
- */
- privacyBudgetTemplate: PrivacyBudgetTemplate;
- }
- export interface GetProtectedQueryInput {
- /**
- * The identifier for a membership in a protected query instance.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * The identifier for a protected query instance.
- */
- protectedQueryIdentifier: ProtectedQueryIdentifier;
- }
- export interface GetProtectedQueryOutput {
- /**
- * The query processing metadata.
- */
- protectedQuery: ProtectedQuery;
- }
- export interface GetSchemaAnalysisRuleInput {
- /**
- * A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * The name of the schema to retrieve the analysis rule for.
- */
- name: TableAlias;
- /**
- * The type of the schema analysis rule to retrieve. Schema analysis rules are uniquely identified by a combination of the collaboration, the schema name, and their type.
- */
- type: AnalysisRuleType;
- }
- export interface GetSchemaAnalysisRuleOutput {
- /**
- * A specification about how data from the configured table can be used.
- */
- analysisRule: AnalysisRule;
- }
- export interface GetSchemaInput {
- /**
- * A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * The name of the relation to retrieve the schema for.
- */
- name: TableAlias;
- }
- export interface GetSchemaOutput {
- /**
- * The entire schema object.
- */
- schema: Schema;
- }
- export type GlueDatabaseName = string;
- export type GlueTableName = string;
- export interface GlueTableReference {
- /**
- * The name of the Glue table.
- */
- tableName: GlueTableName;
- /**
- * The name of the database the Glue table belongs to.
- */
- databaseName: GlueDatabaseName;
- }
- export type JoinOperator = "OR"|"AND"|string;
- export type JoinOperatorsList = JoinOperator[];
- export type JoinRequiredOption = "QUERY_RUNNER"|string;
- export type KeyPrefix = string;
- export interface ListAnalysisTemplatesInput {
- /**
- * The identifier for a membership resource.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The maximum size of the results that is returned per call.
- */
- maxResults?: MaxResults;
- }
- export interface ListAnalysisTemplatesOutput {
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * Lists analysis template metadata.
- */
- analysisTemplateSummaries: AnalysisTemplateSummaryList;
- }
- export interface ListCollaborationAnalysisTemplatesInput {
- /**
- * A unique identifier for the collaboration that the analysis templates belong to. Currently accepts collaboration ID.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The maximum size of the results that is returned per call.
- */
- maxResults?: MaxResults;
- }
- export interface ListCollaborationAnalysisTemplatesOutput {
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The metadata of the analysis template within a collaboration.
- */
- collaborationAnalysisTemplateSummaries: CollaborationAnalysisTemplateSummaryList;
- }
- export interface ListCollaborationConfiguredAudienceModelAssociationsInput {
- /**
- * A unique identifier for the collaboration that the configured audience model association belongs to. Accepts a collaboration ID.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The maximum size of the results that is returned per call.
- */
- maxResults?: MaxResults;
- }
- export interface ListCollaborationConfiguredAudienceModelAssociationsOutput {
- /**
- * The metadata of the configured audience model association within a collaboration.
- */
- collaborationConfiguredAudienceModelAssociationSummaries: CollaborationConfiguredAudienceModelAssociationSummaryList;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- }
- export interface ListCollaborationPrivacyBudgetTemplatesInput {
- /**
- * A unique identifier for one of your collaborations.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
- */
- maxResults?: MaxResults;
- }
- export interface ListCollaborationPrivacyBudgetTemplatesOutput {
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * An array that summarizes the collaboration privacy budget templates. The summary includes collaboration information, creation information, the privacy budget type.
- */
- collaborationPrivacyBudgetTemplateSummaries: CollaborationPrivacyBudgetTemplateSummaryList;
- }
- export interface ListCollaborationPrivacyBudgetsInput {
- /**
- * A unique identifier for one of your collaborations.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * Specifies the type of the privacy budget.
- */
- privacyBudgetType: PrivacyBudgetType;
- /**
- * The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
- */
- maxResults?: MaxResults;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- }
- export interface ListCollaborationPrivacyBudgetsOutput {
- /**
- * Summaries of the collaboration privacy budgets.
- */
- collaborationPrivacyBudgetSummaries: CollaborationPrivacyBudgetSummaryList;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- }
- export interface ListCollaborationsInput {
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
- */
- maxResults?: MaxResults;
- /**
- * The caller's status in a collaboration.
- */
- memberStatus?: FilterableMemberStatus;
- }
- export interface ListCollaborationsOutput {
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The list of collaborations.
- */
- collaborationList: CollaborationSummaryList;
- }
- export interface ListConfiguredAudienceModelAssociationsInput {
- /**
- * A unique identifier for a membership that contains the configured audience model associations that you want to retrieve.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
- */
- maxResults?: MaxResults;
- }
- export interface ListConfiguredAudienceModelAssociationsOutput {
- /**
- * Summaries of the configured audience model associations that you requested.
- */
- configuredAudienceModelAssociationSummaries: ConfiguredAudienceModelAssociationSummaryList;
- /**
- * The token value provided to access the next page of results.
- */
- nextToken?: PaginationToken;
- }
- export interface ListConfiguredTableAssociationsInput {
- /**
- * A unique identifier for the membership to list configured table associations for. Currently accepts the membership ID.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The maximum size of the results that is returned per call.
- */
- maxResults?: MaxResults;
- }
- export interface ListConfiguredTableAssociationsOutput {
- /**
- * The retrieved list of configured table associations.
- */
- configuredTableAssociationSummaries: ConfiguredTableAssociationSummaryList;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- }
- export interface ListConfiguredTablesInput {
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The maximum size of the results that is returned per call.
- */
- maxResults?: MaxResults;
- }
- export interface ListConfiguredTablesOutput {
- /**
- * The configured tables listed by the request.
- */
- configuredTableSummaries: ConfiguredTableSummaryList;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- }
- export interface ListMembersInput {
- /**
- * The identifier of the collaboration in which the members are listed.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The maximum size of the results that is returned per call.
- */
- maxResults?: MaxResults;
- }
- export interface ListMembersOutput {
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The list of members returned by the ListMembers operation.
- */
- memberSummaries: MemberSummaryList;
- }
- export interface ListMembershipsInput {
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The maximum size of the results that is returned per call.
- */
- maxResults?: MaxResults;
- /**
- * A filter which will return only memberships in the specified status.
- */
- status?: MembershipStatus;
- }
- export interface ListMembershipsOutput {
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The list of memberships returned from the ListMemberships operation.
- */
- membershipSummaries: MembershipSummaryList;
- }
- export interface ListPrivacyBudgetTemplatesInput {
- /**
- * A unique identifier for one of your memberships for a collaboration. The privacy budget templates are retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
- */
- maxResults?: MaxResults;
- }
- export interface ListPrivacyBudgetTemplatesOutput {
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * An array that summarizes the privacy budget templates. The summary includes collaboration information, creation information, and privacy budget type.
- */
- privacyBudgetTemplateSummaries: PrivacyBudgetTemplateSummaryList;
- }
- export interface ListPrivacyBudgetsInput {
- /**
- * A unique identifier for one of your memberships for a collaboration. The privacy budget is retrieved from the collaboration that this membership belongs to. Accepts a membership ID.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * The privacy budget type.
- */
- privacyBudgetType: PrivacyBudgetType;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service may return a nextToken even if the maximum results has not been met.
- */
- maxResults?: MaxResults;
- }
- export interface ListPrivacyBudgetsOutput {
- /**
- * An array that summarizes the privacy budgets. The summary includes collaboration information, membership information, privacy budget template information, and privacy budget details.
- */
- privacyBudgetSummaries: PrivacyBudgetSummaryList;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- }
- export interface ListProtectedQueriesInput {
- /**
- * The identifier for the membership in the collaboration.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * A filter on the status of the protected query.
- */
- status?: ProtectedQueryStatus;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The maximum size of the results that is returned per call. Service chooses a default if it has not been set. Service can return a nextToken even if the maximum results has not been met.
- */
- maxResults?: MaxResults;
- }
- export interface ListProtectedQueriesOutput {
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * A list of protected queries.
- */
- protectedQueries: ProtectedQuerySummaryList;
- }
- export interface ListSchemasInput {
- /**
- * A unique identifier for the collaboration that the schema belongs to. Currently accepts a collaboration ID.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * If present, filter schemas by schema type. The only valid schema type is currently `TABLE`.
- */
- schemaType?: SchemaType;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- /**
- * The maximum size of the results that is returned per call.
- */
- maxResults?: MaxResults;
- }
- export interface ListSchemasOutput {
- /**
- * The retrieved list of schemas.
- */
- schemaSummaries: SchemaSummaryList;
- /**
- * The token value retrieved from a previous call to access the next page of results.
- */
- nextToken?: PaginationToken;
- }
- export interface ListTagsForResourceInput {
- /**
- * The Amazon Resource Name (ARN) associated with the resource you want to list tags on.
- */
- resourceArn: CleanroomsArn;
- }
- export interface ListTagsForResourceOutput {
- /**
- * A map of objects specifying each key name and value.
- */
- tags: TagMap;
- }
- export type Long = number;
- export type MaxResults = number;
- export type MemberAbilities = MemberAbility[];
- export type MemberAbility = "CAN_QUERY"|"CAN_RECEIVE_RESULTS"|string;
- export type MemberList = MemberSpecification[];
- export interface MemberSpecification {
- /**
- * The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
- */
- accountId: AccountId;
- /**
- * The abilities granted to the collaboration member.
- */
- memberAbilities: MemberAbilities;
- /**
- * The member's display name.
- */
- displayName: DisplayName;
- /**
- * The collaboration member's payment responsibilities set by the collaboration creator. If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer.
- */
- paymentConfiguration?: PaymentConfiguration;
- }
- export type MemberStatus = "INVITED"|"ACTIVE"|"LEFT"|"REMOVED"|string;
- export interface MemberSummary {
- /**
- * The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
- */
- accountId: AccountId;
- /**
- * The status of the member.
- */
- status: MemberStatus;
- /**
- * The member's display name.
- */
- displayName: DisplayName;
- /**
- * The abilities granted to the collaboration member.
- */
- abilities: MemberAbilities;
- /**
- * The time when the member was created.
- */
- createTime: Timestamp;
- /**
- * The time the member metadata was last updated.
- */
- updateTime: Timestamp;
- /**
- * The unique ID for the member's associated membership, if present.
- */
- membershipId?: UUID;
- /**
- * The unique ARN for the member's associated membership, if present.
- */
- membershipArn?: MembershipArn;
- /**
- * The collaboration member's payment responsibilities set by the collaboration creator.
- */
- paymentConfiguration: PaymentConfiguration;
- }
- export type MemberSummaryList = MemberSummary[];
- export interface Membership {
- /**
- * The unique ID of the membership.
- */
- id: UUID;
- /**
- * The unique ARN for the membership.
- */
- arn: MembershipArn;
- /**
- * The unique ARN for the membership's associated collaboration.
- */
- collaborationArn: CollaborationArn;
- /**
- * The unique ID for the membership's collaboration.
- */
- collaborationId: UUID;
- /**
- * The identifier used to reference members of the collaboration. Currently only supports Amazon Web Services account ID.
- */
- collaborationCreatorAccountId: AccountId;
- /**
- * The display name of the collaboration creator.
- */
- collaborationCreatorDisplayName: DisplayName;
- /**
- * The name of the membership's collaboration.
- */
- collaborationName: CollaborationName;
- /**
- * The time when the membership was created.
- */
- createTime: Timestamp;
- /**
- * The time the membership metadata was last updated.
- */
- updateTime: Timestamp;
- /**
- * The status of the membership.
- */
- status: MembershipStatus;
- /**
- * The abilities granted to the collaboration member.
- */
- memberAbilities: MemberAbilities;
- /**
- * An indicator as to whether query logging has been enabled or disabled for the membership.
- */
- queryLogStatus: MembershipQueryLogStatus;
- /**
- * The default protected query result configuration as specified by the member who can receive results.
- */
- defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration;
- /**
- * The payment responsibilities accepted by the collaboration member.
- */
- paymentConfiguration: MembershipPaymentConfiguration;
- }
- export type MembershipArn = string;
- export type MembershipIdentifier = string;
- export interface MembershipPaymentConfiguration {
- /**
- * The payment responsibilities accepted by the collaboration member for query compute costs.
- */
- queryCompute: MembershipQueryComputePaymentConfig;
- }
- export interface MembershipProtectedQueryOutputConfiguration {
- s3?: ProtectedQueryS3OutputConfiguration;
- }
- export interface MembershipProtectedQueryResultConfiguration {
- /**
- * Configuration for protected query results.
- */
- outputConfiguration: MembershipProtectedQueryOutputConfiguration;
- /**
- * The unique ARN for an IAM role that is used by Clean Rooms to write protected query results to the result location, given by the member who can receive results.
- */
- roleArn?: RoleArn;
- }
- export interface MembershipQueryComputePaymentConfig {
- /**
- * Indicates whether the collaboration member has accepted to pay for query compute costs (TRUE) or has not accepted to pay for query compute costs (FALSE). If the collaboration creator has not specified anyone to pay for query compute costs, then the member who can query is the default payer. An error message is returned for the following reasons: If you set the value to FALSE but you are responsible to pay for query compute costs. If you set the value to TRUE but you are not responsible to pay for query compute costs.
- */
- isResponsible: Boolean;
- }
- export type MembershipQueryLogStatus = "ENABLED"|"DISABLED"|string;
- export type MembershipStatus = "ACTIVE"|"REMOVED"|"COLLABORATION_DELETED"|string;
- export interface MembershipSummary {
- /**
- * The unique ID for the membership's collaboration.
- */
- id: UUID;
- /**
- * The unique ARN for the membership.
- */
- arn: MembershipArn;
- /**
- * The unique ARN for the membership's associated collaboration.
- */
- collaborationArn: CollaborationArn;
- /**
- * The unique ID for the membership's collaboration.
- */
- collaborationId: CollaborationIdentifier;
- /**
- * The identifier of the Amazon Web Services principal that created the collaboration. Currently only supports Amazon Web Services account ID.
- */
- collaborationCreatorAccountId: AccountId;
- /**
- * The display name of the collaboration creator.
- */
- collaborationCreatorDisplayName: DisplayName;
- /**
- * The name for the membership's collaboration.
- */
- collaborationName: CollaborationName;
- /**
- * The time when the membership was created.
- */
- createTime: Timestamp;
- /**
- * The time the membership metadata was last updated.
- */
- updateTime: Timestamp;
- /**
- * The status of the membership.
- */
- status: MembershipStatus;
- /**
- * The abilities granted to the collaboration member.
- */
- memberAbilities: MemberAbilities;
- /**
- * The payment responsibilities accepted by the collaboration member.
- */
- paymentConfiguration: MembershipPaymentConfiguration;
- }
- export type MembershipSummaryList = MembershipSummary[];
- export type PaginationToken = string;
- export type ParameterMap = {[key: string]: ParameterValue};
- export type ParameterName = string;
- export type ParameterType = "SMALLINT"|"INTEGER"|"BIGINT"|"DECIMAL"|"REAL"|"DOUBLE_PRECISION"|"BOOLEAN"|"CHAR"|"VARCHAR"|"DATE"|"TIMESTAMP"|"TIMESTAMPTZ"|"TIME"|"TIMETZ"|"VARBYTE"|string;
- export type ParameterValue = string;
- export interface PaymentConfiguration {
- /**
- * The collaboration member's payment responsibilities set by the collaboration creator for query compute costs.
- */
- queryCompute: QueryComputePaymentConfig;
- }
- export interface PreviewPrivacyImpactInput {
- /**
- * A unique identifier for one of your memberships for a collaboration. Accepts a membership ID.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * Specifies the desired epsilon and noise parameters to preview.
- */
- parameters: PreviewPrivacyImpactParametersInput;
- }
- export interface PreviewPrivacyImpactOutput {
- /**
- * An estimate of the number of aggregation functions that the member who can query can run given the epsilon and noise parameters. This does not change the privacy budget.
- */
- privacyImpact: PrivacyImpact;
- }
- export interface PreviewPrivacyImpactParametersInput {
- /**
- * An array that specifies the epsilon and noise parameters.
- */
- differentialPrivacy?: DifferentialPrivacyPreviewParametersInput;
- }
- export interface PrivacyBudget {
- /**
- * An object that specifies the epsilon parameter and the utility in terms of total aggregations, as well as the remaining aggregations available.
- */
- differentialPrivacy?: DifferentialPrivacyPrivacyBudget;
- }
- export interface PrivacyBudgetSummary {
- /**
- * The unique identifier of the privacy budget.
- */
- id: UUID;
- /**
- * The unique identifier of the privacy budget template.
- */
- privacyBudgetTemplateId: PrivacyBudgetTemplateIdentifier;
- /**
- * The ARN of the privacy budget template.
- */
- privacyBudgetTemplateArn: PrivacyBudgetTemplateArn;
- /**
- * The identifier for a membership resource.
- */
- membershipId: MembershipIdentifier;
- /**
- * The Amazon Resource Name (ARN) of the member who created the privacy budget summary.
- */
- membershipArn: MembershipArn;
- /**
- * The unique identifier of the collaboration that contains this privacy budget.
- */
- collaborationId: UUID;
- /**
- * The ARN of the collaboration that contains this privacy budget.
- */
- collaborationArn: CollaborationArn;
- /**
- * Specifies the type of the privacy budget.
- */
- type: PrivacyBudgetType;
- /**
- * The time at which the privacy budget was created.
- */
- createTime: Timestamp;
- /**
- * The most recent time at which the privacy budget was updated.
- */
- updateTime: Timestamp;
- /**
- * The provided privacy budget.
- */
- budget: PrivacyBudget;
- }
- export type PrivacyBudgetSummaryList = PrivacyBudgetSummary[];
- export interface PrivacyBudgetTemplate {
- /**
- * The unique identifier of the privacy budget template.
- */
- id: PrivacyBudgetTemplateIdentifier;
- /**
- * The ARN of the privacy budget template.
- */
- arn: PrivacyBudgetTemplateArn;
- /**
- * The identifier for a membership resource.
- */
- membershipId: UUID;
- /**
- * The Amazon Resource Name (ARN) of the member who created the privacy budget template.
- */
- membershipArn: MembershipArn;
- /**
- * The unique ID of the collaboration that contains this privacy budget template.
- */
- collaborationId: UUID;
- /**
- * The ARN of the collaboration that contains this privacy budget template.
- */
- collaborationArn: CollaborationArn;
- /**
- * The time at which the privacy budget template was created.
- */
- createTime: Timestamp;
- /**
- * The most recent time at which the privacy budget template was updated.
- */
- updateTime: Timestamp;
- /**
- * Specifies the type of the privacy budget template.
- */
- privacyBudgetType: PrivacyBudgetType;
- /**
- * How often the privacy budget refreshes. If you plan to regularly bring new data into the collaboration, use CALENDAR_MONTH to automatically get a new privacy budget for the collaboration every calendar month. Choosing this option allows arbitrary amounts of information to be revealed about rows of the data when repeatedly queried across refreshes. Avoid choosing this if the same rows will be repeatedly queried between privacy budget refreshes.
- */
- autoRefresh: PrivacyBudgetTemplateAutoRefresh;
- /**
- * Specifies the epislon and noise parameters for the privacy budget template.
- */
- parameters: PrivacyBudgetTemplateParametersOutput;
- }
- export type PrivacyBudgetTemplateArn = string;
- export type PrivacyBudgetTemplateAutoRefresh = "CALENDAR_MONTH"|"NONE"|string;
- export type PrivacyBudgetTemplateIdentifier = string;
- export interface PrivacyBudgetTemplateParametersInput {
- /**
- * An object that specifies the epsilon and noise parameters.
- */
- differentialPrivacy?: DifferentialPrivacyTemplateParametersInput;
- }
- export interface PrivacyBudgetTemplateParametersOutput {
- /**
- * The epsilon and noise parameters.
- */
- differentialPrivacy?: DifferentialPrivacyTemplateParametersOutput;
- }
- export interface PrivacyBudgetTemplateSummary {
- /**
- * The unique identifier of the privacy budget template.
- */
- id: PrivacyBudgetTemplateIdentifier;
- /**
- * The ARN of the privacy budget template.
- */
- arn: PrivacyBudgetTemplateArn;
- /**
- * The identifier for a membership resource.
- */
- membershipId: UUID;
- /**
- * The Amazon Resource Name (ARN) of the member who created the privacy budget template.
- */
- membershipArn: MembershipArn;
- /**
- * The unique ID of the collaboration that contains this privacy budget template.
- */
- collaborationId: UUID;
- /**
- * The ARN of the collaboration that contains this privacy budget template.
- */
- collaborationArn: CollaborationArn;
- /**
- * The type of the privacy budget template.
- */
- privacyBudgetType: PrivacyBudgetType;
- /**
- * The time at which the privacy budget template was created.
- */
- createTime: Timestamp;
- /**
- * The most recent time at which the privacy budget template was updated.
- */
- updateTime: Timestamp;
- }
- export type PrivacyBudgetTemplateSummaryList = PrivacyBudgetTemplateSummary[];
- export interface PrivacyBudgetTemplateUpdateParameters {
- /**
- * An object that specifies the new values for the epsilon and noise parameters.
- */
- differentialPrivacy?: DifferentialPrivacyTemplateUpdateParameters;
- }
- export type PrivacyBudgetType = "DIFFERENTIAL_PRIVACY"|string;
- export interface PrivacyImpact {
- /**
- * An object that lists the number and type of aggregation functions you can perform.
- */
- differentialPrivacy?: DifferentialPrivacyPrivacyImpact;
- }
- export interface ProtectedQuery {
- /**
- * The identifier for a protected query instance.
- */
- id: UUID;
- /**
- * The identifier for the membership.
- */
- membershipId: UUID;
- /**
- * The ARN of the membership.
- */
- membershipArn: MembershipArn;
- /**
- * The time at which the protected query was created.
- */
- createTime: Timestamp;
- /**
- * The protected query SQL parameters.
- */
- sqlParameters?: ProtectedQuerySQLParameters;
- /**
- * The status of the query.
- */
- status: ProtectedQueryStatus;
- /**
- * Contains any details needed to write the query results.
- */
- resultConfiguration?: ProtectedQueryResultConfiguration;
- /**
- * Statistics about protected query execution.
- */
- statistics?: ProtectedQueryStatistics;
- /**
- * The result of the protected query.
- */
- result?: ProtectedQueryResult;
- /**
- * An error thrown by the protected query.
- */
- error?: ProtectedQueryError;
- /**
- * The sensitivity parameters of the differential privacy results of the protected query.
- */
- differentialPrivacy?: DifferentialPrivacyParameters;
- }
- export interface ProtectedQueryError {
- /**
- * A description of why the query failed.
- */
- message: String;
- /**
- * An error code for the error.
- */
- code: String;
- }
- export type ProtectedQueryIdentifier = string;
- export type ProtectedQueryMemberOutputList = ProtectedQuerySingleMemberOutput[];
- export interface ProtectedQueryOutput {
- /**
- * If present, the output for a protected query with an `S3` output type.
- */
- s3?: ProtectedQueryS3Output;
- /**
- * The list of member Amazon Web Services account(s) that received the results of the query.
- */
- memberList?: ProtectedQueryMemberOutputList;
- }
- export interface ProtectedQueryOutputConfiguration {
- /**
- * Required configuration for a protected query with an `S3` output type.
- */
- s3?: ProtectedQueryS3OutputConfiguration;
- }
- export interface ProtectedQueryResult {
- /**
- * The output of the protected query.
- */
- output: ProtectedQueryOutput;
- }
- export interface ProtectedQueryResultConfiguration {
- /**
- * Configuration for protected query results.
- */
- outputConfiguration: ProtectedQueryOutputConfiguration;
- }
- export interface ProtectedQueryS3Output {
- /**
- * The S3 location of the result.
- */
- location: String;
- }
- export interface ProtectedQueryS3OutputConfiguration {
- /**
- * Intended file format of the result.
- */
- resultFormat: ResultFormat;
- /**
- * The S3 bucket to unload the protected query results.
- */
- bucket: ProtectedQueryS3OutputConfigurationBucketString;
- /**
- * The S3 prefix to unload the protected query results.
- */
- keyPrefix?: KeyPrefix;
- }
- export type ProtectedQueryS3OutputConfigurationBucketString = string;
- export interface ProtectedQuerySQLParameters {
- /**
- * The query string to be submitted.
- */
- queryString?: ProtectedQuerySQLParametersQueryStringString;
- /**
- * The Amazon Resource Name (ARN) associated with the analysis template within a collaboration.
- */
- analysisTemplateArn?: AnalysisTemplateArn;
- /**
- * The protected query SQL parameters.
- */
- parameters?: ParameterMap;
- }
- export type ProtectedQuerySQLParametersQueryStringString = string;
- export interface ProtectedQuerySingleMemberOutput {
- /**
- * The Amazon Web Services account ID of the member in the collaboration who can receive results for the query.
- */
- accountId: AccountId;
- }
- export interface ProtectedQueryStatistics {
- /**
- * The duration of the Protected Query, from creation until query completion.
- */
- totalDurationInMillis?: Long;
- }
- export type ProtectedQueryStatus = "SUBMITTED"|"STARTED"|"CANCELLED"|"CANCELLING"|"FAILED"|"SUCCESS"|"TIMED_OUT"|string;
- export interface ProtectedQuerySummary {
- /**
- * The unique ID of the protected query.
- */
- id: UUID;
- /**
- * The unique ID for the membership that initiated the protected query.
- */
- membershipId: UUID;
- /**
- * The unique ARN for the membership that initiated the protected query.
- */
- membershipArn: MembershipArn;
- /**
- * The time the protected query was created.
- */
- createTime: Timestamp;
- /**
- * The status of the protected query. Value values are `SUBMITTED`, `STARTED`, `CANCELLED`, `CANCELLING`, `FAILED`, `SUCCESS`, `TIMED_OUT`.
- */
- status: ProtectedQueryStatus;
- }
- export type ProtectedQuerySummaryList = ProtectedQuerySummary[];
- export type ProtectedQueryType = "SQL"|string;
- export interface QueryComputePaymentConfig {
- /**
- * Indicates whether the collaboration creator has configured the collaboration member to pay for query compute costs (TRUE) or has not configured the collaboration member to pay for query compute costs (FALSE). Exactly one member can be configured to pay for query compute costs. An error is returned if the collaboration creator sets a TRUE value for more than one member in the collaboration. If the collaboration creator hasn't specified anyone as the member paying for query compute costs, then the member who can query is the default payer. An error is returned if the collaboration creator sets a FALSE value for the member who can query.
- */
- isResponsible: Boolean;
- }
- export type QueryTables = TableAlias[];
- export type ResourceAlias = string;
- export type ResourceDescription = string;
- export type ResultFormat = "CSV"|"PARQUET"|string;
- export type RoleArn = string;
- export type ScalarFunctions = "ABS"|"CAST"|"CEILING"|"COALESCE"|"CONVERT"|"CURRENT_DATE"|"DATEADD"|"EXTRACT"|"FLOOR"|"GETDATE"|"LN"|"LOG"|"LOWER"|"ROUND"|"RTRIM"|"SQRT"|"SUBSTRING"|"TO_CHAR"|"TO_DATE"|"TO_NUMBER"|"TO_TIMESTAMP"|"TRIM"|"TRUNC"|"UPPER"|string;
- export type ScalarFunctionsList = ScalarFunctions[];
- export interface Schema {
- /**
- * The columns for the relation this schema represents.
- */
- columns: ColumnList;
- /**
- * The partition keys for the dataset underlying this schema.
- */
- partitionKeys: ColumnList;
- /**
- * The analysis rule types associated with the schema. Currently, only one entry is present.
- */
- analysisRuleTypes: AnalysisRuleTypeList;
- /**
- * The analysis method for the schema. The only valid value is currently DIRECT_QUERY.
- */
- analysisMethod?: AnalysisMethod;
- /**
- * The unique account ID for the Amazon Web Services account that owns the schema.
- */
- creatorAccountId: AccountId;
- /**
- * A name for the schema. The schema relation is referred to by this name when queried by a protected query.
- */
- name: TableAlias;
- /**
- * The unique ID for the collaboration that the schema belongs to.
- */
- collaborationId: UUID;
- /**
- * The unique ARN for the collaboration that the schema belongs to.
- */
- collaborationArn: CollaborationArn;
- /**
- * A description for the schema.
- */
- description: TableDescription;
- /**
- * The time the schema was created.
- */
- createTime: Timestamp;
- /**
- * The time the schema was last updated.
- */
- updateTime: Timestamp;
- /**
- * The type of schema. The only valid value is currently `TABLE`.
- */
- type: SchemaType;
- /**
- * Details about the status of the schema. Currently, only one entry is present.
- */
- schemaStatusDetails: SchemaStatusDetailList;
- }
- export type SchemaAnalysisRuleList = AnalysisRule[];
- export interface SchemaAnalysisRuleRequest {
- /**
- * The name of the analysis rule schema that you are requesting.
- */
- name: TableAlias;
- /**
- * The type of analysis rule schema that you are requesting.
- */
- type: AnalysisRuleType;
- }
- export type SchemaAnalysisRuleRequestList = SchemaAnalysisRuleRequest[];
- export type SchemaConfiguration = "DIFFERENTIAL_PRIVACY"|string;
- export type SchemaConfigurationList = SchemaConfiguration[];
- export type SchemaList = Schema[];
- export type SchemaStatus = "READY"|"NOT_READY"|string;
- export interface SchemaStatusDetail {
- /**
- * The status of the schema.
- */
- status: SchemaStatus;
- /**
- * The reasons why the schema status is set to its current state.
- */
- reasons?: SchemaStatusReasonList;
- /**
- * The analysis rule type for which the schema status has been evaluated.
- */
- analysisRuleType?: AnalysisRuleType;
- /**
- * The configuration details of the schema analysis rule for the given type.
- */
- configurations?: SchemaConfigurationList;
- }
- export type SchemaStatusDetailList = SchemaStatusDetail[];
- export interface SchemaStatusReason {
- /**
- * The schema status reason code.
- */
- code: SchemaStatusReasonCode;
- /**
- * An explanation of the schema status reason code.
- */
- message: String;
- }
- export type SchemaStatusReasonCode = "ANALYSIS_RULE_MISSING"|"ANALYSIS_TEMPLATES_NOT_CONFIGURED"|"ANALYSIS_PROVIDERS_NOT_CONFIGURED"|"DIFFERENTIAL_PRIVACY_POLICY_NOT_CONFIGURED"|string;
- export type SchemaStatusReasonList = SchemaStatusReason[];
- export interface SchemaSummary {
- /**
- * The name for the schema object.
- */
- name: TableAlias;
- /**
- * The type of schema object. The only valid schema type is currently `TABLE`.
- */
- type: SchemaType;
- /**
- * The unique account ID for the Amazon Web Services account that owns the schema.
- */
- creatorAccountId: AccountId;
- /**
- * The time the schema object was created.
- */
- createTime: Timestamp;
- /**
- * The time the schema object was last updated.
- */
- updateTime: Timestamp;
- /**
- * The unique ID for the collaboration that the schema belongs to.
- */
- collaborationId: UUID;
- /**
- * The unique ARN for the collaboration that the schema belongs to.
- */
- collaborationArn: CollaborationArn;
- /**
- * The types of analysis rules that are associated with this schema object.
- */
- analysisRuleTypes: AnalysisRuleTypeList;
- /**
- * The analysis method for the associated schema. The only valid value is currently `DIRECT_QUERY`.
- */
- analysisMethod?: AnalysisMethod;
- }
- export type SchemaSummaryList = SchemaSummary[];
- export type SchemaType = "TABLE"|string;
- export interface StartProtectedQueryInput {
- /**
- * The type of the protected query to be started.
- */
- type: ProtectedQueryType;
- /**
- * A unique identifier for the membership to run this query against. Currently accepts a membership ID.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * The protected SQL query parameters.
- */
- sqlParameters: ProtectedQuerySQLParameters;
- /**
- * The details needed to write the query results.
- */
- resultConfiguration?: ProtectedQueryResultConfiguration;
- }
- export interface StartProtectedQueryOutput {
- /**
- * The protected query.
- */
- protectedQuery: ProtectedQuery;
- }
- export type String = string;
- export type TableAlias = string;
- export type TableAliasList = TableAlias[];
- export type TableDescription = string;
- export interface TableReference {
- /**
- * If present, a reference to the Glue table referred to by this table reference.
- */
- glue?: GlueTableReference;
- }
- export type TagKey = string;
- export type TagKeys = TagKey[];
- export type TagMap = {[key: string]: TagValue};
- export interface TagResourceInput {
- /**
- * The Amazon Resource Name (ARN) associated with the resource you want to tag.
- */
- resourceArn: CleanroomsArn;
- /**
- * A map of objects specifying each key name and value.
- */
- tags: TagMap;
- }
- export interface TagResourceOutput {
- }
- export type TagValue = string;
- export type TargetProtectedQueryStatus = "CANCELLED"|string;
- export type Timestamp = Date;
- export type UUID = string;
- export interface UntagResourceInput {
- /**
- * The Amazon Resource Name (ARN) associated with the resource you want to remove the tag from.
- */
- resourceArn: CleanroomsArn;
- /**
- * A list of key names of tags to be removed.
- */
- tagKeys: TagKeys;
- }
- export interface UntagResourceOutput {
- }
- export interface UpdateAnalysisTemplateInput {
- /**
- * The identifier for a membership resource.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * The identifier for the analysis template resource.
- */
- analysisTemplateIdentifier: AnalysisTemplateIdentifier;
- /**
- * A new description for the analysis template.
- */
- description?: ResourceDescription;
- }
- export interface UpdateAnalysisTemplateOutput {
- /**
- * The analysis template.
- */
- analysisTemplate: AnalysisTemplate;
- }
- export interface UpdateCollaborationInput {
- /**
- * The identifier for the collaboration.
- */
- collaborationIdentifier: CollaborationIdentifier;
- /**
- * A human-readable identifier provided by the collaboration owner. Display names are not unique.
- */
- name?: CollaborationName;
- /**
- * A description of the collaboration.
- */
- description?: CollaborationDescription;
- }
- export interface UpdateCollaborationOutput {
- /**
- * The entire collaboration that has been updated.
- */
- collaboration: Collaboration;
- }
- export interface UpdateConfiguredAudienceModelAssociationInput {
- /**
- * A unique identifier for the configured audience model association that you want to update.
- */
- configuredAudienceModelAssociationIdentifier: ConfiguredAudienceModelAssociationIdentifier;
- /**
- * A unique identifier of the membership that contains the configured audience model association that you want to update.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * A new description for the configured audience model association.
- */
- description?: ResourceDescription;
- /**
- * A new name for the configured audience model association.
- */
- name?: ConfiguredAudienceModelAssociationName;
- }
- export interface UpdateConfiguredAudienceModelAssociationOutput {
- /**
- * Details about the configured audience model association that you updated.
- */
- configuredAudienceModelAssociation: ConfiguredAudienceModelAssociation;
- }
- export interface UpdateConfiguredTableAnalysisRuleInput {
- /**
- * The unique identifier for the configured table that the analysis rule applies to. Currently accepts the configured table ID.
- */
- configuredTableIdentifier: ConfiguredTableIdentifier;
- /**
- * The analysis rule type to be updated. Configured table analysis rules are uniquely identified by their configured table identifier and analysis rule type.
- */
- analysisRuleType: ConfiguredTableAnalysisRuleType;
- /**
- * The new analysis rule policy for the configured table analysis rule.
- */
- analysisRulePolicy: ConfiguredTableAnalysisRulePolicy;
- }
- export interface UpdateConfiguredTableAnalysisRuleOutput {
- /**
- * The entire updated analysis rule.
- */
- analysisRule: ConfiguredTableAnalysisRule;
- }
- export interface UpdateConfiguredTableAssociationInput {
- /**
- * The unique identifier for the configured table association to update. Currently accepts the configured table association ID.
- */
- configuredTableAssociationIdentifier: ConfiguredTableAssociationIdentifier;
- /**
- * The unique ID for the membership that the configured table association belongs to.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * A new description for the configured table association.
- */
- description?: TableDescription;
- /**
- * The service will assume this role to access catalog metadata and query the table.
- */
- roleArn?: RoleArn;
- }
- export interface UpdateConfiguredTableAssociationOutput {
- /**
- * The entire updated configured table association.
- */
- configuredTableAssociation: ConfiguredTableAssociation;
- }
- export interface UpdateConfiguredTableInput {
- /**
- * The identifier for the configured table to update. Currently accepts the configured table ID.
- */
- configuredTableIdentifier: ConfiguredTableIdentifier;
- /**
- * A new name for the configured table.
- */
- name?: DisplayName;
- /**
- * A new description for the configured table.
- */
- description?: TableDescription;
- }
- export interface UpdateConfiguredTableOutput {
- /**
- * The updated configured table.
- */
- configuredTable: ConfiguredTable;
- }
- export interface UpdateMembershipInput {
- /**
- * The unique identifier of the membership.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * An indicator as to whether query logging has been enabled or disabled for the membership.
- */
- queryLogStatus?: MembershipQueryLogStatus;
- /**
- * The default protected query result configuration as specified by the member who can receive results.
- */
- defaultResultConfiguration?: MembershipProtectedQueryResultConfiguration;
- }
- export interface UpdateMembershipOutput {
- membership: Membership;
- }
- export interface UpdatePrivacyBudgetTemplateInput {
- /**
- * A unique identifier for one of your memberships for a collaboration. The privacy budget template is updated in the collaboration that this membership belongs to. Accepts a membership ID.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * A unique identifier for your privacy budget template that you want to update.
- */
- privacyBudgetTemplateIdentifier: PrivacyBudgetTemplateIdentifier;
- /**
- * Specifies the type of the privacy budget template.
- */
- privacyBudgetType: PrivacyBudgetType;
- /**
- * Specifies the epsilon and noise parameters for the privacy budget template.
- */
- parameters?: PrivacyBudgetTemplateUpdateParameters;
- }
- export interface UpdatePrivacyBudgetTemplateOutput {
- /**
- * Summary of the privacy budget template.
- */
- privacyBudgetTemplate: PrivacyBudgetTemplate;
- }
- export interface UpdateProtectedQueryInput {
- /**
- * The identifier for a member of a protected query instance.
- */
- membershipIdentifier: MembershipIdentifier;
- /**
- * The identifier for a protected query instance.
- */
- protectedQueryIdentifier: ProtectedQueryIdentifier;
- /**
- * The target status of a query. Used to update the execution status of a currently running query.
- */
- targetStatus: TargetProtectedQueryStatus;
- }
- export interface UpdateProtectedQueryOutput {
- /**
- * The protected query output.
- */
- protectedQuery: ProtectedQuery;
- }
- export type UsersNoisePerQuery = number;
- /**
- * 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.
- */
- export type apiVersion = "2022-02-17"|"latest"|string;
- export interface ClientApiVersions {
- /**
- * 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.
- */
- apiVersion?: apiVersion;
- }
- export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
- /**
- * Contains interfaces for use with the CleanRooms client.
- */
- export import Types = CleanRooms;
- }
- export = CleanRooms;
|