deadline.d.ts 219 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {WaiterConfiguration} from '../lib/service';
  6. import {ServiceConfigurationOptions} from '../lib/service';
  7. import {ConfigBase as Config} from '../lib/config-base';
  8. interface Blob {}
  9. declare class Deadline extends Service {
  10. /**
  11. * Constructs a service object. This object has one method for each API operation.
  12. */
  13. constructor(options?: Deadline.Types.ClientConfiguration)
  14. config: Config & Deadline.Types.ClientConfiguration;
  15. /**
  16. * Assigns a farm membership level to a member.
  17. */
  18. associateMemberToFarm(params: Deadline.Types.AssociateMemberToFarmRequest, callback?: (err: AWSError, data: Deadline.Types.AssociateMemberToFarmResponse) => void): Request<Deadline.Types.AssociateMemberToFarmResponse, AWSError>;
  19. /**
  20. * Assigns a farm membership level to a member.
  21. */
  22. associateMemberToFarm(callback?: (err: AWSError, data: Deadline.Types.AssociateMemberToFarmResponse) => void): Request<Deadline.Types.AssociateMemberToFarmResponse, AWSError>;
  23. /**
  24. * Assigns a fleet membership level to a member.
  25. */
  26. associateMemberToFleet(params: Deadline.Types.AssociateMemberToFleetRequest, callback?: (err: AWSError, data: Deadline.Types.AssociateMemberToFleetResponse) => void): Request<Deadline.Types.AssociateMemberToFleetResponse, AWSError>;
  27. /**
  28. * Assigns a fleet membership level to a member.
  29. */
  30. associateMemberToFleet(callback?: (err: AWSError, data: Deadline.Types.AssociateMemberToFleetResponse) => void): Request<Deadline.Types.AssociateMemberToFleetResponse, AWSError>;
  31. /**
  32. * Assigns a job membership level to a member
  33. */
  34. associateMemberToJob(params: Deadline.Types.AssociateMemberToJobRequest, callback?: (err: AWSError, data: Deadline.Types.AssociateMemberToJobResponse) => void): Request<Deadline.Types.AssociateMemberToJobResponse, AWSError>;
  35. /**
  36. * Assigns a job membership level to a member
  37. */
  38. associateMemberToJob(callback?: (err: AWSError, data: Deadline.Types.AssociateMemberToJobResponse) => void): Request<Deadline.Types.AssociateMemberToJobResponse, AWSError>;
  39. /**
  40. * Assigns a queue membership level to a member
  41. */
  42. associateMemberToQueue(params: Deadline.Types.AssociateMemberToQueueRequest, callback?: (err: AWSError, data: Deadline.Types.AssociateMemberToQueueResponse) => void): Request<Deadline.Types.AssociateMemberToQueueResponse, AWSError>;
  43. /**
  44. * Assigns a queue membership level to a member
  45. */
  46. associateMemberToQueue(callback?: (err: AWSError, data: Deadline.Types.AssociateMemberToQueueResponse) => void): Request<Deadline.Types.AssociateMemberToQueueResponse, AWSError>;
  47. /**
  48. * Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.
  49. */
  50. assumeFleetRoleForRead(params: Deadline.Types.AssumeFleetRoleForReadRequest, callback?: (err: AWSError, data: Deadline.Types.AssumeFleetRoleForReadResponse) => void): Request<Deadline.Types.AssumeFleetRoleForReadResponse, AWSError>;
  51. /**
  52. * Get Amazon Web Services credentials from the fleet role. The IAM permissions of the credentials are scoped down to have read-only access.
  53. */
  54. assumeFleetRoleForRead(callback?: (err: AWSError, data: Deadline.Types.AssumeFleetRoleForReadResponse) => void): Request<Deadline.Types.AssumeFleetRoleForReadResponse, AWSError>;
  55. /**
  56. * Get credentials from the fleet role for a worker.
  57. */
  58. assumeFleetRoleForWorker(params: Deadline.Types.AssumeFleetRoleForWorkerRequest, callback?: (err: AWSError, data: Deadline.Types.AssumeFleetRoleForWorkerResponse) => void): Request<Deadline.Types.AssumeFleetRoleForWorkerResponse, AWSError>;
  59. /**
  60. * Get credentials from the fleet role for a worker.
  61. */
  62. assumeFleetRoleForWorker(callback?: (err: AWSError, data: Deadline.Types.AssumeFleetRoleForWorkerResponse) => void): Request<Deadline.Types.AssumeFleetRoleForWorkerResponse, AWSError>;
  63. /**
  64. * Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.
  65. */
  66. assumeQueueRoleForRead(params: Deadline.Types.AssumeQueueRoleForReadRequest, callback?: (err: AWSError, data: Deadline.Types.AssumeQueueRoleForReadResponse) => void): Request<Deadline.Types.AssumeQueueRoleForReadResponse, AWSError>;
  67. /**
  68. * Gets Amazon Web Services credentials from the queue role. The IAM permissions of the credentials are scoped down to have read-only access.
  69. */
  70. assumeQueueRoleForRead(callback?: (err: AWSError, data: Deadline.Types.AssumeQueueRoleForReadResponse) => void): Request<Deadline.Types.AssumeQueueRoleForReadResponse, AWSError>;
  71. /**
  72. * Allows a user to assume a role for a queue.
  73. */
  74. assumeQueueRoleForUser(params: Deadline.Types.AssumeQueueRoleForUserRequest, callback?: (err: AWSError, data: Deadline.Types.AssumeQueueRoleForUserResponse) => void): Request<Deadline.Types.AssumeQueueRoleForUserResponse, AWSError>;
  75. /**
  76. * Allows a user to assume a role for a queue.
  77. */
  78. assumeQueueRoleForUser(callback?: (err: AWSError, data: Deadline.Types.AssumeQueueRoleForUserResponse) => void): Request<Deadline.Types.AssumeQueueRoleForUserResponse, AWSError>;
  79. /**
  80. * Allows a worker to assume a queue role.
  81. */
  82. assumeQueueRoleForWorker(params: Deadline.Types.AssumeQueueRoleForWorkerRequest, callback?: (err: AWSError, data: Deadline.Types.AssumeQueueRoleForWorkerResponse) => void): Request<Deadline.Types.AssumeQueueRoleForWorkerResponse, AWSError>;
  83. /**
  84. * Allows a worker to assume a queue role.
  85. */
  86. assumeQueueRoleForWorker(callback?: (err: AWSError, data: Deadline.Types.AssumeQueueRoleForWorkerResponse) => void): Request<Deadline.Types.AssumeQueueRoleForWorkerResponse, AWSError>;
  87. /**
  88. * Get batched job details for a worker.
  89. */
  90. batchGetJobEntity(params: Deadline.Types.BatchGetJobEntityRequest, callback?: (err: AWSError, data: Deadline.Types.BatchGetJobEntityResponse) => void): Request<Deadline.Types.BatchGetJobEntityResponse, AWSError>;
  91. /**
  92. * Get batched job details for a worker.
  93. */
  94. batchGetJobEntity(callback?: (err: AWSError, data: Deadline.Types.BatchGetJobEntityResponse) => void): Request<Deadline.Types.BatchGetJobEntityResponse, AWSError>;
  95. /**
  96. * Copies a job template to an Amazon S3 bucket.
  97. */
  98. copyJobTemplate(params: Deadline.Types.CopyJobTemplateRequest, callback?: (err: AWSError, data: Deadline.Types.CopyJobTemplateResponse) => void): Request<Deadline.Types.CopyJobTemplateResponse, AWSError>;
  99. /**
  100. * Copies a job template to an Amazon S3 bucket.
  101. */
  102. copyJobTemplate(callback?: (err: AWSError, data: Deadline.Types.CopyJobTemplateResponse) => void): Request<Deadline.Types.CopyJobTemplateResponse, AWSError>;
  103. /**
  104. * Creates a budget to set spending thresholds for your rendering activity.
  105. */
  106. createBudget(params: Deadline.Types.CreateBudgetRequest, callback?: (err: AWSError, data: Deadline.Types.CreateBudgetResponse) => void): Request<Deadline.Types.CreateBudgetResponse, AWSError>;
  107. /**
  108. * Creates a budget to set spending thresholds for your rendering activity.
  109. */
  110. createBudget(callback?: (err: AWSError, data: Deadline.Types.CreateBudgetResponse) => void): Request<Deadline.Types.CreateBudgetResponse, AWSError>;
  111. /**
  112. * Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.
  113. */
  114. createFarm(params: Deadline.Types.CreateFarmRequest, callback?: (err: AWSError, data: Deadline.Types.CreateFarmResponse) => void): Request<Deadline.Types.CreateFarmResponse, AWSError>;
  115. /**
  116. * Creates a farm to allow space for queues and fleets. Farms are the space where the components of your renders gather and are pieced together in the cloud. Farms contain budgets and allow you to enforce permissions. Deadline Cloud farms are a useful container for large projects.
  117. */
  118. createFarm(callback?: (err: AWSError, data: Deadline.Types.CreateFarmResponse) => void): Request<Deadline.Types.CreateFarmResponse, AWSError>;
  119. /**
  120. * Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.
  121. */
  122. createFleet(params: Deadline.Types.CreateFleetRequest, callback?: (err: AWSError, data: Deadline.Types.CreateFleetResponse) => void): Request<Deadline.Types.CreateFleetResponse, AWSError>;
  123. /**
  124. * Creates a fleet. Fleets gather information relating to compute, or capacity, for renders within your farms. You can choose to manage your own capacity or opt to have fleets fully managed by Deadline Cloud.
  125. */
  126. createFleet(callback?: (err: AWSError, data: Deadline.Types.CreateFleetResponse) => void): Request<Deadline.Types.CreateFleetResponse, AWSError>;
  127. /**
  128. * Creates a job. A job is a render submission submitted by a user. It contains specific job properties outlined as steps and tasks.
  129. */
  130. createJob(params: Deadline.Types.CreateJobRequest, callback?: (err: AWSError, data: Deadline.Types.CreateJobResponse) => void): Request<Deadline.Types.CreateJobResponse, AWSError>;
  131. /**
  132. * Creates a job. A job is a render submission submitted by a user. It contains specific job properties outlined as steps and tasks.
  133. */
  134. createJob(callback?: (err: AWSError, data: Deadline.Types.CreateJobResponse) => void): Request<Deadline.Types.CreateJobResponse, AWSError>;
  135. /**
  136. * Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
  137. */
  138. createLicenseEndpoint(params: Deadline.Types.CreateLicenseEndpointRequest, callback?: (err: AWSError, data: Deadline.Types.CreateLicenseEndpointResponse) => void): Request<Deadline.Types.CreateLicenseEndpointResponse, AWSError>;
  139. /**
  140. * Creates a license endpoint to integrate your various licensed software used for rendering on Deadline Cloud.
  141. */
  142. createLicenseEndpoint(callback?: (err: AWSError, data: Deadline.Types.CreateLicenseEndpointResponse) => void): Request<Deadline.Types.CreateLicenseEndpointResponse, AWSError>;
  143. /**
  144. * Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.
  145. */
  146. createMonitor(params: Deadline.Types.CreateMonitorRequest, callback?: (err: AWSError, data: Deadline.Types.CreateMonitorResponse) => void): Request<Deadline.Types.CreateMonitorResponse, AWSError>;
  147. /**
  148. * Creates an Amazon Web Services Deadline Cloud monitor that you can use to view your farms, queues, and fleets. After you submit a job, you can track the progress of the tasks and steps that make up the job, and then download the job's results.
  149. */
  150. createMonitor(callback?: (err: AWSError, data: Deadline.Types.CreateMonitorResponse) => void): Request<Deadline.Types.CreateMonitorResponse, AWSError>;
  151. /**
  152. * Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.
  153. */
  154. createQueue(params: Deadline.Types.CreateQueueRequest, callback?: (err: AWSError, data: Deadline.Types.CreateQueueResponse) => void): Request<Deadline.Types.CreateQueueResponse, AWSError>;
  155. /**
  156. * Creates a queue to coordinate the order in which jobs run on a farm. A queue can also specify where to pull resources and indicate where to output completed jobs.
  157. */
  158. createQueue(callback?: (err: AWSError, data: Deadline.Types.CreateQueueResponse) => void): Request<Deadline.Types.CreateQueueResponse, AWSError>;
  159. /**
  160. * Creates an environment for a queue that defines how jobs in the queue run.
  161. */
  162. createQueueEnvironment(params: Deadline.Types.CreateQueueEnvironmentRequest, callback?: (err: AWSError, data: Deadline.Types.CreateQueueEnvironmentResponse) => void): Request<Deadline.Types.CreateQueueEnvironmentResponse, AWSError>;
  163. /**
  164. * Creates an environment for a queue that defines how jobs in the queue run.
  165. */
  166. createQueueEnvironment(callback?: (err: AWSError, data: Deadline.Types.CreateQueueEnvironmentResponse) => void): Request<Deadline.Types.CreateQueueEnvironmentResponse, AWSError>;
  167. /**
  168. * Creates an association between a queue and a fleet.
  169. */
  170. createQueueFleetAssociation(params: Deadline.Types.CreateQueueFleetAssociationRequest, callback?: (err: AWSError, data: Deadline.Types.CreateQueueFleetAssociationResponse) => void): Request<Deadline.Types.CreateQueueFleetAssociationResponse, AWSError>;
  171. /**
  172. * Creates an association between a queue and a fleet.
  173. */
  174. createQueueFleetAssociation(callback?: (err: AWSError, data: Deadline.Types.CreateQueueFleetAssociationResponse) => void): Request<Deadline.Types.CreateQueueFleetAssociationResponse, AWSError>;
  175. /**
  176. * Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
  177. */
  178. createStorageProfile(params: Deadline.Types.CreateStorageProfileRequest, callback?: (err: AWSError, data: Deadline.Types.CreateStorageProfileResponse) => void): Request<Deadline.Types.CreateStorageProfileResponse, AWSError>;
  179. /**
  180. * Creates a storage profile that specifies the operating system, file type, and file location of resources used on a farm.
  181. */
  182. createStorageProfile(callback?: (err: AWSError, data: Deadline.Types.CreateStorageProfileResponse) => void): Request<Deadline.Types.CreateStorageProfileResponse, AWSError>;
  183. /**
  184. * Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.
  185. */
  186. createWorker(params: Deadline.Types.CreateWorkerRequest, callback?: (err: AWSError, data: Deadline.Types.CreateWorkerResponse) => void): Request<Deadline.Types.CreateWorkerResponse, AWSError>;
  187. /**
  188. * Creates a worker. A worker tells your instance how much processing power (vCPU), and memory (GiB) you’ll need to assemble the digital assets held within a particular instance. You can specify certain instance types to use, or let the worker know which instances types to exclude.
  189. */
  190. createWorker(callback?: (err: AWSError, data: Deadline.Types.CreateWorkerResponse) => void): Request<Deadline.Types.CreateWorkerResponse, AWSError>;
  191. /**
  192. * Deletes a budget.
  193. */
  194. deleteBudget(params: Deadline.Types.DeleteBudgetRequest, callback?: (err: AWSError, data: Deadline.Types.DeleteBudgetResponse) => void): Request<Deadline.Types.DeleteBudgetResponse, AWSError>;
  195. /**
  196. * Deletes a budget.
  197. */
  198. deleteBudget(callback?: (err: AWSError, data: Deadline.Types.DeleteBudgetResponse) => void): Request<Deadline.Types.DeleteBudgetResponse, AWSError>;
  199. /**
  200. * Deletes a farm.
  201. */
  202. deleteFarm(params: Deadline.Types.DeleteFarmRequest, callback?: (err: AWSError, data: Deadline.Types.DeleteFarmResponse) => void): Request<Deadline.Types.DeleteFarmResponse, AWSError>;
  203. /**
  204. * Deletes a farm.
  205. */
  206. deleteFarm(callback?: (err: AWSError, data: Deadline.Types.DeleteFarmResponse) => void): Request<Deadline.Types.DeleteFarmResponse, AWSError>;
  207. /**
  208. * Deletes a fleet.
  209. */
  210. deleteFleet(params: Deadline.Types.DeleteFleetRequest, callback?: (err: AWSError, data: Deadline.Types.DeleteFleetResponse) => void): Request<Deadline.Types.DeleteFleetResponse, AWSError>;
  211. /**
  212. * Deletes a fleet.
  213. */
  214. deleteFleet(callback?: (err: AWSError, data: Deadline.Types.DeleteFleetResponse) => void): Request<Deadline.Types.DeleteFleetResponse, AWSError>;
  215. /**
  216. * Deletes a license endpoint.
  217. */
  218. deleteLicenseEndpoint(params: Deadline.Types.DeleteLicenseEndpointRequest, callback?: (err: AWSError, data: Deadline.Types.DeleteLicenseEndpointResponse) => void): Request<Deadline.Types.DeleteLicenseEndpointResponse, AWSError>;
  219. /**
  220. * Deletes a license endpoint.
  221. */
  222. deleteLicenseEndpoint(callback?: (err: AWSError, data: Deadline.Types.DeleteLicenseEndpointResponse) => void): Request<Deadline.Types.DeleteLicenseEndpointResponse, AWSError>;
  223. /**
  224. * Deletes a metered product.
  225. */
  226. deleteMeteredProduct(params: Deadline.Types.DeleteMeteredProductRequest, callback?: (err: AWSError, data: Deadline.Types.DeleteMeteredProductResponse) => void): Request<Deadline.Types.DeleteMeteredProductResponse, AWSError>;
  227. /**
  228. * Deletes a metered product.
  229. */
  230. deleteMeteredProduct(callback?: (err: AWSError, data: Deadline.Types.DeleteMeteredProductResponse) => void): Request<Deadline.Types.DeleteMeteredProductResponse, AWSError>;
  231. /**
  232. * Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.
  233. */
  234. deleteMonitor(params: Deadline.Types.DeleteMonitorRequest, callback?: (err: AWSError, data: Deadline.Types.DeleteMonitorResponse) => void): Request<Deadline.Types.DeleteMonitorResponse, AWSError>;
  235. /**
  236. * Removes a Deadline Cloud monitor. After you delete a monitor, you can create a new one and attach farms to the monitor.
  237. */
  238. deleteMonitor(callback?: (err: AWSError, data: Deadline.Types.DeleteMonitorResponse) => void): Request<Deadline.Types.DeleteMonitorResponse, AWSError>;
  239. /**
  240. * Deletes a queue.
  241. */
  242. deleteQueue(params: Deadline.Types.DeleteQueueRequest, callback?: (err: AWSError, data: Deadline.Types.DeleteQueueResponse) => void): Request<Deadline.Types.DeleteQueueResponse, AWSError>;
  243. /**
  244. * Deletes a queue.
  245. */
  246. deleteQueue(callback?: (err: AWSError, data: Deadline.Types.DeleteQueueResponse) => void): Request<Deadline.Types.DeleteQueueResponse, AWSError>;
  247. /**
  248. * Deletes a queue environment.
  249. */
  250. deleteQueueEnvironment(params: Deadline.Types.DeleteQueueEnvironmentRequest, callback?: (err: AWSError, data: Deadline.Types.DeleteQueueEnvironmentResponse) => void): Request<Deadline.Types.DeleteQueueEnvironmentResponse, AWSError>;
  251. /**
  252. * Deletes a queue environment.
  253. */
  254. deleteQueueEnvironment(callback?: (err: AWSError, data: Deadline.Types.DeleteQueueEnvironmentResponse) => void): Request<Deadline.Types.DeleteQueueEnvironmentResponse, AWSError>;
  255. /**
  256. * Deletes a queue-fleet association.
  257. */
  258. deleteQueueFleetAssociation(params: Deadline.Types.DeleteQueueFleetAssociationRequest, callback?: (err: AWSError, data: Deadline.Types.DeleteQueueFleetAssociationResponse) => void): Request<Deadline.Types.DeleteQueueFleetAssociationResponse, AWSError>;
  259. /**
  260. * Deletes a queue-fleet association.
  261. */
  262. deleteQueueFleetAssociation(callback?: (err: AWSError, data: Deadline.Types.DeleteQueueFleetAssociationResponse) => void): Request<Deadline.Types.DeleteQueueFleetAssociationResponse, AWSError>;
  263. /**
  264. * Deletes a storage profile.
  265. */
  266. deleteStorageProfile(params: Deadline.Types.DeleteStorageProfileRequest, callback?: (err: AWSError, data: Deadline.Types.DeleteStorageProfileResponse) => void): Request<Deadline.Types.DeleteStorageProfileResponse, AWSError>;
  267. /**
  268. * Deletes a storage profile.
  269. */
  270. deleteStorageProfile(callback?: (err: AWSError, data: Deadline.Types.DeleteStorageProfileResponse) => void): Request<Deadline.Types.DeleteStorageProfileResponse, AWSError>;
  271. /**
  272. * Deletes a worker.
  273. */
  274. deleteWorker(params: Deadline.Types.DeleteWorkerRequest, callback?: (err: AWSError, data: Deadline.Types.DeleteWorkerResponse) => void): Request<Deadline.Types.DeleteWorkerResponse, AWSError>;
  275. /**
  276. * Deletes a worker.
  277. */
  278. deleteWorker(callback?: (err: AWSError, data: Deadline.Types.DeleteWorkerResponse) => void): Request<Deadline.Types.DeleteWorkerResponse, AWSError>;
  279. /**
  280. * Disassociates a member from a farm.
  281. */
  282. disassociateMemberFromFarm(params: Deadline.Types.DisassociateMemberFromFarmRequest, callback?: (err: AWSError, data: Deadline.Types.DisassociateMemberFromFarmResponse) => void): Request<Deadline.Types.DisassociateMemberFromFarmResponse, AWSError>;
  283. /**
  284. * Disassociates a member from a farm.
  285. */
  286. disassociateMemberFromFarm(callback?: (err: AWSError, data: Deadline.Types.DisassociateMemberFromFarmResponse) => void): Request<Deadline.Types.DisassociateMemberFromFarmResponse, AWSError>;
  287. /**
  288. * Disassociates a member from a fleet.
  289. */
  290. disassociateMemberFromFleet(params: Deadline.Types.DisassociateMemberFromFleetRequest, callback?: (err: AWSError, data: Deadline.Types.DisassociateMemberFromFleetResponse) => void): Request<Deadline.Types.DisassociateMemberFromFleetResponse, AWSError>;
  291. /**
  292. * Disassociates a member from a fleet.
  293. */
  294. disassociateMemberFromFleet(callback?: (err: AWSError, data: Deadline.Types.DisassociateMemberFromFleetResponse) => void): Request<Deadline.Types.DisassociateMemberFromFleetResponse, AWSError>;
  295. /**
  296. * Disassociates a member from a job.
  297. */
  298. disassociateMemberFromJob(params: Deadline.Types.DisassociateMemberFromJobRequest, callback?: (err: AWSError, data: Deadline.Types.DisassociateMemberFromJobResponse) => void): Request<Deadline.Types.DisassociateMemberFromJobResponse, AWSError>;
  299. /**
  300. * Disassociates a member from a job.
  301. */
  302. disassociateMemberFromJob(callback?: (err: AWSError, data: Deadline.Types.DisassociateMemberFromJobResponse) => void): Request<Deadline.Types.DisassociateMemberFromJobResponse, AWSError>;
  303. /**
  304. * Disassociates a member from a queue.
  305. */
  306. disassociateMemberFromQueue(params: Deadline.Types.DisassociateMemberFromQueueRequest, callback?: (err: AWSError, data: Deadline.Types.DisassociateMemberFromQueueResponse) => void): Request<Deadline.Types.DisassociateMemberFromQueueResponse, AWSError>;
  307. /**
  308. * Disassociates a member from a queue.
  309. */
  310. disassociateMemberFromQueue(callback?: (err: AWSError, data: Deadline.Types.DisassociateMemberFromQueueResponse) => void): Request<Deadline.Types.DisassociateMemberFromQueueResponse, AWSError>;
  311. /**
  312. * Get a budget.
  313. */
  314. getBudget(params: Deadline.Types.GetBudgetRequest, callback?: (err: AWSError, data: Deadline.Types.GetBudgetResponse) => void): Request<Deadline.Types.GetBudgetResponse, AWSError>;
  315. /**
  316. * Get a budget.
  317. */
  318. getBudget(callback?: (err: AWSError, data: Deadline.Types.GetBudgetResponse) => void): Request<Deadline.Types.GetBudgetResponse, AWSError>;
  319. /**
  320. * Get a farm.
  321. */
  322. getFarm(params: Deadline.Types.GetFarmRequest, callback?: (err: AWSError, data: Deadline.Types.GetFarmResponse) => void): Request<Deadline.Types.GetFarmResponse, AWSError>;
  323. /**
  324. * Get a farm.
  325. */
  326. getFarm(callback?: (err: AWSError, data: Deadline.Types.GetFarmResponse) => void): Request<Deadline.Types.GetFarmResponse, AWSError>;
  327. /**
  328. * Get a fleet.
  329. */
  330. getFleet(params: Deadline.Types.GetFleetRequest, callback?: (err: AWSError, data: Deadline.Types.GetFleetResponse) => void): Request<Deadline.Types.GetFleetResponse, AWSError>;
  331. /**
  332. * Get a fleet.
  333. */
  334. getFleet(callback?: (err: AWSError, data: Deadline.Types.GetFleetResponse) => void): Request<Deadline.Types.GetFleetResponse, AWSError>;
  335. /**
  336. * Gets a Deadline Cloud job.
  337. */
  338. getJob(params: Deadline.Types.GetJobRequest, callback?: (err: AWSError, data: Deadline.Types.GetJobResponse) => void): Request<Deadline.Types.GetJobResponse, AWSError>;
  339. /**
  340. * Gets a Deadline Cloud job.
  341. */
  342. getJob(callback?: (err: AWSError, data: Deadline.Types.GetJobResponse) => void): Request<Deadline.Types.GetJobResponse, AWSError>;
  343. /**
  344. * Gets a licence endpoint.
  345. */
  346. getLicenseEndpoint(params: Deadline.Types.GetLicenseEndpointRequest, callback?: (err: AWSError, data: Deadline.Types.GetLicenseEndpointResponse) => void): Request<Deadline.Types.GetLicenseEndpointResponse, AWSError>;
  347. /**
  348. * Gets a licence endpoint.
  349. */
  350. getLicenseEndpoint(callback?: (err: AWSError, data: Deadline.Types.GetLicenseEndpointResponse) => void): Request<Deadline.Types.GetLicenseEndpointResponse, AWSError>;
  351. /**
  352. * Gets information about the specified monitor.
  353. */
  354. getMonitor(params: Deadline.Types.GetMonitorRequest, callback?: (err: AWSError, data: Deadline.Types.GetMonitorResponse) => void): Request<Deadline.Types.GetMonitorResponse, AWSError>;
  355. /**
  356. * Gets information about the specified monitor.
  357. */
  358. getMonitor(callback?: (err: AWSError, data: Deadline.Types.GetMonitorResponse) => void): Request<Deadline.Types.GetMonitorResponse, AWSError>;
  359. /**
  360. * Gets a queue.
  361. */
  362. getQueue(params: Deadline.Types.GetQueueRequest, callback?: (err: AWSError, data: Deadline.Types.GetQueueResponse) => void): Request<Deadline.Types.GetQueueResponse, AWSError>;
  363. /**
  364. * Gets a queue.
  365. */
  366. getQueue(callback?: (err: AWSError, data: Deadline.Types.GetQueueResponse) => void): Request<Deadline.Types.GetQueueResponse, AWSError>;
  367. /**
  368. * Gets a queue environment.
  369. */
  370. getQueueEnvironment(params: Deadline.Types.GetQueueEnvironmentRequest, callback?: (err: AWSError, data: Deadline.Types.GetQueueEnvironmentResponse) => void): Request<Deadline.Types.GetQueueEnvironmentResponse, AWSError>;
  371. /**
  372. * Gets a queue environment.
  373. */
  374. getQueueEnvironment(callback?: (err: AWSError, data: Deadline.Types.GetQueueEnvironmentResponse) => void): Request<Deadline.Types.GetQueueEnvironmentResponse, AWSError>;
  375. /**
  376. * Gets a queue-fleet association.
  377. */
  378. getQueueFleetAssociation(params: Deadline.Types.GetQueueFleetAssociationRequest, callback?: (err: AWSError, data: Deadline.Types.GetQueueFleetAssociationResponse) => void): Request<Deadline.Types.GetQueueFleetAssociationResponse, AWSError>;
  379. /**
  380. * Gets a queue-fleet association.
  381. */
  382. getQueueFleetAssociation(callback?: (err: AWSError, data: Deadline.Types.GetQueueFleetAssociationResponse) => void): Request<Deadline.Types.GetQueueFleetAssociationResponse, AWSError>;
  383. /**
  384. * Gets a session.
  385. */
  386. getSession(params: Deadline.Types.GetSessionRequest, callback?: (err: AWSError, data: Deadline.Types.GetSessionResponse) => void): Request<Deadline.Types.GetSessionResponse, AWSError>;
  387. /**
  388. * Gets a session.
  389. */
  390. getSession(callback?: (err: AWSError, data: Deadline.Types.GetSessionResponse) => void): Request<Deadline.Types.GetSessionResponse, AWSError>;
  391. /**
  392. * Gets a session action for the job.
  393. */
  394. getSessionAction(params: Deadline.Types.GetSessionActionRequest, callback?: (err: AWSError, data: Deadline.Types.GetSessionActionResponse) => void): Request<Deadline.Types.GetSessionActionResponse, AWSError>;
  395. /**
  396. * Gets a session action for the job.
  397. */
  398. getSessionAction(callback?: (err: AWSError, data: Deadline.Types.GetSessionActionResponse) => void): Request<Deadline.Types.GetSessionActionResponse, AWSError>;
  399. /**
  400. * Gets a set of statistics for queues or farms. Before you can call the GetSessionStatisticsAggregation operation, you must first call the StartSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.
  401. */
  402. getSessionsStatisticsAggregation(params: Deadline.Types.GetSessionsStatisticsAggregationRequest, callback?: (err: AWSError, data: Deadline.Types.GetSessionsStatisticsAggregationResponse) => void): Request<Deadline.Types.GetSessionsStatisticsAggregationResponse, AWSError>;
  403. /**
  404. * Gets a set of statistics for queues or farms. Before you can call the GetSessionStatisticsAggregation operation, you must first call the StartSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.
  405. */
  406. getSessionsStatisticsAggregation(callback?: (err: AWSError, data: Deadline.Types.GetSessionsStatisticsAggregationResponse) => void): Request<Deadline.Types.GetSessionsStatisticsAggregationResponse, AWSError>;
  407. /**
  408. * Gets a step.
  409. */
  410. getStep(params: Deadline.Types.GetStepRequest, callback?: (err: AWSError, data: Deadline.Types.GetStepResponse) => void): Request<Deadline.Types.GetStepResponse, AWSError>;
  411. /**
  412. * Gets a step.
  413. */
  414. getStep(callback?: (err: AWSError, data: Deadline.Types.GetStepResponse) => void): Request<Deadline.Types.GetStepResponse, AWSError>;
  415. /**
  416. * Gets a storage profile.
  417. */
  418. getStorageProfile(params: Deadline.Types.GetStorageProfileRequest, callback?: (err: AWSError, data: Deadline.Types.GetStorageProfileResponse) => void): Request<Deadline.Types.GetStorageProfileResponse, AWSError>;
  419. /**
  420. * Gets a storage profile.
  421. */
  422. getStorageProfile(callback?: (err: AWSError, data: Deadline.Types.GetStorageProfileResponse) => void): Request<Deadline.Types.GetStorageProfileResponse, AWSError>;
  423. /**
  424. * Gets a storage profile for a queue.
  425. */
  426. getStorageProfileForQueue(params: Deadline.Types.GetStorageProfileForQueueRequest, callback?: (err: AWSError, data: Deadline.Types.GetStorageProfileForQueueResponse) => void): Request<Deadline.Types.GetStorageProfileForQueueResponse, AWSError>;
  427. /**
  428. * Gets a storage profile for a queue.
  429. */
  430. getStorageProfileForQueue(callback?: (err: AWSError, data: Deadline.Types.GetStorageProfileForQueueResponse) => void): Request<Deadline.Types.GetStorageProfileForQueueResponse, AWSError>;
  431. /**
  432. * Gets a task.
  433. */
  434. getTask(params: Deadline.Types.GetTaskRequest, callback?: (err: AWSError, data: Deadline.Types.GetTaskResponse) => void): Request<Deadline.Types.GetTaskResponse, AWSError>;
  435. /**
  436. * Gets a task.
  437. */
  438. getTask(callback?: (err: AWSError, data: Deadline.Types.GetTaskResponse) => void): Request<Deadline.Types.GetTaskResponse, AWSError>;
  439. /**
  440. * Gets a worker.
  441. */
  442. getWorker(params: Deadline.Types.GetWorkerRequest, callback?: (err: AWSError, data: Deadline.Types.GetWorkerResponse) => void): Request<Deadline.Types.GetWorkerResponse, AWSError>;
  443. /**
  444. * Gets a worker.
  445. */
  446. getWorker(callback?: (err: AWSError, data: Deadline.Types.GetWorkerResponse) => void): Request<Deadline.Types.GetWorkerResponse, AWSError>;
  447. /**
  448. * A list of the available metered products.
  449. */
  450. listAvailableMeteredProducts(params: Deadline.Types.ListAvailableMeteredProductsRequest, callback?: (err: AWSError, data: Deadline.Types.ListAvailableMeteredProductsResponse) => void): Request<Deadline.Types.ListAvailableMeteredProductsResponse, AWSError>;
  451. /**
  452. * A list of the available metered products.
  453. */
  454. listAvailableMeteredProducts(callback?: (err: AWSError, data: Deadline.Types.ListAvailableMeteredProductsResponse) => void): Request<Deadline.Types.ListAvailableMeteredProductsResponse, AWSError>;
  455. /**
  456. * A list of budgets in a farm.
  457. */
  458. listBudgets(params: Deadline.Types.ListBudgetsRequest, callback?: (err: AWSError, data: Deadline.Types.ListBudgetsResponse) => void): Request<Deadline.Types.ListBudgetsResponse, AWSError>;
  459. /**
  460. * A list of budgets in a farm.
  461. */
  462. listBudgets(callback?: (err: AWSError, data: Deadline.Types.ListBudgetsResponse) => void): Request<Deadline.Types.ListBudgetsResponse, AWSError>;
  463. /**
  464. * Lists the members of a farm.
  465. */
  466. listFarmMembers(params: Deadline.Types.ListFarmMembersRequest, callback?: (err: AWSError, data: Deadline.Types.ListFarmMembersResponse) => void): Request<Deadline.Types.ListFarmMembersResponse, AWSError>;
  467. /**
  468. * Lists the members of a farm.
  469. */
  470. listFarmMembers(callback?: (err: AWSError, data: Deadline.Types.ListFarmMembersResponse) => void): Request<Deadline.Types.ListFarmMembersResponse, AWSError>;
  471. /**
  472. * Lists farms.
  473. */
  474. listFarms(params: Deadline.Types.ListFarmsRequest, callback?: (err: AWSError, data: Deadline.Types.ListFarmsResponse) => void): Request<Deadline.Types.ListFarmsResponse, AWSError>;
  475. /**
  476. * Lists farms.
  477. */
  478. listFarms(callback?: (err: AWSError, data: Deadline.Types.ListFarmsResponse) => void): Request<Deadline.Types.ListFarmsResponse, AWSError>;
  479. /**
  480. * Lists fleet members.
  481. */
  482. listFleetMembers(params: Deadline.Types.ListFleetMembersRequest, callback?: (err: AWSError, data: Deadline.Types.ListFleetMembersResponse) => void): Request<Deadline.Types.ListFleetMembersResponse, AWSError>;
  483. /**
  484. * Lists fleet members.
  485. */
  486. listFleetMembers(callback?: (err: AWSError, data: Deadline.Types.ListFleetMembersResponse) => void): Request<Deadline.Types.ListFleetMembersResponse, AWSError>;
  487. /**
  488. * Lists fleets.
  489. */
  490. listFleets(params: Deadline.Types.ListFleetsRequest, callback?: (err: AWSError, data: Deadline.Types.ListFleetsResponse) => void): Request<Deadline.Types.ListFleetsResponse, AWSError>;
  491. /**
  492. * Lists fleets.
  493. */
  494. listFleets(callback?: (err: AWSError, data: Deadline.Types.ListFleetsResponse) => void): Request<Deadline.Types.ListFleetsResponse, AWSError>;
  495. /**
  496. * Lists members on a job.
  497. */
  498. listJobMembers(params: Deadline.Types.ListJobMembersRequest, callback?: (err: AWSError, data: Deadline.Types.ListJobMembersResponse) => void): Request<Deadline.Types.ListJobMembersResponse, AWSError>;
  499. /**
  500. * Lists members on a job.
  501. */
  502. listJobMembers(callback?: (err: AWSError, data: Deadline.Types.ListJobMembersResponse) => void): Request<Deadline.Types.ListJobMembersResponse, AWSError>;
  503. /**
  504. * Lists jobs.
  505. */
  506. listJobs(params: Deadline.Types.ListJobsRequest, callback?: (err: AWSError, data: Deadline.Types.ListJobsResponse) => void): Request<Deadline.Types.ListJobsResponse, AWSError>;
  507. /**
  508. * Lists jobs.
  509. */
  510. listJobs(callback?: (err: AWSError, data: Deadline.Types.ListJobsResponse) => void): Request<Deadline.Types.ListJobsResponse, AWSError>;
  511. /**
  512. * Lists license endpoints.
  513. */
  514. listLicenseEndpoints(params: Deadline.Types.ListLicenseEndpointsRequest, callback?: (err: AWSError, data: Deadline.Types.ListLicenseEndpointsResponse) => void): Request<Deadline.Types.ListLicenseEndpointsResponse, AWSError>;
  515. /**
  516. * Lists license endpoints.
  517. */
  518. listLicenseEndpoints(callback?: (err: AWSError, data: Deadline.Types.ListLicenseEndpointsResponse) => void): Request<Deadline.Types.ListLicenseEndpointsResponse, AWSError>;
  519. /**
  520. * Lists metered products.
  521. */
  522. listMeteredProducts(params: Deadline.Types.ListMeteredProductsRequest, callback?: (err: AWSError, data: Deadline.Types.ListMeteredProductsResponse) => void): Request<Deadline.Types.ListMeteredProductsResponse, AWSError>;
  523. /**
  524. * Lists metered products.
  525. */
  526. listMeteredProducts(callback?: (err: AWSError, data: Deadline.Types.ListMeteredProductsResponse) => void): Request<Deadline.Types.ListMeteredProductsResponse, AWSError>;
  527. /**
  528. * Gets a list of your monitors in Deadline Cloud.
  529. */
  530. listMonitors(params: Deadline.Types.ListMonitorsRequest, callback?: (err: AWSError, data: Deadline.Types.ListMonitorsResponse) => void): Request<Deadline.Types.ListMonitorsResponse, AWSError>;
  531. /**
  532. * Gets a list of your monitors in Deadline Cloud.
  533. */
  534. listMonitors(callback?: (err: AWSError, data: Deadline.Types.ListMonitorsResponse) => void): Request<Deadline.Types.ListMonitorsResponse, AWSError>;
  535. /**
  536. * Lists queue environments.
  537. */
  538. listQueueEnvironments(params: Deadline.Types.ListQueueEnvironmentsRequest, callback?: (err: AWSError, data: Deadline.Types.ListQueueEnvironmentsResponse) => void): Request<Deadline.Types.ListQueueEnvironmentsResponse, AWSError>;
  539. /**
  540. * Lists queue environments.
  541. */
  542. listQueueEnvironments(callback?: (err: AWSError, data: Deadline.Types.ListQueueEnvironmentsResponse) => void): Request<Deadline.Types.ListQueueEnvironmentsResponse, AWSError>;
  543. /**
  544. * Lists queue-fleet associations.
  545. */
  546. listQueueFleetAssociations(params: Deadline.Types.ListQueueFleetAssociationsRequest, callback?: (err: AWSError, data: Deadline.Types.ListQueueFleetAssociationsResponse) => void): Request<Deadline.Types.ListQueueFleetAssociationsResponse, AWSError>;
  547. /**
  548. * Lists queue-fleet associations.
  549. */
  550. listQueueFleetAssociations(callback?: (err: AWSError, data: Deadline.Types.ListQueueFleetAssociationsResponse) => void): Request<Deadline.Types.ListQueueFleetAssociationsResponse, AWSError>;
  551. /**
  552. * Lists the members in a queue.
  553. */
  554. listQueueMembers(params: Deadline.Types.ListQueueMembersRequest, callback?: (err: AWSError, data: Deadline.Types.ListQueueMembersResponse) => void): Request<Deadline.Types.ListQueueMembersResponse, AWSError>;
  555. /**
  556. * Lists the members in a queue.
  557. */
  558. listQueueMembers(callback?: (err: AWSError, data: Deadline.Types.ListQueueMembersResponse) => void): Request<Deadline.Types.ListQueueMembersResponse, AWSError>;
  559. /**
  560. * Lists queues.
  561. */
  562. listQueues(params: Deadline.Types.ListQueuesRequest, callback?: (err: AWSError, data: Deadline.Types.ListQueuesResponse) => void): Request<Deadline.Types.ListQueuesResponse, AWSError>;
  563. /**
  564. * Lists queues.
  565. */
  566. listQueues(callback?: (err: AWSError, data: Deadline.Types.ListQueuesResponse) => void): Request<Deadline.Types.ListQueuesResponse, AWSError>;
  567. /**
  568. * Lists session actions.
  569. */
  570. listSessionActions(params: Deadline.Types.ListSessionActionsRequest, callback?: (err: AWSError, data: Deadline.Types.ListSessionActionsResponse) => void): Request<Deadline.Types.ListSessionActionsResponse, AWSError>;
  571. /**
  572. * Lists session actions.
  573. */
  574. listSessionActions(callback?: (err: AWSError, data: Deadline.Types.ListSessionActionsResponse) => void): Request<Deadline.Types.ListSessionActionsResponse, AWSError>;
  575. /**
  576. * Lists sessions.
  577. */
  578. listSessions(params: Deadline.Types.ListSessionsRequest, callback?: (err: AWSError, data: Deadline.Types.ListSessionsResponse) => void): Request<Deadline.Types.ListSessionsResponse, AWSError>;
  579. /**
  580. * Lists sessions.
  581. */
  582. listSessions(callback?: (err: AWSError, data: Deadline.Types.ListSessionsResponse) => void): Request<Deadline.Types.ListSessionsResponse, AWSError>;
  583. /**
  584. * Lists sessions for a worker.
  585. */
  586. listSessionsForWorker(params: Deadline.Types.ListSessionsForWorkerRequest, callback?: (err: AWSError, data: Deadline.Types.ListSessionsForWorkerResponse) => void): Request<Deadline.Types.ListSessionsForWorkerResponse, AWSError>;
  587. /**
  588. * Lists sessions for a worker.
  589. */
  590. listSessionsForWorker(callback?: (err: AWSError, data: Deadline.Types.ListSessionsForWorkerResponse) => void): Request<Deadline.Types.ListSessionsForWorkerResponse, AWSError>;
  591. /**
  592. * Lists step consumers.
  593. */
  594. listStepConsumers(params: Deadline.Types.ListStepConsumersRequest, callback?: (err: AWSError, data: Deadline.Types.ListStepConsumersResponse) => void): Request<Deadline.Types.ListStepConsumersResponse, AWSError>;
  595. /**
  596. * Lists step consumers.
  597. */
  598. listStepConsumers(callback?: (err: AWSError, data: Deadline.Types.ListStepConsumersResponse) => void): Request<Deadline.Types.ListStepConsumersResponse, AWSError>;
  599. /**
  600. * Lists the dependencies for a step.
  601. */
  602. listStepDependencies(params: Deadline.Types.ListStepDependenciesRequest, callback?: (err: AWSError, data: Deadline.Types.ListStepDependenciesResponse) => void): Request<Deadline.Types.ListStepDependenciesResponse, AWSError>;
  603. /**
  604. * Lists the dependencies for a step.
  605. */
  606. listStepDependencies(callback?: (err: AWSError, data: Deadline.Types.ListStepDependenciesResponse) => void): Request<Deadline.Types.ListStepDependenciesResponse, AWSError>;
  607. /**
  608. * Lists steps for a job.
  609. */
  610. listSteps(params: Deadline.Types.ListStepsRequest, callback?: (err: AWSError, data: Deadline.Types.ListStepsResponse) => void): Request<Deadline.Types.ListStepsResponse, AWSError>;
  611. /**
  612. * Lists steps for a job.
  613. */
  614. listSteps(callback?: (err: AWSError, data: Deadline.Types.ListStepsResponse) => void): Request<Deadline.Types.ListStepsResponse, AWSError>;
  615. /**
  616. * Lists storage profiles.
  617. */
  618. listStorageProfiles(params: Deadline.Types.ListStorageProfilesRequest, callback?: (err: AWSError, data: Deadline.Types.ListStorageProfilesResponse) => void): Request<Deadline.Types.ListStorageProfilesResponse, AWSError>;
  619. /**
  620. * Lists storage profiles.
  621. */
  622. listStorageProfiles(callback?: (err: AWSError, data: Deadline.Types.ListStorageProfilesResponse) => void): Request<Deadline.Types.ListStorageProfilesResponse, AWSError>;
  623. /**
  624. * Lists storage profiles for a queue.
  625. */
  626. listStorageProfilesForQueue(params: Deadline.Types.ListStorageProfilesForQueueRequest, callback?: (err: AWSError, data: Deadline.Types.ListStorageProfilesForQueueResponse) => void): Request<Deadline.Types.ListStorageProfilesForQueueResponse, AWSError>;
  627. /**
  628. * Lists storage profiles for a queue.
  629. */
  630. listStorageProfilesForQueue(callback?: (err: AWSError, data: Deadline.Types.ListStorageProfilesForQueueResponse) => void): Request<Deadline.Types.ListStorageProfilesForQueueResponse, AWSError>;
  631. /**
  632. * Lists tags for a resource.
  633. */
  634. listTagsForResource(params: Deadline.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Deadline.Types.ListTagsForResourceResponse) => void): Request<Deadline.Types.ListTagsForResourceResponse, AWSError>;
  635. /**
  636. * Lists tags for a resource.
  637. */
  638. listTagsForResource(callback?: (err: AWSError, data: Deadline.Types.ListTagsForResourceResponse) => void): Request<Deadline.Types.ListTagsForResourceResponse, AWSError>;
  639. /**
  640. * Lists tasks for a job.
  641. */
  642. listTasks(params: Deadline.Types.ListTasksRequest, callback?: (err: AWSError, data: Deadline.Types.ListTasksResponse) => void): Request<Deadline.Types.ListTasksResponse, AWSError>;
  643. /**
  644. * Lists tasks for a job.
  645. */
  646. listTasks(callback?: (err: AWSError, data: Deadline.Types.ListTasksResponse) => void): Request<Deadline.Types.ListTasksResponse, AWSError>;
  647. /**
  648. * Lists workers.
  649. */
  650. listWorkers(params: Deadline.Types.ListWorkersRequest, callback?: (err: AWSError, data: Deadline.Types.ListWorkersResponse) => void): Request<Deadline.Types.ListWorkersResponse, AWSError>;
  651. /**
  652. * Lists workers.
  653. */
  654. listWorkers(callback?: (err: AWSError, data: Deadline.Types.ListWorkersResponse) => void): Request<Deadline.Types.ListWorkersResponse, AWSError>;
  655. /**
  656. * Adds a metered product.
  657. */
  658. putMeteredProduct(params: Deadline.Types.PutMeteredProductRequest, callback?: (err: AWSError, data: Deadline.Types.PutMeteredProductResponse) => void): Request<Deadline.Types.PutMeteredProductResponse, AWSError>;
  659. /**
  660. * Adds a metered product.
  661. */
  662. putMeteredProduct(callback?: (err: AWSError, data: Deadline.Types.PutMeteredProductResponse) => void): Request<Deadline.Types.PutMeteredProductResponse, AWSError>;
  663. /**
  664. * Searches for jobs.
  665. */
  666. searchJobs(params: Deadline.Types.SearchJobsRequest, callback?: (err: AWSError, data: Deadline.Types.SearchJobsResponse) => void): Request<Deadline.Types.SearchJobsResponse, AWSError>;
  667. /**
  668. * Searches for jobs.
  669. */
  670. searchJobs(callback?: (err: AWSError, data: Deadline.Types.SearchJobsResponse) => void): Request<Deadline.Types.SearchJobsResponse, AWSError>;
  671. /**
  672. * Searches for steps.
  673. */
  674. searchSteps(params: Deadline.Types.SearchStepsRequest, callback?: (err: AWSError, data: Deadline.Types.SearchStepsResponse) => void): Request<Deadline.Types.SearchStepsResponse, AWSError>;
  675. /**
  676. * Searches for steps.
  677. */
  678. searchSteps(callback?: (err: AWSError, data: Deadline.Types.SearchStepsResponse) => void): Request<Deadline.Types.SearchStepsResponse, AWSError>;
  679. /**
  680. * Searches for tasks.
  681. */
  682. searchTasks(params: Deadline.Types.SearchTasksRequest, callback?: (err: AWSError, data: Deadline.Types.SearchTasksResponse) => void): Request<Deadline.Types.SearchTasksResponse, AWSError>;
  683. /**
  684. * Searches for tasks.
  685. */
  686. searchTasks(callback?: (err: AWSError, data: Deadline.Types.SearchTasksResponse) => void): Request<Deadline.Types.SearchTasksResponse, AWSError>;
  687. /**
  688. * Searches for workers.
  689. */
  690. searchWorkers(params: Deadline.Types.SearchWorkersRequest, callback?: (err: AWSError, data: Deadline.Types.SearchWorkersResponse) => void): Request<Deadline.Types.SearchWorkersResponse, AWSError>;
  691. /**
  692. * Searches for workers.
  693. */
  694. searchWorkers(callback?: (err: AWSError, data: Deadline.Types.SearchWorkersResponse) => void): Request<Deadline.Types.SearchWorkersResponse, AWSError>;
  695. /**
  696. * Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.
  697. */
  698. startSessionsStatisticsAggregation(params: Deadline.Types.StartSessionsStatisticsAggregationRequest, callback?: (err: AWSError, data: Deadline.Types.StartSessionsStatisticsAggregationResponse) => void): Request<Deadline.Types.StartSessionsStatisticsAggregationResponse, AWSError>;
  699. /**
  700. * Starts an asynchronous request for getting aggregated statistics about queues and farms. Get the statistics using the GetSessionsStatisticsAggregation operation. Statistics are available for 1 hour after you call the StartSessionsStatisticsAggregation operation.
  701. */
  702. startSessionsStatisticsAggregation(callback?: (err: AWSError, data: Deadline.Types.StartSessionsStatisticsAggregationResponse) => void): Request<Deadline.Types.StartSessionsStatisticsAggregationResponse, AWSError>;
  703. /**
  704. * Tags a resource using the resource's ARN and desired tags.
  705. */
  706. tagResource(params: Deadline.Types.TagResourceRequest, callback?: (err: AWSError, data: Deadline.Types.TagResourceResponse) => void): Request<Deadline.Types.TagResourceResponse, AWSError>;
  707. /**
  708. * Tags a resource using the resource's ARN and desired tags.
  709. */
  710. tagResource(callback?: (err: AWSError, data: Deadline.Types.TagResourceResponse) => void): Request<Deadline.Types.TagResourceResponse, AWSError>;
  711. /**
  712. * Removes a tag from a resource using the resource's ARN and tag to remove.
  713. */
  714. untagResource(params: Deadline.Types.UntagResourceRequest, callback?: (err: AWSError, data: Deadline.Types.UntagResourceResponse) => void): Request<Deadline.Types.UntagResourceResponse, AWSError>;
  715. /**
  716. * Removes a tag from a resource using the resource's ARN and tag to remove.
  717. */
  718. untagResource(callback?: (err: AWSError, data: Deadline.Types.UntagResourceResponse) => void): Request<Deadline.Types.UntagResourceResponse, AWSError>;
  719. /**
  720. * Updates a budget that sets spending thresholds for rendering activity.
  721. */
  722. updateBudget(params: Deadline.Types.UpdateBudgetRequest, callback?: (err: AWSError, data: Deadline.Types.UpdateBudgetResponse) => void): Request<Deadline.Types.UpdateBudgetResponse, AWSError>;
  723. /**
  724. * Updates a budget that sets spending thresholds for rendering activity.
  725. */
  726. updateBudget(callback?: (err: AWSError, data: Deadline.Types.UpdateBudgetResponse) => void): Request<Deadline.Types.UpdateBudgetResponse, AWSError>;
  727. /**
  728. * Updates a farm.
  729. */
  730. updateFarm(params: Deadline.Types.UpdateFarmRequest, callback?: (err: AWSError, data: Deadline.Types.UpdateFarmResponse) => void): Request<Deadline.Types.UpdateFarmResponse, AWSError>;
  731. /**
  732. * Updates a farm.
  733. */
  734. updateFarm(callback?: (err: AWSError, data: Deadline.Types.UpdateFarmResponse) => void): Request<Deadline.Types.UpdateFarmResponse, AWSError>;
  735. /**
  736. * Updates a fleet.
  737. */
  738. updateFleet(params: Deadline.Types.UpdateFleetRequest, callback?: (err: AWSError, data: Deadline.Types.UpdateFleetResponse) => void): Request<Deadline.Types.UpdateFleetResponse, AWSError>;
  739. /**
  740. * Updates a fleet.
  741. */
  742. updateFleet(callback?: (err: AWSError, data: Deadline.Types.UpdateFleetResponse) => void): Request<Deadline.Types.UpdateFleetResponse, AWSError>;
  743. /**
  744. * Updates a job.
  745. */
  746. updateJob(params: Deadline.Types.UpdateJobRequest, callback?: (err: AWSError, data: Deadline.Types.UpdateJobResponse) => void): Request<Deadline.Types.UpdateJobResponse, AWSError>;
  747. /**
  748. * Updates a job.
  749. */
  750. updateJob(callback?: (err: AWSError, data: Deadline.Types.UpdateJobResponse) => void): Request<Deadline.Types.UpdateJobResponse, AWSError>;
  751. /**
  752. * Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.
  753. */
  754. updateMonitor(params: Deadline.Types.UpdateMonitorRequest, callback?: (err: AWSError, data: Deadline.Types.UpdateMonitorResponse) => void): Request<Deadline.Types.UpdateMonitorResponse, AWSError>;
  755. /**
  756. * Modifies the settings for a Deadline Cloud monitor. You can modify one or all of the settings when you call UpdateMonitor.
  757. */
  758. updateMonitor(callback?: (err: AWSError, data: Deadline.Types.UpdateMonitorResponse) => void): Request<Deadline.Types.UpdateMonitorResponse, AWSError>;
  759. /**
  760. * Updates a queue.
  761. */
  762. updateQueue(params: Deadline.Types.UpdateQueueRequest, callback?: (err: AWSError, data: Deadline.Types.UpdateQueueResponse) => void): Request<Deadline.Types.UpdateQueueResponse, AWSError>;
  763. /**
  764. * Updates a queue.
  765. */
  766. updateQueue(callback?: (err: AWSError, data: Deadline.Types.UpdateQueueResponse) => void): Request<Deadline.Types.UpdateQueueResponse, AWSError>;
  767. /**
  768. * Updates the queue environment.
  769. */
  770. updateQueueEnvironment(params: Deadline.Types.UpdateQueueEnvironmentRequest, callback?: (err: AWSError, data: Deadline.Types.UpdateQueueEnvironmentResponse) => void): Request<Deadline.Types.UpdateQueueEnvironmentResponse, AWSError>;
  771. /**
  772. * Updates the queue environment.
  773. */
  774. updateQueueEnvironment(callback?: (err: AWSError, data: Deadline.Types.UpdateQueueEnvironmentResponse) => void): Request<Deadline.Types.UpdateQueueEnvironmentResponse, AWSError>;
  775. /**
  776. * Updates a queue-fleet association.
  777. */
  778. updateQueueFleetAssociation(params: Deadline.Types.UpdateQueueFleetAssociationRequest, callback?: (err: AWSError, data: Deadline.Types.UpdateQueueFleetAssociationResponse) => void): Request<Deadline.Types.UpdateQueueFleetAssociationResponse, AWSError>;
  779. /**
  780. * Updates a queue-fleet association.
  781. */
  782. updateQueueFleetAssociation(callback?: (err: AWSError, data: Deadline.Types.UpdateQueueFleetAssociationResponse) => void): Request<Deadline.Types.UpdateQueueFleetAssociationResponse, AWSError>;
  783. /**
  784. * Updates a session.
  785. */
  786. updateSession(params: Deadline.Types.UpdateSessionRequest, callback?: (err: AWSError, data: Deadline.Types.UpdateSessionResponse) => void): Request<Deadline.Types.UpdateSessionResponse, AWSError>;
  787. /**
  788. * Updates a session.
  789. */
  790. updateSession(callback?: (err: AWSError, data: Deadline.Types.UpdateSessionResponse) => void): Request<Deadline.Types.UpdateSessionResponse, AWSError>;
  791. /**
  792. * Updates a step.
  793. */
  794. updateStep(params: Deadline.Types.UpdateStepRequest, callback?: (err: AWSError, data: Deadline.Types.UpdateStepResponse) => void): Request<Deadline.Types.UpdateStepResponse, AWSError>;
  795. /**
  796. * Updates a step.
  797. */
  798. updateStep(callback?: (err: AWSError, data: Deadline.Types.UpdateStepResponse) => void): Request<Deadline.Types.UpdateStepResponse, AWSError>;
  799. /**
  800. * Updates a storage profile.
  801. */
  802. updateStorageProfile(params: Deadline.Types.UpdateStorageProfileRequest, callback?: (err: AWSError, data: Deadline.Types.UpdateStorageProfileResponse) => void): Request<Deadline.Types.UpdateStorageProfileResponse, AWSError>;
  803. /**
  804. * Updates a storage profile.
  805. */
  806. updateStorageProfile(callback?: (err: AWSError, data: Deadline.Types.UpdateStorageProfileResponse) => void): Request<Deadline.Types.UpdateStorageProfileResponse, AWSError>;
  807. /**
  808. * Updates a task.
  809. */
  810. updateTask(params: Deadline.Types.UpdateTaskRequest, callback?: (err: AWSError, data: Deadline.Types.UpdateTaskResponse) => void): Request<Deadline.Types.UpdateTaskResponse, AWSError>;
  811. /**
  812. * Updates a task.
  813. */
  814. updateTask(callback?: (err: AWSError, data: Deadline.Types.UpdateTaskResponse) => void): Request<Deadline.Types.UpdateTaskResponse, AWSError>;
  815. /**
  816. * Updates a worker.
  817. */
  818. updateWorker(params: Deadline.Types.UpdateWorkerRequest, callback?: (err: AWSError, data: Deadline.Types.UpdateWorkerResponse) => void): Request<Deadline.Types.UpdateWorkerResponse, AWSError>;
  819. /**
  820. * Updates a worker.
  821. */
  822. updateWorker(callback?: (err: AWSError, data: Deadline.Types.UpdateWorkerResponse) => void): Request<Deadline.Types.UpdateWorkerResponse, AWSError>;
  823. /**
  824. * Updates the schedule for a worker.
  825. */
  826. updateWorkerSchedule(params: Deadline.Types.UpdateWorkerScheduleRequest, callback?: (err: AWSError, data: Deadline.Types.UpdateWorkerScheduleResponse) => void): Request<Deadline.Types.UpdateWorkerScheduleResponse, AWSError>;
  827. /**
  828. * Updates the schedule for a worker.
  829. */
  830. updateWorkerSchedule(callback?: (err: AWSError, data: Deadline.Types.UpdateWorkerScheduleResponse) => void): Request<Deadline.Types.UpdateWorkerScheduleResponse, AWSError>;
  831. /**
  832. * Waits for the fleetActive state by periodically calling the underlying Deadline.getFleetoperation every 5 seconds (at most 180 times). Wait until a Fleet is activated. Use this after invoking CreateFleet or UpdateFleet.
  833. */
  834. waitFor(state: "fleetActive", params: Deadline.Types.GetFleetRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Deadline.Types.GetFleetResponse) => void): Request<Deadline.Types.GetFleetResponse, AWSError>;
  835. /**
  836. * Waits for the fleetActive state by periodically calling the underlying Deadline.getFleetoperation every 5 seconds (at most 180 times). Wait until a Fleet is activated. Use this after invoking CreateFleet or UpdateFleet.
  837. */
  838. waitFor(state: "fleetActive", callback?: (err: AWSError, data: Deadline.Types.GetFleetResponse) => void): Request<Deadline.Types.GetFleetResponse, AWSError>;
  839. /**
  840. * Waits for the jobCreateComplete state by periodically calling the underlying Deadline.getJoboperation every 1 seconds (at most 120 times). Wait until a Job is created. Use this after invoking CreateJob.
  841. */
  842. waitFor(state: "jobCreateComplete", params: Deadline.Types.GetJobRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Deadline.Types.GetJobResponse) => void): Request<Deadline.Types.GetJobResponse, AWSError>;
  843. /**
  844. * Waits for the jobCreateComplete state by periodically calling the underlying Deadline.getJoboperation every 1 seconds (at most 120 times). Wait until a Job is created. Use this after invoking CreateJob.
  845. */
  846. waitFor(state: "jobCreateComplete", callback?: (err: AWSError, data: Deadline.Types.GetJobResponse) => void): Request<Deadline.Types.GetJobResponse, AWSError>;
  847. /**
  848. * Waits for the licenseEndpointDeleted state by periodically calling the underlying Deadline.getLicenseEndpointoperation every 10 seconds (at most 234 times). Wait until a LicenseEndpoint is Deleted. Use this after invoking DeleteLicenseEndpoint.
  849. */
  850. waitFor(state: "licenseEndpointDeleted", params: Deadline.Types.GetLicenseEndpointRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Deadline.Types.GetLicenseEndpointResponse) => void): Request<Deadline.Types.GetLicenseEndpointResponse, AWSError>;
  851. /**
  852. * Waits for the licenseEndpointDeleted state by periodically calling the underlying Deadline.getLicenseEndpointoperation every 10 seconds (at most 234 times). Wait until a LicenseEndpoint is Deleted. Use this after invoking DeleteLicenseEndpoint.
  853. */
  854. waitFor(state: "licenseEndpointDeleted", callback?: (err: AWSError, data: Deadline.Types.GetLicenseEndpointResponse) => void): Request<Deadline.Types.GetLicenseEndpointResponse, AWSError>;
  855. /**
  856. * Waits for the licenseEndpointValid state by periodically calling the underlying Deadline.getLicenseEndpointoperation every 10 seconds (at most 114 times). Wait until a LicenseEndpoint is Ready. Use this after invoking CreateLicenseEndpoint.
  857. */
  858. waitFor(state: "licenseEndpointValid", params: Deadline.Types.GetLicenseEndpointRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Deadline.Types.GetLicenseEndpointResponse) => void): Request<Deadline.Types.GetLicenseEndpointResponse, AWSError>;
  859. /**
  860. * Waits for the licenseEndpointValid state by periodically calling the underlying Deadline.getLicenseEndpointoperation every 10 seconds (at most 114 times). Wait until a LicenseEndpoint is Ready. Use this after invoking CreateLicenseEndpoint.
  861. */
  862. waitFor(state: "licenseEndpointValid", callback?: (err: AWSError, data: Deadline.Types.GetLicenseEndpointResponse) => void): Request<Deadline.Types.GetLicenseEndpointResponse, AWSError>;
  863. /**
  864. * Waits for the queueFleetAssociationStopped state by periodically calling the underlying Deadline.getQueueFleetAssociationoperation every 10 seconds (at most 60 times). Wait until a QueueFleetAssociation is stopped. Use this after setting the status to STOP_SCHEDULING_AND_COMPLETE_TASKS or STOP_SCHEDULING_AND_CANCEL_TASKS to wait for a QueueFleetAssociation to reach STOPPED
  865. */
  866. waitFor(state: "queueFleetAssociationStopped", params: Deadline.Types.GetQueueFleetAssociationRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Deadline.Types.GetQueueFleetAssociationResponse) => void): Request<Deadline.Types.GetQueueFleetAssociationResponse, AWSError>;
  867. /**
  868. * Waits for the queueFleetAssociationStopped state by periodically calling the underlying Deadline.getQueueFleetAssociationoperation every 10 seconds (at most 60 times). Wait until a QueueFleetAssociation is stopped. Use this after setting the status to STOP_SCHEDULING_AND_COMPLETE_TASKS or STOP_SCHEDULING_AND_CANCEL_TASKS to wait for a QueueFleetAssociation to reach STOPPED
  869. */
  870. waitFor(state: "queueFleetAssociationStopped", callback?: (err: AWSError, data: Deadline.Types.GetQueueFleetAssociationResponse) => void): Request<Deadline.Types.GetQueueFleetAssociationResponse, AWSError>;
  871. /**
  872. * Waits for the queueScheduling state by periodically calling the underlying Deadline.getQueueoperation every 10 seconds (at most 70 times).
  873. */
  874. waitFor(state: "queueScheduling", params: Deadline.Types.GetQueueRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Deadline.Types.GetQueueResponse) => void): Request<Deadline.Types.GetQueueResponse, AWSError>;
  875. /**
  876. * Waits for the queueScheduling state by periodically calling the underlying Deadline.getQueueoperation every 10 seconds (at most 70 times).
  877. */
  878. waitFor(state: "queueScheduling", callback?: (err: AWSError, data: Deadline.Types.GetQueueResponse) => void): Request<Deadline.Types.GetQueueResponse, AWSError>;
  879. /**
  880. * Waits for the queueSchedulingBlocked state by periodically calling the underlying Deadline.getQueueoperation every 10 seconds (at most 30 times).
  881. */
  882. waitFor(state: "queueSchedulingBlocked", params: Deadline.Types.GetQueueRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Deadline.Types.GetQueueResponse) => void): Request<Deadline.Types.GetQueueResponse, AWSError>;
  883. /**
  884. * Waits for the queueSchedulingBlocked state by periodically calling the underlying Deadline.getQueueoperation every 10 seconds (at most 30 times).
  885. */
  886. waitFor(state: "queueSchedulingBlocked", callback?: (err: AWSError, data: Deadline.Types.GetQueueResponse) => void): Request<Deadline.Types.GetQueueResponse, AWSError>;
  887. }
  888. declare namespace Deadline {
  889. export interface AcceleratorCountRange {
  890. /**
  891. * The maximum GPU for the accelerator.
  892. */
  893. max?: MinZeroMaxInteger;
  894. /**
  895. * The minimum GPU for the accelerator.
  896. */
  897. min: MinZeroMaxInteger;
  898. }
  899. export interface AcceleratorTotalMemoryMiBRange {
  900. /**
  901. * The maximum amount of memory to use for the accelerator, measured in MiB.
  902. */
  903. max?: MinZeroMaxInteger;
  904. /**
  905. * The minimum amount of memory to use for the accelerator, measured in MiB.
  906. */
  907. min: MinZeroMaxInteger;
  908. }
  909. export type AcceleratorType = "gpu"|string;
  910. export type AcceleratorTypes = AcceleratorType[];
  911. export type AccessKeyId = string;
  912. export type AggregationId = string;
  913. export type AllowedStorageProfileIds = StorageProfileId[];
  914. export type AmountCapabilityName = string;
  915. export interface AssignedEnvironmentEnterSessionActionDefinition {
  916. /**
  917. * The environment ID of the assigned environment at the start of a session.
  918. */
  919. environmentId: EnvironmentId;
  920. }
  921. export interface AssignedEnvironmentExitSessionActionDefinition {
  922. /**
  923. * The environment ID of the assigned environment when exiting a session.
  924. */
  925. environmentId: EnvironmentId;
  926. }
  927. export interface AssignedSession {
  928. /**
  929. * The job ID for the assigned session.
  930. */
  931. jobId: JobId;
  932. /**
  933. * The log configuration for the worker's assigned session.
  934. */
  935. logConfiguration: LogConfiguration;
  936. /**
  937. * The queue ID of the assigned session.
  938. */
  939. queueId: QueueId;
  940. /**
  941. * The session actions to apply to the assigned session.
  942. */
  943. sessionActions: AssignedSessionActions;
  944. }
  945. export interface AssignedSessionAction {
  946. /**
  947. * The definition of the assigned session action.
  948. */
  949. definition: AssignedSessionActionDefinition;
  950. /**
  951. * The session action ID for the assigned session.
  952. */
  953. sessionActionId: SessionActionId;
  954. }
  955. export interface AssignedSessionActionDefinition {
  956. /**
  957. * The environment a session starts on.
  958. */
  959. envEnter?: AssignedEnvironmentEnterSessionActionDefinition;
  960. /**
  961. * The environment a session exits from.
  962. */
  963. envExit?: AssignedEnvironmentExitSessionActionDefinition;
  964. /**
  965. * The job attachment to sync with an assigned session action.
  966. */
  967. syncInputJobAttachments?: AssignedSyncInputJobAttachmentsSessionActionDefinition;
  968. /**
  969. * The task run.
  970. */
  971. taskRun?: AssignedTaskRunSessionActionDefinition;
  972. }
  973. export type AssignedSessionActions = AssignedSessionAction[];
  974. export type AssignedSessions = {[key: string]: AssignedSession};
  975. export interface AssignedSyncInputJobAttachmentsSessionActionDefinition {
  976. /**
  977. * The step ID.
  978. */
  979. stepId?: StepId;
  980. }
  981. export interface AssignedTaskRunSessionActionDefinition {
  982. /**
  983. * The parameters to include.
  984. */
  985. parameters: TaskParameters;
  986. /**
  987. * The step ID.
  988. */
  989. stepId: StepId;
  990. /**
  991. * The task ID.
  992. */
  993. taskId: TaskId;
  994. }
  995. export interface AssociateMemberToFarmRequest {
  996. /**
  997. * The ID of the farm to associate with the member.
  998. */
  999. farmId: FarmId;
  1000. /**
  1001. * The identity store ID of the member to associate with the farm.
  1002. */
  1003. identityStoreId: IdentityStoreId;
  1004. /**
  1005. * The principal's membership level for the associated farm.
  1006. */
  1007. membershipLevel: MembershipLevel;
  1008. /**
  1009. * The member's principal ID to associate with the farm.
  1010. */
  1011. principalId: IdentityCenterPrincipalId;
  1012. /**
  1013. * The principal type of the member to associate with the farm.
  1014. */
  1015. principalType: PrincipalType;
  1016. }
  1017. export interface AssociateMemberToFarmResponse {
  1018. }
  1019. export interface AssociateMemberToFleetRequest {
  1020. /**
  1021. * The farm ID of the fleet to associate with the member.
  1022. */
  1023. farmId: FarmId;
  1024. /**
  1025. * The ID of the fleet to associate with a member.
  1026. */
  1027. fleetId: FleetId;
  1028. /**
  1029. * The member's identity store ID to associate with the fleet.
  1030. */
  1031. identityStoreId: IdentityStoreId;
  1032. /**
  1033. * The principal's membership level for the associated fleet.
  1034. */
  1035. membershipLevel: MembershipLevel;
  1036. /**
  1037. * The member's principal ID to associate with a fleet.
  1038. */
  1039. principalId: IdentityCenterPrincipalId;
  1040. /**
  1041. * The member's principal type to associate with the fleet.
  1042. */
  1043. principalType: PrincipalType;
  1044. }
  1045. export interface AssociateMemberToFleetResponse {
  1046. }
  1047. export interface AssociateMemberToJobRequest {
  1048. /**
  1049. * The farm ID of the job to associate with the member.
  1050. */
  1051. farmId: FarmId;
  1052. /**
  1053. * The member's identity store ID to associate with the job.
  1054. */
  1055. identityStoreId: IdentityStoreId;
  1056. /**
  1057. * The job ID to associate with the member.
  1058. */
  1059. jobId: JobId;
  1060. /**
  1061. * The principal's membership level for the associated job.
  1062. */
  1063. membershipLevel: MembershipLevel;
  1064. /**
  1065. * The member's principal ID to associate with the job.
  1066. */
  1067. principalId: IdentityCenterPrincipalId;
  1068. /**
  1069. * The member's principal type to associate with the job.
  1070. */
  1071. principalType: PrincipalType;
  1072. /**
  1073. * The queue ID to associate to the member.
  1074. */
  1075. queueId: QueueId;
  1076. }
  1077. export interface AssociateMemberToJobResponse {
  1078. }
  1079. export interface AssociateMemberToQueueRequest {
  1080. /**
  1081. * The farm ID of the queue to associate with the member.
  1082. */
  1083. farmId: FarmId;
  1084. /**
  1085. * The member's identity store ID to associate with the queue.
  1086. */
  1087. identityStoreId: IdentityStoreId;
  1088. /**
  1089. * The principal's membership level for the associated queue.
  1090. */
  1091. membershipLevel: MembershipLevel;
  1092. /**
  1093. * The member's principal ID to associate with the queue.
  1094. */
  1095. principalId: IdentityCenterPrincipalId;
  1096. /**
  1097. * The member's principal type to associate with the queue.
  1098. */
  1099. principalType: PrincipalType;
  1100. /**
  1101. * The ID of the queue to associate to the member.
  1102. */
  1103. queueId: QueueId;
  1104. }
  1105. export interface AssociateMemberToQueueResponse {
  1106. }
  1107. export interface AssumeFleetRoleForReadRequest {
  1108. /**
  1109. * The farm ID for the fleet's farm.
  1110. */
  1111. farmId: FarmId;
  1112. /**
  1113. * The fleet ID.
  1114. */
  1115. fleetId: FleetId;
  1116. }
  1117. export interface AssumeFleetRoleForReadResponse {
  1118. /**
  1119. * The credentials for the fleet role.
  1120. */
  1121. credentials: AwsCredentials;
  1122. }
  1123. export interface AssumeFleetRoleForWorkerRequest {
  1124. /**
  1125. * The farm ID for the fleet's farm.
  1126. */
  1127. farmId: FarmId;
  1128. /**
  1129. * The fleet ID that contains the worker.
  1130. */
  1131. fleetId: FleetId;
  1132. /**
  1133. * The ID of the worker assuming the fleet role.
  1134. */
  1135. workerId: WorkerId;
  1136. }
  1137. export interface AssumeFleetRoleForWorkerResponse {
  1138. /**
  1139. * The credentials for the worker.
  1140. */
  1141. credentials: AwsCredentials;
  1142. }
  1143. export interface AssumeQueueRoleForReadRequest {
  1144. /**
  1145. * The farm ID of the farm containing the queue.
  1146. */
  1147. farmId: FarmId;
  1148. /**
  1149. * The queue ID.
  1150. */
  1151. queueId: QueueId;
  1152. }
  1153. export interface AssumeQueueRoleForReadResponse {
  1154. /**
  1155. * The credentials for the queue role.
  1156. */
  1157. credentials: AwsCredentials;
  1158. }
  1159. export interface AssumeQueueRoleForUserRequest {
  1160. /**
  1161. * The farm ID of the queue that the user assumes the role for.
  1162. */
  1163. farmId: FarmId;
  1164. /**
  1165. * The queue ID of the queue that the user assumes the role for.
  1166. */
  1167. queueId: QueueId;
  1168. }
  1169. export interface AssumeQueueRoleForUserResponse {
  1170. /**
  1171. * The credentials for the queue role that a user has access to.
  1172. */
  1173. credentials: AwsCredentials;
  1174. }
  1175. export interface AssumeQueueRoleForWorkerRequest {
  1176. /**
  1177. * The farm ID of the worker assuming the queue role.
  1178. */
  1179. farmId: FarmId;
  1180. /**
  1181. * The fleet ID of the worker assuming the queue role.
  1182. */
  1183. fleetId: FleetId;
  1184. /**
  1185. * The queue ID of the worker assuming the queue role.
  1186. */
  1187. queueId: QueueId;
  1188. /**
  1189. * The worker ID of the worker assuming the queue role.
  1190. */
  1191. workerId: WorkerId;
  1192. }
  1193. export interface AssumeQueueRoleForWorkerResponse {
  1194. /**
  1195. * The Amazon Web Services credentials for the role that the worker is assuming.
  1196. */
  1197. credentials?: AwsCredentials;
  1198. }
  1199. export interface Attachments {
  1200. /**
  1201. * The file system.
  1202. */
  1203. fileSystem?: JobAttachmentsFileSystem;
  1204. /**
  1205. * A list of manifests which describe job attachment configurations.
  1206. */
  1207. manifests: ManifestPropertiesList;
  1208. }
  1209. export type AttributeCapabilityName = string;
  1210. export type AttributeCapabilityValue = string;
  1211. export type AttributeCapabilityValuesList = AttributeCapabilityValue[];
  1212. export type AutoScalingMode = "NO_SCALING"|"EVENT_BASED_AUTO_SCALING"|string;
  1213. export type AutoScalingStatus = "GROWING"|"STEADY"|"SHRINKING"|string;
  1214. export interface AwsCredentials {
  1215. /**
  1216. * The IAM access key ID.
  1217. */
  1218. accessKeyId: AccessKeyId;
  1219. /**
  1220. * The expiration date and time of the IAM credentials.
  1221. */
  1222. expiration: SyntheticTimestamp_date_time;
  1223. /**
  1224. * The IAM secret access key.
  1225. */
  1226. secretAccessKey: SecretAccessKey;
  1227. /**
  1228. * The IAM session token
  1229. */
  1230. sessionToken: SessionToken;
  1231. }
  1232. export type BatchGetJobEntityErrors = GetJobEntityError[];
  1233. export type BatchGetJobEntityList = JobEntity[];
  1234. export interface BatchGetJobEntityRequest {
  1235. /**
  1236. * The farm ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.
  1237. */
  1238. farmId: FarmId;
  1239. /**
  1240. * The fleet ID of the worker that's fetching job details. The worker must have an assignment on a job to fetch job details.
  1241. */
  1242. fleetId: FleetId;
  1243. /**
  1244. * The job identifiers to include within the job entity batch details.
  1245. */
  1246. identifiers: JobEntityIdentifiers;
  1247. /**
  1248. * The worker ID of the worker containing the job details to get.
  1249. */
  1250. workerId: WorkerId;
  1251. }
  1252. export interface BatchGetJobEntityResponse {
  1253. /**
  1254. * A list of the job entities, or details, in the batch.
  1255. */
  1256. entities: BatchGetJobEntityList;
  1257. /**
  1258. * A list of errors from the job error logs for the batch.
  1259. */
  1260. errors: BatchGetJobEntityErrors;
  1261. }
  1262. export type BoundedString = string;
  1263. export interface BudgetActionToAdd {
  1264. /**
  1265. * A description for the budget action to add.
  1266. */
  1267. description?: Description;
  1268. /**
  1269. * The percentage threshold for the budget action to add.
  1270. */
  1271. thresholdPercentage: ThresholdPercentage;
  1272. /**
  1273. * The type of budget action to add.
  1274. */
  1275. type: BudgetActionType;
  1276. }
  1277. export interface BudgetActionToRemove {
  1278. /**
  1279. * The percentage threshold for the budget action to remove.
  1280. */
  1281. thresholdPercentage: ThresholdPercentage;
  1282. /**
  1283. * The type of budget action to remove.
  1284. */
  1285. type: BudgetActionType;
  1286. }
  1287. export type BudgetActionType = "STOP_SCHEDULING_AND_COMPLETE_TASKS"|"STOP_SCHEDULING_AND_CANCEL_TASKS"|string;
  1288. export type BudgetActionsToAdd = BudgetActionToAdd[];
  1289. export type BudgetActionsToRemove = BudgetActionToRemove[];
  1290. export type BudgetId = string;
  1291. export interface BudgetSchedule {
  1292. /**
  1293. * The fixed start and end time of the budget's schedule.
  1294. */
  1295. fixed?: FixedBudgetSchedule;
  1296. }
  1297. export type BudgetStatus = "ACTIVE"|"INACTIVE"|string;
  1298. export type BudgetSummaries = BudgetSummary[];
  1299. export interface BudgetSummary {
  1300. /**
  1301. * The approximate dollar limit of the budget.
  1302. */
  1303. approximateDollarLimit: ConsumedUsageLimit;
  1304. /**
  1305. * The budget ID.
  1306. */
  1307. budgetId: BudgetId;
  1308. /**
  1309. * The date and time the resource was created.
  1310. */
  1311. createdAt: CreatedAt;
  1312. /**
  1313. * The user or system that created this resource.
  1314. */
  1315. createdBy: CreatedBy;
  1316. /**
  1317. * The description of the budget summary.
  1318. */
  1319. description?: Description;
  1320. /**
  1321. * The display name of the budget summary to update.
  1322. */
  1323. displayName: ResourceName;
  1324. /**
  1325. * The status of the budget. ACTIVE–The budget is being evaluated. INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.
  1326. */
  1327. status: BudgetStatus;
  1328. /**
  1329. * The date and time the resource was updated.
  1330. */
  1331. updatedAt?: UpdatedAt;
  1332. /**
  1333. * The user or system that updated this resource.
  1334. */
  1335. updatedBy?: UpdatedBy;
  1336. /**
  1337. * The resource used to track expenditure in the budget.
  1338. */
  1339. usageTrackingResource: UsageTrackingResource;
  1340. /**
  1341. * The consumed usage for the budget.
  1342. */
  1343. usages: ConsumedUsages;
  1344. }
  1345. export type CancelSessionActions = {[key: string]: SessionActionIdList};
  1346. export type ClientToken = string;
  1347. export type CombinationExpression = string;
  1348. export type ComparisonOperator = "EQUAL"|"NOT_EQUAL"|"GREATER_THAN_EQUAL_TO"|"GREATER_THAN"|"LESS_THAN_EQUAL_TO"|"LESS_THAN"|string;
  1349. export type CompletedStatus = "SUCCEEDED"|"FAILED"|"INTERRUPTED"|"CANCELED"|"NEVER_ATTEMPTED"|string;
  1350. export type ConsumedUsageLimit = number;
  1351. export interface ConsumedUsages {
  1352. /**
  1353. * The amount of the budget consumed.
  1354. */
  1355. approximateDollarUsage: Float;
  1356. }
  1357. export interface CopyJobTemplateRequest {
  1358. /**
  1359. * The farm ID to copy.
  1360. */
  1361. farmId: FarmId;
  1362. /**
  1363. * The job ID to copy.
  1364. */
  1365. jobId: JobId;
  1366. /**
  1367. * The queue ID to copy.
  1368. */
  1369. queueId: QueueId;
  1370. /**
  1371. * The Amazon S3 bucket name and key where you would like to add a copy of the job template.
  1372. */
  1373. targetS3Location: S3Location;
  1374. }
  1375. export interface CopyJobTemplateResponse {
  1376. /**
  1377. * The format of the job template, either JSON or YAML.
  1378. */
  1379. templateType: JobTemplateType;
  1380. }
  1381. export type CpuArchitectureType = "x86_64"|"arm64"|string;
  1382. export interface CreateBudgetRequest {
  1383. /**
  1384. * The budget actions to specify what happens when the budget runs out.
  1385. */
  1386. actions: BudgetActionsToAdd;
  1387. /**
  1388. * The dollar limit based on consumed usage.
  1389. */
  1390. approximateDollarLimit: ConsumedUsageLimit;
  1391. /**
  1392. * The unique token which the server uses to recognize retries of the same request.
  1393. */
  1394. clientToken?: ClientToken;
  1395. /**
  1396. * The description of the budget.
  1397. */
  1398. description?: Description;
  1399. /**
  1400. * The display name of the budget.
  1401. */
  1402. displayName: ResourceName;
  1403. /**
  1404. * The farm ID to include in this budget.
  1405. */
  1406. farmId: FarmId;
  1407. /**
  1408. * The schedule to associate with this budget.
  1409. */
  1410. schedule: BudgetSchedule;
  1411. /**
  1412. * The queue ID provided to this budget to track usage.
  1413. */
  1414. usageTrackingResource: UsageTrackingResource;
  1415. }
  1416. export interface CreateBudgetResponse {
  1417. /**
  1418. * The budget ID.
  1419. */
  1420. budgetId: BudgetId;
  1421. }
  1422. export interface CreateFarmRequest {
  1423. /**
  1424. * The unique token which the server uses to recognize retries of the same request.
  1425. */
  1426. clientToken?: ClientToken;
  1427. /**
  1428. * The description of the farm.
  1429. */
  1430. description?: Description;
  1431. /**
  1432. * The display name of the farm.
  1433. */
  1434. displayName: ResourceName;
  1435. /**
  1436. * The ARN of the KMS key to use on the farm.
  1437. */
  1438. kmsKeyArn?: KmsKeyArn;
  1439. /**
  1440. * The tags to add to your farm. Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
  1441. */
  1442. tags?: Tags;
  1443. }
  1444. export interface CreateFarmResponse {
  1445. /**
  1446. * The farm ID.
  1447. */
  1448. farmId: FarmId;
  1449. }
  1450. export interface CreateFleetRequest {
  1451. /**
  1452. * The unique token which the server uses to recognize retries of the same request.
  1453. */
  1454. clientToken?: ClientToken;
  1455. /**
  1456. * The configuration settings for the fleet. Customer managed fleets are self-managed. Service managed Amazon EC2 fleets are managed by Deadline Cloud.
  1457. */
  1458. configuration: FleetConfiguration;
  1459. /**
  1460. * The description of the fleet.
  1461. */
  1462. description?: Description;
  1463. /**
  1464. * The display name of the fleet.
  1465. */
  1466. displayName: ResourceName;
  1467. /**
  1468. * The farm ID of the farm to connect to the fleet.
  1469. */
  1470. farmId: FarmId;
  1471. /**
  1472. * The maximum number of workers for the fleet.
  1473. */
  1474. maxWorkerCount: MinZeroMaxInteger;
  1475. /**
  1476. * The minimum number of workers for the fleet.
  1477. */
  1478. minWorkerCount?: MinZeroMaxInteger;
  1479. /**
  1480. * The IAM role ARN for the role that the fleet's workers will use.
  1481. */
  1482. roleArn: IamRoleArn;
  1483. /**
  1484. * Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
  1485. */
  1486. tags?: Tags;
  1487. }
  1488. export interface CreateFleetResponse {
  1489. /**
  1490. * The fleet ID.
  1491. */
  1492. fleetId: FleetId;
  1493. }
  1494. export interface CreateJobRequest {
  1495. /**
  1496. * The attachments for the job. Attach files required for the job to run to a render job.
  1497. */
  1498. attachments?: Attachments;
  1499. /**
  1500. * The unique token which the server uses to recognize retries of the same request.
  1501. */
  1502. clientToken?: ClientToken;
  1503. /**
  1504. * The farm ID of the farm to connect to the job.
  1505. */
  1506. farmId: FarmId;
  1507. /**
  1508. * The number of task failures before the job stops running and is marked as FAILED.
  1509. */
  1510. maxFailedTasksCount?: MaxFailedTasksCount;
  1511. /**
  1512. * The maximum number of retries for a job.
  1513. */
  1514. maxRetriesPerTask?: MaxRetriesPerTask;
  1515. /**
  1516. * The parameters for the job.
  1517. */
  1518. parameters?: JobParameters;
  1519. /**
  1520. * The priority of the job on a scale of 1 to 100. The highest priority is 1.
  1521. */
  1522. priority: JobPriority;
  1523. /**
  1524. * The ID of the queue that the job is submitted to.
  1525. */
  1526. queueId: QueueId;
  1527. /**
  1528. * The storage profile ID for the storage profile to connect to the job.
  1529. */
  1530. storageProfileId?: StorageProfileId;
  1531. /**
  1532. * The initial status of the job's tasks when they are created. Tasks that are created with a SUSPENDED status will not run until you update their status.
  1533. */
  1534. targetTaskRunStatus?: CreateJobTargetTaskRunStatus;
  1535. /**
  1536. * The job template to use for this job.
  1537. */
  1538. template: JobTemplate;
  1539. /**
  1540. * The file type for the job template.
  1541. */
  1542. templateType: JobTemplateType;
  1543. }
  1544. export interface CreateJobResponse {
  1545. /**
  1546. * The job ID.
  1547. */
  1548. jobId: JobId;
  1549. }
  1550. export type CreateJobTargetTaskRunStatus = "READY"|"SUSPENDED"|string;
  1551. export interface CreateLicenseEndpointRequest {
  1552. /**
  1553. * The unique token which the server uses to recognize retries of the same request.
  1554. */
  1555. clientToken?: ClientToken;
  1556. /**
  1557. * The security group IDs.
  1558. */
  1559. securityGroupIds: CreateLicenseEndpointRequestSecurityGroupIdsList;
  1560. /**
  1561. * The subnet IDs.
  1562. */
  1563. subnetIds: CreateLicenseEndpointRequestSubnetIdsList;
  1564. /**
  1565. * Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
  1566. */
  1567. tags?: Tags;
  1568. /**
  1569. * The VPC (virtual private cloud) ID to use with the license endpoint.
  1570. */
  1571. vpcId: VpcId;
  1572. }
  1573. export type CreateLicenseEndpointRequestSecurityGroupIdsList = SecurityGroupId[];
  1574. export type CreateLicenseEndpointRequestSubnetIdsList = SubnetId[];
  1575. export interface CreateLicenseEndpointResponse {
  1576. /**
  1577. * The license endpoint ID.
  1578. */
  1579. licenseEndpointId: LicenseEndpointId;
  1580. }
  1581. export interface CreateMonitorRequest {
  1582. /**
  1583. * The unique token which the server uses to recognize retries of the same request.
  1584. */
  1585. clientToken?: ClientToken;
  1586. /**
  1587. * The name that you give the monitor that is displayed in the Deadline Cloud console.
  1588. */
  1589. displayName: ResourceName;
  1590. /**
  1591. * The Amazon Resource Name (ARN) of the IAM Identity Center instance that authenticates monitor users.
  1592. */
  1593. identityCenterInstanceArn: IdentityCenterInstanceArn;
  1594. /**
  1595. * The Amazon Resource Name (ARN) of the IAM role that the monitor uses to connect to Deadline Cloud. Every user that signs in to the monitor using IAM Identity Center uses this role to access Deadline Cloud resources.
  1596. */
  1597. roleArn: IamRoleArn;
  1598. /**
  1599. * The subdomain to use when creating the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
  1600. */
  1601. subdomain: Subdomain;
  1602. }
  1603. export interface CreateMonitorResponse {
  1604. /**
  1605. * The Amazon Resource Name (ARN) that IAM Identity Center assigns to the monitor.
  1606. */
  1607. identityCenterApplicationArn: IdentityCenterApplicationArn;
  1608. /**
  1609. * The unique identifier of the monitor.
  1610. */
  1611. monitorId: MonitorId;
  1612. }
  1613. export interface CreateQueueEnvironmentRequest {
  1614. /**
  1615. * The unique token which the server uses to recognize retries of the same request.
  1616. */
  1617. clientToken?: ClientToken;
  1618. /**
  1619. * The farm ID of the farm to connect to the environment.
  1620. */
  1621. farmId: FarmId;
  1622. /**
  1623. * Sets the priority of the environments in the queue from 0 to 10,000, where 0 is the highest priority. If two environments share the same priority value, the environment created first takes higher priority.
  1624. */
  1625. priority: Priority;
  1626. /**
  1627. * The queue ID to connect the queue and environment.
  1628. */
  1629. queueId: QueueId;
  1630. /**
  1631. * The environment template to use in the queue.
  1632. */
  1633. template: EnvironmentTemplate;
  1634. /**
  1635. * The template's file type, JSON or YAML.
  1636. */
  1637. templateType: EnvironmentTemplateType;
  1638. }
  1639. export interface CreateQueueEnvironmentResponse {
  1640. /**
  1641. * The queue environment ID.
  1642. */
  1643. queueEnvironmentId: QueueEnvironmentId;
  1644. }
  1645. export interface CreateQueueFleetAssociationRequest {
  1646. /**
  1647. * The ID of the farm that the queue and fleet belong to.
  1648. */
  1649. farmId: FarmId;
  1650. /**
  1651. * The fleet ID.
  1652. */
  1653. fleetId: FleetId;
  1654. /**
  1655. * The queue ID.
  1656. */
  1657. queueId: QueueId;
  1658. }
  1659. export interface CreateQueueFleetAssociationResponse {
  1660. }
  1661. export interface CreateQueueRequest {
  1662. /**
  1663. * The storage profile IDs to include in the queue.
  1664. */
  1665. allowedStorageProfileIds?: AllowedStorageProfileIds;
  1666. /**
  1667. * The unique token which the server uses to recognize retries of the same request.
  1668. */
  1669. clientToken?: ClientToken;
  1670. /**
  1671. * The default action to take on a queue if a budget isn't configured.
  1672. */
  1673. defaultBudgetAction?: DefaultQueueBudgetAction;
  1674. /**
  1675. * The description of the queue.
  1676. */
  1677. description?: Description;
  1678. /**
  1679. * The display name of the queue.
  1680. */
  1681. displayName: ResourceName;
  1682. /**
  1683. * The farm ID of the farm to connect to the queue.
  1684. */
  1685. farmId: FarmId;
  1686. /**
  1687. * The job attachment settings for the queue. These are the Amazon S3 bucket name and the Amazon S3 prefix.
  1688. */
  1689. jobAttachmentSettings?: JobAttachmentSettings;
  1690. /**
  1691. * The jobs in the queue run as the specified POSIX user.
  1692. */
  1693. jobRunAsUser?: JobRunAsUser;
  1694. /**
  1695. * The file system location name to include in the queue.
  1696. */
  1697. requiredFileSystemLocationNames?: RequiredFileSystemLocationNames;
  1698. /**
  1699. * The IAM role ARN that workers will use while running jobs for this queue.
  1700. */
  1701. roleArn?: IamRoleArn;
  1702. /**
  1703. * Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
  1704. */
  1705. tags?: Tags;
  1706. }
  1707. export interface CreateQueueResponse {
  1708. /**
  1709. * The queue ID.
  1710. */
  1711. queueId: QueueId;
  1712. }
  1713. export interface CreateStorageProfileRequest {
  1714. /**
  1715. * The unique token which the server uses to recognize retries of the same request.
  1716. */
  1717. clientToken?: ClientToken;
  1718. /**
  1719. * The display name of the storage profile.
  1720. */
  1721. displayName: ResourceName;
  1722. /**
  1723. * The farm ID of the farm to connect to the storage profile.
  1724. */
  1725. farmId: FarmId;
  1726. /**
  1727. * File system paths to include in the storage profile.
  1728. */
  1729. fileSystemLocations?: FileSystemLocationsList;
  1730. /**
  1731. * The type of operating system (OS) for the storage profile.
  1732. */
  1733. osFamily: StorageProfileOperatingSystemFamily;
  1734. }
  1735. export interface CreateStorageProfileResponse {
  1736. /**
  1737. * The storage profile ID.
  1738. */
  1739. storageProfileId: StorageProfileId;
  1740. }
  1741. export interface CreateWorkerRequest {
  1742. /**
  1743. * The unique token which the server uses to recognize retries of the same request.
  1744. */
  1745. clientToken?: ClientToken;
  1746. /**
  1747. * The farm ID of the farm to connect to the worker.
  1748. */
  1749. farmId: FarmId;
  1750. /**
  1751. * The fleet ID to connect to the worker.
  1752. */
  1753. fleetId: FleetId;
  1754. /**
  1755. * The IP address and host name of the worker.
  1756. */
  1757. hostProperties?: HostPropertiesRequest;
  1758. }
  1759. export interface CreateWorkerResponse {
  1760. /**
  1761. * The worker ID.
  1762. */
  1763. workerId: WorkerId;
  1764. }
  1765. export type CreatedAt = Date;
  1766. export type CreatedBy = string;
  1767. export type CustomFleetAmountCapabilities = FleetAmountCapability[];
  1768. export type CustomFleetAttributeCapabilities = FleetAttributeCapability[];
  1769. export interface CustomerManagedFleetConfiguration {
  1770. /**
  1771. * The Auto Scaling mode for the customer managed fleet configuration.
  1772. */
  1773. mode: AutoScalingMode;
  1774. /**
  1775. * The storage profile ID.
  1776. */
  1777. storageProfileId?: StorageProfileId;
  1778. /**
  1779. * The worker capabilities for a customer managed fleet configuration.
  1780. */
  1781. workerCapabilities: CustomerManagedWorkerCapabilities;
  1782. }
  1783. export type CustomerManagedFleetOperatingSystemFamily = "WINDOWS"|"LINUX"|"MACOS"|string;
  1784. export interface CustomerManagedWorkerCapabilities {
  1785. /**
  1786. * The range of the accelerator.
  1787. */
  1788. acceleratorCount?: AcceleratorCountRange;
  1789. /**
  1790. * The total memory (MiB) for the customer managed worker capabilities.
  1791. */
  1792. acceleratorTotalMemoryMiB?: AcceleratorTotalMemoryMiBRange;
  1793. /**
  1794. * The accelerator types for the customer managed worker capabilities.
  1795. */
  1796. acceleratorTypes?: AcceleratorTypes;
  1797. /**
  1798. * The CPU architecture type for the customer managed worker capabilities.
  1799. */
  1800. cpuArchitectureType: CpuArchitectureType;
  1801. /**
  1802. * Custom requirement ranges for customer managed worker capabilities.
  1803. */
  1804. customAmounts?: CustomFleetAmountCapabilities;
  1805. /**
  1806. * Custom attributes for the customer manged worker capabilities.
  1807. */
  1808. customAttributes?: CustomFleetAttributeCapabilities;
  1809. /**
  1810. * The memory (MiB).
  1811. */
  1812. memoryMiB: MemoryMiBRange;
  1813. /**
  1814. * The operating system (OS) family.
  1815. */
  1816. osFamily: CustomerManagedFleetOperatingSystemFamily;
  1817. /**
  1818. * The vCPU count for the customer manged worker capabilities.
  1819. */
  1820. vCpuCount: VCpuCountRange;
  1821. }
  1822. export interface DateTimeFilterExpression {
  1823. /**
  1824. * The date and time.
  1825. */
  1826. dateTime: SyntheticTimestamp_date_time;
  1827. /**
  1828. * The name of the date-time field to filter on.
  1829. */
  1830. name: String;
  1831. /**
  1832. * The type of comparison to use to filter the results.
  1833. */
  1834. operator: ComparisonOperator;
  1835. }
  1836. export type DefaultQueueBudgetAction = "NONE"|"STOP_SCHEDULING_AND_COMPLETE_TASKS"|"STOP_SCHEDULING_AND_CANCEL_TASKS"|string;
  1837. export interface DeleteBudgetRequest {
  1838. /**
  1839. * The budget ID of the budget to delete.
  1840. */
  1841. budgetId: BudgetId;
  1842. /**
  1843. * The farm ID of the farm to remove from the budget.
  1844. */
  1845. farmId: FarmId;
  1846. }
  1847. export interface DeleteBudgetResponse {
  1848. }
  1849. export interface DeleteFarmRequest {
  1850. /**
  1851. * The farm ID of the farm to delete.
  1852. */
  1853. farmId: FarmId;
  1854. }
  1855. export interface DeleteFarmResponse {
  1856. }
  1857. export interface DeleteFleetRequest {
  1858. /**
  1859. * The unique token which the server uses to recognize retries of the same request.
  1860. */
  1861. clientToken?: ClientToken;
  1862. /**
  1863. * The farm ID of the farm to remove from the fleet.
  1864. */
  1865. farmId: FarmId;
  1866. /**
  1867. * The fleet ID of the fleet to delete.
  1868. */
  1869. fleetId: FleetId;
  1870. }
  1871. export interface DeleteFleetResponse {
  1872. }
  1873. export interface DeleteLicenseEndpointRequest {
  1874. /**
  1875. * The license endpoint ID of the license endpoint to delete.
  1876. */
  1877. licenseEndpointId: LicenseEndpointId;
  1878. }
  1879. export interface DeleteLicenseEndpointResponse {
  1880. }
  1881. export interface DeleteMeteredProductRequest {
  1882. /**
  1883. * The ID of the license endpoint from which to remove the metered product.
  1884. */
  1885. licenseEndpointId: LicenseEndpointId;
  1886. /**
  1887. * The product ID to remove from the license endpoint.
  1888. */
  1889. productId: MeteredProductId;
  1890. }
  1891. export interface DeleteMeteredProductResponse {
  1892. }
  1893. export interface DeleteMonitorRequest {
  1894. /**
  1895. * The unique identifier of the monitor to delete. This ID is returned by the CreateMonitor operation, and is included in the response to the GetMonitor operation.
  1896. */
  1897. monitorId: MonitorId;
  1898. }
  1899. export interface DeleteMonitorResponse {
  1900. }
  1901. export interface DeleteQueueEnvironmentRequest {
  1902. /**
  1903. * The farm ID of the farm from which to remove the queue environment.
  1904. */
  1905. farmId: FarmId;
  1906. /**
  1907. * The queue environment ID of the queue environment to delete.
  1908. */
  1909. queueEnvironmentId: QueueEnvironmentId;
  1910. /**
  1911. * The queue ID of the queue environment to delete.
  1912. */
  1913. queueId: QueueId;
  1914. }
  1915. export interface DeleteQueueEnvironmentResponse {
  1916. }
  1917. export interface DeleteQueueFleetAssociationRequest {
  1918. /**
  1919. * The farm ID of the farm that holds the queue-fleet association.
  1920. */
  1921. farmId: FarmId;
  1922. /**
  1923. * The fleet ID of the queue-fleet association.
  1924. */
  1925. fleetId: FleetId;
  1926. /**
  1927. * The queue ID of the queue-fleet association.
  1928. */
  1929. queueId: QueueId;
  1930. }
  1931. export interface DeleteQueueFleetAssociationResponse {
  1932. }
  1933. export interface DeleteQueueRequest {
  1934. /**
  1935. * The ID of the farm from which to remove the queue.
  1936. */
  1937. farmId: FarmId;
  1938. /**
  1939. * The queue ID of the queue to delete.
  1940. */
  1941. queueId: QueueId;
  1942. }
  1943. export interface DeleteQueueResponse {
  1944. }
  1945. export interface DeleteStorageProfileRequest {
  1946. /**
  1947. * The farm ID of the farm from which to remove the storage profile.
  1948. */
  1949. farmId: FarmId;
  1950. /**
  1951. * The storage profile ID of the storage profile to delete.
  1952. */
  1953. storageProfileId: StorageProfileId;
  1954. }
  1955. export interface DeleteStorageProfileResponse {
  1956. }
  1957. export interface DeleteWorkerRequest {
  1958. /**
  1959. * The farm ID of the worker to delete.
  1960. */
  1961. farmId: FarmId;
  1962. /**
  1963. * The fleet ID of the worker to delete.
  1964. */
  1965. fleetId: FleetId;
  1966. /**
  1967. * The worker ID of the worker to delete.
  1968. */
  1969. workerId: WorkerId;
  1970. }
  1971. export interface DeleteWorkerResponse {
  1972. }
  1973. export type DependenciesList = StepId[];
  1974. export type DependencyConsumerResolutionStatus = "RESOLVED"|"UNRESOLVED"|string;
  1975. export interface DependencyCounts {
  1976. /**
  1977. * The number of consumers resolved.
  1978. */
  1979. consumersResolved: Integer;
  1980. /**
  1981. * The number of unresolved consumers.
  1982. */
  1983. consumersUnresolved: Integer;
  1984. /**
  1985. * The number of resolved dependencies.
  1986. */
  1987. dependenciesResolved: Integer;
  1988. /**
  1989. * The number of unresolved dependencies.
  1990. */
  1991. dependenciesUnresolved: Integer;
  1992. }
  1993. export type Description = string;
  1994. export type DesiredWorkerStatus = "STOPPED"|string;
  1995. export interface DisassociateMemberFromFarmRequest {
  1996. /**
  1997. * The farm ID of the farm to disassociate from the member.
  1998. */
  1999. farmId: FarmId;
  2000. /**
  2001. * A member's principal ID to disassociate from a farm.
  2002. */
  2003. principalId: IdentityCenterPrincipalId;
  2004. }
  2005. export interface DisassociateMemberFromFarmResponse {
  2006. }
  2007. export interface DisassociateMemberFromFleetRequest {
  2008. /**
  2009. * The farm ID of the fleet to disassociate a member from.
  2010. */
  2011. farmId: FarmId;
  2012. /**
  2013. * The fleet ID of the fleet to from which to disassociate a member.
  2014. */
  2015. fleetId: FleetId;
  2016. /**
  2017. * A member's principal ID to disassociate from a fleet.
  2018. */
  2019. principalId: IdentityCenterPrincipalId;
  2020. }
  2021. export interface DisassociateMemberFromFleetResponse {
  2022. }
  2023. export interface DisassociateMemberFromJobRequest {
  2024. /**
  2025. * The farm ID for the job to disassociate from the member.
  2026. */
  2027. farmId: FarmId;
  2028. /**
  2029. * The job ID to disassociate from a member in a job.
  2030. */
  2031. jobId: JobId;
  2032. /**
  2033. * A member's principal ID to disassociate from a job.
  2034. */
  2035. principalId: IdentityCenterPrincipalId;
  2036. /**
  2037. * The queue ID connected to a job for which you're disassociating a member.
  2038. */
  2039. queueId: QueueId;
  2040. }
  2041. export interface DisassociateMemberFromJobResponse {
  2042. }
  2043. export interface DisassociateMemberFromQueueRequest {
  2044. /**
  2045. * The farm ID for the queue to disassociate from a member.
  2046. */
  2047. farmId: FarmId;
  2048. /**
  2049. * A member's principal ID to disassociate from a queue.
  2050. */
  2051. principalId: IdentityCenterPrincipalId;
  2052. /**
  2053. * The queue ID of the queue in which you're disassociating from a member.
  2054. */
  2055. queueId: QueueId;
  2056. }
  2057. export interface DisassociateMemberFromQueueResponse {
  2058. }
  2059. export type DnsName = string;
  2060. export interface Document {
  2061. }
  2062. export type Double = number;
  2063. export type EbsIops = number;
  2064. export type EbsThroughputMiB = number;
  2065. export interface Ec2EbsVolume {
  2066. /**
  2067. * The IOPS per volume.
  2068. */
  2069. iops?: EbsIops;
  2070. /**
  2071. * The EBS volume size in GiB.
  2072. */
  2073. sizeGiB?: Integer;
  2074. /**
  2075. * The throughput per volume in MiB.
  2076. */
  2077. throughputMiB?: EbsThroughputMiB;
  2078. }
  2079. export type Ec2MarketType = "on-demand"|"spot"|string;
  2080. export type EndedAt = Date;
  2081. export type EndsAt = Date;
  2082. export interface EnvironmentDetailsEntity {
  2083. /**
  2084. * The environment ID.
  2085. */
  2086. environmentId: EnvironmentId;
  2087. /**
  2088. * The job ID.
  2089. */
  2090. jobId: JobId;
  2091. /**
  2092. * The schema version in the environment.
  2093. */
  2094. schemaVersion: String;
  2095. /**
  2096. * The template used for the environment.
  2097. */
  2098. template: Document;
  2099. }
  2100. export interface EnvironmentDetailsError {
  2101. /**
  2102. * The error code.
  2103. */
  2104. code: JobEntityErrorCode;
  2105. /**
  2106. * The environment ID.
  2107. */
  2108. environmentId: EnvironmentId;
  2109. /**
  2110. * The job ID.
  2111. */
  2112. jobId: JobId;
  2113. /**
  2114. * The error message detailing the error's cause.
  2115. */
  2116. message: String;
  2117. }
  2118. export interface EnvironmentDetailsIdentifiers {
  2119. /**
  2120. * The environment ID.
  2121. */
  2122. environmentId: EnvironmentId;
  2123. /**
  2124. * The job ID.
  2125. */
  2126. jobId: JobId;
  2127. }
  2128. export interface EnvironmentEnterSessionActionDefinition {
  2129. /**
  2130. * The environment ID.
  2131. */
  2132. environmentId: EnvironmentId;
  2133. }
  2134. export interface EnvironmentEnterSessionActionDefinitionSummary {
  2135. /**
  2136. * The environment ID.
  2137. */
  2138. environmentId: EnvironmentId;
  2139. }
  2140. export interface EnvironmentExitSessionActionDefinition {
  2141. /**
  2142. * The environment ID.
  2143. */
  2144. environmentId: EnvironmentId;
  2145. }
  2146. export interface EnvironmentExitSessionActionDefinitionSummary {
  2147. /**
  2148. * The environment ID.
  2149. */
  2150. environmentId: EnvironmentId;
  2151. }
  2152. export type EnvironmentId = string;
  2153. export type EnvironmentName = string;
  2154. export type EnvironmentTemplate = string;
  2155. export type EnvironmentTemplateType = "JSON"|"YAML"|string;
  2156. export type FarmId = string;
  2157. export interface FarmMember {
  2158. /**
  2159. * The farm ID of the farm member.
  2160. */
  2161. farmId: FarmId;
  2162. /**
  2163. * The identity store ID of the farm member.
  2164. */
  2165. identityStoreId: IdentityStoreId;
  2166. /**
  2167. * The farm member's membership level.
  2168. */
  2169. membershipLevel: MembershipLevel;
  2170. /**
  2171. * The principal ID of the farm member.
  2172. */
  2173. principalId: IdentityCenterPrincipalId;
  2174. /**
  2175. * The principal type of the farm member.
  2176. */
  2177. principalType: PrincipalType;
  2178. }
  2179. export type FarmMembers = FarmMember[];
  2180. export type FarmSummaries = FarmSummary[];
  2181. export interface FarmSummary {
  2182. /**
  2183. * The date and time the resource was created.
  2184. */
  2185. createdAt: CreatedAt;
  2186. /**
  2187. * The user or system that created this resource.
  2188. */
  2189. createdBy: CreatedBy;
  2190. /**
  2191. * The display name of the farm.
  2192. */
  2193. displayName: ResourceName;
  2194. /**
  2195. * The farm ID.
  2196. */
  2197. farmId: FarmId;
  2198. /**
  2199. * The ARN for the KMS key.
  2200. */
  2201. kmsKeyArn?: KmsKeyArn;
  2202. /**
  2203. * The date and time the resource was updated.
  2204. */
  2205. updatedAt?: UpdatedAt;
  2206. /**
  2207. * The user or system that updated this resource.
  2208. */
  2209. updatedBy?: UpdatedBy;
  2210. }
  2211. export interface FieldSortExpression {
  2212. /**
  2213. * The name of the field.
  2214. */
  2215. name: String;
  2216. /**
  2217. * The sort order for the field.
  2218. */
  2219. sortOrder: SortOrder;
  2220. }
  2221. export interface FileSystemLocation {
  2222. /**
  2223. * The location name.
  2224. */
  2225. name: FileSystemLocationName;
  2226. /**
  2227. * The file path.
  2228. */
  2229. path: PathString;
  2230. /**
  2231. * The type of file.
  2232. */
  2233. type: FileSystemLocationType;
  2234. }
  2235. export type FileSystemLocationName = string;
  2236. export type FileSystemLocationType = "SHARED"|"LOCAL"|string;
  2237. export type FileSystemLocationsList = FileSystemLocation[];
  2238. export interface FixedBudgetSchedule {
  2239. /**
  2240. * When the budget ends.
  2241. */
  2242. endTime: EndsAt;
  2243. /**
  2244. * When the budget starts.
  2245. */
  2246. startTime: StartsAt;
  2247. }
  2248. export type FleetAmountCapabilities = FleetAmountCapability[];
  2249. export interface FleetAmountCapability {
  2250. /**
  2251. * The maximum amount of the fleet worker capability.
  2252. */
  2253. max?: Float;
  2254. /**
  2255. * The minimum amount of fleet worker capability.
  2256. */
  2257. min: Float;
  2258. /**
  2259. * The name of the fleet capability.
  2260. */
  2261. name: AmountCapabilityName;
  2262. }
  2263. export type FleetAttributeCapabilities = FleetAttributeCapability[];
  2264. export interface FleetAttributeCapability {
  2265. /**
  2266. * The name of the fleet attribute capability for the worker.
  2267. */
  2268. name: AttributeCapabilityName;
  2269. /**
  2270. * The number of fleet attribute capabilities.
  2271. */
  2272. values: AttributeCapabilityValuesList;
  2273. }
  2274. export interface FleetCapabilities {
  2275. /**
  2276. * Amount capabilities of the fleet.
  2277. */
  2278. amounts?: FleetAmountCapabilities;
  2279. /**
  2280. * Attribute capabilities of the fleet.
  2281. */
  2282. attributes?: FleetAttributeCapabilities;
  2283. }
  2284. export interface FleetConfiguration {
  2285. /**
  2286. * The customer managed fleets within a fleet configuration.
  2287. */
  2288. customerManaged?: CustomerManagedFleetConfiguration;
  2289. /**
  2290. * The service managed Amazon EC2 instances for a fleet configuration.
  2291. */
  2292. serviceManagedEc2?: ServiceManagedEc2FleetConfiguration;
  2293. }
  2294. export type FleetId = string;
  2295. export interface FleetMember {
  2296. /**
  2297. * The farm ID.
  2298. */
  2299. farmId: FarmId;
  2300. /**
  2301. * The fleet ID.
  2302. */
  2303. fleetId: FleetId;
  2304. /**
  2305. * The identity store ID.
  2306. */
  2307. identityStoreId: IdentityStoreId;
  2308. /**
  2309. * The fleet member's membership level.
  2310. */
  2311. membershipLevel: MembershipLevel;
  2312. /**
  2313. * The principal ID of the fleet member.
  2314. */
  2315. principalId: IdentityCenterPrincipalId;
  2316. /**
  2317. * The principal type of the fleet member.
  2318. */
  2319. principalType: PrincipalType;
  2320. }
  2321. export type FleetMembers = FleetMember[];
  2322. export type FleetStatus = "ACTIVE"|"CREATE_IN_PROGRESS"|"UPDATE_IN_PROGRESS"|"CREATE_FAILED"|"UPDATE_FAILED"|string;
  2323. export type FleetSummaries = FleetSummary[];
  2324. export interface FleetSummary {
  2325. /**
  2326. * The Auto Scaling status of a fleet.
  2327. */
  2328. autoScalingStatus?: AutoScalingStatus;
  2329. /**
  2330. * The configuration details for the fleet.
  2331. */
  2332. configuration: FleetConfiguration;
  2333. /**
  2334. * The date and time the resource was created.
  2335. */
  2336. createdAt: CreatedAt;
  2337. /**
  2338. * The user or system that created this resource.
  2339. */
  2340. createdBy: CreatedBy;
  2341. /**
  2342. * The display name of the fleet summary to update.
  2343. */
  2344. displayName: ResourceName;
  2345. /**
  2346. * The farm ID.
  2347. */
  2348. farmId: FarmId;
  2349. /**
  2350. * The fleet ID.
  2351. */
  2352. fleetId: FleetId;
  2353. /**
  2354. * The maximum number of workers specified in the fleet.
  2355. */
  2356. maxWorkerCount: MinZeroMaxInteger;
  2357. /**
  2358. * The minimum number of workers in the fleet.
  2359. */
  2360. minWorkerCount: MinZeroMaxInteger;
  2361. /**
  2362. * The status of the fleet.
  2363. */
  2364. status: FleetStatus;
  2365. /**
  2366. * The target number of workers in a fleet.
  2367. */
  2368. targetWorkerCount?: Integer;
  2369. /**
  2370. * The date and time the resource was updated.
  2371. */
  2372. updatedAt?: UpdatedAt;
  2373. /**
  2374. * The user or system that updated this resource.
  2375. */
  2376. updatedBy?: UpdatedBy;
  2377. /**
  2378. * The number of workers in the fleet summary.
  2379. */
  2380. workerCount: Integer;
  2381. }
  2382. export type Float = number;
  2383. export type FloatString = string;
  2384. export interface GetBudgetRequest {
  2385. /**
  2386. * The budget ID.
  2387. */
  2388. budgetId: BudgetId;
  2389. /**
  2390. * The farm ID of the farm connected to the budget.
  2391. */
  2392. farmId: FarmId;
  2393. }
  2394. export interface GetBudgetResponse {
  2395. /**
  2396. * The budget actions for the budget.
  2397. */
  2398. actions: ResponseBudgetActionList;
  2399. /**
  2400. * The consumed usage limit for the budget.
  2401. */
  2402. approximateDollarLimit: ConsumedUsageLimit;
  2403. /**
  2404. * The budget ID.
  2405. */
  2406. budgetId: BudgetId;
  2407. /**
  2408. * The date and time the resource was created.
  2409. */
  2410. createdAt: CreatedAt;
  2411. /**
  2412. * The user or system that created this resource.
  2413. */
  2414. createdBy: CreatedBy;
  2415. /**
  2416. * The description of the budget.
  2417. */
  2418. description?: Description;
  2419. /**
  2420. * The display name of the budget.
  2421. */
  2422. displayName: ResourceName;
  2423. /**
  2424. * The date and time the queue stopped.
  2425. */
  2426. queueStoppedAt?: UpdatedAt;
  2427. /**
  2428. * The budget schedule.
  2429. */
  2430. schedule: BudgetSchedule;
  2431. /**
  2432. * The status of the budget. ACTIVE–Get a budget being evaluated. INACTIVE–Get an inactive budget. This can include expired, canceled, or deleted statuses.
  2433. */
  2434. status: BudgetStatus;
  2435. /**
  2436. * The date and time the resource was updated.
  2437. */
  2438. updatedAt?: UpdatedAt;
  2439. /**
  2440. * The user or system that updated this resource.
  2441. */
  2442. updatedBy?: UpdatedBy;
  2443. /**
  2444. * The resource that the budget is tracking usage for.
  2445. */
  2446. usageTrackingResource: UsageTrackingResource;
  2447. /**
  2448. * The usages of the budget.
  2449. */
  2450. usages: ConsumedUsages;
  2451. }
  2452. export interface GetFarmRequest {
  2453. /**
  2454. * The farm ID of the farm.
  2455. */
  2456. farmId: FarmId;
  2457. }
  2458. export interface GetFarmResponse {
  2459. /**
  2460. * The date and time the resource was created.
  2461. */
  2462. createdAt: CreatedAt;
  2463. /**
  2464. * The user or system that created this resource.
  2465. */
  2466. createdBy: CreatedBy;
  2467. /**
  2468. * The description of the farm.
  2469. */
  2470. description?: Description;
  2471. /**
  2472. * The display name of the farm.
  2473. */
  2474. displayName: ResourceName;
  2475. /**
  2476. * The farm ID of the farm to get.
  2477. */
  2478. farmId: FarmId;
  2479. /**
  2480. * The ARN of the KMS key used on the farm.
  2481. */
  2482. kmsKeyArn: KmsKeyArn;
  2483. /**
  2484. * The date and time the resource was updated.
  2485. */
  2486. updatedAt?: UpdatedAt;
  2487. /**
  2488. * The user or system that updated this resource.
  2489. */
  2490. updatedBy?: UpdatedBy;
  2491. }
  2492. export interface GetFleetRequest {
  2493. /**
  2494. * The farm ID of the farm in the fleet.
  2495. */
  2496. farmId: FarmId;
  2497. /**
  2498. * The fleet ID of the fleet to get.
  2499. */
  2500. fleetId: FleetId;
  2501. }
  2502. export interface GetFleetResponse {
  2503. /**
  2504. * The Auto Scaling status of the fleet. Either GROWING, STEADY, or SHRINKING.
  2505. */
  2506. autoScalingStatus?: AutoScalingStatus;
  2507. /**
  2508. * Outlines what the fleet is capable of for minimums, maximums, and naming, in addition to attribute names and values.
  2509. */
  2510. capabilities?: FleetCapabilities;
  2511. /**
  2512. * The configuration setting for the fleet.
  2513. */
  2514. configuration: FleetConfiguration;
  2515. /**
  2516. * The date and time the resource was created.
  2517. */
  2518. createdAt: CreatedAt;
  2519. /**
  2520. * The user or system that created this resource.
  2521. */
  2522. createdBy: CreatedBy;
  2523. /**
  2524. * The description of the fleet.
  2525. */
  2526. description?: Description;
  2527. /**
  2528. * The display name of the fleet.
  2529. */
  2530. displayName: ResourceName;
  2531. /**
  2532. * The farm ID of the farm in the fleet.
  2533. */
  2534. farmId: FarmId;
  2535. /**
  2536. * The fleet ID.
  2537. */
  2538. fleetId: FleetId;
  2539. /**
  2540. * The maximum number of workers specified in the fleet.
  2541. */
  2542. maxWorkerCount: MinZeroMaxInteger;
  2543. /**
  2544. * The minimum number of workers specified in the fleet.
  2545. */
  2546. minWorkerCount: MinZeroMaxInteger;
  2547. /**
  2548. * The IAM role ARN.
  2549. */
  2550. roleArn: IamRoleArn;
  2551. /**
  2552. * The Auto Scaling status of the fleet.
  2553. */
  2554. status: FleetStatus;
  2555. /**
  2556. * The number of target workers in the fleet.
  2557. */
  2558. targetWorkerCount?: Integer;
  2559. /**
  2560. * The date and time the resource was updated.
  2561. */
  2562. updatedAt?: UpdatedAt;
  2563. /**
  2564. * The user or system that updated this resource.
  2565. */
  2566. updatedBy?: UpdatedBy;
  2567. /**
  2568. * The number of workers in the fleet.
  2569. */
  2570. workerCount: Integer;
  2571. }
  2572. export interface GetJobEntityError {
  2573. /**
  2574. * The environment details for the failed job entity.
  2575. */
  2576. environmentDetails?: EnvironmentDetailsError;
  2577. /**
  2578. * The job attachment details for the failed job entity.
  2579. */
  2580. jobAttachmentDetails?: JobAttachmentDetailsError;
  2581. /**
  2582. * The job details for the failed job entity.
  2583. */
  2584. jobDetails?: JobDetailsError;
  2585. /**
  2586. * The step details for the failed job entity.
  2587. */
  2588. stepDetails?: StepDetailsError;
  2589. }
  2590. export interface GetJobRequest {
  2591. /**
  2592. * The farm ID of the farm in the job.
  2593. */
  2594. farmId: FarmId;
  2595. /**
  2596. * The job ID.
  2597. */
  2598. jobId: JobId;
  2599. /**
  2600. * The queue ID associated with the job.
  2601. */
  2602. queueId: QueueId;
  2603. }
  2604. export interface GetJobResponse {
  2605. /**
  2606. * The attachments for the job.
  2607. */
  2608. attachments?: Attachments;
  2609. /**
  2610. * The date and time the resource was created.
  2611. */
  2612. createdAt: CreatedAt;
  2613. /**
  2614. * The user or system that created this resource.
  2615. */
  2616. createdBy: CreatedBy;
  2617. /**
  2618. * The description of the job.
  2619. */
  2620. description?: JobDescription;
  2621. /**
  2622. * The date and time the resource ended running.
  2623. */
  2624. endedAt?: EndedAt;
  2625. /**
  2626. * The job ID.
  2627. */
  2628. jobId: JobId;
  2629. /**
  2630. * The life cycle status for the job.
  2631. */
  2632. lifecycleStatus: JobLifecycleStatus;
  2633. /**
  2634. * A message that communicates the status of the life cycle for the job.
  2635. */
  2636. lifecycleStatusMessage: String;
  2637. /**
  2638. * The number of task failures before the job stops running and is marked as FAILED.
  2639. */
  2640. maxFailedTasksCount?: MaxFailedTasksCount;
  2641. /**
  2642. * The maximum number of retries per failed tasks.
  2643. */
  2644. maxRetriesPerTask?: MaxRetriesPerTask;
  2645. /**
  2646. * The name of the job.
  2647. */
  2648. name: JobName;
  2649. /**
  2650. * The parameters for the job.
  2651. */
  2652. parameters?: JobParameters;
  2653. /**
  2654. * The job priority.
  2655. */
  2656. priority: JobPriority;
  2657. /**
  2658. * The date and time the resource started running.
  2659. */
  2660. startedAt?: StartedAt;
  2661. /**
  2662. * The storage profile ID associated with the job.
  2663. */
  2664. storageProfileId?: StorageProfileId;
  2665. /**
  2666. * The task status with which the job started.
  2667. */
  2668. targetTaskRunStatus?: JobTargetTaskRunStatus;
  2669. /**
  2670. * The task run status for the job.
  2671. */
  2672. taskRunStatus?: TaskRunStatus;
  2673. /**
  2674. * The number of tasks running on the job.
  2675. */
  2676. taskRunStatusCounts?: TaskRunStatusCounts;
  2677. /**
  2678. * The date and time the resource was updated.
  2679. */
  2680. updatedAt?: UpdatedAt;
  2681. /**
  2682. * The user or system that updated this resource.
  2683. */
  2684. updatedBy?: UpdatedBy;
  2685. }
  2686. export interface GetLicenseEndpointRequest {
  2687. /**
  2688. * The license endpoint ID.
  2689. */
  2690. licenseEndpointId: LicenseEndpointId;
  2691. }
  2692. export interface GetLicenseEndpointResponse {
  2693. /**
  2694. * The DNS name.
  2695. */
  2696. dnsName?: DnsName;
  2697. /**
  2698. * The license endpoint ID.
  2699. */
  2700. licenseEndpointId: LicenseEndpointId;
  2701. /**
  2702. * The security group IDs for the license endpoint.
  2703. */
  2704. securityGroupIds?: GetLicenseEndpointResponseSecurityGroupIdsList;
  2705. /**
  2706. * The status of the license endpoint.
  2707. */
  2708. status: LicenseEndpointStatus;
  2709. /**
  2710. * The status message of the license endpoint.
  2711. */
  2712. statusMessage: StatusMessage;
  2713. /**
  2714. * The subnet IDs.
  2715. */
  2716. subnetIds?: GetLicenseEndpointResponseSubnetIdsList;
  2717. /**
  2718. * The VCP(virtual private cloud) ID associated with the license endpoint.
  2719. */
  2720. vpcId?: VpcId;
  2721. }
  2722. export type GetLicenseEndpointResponseSecurityGroupIdsList = SecurityGroupId[];
  2723. export type GetLicenseEndpointResponseSubnetIdsList = SubnetId[];
  2724. export interface GetMonitorRequest {
  2725. /**
  2726. * The unique identifier for the monitor. This ID is returned by the CreateMonitor operation.
  2727. */
  2728. monitorId: MonitorId;
  2729. }
  2730. export interface GetMonitorResponse {
  2731. /**
  2732. * The UNIX timestamp of the date and time that the monitor was created.
  2733. */
  2734. createdAt: CreatedAt;
  2735. /**
  2736. * The user name of the person that created the monitor.
  2737. */
  2738. createdBy: CreatedBy;
  2739. /**
  2740. * The name used to identify the monitor on the Deadline Cloud console.
  2741. */
  2742. displayName: ResourceName;
  2743. /**
  2744. * The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.
  2745. */
  2746. identityCenterApplicationArn: IdentityCenterApplicationArn;
  2747. /**
  2748. * The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.
  2749. */
  2750. identityCenterInstanceArn: IdentityCenterInstanceArn;
  2751. /**
  2752. * The unique identifier for the monitor.
  2753. */
  2754. monitorId: MonitorId;
  2755. /**
  2756. * The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
  2757. */
  2758. roleArn: IamRoleArn;
  2759. /**
  2760. * The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
  2761. */
  2762. subdomain: Subdomain;
  2763. /**
  2764. * The UNIX timestamp of the last date and time that the monitor was updated.
  2765. */
  2766. updatedAt?: UpdatedAt;
  2767. /**
  2768. * The user name of the person that last updated the monitor.
  2769. */
  2770. updatedBy?: UpdatedBy;
  2771. /**
  2772. * The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
  2773. */
  2774. url: Url;
  2775. }
  2776. export interface GetQueueEnvironmentRequest {
  2777. /**
  2778. * The farm ID for the queue environment.
  2779. */
  2780. farmId: FarmId;
  2781. /**
  2782. * The queue environment ID.
  2783. */
  2784. queueEnvironmentId: QueueEnvironmentId;
  2785. /**
  2786. * The queue ID for the queue environment.
  2787. */
  2788. queueId: QueueId;
  2789. }
  2790. export interface GetQueueEnvironmentResponse {
  2791. /**
  2792. * The date and time the resource was created.
  2793. */
  2794. createdAt: CreatedAt;
  2795. /**
  2796. * The user or system that created this resource.&gt;
  2797. */
  2798. createdBy: CreatedBy;
  2799. /**
  2800. * The name of the queue environment.
  2801. */
  2802. name: EnvironmentName;
  2803. /**
  2804. * The priority of the queue environment.
  2805. */
  2806. priority: Priority;
  2807. /**
  2808. * The queue environment ID.
  2809. */
  2810. queueEnvironmentId: QueueEnvironmentId;
  2811. /**
  2812. * The template for the queue environment.
  2813. */
  2814. template: EnvironmentTemplate;
  2815. /**
  2816. * The type of template for the queue environment.
  2817. */
  2818. templateType: EnvironmentTemplateType;
  2819. /**
  2820. * The date and time the resource was updated.
  2821. */
  2822. updatedAt?: UpdatedAt;
  2823. /**
  2824. * The user or system that updated this resource.
  2825. */
  2826. updatedBy?: UpdatedBy;
  2827. }
  2828. export interface GetQueueFleetAssociationRequest {
  2829. /**
  2830. * The farm ID of the farm that contains the queue-fleet association.
  2831. */
  2832. farmId: FarmId;
  2833. /**
  2834. * The fleet ID for the queue-fleet association.
  2835. */
  2836. fleetId: FleetId;
  2837. /**
  2838. * The queue ID for the queue-fleet association.
  2839. */
  2840. queueId: QueueId;
  2841. }
  2842. export interface GetQueueFleetAssociationResponse {
  2843. /**
  2844. * The date and time the resource was created.
  2845. */
  2846. createdAt: CreatedAt;
  2847. /**
  2848. * The user or system that created this resource.
  2849. */
  2850. createdBy: CreatedBy;
  2851. /**
  2852. * The fleet ID for the queue-fleet association.
  2853. */
  2854. fleetId: FleetId;
  2855. /**
  2856. * The queue ID for the queue-fleet association.
  2857. */
  2858. queueId: QueueId;
  2859. /**
  2860. * The status of the queue-fleet association.
  2861. */
  2862. status: QueueFleetAssociationStatus;
  2863. /**
  2864. * The date and time the resource was updated.
  2865. */
  2866. updatedAt?: UpdatedAt;
  2867. /**
  2868. * The user or system that updated this resource.
  2869. */
  2870. updatedBy?: UpdatedBy;
  2871. }
  2872. export interface GetQueueRequest {
  2873. /**
  2874. * The farm ID of the farm in the queue.
  2875. */
  2876. farmId: FarmId;
  2877. /**
  2878. * The queue ID for the queue to retrieve.
  2879. */
  2880. queueId: QueueId;
  2881. }
  2882. export interface GetQueueResponse {
  2883. /**
  2884. * The storage profile IDs for the queue.
  2885. */
  2886. allowedStorageProfileIds?: AllowedStorageProfileIds;
  2887. /**
  2888. * The reason the queue was blocked.
  2889. */
  2890. blockedReason?: QueueBlockedReason;
  2891. /**
  2892. * The date and time the resource was created.
  2893. */
  2894. createdAt: CreatedAt;
  2895. /**
  2896. * The user or system that created this resource.
  2897. */
  2898. createdBy: CreatedBy;
  2899. /**
  2900. * The default action taken on a queue if a budget wasn't configured.
  2901. */
  2902. defaultBudgetAction: DefaultQueueBudgetAction;
  2903. /**
  2904. * The description of the queue.
  2905. */
  2906. description?: Description;
  2907. /**
  2908. * The display name of the queue.
  2909. */
  2910. displayName: ResourceName;
  2911. /**
  2912. * The farm ID for the queue.
  2913. */
  2914. farmId: FarmId;
  2915. /**
  2916. * The job attachment settings for the queue.
  2917. */
  2918. jobAttachmentSettings?: JobAttachmentSettings;
  2919. /**
  2920. * The jobs in the queue ran as this specified POSIX user.
  2921. */
  2922. jobRunAsUser?: JobRunAsUser;
  2923. /**
  2924. * The queue ID.
  2925. */
  2926. queueId: QueueId;
  2927. /**
  2928. * A list of the required file system location names in the queue.
  2929. */
  2930. requiredFileSystemLocationNames?: RequiredFileSystemLocationNames;
  2931. /**
  2932. * The IAM role ARN.
  2933. */
  2934. roleArn?: IamRoleArn;
  2935. /**
  2936. * The status of the queue. ACTIVE–The queue is active. SCHEDULING–The queue is scheduling. SCHEDULING_BLOCKED–The queue scheduling is blocked. See the provided reason.
  2937. */
  2938. status: QueueStatus;
  2939. /**
  2940. * The date and time the resource was updated.
  2941. */
  2942. updatedAt?: UpdatedAt;
  2943. /**
  2944. * The user or system that updated this resource.
  2945. */
  2946. updatedBy?: UpdatedBy;
  2947. }
  2948. export interface GetSessionActionRequest {
  2949. /**
  2950. * The farm ID for the session action.
  2951. */
  2952. farmId: FarmId;
  2953. /**
  2954. * The job ID for the session.
  2955. */
  2956. jobId: JobId;
  2957. /**
  2958. * The queue ID for the session action.
  2959. */
  2960. queueId: QueueId;
  2961. /**
  2962. * The session action ID for the session.
  2963. */
  2964. sessionActionId: SessionActionId;
  2965. }
  2966. export interface GetSessionActionResponse {
  2967. /**
  2968. * The session action definition.
  2969. */
  2970. definition: SessionActionDefinition;
  2971. /**
  2972. * The date and time the resource ended running.
  2973. */
  2974. endedAt?: EndedAt;
  2975. /**
  2976. * The exit code to exit the session.
  2977. */
  2978. processExitCode?: ProcessExitCode;
  2979. /**
  2980. * The message that communicates the progress of the session action.
  2981. */
  2982. progressMessage?: SessionActionProgressMessage;
  2983. /**
  2984. * The percentage completed for a session action.
  2985. */
  2986. progressPercent?: SessionActionProgressPercent;
  2987. /**
  2988. * The session action ID.
  2989. */
  2990. sessionActionId: SessionActionId;
  2991. /**
  2992. * The session ID for the session action.
  2993. */
  2994. sessionId: SessionId;
  2995. /**
  2996. * The date and time the resource started running.
  2997. */
  2998. startedAt?: StartedAt;
  2999. /**
  3000. * The status of the session action.
  3001. */
  3002. status: SessionActionStatus;
  3003. /**
  3004. * The Linux timestamp of the date and time the session action was last updated.
  3005. */
  3006. workerUpdatedAt?: Timestamp;
  3007. }
  3008. export interface GetSessionRequest {
  3009. /**
  3010. * The farm ID for the session.
  3011. */
  3012. farmId: FarmId;
  3013. /**
  3014. * The job ID for the session.
  3015. */
  3016. jobId: JobId;
  3017. /**
  3018. * The queue ID for the session.
  3019. */
  3020. queueId: QueueId;
  3021. /**
  3022. * The session ID.
  3023. */
  3024. sessionId: SessionId;
  3025. }
  3026. export interface GetSessionResponse {
  3027. /**
  3028. * The date and time the resource ended running.
  3029. */
  3030. endedAt?: EndedAt;
  3031. /**
  3032. * The fleet ID for the session.
  3033. */
  3034. fleetId: FleetId;
  3035. /**
  3036. * Provides the Amazon EC2 properties of the host.
  3037. */
  3038. hostProperties?: HostPropertiesResponse;
  3039. /**
  3040. * The life cycle status of the session.
  3041. */
  3042. lifecycleStatus: SessionLifecycleStatus;
  3043. /**
  3044. * The session log.
  3045. */
  3046. log: LogConfiguration;
  3047. /**
  3048. * The session ID.
  3049. */
  3050. sessionId: SessionId;
  3051. /**
  3052. * The date and time the resource started running.
  3053. */
  3054. startedAt: StartedAt;
  3055. /**
  3056. * The life cycle status with which the session started.
  3057. */
  3058. targetLifecycleStatus?: SessionLifecycleTargetStatus;
  3059. /**
  3060. * The date and time the resource was updated.
  3061. */
  3062. updatedAt?: UpdatedAt;
  3063. /**
  3064. * The user or system that updated this resource.
  3065. */
  3066. updatedBy?: UpdatedBy;
  3067. /**
  3068. * The worker ID for the session.
  3069. */
  3070. workerId: WorkerId;
  3071. /**
  3072. * The worker log for the session.
  3073. */
  3074. workerLog?: LogConfiguration;
  3075. }
  3076. export interface GetSessionsStatisticsAggregationRequest {
  3077. /**
  3078. * The identifier returned by the StartSessionsStatisticsAggregation operation that identifies the aggregated statistics.
  3079. */
  3080. aggregationId: AggregationId;
  3081. /**
  3082. * The identifier of the farm to include in the statistics. This should be the same as the farm ID used in the call to the StartSessionsStatisticsAggregation operation.
  3083. */
  3084. farmId: FarmId;
  3085. /**
  3086. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  3087. */
  3088. maxResults?: MaxResults;
  3089. /**
  3090. * The token for the next set of results, or null to start from the beginning.
  3091. */
  3092. nextToken?: String;
  3093. }
  3094. export interface GetSessionsStatisticsAggregationResponse {
  3095. /**
  3096. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  3097. */
  3098. nextToken?: String;
  3099. /**
  3100. * The statistics for the specified fleets or queues.
  3101. */
  3102. statistics?: StatisticsList;
  3103. /**
  3104. * The status of the aggregated results.
  3105. */
  3106. status: SessionsStatisticsAggregationStatus;
  3107. /**
  3108. * A message that describes the status.
  3109. */
  3110. statusMessage?: String;
  3111. }
  3112. export interface GetStepRequest {
  3113. /**
  3114. * The farm ID for the step.
  3115. */
  3116. farmId: FarmId;
  3117. /**
  3118. * The job ID for the step.
  3119. */
  3120. jobId: JobId;
  3121. /**
  3122. * The queue ID for the step.
  3123. */
  3124. queueId: QueueId;
  3125. /**
  3126. * The step ID.
  3127. */
  3128. stepId: StepId;
  3129. }
  3130. export interface GetStepResponse {
  3131. /**
  3132. * The date and time the resource was created.
  3133. */
  3134. createdAt: CreatedAt;
  3135. /**
  3136. * The user or system that created this resource.
  3137. */
  3138. createdBy: CreatedBy;
  3139. /**
  3140. * The number of dependencies in the step.
  3141. */
  3142. dependencyCounts?: DependencyCounts;
  3143. /**
  3144. * The description of the step.
  3145. */
  3146. description?: StepDescription;
  3147. /**
  3148. * The date and time the resource ended running.
  3149. */
  3150. endedAt?: EndedAt;
  3151. /**
  3152. * The life cycle status of the step.
  3153. */
  3154. lifecycleStatus: StepLifecycleStatus;
  3155. /**
  3156. * A message that describes the lifecycle status of the step.
  3157. */
  3158. lifecycleStatusMessage?: String;
  3159. /**
  3160. * The name of the step.
  3161. */
  3162. name: StepName;
  3163. /**
  3164. * A list of step parameters and the combination expression for the step.
  3165. */
  3166. parameterSpace?: ParameterSpace;
  3167. /**
  3168. * The required capabilities of the step.
  3169. */
  3170. requiredCapabilities?: StepRequiredCapabilities;
  3171. /**
  3172. * The date and time the resource started running.
  3173. */
  3174. startedAt?: StartedAt;
  3175. /**
  3176. * The step ID.
  3177. */
  3178. stepId: StepId;
  3179. /**
  3180. * The task status with which the job started.
  3181. */
  3182. targetTaskRunStatus?: StepTargetTaskRunStatus;
  3183. /**
  3184. * The task run status for the job.
  3185. */
  3186. taskRunStatus: TaskRunStatus;
  3187. /**
  3188. * The number of tasks running on the job.
  3189. */
  3190. taskRunStatusCounts: TaskRunStatusCounts;
  3191. /**
  3192. * The date and time the resource was updated.
  3193. */
  3194. updatedAt?: UpdatedAt;
  3195. /**
  3196. * The user or system that updated this resource.
  3197. */
  3198. updatedBy?: UpdatedBy;
  3199. }
  3200. export interface GetStorageProfileForQueueRequest {
  3201. /**
  3202. * The farm ID for the queue in storage profile.
  3203. */
  3204. farmId: FarmId;
  3205. /**
  3206. * The queue ID the queue in the storage profile.
  3207. */
  3208. queueId: QueueId;
  3209. /**
  3210. * The storage profile ID for the storage profile in the queue.
  3211. */
  3212. storageProfileId: StorageProfileId;
  3213. }
  3214. export interface GetStorageProfileForQueueResponse {
  3215. /**
  3216. * The display name of the storage profile connected to a queue.
  3217. */
  3218. displayName: ResourceName;
  3219. /**
  3220. * The location of the files for the storage profile within the queue.
  3221. */
  3222. fileSystemLocations?: FileSystemLocationsList;
  3223. /**
  3224. * The operating system of the storage profile in the queue.
  3225. */
  3226. osFamily: StorageProfileOperatingSystemFamily;
  3227. /**
  3228. * The storage profile ID.
  3229. */
  3230. storageProfileId: StorageProfileId;
  3231. }
  3232. export interface GetStorageProfileRequest {
  3233. /**
  3234. * The farm ID for the storage profile.
  3235. */
  3236. farmId: FarmId;
  3237. /**
  3238. * The storage profile ID.
  3239. */
  3240. storageProfileId: StorageProfileId;
  3241. }
  3242. export interface GetStorageProfileResponse {
  3243. /**
  3244. * The date and time the resource was created.
  3245. */
  3246. createdAt: CreatedAt;
  3247. /**
  3248. * The user or system that created this resource.
  3249. */
  3250. createdBy: CreatedBy;
  3251. /**
  3252. * The display name of the storage profile.
  3253. */
  3254. displayName: ResourceName;
  3255. /**
  3256. * The location of the files for the storage profile.
  3257. */
  3258. fileSystemLocations?: FileSystemLocationsList;
  3259. /**
  3260. * The operating system (OS) for the storage profile.
  3261. */
  3262. osFamily: StorageProfileOperatingSystemFamily;
  3263. /**
  3264. * The storage profile ID.
  3265. */
  3266. storageProfileId: StorageProfileId;
  3267. /**
  3268. * The date and time the resource was updated.
  3269. */
  3270. updatedAt?: UpdatedAt;
  3271. /**
  3272. * The user or system that updated this resource.
  3273. */
  3274. updatedBy?: UpdatedBy;
  3275. }
  3276. export interface GetTaskRequest {
  3277. /**
  3278. * The farm ID of the farm connected to the task.
  3279. */
  3280. farmId: FarmId;
  3281. /**
  3282. * The job ID of the job connected to the task.
  3283. */
  3284. jobId: JobId;
  3285. /**
  3286. * The queue ID for the queue connected to the task.
  3287. */
  3288. queueId: QueueId;
  3289. /**
  3290. * The step ID for the step connected to the task.
  3291. */
  3292. stepId: StepId;
  3293. /**
  3294. * The task ID.
  3295. */
  3296. taskId: TaskId;
  3297. }
  3298. export interface GetTaskResponse {
  3299. /**
  3300. * The date and time the resource was created.
  3301. */
  3302. createdAt: CreatedAt;
  3303. /**
  3304. * The user or system that created this resource.
  3305. */
  3306. createdBy: CreatedBy;
  3307. /**
  3308. * The date and time the resource ended running.
  3309. */
  3310. endedAt?: EndedAt;
  3311. /**
  3312. * The number of times that the task failed and was retried.
  3313. */
  3314. failureRetryCount?: TaskRetryCount;
  3315. /**
  3316. * The latest session ID for the task.
  3317. */
  3318. latestSessionActionId?: SessionActionId;
  3319. /**
  3320. * The parameters for the task.
  3321. */
  3322. parameters?: TaskParameters;
  3323. /**
  3324. * The run status for the task.
  3325. */
  3326. runStatus: TaskRunStatus;
  3327. /**
  3328. * The date and time the resource started running.
  3329. */
  3330. startedAt?: StartedAt;
  3331. /**
  3332. * The run status with which to start the task.
  3333. */
  3334. targetRunStatus?: TaskTargetRunStatus;
  3335. /**
  3336. * The task ID.
  3337. */
  3338. taskId: TaskId;
  3339. /**
  3340. * The date and time the resource was updated.
  3341. */
  3342. updatedAt?: UpdatedAt;
  3343. /**
  3344. * The user or system that updated this resource.
  3345. */
  3346. updatedBy?: UpdatedBy;
  3347. }
  3348. export interface GetWorkerRequest {
  3349. /**
  3350. * The farm ID for the worker.
  3351. */
  3352. farmId: FarmId;
  3353. /**
  3354. * The fleet ID of the worker.
  3355. */
  3356. fleetId: FleetId;
  3357. /**
  3358. * The worker ID.
  3359. */
  3360. workerId: WorkerId;
  3361. }
  3362. export interface GetWorkerResponse {
  3363. /**
  3364. * The date and time the resource was created.
  3365. */
  3366. createdAt: CreatedAt;
  3367. /**
  3368. * The user or system that created this resource.
  3369. */
  3370. createdBy: CreatedBy;
  3371. /**
  3372. * The farm ID.
  3373. */
  3374. farmId: FarmId;
  3375. /**
  3376. * The fleet ID.
  3377. */
  3378. fleetId: FleetId;
  3379. /**
  3380. * The host properties for the worker.
  3381. */
  3382. hostProperties?: HostPropertiesResponse;
  3383. /**
  3384. * The logs for the associated worker.
  3385. */
  3386. log?: LogConfiguration;
  3387. /**
  3388. * The status of the worker.
  3389. */
  3390. status: WorkerStatus;
  3391. /**
  3392. * The date and time the resource was updated.
  3393. */
  3394. updatedAt?: UpdatedAt;
  3395. /**
  3396. * The user or system that updated this resource.
  3397. */
  3398. updatedBy?: UpdatedBy;
  3399. /**
  3400. * The worker ID.
  3401. */
  3402. workerId: WorkerId;
  3403. }
  3404. export type HostName = string;
  3405. export interface HostPropertiesRequest {
  3406. /**
  3407. * The host name.
  3408. */
  3409. hostName?: HostName;
  3410. /**
  3411. * The IP address of the host.
  3412. */
  3413. ipAddresses?: IpAddresses;
  3414. }
  3415. export interface HostPropertiesResponse {
  3416. /**
  3417. * The ARN of the host EC2 instance.
  3418. */
  3419. ec2InstanceArn?: String;
  3420. /**
  3421. * The instance type of the host EC2 instance.
  3422. */
  3423. ec2InstanceType?: InstanceType;
  3424. /**
  3425. * The host name.
  3426. */
  3427. hostName?: HostName;
  3428. /**
  3429. * The IP address of the host.
  3430. */
  3431. ipAddresses?: IpAddresses;
  3432. }
  3433. export type IamRoleArn = string;
  3434. export type IdentityCenterApplicationArn = string;
  3435. export type IdentityCenterInstanceArn = string;
  3436. export type IdentityCenterPrincipalId = string;
  3437. export type IdentityStoreId = string;
  3438. export type InstanceType = string;
  3439. export type InstanceTypes = InstanceType[];
  3440. export type IntString = string;
  3441. export type Integer = number;
  3442. export interface IpAddresses {
  3443. /**
  3444. * The IpV4 address of the network.
  3445. */
  3446. ipV4Addresses?: IpV4Addresses;
  3447. /**
  3448. * The IpV6 address for the network and node component.
  3449. */
  3450. ipV6Addresses?: IpV6Addresses;
  3451. }
  3452. export type IpV4Address = string;
  3453. export type IpV4Addresses = IpV4Address[];
  3454. export type IpV6Address = string;
  3455. export type IpV6Addresses = IpV6Address[];
  3456. export interface JobAttachmentDetailsEntity {
  3457. /**
  3458. * The job attachments.
  3459. */
  3460. attachments: Attachments;
  3461. /**
  3462. * The job ID.
  3463. */
  3464. jobId: JobId;
  3465. }
  3466. export interface JobAttachmentDetailsError {
  3467. /**
  3468. * The error code.
  3469. */
  3470. code: JobEntityErrorCode;
  3471. /**
  3472. * The job ID.
  3473. */
  3474. jobId: JobId;
  3475. /**
  3476. * The error message detailing the error's cause.
  3477. */
  3478. message: String;
  3479. }
  3480. export interface JobAttachmentDetailsIdentifiers {
  3481. /**
  3482. * The job ID.
  3483. */
  3484. jobId: JobId;
  3485. }
  3486. export interface JobAttachmentSettings {
  3487. /**
  3488. * The root prefix.
  3489. */
  3490. rootPrefix: S3Prefix;
  3491. /**
  3492. * The Amazon S3 bucket name.
  3493. */
  3494. s3BucketName: S3BucketName;
  3495. }
  3496. export type JobAttachmentsFileSystem = "COPIED"|"VIRTUAL"|string;
  3497. export type JobDescription = string;
  3498. export interface JobDetailsEntity {
  3499. /**
  3500. * The job attachment settings.
  3501. */
  3502. jobAttachmentSettings?: JobAttachmentSettings;
  3503. /**
  3504. * The job ID.
  3505. */
  3506. jobId: JobId;
  3507. /**
  3508. * The user name and group that the job uses when run.
  3509. */
  3510. jobRunAsUser?: JobRunAsUser;
  3511. /**
  3512. * The log group name.
  3513. */
  3514. logGroupName: String;
  3515. /**
  3516. * The parameters.
  3517. */
  3518. parameters?: JobParameters;
  3519. /**
  3520. * The path mapping rules.
  3521. */
  3522. pathMappingRules?: PathMappingRules;
  3523. /**
  3524. * The queue role ARN.
  3525. */
  3526. queueRoleArn?: IamRoleArn;
  3527. /**
  3528. * The schema version.
  3529. */
  3530. schemaVersion: String;
  3531. }
  3532. export interface JobDetailsError {
  3533. /**
  3534. * The error code.
  3535. */
  3536. code: JobEntityErrorCode;
  3537. /**
  3538. * The job ID.
  3539. */
  3540. jobId: JobId;
  3541. /**
  3542. * The error message detailing the error's cause.
  3543. */
  3544. message: String;
  3545. }
  3546. export interface JobDetailsIdentifiers {
  3547. /**
  3548. * The job ID.
  3549. */
  3550. jobId: JobId;
  3551. }
  3552. export interface JobEntity {
  3553. /**
  3554. * The environment details for the job entity.
  3555. */
  3556. environmentDetails?: EnvironmentDetailsEntity;
  3557. /**
  3558. * The job attachment details.
  3559. */
  3560. jobAttachmentDetails?: JobAttachmentDetailsEntity;
  3561. /**
  3562. * The job details.
  3563. */
  3564. jobDetails?: JobDetailsEntity;
  3565. /**
  3566. * The step details.
  3567. */
  3568. stepDetails?: StepDetailsEntity;
  3569. }
  3570. export type JobEntityErrorCode = "AccessDeniedException"|"InternalServerException"|"ValidationException"|"ResourceNotFoundException"|"MaxPayloadSizeExceeded"|"ConflictException"|string;
  3571. export type JobEntityIdentifiers = JobEntityIdentifiersUnion[];
  3572. export interface JobEntityIdentifiersUnion {
  3573. /**
  3574. * The environment details.
  3575. */
  3576. environmentDetails?: EnvironmentDetailsIdentifiers;
  3577. /**
  3578. * The job attachment details.
  3579. */
  3580. jobAttachmentDetails?: JobAttachmentDetailsIdentifiers;
  3581. /**
  3582. * The job details.
  3583. */
  3584. jobDetails?: JobDetailsIdentifiers;
  3585. /**
  3586. * The step details.
  3587. */
  3588. stepDetails?: StepDetailsIdentifiers;
  3589. }
  3590. export type JobId = string;
  3591. export type JobLifecycleStatus = "CREATE_IN_PROGRESS"|"CREATE_FAILED"|"CREATE_COMPLETE"|"UPLOAD_IN_PROGRESS"|"UPLOAD_FAILED"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"|"UPDATE_SUCCEEDED"|"ARCHIVED"|string;
  3592. export interface JobMember {
  3593. /**
  3594. * The farm ID.
  3595. */
  3596. farmId: FarmId;
  3597. /**
  3598. * The identity store ID.
  3599. */
  3600. identityStoreId: IdentityStoreId;
  3601. /**
  3602. * The job ID.
  3603. */
  3604. jobId: JobId;
  3605. /**
  3606. * The job member's membership level.
  3607. */
  3608. membershipLevel: MembershipLevel;
  3609. /**
  3610. * The principal ID of the job member.
  3611. */
  3612. principalId: IdentityCenterPrincipalId;
  3613. /**
  3614. * The principal type of the job member.
  3615. */
  3616. principalType: PrincipalType;
  3617. /**
  3618. * The queue ID.
  3619. */
  3620. queueId: QueueId;
  3621. }
  3622. export type JobMembers = JobMember[];
  3623. export type JobName = string;
  3624. export interface JobParameter {
  3625. /**
  3626. * A double precision IEEE-754 floating point number represented as a string.
  3627. */
  3628. float?: FloatString;
  3629. /**
  3630. * A signed integer represented as a string.
  3631. */
  3632. int?: IntString;
  3633. /**
  3634. * A file system path represented as a string.
  3635. */
  3636. path?: PathString;
  3637. /**
  3638. * A UTF-8 string.
  3639. */
  3640. string?: ParameterString;
  3641. }
  3642. export type JobParameters = {[key: string]: JobParameter};
  3643. export type JobPriority = number;
  3644. export interface JobRunAsUser {
  3645. /**
  3646. * The user and group that the jobs in the queue run as.
  3647. */
  3648. posix?: PosixUser;
  3649. /**
  3650. * Specifies whether the job should run using the queue's system user or if the job should run using the worker agent system user.
  3651. */
  3652. runAs: RunAs;
  3653. /**
  3654. * Identifies a Microsoft Windows user.
  3655. */
  3656. windows?: WindowsUser;
  3657. }
  3658. export type JobSearchSummaries = JobSearchSummary[];
  3659. export interface JobSearchSummary {
  3660. /**
  3661. * The date and time the resource was created.
  3662. */
  3663. createdAt?: CreatedAt;
  3664. /**
  3665. * The user or system that created this resource.
  3666. */
  3667. createdBy?: CreatedBy;
  3668. /**
  3669. * The date and time the resource ended running.
  3670. */
  3671. endedAt?: EndedAt;
  3672. /**
  3673. * The job ID.
  3674. */
  3675. jobId?: JobId;
  3676. /**
  3677. * The job parameters.
  3678. */
  3679. jobParameters?: JobParameters;
  3680. /**
  3681. * The life cycle status.
  3682. */
  3683. lifecycleStatus?: JobLifecycleStatus;
  3684. /**
  3685. * The life cycle status message.
  3686. */
  3687. lifecycleStatusMessage?: String;
  3688. /**
  3689. * The number of task failures before the job stops running and is marked as FAILED.
  3690. */
  3691. maxFailedTasksCount?: MaxFailedTasksCount;
  3692. /**
  3693. * The maximum number of retries for a job.
  3694. */
  3695. maxRetriesPerTask?: MaxRetriesPerTask;
  3696. /**
  3697. * The job name.
  3698. */
  3699. name?: JobName;
  3700. /**
  3701. * The job priority.
  3702. */
  3703. priority?: JobPriority;
  3704. /**
  3705. * The queue ID.
  3706. */
  3707. queueId?: QueueId;
  3708. /**
  3709. * The date and time the resource started running.
  3710. */
  3711. startedAt?: StartedAt;
  3712. /**
  3713. * The task status to start with on the job.
  3714. */
  3715. targetTaskRunStatus?: JobTargetTaskRunStatus;
  3716. /**
  3717. * task run status for the job. PENDING–pending and waiting for resources. READY–ready to be processed. ASSIGNED–assigned and will run next on a worker. SCHEDULED–scheduled to be run on a worker. INTERRUPTING–being interrupted. RUNNING–running on a worker. SUSPENDED–the task is suspended. CANCELED–the task has been canceled. FAILED–the task has failed. SUCCEEDED–the task has succeeded.
  3718. */
  3719. taskRunStatus?: TaskRunStatus;
  3720. /**
  3721. * The number of tasks running on the job.
  3722. */
  3723. taskRunStatusCounts?: TaskRunStatusCounts;
  3724. }
  3725. export type JobSummaries = JobSummary[];
  3726. export interface JobSummary {
  3727. /**
  3728. * The date and time the resource was created.
  3729. */
  3730. createdAt: CreatedAt;
  3731. /**
  3732. * The user or system that created this resource.
  3733. */
  3734. createdBy: CreatedBy;
  3735. /**
  3736. * The date and time the resource ended running.
  3737. */
  3738. endedAt?: EndedAt;
  3739. /**
  3740. * The job ID.
  3741. */
  3742. jobId: JobId;
  3743. /**
  3744. * The life cycle status.
  3745. */
  3746. lifecycleStatus: JobLifecycleStatus;
  3747. /**
  3748. * The life cycle status message.
  3749. */
  3750. lifecycleStatusMessage: String;
  3751. /**
  3752. * The number of task failures before the job stops running and is marked as FAILED.
  3753. */
  3754. maxFailedTasksCount?: MaxFailedTasksCount;
  3755. /**
  3756. * The maximum number of retries for a job.
  3757. */
  3758. maxRetriesPerTask?: MaxRetriesPerTask;
  3759. /**
  3760. * The job name.
  3761. */
  3762. name: JobName;
  3763. /**
  3764. * The job priority.
  3765. */
  3766. priority: JobPriority;
  3767. /**
  3768. * The date and time the resource started running.
  3769. */
  3770. startedAt?: StartedAt;
  3771. /**
  3772. * The task status to start with on the job.
  3773. */
  3774. targetTaskRunStatus?: JobTargetTaskRunStatus;
  3775. /**
  3776. * The task run status for the job. PENDING–pending and waiting for resources. READY–ready to be processed. ASSIGNED–assigned and will run next on a worker. SCHEDULED–scheduled to be run on a worker. INTERRUPTING–being interrupted. RUNNING–running on a worker. SUSPENDED–the task is suspended. CANCELED–the task has been canceled. FAILED–the task has failed. SUCCEEDED–the task has succeeded.
  3777. */
  3778. taskRunStatus?: TaskRunStatus;
  3779. /**
  3780. * The number of tasks running on the job.
  3781. */
  3782. taskRunStatusCounts?: TaskRunStatusCounts;
  3783. /**
  3784. * The date and time the resource was updated.
  3785. */
  3786. updatedAt?: UpdatedAt;
  3787. /**
  3788. * The user or system that updated this resource.
  3789. */
  3790. updatedBy?: UpdatedBy;
  3791. }
  3792. export type JobTargetTaskRunStatus = "READY"|"FAILED"|"SUCCEEDED"|"CANCELED"|"SUSPENDED"|"PENDING"|string;
  3793. export type JobTemplate = string;
  3794. export type JobTemplateType = "JSON"|"YAML"|string;
  3795. export type KmsKeyArn = string;
  3796. export type LicenseEndpointId = string;
  3797. export type LicenseEndpointStatus = "CREATE_IN_PROGRESS"|"DELETE_IN_PROGRESS"|"READY"|"NOT_READY"|string;
  3798. export type LicenseEndpointSummaries = LicenseEndpointSummary[];
  3799. export interface LicenseEndpointSummary {
  3800. /**
  3801. * The license endpoint ID.
  3802. */
  3803. licenseEndpointId?: LicenseEndpointId;
  3804. /**
  3805. * The status of the license endpoint.
  3806. */
  3807. status?: LicenseEndpointStatus;
  3808. /**
  3809. * The status message of the license endpoint.
  3810. */
  3811. statusMessage?: StatusMessage;
  3812. /**
  3813. * The VCP(virtual private cloud) ID associated with the license endpoint.
  3814. */
  3815. vpcId?: VpcId;
  3816. }
  3817. export type LicenseProduct = string;
  3818. export type ListAttributeCapabilityValue = AttributeCapabilityValue[];
  3819. export interface ListAvailableMeteredProductsRequest {
  3820. /**
  3821. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  3822. */
  3823. maxResults?: MaxResults;
  3824. /**
  3825. * The token for the next set of results, or null to start from the beginning.
  3826. */
  3827. nextToken?: String;
  3828. }
  3829. export interface ListAvailableMeteredProductsResponse {
  3830. /**
  3831. * The metered products.
  3832. */
  3833. meteredProducts: MeteredProductSummaryList;
  3834. /**
  3835. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  3836. */
  3837. nextToken?: String;
  3838. }
  3839. export interface ListBudgetsRequest {
  3840. /**
  3841. * The farm ID associated with the budgets.
  3842. */
  3843. farmId: FarmId;
  3844. /**
  3845. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  3846. */
  3847. maxResults?: MaxResults;
  3848. /**
  3849. * The token for the next set of results, or null to start from the beginning.
  3850. */
  3851. nextToken?: String;
  3852. /**
  3853. * The status to list for the budgets.
  3854. */
  3855. status?: BudgetStatus;
  3856. }
  3857. export interface ListBudgetsResponse {
  3858. /**
  3859. * The budgets to include on the list.
  3860. */
  3861. budgets: BudgetSummaries;
  3862. /**
  3863. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  3864. */
  3865. nextToken?: String;
  3866. }
  3867. export interface ListFarmMembersRequest {
  3868. /**
  3869. * The farm ID.
  3870. */
  3871. farmId: FarmId;
  3872. /**
  3873. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  3874. */
  3875. maxResults?: MaxResults;
  3876. /**
  3877. * The token for the next set of results, or null to start from the beginning.
  3878. */
  3879. nextToken?: String;
  3880. }
  3881. export interface ListFarmMembersResponse {
  3882. /**
  3883. * The members on the list.
  3884. */
  3885. members: FarmMembers;
  3886. /**
  3887. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  3888. */
  3889. nextToken?: String;
  3890. }
  3891. export interface ListFarmsRequest {
  3892. /**
  3893. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  3894. */
  3895. maxResults?: MaxResults;
  3896. /**
  3897. * The token for the next set of results, or null to start from the beginning.
  3898. */
  3899. nextToken?: String;
  3900. /**
  3901. * The principal ID of the member to list on the farm.
  3902. */
  3903. principalId?: IdentityCenterPrincipalId;
  3904. }
  3905. export interface ListFarmsResponse {
  3906. /**
  3907. * Farms on the list.
  3908. */
  3909. farms: FarmSummaries;
  3910. /**
  3911. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  3912. */
  3913. nextToken?: String;
  3914. }
  3915. export interface ListFleetMembersRequest {
  3916. /**
  3917. * The farm ID of the fleet.
  3918. */
  3919. farmId: FarmId;
  3920. /**
  3921. * The fleet ID to include on the list.
  3922. */
  3923. fleetId: FleetId;
  3924. /**
  3925. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  3926. */
  3927. maxResults?: MaxResults;
  3928. /**
  3929. * The token for the next set of results, or null to start from the beginning.
  3930. */
  3931. nextToken?: String;
  3932. }
  3933. export interface ListFleetMembersResponse {
  3934. /**
  3935. * The members on the list.
  3936. */
  3937. members: FleetMembers;
  3938. /**
  3939. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  3940. */
  3941. nextToken?: String;
  3942. }
  3943. export interface ListFleetsRequest {
  3944. /**
  3945. * The display names of a list of fleets.
  3946. */
  3947. displayName?: ResourceName;
  3948. /**
  3949. * The farm ID of the fleets.
  3950. */
  3951. farmId: FarmId;
  3952. /**
  3953. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  3954. */
  3955. maxResults?: MaxResults;
  3956. /**
  3957. * The token for the next set of results, or null to start from the beginning.
  3958. */
  3959. nextToken?: String;
  3960. /**
  3961. * The principal ID of the members to include in the fleet.
  3962. */
  3963. principalId?: IdentityCenterPrincipalId;
  3964. /**
  3965. * The status of the fleet.
  3966. */
  3967. status?: FleetStatus;
  3968. }
  3969. export interface ListFleetsResponse {
  3970. /**
  3971. * The fleets on the list.
  3972. */
  3973. fleets: FleetSummaries;
  3974. /**
  3975. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  3976. */
  3977. nextToken?: String;
  3978. }
  3979. export interface ListJobMembersRequest {
  3980. /**
  3981. * The farm ID of the job to list.
  3982. */
  3983. farmId: FarmId;
  3984. /**
  3985. * The job ID to include on the list.
  3986. */
  3987. jobId: JobId;
  3988. /**
  3989. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  3990. */
  3991. maxResults?: MaxResults;
  3992. /**
  3993. * The token for the next set of results, or null to start from the beginning.
  3994. */
  3995. nextToken?: String;
  3996. /**
  3997. * The queue ID to include on the list.
  3998. */
  3999. queueId: QueueId;
  4000. }
  4001. export interface ListJobMembersResponse {
  4002. /**
  4003. * The members on the list.
  4004. */
  4005. members: JobMembers;
  4006. /**
  4007. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4008. */
  4009. nextToken?: String;
  4010. }
  4011. export interface ListJobsRequest {
  4012. /**
  4013. * The farm ID for the jobs.
  4014. */
  4015. farmId: FarmId;
  4016. /**
  4017. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4018. */
  4019. maxResults?: MaxResults;
  4020. /**
  4021. * The token for the next set of results, or null to start from the beginning.
  4022. */
  4023. nextToken?: String;
  4024. /**
  4025. * The principal ID of the members on the jobs.
  4026. */
  4027. principalId?: IdentityCenterPrincipalId;
  4028. /**
  4029. * The queue ID for the job.
  4030. */
  4031. queueId: QueueId;
  4032. }
  4033. export interface ListJobsResponse {
  4034. /**
  4035. * The jobs on the list.
  4036. */
  4037. jobs: JobSummaries;
  4038. /**
  4039. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4040. */
  4041. nextToken?: String;
  4042. }
  4043. export interface ListLicenseEndpointsRequest {
  4044. /**
  4045. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4046. */
  4047. maxResults?: MaxResults;
  4048. /**
  4049. * The token for the next set of results, or null to start from the beginning.
  4050. */
  4051. nextToken?: String;
  4052. }
  4053. export interface ListLicenseEndpointsResponse {
  4054. /**
  4055. * The license endpoints.
  4056. */
  4057. licenseEndpoints: LicenseEndpointSummaries;
  4058. /**
  4059. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4060. */
  4061. nextToken?: String;
  4062. }
  4063. export interface ListMeteredProductsRequest {
  4064. /**
  4065. * The license endpoint ID to include on the list of metered products.
  4066. */
  4067. licenseEndpointId: LicenseEndpointId;
  4068. /**
  4069. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4070. */
  4071. maxResults?: MaxResults;
  4072. /**
  4073. * The token for the next set of results, or null to start from the beginning.
  4074. */
  4075. nextToken?: String;
  4076. }
  4077. export interface ListMeteredProductsResponse {
  4078. /**
  4079. * The metered products to list.
  4080. */
  4081. meteredProducts: MeteredProductSummaryList;
  4082. /**
  4083. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4084. */
  4085. nextToken?: String;
  4086. }
  4087. export interface ListMonitorsRequest {
  4088. /**
  4089. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4090. */
  4091. maxResults?: MaxResults;
  4092. /**
  4093. * The token for the next set of results, or null to start from the beginning.
  4094. */
  4095. nextToken?: String;
  4096. }
  4097. export interface ListMonitorsResponse {
  4098. /**
  4099. * A list of MonitorSummary objects that describe your monitors in the Deadline Cloud.
  4100. */
  4101. monitors: MonitorSummaries;
  4102. /**
  4103. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4104. */
  4105. nextToken?: String;
  4106. }
  4107. export interface ListQueueEnvironmentsRequest {
  4108. /**
  4109. * The farm ID for the queue environment list.
  4110. */
  4111. farmId: FarmId;
  4112. /**
  4113. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4114. */
  4115. maxResults?: MaxResults;
  4116. /**
  4117. * The token for the next set of results, or null to start from the beginning.
  4118. */
  4119. nextToken?: String;
  4120. /**
  4121. * The queue ID for the queue environment list.
  4122. */
  4123. queueId: QueueId;
  4124. }
  4125. export interface ListQueueEnvironmentsResponse {
  4126. /**
  4127. * The environments to include in the queue environments list.
  4128. */
  4129. environments: QueueEnvironmentSummaries;
  4130. /**
  4131. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4132. */
  4133. nextToken?: String;
  4134. }
  4135. export interface ListQueueFleetAssociationsRequest {
  4136. /**
  4137. * The farm ID for the queue-fleet association list.
  4138. */
  4139. farmId: FarmId;
  4140. /**
  4141. * The fleet ID for the queue-fleet association list.
  4142. */
  4143. fleetId?: FleetId;
  4144. /**
  4145. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4146. */
  4147. maxResults?: MaxResults;
  4148. /**
  4149. * The token for the next set of results, or null to start from the beginning.
  4150. */
  4151. nextToken?: String;
  4152. /**
  4153. * The queue ID for the queue-fleet association list.
  4154. */
  4155. queueId?: QueueId;
  4156. }
  4157. export interface ListQueueFleetAssociationsResponse {
  4158. /**
  4159. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4160. */
  4161. nextToken?: String;
  4162. /**
  4163. * The queue-fleet associations on the list.
  4164. */
  4165. queueFleetAssociations: QueueFleetAssociationSummaries;
  4166. }
  4167. export interface ListQueueMembersRequest {
  4168. /**
  4169. * The farm ID for the queue.
  4170. */
  4171. farmId: FarmId;
  4172. /**
  4173. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4174. */
  4175. maxResults?: MaxResults;
  4176. /**
  4177. * The token for the next set of results, or null to start from the beginning.
  4178. */
  4179. nextToken?: String;
  4180. /**
  4181. * The queue ID to include on the list.
  4182. */
  4183. queueId: QueueId;
  4184. }
  4185. export interface ListQueueMembersResponse {
  4186. /**
  4187. * The members on the list.
  4188. */
  4189. members: QueueMemberList;
  4190. /**
  4191. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4192. */
  4193. nextToken?: String;
  4194. }
  4195. export interface ListQueuesRequest {
  4196. /**
  4197. * The farm ID of the queue.
  4198. */
  4199. farmId: FarmId;
  4200. /**
  4201. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4202. */
  4203. maxResults?: MaxResults;
  4204. /**
  4205. * The token for the next set of results, or null to start from the beginning.
  4206. */
  4207. nextToken?: String;
  4208. /**
  4209. * The principal ID. This filter is only valid when using Nimble Studio credentials and should match the user ID in the credentials of the caller.
  4210. */
  4211. principalId?: IdentityCenterPrincipalId;
  4212. /**
  4213. * The status of the queues listed. ACTIVE–The queues are active. SCHEDULING–The queues are scheduling. SCHEDULING_BLOCKED–The queue scheduling is blocked for these queues.
  4214. */
  4215. status?: QueueStatus;
  4216. }
  4217. export interface ListQueuesResponse {
  4218. /**
  4219. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4220. */
  4221. nextToken?: String;
  4222. /**
  4223. * The queues on the list.
  4224. */
  4225. queues: QueueSummaries;
  4226. }
  4227. export interface ListSessionActionsRequest {
  4228. /**
  4229. * The farm ID for the session actions list.
  4230. */
  4231. farmId: FarmId;
  4232. /**
  4233. * The job ID for the session actions list.
  4234. */
  4235. jobId: JobId;
  4236. /**
  4237. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4238. */
  4239. maxResults?: MaxResults;
  4240. /**
  4241. * The token for the next set of results, or null to start from the beginning.
  4242. */
  4243. nextToken?: String;
  4244. /**
  4245. * The queue ID for the session actions list.
  4246. */
  4247. queueId: QueueId;
  4248. /**
  4249. * The session ID to include on the sessions action list.
  4250. */
  4251. sessionId?: SessionId;
  4252. /**
  4253. * The task ID for the session actions list.
  4254. */
  4255. taskId?: TaskId;
  4256. }
  4257. export interface ListSessionActionsResponse {
  4258. /**
  4259. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4260. */
  4261. nextToken?: String;
  4262. /**
  4263. * The session actions.
  4264. */
  4265. sessionActions: SessionActionSummaries;
  4266. }
  4267. export interface ListSessionsForWorkerRequest {
  4268. /**
  4269. * The farm ID for the session.
  4270. */
  4271. farmId: FarmId;
  4272. /**
  4273. * The fleet ID for the session.
  4274. */
  4275. fleetId: FleetId;
  4276. /**
  4277. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4278. */
  4279. maxResults?: MaxResults;
  4280. /**
  4281. * The token for the next set of results, or null to start from the beginning.
  4282. */
  4283. nextToken?: String;
  4284. /**
  4285. * The worker ID for the session.
  4286. */
  4287. workerId: WorkerId;
  4288. }
  4289. export interface ListSessionsForWorkerResponse {
  4290. /**
  4291. * The token for the next set of results, or null to start from the beginning.
  4292. */
  4293. nextToken?: String;
  4294. /**
  4295. * The sessions in the response.
  4296. */
  4297. sessions: ListSessionsForWorkerSummaries;
  4298. }
  4299. export type ListSessionsForWorkerSummaries = WorkerSessionSummary[];
  4300. export interface ListSessionsRequest {
  4301. /**
  4302. * The farm ID for the list of sessions.
  4303. */
  4304. farmId: FarmId;
  4305. /**
  4306. * The job ID for the list of sessions.
  4307. */
  4308. jobId: JobId;
  4309. /**
  4310. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4311. */
  4312. maxResults?: MaxResults;
  4313. /**
  4314. * The token for the next set of results, or null to start from the beginning.
  4315. */
  4316. nextToken?: String;
  4317. /**
  4318. * The queue ID for the list of sessions
  4319. */
  4320. queueId: QueueId;
  4321. }
  4322. export interface ListSessionsResponse {
  4323. /**
  4324. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4325. */
  4326. nextToken?: String;
  4327. /**
  4328. * The sessions on the list.
  4329. */
  4330. sessions: SessionSummaries;
  4331. }
  4332. export interface ListStepConsumersRequest {
  4333. /**
  4334. * The farm ID for the list of step consumers.
  4335. */
  4336. farmId: FarmId;
  4337. /**
  4338. * The job ID for the step consumer.
  4339. */
  4340. jobId: JobId;
  4341. /**
  4342. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4343. */
  4344. maxResults?: ListStepConsumersRequestMaxResultsInteger;
  4345. /**
  4346. * The token for the next set of results, or null to start from the beginning.
  4347. */
  4348. nextToken?: String;
  4349. /**
  4350. * The queue ID for the step consumer.
  4351. */
  4352. queueId: QueueId;
  4353. /**
  4354. * The step ID to include on the list.
  4355. */
  4356. stepId: StepId;
  4357. }
  4358. export type ListStepConsumersRequestMaxResultsInteger = number;
  4359. export interface ListStepConsumersResponse {
  4360. /**
  4361. * The consumers on the list.
  4362. */
  4363. consumers: StepConsumers;
  4364. /**
  4365. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4366. */
  4367. nextToken?: String;
  4368. }
  4369. export interface ListStepDependenciesRequest {
  4370. /**
  4371. * The farm ID for the step dependencies list.
  4372. */
  4373. farmId: FarmId;
  4374. /**
  4375. * The job ID for the step dependencies list.
  4376. */
  4377. jobId: JobId;
  4378. /**
  4379. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4380. */
  4381. maxResults?: ListStepDependenciesRequestMaxResultsInteger;
  4382. /**
  4383. * The token for the next set of results, or null to start from the beginning.
  4384. */
  4385. nextToken?: String;
  4386. /**
  4387. * The queue ID for the step dependencies list.
  4388. */
  4389. queueId: QueueId;
  4390. /**
  4391. * The step ID to include on the list.
  4392. */
  4393. stepId: StepId;
  4394. }
  4395. export type ListStepDependenciesRequestMaxResultsInteger = number;
  4396. export interface ListStepDependenciesResponse {
  4397. /**
  4398. * The dependencies on the list.
  4399. */
  4400. dependencies: StepDependencies;
  4401. /**
  4402. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4403. */
  4404. nextToken?: String;
  4405. }
  4406. export interface ListStepsRequest {
  4407. /**
  4408. * The farm ID to include on the list of steps.
  4409. */
  4410. farmId: FarmId;
  4411. /**
  4412. * The job ID to include on the list of steps.
  4413. */
  4414. jobId: JobId;
  4415. /**
  4416. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4417. */
  4418. maxResults?: MaxResults;
  4419. /**
  4420. * The token for the next set of results, or null to start from the beginning.
  4421. */
  4422. nextToken?: String;
  4423. /**
  4424. * The queue ID to include on the list of steps.
  4425. */
  4426. queueId: QueueId;
  4427. }
  4428. export interface ListStepsResponse {
  4429. /**
  4430. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4431. */
  4432. nextToken?: String;
  4433. /**
  4434. * The steps on the list.
  4435. */
  4436. steps: StepSummaries;
  4437. }
  4438. export interface ListStorageProfilesForQueueRequest {
  4439. /**
  4440. * The farm ID of the queue's storage profile.
  4441. */
  4442. farmId: FarmId;
  4443. /**
  4444. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4445. */
  4446. maxResults?: MaxResults;
  4447. /**
  4448. * The token for the next set of results, or null to start from the beginning.
  4449. */
  4450. nextToken?: String;
  4451. /**
  4452. * The queue ID for the storage profile.
  4453. */
  4454. queueId: QueueId;
  4455. }
  4456. export interface ListStorageProfilesForQueueResponse {
  4457. /**
  4458. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4459. */
  4460. nextToken?: String;
  4461. /**
  4462. * The storage profiles in the queue.
  4463. */
  4464. storageProfiles: StorageProfileSummaries;
  4465. }
  4466. export interface ListStorageProfilesRequest {
  4467. /**
  4468. * The farm ID of the storage profile.
  4469. */
  4470. farmId: FarmId;
  4471. /**
  4472. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4473. */
  4474. maxResults?: MaxResults;
  4475. /**
  4476. * The token for the next set of results, or null to start from the beginning.
  4477. */
  4478. nextToken?: String;
  4479. }
  4480. export interface ListStorageProfilesResponse {
  4481. /**
  4482. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4483. */
  4484. nextToken?: String;
  4485. /**
  4486. * The storage profiles.
  4487. */
  4488. storageProfiles: StorageProfileSummaries;
  4489. }
  4490. export interface ListTagsForResourceRequest {
  4491. /**
  4492. * The resource ARN to list tags for.
  4493. */
  4494. resourceArn: String;
  4495. }
  4496. export interface ListTagsForResourceResponse {
  4497. /**
  4498. * Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
  4499. */
  4500. tags?: Tags;
  4501. }
  4502. export interface ListTasksRequest {
  4503. /**
  4504. * The farm ID connected to the tasks.
  4505. */
  4506. farmId: FarmId;
  4507. /**
  4508. * The job ID for the tasks.
  4509. */
  4510. jobId: JobId;
  4511. /**
  4512. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4513. */
  4514. maxResults?: MaxResults;
  4515. /**
  4516. * The token for the next set of results, or null to start from the beginning.
  4517. */
  4518. nextToken?: String;
  4519. /**
  4520. * The queue ID connected to the tasks.
  4521. */
  4522. queueId: QueueId;
  4523. /**
  4524. * The step ID for the tasks.
  4525. */
  4526. stepId: StepId;
  4527. }
  4528. export interface ListTasksResponse {
  4529. /**
  4530. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4531. */
  4532. nextToken?: String;
  4533. /**
  4534. * Tasks for the job.
  4535. */
  4536. tasks: TaskSummaries;
  4537. }
  4538. export interface ListWorkersRequest {
  4539. /**
  4540. * The farm ID connected to the workers.
  4541. */
  4542. farmId: FarmId;
  4543. /**
  4544. * The fleet ID of the workers.
  4545. */
  4546. fleetId: FleetId;
  4547. /**
  4548. * The maximum number of results to return. Use this parameter with NextToken to get results as a set of sequential pages.
  4549. */
  4550. maxResults?: MaxResults;
  4551. /**
  4552. * The token for the next set of results, or null to start from the beginning.
  4553. */
  4554. nextToken?: String;
  4555. }
  4556. export interface ListWorkersResponse {
  4557. /**
  4558. * If Deadline Cloud returns nextToken, then there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, call the operation again using the returned token. Keep all other arguments unchanged. If no results remain, then nextToken is set to null. Each pagination token expires after 24 hours. If you provide a token that isn't valid, then you receive an HTTP 400 ValidationException error.
  4559. */
  4560. nextToken?: String;
  4561. /**
  4562. * The workers on the list.
  4563. */
  4564. workers: WorkerSummaries;
  4565. }
  4566. export interface LogConfiguration {
  4567. /**
  4568. * The log configuration error details.
  4569. */
  4570. error?: LogError;
  4571. /**
  4572. * The log drivers for worker related logs.
  4573. */
  4574. logDriver: LogDriver;
  4575. /**
  4576. * The options for a log driver.
  4577. */
  4578. options?: LogOptions;
  4579. /**
  4580. * The parameters for the log configuration.
  4581. */
  4582. parameters?: LogParameters;
  4583. }
  4584. export type LogDriver = string;
  4585. export type LogError = string;
  4586. export type LogOptions = {[key: string]: String};
  4587. export type LogParameters = {[key: string]: String};
  4588. export type LogicalOperator = "AND"|"OR"|string;
  4589. export interface ManifestProperties {
  4590. /**
  4591. * The file system location name.
  4592. */
  4593. fileSystemLocationName?: FileSystemLocationName;
  4594. /**
  4595. * The has value of the file.
  4596. */
  4597. inputManifestHash?: ManifestPropertiesInputManifestHashString;
  4598. /**
  4599. * The file path.
  4600. */
  4601. inputManifestPath?: ManifestPropertiesInputManifestPathString;
  4602. /**
  4603. * The file path relative to the directory.
  4604. */
  4605. outputRelativeDirectories?: OutputRelativeDirectoriesList;
  4606. /**
  4607. * The file's root path.
  4608. */
  4609. rootPath: ManifestPropertiesRootPathString;
  4610. /**
  4611. * The format of the root path.
  4612. */
  4613. rootPathFormat: PathFormat;
  4614. }
  4615. export type ManifestPropertiesInputManifestHashString = string;
  4616. export type ManifestPropertiesInputManifestPathString = string;
  4617. export type ManifestPropertiesList = ManifestProperties[];
  4618. export type ManifestPropertiesRootPathString = string;
  4619. export type MaxFailedTasksCount = number;
  4620. export type MaxResults = number;
  4621. export type MaxRetriesPerTask = number;
  4622. export type MembershipLevel = "VIEWER"|"CONTRIBUTOR"|"OWNER"|"MANAGER"|string;
  4623. export type MemoryAmountMiB = number;
  4624. export interface MemoryMiBRange {
  4625. /**
  4626. * The maximum amount of memory (in MiB).
  4627. */
  4628. max?: MemoryAmountMiB;
  4629. /**
  4630. * The minimum amount of memory (in MiB).
  4631. */
  4632. min: MemoryAmountMiB;
  4633. }
  4634. export type MeteredProductId = string;
  4635. export interface MeteredProductSummary {
  4636. /**
  4637. * The family to which the metered product belongs.
  4638. */
  4639. family: BoundedString;
  4640. /**
  4641. * The port on which the metered product should run.
  4642. */
  4643. port: PortNumber;
  4644. /**
  4645. * The product ID.
  4646. */
  4647. productId: MeteredProductId;
  4648. /**
  4649. * The vendor.
  4650. */
  4651. vendor: BoundedString;
  4652. }
  4653. export type MeteredProductSummaryList = MeteredProductSummary[];
  4654. export type MinOneMaxTenThousand = number;
  4655. export type MinZeroMaxInteger = number;
  4656. export type MonitorId = string;
  4657. export type MonitorSummaries = MonitorSummary[];
  4658. export interface MonitorSummary {
  4659. /**
  4660. * The UNIX timestamp of the date and time that the monitor was created.
  4661. */
  4662. createdAt: CreatedAt;
  4663. /**
  4664. * The user name of the person that created the monitor.
  4665. */
  4666. createdBy: CreatedBy;
  4667. /**
  4668. * The name of the monitor that displays on the Deadline Cloud console.
  4669. */
  4670. displayName: ResourceName;
  4671. /**
  4672. * The Amazon Resource Name (ARN) that the IAM Identity Center assigned to the monitor when it was created.
  4673. */
  4674. identityCenterApplicationArn: IdentityCenterApplicationArn;
  4675. /**
  4676. * The Amazon Resource Name (ARN) of the IAM Identity Center instance responsible for authenticating monitor users.
  4677. */
  4678. identityCenterInstanceArn: IdentityCenterInstanceArn;
  4679. /**
  4680. * The unique identifier for the monitor.
  4681. */
  4682. monitorId: MonitorId;
  4683. /**
  4684. * The Amazon Resource Name (ARN) of the IAM role for the monitor. Users of the monitor use this role to access Deadline Cloud resources.
  4685. */
  4686. roleArn: IamRoleArn;
  4687. /**
  4688. * The subdomain used for the monitor URL. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
  4689. */
  4690. subdomain: Subdomain;
  4691. /**
  4692. * The UNIX timestamp of the date and time that the monitor was last updated.
  4693. */
  4694. updatedAt?: UpdatedAt;
  4695. /**
  4696. * The user name of the person that last updated the monitor.
  4697. */
  4698. updatedBy?: UpdatedBy;
  4699. /**
  4700. * The complete URL of the monitor. The full URL of the monitor is subdomain.Region.deadlinecloud.amazonaws.com.
  4701. */
  4702. url: Url;
  4703. }
  4704. export type NextItemOffset = number;
  4705. export type OutputRelativeDirectoriesList = OutputRelativeDirectoriesListMemberString[];
  4706. export type OutputRelativeDirectoriesListMemberString = string;
  4707. export interface ParameterFilterExpression {
  4708. /**
  4709. * The name of the parameter to filter on.
  4710. */
  4711. name: String;
  4712. /**
  4713. * The type of comparison to use to filter results.
  4714. */
  4715. operator: ComparisonOperator;
  4716. /**
  4717. * The parameter's value.
  4718. */
  4719. value: ParameterValue;
  4720. }
  4721. export interface ParameterSortExpression {
  4722. /**
  4723. * The parameter name to sort by.
  4724. */
  4725. name: String;
  4726. /**
  4727. * The sort order for the parameter.
  4728. */
  4729. sortOrder: SortOrder;
  4730. }
  4731. export interface ParameterSpace {
  4732. /**
  4733. * The combination expression to use in the search.
  4734. */
  4735. combination?: CombinationExpression;
  4736. /**
  4737. * The parameters to search for.
  4738. */
  4739. parameters: StepParameterList;
  4740. }
  4741. export type ParameterString = string;
  4742. export type ParameterValue = string;
  4743. export type PathFormat = "windows"|"posix"|string;
  4744. export interface PathMappingRule {
  4745. /**
  4746. * The destination path.
  4747. */
  4748. destinationPath: String;
  4749. /**
  4750. * The source path.
  4751. */
  4752. sourcePath: String;
  4753. /**
  4754. * The source path format.
  4755. */
  4756. sourcePathFormat: PathFormat;
  4757. }
  4758. export type PathMappingRules = PathMappingRule[];
  4759. export type PathString = string;
  4760. export type Period = "HOURLY"|"DAILY"|"WEEKLY"|"MONTHLY"|string;
  4761. export type PortNumber = number;
  4762. export interface PosixUser {
  4763. /**
  4764. * The name of the POSIX user's group.
  4765. */
  4766. group: PosixUserGroupString;
  4767. /**
  4768. * The name of the POSIX user.
  4769. */
  4770. user: PosixUserUserString;
  4771. }
  4772. export type PosixUserGroupString = string;
  4773. export type PosixUserUserString = string;
  4774. export type PrincipalType = "USER"|"GROUP"|string;
  4775. export type Priority = number;
  4776. export type ProcessExitCode = number;
  4777. export interface PutMeteredProductRequest {
  4778. /**
  4779. * The license endpoint ID to add to the metered product.
  4780. */
  4781. licenseEndpointId: LicenseEndpointId;
  4782. /**
  4783. * The product ID to add to the metered product.
  4784. */
  4785. productId: MeteredProductId;
  4786. }
  4787. export interface PutMeteredProductResponse {
  4788. }
  4789. export type QueueBlockedReason = "NO_BUDGET_CONFIGURED"|"BUDGET_THRESHOLD_REACHED"|string;
  4790. export type QueueEnvironmentId = string;
  4791. export type QueueEnvironmentSummaries = QueueEnvironmentSummary[];
  4792. export interface QueueEnvironmentSummary {
  4793. /**
  4794. * The name of the queue environment.
  4795. */
  4796. name: EnvironmentName;
  4797. /**
  4798. * The queue environment's priority.
  4799. */
  4800. priority: Priority;
  4801. /**
  4802. * The queue environment ID.
  4803. */
  4804. queueEnvironmentId: QueueEnvironmentId;
  4805. }
  4806. export type QueueFleetAssociationStatus = "ACTIVE"|"STOP_SCHEDULING_AND_COMPLETE_TASKS"|"STOP_SCHEDULING_AND_CANCEL_TASKS"|"STOPPED"|string;
  4807. export type QueueFleetAssociationSummaries = QueueFleetAssociationSummary[];
  4808. export interface QueueFleetAssociationSummary {
  4809. /**
  4810. * The date and time the resource was created.
  4811. */
  4812. createdAt: CreatedAt;
  4813. /**
  4814. * The user or system that created this resource.
  4815. */
  4816. createdBy: CreatedBy;
  4817. /**
  4818. * The fleet ID.
  4819. */
  4820. fleetId: FleetId;
  4821. /**
  4822. * The queue ID.
  4823. */
  4824. queueId: QueueId;
  4825. /**
  4826. * The status of task scheduling in the queue-fleet association. ACTIVE–Association is active. STOP_SCHEDULING_AND_COMPLETE_TASKS–Association has stopped scheduling new tasks and is completing current tasks. STOP_SCHEDULING_AND_CANCEL_TASKS–Association has stopped scheduling new tasks and is canceling current tasks. STOPPED–Association has been stopped.
  4827. */
  4828. status: QueueFleetAssociationStatus;
  4829. /**
  4830. * The date and time the resource was updated.
  4831. */
  4832. updatedAt?: UpdatedAt;
  4833. /**
  4834. * The user or system that updated this resource.
  4835. */
  4836. updatedBy?: UpdatedBy;
  4837. }
  4838. export type QueueId = string;
  4839. export interface QueueMember {
  4840. /**
  4841. * The farm ID.
  4842. */
  4843. farmId: FarmId;
  4844. /**
  4845. * The identity store ID.
  4846. */
  4847. identityStoreId: IdentityStoreId;
  4848. /**
  4849. * The queue member's membership level.
  4850. */
  4851. membershipLevel: MembershipLevel;
  4852. /**
  4853. * The principal ID of the queue member.
  4854. */
  4855. principalId: IdentityCenterPrincipalId;
  4856. /**
  4857. * The principal type of the queue member.
  4858. */
  4859. principalType: PrincipalType;
  4860. /**
  4861. * The queue ID.
  4862. */
  4863. queueId: QueueId;
  4864. }
  4865. export type QueueMemberList = QueueMember[];
  4866. export type QueueStatus = "IDLE"|"SCHEDULING"|"SCHEDULING_BLOCKED"|string;
  4867. export type QueueSummaries = QueueSummary[];
  4868. export interface QueueSummary {
  4869. /**
  4870. * The reason the queue is blocked, if applicable.
  4871. */
  4872. blockedReason?: QueueBlockedReason;
  4873. /**
  4874. * The date and time the resource was created.
  4875. */
  4876. createdAt: CreatedAt;
  4877. /**
  4878. * The user or system that created this resource.
  4879. */
  4880. createdBy: CreatedBy;
  4881. /**
  4882. * The default action taken on a queue summary if a budget wasn't configured.
  4883. */
  4884. defaultBudgetAction: DefaultQueueBudgetAction;
  4885. /**
  4886. * The display name of the queue summary to update.
  4887. */
  4888. displayName: ResourceName;
  4889. /**
  4890. * The farm ID.
  4891. */
  4892. farmId: FarmId;
  4893. /**
  4894. * The queue ID.
  4895. */
  4896. queueId: QueueId;
  4897. /**
  4898. * That status of the queue.
  4899. */
  4900. status: QueueStatus;
  4901. /**
  4902. * The date and time the resource was updated.
  4903. */
  4904. updatedAt?: UpdatedAt;
  4905. /**
  4906. * The user or system that updated this resource.
  4907. */
  4908. updatedBy?: UpdatedBy;
  4909. }
  4910. export type RequiredFileSystemLocationNames = FileSystemLocationName[];
  4911. export type ResourceName = string;
  4912. export interface ResponseBudgetAction {
  4913. /**
  4914. * The budget action description.
  4915. */
  4916. description?: Description;
  4917. /**
  4918. * The percentage threshold for the budget.
  4919. */
  4920. thresholdPercentage: ThresholdPercentage;
  4921. /**
  4922. * The action taken on the budget once scheduling stops.
  4923. */
  4924. type: BudgetActionType;
  4925. }
  4926. export type ResponseBudgetActionList = ResponseBudgetAction[];
  4927. export type RunAs = "QUEUE_CONFIGURED_USER"|"WORKER_AGENT_USER"|string;
  4928. export type S3BucketName = string;
  4929. export type S3Key = string;
  4930. export interface S3Location {
  4931. /**
  4932. * The name of the Amazon S3 bucket.
  4933. */
  4934. bucketName: S3BucketName;
  4935. /**
  4936. * The Amazon S3 object key that uniquely identifies the Amazon S3 bucket.
  4937. */
  4938. key: S3Key;
  4939. }
  4940. export type S3Prefix = string;
  4941. export interface SearchFilterExpression {
  4942. /**
  4943. * Filters based on date and time.
  4944. */
  4945. dateTimeFilter?: DateTimeFilterExpression;
  4946. /**
  4947. * Filters by group.
  4948. */
  4949. groupFilter?: SearchGroupedFilterExpressions;
  4950. /**
  4951. * Filters by parameter.
  4952. */
  4953. parameterFilter?: ParameterFilterExpression;
  4954. /**
  4955. * Filters by a specified search term.
  4956. */
  4957. searchTermFilter?: SearchTermFilterExpression;
  4958. /**
  4959. * Filters by a string.
  4960. */
  4961. stringFilter?: StringFilterExpression;
  4962. }
  4963. export type SearchFilterExpressions = SearchFilterExpression[];
  4964. export interface SearchGroupedFilterExpressions {
  4965. /**
  4966. * The filters to use for the search.
  4967. */
  4968. filters: SearchFilterExpressions;
  4969. /**
  4970. * The operators to include in the search.
  4971. */
  4972. operator: LogicalOperator;
  4973. }
  4974. export interface SearchJobsRequest {
  4975. /**
  4976. * The farm ID of the job.
  4977. */
  4978. farmId: FarmId;
  4979. /**
  4980. * The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
  4981. */
  4982. filterExpressions?: SearchGroupedFilterExpressions;
  4983. /**
  4984. * Defines how far into the scrollable list to start the return of results.
  4985. */
  4986. itemOffset: SearchJobsRequestItemOffsetInteger;
  4987. /**
  4988. * Specifies the number of items per page for the resource.
  4989. */
  4990. pageSize?: SearchJobsRequestPageSizeInteger;
  4991. /**
  4992. * The queue ID to use in the job search.
  4993. */
  4994. queueIds: SearchJobsRequestQueueIdsList;
  4995. /**
  4996. * The search terms for a resource.
  4997. */
  4998. sortExpressions?: SearchSortExpressions;
  4999. }
  5000. export type SearchJobsRequestItemOffsetInteger = number;
  5001. export type SearchJobsRequestPageSizeInteger = number;
  5002. export type SearchJobsRequestQueueIdsList = QueueId[];
  5003. export interface SearchJobsResponse {
  5004. /**
  5005. * The jobs in the search.
  5006. */
  5007. jobs: JobSearchSummaries;
  5008. /**
  5009. * The next incremental starting point after the defined itemOffset.
  5010. */
  5011. nextItemOffset?: NextItemOffset;
  5012. /**
  5013. * The total number of results in the search.
  5014. */
  5015. totalResults: TotalResults;
  5016. }
  5017. export interface SearchSortExpression {
  5018. /**
  5019. * Options for sorting by a field.
  5020. */
  5021. fieldSort?: FieldSortExpression;
  5022. /**
  5023. * Options for sorting by a parameter.
  5024. */
  5025. parameterSort?: ParameterSortExpression;
  5026. /**
  5027. * Options for sorting a particular user's jobs first.
  5028. */
  5029. userJobsFirst?: UserJobsFirst;
  5030. }
  5031. export type SearchSortExpressions = SearchSortExpression[];
  5032. export interface SearchStepsRequest {
  5033. /**
  5034. * The farm ID to use for the step search.
  5035. */
  5036. farmId: FarmId;
  5037. /**
  5038. * The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
  5039. */
  5040. filterExpressions?: SearchGroupedFilterExpressions;
  5041. /**
  5042. * Defines how far into the scrollable list to start the return of results.
  5043. */
  5044. itemOffset: SearchStepsRequestItemOffsetInteger;
  5045. /**
  5046. * The job ID to use in the step search.
  5047. */
  5048. jobId?: JobId;
  5049. /**
  5050. * Specifies the number of items per page for the resource.
  5051. */
  5052. pageSize?: SearchStepsRequestPageSizeInteger;
  5053. /**
  5054. * The queue IDs in the step search.
  5055. */
  5056. queueIds: SearchStepsRequestQueueIdsList;
  5057. /**
  5058. * The search terms for a resource.
  5059. */
  5060. sortExpressions?: SearchSortExpressions;
  5061. }
  5062. export type SearchStepsRequestItemOffsetInteger = number;
  5063. export type SearchStepsRequestPageSizeInteger = number;
  5064. export type SearchStepsRequestQueueIdsList = QueueId[];
  5065. export interface SearchStepsResponse {
  5066. /**
  5067. * The next incremental starting point after the defined itemOffset.
  5068. */
  5069. nextItemOffset?: NextItemOffset;
  5070. /**
  5071. * The steps in the search.
  5072. */
  5073. steps: StepSearchSummaries;
  5074. /**
  5075. * The total number of results in the search.
  5076. */
  5077. totalResults: TotalResults;
  5078. }
  5079. export interface SearchTasksRequest {
  5080. /**
  5081. * The farm ID of the task.
  5082. */
  5083. farmId: FarmId;
  5084. /**
  5085. * The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
  5086. */
  5087. filterExpressions?: SearchGroupedFilterExpressions;
  5088. /**
  5089. * Defines how far into the scrollable list to start the return of results.
  5090. */
  5091. itemOffset: SearchTasksRequestItemOffsetInteger;
  5092. /**
  5093. * The job ID for the task search.
  5094. */
  5095. jobId?: JobId;
  5096. /**
  5097. * Specifies the number of items per page for the resource.
  5098. */
  5099. pageSize?: SearchTasksRequestPageSizeInteger;
  5100. /**
  5101. * The queue IDs to include in the search.
  5102. */
  5103. queueIds: SearchTasksRequestQueueIdsList;
  5104. /**
  5105. * The search terms for a resource.
  5106. */
  5107. sortExpressions?: SearchSortExpressions;
  5108. }
  5109. export type SearchTasksRequestItemOffsetInteger = number;
  5110. export type SearchTasksRequestPageSizeInteger = number;
  5111. export type SearchTasksRequestQueueIdsList = QueueId[];
  5112. export interface SearchTasksResponse {
  5113. /**
  5114. * The next incremental starting point after the defined itemOffset.
  5115. */
  5116. nextItemOffset?: NextItemOffset;
  5117. /**
  5118. * Tasks in the search.
  5119. */
  5120. tasks: TaskSearchSummaries;
  5121. /**
  5122. * The total number of results in the search.
  5123. */
  5124. totalResults: TotalResults;
  5125. }
  5126. export type SearchTerm = string;
  5127. export interface SearchTermFilterExpression {
  5128. /**
  5129. * The term to search for.
  5130. */
  5131. searchTerm: SearchTerm;
  5132. }
  5133. export interface SearchWorkersRequest {
  5134. /**
  5135. * The farm ID in the workers search.
  5136. */
  5137. farmId: FarmId;
  5138. /**
  5139. * The filter expression, AND or OR, to use when searching among a group of search strings in a resource. You can use two groupings per search each within parenthesis ().
  5140. */
  5141. filterExpressions?: SearchGroupedFilterExpressions;
  5142. /**
  5143. * The fleet ID of the workers to search for.
  5144. */
  5145. fleetIds: SearchWorkersRequestFleetIdsList;
  5146. /**
  5147. * Defines how far into the scrollable list to start the return of results.
  5148. */
  5149. itemOffset: SearchWorkersRequestItemOffsetInteger;
  5150. /**
  5151. * Specifies the number of items per page for the resource.
  5152. */
  5153. pageSize?: SearchWorkersRequestPageSizeInteger;
  5154. /**
  5155. * The search terms for a resource.
  5156. */
  5157. sortExpressions?: SearchSortExpressions;
  5158. }
  5159. export type SearchWorkersRequestFleetIdsList = FleetId[];
  5160. export type SearchWorkersRequestItemOffsetInteger = number;
  5161. export type SearchWorkersRequestPageSizeInteger = number;
  5162. export interface SearchWorkersResponse {
  5163. /**
  5164. * The next incremental starting point after the defined itemOffset.
  5165. */
  5166. nextItemOffset?: NextItemOffset;
  5167. /**
  5168. * The total number of results in the search.
  5169. */
  5170. totalResults: TotalResults;
  5171. /**
  5172. * The workers for the search.
  5173. */
  5174. workers: WorkerSearchSummaries;
  5175. }
  5176. export type SecretAccessKey = string;
  5177. export type SecurityGroupId = string;
  5178. export interface ServiceManagedEc2FleetConfiguration {
  5179. /**
  5180. * The Amazon EC2 instance capabilities.
  5181. */
  5182. instanceCapabilities: ServiceManagedEc2InstanceCapabilities;
  5183. /**
  5184. * The Amazon EC2 market type.
  5185. */
  5186. instanceMarketOptions: ServiceManagedEc2InstanceMarketOptions;
  5187. }
  5188. export interface ServiceManagedEc2InstanceCapabilities {
  5189. /**
  5190. * The allowable Amazon EC2 instance types.
  5191. */
  5192. allowedInstanceTypes?: InstanceTypes;
  5193. /**
  5194. * The CPU architecture type.
  5195. */
  5196. cpuArchitectureType: CpuArchitectureType;
  5197. /**
  5198. * The custom capability amounts to require for instances in this fleet.
  5199. */
  5200. customAmounts?: CustomFleetAmountCapabilities;
  5201. /**
  5202. * The custom capability attributes to require for instances in this fleet.
  5203. */
  5204. customAttributes?: CustomFleetAttributeCapabilities;
  5205. /**
  5206. * The instance types to exclude from the fleet.
  5207. */
  5208. excludedInstanceTypes?: InstanceTypes;
  5209. /**
  5210. * The memory, as MiB, for the Amazon EC2 instance type.
  5211. */
  5212. memoryMiB: MemoryMiBRange;
  5213. /**
  5214. * The operating system (OS) family.
  5215. */
  5216. osFamily: ServiceManagedFleetOperatingSystemFamily;
  5217. /**
  5218. * The root EBS volume.
  5219. */
  5220. rootEbsVolume?: Ec2EbsVolume;
  5221. /**
  5222. * The amount of vCPU to require for instances in this fleet.
  5223. */
  5224. vCpuCount: VCpuCountRange;
  5225. }
  5226. export interface ServiceManagedEc2InstanceMarketOptions {
  5227. /**
  5228. * The Amazon EC2 instance type.
  5229. */
  5230. type: Ec2MarketType;
  5231. }
  5232. export type ServiceManagedFleetOperatingSystemFamily = "WINDOWS"|"LINUX"|string;
  5233. export interface SessionActionDefinition {
  5234. /**
  5235. * The environment to enter into.
  5236. */
  5237. envEnter?: EnvironmentEnterSessionActionDefinition;
  5238. /**
  5239. * The environment to exit from.
  5240. */
  5241. envExit?: EnvironmentExitSessionActionDefinition;
  5242. /**
  5243. * The job attachments to sync with a session action.
  5244. */
  5245. syncInputJobAttachments?: SyncInputJobAttachmentsSessionActionDefinition;
  5246. /**
  5247. * The task run in the session.
  5248. */
  5249. taskRun?: TaskRunSessionActionDefinition;
  5250. }
  5251. export interface SessionActionDefinitionSummary {
  5252. /**
  5253. * The environment to enter into.
  5254. */
  5255. envEnter?: EnvironmentEnterSessionActionDefinitionSummary;
  5256. /**
  5257. * The environment to exit from.
  5258. */
  5259. envExit?: EnvironmentExitSessionActionDefinitionSummary;
  5260. /**
  5261. * The job attachments to sync with the session action definition.
  5262. */
  5263. syncInputJobAttachments?: SyncInputJobAttachmentsSessionActionDefinitionSummary;
  5264. /**
  5265. * The task run.
  5266. */
  5267. taskRun?: TaskRunSessionActionDefinitionSummary;
  5268. }
  5269. export type SessionActionId = string;
  5270. export type SessionActionIdList = SessionActionId[];
  5271. export type SessionActionProgressMessage = string;
  5272. export type SessionActionProgressPercent = number;
  5273. export type SessionActionStatus = "ASSIGNED"|"RUNNING"|"CANCELING"|"SUCCEEDED"|"FAILED"|"INTERRUPTED"|"CANCELED"|"NEVER_ATTEMPTED"|"SCHEDULED"|"RECLAIMING"|"RECLAIMED"|string;
  5274. export type SessionActionSummaries = SessionActionSummary[];
  5275. export interface SessionActionSummary {
  5276. /**
  5277. * The session action definition.
  5278. */
  5279. definition: SessionActionDefinitionSummary;
  5280. /**
  5281. * The date and time the resource ended running.
  5282. */
  5283. endedAt?: EndedAt;
  5284. /**
  5285. * The completion percentage for the session action.
  5286. */
  5287. progressPercent?: SessionActionProgressPercent;
  5288. /**
  5289. * The session action ID.
  5290. */
  5291. sessionActionId: SessionActionId;
  5292. /**
  5293. * The date and time the resource started running.
  5294. */
  5295. startedAt?: StartedAt;
  5296. /**
  5297. * The status of the session action.
  5298. */
  5299. status: SessionActionStatus;
  5300. /**
  5301. * The Linux timestamp of the last date and time that the session action was updated.
  5302. */
  5303. workerUpdatedAt?: Timestamp;
  5304. }
  5305. export type SessionId = string;
  5306. export type SessionLifecycleStatus = "STARTED"|"UPDATE_IN_PROGRESS"|"UPDATE_SUCCEEDED"|"UPDATE_FAILED"|"ENDED"|string;
  5307. export type SessionLifecycleTargetStatus = "ENDED"|string;
  5308. export type SessionSummaries = SessionSummary[];
  5309. export interface SessionSummary {
  5310. /**
  5311. * The date and time the resource ended running.
  5312. */
  5313. endedAt?: EndedAt;
  5314. /**
  5315. * The fleet ID.
  5316. */
  5317. fleetId: FleetId;
  5318. /**
  5319. * The life cycle status for the session.
  5320. */
  5321. lifecycleStatus: SessionLifecycleStatus;
  5322. /**
  5323. * The session ID.
  5324. */
  5325. sessionId: SessionId;
  5326. /**
  5327. * The date and time the resource started running.
  5328. */
  5329. startedAt: StartedAt;
  5330. /**
  5331. * The target life cycle status for the session.
  5332. */
  5333. targetLifecycleStatus?: SessionLifecycleTargetStatus;
  5334. /**
  5335. * The date and time the resource was updated.
  5336. */
  5337. updatedAt?: UpdatedAt;
  5338. /**
  5339. * The user or system that updated this resource.
  5340. */
  5341. updatedBy?: UpdatedBy;
  5342. /**
  5343. * The worker ID.
  5344. */
  5345. workerId: WorkerId;
  5346. }
  5347. export type SessionToken = string;
  5348. export type SessionsStatisticsAggregationStatus = "IN_PROGRESS"|"TIMEOUT"|"FAILED"|"COMPLETED"|string;
  5349. export interface SessionsStatisticsResources {
  5350. /**
  5351. * One to 10 fleet IDs that specify the fleets to return statistics for. If you specify the fleetIds field, you can't specify the queueIds field.
  5352. */
  5353. fleetIds?: SessionsStatisticsResourcesFleetIdsList;
  5354. /**
  5355. * One to 10 queue IDs that specify the queues to return statistics for. If you specify the queueIds field, you can't specify the fleetIds field.
  5356. */
  5357. queueIds?: SessionsStatisticsResourcesQueueIdsList;
  5358. }
  5359. export type SessionsStatisticsResourcesFleetIdsList = FleetId[];
  5360. export type SessionsStatisticsResourcesQueueIdsList = QueueId[];
  5361. export type SortOrder = "ASCENDING"|"DESCENDING"|string;
  5362. export interface StartSessionsStatisticsAggregationRequest {
  5363. /**
  5364. * The Linux timestamp of the date and time that the statistics end.
  5365. */
  5366. endTime: SyntheticTimestamp_date_time;
  5367. /**
  5368. * The identifier of the farm that contains queues or fleets to return statistics for.
  5369. */
  5370. farmId: FarmId;
  5371. /**
  5372. * The field to use to group the statistics.
  5373. */
  5374. groupBy: UsageGroupBy;
  5375. /**
  5376. * The period to aggregate the statistics.
  5377. */
  5378. period?: Period;
  5379. /**
  5380. * A list of fleet IDs or queue IDs to gather statistics for.
  5381. */
  5382. resourceIds: SessionsStatisticsResources;
  5383. /**
  5384. * The Linux timestamp of the date and time that the statistics start.
  5385. */
  5386. startTime: SyntheticTimestamp_date_time;
  5387. /**
  5388. * One to four statistics to return.
  5389. */
  5390. statistics: UsageStatistics;
  5391. /**
  5392. * The timezone to use for the statistics. Use UTC notation such as "UTC+8."
  5393. */
  5394. timezone?: Timezone;
  5395. }
  5396. export interface StartSessionsStatisticsAggregationResponse {
  5397. /**
  5398. * A unique identifier for the aggregated statistics. Use this identifier with the GetAggregatedStatisticsForSessions operation to return the statistics.
  5399. */
  5400. aggregationId: AggregationId;
  5401. }
  5402. export type StartedAt = Date;
  5403. export type StartsAt = Date;
  5404. export interface Statistics {
  5405. /**
  5406. * The end time for the aggregation.
  5407. */
  5408. aggregationEndTime?: SyntheticTimestamp_date_time;
  5409. /**
  5410. * The start time for the aggregation.
  5411. */
  5412. aggregationStartTime?: SyntheticTimestamp_date_time;
  5413. /**
  5414. * How the statistics should appear in USD. Options include: minimum, maximum, average or sum.
  5415. */
  5416. costInUsd: Stats;
  5417. /**
  5418. * The number of instances in a list of statistics.
  5419. */
  5420. count: Integer;
  5421. /**
  5422. * The fleet ID.
  5423. */
  5424. fleetId?: FleetId;
  5425. /**
  5426. * The type of instance.
  5427. */
  5428. instanceType?: InstanceType;
  5429. /**
  5430. * The job ID.
  5431. */
  5432. jobId?: JobId;
  5433. /**
  5434. * The job name.
  5435. */
  5436. jobName?: JobName;
  5437. /**
  5438. * The licensed product.
  5439. */
  5440. licenseProduct?: LicenseProduct;
  5441. /**
  5442. * The queue ID.
  5443. */
  5444. queueId?: QueueId;
  5445. /**
  5446. * The total aggregated runtime.
  5447. */
  5448. runtimeInSeconds: Stats;
  5449. /**
  5450. * The type of usage for the statistics.
  5451. */
  5452. usageType?: UsageType;
  5453. /**
  5454. * The user ID.
  5455. */
  5456. userId?: UserId;
  5457. }
  5458. export type StatisticsList = Statistics[];
  5459. export interface Stats {
  5460. /**
  5461. * The average of the usage statistics.
  5462. */
  5463. avg?: Double;
  5464. /**
  5465. * The maximum among the usage statistics.
  5466. */
  5467. max?: Double;
  5468. /**
  5469. * The minimum of the usage statistics.
  5470. */
  5471. min?: Double;
  5472. /**
  5473. * The sum of the usage statistics.
  5474. */
  5475. sum?: Double;
  5476. }
  5477. export type StatusMessage = string;
  5478. export type StepAmountCapabilities = StepAmountCapability[];
  5479. export interface StepAmountCapability {
  5480. /**
  5481. * The maximum amount.
  5482. */
  5483. max?: Double;
  5484. /**
  5485. * The minimum amount.
  5486. */
  5487. min?: Double;
  5488. /**
  5489. * The name of the step.
  5490. */
  5491. name: AmountCapabilityName;
  5492. /**
  5493. * The amount value.
  5494. */
  5495. value?: Double;
  5496. }
  5497. export type StepAttributeCapabilities = StepAttributeCapability[];
  5498. export interface StepAttributeCapability {
  5499. /**
  5500. * Requires all of the step attribute values.
  5501. */
  5502. allOf?: ListAttributeCapabilityValue;
  5503. /**
  5504. * Requires any of the step attributes in a given list.
  5505. */
  5506. anyOf?: ListAttributeCapabilityValue;
  5507. /**
  5508. * The name of the step attribute.
  5509. */
  5510. name: AttributeCapabilityName;
  5511. }
  5512. export interface StepConsumer {
  5513. /**
  5514. * The step consumer status.
  5515. */
  5516. status: DependencyConsumerResolutionStatus;
  5517. /**
  5518. * The step ID.
  5519. */
  5520. stepId: StepId;
  5521. }
  5522. export type StepConsumers = StepConsumer[];
  5523. export type StepDependencies = StepDependency[];
  5524. export interface StepDependency {
  5525. /**
  5526. * The step dependency status.
  5527. */
  5528. status: DependencyConsumerResolutionStatus;
  5529. /**
  5530. * The step ID.
  5531. */
  5532. stepId: StepId;
  5533. }
  5534. export type StepDescription = string;
  5535. export interface StepDetailsEntity {
  5536. /**
  5537. * The dependencies for a step.
  5538. */
  5539. dependencies: DependenciesList;
  5540. /**
  5541. * The job ID.
  5542. */
  5543. jobId: JobId;
  5544. /**
  5545. * The schema version for a step template.
  5546. */
  5547. schemaVersion: String;
  5548. /**
  5549. * The step ID.
  5550. */
  5551. stepId: StepId;
  5552. /**
  5553. * The template for a step.
  5554. */
  5555. template: Document;
  5556. }
  5557. export interface StepDetailsError {
  5558. /**
  5559. * The error code.
  5560. */
  5561. code: JobEntityErrorCode;
  5562. /**
  5563. * The job ID.
  5564. */
  5565. jobId: JobId;
  5566. /**
  5567. * The error message detailing the error's cause.
  5568. */
  5569. message: String;
  5570. /**
  5571. * The step ID.
  5572. */
  5573. stepId: StepId;
  5574. }
  5575. export interface StepDetailsIdentifiers {
  5576. /**
  5577. * The job ID.
  5578. */
  5579. jobId: JobId;
  5580. /**
  5581. * The step ID.
  5582. */
  5583. stepId: StepId;
  5584. }
  5585. export type StepId = string;
  5586. export type StepLifecycleStatus = "CREATE_COMPLETE"|"UPDATE_IN_PROGRESS"|"UPDATE_FAILED"|"UPDATE_SUCCEEDED"|string;
  5587. export type StepName = string;
  5588. export interface StepParameter {
  5589. /**
  5590. * The name of the parameter.
  5591. */
  5592. name: StepParameterName;
  5593. /**
  5594. * The data type of the parameter.
  5595. */
  5596. type: StepParameterType;
  5597. }
  5598. export type StepParameterList = StepParameter[];
  5599. export type StepParameterName = string;
  5600. export type StepParameterType = "INT"|"FLOAT"|"STRING"|"PATH"|string;
  5601. export interface StepRequiredCapabilities {
  5602. /**
  5603. * The capability amounts that the step requires.
  5604. */
  5605. amounts: StepAmountCapabilities;
  5606. /**
  5607. * The capability attributes that the step requires.
  5608. */
  5609. attributes: StepAttributeCapabilities;
  5610. }
  5611. export type StepSearchSummaries = StepSearchSummary[];
  5612. export interface StepSearchSummary {
  5613. /**
  5614. * The date and time the resource was created.
  5615. */
  5616. createdAt?: CreatedAt;
  5617. /**
  5618. * The date and time the resource ended running.
  5619. */
  5620. endedAt?: EndedAt;
  5621. /**
  5622. * The job ID.
  5623. */
  5624. jobId?: JobId;
  5625. /**
  5626. * The life cycle status.
  5627. */
  5628. lifecycleStatus?: StepLifecycleStatus;
  5629. /**
  5630. * The life cycle status message.
  5631. */
  5632. lifecycleStatusMessage?: String;
  5633. /**
  5634. * The step name.
  5635. */
  5636. name?: StepName;
  5637. /**
  5638. * The parameters and combination expressions for the search.
  5639. */
  5640. parameterSpace?: ParameterSpace;
  5641. /**
  5642. * The queue ID.
  5643. */
  5644. queueId?: QueueId;
  5645. /**
  5646. * The date and time the resource started running.
  5647. */
  5648. startedAt?: StartedAt;
  5649. /**
  5650. * The step ID.
  5651. */
  5652. stepId?: StepId;
  5653. /**
  5654. * The task status to start with on the job.
  5655. */
  5656. targetTaskRunStatus?: StepTargetTaskRunStatus;
  5657. /**
  5658. * The task run status for the job. PENDING–pending and waiting for resources. READY–ready to be processed. ASSIGNED–assigned and will run next on a worker. SCHEDULED–scheduled to be run on a worker. INTERRUPTING–being interrupted. RUNNING–running on a worker. SUSPENDED–the task is suspended. CANCELED–the task has been canceled. FAILED–the task has failed. SUCCEEDED–the task has succeeded.
  5659. */
  5660. taskRunStatus?: TaskRunStatus;
  5661. /**
  5662. * The number of tasks running on the job.
  5663. */
  5664. taskRunStatusCounts?: TaskRunStatusCounts;
  5665. }
  5666. export type StepSummaries = StepSummary[];
  5667. export interface StepSummary {
  5668. /**
  5669. * The date and time the resource was created.
  5670. */
  5671. createdAt: CreatedAt;
  5672. /**
  5673. * The user or system that created this resource.
  5674. */
  5675. createdBy: CreatedBy;
  5676. /**
  5677. * The number of dependencies for the step.
  5678. */
  5679. dependencyCounts?: DependencyCounts;
  5680. /**
  5681. * The date and time the resource ended running.
  5682. */
  5683. endedAt?: EndedAt;
  5684. /**
  5685. * The life cycle status.
  5686. */
  5687. lifecycleStatus: StepLifecycleStatus;
  5688. /**
  5689. * A message that describes the lifecycle of the step.
  5690. */
  5691. lifecycleStatusMessage?: String;
  5692. /**
  5693. * The name of the step.
  5694. */
  5695. name: StepName;
  5696. /**
  5697. * The date and time the resource started running.
  5698. */
  5699. startedAt?: StartedAt;
  5700. /**
  5701. * The step ID.
  5702. */
  5703. stepId: StepId;
  5704. /**
  5705. * The task status to start with on the job.
  5706. */
  5707. targetTaskRunStatus?: StepTargetTaskRunStatus;
  5708. /**
  5709. * The task run status for the job. PENDING–pending and waiting for resources. READY–ready to process. ASSIGNED–assigned and will run next on a worker. SCHEDULED–scheduled to run on a worker. INTERRUPTING–being interrupted. RUNNING–running on a worker. SUSPENDED–the task is suspended. CANCELED–the task has been canceled. FAILED–the task has failed. SUCCEEDED–the task has succeeded.
  5710. */
  5711. taskRunStatus: TaskRunStatus;
  5712. /**
  5713. * The number of tasks running on the job.
  5714. */
  5715. taskRunStatusCounts: TaskRunStatusCounts;
  5716. /**
  5717. * The date and time the resource was updated.
  5718. */
  5719. updatedAt?: UpdatedAt;
  5720. /**
  5721. * The user or system that updated this resource.
  5722. */
  5723. updatedBy?: UpdatedBy;
  5724. }
  5725. export type StepTargetTaskRunStatus = "READY"|"FAILED"|"SUCCEEDED"|"CANCELED"|"SUSPENDED"|"PENDING"|string;
  5726. export type StorageProfileId = string;
  5727. export type StorageProfileOperatingSystemFamily = "WINDOWS"|"LINUX"|"MACOS"|string;
  5728. export type StorageProfileSummaries = StorageProfileSummary[];
  5729. export interface StorageProfileSummary {
  5730. /**
  5731. * The display name of the storage profile summary to update.
  5732. */
  5733. displayName: ResourceName;
  5734. /**
  5735. * The operating system (OS) family.
  5736. */
  5737. osFamily: StorageProfileOperatingSystemFamily;
  5738. /**
  5739. * The storage profile ID.
  5740. */
  5741. storageProfileId: StorageProfileId;
  5742. }
  5743. export type String = string;
  5744. export type StringFilter = string;
  5745. export interface StringFilterExpression {
  5746. /**
  5747. * The field name to search.
  5748. */
  5749. name: String;
  5750. /**
  5751. * The type of comparison to use for this search.
  5752. */
  5753. operator: ComparisonOperator;
  5754. /**
  5755. * The string to search for.
  5756. */
  5757. value: StringFilter;
  5758. }
  5759. export type StringList = String[];
  5760. export type Subdomain = string;
  5761. export type SubnetId = string;
  5762. export interface SyncInputJobAttachmentsSessionActionDefinition {
  5763. /**
  5764. * The step ID for the step in the job attachment.
  5765. */
  5766. stepId?: StepId;
  5767. }
  5768. export interface SyncInputJobAttachmentsSessionActionDefinitionSummary {
  5769. /**
  5770. * The step ID of the step in the job attachment.
  5771. */
  5772. stepId?: StepId;
  5773. }
  5774. export type SyntheticTimestamp_date_time = Date;
  5775. export interface TagResourceRequest {
  5776. /**
  5777. * The ARN of the resource to apply tags to.
  5778. */
  5779. resourceArn: String;
  5780. /**
  5781. * Each tag consists of a tag key and a tag value. Tag keys and values are both required, but tag values can be empty strings.
  5782. */
  5783. tags?: Tags;
  5784. }
  5785. export interface TagResourceResponse {
  5786. }
  5787. export type Tags = {[key: string]: String};
  5788. export type TaskId = string;
  5789. export interface TaskParameterValue {
  5790. /**
  5791. * A double precision IEEE-754 floating point number represented as a string.
  5792. */
  5793. float?: FloatString;
  5794. /**
  5795. * A signed integer represented as a string.
  5796. */
  5797. int?: IntString;
  5798. /**
  5799. * A file system path represented as a string.
  5800. */
  5801. path?: PathString;
  5802. /**
  5803. * A UTF-8 string.
  5804. */
  5805. string?: ParameterString;
  5806. }
  5807. export type TaskParameters = {[key: string]: TaskParameterValue};
  5808. export type TaskRetryCount = number;
  5809. export interface TaskRunSessionActionDefinition {
  5810. /**
  5811. * The task parameters.
  5812. */
  5813. parameters: TaskParameters;
  5814. /**
  5815. * The step ID.
  5816. */
  5817. stepId: StepId;
  5818. /**
  5819. * The task ID.
  5820. */
  5821. taskId: TaskId;
  5822. }
  5823. export interface TaskRunSessionActionDefinitionSummary {
  5824. /**
  5825. * The step ID.
  5826. */
  5827. stepId: StepId;
  5828. /**
  5829. * The task ID.
  5830. */
  5831. taskId: TaskId;
  5832. }
  5833. export type TaskRunStatus = "PENDING"|"READY"|"ASSIGNED"|"STARTING"|"SCHEDULED"|"INTERRUPTING"|"RUNNING"|"SUSPENDED"|"CANCELED"|"FAILED"|"SUCCEEDED"|"NOT_COMPATIBLE"|string;
  5834. export type TaskRunStatusCounts = {[key: string]: Integer};
  5835. export type TaskSearchSummaries = TaskSearchSummary[];
  5836. export interface TaskSearchSummary {
  5837. /**
  5838. * The date and time the resource ended running.
  5839. */
  5840. endedAt?: EndedAt;
  5841. /**
  5842. * The number of times that the task failed and was retried.
  5843. */
  5844. failureRetryCount?: TaskRetryCount;
  5845. /**
  5846. * The job ID.
  5847. */
  5848. jobId?: JobId;
  5849. /**
  5850. * The parameters to search for.
  5851. */
  5852. parameters?: TaskParameters;
  5853. /**
  5854. * The queue ID.
  5855. */
  5856. queueId?: QueueId;
  5857. /**
  5858. * The run status of the task.
  5859. */
  5860. runStatus?: TaskRunStatus;
  5861. /**
  5862. * The date and time the resource started running.
  5863. */
  5864. startedAt?: StartedAt;
  5865. /**
  5866. * The step ID.
  5867. */
  5868. stepId?: StepId;
  5869. /**
  5870. * The run status that the task is being updated to.
  5871. */
  5872. targetRunStatus?: TaskTargetRunStatus;
  5873. /**
  5874. * The task ID.
  5875. */
  5876. taskId?: TaskId;
  5877. }
  5878. export type TaskSummaries = TaskSummary[];
  5879. export interface TaskSummary {
  5880. /**
  5881. * The date and time the resource was created.
  5882. */
  5883. createdAt: CreatedAt;
  5884. /**
  5885. * The user or system that created this resource.
  5886. */
  5887. createdBy: CreatedBy;
  5888. /**
  5889. * The date and time the resource ended running.
  5890. */
  5891. endedAt?: EndedAt;
  5892. /**
  5893. * The number of times that the task failed and was retried.
  5894. */
  5895. failureRetryCount?: TaskRetryCount;
  5896. /**
  5897. * The latest session action for the task.
  5898. */
  5899. latestSessionActionId?: SessionActionId;
  5900. /**
  5901. * The task parameters.
  5902. */
  5903. parameters?: TaskParameters;
  5904. /**
  5905. * The run status of the task.
  5906. */
  5907. runStatus: TaskRunStatus;
  5908. /**
  5909. * The date and time the resource started running.
  5910. */
  5911. startedAt?: StartedAt;
  5912. /**
  5913. * The run status on which the started.
  5914. */
  5915. targetRunStatus?: TaskTargetRunStatus;
  5916. /**
  5917. * The task ID.
  5918. */
  5919. taskId: TaskId;
  5920. /**
  5921. * The date and time the resource was updated.
  5922. */
  5923. updatedAt?: UpdatedAt;
  5924. /**
  5925. * The user or system that updated this resource.
  5926. */
  5927. updatedBy?: UpdatedBy;
  5928. }
  5929. export type TaskTargetRunStatus = "READY"|"FAILED"|"SUCCEEDED"|"CANCELED"|"SUSPENDED"|"PENDING"|string;
  5930. export type ThresholdPercentage = number;
  5931. export type Timestamp = Date;
  5932. export type Timezone = string;
  5933. export type TotalResults = number;
  5934. export interface UntagResourceRequest {
  5935. /**
  5936. * The ARN of the resource to remove the tag from.
  5937. */
  5938. resourceArn: String;
  5939. /**
  5940. * They keys of the tag.
  5941. */
  5942. tagKeys: StringList;
  5943. }
  5944. export interface UntagResourceResponse {
  5945. }
  5946. export interface UpdateBudgetRequest {
  5947. /**
  5948. * The budget actions to add. Budget actions specify what happens when the budget runs out.
  5949. */
  5950. actionsToAdd?: BudgetActionsToAdd;
  5951. /**
  5952. * The budget actions to remove from the budget.
  5953. */
  5954. actionsToRemove?: BudgetActionsToRemove;
  5955. /**
  5956. * The dollar limit to update on the budget. Based on consumed usage.
  5957. */
  5958. approximateDollarLimit?: ConsumedUsageLimit;
  5959. /**
  5960. * The budget ID to update.
  5961. */
  5962. budgetId: BudgetId;
  5963. /**
  5964. * The unique token which the server uses to recognize retries of the same request.
  5965. */
  5966. clientToken?: ClientToken;
  5967. /**
  5968. * The description of the budget to update.
  5969. */
  5970. description?: Description;
  5971. /**
  5972. * The display name of the budget to update.
  5973. */
  5974. displayName?: ResourceName;
  5975. /**
  5976. * The farm ID of the budget to update.
  5977. */
  5978. farmId: FarmId;
  5979. /**
  5980. * The schedule to update.
  5981. */
  5982. schedule?: BudgetSchedule;
  5983. /**
  5984. * Updates the status of the budget. ACTIVE–The budget is being evaluated. INACTIVE–The budget is inactive. This can include Expired, Canceled, or deleted Deleted statuses.
  5985. */
  5986. status?: BudgetStatus;
  5987. }
  5988. export interface UpdateBudgetResponse {
  5989. }
  5990. export interface UpdateFarmRequest {
  5991. /**
  5992. * The description of the farm to update.
  5993. */
  5994. description?: Description;
  5995. /**
  5996. * The display name of the farm to update.
  5997. */
  5998. displayName?: ResourceName;
  5999. /**
  6000. * The farm ID to update.
  6001. */
  6002. farmId: FarmId;
  6003. }
  6004. export interface UpdateFarmResponse {
  6005. }
  6006. export interface UpdateFleetRequest {
  6007. /**
  6008. * The unique token which the server uses to recognize retries of the same request.
  6009. */
  6010. clientToken?: ClientToken;
  6011. /**
  6012. * The fleet configuration to update.
  6013. */
  6014. configuration?: FleetConfiguration;
  6015. /**
  6016. * The description of the fleet to update.
  6017. */
  6018. description?: Description;
  6019. /**
  6020. * The display name of the fleet to update.
  6021. */
  6022. displayName?: ResourceName;
  6023. /**
  6024. * The farm ID to update.
  6025. */
  6026. farmId: FarmId;
  6027. /**
  6028. * The fleet ID to update.
  6029. */
  6030. fleetId: FleetId;
  6031. /**
  6032. * The maximum number of workers in the fleet.
  6033. */
  6034. maxWorkerCount?: MinZeroMaxInteger;
  6035. /**
  6036. * The minimum number of workers in the fleet.
  6037. */
  6038. minWorkerCount?: MinZeroMaxInteger;
  6039. /**
  6040. * The IAM role ARN that the fleet's workers assume while running jobs.
  6041. */
  6042. roleArn?: IamRoleArn;
  6043. }
  6044. export interface UpdateFleetResponse {
  6045. }
  6046. export type UpdateJobLifecycleStatus = "ARCHIVED"|string;
  6047. export interface UpdateJobRequest {
  6048. /**
  6049. * The unique token which the server uses to recognize retries of the same request.
  6050. */
  6051. clientToken?: ClientToken;
  6052. /**
  6053. * The farm ID of the job to update.
  6054. */
  6055. farmId: FarmId;
  6056. /**
  6057. * The job ID to update.
  6058. */
  6059. jobId: JobId;
  6060. /**
  6061. * The status of a job in its lifecycle.
  6062. */
  6063. lifecycleStatus?: UpdateJobLifecycleStatus;
  6064. /**
  6065. * The number of task failures before the job stops running and is marked as FAILED.
  6066. */
  6067. maxFailedTasksCount?: MaxFailedTasksCount;
  6068. /**
  6069. * The maximum number of retries for a job.
  6070. */
  6071. maxRetriesPerTask?: MaxRetriesPerTask;
  6072. /**
  6073. * The job priority to update.
  6074. */
  6075. priority?: JobPriority;
  6076. /**
  6077. * The queue ID of the job to update.
  6078. */
  6079. queueId: QueueId;
  6080. /**
  6081. * The task status to update the job's tasks to.
  6082. */
  6083. targetTaskRunStatus?: JobTargetTaskRunStatus;
  6084. }
  6085. export interface UpdateJobResponse {
  6086. }
  6087. export interface UpdateMonitorRequest {
  6088. /**
  6089. * The new value to use for the monitor's display name.
  6090. */
  6091. displayName?: ResourceName;
  6092. /**
  6093. * The unique identifier of the monitor to update.
  6094. */
  6095. monitorId: MonitorId;
  6096. /**
  6097. * The Amazon Resource Name (ARN) of the new IAM role to use with the monitor.
  6098. */
  6099. roleArn?: IamRoleArn;
  6100. /**
  6101. * The new value of the subdomain to use when forming the monitor URL.
  6102. */
  6103. subdomain?: Subdomain;
  6104. }
  6105. export interface UpdateMonitorResponse {
  6106. }
  6107. export interface UpdateQueueEnvironmentRequest {
  6108. /**
  6109. * The unique token which the server uses to recognize retries of the same request.
  6110. */
  6111. clientToken?: ClientToken;
  6112. /**
  6113. * The farm ID of the queue environment to update.
  6114. */
  6115. farmId: FarmId;
  6116. /**
  6117. * The priority to update.
  6118. */
  6119. priority?: Priority;
  6120. /**
  6121. * The queue environment ID to update.
  6122. */
  6123. queueEnvironmentId: QueueEnvironmentId;
  6124. /**
  6125. * The queue ID of the queue environment to update.
  6126. */
  6127. queueId: QueueId;
  6128. /**
  6129. * The template to update.
  6130. */
  6131. template?: EnvironmentTemplate;
  6132. /**
  6133. * The template type to update.
  6134. */
  6135. templateType?: EnvironmentTemplateType;
  6136. }
  6137. export interface UpdateQueueEnvironmentResponse {
  6138. }
  6139. export interface UpdateQueueFleetAssociationRequest {
  6140. /**
  6141. * The farm ID to update.
  6142. */
  6143. farmId: FarmId;
  6144. /**
  6145. * The fleet ID to update.
  6146. */
  6147. fleetId: FleetId;
  6148. /**
  6149. * The queue ID to update.
  6150. */
  6151. queueId: QueueId;
  6152. /**
  6153. * The status to update.
  6154. */
  6155. status: UpdateQueueFleetAssociationStatus;
  6156. }
  6157. export interface UpdateQueueFleetAssociationResponse {
  6158. }
  6159. export type UpdateQueueFleetAssociationStatus = "ACTIVE"|"STOP_SCHEDULING_AND_COMPLETE_TASKS"|"STOP_SCHEDULING_AND_CANCEL_TASKS"|string;
  6160. export interface UpdateQueueRequest {
  6161. /**
  6162. * The storage profile IDs to add.
  6163. */
  6164. allowedStorageProfileIdsToAdd?: AllowedStorageProfileIds;
  6165. /**
  6166. * The storage profile ID to remove.
  6167. */
  6168. allowedStorageProfileIdsToRemove?: AllowedStorageProfileIds;
  6169. /**
  6170. * The idempotency token to update in the queue.
  6171. */
  6172. clientToken?: ClientToken;
  6173. /**
  6174. * The default action to take for a queue update if a budget isn't configured.
  6175. */
  6176. defaultBudgetAction?: DefaultQueueBudgetAction;
  6177. /**
  6178. * The description of the queue to update.
  6179. */
  6180. description?: Description;
  6181. /**
  6182. * The display name of the queue to update.
  6183. */
  6184. displayName?: ResourceName;
  6185. /**
  6186. * The farm ID to update in the queue.
  6187. */
  6188. farmId: FarmId;
  6189. /**
  6190. * The job attachment settings to update for the queue.
  6191. */
  6192. jobAttachmentSettings?: JobAttachmentSettings;
  6193. /**
  6194. * Update the jobs in the queue to run as a specified POSIX user.
  6195. */
  6196. jobRunAsUser?: JobRunAsUser;
  6197. /**
  6198. * The queue ID to update.
  6199. */
  6200. queueId: QueueId;
  6201. /**
  6202. * The required file system location names to add to the queue.
  6203. */
  6204. requiredFileSystemLocationNamesToAdd?: RequiredFileSystemLocationNames;
  6205. /**
  6206. * The required file system location names to remove from the queue.
  6207. */
  6208. requiredFileSystemLocationNamesToRemove?: RequiredFileSystemLocationNames;
  6209. /**
  6210. * The IAM role ARN that's used to run jobs from this queue.
  6211. */
  6212. roleArn?: IamRoleArn;
  6213. }
  6214. export interface UpdateQueueResponse {
  6215. }
  6216. export interface UpdateSessionRequest {
  6217. /**
  6218. * The unique token which the server uses to recognize retries of the same request.
  6219. */
  6220. clientToken?: ClientToken;
  6221. /**
  6222. * The farm ID to update in the session.
  6223. */
  6224. farmId: FarmId;
  6225. /**
  6226. * The job ID to update in the session.
  6227. */
  6228. jobId: JobId;
  6229. /**
  6230. * The queue ID to update in the session.
  6231. */
  6232. queueId: QueueId;
  6233. /**
  6234. * The session ID to update.
  6235. */
  6236. sessionId: SessionId;
  6237. /**
  6238. * The life cycle status to update in the session.
  6239. */
  6240. targetLifecycleStatus: SessionLifecycleTargetStatus;
  6241. }
  6242. export interface UpdateSessionResponse {
  6243. }
  6244. export interface UpdateStepRequest {
  6245. /**
  6246. * The unique token which the server uses to recognize retries of the same request.
  6247. */
  6248. clientToken?: ClientToken;
  6249. /**
  6250. * The farm ID to update.
  6251. */
  6252. farmId: FarmId;
  6253. /**
  6254. * The job ID to update.
  6255. */
  6256. jobId: JobId;
  6257. /**
  6258. * The queue ID to update.
  6259. */
  6260. queueId: QueueId;
  6261. /**
  6262. * The step ID to update.
  6263. */
  6264. stepId: StepId;
  6265. /**
  6266. * The task status to update the step's tasks to.
  6267. */
  6268. targetTaskRunStatus: StepTargetTaskRunStatus;
  6269. }
  6270. export interface UpdateStepResponse {
  6271. }
  6272. export interface UpdateStorageProfileRequest {
  6273. /**
  6274. * The unique token which the server uses to recognize retries of the same request.
  6275. */
  6276. clientToken?: ClientToken;
  6277. /**
  6278. * The display name of the storage profile to update.
  6279. */
  6280. displayName?: ResourceName;
  6281. /**
  6282. * The farm ID to update.
  6283. */
  6284. farmId: FarmId;
  6285. /**
  6286. * The file system location names to add.
  6287. */
  6288. fileSystemLocationsToAdd?: FileSystemLocationsList;
  6289. /**
  6290. * The file system location names to remove.
  6291. */
  6292. fileSystemLocationsToRemove?: FileSystemLocationsList;
  6293. /**
  6294. * The OS system to update.
  6295. */
  6296. osFamily?: StorageProfileOperatingSystemFamily;
  6297. /**
  6298. * The storage profile ID to update.
  6299. */
  6300. storageProfileId: StorageProfileId;
  6301. }
  6302. export interface UpdateStorageProfileResponse {
  6303. }
  6304. export interface UpdateTaskRequest {
  6305. /**
  6306. * The unique token which the server uses to recognize retries of the same request.
  6307. */
  6308. clientToken?: ClientToken;
  6309. /**
  6310. * The farm ID to update.
  6311. */
  6312. farmId: FarmId;
  6313. /**
  6314. * The job ID to update.
  6315. */
  6316. jobId: JobId;
  6317. /**
  6318. * The queue ID to update.
  6319. */
  6320. queueId: QueueId;
  6321. /**
  6322. * The step ID to update.
  6323. */
  6324. stepId: StepId;
  6325. /**
  6326. * The run status with which to start the task.
  6327. */
  6328. targetRunStatus: TaskTargetRunStatus;
  6329. /**
  6330. * The task ID to update.
  6331. */
  6332. taskId: TaskId;
  6333. }
  6334. export interface UpdateTaskResponse {
  6335. }
  6336. export interface UpdateWorkerRequest {
  6337. /**
  6338. * The worker capabilities to update.
  6339. */
  6340. capabilities?: WorkerCapabilities;
  6341. /**
  6342. * The farm ID to update.
  6343. */
  6344. farmId: FarmId;
  6345. /**
  6346. * The fleet ID to update.
  6347. */
  6348. fleetId: FleetId;
  6349. /**
  6350. * The host properties to update.
  6351. */
  6352. hostProperties?: HostPropertiesRequest;
  6353. /**
  6354. * The worker status to update.
  6355. */
  6356. status?: UpdatedWorkerStatus;
  6357. /**
  6358. * The worker ID to update.
  6359. */
  6360. workerId: WorkerId;
  6361. }
  6362. export interface UpdateWorkerResponse {
  6363. /**
  6364. * The worker log to update.
  6365. */
  6366. log?: LogConfiguration;
  6367. }
  6368. export type UpdateWorkerScheduleInterval = number;
  6369. export interface UpdateWorkerScheduleRequest {
  6370. /**
  6371. * The farm ID to update.
  6372. */
  6373. farmId: FarmId;
  6374. /**
  6375. * The fleet ID to update.
  6376. */
  6377. fleetId: FleetId;
  6378. /**
  6379. * The session actions associated with the worker schedule to update.
  6380. */
  6381. updatedSessionActions?: UpdatedSessionActions;
  6382. /**
  6383. * The worker ID to update.
  6384. */
  6385. workerId: WorkerId;
  6386. }
  6387. export interface UpdateWorkerScheduleResponse {
  6388. /**
  6389. * The assigned sessions to update.
  6390. */
  6391. assignedSessions: AssignedSessions;
  6392. /**
  6393. * The session actions associated with the worker schedule to cancel.
  6394. */
  6395. cancelSessionActions: CancelSessionActions;
  6396. /**
  6397. * The status to update the worker to.
  6398. */
  6399. desiredWorkerStatus?: DesiredWorkerStatus;
  6400. /**
  6401. * Updates the time interval (in seconds) for the schedule.
  6402. */
  6403. updateIntervalSeconds: UpdateWorkerScheduleInterval;
  6404. }
  6405. export type UpdatedAt = Date;
  6406. export type UpdatedBy = string;
  6407. export interface UpdatedSessionActionInfo {
  6408. /**
  6409. * The status of the session upon completion.
  6410. */
  6411. completedStatus?: CompletedStatus;
  6412. /**
  6413. * The date and time the resource ended running.
  6414. */
  6415. endedAt?: SyntheticTimestamp_date_time;
  6416. /**
  6417. * The process exit code.
  6418. */
  6419. processExitCode?: ProcessExitCode;
  6420. /**
  6421. * A message to indicate the progress of the updated session action.
  6422. */
  6423. progressMessage?: SessionActionProgressMessage;
  6424. /**
  6425. * The percentage completed.
  6426. */
  6427. progressPercent?: SessionActionProgressPercent;
  6428. /**
  6429. * The date and time the resource started running.
  6430. */
  6431. startedAt?: SyntheticTimestamp_date_time;
  6432. /**
  6433. * The updated time.
  6434. */
  6435. updatedAt?: SyntheticTimestamp_date_time;
  6436. }
  6437. export type UpdatedSessionActions = {[key: string]: UpdatedSessionActionInfo};
  6438. export type UpdatedWorkerStatus = "STARTED"|"STOPPING"|"STOPPED"|string;
  6439. export type Url = string;
  6440. export type UsageGroupBy = UsageGroupByField[];
  6441. export type UsageGroupByField = "QUEUE_ID"|"FLEET_ID"|"JOB_ID"|"USER_ID"|"USAGE_TYPE"|"INSTANCE_TYPE"|"LICENSE_PRODUCT"|string;
  6442. export type UsageStatistic = "SUM"|"MIN"|"MAX"|"AVG"|string;
  6443. export type UsageStatistics = UsageStatistic[];
  6444. export interface UsageTrackingResource {
  6445. /**
  6446. * The queue ID.
  6447. */
  6448. queueId?: QueueId;
  6449. }
  6450. export type UsageType = "COMPUTE"|"LICENSE"|string;
  6451. export type UserId = string;
  6452. export interface UserJobsFirst {
  6453. /**
  6454. * The user's ID.
  6455. */
  6456. userIdentityId: String;
  6457. }
  6458. export interface VCpuCountRange {
  6459. /**
  6460. * The maximum amount of vCPU.
  6461. */
  6462. max?: MinOneMaxTenThousand;
  6463. /**
  6464. * The minimum amount of vCPU.
  6465. */
  6466. min: MinOneMaxTenThousand;
  6467. }
  6468. export type VpcId = string;
  6469. export interface WindowsUser {
  6470. /**
  6471. * The password ARN for the Windows user.
  6472. */
  6473. passwordArn: WindowsUserPasswordArnString;
  6474. /**
  6475. * The user.
  6476. */
  6477. user: WindowsUserUserString;
  6478. }
  6479. export type WindowsUserPasswordArnString = string;
  6480. export type WindowsUserUserString = string;
  6481. export interface WorkerAmountCapability {
  6482. /**
  6483. * The name of the worker amount capability.
  6484. */
  6485. name: AmountCapabilityName;
  6486. /**
  6487. * The value of the worker amount capability.
  6488. */
  6489. value: Float;
  6490. }
  6491. export type WorkerAmountCapabilityList = WorkerAmountCapability[];
  6492. export interface WorkerAttributeCapability {
  6493. /**
  6494. * The name of the worker attribute capability.
  6495. */
  6496. name: AttributeCapabilityName;
  6497. /**
  6498. * The values of the worker amount capability.
  6499. */
  6500. values: AttributeCapabilityValuesList;
  6501. }
  6502. export type WorkerAttributeCapabilityList = WorkerAttributeCapability[];
  6503. export interface WorkerCapabilities {
  6504. /**
  6505. * The worker capabilities amounts on a list of worker capabilities.
  6506. */
  6507. amounts: WorkerAmountCapabilityList;
  6508. /**
  6509. * The worker attribute capabilities in the list of attribute capabilities.
  6510. */
  6511. attributes: WorkerAttributeCapabilityList;
  6512. }
  6513. export type WorkerId = string;
  6514. export type WorkerSearchSummaries = WorkerSearchSummary[];
  6515. export interface WorkerSearchSummary {
  6516. /**
  6517. * The date and time the resource was created.
  6518. */
  6519. createdAt?: CreatedAt;
  6520. /**
  6521. * The user or system that created this resource.
  6522. */
  6523. createdBy?: CreatedBy;
  6524. /**
  6525. * The fleet ID.
  6526. */
  6527. fleetId?: FleetId;
  6528. /**
  6529. * Provides the Amazon EC2 instance properties of the worker host.
  6530. */
  6531. hostProperties?: HostPropertiesResponse;
  6532. /**
  6533. * The status of the worker search.
  6534. */
  6535. status?: WorkerStatus;
  6536. /**
  6537. * The date and time the resource was updated.
  6538. */
  6539. updatedAt?: UpdatedAt;
  6540. /**
  6541. * The user or system that updated this resource.
  6542. */
  6543. updatedBy?: UpdatedBy;
  6544. /**
  6545. * The worker ID.
  6546. */
  6547. workerId?: WorkerId;
  6548. }
  6549. export interface WorkerSessionSummary {
  6550. /**
  6551. * The date and time the resource ended running.
  6552. */
  6553. endedAt?: EndedAt;
  6554. /**
  6555. * The job ID for the job associated with the worker's session.
  6556. */
  6557. jobId: JobId;
  6558. /**
  6559. * The life cycle status for the worker's session.
  6560. */
  6561. lifecycleStatus: SessionLifecycleStatus;
  6562. /**
  6563. * The queue ID for the queue associated to the worker.
  6564. */
  6565. queueId: QueueId;
  6566. /**
  6567. * The session ID for the session action.
  6568. */
  6569. sessionId: SessionId;
  6570. /**
  6571. * The date and time the resource started running.
  6572. */
  6573. startedAt: StartedAt;
  6574. /**
  6575. * The life cycle status
  6576. */
  6577. targetLifecycleStatus?: SessionLifecycleTargetStatus;
  6578. }
  6579. export type WorkerStatus = "CREATED"|"STARTED"|"STOPPING"|"STOPPED"|"NOT_RESPONDING"|"NOT_COMPATIBLE"|"RUNNING"|"IDLE"|string;
  6580. export type WorkerSummaries = WorkerSummary[];
  6581. export interface WorkerSummary {
  6582. /**
  6583. * The date and time the resource was created.
  6584. */
  6585. createdAt: CreatedAt;
  6586. /**
  6587. * The user or system that created this resource.
  6588. */
  6589. createdBy: CreatedBy;
  6590. /**
  6591. * The farm ID.
  6592. */
  6593. farmId: FarmId;
  6594. /**
  6595. * The fleet ID.
  6596. */
  6597. fleetId: FleetId;
  6598. /**
  6599. * The host properties of the worker.
  6600. */
  6601. hostProperties?: HostPropertiesResponse;
  6602. /**
  6603. * The log configuration for the worker.
  6604. */
  6605. log?: LogConfiguration;
  6606. /**
  6607. * The status of the worker.
  6608. */
  6609. status: WorkerStatus;
  6610. /**
  6611. * The date and time the resource was updated.
  6612. */
  6613. updatedAt?: UpdatedAt;
  6614. /**
  6615. * The user or system that updated this resource.
  6616. */
  6617. updatedBy?: UpdatedBy;
  6618. /**
  6619. * The worker ID.
  6620. */
  6621. workerId: WorkerId;
  6622. }
  6623. /**
  6624. * 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.
  6625. */
  6626. export type apiVersion = "2023-10-12"|"latest"|string;
  6627. export interface ClientApiVersions {
  6628. /**
  6629. * 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.
  6630. */
  6631. apiVersion?: apiVersion;
  6632. }
  6633. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  6634. /**
  6635. * Contains interfaces for use with the Deadline client.
  6636. */
  6637. export import Types = Deadline;
  6638. }
  6639. export = Deadline;