@aws-sdk/client-rds 3.306.0 → 3.309.0

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

@@ -57,69 +57,147 @@ export interface DescribeSourceRegionsCommandOutput extends SourceRegionMessage,
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  *
- * @example To describe source regions
+ * @example To describe source Regions
  * ```javascript
- * // To list the AWS regions where a Read Replica can be created.
- * const input = {};
+ * // 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"
+ * };
  * const command = new DescribeSourceRegionsCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
  *   "SourceRegions": [
  *     {
+ *       "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-northeast-1.amazonaws.com",
  *       "RegionName": "ap-northeast-1",
- *       "Status": "available"
+ *       "Status": "available",
+ *       "SupportsDBInstanceAutomatedBackupsReplication": true
  *     },
  *     {
  *       "Endpoint": "https://rds.ap-northeast-2.amazonaws.com",
  *       "RegionName": "ap-northeast-2",
- *       "Status": "available"
+ *       "Status": "available",
+ *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *     },
+ *     {
+ *       "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"
+ *       "Status": "available",
+ *       "SupportsDBInstanceAutomatedBackupsReplication": true
  *     },
  *     {
  *       "Endpoint": "https://rds.ap-southeast-1.amazonaws.com",
  *       "RegionName": "ap-southeast-1",
- *       "Status": "available"
+ *       "Status": "available",
+ *       "SupportsDBInstanceAutomatedBackupsReplication": true
  *     },
  *     {
  *       "Endpoint": "https://rds.ap-southeast-2.amazonaws.com",
  *       "RegionName": "ap-southeast-2",
- *       "Status": "available"
+ *       "Status": "available",
+ *       "SupportsDBInstanceAutomatedBackupsReplication": true
+ *     },
+ *     {
+ *       "Endpoint": "https://rds.ap-southeast-3.amazonaws.com",
+ *       "RegionName": "ap-southeast-3",
+ *       "Status": "available",
+ *       "SupportsDBInstanceAutomatedBackupsReplication": false
  *     },
  *     {
- *       "Endpoint": "https://rds.eu-central-1.amazonaws.com",
- *       "RegionName": "eu-central-1",
- *       "Status": "available"
+ *       "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-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"
+ *       "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.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.sa-east-1.amazonaws.com",
  *       "RegionName": "sa-east-1",
- *       "Status": "available"
+ *       "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"
+ *       "Status": "available",
+ *       "SupportsDBInstanceAutomatedBackupsReplication": true
  *     },
  *     {
  *       "Endpoint": "https://rds.us-west-2.amazonaws.com",
  *       "RegionName": "us-west-2",
- *       "Status": "available"
+ *       "Status": "available",
+ *       "SupportsDBInstanceAutomatedBackupsReplication": true
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-source-regions-1473457722410
+ * // example id: to-describe-source-regions-1680283924227
  * ```
  *
  */

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

@@ -49,6 +49,40 @@ export interface DescribeValidDBInstanceModificationsCommandOutput extends Descr
  *  <p>The DB instance isn't in a valid state.</p>
  *
  *
+ * @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"
+ * };
+ * const command = new DescribeValidDBInstanceModificationsCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ValidDBInstanceModificationsMessage": {
+ *     "Storage": [
+ *       {
+ *         "StorageSize": [
+ *           {
+ *             "From": 20,
+ *             "Step": 1,
+ *             "To": 20
+ *           },
+ *           {
+ *             "From": 22,
+ *             "Step": 1,
+ *             "To": 6144
+ *           }
+ *         ],
+ *         "StorageType": "gp2"
+ *       }
+ *     ]
+ *   }
+ * }
+ * *\/
+ * // example id: to-describe-valid-modifications-for-a-db-instance-1680284230997
+ * ```
+ *
  */
 export declare class DescribeValidDBInstanceModificationsCommand extends $Command<DescribeValidDBInstanceModificationsCommandInput, DescribeValidDBInstanceModificationsCommandOutput, RDSClientResolvedConfig> {
     readonly input: DescribeValidDBInstanceModificationsCommandInput;

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

@@ -52,16 +52,16 @@ export interface DownloadDBLogFilePortionCommandOutput extends DownloadDBLogFile
  *             <code>LogFileName</code> doesn't refer to an existing DB log file.</p>
  *
  *
- * @example To list information about DB log files
+ * @example To download a DB log file
  * ```javascript
