@aws-sdk/client-rds 3.776.0 → 3.777.0

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

@@ -79,150 +79,150 @@ declare const DescribeSourceRegionsCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To describe source Regions
  * ```javascript
  * // The following example retrieves details about all source AWS Regions where the current AWS Region can create a read replica, copy a DB snapshot from, or replicate automated backups from. It also shows that automated backups can be replicated only from US West (Oregon) to the destination AWS Region, US East (N. Virginia).
  * const input = {
- *   "RegionName": "us-east-1"
+ *   RegionName: "us-east-1"
  * };
  * const command = new DescribeSourceRegionsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "SourceRegions": [
+ *   SourceRegions: [
  *     {
- *       "Endpoint": "https://rds.af-south-1.amazonaws.com",
- *       "RegionName": "af-south-1",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": false
+ *       Endpoint: "https://rds.af-south-1.amazonaws.com",
+ *       RegionName: "af-south-1",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: false
  *     },
  *     {
- *       "Endpoint": "https://rds.ap-east-1.amazonaws.com",
- *       "RegionName": "ap-east-1",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": false
+ *       Endpoint: "https://rds.ap-east-1.amazonaws.com",
+ *       RegionName: "ap-east-1",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: false
  *     },
  *     {
- *       "Endpoint": "https://rds.ap-northeast-1.amazonaws.com",
- *       "RegionName": "ap-northeast-1",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *       Endpoint: "https://rds.ap-northeast-1.amazonaws.com",
+ *       RegionName: "ap-northeast-1",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: true
  *     },
  *     {
- *       "Endpoint": "https://rds.ap-northeast-2.amazonaws.com",
- *       "RegionName": "ap-northeast-2",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *       Endpoint: "https://rds.ap-northeast-2.amazonaws.com",
+ *       RegionName: "ap-northeast-2",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: true
  *     },
  *     {
- *       "Endpoint": "https://rds.ap-northeast-3.amazonaws.com",
- *       "RegionName": "ap-northeast-3",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": false
+ *       Endpoint: "https://rds.ap-northeast-3.amazonaws.com",
+ *       RegionName: "ap-northeast-3",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: false
  *     },
  *     {
- *       "Endpoint": "https://rds.ap-south-1.amazonaws.com",
- *       "RegionName": "ap-south-1",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *       Endpoint: "https://rds.ap-south-1.amazonaws.com",
+ *       RegionName: "ap-south-1",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: true
  *     },
  *     {
- *       "Endpoint": "https://rds.ap-southeast-1.amazonaws.com",
- *       "RegionName": "ap-southeast-1",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *       Endpoint: "https://rds.ap-southeast-1.amazonaws.com",
+ *       RegionName: "ap-southeast-1",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: true
  *     },
  *     {
- *       "Endpoint": "https://rds.ap-southeast-2.amazonaws.com",
- *       "RegionName": "ap-southeast-2",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *       Endpoint: "https://rds.ap-southeast-2.amazonaws.com",
+ *       RegionName: "ap-southeast-2",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: true
  *     },
  *     {
- *       "Endpoint": "https://rds.ap-southeast-3.amazonaws.com",
- *       "RegionName": "ap-southeast-3",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": false
+ *       Endpoint: "https://rds.ap-southeast-3.amazonaws.com",
+ *       RegionName: "ap-southeast-3",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: false
  *     },
  *     {
- *       "Endpoint": "https://rds.ca-central-1.amazonaws.com",
- *       "RegionName": "ca-central-1",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *       Endpoint: "https://rds.ca-central-1.amazonaws.com",
+ *       RegionName: "ca-central-1",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: true
  *     },
  *     {
- *       "Endpoint": "https://rds.eu-north-1.amazonaws.com",
- *       "RegionName": "eu-north-1",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *       Endpoint: "https://rds.eu-north-1.amazonaws.com",
+ *       RegionName: "eu-north-1",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: true
  *     },
  *     {
- *       "Endpoint": "https://rds.eu-south-1.amazonaws.com",
- *       "RegionName": "eu-south-1",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": false
+ *       Endpoint: "https://rds.eu-south-1.amazonaws.com",
+ *       RegionName: "eu-south-1",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: false
  *     },
  *     {
- *       "Endpoint": "https://rds.eu-west-1.amazonaws.com",
- *       "RegionName": "eu-west-1",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *       Endpoint: "https://rds.eu-west-1.amazonaws.com",
+ *       RegionName: "eu-west-1",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: true
  *     },
  *     {
- *       "Endpoint": "https://rds.eu-west-2.amazonaws.com",
- *       "RegionName": "eu-west-2",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *       Endpoint: "https://rds.eu-west-2.amazonaws.com",
+ *       RegionName: "eu-west-2",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: true
  *     },
  *     {
- *       "Endpoint": "https://rds.eu-west-3.amazonaws.com",
- *       "RegionName": "eu-west-3",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *       Endpoint: "https://rds.eu-west-3.amazonaws.com",
+ *       RegionName: "eu-west-3",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: true
  *     },
  *     {
- *       "Endpoint": "https://rds.me-central-1.amazonaws.com",
- *       "RegionName": "me-central-1",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": false
+ *       Endpoint: "https://rds.me-central-1.amazonaws.com",
+ *       RegionName: "me-central-1",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: false
  *     },
  *     {
- *       "Endpoint": "https://rds.me-south-1.amazonaws.com",
- *       "RegionName": "me-south-1",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": false
+ *       Endpoint: "https://rds.me-south-1.amazonaws.com",
+ *       RegionName: "me-south-1",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: false
  *     },
  *     {
- *       "Endpoint": "https://rds.sa-east-1.amazonaws.com",
- *       "RegionName": "sa-east-1",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *       Endpoint: "https://rds.sa-east-1.amazonaws.com",
+ *       RegionName: "sa-east-1",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: true
  *     },
  *     {
- *       "Endpoint": "https://rds.us-east-2.amazonaws.com",
- *       "RegionName": "us-east-2",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *       Endpoint: "https://rds.us-east-2.amazonaws.com",
+ *       RegionName: "us-east-2",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: true
  *     },
  *     {
- *       "Endpoint": "https://rds.us-west-1.amazonaws.com",
- *       "RegionName": "us-west-1",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *       Endpoint: "https://rds.us-west-1.amazonaws.com",
+ *       RegionName: "us-west-1",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: true
  *     },
  *     {
- *       "Endpoint": "https://rds.us-west-2.amazonaws.com",
- *       "RegionName": "us-west-2",
- *       "Status": "available",
- *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *       Endpoint: "https://rds.us-west-2.amazonaws.com",
+ *       RegionName: "us-west-2",
+ *       Status: "available",
+ *       SupportsDBInstanceAutomatedBackupsReplication: true
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-source-regions-1680283924227
  * ```
  *
