@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
@@ -36,6 +36,72 @@ export interface DescribeSourceRegionsCommandOutput extends SourceRegionMessage,
36
36
  * @see {@link DescribeSourceRegionsCommandOutput} for command's `response` shape.
37
37
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
38
38
  *
39
+ *
40
+ * @example To describe source regions
41
+ * ```javascript
42
+ * // To list the AWS regions where a Read Replica can be created.
43
+ * const input = {};
44
+ * const command = new DescribeSourceRegionsCommand(input);
45
+ * const response = await client.send(command);
46
+ * /* response ==
47
+ * {
48
+ * "SourceRegions": [
49
+ * {
50
+ * "Endpoint": "https://rds.ap-northeast-1.amazonaws.com",
51
+ * "RegionName": "ap-northeast-1",
52
+ * "Status": "available"
53
+ * },
54
+ * {
55
+ * "Endpoint": "https://rds.ap-northeast-2.amazonaws.com",
56
+ * "RegionName": "ap-northeast-2",
57
+ * "Status": "available"
58
+ * },
59
+ * {
60
+ * "Endpoint": "https://rds.ap-south-1.amazonaws.com",
61
+ * "RegionName": "ap-south-1",
62
+ * "Status": "available"
63
+ * },
64
+ * {
65
+ * "Endpoint": "https://rds.ap-southeast-1.amazonaws.com",
66
+ * "RegionName": "ap-southeast-1",
67
+ * "Status": "available"
68
+ * },
69
+ * {
70
+ * "Endpoint": "https://rds.ap-southeast-2.amazonaws.com",
71
+ * "RegionName": "ap-southeast-2",
72
+ * "Status": "available"
73
+ * },
74
+ * {
75
+ * "Endpoint": "https://rds.eu-central-1.amazonaws.com",
76
+ * "RegionName": "eu-central-1",
77
+ * "Status": "available"
78
+ * },
79
+ * {
80
+ * "Endpoint": "https://rds.eu-west-1.amazonaws.com",
81
+ * "RegionName": "eu-west-1",
82
+ * "Status": "available"
83
+ * },
84
+ * {
85
+ * "Endpoint": "https://rds.sa-east-1.amazonaws.com",
86
+ * "RegionName": "sa-east-1",
87
+ * "Status": "available"
88
+ * },
89
+ * {
90
+ * "Endpoint": "https://rds.us-west-1.amazonaws.com",
91
+ * "RegionName": "us-west-1",
92
+ * "Status": "available"
93
+ * },
94
+ * {
95
+ * "Endpoint": "https://rds.us-west-2.amazonaws.com",
96
+ * "RegionName": "us-west-2",
97
+ * "Status": "available"
98
+ * }
99
+ * ]
100
+ * }
101
+ * *\/
102
+ * // example id: to-describe-source-regions-1473457722410
103
+ * ```
104
+ *
39
105
  */