- * // This example lists information for the specified log file for the specified DB instance.
+ * // The following example downloads only the latest part of your log file.
  * const input = {
- *   "DBInstanceIdentifier": "mymysqlinstance",
- *   "LogFileName": "mysqlUpgrade"
+ *   "DBInstanceIdentifier": "test-instance",
+ *   "LogFileName": "log.txt"
  * };
  * const command = new DownloadDBLogFilePortionCommand(input);
  * await client.send(command);
- * // example id: download-db-log-file-portion-54a82731-a441-4fc7-a010-8eccae6fa202
+ * // example id: to-download-a-db-log-file-1680284895898
  * ```
  *
  */

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

@@ -73,15 +73,29 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta
  *             <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
  *
  *
- * @example To list information about tags associated with a resource
+ * @example To list tags on an Amazon RDS resource
  * ```javascript
- * // This example lists information about all tags associated with the specified DB option group.
+ * // The following example lists all tags on a DB instance.
  * const input = {
- *   "ResourceName": "arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup"
+ *   "ResourceName": "arn:aws:rds:us-east-1:123456789012:db:orcl1"
  * };
  * const command = new ListTagsForResourceCommand(input);
- * await client.send(command);
- * // example id: list-tags-for-resource-8401f3c2-77cd-4f90-bfd5-b523f0adcc2f
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "TagList": [
+ *     {
+ *       "Key": "Environment",
+ *       "Value": "test"
+ *     },
+ *     {
+ *       "Key": "Name",
+ *       "Value": "MyDatabase"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-tags-on-an-amazon-rds-resource-1680285113240
  * ```
  *
  */

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

@@ -70,6 +70,31 @@ export interface ModifyCertificatesCommandOutput extends ModifyCertificatesResul
  *         existing certificate.</p>
  *
  *
+ * @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"
+ * };
+ * const command = new ModifyCertificatesCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "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
+ * ```
+ *
  */
 export declare class ModifyCertificatesCommand extends $Command<ModifyCertificatesCommandInput, ModifyCertificatesCommandOutput, RDSClientResolvedConfig> {
     readonly input: ModifyCertificatesCommandInput;

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

@@ -73,6 +73,27 @@ export interface ModifyCurrentDBClusterCapacityCommandOutput extends DBClusterCa
  *  <p>The requested operation can't be performed while the cluster is in this state.</p>
  *
  *
+ * @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"
+ * };
+ * const command = new ModifyCurrentDBClusterCapacityCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CurrentCapacity": 1,
+ *   "DBClusterIdentifier": "mydbcluster",
+ *   "PendingCapacity": 8,
+ *   "SecondsBeforeTimeout": 300,
+ *   "TimeoutAction": "ForceApplyCapacityChange"
+ * }
+ * *\/
+ * // example id: to-scale-the-capacity-of-an-aurora-serverless-db-cluster-1680307179599
+ * ```
+ *
  */
 export declare class ModifyCurrentDBClusterCapacityCommand extends $Command<ModifyCurrentDBClusterCapacityCommandInput, ModifyCurrentDBClusterCapacityCommandOutput, RDSClientResolvedConfig> {
     readonly input: ModifyCurrentDBClusterCapacityCommandInput;

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

@@ -148,25 +148,76 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
  *             available across all DB instances.</p>
  *
  *
- * @example To change DB cluster settings
+ * @example To modify a DB cluster
  * ```javascript
- * // This example changes the specified settings for the specified DB cluster.
+ * // The following example changes the master user password for the DB cluster named cluster-2 and sets the backup retention period to 14 days. The ApplyImmediately parameter causes the changes to be made immediately, instead of waiting until the next maintenance window.
  * const input = {
  *   "ApplyImmediately": true,
- *   "DBClusterIdentifier": "mydbcluster",
- *   "MasterUserPassword": "mynewpassword",
- *   "NewDBClusterIdentifier": "mynewdbcluster",
- *   "PreferredBackupWindow": "04:00-04:30",
- *   "PreferredMaintenanceWindow": "Tue:05:00-Tue:05:30"
+ *   "BackupRetentionPeriod": 14,
+ *   "DBClusterIdentifier": "cluster-2",
+ *   "MasterUserPassword": "newpassword99"
  * };
  * const command = new ModifyDBClusterCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "DBCluster": {}
+ *   "DBCluster": {
+ *     "AllocatedStorage": 1,
+ *     "AssociatedRoles": [],
+ *     "AvailabilityZones": [
+ *       "eu-central-1b",
+ *       "eu-central-1c",
+ *       "eu-central-1a"
+ *     ],
+ *     "BackupRetentionPeriod": 14,
+ *     "ClusterCreateTime": "2020-04-03T14:44:02.764Z",
+ *     "CopyTagsToSnapshot": true,
+ *     "CrossAccountClone": false,
+ *     "DBClusterArn": "arn:aws:rds:eu-central-1:123456789012:cluster:cluster-2",
+ *     "DBClusterIdentifier": "cluster-2",
+ *     "DBClusterMembers": [
+ *       {
+ *         "DBClusterParameterGroupStatus": "in-sync",
+ *         "DBInstanceIdentifier": "cluster-2-instance-1",
+ *         "IsClusterWriter": true,
+ *         "PromotionTier": 1
+ *       }
+ *     ],
+ *     "DBClusterParameterGroup": "default.aurora5.6",
+ *     "DBSubnetGroup": "default-vpc-2305ca49",
+ *     "DatabaseName": "",
+ *     "DbClusterResourceId": "cluster-AGJ7XI77XVIS6FUXHU1EXAMPLE",
+ *     "DeletionProtection": false,
+ *     "DomainMemberships": [],
+ *     "EarliestRestorableTime": "2020-06-03T02:07:29.637Z",
+ *     "Endpoint": "cluster-2.cluster-############.eu-central-1.rds.amazonaws.com",
+ *     "Engine": "aurora",
+ *     "EngineMode": "provisioned",
+ *     "EngineVersion": "5.6.10a",
+ *     "HostedZoneId": "Z1RLNU0EXAMPLE",
+ *     "HttpEndpointEnabled": false,
+ *     "IAMDatabaseAuthenticationEnabled": false,
+ *     "KmsKeyId": "arn:aws:kms:eu-central-1:123456789012:key/d1bd7c8f-5cdb-49ca-8a62-a1b2c3d4e5f6",
+ *     "LatestRestorableTime": "2020-06-04T15:11:25.748Z",
+ *     "MasterUsername": "admin",
+ *     "MultiAZ": false,
+ *     "Port": 3306,
+ *     "PreferredBackupWindow": "01:55-02:25",
+ *     "PreferredMaintenanceWindow": "thu:21:14-thu:21:44",
+ *     "ReadReplicaIdentifiers": [],
+ *     "ReaderEndpoint": "cluster-2.cluster-ro-############.eu-central-1.rds.amazonaws.com",
+ *     "Status": "available",
+ *     "StorageEncrypted": true,
+ *     "VpcSecurityGroups": [
+ *       {
+ *         "Status": "active",
+ *         "VpcSecurityGroupId": "sg-20a5c047"
+ *       }
+ *     ]
+ *   }
  * }
  * *\/
