licensemanager.d.ts 97 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648
  1. import {Request} from '../lib/request';
  2. import {Response} from '../lib/response';
  3. import {AWSError} from '../lib/error';
  4. import {Service} from '../lib/service';
  5. import {ServiceConfigurationOptions} from '../lib/service';
  6. import {ConfigBase as Config} from '../lib/config-base';
  7. interface Blob {}
  8. declare class LicenseManager extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: LicenseManager.Types.ClientConfiguration)
  13. config: Config & LicenseManager.Types.ClientConfiguration;
  14. /**
  15. * Accepts the specified grant.
  16. */
  17. acceptGrant(params: LicenseManager.Types.AcceptGrantRequest, callback?: (err: AWSError, data: LicenseManager.Types.AcceptGrantResponse) => void): Request<LicenseManager.Types.AcceptGrantResponse, AWSError>;
  18. /**
  19. * Accepts the specified grant.
  20. */
  21. acceptGrant(callback?: (err: AWSError, data: LicenseManager.Types.AcceptGrantResponse) => void): Request<LicenseManager.Types.AcceptGrantResponse, AWSError>;
  22. /**
  23. * Checks in the specified license. Check in a license when it is no longer in use.
  24. */
  25. checkInLicense(params: LicenseManager.Types.CheckInLicenseRequest, callback?: (err: AWSError, data: LicenseManager.Types.CheckInLicenseResponse) => void): Request<LicenseManager.Types.CheckInLicenseResponse, AWSError>;
  26. /**
  27. * Checks in the specified license. Check in a license when it is no longer in use.
  28. */
  29. checkInLicense(callback?: (err: AWSError, data: LicenseManager.Types.CheckInLicenseResponse) => void): Request<LicenseManager.Types.CheckInLicenseResponse, AWSError>;
  30. /**
  31. * Checks out the specified license for offline use.
  32. */
  33. checkoutBorrowLicense(params: LicenseManager.Types.CheckoutBorrowLicenseRequest, callback?: (err: AWSError, data: LicenseManager.Types.CheckoutBorrowLicenseResponse) => void): Request<LicenseManager.Types.CheckoutBorrowLicenseResponse, AWSError>;
  34. /**
  35. * Checks out the specified license for offline use.
  36. */
  37. checkoutBorrowLicense(callback?: (err: AWSError, data: LicenseManager.Types.CheckoutBorrowLicenseResponse) => void): Request<LicenseManager.Types.CheckoutBorrowLicenseResponse, AWSError>;
  38. /**
  39. * Checks out the specified license. If the account that created the license is the same that is performing the check out, you must specify the account as the beneficiary.
  40. */
  41. checkoutLicense(params: LicenseManager.Types.CheckoutLicenseRequest, callback?: (err: AWSError, data: LicenseManager.Types.CheckoutLicenseResponse) => void): Request<LicenseManager.Types.CheckoutLicenseResponse, AWSError>;
  42. /**
  43. * Checks out the specified license. If the account that created the license is the same that is performing the check out, you must specify the account as the beneficiary.
  44. */
  45. checkoutLicense(callback?: (err: AWSError, data: LicenseManager.Types.CheckoutLicenseResponse) => void): Request<LicenseManager.Types.CheckoutLicenseResponse, AWSError>;
  46. /**
  47. * Creates a grant for the specified license. A grant shares the use of license entitlements with a specific Amazon Web Services account, an organization, or an organizational unit (OU). For more information, see Granted licenses in License Manager in the License Manager User Guide.
  48. */
  49. createGrant(params: LicenseManager.Types.CreateGrantRequest, callback?: (err: AWSError, data: LicenseManager.Types.CreateGrantResponse) => void): Request<LicenseManager.Types.CreateGrantResponse, AWSError>;
  50. /**
  51. * Creates a grant for the specified license. A grant shares the use of license entitlements with a specific Amazon Web Services account, an organization, or an organizational unit (OU). For more information, see Granted licenses in License Manager in the License Manager User Guide.
  52. */
  53. createGrant(callback?: (err: AWSError, data: LicenseManager.Types.CreateGrantResponse) => void): Request<LicenseManager.Types.CreateGrantResponse, AWSError>;
  54. /**
  55. * Creates a new version of the specified grant. For more information, see Granted licenses in License Manager in the License Manager User Guide.
  56. */
  57. createGrantVersion(params: LicenseManager.Types.CreateGrantVersionRequest, callback?: (err: AWSError, data: LicenseManager.Types.CreateGrantVersionResponse) => void): Request<LicenseManager.Types.CreateGrantVersionResponse, AWSError>;
  58. /**
  59. * Creates a new version of the specified grant. For more information, see Granted licenses in License Manager in the License Manager User Guide.
  60. */
  61. createGrantVersion(callback?: (err: AWSError, data: LicenseManager.Types.CreateGrantVersionResponse) => void): Request<LicenseManager.Types.CreateGrantVersionResponse, AWSError>;
  62. /**
  63. * Creates a license.
  64. */
  65. createLicense(params: LicenseManager.Types.CreateLicenseRequest, callback?: (err: AWSError, data: LicenseManager.Types.CreateLicenseResponse) => void): Request<LicenseManager.Types.CreateLicenseResponse, AWSError>;
  66. /**
  67. * Creates a license.
  68. */
  69. createLicense(callback?: (err: AWSError, data: LicenseManager.Types.CreateLicenseResponse) => void): Request<LicenseManager.Types.CreateLicenseResponse, AWSError>;
  70. /**
  71. * Creates a license configuration. A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), license affinity to host (how long a license must be associated with a host), and the number of licenses purchased and used.
  72. */
  73. createLicenseConfiguration(params: LicenseManager.Types.CreateLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.CreateLicenseConfigurationResponse) => void): Request<LicenseManager.Types.CreateLicenseConfigurationResponse, AWSError>;
  74. /**
  75. * Creates a license configuration. A license configuration is an abstraction of a customer license agreement that can be consumed and enforced by License Manager. Components include specifications for the license type (licensing by instance, socket, CPU, or vCPU), allowed tenancy (shared tenancy, Dedicated Instance, Dedicated Host, or all of these), license affinity to host (how long a license must be associated with a host), and the number of licenses purchased and used.
  76. */
  77. createLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.CreateLicenseConfigurationResponse) => void): Request<LicenseManager.Types.CreateLicenseConfigurationResponse, AWSError>;
  78. /**
  79. * Creates a new license conversion task.
  80. */
  81. createLicenseConversionTaskForResource(params: LicenseManager.Types.CreateLicenseConversionTaskForResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.CreateLicenseConversionTaskForResourceResponse) => void): Request<LicenseManager.Types.CreateLicenseConversionTaskForResourceResponse, AWSError>;
  82. /**
  83. * Creates a new license conversion task.
  84. */
  85. createLicenseConversionTaskForResource(callback?: (err: AWSError, data: LicenseManager.Types.CreateLicenseConversionTaskForResourceResponse) => void): Request<LicenseManager.Types.CreateLicenseConversionTaskForResourceResponse, AWSError>;
  86. /**
  87. * Creates a report generator.
  88. */
  89. createLicenseManagerReportGenerator(params: LicenseManager.Types.CreateLicenseManagerReportGeneratorRequest, callback?: (err: AWSError, data: LicenseManager.Types.CreateLicenseManagerReportGeneratorResponse) => void): Request<LicenseManager.Types.CreateLicenseManagerReportGeneratorResponse, AWSError>;
  90. /**
  91. * Creates a report generator.
  92. */
  93. createLicenseManagerReportGenerator(callback?: (err: AWSError, data: LicenseManager.Types.CreateLicenseManagerReportGeneratorResponse) => void): Request<LicenseManager.Types.CreateLicenseManagerReportGeneratorResponse, AWSError>;
  94. /**
  95. * Creates a new version of the specified license.
  96. */
  97. createLicenseVersion(params: LicenseManager.Types.CreateLicenseVersionRequest, callback?: (err: AWSError, data: LicenseManager.Types.CreateLicenseVersionResponse) => void): Request<LicenseManager.Types.CreateLicenseVersionResponse, AWSError>;
  98. /**
  99. * Creates a new version of the specified license.
  100. */
  101. createLicenseVersion(callback?: (err: AWSError, data: LicenseManager.Types.CreateLicenseVersionResponse) => void): Request<LicenseManager.Types.CreateLicenseVersionResponse, AWSError>;
  102. /**
  103. * Creates a long-lived token. A refresh token is a JWT token used to get an access token. With an access token, you can call AssumeRoleWithWebIdentity to get role credentials that you can use to call License Manager to manage the specified license.
  104. */
  105. createToken(params: LicenseManager.Types.CreateTokenRequest, callback?: (err: AWSError, data: LicenseManager.Types.CreateTokenResponse) => void): Request<LicenseManager.Types.CreateTokenResponse, AWSError>;
  106. /**
  107. * Creates a long-lived token. A refresh token is a JWT token used to get an access token. With an access token, you can call AssumeRoleWithWebIdentity to get role credentials that you can use to call License Manager to manage the specified license.
  108. */
  109. createToken(callback?: (err: AWSError, data: LicenseManager.Types.CreateTokenResponse) => void): Request<LicenseManager.Types.CreateTokenResponse, AWSError>;
  110. /**
  111. * Deletes the specified grant.
  112. */
  113. deleteGrant(params: LicenseManager.Types.DeleteGrantRequest, callback?: (err: AWSError, data: LicenseManager.Types.DeleteGrantResponse) => void): Request<LicenseManager.Types.DeleteGrantResponse, AWSError>;
  114. /**
  115. * Deletes the specified grant.
  116. */
  117. deleteGrant(callback?: (err: AWSError, data: LicenseManager.Types.DeleteGrantResponse) => void): Request<LicenseManager.Types.DeleteGrantResponse, AWSError>;
  118. /**
  119. * Deletes the specified license.
  120. */
  121. deleteLicense(params: LicenseManager.Types.DeleteLicenseRequest, callback?: (err: AWSError, data: LicenseManager.Types.DeleteLicenseResponse) => void): Request<LicenseManager.Types.DeleteLicenseResponse, AWSError>;
  122. /**
  123. * Deletes the specified license.
  124. */
  125. deleteLicense(callback?: (err: AWSError, data: LicenseManager.Types.DeleteLicenseResponse) => void): Request<LicenseManager.Types.DeleteLicenseResponse, AWSError>;
  126. /**
  127. * Deletes the specified license configuration. You cannot delete a license configuration that is in use.
  128. */
  129. deleteLicenseConfiguration(params: LicenseManager.Types.DeleteLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.DeleteLicenseConfigurationResponse) => void): Request<LicenseManager.Types.DeleteLicenseConfigurationResponse, AWSError>;
  130. /**
  131. * Deletes the specified license configuration. You cannot delete a license configuration that is in use.
  132. */
  133. deleteLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.DeleteLicenseConfigurationResponse) => void): Request<LicenseManager.Types.DeleteLicenseConfigurationResponse, AWSError>;
  134. /**
  135. * Deletes the specified report generator. This action deletes the report generator, which stops it from generating future reports. The action cannot be reversed. It has no effect on the previous reports from this generator.
  136. */
  137. deleteLicenseManagerReportGenerator(params: LicenseManager.Types.DeleteLicenseManagerReportGeneratorRequest, callback?: (err: AWSError, data: LicenseManager.Types.DeleteLicenseManagerReportGeneratorResponse) => void): Request<LicenseManager.Types.DeleteLicenseManagerReportGeneratorResponse, AWSError>;
  138. /**
  139. * Deletes the specified report generator. This action deletes the report generator, which stops it from generating future reports. The action cannot be reversed. It has no effect on the previous reports from this generator.
  140. */
  141. deleteLicenseManagerReportGenerator(callback?: (err: AWSError, data: LicenseManager.Types.DeleteLicenseManagerReportGeneratorResponse) => void): Request<LicenseManager.Types.DeleteLicenseManagerReportGeneratorResponse, AWSError>;
  142. /**
  143. * Deletes the specified token. Must be called in the license home Region.
  144. */
  145. deleteToken(params: LicenseManager.Types.DeleteTokenRequest, callback?: (err: AWSError, data: LicenseManager.Types.DeleteTokenResponse) => void): Request<LicenseManager.Types.DeleteTokenResponse, AWSError>;
  146. /**
  147. * Deletes the specified token. Must be called in the license home Region.
  148. */
  149. deleteToken(callback?: (err: AWSError, data: LicenseManager.Types.DeleteTokenResponse) => void): Request<LicenseManager.Types.DeleteTokenResponse, AWSError>;
  150. /**
  151. * Extends the expiration date for license consumption.
  152. */
  153. extendLicenseConsumption(params: LicenseManager.Types.ExtendLicenseConsumptionRequest, callback?: (err: AWSError, data: LicenseManager.Types.ExtendLicenseConsumptionResponse) => void): Request<LicenseManager.Types.ExtendLicenseConsumptionResponse, AWSError>;
  154. /**
  155. * Extends the expiration date for license consumption.
  156. */
  157. extendLicenseConsumption(callback?: (err: AWSError, data: LicenseManager.Types.ExtendLicenseConsumptionResponse) => void): Request<LicenseManager.Types.ExtendLicenseConsumptionResponse, AWSError>;
  158. /**
  159. * Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens are valid for one hour.
  160. */
  161. getAccessToken(params: LicenseManager.Types.GetAccessTokenRequest, callback?: (err: AWSError, data: LicenseManager.Types.GetAccessTokenResponse) => void): Request<LicenseManager.Types.GetAccessTokenResponse, AWSError>;
  162. /**
  163. * Gets a temporary access token to use with AssumeRoleWithWebIdentity. Access tokens are valid for one hour.
  164. */
  165. getAccessToken(callback?: (err: AWSError, data: LicenseManager.Types.GetAccessTokenResponse) => void): Request<LicenseManager.Types.GetAccessTokenResponse, AWSError>;
  166. /**
  167. * Gets detailed information about the specified grant.
  168. */
  169. getGrant(params: LicenseManager.Types.GetGrantRequest, callback?: (err: AWSError, data: LicenseManager.Types.GetGrantResponse) => void): Request<LicenseManager.Types.GetGrantResponse, AWSError>;
  170. /**
  171. * Gets detailed information about the specified grant.
  172. */
  173. getGrant(callback?: (err: AWSError, data: LicenseManager.Types.GetGrantResponse) => void): Request<LicenseManager.Types.GetGrantResponse, AWSError>;
  174. /**
  175. * Gets detailed information about the specified license.
  176. */
  177. getLicense(params: LicenseManager.Types.GetLicenseRequest, callback?: (err: AWSError, data: LicenseManager.Types.GetLicenseResponse) => void): Request<LicenseManager.Types.GetLicenseResponse, AWSError>;
  178. /**
  179. * Gets detailed information about the specified license.
  180. */
  181. getLicense(callback?: (err: AWSError, data: LicenseManager.Types.GetLicenseResponse) => void): Request<LicenseManager.Types.GetLicenseResponse, AWSError>;
  182. /**
  183. * Gets detailed information about the specified license configuration.
  184. */
  185. getLicenseConfiguration(params: LicenseManager.Types.GetLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.GetLicenseConfigurationResponse) => void): Request<LicenseManager.Types.GetLicenseConfigurationResponse, AWSError>;
  186. /**
  187. * Gets detailed information about the specified license configuration.
  188. */
  189. getLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.GetLicenseConfigurationResponse) => void): Request<LicenseManager.Types.GetLicenseConfigurationResponse, AWSError>;
  190. /**
  191. * Gets information about the specified license type conversion task.
  192. */
  193. getLicenseConversionTask(params: LicenseManager.Types.GetLicenseConversionTaskRequest, callback?: (err: AWSError, data: LicenseManager.Types.GetLicenseConversionTaskResponse) => void): Request<LicenseManager.Types.GetLicenseConversionTaskResponse, AWSError>;
  194. /**
  195. * Gets information about the specified license type conversion task.
  196. */
  197. getLicenseConversionTask(callback?: (err: AWSError, data: LicenseManager.Types.GetLicenseConversionTaskResponse) => void): Request<LicenseManager.Types.GetLicenseConversionTaskResponse, AWSError>;
  198. /**
  199. * Gets information about the specified report generator.
  200. */
  201. getLicenseManagerReportGenerator(params: LicenseManager.Types.GetLicenseManagerReportGeneratorRequest, callback?: (err: AWSError, data: LicenseManager.Types.GetLicenseManagerReportGeneratorResponse) => void): Request<LicenseManager.Types.GetLicenseManagerReportGeneratorResponse, AWSError>;
  202. /**
  203. * Gets information about the specified report generator.
  204. */
  205. getLicenseManagerReportGenerator(callback?: (err: AWSError, data: LicenseManager.Types.GetLicenseManagerReportGeneratorResponse) => void): Request<LicenseManager.Types.GetLicenseManagerReportGeneratorResponse, AWSError>;
  206. /**
  207. * Gets detailed information about the usage of the specified license.
  208. */
  209. getLicenseUsage(params: LicenseManager.Types.GetLicenseUsageRequest, callback?: (err: AWSError, data: LicenseManager.Types.GetLicenseUsageResponse) => void): Request<LicenseManager.Types.GetLicenseUsageResponse, AWSError>;
  210. /**
  211. * Gets detailed information about the usage of the specified license.
  212. */
  213. getLicenseUsage(callback?: (err: AWSError, data: LicenseManager.Types.GetLicenseUsageResponse) => void): Request<LicenseManager.Types.GetLicenseUsageResponse, AWSError>;
  214. /**
  215. * Gets the License Manager settings for the current Region.
  216. */
  217. getServiceSettings(params: LicenseManager.Types.GetServiceSettingsRequest, callback?: (err: AWSError, data: LicenseManager.Types.GetServiceSettingsResponse) => void): Request<LicenseManager.Types.GetServiceSettingsResponse, AWSError>;
  218. /**
  219. * Gets the License Manager settings for the current Region.
  220. */
  221. getServiceSettings(callback?: (err: AWSError, data: LicenseManager.Types.GetServiceSettingsResponse) => void): Request<LicenseManager.Types.GetServiceSettingsResponse, AWSError>;
  222. /**
  223. * Lists the resource associations for the specified license configuration. Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance might not consume a license (depending on the license rules).
  224. */
  225. listAssociationsForLicenseConfiguration(params: LicenseManager.Types.ListAssociationsForLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListAssociationsForLicenseConfigurationResponse) => void): Request<LicenseManager.Types.ListAssociationsForLicenseConfigurationResponse, AWSError>;
  226. /**
  227. * Lists the resource associations for the specified license configuration. Resource associations need not consume licenses from a license configuration. For example, an AMI or a stopped instance might not consume a license (depending on the license rules).
  228. */
  229. listAssociationsForLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.ListAssociationsForLicenseConfigurationResponse) => void): Request<LicenseManager.Types.ListAssociationsForLicenseConfigurationResponse, AWSError>;
  230. /**
  231. * Lists the grants distributed for the specified license.
  232. */
  233. listDistributedGrants(params: LicenseManager.Types.ListDistributedGrantsRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListDistributedGrantsResponse) => void): Request<LicenseManager.Types.ListDistributedGrantsResponse, AWSError>;
  234. /**
  235. * Lists the grants distributed for the specified license.
  236. */
  237. listDistributedGrants(callback?: (err: AWSError, data: LicenseManager.Types.ListDistributedGrantsResponse) => void): Request<LicenseManager.Types.ListDistributedGrantsResponse, AWSError>;
  238. /**
  239. * Lists the license configuration operations that failed.
  240. */
  241. listFailuresForLicenseConfigurationOperations(params: LicenseManager.Types.ListFailuresForLicenseConfigurationOperationsRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListFailuresForLicenseConfigurationOperationsResponse) => void): Request<LicenseManager.Types.ListFailuresForLicenseConfigurationOperationsResponse, AWSError>;
  242. /**
  243. * Lists the license configuration operations that failed.
  244. */
  245. listFailuresForLicenseConfigurationOperations(callback?: (err: AWSError, data: LicenseManager.Types.ListFailuresForLicenseConfigurationOperationsResponse) => void): Request<LicenseManager.Types.ListFailuresForLicenseConfigurationOperationsResponse, AWSError>;
  246. /**
  247. * Lists the license configurations for your account.
  248. */
  249. listLicenseConfigurations(params: LicenseManager.Types.ListLicenseConfigurationsRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseConfigurationsResponse) => void): Request<LicenseManager.Types.ListLicenseConfigurationsResponse, AWSError>;
  250. /**
  251. * Lists the license configurations for your account.
  252. */
  253. listLicenseConfigurations(callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseConfigurationsResponse) => void): Request<LicenseManager.Types.ListLicenseConfigurationsResponse, AWSError>;
  254. /**
  255. * Lists the license type conversion tasks for your account.
  256. */
  257. listLicenseConversionTasks(params: LicenseManager.Types.ListLicenseConversionTasksRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseConversionTasksResponse) => void): Request<LicenseManager.Types.ListLicenseConversionTasksResponse, AWSError>;
  258. /**
  259. * Lists the license type conversion tasks for your account.
  260. */
  261. listLicenseConversionTasks(callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseConversionTasksResponse) => void): Request<LicenseManager.Types.ListLicenseConversionTasksResponse, AWSError>;
  262. /**
  263. * Lists the report generators for your account.
  264. */
  265. listLicenseManagerReportGenerators(params: LicenseManager.Types.ListLicenseManagerReportGeneratorsRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseManagerReportGeneratorsResponse) => void): Request<LicenseManager.Types.ListLicenseManagerReportGeneratorsResponse, AWSError>;
  266. /**
  267. * Lists the report generators for your account.
  268. */
  269. listLicenseManagerReportGenerators(callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseManagerReportGeneratorsResponse) => void): Request<LicenseManager.Types.ListLicenseManagerReportGeneratorsResponse, AWSError>;
  270. /**
  271. * Describes the license configurations for the specified resource.
  272. */
  273. listLicenseSpecificationsForResource(params: LicenseManager.Types.ListLicenseSpecificationsForResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseSpecificationsForResourceResponse) => void): Request<LicenseManager.Types.ListLicenseSpecificationsForResourceResponse, AWSError>;
  274. /**
  275. * Describes the license configurations for the specified resource.
  276. */
  277. listLicenseSpecificationsForResource(callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseSpecificationsForResourceResponse) => void): Request<LicenseManager.Types.ListLicenseSpecificationsForResourceResponse, AWSError>;
  278. /**
  279. * Lists all versions of the specified license.
  280. */
  281. listLicenseVersions(params: LicenseManager.Types.ListLicenseVersionsRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseVersionsResponse) => void): Request<LicenseManager.Types.ListLicenseVersionsResponse, AWSError>;
  282. /**
  283. * Lists all versions of the specified license.
  284. */
  285. listLicenseVersions(callback?: (err: AWSError, data: LicenseManager.Types.ListLicenseVersionsResponse) => void): Request<LicenseManager.Types.ListLicenseVersionsResponse, AWSError>;
  286. /**
  287. * Lists the licenses for your account.
  288. */
  289. listLicenses(params: LicenseManager.Types.ListLicensesRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListLicensesResponse) => void): Request<LicenseManager.Types.ListLicensesResponse, AWSError>;
  290. /**
  291. * Lists the licenses for your account.
  292. */
  293. listLicenses(callback?: (err: AWSError, data: LicenseManager.Types.ListLicensesResponse) => void): Request<LicenseManager.Types.ListLicensesResponse, AWSError>;
  294. /**
  295. * Lists grants that are received. Received grants are grants created while specifying the recipient as this Amazon Web Services account, your organization, or an organizational unit (OU) to which this member account belongs.
  296. */
  297. listReceivedGrants(params: LicenseManager.Types.ListReceivedGrantsRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListReceivedGrantsResponse) => void): Request<LicenseManager.Types.ListReceivedGrantsResponse, AWSError>;
  298. /**
  299. * Lists grants that are received. Received grants are grants created while specifying the recipient as this Amazon Web Services account, your organization, or an organizational unit (OU) to which this member account belongs.
  300. */
  301. listReceivedGrants(callback?: (err: AWSError, data: LicenseManager.Types.ListReceivedGrantsResponse) => void): Request<LicenseManager.Types.ListReceivedGrantsResponse, AWSError>;
  302. /**
  303. * Lists the grants received for all accounts in the organization.
  304. */
  305. listReceivedGrantsForOrganization(params: LicenseManager.Types.ListReceivedGrantsForOrganizationRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListReceivedGrantsForOrganizationResponse) => void): Request<LicenseManager.Types.ListReceivedGrantsForOrganizationResponse, AWSError>;
  306. /**
  307. * Lists the grants received for all accounts in the organization.
  308. */
  309. listReceivedGrantsForOrganization(callback?: (err: AWSError, data: LicenseManager.Types.ListReceivedGrantsForOrganizationResponse) => void): Request<LicenseManager.Types.ListReceivedGrantsForOrganizationResponse, AWSError>;
  310. /**
  311. * Lists received licenses.
  312. */
  313. listReceivedLicenses(params: LicenseManager.Types.ListReceivedLicensesRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListReceivedLicensesResponse) => void): Request<LicenseManager.Types.ListReceivedLicensesResponse, AWSError>;
  314. /**
  315. * Lists received licenses.
  316. */
  317. listReceivedLicenses(callback?: (err: AWSError, data: LicenseManager.Types.ListReceivedLicensesResponse) => void): Request<LicenseManager.Types.ListReceivedLicensesResponse, AWSError>;
  318. /**
  319. * Lists the licenses received for all accounts in the organization.
  320. */
  321. listReceivedLicensesForOrganization(params: LicenseManager.Types.ListReceivedLicensesForOrganizationRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListReceivedLicensesForOrganizationResponse) => void): Request<LicenseManager.Types.ListReceivedLicensesForOrganizationResponse, AWSError>;
  322. /**
  323. * Lists the licenses received for all accounts in the organization.
  324. */
  325. listReceivedLicensesForOrganization(callback?: (err: AWSError, data: LicenseManager.Types.ListReceivedLicensesForOrganizationResponse) => void): Request<LicenseManager.Types.ListReceivedLicensesForOrganizationResponse, AWSError>;
  326. /**
  327. * Lists resources managed using Systems Manager inventory.
  328. */
  329. listResourceInventory(params: LicenseManager.Types.ListResourceInventoryRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListResourceInventoryResponse) => void): Request<LicenseManager.Types.ListResourceInventoryResponse, AWSError>;
  330. /**
  331. * Lists resources managed using Systems Manager inventory.
  332. */
  333. listResourceInventory(callback?: (err: AWSError, data: LicenseManager.Types.ListResourceInventoryResponse) => void): Request<LicenseManager.Types.ListResourceInventoryResponse, AWSError>;
  334. /**
  335. * Lists the tags for the specified license configuration.
  336. */
  337. listTagsForResource(params: LicenseManager.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListTagsForResourceResponse) => void): Request<LicenseManager.Types.ListTagsForResourceResponse, AWSError>;
  338. /**
  339. * Lists the tags for the specified license configuration.
  340. */
  341. listTagsForResource(callback?: (err: AWSError, data: LicenseManager.Types.ListTagsForResourceResponse) => void): Request<LicenseManager.Types.ListTagsForResourceResponse, AWSError>;
  342. /**
  343. * Lists your tokens.
  344. */
  345. listTokens(params: LicenseManager.Types.ListTokensRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListTokensResponse) => void): Request<LicenseManager.Types.ListTokensResponse, AWSError>;
  346. /**
  347. * Lists your tokens.
  348. */
  349. listTokens(callback?: (err: AWSError, data: LicenseManager.Types.ListTokensResponse) => void): Request<LicenseManager.Types.ListTokensResponse, AWSError>;
  350. /**
  351. * Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.
  352. */
  353. listUsageForLicenseConfiguration(params: LicenseManager.Types.ListUsageForLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.ListUsageForLicenseConfigurationResponse) => void): Request<LicenseManager.Types.ListUsageForLicenseConfigurationResponse, AWSError>;
  354. /**
  355. * Lists all license usage records for a license configuration, displaying license consumption details by resource at a selected point in time. Use this action to audit the current license consumption for any license inventory and configuration.
  356. */
  357. listUsageForLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.ListUsageForLicenseConfigurationResponse) => void): Request<LicenseManager.Types.ListUsageForLicenseConfigurationResponse, AWSError>;
  358. /**
  359. * Rejects the specified grant.
  360. */
  361. rejectGrant(params: LicenseManager.Types.RejectGrantRequest, callback?: (err: AWSError, data: LicenseManager.Types.RejectGrantResponse) => void): Request<LicenseManager.Types.RejectGrantResponse, AWSError>;
  362. /**
  363. * Rejects the specified grant.
  364. */
  365. rejectGrant(callback?: (err: AWSError, data: LicenseManager.Types.RejectGrantResponse) => void): Request<LicenseManager.Types.RejectGrantResponse, AWSError>;
  366. /**
  367. * Adds the specified tags to the specified license configuration.
  368. */
  369. tagResource(params: LicenseManager.Types.TagResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.TagResourceResponse) => void): Request<LicenseManager.Types.TagResourceResponse, AWSError>;
  370. /**
  371. * Adds the specified tags to the specified license configuration.
  372. */
  373. tagResource(callback?: (err: AWSError, data: LicenseManager.Types.TagResourceResponse) => void): Request<LicenseManager.Types.TagResourceResponse, AWSError>;
  374. /**
  375. * Removes the specified tags from the specified license configuration.
  376. */
  377. untagResource(params: LicenseManager.Types.UntagResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.UntagResourceResponse) => void): Request<LicenseManager.Types.UntagResourceResponse, AWSError>;
  378. /**
  379. * Removes the specified tags from the specified license configuration.
  380. */
  381. untagResource(callback?: (err: AWSError, data: LicenseManager.Types.UntagResourceResponse) => void): Request<LicenseManager.Types.UntagResourceResponse, AWSError>;
  382. /**
  383. * Modifies the attributes of an existing license configuration.
  384. */
  385. updateLicenseConfiguration(params: LicenseManager.Types.UpdateLicenseConfigurationRequest, callback?: (err: AWSError, data: LicenseManager.Types.UpdateLicenseConfigurationResponse) => void): Request<LicenseManager.Types.UpdateLicenseConfigurationResponse, AWSError>;
  386. /**
  387. * Modifies the attributes of an existing license configuration.
  388. */
  389. updateLicenseConfiguration(callback?: (err: AWSError, data: LicenseManager.Types.UpdateLicenseConfigurationResponse) => void): Request<LicenseManager.Types.UpdateLicenseConfigurationResponse, AWSError>;
  390. /**
  391. * Updates a report generator. After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated.
  392. */
  393. updateLicenseManagerReportGenerator(params: LicenseManager.Types.UpdateLicenseManagerReportGeneratorRequest, callback?: (err: AWSError, data: LicenseManager.Types.UpdateLicenseManagerReportGeneratorResponse) => void): Request<LicenseManager.Types.UpdateLicenseManagerReportGeneratorResponse, AWSError>;
  394. /**
  395. * Updates a report generator. After you make changes to a report generator, it starts generating new reports within 60 minutes of being updated.
  396. */
  397. updateLicenseManagerReportGenerator(callback?: (err: AWSError, data: LicenseManager.Types.UpdateLicenseManagerReportGeneratorResponse) => void): Request<LicenseManager.Types.UpdateLicenseManagerReportGeneratorResponse, AWSError>;
  398. /**
  399. * Adds or removes the specified license configurations for the specified Amazon Web Services resource. You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and CloudFormation templates, as they send license configurations to the operation that creates the resource.
  400. */
  401. updateLicenseSpecificationsForResource(params: LicenseManager.Types.UpdateLicenseSpecificationsForResourceRequest, callback?: (err: AWSError, data: LicenseManager.Types.UpdateLicenseSpecificationsForResourceResponse) => void): Request<LicenseManager.Types.UpdateLicenseSpecificationsForResourceResponse, AWSError>;
  402. /**
  403. * Adds or removes the specified license configurations for the specified Amazon Web Services resource. You can update the license specifications of AMIs, instances, and hosts. You cannot update the license specifications for launch templates and CloudFormation templates, as they send license configurations to the operation that creates the resource.
  404. */
  405. updateLicenseSpecificationsForResource(callback?: (err: AWSError, data: LicenseManager.Types.UpdateLicenseSpecificationsForResourceResponse) => void): Request<LicenseManager.Types.UpdateLicenseSpecificationsForResourceResponse, AWSError>;
  406. /**
  407. * Updates License Manager settings for the current Region.
  408. */
  409. updateServiceSettings(params: LicenseManager.Types.UpdateServiceSettingsRequest, callback?: (err: AWSError, data: LicenseManager.Types.UpdateServiceSettingsResponse) => void): Request<LicenseManager.Types.UpdateServiceSettingsResponse, AWSError>;
  410. /**
  411. * Updates License Manager settings for the current Region.
  412. */
  413. updateServiceSettings(callback?: (err: AWSError, data: LicenseManager.Types.UpdateServiceSettingsResponse) => void): Request<LicenseManager.Types.UpdateServiceSettingsResponse, AWSError>;
  414. }
  415. declare namespace LicenseManager {
  416. export interface AcceptGrantRequest {
  417. /**
  418. * Amazon Resource Name (ARN) of the grant.
  419. */
  420. GrantArn: Arn;
  421. }
  422. export interface AcceptGrantResponse {
  423. /**
  424. * Grant ARN.
  425. */
  426. GrantArn?: Arn;
  427. /**
  428. * Grant status.
  429. */
  430. Status?: GrantStatus;
  431. /**
  432. * Grant version.
  433. */
  434. Version?: String;
  435. }
  436. export type ActivationOverrideBehavior = "DISTRIBUTED_GRANTS_ONLY"|"ALL_GRANTS_PERMITTED_BY_ISSUER"|string;
  437. export type AllowedOperation = "CreateGrant"|"CheckoutLicense"|"CheckoutBorrowLicense"|"CheckInLicense"|"ExtendConsumptionLicense"|"ListPurchasedLicenses"|"CreateToken"|string;
  438. export type AllowedOperationList = AllowedOperation[];
  439. export type Arn = string;
  440. export type ArnList = Arn[];
  441. export interface AutomatedDiscoveryInformation {
  442. /**
  443. * Time that automated discovery last ran.
  444. */
  445. LastRunTime?: DateTime;
  446. }
  447. export type Boolean = boolean;
  448. export interface BorrowConfiguration {
  449. /**
  450. * Indicates whether early check-ins are allowed.
  451. */
  452. AllowEarlyCheckIn: BoxBoolean;
  453. /**
  454. * Maximum time for the borrow configuration, in minutes.
  455. */
  456. MaxTimeToLiveInMinutes: BoxInteger;
  457. }
  458. export type BoxBoolean = boolean;
  459. export type BoxInteger = number;
  460. export type BoxLong = number;
  461. export interface CheckInLicenseRequest {
  462. /**
  463. * License consumption token.
  464. */
  465. LicenseConsumptionToken: String;
  466. /**
  467. * License beneficiary.
  468. */
  469. Beneficiary?: String;
  470. }
  471. export interface CheckInLicenseResponse {
  472. }
  473. export interface CheckoutBorrowLicenseRequest {
  474. /**
  475. * Amazon Resource Name (ARN) of the license. The license must use the borrow consumption configuration.
  476. */
  477. LicenseArn: Arn;
  478. /**
  479. * License entitlements. Partial checkouts are not supported.
  480. */
  481. Entitlements: EntitlementDataList;
  482. /**
  483. * Digital signature method. The possible value is JSON Web Signature (JWS) algorithm PS384. For more information, see RFC 7518 Digital Signature with RSASSA-PSS.
  484. */
  485. DigitalSignatureMethod: DigitalSignatureMethod;
  486. /**
  487. * Node ID.
  488. */
  489. NodeId?: String;
  490. /**
  491. * Information about constraints.
  492. */
  493. CheckoutMetadata?: MetadataList;
  494. /**
  495. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  496. */
  497. ClientToken: ClientToken;
  498. }
  499. export interface CheckoutBorrowLicenseResponse {
  500. /**
  501. * Amazon Resource Name (ARN) of the license.
  502. */
  503. LicenseArn?: Arn;
  504. /**
  505. * License consumption token.
  506. */
  507. LicenseConsumptionToken?: String;
  508. /**
  509. * Allowed license entitlements.
  510. */
  511. EntitlementsAllowed?: EntitlementDataList;
  512. /**
  513. * Node ID.
  514. */
  515. NodeId?: String;
  516. /**
  517. * Signed token.
  518. */
  519. SignedToken?: SignedToken;
  520. /**
  521. * Date and time at which the license checkout is issued.
  522. */
  523. IssuedAt?: ISO8601DateTime;
  524. /**
  525. * Date and time at which the license checkout expires.
  526. */
  527. Expiration?: ISO8601DateTime;
  528. /**
  529. * Information about constraints.
  530. */
  531. CheckoutMetadata?: MetadataList;
  532. }
  533. export interface CheckoutLicenseRequest {
  534. /**
  535. * Product SKU.
  536. */
  537. ProductSKU: String;
  538. /**
  539. * Checkout type.
  540. */
  541. CheckoutType: CheckoutType;
  542. /**
  543. * Key fingerprint identifying the license.
  544. */
  545. KeyFingerprint: String;
  546. /**
  547. * License entitlements.
  548. */
  549. Entitlements: EntitlementDataList;
  550. /**
  551. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  552. */
  553. ClientToken: ClientToken;
  554. /**
  555. * License beneficiary.
  556. */
  557. Beneficiary?: String;
  558. /**
  559. * Node ID.
  560. */
  561. NodeId?: String;
  562. }
  563. export interface CheckoutLicenseResponse {
  564. /**
  565. * Checkout type.
  566. */
  567. CheckoutType?: CheckoutType;
  568. /**
  569. * License consumption token.
  570. */
  571. LicenseConsumptionToken?: String;
  572. /**
  573. * Allowed license entitlements.
  574. */
  575. EntitlementsAllowed?: EntitlementDataList;
  576. /**
  577. * Signed token.
  578. */
  579. SignedToken?: SignedToken;
  580. /**
  581. * Node ID.
  582. */
  583. NodeId?: String;
  584. /**
  585. * Date and time at which the license checkout is issued.
  586. */
  587. IssuedAt?: ISO8601DateTime;
  588. /**
  589. * Date and time at which the license checkout expires.
  590. */
  591. Expiration?: ISO8601DateTime;
  592. /**
  593. * Amazon Resource Name (ARN) of the checkout license.
  594. */
  595. LicenseArn?: String;
  596. }
  597. export type CheckoutType = "PROVISIONAL"|"PERPETUAL"|string;
  598. export type ClientRequestToken = string;
  599. export type ClientToken = string;
  600. export interface ConsumedLicenseSummary {
  601. /**
  602. * Resource type of the resource consuming a license.
  603. */
  604. ResourceType?: ResourceType;
  605. /**
  606. * Number of licenses consumed by the resource.
  607. */
  608. ConsumedLicenses?: BoxLong;
  609. }
  610. export type ConsumedLicenseSummaryList = ConsumedLicenseSummary[];
  611. export interface ConsumptionConfiguration {
  612. /**
  613. * Renewal frequency.
  614. */
  615. RenewType?: RenewType;
  616. /**
  617. * Details about a provisional configuration.
  618. */
  619. ProvisionalConfiguration?: ProvisionalConfiguration;
  620. /**
  621. * Details about a borrow configuration.
  622. */
  623. BorrowConfiguration?: BorrowConfiguration;
  624. }
  625. export interface CreateGrantRequest {
  626. /**
  627. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  628. */
  629. ClientToken: ClientToken;
  630. /**
  631. * Grant name.
  632. */
  633. GrantName: String;
  634. /**
  635. * Amazon Resource Name (ARN) of the license.
  636. */
  637. LicenseArn: Arn;
  638. /**
  639. * The grant principals. You can specify one of the following as an Amazon Resource Name (ARN): An Amazon Web Services account, which includes only the account specified. An organizational unit (OU), which includes all accounts in the OU. An organization, which will include all accounts across your organization.
  640. */
  641. Principals: PrincipalArnList;
  642. /**
  643. * Home Region of the grant.
  644. */
  645. HomeRegion: String;
  646. /**
  647. * Allowed operations for the grant.
  648. */
  649. AllowedOperations: AllowedOperationList;
  650. }
  651. export interface CreateGrantResponse {
  652. /**
  653. * Grant ARN.
  654. */
  655. GrantArn?: Arn;
  656. /**
  657. * Grant status.
  658. */
  659. Status?: GrantStatus;
  660. /**
  661. * Grant version.
  662. */
  663. Version?: String;
  664. }
  665. export interface CreateGrantVersionRequest {
  666. /**
  667. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  668. */
  669. ClientToken: ClientToken;
  670. /**
  671. * Amazon Resource Name (ARN) of the grant.
  672. */
  673. GrantArn: Arn;
  674. /**
  675. * Grant name.
  676. */
  677. GrantName?: String;
  678. /**
  679. * Allowed operations for the grant.
  680. */
  681. AllowedOperations?: AllowedOperationList;
  682. /**
  683. * Grant status.
  684. */
  685. Status?: GrantStatus;
  686. /**
  687. * Grant status reason.
  688. */
  689. StatusReason?: StatusReasonMessage;
  690. /**
  691. * Current version of the grant.
  692. */
  693. SourceVersion?: String;
  694. /**
  695. * The options specified for the grant.
  696. */
  697. Options?: Options;
  698. }
  699. export interface CreateGrantVersionResponse {
  700. /**
  701. * Grant ARN.
  702. */
  703. GrantArn?: Arn;
  704. /**
  705. * Grant status.
  706. */
  707. Status?: GrantStatus;
  708. /**
  709. * New version of the grant.
  710. */
  711. Version?: String;
  712. }
  713. export interface CreateLicenseConfigurationRequest {
  714. /**
  715. * Name of the license configuration.
  716. */
  717. Name: String;
  718. /**
  719. * Description of the license configuration.
  720. */
  721. Description?: String;
  722. /**
  723. * Dimension used to track the license inventory.
  724. */
  725. LicenseCountingType: LicenseCountingType;
  726. /**
  727. * Number of licenses managed by the license configuration.
  728. */
  729. LicenseCount?: BoxLong;
  730. /**
  731. * Indicates whether hard or soft license enforcement is used. Exceeding a hard limit blocks the launch of new instances.
  732. */
  733. LicenseCountHardLimit?: BoxBoolean;
  734. /**
  735. * License rules. The syntax is #name=value (for example, #allowedTenancy=EC2-DedicatedHost). The available rules vary by dimension, as follows. Cores dimension: allowedTenancy | licenseAffinityToHost | maximumCores | minimumCores Instances dimension: allowedTenancy | maximumCores | minimumCores | maximumSockets | minimumSockets | maximumVcpus | minimumVcpus Sockets dimension: allowedTenancy | licenseAffinityToHost | maximumSockets | minimumSockets vCPUs dimension: allowedTenancy | honorVcpuOptimization | maximumVcpus | minimumVcpus The unit for licenseAffinityToHost is days and the range is 1 to 180. The possible values for allowedTenancy are EC2-Default, EC2-DedicatedHost, and EC2-DedicatedInstance. The possible values for honorVcpuOptimization are True and False.
  736. */
  737. LicenseRules?: StringList;
  738. /**
  739. * Tags to add to the license configuration.
  740. */
  741. Tags?: TagList;
  742. /**
  743. * When true, disassociates a resource when software is uninstalled.
  744. */
  745. DisassociateWhenNotFound?: BoxBoolean;
  746. /**
  747. * Product information.
  748. */
  749. ProductInformationList?: ProductInformationList;
  750. }
  751. export interface CreateLicenseConfigurationResponse {
  752. /**
  753. * Amazon Resource Name (ARN) of the license configuration.
  754. */
  755. LicenseConfigurationArn?: String;
  756. }
  757. export interface CreateLicenseConversionTaskForResourceRequest {
  758. /**
  759. * Amazon Resource Name (ARN) of the resource you are converting the license type for.
  760. */
  761. ResourceArn: Arn;
  762. /**
  763. * Information that identifies the license type you are converting from. For the structure of the source license, see Convert a license type using the CLI in the License Manager User Guide.
  764. */
  765. SourceLicenseContext: LicenseConversionContext;
  766. /**
  767. * Information that identifies the license type you are converting to. For the structure of the destination license, see Convert a license type using the CLI in the License Manager User Guide.
  768. */
  769. DestinationLicenseContext: LicenseConversionContext;
  770. }
  771. export interface CreateLicenseConversionTaskForResourceResponse {
  772. /**
  773. * The ID of the created license type conversion task.
  774. */
  775. LicenseConversionTaskId?: LicenseConversionTaskId;
  776. }
  777. export interface CreateLicenseManagerReportGeneratorRequest {
  778. /**
  779. * Name of the report generator.
  780. */
  781. ReportGeneratorName: ReportGeneratorName;
  782. /**
  783. * Type of reports to generate. The following report types an be generated: License configuration report - Reports the number and details of consumed licenses for a license configuration. Resource report - Reports the tracked licenses and resource consumption for a license configuration.
  784. */
  785. Type: ReportTypeList;
  786. /**
  787. * Defines the type of license configuration the report generator tracks.
  788. */
  789. ReportContext: ReportContext;
  790. /**
  791. * Frequency by which reports are generated. Reports can be generated daily, monthly, or weekly.
  792. */
  793. ReportFrequency: ReportFrequency;
  794. /**
  795. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  796. */
  797. ClientToken: ClientRequestToken;
  798. /**
  799. * Description of the report generator.
  800. */
  801. Description?: String;
  802. /**
  803. * Tags to add to the report generator.
  804. */
  805. Tags?: TagList;
  806. }
  807. export interface CreateLicenseManagerReportGeneratorResponse {
  808. /**
  809. * The Amazon Resource Name (ARN) of the new report generator.
  810. */
  811. LicenseManagerReportGeneratorArn?: String;
  812. }
  813. export interface CreateLicenseRequest {
  814. /**
  815. * License name.
  816. */
  817. LicenseName: String;
  818. /**
  819. * Product name.
  820. */
  821. ProductName: String;
  822. /**
  823. * Product SKU.
  824. */
  825. ProductSKU: String;
  826. /**
  827. * License issuer.
  828. */
  829. Issuer: Issuer;
  830. /**
  831. * Home Region for the license.
  832. */
  833. HomeRegion: String;
  834. /**
  835. * Date and time range during which the license is valid, in ISO8601-UTC format.
  836. */
  837. Validity: DatetimeRange;
  838. /**
  839. * License entitlements.
  840. */
  841. Entitlements: EntitlementList;
  842. /**
  843. * License beneficiary.
  844. */
  845. Beneficiary: String;
  846. /**
  847. * Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.
  848. */
  849. ConsumptionConfiguration: ConsumptionConfiguration;
  850. /**
  851. * Information about the license.
  852. */
  853. LicenseMetadata?: MetadataList;
  854. /**
  855. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  856. */
  857. ClientToken: ClientToken;
  858. }
  859. export interface CreateLicenseResponse {
  860. /**
  861. * Amazon Resource Name (ARN) of the license.
  862. */
  863. LicenseArn?: Arn;
  864. /**
  865. * License status.
  866. */
  867. Status?: LicenseStatus;
  868. /**
  869. * License version.
  870. */
  871. Version?: String;
  872. }
  873. export interface CreateLicenseVersionRequest {
  874. /**
  875. * Amazon Resource Name (ARN) of the license.
  876. */
  877. LicenseArn: Arn;
  878. /**
  879. * License name.
  880. */
  881. LicenseName: String;
  882. /**
  883. * Product name.
  884. */
  885. ProductName: String;
  886. /**
  887. * License issuer.
  888. */
  889. Issuer: Issuer;
  890. /**
  891. * Home Region of the license.
  892. */
  893. HomeRegion: String;
  894. /**
  895. * Date and time range during which the license is valid, in ISO8601-UTC format.
  896. */
  897. Validity: DatetimeRange;
  898. /**
  899. * Information about the license.
  900. */
  901. LicenseMetadata?: MetadataList;
  902. /**
  903. * License entitlements.
  904. */
  905. Entitlements: EntitlementList;
  906. /**
  907. * Configuration for consumption of the license. Choose a provisional configuration for workloads running with continuous connectivity. Choose a borrow configuration for workloads with offline usage.
  908. */
  909. ConsumptionConfiguration: ConsumptionConfiguration;
  910. /**
  911. * License status.
  912. */
  913. Status: LicenseStatus;
  914. /**
  915. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  916. */
  917. ClientToken: ClientToken;
  918. /**
  919. * Current version of the license.
  920. */
  921. SourceVersion?: String;
  922. }
  923. export interface CreateLicenseVersionResponse {
  924. /**
  925. * License ARN.
  926. */
  927. LicenseArn?: Arn;
  928. /**
  929. * New version of the license.
  930. */
  931. Version?: String;
  932. /**
  933. * License status.
  934. */
  935. Status?: LicenseStatus;
  936. }
  937. export interface CreateTokenRequest {
  938. /**
  939. * Amazon Resource Name (ARN) of the license. The ARN is mapped to the aud claim of the JWT token.
  940. */
  941. LicenseArn: Arn;
  942. /**
  943. * Amazon Resource Name (ARN) of the IAM roles to embed in the token. License Manager does not check whether the roles are in use.
  944. */
  945. RoleArns?: ArnList;
  946. /**
  947. * Token expiration, in days, counted from token creation. The default is 365 days.
  948. */
  949. ExpirationInDays?: Integer;
  950. /**
  951. * Data specified by the caller to be included in the JWT token. The data is mapped to the amr claim of the JWT token.
  952. */
  953. TokenProperties?: MaxSize3StringList;
  954. /**
  955. * Idempotency token, valid for 10 minutes.
  956. */
  957. ClientToken: ClientToken;
  958. }
  959. export interface CreateTokenResponse {
  960. /**
  961. * Token ID.
  962. */
  963. TokenId?: String;
  964. /**
  965. * Token type.
  966. */
  967. TokenType?: TokenType;
  968. /**
  969. * Refresh token, encoded as a JWT token.
  970. */
  971. Token?: TokenString;
  972. }
  973. export type DateTime = Date;
  974. export interface DatetimeRange {
  975. /**
  976. * Start of the time range.
  977. */
  978. Begin: ISO8601DateTime;
  979. /**
  980. * End of the time range.
  981. */
  982. End?: ISO8601DateTime;
  983. }
  984. export interface DeleteGrantRequest {
  985. /**
  986. * Amazon Resource Name (ARN) of the grant.
  987. */
  988. GrantArn: Arn;
  989. /**
  990. * The Status reason for the delete request.
  991. */
  992. StatusReason?: StatusReasonMessage;
  993. /**
  994. * Current version of the grant.
  995. */
  996. Version: String;
  997. }
  998. export interface DeleteGrantResponse {
  999. /**
  1000. * Grant ARN.
  1001. */
  1002. GrantArn?: Arn;
  1003. /**
  1004. * Grant status.
  1005. */
  1006. Status?: GrantStatus;
  1007. /**
  1008. * Grant version.
  1009. */
  1010. Version?: String;
  1011. }
  1012. export interface DeleteLicenseConfigurationRequest {
  1013. /**
  1014. * ID of the license configuration.
  1015. */
  1016. LicenseConfigurationArn: String;
  1017. }
  1018. export interface DeleteLicenseConfigurationResponse {
  1019. }
  1020. export interface DeleteLicenseManagerReportGeneratorRequest {
  1021. /**
  1022. * Amazon Resource Name (ARN) of the report generator to be deleted.
  1023. */
  1024. LicenseManagerReportGeneratorArn: String;
  1025. }
  1026. export interface DeleteLicenseManagerReportGeneratorResponse {
  1027. }
  1028. export interface DeleteLicenseRequest {
  1029. /**
  1030. * Amazon Resource Name (ARN) of the license.
  1031. */
  1032. LicenseArn: Arn;
  1033. /**
  1034. * Current version of the license.
  1035. */
  1036. SourceVersion: String;
  1037. }
  1038. export interface DeleteLicenseResponse {
  1039. /**
  1040. * License status.
  1041. */
  1042. Status?: LicenseDeletionStatus;
  1043. /**
  1044. * Date when the license is deleted.
  1045. */
  1046. DeletionDate?: ISO8601DateTime;
  1047. }
  1048. export interface DeleteTokenRequest {
  1049. /**
  1050. * Token ID.
  1051. */
  1052. TokenId: String;
  1053. }
  1054. export interface DeleteTokenResponse {
  1055. }
  1056. export type DigitalSignatureMethod = "JWT_PS384"|string;
  1057. export interface Entitlement {
  1058. /**
  1059. * Entitlement name.
  1060. */
  1061. Name: String;
  1062. /**
  1063. * Entitlement resource. Use only if the unit is None.
  1064. */
  1065. Value?: String;
  1066. /**
  1067. * Maximum entitlement count. Use if the unit is not None.
  1068. */
  1069. MaxCount?: Long;
  1070. /**
  1071. * Indicates whether overages are allowed.
  1072. */
  1073. Overage?: BoxBoolean;
  1074. /**
  1075. * Entitlement unit.
  1076. */
  1077. Unit: EntitlementUnit;
  1078. /**
  1079. * Indicates whether check-ins are allowed.
  1080. */
  1081. AllowCheckIn?: BoxBoolean;
  1082. }
  1083. export interface EntitlementData {
  1084. /**
  1085. * Entitlement data name.
  1086. */
  1087. Name: String;
  1088. /**
  1089. * Entitlement data value.
  1090. */
  1091. Value?: String;
  1092. /**
  1093. * Entitlement data unit.
  1094. */
  1095. Unit: EntitlementDataUnit;
  1096. }
  1097. export type EntitlementDataList = EntitlementData[];
  1098. export type EntitlementDataUnit = "Count"|"None"|"Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|string;
  1099. export type EntitlementList = Entitlement[];
  1100. export type EntitlementUnit = "Count"|"None"|"Seconds"|"Microseconds"|"Milliseconds"|"Bytes"|"Kilobytes"|"Megabytes"|"Gigabytes"|"Terabytes"|"Bits"|"Kilobits"|"Megabits"|"Gigabits"|"Terabits"|"Percent"|"Bytes/Second"|"Kilobytes/Second"|"Megabytes/Second"|"Gigabytes/Second"|"Terabytes/Second"|"Bits/Second"|"Kilobits/Second"|"Megabits/Second"|"Gigabits/Second"|"Terabits/Second"|"Count/Second"|string;
  1101. export interface EntitlementUsage {
  1102. /**
  1103. * Entitlement usage name.
  1104. */
  1105. Name: String;
  1106. /**
  1107. * Resource usage consumed.
  1108. */
  1109. ConsumedValue: String;
  1110. /**
  1111. * Maximum entitlement usage count.
  1112. */
  1113. MaxCount?: String;
  1114. /**
  1115. * Entitlement usage unit.
  1116. */
  1117. Unit: EntitlementDataUnit;
  1118. }
  1119. export type EntitlementUsageList = EntitlementUsage[];
  1120. export interface ExtendLicenseConsumptionRequest {
  1121. /**
  1122. * License consumption token.
  1123. */
  1124. LicenseConsumptionToken: String;
  1125. /**
  1126. * Checks whether you have the required permissions for the action, without actually making the request. Provides an error response if you do not have the required permissions.
  1127. */
  1128. DryRun?: Boolean;
  1129. }
  1130. export interface ExtendLicenseConsumptionResponse {
  1131. /**
  1132. * License consumption token.
  1133. */
  1134. LicenseConsumptionToken?: String;
  1135. /**
  1136. * Date and time at which the license consumption expires.
  1137. */
  1138. Expiration?: ISO8601DateTime;
  1139. }
  1140. export interface Filter {
  1141. /**
  1142. * Name of the filter. Filter names are case-sensitive.
  1143. */
  1144. Name?: FilterName;
  1145. /**
  1146. * The value of the filter, which is case-sensitive. You can only specify one value for the filter.
  1147. */
  1148. Values?: FilterValues;
  1149. }
  1150. export type FilterList = Filter[];
  1151. export type FilterName = string;
  1152. export type FilterValue = string;
  1153. export type FilterValues = FilterValue[];
  1154. export type Filters = Filter[];
  1155. export interface GetAccessTokenRequest {
  1156. /**
  1157. * Refresh token, encoded as a JWT token.
  1158. */
  1159. Token: TokenString;
  1160. /**
  1161. * Token properties to validate against those present in the JWT token.
  1162. */
  1163. TokenProperties?: MaxSize3StringList;
  1164. }
  1165. export interface GetAccessTokenResponse {
  1166. /**
  1167. * Temporary access token.
  1168. */
  1169. AccessToken?: TokenString;
  1170. }
  1171. export interface GetGrantRequest {
  1172. /**
  1173. * Amazon Resource Name (ARN) of the grant.
  1174. */
  1175. GrantArn: Arn;
  1176. /**
  1177. * Grant version.
  1178. */
  1179. Version?: String;
  1180. }
  1181. export interface GetGrantResponse {
  1182. /**
  1183. * Grant details.
  1184. */
  1185. Grant?: Grant;
  1186. }
  1187. export interface GetLicenseConfigurationRequest {
  1188. /**
  1189. * Amazon Resource Name (ARN) of the license configuration.
  1190. */
  1191. LicenseConfigurationArn: String;
  1192. }
  1193. export interface GetLicenseConfigurationResponse {
  1194. /**
  1195. * Unique ID for the license configuration.
  1196. */
  1197. LicenseConfigurationId?: String;
  1198. /**
  1199. * Amazon Resource Name (ARN) of the license configuration.
  1200. */
  1201. LicenseConfigurationArn?: String;
  1202. /**
  1203. * Name of the license configuration.
  1204. */
  1205. Name?: String;
  1206. /**
  1207. * Description of the license configuration.
  1208. */
  1209. Description?: String;
  1210. /**
  1211. * Dimension for which the licenses are counted.
  1212. */
  1213. LicenseCountingType?: LicenseCountingType;
  1214. /**
  1215. * License rules.
  1216. */
  1217. LicenseRules?: StringList;
  1218. /**
  1219. * Number of available licenses.
  1220. */
  1221. LicenseCount?: BoxLong;
  1222. /**
  1223. * Sets the number of available licenses as a hard limit.
  1224. */
  1225. LicenseCountHardLimit?: BoxBoolean;
  1226. /**
  1227. * Number of licenses assigned to resources.
  1228. */
  1229. ConsumedLicenses?: BoxLong;
  1230. /**
  1231. * License configuration status.
  1232. */
  1233. Status?: String;
  1234. /**
  1235. * Account ID of the owner of the license configuration.
  1236. */
  1237. OwnerAccountId?: String;
  1238. /**
  1239. * Summaries of the licenses consumed by resources.
  1240. */
  1241. ConsumedLicenseSummaryList?: ConsumedLicenseSummaryList;
  1242. /**
  1243. * Summaries of the managed resources.
  1244. */
  1245. ManagedResourceSummaryList?: ManagedResourceSummaryList;
  1246. /**
  1247. * Tags for the license configuration.
  1248. */
  1249. Tags?: TagList;
  1250. /**
  1251. * Product information.
  1252. */
  1253. ProductInformationList?: ProductInformationList;
  1254. /**
  1255. * Automated discovery information.
  1256. */
  1257. AutomatedDiscoveryInformation?: AutomatedDiscoveryInformation;
  1258. /**
  1259. * When true, disassociates a resource when software is uninstalled.
  1260. */
  1261. DisassociateWhenNotFound?: BoxBoolean;
  1262. }
  1263. export interface GetLicenseConversionTaskRequest {
  1264. /**
  1265. * ID of the license type conversion task to retrieve information on.
  1266. */
  1267. LicenseConversionTaskId: LicenseConversionTaskId;
  1268. }
  1269. export interface GetLicenseConversionTaskResponse {
  1270. /**
  1271. * ID of the license type conversion task.
  1272. */
  1273. LicenseConversionTaskId?: LicenseConversionTaskId;
  1274. /**
  1275. * Amazon Resource Names (ARN) of the resources the license conversion task is associated with.
  1276. */
  1277. ResourceArn?: String;
  1278. /**
  1279. * Information about the license type converted from.
  1280. */
  1281. SourceLicenseContext?: LicenseConversionContext;
  1282. /**
  1283. * Information about the license type converted to.
  1284. */
  1285. DestinationLicenseContext?: LicenseConversionContext;
  1286. /**
  1287. * The status message for the conversion task.
  1288. */
  1289. StatusMessage?: String;
  1290. /**
  1291. * Status of the license type conversion task.
  1292. */
  1293. Status?: LicenseConversionTaskStatus;
  1294. /**
  1295. * Time at which the license type conversion task was started .
  1296. */
  1297. StartTime?: DateTime;
  1298. /**
  1299. * Amount of time to complete the license type conversion.
  1300. */
  1301. LicenseConversionTime?: DateTime;
  1302. /**
  1303. * Time at which the license type conversion task was completed.
  1304. */
  1305. EndTime?: DateTime;
  1306. }
  1307. export interface GetLicenseManagerReportGeneratorRequest {
  1308. /**
  1309. * Amazon Resource Name (ARN) of the report generator.
  1310. */
  1311. LicenseManagerReportGeneratorArn: String;
  1312. }
  1313. export interface GetLicenseManagerReportGeneratorResponse {
  1314. /**
  1315. * A report generator that creates periodic reports about your license configurations.
  1316. */
  1317. ReportGenerator?: ReportGenerator;
  1318. }
  1319. export interface GetLicenseRequest {
  1320. /**
  1321. * Amazon Resource Name (ARN) of the license.
  1322. */
  1323. LicenseArn: Arn;
  1324. /**
  1325. * License version.
  1326. */
  1327. Version?: String;
  1328. }
  1329. export interface GetLicenseResponse {
  1330. /**
  1331. * License details.
  1332. */
  1333. License?: License;
  1334. }
  1335. export interface GetLicenseUsageRequest {
  1336. /**
  1337. * Amazon Resource Name (ARN) of the license.
  1338. */
  1339. LicenseArn: Arn;
  1340. }
  1341. export interface GetLicenseUsageResponse {
  1342. /**
  1343. * License usage details.
  1344. */
  1345. LicenseUsage?: LicenseUsage;
  1346. }
  1347. export interface GetServiceSettingsRequest {
  1348. }
  1349. export interface GetServiceSettingsResponse {
  1350. /**
  1351. * Regional S3 bucket path for storing reports, license trail event data, discovery data, and so on.
  1352. */
  1353. S3BucketArn?: String;
  1354. /**
  1355. * SNS topic configured to receive notifications from License Manager.
  1356. */
  1357. SnsTopicArn?: String;
  1358. /**
  1359. * Indicates whether Organizations is integrated with License Manager for cross-account discovery.
  1360. */
  1361. OrganizationConfiguration?: OrganizationConfiguration;
  1362. /**
  1363. * Indicates whether cross-account discovery is enabled.
  1364. */
  1365. EnableCrossAccountsDiscovery?: BoxBoolean;
  1366. /**
  1367. * Amazon Resource Name (ARN) of the resource share. The License Manager management account provides member accounts with access to this share.
  1368. */
  1369. LicenseManagerResourceShareArn?: String;
  1370. }
  1371. export interface Grant {
  1372. /**
  1373. * Amazon Resource Name (ARN) of the grant.
  1374. */
  1375. GrantArn: Arn;
  1376. /**
  1377. * Grant name.
  1378. */
  1379. GrantName: String;
  1380. /**
  1381. * Parent ARN.
  1382. */
  1383. ParentArn: Arn;
  1384. /**
  1385. * License ARN.
  1386. */
  1387. LicenseArn: Arn;
  1388. /**
  1389. * The grantee principal ARN.
  1390. */
  1391. GranteePrincipalArn: Arn;
  1392. /**
  1393. * Home Region of the grant.
  1394. */
  1395. HomeRegion: String;
  1396. /**
  1397. * Grant status.
  1398. */
  1399. GrantStatus: GrantStatus;
  1400. /**
  1401. * Grant status reason.
  1402. */
  1403. StatusReason?: StatusReasonMessage;
  1404. /**
  1405. * Grant version.
  1406. */
  1407. Version: String;
  1408. /**
  1409. * Granted operations.
  1410. */
  1411. GrantedOperations: AllowedOperationList;
  1412. /**
  1413. * The options specified for the grant.
  1414. */
  1415. Options?: Options;
  1416. }
  1417. export type GrantList = Grant[];
  1418. export type GrantStatus = "PENDING_WORKFLOW"|"PENDING_ACCEPT"|"REJECTED"|"ACTIVE"|"FAILED_WORKFLOW"|"DELETED"|"PENDING_DELETE"|"DISABLED"|"WORKFLOW_COMPLETED"|string;
  1419. export interface GrantedLicense {
  1420. /**
  1421. * Amazon Resource Name (ARN) of the license.
  1422. */
  1423. LicenseArn?: Arn;
  1424. /**
  1425. * License name.
  1426. */
  1427. LicenseName?: String;
  1428. /**
  1429. * Product name.
  1430. */
  1431. ProductName?: String;
  1432. /**
  1433. * Product SKU.
  1434. */
  1435. ProductSKU?: String;
  1436. /**
  1437. * Granted license issuer.
  1438. */
  1439. Issuer?: IssuerDetails;
  1440. /**
  1441. * Home Region of the granted license.
  1442. */
  1443. HomeRegion?: String;
  1444. /**
  1445. * Granted license status.
  1446. */
  1447. Status?: LicenseStatus;
  1448. /**
  1449. * Date and time range during which the granted license is valid, in ISO8601-UTC format.
  1450. */
  1451. Validity?: DatetimeRange;
  1452. /**
  1453. * Granted license beneficiary.
  1454. */
  1455. Beneficiary?: String;
  1456. /**
  1457. * License entitlements.
  1458. */
  1459. Entitlements?: EntitlementList;
  1460. /**
  1461. * Configuration for consumption of the license.
  1462. */
  1463. ConsumptionConfiguration?: ConsumptionConfiguration;
  1464. /**
  1465. * Granted license metadata.
  1466. */
  1467. LicenseMetadata?: MetadataList;
  1468. /**
  1469. * Creation time of the granted license.
  1470. */
  1471. CreateTime?: ISO8601DateTime;
  1472. /**
  1473. * Version of the granted license.
  1474. */
  1475. Version?: String;
  1476. /**
  1477. * Granted license received metadata.
  1478. */
  1479. ReceivedMetadata?: ReceivedMetadata;
  1480. }
  1481. export type GrantedLicenseList = GrantedLicense[];
  1482. export type ISO8601DateTime = string;
  1483. export type Integer = number;
  1484. export interface InventoryFilter {
  1485. /**
  1486. * Name of the filter.
  1487. */
  1488. Name: String;
  1489. /**
  1490. * Condition of the filter.
  1491. */
  1492. Condition: InventoryFilterCondition;
  1493. /**
  1494. * Value of the filter.
  1495. */
  1496. Value?: String;
  1497. }
  1498. export type InventoryFilterCondition = "EQUALS"|"NOT_EQUALS"|"BEGINS_WITH"|"CONTAINS"|string;
  1499. export type InventoryFilterList = InventoryFilter[];
  1500. export interface Issuer {
  1501. /**
  1502. * Issuer name.
  1503. */
  1504. Name: String;
  1505. /**
  1506. * Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.
  1507. */
  1508. SignKey?: String;
  1509. }
  1510. export interface IssuerDetails {
  1511. /**
  1512. * Issuer name.
  1513. */
  1514. Name?: String;
  1515. /**
  1516. * Asymmetric KMS key from Key Management Service. The KMS key must have a key usage of sign and verify, and support the RSASSA-PSS SHA-256 signing algorithm.
  1517. */
  1518. SignKey?: String;
  1519. /**
  1520. * Issuer key fingerprint.
  1521. */
  1522. KeyFingerprint?: String;
  1523. }
  1524. export interface License {
  1525. /**
  1526. * Amazon Resource Name (ARN) of the license.
  1527. */
  1528. LicenseArn?: Arn;
  1529. /**
  1530. * License name.
  1531. */
  1532. LicenseName?: String;
  1533. /**
  1534. * Product name.
  1535. */
  1536. ProductName?: String;
  1537. /**
  1538. * Product SKU.
  1539. */
  1540. ProductSKU?: String;
  1541. /**
  1542. * License issuer.
  1543. */
  1544. Issuer?: IssuerDetails;
  1545. /**
  1546. * Home Region of the license.
  1547. */
  1548. HomeRegion?: String;
  1549. /**
  1550. * License status.
  1551. */
  1552. Status?: LicenseStatus;
  1553. /**
  1554. * Date and time range during which the license is valid, in ISO8601-UTC format.
  1555. */
  1556. Validity?: DatetimeRange;
  1557. /**
  1558. * License beneficiary.
  1559. */
  1560. Beneficiary?: String;
  1561. /**
  1562. * License entitlements.
  1563. */
  1564. Entitlements?: EntitlementList;
  1565. /**
  1566. * Configuration for consumption of the license.
  1567. */
  1568. ConsumptionConfiguration?: ConsumptionConfiguration;
  1569. /**
  1570. * License metadata.
  1571. */
  1572. LicenseMetadata?: MetadataList;
  1573. /**
  1574. * License creation time.
  1575. */
  1576. CreateTime?: ISO8601DateTime;
  1577. /**
  1578. * License version.
  1579. */
  1580. Version?: String;
  1581. }
  1582. export interface LicenseConfiguration {
  1583. /**
  1584. * Unique ID of the license configuration.
  1585. */
  1586. LicenseConfigurationId?: String;
  1587. /**
  1588. * Amazon Resource Name (ARN) of the license configuration.
  1589. */
  1590. LicenseConfigurationArn?: String;
  1591. /**
  1592. * Name of the license configuration.
  1593. */
  1594. Name?: String;
  1595. /**
  1596. * Description of the license configuration.
  1597. */
  1598. Description?: String;
  1599. /**
  1600. * Dimension to use to track the license inventory.
  1601. */
  1602. LicenseCountingType?: LicenseCountingType;
  1603. /**
  1604. * License rules.
  1605. */
  1606. LicenseRules?: StringList;
  1607. /**
  1608. * Number of licenses managed by the license configuration.
  1609. */
  1610. LicenseCount?: BoxLong;
  1611. /**
  1612. * Number of available licenses as a hard limit.
  1613. */
  1614. LicenseCountHardLimit?: BoxBoolean;
  1615. /**
  1616. * When true, disassociates a resource when software is uninstalled.
  1617. */
  1618. DisassociateWhenNotFound?: BoxBoolean;
  1619. /**
  1620. * Number of licenses consumed.
  1621. */
  1622. ConsumedLicenses?: BoxLong;
  1623. /**
  1624. * Status of the license configuration.
  1625. */
  1626. Status?: String;
  1627. /**
  1628. * Account ID of the license configuration's owner.
  1629. */
  1630. OwnerAccountId?: String;
  1631. /**
  1632. * Summaries for licenses consumed by various resources.
  1633. */
  1634. ConsumedLicenseSummaryList?: ConsumedLicenseSummaryList;
  1635. /**
  1636. * Summaries for managed resources.
  1637. */
  1638. ManagedResourceSummaryList?: ManagedResourceSummaryList;
  1639. /**
  1640. * Product information.
  1641. */
  1642. ProductInformationList?: ProductInformationList;
  1643. /**
  1644. * Automated discovery information.
  1645. */
  1646. AutomatedDiscoveryInformation?: AutomatedDiscoveryInformation;
  1647. }
  1648. export interface LicenseConfigurationAssociation {
  1649. /**
  1650. * Amazon Resource Name (ARN) of the resource.
  1651. */
  1652. ResourceArn?: String;
  1653. /**
  1654. * Type of server resource.
  1655. */
  1656. ResourceType?: ResourceType;
  1657. /**
  1658. * ID of the Amazon Web Services account that owns the resource consuming licenses.
  1659. */
  1660. ResourceOwnerId?: String;
  1661. /**
  1662. * Time when the license configuration was associated with the resource.
  1663. */
  1664. AssociationTime?: DateTime;
  1665. /**
  1666. * Scope of AMI associations. The possible value is cross-account.
  1667. */
  1668. AmiAssociationScope?: String;
  1669. }
  1670. export type LicenseConfigurationAssociations = LicenseConfigurationAssociation[];
  1671. export type LicenseConfigurationStatus = "AVAILABLE"|"DISABLED"|string;
  1672. export interface LicenseConfigurationUsage {
  1673. /**
  1674. * Amazon Resource Name (ARN) of the resource.
  1675. */
  1676. ResourceArn?: String;
  1677. /**
  1678. * Type of resource.
  1679. */
  1680. ResourceType?: ResourceType;
  1681. /**
  1682. * Status of the resource.
  1683. */
  1684. ResourceStatus?: String;
  1685. /**
  1686. * ID of the account that owns the resource.
  1687. */
  1688. ResourceOwnerId?: String;
  1689. /**
  1690. * Time when the license configuration was initially associated with the resource.
  1691. */
  1692. AssociationTime?: DateTime;
  1693. /**
  1694. * Number of licenses consumed by the resource.
  1695. */
  1696. ConsumedLicenses?: BoxLong;
  1697. }
  1698. export type LicenseConfigurationUsageList = LicenseConfigurationUsage[];
  1699. export type LicenseConfigurations = LicenseConfiguration[];
  1700. export interface LicenseConversionContext {
  1701. /**
  1702. * The Usage operation value that corresponds to the license type you are converting your resource from. For more information about which platforms correspond to which usage operation values see Sample data: usage operation by platform
  1703. */
  1704. UsageOperation?: UsageOperation;
  1705. }
  1706. export interface LicenseConversionTask {
  1707. /**
  1708. * The ID of the license type conversion task.
  1709. */
  1710. LicenseConversionTaskId?: LicenseConversionTaskId;
  1711. /**
  1712. * The Amazon Resource Name (ARN) of the resource associated with the license type conversion task.
  1713. */
  1714. ResourceArn?: String;
  1715. /**
  1716. * Information about the license type this conversion task converted from.
  1717. */
  1718. SourceLicenseContext?: LicenseConversionContext;
  1719. /**
  1720. * Information about the license type this conversion task converted to.
  1721. */
  1722. DestinationLicenseContext?: LicenseConversionContext;
  1723. /**
  1724. * The status of the conversion task.
  1725. */
  1726. Status?: LicenseConversionTaskStatus;
  1727. /**
  1728. * The status message for the conversion task.
  1729. */
  1730. StatusMessage?: String;
  1731. /**
  1732. * The time the conversion task was started at.
  1733. */
  1734. StartTime?: DateTime;
  1735. /**
  1736. * The time the usage operation value of the resource was changed.
  1737. */
  1738. LicenseConversionTime?: DateTime;
  1739. /**
  1740. * The time the conversion task was completed.
  1741. */
  1742. EndTime?: DateTime;
  1743. }
  1744. export type LicenseConversionTaskId = string;
  1745. export type LicenseConversionTaskStatus = "IN_PROGRESS"|"SUCCEEDED"|"FAILED"|string;
  1746. export type LicenseConversionTasks = LicenseConversionTask[];
  1747. export type LicenseCountingType = "vCPU"|"Instance"|"Core"|"Socket"|string;
  1748. export type LicenseDeletionStatus = "PENDING_DELETE"|"DELETED"|string;
  1749. export type LicenseList = License[];
  1750. export interface LicenseOperationFailure {
  1751. /**
  1752. * Amazon Resource Name (ARN) of the resource.
  1753. */
  1754. ResourceArn?: String;
  1755. /**
  1756. * Resource type.
  1757. */
  1758. ResourceType?: ResourceType;
  1759. /**
  1760. * Error message.
  1761. */
  1762. ErrorMessage?: String;
  1763. /**
  1764. * Failure time.
  1765. */
  1766. FailureTime?: DateTime;
  1767. /**
  1768. * Name of the operation.
  1769. */
  1770. OperationName?: String;
  1771. /**
  1772. * ID of the Amazon Web Services account that owns the resource.
  1773. */
  1774. ResourceOwnerId?: String;
  1775. /**
  1776. * The requester is "License Manager Automated Discovery".
  1777. */
  1778. OperationRequestedBy?: String;
  1779. /**
  1780. * Reserved.
  1781. */
  1782. MetadataList?: MetadataList;
  1783. }
  1784. export type LicenseOperationFailureList = LicenseOperationFailure[];
  1785. export interface LicenseSpecification {
  1786. /**
  1787. * Amazon Resource Name (ARN) of the license configuration.
  1788. */
  1789. LicenseConfigurationArn: String;
  1790. /**
  1791. * Scope of AMI associations. The possible value is cross-account.
  1792. */
  1793. AmiAssociationScope?: String;
  1794. }
  1795. export type LicenseSpecifications = LicenseSpecification[];
  1796. export type LicenseStatus = "AVAILABLE"|"PENDING_AVAILABLE"|"DEACTIVATED"|"SUSPENDED"|"EXPIRED"|"PENDING_DELETE"|"DELETED"|string;
  1797. export interface LicenseUsage {
  1798. /**
  1799. * License entitlement usages.
  1800. */
  1801. EntitlementUsages?: EntitlementUsageList;
  1802. }
  1803. export interface ListAssociationsForLicenseConfigurationRequest {
  1804. /**
  1805. * Amazon Resource Name (ARN) of a license configuration.
  1806. */
  1807. LicenseConfigurationArn: String;
  1808. /**
  1809. * Maximum number of results to return in a single call.
  1810. */
  1811. MaxResults?: BoxInteger;
  1812. /**
  1813. * Token for the next set of results.
  1814. */
  1815. NextToken?: String;
  1816. }
  1817. export interface ListAssociationsForLicenseConfigurationResponse {
  1818. /**
  1819. * Information about the associations for the license configuration.
  1820. */
  1821. LicenseConfigurationAssociations?: LicenseConfigurationAssociations;
  1822. /**
  1823. * Token for the next set of results.
  1824. */
  1825. NextToken?: String;
  1826. }
  1827. export interface ListDistributedGrantsRequest {
  1828. /**
  1829. * Amazon Resource Names (ARNs) of the grants.
  1830. */
  1831. GrantArns?: ArnList;
  1832. /**
  1833. * Filters to scope the results. The following filters are supported: LicenseArn GrantStatus GranteePrincipalARN ProductSKU LicenseIssuerName
  1834. */
  1835. Filters?: FilterList;
  1836. /**
  1837. * Token for the next set of results.
  1838. */
  1839. NextToken?: String;
  1840. /**
  1841. * Maximum number of results to return in a single call.
  1842. */
  1843. MaxResults?: MaxSize100;
  1844. }
  1845. export interface ListDistributedGrantsResponse {
  1846. /**
  1847. * Distributed grant details.
  1848. */
  1849. Grants?: GrantList;
  1850. /**
  1851. * Token for the next set of results.
  1852. */
  1853. NextToken?: String;
  1854. }
  1855. export interface ListFailuresForLicenseConfigurationOperationsRequest {
  1856. /**
  1857. * Amazon Resource Name of the license configuration.
  1858. */
  1859. LicenseConfigurationArn: String;
  1860. /**
  1861. * Maximum number of results to return in a single call.
  1862. */
  1863. MaxResults?: BoxInteger;
  1864. /**
  1865. * Token for the next set of results.
  1866. */
  1867. NextToken?: String;
  1868. }
  1869. export interface ListFailuresForLicenseConfigurationOperationsResponse {
  1870. /**
  1871. * License configuration operations that failed.
  1872. */
  1873. LicenseOperationFailureList?: LicenseOperationFailureList;
  1874. /**
  1875. * Token for the next set of results.
  1876. */
  1877. NextToken?: String;
  1878. }
  1879. export interface ListLicenseConfigurationsRequest {
  1880. /**
  1881. * Amazon Resource Names (ARN) of the license configurations.
  1882. */
  1883. LicenseConfigurationArns?: StringList;
  1884. /**
  1885. * Maximum number of results to return in a single call.
  1886. */
  1887. MaxResults?: BoxInteger;
  1888. /**
  1889. * Token for the next set of results.
  1890. */
  1891. NextToken?: String;
  1892. /**
  1893. * Filters to scope the results. The following filters and logical operators are supported: licenseCountingType - The dimension for which licenses are counted. Possible values are vCPU | Instance | Core | Socket. Logical operators are EQUALS | NOT_EQUALS. enforceLicenseCount - A Boolean value that indicates whether hard license enforcement is used. Logical operators are EQUALS | NOT_EQUALS. usagelimitExceeded - A Boolean value that indicates whether the available licenses have been exceeded. Logical operators are EQUALS | NOT_EQUALS.
  1894. */
  1895. Filters?: Filters;
  1896. }
  1897. export interface ListLicenseConfigurationsResponse {
  1898. /**
  1899. * Information about the license configurations.
  1900. */
  1901. LicenseConfigurations?: LicenseConfigurations;
  1902. /**
  1903. * Token for the next set of results.
  1904. */
  1905. NextToken?: String;
  1906. }
  1907. export interface ListLicenseConversionTasksRequest {
  1908. /**
  1909. * Token for the next set of results.
  1910. */
  1911. NextToken?: String;
  1912. /**
  1913. * Maximum number of results to return in a single call.
  1914. */
  1915. MaxResults?: BoxInteger;
  1916. /**
  1917. * Filters to scope the results. Valid filters are ResourceArns and Status.
  1918. */
  1919. Filters?: Filters;
  1920. }
  1921. export interface ListLicenseConversionTasksResponse {
  1922. /**
  1923. * Information about the license configuration tasks for your account.
  1924. */
  1925. LicenseConversionTasks?: LicenseConversionTasks;
  1926. /**
  1927. * Token for the next set of results.
  1928. */
  1929. NextToken?: String;
  1930. }
  1931. export interface ListLicenseManagerReportGeneratorsRequest {
  1932. /**
  1933. * Filters to scope the results. The following filters are supported: LicenseConfigurationArn
  1934. */
  1935. Filters?: FilterList;
  1936. /**
  1937. * Token for the next set of results.
  1938. */
  1939. NextToken?: String;
  1940. /**
  1941. * Maximum number of results to return in a single call.
  1942. */
  1943. MaxResults?: MaxSize100;
  1944. }
  1945. export interface ListLicenseManagerReportGeneratorsResponse {
  1946. /**
  1947. * A report generator that creates periodic reports about your license configurations.
  1948. */
  1949. ReportGenerators?: ReportGeneratorList;
  1950. /**
  1951. * Token for the next set of results.
  1952. */
  1953. NextToken?: String;
  1954. }
  1955. export interface ListLicenseSpecificationsForResourceRequest {
  1956. /**
  1957. * Amazon Resource Name (ARN) of a resource that has an associated license configuration.
  1958. */
  1959. ResourceArn: String;
  1960. /**
  1961. * Maximum number of results to return in a single call.
  1962. */
  1963. MaxResults?: BoxInteger;
  1964. /**
  1965. * Token for the next set of results.
  1966. */
  1967. NextToken?: String;
  1968. }
  1969. export interface ListLicenseSpecificationsForResourceResponse {
  1970. /**
  1971. * License configurations associated with a resource.
  1972. */
  1973. LicenseSpecifications?: LicenseSpecifications;
  1974. /**
  1975. * Token for the next set of results.
  1976. */
  1977. NextToken?: String;
  1978. }
  1979. export interface ListLicenseVersionsRequest {
  1980. /**
  1981. * Amazon Resource Name (ARN) of the license.
  1982. */
  1983. LicenseArn: Arn;
  1984. /**
  1985. * Token for the next set of results.
  1986. */
  1987. NextToken?: String;
  1988. /**
  1989. * Maximum number of results to return in a single call.
  1990. */
  1991. MaxResults?: MaxSize100;
  1992. }
  1993. export interface ListLicenseVersionsResponse {
  1994. /**
  1995. * License details.
  1996. */
  1997. Licenses?: LicenseList;
  1998. /**
  1999. * Token for the next set of results.
  2000. */
  2001. NextToken?: String;
  2002. }
  2003. export interface ListLicensesRequest {
  2004. /**
  2005. * Amazon Resource Names (ARNs) of the licenses.
  2006. */
  2007. LicenseArns?: ArnList;
  2008. /**
  2009. * Filters to scope the results. The following filters are supported: Beneficiary ProductSKU Fingerprint Status
  2010. */
  2011. Filters?: FilterList;
  2012. /**
  2013. * Token for the next set of results.
  2014. */
  2015. NextToken?: String;
  2016. /**
  2017. * Maximum number of results to return in a single call.
  2018. */
  2019. MaxResults?: MaxSize100;
  2020. }
  2021. export interface ListLicensesResponse {
  2022. /**
  2023. * License details.
  2024. */
  2025. Licenses?: LicenseList;
  2026. /**
  2027. * Token for the next set of results.
  2028. */
  2029. NextToken?: String;
  2030. }
  2031. export interface ListReceivedGrantsForOrganizationRequest {
  2032. /**
  2033. * The Amazon Resource Name (ARN) of the received license.
  2034. */
  2035. LicenseArn: Arn;
  2036. /**
  2037. * Filters to scope the results. The following filters are supported: ParentArn GranteePrincipalArn
  2038. */
  2039. Filters?: FilterList;
  2040. /**
  2041. * Token for the next set of results.
  2042. */
  2043. NextToken?: String;
  2044. /**
  2045. * Maximum number of results to return in a single call.
  2046. */
  2047. MaxResults?: MaxSize100;
  2048. }
  2049. export interface ListReceivedGrantsForOrganizationResponse {
  2050. /**
  2051. * Lists the grants the organization has received.
  2052. */
  2053. Grants?: GrantList;
  2054. /**
  2055. * Token for the next set of results.
  2056. */
  2057. NextToken?: String;
  2058. }
  2059. export interface ListReceivedGrantsRequest {
  2060. /**
  2061. * Amazon Resource Names (ARNs) of the grants.
  2062. */
  2063. GrantArns?: ArnList;
  2064. /**
  2065. * Filters to scope the results. The following filters are supported: ProductSKU LicenseIssuerName LicenseArn GrantStatus GranterAccountId
  2066. */
  2067. Filters?: FilterList;
  2068. /**
  2069. * Token for the next set of results.
  2070. */
  2071. NextToken?: String;
  2072. /**
  2073. * Maximum number of results to return in a single call.
  2074. */
  2075. MaxResults?: MaxSize100;
  2076. }
  2077. export interface ListReceivedGrantsResponse {
  2078. /**
  2079. * Received grant details.
  2080. */
  2081. Grants?: GrantList;
  2082. /**
  2083. * Token for the next set of results.
  2084. */
  2085. NextToken?: String;
  2086. }
  2087. export interface ListReceivedLicensesForOrganizationRequest {
  2088. /**
  2089. * Filters to scope the results. The following filters are supported: Beneficiary ProductSKU
  2090. */
  2091. Filters?: FilterList;
  2092. /**
  2093. * Token for the next set of results.
  2094. */
  2095. NextToken?: String;
  2096. /**
  2097. * Maximum number of results to return in a single call.
  2098. */
  2099. MaxResults?: MaxSize100;
  2100. }
  2101. export interface ListReceivedLicensesForOrganizationResponse {
  2102. /**
  2103. * Lists the licenses the organization has received.
  2104. */
  2105. Licenses?: GrantedLicenseList;
  2106. /**
  2107. * Token for the next set of results.
  2108. */
  2109. NextToken?: String;
  2110. }
  2111. export interface ListReceivedLicensesRequest {
  2112. /**
  2113. * Amazon Resource Names (ARNs) of the licenses.
  2114. */
  2115. LicenseArns?: ArnList;
  2116. /**
  2117. * Filters to scope the results. The following filters are supported: ProductSKU Status Fingerprint IssuerName Beneficiary
  2118. */
  2119. Filters?: FilterList;
  2120. /**
  2121. * Token for the next set of results.
  2122. */
  2123. NextToken?: String;
  2124. /**
  2125. * Maximum number of results to return in a single call.
  2126. */
  2127. MaxResults?: MaxSize100;
  2128. }
  2129. export interface ListReceivedLicensesResponse {
  2130. /**
  2131. * Received license details.
  2132. */
  2133. Licenses?: GrantedLicenseList;
  2134. /**
  2135. * Token for the next set of results.
  2136. */
  2137. NextToken?: String;
  2138. }
  2139. export interface ListResourceInventoryRequest {
  2140. /**
  2141. * Maximum number of results to return in a single call.
  2142. */
  2143. MaxResults?: BoxInteger;
  2144. /**
  2145. * Token for the next set of results.
  2146. */
  2147. NextToken?: String;
  2148. /**
  2149. * Filters to scope the results. The following filters and logical operators are supported: account_id - The ID of the Amazon Web Services account that owns the resource. Logical operators are EQUALS | NOT_EQUALS. application_name - The name of the application. Logical operators are EQUALS | BEGINS_WITH. license_included - The type of license included. Logical operators are EQUALS | NOT_EQUALS. Possible values are sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter. platform - The platform of the resource. Logical operators are EQUALS | BEGINS_WITH. resource_id - The ID of the resource. Logical operators are EQUALS | NOT_EQUALS. tag:&lt;key&gt; - The key/value combination of a tag assigned to the resource. Logical operators are EQUALS (single account) or EQUALS | NOT_EQUALS (cross account).
  2150. */
  2151. Filters?: InventoryFilterList;
  2152. }
  2153. export interface ListResourceInventoryResponse {
  2154. /**
  2155. * Information about the resources.
  2156. */
  2157. ResourceInventoryList?: ResourceInventoryList;
  2158. /**
  2159. * Token for the next set of results.
  2160. */
  2161. NextToken?: String;
  2162. }
  2163. export interface ListTagsForResourceRequest {
  2164. /**
  2165. * Amazon Resource Name (ARN) of the license configuration.
  2166. */
  2167. ResourceArn: String;
  2168. }
  2169. export interface ListTagsForResourceResponse {
  2170. /**
  2171. * Information about the tags.
  2172. */
  2173. Tags?: TagList;
  2174. }
  2175. export interface ListTokensRequest {
  2176. /**
  2177. * Token IDs.
  2178. */
  2179. TokenIds?: StringList;
  2180. /**
  2181. * Filters to scope the results. The following filter is supported: LicenseArns
  2182. */
  2183. Filters?: FilterList;
  2184. /**
  2185. * Token for the next set of results.
  2186. */
  2187. NextToken?: String;
  2188. /**
  2189. * Maximum number of results to return in a single call.
  2190. */
  2191. MaxResults?: MaxSize100;
  2192. }
  2193. export interface ListTokensResponse {
  2194. /**
  2195. * Received token details.
  2196. */
  2197. Tokens?: TokenList;
  2198. /**
  2199. * Token for the next set of results.
  2200. */
  2201. NextToken?: String;
  2202. }
  2203. export interface ListUsageForLicenseConfigurationRequest {
  2204. /**
  2205. * Amazon Resource Name (ARN) of the license configuration.
  2206. */
  2207. LicenseConfigurationArn: String;
  2208. /**
  2209. * Maximum number of results to return in a single call.
  2210. */
  2211. MaxResults?: BoxInteger;
  2212. /**
  2213. * Token for the next set of results.
  2214. */
  2215. NextToken?: String;
  2216. /**
  2217. * Filters to scope the results. The following filters and logical operators are supported: resourceArn - The ARN of the license configuration resource. Logical operators are EQUALS | NOT_EQUALS. resourceType - The resource type (EC2_INSTANCE | EC2_HOST | EC2_AMI | SYSTEMS_MANAGER_MANAGED_INSTANCE). Logical operators are EQUALS | NOT_EQUALS. resourceAccount - The ID of the account that owns the resource. Logical operators are EQUALS | NOT_EQUALS.
  2218. */
  2219. Filters?: Filters;
  2220. }
  2221. export interface ListUsageForLicenseConfigurationResponse {
  2222. /**
  2223. * Information about the license configurations.
  2224. */
  2225. LicenseConfigurationUsageList?: LicenseConfigurationUsageList;
  2226. /**
  2227. * Token for the next set of results.
  2228. */
  2229. NextToken?: String;
  2230. }
  2231. export type Long = number;
  2232. export interface ManagedResourceSummary {
  2233. /**
  2234. * Type of resource associated with a license.
  2235. */
  2236. ResourceType?: ResourceType;
  2237. /**
  2238. * Number of resources associated with licenses.
  2239. */
  2240. AssociationCount?: BoxLong;
  2241. }
  2242. export type ManagedResourceSummaryList = ManagedResourceSummary[];
  2243. export type MaxSize100 = number;
  2244. export type MaxSize3StringList = String[];
  2245. export interface Metadata {
  2246. /**
  2247. * The key name.
  2248. */
  2249. Name?: String;
  2250. /**
  2251. * The value.
  2252. */
  2253. Value?: String;
  2254. }
  2255. export type MetadataList = Metadata[];
  2256. export interface Options {
  2257. /**
  2258. * An activation option for your grant that determines the behavior of activating a grant. Activation options can only be used with granted licenses sourced from the Amazon Web Services Marketplace. Additionally, the operation must specify the value of ACTIVE for the Status parameter. As a license administrator, you can optionally specify an ActivationOverrideBehavior when activating a grant. As a grantor, you can optionally specify an ActivationOverrideBehavior when you activate a grant for a grantee account in your organization. As a grantee, if the grantor creating the distributed grant doesn’t specify an ActivationOverrideBehavior, you can optionally specify one when you are activating the grant. DISTRIBUTED_GRANTS_ONLY Use this value to activate a grant without replacing any member account’s active grants for the same product. ALL_GRANTS_PERMITTED_BY_ISSUER Use this value to activate a grant and disable other active grants in any member accounts for the same product. This action will also replace their previously activated grants with this activated grant.
  2259. */
  2260. ActivationOverrideBehavior?: ActivationOverrideBehavior;
  2261. }
  2262. export interface OrganizationConfiguration {
  2263. /**
  2264. * Enables Organizations integration.
  2265. */
  2266. EnableIntegration: Boolean;
  2267. }
  2268. export type PrincipalArnList = Arn[];
  2269. export interface ProductInformation {
  2270. /**
  2271. * Resource type. The possible values are SSM_MANAGED | RDS.
  2272. */
  2273. ResourceType: String;
  2274. /**
  2275. * A Product information filter consists of a ProductInformationFilterComparator which is a logical operator, a ProductInformationFilterName which specifies the type of filter being declared, and a ProductInformationFilterValue that specifies the value to filter on. Accepted values for ProductInformationFilterName are listed here along with descriptions and valid options for ProductInformationFilterComparator. The following filters and are supported when the resource type is SSM_MANAGED: Application Name - The name of the application. Logical operator is EQUALS. Application Publisher - The publisher of the application. Logical operator is EQUALS. Application Version - The version of the application. Logical operator is EQUALS. Platform Name - The name of the platform. Logical operator is EQUALS. Platform Type - The platform type. Logical operator is EQUALS. Tag:key - The key of a tag attached to an Amazon Web Services resource you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. The key for your tag must be appended to Tag: following the example: Tag:name-of-your-key. ProductInformationFilterValue is optional if you are not using values for the key. AccountId - The 12-digit ID of an Amazon Web Services account you wish to exclude from automated discovery. Logical operator is NOT_EQUALS. License Included - The type of license included. Logical operators are EQUALS and NOT_EQUALS. Possible values are: sql-server-enterprise | sql-server-standard | sql-server-web | windows-server-datacenter. The following filters and logical operators are supported when the resource type is RDS: Engine Edition - The edition of the database engine. Logical operator is EQUALS. Possible values are: oracle-ee | oracle-se | oracle-se1 | oracle-se2. License Pack - The license pack. Logical operator is EQUALS. Possible values are: data guard | diagnostic pack sqlt | tuning pack sqlt | ols | olap.
  2276. */
  2277. ProductInformationFilterList: ProductInformationFilterList;
  2278. }
  2279. export interface ProductInformationFilter {
  2280. /**
  2281. * Filter name.
  2282. */
  2283. ProductInformationFilterName: String;
  2284. /**
  2285. * Filter value.
  2286. */
  2287. ProductInformationFilterValue?: StringList;
  2288. /**
  2289. * Logical operator.
  2290. */
  2291. ProductInformationFilterComparator: String;
  2292. }
  2293. export type ProductInformationFilterList = ProductInformationFilter[];
  2294. export type ProductInformationList = ProductInformation[];
  2295. export interface ProvisionalConfiguration {
  2296. /**
  2297. * Maximum time for the provisional configuration, in minutes.
  2298. */
  2299. MaxTimeToLiveInMinutes: BoxInteger;
  2300. }
  2301. export interface ReceivedMetadata {
  2302. /**
  2303. * Received status.
  2304. */
  2305. ReceivedStatus?: ReceivedStatus;
  2306. /**
  2307. * Received status reason.
  2308. */
  2309. ReceivedStatusReason?: StatusReasonMessage;
  2310. /**
  2311. * Allowed operations.
  2312. */
  2313. AllowedOperations?: AllowedOperationList;
  2314. }
  2315. export type ReceivedStatus = "PENDING_WORKFLOW"|"PENDING_ACCEPT"|"REJECTED"|"ACTIVE"|"FAILED_WORKFLOW"|"DELETED"|"DISABLED"|"WORKFLOW_COMPLETED"|string;
  2316. export interface RejectGrantRequest {
  2317. /**
  2318. * Amazon Resource Name (ARN) of the grant.
  2319. */
  2320. GrantArn: Arn;
  2321. }
  2322. export interface RejectGrantResponse {
  2323. /**
  2324. * Grant ARN.
  2325. */
  2326. GrantArn?: Arn;
  2327. /**
  2328. * Grant status.
  2329. */
  2330. Status?: GrantStatus;
  2331. /**
  2332. * Grant version.
  2333. */
  2334. Version?: String;
  2335. }
  2336. export type RenewType = "None"|"Weekly"|"Monthly"|string;
  2337. export interface ReportContext {
  2338. /**
  2339. * Amazon Resource Name (ARN) of the license configuration that this generator reports on.
  2340. */
  2341. licenseConfigurationArns: ArnList;
  2342. }
  2343. export interface ReportFrequency {
  2344. /**
  2345. * Number of times within the frequency period that a report is generated. The only supported value is 1.
  2346. */
  2347. value?: Integer;
  2348. /**
  2349. * Time period between each report. The period can be daily, weekly, or monthly.
  2350. */
  2351. period?: ReportFrequencyType;
  2352. }
  2353. export type ReportFrequencyType = "DAY"|"WEEK"|"MONTH"|string;
  2354. export interface ReportGenerator {
  2355. /**
  2356. * Name of the report generator.
  2357. */
  2358. ReportGeneratorName?: String;
  2359. /**
  2360. * Type of reports that are generated.
  2361. */
  2362. ReportType?: ReportTypeList;
  2363. /**
  2364. * License configuration type for this generator.
  2365. */
  2366. ReportContext?: ReportContext;
  2367. /**
  2368. * Details about how frequently reports are generated.
  2369. */
  2370. ReportFrequency?: ReportFrequency;
  2371. /**
  2372. * Amazon Resource Name (ARN) of the report generator.
  2373. */
  2374. LicenseManagerReportGeneratorArn?: String;
  2375. /**
  2376. * Status of the last report generation attempt.
  2377. */
  2378. LastRunStatus?: String;
  2379. /**
  2380. * Failure message for the last report generation attempt.
  2381. */
  2382. LastRunFailureReason?: String;
  2383. /**
  2384. * Time the last report was generated at.
  2385. */
  2386. LastReportGenerationTime?: String;
  2387. /**
  2388. * The Amazon Web Services account ID used to create the report generator.
  2389. */
  2390. ReportCreatorAccount?: String;
  2391. /**
  2392. * Description of the report generator.
  2393. */
  2394. Description?: String;
  2395. /**
  2396. * Details of the S3 bucket that report generator reports are published to.
  2397. */
  2398. S3Location?: S3Location;
  2399. /**
  2400. * Time the report was created.
  2401. */
  2402. CreateTime?: String;
  2403. /**
  2404. * Tags associated with the report generator.
  2405. */
  2406. Tags?: TagList;
  2407. }
  2408. export type ReportGeneratorList = ReportGenerator[];
  2409. export type ReportGeneratorName = string;
  2410. export type ReportType = "LicenseConfigurationSummaryReport"|"LicenseConfigurationUsageReport"|string;
  2411. export type ReportTypeList = ReportType[];
  2412. export interface ResourceInventory {
  2413. /**
  2414. * ID of the resource.
  2415. */
  2416. ResourceId?: String;
  2417. /**
  2418. * Type of resource.
  2419. */
  2420. ResourceType?: ResourceType;
  2421. /**
  2422. * Amazon Resource Name (ARN) of the resource.
  2423. */
  2424. ResourceArn?: String;
  2425. /**
  2426. * Platform of the resource.
  2427. */
  2428. Platform?: String;
  2429. /**
  2430. * Platform version of the resource in the inventory.
  2431. */
  2432. PlatformVersion?: String;
  2433. /**
  2434. * ID of the account that owns the resource.
  2435. */
  2436. ResourceOwningAccountId?: String;
  2437. }
  2438. export type ResourceInventoryList = ResourceInventory[];
  2439. export type ResourceType = "EC2_INSTANCE"|"EC2_HOST"|"EC2_AMI"|"RDS"|"SYSTEMS_MANAGER_MANAGED_INSTANCE"|string;
  2440. export interface S3Location {
  2441. /**
  2442. * Name of the S3 bucket reports are published to.
  2443. */
  2444. bucket?: String;
  2445. /**
  2446. * Prefix of the S3 bucket reports are published to.
  2447. */
  2448. keyPrefix?: String;
  2449. }
  2450. export type SignedToken = string;
  2451. export type StatusReasonMessage = string;
  2452. export type String = string;
  2453. export type StringList = String[];
  2454. export interface Tag {
  2455. /**
  2456. * Tag key.
  2457. */
  2458. Key?: String;
  2459. /**
  2460. * Tag value.
  2461. */
  2462. Value?: String;
  2463. }
  2464. export type TagKeyList = String[];
  2465. export type TagList = Tag[];
  2466. export interface TagResourceRequest {
  2467. /**
  2468. * Amazon Resource Name (ARN) of the license configuration.
  2469. */
  2470. ResourceArn: String;
  2471. /**
  2472. * One or more tags.
  2473. */
  2474. Tags: TagList;
  2475. }
  2476. export interface TagResourceResponse {
  2477. }
  2478. export interface TokenData {
  2479. /**
  2480. * Token ID.
  2481. */
  2482. TokenId?: String;
  2483. /**
  2484. * Type of token generated. The supported value is REFRESH_TOKEN.
  2485. */
  2486. TokenType?: String;
  2487. /**
  2488. * Amazon Resource Name (ARN) of the license.
  2489. */
  2490. LicenseArn?: String;
  2491. /**
  2492. * Token expiration time, in ISO8601-UTC format.
  2493. */
  2494. ExpirationTime?: ISO8601DateTime;
  2495. /**
  2496. * Data specified by the caller.
  2497. */
  2498. TokenProperties?: MaxSize3StringList;
  2499. /**
  2500. * Amazon Resource Names (ARN) of the roles included in the token.
  2501. */
  2502. RoleArns?: ArnList;
  2503. /**
  2504. * Token status. The possible values are AVAILABLE and DELETED.
  2505. */
  2506. Status?: String;
  2507. }
  2508. export type TokenList = TokenData[];
  2509. export type TokenString = string;
  2510. export type TokenType = "REFRESH_TOKEN"|string;
  2511. export interface UntagResourceRequest {
  2512. /**
  2513. * Amazon Resource Name (ARN) of the license configuration.
  2514. */
  2515. ResourceArn: String;
  2516. /**
  2517. * Keys identifying the tags to remove.
  2518. */
  2519. TagKeys: TagKeyList;
  2520. }
  2521. export interface UntagResourceResponse {
  2522. }
  2523. export interface UpdateLicenseConfigurationRequest {
  2524. /**
  2525. * Amazon Resource Name (ARN) of the license configuration.
  2526. */
  2527. LicenseConfigurationArn: String;
  2528. /**
  2529. * New status of the license configuration.
  2530. */
  2531. LicenseConfigurationStatus?: LicenseConfigurationStatus;
  2532. /**
  2533. * New license rule. The only rule that you can add after you create a license configuration is licenseAffinityToHost.
  2534. */
  2535. LicenseRules?: StringList;
  2536. /**
  2537. * New number of licenses managed by the license configuration.
  2538. */
  2539. LicenseCount?: BoxLong;
  2540. /**
  2541. * New hard limit of the number of available licenses.
  2542. */
  2543. LicenseCountHardLimit?: BoxBoolean;
  2544. /**
  2545. * New name of the license configuration.
  2546. */
  2547. Name?: String;
  2548. /**
  2549. * New description of the license configuration.
  2550. */
  2551. Description?: String;
  2552. /**
  2553. * New product information.
  2554. */
  2555. ProductInformationList?: ProductInformationList;
  2556. /**
  2557. * When true, disassociates a resource when software is uninstalled.
  2558. */
  2559. DisassociateWhenNotFound?: BoxBoolean;
  2560. }
  2561. export interface UpdateLicenseConfigurationResponse {
  2562. }
  2563. export interface UpdateLicenseManagerReportGeneratorRequest {
  2564. /**
  2565. * Amazon Resource Name (ARN) of the report generator to update.
  2566. */
  2567. LicenseManagerReportGeneratorArn: String;
  2568. /**
  2569. * Name of the report generator.
  2570. */
  2571. ReportGeneratorName: ReportGeneratorName;
  2572. /**
  2573. * Type of reports to generate. The following report types are supported: License configuration report - Reports the number and details of consumed licenses for a license configuration. Resource report - Reports the tracked licenses and resource consumption for a license configuration.
  2574. */
  2575. Type: ReportTypeList;
  2576. /**
  2577. * The report context.
  2578. */
  2579. ReportContext: ReportContext;
  2580. /**
  2581. * Frequency by which reports are generated.
  2582. */
  2583. ReportFrequency: ReportFrequency;
  2584. /**
  2585. * Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
  2586. */
  2587. ClientToken: ClientRequestToken;
  2588. /**
  2589. * Description of the report generator.
  2590. */
  2591. Description?: String;
  2592. }
  2593. export interface UpdateLicenseManagerReportGeneratorResponse {
  2594. }
  2595. export interface UpdateLicenseSpecificationsForResourceRequest {
  2596. /**
  2597. * Amazon Resource Name (ARN) of the Amazon Web Services resource.
  2598. */
  2599. ResourceArn: String;
  2600. /**
  2601. * ARNs of the license configurations to add.
  2602. */
  2603. AddLicenseSpecifications?: LicenseSpecifications;
  2604. /**
  2605. * ARNs of the license configurations to remove.
  2606. */
  2607. RemoveLicenseSpecifications?: LicenseSpecifications;
  2608. }
  2609. export interface UpdateLicenseSpecificationsForResourceResponse {
  2610. }
  2611. export interface UpdateServiceSettingsRequest {
  2612. /**
  2613. * Amazon Resource Name (ARN) of the Amazon S3 bucket where the License Manager information is stored.
  2614. */
  2615. S3BucketArn?: String;
  2616. /**
  2617. * Amazon Resource Name (ARN) of the Amazon SNS topic used for License Manager alerts.
  2618. */
  2619. SnsTopicArn?: String;
  2620. /**
  2621. * Enables integration with Organizations for cross-account discovery.
  2622. */
  2623. OrganizationConfiguration?: OrganizationConfiguration;
  2624. /**
  2625. * Activates cross-account discovery.
  2626. */
  2627. EnableCrossAccountsDiscovery?: BoxBoolean;
  2628. }
  2629. export interface UpdateServiceSettingsResponse {
  2630. }
  2631. export type UsageOperation = string;
  2632. /**
  2633. * 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.
  2634. */
  2635. export type apiVersion = "2018-08-01"|"latest"|string;
  2636. export interface ClientApiVersions {
  2637. /**
  2638. * 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.
  2639. */
  2640. apiVersion?: apiVersion;
  2641. }
  2642. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  2643. /**
  2644. * Contains interfaces for use with the LicenseManager client.
  2645. */
  2646. export import Types = LicenseManager;
  2647. }
  2648. export = LicenseManager;