@aws-sdk/client-rds 3.288.0 → 3.289.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (83) hide show
  1. package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +17 -0
  2. package/dist-types/commands/AddTagsToResourceCommand.d.ts +17 -0
  3. package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +18 -0
  4. package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +17 -0
  5. package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +18 -0
  6. package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +17 -0
  7. package/dist-types/commands/CopyDBParameterGroupCommand.d.ts +18 -0
  8. package/dist-types/commands/CopyDBSnapshotCommand.d.ts +17 -0
  9. package/dist-types/commands/CopyOptionGroupCommand.d.ts +18 -0
  10. package/dist-types/commands/CreateDBClusterCommand.d.ts +28 -0
  11. package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +18 -0
  12. package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +17 -0
  13. package/dist-types/commands/CreateDBInstanceCommand.d.ts +21 -0
  14. package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +28 -0
  15. package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +18 -0
  16. package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +17 -0
  17. package/dist-types/commands/CreateDBSnapshotCommand.d.ts +17 -0
  18. package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +21 -0
  19. package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +25 -0
  20. package/dist-types/commands/CreateOptionGroupCommand.d.ts +19 -0
  21. package/dist-types/commands/DeleteDBClusterCommand.d.ts +17 -0
  22. package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +11 -0
  23. package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +16 -0
  24. package/dist-types/commands/DeleteDBInstanceCommand.d.ts +17 -0
  25. package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts +11 -0
  26. package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +11 -0
  27. package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +16 -0
  28. package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +11 -0
  29. package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +16 -0
  30. package/dist-types/commands/DeleteOptionGroupCommand.d.ts +11 -0
  31. package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +9 -0
  32. package/dist-types/commands/DescribeCertificatesCommand.d.ts +12 -0
  33. package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +11 -0
  34. package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +12 -0
  35. package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +16 -0
  36. package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +12 -0
  37. package/dist-types/commands/DescribeDBClustersCommand.d.ts +11 -0
  38. package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +15 -0
  39. package/dist-types/commands/DescribeDBInstancesCommand.d.ts +11 -0
  40. package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +14 -0
  41. package/dist-types/commands/DescribeDBParameterGroupsCommand.d.ts +11 -0
  42. package/dist-types/commands/DescribeDBParametersCommand.d.ts +13 -0
  43. package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +11 -0
  44. package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +16 -0
  45. package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +14 -0
  46. package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +11 -0
  47. package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +16 -0
  48. package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +16 -0
  49. package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +11 -0
  50. package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +11 -0
  51. package/dist-types/commands/DescribeEventsCommand.d.ts +16 -0
  52. package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +12 -0
  53. package/dist-types/commands/DescribeOptionGroupsCommand.d.ts +12 -0
  54. package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +15 -0
  55. package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +11 -0
  56. package/dist-types/commands/DescribeReservedDBInstancesCommand.d.ts +15 -0
  57. package/dist-types/commands/DescribeReservedDBInstancesOfferingsCommand.d.ts +15 -0
  58. package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +65 -0
  59. package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +12 -0
  60. package/dist-types/commands/FailoverDBClusterCommand.d.ts +17 -0
  61. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  62. package/dist-types/commands/ModifyDBClusterCommand.d.ts +21 -0
  63. package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +18 -0
  64. package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +24 -0
  65. package/dist-types/commands/ModifyDBInstanceCommand.d.ts +23 -0
  66. package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +18 -0
  67. package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +20 -0
  68. package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +20 -0
  69. package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +22 -0
  70. package/dist-types/commands/ModifyOptionGroupCommand.d.ts +25 -0
  71. package/dist-types/commands/PromoteReadReplicaCommand.d.ts +18 -0
  72. package/dist-types/commands/PurchaseReservedDBInstancesOfferingCommand.d.ts +17 -0
  73. package/dist-types/commands/RebootDBInstanceCommand.d.ts +17 -0
  74. package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +17 -0
  75. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +14 -0
  76. package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +12 -0
  77. package/dist-types/commands/ResetDBParameterGroupCommand.d.ts +12 -0
  78. package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +18 -0
  79. package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +18 -0
  80. package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +93 -0
  81. package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +94 -0
  82. package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +17 -0
  83. package/package.json +31 -31