- * // example id: modify-db-cluster-a370ee1b-768d-450a-853b-707cb1ab663d
+ * // example id: to-modify-a-db-cluster-1680310823999
  * ```
  *
  */

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

@@ -67,6 +67,40 @@ export interface ModifyDBClusterEndpointCommandOutput extends DBClusterEndpoint,
  *  <p>The DB instance isn't in a valid state.</p>
  *
  *
+ * @example To modify a custom DB cluster endpoint
+ * ```javascript
+ * // The following example modifies the specified custom DB cluster endpoint.
+ * const input = {
+ *   "DBClusterEndpointIdentifier": "mycustomendpoint",
+ *   "StaticMembers": [
+ *     "dbinstance1",
+ *     "dbinstance2",
+ *     "dbinstance3"
+ *   ]
+ * };
+ * const command = new ModifyDBClusterEndpointCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "CustomEndpointType": "READER",
+ *   "DBClusterEndpointArn": "arn:aws:rds:us-east-1:123456789012:cluster-endpoint:mycustomendpoint",
+ *   "DBClusterEndpointIdentifier": "mycustomendpoint",
+ *   "DBClusterEndpointResourceIdentifier": "cluster-endpoint-ANPAJ4AE5446DAEXAMPLE",
+ *   "DBClusterIdentifier": "mydbcluster",
+ *   "Endpoint": "mycustomendpoint.cluster-custom-cnpexample.us-east-1.rds.amazonaws.com",
+ *   "EndpointType": "CUSTOM",
+ *   "ExcludedMembers": [],
+ *   "StaticMembers": [
+ *     "dbinstance1",
+ *     "dbinstance2",
+ *     "dbinstance3"
+ *   ],
+ *   "Status": "modifying"
+ * }
+ * *\/
+ * // example id: to-modify-a-custom-db-cluster-endpoint-1680307652958
+ * ```
+ *
  */
 export declare class ModifyDBClusterEndpointCommand extends $Command<ModifyDBClusterEndpointCommandInput, ModifyDBClusterEndpointCommandOutput, RDSClientResolvedConfig> {
     readonly input: ModifyDBClusterEndpointCommandInput;

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

@@ -92,22 +92,32 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
  *             this state.</p>
  *
  *
- * @example To change DB cluster parameter group settings
+ * @example To modify parameters in a DB cluster parameter group
  * ```javascript
