es.d.ts 123 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925
  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 ES extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: ES.Types.ClientConfiguration)
  13. config: Config & ES.Types.ClientConfiguration;
  14. /**
  15. * Allows the destination domain owner to accept an inbound cross-cluster search connection request.
  16. */
  17. acceptInboundCrossClusterSearchConnection(params: ES.Types.AcceptInboundCrossClusterSearchConnectionRequest, callback?: (err: AWSError, data: ES.Types.AcceptInboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.AcceptInboundCrossClusterSearchConnectionResponse, AWSError>;
  18. /**
  19. * Allows the destination domain owner to accept an inbound cross-cluster search connection request.
  20. */
  21. acceptInboundCrossClusterSearchConnection(callback?: (err: AWSError, data: ES.Types.AcceptInboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.AcceptInboundCrossClusterSearchConnectionResponse, AWSError>;
  22. /**
  23. * Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
  24. */
  25. addTags(params: ES.Types.AddTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  26. /**
  27. * Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags. See Tagging Amazon Elasticsearch Service Domains for more information.
  28. */
  29. addTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  30. /**
  31. * Associates a package with an Amazon ES domain.
  32. */
  33. associatePackage(params: ES.Types.AssociatePackageRequest, callback?: (err: AWSError, data: ES.Types.AssociatePackageResponse) => void): Request<ES.Types.AssociatePackageResponse, AWSError>;
  34. /**
  35. * Associates a package with an Amazon ES domain.
  36. */
  37. associatePackage(callback?: (err: AWSError, data: ES.Types.AssociatePackageResponse) => void): Request<ES.Types.AssociatePackageResponse, AWSError>;
  38. /**
  39. * Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
  40. */
  41. authorizeVpcEndpointAccess(params: ES.Types.AuthorizeVpcEndpointAccessRequest, callback?: (err: AWSError, data: ES.Types.AuthorizeVpcEndpointAccessResponse) => void): Request<ES.Types.AuthorizeVpcEndpointAccessResponse, AWSError>;
  42. /**
  43. * Provides access to an Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
  44. */
  45. authorizeVpcEndpointAccess(callback?: (err: AWSError, data: ES.Types.AuthorizeVpcEndpointAccessResponse) => void): Request<ES.Types.AuthorizeVpcEndpointAccessResponse, AWSError>;
  46. /**
  47. * Cancels a pending configuration change on an Amazon OpenSearch Service domain.
  48. */
  49. cancelDomainConfigChange(params: ES.Types.CancelDomainConfigChangeRequest, callback?: (err: AWSError, data: ES.Types.CancelDomainConfigChangeResponse) => void): Request<ES.Types.CancelDomainConfigChangeResponse, AWSError>;
  50. /**
  51. * Cancels a pending configuration change on an Amazon OpenSearch Service domain.
  52. */
  53. cancelDomainConfigChange(callback?: (err: AWSError, data: ES.Types.CancelDomainConfigChangeResponse) => void): Request<ES.Types.CancelDomainConfigChangeResponse, AWSError>;
  54. /**
  55. * Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.
  56. */
  57. cancelElasticsearchServiceSoftwareUpdate(params: ES.Types.CancelElasticsearchServiceSoftwareUpdateRequest, callback?: (err: AWSError, data: ES.Types.CancelElasticsearchServiceSoftwareUpdateResponse) => void): Request<ES.Types.CancelElasticsearchServiceSoftwareUpdateResponse, AWSError>;
  58. /**
  59. * Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.
  60. */
  61. cancelElasticsearchServiceSoftwareUpdate(callback?: (err: AWSError, data: ES.Types.CancelElasticsearchServiceSoftwareUpdateResponse) => void): Request<ES.Types.CancelElasticsearchServiceSoftwareUpdateResponse, AWSError>;
  62. /**
  63. * Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
  64. */
  65. createElasticsearchDomain(params: ES.Types.CreateElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.CreateElasticsearchDomainResponse) => void): Request<ES.Types.CreateElasticsearchDomainResponse, AWSError>;
  66. /**
  67. * Creates a new Elasticsearch domain. For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
  68. */
  69. createElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.CreateElasticsearchDomainResponse) => void): Request<ES.Types.CreateElasticsearchDomainResponse, AWSError>;
  70. /**
  71. * Creates a new cross-cluster search connection from a source domain to a destination domain.
  72. */
  73. createOutboundCrossClusterSearchConnection(params: ES.Types.CreateOutboundCrossClusterSearchConnectionRequest, callback?: (err: AWSError, data: ES.Types.CreateOutboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.CreateOutboundCrossClusterSearchConnectionResponse, AWSError>;
  74. /**
  75. * Creates a new cross-cluster search connection from a source domain to a destination domain.
  76. */
  77. createOutboundCrossClusterSearchConnection(callback?: (err: AWSError, data: ES.Types.CreateOutboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.CreateOutboundCrossClusterSearchConnectionResponse, AWSError>;
  78. /**
  79. * Create a package for use with Amazon ES domains.
  80. */
  81. createPackage(params: ES.Types.CreatePackageRequest, callback?: (err: AWSError, data: ES.Types.CreatePackageResponse) => void): Request<ES.Types.CreatePackageResponse, AWSError>;
  82. /**
  83. * Create a package for use with Amazon ES domains.
  84. */
  85. createPackage(callback?: (err: AWSError, data: ES.Types.CreatePackageResponse) => void): Request<ES.Types.CreatePackageResponse, AWSError>;
  86. /**
  87. * Creates an Amazon OpenSearch Service-managed VPC endpoint.
  88. */
  89. createVpcEndpoint(params: ES.Types.CreateVpcEndpointRequest, callback?: (err: AWSError, data: ES.Types.CreateVpcEndpointResponse) => void): Request<ES.Types.CreateVpcEndpointResponse, AWSError>;
  90. /**
  91. * Creates an Amazon OpenSearch Service-managed VPC endpoint.
  92. */
  93. createVpcEndpoint(callback?: (err: AWSError, data: ES.Types.CreateVpcEndpointResponse) => void): Request<ES.Types.CreateVpcEndpointResponse, AWSError>;
  94. /**
  95. * Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
  96. */
  97. deleteElasticsearchDomain(params: ES.Types.DeleteElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.DeleteElasticsearchDomainResponse) => void): Request<ES.Types.DeleteElasticsearchDomainResponse, AWSError>;
  98. /**
  99. * Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.
  100. */
  101. deleteElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.DeleteElasticsearchDomainResponse) => void): Request<ES.Types.DeleteElasticsearchDomainResponse, AWSError>;
  102. /**
  103. * Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role. See Deleting Elasticsearch Service Role in VPC Endpoints for Amazon Elasticsearch Service Domains.
  104. */
  105. deleteElasticsearchServiceRole(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  106. /**
  107. * Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
  108. */
  109. deleteInboundCrossClusterSearchConnection(params: ES.Types.DeleteInboundCrossClusterSearchConnectionRequest, callback?: (err: AWSError, data: ES.Types.DeleteInboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.DeleteInboundCrossClusterSearchConnectionResponse, AWSError>;
  110. /**
  111. * Allows the destination domain owner to delete an existing inbound cross-cluster search connection.
  112. */
  113. deleteInboundCrossClusterSearchConnection(callback?: (err: AWSError, data: ES.Types.DeleteInboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.DeleteInboundCrossClusterSearchConnectionResponse, AWSError>;
  114. /**
  115. * Allows the source domain owner to delete an existing outbound cross-cluster search connection.
  116. */
  117. deleteOutboundCrossClusterSearchConnection(params: ES.Types.DeleteOutboundCrossClusterSearchConnectionRequest, callback?: (err: AWSError, data: ES.Types.DeleteOutboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.DeleteOutboundCrossClusterSearchConnectionResponse, AWSError>;
  118. /**
  119. * Allows the source domain owner to delete an existing outbound cross-cluster search connection.
  120. */
  121. deleteOutboundCrossClusterSearchConnection(callback?: (err: AWSError, data: ES.Types.DeleteOutboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.DeleteOutboundCrossClusterSearchConnectionResponse, AWSError>;
  122. /**
  123. * Delete the package.
  124. */
  125. deletePackage(params: ES.Types.DeletePackageRequest, callback?: (err: AWSError, data: ES.Types.DeletePackageResponse) => void): Request<ES.Types.DeletePackageResponse, AWSError>;
  126. /**
  127. * Delete the package.
  128. */
  129. deletePackage(callback?: (err: AWSError, data: ES.Types.DeletePackageResponse) => void): Request<ES.Types.DeletePackageResponse, AWSError>;
  130. /**
  131. * Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
  132. */
  133. deleteVpcEndpoint(params: ES.Types.DeleteVpcEndpointRequest, callback?: (err: AWSError, data: ES.Types.DeleteVpcEndpointResponse) => void): Request<ES.Types.DeleteVpcEndpointResponse, AWSError>;
  134. /**
  135. * Deletes an Amazon OpenSearch Service-managed interface VPC endpoint.
  136. */
  137. deleteVpcEndpoint(callback?: (err: AWSError, data: ES.Types.DeleteVpcEndpointResponse) => void): Request<ES.Types.DeleteVpcEndpointResponse, AWSError>;
  138. /**
  139. * Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
  140. */
  141. describeDomainAutoTunes(params: ES.Types.DescribeDomainAutoTunesRequest, callback?: (err: AWSError, data: ES.Types.DescribeDomainAutoTunesResponse) => void): Request<ES.Types.DescribeDomainAutoTunesResponse, AWSError>;
  142. /**
  143. * Provides scheduled Auto-Tune action details for the Elasticsearch domain, such as Auto-Tune action type, description, severity, and scheduled date.
  144. */
  145. describeDomainAutoTunes(callback?: (err: AWSError, data: ES.Types.DescribeDomainAutoTunesResponse) => void): Request<ES.Types.DescribeDomainAutoTunesResponse, AWSError>;
  146. /**
  147. * Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
  148. */
  149. describeDomainChangeProgress(params: ES.Types.DescribeDomainChangeProgressRequest, callback?: (err: AWSError, data: ES.Types.DescribeDomainChangeProgressResponse) => void): Request<ES.Types.DescribeDomainChangeProgressResponse, AWSError>;
  150. /**
  151. * Returns information about the current blue/green deployment happening on a domain, including a change ID, status, and progress stages.
  152. */
  153. describeDomainChangeProgress(callback?: (err: AWSError, data: ES.Types.DescribeDomainChangeProgressResponse) => void): Request<ES.Types.DescribeDomainChangeProgressResponse, AWSError>;
  154. /**
  155. * Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
  156. */
  157. describeElasticsearchDomain(params: ES.Types.DescribeElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainResponse) => void): Request<ES.Types.DescribeElasticsearchDomainResponse, AWSError>;
  158. /**
  159. * Returns domain configuration information about the specified Elasticsearch domain, including the domain ID, domain endpoint, and domain ARN.
  160. */
  161. describeElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainResponse) => void): Request<ES.Types.DescribeElasticsearchDomainResponse, AWSError>;
  162. /**
  163. * Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
  164. */
  165. describeElasticsearchDomainConfig(params: ES.Types.DescribeElasticsearchDomainConfigRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainConfigResponse) => void): Request<ES.Types.DescribeElasticsearchDomainConfigResponse, AWSError>;
  166. /**
  167. * Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.
  168. */
  169. describeElasticsearchDomainConfig(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainConfigResponse) => void): Request<ES.Types.DescribeElasticsearchDomainConfigResponse, AWSError>;
  170. /**
  171. * Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
  172. */
  173. describeElasticsearchDomains(params: ES.Types.DescribeElasticsearchDomainsRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainsResponse) => void): Request<ES.Types.DescribeElasticsearchDomainsResponse, AWSError>;
  174. /**
  175. * Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.
  176. */
  177. describeElasticsearchDomains(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchDomainsResponse) => void): Request<ES.Types.DescribeElasticsearchDomainsResponse, AWSError>;
  178. /**
  179. * Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.
  180. */
  181. describeElasticsearchInstanceTypeLimits(params: ES.Types.DescribeElasticsearchInstanceTypeLimitsRequest, callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchInstanceTypeLimitsResponse) => void): Request<ES.Types.DescribeElasticsearchInstanceTypeLimitsResponse, AWSError>;
  182. /**
  183. * Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the DomainName to know what Limits are supported for modifying.
  184. */
  185. describeElasticsearchInstanceTypeLimits(callback?: (err: AWSError, data: ES.Types.DescribeElasticsearchInstanceTypeLimitsResponse) => void): Request<ES.Types.DescribeElasticsearchInstanceTypeLimitsResponse, AWSError>;
  186. /**
  187. * Lists all the inbound cross-cluster search connections for a destination domain.
  188. */
  189. describeInboundCrossClusterSearchConnections(params: ES.Types.DescribeInboundCrossClusterSearchConnectionsRequest, callback?: (err: AWSError, data: ES.Types.DescribeInboundCrossClusterSearchConnectionsResponse) => void): Request<ES.Types.DescribeInboundCrossClusterSearchConnectionsResponse, AWSError>;
  190. /**
  191. * Lists all the inbound cross-cluster search connections for a destination domain.
  192. */
  193. describeInboundCrossClusterSearchConnections(callback?: (err: AWSError, data: ES.Types.DescribeInboundCrossClusterSearchConnectionsResponse) => void): Request<ES.Types.DescribeInboundCrossClusterSearchConnectionsResponse, AWSError>;
  194. /**
  195. * Lists all the outbound cross-cluster search connections for a source domain.
  196. */
  197. describeOutboundCrossClusterSearchConnections(params: ES.Types.DescribeOutboundCrossClusterSearchConnectionsRequest, callback?: (err: AWSError, data: ES.Types.DescribeOutboundCrossClusterSearchConnectionsResponse) => void): Request<ES.Types.DescribeOutboundCrossClusterSearchConnectionsResponse, AWSError>;
  198. /**
  199. * Lists all the outbound cross-cluster search connections for a source domain.
  200. */
  201. describeOutboundCrossClusterSearchConnections(callback?: (err: AWSError, data: ES.Types.DescribeOutboundCrossClusterSearchConnectionsResponse) => void): Request<ES.Types.DescribeOutboundCrossClusterSearchConnectionsResponse, AWSError>;
  202. /**
  203. * Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
  204. */
  205. describePackages(params: ES.Types.DescribePackagesRequest, callback?: (err: AWSError, data: ES.Types.DescribePackagesResponse) => void): Request<ES.Types.DescribePackagesResponse, AWSError>;
  206. /**
  207. * Describes all packages available to Amazon ES. Includes options for filtering, limiting the number of results, and pagination.
  208. */
  209. describePackages(callback?: (err: AWSError, data: ES.Types.DescribePackagesResponse) => void): Request<ES.Types.DescribePackagesResponse, AWSError>;
  210. /**
  211. * Lists available reserved Elasticsearch instance offerings.
  212. */
  213. describeReservedElasticsearchInstanceOfferings(params: ES.Types.DescribeReservedElasticsearchInstanceOfferingsRequest, callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstanceOfferingsResponse) => void): Request<ES.Types.DescribeReservedElasticsearchInstanceOfferingsResponse, AWSError>;
  214. /**
  215. * Lists available reserved Elasticsearch instance offerings.
  216. */
  217. describeReservedElasticsearchInstanceOfferings(callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstanceOfferingsResponse) => void): Request<ES.Types.DescribeReservedElasticsearchInstanceOfferingsResponse, AWSError>;
  218. /**
  219. * Returns information about reserved Elasticsearch instances for this account.
  220. */
  221. describeReservedElasticsearchInstances(params: ES.Types.DescribeReservedElasticsearchInstancesRequest, callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstancesResponse) => void): Request<ES.Types.DescribeReservedElasticsearchInstancesResponse, AWSError>;
  222. /**
  223. * Returns information about reserved Elasticsearch instances for this account.
  224. */
  225. describeReservedElasticsearchInstances(callback?: (err: AWSError, data: ES.Types.DescribeReservedElasticsearchInstancesResponse) => void): Request<ES.Types.DescribeReservedElasticsearchInstancesResponse, AWSError>;
  226. /**
  227. * Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
  228. */
  229. describeVpcEndpoints(params: ES.Types.DescribeVpcEndpointsRequest, callback?: (err: AWSError, data: ES.Types.DescribeVpcEndpointsResponse) => void): Request<ES.Types.DescribeVpcEndpointsResponse, AWSError>;
  230. /**
  231. * Describes one or more Amazon OpenSearch Service-managed VPC endpoints.
  232. */
  233. describeVpcEndpoints(callback?: (err: AWSError, data: ES.Types.DescribeVpcEndpointsResponse) => void): Request<ES.Types.DescribeVpcEndpointsResponse, AWSError>;
  234. /**
  235. * Dissociates a package from the Amazon ES domain.
  236. */
  237. dissociatePackage(params: ES.Types.DissociatePackageRequest, callback?: (err: AWSError, data: ES.Types.DissociatePackageResponse) => void): Request<ES.Types.DissociatePackageResponse, AWSError>;
  238. /**
  239. * Dissociates a package from the Amazon ES domain.
  240. */
  241. dissociatePackage(callback?: (err: AWSError, data: ES.Types.DissociatePackageResponse) => void): Request<ES.Types.DissociatePackageResponse, AWSError>;
  242. /**
  243. * Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.
  244. */
  245. getCompatibleElasticsearchVersions(params: ES.Types.GetCompatibleElasticsearchVersionsRequest, callback?: (err: AWSError, data: ES.Types.GetCompatibleElasticsearchVersionsResponse) => void): Request<ES.Types.GetCompatibleElasticsearchVersionsResponse, AWSError>;
  246. /**
  247. * Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a DomainName to get all upgrade compatible Elasticsearch versions for that specific domain.
  248. */
  249. getCompatibleElasticsearchVersions(callback?: (err: AWSError, data: ES.Types.GetCompatibleElasticsearchVersionsResponse) => void): Request<ES.Types.GetCompatibleElasticsearchVersionsResponse, AWSError>;
  250. /**
  251. * Returns a list of versions of the package, along with their creation time and commit message.
  252. */
  253. getPackageVersionHistory(params: ES.Types.GetPackageVersionHistoryRequest, callback?: (err: AWSError, data: ES.Types.GetPackageVersionHistoryResponse) => void): Request<ES.Types.GetPackageVersionHistoryResponse, AWSError>;
  254. /**
  255. * Returns a list of versions of the package, along with their creation time and commit message.
  256. */
  257. getPackageVersionHistory(callback?: (err: AWSError, data: ES.Types.GetPackageVersionHistoryResponse) => void): Request<ES.Types.GetPackageVersionHistoryResponse, AWSError>;
  258. /**
  259. * Retrieves the complete history of the last 10 upgrades that were performed on the domain.
  260. */
  261. getUpgradeHistory(params: ES.Types.GetUpgradeHistoryRequest, callback?: (err: AWSError, data: ES.Types.GetUpgradeHistoryResponse) => void): Request<ES.Types.GetUpgradeHistoryResponse, AWSError>;
  262. /**
  263. * Retrieves the complete history of the last 10 upgrades that were performed on the domain.
  264. */
  265. getUpgradeHistory(callback?: (err: AWSError, data: ES.Types.GetUpgradeHistoryResponse) => void): Request<ES.Types.GetUpgradeHistoryResponse, AWSError>;
  266. /**
  267. * Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
  268. */
  269. getUpgradeStatus(params: ES.Types.GetUpgradeStatusRequest, callback?: (err: AWSError, data: ES.Types.GetUpgradeStatusResponse) => void): Request<ES.Types.GetUpgradeStatusResponse, AWSError>;
  270. /**
  271. * Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.
  272. */
  273. getUpgradeStatus(callback?: (err: AWSError, data: ES.Types.GetUpgradeStatusResponse) => void): Request<ES.Types.GetUpgradeStatusResponse, AWSError>;
  274. /**
  275. * Returns the name of all Elasticsearch domains owned by the current user's account.
  276. */
  277. listDomainNames(params: ES.Types.ListDomainNamesRequest, callback?: (err: AWSError, data: ES.Types.ListDomainNamesResponse) => void): Request<ES.Types.ListDomainNamesResponse, AWSError>;
  278. /**
  279. * Returns the name of all Elasticsearch domains owned by the current user's account.
  280. */
  281. listDomainNames(callback?: (err: AWSError, data: ES.Types.ListDomainNamesResponse) => void): Request<ES.Types.ListDomainNamesResponse, AWSError>;
  282. /**
  283. * Lists all Amazon ES domains associated with the package.
  284. */
  285. listDomainsForPackage(params: ES.Types.ListDomainsForPackageRequest, callback?: (err: AWSError, data: ES.Types.ListDomainsForPackageResponse) => void): Request<ES.Types.ListDomainsForPackageResponse, AWSError>;
  286. /**
  287. * Lists all Amazon ES domains associated with the package.
  288. */
  289. listDomainsForPackage(callback?: (err: AWSError, data: ES.Types.ListDomainsForPackageResponse) => void): Request<ES.Types.ListDomainsForPackageResponse, AWSError>;
  290. /**
  291. * List all Elasticsearch instance types that are supported for given ElasticsearchVersion
  292. */
  293. listElasticsearchInstanceTypes(params: ES.Types.ListElasticsearchInstanceTypesRequest, callback?: (err: AWSError, data: ES.Types.ListElasticsearchInstanceTypesResponse) => void): Request<ES.Types.ListElasticsearchInstanceTypesResponse, AWSError>;
  294. /**
  295. * List all Elasticsearch instance types that are supported for given ElasticsearchVersion
  296. */
  297. listElasticsearchInstanceTypes(callback?: (err: AWSError, data: ES.Types.ListElasticsearchInstanceTypesResponse) => void): Request<ES.Types.ListElasticsearchInstanceTypesResponse, AWSError>;
  298. /**
  299. * List all supported Elasticsearch versions
  300. */
  301. listElasticsearchVersions(params: ES.Types.ListElasticsearchVersionsRequest, callback?: (err: AWSError, data: ES.Types.ListElasticsearchVersionsResponse) => void): Request<ES.Types.ListElasticsearchVersionsResponse, AWSError>;
  302. /**
  303. * List all supported Elasticsearch versions
  304. */
  305. listElasticsearchVersions(callback?: (err: AWSError, data: ES.Types.ListElasticsearchVersionsResponse) => void): Request<ES.Types.ListElasticsearchVersionsResponse, AWSError>;
  306. /**
  307. * Lists all packages associated with the Amazon ES domain.
  308. */
  309. listPackagesForDomain(params: ES.Types.ListPackagesForDomainRequest, callback?: (err: AWSError, data: ES.Types.ListPackagesForDomainResponse) => void): Request<ES.Types.ListPackagesForDomainResponse, AWSError>;
  310. /**
  311. * Lists all packages associated with the Amazon ES domain.
  312. */
  313. listPackagesForDomain(callback?: (err: AWSError, data: ES.Types.ListPackagesForDomainResponse) => void): Request<ES.Types.ListPackagesForDomainResponse, AWSError>;
  314. /**
  315. * Returns all tags for the given Elasticsearch domain.
  316. */
  317. listTags(params: ES.Types.ListTagsRequest, callback?: (err: AWSError, data: ES.Types.ListTagsResponse) => void): Request<ES.Types.ListTagsResponse, AWSError>;
  318. /**
  319. * Returns all tags for the given Elasticsearch domain.
  320. */
  321. listTags(callback?: (err: AWSError, data: ES.Types.ListTagsResponse) => void): Request<ES.Types.ListTagsResponse, AWSError>;
  322. /**
  323. * Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
  324. */
  325. listVpcEndpointAccess(params: ES.Types.ListVpcEndpointAccessRequest, callback?: (err: AWSError, data: ES.Types.ListVpcEndpointAccessResponse) => void): Request<ES.Types.ListVpcEndpointAccessResponse, AWSError>;
  326. /**
  327. * Retrieves information about each principal that is allowed to access a given Amazon OpenSearch Service domain through the use of an interface VPC endpoint.
  328. */
  329. listVpcEndpointAccess(callback?: (err: AWSError, data: ES.Types.ListVpcEndpointAccessResponse) => void): Request<ES.Types.ListVpcEndpointAccessResponse, AWSError>;
  330. /**
  331. * Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
  332. */
  333. listVpcEndpoints(params: ES.Types.ListVpcEndpointsRequest, callback?: (err: AWSError, data: ES.Types.ListVpcEndpointsResponse) => void): Request<ES.Types.ListVpcEndpointsResponse, AWSError>;
  334. /**
  335. * Retrieves all Amazon OpenSearch Service-managed VPC endpoints in the current account and Region.
  336. */
  337. listVpcEndpoints(callback?: (err: AWSError, data: ES.Types.ListVpcEndpointsResponse) => void): Request<ES.Types.ListVpcEndpointsResponse, AWSError>;
  338. /**
  339. * Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
  340. */
  341. listVpcEndpointsForDomain(params: ES.Types.ListVpcEndpointsForDomainRequest, callback?: (err: AWSError, data: ES.Types.ListVpcEndpointsForDomainResponse) => void): Request<ES.Types.ListVpcEndpointsForDomainResponse, AWSError>;
  342. /**
  343. * Retrieves all Amazon OpenSearch Service-managed VPC endpoints associated with a particular domain.
  344. */
  345. listVpcEndpointsForDomain(callback?: (err: AWSError, data: ES.Types.ListVpcEndpointsForDomainResponse) => void): Request<ES.Types.ListVpcEndpointsForDomainResponse, AWSError>;
  346. /**
  347. * Allows you to purchase reserved Elasticsearch instances.
  348. */
  349. purchaseReservedElasticsearchInstanceOffering(params: ES.Types.PurchaseReservedElasticsearchInstanceOfferingRequest, callback?: (err: AWSError, data: ES.Types.PurchaseReservedElasticsearchInstanceOfferingResponse) => void): Request<ES.Types.PurchaseReservedElasticsearchInstanceOfferingResponse, AWSError>;
  350. /**
  351. * Allows you to purchase reserved Elasticsearch instances.
  352. */
  353. purchaseReservedElasticsearchInstanceOffering(callback?: (err: AWSError, data: ES.Types.PurchaseReservedElasticsearchInstanceOfferingResponse) => void): Request<ES.Types.PurchaseReservedElasticsearchInstanceOfferingResponse, AWSError>;
  354. /**
  355. * Allows the destination domain owner to reject an inbound cross-cluster search connection request.
  356. */
  357. rejectInboundCrossClusterSearchConnection(params: ES.Types.RejectInboundCrossClusterSearchConnectionRequest, callback?: (err: AWSError, data: ES.Types.RejectInboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.RejectInboundCrossClusterSearchConnectionResponse, AWSError>;
  358. /**
  359. * Allows the destination domain owner to reject an inbound cross-cluster search connection request.
  360. */
  361. rejectInboundCrossClusterSearchConnection(callback?: (err: AWSError, data: ES.Types.RejectInboundCrossClusterSearchConnectionResponse) => void): Request<ES.Types.RejectInboundCrossClusterSearchConnectionResponse, AWSError>;
  362. /**
  363. * Removes the specified set of tags from the specified Elasticsearch domain.
  364. */
  365. removeTags(params: ES.Types.RemoveTagsRequest, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  366. /**
  367. * Removes the specified set of tags from the specified Elasticsearch domain.
  368. */
  369. removeTags(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
  370. /**
  371. * Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
  372. */
  373. revokeVpcEndpointAccess(params: ES.Types.RevokeVpcEndpointAccessRequest, callback?: (err: AWSError, data: ES.Types.RevokeVpcEndpointAccessResponse) => void): Request<ES.Types.RevokeVpcEndpointAccessResponse, AWSError>;
  374. /**
  375. * Revokes access to an Amazon OpenSearch Service domain that was provided through an interface VPC endpoint.
  376. */
  377. revokeVpcEndpointAccess(callback?: (err: AWSError, data: ES.Types.RevokeVpcEndpointAccessResponse) => void): Request<ES.Types.RevokeVpcEndpointAccessResponse, AWSError>;
  378. /**
  379. * Schedules a service software update for an Amazon ES domain.
  380. */
  381. startElasticsearchServiceSoftwareUpdate(params: ES.Types.StartElasticsearchServiceSoftwareUpdateRequest, callback?: (err: AWSError, data: ES.Types.StartElasticsearchServiceSoftwareUpdateResponse) => void): Request<ES.Types.StartElasticsearchServiceSoftwareUpdateResponse, AWSError>;
  382. /**
  383. * Schedules a service software update for an Amazon ES domain.
  384. */
  385. startElasticsearchServiceSoftwareUpdate(callback?: (err: AWSError, data: ES.Types.StartElasticsearchServiceSoftwareUpdateResponse) => void): Request<ES.Types.StartElasticsearchServiceSoftwareUpdateResponse, AWSError>;
  386. /**
  387. * Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
  388. */
  389. updateElasticsearchDomainConfig(params: ES.Types.UpdateElasticsearchDomainConfigRequest, callback?: (err: AWSError, data: ES.Types.UpdateElasticsearchDomainConfigResponse) => void): Request<ES.Types.UpdateElasticsearchDomainConfigResponse, AWSError>;
  390. /**
  391. * Modifies the cluster configuration of the specified Elasticsearch domain, setting as setting the instance type and the number of instances.
  392. */
  393. updateElasticsearchDomainConfig(callback?: (err: AWSError, data: ES.Types.UpdateElasticsearchDomainConfigResponse) => void): Request<ES.Types.UpdateElasticsearchDomainConfigResponse, AWSError>;
  394. /**
  395. * Updates a package for use with Amazon ES domains.
  396. */
  397. updatePackage(params: ES.Types.UpdatePackageRequest, callback?: (err: AWSError, data: ES.Types.UpdatePackageResponse) => void): Request<ES.Types.UpdatePackageResponse, AWSError>;
  398. /**
  399. * Updates a package for use with Amazon ES domains.
  400. */
  401. updatePackage(callback?: (err: AWSError, data: ES.Types.UpdatePackageResponse) => void): Request<ES.Types.UpdatePackageResponse, AWSError>;
  402. /**
  403. * Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
  404. */
  405. updateVpcEndpoint(params: ES.Types.UpdateVpcEndpointRequest, callback?: (err: AWSError, data: ES.Types.UpdateVpcEndpointResponse) => void): Request<ES.Types.UpdateVpcEndpointResponse, AWSError>;
  406. /**
  407. * Modifies an Amazon OpenSearch Service-managed interface VPC endpoint.
  408. */
  409. updateVpcEndpoint(callback?: (err: AWSError, data: ES.Types.UpdateVpcEndpointResponse) => void): Request<ES.Types.UpdateVpcEndpointResponse, AWSError>;
  410. /**
  411. * Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
  412. */
  413. upgradeElasticsearchDomain(params: ES.Types.UpgradeElasticsearchDomainRequest, callback?: (err: AWSError, data: ES.Types.UpgradeElasticsearchDomainResponse) => void): Request<ES.Types.UpgradeElasticsearchDomainResponse, AWSError>;
  414. /**
  415. * Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.
  416. */
  417. upgradeElasticsearchDomain(callback?: (err: AWSError, data: ES.Types.UpgradeElasticsearchDomainResponse) => void): Request<ES.Types.UpgradeElasticsearchDomainResponse, AWSError>;
  418. }
  419. declare namespace ES {
  420. export type ARN = string;
  421. export type AWSAccount = string;
  422. export interface AcceptInboundCrossClusterSearchConnectionRequest {
  423. /**
  424. * The id of the inbound connection that you want to accept.
  425. */
  426. CrossClusterSearchConnectionId: CrossClusterSearchConnectionId;
  427. }
  428. export interface AcceptInboundCrossClusterSearchConnectionResponse {
  429. /**
  430. * Specifies the InboundCrossClusterSearchConnection of accepted inbound connection.
  431. */
  432. CrossClusterSearchConnection?: InboundCrossClusterSearchConnection;
  433. }
  434. export interface AccessPoliciesStatus {
  435. /**
  436. * The access policy configured for the Elasticsearch domain. Access policies may be resource-based, IP-based, or IAM-based. See Configuring Access Policiesfor more information.
  437. */
  438. Options: PolicyDocument;
  439. /**
  440. * The status of the access policy for the Elasticsearch domain. See OptionStatus for the status information that's included.
  441. */
  442. Status: OptionStatus;
  443. }
  444. export interface AddTagsRequest {
  445. /**
  446. * Specify the ARN for which you want to add the tags.
  447. */
  448. ARN: ARN;
  449. /**
  450. * List of Tag that need to be added for the Elasticsearch domain.
  451. */
  452. TagList: TagList;
  453. }
  454. export interface AdditionalLimit {
  455. /**
  456. * Name of Additional Limit is specific to a given InstanceType and for each of it's InstanceRole etc. Attributes and their details: MaximumNumberOfDataNodesSupported This attribute will be present in Master node only to specify how much data nodes upto which given ESPartitionInstanceType can support as master node. MaximumNumberOfDataNodesWithoutMasterNode This attribute will be present in Data node only to specify how much data nodes of given ESPartitionInstanceType upto which you don't need any master nodes to govern them.
  457. */
  458. LimitName?: LimitName;
  459. /**
  460. * Value for given AdditionalLimit$LimitName .
  461. */
  462. LimitValues?: LimitValueList;
  463. }
  464. export type AdditionalLimitList = AdditionalLimit[];
  465. export type AdvancedOptions = {[key: string]: String};
  466. export interface AdvancedOptionsStatus {
  467. /**
  468. * Specifies the status of advanced options for the specified Elasticsearch domain.
  469. */
  470. Options: AdvancedOptions;
  471. /**
  472. * Specifies the status of OptionStatus for advanced options for the specified Elasticsearch domain.
  473. */
  474. Status: OptionStatus;
  475. }
  476. export interface AdvancedSecurityOptions {
  477. /**
  478. * True if advanced security is enabled.
  479. */
  480. Enabled?: Boolean;
  481. /**
  482. * True if the internal user database is enabled.
  483. */
  484. InternalUserDatabaseEnabled?: Boolean;
  485. /**
  486. * Describes the SAML application configured for a domain.
  487. */
  488. SAMLOptions?: SAMLOptionsOutput;
  489. /**
  490. * Specifies the Anonymous Auth Disable Date when Anonymous Auth is enabled.
  491. */
  492. AnonymousAuthDisableDate?: DisableTimestamp;
  493. /**
  494. * True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
  495. */
  496. AnonymousAuthEnabled?: Boolean;
  497. }
  498. export interface AdvancedSecurityOptionsInput {
  499. /**
  500. * True if advanced security is enabled.
  501. */
  502. Enabled?: Boolean;
  503. /**
  504. * True if the internal user database is enabled.
  505. */
  506. InternalUserDatabaseEnabled?: Boolean;
  507. /**
  508. * Credentials for the master user: username and password, ARN, or both.
  509. */
  510. MasterUserOptions?: MasterUserOptions;
  511. /**
  512. * Specifies the SAML application configuration for the domain.
  513. */
  514. SAMLOptions?: SAMLOptionsInput;
  515. /**
  516. * True if Anonymous auth is enabled. Anonymous auth can be enabled only when AdvancedSecurity is enabled on existing domains.
  517. */
  518. AnonymousAuthEnabled?: Boolean;
  519. }
  520. export interface AdvancedSecurityOptionsStatus {
  521. /**
  522. * Specifies advanced security options for the specified Elasticsearch domain.
  523. */
  524. Options: AdvancedSecurityOptions;
  525. /**
  526. * Status of the advanced security options for the specified Elasticsearch domain.
  527. */
  528. Status: OptionStatus;
  529. }
  530. export interface AssociatePackageRequest {
  531. /**
  532. * Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.
  533. */
  534. PackageID: PackageID;
  535. /**
  536. * Name of the domain that you want to associate the package with.
  537. */
  538. DomainName: DomainName;
  539. }
  540. export interface AssociatePackageResponse {
  541. /**
  542. * DomainPackageDetails
  543. */
  544. DomainPackageDetails?: DomainPackageDetails;
  545. }
  546. export interface AuthorizeVpcEndpointAccessRequest {
  547. /**
  548. * The name of the OpenSearch Service domain to provide access to.
  549. */
  550. DomainName: DomainName;
  551. /**
  552. * The account ID to grant access to.
  553. */
  554. Account: AWSAccount;
  555. }
  556. export interface AuthorizeVpcEndpointAccessResponse {
  557. /**
  558. * Information about the account or service that was provided access to the domain.
  559. */
  560. AuthorizedPrincipal: AuthorizedPrincipal;
  561. }
  562. export interface AuthorizedPrincipal {
  563. /**
  564. * The type of principal.
  565. */
  566. PrincipalType?: PrincipalType;
  567. /**
  568. * The IAM principal that is allowed access to the domain.
  569. */
  570. Principal?: String;
  571. }
  572. export type AuthorizedPrincipalList = AuthorizedPrincipal[];
  573. export interface AutoTune {
  574. /**
  575. * Specifies Auto-Tune type. Valid value is SCHEDULED_ACTION.
  576. */
  577. AutoTuneType?: AutoTuneType;
  578. /**
  579. * Specifies details of the Auto-Tune action. See the Developer Guide for more information.
  580. */
  581. AutoTuneDetails?: AutoTuneDetails;
  582. }
  583. export type AutoTuneDate = Date;
  584. export type AutoTuneDesiredState = "ENABLED"|"DISABLED"|string;
  585. export interface AutoTuneDetails {
  586. ScheduledAutoTuneDetails?: ScheduledAutoTuneDetails;
  587. }
  588. export type AutoTuneList = AutoTune[];
  589. export interface AutoTuneMaintenanceSchedule {
  590. /**
  591. * Specifies timestamp at which Auto-Tune maintenance schedule start.
  592. */
  593. StartAt?: StartAt;
  594. /**
  595. * Specifies maintenance schedule duration: duration value and duration unit. See the Developer Guide for more information.
  596. */
  597. Duration?: Duration;
  598. /**
  599. * Specifies cron expression for a recurring maintenance schedule. See the Developer Guide for more information.
  600. */
  601. CronExpressionForRecurrence?: String;
  602. }
  603. export type AutoTuneMaintenanceScheduleList = AutoTuneMaintenanceSchedule[];
  604. export interface AutoTuneOptions {
  605. /**
  606. * Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
  607. */
  608. DesiredState?: AutoTuneDesiredState;
  609. /**
  610. * Specifies the rollback state while disabling Auto-Tune for the domain. Valid values are NO_ROLLBACK, DEFAULT_ROLLBACK.
  611. */
  612. RollbackOnDisable?: RollbackOnDisable;
  613. /**
  614. * Specifies list of maitenance schedules. See the Developer Guide for more information.
  615. */
  616. MaintenanceSchedules?: AutoTuneMaintenanceScheduleList;
  617. }
  618. export interface AutoTuneOptionsInput {
  619. /**
  620. * Specifies the Auto-Tune desired state. Valid values are ENABLED, DISABLED.
  621. */
  622. DesiredState?: AutoTuneDesiredState;
  623. /**
  624. * Specifies list of maitenance schedules. See the Developer Guide for more information.
  625. */
  626. MaintenanceSchedules?: AutoTuneMaintenanceScheduleList;
  627. }
  628. export interface AutoTuneOptionsOutput {
  629. /**
  630. * Specifies the AutoTuneState for the Elasticsearch domain.
  631. */
  632. State?: AutoTuneState;
  633. /**
  634. * Specifies the error message while enabling or disabling the Auto-Tune.
  635. */
  636. ErrorMessage?: String;
  637. }
  638. export interface AutoTuneOptionsStatus {
  639. /**
  640. * Specifies Auto-Tune options for the specified Elasticsearch domain.
  641. */
  642. Options?: AutoTuneOptions;
  643. /**
  644. * Specifies Status of the Auto-Tune options for the specified Elasticsearch domain.
  645. */
  646. Status?: AutoTuneStatus;
  647. }
  648. export type AutoTuneState = "ENABLED"|"DISABLED"|"ENABLE_IN_PROGRESS"|"DISABLE_IN_PROGRESS"|"DISABLED_AND_ROLLBACK_SCHEDULED"|"DISABLED_AND_ROLLBACK_IN_PROGRESS"|"DISABLED_AND_ROLLBACK_COMPLETE"|"DISABLED_AND_ROLLBACK_ERROR"|"ERROR"|string;
  649. export interface AutoTuneStatus {
  650. /**
  651. * Timestamp which tells Auto-Tune options creation date .
  652. */
  653. CreationDate: UpdateTimestamp;
  654. /**
  655. * Timestamp which tells Auto-Tune options last updated time.
  656. */
  657. UpdateDate: UpdateTimestamp;
  658. /**
  659. * Specifies the Auto-Tune options latest version.
  660. */
  661. UpdateVersion?: UIntValue;
  662. /**
  663. * Specifies the AutoTuneState for the Elasticsearch domain.
  664. */
  665. State: AutoTuneState;
  666. /**
  667. * Specifies the error message while enabling or disabling the Auto-Tune options.
  668. */
  669. ErrorMessage?: String;
  670. /**
  671. * Indicates whether the Elasticsearch domain is being deleted.
  672. */
  673. PendingDeletion?: Boolean;
  674. }
  675. export type AutoTuneType = "SCHEDULED_ACTION"|string;
  676. export type BackendRole = string;
  677. export type Boolean = boolean;
  678. export interface CancelDomainConfigChangeRequest {
  679. /**
  680. * Name of the OpenSearch Service domain configuration request to cancel.
  681. */
  682. DomainName: DomainName;
  683. /**
  684. * When set to True, returns the list of change IDs and properties that will be cancelled without actually cancelling the change.
  685. */
  686. DryRun?: DryRun;
  687. }
  688. export interface CancelDomainConfigChangeResponse {
  689. /**
  690. * Whether or not the request was a dry run. If True, the changes were not actually cancelled.
  691. */
  692. DryRun?: DryRun;
  693. /**
  694. * The unique identifiers of the changes that were cancelled.
  695. */
  696. CancelledChangeIds?: GUIDList;
  697. /**
  698. * The domain change properties that were cancelled.
  699. */
  700. CancelledChangeProperties?: CancelledChangePropertyList;
  701. }
  702. export interface CancelElasticsearchServiceSoftwareUpdateRequest {
  703. /**
  704. * The name of the domain that you want to stop the latest service software update on.
  705. */
  706. DomainName: DomainName;
  707. }
  708. export interface CancelElasticsearchServiceSoftwareUpdateResponse {
  709. /**
  710. * The current status of the Elasticsearch service software update.
  711. */
  712. ServiceSoftwareOptions?: ServiceSoftwareOptions;
  713. }
  714. export interface CancelledChangeProperty {
  715. /**
  716. * The name of the property whose change was cancelled.
  717. */
  718. PropertyName?: String;
  719. /**
  720. * The pending value of the property that was cancelled. This would have been the eventual value of the property if the chance had not been cancelled.
  721. */
  722. CancelledValue?: String;
  723. /**
  724. * The current value of the property, after the change was cancelled.
  725. */
  726. ActiveValue?: String;
  727. }
  728. export type CancelledChangePropertyList = CancelledChangeProperty[];
  729. export interface ChangeProgressDetails {
  730. /**
  731. * The unique change identifier associated with a specific domain configuration change.
  732. */
  733. ChangeId?: GUID;
  734. /**
  735. * Contains an optional message associated with the domain configuration change.
  736. */
  737. Message?: Message;
  738. /**
  739. * The current status of the configuration change.
  740. */
  741. ConfigChangeStatus?: ConfigChangeStatus;
  742. /**
  743. * The time that the configuration change was initiated, in Universal Coordinated Time (UTC).
  744. */
  745. StartTime?: UpdateTimestamp;
  746. /**
  747. * The last time that the configuration change was updated.
  748. */
  749. LastUpdatedTime?: UpdateTimestamp;
  750. /**
  751. * The IAM principal who initiated the configuration change.
  752. */
  753. InitiatedBy?: InitiatedBy;
  754. }
  755. export interface ChangeProgressStage {
  756. /**
  757. * The name of the specific progress stage.
  758. */
  759. Name?: ChangeProgressStageName;
  760. /**
  761. * The overall status of a specific progress stage.
  762. */
  763. Status?: ChangeProgressStageStatus;
  764. /**
  765. * The description of the progress stage.
  766. */
  767. Description?: Description;
  768. /**
  769. * The last updated timestamp of the progress stage.
  770. */
  771. LastUpdated?: LastUpdated;
  772. }
  773. export type ChangeProgressStageList = ChangeProgressStage[];
  774. export type ChangeProgressStageName = string;
  775. export type ChangeProgressStageStatus = string;
  776. export interface ChangeProgressStatusDetails {
  777. /**
  778. * The unique change identifier associated with a specific domain configuration change.
  779. */
  780. ChangeId?: GUID;
  781. /**
  782. * The time at which the configuration change is made on the domain.
  783. */
  784. StartTime?: UpdateTimestamp;
  785. /**
  786. * The overall status of the domain configuration change. This field can take the following values: PENDING, PROCESSING, COMPLETED and FAILED
  787. */
  788. Status?: OverallChangeStatus;
  789. /**
  790. * The list of properties involved in the domain configuration change that are still in pending.
  791. */
  792. PendingProperties?: StringList;
  793. /**
  794. * The list of properties involved in the domain configuration change that are completed.
  795. */
  796. CompletedProperties?: StringList;
  797. /**
  798. * The total number of stages required for the configuration change.
  799. */
  800. TotalNumberOfStages?: TotalNumberOfStages;
  801. /**
  802. * The specific stages that the domain is going through to perform the configuration change.
  803. */
  804. ChangeProgressStages?: ChangeProgressStageList;
  805. /**
  806. * The current status of the configuration change.
  807. */
  808. ConfigChangeStatus?: ConfigChangeStatus;
  809. /**
  810. * The last time that the status of the configuration change was updated.
  811. */
  812. LastUpdatedTime?: UpdateTimestamp;
  813. /**
  814. * The IAM principal who initiated the configuration change.
  815. */
  816. InitiatedBy?: InitiatedBy;
  817. }
  818. export type ClientToken = string;
  819. export type CloudWatchLogsLogGroupArn = string;
  820. export interface CognitoOptions {
  821. /**
  822. * Specifies the option to enable Cognito for Kibana authentication.
  823. */
  824. Enabled?: Boolean;
  825. /**
  826. * Specifies the Cognito user pool ID for Kibana authentication.
  827. */
  828. UserPoolId?: UserPoolId;
  829. /**
  830. * Specifies the Cognito identity pool ID for Kibana authentication.
  831. */
  832. IdentityPoolId?: IdentityPoolId;
  833. /**
  834. * Specifies the role ARN that provides Elasticsearch permissions for accessing Cognito resources.
  835. */
  836. RoleArn?: RoleArn;
  837. }
  838. export interface CognitoOptionsStatus {
  839. /**
  840. * Specifies the Cognito options for the specified Elasticsearch domain.
  841. */
  842. Options: CognitoOptions;
  843. /**
  844. * Specifies the status of the Cognito options for the specified Elasticsearch domain.
  845. */
  846. Status: OptionStatus;
  847. }
  848. export interface ColdStorageOptions {
  849. /**
  850. * Enable cold storage option. Accepted values true or false
  851. */
  852. Enabled: Boolean;
  853. }
  854. export type CommitMessage = string;
  855. export type CompatibleElasticsearchVersionsList = CompatibleVersionsMap[];
  856. export interface CompatibleVersionsMap {
  857. /**
  858. * The current version of Elasticsearch on which a domain is.
  859. */
  860. SourceVersion?: ElasticsearchVersionString;
  861. TargetVersions?: ElasticsearchVersionList;
  862. }
  863. export type ConfigChangeStatus = "Pending"|"Initializing"|"Validating"|"ValidationFailed"|"ApplyingChanges"|"Completed"|"PendingUserInput"|"Cancelled"|string;
  864. export type ConnectionAlias = string;
  865. export interface CreateElasticsearchDomainRequest {
  866. /**
  867. * The name of the Elasticsearch domain that you are creating. Domain names are unique across the domains owned by an account within an AWS region. Domain names must start with a lowercase letter and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
  868. */
  869. DomainName: DomainName;
  870. /**
  871. * String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3". For more information, see Creating Elasticsearch Domains in the Amazon Elasticsearch Service Developer Guide.
  872. */
  873. ElasticsearchVersion?: ElasticsearchVersionString;
  874. /**
  875. * Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.
  876. */
  877. ElasticsearchClusterConfig?: ElasticsearchClusterConfig;
  878. /**
  879. * Options to enable, disable and specify the type and size of EBS storage volumes.
  880. */
  881. EBSOptions?: EBSOptions;
  882. /**
  883. * IAM access policy as a JSON-formatted string.
  884. */
  885. AccessPolicies?: PolicyDocument;
  886. /**
  887. * Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.
  888. */
  889. SnapshotOptions?: SnapshotOptions;
  890. /**
  891. * Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains
  892. */
  893. VPCOptions?: VPCOptions;
  894. /**
  895. * Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
  896. */
  897. CognitoOptions?: CognitoOptions;
  898. /**
  899. * Specifies the Encryption At Rest Options.
  900. */
  901. EncryptionAtRestOptions?: EncryptionAtRestOptions;
  902. /**
  903. * Specifies the NodeToNodeEncryptionOptions.
  904. */
  905. NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
  906. /**
  907. * Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
  908. */
  909. AdvancedOptions?: AdvancedOptions;
  910. /**
  911. * Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.
  912. */
  913. LogPublishingOptions?: LogPublishingOptions;
  914. /**
  915. * Options to specify configuration that will be applied to the domain endpoint.
  916. */
  917. DomainEndpointOptions?: DomainEndpointOptions;
  918. /**
  919. * Specifies advanced security options.
  920. */
  921. AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
  922. /**
  923. * Specifies Auto-Tune options.
  924. */
  925. AutoTuneOptions?: AutoTuneOptionsInput;
  926. /**
  927. * A list of Tag added during domain creation.
  928. */
  929. TagList?: TagList;
  930. }
  931. export interface CreateElasticsearchDomainResponse {
  932. /**
  933. * The status of the newly created Elasticsearch domain.
  934. */
  935. DomainStatus?: ElasticsearchDomainStatus;
  936. }
  937. export interface CreateOutboundCrossClusterSearchConnectionRequest {
  938. /**
  939. * Specifies the DomainInformation for the source Elasticsearch domain.
  940. */
  941. SourceDomainInfo: DomainInformation;
  942. /**
  943. * Specifies the DomainInformation for the destination Elasticsearch domain.
  944. */
  945. DestinationDomainInfo: DomainInformation;
  946. /**
  947. * Specifies the connection alias that will be used by the customer for this connection.
  948. */
  949. ConnectionAlias: ConnectionAlias;
  950. }
  951. export interface CreateOutboundCrossClusterSearchConnectionResponse {
  952. /**
  953. * Specifies the DomainInformation for the source Elasticsearch domain.
  954. */
  955. SourceDomainInfo?: DomainInformation;
  956. /**
  957. * Specifies the DomainInformation for the destination Elasticsearch domain.
  958. */
  959. DestinationDomainInfo?: DomainInformation;
  960. /**
  961. * Specifies the connection alias provided during the create connection request.
  962. */
  963. ConnectionAlias?: ConnectionAlias;
  964. /**
  965. * Specifies the OutboundCrossClusterSearchConnectionStatus for the newly created connection.
  966. */
  967. ConnectionStatus?: OutboundCrossClusterSearchConnectionStatus;
  968. /**
  969. * Unique id for the created outbound connection, which is used for subsequent operations on connection.
  970. */
  971. CrossClusterSearchConnectionId?: CrossClusterSearchConnectionId;
  972. }
  973. export interface CreatePackageRequest {
  974. /**
  975. * Unique identifier for the package.
  976. */
  977. PackageName: PackageName;
  978. /**
  979. * Type of package. Currently supports only TXT-DICTIONARY.
  980. */
  981. PackageType: PackageType;
  982. /**
  983. * Description of the package.
  984. */
  985. PackageDescription?: PackageDescription;
  986. /**
  987. * The customer S3 location PackageSource for importing the package.
  988. */
  989. PackageSource: PackageSource;
  990. }
  991. export interface CreatePackageResponse {
  992. /**
  993. * Information about the package PackageDetails.
  994. */
  995. PackageDetails?: PackageDetails;
  996. }
  997. export interface CreateVpcEndpointRequest {
  998. /**
  999. * The Amazon Resource Name (ARN) of the domain to grant access to.
  1000. */
  1001. DomainArn: DomainArn;
  1002. /**
  1003. * Options to specify the subnets and security groups for the endpoint.
  1004. */
  1005. VpcOptions: VPCOptions;
  1006. /**
  1007. * Unique, case-sensitive identifier to ensure idempotency of the request.
  1008. */
  1009. ClientToken?: ClientToken;
  1010. }
  1011. export interface CreateVpcEndpointResponse {
  1012. /**
  1013. * Information about the newly created VPC endpoint.
  1014. */
  1015. VpcEndpoint: VpcEndpoint;
  1016. }
  1017. export type CreatedAt = Date;
  1018. export type CrossClusterSearchConnectionId = string;
  1019. export type CrossClusterSearchConnectionStatusMessage = string;
  1020. export interface DeleteElasticsearchDomainRequest {
  1021. /**
  1022. * The name of the Elasticsearch domain that you want to permanently delete.
  1023. */
  1024. DomainName: DomainName;
  1025. }
  1026. export interface DeleteElasticsearchDomainResponse {
  1027. /**
  1028. * The status of the Elasticsearch domain being deleted.
  1029. */
  1030. DomainStatus?: ElasticsearchDomainStatus;
  1031. }
  1032. export interface DeleteInboundCrossClusterSearchConnectionRequest {
  1033. /**
  1034. * The id of the inbound connection that you want to permanently delete.
  1035. */
  1036. CrossClusterSearchConnectionId: CrossClusterSearchConnectionId;
  1037. }
  1038. export interface DeleteInboundCrossClusterSearchConnectionResponse {
  1039. /**
  1040. * Specifies the InboundCrossClusterSearchConnection of deleted inbound connection.
  1041. */
  1042. CrossClusterSearchConnection?: InboundCrossClusterSearchConnection;
  1043. }
  1044. export interface DeleteOutboundCrossClusterSearchConnectionRequest {
  1045. /**
  1046. * The id of the outbound connection that you want to permanently delete.
  1047. */
  1048. CrossClusterSearchConnectionId: CrossClusterSearchConnectionId;
  1049. }
  1050. export interface DeleteOutboundCrossClusterSearchConnectionResponse {
  1051. /**
  1052. * Specifies the OutboundCrossClusterSearchConnection of deleted outbound connection.
  1053. */
  1054. CrossClusterSearchConnection?: OutboundCrossClusterSearchConnection;
  1055. }
  1056. export interface DeletePackageRequest {
  1057. /**
  1058. * Internal ID of the package that you want to delete. Use DescribePackages to find this value.
  1059. */
  1060. PackageID: PackageID;
  1061. }
  1062. export interface DeletePackageResponse {
  1063. /**
  1064. * PackageDetails
  1065. */
  1066. PackageDetails?: PackageDetails;
  1067. }
  1068. export interface DeleteVpcEndpointRequest {
  1069. /**
  1070. * The unique identifier of the endpoint to be deleted.
  1071. */
  1072. VpcEndpointId: VpcEndpointId;
  1073. }
  1074. export interface DeleteVpcEndpointResponse {
  1075. /**
  1076. * Information about the deleted endpoint, including its current status (DELETING or DELETE_FAILED).
  1077. */
  1078. VpcEndpointSummary: VpcEndpointSummary;
  1079. }
  1080. export type DeploymentCloseDateTimeStamp = Date;
  1081. export type DeploymentStatus = "PENDING_UPDATE"|"IN_PROGRESS"|"COMPLETED"|"NOT_ELIGIBLE"|"ELIGIBLE"|string;
  1082. export type DeploymentType = string;
  1083. export interface DescribeDomainAutoTunesRequest {
  1084. /**
  1085. * Specifies the domain name for which you want Auto-Tune action details.
  1086. */
  1087. DomainName: DomainName;
  1088. /**
  1089. * Set this value to limit the number of results returned. If not specified, defaults to 100.
  1090. */
  1091. MaxResults?: MaxResults;
  1092. /**
  1093. * NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.
  1094. */
  1095. NextToken?: NextToken;
  1096. }
  1097. export interface DescribeDomainAutoTunesResponse {
  1098. /**
  1099. * Specifies the list of setting adjustments that Auto-Tune has made to the domain. See the Developer Guide for more information.
  1100. */
  1101. AutoTunes?: AutoTuneList;
  1102. /**
  1103. * Specifies an identifier to allow retrieval of paginated results.
  1104. */
  1105. NextToken?: NextToken;
  1106. }
  1107. export interface DescribeDomainChangeProgressRequest {
  1108. /**
  1109. * The domain you want to get the progress information about.
  1110. */
  1111. DomainName: DomainName;
  1112. /**
  1113. * The specific change ID for which you want to get progress information. This is an optional parameter. If omitted, the service returns information about the most recent configuration change.
  1114. */
  1115. ChangeId?: GUID;
  1116. }
  1117. export interface DescribeDomainChangeProgressResponse {
  1118. /**
  1119. * Progress information for the configuration change that is requested in the DescribeDomainChangeProgress request.
  1120. */
  1121. ChangeProgressStatus?: ChangeProgressStatusDetails;
  1122. }
  1123. export interface DescribeElasticsearchDomainConfigRequest {
  1124. /**
  1125. * The Elasticsearch domain that you want to get information about.
  1126. */
  1127. DomainName: DomainName;
  1128. }
  1129. export interface DescribeElasticsearchDomainConfigResponse {
  1130. /**
  1131. * The configuration information of the domain requested in the DescribeElasticsearchDomainConfig request.
  1132. */
  1133. DomainConfig: ElasticsearchDomainConfig;
  1134. }
  1135. export interface DescribeElasticsearchDomainRequest {
  1136. /**
  1137. * The name of the Elasticsearch domain for which you want information.
  1138. */
  1139. DomainName: DomainName;
  1140. }
  1141. export interface DescribeElasticsearchDomainResponse {
  1142. /**
  1143. * The current status of the Elasticsearch domain.
  1144. */
  1145. DomainStatus: ElasticsearchDomainStatus;
  1146. }
  1147. export interface DescribeElasticsearchDomainsRequest {
  1148. /**
  1149. * The Elasticsearch domains for which you want information.
  1150. */
  1151. DomainNames: DomainNameList;
  1152. }
  1153. export interface DescribeElasticsearchDomainsResponse {
  1154. /**
  1155. * The status of the domains requested in the DescribeElasticsearchDomains request.
  1156. */
  1157. DomainStatusList: ElasticsearchDomainStatusList;
  1158. }
  1159. export interface DescribeElasticsearchInstanceTypeLimitsRequest {
  1160. /**
  1161. * DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch Limits for existing domain.
  1162. */
  1163. DomainName?: DomainName;
  1164. /**
  1165. * The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed.
  1166. */
  1167. InstanceType: ESPartitionInstanceType;
  1168. /**
  1169. * Version of Elasticsearch for which Limits are needed.
  1170. */
  1171. ElasticsearchVersion: ElasticsearchVersionString;
  1172. }
  1173. export interface DescribeElasticsearchInstanceTypeLimitsResponse {
  1174. LimitsByRole?: LimitsByRole;
  1175. }
  1176. export interface DescribeInboundCrossClusterSearchConnectionsRequest {
  1177. /**
  1178. * A list of filters used to match properties for inbound cross-cluster search connection. Available Filter names for this operation are: cross-cluster-search-connection-id source-domain-info.domain-name source-domain-info.owner-id source-domain-info.region destination-domain-info.domain-name
  1179. */
  1180. Filters?: FilterList;
  1181. /**
  1182. * Set this value to limit the number of results returned. If not specified, defaults to 100.
  1183. */
  1184. MaxResults?: MaxResults;
  1185. /**
  1186. * NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.
  1187. */
  1188. NextToken?: NextToken;
  1189. }
  1190. export interface DescribeInboundCrossClusterSearchConnectionsResponse {
  1191. /**
  1192. * Consists of list of InboundCrossClusterSearchConnection matching the specified filter criteria.
  1193. */
  1194. CrossClusterSearchConnections?: InboundCrossClusterSearchConnections;
  1195. /**
  1196. * If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
  1197. */
  1198. NextToken?: NextToken;
  1199. }
  1200. export interface DescribeOutboundCrossClusterSearchConnectionsRequest {
  1201. /**
  1202. * A list of filters used to match properties for outbound cross-cluster search connection. Available Filter names for this operation are: cross-cluster-search-connection-id destination-domain-info.domain-name destination-domain-info.owner-id destination-domain-info.region source-domain-info.domain-name
  1203. */
  1204. Filters?: FilterList;
  1205. /**
  1206. * Set this value to limit the number of results returned. If not specified, defaults to 100.
  1207. */
  1208. MaxResults?: MaxResults;
  1209. /**
  1210. * NextToken is sent in case the earlier API call results contain the NextToken. It is used for pagination.
  1211. */
  1212. NextToken?: NextToken;
  1213. }
  1214. export interface DescribeOutboundCrossClusterSearchConnectionsResponse {
  1215. /**
  1216. * Consists of list of OutboundCrossClusterSearchConnection matching the specified filter criteria.
  1217. */
  1218. CrossClusterSearchConnections?: OutboundCrossClusterSearchConnections;
  1219. /**
  1220. * If more results are available and NextToken is present, make the next request to the same API with the received NextToken to paginate the remaining results.
  1221. */
  1222. NextToken?: NextToken;
  1223. }
  1224. export interface DescribePackagesFilter {
  1225. /**
  1226. * Any field from PackageDetails.
  1227. */
  1228. Name?: DescribePackagesFilterName;
  1229. /**
  1230. * A non-empty list of values for the specified field.
  1231. */
  1232. Value?: DescribePackagesFilterValues;
  1233. }
  1234. export type DescribePackagesFilterList = DescribePackagesFilter[];
  1235. export type DescribePackagesFilterName = "PackageID"|"PackageName"|"PackageStatus"|string;
  1236. export type DescribePackagesFilterValue = string;
  1237. export type DescribePackagesFilterValues = DescribePackagesFilterValue[];
  1238. export interface DescribePackagesRequest {
  1239. /**
  1240. * Only returns packages that match the DescribePackagesFilterList values.
  1241. */
  1242. Filters?: DescribePackagesFilterList;
  1243. /**
  1244. * Limits results to a maximum number of packages.
  1245. */
  1246. MaxResults?: MaxResults;
  1247. /**
  1248. * Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
  1249. */
  1250. NextToken?: NextToken;
  1251. }
  1252. export interface DescribePackagesResponse {
  1253. /**
  1254. * List of PackageDetails objects.
  1255. */
  1256. PackageDetailsList?: PackageDetailsList;
  1257. NextToken?: String;
  1258. }
  1259. export interface DescribeReservedElasticsearchInstanceOfferingsRequest {
  1260. /**
  1261. * The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.
  1262. */
  1263. ReservedElasticsearchInstanceOfferingId?: GUID;
  1264. /**
  1265. * Set this value to limit the number of results returned. If not specified, defaults to 100.
  1266. */
  1267. MaxResults?: MaxResults;
  1268. /**
  1269. * NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.
  1270. */
  1271. NextToken?: NextToken;
  1272. }
  1273. export interface DescribeReservedElasticsearchInstanceOfferingsResponse {
  1274. /**
  1275. * Provides an identifier to allow retrieval of paginated results.
  1276. */
  1277. NextToken?: NextToken;
  1278. /**
  1279. * List of reserved Elasticsearch instance offerings
  1280. */
  1281. ReservedElasticsearchInstanceOfferings?: ReservedElasticsearchInstanceOfferingList;
  1282. }
  1283. export interface DescribeReservedElasticsearchInstancesRequest {
  1284. /**
  1285. * The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.
  1286. */
  1287. ReservedElasticsearchInstanceId?: GUID;
  1288. /**
  1289. * Set this value to limit the number of results returned. If not specified, defaults to 100.
  1290. */
  1291. MaxResults?: MaxResults;
  1292. /**
  1293. * NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.
  1294. */
  1295. NextToken?: NextToken;
  1296. }
  1297. export interface DescribeReservedElasticsearchInstancesResponse {
  1298. /**
  1299. * Provides an identifier to allow retrieval of paginated results.
  1300. */
  1301. NextToken?: String;
  1302. /**
  1303. * List of reserved Elasticsearch instances.
  1304. */
  1305. ReservedElasticsearchInstances?: ReservedElasticsearchInstanceList;
  1306. }
  1307. export interface DescribeVpcEndpointsRequest {
  1308. /**
  1309. * The unique identifiers of the endpoints to get information about.
  1310. */
  1311. VpcEndpointIds: VpcEndpointIdList;
  1312. }
  1313. export interface DescribeVpcEndpointsResponse {
  1314. /**
  1315. * Information about each requested VPC endpoint.
  1316. */
  1317. VpcEndpoints: VpcEndpoints;
  1318. /**
  1319. * Any errors associated with the request.
  1320. */
  1321. VpcEndpointErrors: VpcEndpointErrorList;
  1322. }
  1323. export type Description = string;
  1324. export type DisableTimestamp = Date;
  1325. export interface DissociatePackageRequest {
  1326. /**
  1327. * Internal ID of the package that you want to associate with a domain. Use DescribePackages to find this value.
  1328. */
  1329. PackageID: PackageID;
  1330. /**
  1331. * Name of the domain that you want to associate the package with.
  1332. */
  1333. DomainName: DomainName;
  1334. }
  1335. export interface DissociatePackageResponse {
  1336. /**
  1337. * DomainPackageDetails
  1338. */
  1339. DomainPackageDetails?: DomainPackageDetails;
  1340. }
  1341. export type DomainArn = string;
  1342. export interface DomainEndpointOptions {
  1343. /**
  1344. * Specify if only HTTPS endpoint should be enabled for the Elasticsearch domain.
  1345. */
  1346. EnforceHTTPS?: Boolean;
  1347. /**
  1348. * Specify the TLS security policy that needs to be applied to the HTTPS endpoint of Elasticsearch domain. It can be one of the following values: Policy-Min-TLS-1-0-2019-07: TLS security policy that supports TLS version 1.0 to TLS version 1.2 Policy-Min-TLS-1-2-2019-07: TLS security policy that supports only TLS version 1.2 Policy-Min-TLS-1-2-PFS-2023-10: TLS security policy that supports TLS version 1.2 to TLS version 1.3 with perfect forward secrecy cipher suites
  1349. */
  1350. TLSSecurityPolicy?: TLSSecurityPolicy;
  1351. /**
  1352. * Specify if custom endpoint should be enabled for the Elasticsearch domain.
  1353. */
  1354. CustomEndpointEnabled?: Boolean;
  1355. /**
  1356. * Specify the fully qualified domain for your custom endpoint.
  1357. */
  1358. CustomEndpoint?: DomainNameFqdn;
  1359. /**
  1360. * Specify ACM certificate ARN for your custom endpoint.
  1361. */
  1362. CustomEndpointCertificateArn?: ARN;
  1363. }
  1364. export interface DomainEndpointOptionsStatus {
  1365. /**
  1366. * Options to configure endpoint for the Elasticsearch domain.
  1367. */
  1368. Options: DomainEndpointOptions;
  1369. /**
  1370. * The status of the endpoint options for the Elasticsearch domain. See OptionStatus for the status information that's included.
  1371. */
  1372. Status: OptionStatus;
  1373. }
  1374. export type DomainId = string;
  1375. export interface DomainInfo {
  1376. /**
  1377. * Specifies the DomainName.
  1378. */
  1379. DomainName?: DomainName;
  1380. /**
  1381. * Specifies the EngineType of the domain.
  1382. */
  1383. EngineType?: EngineType;
  1384. }
  1385. export type DomainInfoList = DomainInfo[];
  1386. export interface DomainInformation {
  1387. OwnerId?: OwnerId;
  1388. DomainName: DomainName;
  1389. Region?: Region;
  1390. }
  1391. export type DomainName = string;
  1392. export type DomainNameFqdn = string;
  1393. export type DomainNameList = DomainName[];
  1394. export interface DomainPackageDetails {
  1395. /**
  1396. * Internal ID of the package.
  1397. */
  1398. PackageID?: PackageID;
  1399. /**
  1400. * User specified name of the package.
  1401. */
  1402. PackageName?: PackageName;
  1403. /**
  1404. * Currently supports only TXT-DICTIONARY.
  1405. */
  1406. PackageType?: PackageType;
  1407. /**
  1408. * Timestamp of the most-recent update to the association status.
  1409. */
  1410. LastUpdated?: LastUpdated;
  1411. /**
  1412. * Name of the domain you've associated a package with.
  1413. */
  1414. DomainName?: DomainName;
  1415. /**
  1416. * State of the association. Values are ASSOCIATING/ASSOCIATION_FAILED/ACTIVE/DISSOCIATING/DISSOCIATION_FAILED.
  1417. */
  1418. DomainPackageStatus?: DomainPackageStatus;
  1419. PackageVersion?: PackageVersion;
  1420. /**
  1421. * The relative path on Amazon ES nodes, which can be used as synonym_path when the package is synonym file.
  1422. */
  1423. ReferencePath?: ReferencePath;
  1424. /**
  1425. * Additional information if the package is in an error state. Null otherwise.
  1426. */
  1427. ErrorDetails?: ErrorDetails;
  1428. }
  1429. export type DomainPackageDetailsList = DomainPackageDetails[];
  1430. export type DomainPackageStatus = "ASSOCIATING"|"ASSOCIATION_FAILED"|"ACTIVE"|"DISSOCIATING"|"DISSOCIATION_FAILED"|string;
  1431. export type DomainProcessingStatusType = "Creating"|"Active"|"Modifying"|"UpgradingEngineVersion"|"UpdatingServiceSoftware"|"Isolated"|"Deleting"|string;
  1432. export type Double = number;
  1433. export type DryRun = boolean;
  1434. export interface DryRunResults {
  1435. /**
  1436. * Specifies the deployment mechanism through which the update shall be applied on the domain. Possible responses are Blue/Green (The update will require a blue/green deployment.) DynamicUpdate (The update can be applied in-place without a Blue/Green deployment required.) Undetermined (The domain is undergoing an update which needs to complete before the deployment type can be predicted.) None (The configuration change matches the current configuration and will not result in any update.)
  1437. */
  1438. DeploymentType?: DeploymentType;
  1439. /**
  1440. * Contains an optional message associated with the DryRunResults.
  1441. */
  1442. Message?: Message;
  1443. }
  1444. export interface Duration {
  1445. /**
  1446. * Integer to specify the value of a maintenance schedule duration. See the Developer Guide for more information.
  1447. */
  1448. Value?: DurationValue;
  1449. /**
  1450. * Specifies the unit of a maintenance schedule duration. Valid value is HOURS. See the Developer Guide for more information.
  1451. */
  1452. Unit?: TimeUnit;
  1453. }
  1454. export type DurationValue = number;
  1455. export interface EBSOptions {
  1456. /**
  1457. * Specifies whether EBS-based storage is enabled.
  1458. */
  1459. EBSEnabled?: Boolean;
  1460. /**
  1461. * Specifies the volume type for EBS-based storage.
  1462. */
  1463. VolumeType?: VolumeType;
  1464. /**
  1465. * Integer to specify the size of an EBS volume.
  1466. */
  1467. VolumeSize?: IntegerClass;
  1468. /**
  1469. * Specifies the IOPS for Provisioned IOPS And GP3 EBS volume (SSD).
  1470. */
  1471. Iops?: IntegerClass;
  1472. /**
  1473. * Specifies the Throughput for GP3 EBS volume (SSD).
  1474. */
  1475. Throughput?: IntegerClass;
  1476. }
  1477. export interface EBSOptionsStatus {
  1478. /**
  1479. * Specifies the EBS options for the specified Elasticsearch domain.
  1480. */
  1481. Options: EBSOptions;
  1482. /**
  1483. * Specifies the status of the EBS options for the specified Elasticsearch domain.
  1484. */
  1485. Status: OptionStatus;
  1486. }
  1487. export type ESPartitionInstanceType = "m3.medium.elasticsearch"|"m3.large.elasticsearch"|"m3.xlarge.elasticsearch"|"m3.2xlarge.elasticsearch"|"m4.large.elasticsearch"|"m4.xlarge.elasticsearch"|"m4.2xlarge.elasticsearch"|"m4.4xlarge.elasticsearch"|"m4.10xlarge.elasticsearch"|"m5.large.elasticsearch"|"m5.xlarge.elasticsearch"|"m5.2xlarge.elasticsearch"|"m5.4xlarge.elasticsearch"|"m5.12xlarge.elasticsearch"|"r5.large.elasticsearch"|"r5.xlarge.elasticsearch"|"r5.2xlarge.elasticsearch"|"r5.4xlarge.elasticsearch"|"r5.12xlarge.elasticsearch"|"c5.large.elasticsearch"|"c5.xlarge.elasticsearch"|"c5.2xlarge.elasticsearch"|"c5.4xlarge.elasticsearch"|"c5.9xlarge.elasticsearch"|"c5.18xlarge.elasticsearch"|"ultrawarm1.medium.elasticsearch"|"ultrawarm1.large.elasticsearch"|"t2.micro.elasticsearch"|"t2.small.elasticsearch"|"t2.medium.elasticsearch"|"r3.large.elasticsearch"|"r3.xlarge.elasticsearch"|"r3.2xlarge.elasticsearch"|"r3.4xlarge.elasticsearch"|"r3.8xlarge.elasticsearch"|"i2.xlarge.elasticsearch"|"i2.2xlarge.elasticsearch"|"d2.xlarge.elasticsearch"|"d2.2xlarge.elasticsearch"|"d2.4xlarge.elasticsearch"|"d2.8xlarge.elasticsearch"|"c4.large.elasticsearch"|"c4.xlarge.elasticsearch"|"c4.2xlarge.elasticsearch"|"c4.4xlarge.elasticsearch"|"c4.8xlarge.elasticsearch"|"r4.large.elasticsearch"|"r4.xlarge.elasticsearch"|"r4.2xlarge.elasticsearch"|"r4.4xlarge.elasticsearch"|"r4.8xlarge.elasticsearch"|"r4.16xlarge.elasticsearch"|"i3.large.elasticsearch"|"i3.xlarge.elasticsearch"|"i3.2xlarge.elasticsearch"|"i3.4xlarge.elasticsearch"|"i3.8xlarge.elasticsearch"|"i3.16xlarge.elasticsearch"|string;
  1488. export type ESWarmPartitionInstanceType = "ultrawarm1.medium.elasticsearch"|"ultrawarm1.large.elasticsearch"|string;
  1489. export interface ElasticsearchClusterConfig {
  1490. /**
  1491. * The instance type for an Elasticsearch cluster. UltraWarm instance types are not supported for data instances.
  1492. */
  1493. InstanceType?: ESPartitionInstanceType;
  1494. /**
  1495. * The number of instances in the specified domain cluster.
  1496. */
  1497. InstanceCount?: IntegerClass;
  1498. /**
  1499. * A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.
  1500. */
  1501. DedicatedMasterEnabled?: Boolean;
  1502. /**
  1503. * A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.
  1504. */
  1505. ZoneAwarenessEnabled?: Boolean;
  1506. /**
  1507. * Specifies the zone awareness configuration for a domain when zone awareness is enabled.
  1508. */
  1509. ZoneAwarenessConfig?: ZoneAwarenessConfig;
  1510. /**
  1511. * The instance type for a dedicated master node.
  1512. */
  1513. DedicatedMasterType?: ESPartitionInstanceType;
  1514. /**
  1515. * Total number of dedicated master nodes, active and on standby, for the cluster.
  1516. */
  1517. DedicatedMasterCount?: IntegerClass;
  1518. /**
  1519. * True to enable warm storage.
  1520. */
  1521. WarmEnabled?: Boolean;
  1522. /**
  1523. * The instance type for the Elasticsearch cluster's warm nodes.
  1524. */
  1525. WarmType?: ESWarmPartitionInstanceType;
  1526. /**
  1527. * The number of warm nodes in the cluster.
  1528. */
  1529. WarmCount?: IntegerClass;
  1530. /**
  1531. * Specifies the ColdStorageOptions config for Elasticsearch Domain
  1532. */
  1533. ColdStorageOptions?: ColdStorageOptions;
  1534. }
  1535. export interface ElasticsearchClusterConfigStatus {
  1536. /**
  1537. * Specifies the cluster configuration for the specified Elasticsearch domain.
  1538. */
  1539. Options: ElasticsearchClusterConfig;
  1540. /**
  1541. * Specifies the status of the configuration for the specified Elasticsearch domain.
  1542. */
  1543. Status: OptionStatus;
  1544. }
  1545. export interface ElasticsearchDomainConfig {
  1546. /**
  1547. * String of format X.Y to specify version for the Elasticsearch domain.
  1548. */
  1549. ElasticsearchVersion?: ElasticsearchVersionStatus;
  1550. /**
  1551. * Specifies the ElasticsearchClusterConfig for the Elasticsearch domain.
  1552. */
  1553. ElasticsearchClusterConfig?: ElasticsearchClusterConfigStatus;
  1554. /**
  1555. * Specifies the EBSOptions for the Elasticsearch domain.
  1556. */
  1557. EBSOptions?: EBSOptionsStatus;
  1558. /**
  1559. * IAM access policy as a JSON-formatted string.
  1560. */
  1561. AccessPolicies?: AccessPoliciesStatus;
  1562. /**
  1563. * Specifies the SnapshotOptions for the Elasticsearch domain.
  1564. */
  1565. SnapshotOptions?: SnapshotOptionsStatus;
  1566. /**
  1567. * The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
  1568. */
  1569. VPCOptions?: VPCDerivedInfoStatus;
  1570. /**
  1571. * The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.
  1572. */
  1573. CognitoOptions?: CognitoOptionsStatus;
  1574. /**
  1575. * Specifies the EncryptionAtRestOptions for the Elasticsearch domain.
  1576. */
  1577. EncryptionAtRestOptions?: EncryptionAtRestOptionsStatus;
  1578. /**
  1579. * Specifies the NodeToNodeEncryptionOptions for the Elasticsearch domain.
  1580. */
  1581. NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptionsStatus;
  1582. /**
  1583. * Specifies the AdvancedOptions for the domain. See Configuring Advanced Options for more information.
  1584. */
  1585. AdvancedOptions?: AdvancedOptionsStatus;
  1586. /**
  1587. * Log publishing options for the given domain.
  1588. */
  1589. LogPublishingOptions?: LogPublishingOptionsStatus;
  1590. /**
  1591. * Specifies the DomainEndpointOptions for the Elasticsearch domain.
  1592. */
  1593. DomainEndpointOptions?: DomainEndpointOptionsStatus;
  1594. /**
  1595. * Specifies AdvancedSecurityOptions for the domain.
  1596. */
  1597. AdvancedSecurityOptions?: AdvancedSecurityOptionsStatus;
  1598. /**
  1599. * Specifies AutoTuneOptions for the domain.
  1600. */
  1601. AutoTuneOptions?: AutoTuneOptionsStatus;
  1602. /**
  1603. * Specifies change details of the domain configuration change.
  1604. */
  1605. ChangeProgressDetails?: ChangeProgressDetails;
  1606. /**
  1607. * Information about the domain properties that are currently being modified.
  1608. */
  1609. ModifyingProperties?: ModifyingPropertiesList;
  1610. }
  1611. export interface ElasticsearchDomainStatus {
  1612. /**
  1613. * The unique identifier for the specified Elasticsearch domain.
  1614. */
  1615. DomainId: DomainId;
  1616. /**
  1617. * The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).
  1618. */
  1619. DomainName: DomainName;
  1620. /**
  1621. * The Amazon resource name (ARN) of an Elasticsearch domain. See Identifiers for IAM Entities in Using AWS Identity and Access Management for more information.
  1622. */
  1623. ARN: ARN;
  1624. /**
  1625. * The domain creation status. True if the creation of an Elasticsearch domain is complete. False if domain creation is still in progress.
  1626. */
  1627. Created?: Boolean;
  1628. /**
  1629. * The domain deletion status. True if a delete request has been received for the domain but resource cleanup is still in progress. False if the domain has not been deleted. Once domain deletion is complete, the status of the domain is no longer returned.
  1630. */
  1631. Deleted?: Boolean;
  1632. /**
  1633. * The Elasticsearch domain endpoint that you use to submit index and search requests.
  1634. */
  1635. Endpoint?: ServiceUrl;
  1636. /**
  1637. * Map containing the Elasticsearch domain endpoints used to submit index and search requests. Example key, value: 'vpc','vpc-endpoint-h2dsd34efgyghrtguk5gt6j2foh4.us-east-1.es.amazonaws.com'.
  1638. */
  1639. Endpoints?: EndpointsMap;
  1640. /**
  1641. * The status of the Elasticsearch domain configuration. True if Amazon Elasticsearch Service is processing configuration changes. False if the configuration is active.
  1642. */
  1643. Processing?: Boolean;
  1644. /**
  1645. * The status of an Elasticsearch domain version upgrade. True if Amazon Elasticsearch Service is undergoing a version upgrade. False if the configuration is active.
  1646. */
  1647. UpgradeProcessing?: Boolean;
  1648. ElasticsearchVersion?: ElasticsearchVersionString;
  1649. /**
  1650. * The type and number of instances in the domain cluster.
  1651. */
  1652. ElasticsearchClusterConfig: ElasticsearchClusterConfig;
  1653. /**
  1654. * The EBSOptions for the specified domain. See Configuring EBS-based Storage for more information.
  1655. */
  1656. EBSOptions?: EBSOptions;
  1657. /**
  1658. * IAM access policy as a JSON-formatted string.
  1659. */
  1660. AccessPolicies?: PolicyDocument;
  1661. /**
  1662. * Specifies the status of the SnapshotOptions
  1663. */
  1664. SnapshotOptions?: SnapshotOptions;
  1665. /**
  1666. * The VPCOptions for the specified domain. For more information, see VPC Endpoints for Amazon Elasticsearch Service Domains.
  1667. */
  1668. VPCOptions?: VPCDerivedInfo;
  1669. /**
  1670. * The CognitoOptions for the specified domain. For more information, see Amazon Cognito Authentication for Kibana.
  1671. */
  1672. CognitoOptions?: CognitoOptions;
  1673. /**
  1674. * Specifies the status of the EncryptionAtRestOptions.
  1675. */
  1676. EncryptionAtRestOptions?: EncryptionAtRestOptions;
  1677. /**
  1678. * Specifies the status of the NodeToNodeEncryptionOptions.
  1679. */
  1680. NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
  1681. /**
  1682. * Specifies the status of the AdvancedOptions
  1683. */
  1684. AdvancedOptions?: AdvancedOptions;
  1685. /**
  1686. * Log publishing options for the given domain.
  1687. */
  1688. LogPublishingOptions?: LogPublishingOptions;
  1689. /**
  1690. * The current status of the Elasticsearch domain's service software.
  1691. */
  1692. ServiceSoftwareOptions?: ServiceSoftwareOptions;
  1693. /**
  1694. * The current status of the Elasticsearch domain's endpoint options.
  1695. */
  1696. DomainEndpointOptions?: DomainEndpointOptions;
  1697. /**
  1698. * The current status of the Elasticsearch domain's advanced security options.
  1699. */
  1700. AdvancedSecurityOptions?: AdvancedSecurityOptions;
  1701. /**
  1702. * The current status of the Elasticsearch domain's Auto-Tune options.
  1703. */
  1704. AutoTuneOptions?: AutoTuneOptionsOutput;
  1705. /**
  1706. * Specifies change details of the domain configuration change.
  1707. */
  1708. ChangeProgressDetails?: ChangeProgressDetails;
  1709. /**
  1710. * The status of any changes that are currently in progress for the domain.
  1711. */
  1712. DomainProcessingStatus?: DomainProcessingStatusType;
  1713. /**
  1714. * Information about the domain properties that are currently being modified.
  1715. */
  1716. ModifyingProperties?: ModifyingPropertiesList;
  1717. }
  1718. export type ElasticsearchDomainStatusList = ElasticsearchDomainStatus[];
  1719. export type ElasticsearchInstanceTypeList = ESPartitionInstanceType[];
  1720. export type ElasticsearchVersionList = ElasticsearchVersionString[];
  1721. export interface ElasticsearchVersionStatus {
  1722. /**
  1723. * Specifies the Elasticsearch version for the specified Elasticsearch domain.
  1724. */
  1725. Options: ElasticsearchVersionString;
  1726. /**
  1727. * Specifies the status of the Elasticsearch version options for the specified Elasticsearch domain.
  1728. */
  1729. Status: OptionStatus;
  1730. }
  1731. export type ElasticsearchVersionString = string;
  1732. export interface EncryptionAtRestOptions {
  1733. /**
  1734. * Specifies the option to enable Encryption At Rest.
  1735. */
  1736. Enabled?: Boolean;
  1737. /**
  1738. * Specifies the KMS Key ID for Encryption At Rest options.
  1739. */
  1740. KmsKeyId?: KmsKeyId;
  1741. }
  1742. export interface EncryptionAtRestOptionsStatus {
  1743. /**
  1744. * Specifies the Encryption At Rest options for the specified Elasticsearch domain.
  1745. */
  1746. Options: EncryptionAtRestOptions;
  1747. /**
  1748. * Specifies the status of the Encryption At Rest options for the specified Elasticsearch domain.
  1749. */
  1750. Status: OptionStatus;
  1751. }
  1752. export type Endpoint = string;
  1753. export type EndpointsMap = {[key: string]: ServiceUrl};
  1754. export type EngineType = "OpenSearch"|"Elasticsearch"|string;
  1755. export interface ErrorDetails {
  1756. ErrorType?: ErrorType;
  1757. ErrorMessage?: ErrorMessage;
  1758. }
  1759. export type ErrorMessage = string;
  1760. export type ErrorType = string;
  1761. export interface Filter {
  1762. /**
  1763. * Specifies the name of the filter.
  1764. */
  1765. Name?: NonEmptyString;
  1766. /**
  1767. * Contains one or more values for the filter.
  1768. */
  1769. Values?: ValueStringList;
  1770. }
  1771. export type FilterList = Filter[];
  1772. export type GUID = string;
  1773. export type GUIDList = GUID[];
  1774. export interface GetCompatibleElasticsearchVersionsRequest {
  1775. DomainName?: DomainName;
  1776. }
  1777. export interface GetCompatibleElasticsearchVersionsResponse {
  1778. /**
  1779. * A map of compatible Elasticsearch versions returned as part of the GetCompatibleElasticsearchVersions operation.
  1780. */
  1781. CompatibleElasticsearchVersions?: CompatibleElasticsearchVersionsList;
  1782. }
  1783. export interface GetPackageVersionHistoryRequest {
  1784. /**
  1785. * Returns an audit history of versions of the package.
  1786. */
  1787. PackageID: PackageID;
  1788. /**
  1789. * Limits results to a maximum number of versions.
  1790. */
  1791. MaxResults?: MaxResults;
  1792. /**
  1793. * Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
  1794. */
  1795. NextToken?: NextToken;
  1796. }
  1797. export interface GetPackageVersionHistoryResponse {
  1798. PackageID?: PackageID;
  1799. /**
  1800. * List of PackageVersionHistory objects.
  1801. */
  1802. PackageVersionHistoryList?: PackageVersionHistoryList;
  1803. NextToken?: String;
  1804. }
  1805. export interface GetUpgradeHistoryRequest {
  1806. DomainName: DomainName;
  1807. MaxResults?: MaxResults;
  1808. NextToken?: NextToken;
  1809. }
  1810. export interface GetUpgradeHistoryResponse {
  1811. /**
  1812. * A list of UpgradeHistory objects corresponding to each Upgrade or Upgrade Eligibility Check performed on a domain returned as part of GetUpgradeHistoryResponse object.
  1813. */
  1814. UpgradeHistories?: UpgradeHistoryList;
  1815. /**
  1816. * Pagination token that needs to be supplied to the next call to get the next page of results
  1817. */
  1818. NextToken?: String;
  1819. }
  1820. export interface GetUpgradeStatusRequest {
  1821. DomainName: DomainName;
  1822. }
  1823. export interface GetUpgradeStatusResponse {
  1824. /**
  1825. * Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: PreUpgradeCheck Snapshot Upgrade
  1826. */
  1827. UpgradeStep?: UpgradeStep;
  1828. /**
  1829. * One of 4 statuses that a step can go through returned as part of the GetUpgradeStatusResponse object. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed
  1830. */
  1831. StepStatus?: UpgradeStatus;
  1832. /**
  1833. * A string that describes the update briefly
  1834. */
  1835. UpgradeName?: UpgradeName;
  1836. }
  1837. export type IdentityPoolId = string;
  1838. export interface InboundCrossClusterSearchConnection {
  1839. /**
  1840. * Specifies the DomainInformation for the source Elasticsearch domain.
  1841. */
  1842. SourceDomainInfo?: DomainInformation;
  1843. /**
  1844. * Specifies the DomainInformation for the destination Elasticsearch domain.
  1845. */
  1846. DestinationDomainInfo?: DomainInformation;
  1847. /**
  1848. * Specifies the connection id for the inbound cross-cluster search connection.
  1849. */
  1850. CrossClusterSearchConnectionId?: CrossClusterSearchConnectionId;
  1851. /**
  1852. * Specifies the InboundCrossClusterSearchConnectionStatus for the outbound connection.
  1853. */
  1854. ConnectionStatus?: InboundCrossClusterSearchConnectionStatus;
  1855. }
  1856. export interface InboundCrossClusterSearchConnectionStatus {
  1857. /**
  1858. * The state code for inbound connection. This can be one of the following: PENDING_ACCEPTANCE: Inbound connection is not yet accepted by destination domain owner. APPROVED: Inbound connection is pending acceptance by destination domain owner. REJECTING: Inbound connection rejection is in process. REJECTED: Inbound connection is rejected. DELETING: Inbound connection deletion is in progress. DELETED: Inbound connection is deleted and cannot be used further.
  1859. */
  1860. StatusCode?: InboundCrossClusterSearchConnectionStatusCode;
  1861. /**
  1862. * Specifies verbose information for the inbound connection status.
  1863. */
  1864. Message?: CrossClusterSearchConnectionStatusMessage;
  1865. }
  1866. export type InboundCrossClusterSearchConnectionStatusCode = "PENDING_ACCEPTANCE"|"APPROVED"|"REJECTING"|"REJECTED"|"DELETING"|"DELETED"|string;
  1867. export type InboundCrossClusterSearchConnections = InboundCrossClusterSearchConnection[];
  1868. export type InitiatedBy = "CUSTOMER"|"SERVICE"|string;
  1869. export type InstanceCount = number;
  1870. export interface InstanceCountLimits {
  1871. MinimumInstanceCount?: MinimumInstanceCount;
  1872. MaximumInstanceCount?: MaximumInstanceCount;
  1873. }
  1874. export interface InstanceLimits {
  1875. InstanceCountLimits?: InstanceCountLimits;
  1876. }
  1877. export type InstanceRole = string;
  1878. export type Integer = number;
  1879. export type IntegerClass = number;
  1880. export type Issue = string;
  1881. export type Issues = Issue[];
  1882. export type KmsKeyId = string;
  1883. export type LastUpdated = Date;
  1884. export type LimitName = string;
  1885. export type LimitValue = string;
  1886. export type LimitValueList = LimitValue[];
  1887. export interface Limits {
  1888. /**
  1889. * StorageType represents the list of storage related types and attributes that are available for given InstanceType.
  1890. */
  1891. StorageTypes?: StorageTypeList;
  1892. InstanceLimits?: InstanceLimits;
  1893. /**
  1894. * List of additional limits that are specific to a given InstanceType and for each of it's InstanceRole .
  1895. */
  1896. AdditionalLimits?: AdditionalLimitList;
  1897. }
  1898. export type LimitsByRole = {[key: string]: Limits};
  1899. export interface ListDomainNamesRequest {
  1900. /**
  1901. * Optional parameter to filter the output by domain engine type. Acceptable values are 'Elasticsearch' and 'OpenSearch'.
  1902. */
  1903. EngineType?: EngineType;
  1904. }
  1905. export interface ListDomainNamesResponse {
  1906. /**
  1907. * List of domain names and respective engine types.
  1908. */
  1909. DomainNames?: DomainInfoList;
  1910. }
  1911. export interface ListDomainsForPackageRequest {
  1912. /**
  1913. * The package for which to list domains.
  1914. */
  1915. PackageID: PackageID;
  1916. /**
  1917. * Limits results to a maximum number of domains.
  1918. */
  1919. MaxResults?: MaxResults;
  1920. /**
  1921. * Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
  1922. */
  1923. NextToken?: NextToken;
  1924. }
  1925. export interface ListDomainsForPackageResponse {
  1926. /**
  1927. * List of DomainPackageDetails objects.
  1928. */
  1929. DomainPackageDetailsList?: DomainPackageDetailsList;
  1930. NextToken?: String;
  1931. }
  1932. export interface ListElasticsearchInstanceTypesRequest {
  1933. /**
  1934. * Version of Elasticsearch for which list of supported elasticsearch instance types are needed.
  1935. */
  1936. ElasticsearchVersion: ElasticsearchVersionString;
  1937. /**
  1938. * DomainName represents the name of the Domain that we are trying to modify. This should be present only if we are querying for list of available Elasticsearch instance types when modifying existing domain.
  1939. */
  1940. DomainName?: DomainName;
  1941. /**
  1942. * Set this value to limit the number of results returned. Value provided must be greater than 30 else it wont be honored.
  1943. */
  1944. MaxResults?: MaxResults;
  1945. /**
  1946. * NextToken should be sent in case if earlier API call produced result containing NextToken. It is used for pagination.
  1947. */
  1948. NextToken?: NextToken;
  1949. }
  1950. export interface ListElasticsearchInstanceTypesResponse {
  1951. /**
  1952. * List of instance types supported by Amazon Elasticsearch service for given ElasticsearchVersion
  1953. */
  1954. ElasticsearchInstanceTypes?: ElasticsearchInstanceTypeList;
  1955. /**
  1956. * In case if there are more results available NextToken would be present, make further request to the same API with received NextToken to paginate remaining results.
  1957. */
  1958. NextToken?: NextToken;
  1959. }
  1960. export interface ListElasticsearchVersionsRequest {
  1961. /**
  1962. * Set this value to limit the number of results returned. Value provided must be greater than 10 else it wont be honored.
  1963. */
  1964. MaxResults?: MaxResults;
  1965. NextToken?: NextToken;
  1966. }
  1967. export interface ListElasticsearchVersionsResponse {
  1968. ElasticsearchVersions?: ElasticsearchVersionList;
  1969. NextToken?: NextToken;
  1970. }
  1971. export interface ListPackagesForDomainRequest {
  1972. /**
  1973. * The name of the domain for which you want to list associated packages.
  1974. */
  1975. DomainName: DomainName;
  1976. /**
  1977. * Limits results to a maximum number of packages.
  1978. */
  1979. MaxResults?: MaxResults;
  1980. /**
  1981. * Used for pagination. Only necessary if a previous API call includes a non-null NextToken value. If provided, returns results for the next page.
  1982. */
  1983. NextToken?: NextToken;
  1984. }
  1985. export interface ListPackagesForDomainResponse {
  1986. /**
  1987. * List of DomainPackageDetails objects.
  1988. */
  1989. DomainPackageDetailsList?: DomainPackageDetailsList;
  1990. /**
  1991. * Pagination token that needs to be supplied to the next call to get the next page of results.
  1992. */
  1993. NextToken?: String;
  1994. }
  1995. export interface ListTagsRequest {
  1996. /**
  1997. * Specify the ARN for the Elasticsearch domain to which the tags are attached that you want to view.
  1998. */
  1999. ARN: ARN;
  2000. }
  2001. export interface ListTagsResponse {
  2002. /**
  2003. * List of Tag for the requested Elasticsearch domain.
  2004. */
  2005. TagList?: TagList;
  2006. }
  2007. export interface ListVpcEndpointAccessRequest {
  2008. /**
  2009. * The name of the OpenSearch Service domain to retrieve access information for.
  2010. */
  2011. DomainName: DomainName;
  2012. /**
  2013. * Provides an identifier to allow retrieval of paginated results.
  2014. */
  2015. NextToken?: NextToken;
  2016. }
  2017. export interface ListVpcEndpointAccessResponse {
  2018. /**
  2019. * List of AuthorizedPrincipal describing the details of the permissions to manage VPC endpoints against the specified domain.
  2020. */
  2021. AuthorizedPrincipalList: AuthorizedPrincipalList;
  2022. /**
  2023. * Provides an identifier to allow retrieval of paginated results.
  2024. */
  2025. NextToken: NextToken;
  2026. }
  2027. export interface ListVpcEndpointsForDomainRequest {
  2028. /**
  2029. * Name of the ElasticSearch domain whose VPC endpoints are to be listed.
  2030. */
  2031. DomainName: DomainName;
  2032. /**
  2033. * Provides an identifier to allow retrieval of paginated results.
  2034. */
  2035. NextToken?: NextToken;
  2036. }
  2037. export interface ListVpcEndpointsForDomainResponse {
  2038. /**
  2039. * Provides list of VpcEndpointSummary summarizing details of the VPC endpoints.
  2040. */
  2041. VpcEndpointSummaryList: VpcEndpointSummaryList;
  2042. /**
  2043. * Information about each endpoint associated with the domain.
  2044. */
  2045. NextToken: NextToken;
  2046. }
  2047. export interface ListVpcEndpointsRequest {
  2048. /**
  2049. * Identifier to allow retrieval of paginated results.
  2050. */
  2051. NextToken?: NextToken;
  2052. }
  2053. export interface ListVpcEndpointsResponse {
  2054. /**
  2055. * Information about each endpoint.
  2056. */
  2057. VpcEndpointSummaryList: VpcEndpointSummaryList;
  2058. /**
  2059. * Provides an identifier to allow retrieval of paginated results.
  2060. */
  2061. NextToken: NextToken;
  2062. }
  2063. export interface LogPublishingOption {
  2064. CloudWatchLogsLogGroupArn?: CloudWatchLogsLogGroupArn;
  2065. /**
  2066. * Specifies whether given log publishing option is enabled or not.
  2067. */
  2068. Enabled?: Boolean;
  2069. }
  2070. export type LogPublishingOptions = {[key: string]: LogPublishingOption};
  2071. export interface LogPublishingOptionsStatus {
  2072. /**
  2073. * The log publishing options configured for the Elasticsearch domain.
  2074. */
  2075. Options?: LogPublishingOptions;
  2076. /**
  2077. * The status of the log publishing options for the Elasticsearch domain. See OptionStatus for the status information that's included.
  2078. */
  2079. Status?: OptionStatus;
  2080. }
  2081. export type LogType = "INDEX_SLOW_LOGS"|"SEARCH_SLOW_LOGS"|"ES_APPLICATION_LOGS"|"AUDIT_LOGS"|string;
  2082. export interface MasterUserOptions {
  2083. /**
  2084. * ARN for the master user (if IAM is enabled).
  2085. */
  2086. MasterUserARN?: ARN;
  2087. /**
  2088. * The master user's username, which is stored in the Amazon Elasticsearch Service domain's internal database.
  2089. */
  2090. MasterUserName?: Username;
  2091. /**
  2092. * The master user's password, which is stored in the Amazon Elasticsearch Service domain's internal database.
  2093. */
  2094. MasterUserPassword?: Password;
  2095. }
  2096. export type MaxResults = number;
  2097. export type MaximumInstanceCount = number;
  2098. export type Message = string;
  2099. export type MinimumInstanceCount = number;
  2100. export interface ModifyingProperties {
  2101. /**
  2102. * The name of the property that is currently being modified.
  2103. */
  2104. Name?: String;
  2105. /**
  2106. * The current value of the domain property that is being modified.
  2107. */
  2108. ActiveValue?: String;
  2109. /**
  2110. * The value that the property that is currently being modified will eventually have.
  2111. */
  2112. PendingValue?: String;
  2113. /**
  2114. * The type of value that is currently being modified. Properties can have two types: PLAIN_TEXT: Contain direct values such as "1", "True", or "c5.large.search". STRINGIFIED_JSON: Contain content in JSON format, such as {"Enabled":"True"}".
  2115. */
  2116. ValueType?: PropertyValueType;
  2117. }
  2118. export type ModifyingPropertiesList = ModifyingProperties[];
  2119. export type NextToken = string;
  2120. export interface NodeToNodeEncryptionOptions {
  2121. /**
  2122. * Specify true to enable node-to-node encryption.
  2123. */
  2124. Enabled?: Boolean;
  2125. }
  2126. export interface NodeToNodeEncryptionOptionsStatus {
  2127. /**
  2128. * Specifies the node-to-node encryption options for the specified Elasticsearch domain.
  2129. */
  2130. Options: NodeToNodeEncryptionOptions;
  2131. /**
  2132. * Specifies the status of the node-to-node encryption options for the specified Elasticsearch domain.
  2133. */
  2134. Status: OptionStatus;
  2135. }
  2136. export type NonEmptyString = string;
  2137. export type OptionState = "RequiresIndexDocuments"|"Processing"|"Active"|string;
  2138. export interface OptionStatus {
  2139. /**
  2140. * Timestamp which tells the creation date for the entity.
  2141. */
  2142. CreationDate: UpdateTimestamp;
  2143. /**
  2144. * Timestamp which tells the last updated time for the entity.
  2145. */
  2146. UpdateDate: UpdateTimestamp;
  2147. /**
  2148. * Specifies the latest version for the entity.
  2149. */
  2150. UpdateVersion?: UIntValue;
  2151. /**
  2152. * Provides the OptionState for the Elasticsearch domain.
  2153. */
  2154. State: OptionState;
  2155. /**
  2156. * Indicates whether the Elasticsearch domain is being deleted.
  2157. */
  2158. PendingDeletion?: Boolean;
  2159. }
  2160. export interface OutboundCrossClusterSearchConnection {
  2161. /**
  2162. * Specifies the DomainInformation for the source Elasticsearch domain.
  2163. */
  2164. SourceDomainInfo?: DomainInformation;
  2165. /**
  2166. * Specifies the DomainInformation for the destination Elasticsearch domain.
  2167. */
  2168. DestinationDomainInfo?: DomainInformation;
  2169. /**
  2170. * Specifies the connection id for the outbound cross-cluster search connection.
  2171. */
  2172. CrossClusterSearchConnectionId?: CrossClusterSearchConnectionId;
  2173. /**
  2174. * Specifies the connection alias for the outbound cross-cluster search connection.
  2175. */
  2176. ConnectionAlias?: ConnectionAlias;
  2177. /**
  2178. * Specifies the OutboundCrossClusterSearchConnectionStatus for the outbound connection.
  2179. */
  2180. ConnectionStatus?: OutboundCrossClusterSearchConnectionStatus;
  2181. }
  2182. export interface OutboundCrossClusterSearchConnectionStatus {
  2183. /**
  2184. * The state code for outbound connection. This can be one of the following: VALIDATING: The outbound connection request is being validated. VALIDATION_FAILED: Validation failed for the connection request. PENDING_ACCEPTANCE: Outbound connection request is validated and is not yet accepted by destination domain owner. PROVISIONING: Outbound connection request is in process. ACTIVE: Outbound connection is active and ready to use. REJECTED: Outbound connection request is rejected by destination domain owner. DELETING: Outbound connection deletion is in progress. DELETED: Outbound connection is deleted and cannot be used further.
  2185. */
  2186. StatusCode?: OutboundCrossClusterSearchConnectionStatusCode;
  2187. /**
  2188. * Specifies verbose information for the outbound connection status.
  2189. */
  2190. Message?: CrossClusterSearchConnectionStatusMessage;
  2191. }
  2192. export type OutboundCrossClusterSearchConnectionStatusCode = "PENDING_ACCEPTANCE"|"VALIDATING"|"VALIDATION_FAILED"|"PROVISIONING"|"ACTIVE"|"REJECTED"|"DELETING"|"DELETED"|string;
  2193. export type OutboundCrossClusterSearchConnections = OutboundCrossClusterSearchConnection[];
  2194. export type OverallChangeStatus = "PENDING"|"PROCESSING"|"COMPLETED"|"FAILED"|string;
  2195. export type OwnerId = string;
  2196. export type PackageDescription = string;
  2197. export interface PackageDetails {
  2198. /**
  2199. * Internal ID of the package.
  2200. */
  2201. PackageID?: PackageID;
  2202. /**
  2203. * User specified name of the package.
  2204. */
  2205. PackageName?: PackageName;
  2206. /**
  2207. * Currently supports only TXT-DICTIONARY.
  2208. */
  2209. PackageType?: PackageType;
  2210. /**
  2211. * User-specified description of the package.
  2212. */
  2213. PackageDescription?: PackageDescription;
  2214. /**
  2215. * Current state of the package. Values are COPYING/COPY_FAILED/AVAILABLE/DELETING/DELETE_FAILED
  2216. */
  2217. PackageStatus?: PackageStatus;
  2218. /**
  2219. * Timestamp which tells creation date of the package.
  2220. */
  2221. CreatedAt?: CreatedAt;
  2222. LastUpdatedAt?: LastUpdated;
  2223. AvailablePackageVersion?: PackageVersion;
  2224. /**
  2225. * Additional information if the package is in an error state. Null otherwise.
  2226. */
  2227. ErrorDetails?: ErrorDetails;
  2228. }
  2229. export type PackageDetailsList = PackageDetails[];
  2230. export type PackageID = string;
  2231. export type PackageName = string;
  2232. export interface PackageSource {
  2233. /**
  2234. * Name of the bucket containing the package.
  2235. */
  2236. S3BucketName?: S3BucketName;
  2237. /**
  2238. * Key (file name) of the package.
  2239. */
  2240. S3Key?: S3Key;
  2241. }
  2242. export type PackageStatus = "COPYING"|"COPY_FAILED"|"VALIDATING"|"VALIDATION_FAILED"|"AVAILABLE"|"DELETING"|"DELETED"|"DELETE_FAILED"|string;
  2243. export type PackageType = "TXT-DICTIONARY"|string;
  2244. export type PackageVersion = string;
  2245. export interface PackageVersionHistory {
  2246. /**
  2247. * Version of the package.
  2248. */
  2249. PackageVersion?: PackageVersion;
  2250. /**
  2251. * A message associated with the version.
  2252. */
  2253. CommitMessage?: CommitMessage;
  2254. /**
  2255. * Timestamp which tells creation time of the package version.
  2256. */
  2257. CreatedAt?: CreatedAt;
  2258. }
  2259. export type PackageVersionHistoryList = PackageVersionHistory[];
  2260. export type Password = string;
  2261. export type PolicyDocument = string;
  2262. export type PrincipalType = "AWS_ACCOUNT"|"AWS_SERVICE"|string;
  2263. export type PropertyValueType = "PLAIN_TEXT"|"STRINGIFIED_JSON"|string;
  2264. export interface PurchaseReservedElasticsearchInstanceOfferingRequest {
  2265. /**
  2266. * The ID of the reserved Elasticsearch instance offering to purchase.
  2267. */
  2268. ReservedElasticsearchInstanceOfferingId: GUID;
  2269. /**
  2270. * A customer-specified identifier to track this reservation.
  2271. */
  2272. ReservationName: ReservationToken;
  2273. /**
  2274. * The number of Elasticsearch instances to reserve.
  2275. */
  2276. InstanceCount?: InstanceCount;
  2277. }
  2278. export interface PurchaseReservedElasticsearchInstanceOfferingResponse {
  2279. /**
  2280. * Details of the reserved Elasticsearch instance which was purchased.
  2281. */
  2282. ReservedElasticsearchInstanceId?: GUID;
  2283. /**
  2284. * The customer-specified identifier used to track this reservation.
  2285. */
  2286. ReservationName?: ReservationToken;
  2287. }
  2288. export interface RecurringCharge {
  2289. /**
  2290. * The monetary amount of the recurring charge.
  2291. */
  2292. RecurringChargeAmount?: Double;
  2293. /**
  2294. * The frequency of the recurring charge.
  2295. */
  2296. RecurringChargeFrequency?: String;
  2297. }
  2298. export type RecurringChargeList = RecurringCharge[];
  2299. export type ReferencePath = string;
  2300. export type Region = string;
  2301. export interface RejectInboundCrossClusterSearchConnectionRequest {
  2302. /**
  2303. * The id of the inbound connection that you want to reject.
  2304. */
  2305. CrossClusterSearchConnectionId: CrossClusterSearchConnectionId;
  2306. }
  2307. export interface RejectInboundCrossClusterSearchConnectionResponse {
  2308. /**
  2309. * Specifies the InboundCrossClusterSearchConnection of rejected inbound connection.
  2310. */
  2311. CrossClusterSearchConnection?: InboundCrossClusterSearchConnection;
  2312. }
  2313. export interface RemoveTagsRequest {
  2314. /**
  2315. * Specifies the ARN for the Elasticsearch domain from which you want to delete the specified tags.
  2316. */
  2317. ARN: ARN;
  2318. /**
  2319. * Specifies the TagKey list which you want to remove from the Elasticsearch domain.
  2320. */
  2321. TagKeys: StringList;
  2322. }
  2323. export type ReservationToken = string;
  2324. export interface ReservedElasticsearchInstance {
  2325. /**
  2326. * The customer-specified identifier to track this reservation.
  2327. */
  2328. ReservationName?: ReservationToken;
  2329. /**
  2330. * The unique identifier for the reservation.
  2331. */
  2332. ReservedElasticsearchInstanceId?: GUID;
  2333. /**
  2334. * The offering identifier.
  2335. */
  2336. ReservedElasticsearchInstanceOfferingId?: String;
  2337. /**
  2338. * The Elasticsearch instance type offered by the reserved instance offering.
  2339. */
  2340. ElasticsearchInstanceType?: ESPartitionInstanceType;
  2341. /**
  2342. * The time the reservation started.
  2343. */
  2344. StartTime?: UpdateTimestamp;
  2345. /**
  2346. * The duration, in seconds, for which the Elasticsearch instance is reserved.
  2347. */
  2348. Duration?: Integer;
  2349. /**
  2350. * The upfront fixed charge you will paid to purchase the specific reserved Elasticsearch instance offering.
  2351. */
  2352. FixedPrice?: Double;
  2353. /**
  2354. * The rate you are charged for each hour for the domain that is using this reserved instance.
  2355. */
  2356. UsagePrice?: Double;
  2357. /**
  2358. * The currency code for the reserved Elasticsearch instance offering.
  2359. */
  2360. CurrencyCode?: String;
  2361. /**
  2362. * The number of Elasticsearch instances that have been reserved.
  2363. */
  2364. ElasticsearchInstanceCount?: Integer;
  2365. /**
  2366. * The state of the reserved Elasticsearch instance.
  2367. */
  2368. State?: String;
  2369. /**
  2370. * The payment option as defined in the reserved Elasticsearch instance offering.
  2371. */
  2372. PaymentOption?: ReservedElasticsearchInstancePaymentOption;
  2373. /**
  2374. * The charge to your account regardless of whether you are creating any domains using the instance offering.
  2375. */
  2376. RecurringCharges?: RecurringChargeList;
  2377. }
  2378. export type ReservedElasticsearchInstanceList = ReservedElasticsearchInstance[];
  2379. export interface ReservedElasticsearchInstanceOffering {
  2380. /**
  2381. * The Elasticsearch reserved instance offering identifier.
  2382. */
  2383. ReservedElasticsearchInstanceOfferingId?: GUID;
  2384. /**
  2385. * The Elasticsearch instance type offered by the reserved instance offering.
  2386. */
  2387. ElasticsearchInstanceType?: ESPartitionInstanceType;
  2388. /**
  2389. * The duration, in seconds, for which the offering will reserve the Elasticsearch instance.
  2390. */
  2391. Duration?: Integer;
  2392. /**
  2393. * The upfront fixed charge you will pay to purchase the specific reserved Elasticsearch instance offering.
  2394. */
  2395. FixedPrice?: Double;
  2396. /**
  2397. * The rate you are charged for each hour the domain that is using the offering is running.
  2398. */
  2399. UsagePrice?: Double;
  2400. /**
  2401. * The currency code for the reserved Elasticsearch instance offering.
  2402. */
  2403. CurrencyCode?: String;
  2404. /**
  2405. * Payment option for the reserved Elasticsearch instance offering
  2406. */
  2407. PaymentOption?: ReservedElasticsearchInstancePaymentOption;
  2408. /**
  2409. * The charge to your account regardless of whether you are creating any domains using the instance offering.
  2410. */
  2411. RecurringCharges?: RecurringChargeList;
  2412. }
  2413. export type ReservedElasticsearchInstanceOfferingList = ReservedElasticsearchInstanceOffering[];
  2414. export type ReservedElasticsearchInstancePaymentOption = "ALL_UPFRONT"|"PARTIAL_UPFRONT"|"NO_UPFRONT"|string;
  2415. export interface RevokeVpcEndpointAccessRequest {
  2416. /**
  2417. * The name of the OpenSearch Service domain.
  2418. */
  2419. DomainName: DomainName;
  2420. /**
  2421. * The account ID to revoke access from.
  2422. */
  2423. Account: AWSAccount;
  2424. }
  2425. export interface RevokeVpcEndpointAccessResponse {
  2426. }
  2427. export type RoleArn = string;
  2428. export type RollbackOnDisable = "NO_ROLLBACK"|"DEFAULT_ROLLBACK"|string;
  2429. export type S3BucketName = string;
  2430. export type S3Key = string;
  2431. export type SAMLEntityId = string;
  2432. export interface SAMLIdp {
  2433. /**
  2434. * The Metadata of the SAML application in xml format.
  2435. */
  2436. MetadataContent: SAMLMetadata;
  2437. /**
  2438. * The unique Entity ID of the application in SAML Identity Provider.
  2439. */
  2440. EntityId: SAMLEntityId;
  2441. }
  2442. export type SAMLMetadata = string;
  2443. export interface SAMLOptionsInput {
  2444. /**
  2445. * True if SAML is enabled.
  2446. */
  2447. Enabled?: Boolean;
  2448. /**
  2449. * Specifies the SAML Identity Provider's information.
  2450. */
  2451. Idp?: SAMLIdp;
  2452. /**
  2453. * The SAML master username, which is stored in the Amazon Elasticsearch Service domain's internal database.
  2454. */
  2455. MasterUserName?: Username;
  2456. /**
  2457. * The backend role to which the SAML master user is mapped to.
  2458. */
  2459. MasterBackendRole?: BackendRole;
  2460. /**
  2461. * The key to use for matching the SAML Subject attribute.
  2462. */
  2463. SubjectKey?: String;
  2464. /**
  2465. * The key to use for matching the SAML Roles attribute.
  2466. */
  2467. RolesKey?: String;
  2468. /**
  2469. * The duration, in minutes, after which a user session becomes inactive. Acceptable values are between 1 and 1440, and the default value is 60.
  2470. */
  2471. SessionTimeoutMinutes?: IntegerClass;
  2472. }
  2473. export interface SAMLOptionsOutput {
  2474. /**
  2475. * True if SAML is enabled.
  2476. */
  2477. Enabled?: Boolean;
  2478. /**
  2479. * Describes the SAML Identity Provider's information.
  2480. */
  2481. Idp?: SAMLIdp;
  2482. /**
  2483. * The key used for matching the SAML Subject attribute.
  2484. */
  2485. SubjectKey?: String;
  2486. /**
  2487. * The key used for matching the SAML Roles attribute.
  2488. */
  2489. RolesKey?: String;
  2490. /**
  2491. * The duration, in minutes, after which a user session becomes inactive.
  2492. */
  2493. SessionTimeoutMinutes?: IntegerClass;
  2494. }
  2495. export type ScheduledAutoTuneActionType = "JVM_HEAP_SIZE_TUNING"|"JVM_YOUNG_GEN_TUNING"|string;
  2496. export type ScheduledAutoTuneDescription = string;
  2497. export interface ScheduledAutoTuneDetails {
  2498. /**
  2499. * Specifies timestamp for the Auto-Tune action scheduled for the domain.
  2500. */
  2501. Date?: AutoTuneDate;
  2502. /**
  2503. * Specifies Auto-Tune action type. Valid values are JVM_HEAP_SIZE_TUNING and JVM_YOUNG_GEN_TUNING.
  2504. */
  2505. ActionType?: ScheduledAutoTuneActionType;
  2506. /**
  2507. * Specifies Auto-Tune action description.
  2508. */
  2509. Action?: ScheduledAutoTuneDescription;
  2510. /**
  2511. * Specifies Auto-Tune action severity. Valid values are LOW, MEDIUM and HIGH.
  2512. */
  2513. Severity?: ScheduledAutoTuneSeverityType;
  2514. }
  2515. export type ScheduledAutoTuneSeverityType = "LOW"|"MEDIUM"|"HIGH"|string;
  2516. export interface ServiceSoftwareOptions {
  2517. /**
  2518. * The current service software version that is present on the domain.
  2519. */
  2520. CurrentVersion?: String;
  2521. /**
  2522. * The new service software version if one is available.
  2523. */
  2524. NewVersion?: String;
  2525. /**
  2526. * True if you are able to update you service software version. False if you are not able to update your service software version.
  2527. */
  2528. UpdateAvailable?: Boolean;
  2529. /**
  2530. * True if you are able to cancel your service software version update. False if you are not able to cancel your service software version.
  2531. */
  2532. Cancellable?: Boolean;
  2533. /**
  2534. * The status of your service software update. This field can take the following values: ELIGIBLE, PENDING_UPDATE, IN_PROGRESS, COMPLETED, and NOT_ELIGIBLE.
  2535. */
  2536. UpdateStatus?: DeploymentStatus;
  2537. /**
  2538. * The description of the UpdateStatus.
  2539. */
  2540. Description?: String;
  2541. /**
  2542. * Timestamp, in Epoch time, until which you can manually request a service software update. After this date, we automatically update your service software.
  2543. */
  2544. AutomatedUpdateDate?: DeploymentCloseDateTimeStamp;
  2545. /**
  2546. * True if a service software is never automatically updated. False if a service software is automatically updated after AutomatedUpdateDate.
  2547. */
  2548. OptionalDeployment?: Boolean;
  2549. }
  2550. export type ServiceUrl = string;
  2551. export interface SnapshotOptions {
  2552. /**
  2553. * Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.
  2554. */
  2555. AutomatedSnapshotStartHour?: IntegerClass;
  2556. }
  2557. export interface SnapshotOptionsStatus {
  2558. /**
  2559. * Specifies the daily snapshot options specified for the Elasticsearch domain.
  2560. */
  2561. Options: SnapshotOptions;
  2562. /**
  2563. * Specifies the status of a daily automated snapshot.
  2564. */
  2565. Status: OptionStatus;
  2566. }
  2567. export type StartAt = Date;
  2568. export interface StartElasticsearchServiceSoftwareUpdateRequest {
  2569. /**
  2570. * The name of the domain that you want to update to the latest service software.
  2571. */
  2572. DomainName: DomainName;
  2573. }
  2574. export interface StartElasticsearchServiceSoftwareUpdateResponse {
  2575. /**
  2576. * The current status of the Elasticsearch service software update.
  2577. */
  2578. ServiceSoftwareOptions?: ServiceSoftwareOptions;
  2579. }
  2580. export type StartTimestamp = Date;
  2581. export type StorageSubTypeName = string;
  2582. export interface StorageType {
  2583. StorageTypeName?: StorageTypeName;
  2584. StorageSubTypeName?: StorageSubTypeName;
  2585. /**
  2586. * List of limits that are applicable for given storage type.
  2587. */
  2588. StorageTypeLimits?: StorageTypeLimitList;
  2589. }
  2590. export interface StorageTypeLimit {
  2591. /**
  2592. * Name of storage limits that are applicable for given storage type. If StorageType is ebs, following storage options are applicable MinimumVolumeSize Minimum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable. MaximumVolumeSize Maximum amount of volume size that is applicable for given storage type.It can be empty if it is not applicable. MaximumIops Maximum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable. MinimumIops Minimum amount of Iops that is applicable for given storage type.It can be empty if it is not applicable. MaximumThroughput Maximum amount of Throughput that is applicable for given storage type.It can be empty if it is not applicable. MinimumThroughput Minimum amount of Throughput that is applicable for given storage type.It can be empty if it is not applicable.
  2593. */
  2594. LimitName?: LimitName;
  2595. /**
  2596. * Values for the StorageTypeLimit$LimitName .
  2597. */
  2598. LimitValues?: LimitValueList;
  2599. }
  2600. export type StorageTypeLimitList = StorageTypeLimit[];
  2601. export type StorageTypeList = StorageType[];
  2602. export type StorageTypeName = string;
  2603. export type String = string;
  2604. export type StringList = String[];
  2605. export type TLSSecurityPolicy = "Policy-Min-TLS-1-0-2019-07"|"Policy-Min-TLS-1-2-2019-07"|"Policy-Min-TLS-1-2-PFS-2023-10"|string;
  2606. export interface Tag {
  2607. /**
  2608. * Specifies the TagKey, the name of the tag. Tag keys must be unique for the Elasticsearch domain to which they are attached.
  2609. */
  2610. Key: TagKey;
  2611. /**
  2612. * Specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and do not have to be unique in a tag set. For example, you can have a key value pair in a tag set of project : Trinity and cost-center : Trinity
  2613. */
  2614. Value: TagValue;
  2615. }
  2616. export type TagKey = string;
  2617. export type TagList = Tag[];
  2618. export type TagValue = string;
  2619. export type TimeUnit = "HOURS"|string;
  2620. export type TotalNumberOfStages = number;
  2621. export type UIntValue = number;
  2622. export interface UpdateElasticsearchDomainConfigRequest {
  2623. /**
  2624. * The name of the Elasticsearch domain that you are updating.
  2625. */
  2626. DomainName: DomainName;
  2627. /**
  2628. * The type and number of instances to instantiate for the domain cluster.
  2629. */
  2630. ElasticsearchClusterConfig?: ElasticsearchClusterConfig;
  2631. /**
  2632. * Specify the type and size of the EBS volume that you want to use.
  2633. */
  2634. EBSOptions?: EBSOptions;
  2635. /**
  2636. * Option to set the time, in UTC format, for the daily automated snapshot. Default value is 0 hours.
  2637. */
  2638. SnapshotOptions?: SnapshotOptions;
  2639. /**
  2640. * Options to specify the subnets and security groups for VPC endpoint. For more information, see Creating a VPC in VPC Endpoints for Amazon Elasticsearch Service Domains
  2641. */
  2642. VPCOptions?: VPCOptions;
  2643. /**
  2644. * Options to specify the Cognito user and identity pools for Kibana authentication. For more information, see Amazon Cognito Authentication for Kibana.
  2645. */
  2646. CognitoOptions?: CognitoOptions;
  2647. /**
  2648. * Modifies the advanced option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true. See Configuration Advanced Options for more information.
  2649. */
  2650. AdvancedOptions?: AdvancedOptions;
  2651. /**
  2652. * IAM access policy as a JSON-formatted string.
  2653. */
  2654. AccessPolicies?: PolicyDocument;
  2655. /**
  2656. * Map of LogType and LogPublishingOption, each containing options to publish a given type of Elasticsearch log.
  2657. */
  2658. LogPublishingOptions?: LogPublishingOptions;
  2659. /**
  2660. * Options to specify configuration that will be applied to the domain endpoint.
  2661. */
  2662. DomainEndpointOptions?: DomainEndpointOptions;
  2663. /**
  2664. * Specifies advanced security options.
  2665. */
  2666. AdvancedSecurityOptions?: AdvancedSecurityOptionsInput;
  2667. /**
  2668. * Specifies the NodeToNodeEncryptionOptions.
  2669. */
  2670. NodeToNodeEncryptionOptions?: NodeToNodeEncryptionOptions;
  2671. /**
  2672. * Specifies the Encryption At Rest Options.
  2673. */
  2674. EncryptionAtRestOptions?: EncryptionAtRestOptions;
  2675. /**
  2676. * Specifies Auto-Tune options.
  2677. */
  2678. AutoTuneOptions?: AutoTuneOptions;
  2679. /**
  2680. * This flag, when set to True, specifies whether the UpdateElasticsearchDomain request should return the results of validation checks without actually applying the change. This flag, when set to True, specifies the deployment mechanism through which the update shall be applied on the domain. This will not actually perform the Update.
  2681. */
  2682. DryRun?: DryRun;
  2683. }
  2684. export interface UpdateElasticsearchDomainConfigResponse {
  2685. /**
  2686. * The status of the updated Elasticsearch domain.
  2687. */
  2688. DomainConfig: ElasticsearchDomainConfig;
  2689. /**
  2690. * Contains result of DryRun.
  2691. */
  2692. DryRunResults?: DryRunResults;
  2693. }
  2694. export interface UpdatePackageRequest {
  2695. /**
  2696. * Unique identifier for the package.
  2697. */
  2698. PackageID: PackageID;
  2699. PackageSource: PackageSource;
  2700. /**
  2701. * New description of the package.
  2702. */
  2703. PackageDescription?: PackageDescription;
  2704. /**
  2705. * An info message for the new version which will be shown as part of GetPackageVersionHistoryResponse.
  2706. */
  2707. CommitMessage?: CommitMessage;
  2708. }
  2709. export interface UpdatePackageResponse {
  2710. /**
  2711. * Information about the package PackageDetails.
  2712. */
  2713. PackageDetails?: PackageDetails;
  2714. }
  2715. export type UpdateTimestamp = Date;
  2716. export interface UpdateVpcEndpointRequest {
  2717. /**
  2718. * Unique identifier of the VPC endpoint to be updated.
  2719. */
  2720. VpcEndpointId: VpcEndpointId;
  2721. /**
  2722. * The security groups and/or subnets to add, remove, or modify.
  2723. */
  2724. VpcOptions: VPCOptions;
  2725. }
  2726. export interface UpdateVpcEndpointResponse {
  2727. /**
  2728. * The endpoint to be updated.
  2729. */
  2730. VpcEndpoint: VpcEndpoint;
  2731. }
  2732. export interface UpgradeElasticsearchDomainRequest {
  2733. DomainName: DomainName;
  2734. /**
  2735. * The version of Elasticsearch that you intend to upgrade the domain to.
  2736. */
  2737. TargetVersion: ElasticsearchVersionString;
  2738. /**
  2739. * This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.
  2740. */
  2741. PerformCheckOnly?: Boolean;
  2742. }
  2743. export interface UpgradeElasticsearchDomainResponse {
  2744. DomainName?: DomainName;
  2745. /**
  2746. * The version of Elasticsearch that you intend to upgrade the domain to.
  2747. */
  2748. TargetVersion?: ElasticsearchVersionString;
  2749. /**
  2750. * This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.
  2751. */
  2752. PerformCheckOnly?: Boolean;
  2753. ChangeProgressDetails?: ChangeProgressDetails;
  2754. }
  2755. export interface UpgradeHistory {
  2756. /**
  2757. * A string that describes the update briefly
  2758. */
  2759. UpgradeName?: UpgradeName;
  2760. /**
  2761. * UTC Timestamp at which the Upgrade API call was made in "yyyy-MM-ddTHH:mm:ssZ" format.
  2762. */
  2763. StartTimestamp?: StartTimestamp;
  2764. /**
  2765. * The overall status of the update. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed
  2766. */
  2767. UpgradeStatus?: UpgradeStatus;
  2768. /**
  2769. * A list of UpgradeStepItem s representing information about each step performed as pard of a specific Upgrade or Upgrade Eligibility Check.
  2770. */
  2771. StepsList?: UpgradeStepsList;
  2772. }
  2773. export type UpgradeHistoryList = UpgradeHistory[];
  2774. export type UpgradeName = string;
  2775. export type UpgradeStatus = "IN_PROGRESS"|"SUCCEEDED"|"SUCCEEDED_WITH_ISSUES"|"FAILED"|string;
  2776. export type UpgradeStep = "PRE_UPGRADE_CHECK"|"SNAPSHOT"|"UPGRADE"|string;
  2777. export interface UpgradeStepItem {
  2778. /**
  2779. * Represents one of 3 steps that an Upgrade or Upgrade Eligibility Check does through: PreUpgradeCheck Snapshot Upgrade
  2780. */
  2781. UpgradeStep?: UpgradeStep;
  2782. /**
  2783. * The status of a particular step during an upgrade. The status can take one of the following values: In Progress Succeeded Succeeded with Issues Failed
  2784. */
  2785. UpgradeStepStatus?: UpgradeStatus;
  2786. /**
  2787. * A list of strings containing detailed information about the errors encountered in a particular step.
  2788. */
  2789. Issues?: Issues;
  2790. /**
  2791. * The Floating point value representing progress percentage of a particular step.
  2792. */
  2793. ProgressPercent?: Double;
  2794. }
  2795. export type UpgradeStepsList = UpgradeStepItem[];
  2796. export type UserPoolId = string;
  2797. export type Username = string;
  2798. export interface VPCDerivedInfo {
  2799. /**
  2800. * The VPC Id for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
  2801. */
  2802. VPCId?: String;
  2803. /**
  2804. * Specifies the subnets for VPC endpoint.
  2805. */
  2806. SubnetIds?: StringList;
  2807. /**
  2808. * The availability zones for the Elasticsearch domain. Exists only if the domain was created with VPCOptions.
  2809. */
  2810. AvailabilityZones?: StringList;
  2811. /**
  2812. * Specifies the security groups for VPC endpoint.
  2813. */
  2814. SecurityGroupIds?: StringList;
  2815. }
  2816. export interface VPCDerivedInfoStatus {
  2817. /**
  2818. * Specifies the VPC options for the specified Elasticsearch domain.
  2819. */
  2820. Options: VPCDerivedInfo;
  2821. /**
  2822. * Specifies the status of the VPC options for the specified Elasticsearch domain.
  2823. */
  2824. Status: OptionStatus;
  2825. }
  2826. export interface VPCOptions {
  2827. /**
  2828. * Specifies the subnets for VPC endpoint.
  2829. */
  2830. SubnetIds?: StringList;
  2831. /**
  2832. * Specifies the security groups for VPC endpoint.
  2833. */
  2834. SecurityGroupIds?: StringList;
  2835. }
  2836. export type ValueStringList = NonEmptyString[];
  2837. export type VolumeType = "standard"|"gp2"|"io1"|"gp3"|string;
  2838. export interface VpcEndpoint {
  2839. /**
  2840. * The unique identifier of the endpoint.
  2841. */
  2842. VpcEndpointId?: VpcEndpointId;
  2843. /**
  2844. * The creator of the endpoint.
  2845. */
  2846. VpcEndpointOwner?: AWSAccount;
  2847. /**
  2848. * The Amazon Resource Name (ARN) of the domain associated with the endpoint.
  2849. */
  2850. DomainArn?: DomainArn;
  2851. /**
  2852. * Options to specify the subnets and security groups for an Amazon OpenSearch Service VPC endpoint.
  2853. */
  2854. VpcOptions?: VPCDerivedInfo;
  2855. /**
  2856. * The current status of the endpoint.
  2857. */
  2858. Status?: VpcEndpointStatus;
  2859. /**
  2860. * The connection endpoint ID for connecting to the domain.
  2861. */
  2862. Endpoint?: Endpoint;
  2863. }
  2864. export interface VpcEndpointError {
  2865. /**
  2866. * The unique identifier of the endpoint.
  2867. */
  2868. VpcEndpointId?: VpcEndpointId;
  2869. /**
  2870. * The code associated with the error.
  2871. */
  2872. ErrorCode?: VpcEndpointErrorCode;
  2873. /**
  2874. * A message describing the error.
  2875. */
  2876. ErrorMessage?: String;
  2877. }
  2878. export type VpcEndpointErrorCode = "ENDPOINT_NOT_FOUND"|"SERVER_ERROR"|string;
  2879. export type VpcEndpointErrorList = VpcEndpointError[];
  2880. export type VpcEndpointId = string;
  2881. export type VpcEndpointIdList = VpcEndpointId[];
  2882. export type VpcEndpointStatus = "CREATING"|"CREATE_FAILED"|"ACTIVE"|"UPDATING"|"UPDATE_FAILED"|"DELETING"|"DELETE_FAILED"|string;
  2883. export interface VpcEndpointSummary {
  2884. /**
  2885. * The unique identifier of the endpoint.
  2886. */
  2887. VpcEndpointId?: VpcEndpointId;
  2888. /**
  2889. * The creator of the endpoint.
  2890. */
  2891. VpcEndpointOwner?: String;
  2892. /**
  2893. * The Amazon Resource Name (ARN) of the domain associated with the endpoint.
  2894. */
  2895. DomainArn?: DomainArn;
  2896. /**
  2897. * The current status of the endpoint.
  2898. */
  2899. Status?: VpcEndpointStatus;
  2900. }
  2901. export type VpcEndpointSummaryList = VpcEndpointSummary[];
  2902. export type VpcEndpoints = VpcEndpoint[];
  2903. export interface ZoneAwarenessConfig {
  2904. /**
  2905. * An integer value to indicate the number of availability zones for a domain when zone awareness is enabled. This should be equal to number of subnets if VPC endpoints is enabled
  2906. */
  2907. AvailabilityZoneCount?: IntegerClass;
  2908. }
  2909. /**
  2910. * 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.
  2911. */
  2912. export type apiVersion = "2015-01-01"|"latest"|string;
  2913. export interface ClientApiVersions {
  2914. /**
  2915. * 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.
  2916. */
  2917. apiVersion?: apiVersion;
  2918. }
  2919. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  2920. /**
  2921. * Contains interfaces for use with the ES client.
  2922. */
  2923. export import Types = ES;
  2924. }
  2925. export = ES;