docs(client-rds): Updates Amazon RDS documentation for support for RD…

…S for Db2.
aws · Nov 27, 2023 · 8a6764a · 8a6764a
1 parent defc236
commit 8a6764a
Show file tree

Hide file tree

Showing 27 changed files with 478 additions and 289 deletions.
diff --git a/clients/client-rds/README.md b/clients/client-rds/README.md
@@ -14,7 +14,7 @@ scale a relational database in the cloud. It provides cost-efficient, resizeable
 database and manages common database administration tasks, freeing up developers to focus on what makes their applications
 and businesses unique.</p>
 <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server,
-Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
+Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
 you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS
 automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS
 is flexible: you can scale your DB instance's compute resources and storage capacity to meet your

diff --git a/clients/client-rds/src/RDS.ts b/clients/client-rds/src/RDS.ts
@@ -3457,7 +3457,7 @@ export interface RDS {
  *           database and manages common database administration tasks, freeing up developers to focus on what makes their applications
  *           and businesses unique.</p>
  *          <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server,
- *           Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
+ *           Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
  *           you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS
  *           automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS
  *           is flexible: you can scale your DB instance's compute resources and storage capacity to meet your

diff --git a/clients/client-rds/src/RDSClient.ts b/clients/client-rds/src/RDSClient.ts
@@ -1048,7 +1048,7 @@ export interface RDSClientResolvedConfig extends RDSClientResolvedConfigType {}
  *           database and manages common database administration tasks, freeing up developers to focus on what makes their applications
  *           and businesses unique.</p>
  *          <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server,
- *           Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
+ *           Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
  *           you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS
  *           automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS
  *           is flexible: you can scale your DB instance's compute resources and storage capacity to meet your

diff --git a/clients/client-rds/src/commands/CreateDBInstanceReadReplicaCommand.ts b/clients/client-rds/src/commands/CreateDBInstanceReadReplicaCommand.ts
@@ -40,7 +40,7 @@ export interface CreateDBInstanceReadReplicaCommandOutput extends CreateDBInstan
  * @public
  * <p>Creates a new DB instance that acts as a read replica for an existing source DB
  *             instance or Multi-AZ DB cluster. You can create a read replica for a DB instance running
- *             MySQL, MariaDB, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a
+ *             Db2, MariaDB, MySQL, Oracle, PostgreSQL, or SQL Server. You can create a read replica for a
  *             Multi-AZ DB cluster running MySQL or PostgreSQL. For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ReadRepl.html">Working
  *                 with read replicas</a> and <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/multi-az-db-clusters-concepts.html#multi-az-db-clusters-migrating-to-instance-with-read-replica">Migrating from a Multi-AZ DB cluster to a DB instance using a read replica</a> in the <i>Amazon RDS User Guide</i>.</p>
  *          <p>Amazon Aurora doesn't support this operation. To create a DB instance for an Aurora DB cluster, use the <code>CreateDBInstance</code>

diff --git a/clients/client-rds/src/commands/DescribeOptionGroupOptionsCommand.ts b/clients/client-rds/src/commands/DescribeOptionGroupOptionsCommand.ts
@@ -37,7 +37,7 @@ export interface DescribeOptionGroupOptionsCommandOutput extends OptionGroupOpti
 
 /**
  * @public
- * <p>Describes all available options.</p>
+ * <p>Describes all available options for the specified engine.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-rds/src/commands/DescribeOrderableDBInstanceOptionsCommand.ts b/clients/client-rds/src/commands/DescribeOrderableDBInstanceOptionsCommand.ts
@@ -42,7 +42,7 @@ export interface DescribeOrderableDBInstanceOptionsCommandOutput
 
 /**
  * @public
- * <p>Returns a list of orderable DB instance options for the specified DB engine, DB engine version, and DB instance class.</p>
+ * <p>Describes the orderable DB instance options for a specified DB engine.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-rds/src/commands/ModifyCurrentDBClusterCapacityCommand.ts b/clients/client-rds/src/commands/ModifyCurrentDBClusterCapacityCommand.ts
@@ -56,7 +56,7 @@ export interface ModifyCurrentDBClusterCapacityCommandOutput extends DBClusterCa
  *                   Autoscaling for Aurora Serverless v1</a> in the <i>Amazon Aurora User Guide</i>.</p>
  *          </important>
  *          <note>
- *             <p>This action only applies to Aurora Serverless v1 DB clusters.</p>
+ *             <p>This operation only applies to Aurora Serverless v1 DB clusters.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-rds/src/commands/ModifyDBClusterEndpointCommand.ts b/clients/client-rds/src/commands/ModifyDBClusterEndpointCommand.ts
@@ -40,7 +40,7 @@ export interface ModifyDBClusterEndpointCommandOutput extends DBClusterEndpoint,
  * @public
  * <p>Modifies the properties of an endpoint in an Amazon Aurora DB cluster.</p>
  *          <note>
- *             <p>This action only applies to Aurora DB clusters.</p>
+ *             <p>This operation only applies to Aurora DB clusters.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-rds/src/commands/ModifyDBClusterParameterGroupCommand.ts b/clients/client-rds/src/commands/ModifyDBClusterParameterGroupCommand.ts
@@ -49,7 +49,7 @@ export interface ModifyDBClusterParameterGroupCommandOutput
  *          <important>
  *             <p>After you create a DB cluster parameter group, you should wait at least 5 minutes
  *                 before creating your first DB cluster that uses that DB cluster parameter group as the default parameter
- *                 group. This allows Amazon RDS to fully complete the create action before the parameter
+ *                 group. This allows Amazon RDS to fully complete the create operation before the parameter
  *                 group is used as the default for a new DB cluster. This is especially important for parameters
  *                 that are critical when creating the default database for a DB cluster, such as the character set
  *                 for the default database defined by the <code>character_set_database</code> parameter. You can use the

diff --git a/clients/client-rds/src/commands/ModifyDBParameterGroupCommand.ts b/clients/client-rds/src/commands/ModifyDBParameterGroupCommand.ts
@@ -43,7 +43,7 @@ export interface ModifyDBParameterGroupCommandOutput extends DBParameterGroupNam
  *          <important>
  *             <p>After you modify a DB parameter group, you should wait at least 5 minutes
  *             before creating your first DB instance that uses that DB parameter group as the default parameter
- *             group. This allows Amazon RDS to fully complete the modify action before the parameter
+ *             group. This allows Amazon RDS to fully complete the modify operation before the parameter
  *             group is used as the default for a new DB instance. This is especially important for parameters
  *             that are critical when creating the default database for a DB instance, such as the character set
  *             for the default database defined by the <code>character_set_database</code> parameter. You can use the

diff --git a/clients/client-rds/src/commands/ModifyDBSnapshotCommand.ts b/clients/client-rds/src/commands/ModifyDBSnapshotCommand.ts
@@ -41,8 +41,8 @@ export interface ModifyDBSnapshotCommandOutput extends ModifyDBSnapshotResult, _
  *             or unencrypted, but not shared or public.
  *
  *     </p>
- *          <p>Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This command
- *           doesn't apply to RDS Custom.</p>
+ *          <p>Amazon RDS supports upgrading DB snapshots for MySQL, PostgreSQL, and Oracle. This operation
+ *           doesn't apply to RDS Custom or RDS for Db2.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-rds/src/commands/RemoveFromGlobalClusterCommand.ts b/clients/client-rds/src/commands/RemoveFromGlobalClusterCommand.ts
@@ -41,7 +41,7 @@ export interface RemoveFromGlobalClusterCommandOutput extends RemoveFromGlobalCl
  *         standalone cluster with read-write capability instead of being read-only and receiving data from a
  *         primary cluster in a different Region.</p>
  *          <note>
- *             <p>This action only applies to Aurora DB clusters.</p>
+ *             <p>This operation only applies to Aurora DB clusters.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-rds/src/commands/RestoreDBClusterFromS3Command.ts b/clients/client-rds/src/commands/RestoreDBClusterFromS3Command.ts
@@ -42,18 +42,18 @@ export interface RestoreDBClusterFromS3CommandOutput extends RestoreDBClusterFro
  *             created using the Percona XtraBackup utility as described in <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/AuroraMySQL.Migrating.ExtMySQL.html#AuroraMySQL.Migrating.ExtMySQL.S3"> Migrating Data from MySQL by Using an Amazon S3 Bucket</a> in the
  *                 <i>Amazon Aurora User Guide</i>.</p>
  *          <note>
- *             <p>This action only restores the DB cluster, not the DB instances for that DB
- *                   cluster. You must invoke the <code>CreateDBInstance</code> action to create DB
+ *             <p>This operation only restores the DB cluster, not the DB instances for that DB
+ *                   cluster. You must invoke the <code>CreateDBInstance</code> operation to create DB
  *                   instances for the restored DB cluster, specifying the identifier of the restored DB
  *                   cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after
- *                   the <code>RestoreDBClusterFromS3</code> action has completed and the DB
+ *                   the <code>RestoreDBClusterFromS3</code> operation has completed and the DB
  *                   cluster is available.</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>
  *          <note>
- *             <p>This action only applies to Aurora DB clusters. The source DB engine must be MySQL.</p>
+ *             <p>This operation only applies to Aurora DB clusters. The source DB engine must be MySQL.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-rds/src/commands/RestoreDBClusterFromSnapshotCommand.ts b/clients/client-rds/src/commands/RestoreDBClusterFromSnapshotCommand.ts
@@ -44,11 +44,11 @@ export interface RestoreDBClusterFromSnapshotCommandOutput
  *             configuration. If you don't specify a security group, the new DB cluster is
  *             associated with the default security group.</p>
  *          <note>
- *             <p>This action only restores the DB cluster, not the DB instances for that DB
- *                 cluster. You must invoke the <code>CreateDBInstance</code> action to create DB
+ *             <p>This operation only restores the DB cluster, not the DB instances for that DB
+ *                 cluster. You must invoke the <code>CreateDBInstance</code> operation to create DB
  *                 instances for the restored DB cluster, specifying the identifier of the restored DB
  *                 cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after
- *                 the <code>RestoreDBClusterFromSnapshot</code> action has completed and the DB
+ *                 the <code>RestoreDBClusterFromSnapshot</code> operation has completed and the DB
  *                 cluster is available.</p>
  *          </note>
  *          <p>For more information on Amazon Aurora DB clusters, see

diff --git a/clients/client-rds/src/commands/RestoreDBClusterToPointInTimeCommand.ts b/clients/client-rds/src/commands/RestoreDBClusterToPointInTimeCommand.ts
@@ -48,11 +48,11 @@ export interface RestoreDBClusterToPointInTimeCommandOutput
  *             source DB cluster with the same configuration as the original DB cluster, except that
  *             the new DB cluster is created with the default DB security group.</p>
  *          <note>
- *             <p>For Aurora, this action only restores the DB cluster, not the DB instances for that DB
- *                 cluster. You must invoke the <code>CreateDBInstance</code> action to create DB
+ *             <p>For Aurora, this operation only restores the DB cluster, not the DB instances for that DB
+ *                 cluster. You must invoke the <code>CreateDBInstance</code> operation to create DB
  *                 instances for the restored DB cluster, specifying the identifier of the restored DB
  *                 cluster in <code>DBClusterIdentifier</code>. You can create DB instances only after
- *                 the <code>RestoreDBClusterToPointInTime</code> action has completed and the DB
+ *                 the <code>RestoreDBClusterToPointInTime</code> operation has completed and the DB
  *                 cluster is available.</p>
  *          </note>
  *          <p>For more information on Amazon Aurora DB clusters, see

diff --git a/clients/client-rds/src/commands/RestoreDBInstanceFromDBSnapshotCommand.ts b/clients/client-rds/src/commands/RestoreDBInstanceFromDBSnapshotCommand.ts
@@ -47,9 +47,9 @@ export interface RestoreDBInstanceFromDBSnapshotCommandOutput
  *             instance is created as a Single-AZ deployment, except when the instance is a SQL Server instance that has an option group
  *             associated with mirroring. In this case, the instance becomes a Multi-AZ deployment, not a Single-AZ deployment.</p>
  *          <p>If you want to replace your original DB instance with the new, restored DB instance, then rename your original DB instance
- *             before you call the RestoreDBInstanceFromDBSnapshot action. RDS doesn't allow two DB instances with the same name. After you
+ *             before you call the <code>RestoreDBInstanceFromDBSnapshot</code> operation. RDS doesn't allow two DB instances with the same name. After you
  *             have renamed your original DB instance with a different identifier, then you can pass the original name of the DB instance as
- *             the DBInstanceIdentifier in the call to the RestoreDBInstanceFromDBSnapshot action. The result is that you replace the original
+ *             the <code>DBInstanceIdentifier</code> in the call to the <code>RestoreDBInstanceFromDBSnapshot</code> operation. The result is that you replace the original
  *             DB instance with the DB instance created from the snapshot.</p>
  *          <p>If you are restoring from a shared manual DB snapshot, the <code>DBSnapshotIdentifier</code>
  *       must be the ARN of the shared DB snapshot.</p>

diff --git a/clients/client-rds/src/commands/RestoreDBInstanceFromS3Command.ts b/clients/client-rds/src/commands/RestoreDBInstanceFromS3Command.ts
@@ -45,7 +45,7 @@ export interface RestoreDBInstanceFromS3CommandOutput extends RestoreDBInstanceF
  *             For more information, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/MySQL.Procedural.Importing.html">Importing Data into an Amazon RDS MySQL DB Instance</a>
  *             in the <i>Amazon RDS User Guide.</i>
  *          </p>
- *          <p>This command doesn't apply to RDS Custom.</p>
+ *          <p>This operation doesn't apply to RDS Custom.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript

diff --git a/clients/client-rds/src/commands/RestoreDBInstanceToPointInTimeCommand.ts b/clients/client-rds/src/commands/RestoreDBInstanceToPointInTimeCommand.ts
@@ -50,7 +50,7 @@ export interface RestoreDBInstanceToPointInTimeCommandOutput
  *             option group that is associated with mirroring; in this case, the instance becomes a
  *             mirrored deployment and not a single-AZ deployment.</p>
  *          <note>
- *             <p>This command doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use <code>RestoreDBClusterToPointInTime</code>.</p>
+ *             <p>This operation doesn't apply to Aurora MySQL and Aurora PostgreSQL. For Aurora, use <code>RestoreDBClusterToPointInTime</code>.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-rds/src/commands/StartDBClusterCommand.ts b/clients/client-rds/src/commands/StartDBClusterCommand.ts
@@ -38,12 +38,12 @@ export interface StartDBClusterCommandOutput extends StartDBClusterResult, __Met
 /**
  * @public
  * <p>Starts an Amazon Aurora DB cluster that was stopped using the Amazon Web Services console, the stop-db-cluster
- *        CLI command, or the StopDBCluster action.</p>
+ *        CLI command, or the <code>StopDBCluster</code> operation.</p>
  *          <p>For more information, see
  *            <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html">
  *                Stopping and Starting an Aurora Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>
  *          <note>
- *             <p>This action only applies to Aurora DB clusters.</p>
+ *             <p>This operation only applies to Aurora DB clusters.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-rds/src/commands/StartDBInstanceCommand.ts b/clients/client-rds/src/commands/StartDBInstanceCommand.ts
@@ -37,7 +37,7 @@ export interface StartDBInstanceCommandOutput extends StartDBInstanceResult, __M
 
 /**
  * @public
- * <p>Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the StopDBInstance action.</p>
+ * <p>Starts an Amazon RDS DB instance that was stopped using the Amazon Web Services console, the stop-db-instance CLI command, or the <code>StopDBInstance</code> operation.</p>
  *          <p>For more information, see
  *             <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_StartInstance.html">
  *                 Starting an Amazon RDS DB instance That Was Previously Stopped</a> in the

diff --git a/clients/client-rds/src/commands/StartExportTaskCommand.ts b/clients/client-rds/src/commands/StartExportTaskCommand.ts
@@ -40,7 +40,7 @@ export interface StartExportTaskCommandOutput extends ExportTask, __MetadataBear
  * @public
  * <p>Starts an export of DB snapshot or DB cluster data to Amazon S3.
  *             The provided IAM role must have access to the S3 bucket.</p>
- *          <p>You can't export snapshot data from RDS Custom DB instances.</p>
+ *          <p>You can't export snapshot data from Db2 or RDS Custom DB instances.</p>
  *          <p>You can't export cluster data from Multi-AZ DB clusters.</p>
  *          <p>For more information on exporting DB snapshot data, see
  *             <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html">Exporting DB snapshot

diff --git a/clients/client-rds/src/commands/StopActivityStreamCommand.ts b/clients/client-rds/src/commands/StopActivityStreamCommand.ts
@@ -38,7 +38,7 @@ export interface StopActivityStreamCommandOutput extends StopActivityStreamRespo
 /**
  * @public
  * <p>Stops a database activity stream that was started using the Amazon Web Services console,
- *             the <code>start-activity-stream</code> CLI command, or the <code>StartActivityStream</code> action.</p>
+ *             the <code>start-activity-stream</code> CLI command, or the <code>StartActivityStream</code> operation.</p>
  *          <p>For more information, see
  *             <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/DBActivityStreams.html">
  *                 Monitoring Amazon Aurora with Database Activity Streams</a>

diff --git a/clients/client-rds/src/commands/StopDBClusterCommand.ts b/clients/client-rds/src/commands/StopDBClusterCommand.ts
@@ -44,7 +44,7 @@ export interface StopDBClusterCommandOutput extends StopDBClusterResult, __Metad
  *            <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-cluster-stop-start.html">
  *                Stopping and Starting an Aurora Cluster</a> in the <i>Amazon Aurora User Guide</i>.</p>
  *          <note>
- *             <p>This action only applies to Aurora DB clusters.</p>
+ *             <p>This operation only applies to Aurora DB clusters.</p>
  *          </note>
  * @example
  * Use a bare-bones client and the command you need to make an API call.

diff --git a/clients/client-rds/src/index.ts b/clients/client-rds/src/index.ts
@@ -8,7 +8,7 @@
  *           database and manages common database administration tasks, freeing up developers to focus on what makes their applications
  *           and businesses unique.</p>
  *          <p>Amazon RDS gives you access to the capabilities of a MySQL, MariaDB, PostgreSQL, Microsoft SQL Server,
- *           Oracle, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
+ *           Oracle, Db2, or Amazon Aurora database server. These capabilities mean that the code, applications, and tools
  *           you already use today with your existing databases work with Amazon RDS without modification. Amazon RDS
  *           automatically backs up your database and maintains the database software that powers your DB instance. Amazon RDS
  *           is flexible: you can scale your DB instance's compute resources and storage capacity to meet your