- * // This example immediately changes the specified setting for the specified DB cluster parameter group.
+ * // The following example modifies the values of parameters in a DB cluster parameter group.
  * const input = {
- *   "DBClusterParameterGroupName": "mydbclusterparametergroup",
+ *   "DBClusterParameterGroupName": "mydbclusterpg",
  *   "Parameters": [
  *     {
  *       "ApplyMethod": "immediate",
- *       "ParameterName": "time_zone",
- *       "ParameterValue": "America/Phoenix"
+ *       "ParameterName": "server_audit_logging",
+ *       "ParameterValue": "1"
+ *     },
+ *     {
+ *       "ApplyMethod": "immediate",
+ *       "ParameterName": "server_audit_logs_upload",
+ *       "ParameterValue": "1"
  *     }
  *   ]
  * };
  * const command = new ModifyDBClusterParameterGroupCommand(input);
- * await client.send(command);
- * // example id: modify-db-cluster-parameter-group-f9156bc9-082a-442e-8d12-239542c1a113
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBClusterParameterGroupName": "mydbclusterpg"
+ * }
+ * *\/
+ * // example id: to-modify-parameters-in-a-db-cluster-parameter-group-1680377584537
  * ```
  *
  */

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

@@ -75,28 +75,34 @@ export interface ModifyDBClusterSnapshotAttributeCommandOutput extends ModifyDBC
  *  <p>You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.</p>
  *
  *
- * @example To add or remove access to a manual DB cluster snapshot
+ * @example To modify a DB cluster snapshot attribute
  * ```javascript
- * // The following example gives two AWS accounts access to a manual DB cluster snapshot and ensures that the DB cluster snapshot is private by removing the value "all".
+ * // The following example makes changes to the specified DB cluster snapshot attribute.
  * const input = {
  *   "AttributeName": "restore",
- *   "DBClusterSnapshotIdentifier": "manual-cluster-snapshot1",
+ *   "DBClusterSnapshotIdentifier": "myclustersnapshot",
  *   "ValuesToAdd": [
- *     "123451234512",
  *     "123456789012"
- *   ],
- *   "ValuesToRemove": [
- *     "all"
  *   ]
  * };
  * const command = new ModifyDBClusterSnapshotAttributeCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "DBClusterSnapshotAttributesResult": {}
+ *   "DBClusterSnapshotAttributesResult": {
+ *     "DBClusterSnapshotAttributes": [
+ *       {
+ *         "AttributeName": "restore",
+ *         "AttributeValues": [
+ *           "123456789012"
+ *         ]
+ *       }
+ *     ],
+ *     "DBClusterSnapshotIdentifier": "myclustersnapshot"
+ *   }
  * }
  * *\/
- * // example id: to-add-or-remove-access-to-a-manual-db-cluster-snapshot-1473889426431
+ * // example id: to-modify-a-db-cluster-snapshot-attribute-1680310358770
  * ```
  *
  */

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

@@ -185,27 +185,53 @@ export interface ModifyDBInstanceCommandOutput extends ModifyDBInstanceResult, _
  *             with the DB instance.</p>
  *
  *
- * @example To change DB instance settings
+ * @example To modify parameters in a DB cluster parameter group
  * ```javascript
