@aws-sdk/client-rds 3.306.0 → 3.309.0

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

@@ -54,15 +54,77 @@ export interface DescribeEventCategoriesCommandOutput extends EventCategoriesMes
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  *
- * @example To list event categories.
+ * @example To describe event categories
  * ```javascript
- * // This example lists all DB instance event categories.
+ * // The following example retrieves details about the event categories for all available event sources.
  * const input = {
- *   "SourceType": "db-instance"
+ *   "Filters": [],
+ *   "SourceType": ""
  * };
  * const command = new DescribeEventCategoriesCommand(input);
- * await client.send(command);
- * // example id: describe-event-categories-97bd4c77-12da-4be6-b42f-edf77771428b
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "EventCategoriesMapList": [
+ *     {
+ *       "EventCategories": [
+ *         "deletion",
+ *         "read replica",
+ *         "failover",
+ *         "restoration",
+ *         "maintenance",
+ *         "low storage",
+ *         "configuration change",
+ *         "backup",
+ *         "creation",
+ *         "availability",
+ *         "recovery",
+ *         "failure",
+ *         "backtrack",
+ *         "notification"
+ *       ],
+ *       "SourceType": "db-instance"
+ *     },
+ *     {
+ *       "EventCategories": [
+ *         "configuration change",
+ *         "failure"
+ *       ],
+ *       "SourceType": "db-security-group"
+ *     },
+ *     {
+ *       "EventCategories": [
+ *         "configuration change"
+ *       ],
+ *       "SourceType": "db-parameter-group"
+ *     },
+ *     {
+ *       "EventCategories": [
+ *         "deletion",
+ *         "creation",
+ *         "restoration",
+ *         "notification"
+ *       ],
+ *       "SourceType": "db-snapshot"
+ *     },
+ *     {
+ *       "EventCategories": [
+ *         "failover",
+ *         "failure",
+ *         "notification"
+ *       ],
+ *       "SourceType": "db-cluster"
+ *     },
+ *     {
+ *       "EventCategories": [
+ *         "backup"
+ *       ],
+ *       "SourceType": "db-cluster-snapshot"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-event-categories-1680281431508
  * ```
  *
  */

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

@@ -55,15 +55,33 @@ export interface DescribeEventSubscriptionsCommandOutput extends EventSubscripti
  *  <p>The subscription name does not exist.</p>
  *
  *
- * @example To list information about DB event notification subscriptions
+ * @example To describe event subscriptions
  * ```javascript
- * // This example lists information for the specified DB event notification subscription.
- * const input = {
- *   "SubscriptionName": "mymysqleventsubscription"
- * };
+ * // This example describes all of the Amazon RDS event subscriptions for the current AWS account.
+ * const input = {};
  * const command = new DescribeEventSubscriptionsCommand(input);
- * await client.send(command);
- * // example id: describe-event-subscriptions-11184a82-e58a-4d0c-b558-f3a7489e0850
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "EventSubscriptionsList": [
+ *     {
+ *       "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"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-event-subscriptions-1680281683538
  * ```
  *
  */

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

@@ -64,20 +64,42 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  *
- * @example To list information about events
+ * @example To describe events
  * ```javascript
- * // This example lists information for all backup-related events for the specified DB instance for the past 7 days (7 days * 24 hours * 60 minutes = 10,080 minutes).
+ * // The following retrieves details for the events that have occurred for the specified DB instance.
  * const input = {
- *   "Duration": 10080,
- *   "EventCategories": [
- *     "backup"
- *   ],
- *   "SourceIdentifier": "mymysqlinstance",
+ *   "SourceIdentifier": "test-instance",
  *   "SourceType": "db-instance"
  * };
  * const command = new DescribeEventsCommand(input);
- * await client.send(command);
- * // example id: describe-events-3836e5ed-3913-4f76-8452-c77fcad5016b
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "Events": [
+ *     {
+ *       "Date": "2018-07-31T23:09:23.983Z",
+ *       "EventCategories": [
+ *         "backup"
+ *       ],
+ *       "Message": "Backing up DB instance",
+ *       "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance",
+ *       "SourceIdentifier": "test-instance",
+ *       "SourceType": "db-instance"
+ *     },
+ *     {
+ *       "Date": "2018-07-31T23:15:13.049Z",
+ *       "EventCategories": [
+ *         "backup"
+ *       ],
+ *       "Message": "Finished DB Instance backup",
+ *       "SourceArn": "arn:aws:rds:us-east-1:123456789012:db:test-instance",
+ *       "SourceIdentifier": "test-instance",
+ *       "SourceType": "db-instance"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-events-1680281559411
  * ```
  *
  */

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

@@ -56,6 +56,47 @@ export interface DescribeExportTasksCommandOutput extends ExportTasksMessage, __
  *  <p>The export task doesn't exist.</p>
  *
  *