+ * @public
  */
 export declare class DescribeSourceRegionsCommand extends DescribeSourceRegionsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -95,6 +95,7 @@ declare const DescribeTenantDatabasesCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
+ *
  * @public
  */
 export declare class DescribeTenantDatabasesCommand extends DescribeTenantDatabasesCommand_base {

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

@@ -111,41 +111,41 @@ declare const DescribeValidDBInstanceModificationsCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To describe valid modifications for a DB instance
  * ```javascript
  * // The following example retrieves details about the valid modifications for the specified DB instance.
  * const input = {
- *   "DBInstanceIdentifier": "database-test1"
+ *   DBInstanceIdentifier: "database-test1"
  * };
  * const command = new DescribeValidDBInstanceModificationsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "ValidDBInstanceModificationsMessage": {
- *     "Storage": [
+ *   ValidDBInstanceModificationsMessage: {
+ *     Storage: [
  *       {
- *         "StorageSize": [
+ *         StorageSize: [
  *           {
- *             "From": 20,
- *             "Step": 1,
- *             "To": 20
+ *             From: 20,
+ *             Step: 1,
+ *             To: 20
  *           },
  *           {
- *             "From": 22,
- *             "Step": 1,
- *             "To": 6144
+ *             From: 22,
+ *             Step: 1,
+ *             To: 6144
  *           }
  *         ],
- *         "StorageType": "gp2"
+ *         StorageType: "gp2"
  *       }
  *     ]
  *   }
  * }
  * *\/
- * // example id: to-describe-valid-modifications-for-a-db-instance-1680284230997
  * ```
  *
+ * @public
  */
 export declare class DescribeValidDBInstanceModificationsCommand extends DescribeValidDBInstanceModificationsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -67,6 +67,7 @@ declare const DisableHttpEndpointCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
+ *
  * @public
  */
 export declare class DisableHttpEndpointCommand extends DisableHttpEndpointCommand_base {

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

@@ -71,19 +71,22 @@ declare const DownloadDBLogFilePortionCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To download a DB log file
  * ```javascript
  * // The following example downloads only the latest part of your log file.
  * const input = {
- *   "DBInstanceIdentifier": "test-instance",
- *   "LogFileName": "log.txt"
+ *   DBInstanceIdentifier: "test-instance",
+ *   LogFileName: "log.txt"
  * };
  * const command = new DownloadDBLogFilePortionCommand(input);
- * await client.send(command);
- * // example id: to-download-a-db-log-file-1680284895898
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DownloadDBLogFilePortionCommand extends DownloadDBLogFilePortionCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -71,6 +71,7 @@ declare const EnableHttpEndpointCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
+ *
  * @public
  */
 export declare class EnableHttpEndpointCommand extends EnableHttpEndpointCommand_base {

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

@@ -272,24 +272,24 @@ declare const FailoverDBClusterCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To perform a failover for a DB cluster
  * ```javascript
  * // This example performs a failover for the specified DB cluster to the specified DB instance.
  * const input = {
- *   "DBClusterIdentifier": "myaurorainstance-cluster",
- *   "TargetDBInstanceIdentifier": "myaurorareplica"
+ *   DBClusterIdentifier: "myaurorainstance-cluster",
+ *   TargetDBInstanceIdentifier: "myaurorareplica"
  * };
  * const command = new FailoverDBClusterCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "DBCluster": {}
+ *   DBCluster:   { /* empty *\/ }
  * }
  * *\/
- * // example id: failover-db-cluster-9e7f2f93-d98c-42c7-bb0e-d6c485c096d6
  * ```
  *
+ * @public
  */
 export declare class FailoverDBClusterCommand extends FailoverDBClusterCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -140,6 +140,7 @@ declare const FailoverGlobalClusterCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
+ *
  * @public
  */
 export declare class FailoverGlobalClusterCommand extends FailoverGlobalClusterCommand_base {

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

@@ -101,32 +101,32 @@ declare const ListTagsForResourceCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To list tags on an Amazon RDS resource
  * ```javascript
  * // The following example lists all tags on a DB instance.
  * const input = {
- *   "ResourceName": "arn:aws:rds:us-east-1:123456789012:db:orcl1"
+ *   ResourceName: "arn:aws:rds:us-east-1:123456789012:db:orcl1"
  * };
  * const command = new ListTagsForResourceCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "TagList": [
+ *   TagList: [
  *     {
- *       "Key": "Environment",
- *       "Value": "test"
+ *       Key: "Environment",
+ *       Value: "test"
  *     },
  *     {
- *       "Key": "Name",
- *       "Value": "MyDatabase"
+ *       Key: "Name",
+ *       Value: "MyDatabase"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-list-tags-on-an-amazon-rds-resource-1680285113240
  * ```
  *
+ * @public
  */
 export declare class ListTagsForResourceCommand extends ListTagsForResourceCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -74,6 +74,7 @@ declare const ModifyActivityStreamCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
+ *
  * @public
  */
 export declare class ModifyActivityStreamCommand extends ModifyActivityStreamCommand_base {

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

@@ -93,32 +93,32 @@ declare const ModifyCertificatesCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To temporarily override the system-default SSL/TLS certificate for new DB instances
  * ```javascript
  * // The following example temporarily overrides the system-default SSL/TLS certificate for new DB instances.
  * const input = {
- *   "CertificateIdentifier": "rds-ca-2019"
+ *   CertificateIdentifier: "rds-ca-2019"
  * };
  * const command = new ModifyCertificatesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Certificate": {
- *     "CertificateArn": "arn:aws:rds:us-east-1::cert:rds-ca-2019",
- *     "CertificateIdentifier": "rds-ca-2019",
- *     "CertificateType": "CA",
- *     "CustomerOverride": true,
- *     "CustomerOverrideValidTill": "2024-08-22T17:08:50Z",
- *     "Thumbprint": "EXAMPLE123456789012",
- *     "ValidFrom": "2019-09-19T18:16:53Z",
- *     "ValidTill": "2024-08-22T17:08:50Z"
+ *   Certificate: {
+ *     CertificateArn: "arn:aws:rds:us-east-1::cert:rds-ca-2019",
+ *     CertificateIdentifier: "rds-ca-2019",
+ *     CertificateType: "CA",
+ *     CustomerOverride: true,
+ *     CustomerOverrideValidTill: "2024-08-22T17:08:50Z",
+ *     Thumbprint: "EXAMPLE123456789012",
+ *     ValidFrom: "2019-09-19T18:16:53Z",
+ *     ValidTill: "2024-08-22T17:08:50Z"
  *   }
  * }
  * *\/
- * // example id: to-temporarily-override-the-system-default-ssltls-certificate-for-new-db-instances-1680306491984
  * ```
  *
+ * @public
  */
 export declare class ModifyCertificatesCommand extends ModifyCertificatesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -91,28 +91,28 @@ declare const ModifyCurrentDBClusterCapacityCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To scale the capacity of an Aurora Serverless DB cluster
  * ```javascript
  * // The following example scales the capacity of an Aurora Serverless DB cluster to 8.
  * const input = {
- *   "Capacity": 8,
- *   "DBClusterIdentifier": "mydbcluster"
+ *   Capacity: 8,
+ *   DBClusterIdentifier: "mydbcluster"
  * };
  * const command = new ModifyCurrentDBClusterCapacityCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "CurrentCapacity": 1,
- *   "DBClusterIdentifier": "mydbcluster",
- *   "PendingCapacity": 8,
- *   "SecondsBeforeTimeout": 300,
- *   "TimeoutAction": "ForceApplyCapacityChange"
+ *   CurrentCapacity: 1,
+ *   DBClusterIdentifier: "mydbcluster",
+ *   PendingCapacity: 8,
+ *   SecondsBeforeTimeout: 300,
+ *   TimeoutAction: "ForceApplyCapacityChange"
  * }
  * *\/
- * // example id: to-scale-the-capacity-of-an-aurora-serverless-db-cluster-1680307179599
  * ```
  *
+ * @public
  */
 export declare class ModifyCurrentDBClusterCapacityCommand extends ModifyCurrentDBClusterCapacityCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -161,6 +161,7 @@ declare const ModifyCustomDBEngineVersionCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
+ *
  * @public
  */
 export declare class ModifyCustomDBEngineVersionCommand extends ModifyCustomDBEngineVersionCommand_base {