- * // This example immediately changes the specified settings for the specified DB instance.
+ * // The following example associates an option group and a parameter group with a compatible Microsoft SQL Server DB instance. The ApplyImmediately parameter causes the option and parameter groups to be associated immediately, instead of waiting until the next maintenance window.
  * const input = {
- *   "AllocatedStorage": 10,
  *   "ApplyImmediately": true,
- *   "BackupRetentionPeriod": 1,
- *   "DBInstanceClass": "db.t2.small",
- *   "DBInstanceIdentifier": "mymysqlinstance",
- *   "MasterUserPassword": "mynewpassword",
- *   "PreferredBackupWindow": "04:00-04:30",
- *   "PreferredMaintenanceWindow": "Tue:05:00-Tue:05:30"
+ *   "DBInstanceIdentifier": "database-2",
+ *   "DBParameterGroupName": "test-sqlserver-se-2017",
+ *   "OptionGroupName": "test-se-2017"
  * };
  * const command = new ModifyDBInstanceCommand(input);
  * const response = await client.send(command);
  * /* response ==
  * {
- *   "DBInstance": {}
+ *   "DBInstance": {
+ *     "AssociatedRoles": [],
+ *     "AutoMinorVersionUpgrade": false,
+ *     "AvailabilityZone": "us-west-2d",
+ *     "CharacterSetName": "SQL_Latin1_General_CP1_CI_AS",
+ *     "DBInstanceClass": "db.r4.large",
+ *     "DBInstanceIdentifier": "database-2",
+ *     "DBInstanceStatus": "available",
+ *     "DBParameterGroups": [
+ *       {
+ *         "DBParameterGroupName": "test-sqlserver-se-2017",
+ *         "ParameterApplyStatus": "applying"
+ *       }
+ *     ],
+ *     "DeletionProtection": false,
+ *     "Engine": "sqlserver-se",
+ *     "EngineVersion": "14.00.3281.6.v1",
+ *     "LicenseModel": "license-included",
+ *     "MaxAllocatedStorage": 1000,
+ *     "MultiAZ": true,
+ *     "OptionGroupMemberships": [
+ *       {
+ *         "OptionGroupName": "test-se-2017",
+ *         "Status": "pending-apply"
+ *       }
+ *     ],
+ *     "PubliclyAccessible": true,
+ *     "ReadReplicaDBInstanceIdentifiers": [],
+ *     "SecondaryAvailabilityZone": "us-west-2c",
+ *     "StorageType": "gp2"
+ *   }
  * }
  * *\/
- * // example id: modify-db-instance-6979a368-6254-467b-8a8d-61103f4fcde9
+ * // example id: to-modify-parameters-in-a-db-cluster-parameter-group-1680377584537
  * ```
  *
  */

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

@@ -80,22 +80,27 @@ export interface ModifyDBParameterGroupCommandOutput extends DBParameterGroupNam
  *             this state.</p>
  *
  *
- * @example To change DB parameter group settings
+ * @example To modify a DB parameter group
  * ```javascript
- * // This example immediately changes the specified setting for the specified DB parameter group.
+ * // The following example changes the value of the clr enabled parameter in a DB parameter group. The value of the ApplyMethod parameter causes the DB parameter group to be modified immediately, instead of waiting until the next maintenance window.
  * const input = {
- *   "DBParameterGroupName": "mymysqlparametergroup",
+ *   "DBParameterGroupName": "test-sqlserver-se-2017",
  *   "Parameters": [
  *     {
  *       "ApplyMethod": "immediate",
- *       "ParameterName": "time_zone",
- *       "ParameterValue": "America/Phoenix"
+ *       "ParameterName": "clr enabled",
+ *       "ParameterValue": "1"
  *     }
  *   ]
  * };
  * const command = new ModifyDBParameterGroupCommand(input);
- * await client.send(command);
- * // example id: modify-db-parameter-group-f3a4e52a-68e4-4b88-b559-f912d34c457a
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "DBParameterGroupName": "test-sqlserver-se-2017"
+ * }
+ * *\/
+ * // example id: to-modify-a-db-parameter-group-1680382937235
  * ```
  *
  */