@aws-sdk/client-rds 3.288.0 → 3.290.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 (142) hide show
  1. package/dist-types/commands/AddRoleToDBClusterCommand.d.ts +14 -0
  2. package/dist-types/commands/AddRoleToDBInstanceCommand.d.ts +14 -0
  3. package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +24 -0
  4. package/dist-types/commands/AddTagsToResourceCommand.d.ts +40 -0
  5. package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +28 -0
  6. package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +32 -0
  7. package/dist-types/commands/BacktrackDBClusterCommand.d.ts +8 -0
  8. package/dist-types/commands/CancelExportTaskCommand.d.ts +7 -0
  9. package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +31 -0
  10. package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +38 -0
  11. package/dist-types/commands/CopyDBParameterGroupCommand.d.ts +31 -0
  12. package/dist-types/commands/CopyDBSnapshotCommand.d.ts +41 -0
  13. package/dist-types/commands/CopyOptionGroupCommand.d.ts +28 -0
  14. package/dist-types/commands/CreateBlueGreenDeploymentCommand.d.ts +42 -0
  15. package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +13 -0
  16. package/dist-types/commands/CreateDBClusterCommand.d.ts +94 -0
  17. package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +21 -0
  18. package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +26 -0
  19. package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +35 -0
  20. package/dist-types/commands/CreateDBInstanceCommand.d.ts +100 -0
  21. package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +102 -0
  22. package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +26 -0
  23. package/dist-types/commands/CreateDBProxyCommand.d.ts +10 -0
  24. package/dist-types/commands/CreateDBProxyEndpointCommand.d.ts +16 -0
  25. package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +29 -0
  26. package/dist-types/commands/CreateDBSnapshotCommand.d.ts +33 -0
  27. package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +40 -0
  28. package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +47 -0
  29. package/dist-types/commands/CreateGlobalClusterCommand.d.ts +14 -0
  30. package/dist-types/commands/CreateOptionGroupCommand.d.ts +26 -0
  31. package/dist-types/commands/DeleteBlueGreenDeploymentCommand.d.ts +9 -0
  32. package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +7 -0
  33. package/dist-types/commands/DeleteDBClusterCommand.d.ts +35 -0
  34. package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts +10 -0
  35. package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +22 -0
  36. package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +24 -0
  37. package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +8 -0
  38. package/dist-types/commands/DeleteDBInstanceCommand.d.ts +41 -0
  39. package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts +22 -0
  40. package/dist-types/commands/DeleteDBProxyCommand.d.ts +7 -0
  41. package/dist-types/commands/DeleteDBProxyEndpointCommand.d.ts +7 -0
  42. package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +19 -0
  43. package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +24 -0
  44. package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +22 -0
  45. package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +23 -0
  46. package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +7 -0
  47. package/dist-types/commands/DeleteOptionGroupCommand.d.ts +18 -0
  48. package/dist-types/commands/DeregisterDBProxyTargetsCommand.d.ts +13 -0
  49. package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +10 -0
  50. package/dist-types/commands/DescribeBlueGreenDeploymentsCommand.d.ts +5 -0
  51. package/dist-types/commands/DescribeCertificatesCommand.d.ts +18 -0
  52. package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +9 -0
  53. package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +5 -0
  54. package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +17 -0
  55. package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +18 -0
  56. package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +21 -0
  57. package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +17 -0
  58. package/dist-types/commands/DescribeDBClustersCommand.d.ts +16 -0
  59. package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +16 -0
  60. package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +4 -0
  61. package/dist-types/commands/DescribeDBInstancesCommand.d.ts +16 -0
  62. package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +19 -0
  63. package/dist-types/commands/DescribeDBParameterGroupsCommand.d.ts +17 -0
  64. package/dist-types/commands/DescribeDBParametersCommand.d.ts +19 -0
  65. package/dist-types/commands/DescribeDBProxiesCommand.d.ts +4 -0
  66. package/dist-types/commands/DescribeDBProxyEndpointsCommand.d.ts +7 -0
  67. package/dist-types/commands/DescribeDBProxyTargetGroupsCommand.d.ts +10 -0
  68. package/dist-types/commands/DescribeDBProxyTargetsCommand.d.ts +13 -0
  69. package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +16 -0
  70. package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +21 -0
  71. package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +19 -0
  72. package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +16 -0
  73. package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +17 -0
  74. package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +17 -0
  75. package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +12 -0
  76. package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +15 -0
  77. package/dist-types/commands/DescribeEventsCommand.d.ts +17 -0
  78. package/dist-types/commands/DescribeExportTasksCommand.d.ts +4 -0
  79. package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +4 -0
  80. package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +13 -0
  81. package/dist-types/commands/DescribeOptionGroupsCommand.d.ts +16 -0
  82. package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +16 -0
  83. package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +15 -0
  84. package/dist-types/commands/DescribeReservedDBInstancesCommand.d.ts +19 -0
  85. package/dist-types/commands/DescribeReservedDBInstancesOfferingsCommand.d.ts +19 -0
  86. package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +66 -0
  87. package/dist-types/commands/DescribeValidDBInstanceModificationsCommand.d.ts +8 -0
  88. package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +21 -0
  89. package/dist-types/commands/FailoverDBClusterCommand.d.ts +28 -0
  90. package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +14 -0
  91. package/dist-types/commands/ListTagsForResourceCommand.d.ts +34 -0
  92. package/dist-types/commands/ModifyActivityStreamCommand.d.ts +11 -0
  93. package/dist-types/commands/ModifyCertificatesCommand.d.ts +6 -0
  94. package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +14 -0
  95. package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +7 -0
  96. package/dist-types/commands/ModifyDBClusterCommand.d.ts +65 -0
  97. package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +17 -0
  98. package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +29 -0
  99. package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +35 -0
  100. package/dist-types/commands/ModifyDBInstanceCommand.d.ts +98 -0
  101. package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +29 -0
  102. package/dist-types/commands/ModifyDBProxyCommand.d.ts +10 -0
  103. package/dist-types/commands/ModifyDBProxyEndpointCommand.d.ts +13 -0
  104. package/dist-types/commands/ModifyDBProxyTargetGroupCommand.d.ts +10 -0
  105. package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +31 -0
  106. package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +5 -0
  107. package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +38 -0
  108. package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +41 -0
  109. package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +13 -0
  110. package/dist-types/commands/ModifyOptionGroupCommand.d.ts +32 -0
  111. package/dist-types/commands/PromoteReadReplicaCommand.d.ts +26 -0
  112. package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +8 -0
  113. package/dist-types/commands/PurchaseReservedDBInstancesOfferingCommand.d.ts +27 -0
  114. package/dist-types/commands/RebootDBClusterCommand.d.ts +11 -0
  115. package/dist-types/commands/RebootDBInstanceCommand.d.ts +25 -0
  116. package/dist-types/commands/RegisterDBProxyTargetsCommand.d.ts +32 -0
  117. package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +11 -0
  118. package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +11 -0
  119. package/dist-types/commands/RemoveRoleFromDBInstanceCommand.d.ts +12 -0
  120. package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +24 -0
  121. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +37 -0
  122. package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +23 -0
  123. package/dist-types/commands/ResetDBParameterGroupCommand.d.ts +23 -0
  124. package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +54 -0
  125. package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +84 -0
  126. package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +84 -0
  127. package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +174 -0
  128. package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +67 -0
  129. package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +180 -0
  130. package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +31 -0
  131. package/dist-types/commands/StartActivityStreamCommand.d.ts +21 -0
  132. package/dist-types/commands/StartDBClusterCommand.d.ts +11 -0
  133. package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +20 -0
  134. package/dist-types/commands/StartDBInstanceCommand.d.ts +42 -0
  135. package/dist-types/commands/StartExportTaskCommand.d.ts +35 -0
  136. package/dist-types/commands/StopActivityStreamCommand.d.ts +18 -0
  137. package/dist-types/commands/StopDBClusterCommand.d.ts +11 -0
  138. package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +8 -0
  139. package/dist-types/commands/StopDBInstanceCommand.d.ts +19 -0
  140. package/dist-types/commands/SwitchoverBlueGreenDeploymentCommand.d.ts +9 -0
  141. package/dist-types/commands/SwitchoverReadReplicaCommand.d.ts +8 -0
  142. package/package.json +31 -31
