redshiftserverless.d.ts 107 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471
  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 RedshiftServerless extends Service {
  9. /**
  10. * Constructs a service object. This object has one method for each API operation.
  11. */
  12. constructor(options?: RedshiftServerless.Types.ClientConfiguration)
  13. config: Config & RedshiftServerless.Types.ClientConfiguration;
  14. /**
  15. * Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.
  16. */
  17. convertRecoveryPointToSnapshot(params: RedshiftServerless.Types.ConvertRecoveryPointToSnapshotRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ConvertRecoveryPointToSnapshotResponse) => void): Request<RedshiftServerless.Types.ConvertRecoveryPointToSnapshotResponse, AWSError>;
  18. /**
  19. * Converts a recovery point to a snapshot. For more information about recovery points and snapshots, see Working with snapshots and recovery points.
  20. */
  21. convertRecoveryPointToSnapshot(callback?: (err: AWSError, data: RedshiftServerless.Types.ConvertRecoveryPointToSnapshotResponse) => void): Request<RedshiftServerless.Types.ConvertRecoveryPointToSnapshotResponse, AWSError>;
  22. /**
  23. * Creates a custom domain association for Amazon Redshift Serverless.
  24. */
  25. createCustomDomainAssociation(params: RedshiftServerless.Types.CreateCustomDomainAssociationRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.CreateCustomDomainAssociationResponse, AWSError>;
  26. /**
  27. * Creates a custom domain association for Amazon Redshift Serverless.
  28. */
  29. createCustomDomainAssociation(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.CreateCustomDomainAssociationResponse, AWSError>;
  30. /**
  31. * Creates an Amazon Redshift Serverless managed VPC endpoint.
  32. */
  33. createEndpointAccess(params: RedshiftServerless.Types.CreateEndpointAccessRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateEndpointAccessResponse) => void): Request<RedshiftServerless.Types.CreateEndpointAccessResponse, AWSError>;
  34. /**
  35. * Creates an Amazon Redshift Serverless managed VPC endpoint.
  36. */
  37. createEndpointAccess(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateEndpointAccessResponse) => void): Request<RedshiftServerless.Types.CreateEndpointAccessResponse, AWSError>;
  38. /**
  39. * Creates a namespace in Amazon Redshift Serverless.
  40. */
  41. createNamespace(params: RedshiftServerless.Types.CreateNamespaceRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateNamespaceResponse) => void): Request<RedshiftServerless.Types.CreateNamespaceResponse, AWSError>;
  42. /**
  43. * Creates a namespace in Amazon Redshift Serverless.
  44. */
  45. createNamespace(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateNamespaceResponse) => void): Request<RedshiftServerless.Types.CreateNamespaceResponse, AWSError>;
  46. /**
  47. * Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the CreateSnapshot API operation.
  48. */
  49. createScheduledAction(params: RedshiftServerless.Types.CreateScheduledActionRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateScheduledActionResponse) => void): Request<RedshiftServerless.Types.CreateScheduledActionResponse, AWSError>;
  50. /**
  51. * Creates a scheduled action. A scheduled action contains a schedule and an Amazon Redshift API action. For example, you can create a schedule of when to run the CreateSnapshot API operation.
  52. */
  53. createScheduledAction(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateScheduledActionResponse) => void): Request<RedshiftServerless.Types.CreateScheduledActionResponse, AWSError>;
  54. /**
  55. * Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.
  56. */
  57. createSnapshot(params: RedshiftServerless.Types.CreateSnapshotRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateSnapshotResponse) => void): Request<RedshiftServerless.Types.CreateSnapshotResponse, AWSError>;
  58. /**
  59. * Creates a snapshot of all databases in a namespace. For more information about snapshots, see Working with snapshots and recovery points.
  60. */
  61. createSnapshot(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateSnapshotResponse) => void): Request<RedshiftServerless.Types.CreateSnapshotResponse, AWSError>;
  62. /**
  63. * Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.
  64. */
  65. createSnapshotCopyConfiguration(params: RedshiftServerless.Types.CreateSnapshotCopyConfigurationRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateSnapshotCopyConfigurationResponse) => void): Request<RedshiftServerless.Types.CreateSnapshotCopyConfigurationResponse, AWSError>;
  66. /**
  67. * Creates a snapshot copy configuration that lets you copy snapshots to another Amazon Web Services Region.
  68. */
  69. createSnapshotCopyConfiguration(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateSnapshotCopyConfigurationResponse) => void): Request<RedshiftServerless.Types.CreateSnapshotCopyConfigurationResponse, AWSError>;
  70. /**
  71. * Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.
  72. */
  73. createUsageLimit(params: RedshiftServerless.Types.CreateUsageLimitRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateUsageLimitResponse) => void): Request<RedshiftServerless.Types.CreateUsageLimitResponse, AWSError>;
  74. /**
  75. * Creates a usage limit for a specified Amazon Redshift Serverless usage type. The usage limit is identified by the returned usage limit identifier.
  76. */
  77. createUsageLimit(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateUsageLimitResponse) => void): Request<RedshiftServerless.Types.CreateUsageLimitResponse, AWSError>;
  78. /**
  79. * Creates an workgroup in Amazon Redshift Serverless.
  80. */
  81. createWorkgroup(params: RedshiftServerless.Types.CreateWorkgroupRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.CreateWorkgroupResponse) => void): Request<RedshiftServerless.Types.CreateWorkgroupResponse, AWSError>;
  82. /**
  83. * Creates an workgroup in Amazon Redshift Serverless.
  84. */
  85. createWorkgroup(callback?: (err: AWSError, data: RedshiftServerless.Types.CreateWorkgroupResponse) => void): Request<RedshiftServerless.Types.CreateWorkgroupResponse, AWSError>;
  86. /**
  87. * Deletes a custom domain association for Amazon Redshift Serverless.
  88. */
  89. deleteCustomDomainAssociation(params: RedshiftServerless.Types.DeleteCustomDomainAssociationRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.DeleteCustomDomainAssociationResponse, AWSError>;
  90. /**
  91. * Deletes a custom domain association for Amazon Redshift Serverless.
  92. */
  93. deleteCustomDomainAssociation(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.DeleteCustomDomainAssociationResponse, AWSError>;
  94. /**
  95. * Deletes an Amazon Redshift Serverless managed VPC endpoint.
  96. */
  97. deleteEndpointAccess(params: RedshiftServerless.Types.DeleteEndpointAccessRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteEndpointAccessResponse) => void): Request<RedshiftServerless.Types.DeleteEndpointAccessResponse, AWSError>;
  98. /**
  99. * Deletes an Amazon Redshift Serverless managed VPC endpoint.
  100. */
  101. deleteEndpointAccess(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteEndpointAccessResponse) => void): Request<RedshiftServerless.Types.DeleteEndpointAccessResponse, AWSError>;
  102. /**
  103. * Deletes a namespace from Amazon Redshift Serverless. Before you delete the namespace, you can create a final snapshot that has all of the data within the namespace.
  104. */
  105. deleteNamespace(params: RedshiftServerless.Types.DeleteNamespaceRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteNamespaceResponse) => void): Request<RedshiftServerless.Types.DeleteNamespaceResponse, AWSError>;
  106. /**
  107. * Deletes a namespace from Amazon Redshift Serverless. Before you delete the namespace, you can create a final snapshot that has all of the data within the namespace.
  108. */
  109. deleteNamespace(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteNamespaceResponse) => void): Request<RedshiftServerless.Types.DeleteNamespaceResponse, AWSError>;
  110. /**
  111. * Deletes the specified resource policy.
  112. */
  113. deleteResourcePolicy(params: RedshiftServerless.Types.DeleteResourcePolicyRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteResourcePolicyResponse) => void): Request<RedshiftServerless.Types.DeleteResourcePolicyResponse, AWSError>;
  114. /**
  115. * Deletes the specified resource policy.
  116. */
  117. deleteResourcePolicy(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteResourcePolicyResponse) => void): Request<RedshiftServerless.Types.DeleteResourcePolicyResponse, AWSError>;
  118. /**
  119. * Deletes a scheduled action.
  120. */
  121. deleteScheduledAction(params: RedshiftServerless.Types.DeleteScheduledActionRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteScheduledActionResponse) => void): Request<RedshiftServerless.Types.DeleteScheduledActionResponse, AWSError>;
  122. /**
  123. * Deletes a scheduled action.
  124. */
  125. deleteScheduledAction(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteScheduledActionResponse) => void): Request<RedshiftServerless.Types.DeleteScheduledActionResponse, AWSError>;
  126. /**
  127. * Deletes a snapshot from Amazon Redshift Serverless.
  128. */
  129. deleteSnapshot(params: RedshiftServerless.Types.DeleteSnapshotRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteSnapshotResponse) => void): Request<RedshiftServerless.Types.DeleteSnapshotResponse, AWSError>;
  130. /**
  131. * Deletes a snapshot from Amazon Redshift Serverless.
  132. */
  133. deleteSnapshot(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteSnapshotResponse) => void): Request<RedshiftServerless.Types.DeleteSnapshotResponse, AWSError>;
  134. /**
  135. * Deletes a snapshot copy configuration
  136. */
  137. deleteSnapshotCopyConfiguration(params: RedshiftServerless.Types.DeleteSnapshotCopyConfigurationRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteSnapshotCopyConfigurationResponse) => void): Request<RedshiftServerless.Types.DeleteSnapshotCopyConfigurationResponse, AWSError>;
  138. /**
  139. * Deletes a snapshot copy configuration
  140. */
  141. deleteSnapshotCopyConfiguration(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteSnapshotCopyConfigurationResponse) => void): Request<RedshiftServerless.Types.DeleteSnapshotCopyConfigurationResponse, AWSError>;
  142. /**
  143. * Deletes a usage limit from Amazon Redshift Serverless.
  144. */
  145. deleteUsageLimit(params: RedshiftServerless.Types.DeleteUsageLimitRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteUsageLimitResponse) => void): Request<RedshiftServerless.Types.DeleteUsageLimitResponse, AWSError>;
  146. /**
  147. * Deletes a usage limit from Amazon Redshift Serverless.
  148. */
  149. deleteUsageLimit(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteUsageLimitResponse) => void): Request<RedshiftServerless.Types.DeleteUsageLimitResponse, AWSError>;
  150. /**
  151. * Deletes a workgroup.
  152. */
  153. deleteWorkgroup(params: RedshiftServerless.Types.DeleteWorkgroupRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteWorkgroupResponse) => void): Request<RedshiftServerless.Types.DeleteWorkgroupResponse, AWSError>;
  154. /**
  155. * Deletes a workgroup.
  156. */
  157. deleteWorkgroup(callback?: (err: AWSError, data: RedshiftServerless.Types.DeleteWorkgroupResponse) => void): Request<RedshiftServerless.Types.DeleteWorkgroupResponse, AWSError>;
  158. /**
  159. * Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). &lt;p&gt;The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.&lt;/p&gt; &lt;p&gt;If the &lt;code&gt;DbName&lt;/code&gt; parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.&lt;/p&gt;
  160. */
  161. getCredentials(params: RedshiftServerless.Types.GetCredentialsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetCredentialsResponse) => void): Request<RedshiftServerless.Types.GetCredentialsResponse, AWSError>;
  162. /**
  163. * Returns a database user name and temporary password with temporary authorization to log in to Amazon Redshift Serverless. By default, the temporary credentials expire in 900 seconds. You can optionally specify a duration between 900 seconds (15 minutes) and 3600 seconds (60 minutes). &lt;p&gt;The Identity and Access Management (IAM) user or role that runs GetCredentials must have an IAM policy attached that allows access to all necessary actions and resources.&lt;/p&gt; &lt;p&gt;If the &lt;code&gt;DbName&lt;/code&gt; parameter is specified, the IAM policy must allow access to the resource dbname for the specified database name.&lt;/p&gt;
  164. */
  165. getCredentials(callback?: (err: AWSError, data: RedshiftServerless.Types.GetCredentialsResponse) => void): Request<RedshiftServerless.Types.GetCredentialsResponse, AWSError>;
  166. /**
  167. * Gets information about a specific custom domain association.
  168. */
  169. getCustomDomainAssociation(params: RedshiftServerless.Types.GetCustomDomainAssociationRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.GetCustomDomainAssociationResponse, AWSError>;
  170. /**
  171. * Gets information about a specific custom domain association.
  172. */
  173. getCustomDomainAssociation(callback?: (err: AWSError, data: RedshiftServerless.Types.GetCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.GetCustomDomainAssociationResponse, AWSError>;
  174. /**
  175. * Returns information, such as the name, about a VPC endpoint.
  176. */
  177. getEndpointAccess(params: RedshiftServerless.Types.GetEndpointAccessRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetEndpointAccessResponse) => void): Request<RedshiftServerless.Types.GetEndpointAccessResponse, AWSError>;
  178. /**
  179. * Returns information, such as the name, about a VPC endpoint.
  180. */
  181. getEndpointAccess(callback?: (err: AWSError, data: RedshiftServerless.Types.GetEndpointAccessResponse) => void): Request<RedshiftServerless.Types.GetEndpointAccessResponse, AWSError>;
  182. /**
  183. * Returns information about a namespace in Amazon Redshift Serverless.
  184. */
  185. getNamespace(params: RedshiftServerless.Types.GetNamespaceRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetNamespaceResponse) => void): Request<RedshiftServerless.Types.GetNamespaceResponse, AWSError>;
  186. /**
  187. * Returns information about a namespace in Amazon Redshift Serverless.
  188. */
  189. getNamespace(callback?: (err: AWSError, data: RedshiftServerless.Types.GetNamespaceResponse) => void): Request<RedshiftServerless.Types.GetNamespaceResponse, AWSError>;
  190. /**
  191. * Returns information about a recovery point.
  192. */
  193. getRecoveryPoint(params: RedshiftServerless.Types.GetRecoveryPointRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetRecoveryPointResponse) => void): Request<RedshiftServerless.Types.GetRecoveryPointResponse, AWSError>;
  194. /**
  195. * Returns information about a recovery point.
  196. */
  197. getRecoveryPoint(callback?: (err: AWSError, data: RedshiftServerless.Types.GetRecoveryPointResponse) => void): Request<RedshiftServerless.Types.GetRecoveryPointResponse, AWSError>;
  198. /**
  199. * Returns a resource policy.
  200. */
  201. getResourcePolicy(params: RedshiftServerless.Types.GetResourcePolicyRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetResourcePolicyResponse) => void): Request<RedshiftServerless.Types.GetResourcePolicyResponse, AWSError>;
  202. /**
  203. * Returns a resource policy.
  204. */
  205. getResourcePolicy(callback?: (err: AWSError, data: RedshiftServerless.Types.GetResourcePolicyResponse) => void): Request<RedshiftServerless.Types.GetResourcePolicyResponse, AWSError>;
  206. /**
  207. * Returns information about a scheduled action.
  208. */
  209. getScheduledAction(params: RedshiftServerless.Types.GetScheduledActionRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetScheduledActionResponse) => void): Request<RedshiftServerless.Types.GetScheduledActionResponse, AWSError>;
  210. /**
  211. * Returns information about a scheduled action.
  212. */
  213. getScheduledAction(callback?: (err: AWSError, data: RedshiftServerless.Types.GetScheduledActionResponse) => void): Request<RedshiftServerless.Types.GetScheduledActionResponse, AWSError>;
  214. /**
  215. * Returns information about a specific snapshot.
  216. */
  217. getSnapshot(params: RedshiftServerless.Types.GetSnapshotRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetSnapshotResponse) => void): Request<RedshiftServerless.Types.GetSnapshotResponse, AWSError>;
  218. /**
  219. * Returns information about a specific snapshot.
  220. */
  221. getSnapshot(callback?: (err: AWSError, data: RedshiftServerless.Types.GetSnapshotResponse) => void): Request<RedshiftServerless.Types.GetSnapshotResponse, AWSError>;
  222. /**
  223. * Returns information about a TableRestoreStatus object.
  224. */
  225. getTableRestoreStatus(params: RedshiftServerless.Types.GetTableRestoreStatusRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetTableRestoreStatusResponse) => void): Request<RedshiftServerless.Types.GetTableRestoreStatusResponse, AWSError>;
  226. /**
  227. * Returns information about a TableRestoreStatus object.
  228. */
  229. getTableRestoreStatus(callback?: (err: AWSError, data: RedshiftServerless.Types.GetTableRestoreStatusResponse) => void): Request<RedshiftServerless.Types.GetTableRestoreStatusResponse, AWSError>;
  230. /**
  231. * Returns information about a usage limit.
  232. */
  233. getUsageLimit(params: RedshiftServerless.Types.GetUsageLimitRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetUsageLimitResponse) => void): Request<RedshiftServerless.Types.GetUsageLimitResponse, AWSError>;
  234. /**
  235. * Returns information about a usage limit.
  236. */
  237. getUsageLimit(callback?: (err: AWSError, data: RedshiftServerless.Types.GetUsageLimitResponse) => void): Request<RedshiftServerless.Types.GetUsageLimitResponse, AWSError>;
  238. /**
  239. * Returns information about a specific workgroup.
  240. */
  241. getWorkgroup(params: RedshiftServerless.Types.GetWorkgroupRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.GetWorkgroupResponse) => void): Request<RedshiftServerless.Types.GetWorkgroupResponse, AWSError>;
  242. /**
  243. * Returns information about a specific workgroup.
  244. */
  245. getWorkgroup(callback?: (err: AWSError, data: RedshiftServerless.Types.GetWorkgroupResponse) => void): Request<RedshiftServerless.Types.GetWorkgroupResponse, AWSError>;
  246. /**
  247. * Lists custom domain associations for Amazon Redshift Serverless.
  248. */
  249. listCustomDomainAssociations(params: RedshiftServerless.Types.ListCustomDomainAssociationsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListCustomDomainAssociationsResponse) => void): Request<RedshiftServerless.Types.ListCustomDomainAssociationsResponse, AWSError>;
  250. /**
  251. * Lists custom domain associations for Amazon Redshift Serverless.
  252. */
  253. listCustomDomainAssociations(callback?: (err: AWSError, data: RedshiftServerless.Types.ListCustomDomainAssociationsResponse) => void): Request<RedshiftServerless.Types.ListCustomDomainAssociationsResponse, AWSError>;
  254. /**
  255. * Returns an array of EndpointAccess objects and relevant information.
  256. */
  257. listEndpointAccess(params: RedshiftServerless.Types.ListEndpointAccessRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListEndpointAccessResponse) => void): Request<RedshiftServerless.Types.ListEndpointAccessResponse, AWSError>;
  258. /**
  259. * Returns an array of EndpointAccess objects and relevant information.
  260. */
  261. listEndpointAccess(callback?: (err: AWSError, data: RedshiftServerless.Types.ListEndpointAccessResponse) => void): Request<RedshiftServerless.Types.ListEndpointAccessResponse, AWSError>;
  262. /**
  263. * Returns information about a list of specified namespaces.
  264. */
  265. listNamespaces(params: RedshiftServerless.Types.ListNamespacesRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListNamespacesResponse) => void): Request<RedshiftServerless.Types.ListNamespacesResponse, AWSError>;
  266. /**
  267. * Returns information about a list of specified namespaces.
  268. */
  269. listNamespaces(callback?: (err: AWSError, data: RedshiftServerless.Types.ListNamespacesResponse) => void): Request<RedshiftServerless.Types.ListNamespacesResponse, AWSError>;
  270. /**
  271. * Returns an array of recovery points.
  272. */
  273. listRecoveryPoints(params: RedshiftServerless.Types.ListRecoveryPointsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListRecoveryPointsResponse) => void): Request<RedshiftServerless.Types.ListRecoveryPointsResponse, AWSError>;
  274. /**
  275. * Returns an array of recovery points.
  276. */
  277. listRecoveryPoints(callback?: (err: AWSError, data: RedshiftServerless.Types.ListRecoveryPointsResponse) => void): Request<RedshiftServerless.Types.ListRecoveryPointsResponse, AWSError>;
  278. /**
  279. * Returns a list of scheduled actions. You can use the flags to filter the list of returned scheduled actions.
  280. */
  281. listScheduledActions(params: RedshiftServerless.Types.ListScheduledActionsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListScheduledActionsResponse) => void): Request<RedshiftServerless.Types.ListScheduledActionsResponse, AWSError>;
  282. /**
  283. * Returns a list of scheduled actions. You can use the flags to filter the list of returned scheduled actions.
  284. */
  285. listScheduledActions(callback?: (err: AWSError, data: RedshiftServerless.Types.ListScheduledActionsResponse) => void): Request<RedshiftServerless.Types.ListScheduledActionsResponse, AWSError>;
  286. /**
  287. * Returns a list of snapshot copy configurations.
  288. */
  289. listSnapshotCopyConfigurations(params: RedshiftServerless.Types.ListSnapshotCopyConfigurationsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListSnapshotCopyConfigurationsResponse) => void): Request<RedshiftServerless.Types.ListSnapshotCopyConfigurationsResponse, AWSError>;
  290. /**
  291. * Returns a list of snapshot copy configurations.
  292. */
  293. listSnapshotCopyConfigurations(callback?: (err: AWSError, data: RedshiftServerless.Types.ListSnapshotCopyConfigurationsResponse) => void): Request<RedshiftServerless.Types.ListSnapshotCopyConfigurationsResponse, AWSError>;
  294. /**
  295. * Returns a list of snapshots.
  296. */
  297. listSnapshots(params: RedshiftServerless.Types.ListSnapshotsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListSnapshotsResponse) => void): Request<RedshiftServerless.Types.ListSnapshotsResponse, AWSError>;
  298. /**
  299. * Returns a list of snapshots.
  300. */
  301. listSnapshots(callback?: (err: AWSError, data: RedshiftServerless.Types.ListSnapshotsResponse) => void): Request<RedshiftServerless.Types.ListSnapshotsResponse, AWSError>;
  302. /**
  303. * Returns information about an array of TableRestoreStatus objects.
  304. */
  305. listTableRestoreStatus(params: RedshiftServerless.Types.ListTableRestoreStatusRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListTableRestoreStatusResponse) => void): Request<RedshiftServerless.Types.ListTableRestoreStatusResponse, AWSError>;
  306. /**
  307. * Returns information about an array of TableRestoreStatus objects.
  308. */
  309. listTableRestoreStatus(callback?: (err: AWSError, data: RedshiftServerless.Types.ListTableRestoreStatusResponse) => void): Request<RedshiftServerless.Types.ListTableRestoreStatusResponse, AWSError>;
  310. /**
  311. * Lists the tags assigned to a resource.
  312. */
  313. listTagsForResource(params: RedshiftServerless.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListTagsForResourceResponse) => void): Request<RedshiftServerless.Types.ListTagsForResourceResponse, AWSError>;
  314. /**
  315. * Lists the tags assigned to a resource.
  316. */
  317. listTagsForResource(callback?: (err: AWSError, data: RedshiftServerless.Types.ListTagsForResourceResponse) => void): Request<RedshiftServerless.Types.ListTagsForResourceResponse, AWSError>;
  318. /**
  319. * Lists all usage limits within Amazon Redshift Serverless.
  320. */
  321. listUsageLimits(params: RedshiftServerless.Types.ListUsageLimitsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListUsageLimitsResponse) => void): Request<RedshiftServerless.Types.ListUsageLimitsResponse, AWSError>;
  322. /**
  323. * Lists all usage limits within Amazon Redshift Serverless.
  324. */
  325. listUsageLimits(callback?: (err: AWSError, data: RedshiftServerless.Types.ListUsageLimitsResponse) => void): Request<RedshiftServerless.Types.ListUsageLimitsResponse, AWSError>;
  326. /**
  327. * Returns information about a list of specified workgroups.
  328. */
  329. listWorkgroups(params: RedshiftServerless.Types.ListWorkgroupsRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.ListWorkgroupsResponse) => void): Request<RedshiftServerless.Types.ListWorkgroupsResponse, AWSError>;
  330. /**
  331. * Returns information about a list of specified workgroups.
  332. */
  333. listWorkgroups(callback?: (err: AWSError, data: RedshiftServerless.Types.ListWorkgroupsResponse) => void): Request<RedshiftServerless.Types.ListWorkgroupsResponse, AWSError>;
  334. /**
  335. * Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
  336. */
  337. putResourcePolicy(params: RedshiftServerless.Types.PutResourcePolicyRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.PutResourcePolicyResponse) => void): Request<RedshiftServerless.Types.PutResourcePolicyResponse, AWSError>;
  338. /**
  339. * Creates or updates a resource policy. Currently, you can use policies to share snapshots across Amazon Web Services accounts.
  340. */
  341. putResourcePolicy(callback?: (err: AWSError, data: RedshiftServerless.Types.PutResourcePolicyResponse) => void): Request<RedshiftServerless.Types.PutResourcePolicyResponse, AWSError>;
  342. /**
  343. * Restore the data from a recovery point.
  344. */
  345. restoreFromRecoveryPoint(params: RedshiftServerless.Types.RestoreFromRecoveryPointRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreFromRecoveryPointResponse) => void): Request<RedshiftServerless.Types.RestoreFromRecoveryPointResponse, AWSError>;
  346. /**
  347. * Restore the data from a recovery point.
  348. */
  349. restoreFromRecoveryPoint(callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreFromRecoveryPointResponse) => void): Request<RedshiftServerless.Types.RestoreFromRecoveryPointResponse, AWSError>;
  350. /**
  351. * Restores a namespace from a snapshot.
  352. */
  353. restoreFromSnapshot(params: RedshiftServerless.Types.RestoreFromSnapshotRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreFromSnapshotResponse) => void): Request<RedshiftServerless.Types.RestoreFromSnapshotResponse, AWSError>;
  354. /**
  355. * Restores a namespace from a snapshot.
  356. */
  357. restoreFromSnapshot(callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreFromSnapshotResponse) => void): Request<RedshiftServerless.Types.RestoreFromSnapshotResponse, AWSError>;
  358. /**
  359. * Restores a table from a recovery point to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.
  360. */
  361. restoreTableFromRecoveryPoint(params: RedshiftServerless.Types.RestoreTableFromRecoveryPointRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreTableFromRecoveryPointResponse) => void): Request<RedshiftServerless.Types.RestoreTableFromRecoveryPointResponse, AWSError>;
  362. /**
  363. * Restores a table from a recovery point to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.
  364. */
  365. restoreTableFromRecoveryPoint(callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreTableFromRecoveryPointResponse) => void): Request<RedshiftServerless.Types.RestoreTableFromRecoveryPointResponse, AWSError>;
  366. /**
  367. * Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.
  368. */
  369. restoreTableFromSnapshot(params: RedshiftServerless.Types.RestoreTableFromSnapshotRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreTableFromSnapshotResponse) => void): Request<RedshiftServerless.Types.RestoreTableFromSnapshotResponse, AWSError>;
  370. /**
  371. * Restores a table from a snapshot to your Amazon Redshift Serverless instance. You can't use this operation to restore tables with interleaved sort keys.
  372. */
  373. restoreTableFromSnapshot(callback?: (err: AWSError, data: RedshiftServerless.Types.RestoreTableFromSnapshotResponse) => void): Request<RedshiftServerless.Types.RestoreTableFromSnapshotResponse, AWSError>;
  374. /**
  375. * Assigns one or more tags to a resource.
  376. */
  377. tagResource(params: RedshiftServerless.Types.TagResourceRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.TagResourceResponse) => void): Request<RedshiftServerless.Types.TagResourceResponse, AWSError>;
  378. /**
  379. * Assigns one or more tags to a resource.
  380. */
  381. tagResource(callback?: (err: AWSError, data: RedshiftServerless.Types.TagResourceResponse) => void): Request<RedshiftServerless.Types.TagResourceResponse, AWSError>;
  382. /**
  383. * Removes a tag or set of tags from a resource.
  384. */
  385. untagResource(params: RedshiftServerless.Types.UntagResourceRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UntagResourceResponse) => void): Request<RedshiftServerless.Types.UntagResourceResponse, AWSError>;
  386. /**
  387. * Removes a tag or set of tags from a resource.
  388. */
  389. untagResource(callback?: (err: AWSError, data: RedshiftServerless.Types.UntagResourceResponse) => void): Request<RedshiftServerless.Types.UntagResourceResponse, AWSError>;
  390. /**
  391. * Updates an Amazon Redshift Serverless certificate associated with a custom domain.
  392. */
  393. updateCustomDomainAssociation(params: RedshiftServerless.Types.UpdateCustomDomainAssociationRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.UpdateCustomDomainAssociationResponse, AWSError>;
  394. /**
  395. * Updates an Amazon Redshift Serverless certificate associated with a custom domain.
  396. */
  397. updateCustomDomainAssociation(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateCustomDomainAssociationResponse) => void): Request<RedshiftServerless.Types.UpdateCustomDomainAssociationResponse, AWSError>;
  398. /**
  399. * Updates an Amazon Redshift Serverless managed endpoint.
  400. */
  401. updateEndpointAccess(params: RedshiftServerless.Types.UpdateEndpointAccessRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateEndpointAccessResponse) => void): Request<RedshiftServerless.Types.UpdateEndpointAccessResponse, AWSError>;
  402. /**
  403. * Updates an Amazon Redshift Serverless managed endpoint.
  404. */
  405. updateEndpointAccess(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateEndpointAccessResponse) => void): Request<RedshiftServerless.Types.UpdateEndpointAccessResponse, AWSError>;
  406. /**
  407. * Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId and logExports in a single request.
  408. */
  409. updateNamespace(params: RedshiftServerless.Types.UpdateNamespaceRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateNamespaceResponse) => void): Request<RedshiftServerless.Types.UpdateNamespaceResponse, AWSError>;
  410. /**
  411. * Updates a namespace with the specified settings. Unless required, you can't update multiple parameters in one request. For example, you must specify both adminUsername and adminUserPassword to update either field, but you can't update both kmsKeyId and logExports in a single request.
  412. */
  413. updateNamespace(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateNamespaceResponse) => void): Request<RedshiftServerless.Types.UpdateNamespaceResponse, AWSError>;
  414. /**
  415. * Updates a scheduled action.
  416. */
  417. updateScheduledAction(params: RedshiftServerless.Types.UpdateScheduledActionRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateScheduledActionResponse) => void): Request<RedshiftServerless.Types.UpdateScheduledActionResponse, AWSError>;
  418. /**
  419. * Updates a scheduled action.
  420. */
  421. updateScheduledAction(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateScheduledActionResponse) => void): Request<RedshiftServerless.Types.UpdateScheduledActionResponse, AWSError>;
  422. /**
  423. * Updates a snapshot.
  424. */
  425. updateSnapshot(params: RedshiftServerless.Types.UpdateSnapshotRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateSnapshotResponse) => void): Request<RedshiftServerless.Types.UpdateSnapshotResponse, AWSError>;
  426. /**
  427. * Updates a snapshot.
  428. */
  429. updateSnapshot(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateSnapshotResponse) => void): Request<RedshiftServerless.Types.UpdateSnapshotResponse, AWSError>;
  430. /**
  431. * Updates a snapshot copy configuration.
  432. */
  433. updateSnapshotCopyConfiguration(params: RedshiftServerless.Types.UpdateSnapshotCopyConfigurationRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateSnapshotCopyConfigurationResponse) => void): Request<RedshiftServerless.Types.UpdateSnapshotCopyConfigurationResponse, AWSError>;
  434. /**
  435. * Updates a snapshot copy configuration.
  436. */
  437. updateSnapshotCopyConfiguration(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateSnapshotCopyConfigurationResponse) => void): Request<RedshiftServerless.Types.UpdateSnapshotCopyConfigurationResponse, AWSError>;
  438. /**
  439. * Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.
  440. */
  441. updateUsageLimit(params: RedshiftServerless.Types.UpdateUsageLimitRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateUsageLimitResponse) => void): Request<RedshiftServerless.Types.UpdateUsageLimitResponse, AWSError>;
  442. /**
  443. * Update a usage limit in Amazon Redshift Serverless. You can't update the usage type or period of a usage limit.
  444. */
  445. updateUsageLimit(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateUsageLimitResponse) => void): Request<RedshiftServerless.Types.UpdateUsageLimitResponse, AWSError>;
  446. /**
  447. * Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity or port in a single request, but you can't update both in the same request.
  448. */
  449. updateWorkgroup(params: RedshiftServerless.Types.UpdateWorkgroupRequest, callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateWorkgroupResponse) => void): Request<RedshiftServerless.Types.UpdateWorkgroupResponse, AWSError>;
  450. /**
  451. * Updates a workgroup with the specified configuration settings. You can't update multiple parameters in one request. For example, you can update baseCapacity or port in a single request, but you can't update both in the same request.
  452. */
  453. updateWorkgroup(callback?: (err: AWSError, data: RedshiftServerless.Types.UpdateWorkgroupResponse) => void): Request<RedshiftServerless.Types.UpdateWorkgroupResponse, AWSError>;
  454. }
  455. declare namespace RedshiftServerless {
  456. export type AccountIdList = String[];
  457. export type AmazonResourceName = string;
  458. export interface Association {
  459. /**
  460. * The custom domain name’s certificate Amazon resource name (ARN).
  461. */
  462. customDomainCertificateArn?: CustomDomainCertificateArnString;
  463. /**
  464. * The expiration time for the certificate.
  465. */
  466. customDomainCertificateExpiryTime?: SyntheticTimestamp_date_time;
  467. /**
  468. * The custom domain name associated with the workgroup.
  469. */
  470. customDomainName?: CustomDomainName;
  471. /**
  472. * The name of the workgroup associated with the database.
  473. */
  474. workgroupName?: WorkgroupName;
  475. }
  476. export type AssociationList = Association[];
  477. export type Boolean = boolean;
  478. export interface ConfigParameter {
  479. /**
  480. * The key of the parameter. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
  481. */
  482. parameterKey?: ParameterKey;
  483. /**
  484. * The value of the parameter to set.
  485. */
  486. parameterValue?: ParameterValue;
  487. }
  488. export type ConfigParameterList = ConfigParameter[];
  489. export interface ConvertRecoveryPointToSnapshotRequest {
  490. /**
  491. * The unique identifier of the recovery point.
  492. */
  493. recoveryPointId: String;
  494. /**
  495. * How long to retain the snapshot.
  496. */
  497. retentionPeriod?: Integer;
  498. /**
  499. * The name of the snapshot.
  500. */
  501. snapshotName: String;
  502. /**
  503. * An array of Tag objects to associate with the created snapshot.
  504. */
  505. tags?: TagList;
  506. }
  507. export interface ConvertRecoveryPointToSnapshotResponse {
  508. /**
  509. * The snapshot converted from the recovery point.
  510. */
  511. snapshot?: Snapshot;
  512. }
  513. export interface CreateCustomDomainAssociationRequest {
  514. /**
  515. * The custom domain name’s certificate Amazon resource name (ARN).
  516. */
  517. customDomainCertificateArn: CustomDomainCertificateArnString;
  518. /**
  519. * The custom domain name to associate with the workgroup.
  520. */
  521. customDomainName: CustomDomainName;
  522. /**
  523. * The name of the workgroup associated with the database.
  524. */
  525. workgroupName: WorkgroupName;
  526. }
  527. export interface CreateCustomDomainAssociationResponse {
  528. /**
  529. * The custom domain name’s certificate Amazon resource name (ARN).
  530. */
  531. customDomainCertificateArn?: CustomDomainCertificateArnString;
  532. /**
  533. * The expiration time for the certificate.
  534. */
  535. customDomainCertificateExpiryTime?: SyntheticTimestamp_date_time;
  536. /**
  537. * The custom domain name to associate with the workgroup.
  538. */
  539. customDomainName?: CustomDomainName;
  540. /**
  541. * The name of the workgroup associated with the database.
  542. */
  543. workgroupName?: WorkgroupName;
  544. }
  545. export interface CreateEndpointAccessRequest {
  546. /**
  547. * The name of the VPC endpoint. An endpoint name must contain 1-30 characters. Valid characters are A-Z, a-z, 0-9, and hyphen(-). The first character must be a letter. The name can't contain two consecutive hyphens or end with a hyphen.
  548. */
  549. endpointName: String;
  550. /**
  551. * The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
  552. */
  553. ownerAccount?: OwnerAccount;
  554. /**
  555. * The unique identifers of subnets from which Amazon Redshift Serverless chooses one to deploy a VPC endpoint.
  556. */
  557. subnetIds: SubnetIdList;
  558. /**
  559. * The unique identifiers of the security group that defines the ports, protocols, and sources for inbound traffic that you are authorizing into your endpoint.
  560. */
  561. vpcSecurityGroupIds?: VpcSecurityGroupIdList;
  562. /**
  563. * The name of the workgroup to associate with the VPC endpoint.
  564. */
  565. workgroupName: String;
  566. }
  567. export interface CreateEndpointAccessResponse {
  568. /**
  569. * The created VPC endpoint.
  570. */
  571. endpoint?: EndpointAccess;
  572. }
  573. export interface CreateNamespaceRequest {
  574. /**
  575. * The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.
  576. */
  577. adminPasswordSecretKmsKeyId?: KmsKeyId;
  578. /**
  579. * The password of the administrator for the first database created in the namespace. You can't use adminUserPassword if manageAdminPassword is true.
  580. */
  581. adminUserPassword?: DbPassword;
  582. /**
  583. * The username of the administrator for the first database created in the namespace.
  584. */
  585. adminUsername?: DbUser;
  586. /**
  587. * The name of the first database created in the namespace.
  588. */
  589. dbName?: String;
  590. /**
  591. * The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
  592. */
  593. defaultIamRoleArn?: String;
  594. /**
  595. * A list of IAM roles to associate with the namespace.
  596. */
  597. iamRoles?: IamRoleArnList;
  598. /**
  599. * The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
  600. */
  601. kmsKeyId?: String;
  602. /**
  603. * The types of logs the namespace can export. Available export types are userlog, connectionlog, and useractivitylog.
  604. */
  605. logExports?: LogExportList;
  606. /**
  607. * If true, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.
  608. */
  609. manageAdminPassword?: Boolean;
  610. /**
  611. * The name of the namespace.
  612. */
  613. namespaceName: NamespaceName;
  614. /**
  615. * The ARN for the Redshift application that integrates with IAM Identity Center.
  616. */
  617. redshiftIdcApplicationArn?: RedshiftIdcApplicationArn;
  618. /**
  619. * A list of tag instances.
  620. */
  621. tags?: TagList;
  622. }
  623. export interface CreateNamespaceResponse {
  624. /**
  625. * The created namespace object.
  626. */
  627. namespace?: Namespace;
  628. }
  629. export interface CreateScheduledActionRequest {
  630. /**
  631. * Indicates whether the schedule is enabled. If false, the scheduled action does not trigger. For more information about state of the scheduled action, see ScheduledAction.
  632. */
  633. enabled?: Boolean;
  634. /**
  635. * The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
  636. */
  637. endTime?: Timestamp;
  638. /**
  639. * The name of the namespace for which to create a scheduled action.
  640. */
  641. namespaceName: NamespaceName;
  642. /**
  643. * The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide
  644. */
  645. roleArn: IamRoleArn;
  646. /**
  647. * The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00. Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, "(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
  648. */
  649. schedule: Schedule;
  650. /**
  651. * The description of the scheduled action.
  652. */
  653. scheduledActionDescription?: String;
  654. /**
  655. * The name of the scheduled action.
  656. */
  657. scheduledActionName: ScheduledActionName;
  658. /**
  659. * The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
  660. */
  661. startTime?: Timestamp;
  662. targetAction: TargetAction;
  663. }
  664. export interface CreateScheduledActionResponse {
  665. /**
  666. * The returned ScheduledAction object that describes the properties of a scheduled action.
  667. */
  668. scheduledAction?: ScheduledActionResponse;
  669. }
  670. export interface CreateSnapshotCopyConfigurationRequest {
  671. /**
  672. * The KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
  673. */
  674. destinationKmsKeyId?: KmsKeyId;
  675. /**
  676. * The destination Amazon Web Services Region that you want to copy snapshots to.
  677. */
  678. destinationRegion: String;
  679. /**
  680. * The name of the namespace to copy snapshots from.
  681. */
  682. namespaceName: NamespaceName;
  683. /**
  684. * The retention period of the snapshots that you copy to the destination Amazon Web Services Region.
  685. */
  686. snapshotRetentionPeriod?: Integer;
  687. }
  688. export interface CreateSnapshotCopyConfigurationResponse {
  689. /**
  690. * The snapshot copy configuration object that is returned.
  691. */
  692. snapshotCopyConfiguration: SnapshotCopyConfiguration;
  693. }
  694. export interface CreateSnapshotRequest {
  695. /**
  696. * The namespace to create a snapshot for.
  697. */
  698. namespaceName: String;
  699. /**
  700. * How long to retain the created snapshot.
  701. */
  702. retentionPeriod?: Integer;
  703. /**
  704. * The name of the snapshot.
  705. */
  706. snapshotName: String;
  707. /**
  708. * An array of Tag objects to associate with the snapshot.
  709. */
  710. tags?: TagList;
  711. }
  712. export interface CreateSnapshotResponse {
  713. /**
  714. * The created snapshot object.
  715. */
  716. snapshot?: Snapshot;
  717. }
  718. export interface CreateSnapshotScheduleActionParameters {
  719. /**
  720. * The name of the namespace for which you want to configure a scheduled action to create a snapshot.
  721. */
  722. namespaceName: NamespaceName;
  723. /**
  724. * The retention period of the snapshot created by the scheduled action.
  725. */
  726. retentionPeriod?: Integer;
  727. /**
  728. * A string prefix that is attached to the name of the snapshot created by the scheduled action. The final name of the snapshot is the string prefix appended by the date and time of when the snapshot was created.
  729. */
  730. snapshotNamePrefix: SnapshotNamePrefix;
  731. /**
  732. * An array of Tag objects to associate with the snapshot.
  733. */
  734. tags?: TagList;
  735. }
  736. export interface CreateUsageLimitRequest {
  737. /**
  738. * The limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.
  739. */
  740. amount: Long;
  741. /**
  742. * The action that Amazon Redshift Serverless takes when the limit is reached. The default is log.
  743. */
  744. breachAction?: UsageLimitBreachAction;
  745. /**
  746. * The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
  747. */
  748. period?: UsageLimitPeriod;
  749. /**
  750. * The Amazon Resource Name (ARN) of the Amazon Redshift Serverless resource to create the usage limit for.
  751. */
  752. resourceArn: String;
  753. /**
  754. * The type of Amazon Redshift Serverless usage to create a usage limit for.
  755. */
  756. usageType: UsageLimitUsageType;
  757. }
  758. export interface CreateUsageLimitResponse {
  759. /**
  760. * The returned usage limit object.
  761. */
  762. usageLimit?: UsageLimit;
  763. }
  764. export interface CreateWorkgroupRequest {
  765. /**
  766. * The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
  767. */
  768. baseCapacity?: Integer;
  769. /**
  770. * An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
  771. */
  772. configParameters?: ConfigParameterList;
  773. /**
  774. * The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC instead of over the internet.
  775. */
  776. enhancedVpcRouting?: Boolean;
  777. /**
  778. * The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
  779. */
  780. maxCapacity?: Integer;
  781. /**
  782. * The name of the namespace to associate with the workgroup.
  783. */
  784. namespaceName: NamespaceName;
  785. /**
  786. * The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
  787. */
  788. port?: Integer;
  789. /**
  790. * A value that specifies whether the workgroup can be accessed from a public network.
  791. */
  792. publiclyAccessible?: Boolean;
  793. /**
  794. * An array of security group IDs to associate with the workgroup.
  795. */
  796. securityGroupIds?: SecurityGroupIdList;
  797. /**
  798. * An array of VPC subnet IDs to associate with the workgroup.
  799. */
  800. subnetIds?: SubnetIdList;
  801. /**
  802. * A array of tag instances.
  803. */
  804. tags?: TagList;
  805. /**
  806. * The name of the created workgroup.
  807. */
  808. workgroupName: WorkgroupName;
  809. }
  810. export interface CreateWorkgroupResponse {
  811. /**
  812. * The created workgroup object.
  813. */
  814. workgroup?: Workgroup;
  815. }
  816. export type CustomDomainCertificateArnString = string;
  817. export type CustomDomainName = string;
  818. export type DbName = string;
  819. export type DbPassword = string;
  820. export type DbUser = string;
  821. export interface DeleteCustomDomainAssociationRequest {
  822. /**
  823. * The custom domain name associated with the workgroup.
  824. */
  825. customDomainName: CustomDomainName;
  826. /**
  827. * The name of the workgroup associated with the database.
  828. */
  829. workgroupName: WorkgroupName;
  830. }
  831. export interface DeleteCustomDomainAssociationResponse {
  832. }
  833. export interface DeleteEndpointAccessRequest {
  834. /**
  835. * The name of the VPC endpoint to delete.
  836. */
  837. endpointName: String;
  838. }
  839. export interface DeleteEndpointAccessResponse {
  840. /**
  841. * The deleted VPC endpoint.
  842. */
  843. endpoint?: EndpointAccess;
  844. }
  845. export interface DeleteNamespaceRequest {
  846. /**
  847. * The name of the snapshot to be created before the namespace is deleted.
  848. */
  849. finalSnapshotName?: String;
  850. /**
  851. * How long to retain the final snapshot.
  852. */
  853. finalSnapshotRetentionPeriod?: Integer;
  854. /**
  855. * The name of the namespace to delete.
  856. */
  857. namespaceName: NamespaceName;
  858. }
  859. export interface DeleteNamespaceResponse {
  860. /**
  861. * The deleted namespace object.
  862. */
  863. namespace: Namespace;
  864. }
  865. export interface DeleteResourcePolicyRequest {
  866. /**
  867. * The Amazon Resource Name (ARN) of the policy to delete.
  868. */
  869. resourceArn: String;
  870. }
  871. export interface DeleteResourcePolicyResponse {
  872. }
  873. export interface DeleteScheduledActionRequest {
  874. /**
  875. * The name of the scheduled action to delete.
  876. */
  877. scheduledActionName: ScheduledActionName;
  878. }
  879. export interface DeleteScheduledActionResponse {
  880. /**
  881. * The deleted scheduled action object.
  882. */
  883. scheduledAction?: ScheduledActionResponse;
  884. }
  885. export interface DeleteSnapshotCopyConfigurationRequest {
  886. /**
  887. * The ID of the snapshot copy configuration to delete.
  888. */
  889. snapshotCopyConfigurationId: String;
  890. }
  891. export interface DeleteSnapshotCopyConfigurationResponse {
  892. /**
  893. * The deleted snapshot copy configuration object.
  894. */
  895. snapshotCopyConfiguration: SnapshotCopyConfiguration;
  896. }
  897. export interface DeleteSnapshotRequest {
  898. /**
  899. * The name of the snapshot to be deleted.
  900. */
  901. snapshotName: String;
  902. }
  903. export interface DeleteSnapshotResponse {
  904. /**
  905. * The deleted snapshot object.
  906. */
  907. snapshot?: Snapshot;
  908. }
  909. export interface DeleteUsageLimitRequest {
  910. /**
  911. * The unique identifier of the usage limit to delete.
  912. */
  913. usageLimitId: String;
  914. }
  915. export interface DeleteUsageLimitResponse {
  916. /**
  917. * The deleted usage limit object.
  918. */
  919. usageLimit?: UsageLimit;
  920. }
  921. export interface DeleteWorkgroupRequest {
  922. /**
  923. * The name of the workgroup to be deleted.
  924. */
  925. workgroupName: WorkgroupName;
  926. }
  927. export interface DeleteWorkgroupResponse {
  928. /**
  929. * The deleted workgroup object.
  930. */
  931. workgroup: Workgroup;
  932. }
  933. export type Double = number;
  934. export interface Endpoint {
  935. /**
  936. * The DNS address of the VPC endpoint.
  937. */
  938. address?: String;
  939. /**
  940. * The port that Amazon Redshift Serverless listens on.
  941. */
  942. port?: Integer;
  943. /**
  944. * An array of VpcEndpoint objects.
  945. */
  946. vpcEndpoints?: VpcEndpointList;
  947. }
  948. export interface EndpointAccess {
  949. /**
  950. * The DNS address of the endpoint.
  951. */
  952. address?: String;
  953. /**
  954. * The Amazon Resource Name (ARN) of the VPC endpoint.
  955. */
  956. endpointArn?: String;
  957. /**
  958. * The time that the endpoint was created.
  959. */
  960. endpointCreateTime?: SyntheticTimestamp_date_time;
  961. /**
  962. * The name of the VPC endpoint.
  963. */
  964. endpointName?: String;
  965. /**
  966. * The status of the VPC endpoint.
  967. */
  968. endpointStatus?: String;
  969. /**
  970. * The port number on which Amazon Redshift Serverless accepts incoming connections.
  971. */
  972. port?: Integer;
  973. /**
  974. * The unique identifier of subnets where Amazon Redshift Serverless choose to deploy the VPC endpoint.
  975. */
  976. subnetIds?: SubnetIdList;
  977. /**
  978. * The connection endpoint for connecting to Amazon Redshift Serverless.
  979. */
  980. vpcEndpoint?: VpcEndpoint;
  981. /**
  982. * The security groups associated with the endpoint.
  983. */
  984. vpcSecurityGroups?: VpcSecurityGroupMembershipList;
  985. /**
  986. * The name of the workgroup associated with the endpoint.
  987. */
  988. workgroupName?: String;
  989. }
  990. export type EndpointAccessList = EndpointAccess[];
  991. export interface GetCredentialsRequest {
  992. /**
  993. * The custom domain name associated with the workgroup. The custom domain name or the workgroup name must be included in the request.
  994. */
  995. customDomainName?: CustomDomainName;
  996. /**
  997. * The name of the database to get temporary authorization to log on to. Constraints: Must be 1 to 64 alphanumeric characters or hyphens. Must contain only uppercase or lowercase letters, numbers, underscore, plus sign, period (dot), at symbol (@), or hyphen. The first character must be a letter. Must not contain a colon ( : ) or slash ( / ). Cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide
  998. */
  999. dbName?: DbName;
  1000. /**
  1001. * The number of seconds until the returned temporary password expires. The minimum is 900 seconds, and the maximum is 3600 seconds.
  1002. */
  1003. durationSeconds?: Integer;
  1004. /**
  1005. * The name of the workgroup associated with the database.
  1006. */
  1007. workgroupName?: WorkgroupName;
  1008. }
  1009. export interface GetCredentialsResponse {
  1010. /**
  1011. * A temporary password that authorizes the user name returned by DbUser to log on to the database DbName.
  1012. */
  1013. dbPassword?: DbPassword;
  1014. /**
  1015. * A database user name that is authorized to log on to the database DbName using the password DbPassword. If the specified DbUser exists in the database, the new user name has the same database privileges as the the user named in DbUser. By default, the user is added to PUBLIC.
  1016. */
  1017. dbUser?: DbUser;
  1018. /**
  1019. * The date and time the password in DbPassword expires.
  1020. */
  1021. expiration?: Timestamp;
  1022. /**
  1023. * The date and time of when the DbUser and DbPassword authorization refreshes.
  1024. */
  1025. nextRefreshTime?: Timestamp;
  1026. }
  1027. export interface GetCustomDomainAssociationRequest {
  1028. /**
  1029. * The custom domain name associated with the workgroup.
  1030. */
  1031. customDomainName: CustomDomainName;
  1032. /**
  1033. * The name of the workgroup associated with the database.
  1034. */
  1035. workgroupName: WorkgroupName;
  1036. }
  1037. export interface GetCustomDomainAssociationResponse {
  1038. /**
  1039. * The custom domain name’s certificate Amazon resource name (ARN).
  1040. */
  1041. customDomainCertificateArn?: CustomDomainCertificateArnString;
  1042. /**
  1043. * The expiration time for the certificate.
  1044. */
  1045. customDomainCertificateExpiryTime?: SyntheticTimestamp_date_time;
  1046. /**
  1047. * The custom domain name associated with the workgroup.
  1048. */
  1049. customDomainName?: CustomDomainName;
  1050. /**
  1051. * The name of the workgroup associated with the database.
  1052. */
  1053. workgroupName?: WorkgroupName;
  1054. }
  1055. export interface GetEndpointAccessRequest {
  1056. /**
  1057. * The name of the VPC endpoint to return information for.
  1058. */
  1059. endpointName: String;
  1060. }
  1061. export interface GetEndpointAccessResponse {
  1062. /**
  1063. * The returned VPC endpoint.
  1064. */
  1065. endpoint?: EndpointAccess;
  1066. }
  1067. export interface GetNamespaceRequest {
  1068. /**
  1069. * The name of the namespace to retrieve information for.
  1070. */
  1071. namespaceName: NamespaceName;
  1072. }
  1073. export interface GetNamespaceResponse {
  1074. /**
  1075. * The returned namespace object.
  1076. */
  1077. namespace: Namespace;
  1078. }
  1079. export interface GetRecoveryPointRequest {
  1080. /**
  1081. * The unique identifier of the recovery point to return information for.
  1082. */
  1083. recoveryPointId: String;
  1084. }
  1085. export interface GetRecoveryPointResponse {
  1086. /**
  1087. * The returned recovery point object.
  1088. */
  1089. recoveryPoint?: RecoveryPoint;
  1090. }
  1091. export interface GetResourcePolicyRequest {
  1092. /**
  1093. * The Amazon Resource Name (ARN) of the resource to return.
  1094. */
  1095. resourceArn: String;
  1096. }
  1097. export interface GetResourcePolicyResponse {
  1098. /**
  1099. * The returned resource policy.
  1100. */
  1101. resourcePolicy?: ResourcePolicy;
  1102. }
  1103. export interface GetScheduledActionRequest {
  1104. /**
  1105. * The name of the scheduled action.
  1106. */
  1107. scheduledActionName: ScheduledActionName;
  1108. }
  1109. export interface GetScheduledActionResponse {
  1110. /**
  1111. * The returned scheduled action object.
  1112. */
  1113. scheduledAction?: ScheduledActionResponse;
  1114. }
  1115. export interface GetSnapshotRequest {
  1116. /**
  1117. * The owner Amazon Web Services account of a snapshot shared with another user.
  1118. */
  1119. ownerAccount?: String;
  1120. /**
  1121. * The Amazon Resource Name (ARN) of the snapshot to return.
  1122. */
  1123. snapshotArn?: String;
  1124. /**
  1125. * The name of the snapshot to return.
  1126. */
  1127. snapshotName?: String;
  1128. }
  1129. export interface GetSnapshotResponse {
  1130. /**
  1131. * The returned snapshot object.
  1132. */
  1133. snapshot?: Snapshot;
  1134. }
  1135. export interface GetTableRestoreStatusRequest {
  1136. /**
  1137. * The ID of the RestoreTableFromSnapshot request to return status for.
  1138. */
  1139. tableRestoreRequestId: String;
  1140. }
  1141. export interface GetTableRestoreStatusResponse {
  1142. /**
  1143. * The returned TableRestoreStatus object that contains information about the status of your RestoreTableFromSnapshot request.
  1144. */
  1145. tableRestoreStatus?: TableRestoreStatus;
  1146. }
  1147. export interface GetUsageLimitRequest {
  1148. /**
  1149. * The unique identifier of the usage limit to return information for.
  1150. */
  1151. usageLimitId: String;
  1152. }
  1153. export interface GetUsageLimitResponse {
  1154. /**
  1155. * The returned usage limit object.
  1156. */
  1157. usageLimit?: UsageLimit;
  1158. }
  1159. export interface GetWorkgroupRequest {
  1160. /**
  1161. * The name of the workgroup to return information for.
  1162. */
  1163. workgroupName: WorkgroupName;
  1164. }
  1165. export interface GetWorkgroupResponse {
  1166. /**
  1167. * The returned workgroup object.
  1168. */
  1169. workgroup: Workgroup;
  1170. }
  1171. export type IamRoleArn = string;
  1172. export type IamRoleArnList = IamRoleArn[];
  1173. export type Integer = number;
  1174. export type KmsKeyId = string;
  1175. export interface ListCustomDomainAssociationsRequest {
  1176. /**
  1177. * The custom domain name’s certificate Amazon resource name (ARN).
  1178. */
  1179. customDomainCertificateArn?: CustomDomainCertificateArnString;
  1180. /**
  1181. * The custom domain name associated with the workgroup.
  1182. */
  1183. customDomainName?: CustomDomainName;
  1184. /**
  1185. * An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
  1186. */
  1187. maxResults?: ListCustomDomainAssociationsRequestMaxResultsInteger;
  1188. /**
  1189. * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
  1190. */
  1191. nextToken?: PaginationToken;
  1192. }
  1193. export type ListCustomDomainAssociationsRequestMaxResultsInteger = number;
  1194. export interface ListCustomDomainAssociationsResponse {
  1195. /**
  1196. * A list of Association objects.
  1197. */
  1198. associations?: AssociationList;
  1199. /**
  1200. * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
  1201. */
  1202. nextToken?: PaginationToken;
  1203. }
  1204. export interface ListEndpointAccessRequest {
  1205. /**
  1206. * An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
  1207. */
  1208. maxResults?: ListEndpointAccessRequestMaxResultsInteger;
  1209. /**
  1210. * If your initial ListEndpointAccess operation returns a nextToken, you can include the returned nextToken in following ListEndpointAccess operations, which returns results in the next page.
  1211. */
  1212. nextToken?: String;
  1213. /**
  1214. * The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
  1215. */
  1216. ownerAccount?: OwnerAccount;
  1217. /**
  1218. * The unique identifier of the virtual private cloud with access to Amazon Redshift Serverless.
  1219. */
  1220. vpcId?: String;
  1221. /**
  1222. * The name of the workgroup associated with the VPC endpoint to return.
  1223. */
  1224. workgroupName?: String;
  1225. }
  1226. export type ListEndpointAccessRequestMaxResultsInteger = number;
  1227. export interface ListEndpointAccessResponse {
  1228. /**
  1229. * The returned VPC endpoints.
  1230. */
  1231. endpoints: EndpointAccessList;
  1232. /**
  1233. * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
  1234. */
  1235. nextToken?: String;
  1236. }
  1237. export interface ListNamespacesRequest {
  1238. /**
  1239. * An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
  1240. */
  1241. maxResults?: ListNamespacesRequestMaxResultsInteger;
  1242. /**
  1243. * If your initial ListNamespaces operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.
  1244. */
  1245. nextToken?: String;
  1246. }
  1247. export type ListNamespacesRequestMaxResultsInteger = number;
  1248. export interface ListNamespacesResponse {
  1249. /**
  1250. * The list of returned namespaces.
  1251. */
  1252. namespaces: NamespaceList;
  1253. /**
  1254. * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
  1255. */
  1256. nextToken?: String;
  1257. }
  1258. export interface ListRecoveryPointsRequest {
  1259. /**
  1260. * The time when creation of the recovery point finished.
  1261. */
  1262. endTime?: Timestamp;
  1263. /**
  1264. * An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
  1265. */
  1266. maxResults?: ListRecoveryPointsRequestMaxResultsInteger;
  1267. /**
  1268. * The Amazon Resource Name (ARN) of the namespace from which to list recovery points.
  1269. */
  1270. namespaceArn?: String;
  1271. /**
  1272. * The name of the namespace to list recovery points for.
  1273. */
  1274. namespaceName?: NamespaceName;
  1275. /**
  1276. * If your initial ListRecoveryPoints operation returns a nextToken, you can include the returned nextToken in following ListRecoveryPoints operations, which returns results in the next page.
  1277. */
  1278. nextToken?: String;
  1279. /**
  1280. * The time when the recovery point's creation was initiated.
  1281. */
  1282. startTime?: Timestamp;
  1283. }
  1284. export type ListRecoveryPointsRequestMaxResultsInteger = number;
  1285. export interface ListRecoveryPointsResponse {
  1286. /**
  1287. * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
  1288. */
  1289. nextToken?: String;
  1290. /**
  1291. * The returned recovery point objects.
  1292. */
  1293. recoveryPoints?: RecoveryPointList;
  1294. }
  1295. export interface ListScheduledActionsRequest {
  1296. /**
  1297. * An optional parameter that specifies the maximum number of results to return. Use nextToken to display the next page of results.
  1298. */
  1299. maxResults?: ListScheduledActionsRequestMaxResultsInteger;
  1300. /**
  1301. * The name of namespace associated with the scheduled action to retrieve.
  1302. */
  1303. namespaceName?: NamespaceName;
  1304. /**
  1305. * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
  1306. */
  1307. nextToken?: PaginationToken;
  1308. }
  1309. export type ListScheduledActionsRequestMaxResultsInteger = number;
  1310. export interface ListScheduledActionsResponse {
  1311. /**
  1312. * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
  1313. */
  1314. nextToken?: PaginationToken;
  1315. /**
  1316. * All of the returned scheduled action association objects.
  1317. */
  1318. scheduledActions?: ScheduledActionsList;
  1319. }
  1320. export interface ListSnapshotCopyConfigurationsRequest {
  1321. /**
  1322. * An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
  1323. */
  1324. maxResults?: ListSnapshotCopyConfigurationsRequestMaxResultsInteger;
  1325. /**
  1326. * The namespace from which to list all snapshot copy configurations.
  1327. */
  1328. namespaceName?: NamespaceName;
  1329. /**
  1330. * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
  1331. */
  1332. nextToken?: PaginationToken;
  1333. }
  1334. export type ListSnapshotCopyConfigurationsRequestMaxResultsInteger = number;
  1335. export interface ListSnapshotCopyConfigurationsResponse {
  1336. /**
  1337. * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
  1338. */
  1339. nextToken?: PaginationToken;
  1340. /**
  1341. * All of the returned snapshot copy configurations.
  1342. */
  1343. snapshotCopyConfigurations: SnapshotCopyConfigurations;
  1344. }
  1345. export interface ListSnapshotsRequest {
  1346. /**
  1347. * The timestamp showing when the snapshot creation finished.
  1348. */
  1349. endTime?: Timestamp;
  1350. /**
  1351. * An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
  1352. */
  1353. maxResults?: ListSnapshotsRequestMaxResultsInteger;
  1354. /**
  1355. * The Amazon Resource Name (ARN) of the namespace from which to list all snapshots.
  1356. */
  1357. namespaceArn?: String;
  1358. /**
  1359. * The namespace from which to list all snapshots.
  1360. */
  1361. namespaceName?: String;
  1362. /**
  1363. * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
  1364. */
  1365. nextToken?: String;
  1366. /**
  1367. * The owner Amazon Web Services account of the snapshot.
  1368. */
  1369. ownerAccount?: String;
  1370. /**
  1371. * The time when the creation of the snapshot was initiated.
  1372. */
  1373. startTime?: Timestamp;
  1374. }
  1375. export type ListSnapshotsRequestMaxResultsInteger = number;
  1376. export interface ListSnapshotsResponse {
  1377. /**
  1378. * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
  1379. */
  1380. nextToken?: String;
  1381. /**
  1382. * All of the returned snapshot objects.
  1383. */
  1384. snapshots?: SnapshotList;
  1385. }
  1386. export interface ListTableRestoreStatusRequest {
  1387. /**
  1388. * An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
  1389. */
  1390. maxResults?: ListTableRestoreStatusRequestMaxResultsInteger;
  1391. /**
  1392. * The namespace from which to list all of the statuses of RestoreTableFromSnapshot operations .
  1393. */
  1394. namespaceName?: String;
  1395. /**
  1396. * If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will return results on the next page.
  1397. */
  1398. nextToken?: PaginationToken;
  1399. /**
  1400. * The workgroup from which to list all of the statuses of RestoreTableFromSnapshot operations.
  1401. */
  1402. workgroupName?: String;
  1403. }
  1404. export type ListTableRestoreStatusRequestMaxResultsInteger = number;
  1405. export interface ListTableRestoreStatusResponse {
  1406. /**
  1407. * If your initial ListTableRestoreStatus operation returns a nextToken, you can include the returned nextToken in following ListTableRestoreStatus operations. This will returns results on the next page.
  1408. */
  1409. nextToken?: PaginationToken;
  1410. /**
  1411. * The array of returned TableRestoreStatus objects.
  1412. */
  1413. tableRestoreStatuses?: TableRestoreStatusList;
  1414. }
  1415. export interface ListTagsForResourceRequest {
  1416. /**
  1417. * The Amazon Resource Name (ARN) of the resource to list tags for.
  1418. */
  1419. resourceArn: AmazonResourceName;
  1420. }
  1421. export interface ListTagsForResourceResponse {
  1422. /**
  1423. * A map of the key-value pairs assigned to the resource.
  1424. */
  1425. tags?: TagList;
  1426. }
  1427. export interface ListUsageLimitsRequest {
  1428. /**
  1429. * An optional parameter that specifies the maximum number of results to return. You can use nextToken to get the next page of results. The default is 100.
  1430. */
  1431. maxResults?: ListUsageLimitsRequestMaxResultsInteger;
  1432. /**
  1433. * If your initial ListUsageLimits operation returns a nextToken, you can include the returned nextToken in following ListUsageLimits operations, which returns results in the next page.
  1434. */
  1435. nextToken?: PaginationToken;
  1436. /**
  1437. * The Amazon Resource Name (ARN) associated with the resource whose usage limits you want to list.
  1438. */
  1439. resourceArn?: String;
  1440. /**
  1441. * The Amazon Redshift Serverless feature whose limits you want to see.
  1442. */
  1443. usageType?: UsageLimitUsageType;
  1444. }
  1445. export type ListUsageLimitsRequestMaxResultsInteger = number;
  1446. export interface ListUsageLimitsResponse {
  1447. /**
  1448. * When nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. Make the call again using the returned token to retrieve the next page.
  1449. */
  1450. nextToken?: PaginationToken;
  1451. /**
  1452. * An array of returned usage limit objects.
  1453. */
  1454. usageLimits?: UsageLimits;
  1455. }
  1456. export interface ListWorkgroupsRequest {
  1457. /**
  1458. * An optional parameter that specifies the maximum number of results to return. You can use nextToken to display the next page of results.
  1459. */
  1460. maxResults?: ListWorkgroupsRequestMaxResultsInteger;
  1461. /**
  1462. * If your initial ListWorkgroups operation returns a nextToken, you can include the returned nextToken in following ListNamespaces operations, which returns results in the next page.
  1463. */
  1464. nextToken?: String;
  1465. /**
  1466. * The owner Amazon Web Services account for the Amazon Redshift Serverless workgroup.
  1467. */
  1468. ownerAccount?: OwnerAccount;
  1469. }
  1470. export type ListWorkgroupsRequestMaxResultsInteger = number;
  1471. export interface ListWorkgroupsResponse {
  1472. /**
  1473. * If nextToken is returned, there are more results available. The value of nextToken is a unique pagination token for each page. To retrieve the next page, make the call again using the returned token.
  1474. */
  1475. nextToken?: String;
  1476. /**
  1477. * The returned array of workgroups.
  1478. */
  1479. workgroups: WorkgroupList;
  1480. }
  1481. export type LogExport = "useractivitylog"|"userlog"|"connectionlog"|string;
  1482. export type LogExportList = LogExport[];
  1483. export type Long = number;
  1484. export interface Namespace {
  1485. /**
  1486. * The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
  1487. */
  1488. adminPasswordSecretArn?: String;
  1489. /**
  1490. * The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
  1491. */
  1492. adminPasswordSecretKmsKeyId?: KmsKeyId;
  1493. /**
  1494. * The username of the administrator for the first database created in the namespace.
  1495. */
  1496. adminUsername?: DbUser;
  1497. /**
  1498. * The date of when the namespace was created.
  1499. */
  1500. creationDate?: SyntheticTimestamp_date_time;
  1501. /**
  1502. * The name of the first database created in the namespace.
  1503. */
  1504. dbName?: String;
  1505. /**
  1506. * The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace.
  1507. */
  1508. defaultIamRoleArn?: String;
  1509. /**
  1510. * A list of IAM roles to associate with the namespace.
  1511. */
  1512. iamRoles?: IamRoleArnList;
  1513. /**
  1514. * The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
  1515. */
  1516. kmsKeyId?: String;
  1517. /**
  1518. * The types of logs the namespace can export. Available export types are User log, Connection log, and User activity log.
  1519. */
  1520. logExports?: LogExportList;
  1521. /**
  1522. * The Amazon Resource Name (ARN) associated with a namespace.
  1523. */
  1524. namespaceArn?: String;
  1525. /**
  1526. * The unique identifier of a namespace.
  1527. */
  1528. namespaceId?: String;
  1529. /**
  1530. * The name of the namespace. Must be between 3-64 alphanumeric characters in lowercase, and it cannot be a reserved word. A list of reserved words can be found in Reserved Words in the Amazon Redshift Database Developer Guide.
  1531. */
  1532. namespaceName?: NamespaceName;
  1533. /**
  1534. * The status of the namespace.
  1535. */
  1536. status?: NamespaceStatus;
  1537. }
  1538. export type NamespaceList = Namespace[];
  1539. export type NamespaceName = string;
  1540. export type NamespaceStatus = "AVAILABLE"|"MODIFYING"|"DELETING"|string;
  1541. export interface NetworkInterface {
  1542. /**
  1543. * The availability Zone.
  1544. */
  1545. availabilityZone?: String;
  1546. /**
  1547. * The unique identifier of the network interface.
  1548. */
  1549. networkInterfaceId?: String;
  1550. /**
  1551. * The IPv4 address of the network interface within the subnet.
  1552. */
  1553. privateIpAddress?: String;
  1554. /**
  1555. * The unique identifier of the subnet.
  1556. */
  1557. subnetId?: String;
  1558. }
  1559. export type NetworkInterfaceList = NetworkInterface[];
  1560. export type NextInvocationsList = Timestamp[];
  1561. export type OwnerAccount = string;
  1562. export type PaginationToken = string;
  1563. export type ParameterKey = string;
  1564. export type ParameterValue = string;
  1565. export interface PutResourcePolicyRequest {
  1566. /**
  1567. * The policy to create or update. For example, the following policy grants a user authorization to restore a snapshot. "{\"Version\": \"2012-10-17\", \"Statement\" : [{ \"Sid\": \"AllowUserRestoreFromSnapshot\", \"Principal\":{\"AWS\": [\"739247239426\"]}, \"Action\": [\"redshift-serverless:RestoreFromSnapshot\"] , \"Effect\": \"Allow\" }]}"
  1568. */
  1569. policy: String;
  1570. /**
  1571. * The Amazon Resource Name (ARN) of the account to create or update a resource policy for.
  1572. */
  1573. resourceArn: String;
  1574. }
  1575. export interface PutResourcePolicyResponse {
  1576. /**
  1577. * The policy that was created or updated.
  1578. */
  1579. resourcePolicy?: ResourcePolicy;
  1580. }
  1581. export interface RecoveryPoint {
  1582. /**
  1583. * The Amazon Resource Name (ARN) of the namespace the recovery point is associated with.
  1584. */
  1585. namespaceArn?: String;
  1586. /**
  1587. * The name of the namespace the recovery point is associated with.
  1588. */
  1589. namespaceName?: NamespaceName;
  1590. /**
  1591. * The time the recovery point is created.
  1592. */
  1593. recoveryPointCreateTime?: SyntheticTimestamp_date_time;
  1594. /**
  1595. * The unique identifier of the recovery point.
  1596. */
  1597. recoveryPointId?: String;
  1598. /**
  1599. * The total size of the data in the recovery point in megabytes.
  1600. */
  1601. totalSizeInMegaBytes?: Double;
  1602. /**
  1603. * The name of the workgroup the recovery point is associated with.
  1604. */
  1605. workgroupName?: WorkgroupName;
  1606. }
  1607. export type RecoveryPointList = RecoveryPoint[];
  1608. export type RedshiftIdcApplicationArn = string;
  1609. export interface ResourcePolicy {
  1610. /**
  1611. * The resource policy.
  1612. */
  1613. policy?: String;
  1614. /**
  1615. * The Amazon Resource Name (ARN) of the policy.
  1616. */
  1617. resourceArn?: String;
  1618. }
  1619. export interface RestoreFromRecoveryPointRequest {
  1620. /**
  1621. * The name of the namespace to restore data into.
  1622. */
  1623. namespaceName: NamespaceName;
  1624. /**
  1625. * The unique identifier of the recovery point to restore from.
  1626. */
  1627. recoveryPointId: String;
  1628. /**
  1629. * The name of the workgroup used to restore data.
  1630. */
  1631. workgroupName: WorkgroupName;
  1632. }
  1633. export interface RestoreFromRecoveryPointResponse {
  1634. /**
  1635. * The namespace that data was restored into.
  1636. */
  1637. namespace?: Namespace;
  1638. /**
  1639. * The unique identifier of the recovery point used for the restore.
  1640. */
  1641. recoveryPointId?: String;
  1642. }
  1643. export interface RestoreFromSnapshotRequest {
  1644. /**
  1645. * The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
  1646. */
  1647. adminPasswordSecretKmsKeyId?: KmsKeyId;
  1648. /**
  1649. * If true, Amazon Redshift uses Secrets Manager to manage the restored snapshot's admin credentials. If MmanageAdminPassword is false or not set, Amazon Redshift uses the admin credentials that the namespace or cluster had at the time the snapshot was taken.
  1650. */
  1651. manageAdminPassword?: Boolean;
  1652. /**
  1653. * The name of the namespace to restore the snapshot to.
  1654. */
  1655. namespaceName: NamespaceName;
  1656. /**
  1657. * The Amazon Web Services account that owns the snapshot.
  1658. */
  1659. ownerAccount?: String;
  1660. /**
  1661. * The Amazon Resource Name (ARN) of the snapshot to restore from. Required if restoring from Amazon Redshift Serverless to a provisioned cluster. Must not be specified at the same time as snapshotName. The format of the ARN is arn:aws:redshift:&lt;region&gt;:&lt;account_id&gt;:snapshot:&lt;cluster_identifier&gt;/&lt;snapshot_identifier&gt;.
  1662. */
  1663. snapshotArn?: String;
  1664. /**
  1665. * The name of the snapshot to restore from. Must not be specified at the same time as snapshotArn.
  1666. */
  1667. snapshotName?: String;
  1668. /**
  1669. * The name of the workgroup used to restore the snapshot.
  1670. */
  1671. workgroupName: WorkgroupName;
  1672. }
  1673. export interface RestoreFromSnapshotResponse {
  1674. namespace?: Namespace;
  1675. /**
  1676. * The owner Amazon Web Services; account of the snapshot that was restored.
  1677. */
  1678. ownerAccount?: String;
  1679. /**
  1680. * The name of the snapshot used to restore the namespace.
  1681. */
  1682. snapshotName?: String;
  1683. }
  1684. export interface RestoreTableFromRecoveryPointRequest {
  1685. /**
  1686. * Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.
  1687. */
  1688. activateCaseSensitiveIdentifier?: Boolean;
  1689. /**
  1690. * Namespace of the recovery point to restore from.
  1691. */
  1692. namespaceName: String;
  1693. /**
  1694. * The name of the table to create from the restore operation.
  1695. */
  1696. newTableName: String;
  1697. /**
  1698. * The ID of the recovery point to restore the table from.
  1699. */
  1700. recoveryPointId: String;
  1701. /**
  1702. * The name of the source database that contains the table being restored.
  1703. */
  1704. sourceDatabaseName: String;
  1705. /**
  1706. * The name of the source schema that contains the table being restored.
  1707. */
  1708. sourceSchemaName?: String;
  1709. /**
  1710. * The name of the source table being restored.
  1711. */
  1712. sourceTableName: String;
  1713. /**
  1714. * The name of the database to restore the table to.
  1715. */
  1716. targetDatabaseName?: String;
  1717. /**
  1718. * The name of the schema to restore the table to.
  1719. */
  1720. targetSchemaName?: String;
  1721. /**
  1722. * The workgroup to restore the table to.
  1723. */
  1724. workgroupName: String;
  1725. }
  1726. export interface RestoreTableFromRecoveryPointResponse {
  1727. tableRestoreStatus?: TableRestoreStatus;
  1728. }
  1729. export interface RestoreTableFromSnapshotRequest {
  1730. /**
  1731. * Indicates whether name identifiers for database, schema, and table are case sensitive. If true, the names are case sensitive. If false, the names are not case sensitive. The default is false.
  1732. */
  1733. activateCaseSensitiveIdentifier?: Boolean;
  1734. /**
  1735. * The namespace of the snapshot to restore from.
  1736. */
  1737. namespaceName: String;
  1738. /**
  1739. * The name of the table to create from the restore operation.
  1740. */
  1741. newTableName: String;
  1742. /**
  1743. * The name of the snapshot to restore the table from.
  1744. */
  1745. snapshotName: String;
  1746. /**
  1747. * The name of the source database that contains the table being restored.
  1748. */
  1749. sourceDatabaseName: String;
  1750. /**
  1751. * The name of the source schema that contains the table being restored.
  1752. */
  1753. sourceSchemaName?: String;
  1754. /**
  1755. * The name of the source table being restored.
  1756. */
  1757. sourceTableName: String;
  1758. /**
  1759. * The name of the database to restore the table to.
  1760. */
  1761. targetDatabaseName?: String;
  1762. /**
  1763. * The name of the schema to restore the table to.
  1764. */
  1765. targetSchemaName?: String;
  1766. /**
  1767. * The workgroup to restore the table to.
  1768. */
  1769. workgroupName: String;
  1770. }
  1771. export interface RestoreTableFromSnapshotResponse {
  1772. /**
  1773. * The TableRestoreStatus object that contains the status of the restore operation.
  1774. */
  1775. tableRestoreStatus?: TableRestoreStatus;
  1776. }
  1777. export interface Schedule {
  1778. /**
  1779. * The timestamp of when Amazon Redshift Serverless should run the scheduled action. Timestamp is in UTC. Format of at expression is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00.
  1780. */
  1781. at?: Timestamp;
  1782. /**
  1783. * The cron expression to use to schedule a recurring scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. Format of cron expressions is (Minutes Hours Day-of-month Month Day-of-week Year). For example, "(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
  1784. */
  1785. cron?: String;
  1786. }
  1787. export interface ScheduledActionAssociation {
  1788. /**
  1789. * Name of associated Amazon Redshift Serverless namespace.
  1790. */
  1791. namespaceName?: NamespaceName;
  1792. /**
  1793. * Name of associated scheduled action.
  1794. */
  1795. scheduledActionName?: ScheduledActionName;
  1796. }
  1797. export type ScheduledActionName = string;
  1798. export interface ScheduledActionResponse {
  1799. /**
  1800. * The end time of
  1801. */
  1802. endTime?: Timestamp;
  1803. /**
  1804. * The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.
  1805. */
  1806. namespaceName?: NamespaceName;
  1807. /**
  1808. * An array of timestamps of when the next scheduled actions will trigger.
  1809. */
  1810. nextInvocations?: NextInvocationsList;
  1811. /**
  1812. * The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots. (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide
  1813. */
  1814. roleArn?: IamRoleArn;
  1815. /**
  1816. * The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00. Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, "(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
  1817. */
  1818. schedule?: Schedule;
  1819. /**
  1820. * The description of the scheduled action.
  1821. */
  1822. scheduledActionDescription?: String;
  1823. /**
  1824. * The name of the scheduled action.
  1825. */
  1826. scheduledActionName?: ScheduledActionName;
  1827. /**
  1828. * The uuid of the scheduled action.
  1829. */
  1830. scheduledActionUuid?: String;
  1831. /**
  1832. * The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.
  1833. */
  1834. startTime?: Timestamp;
  1835. /**
  1836. * The state of the scheduled action.
  1837. */
  1838. state?: State;
  1839. targetAction?: TargetAction;
  1840. }
  1841. export type ScheduledActionsList = ScheduledActionAssociation[];
  1842. export type SecurityGroupId = string;
  1843. export type SecurityGroupIdList = SecurityGroupId[];
  1844. export interface Snapshot {
  1845. /**
  1846. * All of the Amazon Web Services accounts that have access to restore a snapshot to a provisioned cluster.
  1847. */
  1848. accountsWithProvisionedRestoreAccess?: AccountIdList;
  1849. /**
  1850. * All of the Amazon Web Services accounts that have access to restore a snapshot to a namespace.
  1851. */
  1852. accountsWithRestoreAccess?: AccountIdList;
  1853. /**
  1854. * The size of the incremental backup in megabytes.
  1855. */
  1856. actualIncrementalBackupSizeInMegaBytes?: Double;
  1857. /**
  1858. * The Amazon Resource Name (ARN) for the namespace's admin user credentials secret.
  1859. */
  1860. adminPasswordSecretArn?: String;
  1861. /**
  1862. * The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret.
  1863. */
  1864. adminPasswordSecretKmsKeyId?: KmsKeyId;
  1865. /**
  1866. * The username of the database within a snapshot.
  1867. */
  1868. adminUsername?: String;
  1869. /**
  1870. * The size in megabytes of the data that has been backed up to a snapshot.
  1871. */
  1872. backupProgressInMegaBytes?: Double;
  1873. /**
  1874. * The rate at which data is backed up into a snapshot in megabytes per second.
  1875. */
  1876. currentBackupRateInMegaBytesPerSecond?: Double;
  1877. /**
  1878. * The amount of time it took to back up data into a snapshot.
  1879. */
  1880. elapsedTimeInSeconds?: Long;
  1881. /**
  1882. * The estimated amount of seconds until the snapshot completes backup.
  1883. */
  1884. estimatedSecondsToCompletion?: Long;
  1885. /**
  1886. * The unique identifier of the KMS key used to encrypt the snapshot.
  1887. */
  1888. kmsKeyId?: KmsKeyId;
  1889. /**
  1890. * The Amazon Resource Name (ARN) of the namespace the snapshot was created from.
  1891. */
  1892. namespaceArn?: String;
  1893. /**
  1894. * The name of the namepsace.
  1895. */
  1896. namespaceName?: String;
  1897. /**
  1898. * The owner Amazon Web Services; account of the snapshot.
  1899. */
  1900. ownerAccount?: String;
  1901. /**
  1902. * The Amazon Resource Name (ARN) of the snapshot.
  1903. */
  1904. snapshotArn?: String;
  1905. /**
  1906. * The timestamp of when the snapshot was created.
  1907. */
  1908. snapshotCreateTime?: SyntheticTimestamp_date_time;
  1909. /**
  1910. * The name of the snapshot.
  1911. */
  1912. snapshotName?: String;
  1913. /**
  1914. * The amount of days until the snapshot is deleted.
  1915. */
  1916. snapshotRemainingDays?: Integer;
  1917. /**
  1918. * The period of time, in days, of how long the snapshot is retained.
  1919. */
  1920. snapshotRetentionPeriod?: Integer;
  1921. /**
  1922. * The timestamp of when data within the snapshot started getting retained.
  1923. */
  1924. snapshotRetentionStartTime?: SyntheticTimestamp_date_time;
  1925. /**
  1926. * The status of the snapshot.
  1927. */
  1928. status?: SnapshotStatus;
  1929. /**
  1930. * The total size, in megabytes, of how big the snapshot is.
  1931. */
  1932. totalBackupSizeInMegaBytes?: Double;
  1933. }
  1934. export interface SnapshotCopyConfiguration {
  1935. /**
  1936. * The ID of the KMS key to use to encrypt your snapshots in the destination Amazon Web Services Region.
  1937. */
  1938. destinationKmsKeyId?: KmsKeyId;
  1939. /**
  1940. * The destination Amazon Web Services Region to copy snapshots to.
  1941. */
  1942. destinationRegion?: String;
  1943. /**
  1944. * The name of the namespace to copy snapshots from in the source Amazon Web Services Region.
  1945. */
  1946. namespaceName?: NamespaceName;
  1947. /**
  1948. * The ARN of the snapshot copy configuration object.
  1949. */
  1950. snapshotCopyConfigurationArn?: String;
  1951. /**
  1952. * The ID of the snapshot copy configuration object.
  1953. */
  1954. snapshotCopyConfigurationId?: String;
  1955. /**
  1956. * The retention period of snapshots that are copied to the destination Amazon Web Services Region.
  1957. */
  1958. snapshotRetentionPeriod?: Integer;
  1959. }
  1960. export type SnapshotCopyConfigurations = SnapshotCopyConfiguration[];
  1961. export type SnapshotList = Snapshot[];
  1962. export type SnapshotNamePrefix = string;
  1963. export type SnapshotStatus = "AVAILABLE"|"CREATING"|"DELETED"|"CANCELLED"|"FAILED"|"COPYING"|string;
  1964. export type State = "ACTIVE"|"DISABLED"|string;
  1965. export type String = string;
  1966. export type SubnetId = string;
  1967. export type SubnetIdList = SubnetId[];
  1968. export type SyntheticTimestamp_date_time = Date;
  1969. export interface TableRestoreStatus {
  1970. /**
  1971. * A message that explains the returned status. For example, if the status of the operation is FAILED, the message explains why the operation failed.
  1972. */
  1973. message?: String;
  1974. /**
  1975. * The namespace of the table being restored from.
  1976. */
  1977. namespaceName?: String;
  1978. /**
  1979. * The name of the table to create from the restore operation.
  1980. */
  1981. newTableName?: String;
  1982. /**
  1983. * The amount of data restored to the new table so far, in megabytes (MB).
  1984. */
  1985. progressInMegaBytes?: Long;
  1986. /**
  1987. * The ID of the recovery point being restored from.
  1988. */
  1989. recoveryPointId?: String;
  1990. /**
  1991. * The time that the table restore request was made, in Universal Coordinated Time (UTC).
  1992. */
  1993. requestTime?: Timestamp;
  1994. /**
  1995. * The name of the snapshot being restored from.
  1996. */
  1997. snapshotName?: String;
  1998. /**
  1999. * The name of the source database being restored from.
  2000. */
  2001. sourceDatabaseName?: String;
  2002. /**
  2003. * The name of the source schema being restored from.
  2004. */
  2005. sourceSchemaName?: String;
  2006. /**
  2007. * The name of the source table being restored from.
  2008. */
  2009. sourceTableName?: String;
  2010. /**
  2011. * A value that describes the current state of the table restore request. Possible values are SUCCEEDED, FAILED, CANCELED, PENDING, and IN_PROGRESS.
  2012. */
  2013. status?: String;
  2014. /**
  2015. * The ID of the RestoreTableFromSnapshot request.
  2016. */
  2017. tableRestoreRequestId?: String;
  2018. /**
  2019. * The name of the database to restore to.
  2020. */
  2021. targetDatabaseName?: String;
  2022. /**
  2023. * The name of the schema to restore to.
  2024. */
  2025. targetSchemaName?: String;
  2026. /**
  2027. * The total amount of data to restore to the new table, in megabytes (MB).
  2028. */
  2029. totalDataInMegaBytes?: Long;
  2030. /**
  2031. * The name of the workgroup being restored from.
  2032. */
  2033. workgroupName?: String;
  2034. }
  2035. export type TableRestoreStatusList = TableRestoreStatus[];
  2036. export interface Tag {
  2037. /**
  2038. * The key to use in the tag.
  2039. */
  2040. key: TagKey;
  2041. /**
  2042. * The value of the tag.
  2043. */
  2044. value: TagValue;
  2045. }
  2046. export type TagKey = string;
  2047. export type TagKeyList = TagKey[];
  2048. export type TagList = Tag[];
  2049. export interface TagResourceRequest {
  2050. /**
  2051. * The Amazon Resource Name (ARN) of the resource to tag.
  2052. */
  2053. resourceArn: AmazonResourceName;
  2054. /**
  2055. * The map of the key-value pairs used to tag the resource.
  2056. */
  2057. tags: TagList;
  2058. }
  2059. export interface TagResourceResponse {
  2060. }
  2061. export type TagValue = string;
  2062. export interface TargetAction {
  2063. createSnapshot?: CreateSnapshotScheduleActionParameters;
  2064. }
  2065. export type Timestamp = Date;
  2066. export interface UntagResourceRequest {
  2067. /**
  2068. * The Amazon Resource Name (ARN) of the resource to remove tags from.
  2069. */
  2070. resourceArn: AmazonResourceName;
  2071. /**
  2072. * The tag or set of tags to remove from the resource.
  2073. */
  2074. tagKeys: TagKeyList;
  2075. }
  2076. export interface UntagResourceResponse {
  2077. }
  2078. export interface UpdateCustomDomainAssociationRequest {
  2079. /**
  2080. * The custom domain name’s certificate Amazon resource name (ARN). This is optional.
  2081. */
  2082. customDomainCertificateArn: CustomDomainCertificateArnString;
  2083. /**
  2084. * The custom domain name associated with the workgroup.
  2085. */
  2086. customDomainName: CustomDomainName;
  2087. /**
  2088. * The name of the workgroup associated with the database.
  2089. */
  2090. workgroupName: WorkgroupName;
  2091. }
  2092. export interface UpdateCustomDomainAssociationResponse {
  2093. /**
  2094. * The custom domain name’s certificate Amazon resource name (ARN).
  2095. */
  2096. customDomainCertificateArn?: CustomDomainCertificateArnString;
  2097. /**
  2098. * The expiration time for the certificate.
  2099. */
  2100. customDomainCertificateExpiryTime?: SyntheticTimestamp_date_time;
  2101. /**
  2102. * The custom domain name associated with the workgroup.
  2103. */
  2104. customDomainName?: CustomDomainName;
  2105. /**
  2106. * The name of the workgroup associated with the database.
  2107. */
  2108. workgroupName?: WorkgroupName;
  2109. }
  2110. export interface UpdateEndpointAccessRequest {
  2111. /**
  2112. * The name of the VPC endpoint to update.
  2113. */
  2114. endpointName: String;
  2115. /**
  2116. * The list of VPC security groups associated with the endpoint after the endpoint is modified.
  2117. */
  2118. vpcSecurityGroupIds?: VpcSecurityGroupIdList;
  2119. }
  2120. export interface UpdateEndpointAccessResponse {
  2121. /**
  2122. * The updated VPC endpoint.
  2123. */
  2124. endpoint?: EndpointAccess;
  2125. }
  2126. export interface UpdateNamespaceRequest {
  2127. /**
  2128. * The ID of the Key Management Service (KMS) key used to encrypt and store the namespace's admin credentials secret. You can only use this parameter if manageAdminPassword is true.
  2129. */
  2130. adminPasswordSecretKmsKeyId?: KmsKeyId;
  2131. /**
  2132. * The password of the administrator for the first database created in the namespace. This parameter must be updated together with adminUsername. You can't use adminUserPassword if manageAdminPassword is true.
  2133. */
  2134. adminUserPassword?: DbPassword;
  2135. /**
  2136. * The username of the administrator for the first database created in the namespace. This parameter must be updated together with adminUserPassword.
  2137. */
  2138. adminUsername?: DbUser;
  2139. /**
  2140. * The Amazon Resource Name (ARN) of the IAM role to set as a default in the namespace. This parameter must be updated together with iamRoles.
  2141. */
  2142. defaultIamRoleArn?: String;
  2143. /**
  2144. * A list of IAM roles to associate with the namespace. This parameter must be updated together with defaultIamRoleArn.
  2145. */
  2146. iamRoles?: IamRoleArnList;
  2147. /**
  2148. * The ID of the Amazon Web Services Key Management Service key used to encrypt your data.
  2149. */
  2150. kmsKeyId?: String;
  2151. /**
  2152. * The types of logs the namespace can export. The export types are userlog, connectionlog, and useractivitylog.
  2153. */
  2154. logExports?: LogExportList;
  2155. /**
  2156. * If true, Amazon Redshift uses Secrets Manager to manage the namespace's admin credentials. You can't use adminUserPassword if manageAdminPassword is true. If manageAdminPassword is false or not set, Amazon Redshift uses adminUserPassword for the admin user account's password.
  2157. */
  2158. manageAdminPassword?: Boolean;
  2159. /**
  2160. * The name of the namespace to update. You can't update the name of a namespace once it is created.
  2161. */
  2162. namespaceName: NamespaceName;
  2163. }
  2164. export interface UpdateNamespaceResponse {
  2165. /**
  2166. * A list of tag instances.
  2167. */
  2168. namespace: Namespace;
  2169. }
  2170. export interface UpdateScheduledActionRequest {
  2171. /**
  2172. * Specifies whether to enable the scheduled action.
  2173. */
  2174. enabled?: Boolean;
  2175. /**
  2176. * The end time in UTC of the scheduled action to update.
  2177. */
  2178. endTime?: Timestamp;
  2179. /**
  2180. * The ARN of the IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift Serverless API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler to schedule creating snapshots (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see Using Identity-Based Policies for Amazon Redshift in the Amazon Redshift Cluster Management Guide
  2181. */
  2182. roleArn?: IamRoleArn;
  2183. /**
  2184. * The schedule for a one-time (at timestamp format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour. Times are in UTC. Format of at timestamp is yyyy-mm-ddThh:mm:ss. For example, 2016-03-04T17:27:00. Format of cron expression is (Minutes Hours Day-of-month Month Day-of-week Year). For example, "(0 10 ? * MON *)". For more information, see Cron Expressions in the Amazon CloudWatch Events User Guide.
  2185. */
  2186. schedule?: Schedule;
  2187. /**
  2188. * The descripion of the scheduled action to update to.
  2189. */
  2190. scheduledActionDescription?: String;
  2191. /**
  2192. * The name of the scheduled action to update to.
  2193. */
  2194. scheduledActionName: ScheduledActionName;
  2195. /**
  2196. * The start time in UTC of the scheduled action to update to.
  2197. */
  2198. startTime?: Timestamp;
  2199. targetAction?: TargetAction;
  2200. }
  2201. export interface UpdateScheduledActionResponse {
  2202. /**
  2203. * The ScheduledAction object that was updated.
  2204. */
  2205. scheduledAction?: ScheduledActionResponse;
  2206. }
  2207. export interface UpdateSnapshotCopyConfigurationRequest {
  2208. /**
  2209. * The ID of the snapshot copy configuration to update.
  2210. */
  2211. snapshotCopyConfigurationId: String;
  2212. /**
  2213. * The new retention period of how long to keep a snapshot in the destination Amazon Web Services Region.
  2214. */
  2215. snapshotRetentionPeriod?: Integer;
  2216. }
  2217. export interface UpdateSnapshotCopyConfigurationResponse {
  2218. /**
  2219. * The updated snapshot copy configuration object.
  2220. */
  2221. snapshotCopyConfiguration: SnapshotCopyConfiguration;
  2222. }
  2223. export interface UpdateSnapshotRequest {
  2224. /**
  2225. * The new retention period of the snapshot.
  2226. */
  2227. retentionPeriod?: Integer;
  2228. /**
  2229. * The name of the snapshot.
  2230. */
  2231. snapshotName: String;
  2232. }
  2233. export interface UpdateSnapshotResponse {
  2234. /**
  2235. * The updated snapshot object.
  2236. */
  2237. snapshot?: Snapshot;
  2238. }
  2239. export interface UpdateUsageLimitRequest {
  2240. /**
  2241. * The new limit amount. If time-based, this amount is in Redshift Processing Units (RPU) consumed per hour. If data-based, this amount is in terabytes (TB) of data transferred between Regions in cross-account sharing. The value must be a positive number.
  2242. */
  2243. amount?: Long;
  2244. /**
  2245. * The new action that Amazon Redshift Serverless takes when the limit is reached.
  2246. */
  2247. breachAction?: UsageLimitBreachAction;
  2248. /**
  2249. * The identifier of the usage limit to update.
  2250. */
  2251. usageLimitId: String;
  2252. }
  2253. export interface UpdateUsageLimitResponse {
  2254. /**
  2255. * The updated usage limit object.
  2256. */
  2257. usageLimit?: UsageLimit;
  2258. }
  2259. export interface UpdateWorkgroupRequest {
  2260. /**
  2261. * The new base data warehouse capacity in Redshift Processing Units (RPUs).
  2262. */
  2263. baseCapacity?: Integer;
  2264. /**
  2265. * An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
  2266. */
  2267. configParameters?: ConfigParameterList;
  2268. /**
  2269. * The value that specifies whether to turn on enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
  2270. */
  2271. enhancedVpcRouting?: Boolean;
  2272. /**
  2273. * The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
  2274. */
  2275. maxCapacity?: Integer;
  2276. /**
  2277. * The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
  2278. */
  2279. port?: Integer;
  2280. /**
  2281. * A value that specifies whether the workgroup can be accessible from a public network.
  2282. */
  2283. publiclyAccessible?: Boolean;
  2284. /**
  2285. * An array of security group IDs to associate with the workgroup.
  2286. */
  2287. securityGroupIds?: SecurityGroupIdList;
  2288. /**
  2289. * An array of VPC subnet IDs to associate with the workgroup.
  2290. */
  2291. subnetIds?: SubnetIdList;
  2292. /**
  2293. * The name of the workgroup to update. You can't update the name of a workgroup once it is created.
  2294. */
  2295. workgroupName: WorkgroupName;
  2296. }
  2297. export interface UpdateWorkgroupResponse {
  2298. /**
  2299. * The updated workgroup object.
  2300. */
  2301. workgroup: Workgroup;
  2302. }
  2303. export interface UsageLimit {
  2304. /**
  2305. * The limit amount. If time-based, this amount is in RPUs consumed per hour. If data-based, this amount is in terabytes (TB). The value must be a positive number.
  2306. */
  2307. amount?: Long;
  2308. /**
  2309. * The action that Amazon Redshift Serverless takes when the limit is reached.
  2310. */
  2311. breachAction?: UsageLimitBreachAction;
  2312. /**
  2313. * The time period that the amount applies to. A weekly period begins on Sunday. The default is monthly.
  2314. */
  2315. period?: UsageLimitPeriod;
  2316. /**
  2317. * The Amazon Resource Name (ARN) that identifies the Amazon Redshift Serverless resource.
  2318. */
  2319. resourceArn?: String;
  2320. /**
  2321. * The Amazon Resource Name (ARN) of the resource associated with the usage limit.
  2322. */
  2323. usageLimitArn?: String;
  2324. /**
  2325. * The identifier of the usage limit.
  2326. */
  2327. usageLimitId?: String;
  2328. /**
  2329. * The Amazon Redshift Serverless feature to limit.
  2330. */
  2331. usageType?: UsageLimitUsageType;
  2332. }
  2333. export type UsageLimitBreachAction = "log"|"emit-metric"|"deactivate"|string;
  2334. export type UsageLimitPeriod = "daily"|"weekly"|"monthly"|string;
  2335. export type UsageLimitUsageType = "serverless-compute"|"cross-region-datasharing"|string;
  2336. export type UsageLimits = UsageLimit[];
  2337. export interface VpcEndpoint {
  2338. /**
  2339. * One or more network interfaces of the endpoint. Also known as an interface endpoint.
  2340. */
  2341. networkInterfaces?: NetworkInterfaceList;
  2342. /**
  2343. * The connection endpoint ID for connecting to Amazon Redshift Serverless.
  2344. */
  2345. vpcEndpointId?: String;
  2346. /**
  2347. * The VPC identifier that the endpoint is associated with.
  2348. */
  2349. vpcId?: String;
  2350. }
  2351. export type VpcEndpointList = VpcEndpoint[];
  2352. export type VpcIds = String[];
  2353. export type VpcSecurityGroupId = string;
  2354. export type VpcSecurityGroupIdList = VpcSecurityGroupId[];
  2355. export interface VpcSecurityGroupMembership {
  2356. /**
  2357. * The status of the VPC security group.
  2358. */
  2359. status?: String;
  2360. /**
  2361. * The unique identifier of the VPC security group.
  2362. */
  2363. vpcSecurityGroupId?: VpcSecurityGroupId;
  2364. }
  2365. export type VpcSecurityGroupMembershipList = VpcSecurityGroupMembership[];
  2366. export interface Workgroup {
  2367. /**
  2368. * The base data warehouse capacity of the workgroup in Redshift Processing Units (RPUs).
  2369. */
  2370. baseCapacity?: Integer;
  2371. /**
  2372. * An array of parameters to set for advanced control over a database. The options are auto_mv, datestyle, enable_case_sensitive_identifier, enable_user_activity_logging, query_group, search_path, require_ssl, use_fips_ssl, and query monitoring metrics that let you define performance boundaries. For more information about query monitoring rules and available metrics, see Query monitoring metrics for Amazon Redshift Serverless.
  2373. */
  2374. configParameters?: ConfigParameterList;
  2375. /**
  2376. * The creation date of the workgroup.
  2377. */
  2378. creationDate?: SyntheticTimestamp_date_time;
  2379. /**
  2380. * A list of VPCs. Each entry is the unique identifier of a virtual private cloud with access to Amazon Redshift Serverless. If all of the VPCs for the grantee are allowed, it shows an asterisk.
  2381. */
  2382. crossAccountVpcs?: VpcIds;
  2383. /**
  2384. * The custom domain name’s certificate Amazon resource name (ARN).
  2385. */
  2386. customDomainCertificateArn?: CustomDomainCertificateArnString;
  2387. /**
  2388. * The expiration time for the certificate.
  2389. */
  2390. customDomainCertificateExpiryTime?: SyntheticTimestamp_date_time;
  2391. /**
  2392. * The custom domain name associated with the workgroup.
  2393. */
  2394. customDomainName?: CustomDomainName;
  2395. /**
  2396. * The endpoint that is created from the workgroup.
  2397. */
  2398. endpoint?: Endpoint;
  2399. /**
  2400. * The value that specifies whether to enable enhanced virtual private cloud (VPC) routing, which forces Amazon Redshift Serverless to route traffic through your VPC.
  2401. */
  2402. enhancedVpcRouting?: Boolean;
  2403. /**
  2404. * The maximum data-warehouse capacity Amazon Redshift Serverless uses to serve queries. The max capacity is specified in RPUs.
  2405. */
  2406. maxCapacity?: Integer;
  2407. /**
  2408. * The namespace the workgroup is associated with.
  2409. */
  2410. namespaceName?: String;
  2411. /**
  2412. * The patch version of your Amazon Redshift Serverless workgroup. For more information about patch versions, see Cluster versions for Amazon Redshift.
  2413. */
  2414. patchVersion?: String;
  2415. /**
  2416. * The custom port to use when connecting to a workgroup. Valid port ranges are 5431-5455 and 8191-8215. The default is 5439.
  2417. */
  2418. port?: Integer;
  2419. /**
  2420. * A value that specifies whether the workgroup can be accessible from a public network.
  2421. */
  2422. publiclyAccessible?: Boolean;
  2423. /**
  2424. * An array of security group IDs to associate with the workgroup.
  2425. */
  2426. securityGroupIds?: SecurityGroupIdList;
  2427. /**
  2428. * The status of the workgroup.
  2429. */
  2430. status?: WorkgroupStatus;
  2431. /**
  2432. * An array of subnet IDs the workgroup is associated with.
  2433. */
  2434. subnetIds?: SubnetIdList;
  2435. /**
  2436. * The Amazon Resource Name (ARN) that links to the workgroup.
  2437. */
  2438. workgroupArn?: String;
  2439. /**
  2440. * The unique identifier of the workgroup.
  2441. */
  2442. workgroupId?: String;
  2443. /**
  2444. * The name of the workgroup.
  2445. */
  2446. workgroupName?: WorkgroupName;
  2447. /**
  2448. * The Amazon Redshift Serverless version of your workgroup. For more information about Amazon Redshift Serverless versions, seeCluster versions for Amazon Redshift.
  2449. */
  2450. workgroupVersion?: String;
  2451. }
  2452. export type WorkgroupList = Workgroup[];
  2453. export type WorkgroupName = string;
  2454. export type WorkgroupStatus = "CREATING"|"AVAILABLE"|"MODIFYING"|"DELETING"|string;
  2455. /**
  2456. * 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.
  2457. */
  2458. export type apiVersion = "2021-04-21"|"latest"|string;
  2459. export interface ClientApiVersions {
  2460. /**
  2461. * 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.
  2462. */
  2463. apiVersion?: apiVersion;
  2464. }
  2465. export type ClientConfiguration = ServiceConfigurationOptions & ClientApiVersions;
  2466. /**
  2467. * Contains interfaces for use with the RedshiftServerless client.
  2468. */
  2469. export import Types = RedshiftServerless;
  2470. }
  2471. export = RedshiftServerless;