@aws-sdk/client-rds 3.776.0 → 3.777.0

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

@@ -87,44 +87,44 @@ declare const DescribeDBParametersCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To describe the parameters in a DB parameter group
  * ```javascript
  * // The following example retrieves the details of the specified DB parameter group.
  * const input = {
- *   "DBParameterGroupName": "mydbpg"
+ *   DBParameterGroupName: "mydbpg"
  * };
  * const command = new DescribeDBParametersCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "Parameters": [
+ *   Parameters: [
  *     {
- *       "AllowedValues": "0,1",
- *       "ApplyMethod": "pending-reboot",
- *       "ApplyType": "static",
- *       "DataType": "boolean",
- *       "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded",
- *       "IsModifiable": false,
- *       "ParameterName": "allow-suspicious-udfs",
- *       "Source": "engine-default"
+ *       AllowedValues: "0,1",
+ *       ApplyMethod: "pending-reboot",
+ *       ApplyType: "static",
+ *       DataType: "boolean",
+ *       Description: "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded",
+ *       IsModifiable: false,
+ *       ParameterName: "allow-suspicious-udfs",
+ *       Source: "engine-default"
  *     },
  *     {
- *       "AllowedValues": "0,1",
- *       "ApplyMethod": "pending-reboot",
- *       "ApplyType": "static",
- *       "DataType": "boolean",
- *       "Description": "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.",
- *       "IsModifiable": false,
- *       "ParameterName": "auto_generate_certs",
- *       "Source": "engine-default"
+ *       AllowedValues: "0,1",
+ *       ApplyMethod: "pending-reboot",
+ *       ApplyType: "static",
+ *       DataType: "boolean",
+ *       Description: "Controls whether the server autogenerates SSL key and certificate files in the data directory, if they do not already exist.",
+ *       IsModifiable: false,
+ *       ParameterName: "auto_generate_certs",
+ *       Source: "engine-default"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-the-parameters-in-a-db-parameter-group-1680279500600
  * ```
  *
+ * @public
  */
 export declare class DescribeDBParametersCommand extends DescribeDBParametersCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

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

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

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

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

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

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

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

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

@@ -99,18 +99,21 @@ declare const DescribeDBSecurityGroupsCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To list DB security group settings
  * ```javascript
  * // This example lists settings for the specified security group.
  * const input = {
- *   "DBSecurityGroupName": "mydbsecuritygroup"
+ *   DBSecurityGroupName: "mydbsecuritygroup"
  * };
  * const command = new DescribeDBSecurityGroupsCommand(input);
- * await client.send(command);
- * // example id: describe-db-security-groups-66fe9ea1-17dd-4275-b82e-f771cee0c849
+ * const response = await client.send(command);
+ * /* response is
+ * { /* empty *\/ }
+ * *\/
  * ```
  *
+ * @public
  */
 export declare class DescribeDBSecurityGroupsCommand extends DescribeDBSecurityGroupsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

@@ -75,34 +75,34 @@ declare const DescribeDBSnapshotAttributesCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To describe the attribute names and values for a DB snapshot
  * ```javascript
  * // The following example describes the attribute names and values for a DB snapshot.
  * const input = {
- *   "DBSnapshotIdentifier": "mydbsnapshot"
+ *   DBSnapshotIdentifier: "mydbsnapshot"
  * };
  * const command = new DescribeDBSnapshotAttributesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "DBSnapshotAttributesResult": {
- *     "DBSnapshotAttributes": [
+ *   DBSnapshotAttributesResult: {
+ *     DBSnapshotAttributes: [
  *       {
- *         "AttributeName": "restore",
- *         "AttributeValues": [
+ *         AttributeName: "restore",
+ *         AttributeValues: [
  *           "123456789012",
  *           "210987654321"
  *         ]
  *       }
  *     ],
- *     "DBSnapshotIdentifier": "mydbsnapshot"
+ *     DBSnapshotIdentifier: "mydbsnapshot"
  *   }
  * }
  * *\/
- * // example id: to-describe-the-attribute-names-and-values-for-a-db-snapshot-1680280194370
  * ```
  *
+ * @public
  */
 export declare class DescribeDBSnapshotAttributesCommand extends DescribeDBSnapshotAttributesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

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

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