40
106
  export declare class DescribeSourceRegionsCommand extends $Command<DescribeSourceRegionsCommandInput, DescribeSourceRegionsCommandOutput, RDSClientResolvedConfig> {
41
107
  readonly input: DescribeSourceRegionsCommandInput;
@@ -31,6 +31,14 @@ export interface DescribeValidDBInstanceModificationsCommandOutput extends Descr
31
31
  * @see {@link DescribeValidDBInstanceModificationsCommandOutput} for command's `response` shape.
32
32
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
33
33
  *
34
+ * @throws {@link DBInstanceNotFoundFault} (client fault)
35
+ * <p>
36
+ * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
37
+ *
38
+ * @throws {@link InvalidDBInstanceStateFault} (client fault)
39
+ * <p>The DB instance isn't in a valid state.</p>
40
+ *
41
+ *
34
42
  */
35
43
  export declare class DescribeValidDBInstanceModificationsCommand extends $Command<DescribeValidDBInstanceModificationsCommandInput, DescribeValidDBInstanceModificationsCommandOutput, RDSClientResolvedConfig> {
36
44
  readonly input: DescribeValidDBInstanceModificationsCommandInput;
@@ -30,6 +30,27 @@ export interface DownloadDBLogFilePortionCommandOutput extends DownloadDBLogFile
30
30
  * @see {@link DownloadDBLogFilePortionCommandOutput} 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
+ * @throws {@link DBLogFileNotFoundFault} (client fault)
38
+ * <p>
39
+ * <code>LogFileName</code> doesn't refer to an existing DB log file.</p>
40
+ *
41
+ *
42
+ * @example To list information about DB log files
43
+ * ```javascript
44
+ * // This example lists information for the specified log file for the specified DB instance.
45
+ * const input = {
46
+ * "DBInstanceIdentifier": "mymysqlinstance",
47
+ * "LogFileName": "mysqlUpgrade"
48
+ * };
49
+ * const command = new DownloadDBLogFilePortionCommand(input);
50
+ * await client.send(command);
51
+ * // example id: download-db-log-file-portion-54a82731-a441-4fc7-a010-8eccae6fa202
52
+ * ```
53
+ *
33
54
  */
34
55
  export declare class DownloadDBLogFilePortionCommand extends $Command<DownloadDBLogFilePortionCommandInput, DownloadDBLogFilePortionCommandOutput, RDSClientResolvedConfig> {
35
56
  readonly input: DownloadDBLogFilePortionCommandInput;
@@ -45,6 +45,34 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
45
45
  * @see {@link FailoverDBClusterCommandOutput} for command's `response` shape.
46
46
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
47
47
  *
48
+ * @throws {@link DBClusterNotFoundFault} (client fault)
49
+ * <p>
50
+ * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
51
+ *
52
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
53
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
54
+ *
55
+ * @throws {@link InvalidDBInstanceStateFault} (client fault)
56
+ * <p>The DB instance isn't in a valid state.</p>
57
+ *
58
+ *
59
+ * @example To perform a failover for a DB cluster
60
+ * ```javascript
61
+ * // This example performs a failover for the specified DB cluster to the specified DB instance.
62
+ * const input = {
63
+ * "DBClusterIdentifier": "myaurorainstance-cluster",
64
+ * "TargetDBInstanceIdentifier": "myaurorareplica"
65
+ * };
66
+ * const command = new FailoverDBClusterCommand(input);
67
+ * const response = await client.send(command);
68
+ * /* response ==
69
+ * {
70
+ * "DBCluster": {}
71
+ * }
72
+ * *\/
73
+ * // example id: failover-db-cluster-9e7f2f93-d98c-42c7-bb0e-d6c485c096d6
74
+ * ```
75
+ *
48
76
  */
49
77
  export declare class FailoverDBClusterCommand extends $Command<FailoverDBClusterCommandInput, FailoverDBClusterCommandOutput, RDSClientResolvedConfig> {
50
78
  readonly input: FailoverDBClusterCommandInput;
@@ -41,6 +41,20 @@ export interface FailoverGlobalClusterCommandOutput extends FailoverGlobalCluste
41
41
  * @see {@link FailoverGlobalClusterCommandOutput} for command's `response` shape.
42
42
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
43
43
  *
44
+ * @throws {@link DBClusterNotFoundFault} (client fault)
45
+ * <p>
46
+ * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
47
+ *
48
+ * @throws {@link GlobalClusterNotFoundFault} (client fault)
49
+ * <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster.</p>
50
+ *
51
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
52
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
53
+ *
54
+ * @throws {@link InvalidGlobalClusterStateFault} (client fault)
55
+ * <p>The global cluster is in an invalid state and can't perform the requested operation.</p>
56
+ *
57
+ *
44
58
  */
45
59
  export declare class FailoverGlobalClusterCommand extends $Command<FailoverGlobalClusterCommandInput, FailoverGlobalClusterCommandOutput, RDSClientResolvedConfig> {
46
60
  readonly input: FailoverGlobalClusterCommandInput;
@@ -32,6 +32,40 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta
32
32
  * @see {@link ListTagsForResourceCommandOutput} for command's `response` shape.
33
33
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
34
34
  *
35
+ * @throws {@link BlueGreenDeploymentNotFoundFault} (client fault)
36
+ * <p>
37
+ * <code>BlueGreenDeploymentIdentifier</code> doesn't refer to an existing blue/green deployment.</p>
38
+ *
39
+ * @throws {@link DBClusterNotFoundFault} (client fault)
40
+ * <p>
41
+ * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
42
+ *
43
+ * @throws {@link DBInstanceNotFoundFault} (client fault)
44
+ * <p>
45
+ * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
46
+ *
47
+ * @throws {@link DBProxyNotFoundFault} (client fault)
48
+ * <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>
49
+ *
50
+ * @throws {@link DBProxyTargetGroupNotFoundFault} (client fault)
51
+ * <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>
52
+ *
53
+ * @throws {@link DBSnapshotNotFoundFault} (client fault)
54
+ * <p>
55
+ * <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
56
+ *
57
+ *
58
+ * @example To list information about tags associated with a resource
59
+ * ```javascript
60
+ * // This example lists information about all tags associated with the specified DB option group.
61
+ * const input = {
62
+ * "ResourceName": "arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup"
63
+ * };
64
+ * const command = new ListTagsForResourceCommand(input);
65
+ * await client.send(command);
66
+ * // example id: list-tags-for-resource-8401f3c2-77cd-4f90-bfd5-b523f0adcc2f
67
+ * ```
68
+ *
35
69
  */
36
70
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, RDSClientResolvedConfig> {
37
71
  readonly input: ListTagsForResourceCommandInput;
@@ -33,6 +33,17 @@ export interface ModifyActivityStreamCommandOutput extends ModifyActivityStreamR
33
33
  * @see {@link ModifyActivityStreamCommandOutput} for command's `response` shape.
34
34
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
35
35
  *
36
+ * @throws {@link DBInstanceNotFoundFault} (client fault)
37
+ * <p>
38
+ * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
39
+ *
40
+ * @throws {@link InvalidDBInstanceStateFault} (client fault)
41
+ * <p>The DB instance isn't in a valid state.</p>
42
+ *
43
+ * @throws {@link ResourceNotFoundFault} (client fault)
44
+ * <p>The specified resource ID was not found.</p>
45
+ *
46
+ *
36
47
  */
37
48
  export declare class ModifyActivityStreamCommand extends $Command<ModifyActivityStreamCommandInput, ModifyActivityStreamCommandOutput, RDSClientResolvedConfig> {
38
49
  readonly input: ModifyActivityStreamCommandInput;
@@ -53,6 +53,12 @@ export interface ModifyCertificatesCommandOutput extends ModifyCertificatesResul
53
53
  * @see {@link ModifyCertificatesCommandOutput} for command's `response` shape.
54
54
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
55
55
  *
56
+ * @throws {@link CertificateNotFoundFault} (client fault)
57
+ * <p>
58
+ * <code>CertificateIdentifier</code> doesn't refer to an
59
+ * existing certificate.</p>
60
+ *
61
+ *
56
62
  */
57
63
  export declare class ModifyCertificatesCommand extends $Command<ModifyCertificatesCommandInput, ModifyCertificatesCommandOutput, RDSClientResolvedConfig> {
58
64
  readonly input: ModifyCertificatesCommandInput;
@@ -46,6 +46,20 @@ export interface ModifyCurrentDBClusterCapacityCommandOutput extends DBClusterCa
46
46
  * @see {@link ModifyCurrentDBClusterCapacityCommandOutput} for command's `response` shape.
47
47
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
48
48
  *
49
+ * @throws {@link DBClusterNotFoundFault} (client fault)
50
+ * <p>
51
+ * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
52
+ *
53
+ * @throws {@link InvalidDBClusterCapacityFault} (client fault)
54
+ * <p>
55
+ * <code>Capacity</code> isn't a valid Aurora Serverless DB cluster
56
+ * capacity. Valid capacity values are <code>2</code>, <code>4</code>, <code>8</code>, <code>16</code>,
57
+ * <code>32</code>, <code>64</code>, <code>128</code>, and <code>256</code>.</p>
58
+ *
59
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
60
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
61
+ *
62
+ *
49
63
  */
50
64
  export declare class ModifyCurrentDBClusterCapacityCommand extends $Command<ModifyCurrentDBClusterCapacityCommandInput, ModifyCurrentDBClusterCapacityCommandOutput, RDSClientResolvedConfig> {
51
65
  readonly input: ModifyCurrentDBClusterCapacityCommandInput;
@@ -40,6 +40,13 @@ export interface ModifyCustomDBEngineVersionCommandOutput extends DBEngineVersio
40
40
  * @see {@link ModifyCustomDBEngineVersionCommandOutput} for command's `response` shape.
41
41
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
42
42
  *
43
+ * @throws {@link CustomDBEngineVersionNotFoundFault} (client fault)
44
+ * <p>The specified CEV was not found.</p>
45
+ *
46
+ * @throws {@link InvalidCustomDBEngineVersionStateFault} (client fault)
47
+ * <p>You can't delete the CEV.</p>
48
+ *
49
+ *
43
50
  */
44
51
  export declare class ModifyCustomDBEngineVersionCommand extends $Command<ModifyCustomDBEngineVersionCommandInput, ModifyCustomDBEngineVersionCommandOutput, RDSClientResolvedConfig> {
45
52
  readonly input: ModifyCustomDBEngineVersionCommandInput;
@@ -37,6 +37,71 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
37
37
  * @see {@link ModifyDBClusterCommandOutput} for command's `response` shape.
38
38
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
39
39
  *
40
+ * @throws {@link DBClusterAlreadyExistsFault} (client fault)
41
+ * <p>The user already has a DB cluster with the given identifier.</p>
42
+ *
43
+ * @throws {@link DBClusterNotFoundFault} (client fault)
44
+ * <p>
45
+ * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
46
+ *
47
+ * @throws {@link DBClusterParameterGroupNotFoundFault} (client fault)
48
+ * <p>
49
+ * <code>DBClusterParameterGroupName</code> doesn't refer to an existing DB
50
+ * cluster parameter group.</p>
51
+ *
52
+ * @throws {@link DBSubnetGroupNotFoundFault} (client fault)
53
+ * <p>
54
+ * <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>
55
+ *
56
+ * @throws {@link DomainNotFoundFault} (client fault)
57
+ * <p>
58
+ * <code>Domain</code> doesn't refer to an existing Active Directory domain.</p>
59
+ *
60
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
61
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
62
+ *
63
+ * @throws {@link InvalidDBInstanceStateFault} (client fault)
64
+ * <p>The DB instance isn't in a valid state.</p>
65
+ *
66
+ * @throws {@link InvalidDBSecurityGroupStateFault} (client fault)
67
+ * <p>The state of the DB security group doesn't allow deletion.</p>
68
+ *
69
+ * @throws {@link InvalidDBSubnetGroupStateFault} (client fault)
70
+ * <p>The DB subnet group cannot be deleted because it's in use.</p>
71
+ *
72
+ * @throws {@link InvalidSubnet} (client fault)
73
+ * <p>The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.</p>
74
+ *
75
+ * @throws {@link InvalidVPCNetworkStateFault} (client fault)
76
+ * <p>The DB subnet group doesn't cover all Availability Zones after it's
77
+ * created because of users' change.</p>
78
+ *
79
+ * @throws {@link StorageQuotaExceededFault} (client fault)
80
+ * <p>The request would result in the user exceeding the allowed amount of storage
81
+ * available across all DB instances.</p>
82
+ *
83
+ *
84
+ * @example To change DB cluster settings
85
+ * ```javascript
86
+ * // This example changes the specified settings for the specified DB cluster.
87
+ * const input = {
88
+ * "ApplyImmediately": true,
89
+ * "DBClusterIdentifier": "mydbcluster",
90
+ * "MasterUserPassword": "mynewpassword",
91
+ * "NewDBClusterIdentifier": "mynewdbcluster",
92
+ * "PreferredBackupWindow": "04:00-04:30",
93
+ * "PreferredMaintenanceWindow": "Tue:05:00-Tue:05:30"
94
+ * };
95
+ * const command = new ModifyDBClusterCommand(input);
96
+ * const response = await client.send(command);
97
+ * /* response ==
98
+ * {
99
+ * "DBCluster": {}
100
+ * }
101
+ * *\/
102
+ * // example id: modify-db-cluster-a370ee1b-768d-450a-853b-707cb1ab663d
103
+ * ```
104
+ *
40
105
  */
41
106
  export declare class ModifyDBClusterCommand extends $Command<ModifyDBClusterCommandInput, ModifyDBClusterCommandOutput, RDSClientResolvedConfig> {
42
107
  readonly input: ModifyDBClusterCommandInput;
@@ -33,6 +33,23 @@ export interface ModifyDBClusterEndpointCommandOutput extends DBClusterEndpoint,
33
33
  * @see {@link ModifyDBClusterEndpointCommandOutput} for command's `response` shape.
34
34
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
35
35
  *
36
+ * @throws {@link DBClusterEndpointNotFoundFault} (client fault)
37
+ * <p>The specified custom endpoint doesn't exist.</p>
38
+ *
39
+ * @throws {@link DBInstanceNotFoundFault} (client fault)
40
+ * <p>
41
+ * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
42
+ *
43
+ * @throws {@link InvalidDBClusterEndpointStateFault} (client fault)
44
+ * <p>The requested operation can't be performed on the endpoint while the endpoint is in this state.</p>
45
+ *
46
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
47
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
48
+ *
49
+ * @throws {@link InvalidDBInstanceStateFault} (client fault)
50
+ * <p>The DB instance isn't in a valid state.</p>
51
+ *
52
+ *
36
53
  */
37
54
  export declare class ModifyDBClusterEndpointCommand extends $Command<ModifyDBClusterEndpointCommandInput, ModifyDBClusterEndpointCommandOutput, RDSClientResolvedConfig> {
38
55
  readonly input: ModifyDBClusterEndpointCommandInput;
@@ -54,6 +54,35 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
54
54
  * @see {@link ModifyDBClusterParameterGroupCommandOutput} for command's `response` shape.
55
55
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
56
56
  *
57
+ * @throws {@link DBParameterGroupNotFoundFault} (client fault)
58
+ * <p>
59
+ * <code>DBParameterGroupName</code> doesn't refer to an
60
+ * existing DB parameter group.</p>
61
+ *
62
+ * @throws {@link InvalidDBParameterGroupStateFault} (client fault)
63
+ * <p>The DB parameter group is in use or is in an invalid state. If you are attempting
64
+ * to delete the parameter group, you can't delete it when the parameter group is in
65
+ * this state.</p>
66
+ *
67
+ *
68
+ * @example To change DB cluster parameter group settings
69
+ * ```javascript
70
+ * // This example immediately changes the specified setting for the specified DB cluster parameter group.
71
+ * const input = {
72
+ * "DBClusterParameterGroupName": "mydbclusterparametergroup",
73
+ * "Parameters": [
74
+ * {
75
+ * "ApplyMethod": "immediate",
76
+ * "ParameterName": "time_zone",
77
+ * "ParameterValue": "America/Phoenix"
78
+ * }
79
+ * ]
80
+ * };
81
+ * const command = new ModifyDBClusterParameterGroupCommand(input);
82
+ * await client.send(command);
83
+ * // example id: modify-db-cluster-parameter-group-f9156bc9-082a-442e-8d12-239542c1a113
84
+ * ```
85
+ *
57
86
  */
58
87
  export declare class ModifyDBClusterParameterGroupCommand extends $Command<ModifyDBClusterParameterGroupCommandInput, ModifyDBClusterParameterGroupCommandOutput, RDSClientResolvedConfig> {
59
88
  readonly input: ModifyDBClusterParameterGroupCommandInput;
@@ -47,6 +47,41 @@ export interface ModifyDBClusterSnapshotAttributeCommandOutput extends ModifyDBC
47
47
  * @see {@link ModifyDBClusterSnapshotAttributeCommandOutput} for command's `response` shape.
48
48
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
49
49
  *
50
+ * @throws {@link DBClusterSnapshotNotFoundFault} (client fault)
51
+ * <p>
52
+ * <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot.</p>
53
+ *
54
+ * @throws {@link InvalidDBClusterSnapshotStateFault} (client fault)
55
+ * <p>The supplied value isn't a valid DB cluster snapshot state.</p>
56
+ *
57
+ * @throws {@link SharedSnapshotQuotaExceededFault} (client fault)
58
+ * <p>You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.</p>
59
+ *
60
+ *
61
+ * @example To add or remove access to a manual DB cluster snapshot
62
+ * ```javascript
63
+ * // The following example gives two AWS accounts access to a manual DB cluster snapshot and ensures that the DB cluster snapshot is private by removing the value "all".
64
+ * const input = {
65
+ * "AttributeName": "restore",
66
+ * "DBClusterSnapshotIdentifier": "manual-cluster-snapshot1",
67
+ * "ValuesToAdd": [
68
+ * "123451234512",
69
+ * "123456789012"
70
+ * ],
71
+ * "ValuesToRemove": [
72
+ * "all"
73
+ * ]
74
+ * };
75
+ * const command = new ModifyDBClusterSnapshotAttributeCommand(input);
76
+ * const response = await client.send(command);
77
+ * /* response ==
78
+ * {
79
+ * "DBClusterSnapshotAttributesResult": {}
80
+ * }
81
+ * *\/
82
+ * // example id: to-add-or-remove-access-to-a-manual-db-cluster-snapshot-1473889426431
83
+ * ```
84
+ *
50
85
  */
51
86
  export declare class ModifyDBClusterSnapshotAttributeCommand extends $Command<ModifyDBClusterSnapshotAttributeCommandInput, ModifyDBClusterSnapshotAttributeCommandOutput, RDSClientResolvedConfig> {
52
87
  readonly input: ModifyDBClusterSnapshotAttributeCommandInput;
@@ -33,6 +33,104 @@ export interface ModifyDBInstanceCommandOutput extends ModifyDBInstanceResult, _
33
33
  * @see {@link ModifyDBInstanceCommandOutput} for command's `response` shape.
34
34
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
35
35
  *
36
+ * @throws {@link AuthorizationNotFoundFault} (client fault)
37
+ * <p>The specified CIDR IP range or Amazon EC2 security group might not be authorized
38
+ * for the specified DB security group.</p>
39
+ * <p>Or, RDS might not be authorized to perform necessary actions using IAM on your
40
+ * behalf.</p>
41
+ *
42
+ * @throws {@link BackupPolicyNotFoundFault} (client fault)
43
+ *
44
+ * @throws {@link CertificateNotFoundFault} (client fault)
45
+ * <p>
46
+ * <code>CertificateIdentifier</code> doesn't refer to an
47
+ * existing certificate.</p>
48
+ *
49
+ * @throws {@link DBInstanceAlreadyExistsFault} (client fault)
50
+ * <p>The user already has a DB instance with the given identifier.</p>
51
+ *
52
+ * @throws {@link DBInstanceNotFoundFault} (client fault)
53
+ * <p>
54
+ * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
55
+ *
56
+ * @throws {@link DBParameterGroupNotFoundFault} (client fault)
57
+ * <p>
58
+ * <code>DBParameterGroupName</code> doesn't refer to an
59
+ * existing DB parameter group.</p>
60
+ *
61
+ * @throws {@link DBSecurityGroupNotFoundFault} (client fault)
62
+ * <p>
63
+ * <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group.</p>
64
+ *
65
+ * @throws {@link DBUpgradeDependencyFailureFault} (client fault)
66
+ * <p>The DB upgrade failed because a resource the DB depends on can't be
67
+ * modified.</p>
68
+ *
69
+ * @throws {@link DomainNotFoundFault} (client fault)
70
+ * <p>
71
+ * <code>Domain</code> doesn't refer to an existing Active Directory domain.</p>
72
+ *
73
+ * @throws {@link InsufficientDBInstanceCapacityFault} (client fault)
74
+ * <p>The specified DB instance class isn't available in the specified Availability
75
+ * Zone.</p>
76
+ *
77
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
78
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
79
+ *
80
+ * @throws {@link InvalidDBInstanceStateFault} (client fault)
81
+ * <p>The DB instance isn't in a valid state.</p>
82
+ *
83
+ * @throws {@link InvalidDBSecurityGroupStateFault} (client fault)
84
+ * <p>The state of the DB security group doesn't allow deletion.</p>
85
+ *
86
+ * @throws {@link InvalidVPCNetworkStateFault} (client fault)
87
+ * <p>The DB subnet group doesn't cover all Availability Zones after it's
88
+ * created because of users' change.</p>
89
+ *
90
+ * @throws {@link KMSKeyNotAccessibleFault} (client fault)
91
+ * <p>An error occurred accessing an Amazon Web Services KMS key.</p>
92
+ *
93
+ * @throws {@link NetworkTypeNotSupported} (client fault)
94
+ * <p>The network type is invalid for the DB instance. Valid nework type values are <code>IPV4</code> and <code>DUAL</code>.</p>
95
+ *
96
+ * @throws {@link OptionGroupNotFoundFault} (client fault)
97
+ * <p>The specified option group could not be found.</p>
98
+ *
99
+ * @throws {@link ProvisionedIopsNotAvailableInAZFault} (client fault)
100
+ * <p>Provisioned IOPS not available in the specified Availability Zone.</p>
101
+ *
102
+ * @throws {@link StorageQuotaExceededFault} (client fault)
103
+ * <p>The request would result in the user exceeding the allowed amount of storage
104
+ * available across all DB instances.</p>
105
+ *
106
+ * @throws {@link StorageTypeNotSupportedFault} (client fault)
107
+ * <p>Storage of the <code>StorageType</code> specified can't be associated
108
+ * with the DB instance.</p>
109
+ *
110
+ *
111
+ * @example To change DB instance settings
112
+ * ```javascript
113
+ * // This example immediately changes the specified settings for the specified DB instance.
114
+ * const input = {
115
+ * "AllocatedStorage": 10,
116
+ * "ApplyImmediately": true,
117
+ * "BackupRetentionPeriod": 1,
118
+ * "DBInstanceClass": "db.t2.small",
119
+ * "DBInstanceIdentifier": "mymysqlinstance",
120
+ * "MasterUserPassword": "mynewpassword",
121
+ * "PreferredBackupWindow": "04:00-04:30",
122
+ * "PreferredMaintenanceWindow": "Tue:05:00-Tue:05:30"
123
+ * };
124
+ * const command = new ModifyDBInstanceCommand(input);
125
+ * const response = await client.send(command);
126
+ * /* response ==
127
+ * {
128
+ * "DBInstance": {}
129
+ * }
130
+ * *\/
131
+ * // example id: modify-db-instance-6979a368-6254-467b-8a8d-61103f4fcde9
132
+ * ```
133
+ *
36
134
  */
37
135
  export declare class ModifyDBInstanceCommand extends $Command<ModifyDBInstanceCommandInput, ModifyDBInstanceCommandOutput, RDSClientResolvedConfig> {
38
136
  readonly input: ModifyDBInstanceCommandInput;
@@ -42,6 +42,35 @@ export interface ModifyDBParameterGroupCommandOutput extends DBParameterGroupNam
42
42
  * @see {@link ModifyDBParameterGroupCommandOutput} for command's `response` shape.
43
43
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
44
44
  *
45
+ * @throws {@link DBParameterGroupNotFoundFault} (client fault)
46
+ * <p>
47
+ * <code>DBParameterGroupName</code> doesn't refer to an
48
+ * existing DB parameter group.</p>
49
+ *
50
+ * @throws {@link InvalidDBParameterGroupStateFault} (client fault)
51
+ * <p>The DB parameter group is in use or is in an invalid state. If you are attempting
52
+ * to delete the parameter group, you can't delete it when the parameter group is in
53
+ * this state.</p>
54
+ *
55
+ *
56
+ * @example To change DB parameter group settings
57
+ * ```javascript
58
+ * // This example immediately changes the specified setting for the specified DB parameter group.
59
+ * const input = {
60
+ * "DBParameterGroupName": "mymysqlparametergroup",
61
+ * "Parameters": [
62
+ * {
63
+ * "ApplyMethod": "immediate",
64
+ * "ParameterName": "time_zone",
65
+ * "ParameterValue": "America/Phoenix"
66
+ * }
67
+ * ]
68
+ * };
69
+ * const command = new ModifyDBParameterGroupCommand(input);
70
+ * await client.send(command);
71
+ * // example id: modify-db-parameter-group-f3a4e52a-68e4-4b88-b559-f912d34c457a
72
+ * ```
73
+ *
45
74
  */
46
75
  export declare class ModifyDBParameterGroupCommand extends $Command<ModifyDBParameterGroupCommandInput, ModifyDBParameterGroupCommandOutput, RDSClientResolvedConfig> {
47
76
  readonly input: ModifyDBParameterGroupCommandInput;
@@ -29,6 +29,16 @@ export interface ModifyDBProxyCommandOutput extends ModifyDBProxyResponse, __Met
29
29
  * @see {@link ModifyDBProxyCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @throws {@link DBProxyAlreadyExistsFault} (client fault)
33
+ * <p>The specified proxy name must be unique for all proxies owned by your Amazon Web Services account in the specified Amazon Web Services Region.</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
+ * @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 ModifyDBProxyCommand extends $Command<ModifyDBProxyCommandInput, ModifyDBProxyCommandOutput, RDSClientResolvedConfig> {
34
44
  readonly input: ModifyDBProxyCommandInput;
@@ -29,6 +29,19 @@ export interface ModifyDBProxyEndpointCommandOutput extends ModifyDBProxyEndpoin
29
29
  * @see {@link ModifyDBProxyEndpointCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @throws {@link DBProxyEndpointAlreadyExistsFault} (client fault)
33
+ * <p>The specified DB proxy endpoint name must be unique for all DB proxy endpoints owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
34
+ *
35
+ * @throws {@link DBProxyEndpointNotFoundFault} (client fault)
36
+ * <p>The DB proxy endpoint doesn't exist.</p>
37
+ *
38
+ * @throws {@link InvalidDBProxyEndpointStateFault} (client fault)
39
+ * <p>You can't perform this operation while the DB proxy endpoint is in a particular state.</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 ModifyDBProxyEndpointCommand extends $Command<ModifyDBProxyEndpointCommandInput, ModifyDBProxyEndpointCommandOutput, RDSClientResolvedConfig> {
34
47
  readonly input: ModifyDBProxyEndpointCommandInput;