@aws-sdk/client-rds 3.968.0 → 3.970.0

package/dist-types/commands/CreateTenantDatabaseCommand.d.ts

@@ -27,8 +27,7 @@ declare const CreateTenantDatabaseCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Creates a tenant database in a DB instance that uses the multi-tenant configuration.
- *             Only RDS for Oracle container database (CDB) instances are supported.</p>
+ * <p>Creates a tenant database in a DB instance that uses the multi-tenant configuration. Only RDS for Oracle container database (CDB) instances are supported.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -95,8 +94,7 @@ declare const CreateTenantDatabaseCommand_base: {
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  * @throws {@link DBInstanceNotFoundFault} (client fault)
- *  <p>
- *             <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
+ *  <p> <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
  *
  * @throws {@link InvalidDBInstanceStateFault} (client fault)
  *  <p>The DB instance isn't in a valid state.</p>
@@ -105,12 +103,10 @@ declare const CreateTenantDatabaseCommand_base: {
  *  <p>An error occurred accessing an Amazon Web Services KMS key.</p>
  *
  * @throws {@link TenantDatabaseAlreadyExistsFault} (client fault)
- *  <p>You attempted to either create a tenant database that already exists or
- *                 modify a tenant database to use the name of an existing tenant database.</p>
+ *  <p>You attempted to either create a tenant database that already exists or modify a tenant database to use the name of an existing tenant database.</p>
  *
  * @throws {@link TenantDatabaseQuotaExceededFault} (client fault)
- *  <p>You attempted to create more tenant databases than are permitted in your Amazon Web Services
- *             account.</p>
+ *  <p>You attempted to create more tenant databases than are permitted in your Amazon Web Services account.</p>
  *
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>

package/dist-types/commands/DeleteBlueGreenDeploymentCommand.d.ts

@@ -27,12 +27,7 @@ declare const DeleteBlueGreenDeploymentCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes a blue/green deployment.</p>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html">Using Amazon RDS
- *                 Blue/Green Deployments for database updates</a> in the <i>Amazon RDS User
- *                 Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html">Using Amazon RDS
- *                 Blue/Green Deployments for database updates</a> in the <i>Amazon Aurora
- *                 User Guide</i>.</p>
+ * <p>Deletes a blue/green deployment.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/blue-green-deployments.html">Using Amazon RDS Blue/Green Deployments for database updates</a> in the <i>Amazon RDS User Guide</i> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/blue-green-deployments.html">Using Amazon RDS Blue/Green Deployments for database updates</a> in the <i>Amazon Aurora User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -88,17 +83,153 @@ declare const DeleteBlueGreenDeploymentCommand_base: {
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  * @throws {@link BlueGreenDeploymentNotFoundFault} (client fault)
- *  <p>
- *             <code>BlueGreenDeploymentIdentifier</code> doesn't refer to an existing blue/green deployment.</p>
+ *  <p> <code>BlueGreenDeploymentIdentifier</code> doesn't refer to an existing blue/green deployment.</p>
  *
  * @throws {@link InvalidBlueGreenDeploymentStateFault} (client fault)
- *  <p>The blue/green deployment can't be switched over or deleted because there is an invalid configuration in
- *             the green environment.</p>
+ *  <p>The blue/green deployment can't be switched over or deleted because there is an invalid configuration in the green environment.</p>
  *
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
  *
+ * @example To delete resources in green environment for an RDS for MySQL DB instance
+ * ```javascript
+ * // The following example deletes the resources in a green environment for an RDS for MySQL DB instance.
+ * const input = {
+ *   BlueGreenDeploymentIdentifier: "bgd-v53303651eexfake",
+ *   DeleteTarget: true
+ * };
+ * const command = new DeleteBlueGreenDeploymentCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   BlueGreenDeployment: {
+ *     BlueGreenDeploymentIdentifier: "bgd-v53303651eexfake",
+ *     BlueGreenDeploymentName: "bgd-cli-test-instance",
+ *     CreateTime: "2022-02-25T21:18:51.183Z",
+ *     DeleteTime: "2022-02-25T22:25:31.331Z",
+ *     Source: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
+ *     Status: "DELETING",
+ *     SwitchoverDetails: [
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-1-green-j382ha"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-2-green-ejv4ao"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-replica-3-green-vlpz3t"
+ *       }
+ *     ],
+ *     Target: "arn:aws:rds:us-east-1:123456789012:db:my-db-instance-green-rkfbpe",
+ *     Tasks: [
+ *       {
+ *         Name: "CREATING_READ_REPLICA_OF_SOURCE",
+ *         Status: "COMPLETED"
+ *       },
+ *       {
+ *         Name: "DB_ENGINE_VERSION_UPGRADE",
+ *         Status: "COMPLETED"
+ *       },
+ *       {
+ *         Name: "CONFIGURE_BACKUPS",
+ *         Status: "COMPLETED"
+ *       },
+ *       {
+ *         Name: "CREATING_TOPOLOGY_OF_SOURCE",
+ *         Status: "COMPLETED"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * ```
+ *
+ * @example To delete resources in green environment for an Aurora MySQL DB cluster
+ * ```javascript
+ * // The following example deletes the resources in a green environment for an Aurora MySQL DB cluster.
+ * const input = {
+ *   BlueGreenDeploymentIdentifier: "bgd-wi89nwzglccsfake",
+ *   DeleteTarget: true
+ * };
+ * const command = new DeleteBlueGreenDeploymentCommand(input);
+ * const response = await client.send(command);
+ * /* response is
+ * {
+ *   BlueGreenDeployment: {
+ *     BlueGreenDeploymentIdentifier: "bgd-wi89nwzglccsfake",
+ *     BlueGreenDeploymentName: "my-blue-green-deployment",
+ *     CreateTime: "2022-02-25T21:12:00.288Z",
+ *     DeleteTime: "2022-02-25T22:29:11.336Z",
+ *     Source: "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
+ *     Status: "DELETING",
+ *     SwitchoverDetails: [
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-1-green-gpmaxf"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-2-green-j2oajq"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:db:my-aurora-mysql-cluster-3-green-mkxies"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-excluded-member-endpoint-green-4sqjrq"
+ *       },
+ *       {
+ *         SourceMember: "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint",
+ *         Status: "AVAILABLE",
+ *         TargetMember: "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:my-reader-endpoint-green-gwwzlg"
+ *       }
+ *     ],
+ *     Target: "arn:aws:rds:us-east-1:123456789012:cluster:my-aurora-mysql-cluster-green-3rnukl",
+ *     Tasks: [
+ *       {
+ *         Name: "CREATING_READ_REPLICA_OF_SOURCE",
+ *         Status: "COMPLETED"
+ *       },
+ *       {
+ *         Name: "DB_ENGINE_VERSION_UPGRADE",
+ *         Status: "COMPLETED"
+ *       },
+ *       {
+ *         Name: "CREATE_DB_INSTANCES_FOR_CLUSTER",
+ *         Status: "COMPLETED"
+ *       },
+ *       {
+ *         Name: "CREATE_CUSTOM_ENDPOINTS",
+ *         Status: "COMPLETED"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * ```
+ *
  * @public
  */
 export declare class DeleteBlueGreenDeploymentCommand extends DeleteBlueGreenDeploymentCommand_base {

package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts

@@ -27,27 +27,7 @@ declare const DeleteCustomDBEngineVersionCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:</p>
- *          <ul>
- *             <li>
- *                <p>The CEV must not be the default for RDS Custom. If it is, change the default
- *                 before running this command.</p>
- *             </li>
- *             <li>
- *                <p>The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot,
- *                 or automated backup of your RDS Custom instance.</p>
- *             </li>
- *          </ul>
- *          <p>Typically, deletion takes a few minutes.</p>
- *          <note>
- *             <p>The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with
- *             Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the
- *             <code>DeleteCustomDbEngineVersion</code> event aren't logged. However, you might see calls from the
- *             API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for
- *             the <code>DeleteCustomDbEngineVersion</code> event.</p>
- *          </note>
- *          <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.delete">Deleting a
- *                 CEV</a> in the <i>Amazon RDS User Guide</i>.</p>
+ * <p>Deletes a custom engine version. To run this command, make sure you meet the following prerequisites:</p> <ul> <li> <p>The CEV must not be the default for RDS Custom. If it is, change the default before running this command.</p> </li> <li> <p>The CEV must not be associated with an RDS Custom DB instance, RDS Custom instance snapshot, or automated backup of your RDS Custom instance.</p> </li> </ul> <p>Typically, deletion takes a few minutes.</p> <note> <p>The MediaImport service that imports files from Amazon S3 to create CEVs isn't integrated with Amazon Web Services CloudTrail. If you turn on data logging for Amazon RDS in CloudTrail, calls to the <code>DeleteCustomDbEngineVersion</code> event aren't logged. However, you might see calls from the API gateway that accesses your Amazon S3 bucket. These calls originate from the MediaImport service for the <code>DeleteCustomDbEngineVersion</code> event.</p> </note> <p>For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/custom-cev.html#custom-cev.delete">Deleting a CEV</a> in the <i>Amazon RDS User Guide</i>.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -68,6 +48,9 @@ declare const DeleteCustomDBEngineVersionCommand_base: {
  * //   EngineVersion: "STRING_VALUE",
  * //   DatabaseInstallationFilesS3BucketName: "STRING_VALUE",
  * //   DatabaseInstallationFilesS3Prefix: "STRING_VALUE",
+ * //   DatabaseInstallationFiles: [ // StringList
+ * //     "STRING_VALUE",
+ * //   ],
  * //   CustomDBEngineVersionManifest: "STRING_VALUE",
  * //   DBParameterGroupFamily: "STRING_VALUE",
  * //   DBEngineDescription: "STRING_VALUE",
@@ -77,6 +60,7 @@ declare const DeleteCustomDBEngineVersionCommand_base: {
  * //     CharacterSetName: "STRING_VALUE",
  * //     CharacterSetDescription: "STRING_VALUE",
  * //   },
+ * //   FailureReason: "STRING_VALUE",
  * //   Image: { // CustomDBEngineVersionAMI
  * //     ImageId: "STRING_VALUE",
  * //     Status: "STRING_VALUE",
@@ -151,10 +135,6 @@ declare const DeleteCustomDBEngineVersionCommand_base: {
  * //     MinCapacity: Number("double"),
  * //     MaxCapacity: Number("double"),
  * //   },
- * //   DatabaseInstallationFiles: [ // StringList
- * //     "STRING_VALUE",
- * //   ],
- * //   FailureReason: "STRING_VALUE",
  * // };
  *
  * ```

package/dist-types/commands/DeleteDBClusterAutomatedBackupCommand.d.ts

@@ -27,8 +27,7 @@ declare const DeleteDBClusterAutomatedBackupCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes automated backups using the <code>DbClusterResourceId</code> value of the source DB cluster or the Amazon
- *             Resource Name (ARN) of the automated backups.</p>
+ * <p>Deletes automated backups using the <code>DbClusterResourceId</code> value of the source DB cluster or the Amazon Resource Name (ARN) of the automated backups.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -95,8 +94,7 @@ declare const DeleteDBClusterAutomatedBackupCommand_base: {
  *  <p>No automated backup for this DB cluster was found.</p>
  *
  * @throws {@link InvalidDBClusterAutomatedBackupStateFault} (client fault)
- *  <p>The automated backup is in an invalid state.
- *             For example, this automated backup is associated with an active cluster.</p>
+ *  <p>The automated backup is in an invalid state. For example, this automated backup is associated with an active cluster.</p>
  *
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>

package/dist-types/commands/DeleteDBClusterCommand.d.ts

@@ -27,17 +27,7 @@ declare const DeleteDBClusterCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>The DeleteDBCluster action deletes a previously provisioned DB cluster.
- *           When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered.
- *           Manual DB cluster snapshots of the specified DB cluster are not deleted.</p>
- *          <p>If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are
- *             terminated and read replicas are promoted to standalone instances.</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>
- *          <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>
+ * <p>The DeleteDBCluster action deletes a previously provisioned DB cluster. When you delete a DB cluster, all automated backups for that DB cluster are deleted and can't be recovered. Manual DB cluster snapshots of the specified DB cluster are not deleted.</p> <p>If you're deleting a Multi-AZ DB cluster with read replicas, all cluster members are terminated and read replicas are promoted to standalone instances.</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> <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -259,12 +249,10 @@ declare const DeleteDBClusterCommand_base: {
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  * @throws {@link DBClusterAutomatedBackupQuotaExceededFault} (client fault)
- *  <p>The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated
- *             backups. The retained automated backups quota is the same as your DB cluster quota.</p>
+ *  <p>The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB cluster quota.</p>
  *
  * @throws {@link DBClusterNotFoundFault} (client fault)
- *  <p>
- *             <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
+ *  <p> <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
  *
  * @throws {@link DBClusterSnapshotAlreadyExistsFault} (client fault)
  *  <p>The user already has a DB cluster snapshot with the given identifier.</p>
@@ -282,8 +270,7 @@ declare const DeleteDBClusterCommand_base: {
  *  <p>An error occurred accessing an Amazon Web Services KMS key.</p>
  *
  * @throws {@link SnapshotQuotaExceededFault} (client fault)
- *  <p>The request would result in the user exceeding the allowed number of DB
- *             snapshots.</p>
+ *  <p>The request would result in the user exceeding the allowed number of DB snapshots.</p>
  *
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>

package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts

@@ -27,10 +27,7 @@ declare const DeleteDBClusterEndpointCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.</p>
- *          <note>
- *             <p>This action only applies to Aurora DB clusters.</p>
- *          </note>
+ * <p>Deletes a custom endpoint and removes it from an Amazon Aurora DB cluster.</p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts

@@ -27,13 +27,7 @@ declare const DeleteDBClusterParameterGroupCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.</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>
- *          <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>
+ * <p>Deletes a specified DB cluster parameter group. The DB cluster parameter group to be deleted can't be associated with any DB clusters.</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> <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -58,14 +52,10 @@ declare const DeleteDBClusterParameterGroupCommand_base: {
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  * @throws {@link DBParameterGroupNotFoundFault} (client fault)
- *  <p>
- *             <code>DBParameterGroupName</code> doesn't refer to an
- *         existing DB parameter group.</p>
+ *  <p> <code>DBParameterGroupName</code> doesn't refer to an existing DB parameter group.</p>
  *
  * @throws {@link InvalidDBParameterGroupStateFault} (client fault)
- *  <p>The DB parameter group is in use or is in an invalid state. If you are attempting
- *             to delete the parameter group, you can't delete it when the parameter group is in
- *             this state.</p>
+ *  <p>The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.</p>
  *
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>

package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts

@@ -27,17 +27,7 @@ declare const DeleteDBClusterSnapshotCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p>
- *          <note>
- *             <p>The DB cluster snapshot must be in the <code>available</code> state to be
- *             deleted.</p>
- *          </note>
- *          <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>
- *          <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>
+ * <p>Deletes a DB cluster snapshot. If the snapshot is being copied, the copy operation is terminated.</p> <note> <p>The DB cluster snapshot must be in the <code>available</code> state to be deleted.</p> </note> <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> <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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -98,8 +88,7 @@ declare const DeleteDBClusterSnapshotCommand_base: {
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  * @throws {@link DBClusterSnapshotNotFoundFault} (client fault)
- *  <p>
- *             <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot.</p>
+ *  <p> <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot.</p>
  *
  * @throws {@link InvalidDBClusterSnapshotStateFault} (client fault)
  *  <p>The supplied value isn't a valid DB cluster snapshot state.</p>

package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts

@@ -113,8 +113,7 @@ declare const DeleteDBInstanceAutomatedBackupCommand_base: {
  *  <p>No automated backup for this DB instance was found.</p>
  *
  * @throws {@link InvalidDBInstanceAutomatedBackupStateFault} (client fault)
- *  <p>The automated backup is in an invalid state.
- *             For example, this automated backup is associated with an active instance.</p>
+ *  <p>The automated backup is in an invalid state. For example, this automated backup is associated with an active instance.</p>
  *
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>

package/dist-types/commands/DeleteDBInstanceCommand.d.ts

@@ -27,29 +27,7 @@ declare const DeleteDBInstanceCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes a previously provisioned DB instance.
- *           When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered.
- *           However, manual DB snapshots of the DB instance aren't deleted.</p>
- *          <p>If you request a final DB snapshot, the status of the Amazon RDS DB instance is <code>deleting</code> until the DB snapshot is created.
- *         This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use <code>DescribeDBInstance</code>.</p>
- *          <p>When a DB instance is in a failure state and has a status of <code>failed</code>, <code>incompatible-restore</code>,
- *           or <code>incompatible-network</code>, you can only delete it when you skip creation of the final snapshot with the <code>SkipFinalSnapshot</code> parameter.</p>
- *          <p>If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following
- *       conditions are true:</p>
- *          <ul>
- *             <li>
- *                <p>The DB cluster is a read replica of another Amazon Aurora DB cluster.</p>
- *             </li>
- *             <li>
- *                <p>The DB instance is the only instance in the DB cluster.</p>
- *             </li>
- *          </ul>
- *          <p>To delete a DB instance in this case, first use the <code>PromoteReadReplicaDBCluster</code> operation to promote the DB cluster so that it's no longer a read replica.
- *         After the promotion completes, use the <code>DeleteDBInstance</code> operation to delete the final instance in the DB cluster.</p>
- *          <important>
- *             <p>For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete
- *         these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.</p>
- *          </important>
+ * <p>Deletes a previously provisioned DB instance. When you delete a DB instance, all automated backups for that instance are deleted and can't be recovered. However, manual DB snapshots of the DB instance aren't deleted.</p> <p>If you request a final DB snapshot, the status of the Amazon RDS DB instance is <code>deleting</code> until the DB snapshot is created. This operation can't be canceled or reverted after it begins. To monitor the status of this operation, use <code>DescribeDBInstance</code>.</p> <p>When a DB instance is in a failure state and has a status of <code>failed</code>, <code>incompatible-restore</code>, or <code>incompatible-network</code>, you can only delete it when you skip creation of the final snapshot with the <code>SkipFinalSnapshot</code> parameter.</p> <p>If the specified DB instance is part of an Amazon Aurora DB cluster, you can't delete the DB instance if both of the following conditions are true:</p> <ul> <li> <p>The DB cluster is a read replica of another Amazon Aurora DB cluster.</p> </li> <li> <p>The DB instance is the only instance in the DB cluster.</p> </li> </ul> <p>To delete a DB instance in this case, first use the <code>PromoteReadReplicaDBCluster</code> operation to promote the DB cluster so that it's no longer a read replica. After the promotion completes, use the <code>DeleteDBInstance</code> operation to delete the final instance in the DB cluster.</p> <important> <p>For RDS Custom DB instances, deleting the DB instance permanently deletes the EC2 instance and the associated EBS volumes. Make sure that you don't terminate or delete these resources before you delete the DB instance. Otherwise, deleting the DB instance and creation of the final snapshot might fail.</p> </important>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -326,17 +304,13 @@ declare const DeleteDBInstanceCommand_base: {
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  * @throws {@link DBInstanceAutomatedBackupQuotaExceededFault} (client fault)
- *  <p>The quota for retained automated backups was exceeded. This prevents you
- *             from retaining any additional automated backups. The retained automated backups
- *             quota is the same as your DB instance quota.</p>
+ *  <p>The quota for retained automated backups was exceeded. This prevents you from retaining any additional automated backups. The retained automated backups quota is the same as your DB instance quota.</p>
  *
  * @throws {@link DBInstanceNotFoundFault} (client fault)
- *  <p>
- *             <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
+ *  <p> <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
  *
  * @throws {@link DBSnapshotAlreadyExistsFault} (client fault)
- *  <p>
- *             <code>DBSnapshotIdentifier</code> is already used by an existing snapshot.</p>
+ *  <p> <code>DBSnapshotIdentifier</code> is already used by an existing snapshot.</p>
  *
  * @throws {@link InvalidDBClusterStateFault} (client fault)
  *  <p>The requested operation can't be performed while the cluster is in this state.</p>
@@ -348,8 +322,7 @@ declare const DeleteDBInstanceCommand_base: {
  *  <p>An error occurred accessing an Amazon Web Services KMS key.</p>
  *
  * @throws {@link SnapshotQuotaExceededFault} (client fault)
- *  <p>The request would result in the user exceeding the allowed number of DB
- *             snapshots.</p>
+ *  <p>The request would result in the user exceeding the allowed number of DB snapshots.</p>
  *
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>

package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts

@@ -52,14 +52,10 @@ declare const DeleteDBParameterGroupCommand_base: {
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  * @throws {@link DBParameterGroupNotFoundFault} (client fault)
- *  <p>
- *             <code>DBParameterGroupName</code> doesn't refer to an
- *         existing DB parameter group.</p>
+ *  <p> <code>DBParameterGroupName</code> doesn't refer to an existing DB parameter group.</p>
  *
  * @throws {@link InvalidDBParameterGroupStateFault} (client fault)
- *  <p>The DB parameter group is in use or is in an invalid state. If you are attempting
- *             to delete the parameter group, you can't delete it when the parameter group is in
- *             this state.</p>
+ *  <p>The DB parameter group is in use or is in an invalid state. If you are attempting to delete the parameter group, you can't delete it when the parameter group is in this state.</p>
  *
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>

package/dist-types/commands/DeleteDBProxyEndpointCommand.d.ts

@@ -27,9 +27,7 @@ declare const DeleteDBProxyEndpointCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes a <code>DBProxyEndpoint</code>. Doing so removes the ability to access the DB proxy using the
- *         endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write
- *         or read-only operations, or using a different VPC than the DB proxy's default VPC.</p>
+ * <p>Deletes a <code>DBProxyEndpoint</code>. Doing so removes the ability to access the DB proxy using the endpoint that you defined. The endpoint that you delete might have provided capabilities such as read/write or read-only operations, or using a different VPC than the DB proxy's default VPC.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts

@@ -27,15 +27,7 @@ declare const DeleteDBSecurityGroupCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes a DB security group.</p>
- *          <p>The specified DB security group must not be associated with any DB instances.</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>
+ * <p>Deletes a DB security group.</p> <p>The specified DB security group must not be associated with any DB instances.</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>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -60,8 +52,7 @@ declare const DeleteDBSecurityGroupCommand_base: {
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  * @throws {@link DBSecurityGroupNotFoundFault} (client fault)
- *  <p>
- *             <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group.</p>
+ *  <p> <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group.</p>
  *
  * @throws {@link InvalidDBSecurityGroupStateFault} (client fault)
  *  <p>The state of the DB security group doesn't allow deletion.</p>

package/dist-types/commands/DeleteDBSnapshotCommand.d.ts

@@ -27,11 +27,7 @@ declare const DeleteDBSnapshotCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes a DB snapshot. If the snapshot is being copied, the copy operation is
- *             terminated.</p>
- *          <note>
- *             <p>The DB snapshot must be in the <code>available</code> state to be deleted.</p>
- *          </note>
+ * <p>Deletes a DB snapshot. If the snapshot is being copied, the copy operation is terminated.</p> <note> <p>The DB snapshot must be in the <code>available</code> state to be deleted.</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -93,7 +89,6 @@ declare const DeleteDBSnapshotCommand_base: {
  * //     DBSystemId: "STRING_VALUE",
  * //     MultiTenant: true || false,
  * //     DedicatedLogVolume: true || false,
- * //     SnapshotAvailabilityZone: "STRING_VALUE",
  * //     AdditionalStorageVolumes: [ // AdditionalStorageVolumesList
  * //       { // AdditionalStorageVolume
  * //         VolumeName: "STRING_VALUE", // required
@@ -104,6 +99,7 @@ declare const DeleteDBSnapshotCommand_base: {
  * //         StorageType: "STRING_VALUE",
  * //       },
  * //     ],
+ * //     SnapshotAvailabilityZone: "STRING_VALUE",
  * //   },
  * // };
  *
@@ -116,8 +112,7 @@ declare const DeleteDBSnapshotCommand_base: {
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  * @throws {@link DBSnapshotNotFoundFault} (client fault)
- *  <p>
- *             <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
+ *  <p> <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
  *
  * @throws {@link InvalidDBSnapshotStateFault} (client fault)
  *  <p>The state of the DB snapshot doesn't allow deletion.</p>

package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts

@@ -27,10 +27,7 @@ declare const DeleteDBSubnetGroupCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes a DB subnet group.</p>
- *          <note>
- *             <p>The specified database subnet group must not be associated with any DB instances.</p>
- *          </note>
+ * <p>Deletes a DB subnet group.</p> <note> <p>The specified database subnet group must not be associated with any DB instances.</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -55,8 +52,7 @@ declare const DeleteDBSubnetGroupCommand_base: {
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  * @throws {@link DBSubnetGroupNotFoundFault} (client fault)
- *  <p>
- *             <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>
+ *  <p> <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>
  *
  * @throws {@link InvalidDBSubnetGroupStateFault} (client fault)
  *  <p>The DB subnet group cannot be deleted because it's in use.</p>

package/dist-types/commands/DeleteGlobalClusterCommand.d.ts

@@ -27,11 +27,7 @@ declare const DeleteGlobalClusterCommand_base: {
     getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions;
 };
 /**
- * <p>Deletes a global database cluster. The primary and secondary clusters must already be detached or
- *         destroyed first.</p>
- *          <note>
- *             <p>This action only applies to Aurora DB clusters.</p>
- *          </note>
+ * <p>Deletes a global database cluster. The primary and secondary clusters must already be detached or destroyed first.</p> <note> <p>This action only applies to Aurora DB clusters.</p> </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript