@aws-sdk/client-rds 3.968.0 → 3.970.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (163) hide show
  1. package/README.md +1 -53
  2. package/dist-cjs/index.js +184 -178
  3. package/dist-es/pagination/DescribeEngineDefaultClusterParametersPaginator.js +4 -0
  4. package/dist-es/pagination/index.js +1 -0
  5. package/dist-es/schemas/schemas_0.js +161 -158
  6. package/dist-es/waiters/waitForDBClusterAvailable.js +2 -2
  7. package/dist-es/waiters/waitForDBClusterDeleted.js +2 -2
  8. package/dist-es/waiters/waitForDBClusterSnapshotAvailable.js +2 -2
  9. package/dist-es/waiters/waitForDBClusterSnapshotDeleted.js +2 -2
  10. package/dist-es/waiters/waitForDBInstanceAvailable.js +2 -2
  11. package/dist-es/waiters/waitForDBInstanceDeleted.js +2 -2
  12. package/dist-es/waiters/waitForDBSnapshotAvailable.js +2 -2
  13. package/dist-es/waiters/waitForDBSnapshotDeleted.js +2 -2
  14. package/dist-es/waiters/waitForTenantDatabaseAvailable.js +2 -2
  15. package/dist-es/waiters/waitForTenantDatabaseDeleted.js +2 -2
  16. package/dist-types/RDS.d.ts +1 -53
  17. package/dist-types/RDSClient.d.ts +1 -53
  18. package/dist-types/commands/AddRoleToDBClusterCommand.d.ts +1 -2
  19. package/dist-types/commands/AddRoleToDBInstanceCommand.d.ts +2 -7
  20. package/dist-types/commands/AddTagsToResourceCommand.d.ts +5 -13
  21. package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +3 -20
  22. package/dist-types/commands/BacktrackDBClusterCommand.d.ts +2 -10
  23. package/dist-types/commands/CancelExportTaskCommand.d.ts +1 -2
  24. package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +3 -10
  25. package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +3 -41
  26. package/dist-types/commands/CopyDBParameterGroupCommand.d.ts +3 -10
  27. package/dist-types/commands/CopyDBSnapshotCommand.d.ts +6 -17
  28. package/dist-types/commands/CreateBlueGreenDeploymentCommand.d.ts +133 -31
  29. package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +7 -7
  30. package/dist-types/commands/CreateDBClusterCommand.d.ts +13 -41
  31. package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +3 -8
  32. package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +2 -32
  33. package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +3 -10
  34. package/dist-types/commands/CreateDBInstanceCommand.d.ts +25 -50
  35. package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +26 -57
  36. package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +2 -11
  37. package/dist-types/commands/CreateDBProxyEndpointCommand.d.ts +1 -3
  38. package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +3 -13
  39. package/dist-types/commands/CreateDBShardGroupCommand.d.ts +3 -6
  40. package/dist-types/commands/CreateDBSnapshotCommand.d.ts +5 -9
  41. package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +3 -6
  42. package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +1 -24
  43. package/dist-types/commands/CreateGlobalClusterCommand.d.ts +3 -17
  44. package/dist-types/commands/CreateIntegrationCommand.d.ts +3 -7
  45. package/dist-types/commands/CreateOptionGroupCommand.d.ts +1 -2
  46. package/dist-types/commands/CreateTenantDatabaseCommand.d.ts +4 -8
  47. package/dist-types/commands/DeleteBlueGreenDeploymentCommand.d.ts +141 -10
  48. package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +5 -25
  49. package/dist-types/commands/DeleteDBClusterAutomatedBackupCommand.d.ts +2 -4
  50. package/dist-types/commands/DeleteDBClusterCommand.d.ts +4 -17
  51. package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts +1 -4
  52. package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +3 -13
  53. package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +2 -13
  54. package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +1 -2
  55. package/dist-types/commands/DeleteDBInstanceCommand.d.ts +5 -32
  56. package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts +2 -6
  57. package/dist-types/commands/DeleteDBProxyEndpointCommand.d.ts +1 -3
  58. package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +2 -11
  59. package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +3 -8
  60. package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +2 -6
  61. package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +1 -5
  62. package/dist-types/commands/DeleteIntegrationCommand.d.ts +1 -3
  63. package/dist-types/commands/DeleteTenantDatabaseCommand.d.ts +3 -8
  64. package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +1 -2
  65. package/dist-types/commands/DescribeBlueGreenDeploymentsCommand.d.ts +214 -8
  66. package/dist-types/commands/DescribeCertificatesCommand.d.ts +53 -9
  67. package/dist-types/commands/DescribeDBClusterAutomatedBackupsCommand.d.ts +1 -4
  68. package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +3 -11
  69. package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +2 -6
  70. package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +2 -12
  71. package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +2 -10
  72. package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +2 -10
  73. package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +2 -9
  74. package/dist-types/commands/DescribeDBClustersCommand.d.ts +2 -10
  75. package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +4 -4
  76. package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +1 -7
  77. package/dist-types/commands/DescribeDBInstancesCommand.d.ts +2 -6
  78. package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +2 -4
  79. package/dist-types/commands/DescribeDBParameterGroupsCommand.d.ts +2 -5
  80. package/dist-types/commands/DescribeDBParametersCommand.d.ts +1 -3
  81. package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +2 -11
  82. package/dist-types/commands/DescribeDBShardGroupsCommand.d.ts +1 -2
  83. package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +2 -10
  84. package/dist-types/commands/DescribeDBSnapshotTenantDatabasesCommand.d.ts +2 -8
  85. package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +2 -3
  86. package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +2 -5
  87. package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +1 -4
  88. package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +1 -7
  89. package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +1 -3
  90. package/dist-types/commands/DescribeEventsCommand.d.ts +1 -8
  91. package/dist-types/commands/DescribeExportTasksCommand.d.ts +1 -2
  92. package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +1 -6
  93. package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +1 -1
  94. package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +1 -6
  95. package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +1 -8
  96. package/dist-types/commands/DescribeTenantDatabasesCommand.d.ts +2 -4
  97. package/dist-types/commands/DescribeValidDBInstanceModificationsCommand.d.ts +2 -5
  98. package/dist-types/commands/DisableHttpEndpointCommand.d.ts +1 -7
  99. package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +3 -11
  100. package/dist-types/commands/EnableHttpEndpointCommand.d.ts +1 -11
  101. package/dist-types/commands/FailoverDBClusterCommand.d.ts +2 -21
  102. package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +2 -38
  103. package/dist-types/commands/ListTagsForResourceCommand.d.ts +5 -12
  104. package/dist-types/commands/ModifyActivityStreamCommand.d.ts +2 -7
  105. package/dist-types/commands/ModifyCertificatesCommand.d.ts +2 -28
  106. package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +3 -24
  107. package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +5 -15
  108. package/dist-types/commands/ModifyDBClusterCommand.d.ts +10 -30
  109. package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +2 -6
  110. package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +3 -24
  111. package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +2 -21
  112. package/dist-types/commands/ModifyDBInstanceCommand.d.ts +25 -45
  113. package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +3 -20
  114. package/dist-types/commands/ModifyDBShardGroupCommand.d.ts +1 -2
  115. package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +2 -19
  116. package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +3 -9
  117. package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +2 -4
  118. package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +1 -5
  119. package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +2 -9
  120. package/dist-types/commands/ModifyIntegrationCommand.d.ts +1 -3
  121. package/dist-types/commands/ModifyTenantDatabaseCommand.d.ts +3 -7
  122. package/dist-types/commands/PromoteReadReplicaCommand.d.ts +2 -20
  123. package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +1 -2
  124. package/dist-types/commands/RebootDBClusterCommand.d.ts +2 -13
  125. package/dist-types/commands/RebootDBInstanceCommand.d.ts +2 -12
  126. package/dist-types/commands/RebootDBShardGroupCommand.d.ts +1 -3
  127. package/dist-types/commands/RegisterDBProxyTargetsCommand.d.ts +3 -7
  128. package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +2 -8
  129. package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +2 -11
  130. package/dist-types/commands/RemoveRoleFromDBInstanceCommand.d.ts +2 -4
  131. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +5 -12
  132. package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +3 -22
  133. package/dist-types/commands/ResetDBParameterGroupCommand.d.ts +3 -14
  134. package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +10 -38
  135. package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +12 -44
  136. package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +12 -48
  137. package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +26 -60
  138. package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +23 -46
  139. package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +26 -55
  140. package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +3 -16
  141. package/dist-types/commands/StartActivityStreamCommand.d.ts +3 -12
  142. package/dist-types/commands/StartDBClusterCommand.d.ts +3 -13
  143. package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +4 -12
  144. package/dist-types/commands/StartDBInstanceCommand.d.ts +8 -27
  145. package/dist-types/commands/StartExportTaskCommand.d.ts +5 -21
  146. package/dist-types/commands/StopActivityStreamCommand.d.ts +3 -13
  147. package/dist-types/commands/StopDBClusterCommand.d.ts +2 -11
  148. package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +2 -7
  149. package/dist-types/commands/StopDBInstanceCommand.d.ts +4 -19
  150. package/dist-types/commands/SwitchoverBlueGreenDeploymentCommand.d.ts +139 -12
  151. package/dist-types/commands/SwitchoverGlobalClusterCommand.d.ts +2 -13
  152. package/dist-types/commands/SwitchoverReadReplicaCommand.d.ts +2 -4
  153. package/dist-types/index.d.ts +1 -53
  154. package/dist-types/models/errors.d.ts +53 -116
  155. package/dist-types/models/models_0.d.ts +982 -8429
  156. package/dist-types/models/models_1.d.ts +557 -4868
  157. package/dist-types/pagination/DescribeEngineDefaultClusterParametersPaginator.d.ts +7 -0
  158. package/dist-types/pagination/index.d.ts +1 -0
  159. package/dist-types/ts3.4/models/models_0.d.ts +7 -7
  160. package/dist-types/ts3.4/models/models_1.d.ts +4 -4
  161. package/dist-types/ts3.4/pagination/DescribeEngineDefaultClusterParametersPaginator.d.ts +11 -0
  162. package/dist-types/ts3.4/pagination/index.d.ts +1 -0
  163. package/package.json +35 -35