@@ -123,48 +123,48 @@ declare const DescribeDBSnapshotsCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To describe a DB snapshot for a DB instance
  * ```javascript
  * // The following example retrieves the details of a DB snapshot for a DB instance.
  * const input = {
- *   "DBSnapshotIdentifier": "mydbsnapshot"
+ *   DBSnapshotIdentifier: "mydbsnapshot"
  * };
  * const command = new DescribeDBSnapshotsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "DBSnapshots": [
+ *   DBSnapshots: [
  *     {
- *       "AllocatedStorage": 20,
- *       "AvailabilityZone": "us-east-1f",
- *       "DBInstanceIdentifier": "mysqldb",
- *       "DBSnapshotArn": "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot",
- *       "DBSnapshotIdentifier": "mydbsnapshot",
- *       "DbiResourceId": "db-AKIAIOSFODNN7EXAMPLE",
- *       "Encrypted": false,
- *       "Engine": "mysql",
- *       "EngineVersion": "5.6.37",
- *       "IAMDatabaseAuthenticationEnabled": false,
- *       "InstanceCreateTime": "2018-02-08T22:24:55.973Z",
- *       "LicenseModel": "general-public-license",
- *       "MasterUsername": "mysqladmin",
- *       "OptionGroupName": "default:mysql-5-6",
- *       "PercentProgress": 100,
- *       "Port": 3306,
- *       "ProcessorFeatures": [],
- *       "SnapshotCreateTime": "2018-02-08T22:28:08.598Z",
- *       "SnapshotType": "manual",
- *       "Status": "available",
- *       "StorageType": "gp2",
- *       "VpcId": "vpc-6594f31c"
+ *       AllocatedStorage: 20,
+ *       AvailabilityZone: "us-east-1f",
+ *       DBInstanceIdentifier: "mysqldb",
+ *       DBSnapshotArn: "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot",
+ *       DBSnapshotIdentifier: "mydbsnapshot",
+ *       DbiResourceId: "db-AKIAIOSFODNN7EXAMPLE",
+ *       Encrypted: false,
+ *       Engine: "mysql",
+ *       EngineVersion: "5.6.37",
+ *       IAMDatabaseAuthenticationEnabled: false,
+ *       InstanceCreateTime: "2018-02-08T22:24:55.973Z",
+ *       LicenseModel: "general-public-license",
+ *       MasterUsername: "mysqladmin",
+ *       OptionGroupName: "default:mysql-5-6",
+ *       PercentProgress: 100,
+ *       Port: 3306,
+ *       ProcessorFeatures:       [],
+ *       SnapshotCreateTime: "2018-02-08T22:28:08.598Z",
+ *       SnapshotType: "manual",
+ *       Status: "available",
+ *       StorageType: "gp2",
+ *       VpcId: "vpc-6594f31c"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-a-db-snapshot-for-a-db-instance-1680280423239
  * ```
  *
+ * @public
  */
 export declare class DescribeDBSnapshotsCommand extends DescribeDBSnapshotsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -94,59 +94,59 @@ declare const DescribeDBSubnetGroupsCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To describe a DB subnet group
  * ```javascript
  * // The following example retrieves the details of the specified DB subnet group.
- * const input = {};
+ * const input = { /* empty *\/ };
  * const command = new DescribeDBSubnetGroupsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "DBSubnetGroups": [
+ *   DBSubnetGroups: [
  *     {
- *       "DBSubnetGroupArn": "arn:aws:rds:us-east-1:123456789012:subgrp:mydbsubnetgroup",
- *       "DBSubnetGroupDescription": "My DB Subnet Group",
- *       "DBSubnetGroupName": "mydbsubnetgroup",
- *       "SubnetGroupStatus": "Complete",
- *       "Subnets": [
+ *       DBSubnetGroupArn: "arn:aws:rds:us-east-1:123456789012:subgrp:mydbsubnetgroup",
+ *       DBSubnetGroupDescription: "My DB Subnet Group",
+ *       DBSubnetGroupName: "mydbsubnetgroup",
+ *       SubnetGroupStatus: "Complete",
+ *       Subnets: [
  *         {
- *           "SubnetAvailabilityZone": {
- *             "Name": "us-east-1a"
+ *           SubnetAvailabilityZone: {
+ *             Name: "us-east-1a"
  *           },
- *           "SubnetIdentifier": "subnet-d8c8e7f4",
- *           "SubnetStatus": "Active"
+ *           SubnetIdentifier: "subnet-d8c8e7f4",
+ *           SubnetStatus: "Active"
  *         },
  *         {
- *           "SubnetAvailabilityZone": {
- *             "Name": "us-east-1f"
+ *           SubnetAvailabilityZone: {
+ *             Name: "us-east-1f"
  *           },
- *           "SubnetIdentifier": "subnet-718fdc7d",
- *           "SubnetStatus": "Active"
+ *           SubnetIdentifier: "subnet-718fdc7d",
+ *           SubnetStatus: "Active"
  *         },
  *         {
- *           "SubnetAvailabilityZone": {
- *             "Name": "us-east-1a"
+ *           SubnetAvailabilityZone: {
+ *             Name: "us-east-1a"
  *           },
- *           "SubnetIdentifier": "subnet-cbc8e7e7",
- *           "SubnetStatus": "Active"
+ *           SubnetIdentifier: "subnet-cbc8e7e7",
+ *           SubnetStatus: "Active"
  *         },
  *         {
- *           "SubnetAvailabilityZone": {
- *             "Name": "us-east-1a"
+ *           SubnetAvailabilityZone: {
+ *             Name: "us-east-1a"
  *           },
- *           "SubnetIdentifier": "subnet-0ccde220",
- *           "SubnetStatus": "Active"
+ *           SubnetIdentifier: "subnet-0ccde220",
+ *           SubnetStatus: "Active"
  *         }
  *       ],
- *       "VpcId": "vpc-971c12ee"
+ *       VpcId: "vpc-971c12ee"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-a-db-subnet-group-1680280764611
  * ```
  *
