12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702270327042705270627072708270927102711271227132714271527162717271827192720272127222723272427252726272727282729273027312732273327342735273627372738273927402741274227432744274527462747274827492750275127522753275427552756275727582759276027612762276327642765276627672768276927702771277227732774277527762777277827792780278127822783278427852786278727882789279027912792279327942795279627972798279928002801280228032804280528062807280828092810281128122813281428152816281728182819282028212822282328242825282628272828282928302831283228332834283528362837283828392840284128422843284428452846284728482849285028512852285328542855285628572858285928602861286228632864286528662867286828692870287128722873287428752876287728782879288028812882288328842885288628872888288928902891289228932894289528962897289828992900290129022903290429052906290729082909291029112912291329142915291629172918291929202921292229232924292529262927292829292930293129322933293429352936293729382939294029412942294329442945294629472948294929502951295229532954295529562957295829592960296129622963296429652966296729682969297029712972297329742975297629772978297929802981298229832984298529862987298829892990299129922993299429952996299729982999300030013002300330043005300630073008300930103011301230133014301530163017301830193020302130223023302430253026302730283029303030313032303330343035303630373038303930403041304230433044304530463047304830493050305130523053305430553056305730583059306030613062306330643065306630673068306930703071307230733074307530763077307830793080308130823083308430853086308730883089309030913092309330943095309630973098309931003101310231033104310531063107310831093110311131123113311431153116311731183119312031213122312331243125312631273128312931303131313231333134313531363137313831393140314131423143314431453146314731483149315031513152315331543155315631573158315931603161316231633164316531663167316831693170317131723173317431753176317731783179318031813182318331843185318631873188318931903191319231933194319531963197319831993200320132023203320432053206320732083209321032113212321332143215321632173218321932203221322232233224322532263227322832293230323132323233323432353236323732383239324032413242324332443245324632473248324932503251325232533254325532563257325832593260326132623263326432653266326732683269327032713272327332743275327632773278327932803281328232833284328532863287328832893290329132923293329432953296329732983299330033013302330333043305330633073308330933103311331233133314331533163317331833193320332133223323332433253326332733283329333033313332333333343335333633373338333933403341334233433344334533463347334833493350335133523353335433553356335733583359336033613362336333643365336633673368336933703371337233733374337533763377337833793380338133823383338433853386338733883389339033913392339333943395339633973398339934003401340234033404340534063407340834093410341134123413341434153416341734183419342034213422342334243425342634273428342934303431343234333434343534363437343834393440344134423443344434453446344734483449345034513452345334543455345634573458345934603461346234633464346534663467346834693470347134723473347434753476347734783479348034813482348334843485348634873488 |
- import {Request} from '../lib/request';
- import {Response} from '../lib/response';
- import {AWSError} from '../lib/error';
- import {Service} from '../lib/service';
- import {WaiterConfiguration} from '../lib/service';
- import {ServiceConfigurationOptions} from '../lib/service';
- import {ConfigBase as Config} from '../lib/config-base';
- interface Blob {}
- declare class AppStream extends Service {
- /**
- * Constructs a service object. This object has one method for each API operation.
- */
- constructor(options?: AppStream.Types.ClientConfiguration)
- config: Config & AppStream.Types.ClientConfiguration;
- /**
- * Associates the specified app block builder with the specified app block.
- */
- associateAppBlockBuilderAppBlock(params: AppStream.Types.AssociateAppBlockBuilderAppBlockRequest, callback?: (err: AWSError, data: AppStream.Types.AssociateAppBlockBuilderAppBlockResult) => void): Request<AppStream.Types.AssociateAppBlockBuilderAppBlockResult, AWSError>;
- /**
- * Associates the specified app block builder with the specified app block.
- */
- associateAppBlockBuilderAppBlock(callback?: (err: AWSError, data: AppStream.Types.AssociateAppBlockBuilderAppBlockResult) => void): Request<AppStream.Types.AssociateAppBlockBuilderAppBlockResult, AWSError>;
- /**
- * Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
- */
- associateApplicationFleet(params: AppStream.Types.AssociateApplicationFleetRequest, callback?: (err: AWSError, data: AppStream.Types.AssociateApplicationFleetResult) => void): Request<AppStream.Types.AssociateApplicationFleetResult, AWSError>;
- /**
- * Associates the specified application with the specified fleet. This is only supported for Elastic fleets.
- */
- associateApplicationFleet(callback?: (err: AWSError, data: AppStream.Types.AssociateApplicationFleetResult) => void): Request<AppStream.Types.AssociateApplicationFleetResult, AWSError>;
- /**
- * Associates an application to entitle.
- */
- associateApplicationToEntitlement(params: AppStream.Types.AssociateApplicationToEntitlementRequest, callback?: (err: AWSError, data: AppStream.Types.AssociateApplicationToEntitlementResult) => void): Request<AppStream.Types.AssociateApplicationToEntitlementResult, AWSError>;
- /**
- * Associates an application to entitle.
- */
- associateApplicationToEntitlement(callback?: (err: AWSError, data: AppStream.Types.AssociateApplicationToEntitlementResult) => void): Request<AppStream.Types.AssociateApplicationToEntitlementResult, AWSError>;
- /**
- * Associates the specified fleet with the specified stack.
- */
- associateFleet(params: AppStream.Types.AssociateFleetRequest, callback?: (err: AWSError, data: AppStream.Types.AssociateFleetResult) => void): Request<AppStream.Types.AssociateFleetResult, AWSError>;
- /**
- * Associates the specified fleet with the specified stack.
- */
- associateFleet(callback?: (err: AWSError, data: AppStream.Types.AssociateFleetResult) => void): Request<AppStream.Types.AssociateFleetResult, AWSError>;
- /**
- * Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.
- */
- batchAssociateUserStack(params: AppStream.Types.BatchAssociateUserStackRequest, callback?: (err: AWSError, data: AppStream.Types.BatchAssociateUserStackResult) => void): Request<AppStream.Types.BatchAssociateUserStackResult, AWSError>;
- /**
- * Associates the specified users with the specified stacks. Users in a user pool cannot be assigned to stacks with fleets that are joined to an Active Directory domain.
- */
- batchAssociateUserStack(callback?: (err: AWSError, data: AppStream.Types.BatchAssociateUserStackResult) => void): Request<AppStream.Types.BatchAssociateUserStackResult, AWSError>;
- /**
- * Disassociates the specified users from the specified stacks.
- */
- batchDisassociateUserStack(params: AppStream.Types.BatchDisassociateUserStackRequest, callback?: (err: AWSError, data: AppStream.Types.BatchDisassociateUserStackResult) => void): Request<AppStream.Types.BatchDisassociateUserStackResult, AWSError>;
- /**
- * Disassociates the specified users from the specified stacks.
- */
- batchDisassociateUserStack(callback?: (err: AWSError, data: AppStream.Types.BatchDisassociateUserStackResult) => void): Request<AppStream.Types.BatchDisassociateUserStackResult, AWSError>;
- /**
- * Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.
- */
- copyImage(params: AppStream.Types.CopyImageRequest, callback?: (err: AWSError, data: AppStream.Types.CopyImageResponse) => void): Request<AppStream.Types.CopyImageResponse, AWSError>;
- /**
- * Copies the image within the same region or to a new region within the same AWS account. Note that any tags you added to the image will not be copied.
- */
- copyImage(callback?: (err: AWSError, data: AppStream.Types.CopyImageResponse) => void): Request<AppStream.Types.CopyImageResponse, AWSError>;
- /**
- * Creates an app block. App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block. This is only supported for Elastic fleets.
- */
- createAppBlock(params: AppStream.Types.CreateAppBlockRequest, callback?: (err: AWSError, data: AppStream.Types.CreateAppBlockResult) => void): Request<AppStream.Types.CreateAppBlockResult, AWSError>;
- /**
- * Creates an app block. App blocks are an Amazon AppStream 2.0 resource that stores the details about the virtual hard disk in an S3 bucket. It also stores the setup script with details about how to mount the virtual hard disk. The virtual hard disk includes the application binaries and other files necessary to launch your applications. Multiple applications can be assigned to a single app block. This is only supported for Elastic fleets.
- */
- createAppBlock(callback?: (err: AWSError, data: AppStream.Types.CreateAppBlockResult) => void): Request<AppStream.Types.CreateAppBlockResult, AWSError>;
- /**
- * Creates an app block builder.
- */
- createAppBlockBuilder(params: AppStream.Types.CreateAppBlockBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.CreateAppBlockBuilderResult) => void): Request<AppStream.Types.CreateAppBlockBuilderResult, AWSError>;
- /**
- * Creates an app block builder.
- */
- createAppBlockBuilder(callback?: (err: AWSError, data: AppStream.Types.CreateAppBlockBuilderResult) => void): Request<AppStream.Types.CreateAppBlockBuilderResult, AWSError>;
- /**
- * Creates a URL to start a create app block builder streaming session.
- */
- createAppBlockBuilderStreamingURL(params: AppStream.Types.CreateAppBlockBuilderStreamingURLRequest, callback?: (err: AWSError, data: AppStream.Types.CreateAppBlockBuilderStreamingURLResult) => void): Request<AppStream.Types.CreateAppBlockBuilderStreamingURLResult, AWSError>;
- /**
- * Creates a URL to start a create app block builder streaming session.
- */
- createAppBlockBuilderStreamingURL(callback?: (err: AWSError, data: AppStream.Types.CreateAppBlockBuilderStreamingURLResult) => void): Request<AppStream.Types.CreateAppBlockBuilderStreamingURLResult, AWSError>;
- /**
- * Creates an application. Applications are an Amazon AppStream 2.0 resource that stores the details about how to launch applications on Elastic fleet streaming instances. An application consists of the launch details, icon, and display name. Applications are associated with an app block that contains the application binaries and other files. The applications assigned to an Elastic fleet are the applications users can launch. This is only supported for Elastic fleets.
- */
- createApplication(params: AppStream.Types.CreateApplicationRequest, callback?: (err: AWSError, data: AppStream.Types.CreateApplicationResult) => void): Request<AppStream.Types.CreateApplicationResult, AWSError>;
- /**
- * Creates an application. Applications are an Amazon AppStream 2.0 resource that stores the details about how to launch applications on Elastic fleet streaming instances. An application consists of the launch details, icon, and display name. Applications are associated with an app block that contains the application binaries and other files. The applications assigned to an Elastic fleet are the applications users can launch. This is only supported for Elastic fleets.
- */
- createApplication(callback?: (err: AWSError, data: AppStream.Types.CreateApplicationResult) => void): Request<AppStream.Types.CreateApplicationResult, AWSError>;
- /**
- * Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
- */
- createDirectoryConfig(params: AppStream.Types.CreateDirectoryConfigRequest, callback?: (err: AWSError, data: AppStream.Types.CreateDirectoryConfigResult) => void): Request<AppStream.Types.CreateDirectoryConfigResult, AWSError>;
- /**
- * Creates a Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
- */
- createDirectoryConfig(callback?: (err: AWSError, data: AppStream.Types.CreateDirectoryConfigResult) => void): Request<AppStream.Types.CreateDirectoryConfigResult, AWSError>;
- /**
- * Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.
- */
- createEntitlement(params: AppStream.Types.CreateEntitlementRequest, callback?: (err: AWSError, data: AppStream.Types.CreateEntitlementResult) => void): Request<AppStream.Types.CreateEntitlementResult, AWSError>;
- /**
- * Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.
- */
- createEntitlement(callback?: (err: AWSError, data: AppStream.Types.CreateEntitlementResult) => void): Request<AppStream.Types.CreateEntitlementResult, AWSError>;
- /**
- * Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
- */
- createFleet(params: AppStream.Types.CreateFleetRequest, callback?: (err: AWSError, data: AppStream.Types.CreateFleetResult) => void): Request<AppStream.Types.CreateFleetResult, AWSError>;
- /**
- * Creates a fleet. A fleet consists of streaming instances that your users access for their applications and desktops.
- */
- createFleet(callback?: (err: AWSError, data: AppStream.Types.CreateFleetResult) => void): Request<AppStream.Types.CreateFleetResult, AWSError>;
- /**
- * Creates an image builder. An image builder is a virtual machine that is used to create an image. The initial state of the builder is PENDING. When it is ready, the state is RUNNING.
- */
- createImageBuilder(params: AppStream.Types.CreateImageBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.CreateImageBuilderResult) => void): Request<AppStream.Types.CreateImageBuilderResult, AWSError>;
- /**
- * Creates an image builder. An image builder is a virtual machine that is used to create an image. The initial state of the builder is PENDING. When it is ready, the state is RUNNING.
- */
- createImageBuilder(callback?: (err: AWSError, data: AppStream.Types.CreateImageBuilderResult) => void): Request<AppStream.Types.CreateImageBuilderResult, AWSError>;
- /**
- * Creates a URL to start an image builder streaming session.
- */
- createImageBuilderStreamingURL(params: AppStream.Types.CreateImageBuilderStreamingURLRequest, callback?: (err: AWSError, data: AppStream.Types.CreateImageBuilderStreamingURLResult) => void): Request<AppStream.Types.CreateImageBuilderStreamingURLResult, AWSError>;
- /**
- * Creates a URL to start an image builder streaming session.
- */
- createImageBuilderStreamingURL(callback?: (err: AWSError, data: AppStream.Types.CreateImageBuilderStreamingURLResult) => void): Request<AppStream.Types.CreateImageBuilderStreamingURLResult, AWSError>;
- /**
- * Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
- */
- createStack(params: AppStream.Types.CreateStackRequest, callback?: (err: AWSError, data: AppStream.Types.CreateStackResult) => void): Request<AppStream.Types.CreateStackResult, AWSError>;
- /**
- * Creates a stack to start streaming applications to users. A stack consists of an associated fleet, user access policies, and storage configurations.
- */
- createStack(callback?: (err: AWSError, data: AppStream.Types.CreateStackResult) => void): Request<AppStream.Types.CreateStackResult, AWSError>;
- /**
- * Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.
- */
- createStreamingURL(params: AppStream.Types.CreateStreamingURLRequest, callback?: (err: AWSError, data: AppStream.Types.CreateStreamingURLResult) => void): Request<AppStream.Types.CreateStreamingURLResult, AWSError>;
- /**
- * Creates a temporary URL to start an AppStream 2.0 streaming session for the specified user. A streaming URL enables application streaming to be tested without user setup.
- */
- createStreamingURL(callback?: (err: AWSError, data: AppStream.Types.CreateStreamingURLResult) => void): Request<AppStream.Types.CreateStreamingURLResult, AWSError>;
- /**
- * Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software. For more information, see the "Update an Image by Using Managed AppStream 2.0 Image Updates" section in Administer Your AppStream 2.0 Images, in the Amazon AppStream 2.0 Administration Guide.
- */
- createUpdatedImage(params: AppStream.Types.CreateUpdatedImageRequest, callback?: (err: AWSError, data: AppStream.Types.CreateUpdatedImageResult) => void): Request<AppStream.Types.CreateUpdatedImageResult, AWSError>;
- /**
- * Creates a new image with the latest Windows operating system updates, driver updates, and AppStream 2.0 agent software. For more information, see the "Update an Image by Using Managed AppStream 2.0 Image Updates" section in Administer Your AppStream 2.0 Images, in the Amazon AppStream 2.0 Administration Guide.
- */
- createUpdatedImage(callback?: (err: AWSError, data: AppStream.Types.CreateUpdatedImageResult) => void): Request<AppStream.Types.CreateUpdatedImageResult, AWSError>;
- /**
- * Creates a usage report subscription. Usage reports are generated daily.
- */
- createUsageReportSubscription(params: AppStream.Types.CreateUsageReportSubscriptionRequest, callback?: (err: AWSError, data: AppStream.Types.CreateUsageReportSubscriptionResult) => void): Request<AppStream.Types.CreateUsageReportSubscriptionResult, AWSError>;
- /**
- * Creates a usage report subscription. Usage reports are generated daily.
- */
- createUsageReportSubscription(callback?: (err: AWSError, data: AppStream.Types.CreateUsageReportSubscriptionResult) => void): Request<AppStream.Types.CreateUsageReportSubscriptionResult, AWSError>;
- /**
- * Creates a new user in the user pool.
- */
- createUser(params: AppStream.Types.CreateUserRequest, callback?: (err: AWSError, data: AppStream.Types.CreateUserResult) => void): Request<AppStream.Types.CreateUserResult, AWSError>;
- /**
- * Creates a new user in the user pool.
- */
- createUser(callback?: (err: AWSError, data: AppStream.Types.CreateUserResult) => void): Request<AppStream.Types.CreateUserResult, AWSError>;
- /**
- * Deletes an app block.
- */
- deleteAppBlock(params: AppStream.Types.DeleteAppBlockRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteAppBlockResult) => void): Request<AppStream.Types.DeleteAppBlockResult, AWSError>;
- /**
- * Deletes an app block.
- */
- deleteAppBlock(callback?: (err: AWSError, data: AppStream.Types.DeleteAppBlockResult) => void): Request<AppStream.Types.DeleteAppBlockResult, AWSError>;
- /**
- * Deletes an app block builder. An app block builder can only be deleted when it has no association with an app block.
- */
- deleteAppBlockBuilder(params: AppStream.Types.DeleteAppBlockBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteAppBlockBuilderResult) => void): Request<AppStream.Types.DeleteAppBlockBuilderResult, AWSError>;
- /**
- * Deletes an app block builder. An app block builder can only be deleted when it has no association with an app block.
- */
- deleteAppBlockBuilder(callback?: (err: AWSError, data: AppStream.Types.DeleteAppBlockBuilderResult) => void): Request<AppStream.Types.DeleteAppBlockBuilderResult, AWSError>;
- /**
- * Deletes an application.
- */
- deleteApplication(params: AppStream.Types.DeleteApplicationRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteApplicationResult) => void): Request<AppStream.Types.DeleteApplicationResult, AWSError>;
- /**
- * Deletes an application.
- */
- deleteApplication(callback?: (err: AWSError, data: AppStream.Types.DeleteApplicationResult) => void): Request<AppStream.Types.DeleteApplicationResult, AWSError>;
- /**
- * Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.
- */
- deleteDirectoryConfig(params: AppStream.Types.DeleteDirectoryConfigRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteDirectoryConfigResult) => void): Request<AppStream.Types.DeleteDirectoryConfigResult, AWSError>;
- /**
- * Deletes the specified Directory Config object from AppStream 2.0. This object includes the information required to join streaming instances to an Active Directory domain.
- */
- deleteDirectoryConfig(callback?: (err: AWSError, data: AppStream.Types.DeleteDirectoryConfigResult) => void): Request<AppStream.Types.DeleteDirectoryConfigResult, AWSError>;
- /**
- * Deletes the specified entitlement.
- */
- deleteEntitlement(params: AppStream.Types.DeleteEntitlementRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteEntitlementResult) => void): Request<AppStream.Types.DeleteEntitlementResult, AWSError>;
- /**
- * Deletes the specified entitlement.
- */
- deleteEntitlement(callback?: (err: AWSError, data: AppStream.Types.DeleteEntitlementResult) => void): Request<AppStream.Types.DeleteEntitlementResult, AWSError>;
- /**
- * Deletes the specified fleet.
- */
- deleteFleet(params: AppStream.Types.DeleteFleetRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteFleetResult) => void): Request<AppStream.Types.DeleteFleetResult, AWSError>;
- /**
- * Deletes the specified fleet.
- */
- deleteFleet(callback?: (err: AWSError, data: AppStream.Types.DeleteFleetResult) => void): Request<AppStream.Types.DeleteFleetResult, AWSError>;
- /**
- * Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.
- */
- deleteImage(params: AppStream.Types.DeleteImageRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteImageResult) => void): Request<AppStream.Types.DeleteImageResult, AWSError>;
- /**
- * Deletes the specified image. You cannot delete an image when it is in use. After you delete an image, you cannot provision new capacity using the image.
- */
- deleteImage(callback?: (err: AWSError, data: AppStream.Types.DeleteImageResult) => void): Request<AppStream.Types.DeleteImageResult, AWSError>;
- /**
- * Deletes the specified image builder and releases the capacity.
- */
- deleteImageBuilder(params: AppStream.Types.DeleteImageBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteImageBuilderResult) => void): Request<AppStream.Types.DeleteImageBuilderResult, AWSError>;
- /**
- * Deletes the specified image builder and releases the capacity.
- */
- deleteImageBuilder(callback?: (err: AWSError, data: AppStream.Types.DeleteImageBuilderResult) => void): Request<AppStream.Types.DeleteImageBuilderResult, AWSError>;
- /**
- * Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.
- */
- deleteImagePermissions(params: AppStream.Types.DeleteImagePermissionsRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteImagePermissionsResult) => void): Request<AppStream.Types.DeleteImagePermissionsResult, AWSError>;
- /**
- * Deletes permissions for the specified private image. After you delete permissions for an image, AWS accounts to which you previously granted these permissions can no longer use the image.
- */
- deleteImagePermissions(callback?: (err: AWSError, data: AppStream.Types.DeleteImagePermissionsResult) => void): Request<AppStream.Types.DeleteImagePermissionsResult, AWSError>;
- /**
- * Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.
- */
- deleteStack(params: AppStream.Types.DeleteStackRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteStackResult) => void): Request<AppStream.Types.DeleteStackResult, AWSError>;
- /**
- * Deletes the specified stack. After the stack is deleted, the application streaming environment provided by the stack is no longer available to users. Also, any reservations made for application streaming sessions for the stack are released.
- */
- deleteStack(callback?: (err: AWSError, data: AppStream.Types.DeleteStackResult) => void): Request<AppStream.Types.DeleteStackResult, AWSError>;
- /**
- * Disables usage report generation.
- */
- deleteUsageReportSubscription(params: AppStream.Types.DeleteUsageReportSubscriptionRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteUsageReportSubscriptionResult) => void): Request<AppStream.Types.DeleteUsageReportSubscriptionResult, AWSError>;
- /**
- * Disables usage report generation.
- */
- deleteUsageReportSubscription(callback?: (err: AWSError, data: AppStream.Types.DeleteUsageReportSubscriptionResult) => void): Request<AppStream.Types.DeleteUsageReportSubscriptionResult, AWSError>;
- /**
- * Deletes a user from the user pool.
- */
- deleteUser(params: AppStream.Types.DeleteUserRequest, callback?: (err: AWSError, data: AppStream.Types.DeleteUserResult) => void): Request<AppStream.Types.DeleteUserResult, AWSError>;
- /**
- * Deletes a user from the user pool.
- */
- deleteUser(callback?: (err: AWSError, data: AppStream.Types.DeleteUserResult) => void): Request<AppStream.Types.DeleteUserResult, AWSError>;
- /**
- * Retrieves a list that describes one or more app block builder associations.
- */
- describeAppBlockBuilderAppBlockAssociations(params: AppStream.Types.DescribeAppBlockBuilderAppBlockAssociationsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeAppBlockBuilderAppBlockAssociationsResult) => void): Request<AppStream.Types.DescribeAppBlockBuilderAppBlockAssociationsResult, AWSError>;
- /**
- * Retrieves a list that describes one or more app block builder associations.
- */
- describeAppBlockBuilderAppBlockAssociations(callback?: (err: AWSError, data: AppStream.Types.DescribeAppBlockBuilderAppBlockAssociationsResult) => void): Request<AppStream.Types.DescribeAppBlockBuilderAppBlockAssociationsResult, AWSError>;
- /**
- * Retrieves a list that describes one or more app block builders.
- */
- describeAppBlockBuilders(params: AppStream.Types.DescribeAppBlockBuildersRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeAppBlockBuildersResult) => void): Request<AppStream.Types.DescribeAppBlockBuildersResult, AWSError>;
- /**
- * Retrieves a list that describes one or more app block builders.
- */
- describeAppBlockBuilders(callback?: (err: AWSError, data: AppStream.Types.DescribeAppBlockBuildersResult) => void): Request<AppStream.Types.DescribeAppBlockBuildersResult, AWSError>;
- /**
- * Retrieves a list that describes one or more app blocks.
- */
- describeAppBlocks(params: AppStream.Types.DescribeAppBlocksRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeAppBlocksResult) => void): Request<AppStream.Types.DescribeAppBlocksResult, AWSError>;
- /**
- * Retrieves a list that describes one or more app blocks.
- */
- describeAppBlocks(callback?: (err: AWSError, data: AppStream.Types.DescribeAppBlocksResult) => void): Request<AppStream.Types.DescribeAppBlocksResult, AWSError>;
- /**
- * Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
- */
- describeApplicationFleetAssociations(params: AppStream.Types.DescribeApplicationFleetAssociationsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeApplicationFleetAssociationsResult) => void): Request<AppStream.Types.DescribeApplicationFleetAssociationsResult, AWSError>;
- /**
- * Retrieves a list that describes one or more application fleet associations. Either ApplicationArn or FleetName must be specified.
- */
- describeApplicationFleetAssociations(callback?: (err: AWSError, data: AppStream.Types.DescribeApplicationFleetAssociationsResult) => void): Request<AppStream.Types.DescribeApplicationFleetAssociationsResult, AWSError>;
- /**
- * Retrieves a list that describes one or more applications.
- */
- describeApplications(params: AppStream.Types.DescribeApplicationsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeApplicationsResult) => void): Request<AppStream.Types.DescribeApplicationsResult, AWSError>;
- /**
- * Retrieves a list that describes one or more applications.
- */
- describeApplications(callback?: (err: AWSError, data: AppStream.Types.DescribeApplicationsResult) => void): Request<AppStream.Types.DescribeApplicationsResult, AWSError>;
- /**
- * Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. Although the response syntax in this topic includes the account password, this password is not returned in the actual response.
- */
- describeDirectoryConfigs(params: AppStream.Types.DescribeDirectoryConfigsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeDirectoryConfigsResult) => void): Request<AppStream.Types.DescribeDirectoryConfigsResult, AWSError>;
- /**
- * Retrieves a list that describes one or more specified Directory Config objects for AppStream 2.0, if the names for these objects are provided. Otherwise, all Directory Config objects in the account are described. These objects include the configuration information required to join fleets and image builders to Microsoft Active Directory domains. Although the response syntax in this topic includes the account password, this password is not returned in the actual response.
- */
- describeDirectoryConfigs(callback?: (err: AWSError, data: AppStream.Types.DescribeDirectoryConfigsResult) => void): Request<AppStream.Types.DescribeDirectoryConfigsResult, AWSError>;
- /**
- * Retrieves a list that describes one of more entitlements.
- */
- describeEntitlements(params: AppStream.Types.DescribeEntitlementsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeEntitlementsResult) => void): Request<AppStream.Types.DescribeEntitlementsResult, AWSError>;
- /**
- * Retrieves a list that describes one of more entitlements.
- */
- describeEntitlements(callback?: (err: AWSError, data: AppStream.Types.DescribeEntitlementsResult) => void): Request<AppStream.Types.DescribeEntitlementsResult, AWSError>;
- /**
- * Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
- */
- describeFleets(params: AppStream.Types.DescribeFleetsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request<AppStream.Types.DescribeFleetsResult, AWSError>;
- /**
- * Retrieves a list that describes one or more specified fleets, if the fleet names are provided. Otherwise, all fleets in the account are described.
- */
- describeFleets(callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request<AppStream.Types.DescribeFleetsResult, AWSError>;
- /**
- * Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.
- */
- describeImageBuilders(params: AppStream.Types.DescribeImageBuildersRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeImageBuildersResult) => void): Request<AppStream.Types.DescribeImageBuildersResult, AWSError>;
- /**
- * Retrieves a list that describes one or more specified image builders, if the image builder names are provided. Otherwise, all image builders in the account are described.
- */
- describeImageBuilders(callback?: (err: AWSError, data: AppStream.Types.DescribeImageBuildersResult) => void): Request<AppStream.Types.DescribeImageBuildersResult, AWSError>;
- /**
- * Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
- */
- describeImagePermissions(params: AppStream.Types.DescribeImagePermissionsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeImagePermissionsResult) => void): Request<AppStream.Types.DescribeImagePermissionsResult, AWSError>;
- /**
- * Retrieves a list that describes the permissions for shared AWS account IDs on a private image that you own.
- */
- describeImagePermissions(callback?: (err: AWSError, data: AppStream.Types.DescribeImagePermissionsResult) => void): Request<AppStream.Types.DescribeImagePermissionsResult, AWSError>;
- /**
- * Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.
- */
- describeImages(params: AppStream.Types.DescribeImagesRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeImagesResult) => void): Request<AppStream.Types.DescribeImagesResult, AWSError>;
- /**
- * Retrieves a list that describes one or more specified images, if the image names or image ARNs are provided. Otherwise, all images in the account are described.
- */
- describeImages(callback?: (err: AWSError, data: AppStream.Types.DescribeImagesResult) => void): Request<AppStream.Types.DescribeImagesResult, AWSError>;
- /**
- * Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.
- */
- describeSessions(params: AppStream.Types.DescribeSessionsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeSessionsResult) => void): Request<AppStream.Types.DescribeSessionsResult, AWSError>;
- /**
- * Retrieves a list that describes the streaming sessions for a specified stack and fleet. If a UserId is provided for the stack and fleet, only streaming sessions for that user are described. If an authentication type is not provided, the default is to authenticate users using a streaming URL.
- */
- describeSessions(callback?: (err: AWSError, data: AppStream.Types.DescribeSessionsResult) => void): Request<AppStream.Types.DescribeSessionsResult, AWSError>;
- /**
- * Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
- */
- describeStacks(params: AppStream.Types.DescribeStacksRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeStacksResult) => void): Request<AppStream.Types.DescribeStacksResult, AWSError>;
- /**
- * Retrieves a list that describes one or more specified stacks, if the stack names are provided. Otherwise, all stacks in the account are described.
- */
- describeStacks(callback?: (err: AWSError, data: AppStream.Types.DescribeStacksResult) => void): Request<AppStream.Types.DescribeStacksResult, AWSError>;
- /**
- * Retrieves a list that describes one or more usage report subscriptions.
- */
- describeUsageReportSubscriptions(params: AppStream.Types.DescribeUsageReportSubscriptionsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeUsageReportSubscriptionsResult) => void): Request<AppStream.Types.DescribeUsageReportSubscriptionsResult, AWSError>;
- /**
- * Retrieves a list that describes one or more usage report subscriptions.
- */
- describeUsageReportSubscriptions(callback?: (err: AWSError, data: AppStream.Types.DescribeUsageReportSubscriptionsResult) => void): Request<AppStream.Types.DescribeUsageReportSubscriptionsResult, AWSError>;
- /**
- * Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following: The stack name The user name (email address of the user associated with the stack) and the authentication type for the user
- */
- describeUserStackAssociations(params: AppStream.Types.DescribeUserStackAssociationsRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeUserStackAssociationsResult) => void): Request<AppStream.Types.DescribeUserStackAssociationsResult, AWSError>;
- /**
- * Retrieves a list that describes the UserStackAssociation objects. You must specify either or both of the following: The stack name The user name (email address of the user associated with the stack) and the authentication type for the user
- */
- describeUserStackAssociations(callback?: (err: AWSError, data: AppStream.Types.DescribeUserStackAssociationsResult) => void): Request<AppStream.Types.DescribeUserStackAssociationsResult, AWSError>;
- /**
- * Retrieves a list that describes one or more specified users in the user pool.
- */
- describeUsers(params: AppStream.Types.DescribeUsersRequest, callback?: (err: AWSError, data: AppStream.Types.DescribeUsersResult) => void): Request<AppStream.Types.DescribeUsersResult, AWSError>;
- /**
- * Retrieves a list that describes one or more specified users in the user pool.
- */
- describeUsers(callback?: (err: AWSError, data: AppStream.Types.DescribeUsersResult) => void): Request<AppStream.Types.DescribeUsersResult, AWSError>;
- /**
- * Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.
- */
- disableUser(params: AppStream.Types.DisableUserRequest, callback?: (err: AWSError, data: AppStream.Types.DisableUserResult) => void): Request<AppStream.Types.DisableUserResult, AWSError>;
- /**
- * Disables the specified user in the user pool. Users can't sign in to AppStream 2.0 until they are re-enabled. This action does not delete the user.
- */
- disableUser(callback?: (err: AWSError, data: AppStream.Types.DisableUserResult) => void): Request<AppStream.Types.DisableUserResult, AWSError>;
- /**
- * Disassociates a specified app block builder from a specified app block.
- */
- disassociateAppBlockBuilderAppBlock(params: AppStream.Types.DisassociateAppBlockBuilderAppBlockRequest, callback?: (err: AWSError, data: AppStream.Types.DisassociateAppBlockBuilderAppBlockResult) => void): Request<AppStream.Types.DisassociateAppBlockBuilderAppBlockResult, AWSError>;
- /**
- * Disassociates a specified app block builder from a specified app block.
- */
- disassociateAppBlockBuilderAppBlock(callback?: (err: AWSError, data: AppStream.Types.DisassociateAppBlockBuilderAppBlockResult) => void): Request<AppStream.Types.DisassociateAppBlockBuilderAppBlockResult, AWSError>;
- /**
- * Disassociates the specified application from the fleet.
- */
- disassociateApplicationFleet(params: AppStream.Types.DisassociateApplicationFleetRequest, callback?: (err: AWSError, data: AppStream.Types.DisassociateApplicationFleetResult) => void): Request<AppStream.Types.DisassociateApplicationFleetResult, AWSError>;
- /**
- * Disassociates the specified application from the fleet.
- */
- disassociateApplicationFleet(callback?: (err: AWSError, data: AppStream.Types.DisassociateApplicationFleetResult) => void): Request<AppStream.Types.DisassociateApplicationFleetResult, AWSError>;
- /**
- * Deletes the specified application from the specified entitlement.
- */
- disassociateApplicationFromEntitlement(params: AppStream.Types.DisassociateApplicationFromEntitlementRequest, callback?: (err: AWSError, data: AppStream.Types.DisassociateApplicationFromEntitlementResult) => void): Request<AppStream.Types.DisassociateApplicationFromEntitlementResult, AWSError>;
- /**
- * Deletes the specified application from the specified entitlement.
- */
- disassociateApplicationFromEntitlement(callback?: (err: AWSError, data: AppStream.Types.DisassociateApplicationFromEntitlementResult) => void): Request<AppStream.Types.DisassociateApplicationFromEntitlementResult, AWSError>;
- /**
- * Disassociates the specified fleet from the specified stack.
- */
- disassociateFleet(params: AppStream.Types.DisassociateFleetRequest, callback?: (err: AWSError, data: AppStream.Types.DisassociateFleetResult) => void): Request<AppStream.Types.DisassociateFleetResult, AWSError>;
- /**
- * Disassociates the specified fleet from the specified stack.
- */
- disassociateFleet(callback?: (err: AWSError, data: AppStream.Types.DisassociateFleetResult) => void): Request<AppStream.Types.DisassociateFleetResult, AWSError>;
- /**
- * Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.
- */
- enableUser(params: AppStream.Types.EnableUserRequest, callback?: (err: AWSError, data: AppStream.Types.EnableUserResult) => void): Request<AppStream.Types.EnableUserResult, AWSError>;
- /**
- * Enables a user in the user pool. After being enabled, users can sign in to AppStream 2.0 and open applications from the stacks to which they are assigned.
- */
- enableUser(callback?: (err: AWSError, data: AppStream.Types.EnableUserResult) => void): Request<AppStream.Types.EnableUserResult, AWSError>;
- /**
- * Immediately stops the specified streaming session.
- */
- expireSession(params: AppStream.Types.ExpireSessionRequest, callback?: (err: AWSError, data: AppStream.Types.ExpireSessionResult) => void): Request<AppStream.Types.ExpireSessionResult, AWSError>;
- /**
- * Immediately stops the specified streaming session.
- */
- expireSession(callback?: (err: AWSError, data: AppStream.Types.ExpireSessionResult) => void): Request<AppStream.Types.ExpireSessionResult, AWSError>;
- /**
- * Retrieves the name of the fleet that is associated with the specified stack.
- */
- listAssociatedFleets(params: AppStream.Types.ListAssociatedFleetsRequest, callback?: (err: AWSError, data: AppStream.Types.ListAssociatedFleetsResult) => void): Request<AppStream.Types.ListAssociatedFleetsResult, AWSError>;
- /**
- * Retrieves the name of the fleet that is associated with the specified stack.
- */
- listAssociatedFleets(callback?: (err: AWSError, data: AppStream.Types.ListAssociatedFleetsResult) => void): Request<AppStream.Types.ListAssociatedFleetsResult, AWSError>;
- /**
- * Retrieves the name of the stack with which the specified fleet is associated.
- */
- listAssociatedStacks(params: AppStream.Types.ListAssociatedStacksRequest, callback?: (err: AWSError, data: AppStream.Types.ListAssociatedStacksResult) => void): Request<AppStream.Types.ListAssociatedStacksResult, AWSError>;
- /**
- * Retrieves the name of the stack with which the specified fleet is associated.
- */
- listAssociatedStacks(callback?: (err: AWSError, data: AppStream.Types.ListAssociatedStacksResult) => void): Request<AppStream.Types.ListAssociatedStacksResult, AWSError>;
- /**
- * Retrieves a list of entitled applications.
- */
- listEntitledApplications(params: AppStream.Types.ListEntitledApplicationsRequest, callback?: (err: AWSError, data: AppStream.Types.ListEntitledApplicationsResult) => void): Request<AppStream.Types.ListEntitledApplicationsResult, AWSError>;
- /**
- * Retrieves a list of entitled applications.
- */
- listEntitledApplications(callback?: (err: AWSError, data: AppStream.Types.ListEntitledApplicationsResult) => void): Request<AppStream.Types.ListEntitledApplicationsResult, AWSError>;
- /**
- * Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
- */
- listTagsForResource(params: AppStream.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: AppStream.Types.ListTagsForResourceResponse) => void): Request<AppStream.Types.ListTagsForResourceResponse, AWSError>;
- /**
- * Retrieves a list of all tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
- */
- listTagsForResource(callback?: (err: AWSError, data: AppStream.Types.ListTagsForResourceResponse) => void): Request<AppStream.Types.ListTagsForResourceResponse, AWSError>;
- /**
- * Starts an app block builder. An app block builder can only be started when it's associated with an app block. Starting an app block builder starts a new instance, which is equivalent to an elastic fleet instance with application builder assistance functionality.
- */
- startAppBlockBuilder(params: AppStream.Types.StartAppBlockBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.StartAppBlockBuilderResult) => void): Request<AppStream.Types.StartAppBlockBuilderResult, AWSError>;
- /**
- * Starts an app block builder. An app block builder can only be started when it's associated with an app block. Starting an app block builder starts a new instance, which is equivalent to an elastic fleet instance with application builder assistance functionality.
- */
- startAppBlockBuilder(callback?: (err: AWSError, data: AppStream.Types.StartAppBlockBuilderResult) => void): Request<AppStream.Types.StartAppBlockBuilderResult, AWSError>;
- /**
- * Starts the specified fleet.
- */
- startFleet(params: AppStream.Types.StartFleetRequest, callback?: (err: AWSError, data: AppStream.Types.StartFleetResult) => void): Request<AppStream.Types.StartFleetResult, AWSError>;
- /**
- * Starts the specified fleet.
- */
- startFleet(callback?: (err: AWSError, data: AppStream.Types.StartFleetResult) => void): Request<AppStream.Types.StartFleetResult, AWSError>;
- /**
- * Starts the specified image builder.
- */
- startImageBuilder(params: AppStream.Types.StartImageBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.StartImageBuilderResult) => void): Request<AppStream.Types.StartImageBuilderResult, AWSError>;
- /**
- * Starts the specified image builder.
- */
- startImageBuilder(callback?: (err: AWSError, data: AppStream.Types.StartImageBuilderResult) => void): Request<AppStream.Types.StartImageBuilderResult, AWSError>;
- /**
- * Stops an app block builder. Stopping an app block builder terminates the instance, and the instance state is not persisted.
- */
- stopAppBlockBuilder(params: AppStream.Types.StopAppBlockBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.StopAppBlockBuilderResult) => void): Request<AppStream.Types.StopAppBlockBuilderResult, AWSError>;
- /**
- * Stops an app block builder. Stopping an app block builder terminates the instance, and the instance state is not persisted.
- */
- stopAppBlockBuilder(callback?: (err: AWSError, data: AppStream.Types.StopAppBlockBuilderResult) => void): Request<AppStream.Types.StopAppBlockBuilderResult, AWSError>;
- /**
- * Stops the specified fleet.
- */
- stopFleet(params: AppStream.Types.StopFleetRequest, callback?: (err: AWSError, data: AppStream.Types.StopFleetResult) => void): Request<AppStream.Types.StopFleetResult, AWSError>;
- /**
- * Stops the specified fleet.
- */
- stopFleet(callback?: (err: AWSError, data: AppStream.Types.StopFleetResult) => void): Request<AppStream.Types.StopFleetResult, AWSError>;
- /**
- * Stops the specified image builder.
- */
- stopImageBuilder(params: AppStream.Types.StopImageBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.StopImageBuilderResult) => void): Request<AppStream.Types.StopImageBuilderResult, AWSError>;
- /**
- * Stops the specified image builder.
- */
- stopImageBuilder(callback?: (err: AWSError, data: AppStream.Types.StopImageBuilderResult) => void): Request<AppStream.Types.StopImageBuilderResult, AWSError>;
- /**
- * Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value. To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
- */
- tagResource(params: AppStream.Types.TagResourceRequest, callback?: (err: AWSError, data: AppStream.Types.TagResourceResponse) => void): Request<AppStream.Types.TagResourceResponse, AWSError>;
- /**
- * Adds or overwrites one or more tags for the specified AppStream 2.0 resource. You can tag AppStream 2.0 image builders, images, fleets, and stacks. Each tag consists of a key and an optional value. If a resource already has a tag with the same key, this operation updates its value. To list the current tags for your resources, use ListTagsForResource. To disassociate tags from your resources, use UntagResource. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
- */
- tagResource(callback?: (err: AWSError, data: AppStream.Types.TagResourceResponse) => void): Request<AppStream.Types.TagResourceResponse, AWSError>;
- /**
- * Disassociates one or more specified tags from the specified AppStream 2.0 resource. To list the current tags for your resources, use ListTagsForResource. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
- */
- untagResource(params: AppStream.Types.UntagResourceRequest, callback?: (err: AWSError, data: AppStream.Types.UntagResourceResponse) => void): Request<AppStream.Types.UntagResourceResponse, AWSError>;
- /**
- * Disassociates one or more specified tags from the specified AppStream 2.0 resource. To list the current tags for your resources, use ListTagsForResource. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
- */
- untagResource(callback?: (err: AWSError, data: AppStream.Types.UntagResourceResponse) => void): Request<AppStream.Types.UntagResourceResponse, AWSError>;
- /**
- * Updates an app block builder. If the app block builder is in the STARTING or STOPPING state, you can't update it. If the app block builder is in the RUNNING state, you can only update the DisplayName and Description. If the app block builder is in the STOPPED state, you can update any attribute except the Name.
- */
- updateAppBlockBuilder(params: AppStream.Types.UpdateAppBlockBuilderRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateAppBlockBuilderResult) => void): Request<AppStream.Types.UpdateAppBlockBuilderResult, AWSError>;
- /**
- * Updates an app block builder. If the app block builder is in the STARTING or STOPPING state, you can't update it. If the app block builder is in the RUNNING state, you can only update the DisplayName and Description. If the app block builder is in the STOPPED state, you can update any attribute except the Name.
- */
- updateAppBlockBuilder(callback?: (err: AWSError, data: AppStream.Types.UpdateAppBlockBuilderResult) => void): Request<AppStream.Types.UpdateAppBlockBuilderResult, AWSError>;
- /**
- * Updates the specified application.
- */
- updateApplication(params: AppStream.Types.UpdateApplicationRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateApplicationResult) => void): Request<AppStream.Types.UpdateApplicationResult, AWSError>;
- /**
- * Updates the specified application.
- */
- updateApplication(callback?: (err: AWSError, data: AppStream.Types.UpdateApplicationResult) => void): Request<AppStream.Types.UpdateApplicationResult, AWSError>;
- /**
- * Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
- */
- updateDirectoryConfig(params: AppStream.Types.UpdateDirectoryConfigRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateDirectoryConfigResult) => void): Request<AppStream.Types.UpdateDirectoryConfigResult, AWSError>;
- /**
- * Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.
- */
- updateDirectoryConfig(callback?: (err: AWSError, data: AppStream.Types.UpdateDirectoryConfigResult) => void): Request<AppStream.Types.UpdateDirectoryConfigResult, AWSError>;
- /**
- * Updates the specified entitlement.
- */
- updateEntitlement(params: AppStream.Types.UpdateEntitlementRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateEntitlementResult) => void): Request<AppStream.Types.UpdateEntitlementResult, AWSError>;
- /**
- * Updates the specified entitlement.
- */
- updateEntitlement(callback?: (err: AWSError, data: AppStream.Types.UpdateEntitlementResult) => void): Request<AppStream.Types.UpdateEntitlementResult, AWSError>;
- /**
- * Updates the specified fleet. If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the following based on the fleet type: Always-On and On-Demand fleet types You can update the DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes. Elastic fleet type You can update the DisplayName, IdleDisconnectTimeoutInSeconds, DisconnectTimeoutInSeconds, MaxConcurrentSessions, SessionScriptS3Location and UsbDeviceFilterStrings attributes. If the fleet is in the STARTING or STOPPED state, you can't update it.
- */
- updateFleet(params: AppStream.Types.UpdateFleetRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateFleetResult) => void): Request<AppStream.Types.UpdateFleetResult, AWSError>;
- /**
- * Updates the specified fleet. If the fleet is in the STOPPED state, you can update any attribute except the fleet name. If the fleet is in the RUNNING state, you can update the following based on the fleet type: Always-On and On-Demand fleet types You can update the DisplayName, ComputeCapacity, ImageARN, ImageName, IdleDisconnectTimeoutInSeconds, and DisconnectTimeoutInSeconds attributes. Elastic fleet type You can update the DisplayName, IdleDisconnectTimeoutInSeconds, DisconnectTimeoutInSeconds, MaxConcurrentSessions, SessionScriptS3Location and UsbDeviceFilterStrings attributes. If the fleet is in the STARTING or STOPPED state, you can't update it.
- */
- updateFleet(callback?: (err: AWSError, data: AppStream.Types.UpdateFleetResult) => void): Request<AppStream.Types.UpdateFleetResult, AWSError>;
- /**
- * Adds or updates permissions for the specified private image.
- */
- updateImagePermissions(params: AppStream.Types.UpdateImagePermissionsRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateImagePermissionsResult) => void): Request<AppStream.Types.UpdateImagePermissionsResult, AWSError>;
- /**
- * Adds or updates permissions for the specified private image.
- */
- updateImagePermissions(callback?: (err: AWSError, data: AppStream.Types.UpdateImagePermissionsResult) => void): Request<AppStream.Types.UpdateImagePermissionsResult, AWSError>;
- /**
- * Updates the specified fields for the specified stack.
- */
- updateStack(params: AppStream.Types.UpdateStackRequest, callback?: (err: AWSError, data: AppStream.Types.UpdateStackResult) => void): Request<AppStream.Types.UpdateStackResult, AWSError>;
- /**
- * Updates the specified fields for the specified stack.
- */
- updateStack(callback?: (err: AWSError, data: AppStream.Types.UpdateStackResult) => void): Request<AppStream.Types.UpdateStackResult, AWSError>;
- /**
- * Waits for the fleetStarted state by periodically calling the underlying AppStream.describeFleetsoperation every 30 seconds (at most 40 times).
- */
- waitFor(state: "fleetStarted", params: AppStream.Types.DescribeFleetsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request<AppStream.Types.DescribeFleetsResult, AWSError>;
- /**
- * Waits for the fleetStarted state by periodically calling the underlying AppStream.describeFleetsoperation every 30 seconds (at most 40 times).
- */
- waitFor(state: "fleetStarted", callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request<AppStream.Types.DescribeFleetsResult, AWSError>;
- /**
- * Waits for the fleetStopped state by periodically calling the underlying AppStream.describeFleetsoperation every 30 seconds (at most 40 times).
- */
- waitFor(state: "fleetStopped", params: AppStream.Types.DescribeFleetsRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request<AppStream.Types.DescribeFleetsResult, AWSError>;
- /**
- * Waits for the fleetStopped state by periodically calling the underlying AppStream.describeFleetsoperation every 30 seconds (at most 40 times).
- */
- waitFor(state: "fleetStopped", callback?: (err: AWSError, data: AppStream.Types.DescribeFleetsResult) => void): Request<AppStream.Types.DescribeFleetsResult, AWSError>;
- }
- declare namespace AppStream {
- export interface AccessEndpoint {
- /**
- * The type of interface endpoint.
- */
- EndpointType: AccessEndpointType;
- /**
- * The identifier (ID) of the VPC in which the interface endpoint is used.
- */
- VpceId?: String;
- }
- export type AccessEndpointList = AccessEndpoint[];
- export type AccessEndpointType = "STREAMING"|string;
- export type AccountName = string;
- export type AccountPassword = string;
- export type Action = "CLIPBOARD_COPY_FROM_LOCAL_DEVICE"|"CLIPBOARD_COPY_TO_LOCAL_DEVICE"|"FILE_UPLOAD"|"FILE_DOWNLOAD"|"PRINTING_TO_LOCAL_DEVICE"|"DOMAIN_PASSWORD_SIGNIN"|"DOMAIN_SMART_CARD_SIGNIN"|string;
- export interface AppBlock {
- /**
- * The name of the app block.
- */
- Name: String;
- /**
- * The ARN of the app block.
- */
- Arn: Arn;
- /**
- * The description of the app block.
- */
- Description?: String;
- /**
- * The display name of the app block.
- */
- DisplayName?: String;
- /**
- * The source S3 location of the app block.
- */
- SourceS3Location?: S3Location;
- /**
- * The setup script details of the app block. This only applies to app blocks with PackagingType CUSTOM.
- */
- SetupScriptDetails?: ScriptDetails;
- /**
- * The created time of the app block.
- */
- CreatedTime?: Timestamp;
- /**
- * The post setup script details of the app block. This only applies to app blocks with PackagingType APPSTREAM2.
- */
- PostSetupScriptDetails?: ScriptDetails;
- /**
- * The packaging type of the app block.
- */
- PackagingType?: PackagingType;
- /**
- * The state of the app block. An app block with AppStream 2.0 packaging will be in the INACTIVE state if no application package (VHD) is assigned to it. After an application package (VHD) is created by an app block builder for an app block, it becomes ACTIVE. Custom app blocks are always in the ACTIVE state and no action is required to use them.
- */
- State?: AppBlockState;
- /**
- * The errors of the app block.
- */
- AppBlockErrors?: ErrorDetailsList;
- }
- export interface AppBlockBuilder {
- /**
- * The ARN of the app block builder.
- */
- Arn: Arn;
- /**
- * The name of the app block builder.
- */
- Name: String;
- /**
- * The display name of the app block builder.
- */
- DisplayName?: String;
- /**
- * The description of the app block builder.
- */
- Description?: String;
- /**
- * The platform of the app block builder. WINDOWS_SERVER_2019 is the only valid value.
- */
- Platform: AppBlockBuilderPlatformType;
- /**
- * The instance type of the app block builder.
- */
- InstanceType: String;
- /**
- * Indicates whether default internet access is enabled for the app block builder.
- */
- EnableDefaultInternetAccess?: BooleanObject;
- /**
- * The ARN of the IAM role that is applied to the app block builder.
- */
- IamRoleArn?: Arn;
- /**
- * The VPC configuration for the app block builder.
- */
- VpcConfig: VpcConfig;
- /**
- * The state of the app block builder.
- */
- State: AppBlockBuilderState;
- /**
- * The creation time of the app block builder.
- */
- CreatedTime?: Timestamp;
- /**
- * The app block builder errors.
- */
- AppBlockBuilderErrors?: ResourceErrors;
- /**
- * The state change reason.
- */
- StateChangeReason?: AppBlockBuilderStateChangeReason;
- /**
- * The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
- */
- AccessEndpoints?: AccessEndpointList;
- }
- export interface AppBlockBuilderAppBlockAssociation {
- /**
- * The ARN of the app block.
- */
- AppBlockArn: Arn;
- /**
- * The name of the app block builder.
- */
- AppBlockBuilderName: Name;
- }
- export type AppBlockBuilderAppBlockAssociationsList = AppBlockBuilderAppBlockAssociation[];
- export type AppBlockBuilderAttribute = "IAM_ROLE_ARN"|"ACCESS_ENDPOINTS"|"VPC_CONFIGURATION_SECURITY_GROUP_IDS"|string;
- export type AppBlockBuilderAttributes = AppBlockBuilderAttribute[];
- export type AppBlockBuilderList = AppBlockBuilder[];
- export type AppBlockBuilderPlatformType = "WINDOWS_SERVER_2019"|string;
- export type AppBlockBuilderState = "STARTING"|"RUNNING"|"STOPPING"|"STOPPED"|string;
- export interface AppBlockBuilderStateChangeReason {
- /**
- * The state change reason code.
- */
- Code?: AppBlockBuilderStateChangeReasonCode;
- /**
- * The state change reason message.
- */
- Message?: String;
- }
- export type AppBlockBuilderStateChangeReasonCode = "INTERNAL_ERROR"|string;
- export type AppBlockState = "INACTIVE"|"ACTIVE"|string;
- export type AppBlocks = AppBlock[];
- export type AppVisibility = "ALL"|"ASSOCIATED"|string;
- export interface Application {
- /**
- * The name of the application.
- */
- Name?: String;
- /**
- * The application name to display.
- */
- DisplayName?: String;
- /**
- * The URL for the application icon. This URL might be time-limited.
- */
- IconURL?: String;
- /**
- * The path to the application executable in the instance.
- */
- LaunchPath?: String;
- /**
- * The arguments that are passed to the application at launch.
- */
- LaunchParameters?: String;
- /**
- * If there is a problem, the application can be disabled after image creation.
- */
- Enabled?: Boolean;
- /**
- * Additional attributes that describe the application.
- */
- Metadata?: Metadata;
- /**
- * The working directory for the application.
- */
- WorkingDirectory?: String;
- /**
- * The description of the application.
- */
- Description?: String;
- /**
- * The ARN of the application.
- */
- Arn?: Arn;
- /**
- * The app block ARN of the application.
- */
- AppBlockArn?: Arn;
- /**
- * The S3 location of the application icon.
- */
- IconS3Location?: S3Location;
- /**
- * The platforms on which the application can run.
- */
- Platforms?: Platforms;
- /**
- * The instance families for the application.
- */
- InstanceFamilies?: StringList;
- /**
- * The time at which the application was created within the app block.
- */
- CreatedTime?: Timestamp;
- }
- export type ApplicationAttribute = "LAUNCH_PARAMETERS"|"WORKING_DIRECTORY"|string;
- export type ApplicationAttributes = ApplicationAttribute[];
- export interface ApplicationFleetAssociation {
- /**
- * The name of the fleet associated with the application.
- */
- FleetName: String;
- /**
- * The ARN of the application associated with the fleet.
- */
- ApplicationArn: Arn;
- }
- export type ApplicationFleetAssociationList = ApplicationFleetAssociation[];
- export interface ApplicationSettings {
- /**
- * Enables or disables persistent application settings for users during their streaming sessions.
- */
- Enabled: Boolean;
- /**
- * The path prefix for the S3 bucket where users’ persistent application settings are stored. You can allow the same persistent application settings to be used across multiple stacks by specifying the same settings group for each stack.
- */
- SettingsGroup?: SettingsGroup;
- }
- export interface ApplicationSettingsResponse {
- /**
- * Specifies whether persistent application settings are enabled for users during their streaming sessions.
- */
- Enabled?: Boolean;
- /**
- * The path prefix for the S3 bucket where users’ persistent application settings are stored.
- */
- SettingsGroup?: SettingsGroup;
- /**
- * The S3 bucket where users’ persistent application settings are stored. When persistent application settings are enabled for the first time for an account in an AWS Region, an S3 bucket is created. The bucket is unique to the AWS account and the Region.
- */
- S3BucketName?: String;
- }
- export type Applications = Application[];
- export type AppstreamAgentVersion = string;
- export type Arn = string;
- export type ArnList = Arn[];
- export interface AssociateAppBlockBuilderAppBlockRequest {
- /**
- * The ARN of the app block.
- */
- AppBlockArn: Arn;
- /**
- * The name of the app block builder.
- */
- AppBlockBuilderName: Name;
- }
- export interface AssociateAppBlockBuilderAppBlockResult {
- /**
- * The list of app block builders associated with app blocks.
- */
- AppBlockBuilderAppBlockAssociation?: AppBlockBuilderAppBlockAssociation;
- }
- export interface AssociateApplicationFleetRequest {
- /**
- * The name of the fleet.
- */
- FleetName: Name;
- /**
- * The ARN of the application.
- */
- ApplicationArn: Arn;
- }
- export interface AssociateApplicationFleetResult {
- /**
- * If fleet name is specified, this returns the list of applications that are associated to it. If application ARN is specified, this returns the list of fleets to which it is associated.
- */
- ApplicationFleetAssociation?: ApplicationFleetAssociation;
- }
- export interface AssociateApplicationToEntitlementRequest {
- /**
- * The name of the stack.
- */
- StackName: Name;
- /**
- * The name of the entitlement.
- */
- EntitlementName: Name;
- /**
- * The identifier of the application.
- */
- ApplicationIdentifier: String;
- }
- export interface AssociateApplicationToEntitlementResult {
- }
- export interface AssociateFleetRequest {
- /**
- * The name of the fleet.
- */
- FleetName: String;
- /**
- * The name of the stack.
- */
- StackName: String;
- }
- export interface AssociateFleetResult {
- }
- export type AuthenticationType = "API"|"SAML"|"USERPOOL"|"AWS_AD"|string;
- export type AwsAccountId = string;
- export type AwsAccountIdList = AwsAccountId[];
- export interface BatchAssociateUserStackRequest {
- /**
- * The list of UserStackAssociation objects.
- */
- UserStackAssociations: UserStackAssociationList;
- }
- export interface BatchAssociateUserStackResult {
- /**
- * The list of UserStackAssociationError objects.
- */
- errors?: UserStackAssociationErrorList;
- }
- export interface BatchDisassociateUserStackRequest {
- /**
- * The list of UserStackAssociation objects.
- */
- UserStackAssociations: UserStackAssociationList;
- }
- export interface BatchDisassociateUserStackResult {
- /**
- * The list of UserStackAssociationError objects.
- */
- errors?: UserStackAssociationErrorList;
- }
- export type Boolean = boolean;
- export type BooleanObject = boolean;
- export interface CertificateBasedAuthProperties {
- /**
- * The status of the certificate-based authentication properties.
- */
- Status?: CertificateBasedAuthStatus;
- /**
- * The ARN of the AWS Certificate Manager Private CA resource.
- */
- CertificateAuthorityArn?: Arn;
- }
- export type CertificateBasedAuthStatus = "DISABLED"|"ENABLED"|"ENABLED_NO_DIRECTORY_LOGIN_FALLBACK"|string;
- export interface ComputeCapacity {
- /**
- * The desired number of streaming instances.
- */
- DesiredInstances?: Integer;
- /**
- * The desired number of user sessions for a multi-session fleet. This is not allowed for single-session fleets. When you create a fleet, you must set either the DesiredSessions or DesiredInstances attribute, based on the type of fleet you create. You can’t define both attributes or leave both attributes blank.
- */
- DesiredSessions?: Integer;
- }
- export interface ComputeCapacityStatus {
- /**
- * The desired number of streaming instances.
- */
- Desired: Integer;
- /**
- * The total number of simultaneous streaming instances that are running.
- */
- Running?: Integer;
- /**
- * The number of instances in use for streaming.
- */
- InUse?: Integer;
- /**
- * The number of currently available instances that can be used to stream sessions.
- */
- Available?: Integer;
- /**
- * The total number of sessions slots that are either running or pending. This represents the total number of concurrent streaming sessions your fleet can support in a steady state. DesiredUserSessionCapacity = ActualUserSessionCapacity + PendingUserSessionCapacity This only applies to multi-session fleets.
- */
- DesiredUserSessions?: Integer;
- /**
- * The number of idle session slots currently available for user sessions. AvailableUserSessionCapacity = ActualUserSessionCapacity - ActiveUserSessions This only applies to multi-session fleets.
- */
- AvailableUserSessions?: Integer;
- /**
- * The number of user sessions currently being used for streaming sessions. This only applies to multi-session fleets.
- */
- ActiveUserSessions?: Integer;
- /**
- * The total number of session slots that are available for streaming or are currently streaming. ActualUserSessionCapacity = AvailableUserSessionCapacity + ActiveUserSessions This only applies to multi-session fleets.
- */
- ActualUserSessions?: Integer;
- }
- export interface CopyImageRequest {
- /**
- * The name of the image to copy.
- */
- SourceImageName: Name;
- /**
- * The name that the image will have when it is copied to the destination.
- */
- DestinationImageName: Name;
- /**
- * The destination region to which the image will be copied. This parameter is required, even if you are copying an image within the same region.
- */
- DestinationRegion: RegionName;
- /**
- * The description that the image will have when it is copied to the destination.
- */
- DestinationImageDescription?: Description;
- }
- export interface CopyImageResponse {
- /**
- * The name of the destination image.
- */
- DestinationImageName?: Name;
- }
- export interface CreateAppBlockBuilderRequest {
- /**
- * The unique name for the app block builder.
- */
- Name: Name;
- /**
- * The description of the app block builder.
- */
- Description?: Description;
- /**
- * The display name of the app block builder.
- */
- DisplayName?: DisplayName;
- /**
- * The tags to associate with the app block builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. If you do not specify a value, the value is set to an empty string. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: _ . : / = + \ - @ For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
- */
- Tags?: Tags;
- /**
- * The platform of the app block builder. WINDOWS_SERVER_2019 is the only valid value.
- */
- Platform: AppBlockBuilderPlatformType;
- /**
- * The instance type to use when launching the app block builder. The following instance types are available: stream.standard.small stream.standard.medium stream.standard.large stream.standard.xlarge stream.standard.2xlarge
- */
- InstanceType: String;
- /**
- * The VPC configuration for the app block builder. App block builders require that you specify at least two subnets in different availability zones.
- */
- VpcConfig: VpcConfig;
- /**
- * Enables or disables default internet access for the app block builder.
- */
- EnableDefaultInternetAccess?: BooleanObject;
- /**
- * The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance. For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
- */
- IamRoleArn?: Arn;
- /**
- * The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
- */
- AccessEndpoints?: AccessEndpointList;
- }
- export interface CreateAppBlockBuilderResult {
- AppBlockBuilder?: AppBlockBuilder;
- }
- export interface CreateAppBlockBuilderStreamingURLRequest {
- /**
- * The name of the app block builder.
- */
- AppBlockBuilderName: Name;
- /**
- * The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.
- */
- Validity?: Long;
- }
- export interface CreateAppBlockBuilderStreamingURLResult {
- /**
- * The URL to start the streaming session.
- */
- StreamingURL?: String;
- /**
- * The elapsed time, in seconds after the Unix epoch, when this URL expires.
- */
- Expires?: Timestamp;
- }
- export interface CreateAppBlockRequest {
- /**
- * The name of the app block.
- */
- Name: Name;
- /**
- * The description of the app block.
- */
- Description?: Description;
- /**
- * The display name of the app block. This is not displayed to the user.
- */
- DisplayName?: DisplayName;
- /**
- * The source S3 location of the app block.
- */
- SourceS3Location: S3Location;
- /**
- * The setup script details of the app block. This must be provided for the CUSTOM PackagingType.
- */
- SetupScriptDetails?: ScriptDetails;
- /**
- * The tags assigned to the app block.
- */
- Tags?: Tags;
- /**
- * The post setup script details of the app block. This can only be provided for the APPSTREAM2 PackagingType.
- */
- PostSetupScriptDetails?: ScriptDetails;
- /**
- * The packaging type of the app block.
- */
- PackagingType?: PackagingType;
- }
- export interface CreateAppBlockResult {
- /**
- * The app block.
- */
- AppBlock?: AppBlock;
- }
- export interface CreateApplicationRequest {
- /**
- * The name of the application. This name is visible to users when display name is not specified.
- */
- Name: Name;
- /**
- * The display name of the application. This name is visible to users in the application catalog.
- */
- DisplayName?: DisplayName;
- /**
- * The description of the application.
- */
- Description?: Description;
- /**
- * The location in S3 of the application icon.
- */
- IconS3Location: S3Location;
- /**
- * The launch path of the application.
- */
- LaunchPath: String;
- /**
- * The working directory of the application.
- */
- WorkingDirectory?: String;
- /**
- * The launch parameters of the application.
- */
- LaunchParameters?: String;
- /**
- * The platforms the application supports. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
- */
- Platforms: Platforms;
- /**
- * The instance families the application supports. Valid values are GENERAL_PURPOSE and GRAPHICS_G4.
- */
- InstanceFamilies: StringList;
- /**
- * The app block ARN to which the application should be associated
- */
- AppBlockArn: Arn;
- /**
- * The tags assigned to the application.
- */
- Tags?: Tags;
- }
- export interface CreateApplicationResult {
- Application?: Application;
- }
- export interface CreateDirectoryConfigRequest {
- /**
- * The fully qualified name of the directory (for example, corp.example.com).
- */
- DirectoryName: DirectoryName;
- /**
- * The distinguished names of the organizational units for computer accounts.
- */
- OrganizationalUnitDistinguishedNames: OrganizationalUnitDistinguishedNamesList;
- /**
- * The credentials for the service account used by the fleet or image builder to connect to the directory.
- */
- ServiceAccountCredentials?: ServiceAccountCredentials;
- /**
- * The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
- */
- CertificateBasedAuthProperties?: CertificateBasedAuthProperties;
- }
- export interface CreateDirectoryConfigResult {
- /**
- * Information about the directory configuration.
- */
- DirectoryConfig?: DirectoryConfig;
- }
- export interface CreateEntitlementRequest {
- /**
- * The name of the entitlement.
- */
- Name: Name;
- /**
- * The name of the stack with which the entitlement is associated.
- */
- StackName: Name;
- /**
- * The description of the entitlement.
- */
- Description?: Description;
- /**
- * Specifies whether all or selected apps are entitled.
- */
- AppVisibility: AppVisibility;
- /**
- * The attributes of the entitlement.
- */
- Attributes: EntitlementAttributeList;
- }
- export interface CreateEntitlementResult {
- /**
- * The entitlement.
- */
- Entitlement?: Entitlement;
- }
- export interface CreateFleetRequest {
- /**
- * A unique name for the fleet.
- */
- Name: Name;
- /**
- * The name of the image used to create the fleet.
- */
- ImageName?: Name;
- /**
- * The ARN of the public, private, or shared image to use.
- */
- ImageArn?: Arn;
- /**
- * The instance type to use when launching fleet instances. The following instance types are available: stream.standard.small stream.standard.medium stream.standard.large stream.standard.xlarge stream.standard.2xlarge stream.compute.large stream.compute.xlarge stream.compute.2xlarge stream.compute.4xlarge stream.compute.8xlarge stream.memory.large stream.memory.xlarge stream.memory.2xlarge stream.memory.4xlarge stream.memory.8xlarge stream.memory.z1d.large stream.memory.z1d.xlarge stream.memory.z1d.2xlarge stream.memory.z1d.3xlarge stream.memory.z1d.6xlarge stream.memory.z1d.12xlarge stream.graphics-design.large stream.graphics-design.xlarge stream.graphics-design.2xlarge stream.graphics-design.4xlarge stream.graphics-desktop.2xlarge stream.graphics.g4dn.xlarge stream.graphics.g4dn.2xlarge stream.graphics.g4dn.4xlarge stream.graphics.g4dn.8xlarge stream.graphics.g4dn.12xlarge stream.graphics.g4dn.16xlarge stream.graphics-pro.4xlarge stream.graphics-pro.8xlarge stream.graphics-pro.16xlarge The following instance types are available for Elastic fleets: stream.standard.small stream.standard.medium stream.standard.large stream.standard.xlarge stream.standard.2xlarge
- */
- InstanceType: String;
- /**
- * The fleet type. ALWAYS_ON Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps. ON_DEMAND Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
- */
- FleetType?: FleetType;
- /**
- * The desired capacity for the fleet. This is not allowed for Elastic fleets. For Elastic fleets, specify MaxConcurrentSessions instead.
- */
- ComputeCapacity?: ComputeCapacity;
- /**
- * The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
- */
- VpcConfig?: VpcConfig;
- /**
- * The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance. Specify a value between 600 and 432000.
- */
- MaxUserDurationInSeconds?: Integer;
- /**
- * The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. Specify a value between 60 and 360000.
- */
- DisconnectTimeoutInSeconds?: Integer;
- /**
- * The description to display.
- */
- Description?: Description;
- /**
- * The fleet name to display.
- */
- DisplayName?: DisplayName;
- /**
- * Enables or disables default internet access for the fleet.
- */
- EnableDefaultInternetAccess?: BooleanObject;
- /**
- * The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain. This is not allowed for Elastic fleets.
- */
- DomainJoinInfo?: DomainJoinInfo;
- /**
- * The tags to associate with the fleet. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. If you do not specify a value, the value is set to an empty string. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: _ . : / = + \ - @ For more information, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
- */
- Tags?: Tags;
- /**
- * The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If they try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0. If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
- */
- IdleDisconnectTimeoutInSeconds?: Integer;
- /**
- * The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance. For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
- */
- IamRoleArn?: Arn;
- /**
- * The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays. The default value is APP.
- */
- StreamView?: StreamView;
- /**
- * The fleet platform. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
- */
- Platform?: PlatformType;
- /**
- * The maximum concurrent sessions of the Elastic fleet. This is required for Elastic fleets, and not allowed for other fleet types.
- */
- MaxConcurrentSessions?: Integer;
- /**
- * The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
- */
- UsbDeviceFilterStrings?: UsbDeviceFilterStrings;
- /**
- * The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
- */
- SessionScriptS3Location?: S3Location;
- /**
- * The maximum number of user sessions on an instance. This only applies to multi-session fleets.
- */
- MaxSessionsPerInstance?: Integer;
- }
- export interface CreateFleetResult {
- /**
- * Information about the fleet.
- */
- Fleet?: Fleet;
- }
- export interface CreateImageBuilderRequest {
- /**
- * A unique name for the image builder.
- */
- Name: Name;
- /**
- * The name of the image used to create the image builder.
- */
- ImageName?: String;
- /**
- * The ARN of the public, private, or shared image to use.
- */
- ImageArn?: Arn;
- /**
- * The instance type to use when launching the image builder. The following instance types are available: stream.standard.small stream.standard.medium stream.standard.large stream.compute.large stream.compute.xlarge stream.compute.2xlarge stream.compute.4xlarge stream.compute.8xlarge stream.memory.large stream.memory.xlarge stream.memory.2xlarge stream.memory.4xlarge stream.memory.8xlarge stream.memory.z1d.large stream.memory.z1d.xlarge stream.memory.z1d.2xlarge stream.memory.z1d.3xlarge stream.memory.z1d.6xlarge stream.memory.z1d.12xlarge stream.graphics-design.large stream.graphics-design.xlarge stream.graphics-design.2xlarge stream.graphics-design.4xlarge stream.graphics-desktop.2xlarge stream.graphics.g4dn.xlarge stream.graphics.g4dn.2xlarge stream.graphics.g4dn.4xlarge stream.graphics.g4dn.8xlarge stream.graphics.g4dn.12xlarge stream.graphics.g4dn.16xlarge stream.graphics-pro.4xlarge stream.graphics-pro.8xlarge stream.graphics-pro.16xlarge
- */
- InstanceType: String;
- /**
- * The description to display.
- */
- Description?: Description;
- /**
- * The image builder name to display.
- */
- DisplayName?: DisplayName;
- /**
- * The VPC configuration for the image builder. You can specify only one subnet.
- */
- VpcConfig?: VpcConfig;
- /**
- * The Amazon Resource Name (ARN) of the IAM role to apply to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance. For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
- */
- IamRoleArn?: Arn;
- /**
- * Enables or disables default internet access for the image builder.
- */
- EnableDefaultInternetAccess?: BooleanObject;
- /**
- * The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
- */
- DomainJoinInfo?: DomainJoinInfo;
- /**
- * The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
- */
- AppstreamAgentVersion?: AppstreamAgentVersion;
- /**
- * The tags to associate with the image builder. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: _ . : / = + \ - @ If you do not specify a value, the value is set to an empty string. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
- */
- Tags?: Tags;
- /**
- * The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the image builder only through the specified endpoints.
- */
- AccessEndpoints?: AccessEndpointList;
- }
- export interface CreateImageBuilderResult {
- /**
- * Information about the image builder.
- */
- ImageBuilder?: ImageBuilder;
- }
- export interface CreateImageBuilderStreamingURLRequest {
- /**
- * The name of the image builder.
- */
- Name: String;
- /**
- * The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 3600 seconds.
- */
- Validity?: Long;
- }
- export interface CreateImageBuilderStreamingURLResult {
- /**
- * The URL to start the AppStream 2.0 streaming session.
- */
- StreamingURL?: String;
- /**
- * The elapsed time, in seconds after the Unix epoch, when this URL expires.
- */
- Expires?: Timestamp;
- }
- export interface CreateStackRequest {
- /**
- * The name of the stack.
- */
- Name: Name;
- /**
- * The description to display.
- */
- Description?: Description;
- /**
- * The stack name to display.
- */
- DisplayName?: DisplayName;
- /**
- * The storage connectors to enable.
- */
- StorageConnectors?: StorageConnectorList;
- /**
- * The URL that users are redirected to after their streaming session ends.
- */
- RedirectURL?: RedirectURL;
- /**
- * The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
- */
- FeedbackURL?: FeedbackURL;
- /**
- * The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
- */
- UserSettings?: UserSettingList;
- /**
- * The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
- */
- ApplicationSettings?: ApplicationSettings;
- /**
- * The tags to associate with the stack. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. If you do not specify a value, the value is set to an empty string. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: _ . : / = + \ - @ For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
- */
- Tags?: Tags;
- /**
- * The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
- */
- AccessEndpoints?: AccessEndpointList;
- /**
- * The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
- */
- EmbedHostDomains?: EmbedHostDomains;
- /**
- * The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
- */
- StreamingExperienceSettings?: StreamingExperienceSettings;
- }
- export interface CreateStackResult {
- /**
- * Information about the stack.
- */
- Stack?: Stack;
- }
- export interface CreateStreamingURLRequest {
- /**
- * The name of the stack.
- */
- StackName: String;
- /**
- * The name of the fleet.
- */
- FleetName: String;
- /**
- * The identifier of the user.
- */
- UserId: StreamingUrlUserId;
- /**
- * The name of the application to launch after the session starts. This is the name that you specified as Name in the Image Assistant. If your fleet is enabled for the Desktop stream view, you can also choose to launch directly to the operating system desktop. To do so, specify Desktop.
- */
- ApplicationId?: String;
- /**
- * The time that the streaming URL will be valid, in seconds. Specify a value between 1 and 604800 seconds. The default is 60 seconds.
- */
- Validity?: Long;
- /**
- * The session context. For more information, see Session Context in the Amazon AppStream 2.0 Administration Guide.
- */
- SessionContext?: String;
- }
- export interface CreateStreamingURLResult {
- /**
- * The URL to start the AppStream 2.0 streaming session.
- */
- StreamingURL?: String;
- /**
- * The elapsed time, in seconds after the Unix epoch, when this URL expires.
- */
- Expires?: Timestamp;
- }
- export interface CreateUpdatedImageRequest {
- /**
- * The name of the image to update.
- */
- existingImageName: Name;
- /**
- * The name of the new image. The name must be unique within the AWS account and Region.
- */
- newImageName: Name;
- /**
- * The description to display for the new image.
- */
- newImageDescription?: Description;
- /**
- * The name to display for the new image.
- */
- newImageDisplayName?: DisplayName;
- /**
- * The tags to associate with the new image. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: _ . : / = + \ - @ If you do not specify a value, the value is set to an empty string. For more information about tags, see Tagging Your Resources in the Amazon AppStream 2.0 Administration Guide.
- */
- newImageTags?: Tags;
- /**
- * Indicates whether to display the status of image update availability before AppStream 2.0 initiates the process of creating a new updated image. If this value is set to true, AppStream 2.0 displays whether image updates are available. If this value is set to false, AppStream 2.0 initiates the process of creating a new updated image without displaying whether image updates are available.
- */
- dryRun?: Boolean;
- }
- export interface CreateUpdatedImageResult {
- image?: Image;
- /**
- * Indicates whether a new image can be created.
- */
- canUpdateImage?: Boolean;
- }
- export interface CreateUsageReportSubscriptionRequest {
- }
- export interface CreateUsageReportSubscriptionResult {
- /**
- * The Amazon S3 bucket where generated reports are stored. If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
- */
- S3BucketName?: String;
- /**
- * The schedule for generating usage reports.
- */
- Schedule?: UsageReportSchedule;
- }
- export interface CreateUserRequest {
- /**
- * The email address of the user. Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
- */
- UserName: Username;
- /**
- * The action to take for the welcome email that is sent to a user after the user is created in the user pool. If you specify SUPPRESS, no email is sent. If you specify RESEND, do not specify the first name or last name of the user. If the value is null, the email is sent. The temporary password in the welcome email is valid for only 7 days. If users don’t set their passwords within 7 days, you must send them a new welcome email.
- */
- MessageAction?: MessageAction;
- /**
- * The first name, or given name, of the user.
- */
- FirstName?: UserAttributeValue;
- /**
- * The last name, or surname, of the user.
- */
- LastName?: UserAttributeValue;
- /**
- * The authentication type for the user. You must specify USERPOOL.
- */
- AuthenticationType: AuthenticationType;
- }
- export interface CreateUserResult {
- }
- export interface DeleteAppBlockBuilderRequest {
- /**
- * The name of the app block builder.
- */
- Name: Name;
- }
- export interface DeleteAppBlockBuilderResult {
- }
- export interface DeleteAppBlockRequest {
- /**
- * The name of the app block.
- */
- Name: Name;
- }
- export interface DeleteAppBlockResult {
- }
- export interface DeleteApplicationRequest {
- /**
- * The name of the application.
- */
- Name: Name;
- }
- export interface DeleteApplicationResult {
- }
- export interface DeleteDirectoryConfigRequest {
- /**
- * The name of the directory configuration.
- */
- DirectoryName: DirectoryName;
- }
- export interface DeleteDirectoryConfigResult {
- }
- export interface DeleteEntitlementRequest {
- /**
- * The name of the entitlement.
- */
- Name: Name;
- /**
- * The name of the stack with which the entitlement is associated.
- */
- StackName: Name;
- }
- export interface DeleteEntitlementResult {
- }
- export interface DeleteFleetRequest {
- /**
- * The name of the fleet.
- */
- Name: String;
- }
- export interface DeleteFleetResult {
- }
- export interface DeleteImageBuilderRequest {
- /**
- * The name of the image builder.
- */
- Name: Name;
- }
- export interface DeleteImageBuilderResult {
- /**
- * Information about the image builder.
- */
- ImageBuilder?: ImageBuilder;
- }
- export interface DeleteImagePermissionsRequest {
- /**
- * The name of the private image.
- */
- Name: Name;
- /**
- * The 12-digit identifier of the AWS account for which to delete image permissions.
- */
- SharedAccountId: AwsAccountId;
- }
- export interface DeleteImagePermissionsResult {
- }
- export interface DeleteImageRequest {
- /**
- * The name of the image.
- */
- Name: Name;
- }
- export interface DeleteImageResult {
- /**
- * Information about the image.
- */
- Image?: Image;
- }
- export interface DeleteStackRequest {
- /**
- * The name of the stack.
- */
- Name: String;
- }
- export interface DeleteStackResult {
- }
- export interface DeleteUsageReportSubscriptionRequest {
- }
- export interface DeleteUsageReportSubscriptionResult {
- }
- export interface DeleteUserRequest {
- /**
- * The email address of the user. Users' email addresses are case-sensitive.
- */
- UserName: Username;
- /**
- * The authentication type for the user. You must specify USERPOOL.
- */
- AuthenticationType: AuthenticationType;
- }
- export interface DeleteUserResult {
- }
- export interface DescribeAppBlockBuilderAppBlockAssociationsRequest {
- /**
- * The ARN of the app block.
- */
- AppBlockArn?: Arn;
- /**
- * The name of the app block builder.
- */
- AppBlockBuilderName?: Name;
- /**
- * The maximum size of each page of results.
- */
- MaxResults?: Integer;
- /**
- * The pagination token used to retrieve the next page of results for this operation.
- */
- NextToken?: String;
- }
- export interface DescribeAppBlockBuilderAppBlockAssociationsResult {
- /**
- * This list of app block builders associated with app blocks.
- */
- AppBlockBuilderAppBlockAssociations?: AppBlockBuilderAppBlockAssociationsList;
- /**
- * The pagination token used to retrieve the next page of results for this operation.
- */
- NextToken?: String;
- }
- export interface DescribeAppBlockBuildersRequest {
- /**
- * The names of the app block builders.
- */
- Names?: StringList;
- /**
- * The pagination token used to retrieve the next page of results for this operation.
- */
- NextToken?: String;
- /**
- * The maximum size of each page of results. The maximum value is 25.
- */
- MaxResults?: Integer;
- }
- export interface DescribeAppBlockBuildersResult {
- /**
- * The list that describes one or more app block builders.
- */
- AppBlockBuilders?: AppBlockBuilderList;
- /**
- * The pagination token used to retrieve the next page of results for this operation.
- */
- NextToken?: String;
- }
- export interface DescribeAppBlocksRequest {
- /**
- * The ARNs of the app blocks.
- */
- Arns?: ArnList;
- /**
- * The pagination token used to retrieve the next page of results for this operation.
- */
- NextToken?: String;
- /**
- * The maximum size of each page of results.
- */
- MaxResults?: Integer;
- }
- export interface DescribeAppBlocksResult {
- /**
- * The app blocks in the list.
- */
- AppBlocks?: AppBlocks;
- /**
- * The pagination token used to retrieve the next page of results for this operation.
- */
- NextToken?: String;
- }
- export interface DescribeApplicationFleetAssociationsRequest {
- /**
- * The name of the fleet.
- */
- FleetName?: Name;
- /**
- * The ARN of the application.
- */
- ApplicationArn?: Arn;
- /**
- * The maximum size of each page of results.
- */
- MaxResults?: Integer;
- /**
- * The pagination token used to retrieve the next page of results for this operation.
- */
- NextToken?: String;
- }
- export interface DescribeApplicationFleetAssociationsResult {
- /**
- * The application fleet associations in the list.
- */
- ApplicationFleetAssociations?: ApplicationFleetAssociationList;
- /**
- * The pagination token used to retrieve the next page of results for this operation.
- */
- NextToken?: String;
- }
- export interface DescribeApplicationsRequest {
- /**
- * The ARNs for the applications.
- */
- Arns?: ArnList;
- /**
- * The pagination token used to retrieve the next page of results for this operation.
- */
- NextToken?: String;
- /**
- * The maximum size of each page of results.
- */
- MaxResults?: Integer;
- }
- export interface DescribeApplicationsResult {
- /**
- * The applications in the list.
- */
- Applications?: Applications;
- /**
- * The pagination token used to retrieve the next page of results for this operation.
- */
- NextToken?: String;
- }
- export interface DescribeDirectoryConfigsRequest {
- /**
- * The directory names.
- */
- DirectoryNames?: DirectoryNameList;
- /**
- * The maximum size of each page of results.
- */
- MaxResults?: Integer;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- */
- NextToken?: String;
- }
- export interface DescribeDirectoryConfigsResult {
- /**
- * Information about the directory configurations. Note that although the response syntax in this topic includes the account password, this password is not returned in the actual response.
- */
- DirectoryConfigs?: DirectoryConfigList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- */
- NextToken?: String;
- }
- export interface DescribeEntitlementsRequest {
- /**
- * The name of the entitlement.
- */
- Name?: Name;
- /**
- * The name of the stack with which the entitlement is associated.
- */
- StackName: Name;
- /**
- * The pagination token used to retrieve the next page of results for this operation.
- */
- NextToken?: String;
- /**
- * The maximum size of each page of results.
- */
- MaxResults?: Integer;
- }
- export interface DescribeEntitlementsResult {
- /**
- * The entitlements.
- */
- Entitlements?: EntitlementList;
- /**
- * The pagination token used to retrieve the next page of results for this operation.
- */
- NextToken?: String;
- }
- export interface DescribeFleetsRequest {
- /**
- * The names of the fleets to describe.
- */
- Names?: StringList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- */
- NextToken?: String;
- }
- export interface DescribeFleetsResult {
- /**
- * Information about the fleets.
- */
- Fleets?: FleetList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- */
- NextToken?: String;
- }
- export interface DescribeImageBuildersRequest {
- /**
- * The names of the image builders to describe.
- */
- Names?: StringList;
- /**
- * The maximum size of each page of results.
- */
- MaxResults?: Integer;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- */
- NextToken?: String;
- }
- export interface DescribeImageBuildersResult {
- /**
- * Information about the image builders.
- */
- ImageBuilders?: ImageBuilderList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- */
- NextToken?: String;
- }
- export interface DescribeImagePermissionsRequest {
- /**
- * The name of the private image for which to describe permissions. The image must be one that you own.
- */
- Name: Name;
- /**
- * The maximum size of each page of results.
- */
- MaxResults?: MaxResults;
- /**
- * The 12-digit identifier of one or more AWS accounts with which the image is shared.
- */
- SharedAwsAccountIds?: AwsAccountIdList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- */
- NextToken?: String;
- }
- export interface DescribeImagePermissionsResult {
- /**
- * The name of the private image.
- */
- Name?: Name;
- /**
- * The permissions for a private image that you own.
- */
- SharedImagePermissionsList?: SharedImagePermissionsList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- */
- NextToken?: String;
- }
- export type DescribeImagesMaxResults = number;
- export interface DescribeImagesRequest {
- /**
- * The names of the public or private images to describe.
- */
- Names?: StringList;
- /**
- * The ARNs of the public, private, and shared images to describe.
- */
- Arns?: ArnList;
- /**
- * The type of image (public, private, or shared) to describe.
- */
- Type?: VisibilityType;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- */
- NextToken?: String;
- /**
- * The maximum size of each page of results.
- */
- MaxResults?: DescribeImagesMaxResults;
- }
- export interface DescribeImagesResult {
- /**
- * Information about the images.
- */
- Images?: ImageList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- */
- NextToken?: String;
- }
- export interface DescribeSessionsRequest {
- /**
- * The name of the stack. This value is case-sensitive.
- */
- StackName: Name;
- /**
- * The name of the fleet. This value is case-sensitive.
- */
- FleetName: Name;
- /**
- * The user identifier (ID). If you specify a user ID, you must also specify the authentication type.
- */
- UserId?: UserId;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- */
- NextToken?: String;
- /**
- * The size of each page of results. The default value is 20 and the maximum value is 50.
- */
- Limit?: Integer;
- /**
- * The authentication method. Specify API for a user authenticated using a streaming URL or SAML for a SAML federated user. The default is to authenticate users using a streaming URL.
- */
- AuthenticationType?: AuthenticationType;
- /**
- * The identifier for the instance hosting the session.
- */
- InstanceId?: String;
- }
- export interface DescribeSessionsResult {
- /**
- * Information about the streaming sessions.
- */
- Sessions?: SessionList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- */
- NextToken?: String;
- }
- export interface DescribeStacksRequest {
- /**
- * The names of the stacks to describe.
- */
- Names?: StringList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- */
- NextToken?: String;
- }
- export interface DescribeStacksResult {
- /**
- * Information about the stacks.
- */
- Stacks?: StackList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- */
- NextToken?: String;
- }
- export interface DescribeUsageReportSubscriptionsRequest {
- /**
- * The maximum size of each page of results.
- */
- MaxResults?: Integer;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- */
- NextToken?: String;
- }
- export interface DescribeUsageReportSubscriptionsResult {
- /**
- * Information about the usage report subscription.
- */
- UsageReportSubscriptions?: UsageReportSubscriptionList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- */
- NextToken?: String;
- }
- export interface DescribeUserStackAssociationsRequest {
- /**
- * The name of the stack that is associated with the user.
- */
- StackName?: String;
- /**
- * The email address of the user who is associated with the stack. Users' email addresses are case-sensitive.
- */
- UserName?: Username;
- /**
- * The authentication type for the user who is associated with the stack. You must specify USERPOOL.
- */
- AuthenticationType?: AuthenticationType;
- /**
- * The maximum size of each page of results.
- */
- MaxResults?: MaxResults;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- */
- NextToken?: String;
- }
- export interface DescribeUserStackAssociationsResult {
- /**
- * The UserStackAssociation objects.
- */
- UserStackAssociations?: UserStackAssociationList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- */
- NextToken?: String;
- }
- export interface DescribeUsersRequest {
- /**
- * The authentication type for the users in the user pool to describe. You must specify USERPOOL.
- */
- AuthenticationType: AuthenticationType;
- /**
- * The maximum size of each page of results.
- */
- MaxResults?: Integer;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- */
- NextToken?: String;
- }
- export interface DescribeUsersResult {
- /**
- * Information about users in the user pool.
- */
- Users?: UserList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- */
- NextToken?: String;
- }
- export type Description = string;
- export interface DirectoryConfig {
- /**
- * The fully qualified name of the directory (for example, corp.example.com).
- */
- DirectoryName: DirectoryName;
- /**
- * The distinguished names of the organizational units for computer accounts.
- */
- OrganizationalUnitDistinguishedNames?: OrganizationalUnitDistinguishedNamesList;
- /**
- * The credentials for the service account used by the fleet or image builder to connect to the directory.
- */
- ServiceAccountCredentials?: ServiceAccountCredentials;
- /**
- * The time the directory configuration was created.
- */
- CreatedTime?: Timestamp;
- /**
- * The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
- */
- CertificateBasedAuthProperties?: CertificateBasedAuthProperties;
- }
- export type DirectoryConfigList = DirectoryConfig[];
- export type DirectoryName = string;
- export type DirectoryNameList = DirectoryName[];
- export interface DisableUserRequest {
- /**
- * The email address of the user. Users' email addresses are case-sensitive.
- */
- UserName: Username;
- /**
- * The authentication type for the user. You must specify USERPOOL.
- */
- AuthenticationType: AuthenticationType;
- }
- export interface DisableUserResult {
- }
- export interface DisassociateAppBlockBuilderAppBlockRequest {
- /**
- * The ARN of the app block.
- */
- AppBlockArn: Arn;
- /**
- * The name of the app block builder.
- */
- AppBlockBuilderName: Name;
- }
- export interface DisassociateAppBlockBuilderAppBlockResult {
- }
- export interface DisassociateApplicationFleetRequest {
- /**
- * The name of the fleet.
- */
- FleetName: Name;
- /**
- * The ARN of the application.
- */
- ApplicationArn: Arn;
- }
- export interface DisassociateApplicationFleetResult {
- }
- export interface DisassociateApplicationFromEntitlementRequest {
- /**
- * The name of the stack with which the entitlement is associated.
- */
- StackName: Name;
- /**
- * The name of the entitlement.
- */
- EntitlementName: Name;
- /**
- * The identifier of the application to remove from the entitlement.
- */
- ApplicationIdentifier: String;
- }
- export interface DisassociateApplicationFromEntitlementResult {
- }
- export interface DisassociateFleetRequest {
- /**
- * The name of the fleet.
- */
- FleetName: String;
- /**
- * The name of the stack.
- */
- StackName: String;
- }
- export interface DisassociateFleetResult {
- }
- export type DisplayName = string;
- export type Domain = string;
- export interface DomainJoinInfo {
- /**
- * The fully qualified name of the directory (for example, corp.example.com).
- */
- DirectoryName?: DirectoryName;
- /**
- * The distinguished name of the organizational unit for computer accounts.
- */
- OrganizationalUnitDistinguishedName?: OrganizationalUnitDistinguishedName;
- }
- export type DomainList = Domain[];
- export type EmbedHostDomain = string;
- export type EmbedHostDomains = EmbedHostDomain[];
- export interface EnableUserRequest {
- /**
- * The email address of the user. Users' email addresses are case-sensitive. During login, if they specify an email address that doesn't use the same capitalization as the email address specified when their user pool account was created, a "user does not exist" error message displays.
- */
- UserName: Username;
- /**
- * The authentication type for the user. You must specify USERPOOL.
- */
- AuthenticationType: AuthenticationType;
- }
- export interface EnableUserResult {
- }
- export interface EntitledApplication {
- /**
- * The identifier of the application.
- */
- ApplicationIdentifier: String;
- }
- export type EntitledApplicationList = EntitledApplication[];
- export interface Entitlement {
- /**
- * The name of the entitlement.
- */
- Name: Name;
- /**
- * The name of the stack with which the entitlement is associated.
- */
- StackName: Name;
- /**
- * The description of the entitlement.
- */
- Description?: Description;
- /**
- * Specifies whether all or selected apps are entitled.
- */
- AppVisibility: AppVisibility;
- /**
- * The attributes of the entitlement.
- */
- Attributes: EntitlementAttributeList;
- /**
- * The time when the entitlement was created.
- */
- CreatedTime?: Timestamp;
- /**
- * The time when the entitlement was last modified.
- */
- LastModifiedTime?: Timestamp;
- }
- export interface EntitlementAttribute {
- /**
- * A supported AWS IAM SAML PrincipalTag attribute that is matched to the associated value when a user identity federates into an Amazon AppStream 2.0 SAML application. The following are valid values: roles department organization groups title costCenter userType
- */
- Name: String;
- /**
- * A value that is matched to a supported SAML attribute name when a user identity federates into an Amazon AppStream 2.0 SAML application.
- */
- Value: String;
- }
- export type EntitlementAttributeList = EntitlementAttribute[];
- export type EntitlementList = Entitlement[];
- export interface ErrorDetails {
- /**
- * The error code.
- */
- ErrorCode?: String;
- /**
- * The error message.
- */
- ErrorMessage?: String;
- }
- export type ErrorDetailsList = ErrorDetails[];
- export interface ExpireSessionRequest {
- /**
- * The identifier of the streaming session.
- */
- SessionId: String;
- }
- export interface ExpireSessionResult {
- }
- export type FeedbackURL = string;
- export interface Fleet {
- /**
- * The Amazon Resource Name (ARN) for the fleet.
- */
- Arn: Arn;
- /**
- * The name of the fleet.
- */
- Name: String;
- /**
- * The fleet name to display.
- */
- DisplayName?: String;
- /**
- * The description to display.
- */
- Description?: String;
- /**
- * The name of the image used to create the fleet.
- */
- ImageName?: String;
- /**
- * The ARN for the public, private, or shared image.
- */
- ImageArn?: Arn;
- /**
- * The instance type to use when launching fleet instances. The following instance types are available: stream.standard.small stream.standard.medium stream.standard.large stream.compute.large stream.compute.xlarge stream.compute.2xlarge stream.compute.4xlarge stream.compute.8xlarge stream.memory.large stream.memory.xlarge stream.memory.2xlarge stream.memory.4xlarge stream.memory.8xlarge stream.memory.z1d.large stream.memory.z1d.xlarge stream.memory.z1d.2xlarge stream.memory.z1d.3xlarge stream.memory.z1d.6xlarge stream.memory.z1d.12xlarge stream.graphics-design.large stream.graphics-design.xlarge stream.graphics-design.2xlarge stream.graphics-design.4xlarge stream.graphics-desktop.2xlarge stream.graphics.g4dn.xlarge stream.graphics.g4dn.2xlarge stream.graphics.g4dn.4xlarge stream.graphics.g4dn.8xlarge stream.graphics.g4dn.12xlarge stream.graphics.g4dn.16xlarge stream.graphics-pro.4xlarge stream.graphics-pro.8xlarge stream.graphics-pro.16xlarge
- */
- InstanceType: String;
- /**
- * The fleet type. ALWAYS_ON Provides users with instant-on access to their apps. You are charged for all running instances in your fleet, even if no users are streaming apps. ON_DEMAND Provide users with access to applications after they connect, which takes one to two minutes. You are charged for instance streaming when users are connected and a small hourly fee for instances that are not streaming apps.
- */
- FleetType?: FleetType;
- /**
- * The capacity status for the fleet.
- */
- ComputeCapacityStatus: ComputeCapacityStatus;
- /**
- * The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance. Specify a value between 600 and 360000.
- */
- MaxUserDurationInSeconds?: Integer;
- /**
- * The amount of time that a streaming session remains active after users disconnect. If they try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. Specify a value between 60 and 360000.
- */
- DisconnectTimeoutInSeconds?: Integer;
- /**
- * The current state for the fleet.
- */
- State: FleetState;
- /**
- * The VPC configuration for the fleet.
- */
- VpcConfig?: VpcConfig;
- /**
- * The time the fleet was created.
- */
- CreatedTime?: Timestamp;
- /**
- * The fleet errors.
- */
- FleetErrors?: FleetErrors;
- /**
- * Indicates whether default internet access is enabled for the fleet.
- */
- EnableDefaultInternetAccess?: BooleanObject;
- /**
- * The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
- */
- DomainJoinInfo?: DomainJoinInfo;
- /**
- * The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0. If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
- */
- IdleDisconnectTimeoutInSeconds?: Integer;
- /**
- * The ARN of the IAM role that is applied to the fleet. To assume a role, the fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance. For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
- */
- IamRoleArn?: Arn;
- /**
- * The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays. The default value is APP.
- */
- StreamView?: StreamView;
- /**
- * The platform of the fleet.
- */
- Platform?: PlatformType;
- /**
- * The maximum number of concurrent sessions for the fleet.
- */
- MaxConcurrentSessions?: Integer;
- /**
- * The USB device filter strings associated with the fleet.
- */
- UsbDeviceFilterStrings?: UsbDeviceFilterStrings;
- /**
- * The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
- */
- SessionScriptS3Location?: S3Location;
- /**
- * The maximum number of user sessions on an instance. This only applies to multi-session fleets.
- */
- MaxSessionsPerInstance?: Integer;
- }
- export type FleetAttribute = "VPC_CONFIGURATION"|"VPC_CONFIGURATION_SECURITY_GROUP_IDS"|"DOMAIN_JOIN_INFO"|"IAM_ROLE_ARN"|"USB_DEVICE_FILTER_STRINGS"|"SESSION_SCRIPT_S3_LOCATION"|"MAX_SESSIONS_PER_INSTANCE"|string;
- export type FleetAttributes = FleetAttribute[];
- export interface FleetError {
- /**
- * The error code.
- */
- ErrorCode?: FleetErrorCode;
- /**
- * The error message.
- */
- ErrorMessage?: String;
- }
- export type FleetErrorCode = "IAM_SERVICE_ROLE_MISSING_ENI_DESCRIBE_ACTION"|"IAM_SERVICE_ROLE_MISSING_ENI_CREATE_ACTION"|"IAM_SERVICE_ROLE_MISSING_ENI_DELETE_ACTION"|"NETWORK_INTERFACE_LIMIT_EXCEEDED"|"INTERNAL_SERVICE_ERROR"|"IAM_SERVICE_ROLE_IS_MISSING"|"MACHINE_ROLE_IS_MISSING"|"STS_DISABLED_IN_REGION"|"SUBNET_HAS_INSUFFICIENT_IP_ADDRESSES"|"IAM_SERVICE_ROLE_MISSING_DESCRIBE_SUBNET_ACTION"|"SUBNET_NOT_FOUND"|"IMAGE_NOT_FOUND"|"INVALID_SUBNET_CONFIGURATION"|"SECURITY_GROUPS_NOT_FOUND"|"IGW_NOT_ATTACHED"|"IAM_SERVICE_ROLE_MISSING_DESCRIBE_SECURITY_GROUPS_ACTION"|"FLEET_STOPPED"|"FLEET_INSTANCE_PROVISIONING_FAILURE"|"DOMAIN_JOIN_ERROR_FILE_NOT_FOUND"|"DOMAIN_JOIN_ERROR_ACCESS_DENIED"|"DOMAIN_JOIN_ERROR_LOGON_FAILURE"|"DOMAIN_JOIN_ERROR_INVALID_PARAMETER"|"DOMAIN_JOIN_ERROR_MORE_DATA"|"DOMAIN_JOIN_ERROR_NO_SUCH_DOMAIN"|"DOMAIN_JOIN_ERROR_NOT_SUPPORTED"|"DOMAIN_JOIN_NERR_INVALID_WORKGROUP_NAME"|"DOMAIN_JOIN_NERR_WORKSTATION_NOT_STARTED"|"DOMAIN_JOIN_ERROR_DS_MACHINE_ACCOUNT_QUOTA_EXCEEDED"|"DOMAIN_JOIN_NERR_PASSWORD_EXPIRED"|"DOMAIN_JOIN_INTERNAL_SERVICE_ERROR"|string;
- export type FleetErrors = FleetError[];
- export type FleetList = Fleet[];
- export type FleetState = "STARTING"|"RUNNING"|"STOPPING"|"STOPPED"|string;
- export type FleetType = "ALWAYS_ON"|"ON_DEMAND"|"ELASTIC"|string;
- export interface Image {
- /**
- * The name of the image.
- */
- Name: String;
- /**
- * The ARN of the image.
- */
- Arn?: Arn;
- /**
- * The ARN of the image from which this image was created.
- */
- BaseImageArn?: Arn;
- /**
- * The image name to display.
- */
- DisplayName?: String;
- /**
- * The image starts in the PENDING state. If image creation succeeds, the state is AVAILABLE. If image creation fails, the state is FAILED.
- */
- State?: ImageState;
- /**
- * Indicates whether the image is public or private.
- */
- Visibility?: VisibilityType;
- /**
- * Indicates whether an image builder can be launched from this image.
- */
- ImageBuilderSupported?: Boolean;
- /**
- * The name of the image builder that was used to create the private image. If the image is shared, this value is null.
- */
- ImageBuilderName?: String;
- /**
- * The operating system platform of the image.
- */
- Platform?: PlatformType;
- /**
- * The description to display.
- */
- Description?: String;
- /**
- * The reason why the last state change occurred.
- */
- StateChangeReason?: ImageStateChangeReason;
- /**
- * The applications associated with the image.
- */
- Applications?: Applications;
- /**
- * The time the image was created.
- */
- CreatedTime?: Timestamp;
- /**
- * The release date of the public base image. For private images, this date is the release date of the base image from which the image was created.
- */
- PublicBaseImageReleasedDate?: Timestamp;
- /**
- * The version of the AppStream 2.0 agent to use for instances that are launched from this image.
- */
- AppstreamAgentVersion?: AppstreamAgentVersion;
- /**
- * The permissions to provide to the destination AWS account for the specified image.
- */
- ImagePermissions?: ImagePermissions;
- /**
- * Describes the errors that are returned when a new image can't be created.
- */
- ImageErrors?: ResourceErrors;
- }
- export interface ImageBuilder {
- /**
- * The name of the image builder.
- */
- Name: String;
- /**
- * The ARN for the image builder.
- */
- Arn?: Arn;
- /**
- * The ARN of the image from which this builder was created.
- */
- ImageArn?: Arn;
- /**
- * The description to display.
- */
- Description?: String;
- /**
- * The image builder name to display.
- */
- DisplayName?: String;
- /**
- * The VPC configuration of the image builder.
- */
- VpcConfig?: VpcConfig;
- /**
- * The instance type for the image builder. The following instance types are available: stream.standard.small stream.standard.medium stream.standard.large stream.compute.large stream.compute.xlarge stream.compute.2xlarge stream.compute.4xlarge stream.compute.8xlarge stream.memory.large stream.memory.xlarge stream.memory.2xlarge stream.memory.4xlarge stream.memory.8xlarge stream.memory.z1d.large stream.memory.z1d.xlarge stream.memory.z1d.2xlarge stream.memory.z1d.3xlarge stream.memory.z1d.6xlarge stream.memory.z1d.12xlarge stream.graphics-design.large stream.graphics-design.xlarge stream.graphics-design.2xlarge stream.graphics-design.4xlarge stream.graphics-desktop.2xlarge stream.graphics.g4dn.xlarge stream.graphics.g4dn.2xlarge stream.graphics.g4dn.4xlarge stream.graphics.g4dn.8xlarge stream.graphics.g4dn.12xlarge stream.graphics.g4dn.16xlarge stream.graphics-pro.4xlarge stream.graphics-pro.8xlarge stream.graphics-pro.16xlarge
- */
- InstanceType?: String;
- /**
- * The operating system platform of the image builder.
- */
- Platform?: PlatformType;
- /**
- * The ARN of the IAM role that is applied to the image builder. To assume a role, the image builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance. For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
- */
- IamRoleArn?: Arn;
- /**
- * The state of the image builder.
- */
- State?: ImageBuilderState;
- /**
- * The reason why the last state change occurred.
- */
- StateChangeReason?: ImageBuilderStateChangeReason;
- /**
- * The time stamp when the image builder was created.
- */
- CreatedTime?: Timestamp;
- /**
- * Enables or disables default internet access for the image builder.
- */
- EnableDefaultInternetAccess?: BooleanObject;
- /**
- * The name of the directory and organizational unit (OU) to use to join the image builder to a Microsoft Active Directory domain.
- */
- DomainJoinInfo?: DomainJoinInfo;
- NetworkAccessConfiguration?: NetworkAccessConfiguration;
- /**
- * The image builder errors.
- */
- ImageBuilderErrors?: ResourceErrors;
- /**
- * The version of the AppStream 2.0 agent that is currently being used by the image builder.
- */
- AppstreamAgentVersion?: AppstreamAgentVersion;
- /**
- * The list of virtual private cloud (VPC) interface endpoint objects. Administrators can connect to the image builder only through the specified endpoints.
- */
- AccessEndpoints?: AccessEndpointList;
- }
- export type ImageBuilderList = ImageBuilder[];
- export type ImageBuilderState = "PENDING"|"UPDATING_AGENT"|"RUNNING"|"STOPPING"|"STOPPED"|"REBOOTING"|"SNAPSHOTTING"|"DELETING"|"FAILED"|"UPDATING"|"PENDING_QUALIFICATION"|string;
- export interface ImageBuilderStateChangeReason {
- /**
- * The state change reason code.
- */
- Code?: ImageBuilderStateChangeReasonCode;
- /**
- * The state change reason message.
- */
- Message?: String;
- }
- export type ImageBuilderStateChangeReasonCode = "INTERNAL_ERROR"|"IMAGE_UNAVAILABLE"|string;
- export type ImageList = Image[];
- export interface ImagePermissions {
- /**
- * Indicates whether the image can be used for a fleet.
- */
- allowFleet?: BooleanObject;
- /**
- * Indicates whether the image can be used for an image builder.
- */
- allowImageBuilder?: BooleanObject;
- }
- export type ImageState = "PENDING"|"AVAILABLE"|"FAILED"|"COPYING"|"DELETING"|"CREATING"|"IMPORTING"|string;
- export interface ImageStateChangeReason {
- /**
- * The state change reason code.
- */
- Code?: ImageStateChangeReasonCode;
- /**
- * The state change reason message.
- */
- Message?: String;
- }
- export type ImageStateChangeReasonCode = "INTERNAL_ERROR"|"IMAGE_BUILDER_NOT_AVAILABLE"|"IMAGE_COPY_FAILURE"|string;
- export type Integer = number;
- export interface LastReportGenerationExecutionError {
- /**
- * The error code for the error that is returned when a usage report can't be generated.
- */
- ErrorCode?: UsageReportExecutionErrorCode;
- /**
- * The error message for the error that is returned when a usage report can't be generated.
- */
- ErrorMessage?: String;
- }
- export type LastReportGenerationExecutionErrors = LastReportGenerationExecutionError[];
- export interface ListAssociatedFleetsRequest {
- /**
- * The name of the stack.
- */
- StackName: String;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- */
- NextToken?: String;
- }
- export interface ListAssociatedFleetsResult {
- /**
- * The name of the fleet.
- */
- Names?: StringList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- */
- NextToken?: String;
- }
- export interface ListAssociatedStacksRequest {
- /**
- * The name of the fleet.
- */
- FleetName: String;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If this value is null, it retrieves the first page.
- */
- NextToken?: String;
- }
- export interface ListAssociatedStacksResult {
- /**
- * The name of the stack.
- */
- Names?: StringList;
- /**
- * The pagination token to use to retrieve the next page of results for this operation. If there are no more pages, this value is null.
- */
- NextToken?: String;
- }
- export interface ListEntitledApplicationsRequest {
- /**
- * The name of the stack with which the entitlement is associated.
- */
- StackName: Name;
- /**
- * The name of the entitlement.
- */
- EntitlementName: Name;
- /**
- * The pagination token used to retrieve the next page of results for this operation.
- */
- NextToken?: String;
- /**
- * The maximum size of each page of results.
- */
- MaxResults?: Integer;
- }
- export interface ListEntitledApplicationsResult {
- /**
- * The entitled applications.
- */
- EntitledApplications?: EntitledApplicationList;
- /**
- * The pagination token used to retrieve the next page of results for this operation.
- */
- NextToken?: String;
- }
- export interface ListTagsForResourceRequest {
- /**
- * The Amazon Resource Name (ARN) of the resource.
- */
- ResourceArn: Arn;
- }
- export interface ListTagsForResourceResponse {
- /**
- * The information about the tags.
- */
- Tags?: Tags;
- }
- export type Long = number;
- export type MaxResults = number;
- export type MessageAction = "SUPPRESS"|"RESEND"|string;
- export type Metadata = {[key: string]: String};
- export type Name = string;
- export interface NetworkAccessConfiguration {
- /**
- * The private IP address of the elastic network interface that is attached to instances in your VPC.
- */
- EniPrivateIpAddress?: String;
- /**
- * The resource identifier of the elastic network interface that is attached to instances in your VPC. All network interfaces have the eni-xxxxxxxx resource identifier.
- */
- EniId?: String;
- }
- export type OrganizationalUnitDistinguishedName = string;
- export type OrganizationalUnitDistinguishedNamesList = OrganizationalUnitDistinguishedName[];
- export type PackagingType = "CUSTOM"|"APPSTREAM2"|string;
- export type Permission = "ENABLED"|"DISABLED"|string;
- export type PlatformType = "WINDOWS"|"WINDOWS_SERVER_2016"|"WINDOWS_SERVER_2019"|"WINDOWS_SERVER_2022"|"AMAZON_LINUX2"|string;
- export type Platforms = PlatformType[];
- export type PreferredProtocol = "TCP"|"UDP"|string;
- export type RedirectURL = string;
- export type RegionName = string;
- export interface ResourceError {
- /**
- * The error code.
- */
- ErrorCode?: FleetErrorCode;
- /**
- * The error message.
- */
- ErrorMessage?: String;
- /**
- * The time the error occurred.
- */
- ErrorTimestamp?: Timestamp;
- }
- export type ResourceErrors = ResourceError[];
- export type ResourceIdentifier = string;
- export type S3Bucket = string;
- export type S3Key = string;
- export interface S3Location {
- /**
- * The S3 bucket of the S3 object.
- */
- S3Bucket: S3Bucket;
- /**
- * The S3 key of the S3 object. This is required when used for the following: IconS3Location (Actions: CreateApplication and UpdateApplication) SessionScriptS3Location (Actions: CreateFleet and UpdateFleet) ScriptDetails (Actions: CreateAppBlock) SourceS3Location when creating an app block with CUSTOM PackagingType (Actions: CreateAppBlock) SourceS3Location when creating an app block with APPSTREAM2 PackagingType, and using an existing application package (VHD file). In this case, S3Key refers to the VHD file. If a new application package is required, then S3Key is not required. (Actions: CreateAppBlock)
- */
- S3Key?: S3Key;
- }
- export interface ScriptDetails {
- /**
- * The S3 object location for the script.
- */
- ScriptS3Location: S3Location;
- /**
- * The run path for the script.
- */
- ExecutablePath: String;
- /**
- * The runtime parameters passed to the run path for the script.
- */
- ExecutableParameters?: String;
- /**
- * The run timeout, in seconds, for the script.
- */
- TimeoutInSeconds: Integer;
- }
- export type SecurityGroupIdList = String[];
- export interface ServiceAccountCredentials {
- /**
- * The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
- */
- AccountName: AccountName;
- /**
- * The password for the account.
- */
- AccountPassword: AccountPassword;
- }
- export interface Session {
- /**
- * The identifier of the streaming session.
- */
- Id: String;
- /**
- * The identifier of the user for whom the session was created.
- */
- UserId: UserId;
- /**
- * The name of the stack for the streaming session.
- */
- StackName: String;
- /**
- * The name of the fleet for the streaming session.
- */
- FleetName: String;
- /**
- * The current state of the streaming session.
- */
- State: SessionState;
- /**
- * Specifies whether a user is connected to the streaming session.
- */
- ConnectionState?: SessionConnectionState;
- /**
- * The time when a streaming instance is dedicated for the user.
- */
- StartTime?: Timestamp;
- /**
- * The time when the streaming session is set to expire. This time is based on the MaxUserDurationinSeconds value, which determines the maximum length of time that a streaming session can run. A streaming session might end earlier than the time specified in SessionMaxExpirationTime, when the DisconnectTimeOutInSeconds elapses or the user chooses to end his or her session. If the DisconnectTimeOutInSeconds elapses, or the user chooses to end his or her session, the streaming instance is terminated and the streaming session ends.
- */
- MaxExpirationTime?: Timestamp;
- /**
- * The authentication method. The user is authenticated using a streaming URL (API) or SAML 2.0 federation (SAML).
- */
- AuthenticationType?: AuthenticationType;
- /**
- * The network details for the streaming session.
- */
- NetworkAccessConfiguration?: NetworkAccessConfiguration;
- /**
- * The identifier for the instance hosting the session.
- */
- InstanceId?: String;
- }
- export type SessionConnectionState = "CONNECTED"|"NOT_CONNECTED"|string;
- export type SessionList = Session[];
- export type SessionState = "ACTIVE"|"PENDING"|"EXPIRED"|string;
- export type SettingsGroup = string;
- export interface SharedImagePermissions {
- /**
- * The 12-digit identifier of the AWS account with which the image is shared.
- */
- sharedAccountId: AwsAccountId;
- /**
- * Describes the permissions for a shared image.
- */
- imagePermissions: ImagePermissions;
- }
- export type SharedImagePermissionsList = SharedImagePermissions[];
- export interface Stack {
- /**
- * The ARN of the stack.
- */
- Arn?: Arn;
- /**
- * The name of the stack.
- */
- Name: String;
- /**
- * The description to display.
- */
- Description?: String;
- /**
- * The stack name to display.
- */
- DisplayName?: String;
- /**
- * The time the stack was created.
- */
- CreatedTime?: Timestamp;
- /**
- * The storage connectors to enable.
- */
- StorageConnectors?: StorageConnectorList;
- /**
- * The URL that users are redirected to after their streaming session ends.
- */
- RedirectURL?: RedirectURL;
- /**
- * The URL that users are redirected to after they click the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
- */
- FeedbackURL?: FeedbackURL;
- /**
- * The errors for the stack.
- */
- StackErrors?: StackErrors;
- /**
- * The actions that are enabled or disabled for users during their streaming sessions. By default these actions are enabled.
- */
- UserSettings?: UserSettingList;
- /**
- * The persistent application settings for users of the stack.
- */
- ApplicationSettings?: ApplicationSettingsResponse;
- /**
- * The list of virtual private cloud (VPC) interface endpoint objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
- */
- AccessEndpoints?: AccessEndpointList;
- /**
- * The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
- */
- EmbedHostDomains?: EmbedHostDomains;
- /**
- * The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
- */
- StreamingExperienceSettings?: StreamingExperienceSettings;
- }
- export type StackAttribute = "STORAGE_CONNECTORS"|"STORAGE_CONNECTOR_HOMEFOLDERS"|"STORAGE_CONNECTOR_GOOGLE_DRIVE"|"STORAGE_CONNECTOR_ONE_DRIVE"|"REDIRECT_URL"|"FEEDBACK_URL"|"THEME_NAME"|"USER_SETTINGS"|"EMBED_HOST_DOMAINS"|"IAM_ROLE_ARN"|"ACCESS_ENDPOINTS"|"STREAMING_EXPERIENCE_SETTINGS"|string;
- export type StackAttributes = StackAttribute[];
- export interface StackError {
- /**
- * The error code.
- */
- ErrorCode?: StackErrorCode;
- /**
- * The error message.
- */
- ErrorMessage?: String;
- }
- export type StackErrorCode = "STORAGE_CONNECTOR_ERROR"|"INTERNAL_SERVICE_ERROR"|string;
- export type StackErrors = StackError[];
- export type StackList = Stack[];
- export interface StartAppBlockBuilderRequest {
- /**
- * The name of the app block builder.
- */
- Name: Name;
- }
- export interface StartAppBlockBuilderResult {
- AppBlockBuilder?: AppBlockBuilder;
- }
- export interface StartFleetRequest {
- /**
- * The name of the fleet.
- */
- Name: String;
- }
- export interface StartFleetResult {
- }
- export interface StartImageBuilderRequest {
- /**
- * The name of the image builder.
- */
- Name: String;
- /**
- * The version of the AppStream 2.0 agent to use for this image builder. To use the latest version of the AppStream 2.0 agent, specify [LATEST].
- */
- AppstreamAgentVersion?: AppstreamAgentVersion;
- }
- export interface StartImageBuilderResult {
- /**
- * Information about the image builder.
- */
- ImageBuilder?: ImageBuilder;
- }
- export interface StopAppBlockBuilderRequest {
- /**
- * The name of the app block builder.
- */
- Name: Name;
- }
- export interface StopAppBlockBuilderResult {
- AppBlockBuilder?: AppBlockBuilder;
- }
- export interface StopFleetRequest {
- /**
- * The name of the fleet.
- */
- Name: String;
- }
- export interface StopFleetResult {
- }
- export interface StopImageBuilderRequest {
- /**
- * The name of the image builder.
- */
- Name: String;
- }
- export interface StopImageBuilderResult {
- /**
- * Information about the image builder.
- */
- ImageBuilder?: ImageBuilder;
- }
- export interface StorageConnector {
- /**
- * The type of storage connector.
- */
- ConnectorType: StorageConnectorType;
- /**
- * The ARN of the storage connector.
- */
- ResourceIdentifier?: ResourceIdentifier;
- /**
- * The names of the domains for the account.
- */
- Domains?: DomainList;
- }
- export type StorageConnectorList = StorageConnector[];
- export type StorageConnectorType = "HOMEFOLDERS"|"GOOGLE_DRIVE"|"ONE_DRIVE"|string;
- export type StreamView = "APP"|"DESKTOP"|string;
- export interface StreamingExperienceSettings {
- /**
- * The preferred protocol that you want to use while streaming your application.
- */
- PreferredProtocol?: PreferredProtocol;
- }
- export type StreamingUrlUserId = string;
- export type String = string;
- export type StringList = String[];
- export type SubnetIdList = String[];
- export type TagKey = string;
- export type TagKeyList = TagKey[];
- export interface TagResourceRequest {
- /**
- * The Amazon Resource Name (ARN) of the resource.
- */
- ResourceArn: Arn;
- /**
- * The tags to associate. A tag is a key-value pair, and the value is optional. For example, Environment=Test. If you do not specify a value, Environment=. If you do not specify a value, the value is set to an empty string. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following special characters: _ . : / = + \ - @
- */
- Tags: Tags;
- }
- export interface TagResourceResponse {
- }
- export type TagValue = string;
- export type Tags = {[key: string]: TagValue};
- export type Timestamp = Date;
- export interface UntagResourceRequest {
- /**
- * The Amazon Resource Name (ARN) of the resource.
- */
- ResourceArn: Arn;
- /**
- * The tag keys for the tags to disassociate.
- */
- TagKeys: TagKeyList;
- }
- export interface UntagResourceResponse {
- }
- export interface UpdateAppBlockBuilderRequest {
- /**
- * The unique name for the app block builder.
- */
- Name: Name;
- /**
- * The description of the app block builder.
- */
- Description?: Description;
- /**
- * The display name of the app block builder.
- */
- DisplayName?: DisplayName;
- /**
- * The platform of the app block builder. WINDOWS_SERVER_2019 is the only valid value.
- */
- Platform?: PlatformType;
- /**
- * The instance type to use when launching the app block builder. The following instance types are available: stream.standard.small stream.standard.medium stream.standard.large stream.standard.xlarge stream.standard.2xlarge
- */
- InstanceType?: String;
- /**
- * The VPC configuration for the app block builder. App block builders require that you specify at least two subnets in different availability zones.
- */
- VpcConfig?: VpcConfig;
- /**
- * Enables or disables default internet access for the app block builder.
- */
- EnableDefaultInternetAccess?: BooleanObject;
- /**
- * The Amazon Resource Name (ARN) of the IAM role to apply to the app block builder. To assume a role, the app block builder calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance. For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
- */
- IamRoleArn?: Arn;
- /**
- * The list of interface VPC endpoint (interface endpoint) objects. Administrators can connect to the app block builder only through the specified endpoints.
- */
- AccessEndpoints?: AccessEndpointList;
- /**
- * The attributes to delete from the app block builder.
- */
- AttributesToDelete?: AppBlockBuilderAttributes;
- }
- export interface UpdateAppBlockBuilderResult {
- AppBlockBuilder?: AppBlockBuilder;
- }
- export interface UpdateApplicationRequest {
- /**
- * The name of the application. This name is visible to users when display name is not specified.
- */
- Name: Name;
- /**
- * The display name of the application. This name is visible to users in the application catalog.
- */
- DisplayName?: DisplayName;
- /**
- * The description of the application.
- */
- Description?: Description;
- /**
- * The icon S3 location of the application.
- */
- IconS3Location?: S3Location;
- /**
- * The launch path of the application.
- */
- LaunchPath?: String;
- /**
- * The working directory of the application.
- */
- WorkingDirectory?: String;
- /**
- * The launch parameters of the application.
- */
- LaunchParameters?: String;
- /**
- * The ARN of the app block.
- */
- AppBlockArn?: Arn;
- /**
- * The attributes to delete for an application.
- */
- AttributesToDelete?: ApplicationAttributes;
- }
- export interface UpdateApplicationResult {
- Application?: Application;
- }
- export interface UpdateDirectoryConfigRequest {
- /**
- * The name of the Directory Config object.
- */
- DirectoryName: DirectoryName;
- /**
- * The distinguished names of the organizational units for computer accounts.
- */
- OrganizationalUnitDistinguishedNames?: OrganizationalUnitDistinguishedNamesList;
- /**
- * The credentials for the service account used by the fleet or image builder to connect to the directory.
- */
- ServiceAccountCredentials?: ServiceAccountCredentials;
- /**
- * The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
- */
- CertificateBasedAuthProperties?: CertificateBasedAuthProperties;
- }
- export interface UpdateDirectoryConfigResult {
- /**
- * Information about the Directory Config object.
- */
- DirectoryConfig?: DirectoryConfig;
- }
- export interface UpdateEntitlementRequest {
- /**
- * The name of the entitlement.
- */
- Name: Name;
- /**
- * The name of the stack with which the entitlement is associated.
- */
- StackName: Name;
- /**
- * The description of the entitlement.
- */
- Description?: Description;
- /**
- * Specifies whether all or only selected apps are entitled.
- */
- AppVisibility?: AppVisibility;
- /**
- * The attributes of the entitlement.
- */
- Attributes?: EntitlementAttributeList;
- }
- export interface UpdateEntitlementResult {
- /**
- * The entitlement.
- */
- Entitlement?: Entitlement;
- }
- export interface UpdateFleetRequest {
- /**
- * The name of the image used to create the fleet.
- */
- ImageName?: String;
- /**
- * The ARN of the public, private, or shared image to use.
- */
- ImageArn?: Arn;
- /**
- * A unique name for the fleet.
- */
- Name?: Name;
- /**
- * The instance type to use when launching fleet instances. The following instance types are available: stream.standard.small stream.standard.medium stream.standard.large stream.standard.xlarge stream.standard.2xlarge stream.compute.large stream.compute.xlarge stream.compute.2xlarge stream.compute.4xlarge stream.compute.8xlarge stream.memory.large stream.memory.xlarge stream.memory.2xlarge stream.memory.4xlarge stream.memory.8xlarge stream.memory.z1d.large stream.memory.z1d.xlarge stream.memory.z1d.2xlarge stream.memory.z1d.3xlarge stream.memory.z1d.6xlarge stream.memory.z1d.12xlarge stream.graphics-design.large stream.graphics-design.xlarge stream.graphics-design.2xlarge stream.graphics-design.4xlarge stream.graphics-desktop.2xlarge stream.graphics.g4dn.xlarge stream.graphics.g4dn.2xlarge stream.graphics.g4dn.4xlarge stream.graphics.g4dn.8xlarge stream.graphics.g4dn.12xlarge stream.graphics.g4dn.16xlarge stream.graphics-pro.4xlarge stream.graphics-pro.8xlarge stream.graphics-pro.16xlarge The following instance types are available for Elastic fleets: stream.standard.small stream.standard.medium stream.standard.large stream.standard.xlarge stream.standard.2xlarge
- */
- InstanceType?: String;
- /**
- * The desired capacity for the fleet. This is not allowed for Elastic fleets.
- */
- ComputeCapacity?: ComputeCapacity;
- /**
- * The VPC configuration for the fleet. This is required for Elastic fleets, but not required for other fleet types. Elastic fleets require that you specify at least two subnets in different availability zones.
- */
- VpcConfig?: VpcConfig;
- /**
- * The maximum amount of time that a streaming session can remain active, in seconds. If users are still connected to a streaming instance five minutes before this limit is reached, they are prompted to save any open documents before being disconnected. After this time elapses, the instance is terminated and replaced by a new instance. Specify a value between 600 and 432000.
- */
- MaxUserDurationInSeconds?: Integer;
- /**
- * The amount of time that a streaming session remains active after users disconnect. If users try to reconnect to the streaming session after a disconnection or network interruption within this time interval, they are connected to their previous session. Otherwise, they are connected to a new session with a new streaming instance. Specify a value between 60 and 360000.
- */
- DisconnectTimeoutInSeconds?: Integer;
- /**
- * Deletes the VPC association for the specified fleet.
- */
- DeleteVpcConfig?: Boolean;
- /**
- * The description to display.
- */
- Description?: Description;
- /**
- * The fleet name to display.
- */
- DisplayName?: DisplayName;
- /**
- * Enables or disables default internet access for the fleet.
- */
- EnableDefaultInternetAccess?: BooleanObject;
- /**
- * The name of the directory and organizational unit (OU) to use to join the fleet to a Microsoft Active Directory domain.
- */
- DomainJoinInfo?: DomainJoinInfo;
- /**
- * The amount of time that users can be idle (inactive) before they are disconnected from their streaming session and the DisconnectTimeoutInSeconds time interval begins. Users are notified before they are disconnected due to inactivity. If users try to reconnect to the streaming session before the time interval specified in DisconnectTimeoutInSeconds elapses, they are connected to their previous session. Users are considered idle when they stop providing keyboard or mouse input during their streaming session. File uploads and downloads, audio in, audio out, and pixels changing do not qualify as user activity. If users continue to be idle after the time interval in IdleDisconnectTimeoutInSeconds elapses, they are disconnected. To prevent users from being disconnected due to inactivity, specify a value of 0. Otherwise, specify a value between 60 and 3600. The default value is 0. If you enable this feature, we recommend that you specify a value that corresponds exactly to a whole number of minutes (for example, 60, 120, and 180). If you don't do this, the value is rounded to the nearest minute. For example, if you specify a value of 70, users are disconnected after 1 minute of inactivity. If you specify a value that is at the midpoint between two different minutes, the value is rounded up. For example, if you specify a value of 90, users are disconnected after 2 minutes of inactivity.
- */
- IdleDisconnectTimeoutInSeconds?: Integer;
- /**
- * The fleet attributes to delete.
- */
- AttributesToDelete?: FleetAttributes;
- /**
- * The Amazon Resource Name (ARN) of the IAM role to apply to the fleet. To assume a role, a fleet instance calls the AWS Security Token Service (STS) AssumeRole API operation and passes the ARN of the role to use. The operation creates a new session with temporary credentials. AppStream 2.0 retrieves the temporary credentials and creates the appstream_machine_role credential profile on the instance. For more information, see Using an IAM Role to Grant Permissions to Applications and Scripts Running on AppStream 2.0 Streaming Instances in the Amazon AppStream 2.0 Administration Guide.
- */
- IamRoleArn?: Arn;
- /**
- * The AppStream 2.0 view that is displayed to your users when they stream from the fleet. When APP is specified, only the windows of applications opened by users display. When DESKTOP is specified, the standard desktop that is provided by the operating system displays. The default value is APP.
- */
- StreamView?: StreamView;
- /**
- * The platform of the fleet. WINDOWS_SERVER_2019 and AMAZON_LINUX2 are supported for Elastic fleets.
- */
- Platform?: PlatformType;
- /**
- * The maximum number of concurrent sessions for a fleet.
- */
- MaxConcurrentSessions?: Integer;
- /**
- * The USB device filter strings that specify which USB devices a user can redirect to the fleet streaming session, when using the Windows native client. This is allowed but not required for Elastic fleets.
- */
- UsbDeviceFilterStrings?: UsbDeviceFilterStrings;
- /**
- * The S3 location of the session scripts configuration zip file. This only applies to Elastic fleets.
- */
- SessionScriptS3Location?: S3Location;
- /**
- * The maximum number of user sessions on an instance. This only applies to multi-session fleets.
- */
- MaxSessionsPerInstance?: Integer;
- }
- export interface UpdateFleetResult {
- /**
- * Information about the fleet.
- */
- Fleet?: Fleet;
- }
- export interface UpdateImagePermissionsRequest {
- /**
- * The name of the private image.
- */
- Name: Name;
- /**
- * The 12-digit identifier of the AWS account for which you want add or update image permissions.
- */
- SharedAccountId: AwsAccountId;
- /**
- * The permissions for the image.
- */
- ImagePermissions: ImagePermissions;
- }
- export interface UpdateImagePermissionsResult {
- }
- export interface UpdateStackRequest {
- /**
- * The stack name to display.
- */
- DisplayName?: DisplayName;
- /**
- * The description to display.
- */
- Description?: Description;
- /**
- * The name of the stack.
- */
- Name: String;
- /**
- * The storage connectors to enable.
- */
- StorageConnectors?: StorageConnectorList;
- /**
- * Deletes the storage connectors currently enabled for the stack.
- */
- DeleteStorageConnectors?: Boolean;
- /**
- * The URL that users are redirected to after their streaming session ends.
- */
- RedirectURL?: RedirectURL;
- /**
- * The URL that users are redirected to after they choose the Send Feedback link. If no URL is specified, no Send Feedback link is displayed.
- */
- FeedbackURL?: FeedbackURL;
- /**
- * The stack attributes to delete.
- */
- AttributesToDelete?: StackAttributes;
- /**
- * The actions that are enabled or disabled for users during their streaming sessions. By default, these actions are enabled.
- */
- UserSettings?: UserSettingList;
- /**
- * The persistent application settings for users of a stack. When these settings are enabled, changes that users make to applications and Windows settings are automatically saved after each session and applied to the next session.
- */
- ApplicationSettings?: ApplicationSettings;
- /**
- * The list of interface VPC endpoint (interface endpoint) objects. Users of the stack can connect to AppStream 2.0 only through the specified endpoints.
- */
- AccessEndpoints?: AccessEndpointList;
- /**
- * The domains where AppStream 2.0 streaming sessions can be embedded in an iframe. You must approve the domains that you want to host embedded AppStream 2.0 streaming sessions.
- */
- EmbedHostDomains?: EmbedHostDomains;
- /**
- * The streaming protocol you want your stack to prefer. This can be UDP or TCP. Currently, UDP is only supported in the Windows native client.
- */
- StreamingExperienceSettings?: StreamingExperienceSettings;
- }
- export interface UpdateStackResult {
- /**
- * Information about the stack.
- */
- Stack?: Stack;
- }
- export type UsageReportExecutionErrorCode = "RESOURCE_NOT_FOUND"|"ACCESS_DENIED"|"INTERNAL_SERVICE_ERROR"|string;
- export type UsageReportSchedule = "DAILY"|string;
- export interface UsageReportSubscription {
- /**
- * The Amazon S3 bucket where generated reports are stored. If you enabled on-instance session scripts and Amazon S3 logging for your session script configuration, AppStream 2.0 created an S3 bucket to store the script output. The bucket is unique to your account and Region. When you enable usage reporting in this case, AppStream 2.0 uses the same bucket to store your usage reports. If you haven't already enabled on-instance session scripts, when you enable usage reports, AppStream 2.0 creates a new S3 bucket.
- */
- S3BucketName?: String;
- /**
- * The schedule for generating usage reports.
- */
- Schedule?: UsageReportSchedule;
- /**
- * The time when the last usage report was generated.
- */
- LastGeneratedReportDate?: Timestamp;
- /**
- * The errors that were returned if usage reports couldn't be generated.
- */
- SubscriptionErrors?: LastReportGenerationExecutionErrors;
- }
- export type UsageReportSubscriptionList = UsageReportSubscription[];
- export type UsbDeviceFilterString = string;
- export type UsbDeviceFilterStrings = UsbDeviceFilterString[];
- export interface User {
- /**
- * The ARN of the user.
- */
- Arn?: Arn;
- /**
- * The email address of the user. Users' email addresses are case-sensitive.
- */
- UserName?: Username;
- /**
- * Specifies whether the user in the user pool is enabled.
- */
- Enabled?: Boolean;
- /**
- * The status of the user in the user pool. The status can be one of the following: UNCONFIRMED – The user is created but not confirmed. CONFIRMED – The user is confirmed. ARCHIVED – The user is no longer active. COMPROMISED – The user is disabled because of a potential security threat. UNKNOWN – The user status is not known.
- */
- Status?: String;
- /**
- * The first name, or given name, of the user.
- */
- FirstName?: UserAttributeValue;
- /**
- * The last name, or surname, of the user.
- */
- LastName?: UserAttributeValue;
- /**
- * The date and time the user was created in the user pool.
- */
- CreatedTime?: Timestamp;
- /**
- * The authentication type for the user.
- */
- AuthenticationType: AuthenticationType;
- }
- export type UserAttributeValue = string;
- export type UserId = string;
- export type UserList = User[];
- export interface UserSetting {
- /**
- * The action that is enabled or disabled.
- */
- Action: Action;
- /**
- * Indicates whether the action is enabled or disabled.
- */
- Permission: Permission;
- /**
- * Specifies the number of characters that can be copied by end users from the local device to the remote session, and to the local device from the remote session. This can be specified only for the CLIPBOARD_COPY_FROM_LOCAL_DEVICE and CLIPBOARD_COPY_TO_LOCAL_DEVICE actions. This defaults to 20,971,520 (20 MB) when unspecified and the permission is ENABLED. This can't be specified when the permission is DISABLED. This can only be specified for AlwaysOn and OnDemand fleets. The attribute is not supported on Elastic fleets. The value can be between 1 and 20,971,520 (20 MB).
- */
- MaximumLength?: Integer;
- }
- export type UserSettingList = UserSetting[];
- export interface UserStackAssociation {
- /**
- * The name of the stack that is associated with the user.
- */
- StackName: String;
- /**
- * The email address of the user who is associated with the stack. Users' email addresses are case-sensitive.
- */
- UserName: Username;
- /**
- * The authentication type for the user.
- */
- AuthenticationType: AuthenticationType;
- /**
- * Specifies whether a welcome email is sent to a user after the user is created in the user pool.
- */
- SendEmailNotification?: Boolean;
- }
- export interface UserStackAssociationError {
- /**
- * Information about the user and associated stack.
- */
- UserStackAssociation?: UserStackAssociation;
- /**
- * The error code for the error that is returned when a user can’t be associated with or disassociated from a stack.
- */
- ErrorCode?: UserStackAssociationErrorCode;
- /**
- * The error message for the error that is returned when a user can’t be associated with or disassociated from a stack.
- */
- ErrorMessage?: String;
- }
- export type UserStackAssociationErrorCode = "STACK_NOT_FOUND"|"USER_NAME_NOT_FOUND"|"DIRECTORY_NOT_FOUND"|"INTERNAL_ERROR"|string;
- export type UserStackAssociationErrorList = UserStackAssociationError[];
- export type UserStackAssociationList = UserStackAssociation[];
- export type Username = string;
- export type VisibilityType = "PUBLIC"|"PRIVATE"|"SHARED"|string;
- export interface VpcConfig {
- /**
- * The identifiers of the subnets to which a network interface is attached from the fleet instance or image builder instance. Fleet instances use one or more subnets. Image builder instances use one subnet.
- */
- SubnetIds?: SubnetIdList;
- /**
- * The identifiers of the security groups for the fleet or image builder.
- */
- SecurityGroupIds?: SecurityGroupIdList;
- }
- /**
- * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
- */
- export type apiVersion = "2016-12-01"|"latest"|string;
- export interface ClientApiVersions {
- /**
- * A string in YYYY-MM-DD format that represents the latest possible API version that can be used in this service. Specify 'latest' to use the latest possible version.
- */
- apiVersion?: apiVersion;
- }
- export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
- /**
- * Contains interfaces for use with the AppStream client.
- */
- export import Types = AppStream;
- }
- export = AppStream;
|