@@ -27,10 +27,7 @@ declare const DescribeDBInstancesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Describes provisioned RDS instances. This API supports pagination.</p>
31
- * <note>
32
- * <p>This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.</p>
33
- * </note>
30
+ * <p>Describes provisioned RDS instances. This API supports pagination.</p> <note> <p>This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.</p> </note>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -317,8 +314,7 @@ declare const DescribeDBInstancesCommand_base: {
317
314
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
318
315
  *
319
316
  * @throws {@link DBInstanceNotFoundFault} (client fault)
320
- * <p>
321
- * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
317
+ * <p> <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
322
318
  *
323
319
  * @throws {@link RDSServiceException}
324
320
  * <p>Base exception class for all service exceptions from RDS service.</p>
@@ -27,8 +27,7 @@ declare const DescribeDBLogFilesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of DB log files for the DB instance.</p>
31
- * <p>This command doesn't apply to RDS Custom.</p>
30
+ * <p>Returns a list of DB log files for the DB instance.</p> <p>This command doesn't apply to RDS Custom.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -75,8 +74,7 @@ declare const DescribeDBLogFilesCommand_base: {
75
74
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
76
75
  *
77
76
  * @throws {@link DBInstanceNotFoundFault} (client fault)
78
- * <p>
79
- * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
77
+ * <p> <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
80
78
  *
81
79
  * @throws {@link DBInstanceNotReadyFault} (client fault)
82
80
  * <p>An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused.</p>
@@ -27,8 +27,7 @@ declare const DescribeDBParameterGroupsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of <code>DBParameterGroup</code> descriptions. If a <code>DBParameterGroupName</code> is specified,
31
- * the list will contain only the description of the specified DB parameter group.</p>
30
+ * <p>Returns a list of <code>DBParameterGroup</code> descriptions. If a <code>DBParameterGroupName</code> is specified, the list will contain only the description of the specified DB parameter group.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -73,9 +72,7 @@ declare const DescribeDBParameterGroupsCommand_base: {
73
72
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
74
73
  *
75
74
  * @throws {@link DBParameterGroupNotFoundFault} (client fault)
76
- * <p>
77
- * <code>DBParameterGroupName</code> doesn't refer to an
78
- * existing DB parameter group.</p>
75
+ * <p> <code>DBParameterGroupName</code> doesn't refer to an existing DB parameter group.</p>
79
76
  *
80
77
  * @throws {@link RDSServiceException}
81
78
  * <p>Base exception class for all service exceptions from RDS service.</p>
@@ -82,9 +82,7 @@ declare const DescribeDBParametersCommand_base: {
82
82
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
83
83
  *
84
84
  * @throws {@link DBParameterGroupNotFoundFault} (client fault)
85
- * <p>
86
- * <code>DBParameterGroupName</code> doesn't refer to an
87
- * existing DB parameter group.</p>
85
+ * <p> <code>DBParameterGroupName</code> doesn't refer to an existing DB parameter group.</p>
88
86
  *
89
87
  * @throws {@link RDSServiceException}
90
88
  * <p>Base exception class for all service exceptions from RDS service.</p>
@@ -27,15 +27,7 @@ declare const DescribeDBSecurityGroupsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of <code>DBSecurityGroup</code> descriptions. If a <code>DBSecurityGroupName</code> is specified,
31
- * the list will contain only the descriptions of the specified DB security group.</p>
32
- * <note>
33
- * <p>EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that
34
- * you migrate as soon as possible. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html">Migrate from EC2-Classic to a VPC</a> in the
35
- * <i>Amazon EC2 User Guide</i>, the blog <a href="http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/">EC2-Classic Networking is Retiring –
36
- * Here’s How to Prepare</a>, and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html">Moving a DB instance not in a VPC
37
- * into a VPC</a> in the <i>Amazon RDS User Guide</i>.</p>
38
- * </note>
30
+ * <p>Returns a list of <code>DBSecurityGroup</code> descriptions. If a <code>DBSecurityGroupName</code> is specified, the list will contain only the descriptions of the specified DB security group.</p> <note> <p>EC2-Classic was retired on August 15, 2022. If you haven't migrated from EC2-Classic to a VPC, we recommend that you migrate as soon as possible. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/vpc-migrate.html">Migrate from EC2-Classic to a VPC</a> in the <i>Amazon EC2 User Guide</i>, the blog <a href="http://aws.amazon.com/blogs/aws/ec2-classic-is-retiring-heres-how-to-prepare/">EC2-Classic Networking is Retiring – Here’s How to Prepare</a>, and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_VPC.Non-VPC2VPC.html">Moving a DB instance not in a VPC into a VPC</a> in the <i>Amazon RDS User Guide</i>.</p> </note>
39
31
  * @example
40
32
  * Use a bare-bones client and the command you need to make an API call.
41
33
  * ```javascript
@@ -95,8 +87,7 @@ declare const DescribeDBSecurityGroupsCommand_base: {
95
87
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
96
88
  *
97
89
  * @throws {@link DBSecurityGroupNotFoundFault} (client fault)
98
- * <p>
99
- * <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group.</p>
90
+ * <p> <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group.</p>
100
91
  *
101
92
  * @throws {@link RDSServiceException}
102
93
  * <p>Base exception class for all service exceptions from RDS service.</p>
@@ -84,8 +84,7 @@ declare const DescribeDBShardGroupsCommand_base: {
84
84
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
85
85
  *
86
86
  * @throws {@link DBClusterNotFoundFault} (client fault)
87
- * <p>
88
- * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
87
+ * <p> <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
89
88
  *
90
89
  * @throws {@link DBShardGroupNotFoundFault} (client fault)
91
90
  * <p>The specified DB shard group name wasn't found.</p>
@@ -27,14 +27,7 @@ declare const DescribeDBSnapshotAttributesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of DB snapshot attribute names and values for a manual DB snapshot.</p>
31
- * <p>When sharing snapshots with other Amazon Web Services accounts, <code>DescribeDBSnapshotAttributes</code>
32
- * returns the <code>restore</code> attribute and a list of IDs for the Amazon Web Services accounts that are
33
- * authorized to copy or restore the manual DB snapshot. If <code>all</code> is included in the list of
34
- * values for the <code>restore</code> attribute, then the manual DB snapshot is public and
35
- * can be copied or restored by all Amazon Web Services accounts.</p>
36
- * <p>To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the
37
- * manual DB snapshot public or private, use the <code>ModifyDBSnapshotAttribute</code> API action.</p>
30
+ * <p>Returns a list of DB snapshot attribute names and values for a manual DB snapshot.</p> <p>When sharing snapshots with other Amazon Web Services accounts, <code>DescribeDBSnapshotAttributes</code> returns the <code>restore</code> attribute and a list of IDs for the Amazon Web Services accounts that are authorized to copy or restore the manual DB snapshot. If <code>all</code> is included in the list of values for the <code>restore</code> attribute, then the manual DB snapshot is public and can be copied or restored by all Amazon Web Services accounts.</p> <p>To add or remove access for an Amazon Web Services account to copy or restore a manual DB snapshot, or to make the manual DB snapshot public or private, use the <code>ModifyDBSnapshotAttribute</code> API action.</p>
38
31
  * @example
39
32
  * Use a bare-bones client and the command you need to make an API call.
40
33
  * ```javascript
@@ -71,8 +64,7 @@ declare const DescribeDBSnapshotAttributesCommand_base: {
71
64
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
72
65
  *
73
66
  * @throws {@link DBSnapshotNotFoundFault} (client fault)
74
- * <p>
75
- * <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
67
+ * <p> <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
76
68
  *
77
69
  * @throws {@link RDSServiceException}
78
70
  * <p>Base exception class for all service exceptions from RDS service.</p>
@@ -27,12 +27,7 @@ declare const DescribeDBSnapshotTenantDatabasesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Describes the tenant databases that exist in a DB snapshot. This command only applies
31
- * to RDS for Oracle DB instances in the multi-tenant configuration.</p>
32
- * <p>You can use this command to inspect the tenant databases within a snapshot before
33
- * restoring it. You can't directly interact with the tenant databases in a DB snapshot. If
34
- * you restore a snapshot that was taken from DB instance using the multi-tenant
35
- * configuration, you restore all its tenant databases.</p>
30
+ * <p>Describes the tenant databases that exist in a DB snapshot. This command only applies to RDS for Oracle DB instances in the multi-tenant configuration.</p> <p>You can use this command to inspect the tenant databases within a snapshot before restoring it. You can't directly interact with the tenant databases in a DB snapshot. If you restore a snapshot that was taken from DB instance using the multi-tenant configuration, you restore all its tenant databases.</p>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -94,8 +89,7 @@ declare const DescribeDBSnapshotTenantDatabasesCommand_base: {
94
89
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
95
90
  *
96
91
  * @throws {@link DBSnapshotNotFoundFault} (client fault)
97
- * <p>
98
- * <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
92
+ * <p> <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
99
93
  *
100
94
  * @throws {@link RDSServiceException}
101
95
  * <p>Base exception class for all service exceptions from RDS service.</p>
@@ -106,7 +106,6 @@ declare const DescribeDBSnapshotsCommand_base: {
106
106
  * // DBSystemId: "STRING_VALUE",
107
107
  * // MultiTenant: true || false,
108
108
  * // DedicatedLogVolume: true || false,
109
- * // SnapshotAvailabilityZone: "STRING_VALUE",
110
109
  * // AdditionalStorageVolumes: [ // AdditionalStorageVolumesList
111
110
  * // { // AdditionalStorageVolume
112
111
  * // VolumeName: "STRING_VALUE", // required
@@ -117,6 +116,7 @@ declare const DescribeDBSnapshotsCommand_base: {
117
116
  * // StorageType: "STRING_VALUE",
118
117
  * // },
119
118
  * // ],
119
+ * // SnapshotAvailabilityZone: "STRING_VALUE",
120
120
  * // },
121
121
  * // ],
122
122
  * // };
@@ -130,8 +130,7 @@ declare const DescribeDBSnapshotsCommand_base: {
130
130
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
131
131
  *
132
132
  * @throws {@link DBSnapshotNotFoundFault} (client fault)
133
- * <p>
134
- * <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
133
+ * <p> <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
135
134
  *
136
135
  * @throws {@link RDSServiceException}
137
136
  * <p>Base exception class for all service exceptions from RDS service.</p>
@@ -27,9 +27,7 @@ declare const DescribeDBSubnetGroupsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.</p>
31
- * <p>For an overview of CIDR ranges, go to the
32
- * <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Wikipedia Tutorial</a>.</p>
30
+ * <p>Returns a list of DBSubnetGroup descriptions. If a DBSubnetGroupName is specified, the list will contain only the descriptions of the specified DBSubnetGroup.</p> <p>For an overview of CIDR ranges, go to the <a href="http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing">Wikipedia Tutorial</a>.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -90,8 +88,7 @@ declare const DescribeDBSubnetGroupsCommand_base: {
90
88
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
91
89
  *
92
90
  * @throws {@link DBSubnetGroupNotFoundFault} (client fault)
93
- * <p>
94
- * <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>
91
+ * <p> <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>
95
92
  *
96
93
  * @throws {@link RDSServiceException}
97
94
  * <p>Base exception class for all service exceptions from RDS service.</p>
@@ -27,10 +27,7 @@ declare const DescribeEngineDefaultClusterParametersCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns the default engine and system parameter information for the cluster database engine.</p>
31
- * <p>For more information on Amazon Aurora, see
32
- * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
33
- * What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
30
+ * <p>Returns the default engine and system parameter information for the cluster database engine.</p> <p>For more information on Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
34
31
  * @example
35
32
  * Use a bare-bones client and the command you need to make an API call.
36
33
  * ```javascript
@@ -27,13 +27,7 @@ declare const DescribeEventCategoriesCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Displays a list of categories for all event source types, or, if specified, for a specified source type.
31
- * You can also see this list in the "Amazon RDS event categories and event messages" section of the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html">
32
- * <i>Amazon RDS User Guide</i>
33
- * </a> or the
34
- * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html">
35
- * <i>Amazon Aurora User Guide</i>
36
- * </a>.</p>
30
+ * <p>Displays a list of categories for all event source types, or, if specified, for a specified source type. You can also see this list in the "Amazon RDS event categories and event messages" section of the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_Events.Messages.html"> <i>Amazon RDS User Guide</i> </a> or the <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/USER_Events.Messages.html"> <i>Amazon Aurora User Guide</i> </a>.</p>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -27,9 +27,7 @@ declare const DescribeEventSubscriptionsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Lists all the subscription descriptions for a customer account. The description for a subscription includes
31
- * <code>SubscriptionName</code>, <code>SNSTopicARN</code>, <code>CustomerID</code>, <code>SourceType</code>, <code>SourceID</code>, <code>CreationTime</code>, and <code>Status</code>.</p>
32
- * <p>If you specify a <code>SubscriptionName</code>, lists the description for that subscription.</p>
30
+ * <p>Lists all the subscription descriptions for a customer account. The description for a subscription includes <code>SubscriptionName</code>, <code>SNSTopicARN</code>, <code>CustomerID</code>, <code>SourceType</code>, <code>SourceID</code>, <code>CreationTime</code>, and <code>Status</code>.</p> <p>If you specify a <code>SubscriptionName</code>, lists the description for that subscription.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -27,14 +27,7 @@ declare const DescribeEventsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days.
31
- * Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be
32
- * obtained by providing the name as a parameter.</p>
33
- * <p>For more information on working with events, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/working-with-events.html">Monitoring Amazon RDS events</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/working-with-events.html">Monitoring Amazon Aurora
34
- * events</a> in the <i>Amazon Aurora User Guide</i>.</p>
35
- * <note>
36
- * <p>By default, RDS returns events that were generated in the past hour.</p>
37
- * </note>
30
+ * <p>Returns events related to DB instances, DB clusters, DB parameter groups, DB security groups, DB snapshots, DB cluster snapshots, and RDS Proxies for the past 14 days. Events specific to a particular DB instance, DB cluster, DB parameter group, DB security group, DB snapshot, DB cluster snapshot group, or RDS Proxy can be obtained by providing the name as a parameter.</p> <p>For more information on working with events, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/working-with-events.html">Monitoring Amazon RDS events</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/working-with-events.html">Monitoring Amazon Aurora events</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>By default, RDS returns events that were generated in the past hour.</p> </note>
38
31
  * @example
39
32
  * Use a bare-bones client and the command you need to make an API call.
40
33
  * ```javascript
@@ -27,8 +27,7 @@ declare const DescribeExportTasksCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns information about a snapshot or cluster export to Amazon S3. This API operation supports
31
- * pagination.</p>
30
+ * <p>Returns information about a snapshot or cluster export to Amazon S3. This API operation supports pagination.</p>
32
31
  * @example
33
32
  * Use a bare-bones client and the command you need to make an API call.
34
33
  * ```javascript
@@ -27,12 +27,7 @@ declare const DescribeGlobalClustersCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns information about Aurora global database clusters. This API supports pagination.</p>
31
- * <p>For more information on Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the
32
- * <i>Amazon Aurora User Guide</i>.</p>
33
- * <note>
34
- * <p>This action only applies to Aurora DB clusters.</p>
35
- * </note>
30
+ * <p>Returns information about Aurora global database clusters. This API supports pagination.</p> <p>For more information on Amazon Aurora, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -111,8 +111,8 @@ declare const DescribeOrderableDBInstanceOptionsCommand_base: {
111
111
  * // ],
112
112
  * // SupportsClusters: true || false,
113
113
  * // SupportsDedicatedLogVolume: true || false,
114
- * // SupportsHttpEndpoint: true || false,
115
114
  * // SupportsAdditionalStorageVolumes: true || false,
115
+ * // SupportsHttpEndpoint: true || false,
116
116
  * // AvailableAdditionalStorageVolumesOptions: [ // AvailableAdditionalStorageVolumesOptionList
117
117
  * // { // AvailableAdditionalStorageVolumesOption
118
118
  * // SupportsStorageAutoscaling: true || false,
@@ -27,12 +27,7 @@ declare const DescribePendingMaintenanceActionsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.</p>
31
- * <p>This API follows an eventual consistency model. This means that the result of the
32
- * <code>DescribePendingMaintenanceActions</code> command might not be immediately
33
- * visible to all subsequent RDS commands. Keep this in mind when you use
34
- * <code>DescribePendingMaintenanceActions</code> immediately after using a previous
35
- * API command such as <code>ApplyPendingMaintenanceActions</code>.</p>
30
+ * <p>Returns a list of resources (for example, DB instances) that have at least one pending maintenance action.</p> <p>This API follows an eventual consistency model. This means that the result of the <code>DescribePendingMaintenanceActions</code> command might not be immediately visible to all subsequent RDS commands. Keep this in mind when you use <code>DescribePendingMaintenanceActions</code> immediately after using a previous API command such as <code>ApplyPendingMaintenanceActions</code>.</p>
36
31
  * @example
37
32
  * Use a bare-bones client and the command you need to make an API call.
38
33
  * ```javascript
@@ -27,14 +27,7 @@ declare const DescribeSourceRegionsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica,
31
- * copy a DB snapshot from, or replicate automated backups from.</p>
32
- * <p>Use this operation to determine whether cross-Region features are supported between other Regions
33
- * and your current Region. This operation supports pagination.</p>
34
- * <p>To return information about the Regions that are enabled for your account, or all Regions,
35
- * use the EC2 operation <code>DescribeRegions</code>. For more information, see
36
- * <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRegions.html">
37
- * DescribeRegions</a> in the <i>Amazon EC2 API Reference</i>.</p>
30
+ * <p>Returns a list of the source Amazon Web Services Regions where the current Amazon Web Services Region can create a read replica, copy a DB snapshot from, or replicate automated backups from.</p> <p>Use this operation to determine whether cross-Region features are supported between other Regions and your current Region. This operation supports pagination.</p> <p>To return information about the Regions that are enabled for your account, or all Regions, use the EC2 operation <code>DescribeRegions</code>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_DescribeRegions.html"> DescribeRegions</a> in the <i>Amazon EC2 API Reference</i>.</p>
38
31
  * @example
39
32
  * Use a bare-bones client and the command you need to make an API call.
40
33
  * ```javascript
@@ -28,8 +28,7 @@ declare const DescribeTenantDatabasesCommand_base: {
28
28
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
29
29
  };
30
30
  /**
31
- * <p>Describes the tenant databases in a DB instance that uses the multi-tenant
32
- * configuration. Only RDS for Oracle CDB instances are supported.</p>
31
+ * <p>Describes the tenant databases in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle CDB instances are supported.</p>
33
32
  * @example
34
33
  * Use a bare-bones client and the command you need to make an API call.
35
34
  * ```javascript
@@ -97,8 +96,7 @@ declare const DescribeTenantDatabasesCommand_base: {
97
96
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
98
97
  *
99
98
  * @throws {@link DBInstanceNotFoundFault} (client fault)
100
- * <p>
101
- * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
99
+ * <p> <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
102
100
  *
103
101
  * @throws {@link RDSServiceException}
104
102
  * <p>Base exception class for all service exceptions from RDS service.</p>
@@ -27,9 +27,7 @@ declare const DescribeValidDBInstanceModificationsCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>You can call <code>DescribeValidDBInstanceModifications</code> to learn what modifications you can make to
31
- * your DB instance. You can use this information when you call <code>ModifyDBInstance</code>.</p>
32
- * <p>This command doesn't apply to RDS Custom.</p>
30
+ * <p>You can call <code>DescribeValidDBInstanceModifications</code> to learn what modifications you can make to your DB instance. You can use this information when you call <code>ModifyDBInstance</code>.</p> <p>This command doesn't apply to RDS Custom.</p>
33
31
  * @example
34
32
  * Use a bare-bones client and the command you need to make an API call.
35
33
  * ```javascript
@@ -145,8 +143,7 @@ declare const DescribeValidDBInstanceModificationsCommand_base: {
145
143
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
146
144
  *
147
145
  * @throws {@link DBInstanceNotFoundFault} (client fault)
148
- * <p>
149
- * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
146
+ * <p> <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
150
147
  *
151
148
  * @throws {@link InvalidDBInstanceStateFault} (client fault)
152
149
  * <p>The DB instance isn't in a valid state.</p>
@@ -27,13 +27,7 @@ declare const DisableHttpEndpointCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.</p>
31
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using RDS Data API</a> in the
32
- * <i>Amazon Aurora User Guide</i>.</p>
33
- * <note>
34
- * <p>This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters,
35
- * use the <code>EnableHttpEndpoint</code> parameter of the <code>ModifyDBCluster</code> operation.</p>
36
- * </note>
30
+ * <p>Disables the HTTP endpoint for the specified DB cluster. Disabling this endpoint disables RDS Data API.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using RDS Data API</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To disable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the <code>EnableHttpEndpoint</code> parameter of the <code>ModifyDBCluster</code> operation.</p> </note>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -27,13 +27,7 @@ declare const DownloadDBLogFilePortionCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Downloads all or a portion of the specified log file, up to 1 MB in size.</p>
31
- * <p>This command doesn't apply to RDS Custom.</p>
32
- * <note>
33
- * <p>This operation uses resources on database instances. Because of this, we recommend publishing database logs to CloudWatch and then
34
- * using the GetLogEvents operation. For more information,
35
- * see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html">GetLogEvents</a> in the <i>Amazon CloudWatch Logs API Reference</i>.</p>
36
- * </note>
30
+ * <p>Downloads all or a portion of the specified log file, up to 1 MB in size.</p> <p>This command doesn't apply to RDS Custom.</p> <note> <p>This operation uses resources on database instances. Because of this, we recommend publishing database logs to CloudWatch and then using the GetLogEvents operation. For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_GetLogEvents.html">GetLogEvents</a> in the <i>Amazon CloudWatch Logs API Reference</i>.</p> </note>
37
31
  * @example
38
32
  * Use a bare-bones client and the command you need to make an API call.
39
33
  * ```javascript
@@ -65,15 +59,13 @@ declare const DownloadDBLogFilePortionCommand_base: {
65
59
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
66
60
  *
67
61
  * @throws {@link DBInstanceNotFoundFault} (client fault)
68
- * <p>
69
- * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
62
+ * <p> <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
70
63
  *
71
64
  * @throws {@link DBInstanceNotReadyFault} (client fault)
72
65
  * <p>An attempt to download or examine log files didn't succeed because an Aurora Serverless v2 instance was paused.</p>
73
66
  *
74
67
  * @throws {@link DBLogFileNotFoundFault} (client fault)
75
- * <p>
76
- * <code>LogFileName</code> doesn't refer to an existing DB log file.</p>
68
+ * <p> <code>LogFileName</code> doesn't refer to an existing DB log file.</p>
77
69
  *
78
70
  * @throws {@link RDSServiceException}
79
71
  * <p>Base exception class for all service exceptions from RDS service.</p>
@@ -27,17 +27,7 @@ declare const EnableHttpEndpointCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint
31
- * isn't enabled.</p>
32
- * <p>When enabled, this endpoint provides a connectionless web service API (RDS Data API)
33
- * for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console
34
- * with the RDS query editor.</p>
35
- * <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using RDS Data API</a> in the
36
- * <i>Amazon Aurora User Guide</i>.</p>
37
- * <note>
38
- * <p>This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters,
39
- * use the <code>EnableHttpEndpoint</code> parameter of the <code>ModifyDBCluster</code> operation.</p>
40
- * </note>
30
+ * <p>Enables the HTTP endpoint for the DB cluster. By default, the HTTP endpoint isn't enabled.</p> <p>When enabled, this endpoint provides a connectionless web service API (RDS Data API) for running SQL queries on the Aurora DB cluster. You can also query your database from inside the RDS console with the RDS query editor.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/data-api.html">Using RDS Data API</a> in the <i>Amazon Aurora User Guide</i>.</p> <note> <p>This operation applies only to Aurora Serverless v2 and provisioned DB clusters. To enable the HTTP endpoint for Aurora Serverless v1 DB clusters, use the <code>EnableHttpEndpoint</code> parameter of the <code>ModifyDBCluster</code> operation.</p> </note>
41
31
  * @example
42
32
  * Use a bare-bones client and the command you need to make an API call.
43
33
  * ```javascript
@@ -27,25 +27,7 @@ declare const FailoverDBClusterCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Forces a failover for a DB cluster.</p>
31
- * <p>For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances)
32
- * in the DB cluster to be the primary DB instance (the cluster writer).</p>
33
- * <p>For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the
34
- * internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances)
35
- * in the DB cluster to be the primary DB instance (the cluster writer).
36
- * Failover times are typically less than 35 seconds.</p>
37
- * <p>An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists,
38
- * when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby
39
- * DB instance when the primary DB instance fails.</p>
40
- * <p>To simulate a failure of a primary instance for testing, you can force a failover.
41
- * Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing
42
- * connections that use those endpoint addresses when the failover is complete.</p>
43
- * <p>For more information on Amazon Aurora DB clusters, see
44
- * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html">
45
- * What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p>
46
- * <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB
47
- * cluster deployments</a> in the <i>Amazon RDS User
48
- * Guide</i>.</p>
30
+ * <p>Forces a failover for a DB cluster.</p> <p>For an Aurora DB cluster, failover for a DB cluster promotes one of the Aurora Replicas (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer).</p> <p>For a Multi-AZ DB cluster, after RDS terminates the primary DB instance, the internal monitoring system detects that the primary DB instance is unhealthy and promotes a readable standby (read-only instances) in the DB cluster to be the primary DB instance (the cluster writer). Failover times are typically less than 35 seconds.</p> <p>An Amazon Aurora DB cluster automatically fails over to an Aurora Replica, if one exists, when the primary DB instance fails. A Multi-AZ DB cluster automatically fails over to a readable standby DB instance when the primary DB instance fails.</p> <p>To simulate a failure of a primary instance for testing, you can force a failover. Because each instance in a DB cluster has its own endpoint address, make sure to clean up and re-establish any existing connections that use those endpoint addresses when the failover is complete.</p> <p>For more information on Amazon Aurora DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/CHAP_AuroraOverview.html"> What is Amazon Aurora?</a> in the <i>Amazon Aurora User Guide</i>.</p> <p>For more information on Multi-AZ DB clusters, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html"> Multi-AZ DB cluster deployments</a> in the <i>Amazon RDS User Guide</i>.</p>
49
31
  * @example
50
32
  * Use a bare-bones client and the command you need to make an API call.
51
33
  * ```javascript
@@ -265,8 +247,7 @@ declare const FailoverDBClusterCommand_base: {
265
247
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
266
248
  *
267
249
  * @throws {@link DBClusterNotFoundFault} (client fault)
268
- * <p>
269
- * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
250
+ * <p> <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
270
251
  *
271
252
  * @throws {@link InvalidDBClusterStateFault} (client fault)
272
253
  * <p>The requested operation can't be performed while the cluster is in this state.</p>
@@ -27,42 +27,7 @@ declare const FailoverGlobalClusterCommand_base: {
27
27
  getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
28
28
  };
29
29
  /**
30
- * <p>Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers."</p>
31
- * <note>
32
- * <p>Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover.
33
- * To switch over a global database cluster, we recommend that you use the <a>SwitchoverGlobalCluster</a> operation instead.</p>
34
- * </note>
35
- * <p>How you use this operation depends on whether you are failing over or switching over your global database cluster:</p>
36
- * <ul>
37
- * <li>
38
- * <p>Failing over - Specify the <code>AllowDataLoss</code> parameter and don't specify the <code>Switchover</code> parameter.</p>
39
- * </li>
40
- * <li>
41
- * <p>Switching over - Specify the <code>Switchover</code> parameter or omit it, but don't specify the <code>AllowDataLoss</code> parameter.</p>
42
- * </li>
43
- * </ul>
44
- * <p>
45
- * <b>About failing over and switching over</b>
46
- * </p>
47
- * <p>While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:</p>
48
- * <ul>
49
- * <li>
50
- * <p>
51
- * <i>Failing over</i> - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region.
52
- * Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred.
53
- * However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees
54
- * that the data is in a transactionally consistent state.</p>
55
- * <p>For more information about failing over an Amazon Aurora global database, see
56
- * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-failover.managed-unplanned">Performing managed failovers for Aurora global databases</a> in the <i>Amazon Aurora User Guide</i>.</p>
57
- * </li>
58
- * <li>
59
- * <p>
60
- * <i>Switching over</i> - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to
61
- * fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.</p>
62
- * <p>For more information about switching over an Amazon Aurora global database, see
63
- * <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover">Performing switchovers for Aurora global databases</a> in the <i>Amazon Aurora User Guide</i>.</p>
64
- * </li>
65
- * </ul>
30
+ * <p>Promotes the specified secondary DB cluster to be the primary DB cluster in the global database cluster to fail over or switch over a global database. Switchover operations were previously called "managed planned failovers."</p> <note> <p>Although this operation can be used either to fail over or to switch over a global database cluster, its intended use is for global database failover. To switch over a global database cluster, we recommend that you use the <a>SwitchoverGlobalCluster</a> operation instead.</p> </note> <p>How you use this operation depends on whether you are failing over or switching over your global database cluster:</p> <ul> <li> <p>Failing over - Specify the <code>AllowDataLoss</code> parameter and don't specify the <code>Switchover</code> parameter.</p> </li> <li> <p>Switching over - Specify the <code>Switchover</code> parameter or omit it, but don't specify the <code>AllowDataLoss</code> parameter.</p> </li> </ul> <p> <b>About failing over and switching over</b> </p> <p>While failing over and switching over a global database cluster both change the primary DB cluster, you use these operations for different reasons:</p> <ul> <li> <p> <i>Failing over</i> - Use this operation to respond to an unplanned event, such as a Regional disaster in the primary Region. Failing over can result in a loss of write transaction data that wasn't replicated to the chosen secondary before the failover event occurred. However, the recovery process that promotes a DB instance on the chosen seconday DB cluster to be the primary writer DB instance guarantees that the data is in a transactionally consistent state.</p> <p>For more information about failing over an Amazon Aurora global database, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-failover.managed-unplanned">Performing managed failovers for Aurora global databases</a> in the <i>Amazon Aurora User Guide</i>.</p> </li> <li> <p> <i>Switching over</i> - Use this operation on a healthy global database cluster for planned events, such as Regional rotation or to fail back to the original primary DB cluster after a failover operation. With this operation, there is no data loss.</p> <p>For more information about switching over an Amazon Aurora global database, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-global-database-disaster-recovery.html#aurora-global-database-disaster-recovery.managed-failover">Performing switchovers for Aurora global databases</a> in the <i>Amazon Aurora User Guide</i>.</p> </li> </ul>
66
31
  * @example
67
32
  * Use a bare-bones client and the command you need to make an API call.
68
33
  * ```javascript
@@ -127,8 +92,7 @@ declare const FailoverGlobalClusterCommand_base: {
127
92
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
128
93
  *
129
94
  * @throws {@link DBClusterNotFoundFault} (client fault)
130
- * <p>
131
- * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
95
+ * <p> <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
132
96
  *
133
97
  * @throws {@link GlobalClusterNotFoundFault} (client fault)
134
98
  * <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster.</p>