@@ -37,6 +37,17 @@ export interface DeleteDBSecurityGroupCommandOutput extends __MetadataBearer {
37
37
  * @see {@link DeleteDBSecurityGroupCommandOutput} for command's `response` shape.
38
38
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
39
39
  *
40
+ * @example To delete a DB security group
41
+ * ```javascript
42
+ * // The following example deletes a DB security group.
43
+ * const input = {
44
+ * "DBSecurityGroupName": "mysecgroup"
45
+ * };
46
+ * const command = new DeleteDBSecurityGroupCommand(input);
47
+ * await client.send(command);
48
+ * // example id: to-delete-a-db-security-group-1473960141889
49
+ * ```
50
+ *
40
51
  */
41
52
  export declare class DeleteDBSecurityGroupCommand extends $Command<DeleteDBSecurityGroupCommandInput, DeleteDBSecurityGroupCommandOutput, RDSClientResolvedConfig> {
42
53
  readonly input: DeleteDBSecurityGroupCommandInput;
@@ -33,6 +33,22 @@ export interface DeleteDBSnapshotCommandOutput extends DeleteDBSnapshotResult, _
33
33
  * @see {@link DeleteDBSnapshotCommandOutput} for command's `response` shape.
34
34
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
35
35
  *
36
+ * @example To delete a DB cluster snapshot.
37
+ * ```javascript
38
+ * // This example deletes the specified DB snapshot.
39
+ * const input = {
40
+ * "DBSnapshotIdentifier": "mydbsnapshot"
41
+ * };
42
+ * const command = new DeleteDBSnapshotCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "DBSnapshot": {}
47
+ * }
48
+ * *\/
49
+ * // example id: delete-db-snapshot-505d6b4e-8ced-479c-856a-c460a33fe07b
50
+ * ```
51
+ *
36
52
  */
37
53
  export declare class DeleteDBSnapshotCommand extends $Command<DeleteDBSnapshotCommandInput, DeleteDBSnapshotCommandOutput, RDSClientResolvedConfig> {
38
54
  readonly input: DeleteDBSnapshotCommandInput;
@@ -32,6 +32,17 @@ export interface DeleteDBSubnetGroupCommandOutput extends __MetadataBearer {
32
32
  * @see {@link DeleteDBSubnetGroupCommandOutput} for command's `response` shape.
33
33
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
34
34
  *
35
+ * @example To delete a DB subnet group.
36
+ * ```javascript
37
+ * // This example deletes the specified DB subnetgroup.
38
+ * const input = {
39
+ * "DBSubnetGroupName": "mydbsubnetgroup"
40
+ * };
41
+ * const command = new DeleteDBSubnetGroupCommand(input);
42
+ * await client.send(command);
43
+ * // example id: delete-db-subnet-group-4ae00375-511e-443d-a01d-4b9f552244aa
44
+ * ```
45
+ *
35
46
  */
36
47
  export declare class DeleteDBSubnetGroupCommand extends $Command<DeleteDBSubnetGroupCommandInput, DeleteDBSubnetGroupCommandOutput, RDSClientResolvedConfig> {
37
48
  readonly input: DeleteDBSubnetGroupCommandInput;
@@ -29,6 +29,22 @@ export interface DeleteEventSubscriptionCommandOutput extends DeleteEventSubscri
29
29
  * @see {@link DeleteEventSubscriptionCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To delete a DB event subscription.
33
+ * ```javascript
34
+ * // This example deletes the specified DB event subscription.
35
+ * const input = {
36
+ * "SubscriptionName": "myeventsubscription"
37
+ * };
38
+ * const command = new DeleteEventSubscriptionCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "EventSubscription": {}
43
+ * }
44
+ * *\/
45
+ * // example id: delete-db-event-subscription-d33567e3-1d5d-48ff-873f-0270453f4a75
46
+ * ```
47
+ *
32
48
  */
33
49
  export declare class DeleteEventSubscriptionCommand extends $Command<DeleteEventSubscriptionCommandInput, DeleteEventSubscriptionCommandOutput, RDSClientResolvedConfig> {
34
50
  readonly input: DeleteEventSubscriptionCommandInput;
@@ -29,6 +29,17 @@ export interface DeleteOptionGroupCommandOutput extends __MetadataBearer {
29
29
  * @see {@link DeleteOptionGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To delete an option group.
33
+ * ```javascript
34
+ * // This example deletes the specified option group.
35
+ * const input = {
36
+ * "OptionGroupName": "mydboptiongroup"
37
+ * };
38
+ * const command = new DeleteOptionGroupCommand(input);
39
+ * await client.send(command);
40
+ * // example id: delete-db-option-group-578be2be-3095-431a-9ea4-9a3c3b0daef4
41
+ * ```
42
+ *
32
43
  */
33
44
  export declare class DeleteOptionGroupCommand extends $Command<DeleteOptionGroupCommandInput, DeleteOptionGroupCommandOutput, RDSClientResolvedConfig> {
34
45
  readonly input: DeleteOptionGroupCommandInput;
@@ -30,6 +30,15 @@ export interface DescribeAccountAttributesCommandOutput extends AccountAttribute
30
30
  * @see {@link DescribeAccountAttributesCommandOutput} for command's `response` shape.
31
31
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
32
32
  *
33
+ * @example To list account attributes
34
+ * ```javascript
35
+ * // This example lists account attributes.
36
+ * const input = {};
37
+ * const command = new DescribeAccountAttributesCommand(input);
38
+ * await client.send(command);
39
+ * // example id: describe-account-attributes-683d3ff7-5524-421a-8da5-e88f1ea2222b
40
+ * ```
41
+ *
33
42
  */
34
43
  export declare class DescribeAccountAttributesCommand extends $Command<DescribeAccountAttributesCommandInput, DescribeAccountAttributesCommandOutput, RDSClientResolvedConfig> {
35
44
  readonly input: DescribeAccountAttributesCommandInput;
@@ -34,6 +34,18 @@ export interface DescribeCertificatesCommandOutput extends CertificateMessage, _
34
34
  * @see {@link DescribeCertificatesCommandOutput} for command's `response` shape.
35
35
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
36
36
  *
37
+ * @example To list certificates
38
+ * ```javascript
39
+ * // This example lists up to 20 certificates for the specified certificate identifier.
40
+ * const input = {
41
+ * "CertificateIdentifier": "rds-ca-2015",
42
+ * "MaxRecords": 20
43
+ * };
44
+ * const command = new DescribeCertificatesCommand(input);
45
+ * await client.send(command);
46
+ * // example id: describe-certificates-9d71a70d-7908-4444-b43f-321d842c62dc
47
+ * ```
48
+ *
37
49
  */
38
50
  export declare class DescribeCertificatesCommand extends $Command<DescribeCertificatesCommandInput, DescribeCertificatesCommandOutput, RDSClientResolvedConfig> {
39
51
  readonly input: DescribeCertificatesCommandInput;
@@ -37,6 +37,17 @@ export interface DescribeDBClusterParameterGroupsCommandOutput extends DBCluster
37
37
  * @see {@link DescribeDBClusterParameterGroupsCommandOutput} for command's `response` shape.
38
38
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
39
39
  *
40
+ * @example To list DB cluster parameter group settings
41
+ * ```javascript
42
+ * // This example lists settings for the specified DB cluster parameter group.
43
+ * const input = {
44
+ * "DBClusterParameterGroupName": "mydbclusterparametergroup"
45
+ * };
46
+ * const command = new DescribeDBClusterParameterGroupsCommand(input);
47
+ * await client.send(command);
48
+ * // example id: describe-db-cluster-parameter-groups-cf9c6e66-664e-4f57-8e29-a9080abfc013
49
+ * ```
50
+ *
40
51
  */
41
52
  export declare class DescribeDBClusterParameterGroupsCommand extends $Command<DescribeDBClusterParameterGroupsCommandInput, DescribeDBClusterParameterGroupsCommandOutput, RDSClientResolvedConfig> {
42
53
  readonly input: DescribeDBClusterParameterGroupsCommandInput;
@@ -35,6 +35,18 @@ export interface DescribeDBClusterParametersCommandOutput extends DBClusterParam
35
35
  * @see {@link DescribeDBClusterParametersCommandOutput} for command's `response` shape.
36
36
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
37
37
  *
38
+ * @example To list DB cluster parameters
39
+ * ```javascript
40
+ * // This example lists system parameters for the specified DB cluster parameter group.
41
+ * const input = {
42
+ * "DBClusterParameterGroupName": "mydbclusterparametergroup",
43
+ * "Source": "system"
44
+ * };
45
+ * const command = new DescribeDBClusterParametersCommand(input);
46
+ * await client.send(command);
47
+ * // example id: describe-db-cluster-parameters-98043c28-e489-41a7-b118-bfd96dc779a1
48
+ * ```
49
+ *
38
50
  */
39
51
  export declare class DescribeDBClusterParametersCommand extends $Command<DescribeDBClusterParametersCommandInput, DescribeDBClusterParametersCommandOutput, RDSClientResolvedConfig> {
40
52
  readonly input: DescribeDBClusterParametersCommandInput;
@@ -36,6 +36,22 @@ export interface DescribeDBClusterSnapshotAttributesCommandOutput extends Descri
36
36
  * @see {@link DescribeDBClusterSnapshotAttributesCommandOutput} for command's `response` shape.
37
37
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
38
38
  *
39
+ * @example To list DB cluster snapshot attributes
40
+ * ```javascript
41
+ * // This example lists attributes for the specified DB cluster snapshot.
42
+ * const input = {
43
+ * "DBClusterSnapshotIdentifier": "mydbclustersnapshot"
44
+ * };
45
+ * const command = new DescribeDBClusterSnapshotAttributesCommand(input);
46
+ * const response = await client.send(command);
47
+ * /* response ==
48
+ * {
49
+ * "DBClusterSnapshotAttributesResult": {}
50
+ * }
51
+ * *\/
52
+ * // example id: describe-db-cluster-snapshot-attributes-6752ade3-0c7b-4b06-a8e4-b76bf4e2d3571
53
+ * ```
54
+ *
39
55
  */
40
56
  export declare class DescribeDBClusterSnapshotAttributesCommand extends $Command<DescribeDBClusterSnapshotAttributesCommandInput, DescribeDBClusterSnapshotAttributesCommandOutput, RDSClientResolvedConfig> {
41
57
  readonly input: DescribeDBClusterSnapshotAttributesCommandInput;
@@ -35,6 +35,18 @@ export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapsh
35
35
  * @see {@link DescribeDBClusterSnapshotsCommandOutput} for command's `response` shape.
36
36
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
37
37
  *
38
+ * @example To list DB cluster snapshots
39
+ * ```javascript
40
+ * // This example lists settings for the specified, manually-created cluster snapshot.
41
+ * const input = {
42
+ * "DBClusterSnapshotIdentifier": "mydbclustersnapshot",
43
+ * "SnapshotType": "manual"
44
+ * };
45
+ * const command = new DescribeDBClusterSnapshotsCommand(input);
46
+ * await client.send(command);
47
+ * // example id: describe-db-cluster-snapshots-52f38af1-3431-4a51-9a6a-e6bb8c961b32
48
+ * ```
49
+ *
38
50
  */
39
51
  export declare class DescribeDBClusterSnapshotsCommand extends $Command<DescribeDBClusterSnapshotsCommandInput, DescribeDBClusterSnapshotsCommandOutput, RDSClientResolvedConfig> {
40
52
  readonly input: DescribeDBClusterSnapshotsCommandInput;
@@ -36,6 +36,17 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met
36
36
  * @see {@link DescribeDBClustersCommandOutput} for command's `response` shape.
37
37
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
38
38
  *
39
+ * @example To list DB clusters
40
+ * ```javascript
41
+ * // This example lists settings for the specified DB cluster.
42
+ * const input = {
43
+ * "DBClusterIdentifier": "mynewdbcluster"
44
+ * };
45
+ * const command = new DescribeDBClustersCommand(input);
46
+ * await client.send(command);
47
+ * // example id: describe-db-clusters-7aae8861-cb95-4b3b-9042-f62df7698635
48
+ * ```
49
+ *
39
50
  */
40
51
  export declare class DescribeDBClustersCommand extends $Command<DescribeDBClustersCommandInput, DescribeDBClustersCommandOutput, RDSClientResolvedConfig> {
41
52
  readonly input: DescribeDBClustersCommandInput;
@@ -29,6 +29,21 @@ export interface DescribeDBEngineVersionsCommandOutput extends DBEngineVersionMe
29
29
  * @see {@link DescribeDBEngineVersionsCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To list DB engine version settings
33
+ * ```javascript
34
+ * // This example lists settings for the specified DB engine version.
35
+ * const input = {
36
+ * "DBParameterGroupFamily": "mysql5.6",
37
+ * "DefaultOnly": true,
38
+ * "Engine": "mysql",
39
+ * "EngineVersion": "5.6",
40
+ * "ListSupportedCharacterSets": true
41
+ * };
42
+ * const command = new DescribeDBEngineVersionsCommand(input);
43
+ * await client.send(command);
44
+ * // example id: describe-db-engine-versions-8e698cf2-2162-425a-a854-111cdaceb52b
45
+ * ```
46
+ *
32
47
  */
33
48
  export declare class DescribeDBEngineVersionsCommand extends $Command<DescribeDBEngineVersionsCommandInput, DescribeDBEngineVersionsCommandOutput, RDSClientResolvedConfig> {
34
49
  readonly input: DescribeDBEngineVersionsCommandInput;
@@ -32,6 +32,17 @@ export interface DescribeDBInstancesCommandOutput extends DBInstanceMessage, __M
32
32
  * @see {@link DescribeDBInstancesCommandOutput} for command's `response` shape.
33
33
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
34
34
  *
35
+ * @example To list DB instance settings
36
+ * ```javascript
37
+ * // This example lists settings for the specified DB instance.
38
+ * const input = {
39
+ * "DBInstanceIdentifier": "mymysqlinstance"
40
+ * };
41
+ * const command = new DescribeDBInstancesCommand(input);
42
+ * await client.send(command);
43
+ * // example id: describe-db-instances-0e11a8c5-4ec3-4463-8cbf-f7254d04c4fc
44
+ * ```
45
+ *
35
46
  */
36
47
  export declare class DescribeDBInstancesCommand extends $Command<DescribeDBInstancesCommandInput, DescribeDBInstancesCommandOutput, RDSClientResolvedConfig> {
37
48
  readonly input: DescribeDBInstancesCommandInput;
@@ -30,6 +30,20 @@ export interface DescribeDBLogFilesCommandOutput extends DescribeDBLogFilesRespo
30
30
  * @see {@link DescribeDBLogFilesCommandOutput} for command's `response` shape.
31
31
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
32
32
  *
33
+ * @example To list DB log file names
34
+ * ```javascript
35
+ * // This example lists matching log file names for the specified DB instance, file name pattern, last write date in POSIX time with milleseconds, and minimum file size.
36
+ * const input = {
37
+ * "DBInstanceIdentifier": "mymysqlinstance",
38
+ * "FileLastWritten": 1470873600000,
39
+ * "FileSize": 0,
40
+ * "FilenameContains": "error"
41
+ * };
42
+ * const command = new DescribeDBLogFilesCommand(input);
43
+ * await client.send(command);
44
+ * // example id: describe-db-log-files-5f002d8d-5c1d-44c2-b5f4-bd284c0f1285
45
+ * ```
46
+ *
33
47
  */
34
48
  export declare class DescribeDBLogFilesCommand extends $Command<DescribeDBLogFilesCommandInput, DescribeDBLogFilesCommandOutput, RDSClientResolvedConfig> {
35
49
  readonly input: DescribeDBLogFilesCommandInput;
@@ -30,6 +30,17 @@ export interface DescribeDBParameterGroupsCommandOutput extends DBParameterGroup
30
30
  * @see {@link DescribeDBParameterGroupsCommandOutput} for command's `response` shape.
31
31
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
32
32
  *
33
+ * @example To list information about DB parameter groups
34
+ * ```javascript
35
+ * // This example lists information about the specified DB parameter group.
36
+ * const input = {
37
+ * "DBParameterGroupName": "mymysqlparametergroup"
38
+ * };
39
+ * const command = new DescribeDBParameterGroupsCommand(input);
40
+ * await client.send(command);
41
+ * // example id: describe-db-parameter-groups-
42
+ * ```
43
+ *
33
44
  */
34
45
  export declare class DescribeDBParameterGroupsCommand extends $Command<DescribeDBParameterGroupsCommandInput, DescribeDBParameterGroupsCommandOutput, RDSClientResolvedConfig> {
35
46
  readonly input: DescribeDBParameterGroupsCommandInput;
@@ -30,6 +30,19 @@ export interface DescribeDBParametersCommandOutput extends DBParameterGroupDetai
30
30
  * @see {@link DescribeDBParametersCommandOutput} for command's `response` shape.
31
31
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
32
32
  *
33
+ * @example To list information about DB parameters
34
+ * ```javascript
35
+ * // This example lists information for up to the first 20 system parameters for the specified DB parameter group.
36
+ * const input = {
37
+ * "DBParameterGroupName": "mymysqlparametergroup",
38
+ * "MaxRecords": 20,
39
+ * "Source": "system"
40
+ * };
41
+ * const command = new DescribeDBParametersCommand(input);
42
+ * await client.send(command);
43
+ * // example id: describe-db-parameters-09db4201-ef4f-4d97-a4b5-d71c0715b901
44
+ * ```
45
+ *
33
46
  */
34
47
  export declare class DescribeDBParametersCommand extends $Command<DescribeDBParametersCommandInput, DescribeDBParametersCommandOutput, RDSClientResolvedConfig> {
35
48
  readonly input: DescribeDBParametersCommandInput;
@@ -37,6 +37,17 @@ export interface DescribeDBSecurityGroupsCommandOutput extends DBSecurityGroupMe
37
37
  * @see {@link DescribeDBSecurityGroupsCommandOutput} for command's `response` shape.
38
38
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
39
39
  *
40
+ * @example To list DB security group settings
41
+ * ```javascript
42
+ * // This example lists settings for the specified security group.
43
+ * const input = {
44
+ * "DBSecurityGroupName": "mydbsecuritygroup"
45
+ * };
46
+ * const command = new DescribeDBSecurityGroupsCommand(input);
47
+ * await client.send(command);
48
+ * // example id: describe-db-security-groups-66fe9ea1-17dd-4275-b82e-f771cee0c849
49
+ * ```
50
+ *
40
51
  */
41
52
  export declare class DescribeDBSecurityGroupsCommand extends $Command<DescribeDBSecurityGroupsCommandInput, DescribeDBSecurityGroupsCommandOutput, RDSClientResolvedConfig> {
42
53
  readonly input: DescribeDBSecurityGroupsCommandInput;
@@ -36,6 +36,22 @@ export interface DescribeDBSnapshotAttributesCommandOutput extends DescribeDBSna
36
36
  * @see {@link DescribeDBSnapshotAttributesCommandOutput} for command's `response` shape.
37
37
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
38
38
  *
39
+ * @example To list DB snapshot attributes
40
+ * ```javascript
41
+ * // This example lists attributes for the specified DB snapshot.
42
+ * const input = {
43
+ * "DBSnapshotIdentifier": "mydbsnapshot"
44
+ * };
45
+ * const command = new DescribeDBSnapshotAttributesCommand(input);
46
+ * const response = await client.send(command);
47
+ * /* response ==
48
+ * {
49
+ * "DBSnapshotAttributesResult": {}
50
+ * }
51
+ * *\/
52
+ * // example id: describe-db-snapshot-attributes-1d4fb750-34f6-4e43-8b3d-b2751d796a95
53
+ * ```
54
+ *
39
55
  */
40
56
  export declare class DescribeDBSnapshotAttributesCommand extends $Command<DescribeDBSnapshotAttributesCommandInput, DescribeDBSnapshotAttributesCommandOutput, RDSClientResolvedConfig> {
41
57
  readonly input: DescribeDBSnapshotAttributesCommandInput;
@@ -29,6 +29,20 @@ export interface DescribeDBSnapshotsCommandOutput extends DBSnapshotMessage, __M
29
29
  * @see {@link DescribeDBSnapshotsCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To list DB snapshot attributes
33
+ * ```javascript
34
+ * // This example lists all manually-created, shared snapshots for the specified DB instance.
35
+ * const input = {
36
+ * "DBInstanceIdentifier": "mymysqlinstance",
37
+ * "IncludePublic": false,
38
+ * "IncludeShared": true,
39
+ * "SnapshotType": "manual"
40
+ * };
41
+ * const command = new DescribeDBSnapshotsCommand(input);
42
+ * await client.send(command);
43
+ * // example id: describe-db-snapshots-2c935989-a1ef-4c85-aea4-1d0f45f17f26
44
+ * ```
45
+ *
32
46
  */
33
47
  export declare class DescribeDBSnapshotsCommand extends $Command<DescribeDBSnapshotsCommandInput, DescribeDBSnapshotsCommandOutput, RDSClientResolvedConfig> {
34
48
  readonly input: DescribeDBSnapshotsCommandInput;
@@ -31,6 +31,17 @@ export interface DescribeDBSubnetGroupsCommandOutput extends DBSubnetGroupMessag
31
31
  * @see {@link DescribeDBSubnetGroupsCommandOutput} for command's `response` shape.
32
32
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
33
33
  *
34
+ * @example To list information about DB subnet groups
35
+ * ```javascript
36
+ * // This example lists information about the specified DB subnet group.
37
+ * const input = {
38
+ * "DBSubnetGroupName": "mydbsubnetgroup"
39
+ * };
40
+ * const command = new DescribeDBSubnetGroupsCommand(input);
41
+ * await client.send(command);
42
+ * // example id: describe-db-subnet-groups-1d97b340-682f-4dd6-9653-8ed72a8d1221
43
+ * ```
44
+ *
34
45
  */
35
46
  export declare class DescribeDBSubnetGroupsCommand extends $Command<DescribeDBSubnetGroupsCommandInput, DescribeDBSubnetGroupsCommandOutput, RDSClientResolvedConfig> {
36
47
  readonly input: DescribeDBSubnetGroupsCommandInput;
@@ -32,6 +32,22 @@ export interface DescribeEngineDefaultClusterParametersCommandOutput extends Des
32
32
  * @see {@link DescribeEngineDefaultClusterParametersCommandOutput} for command's `response` shape.
33
33
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
34
34
  *
35
+ * @example To list default parameters for a DB cluster engine
36
+ * ```javascript
37
+ * // This example lists default parameters for the specified DB cluster engine.
38
+ * const input = {
39
+ * "DBParameterGroupFamily": "aurora5.6"
40
+ * };
41
+ * const command = new DescribeEngineDefaultClusterParametersCommand(input);
42
+ * const response = await client.send(command);
43
+ * /* response ==
44
+ * {
45
+ * "EngineDefaults": {}
46
+ * }
47
+ * *\/
48
+ * // example id: describe-engine-default-cluster-parameters-f130374a-7bee-434b-b51d-da20b6e000e0
49
+ * ```
50
+ *
35
51
  */
36
52
  export declare class DescribeEngineDefaultClusterParametersCommand extends $Command<DescribeEngineDefaultClusterParametersCommandInput, DescribeEngineDefaultClusterParametersCommandOutput, RDSClientResolvedConfig> {
37
53
  readonly input: DescribeEngineDefaultClusterParametersCommandInput;
@@ -29,6 +29,22 @@ export interface DescribeEngineDefaultParametersCommandOutput extends DescribeEn
29
29
  * @see {@link DescribeEngineDefaultParametersCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To list default parameters for a DB engine
33
+ * ```javascript
34
+ * // This example lists default parameters for the specified DB engine.
35
+ * const input = {
36
+ * "DBParameterGroupFamily": "mysql5.6"
37
+ * };
38
+ * const command = new DescribeEngineDefaultParametersCommand(input);
39
+ * const response = await client.send(command);
40
+ * /* response ==
41
+ * {
42
+ * "EngineDefaults": {}
43
+ * }
44
+ * *\/
45
+ * // example id: describe-engine-default-parameters-35d5108e-1d44-4fac-8aeb-04b8fdfface1
46
+ * ```
47
+ *
32
48
  */
33
49
  export declare class DescribeEngineDefaultParametersCommand extends $Command<DescribeEngineDefaultParametersCommandInput, DescribeEngineDefaultParametersCommandOutput, RDSClientResolvedConfig> {
34
50
  readonly input: DescribeEngineDefaultParametersCommandInput;
@@ -35,6 +35,17 @@ export interface DescribeEventCategoriesCommandOutput extends EventCategoriesMes
35
35
  * @see {@link DescribeEventCategoriesCommandOutput} for command's `response` shape.
36
36
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
37
37
  *
38
+ * @example To list event categories.
39
+ * ```javascript
40
+ * // This example lists all DB instance event categories.
41
+ * const input = {
42
+ * "SourceType": "db-instance"
43
+ * };
44
+ * const command = new DescribeEventCategoriesCommand(input);
45
+ * await client.send(command);
46
+ * // example id: describe-event-categories-97bd4c77-12da-4be6-b42f-edf77771428b
47
+ * ```
48
+ *
38
49
  */
39
50
  export declare class DescribeEventCategoriesCommand extends $Command<DescribeEventCategoriesCommandInput, DescribeEventCategoriesCommandOutput, RDSClientResolvedConfig> {
40
51
  readonly input: DescribeEventCategoriesCommandInput;
@@ -31,6 +31,17 @@ export interface DescribeEventSubscriptionsCommandOutput extends EventSubscripti
31
31
  * @see {@link DescribeEventSubscriptionsCommandOutput} for command's `response` shape.
32
32
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
33
33
  *
34
+ * @example To list information about DB event notification subscriptions
35
+ * ```javascript
36
+ * // This example lists information for the specified DB event notification subscription.
37
+ * const input = {
38
+ * "SubscriptionName": "mymysqleventsubscription"
39
+ * };
40
+ * const command = new DescribeEventSubscriptionsCommand(input);
41
+ * await client.send(command);
42
+ * // example id: describe-event-subscriptions-11184a82-e58a-4d0c-b558-f3a7489e0850
43
+ * ```
44
+ *
34
45
  */
35
46
  export declare class DescribeEventSubscriptionsCommand extends $Command<DescribeEventSubscriptionsCommandInput, DescribeEventSubscriptionsCommandOutput, RDSClientResolvedConfig> {
36
47
  readonly input: DescribeEventSubscriptionsCommandInput;
@@ -36,6 +36,22 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
36
36
  * @see {@link DescribeEventsCommandOutput} for command's `response` shape.
37
37
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
38
38
  *
39
+ * @example To list information about events
40
+ * ```javascript
41
+ * // 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).
42
+ * const input = {
43
+ * "Duration": 10080,
44
+ * "EventCategories": [
45
+ * "backup"
46
+ * ],
47
+ * "SourceIdentifier": "mymysqlinstance",
48
+ * "SourceType": "db-instance"
49
+ * };
50
+ * const command = new DescribeEventsCommand(input);
51
+ * await client.send(command);
52
+ * // example id: describe-events-3836e5ed-3913-4f76-8452-c77fcad5016b
53
+ * ```
54
+ *
39
55
  */
40
56
  export declare class DescribeEventsCommand extends $Command<DescribeEventsCommandInput, DescribeEventsCommandOutput, RDSClientResolvedConfig> {
41
57
  readonly input: DescribeEventsCommandInput;
@@ -29,6 +29,18 @@ export interface DescribeOptionGroupOptionsCommandOutput extends OptionGroupOpti
29
29
  * @see {@link DescribeOptionGroupOptionsCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To list information about DB option group options
33
+ * ```javascript
34
+ * // This example lists information for all option group options for the specified DB engine.
35
+ * const input = {
36
+ * "EngineName": "mysql",
37
+ * "MajorEngineVersion": "5.6"
38
+ * };
39
+ * const command = new DescribeOptionGroupOptionsCommand(input);
40
+ * await client.send(command);
41
+ * // example id: describe-option-group-options-30d735a4-81f1-49e4-b3f2-5dc45d50c8ed
42
+ * ```
43
+ *
32
44
  */
33
45
  export declare class DescribeOptionGroupOptionsCommand extends $Command<DescribeOptionGroupOptionsCommandInput, DescribeOptionGroupOptionsCommandOutput, RDSClientResolvedConfig> {
34
46
  readonly input: DescribeOptionGroupOptionsCommandInput;
@@ -29,6 +29,18 @@ export interface DescribeOptionGroupsCommandOutput extends OptionGroups, __Metad
29
29
  * @see {@link DescribeOptionGroupsCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To list information about DB option groups
33
+ * ```javascript
34
+ * // This example lists information for all option groups for the specified DB engine.
35
+ * const input = {
36
+ * "EngineName": "mysql",
37
+ * "MajorEngineVersion": "5.6"
38
+ * };
39
+ * const command = new DescribeOptionGroupsCommand(input);
40
+ * await client.send(command);
41
+ * // example id: describe-option-groups-4ef478a1-66d5-45f2-bec3-e608720418a4
42
+ * ```
43
+ *
32
44
  */
33
45
  export declare class DescribeOptionGroupsCommand extends $Command<DescribeOptionGroupsCommandInput, DescribeOptionGroupsCommandOutput, RDSClientResolvedConfig> {
34
46
  readonly input: DescribeOptionGroupsCommandInput;
@@ -29,6 +29,21 @@ export interface DescribeOrderableDBInstanceOptionsCommandOutput extends Orderab
29
29
  * @see {@link DescribeOrderableDBInstanceOptionsCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To list information about orderable DB instance options
33
+ * ```javascript
34
+ * // 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.
35
+ * const input = {
36
+ * "DBInstanceClass": "db.t2.micro",
37
+ * "Engine": "mysql",
38
+ * "EngineVersion": "5.6.27",
39
+ * "LicenseModel": "general-public-license",
40
+ * "Vpc": true
41
+ * };
42
+ * const command = new DescribeOrderableDBInstanceOptionsCommand(input);
43
+ * await client.send(command);
44
+ * // example id: describe-orderable-db-instance-options-7444d3ed-82eb-42b9-9ed9-896b8c27a782
45
+ * ```
46
+ *
32
47
  */
33
48
  export declare class DescribeOrderableDBInstanceOptionsCommand extends $Command<DescribeOrderableDBInstanceOptionsCommandInput, DescribeOrderableDBInstanceOptionsCommandOutput, RDSClientResolvedConfig> {
34
49
  readonly input: DescribeOrderableDBInstanceOptionsCommandInput;
@@ -29,6 +29,17 @@ export interface DescribePendingMaintenanceActionsCommandOutput extends PendingM
29
29
  * @see {@link DescribePendingMaintenanceActionsCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To list information about pending maintenance actions
33
+ * ```javascript
34
+ * // This example lists information for all pending maintenance actions for the specified DB instance.
35
+ * const input = {
36
+ * "ResourceIdentifier": "arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance"
37
+ * };
38
+ * const command = new DescribePendingMaintenanceActionsCommand(input);
39
+ * await client.send(command);
40
+ * // example id: describe-pending-maintenance-actions-e6021f7e-58ae-49cc-b874-11996176835c
41
+ * ```
42
+ *
32
43
  */
33
44
  export declare class DescribePendingMaintenanceActionsCommand extends $Command<DescribePendingMaintenanceActionsCommandInput, DescribePendingMaintenanceActionsCommandOutput, RDSClientResolvedConfig> {
34
45
  readonly input: DescribePendingMaintenanceActionsCommandInput;
@@ -29,6 +29,21 @@ export interface DescribeReservedDBInstancesCommandOutput extends ReservedDBInst
29
29
  * @see {@link DescribeReservedDBInstancesCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @example To list information about reserved DB instances
33
+ * ```javascript
34
+ * // This example lists information for all reserved DB instances for the specified DB instance class, duration, product, offering type, and availability zone settings.
35
+ * const input = {
36
+ * "DBInstanceClass": "db.t2.micro",
37
+ * "Duration": "1y",
38
+ * "MultiAZ": false,
39
+ * "OfferingType": "No Upfront",
40
+ * "ProductDescription": "mysql"
41
+ * };
42
+ * const command = new DescribeReservedDBInstancesCommand(input);
43
+ * await client.send(command);
44
+ * // example id: describe-reserved-db-instances-d45adaca-2e30-407c-a0f3-aa7b98bea17f
45
+ * ```
46
+ *
32
47
  */
33
48
  export declare class DescribeReservedDBInstancesCommand extends $Command<DescribeReservedDBInstancesCommandInput, DescribeReservedDBInstancesCommandOutput, RDSClientResolvedConfig> {
34
49
  readonly input: DescribeReservedDBInstancesCommandInput;