+ * @example To describe snapshot export tasks
+ * ```javascript
+ * // The following example returns information about snapshot exports to Amazon S3.
+ * const input = {};
+ * const command = new DescribeExportTasksCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ExportTasks": [
+ *     {
+ *       "ExportTaskIdentifier": "test-snapshot-export",
+ *       "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole",
+ *       "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff",
+ *       "PercentProgress": 100,
+ *       "S3Bucket": "mybucket",
+ *       "S3Prefix": "",
+ *       "SnapshotTime": "2020-03-02T18:26:28.163Z",
+ *       "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:test-snapshot",
+ *       "Status": "COMPLETE",
+ *       "TaskEndTime": "2020-03-02T19:10:31.985Z",
+ *       "TaskStartTime": "2020-03-02T18:57:56.896Z",
+ *       "TotalExtractedDataInGB": 0
+ *     },
+ *     {
+ *       "ExportTaskIdentifier": "my-s3-export",
+ *       "IamRoleArn": "arn:aws:iam::123456789012:role/service-role/ExportRole",
+ *       "KmsKeyId": "arn:aws:kms:us-west-2:123456789012:key/abcd0000-7fca-4128-82f2-aabbccddeeff",
+ *       "PercentProgress": 0,
+ *       "S3Bucket": "mybucket",
+ *       "S3Prefix": "",
+ *       "SnapshotTime": "2020-03-27T20:48:42.023Z",
+ *       "SourceArn": "arn:aws:rds:us-west-2:123456789012:snapshot:db5-snapshot-test",
+ *       "Status": "STARTING",
+ *       "TotalExtractedDataInGB": 0
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-snapshot-export-tasks-1680282299489
+ * ```
+ *
  */
 export declare class DescribeExportTasksCommand extends $Command<DescribeExportTasksCommandInput, DescribeExportTasksCommandOutput, RDSClientResolvedConfig> {
     readonly input: DescribeExportTasksCommandInput;

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

@@ -58,6 +58,32 @@ export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessa
  *  <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster.</p>
  *
  *
+ * @example To describe global DB clusters
+ * ```javascript
+ * // The following example lists Aurora global DB clusters in the current AWS Region.
+ * const input = {};
+ * const command = new DescribeGlobalClustersCommand(input);
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "GlobalClusters": [
+ *     {
+ *       "DeletionProtection": false,
+ *       "Engine": "aurora-mysql",
+ *       "EngineVersion": "5.7.mysql_aurora.2.07.2",
+ *       "GlobalClusterArn": "arn:aws:rds::123456789012:global-cluster:myglobalcluster",
+ *       "GlobalClusterIdentifier": "myglobalcluster",
+ *       "GlobalClusterMembers": [],
+ *       "GlobalClusterResourceId": "cluster-f5982077e3b5aabb",
+ *       "Status": "available",
+ *       "StorageEncrypted": false
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-global-db-clusters-1680282459184
+ * ```
+ *
  */
 export declare class DescribeGlobalClustersCommand extends $Command<DescribeGlobalClustersCommandInput, DescribeGlobalClustersCommandOutput, RDSClientResolvedConfig> {
     readonly input: DescribeGlobalClustersCommandInput;

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

@@ -51,16 +51,54 @@ export interface DescribeOptionGroupOptionsCommandOutput extends OptionGroupOpti
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  *
- * @example To list information about DB option group options
+ * @example To describe all available options
  * ```javascript
- * // This example lists information for all option group options for the specified DB engine.
+ * // The following example lists the options for an RDS for MySQL version 8.0 DB instance.
  * const input = {
  *   "EngineName": "mysql",
- *   "MajorEngineVersion": "5.6"
+ *   "MajorEngineVersion": "8.0"
  * };
  * const command = new DescribeOptionGroupOptionsCommand(input);
- * await client.send(command);
- * // example id: describe-option-group-options-30d735a4-81f1-49e4-b3f2-5dc45d50c8ed
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "OptionGroupOptions": [
+ *     {
+ *       "Description": "MariaDB Audit Plugin",
+ *       "EngineName": "mysql",
+ *       "MajorEngineVersion": "8.0",
+ *       "MinimumRequiredMinorEngineVersion": "25",
+ *       "Name": "MARIADB_AUDIT_PLUGIN",
+ *       "OptionGroupOptionSettings": [
+ *         {
+ *           "ApplyType": "DYNAMIC",
+ *           "IsModifiable": true,
+ *           "IsRequired": false,
+ *           "MinimumEngineVersionPerAllowedValue": [],
+ *           "SettingDescription": "Include specified users",
+ *           "SettingName": "SERVER_AUDIT_INCL_USERS"
+ *         },
+ *         {
+ *           "ApplyType": "DYNAMIC",
+ *           "IsModifiable": true,
+ *           "IsRequired": false,
+ *           "MinimumEngineVersionPerAllowedValue": [],
+ *           "SettingDescription": "Exclude specified users",
+ *           "SettingName": "SERVER_AUDIT_EXCL_USERS"
+ *         }
+ *       ],
+ *       "OptionsConflictsWith": [],
+ *       "OptionsDependedOn": [],
+ *       "Permanent": false,
+ *       "Persistent": false,
+ *       "PortRequired": false,
+ *       "RequiresAutoMinorEngineVersionUpgrade": false,
+ *       "VpcOnly": false
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-all-available-options-1680286049492
  * ```
  *
  */

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

@@ -55,16 +55,31 @@ export interface DescribeOptionGroupsCommandOutput extends OptionGroups, __Metad
  *  <p>The specified option group could not be found.</p>
  *
  *
- * @example To list information about DB option groups
+ * @example To describe the available option groups
  * ```javascript
- * // This example lists information for all option groups for the specified DB engine.
+ * // The following example lists the options groups for an Oracle Database 19c instance.
  * const input = {
- *   "EngineName": "mysql",
- *   "MajorEngineVersion": "5.6"
+ *   "EngineName": "oracle-ee",
+ *   "MajorEngineVersion": "19"
  * };
  * const command = new DescribeOptionGroupsCommand(input);
- * await client.send(command);
- * // example id: describe-option-groups-4ef478a1-66d5-45f2-bec3-e608720418a4
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "OptionGroupsList": [
+ *     {
+ *       "AllowsVpcAndNonVpcInstanceMemberships": true,
+ *       "EngineName": "oracle-ee",
+ *       "MajorEngineVersion": "19",
+ *       "OptionGroupArn": "arn:aws:rds:us-west-1:111122223333:og:default:oracle-ee-19",
+ *       "OptionGroupDescription": "Default option group for oracle-ee 19",
+ *       "OptionGroupName": "default:oracle-ee-19",
+ *       "Options": []
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-the-available-option-groups-1680283066000
  * ```
  *
  */

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

@@ -55,19 +55,52 @@ export interface DescribeOrderableDBInstanceOptionsCommandOutput extends Orderab
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
  *
  *
- * @example To list information about orderable DB instance options
+ * @example To describe orderable DB instance options
  * ```javascript
- * // This example lists information for all orderable DB instance options for the specified DB engine, engine version, DB instance class, license model, and VPC settings.
+ * // The following example retrieves details about the orderable options for a DB instances running the MySQL DB engine.
  * const input = {
- *   "DBInstanceClass": "db.t2.micro",
- *   "Engine": "mysql",
- *   "EngineVersion": "5.6.27",
- *   "LicenseModel": "general-public-license",
- *   "Vpc": true
+ *   "Engine": "mysql"
  * };
  * const command = new DescribeOrderableDBInstanceOptionsCommand(input);
- * await client.send(command);
- * // example id: describe-orderable-db-instance-options-7444d3ed-82eb-42b9-9ed9-896b8c27a782
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "OrderableDBInstanceOptions": [
+ *     {
+ *       "AvailabilityZones": [
+ *         {
+ *           "Name": "us-east-1a"
+ *         },
+ *         {
+ *           "Name": "us-east-1b"
+ *         },
+ *         {
+ *           "Name": "us-east-1c"
+ *         },
+ *         {
+ *           "Name": "us-east-1d"
+ *         },
+ *         {
+ *           "Name": "us-east-1e"
+ *         },
+ *         {
+ *           "Name": "us-east-1f"
+ *         }
+ *       ],
+ *       "DBInstanceClass": "db.m4.10xlarge",
+ *       "Engine": "mysql",
+ *       "EngineVersion": "5.7.33",
+ *       "LicenseModel": "general-public-license",
+ *       "MultiAZCapable": true,
+ *       "ReadReplicaCapable": true,
+ *       "StorageType": "gp2",
+ *       "SupportsStorageEncryption": true,
+ *       "Vpc": true
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-orderable-db-instance-options-1680283253165
  * ```
  *
  */

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

@@ -53,15 +53,28 @@ export interface DescribePendingMaintenanceActionsCommandOutput extends PendingM
  *  <p>The specified resource ID was not found.</p>
  *
  *
- * @example To list information about pending maintenance actions
+ * @example To list resources with at least one pending maintenance action
  * ```javascript
- * // This example lists information for all pending maintenance actions for the specified DB instance.
- * const input = {
- *   "ResourceIdentifier": "arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance"
- * };
+ * // The following example lists the pending maintenace action for a DB instance.
+ * const input = {};
  * const command = new DescribePendingMaintenanceActionsCommand(input);
- * await client.send(command);
- * // example id: describe-pending-maintenance-actions-e6021f7e-58ae-49cc-b874-11996176835c
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "PendingMaintenanceActions": [
+ *     {
+ *       "PendingMaintenanceActionDetails": [
+ *         {
+ *           "Action": "system-update",
+ *           "Description": "Upgrade to Aurora PostgreSQL 2.4.2"
+ *         }
+ *       ],
+ *       "ResourceIdentifier": "arn:aws:rds:us-west-2:123456789012:cluster:global-db1-cl1"
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-list-resources-with-at-least-one-pending-maintenance-action-1680283544475
  * ```
  *
  */

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

@@ -60,19 +60,42 @@ export interface DescribeReservedDBInstancesCommandOutput extends ReservedDBInst
  *  <p>The specified reserved DB Instance not found.</p>
  *
  *
- * @example To list information about reserved DB instances
+ * @example To describe reserved DB instances
  * ```javascript
- * // This example lists information for all reserved DB instances for the specified DB instance class, duration, product, offering type, and availability zone settings.
- * const input = {
- *   "DBInstanceClass": "db.t2.micro",
- *   "Duration": "1y",
- *   "MultiAZ": false,
- *   "OfferingType": "No Upfront",
- *   "ProductDescription": "mysql"
- * };
+ * // The following example retrieves details about any reserved DB instances in the current AWS account.
+ * const input = {};
  * const command = new DescribeReservedDBInstancesCommand(input);
- * await client.send(command);
- * // example id: describe-reserved-db-instances-d45adaca-2e30-407c-a0f3-aa7b98bea17f
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ReservedDBInstances": [
+ *     {
+ *       "CurrencyCode": "USD",
+ *       "DBInstanceClass": "db.t3.micro",
+ *       "DBInstanceCount": 1,
+ *       "Duration": 31536000,
+ *       "FixedPrice": 0,
+ *       "LeaseId": "a1b2c3d4-6b69-4a59-be89-5e11aa446666",
+ *       "MultiAZ": false,
+ *       "OfferingType": "No Upfront",
+ *       "ProductDescription": "sqlserver-ex(li)",
+ *       "RecurringCharges": [
+ *         {
+ *           "RecurringChargeAmount": 0.014,
+ *           "RecurringChargeFrequency": "Hourly"
+ *         }
+ *       ],
+ *       "ReservedDBInstanceArn": "arn:aws:rds:us-west-2:123456789012:ri:myreservedinstance",
+ *       "ReservedDBInstanceId": "myreservedinstance",
+ *       "ReservedDBInstancesOfferingId": "12ab34cd-59af-4b2c-a660-1abcdef23456",
+ *       "StartTime": "2020-06-01T13:44:21.436Z",
+ *       "State": "payment-pending",
+ *       "UsagePrice": 0
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-reserved-db-instances-1680283668105
  * ```
  *
  */

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

@@ -58,19 +58,38 @@ export interface DescribeReservedDBInstancesOfferingsCommandOutput extends Reser
  *  <p>Specified offering does not exist.</p>
  *
  *
- * @example To list information about reserved DB instance offerings
+ * @example To describe reserved DB instance offerings
  * ```javascript
- * // This example lists information for all reserved DB instance offerings for the specified DB instance class, duration, product, offering type, and availability zone settings.
+ * // The following example retrieves details about reserved DB instance options for RDS for Oracle.
  * const input = {
- *   "DBInstanceClass": "db.t2.micro",
- *   "Duration": "1y",
- *   "MultiAZ": false,
- *   "OfferingType": "No Upfront",
- *   "ProductDescription": "mysql"
+ *   "ProductDescription": "oracle"
  * };
  * const command = new DescribeReservedDBInstancesOfferingsCommand(input);
- * await client.send(command);
- * // example id: describe-reserved-db-instances-offerings-9de7d1fd-d6a6-4a72-84ae-b2ef58d47d8d
+ * const response = await client.send(command);
+ * /* response ==
+ * {
+ *   "ReservedDBInstancesOfferings": [
+ *     {
+ *       "CurrencyCode": "USD",
+ *       "DBInstanceClass": "db.m4.xlarge",
+ *       "Duration": 31536000,
+ *       "FixedPrice": 4089,
+ *       "MultiAZ": true,
+ *       "OfferingType": "Partial Upfront",
+ *       "ProductDescription": "oracle-se2(li)",
+ *       "RecurringCharges": [
+ *         {
+ *           "RecurringChargeAmount": 0.594,
+ *           "RecurringChargeFrequency": "Hourly"
+ *         }
+ *       ],
+ *       "ReservedDBInstancesOfferingId": "005bdee3-9ef4-4182-aa0c-58ef7cb6c2f8",
+ *       "UsagePrice": 0
+ *     }
+ *   ]
+ * }
+ * *\/
+ * // example id: to-describe-reserved-db-instance-offerings-1680283755054
  * ```
  *
  */