@@ -29,6 +29,22 @@ 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
+ *
33
+ * @example To list DB engine version settings
34
+ * ```javascript
35
+ * // This example lists settings for the specified DB engine version.
36
+ * const input = {
37
+ * "DBParameterGroupFamily": "mysql5.6",
38
+ * "DefaultOnly": true,
39
+ * "Engine": "mysql",
40
+ * "EngineVersion": "5.6",
41
+ * "ListSupportedCharacterSets": true
42
+ * };
43
+ * const command = new DescribeDBEngineVersionsCommand(input);
44
+ * await client.send(command);
45
+ * // example id: describe-db-engine-versions-8e698cf2-2162-425a-a854-111cdaceb52b
46
+ * ```
47
+ *
32
48
  */
33
49
  export declare class DescribeDBEngineVersionsCommand extends $Command<DescribeDBEngineVersionsCommandInput, DescribeDBEngineVersionsCommandOutput, RDSClientResolvedConfig> {
34
50
  readonly input: DescribeDBEngineVersionsCommandInput;
@@ -35,6 +35,10 @@ export interface DescribeDBInstanceAutomatedBackupsCommandOutput extends DBInsta
35
35
  * @see {@link DescribeDBInstanceAutomatedBackupsCommandOutput} for command's `response` shape.
36
36
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
37
37
  *
38
+ * @throws {@link DBInstanceAutomatedBackupNotFoundFault} (client fault)
39
+ * <p>No automated backup for this DB instance was found.</p>
40
+ *
41
+ *
38
42
  */
39
43
  export declare class DescribeDBInstanceAutomatedBackupsCommand extends $Command<DescribeDBInstanceAutomatedBackupsCommandInput, DescribeDBInstanceAutomatedBackupsCommandOutput, RDSClientResolvedConfig> {
40
44
  readonly input: DescribeDBInstanceAutomatedBackupsCommandInput;
@@ -32,6 +32,22 @@ 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
+ * @throws {@link DBInstanceNotFoundFault} (client fault)
36
+ * <p>
37
+ * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
38
+ *
39
+ *
40
+ * @example To list DB instance settings
41
+ * ```javascript
42
+ * // This example lists settings for the specified DB instance.
43
+ * const input = {
44
+ * "DBInstanceIdentifier": "mymysqlinstance"
45
+ * };
46
+ * const command = new DescribeDBInstancesCommand(input);
47
+ * await client.send(command);
48
+ * // example id: describe-db-instances-0e11a8c5-4ec3-4463-8cbf-f7254d04c4fc
49
+ * ```
50
+ *
35
51
  */
36
52
  export declare class DescribeDBInstancesCommand extends $Command<DescribeDBInstancesCommandInput, DescribeDBInstancesCommandOutput, RDSClientResolvedConfig> {
37
53
  readonly input: DescribeDBInstancesCommandInput;
@@ -30,6 +30,25 @@ 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
+ * @throws {@link DBInstanceNotFoundFault} (client fault)
34
+ * <p>
35
+ * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
36
+ *
37
+ *
38
+ * @example To list DB log file names
39
+ * ```javascript
40
+ * // 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.
41
+ * const input = {
42
+ * "DBInstanceIdentifier": "mymysqlinstance",
43
+ * "FileLastWritten": 1470873600000,
44
+ * "FileSize": 0,
45
+ * "FilenameContains": "error"
46
+ * };
47
+ * const command = new DescribeDBLogFilesCommand(input);
48
+ * await client.send(command);
49
+ * // example id: describe-db-log-files-5f002d8d-5c1d-44c2-b5f4-bd284c0f1285
50
+ * ```
51
+ *
33
52
  */
34
53
  export declare class DescribeDBLogFilesCommand extends $Command<DescribeDBLogFilesCommandInput, DescribeDBLogFilesCommandOutput, RDSClientResolvedConfig> {
35
54
  readonly input: DescribeDBLogFilesCommandInput;
@@ -30,6 +30,23 @@ 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
+ * @throws {@link DBParameterGroupNotFoundFault} (client fault)
34
+ * <p>
35
+ * <code>DBParameterGroupName</code> doesn't refer to an
36
+ * existing DB parameter group.</p>
37
+ *
38
+ *
39
+ * @example To list information about DB parameter groups
40
+ * ```javascript
41
+ * // This example lists information about the specified DB parameter group.
42
+ * const input = {
43
+ * "DBParameterGroupName": "mymysqlparametergroup"
44
+ * };
45
+ * const command = new DescribeDBParameterGroupsCommand(input);
46
+ * await client.send(command);
47
+ * // example id: describe-db-parameter-groups-
48
+ * ```
49
+ *
33
50
  */
34
51
  export declare class DescribeDBParameterGroupsCommand extends $Command<DescribeDBParameterGroupsCommandInput, DescribeDBParameterGroupsCommandOutput, RDSClientResolvedConfig> {
35
52
  readonly input: DescribeDBParameterGroupsCommandInput;
@@ -30,6 +30,25 @@ 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
+ * @throws {@link DBParameterGroupNotFoundFault} (client fault)
34
+ * <p>
35
+ * <code>DBParameterGroupName</code> doesn't refer to an
36
+ * existing DB parameter group.</p>
37
+ *
38
+ *
39
+ * @example To list information about DB parameters
40
+ * ```javascript
41
+ * // This example lists information for up to the first 20 system parameters for the specified DB parameter group.
42
+ * const input = {
43
+ * "DBParameterGroupName": "mymysqlparametergroup",
44
+ * "MaxRecords": 20,
45
+ * "Source": "system"
46
+ * };
47
+ * const command = new DescribeDBParametersCommand(input);
48
+ * await client.send(command);
49
+ * // example id: describe-db-parameters-09db4201-ef4f-4d97-a4b5-d71c0715b901
50
+ * ```
51
+ *
33
52
  */
34
53
  export declare class DescribeDBParametersCommand extends $Command<DescribeDBParametersCommandInput, DescribeDBParametersCommandOutput, RDSClientResolvedConfig> {
35
54
  readonly input: DescribeDBParametersCommandInput;
@@ -29,6 +29,10 @@ export interface DescribeDBProxiesCommandOutput extends DescribeDBProxiesRespons
29
29
  * @see {@link DescribeDBProxiesCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @throws {@link DBProxyNotFoundFault} (client fault)
33
+ * <p>The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
34
+ *
35
+ *
32
36
  */
33
37
  export declare class DescribeDBProxiesCommand extends $Command<DescribeDBProxiesCommandInput, DescribeDBProxiesCommandOutput, RDSClientResolvedConfig> {
34
38
  readonly input: DescribeDBProxiesCommandInput;
@@ -29,6 +29,13 @@ export interface DescribeDBProxyEndpointsCommandOutput extends DescribeDBProxyEn
29
29
  * @see {@link DescribeDBProxyEndpointsCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @throws {@link DBProxyEndpointNotFoundFault} (client fault)
33
+ * <p>The DB proxy endpoint doesn't exist.</p>
34
+ *
35
+ * @throws {@link DBProxyNotFoundFault} (client fault)
36
+ * <p>The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
37
+ *
38
+ *
32
39
  */
33
40
  export declare class DescribeDBProxyEndpointsCommand extends $Command<DescribeDBProxyEndpointsCommandInput, DescribeDBProxyEndpointsCommandOutput, RDSClientResolvedConfig> {
34
41
  readonly input: DescribeDBProxyEndpointsCommandInput;
@@ -29,6 +29,16 @@ export interface DescribeDBProxyTargetGroupsCommandOutput extends DescribeDBProx
29
29
  * @see {@link DescribeDBProxyTargetGroupsCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @throws {@link DBProxyNotFoundFault} (client fault)
33
+ * <p>The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
34
+ *
35
+ * @throws {@link DBProxyTargetGroupNotFoundFault} (client fault)
36
+ * <p>The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
37
+ *
38
+ * @throws {@link InvalidDBProxyStateFault} (client fault)
39
+ * <p>The requested operation can't be performed while the proxy is in this state.</p>
40
+ *
41
+ *
32
42
  */
33
43
  export declare class DescribeDBProxyTargetGroupsCommand extends $Command<DescribeDBProxyTargetGroupsCommandInput, DescribeDBProxyTargetGroupsCommandOutput, RDSClientResolvedConfig> {
34
44
  readonly input: DescribeDBProxyTargetGroupsCommandInput;
@@ -29,6 +29,19 @@ export interface DescribeDBProxyTargetsCommandOutput extends DescribeDBProxyTarg
29
29
  * @see {@link DescribeDBProxyTargetsCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @throws {@link DBProxyNotFoundFault} (client fault)
33
+ * <p>The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
34
+ *
35
+ * @throws {@link DBProxyTargetGroupNotFoundFault} (client fault)
36
+ * <p>The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
37
+ *
38
+ * @throws {@link DBProxyTargetNotFoundFault} (client fault)
39
+ * <p>The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
40
+ *
41
+ * @throws {@link InvalidDBProxyStateFault} (client fault)
42
+ * <p>The requested operation can't be performed while the proxy is in this state.</p>
43
+ *
44
+ *
32
45
  */
33
46
  export declare class DescribeDBProxyTargetsCommand extends $Command<DescribeDBProxyTargetsCommandInput, DescribeDBProxyTargetsCommandOutput, RDSClientResolvedConfig> {
34
47
  readonly input: DescribeDBProxyTargetsCommandInput;
@@ -37,6 +37,22 @@ 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
+ * @throws {@link DBSecurityGroupNotFoundFault} (client fault)
41
+ * <p>
42
+ * <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group.</p>
43
+ *
44
+ *
45
+ * @example To list DB security group settings
46
+ * ```javascript
47
+ * // This example lists settings for the specified security group.
48
+ * const input = {
49
+ * "DBSecurityGroupName": "mydbsecuritygroup"
50
+ * };
51
+ * const command = new DescribeDBSecurityGroupsCommand(input);
52
+ * await client.send(command);
53
+ * // example id: describe-db-security-groups-66fe9ea1-17dd-4275-b82e-f771cee0c849
54
+ * ```
55
+ *
40
56
  */
41
57
  export declare class DescribeDBSecurityGroupsCommand extends $Command<DescribeDBSecurityGroupsCommandInput, DescribeDBSecurityGroupsCommandOutput, RDSClientResolvedConfig> {
42
58
  readonly input: DescribeDBSecurityGroupsCommandInput;
@@ -36,6 +36,27 @@ 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
+ * @throws {@link DBSnapshotNotFoundFault} (client fault)
40
+ * <p>
41
+ * <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
42
+ *
43
+ *
44
+ * @example To list DB snapshot attributes
45
+ * ```javascript
46
+ * // This example lists attributes for the specified DB snapshot.
47
+ * const input = {
48
+ * "DBSnapshotIdentifier": "mydbsnapshot"
49
+ * };
50
+ * const command = new DescribeDBSnapshotAttributesCommand(input);
51
+ * const response = await client.send(command);
52
+ * /* response ==
53
+ * {
54
+ * "DBSnapshotAttributesResult": {}
55
+ * }
56
+ * *\/
57
+ * // example id: describe-db-snapshot-attributes-1d4fb750-34f6-4e43-8b3d-b2751d796a95
58
+ * ```
59
+ *
39
60
  */
40
61
  export declare class DescribeDBSnapshotAttributesCommand extends $Command<DescribeDBSnapshotAttributesCommandInput, DescribeDBSnapshotAttributesCommandOutput, RDSClientResolvedConfig> {
41
62
  readonly input: DescribeDBSnapshotAttributesCommandInput;
@@ -29,6 +29,25 @@ 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
+ * @throws {@link DBSnapshotNotFoundFault} (client fault)
33
+ * <p>
34
+ * <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
35
+ *
36
+ *
37
+ * @example To list DB snapshot attributes
38
+ * ```javascript
39
+ * // This example lists all manually-created, shared snapshots for the specified DB instance.
40
+ * const input = {
41
+ * "DBInstanceIdentifier": "mymysqlinstance",
42
+ * "IncludePublic": false,
43
+ * "IncludeShared": true,
44
+ * "SnapshotType": "manual"
45
+ * };
46
+ * const command = new DescribeDBSnapshotsCommand(input);
47
+ * await client.send(command);
48
+ * // example id: describe-db-snapshots-2c935989-a1ef-4c85-aea4-1d0f45f17f26
49
+ * ```
50
+ *
32
51
  */
33
52
  export declare class DescribeDBSnapshotsCommand extends $Command<DescribeDBSnapshotsCommandInput, DescribeDBSnapshotsCommandOutput, RDSClientResolvedConfig> {
34
53
  readonly input: DescribeDBSnapshotsCommandInput;
@@ -31,6 +31,22 @@ 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
+ * @throws {@link DBSubnetGroupNotFoundFault} (client fault)
35
+ * <p>
36
+ * <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>
37
+ *
38
+ *
39
+ * @example To list information about DB subnet groups
40
+ * ```javascript
41
+ * // This example lists information about the specified DB subnet group.
42
+ * const input = {
43
+ * "DBSubnetGroupName": "mydbsubnetgroup"
44
+ * };
45
+ * const command = new DescribeDBSubnetGroupsCommand(input);
46
+ * await client.send(command);
47
+ * // example id: describe-db-subnet-groups-1d97b340-682f-4dd6-9653-8ed72a8d1221
48
+ * ```
49
+ *
34
50
  */
35
51
  export declare class DescribeDBSubnetGroupsCommand extends $Command<DescribeDBSubnetGroupsCommandInput, DescribeDBSubnetGroupsCommandOutput, RDSClientResolvedConfig> {
36
52
  readonly input: DescribeDBSubnetGroupsCommandInput;
@@ -32,6 +32,23 @@ 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
+ *
36
+ * @example To list default parameters for a DB cluster engine
37
+ * ```javascript
38
+ * // This example lists default parameters for the specified DB cluster engine.
39
+ * const input = {
40
+ * "DBParameterGroupFamily": "aurora5.6"
41
+ * };
42
+ * const command = new DescribeEngineDefaultClusterParametersCommand(input);
43
+ * const response = await client.send(command);
44
+ * /* response ==
45
+ * {
46
+ * "EngineDefaults": {}
47
+ * }
48
+ * *\/
49
+ * // example id: describe-engine-default-cluster-parameters-f130374a-7bee-434b-b51d-da20b6e000e0
50
+ * ```
51
+ *
35
52
  */
36
53
  export declare class DescribeEngineDefaultClusterParametersCommand extends $Command<DescribeEngineDefaultClusterParametersCommandInput, DescribeEngineDefaultClusterParametersCommandOutput, RDSClientResolvedConfig> {
37
54
  readonly input: DescribeEngineDefaultClusterParametersCommandInput;
@@ -29,6 +29,23 @@ 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
+ *
33
+ * @example To list default parameters for a DB engine
34
+ * ```javascript
35
+ * // This example lists default parameters for the specified DB engine.
36
+ * const input = {
37
+ * "DBParameterGroupFamily": "mysql5.6"
38
+ * };
39
+ * const command = new DescribeEngineDefaultParametersCommand(input);
40
+ * const response = await client.send(command);
41
+ * /* response ==
42
+ * {
43
+ * "EngineDefaults": {}
44
+ * }
45
+ * *\/
46
+ * // example id: describe-engine-default-parameters-35d5108e-1d44-4fac-8aeb-04b8fdfface1
47
+ * ```
48
+ *
32
49
  */
33
50
  export declare class DescribeEngineDefaultParametersCommand extends $Command<DescribeEngineDefaultParametersCommandInput, DescribeEngineDefaultParametersCommandOutput, RDSClientResolvedConfig> {
34
51
  readonly input: DescribeEngineDefaultParametersCommandInput;
@@ -35,6 +35,18 @@ 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
+ *
39
+ * @example To list event categories.
40
+ * ```javascript
41
+ * // This example lists all DB instance event categories.
42
+ * const input = {
43
+ * "SourceType": "db-instance"
44
+ * };
45
+ * const command = new DescribeEventCategoriesCommand(input);
46
+ * await client.send(command);
47
+ * // example id: describe-event-categories-97bd4c77-12da-4be6-b42f-edf77771428b
48
+ * ```
49
+ *
38
50
  */
39
51
  export declare class DescribeEventCategoriesCommand extends $Command<DescribeEventCategoriesCommandInput, DescribeEventCategoriesCommandOutput, RDSClientResolvedConfig> {
40
52
  readonly input: DescribeEventCategoriesCommandInput;
@@ -31,6 +31,21 @@ 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
+ * @throws {@link SubscriptionNotFoundFault} (client fault)
35
+ * <p>The subscription name does not exist.</p>
36
+ *
37
+ *
38
+ * @example To list information about DB event notification subscriptions
39
+ * ```javascript
40
+ * // This example lists information for the specified DB event notification subscription.
41
+ * const input = {
42
+ * "SubscriptionName": "mymysqleventsubscription"
43
+ * };
44
+ * const command = new DescribeEventSubscriptionsCommand(input);
45
+ * await client.send(command);
46
+ * // example id: describe-event-subscriptions-11184a82-e58a-4d0c-b558-f3a7489e0850
47
+ * ```
48
+ *
34
49
  */
35
50
  export declare class DescribeEventSubscriptionsCommand extends $Command<DescribeEventSubscriptionsCommandInput, DescribeEventSubscriptionsCommandOutput, RDSClientResolvedConfig> {
36
51
  readonly input: DescribeEventSubscriptionsCommandInput;
@@ -36,6 +36,23 @@ 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
+ *
40
+ * @example To list information about events
41
+ * ```javascript
42
+ * // 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).
43
+ * const input = {
44
+ * "Duration": 10080,
45
+ * "EventCategories": [
46
+ * "backup"
47
+ * ],
48
+ * "SourceIdentifier": "mymysqlinstance",
49
+ * "SourceType": "db-instance"
50
+ * };
51
+ * const command = new DescribeEventsCommand(input);
52
+ * await client.send(command);
53
+ * // example id: describe-events-3836e5ed-3913-4f76-8452-c77fcad5016b
54
+ * ```
55
+ *
39
56
  */
40
57
  export declare class DescribeEventsCommand extends $Command<DescribeEventsCommandInput, DescribeEventsCommandOutput, RDSClientResolvedConfig> {
41
58
  readonly input: DescribeEventsCommandInput;
@@ -30,6 +30,10 @@ export interface DescribeExportTasksCommandOutput extends ExportTasksMessage, __
30
30
  * @see {@link DescribeExportTasksCommandOutput} for command's `response` shape.
31
31
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
32
32
  *
33
+ * @throws {@link ExportTaskNotFoundFault} (client fault)
34
+ * <p>The export task doesn't exist.</p>
35
+ *
36
+ *
33
37
  */
34
38
  export declare class DescribeExportTasksCommand extends $Command<DescribeExportTasksCommandInput, DescribeExportTasksCommandOutput, RDSClientResolvedConfig> {
35
39
  readonly input: DescribeExportTasksCommandInput;
@@ -34,6 +34,10 @@ export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessa
34
34
  * @see {@link DescribeGlobalClustersCommandOutput} for command's `response` shape.
35
35
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
36
36
  *
37
+ * @throws {@link GlobalClusterNotFoundFault} (client fault)
38
+ * <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster.</p>
39
+ *
40
+ *
37
41
  */
38
42
  export declare class DescribeGlobalClustersCommand extends $Command<DescribeGlobalClustersCommandInput, DescribeGlobalClustersCommandOutput, RDSClientResolvedConfig> {
39
43
  readonly input: DescribeGlobalClustersCommandInput;
@@ -29,6 +29,19 @@ 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
+ *
33
+ * @example To list information about DB option group options
34
+ * ```javascript
35
+ * // This example lists information for all option group options for the specified DB engine.
36
+ * const input = {
37
+ * "EngineName": "mysql",
38
+ * "MajorEngineVersion": "5.6"
39
+ * };
40
+ * const command = new DescribeOptionGroupOptionsCommand(input);
41
+ * await client.send(command);
42
+ * // example id: describe-option-group-options-30d735a4-81f1-49e4-b3f2-5dc45d50c8ed
43
+ * ```
44
+ *
32
45
  */
33
46
  export declare class DescribeOptionGroupOptionsCommand extends $Command<DescribeOptionGroupOptionsCommandInput, DescribeOptionGroupOptionsCommandOutput, RDSClientResolvedConfig> {
34
47
  readonly input: DescribeOptionGroupOptionsCommandInput;
@@ -29,6 +29,22 @@ 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
+ * @throws {@link OptionGroupNotFoundFault} (client fault)
33
+ * <p>The specified option group could not be found.</p>
34
+ *
35
+ *
36
+ * @example To list information about DB option groups
37
+ * ```javascript
38
+ * // This example lists information for all option groups for the specified DB engine.
39
+ * const input = {
40
+ * "EngineName": "mysql",
41
+ * "MajorEngineVersion": "5.6"
42
+ * };
43
+ * const command = new DescribeOptionGroupsCommand(input);
44
+ * await client.send(command);
45
+ * // example id: describe-option-groups-4ef478a1-66d5-45f2-bec3-e608720418a4
46
+ * ```
47
+ *
32
48
  */
33
49
  export declare class DescribeOptionGroupsCommand extends $Command<DescribeOptionGroupsCommandInput, DescribeOptionGroupsCommandOutput, RDSClientResolvedConfig> {
34
50
  readonly input: DescribeOptionGroupsCommandInput;
@@ -29,6 +29,22 @@ 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
+ *
33
+ * @example To list information about orderable DB instance options
34
+ * ```javascript
35
+ * // 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.
36
+ * const input = {
37
+ * "DBInstanceClass": "db.t2.micro",
38
+ * "Engine": "mysql",
39
+ * "EngineVersion": "5.6.27",
40
+ * "LicenseModel": "general-public-license",
41
+ * "Vpc": true
42
+ * };
43
+ * const command = new DescribeOrderableDBInstanceOptionsCommand(input);
44
+ * await client.send(command);
45
+ * // example id: describe-orderable-db-instance-options-7444d3ed-82eb-42b9-9ed9-896b8c27a782
46
+ * ```
47
+ *
32
48
  */
33
49
  export declare class DescribeOrderableDBInstanceOptionsCommand extends $Command<DescribeOrderableDBInstanceOptionsCommandInput, DescribeOrderableDBInstanceOptionsCommandOutput, RDSClientResolvedConfig> {
34
50
  readonly input: DescribeOrderableDBInstanceOptionsCommandInput;
@@ -29,6 +29,21 @@ 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
+ * @throws {@link ResourceNotFoundFault} (client fault)
33
+ * <p>The specified resource ID was not found.</p>
34
+ *
35
+ *
36
+ * @example To list information about pending maintenance actions
37
+ * ```javascript
38
+ * // This example lists information for all pending maintenance actions for the specified DB instance.
39
+ * const input = {
40
+ * "ResourceIdentifier": "arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance"
41
+ * };
42
+ * const command = new DescribePendingMaintenanceActionsCommand(input);
43
+ * await client.send(command);
44
+ * // example id: describe-pending-maintenance-actions-e6021f7e-58ae-49cc-b874-11996176835c
45
+ * ```
46
+ *
32
47
  */
33
48
  export declare class DescribePendingMaintenanceActionsCommand extends $Command<DescribePendingMaintenanceActionsCommandInput, DescribePendingMaintenanceActionsCommandOutput, RDSClientResolvedConfig> {
34
49
  readonly input: DescribePendingMaintenanceActionsCommandInput;
@@ -29,6 +29,25 @@ 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
+ * @throws {@link ReservedDBInstanceNotFoundFault} (client fault)
33
+ * <p>The specified reserved DB Instance not found.</p>
34
+ *
35
+ *
36
+ * @example To list information about reserved DB instances
37
+ * ```javascript
38
+ * // This example lists information for all reserved DB instances for the specified DB instance class, duration, product, offering type, and availability zone settings.
39
+ * const input = {
40
+ * "DBInstanceClass": "db.t2.micro",
41
+ * "Duration": "1y",
42
+ * "MultiAZ": false,
43
+ * "OfferingType": "No Upfront",
44
+ * "ProductDescription": "mysql"
45
+ * };
46
+ * const command = new DescribeReservedDBInstancesCommand(input);
47
+ * await client.send(command);
48
+ * // example id: describe-reserved-db-instances-d45adaca-2e30-407c-a0f3-aa7b98bea17f
49
+ * ```
50
+ *
32
51
  */
33
52
  export declare class DescribeReservedDBInstancesCommand extends $Command<DescribeReservedDBInstancesCommandInput, DescribeReservedDBInstancesCommandOutput, RDSClientResolvedConfig> {
34
53
  readonly input: DescribeReservedDBInstancesCommandInput;
@@ -29,6 +29,25 @@ export interface DescribeReservedDBInstancesOfferingsCommandOutput extends Reser
29
29
  * @see {@link DescribeReservedDBInstancesOfferingsCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @throws {@link ReservedDBInstancesOfferingNotFoundFault} (client fault)
33
+ * <p>Specified offering does not exist.</p>
34
+ *
35
+ *
36
+ * @example To list information about reserved DB instance offerings
37
+ * ```javascript
38
+ * // This example lists information for all reserved DB instance offerings for the specified DB instance class, duration, product, offering type, and availability zone settings.
39
+ * const input = {
40
+ * "DBInstanceClass": "db.t2.micro",
41
+ * "Duration": "1y",
42
+ * "MultiAZ": false,
43
+ * "OfferingType": "No Upfront",
44
+ * "ProductDescription": "mysql"
45
+ * };
46
+ * const command = new DescribeReservedDBInstancesOfferingsCommand(input);
47
+ * await client.send(command);
48
+ * // example id: describe-reserved-db-instances-offerings-9de7d1fd-d6a6-4a72-84ae-b2ef58d47d8d
49
+ * ```
50
+ *
32
51
  */
33
52
  export declare class DescribeReservedDBInstancesOfferingsCommand extends $Command<DescribeReservedDBInstancesOfferingsCommandInput, DescribeReservedDBInstancesOfferingsCommandOutput, RDSClientResolvedConfig> {
34
53
  readonly input: DescribeReservedDBInstancesOfferingsCommandInput;