+ * @public
  */
 export declare class DescribeDBSubnetGroupsCommand extends DescribeDBSubnetGroupsCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -87,27 +87,27 @@ declare const DescribeEngineDefaultClusterParametersCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To describe the default engine and system parameter information for the Aurora database engine
  * ```javascript
  * // The following example retrieves the details of the default engine and system parameter information for Aurora DB clusters with MySQL 5.7 compatibility.
  * const input = {
- *   "DBParameterGroupFamily": "aurora-mysql5.7"
+ *   DBParameterGroupFamily: "aurora-mysql5.7"
  * };
  * const command = new DescribeEngineDefaultClusterParametersCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "EngineDefaults": {
- *     "Parameters": [
+ *   EngineDefaults: {
+ *     Parameters: [
  *       {
- *         "ApplyType": "dynamic",
- *         "DataType": "string",
- *         "Description": "IAM role ARN used to load data from AWS S3",
- *         "IsModifiable": true,
- *         "ParameterName": "aurora_load_from_s3_role",
- *         "Source": "engine-default",
- *         "SupportedEngineModes": [
+ *         ApplyType: "dynamic",
+ *         DataType: "string",
+ *         Description: "IAM role ARN used to load data from AWS S3",
+ *         IsModifiable: true,
+ *         ParameterName: "aurora_load_from_s3_role",
+ *         Source: "engine-default",
+ *         SupportedEngineModes: [
  *           "provisioned"
  *         ]
  *       }
@@ -115,9 +115,9 @@ declare const DescribeEngineDefaultClusterParametersCommand_base: {
  *   }
  * }
  * *\/
- * // example id: to-describe-the-default-engine-and-system-parameter-information-for-the-aurora-database-engine-1680280902332
  * ```
  *
+ * @public
  */
 export declare class DescribeEngineDefaultClusterParametersCommand extends DescribeEngineDefaultClusterParametersCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -84,35 +84,35 @@ declare const DescribeEngineDefaultParametersCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To describe the default engine and system parameter information for the database engine
  * ```javascript
  * // The following example retrieves details for the default engine and system parameter information for MySQL 5.7 DB instances.
  * const input = {
- *   "DBParameterGroupFamily": "mysql5.7"
+ *   DBParameterGroupFamily: "mysql5.7"
  * };
  * const command = new DescribeEngineDefaultParametersCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "EngineDefaults": {
- *     "Parameters": [
+ *   EngineDefaults: {
+ *     Parameters: [
  *       {
- *         "AllowedValues": "0,1",
- *         "ApplyType": "static",
- *         "DataType": "boolean",
- *         "Description": "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded",
- *         "IsModifiable": false,
- *         "ParameterName": "allow-suspicious-udfs",
- *         "Source": "engine-default"
+ *         AllowedValues: "0,1",
+ *         ApplyType: "static",
+ *         DataType: "boolean",
+ *         Description: "Controls whether user-defined functions that have only an xxx symbol for the main function can be loaded",
+ *         IsModifiable: false,
+ *         ParameterName: "allow-suspicious-udfs",
+ *         Source: "engine-default"
  *       }
  *     ]
  *   }
  * }
  * *\/
- * // example id: to-describe-the-default-engine-and-system-parameter-information-for-the-database-engine-1680281248217
  * ```
  *
+ * @public
  */
 export declare class DescribeEngineDefaultParametersCommand extends DescribeEngineDefaultParametersCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -75,21 +75,21 @@ declare const DescribeEventCategoriesCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To describe event categories
  * ```javascript
  * // The following example retrieves details about the event categories for all available event sources.
  * const input = {
- *   "Filters": [],
- *   "SourceType": ""
+ *   Filters:   [],
+ *   SourceType: ""
  * };
  * const command = new DescribeEventCategoriesCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "EventCategoriesMapList": [
+ *   EventCategoriesMapList: [
  *     {
- *       "EventCategories": [
+ *       EventCategories: [
  *         "deletion",
  *         "read replica",
  *         "failover",
@@ -105,50 +105,50 @@ declare const DescribeEventCategoriesCommand_base: {
  *         "backtrack",
  *         "notification"
  *       ],
- *       "SourceType": "db-instance"
+ *       SourceType: "db-instance"
  *     },
  *     {
- *       "EventCategories": [
+ *       EventCategories: [
  *         "configuration change",
  *         "failure"
  *       ],
- *       "SourceType": "db-security-group"
+ *       SourceType: "db-security-group"
  *     },
  *     {
- *       "EventCategories": [
+ *       EventCategories: [
  *         "configuration change"
  *       ],
- *       "SourceType": "db-parameter-group"
+ *       SourceType: "db-parameter-group"
  *     },
  *     {
- *       "EventCategories": [
+ *       EventCategories: [
  *         "deletion",
  *         "creation",
  *         "restoration",
  *         "notification"
  *       ],
- *       "SourceType": "db-snapshot"
+ *       SourceType: "db-snapshot"
  *     },
  *     {
- *       "EventCategories": [
+ *       EventCategories: [
  *         "failover",
  *         "failure",
  *         "notification"
  *       ],
- *       "SourceType": "db-cluster"
+ *       SourceType: "db-cluster"
  *     },
  *     {
- *       "EventCategories": [
+ *       EventCategories: [
  *         "backup"
  *       ],
- *       "SourceType": "db-cluster-snapshot"
+ *       SourceType: "db-cluster-snapshot"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-event-categories-1680281431508
  * ```
  *
+ * @public
  */
 export declare class DescribeEventCategoriesCommand extends DescribeEventCategoriesCommand_base {
     /** @internal type navigation helper, not in runtime. */

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

@@ -87,36 +87,36 @@ declare const DescribeEventSubscriptionsCommand_base: {
  * @throws {@link RDSServiceException}
  * <p>Base exception class for all service exceptions from RDS service.</p>
  *
- * @public
+ *
  * @example To describe event subscriptions
  * ```javascript
  * // This example describes all of the Amazon RDS event subscriptions for the current AWS account.
- * const input = {};
+ * const input = { /* empty *\/ };
  * const command = new DescribeEventSubscriptionsCommand(input);
  * const response = await client.send(command);
- * /* response ==
+ * /* response is
  * {
- *   "EventSubscriptionsList": [
+ *   EventSubscriptionsList: [
  *     {
- *       "CustSubscriptionId": "my-instance-events",
- *       "CustomerAwsId": "123456789012",
- *       "Enabled": true,
- *       "EventCategoriesList": [
+ *       CustSubscriptionId: "my-instance-events",
+ *       CustomerAwsId: "123456789012",
+ *       Enabled: true,
+ *       EventCategoriesList: [
  *         "backup",
  *         "recovery"
  *       ],
- *       "EventSubscriptionArn": "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
- *       "SnsTopicArn": "arn:aws:sns:us-east-1:123456789012:interesting-events",
- *       "SourceType": "db-instance",
- *       "Status": "creating",
- *       "SubscriptionCreationTime": "2018-07-31 23:22:01.893"
+ *       EventSubscriptionArn: "arn:aws:rds:us-east-1:123456789012:es:my-instance-events",
+ *       SnsTopicArn: "arn:aws:sns:us-east-1:123456789012:interesting-events",
+ *       SourceType: "db-instance",
+ *       Status: "creating",
+ *       SubscriptionCreationTime: "2018-07-31 23:22:01.893"
  *     }
  *   ]
  * }
  * *\/
- * // example id: to-describe-event-subscriptions-1680281683538
  * ```
  *
+ * @public
  */
 export declare class DescribeEventSubscriptionsCommand extends DescribeEventSubscriptionsCommand_base {
     /** @internal type navigation helper, not in runtime. */