@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,20 @@ export interface AddRoleToDBClusterCommandOutput extends __MetadataBearer {
29
29
  * @see {@link AddRoleToDBClusterCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @throws {@link DBClusterNotFoundFault} (client fault)
33
+ * <p>
34
+ * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
35
+ *
36
+ * @throws {@link DBClusterRoleAlreadyExistsFault} (client fault)
37
+ * <p>The specified IAM role Amazon Resource Name (ARN) is already associated with the specified DB cluster.</p>
38
+ *
39
+ * @throws {@link DBClusterRoleQuotaExceededFault} (client fault)
40
+ * <p>You have exceeded the maximum number of IAM roles that can be associated with the specified DB cluster.</p>
41
+ *
42
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
43
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
44
+ *
45
+ *
32
46
  */
33
47
  export declare class AddRoleToDBClusterCommand extends $Command<AddRoleToDBClusterCommandInput, AddRoleToDBClusterCommandOutput, RDSClientResolvedConfig> {
34
48
  readonly input: AddRoleToDBClusterCommandInput;
@@ -33,6 +33,20 @@ export interface AddRoleToDBInstanceCommandOutput extends __MetadataBearer {
33
33
  * @see {@link AddRoleToDBInstanceCommandOutput} 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 DBInstanceRoleAlreadyExistsFault} (client fault)
41
+ * <p>The specified <code>RoleArn</code> or <code>FeatureName</code> value is already associated with the DB instance.</p>
42
+ *
43
+ * @throws {@link DBInstanceRoleQuotaExceededFault} (client fault)
44
+ * <p>You can't associate any more Amazon Web Services Identity and Access Management (IAM) roles with the DB instance because the quota has been reached.</p>
45
+ *
46
+ * @throws {@link InvalidDBInstanceStateFault} (client fault)
47
+ * <p>The DB instance isn't in a valid state.</p>
48
+ *
49
+ *
36
50
  */
37
51
  export declare class AddRoleToDBInstanceCommand extends $Command<AddRoleToDBInstanceCommandInput, AddRoleToDBInstanceCommandOutput, RDSClientResolvedConfig> {
38
52
  readonly input: AddRoleToDBInstanceCommandInput;
@@ -29,6 +29,30 @@ export interface AddSourceIdentifierToSubscriptionCommandOutput extends AddSourc
29
29
  * @see {@link AddSourceIdentifierToSubscriptionCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @throws {@link SourceNotFoundFault} (client fault)
33
+ * <p>The requested source could not be found.</p>
34
+ *
35
+ * @throws {@link SubscriptionNotFoundFault} (client fault)
36
+ * <p>The subscription name does not exist.</p>
37
+ *
38
+ *
39
+ * @example To add a source identifier to an event notification subscription
40
+ * ```javascript
41
+ * // This example add a source identifier to an event notification subscription.
42
+ * const input = {
43
+ * "SourceIdentifier": "mymysqlinstance",
44
+ * "SubscriptionName": "mymysqleventsubscription"
45
+ * };
46
+ * const command = new AddSourceIdentifierToSubscriptionCommand(input);
47
+ * const response = await client.send(command);
48
+ * /* response ==
49
+ * {
50
+ * "EventSubscription": {}
51
+ * }
52
+ * *\/
53
+ * // example id: add-source-identifier-to-subscription-93fb6a15-0a59-4577-a7b5-e12db9752c14
54
+ * ```
55
+ *
32
56
  */
33
57
  export declare class AddSourceIdentifierToSubscriptionCommand extends $Command<AddSourceIdentifierToSubscriptionCommandInput, AddSourceIdentifierToSubscriptionCommandOutput, RDSClientResolvedConfig> {
34
58
  readonly input: AddSourceIdentifierToSubscriptionCommandInput;
@@ -31,6 +31,46 @@ export interface AddTagsToResourceCommandOutput extends __MetadataBearer {
31
31
  * @see {@link AddTagsToResourceCommandOutput} for command's `response` shape.
32
32
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
33
33
  *
34
+ * @throws {@link BlueGreenDeploymentNotFoundFault} (client fault)
35
+ * <p>
36
+ * <code>BlueGreenDeploymentIdentifier</code> doesn't refer to an existing blue/green deployment.</p>
37
+ *
38
+ * @throws {@link DBClusterNotFoundFault} (client fault)
39
+ * <p>
40
+ * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
41
+ *
42
+ * @throws {@link DBInstanceNotFoundFault} (client fault)
43
+ * <p>
44
+ * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
45
+ *
46
+ * @throws {@link DBProxyNotFoundFault} (client fault)
47
+ * <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>
48
+ *
49
+ * @throws {@link DBProxyTargetGroupNotFoundFault} (client fault)
50
+ * <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>
51
+ *
52
+ * @throws {@link DBSnapshotNotFoundFault} (client fault)
53
+ * <p>
54
+ * <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
55
+ *
56
+ *
57
+ * @example To add tags to a resource
58
+ * ```javascript
59
+ * // This example adds a tag to an option group.
60
+ * const input = {
61
+ * "ResourceName": "arn:aws:rds:us-east-1:992648334831:og:mymysqloptiongroup",
62
+ * "Tags": [
63
+ * {
64
+ * "Key": "Staging",
65
+ * "Value": "LocationDB"
66
+ * }
67
+ * ]
68
+ * };
69
+ * const command = new AddTagsToResourceCommand(input);
70
+ * await client.send(command);
71
+ * // example id: add-tags-to-resource-fa99ef50-228b-449d-b893-ca4d4e9768ab
72
+ * ```
73
+ *
34
74
  */
35
75
  export declare class AddTagsToResourceCommand extends $Command<AddTagsToResourceCommandInput, AddTagsToResourceCommandOutput, RDSClientResolvedConfig> {
36
76
  readonly input: AddTagsToResourceCommandInput;
@@ -29,6 +29,34 @@ export interface ApplyPendingMaintenanceActionCommandOutput extends ApplyPending
29
29
  * @see {@link ApplyPendingMaintenanceActionCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
33
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
34
+ *
35
+ * @throws {@link InvalidDBInstanceStateFault} (client fault)
36
+ * <p>The DB instance isn't in a valid state.</p>
37
+ *
38
+ * @throws {@link ResourceNotFoundFault} (client fault)
39
+ * <p>The specified resource ID was not found.</p>
40
+ *
41
+ *
42
+ * @example To apply a pending maintenance action
43
+ * ```javascript
44
+ * // This example immediately applies a pending system update to a DB instance.
45
+ * const input = {
46
+ * "ApplyAction": "system-update",
47
+ * "OptInType": "immediate",
48
+ * "ResourceIdentifier": "arn:aws:rds:us-east-1:992648334831:db:mymysqlinstance"
49
+ * };
50
+ * const command = new ApplyPendingMaintenanceActionCommand(input);
51
+ * const response = await client.send(command);
52
+ * /* response ==
53
+ * {
54
+ * "ResourcePendingMaintenanceActions": {}
55
+ * }
56
+ * *\/
57
+ * // example id: apply-pending-maintenance-action-2a026047-8bbb-47fc-b695-abad9f308c24
58
+ * ```
59
+ *
32
60
  */
33
61
  export declare class ApplyPendingMaintenanceActionCommand extends $Command<ApplyPendingMaintenanceActionCommandInput, ApplyPendingMaintenanceActionCommandOutput, RDSClientResolvedConfig> {
34
62
  readonly input: ApplyPendingMaintenanceActionCommandInput;
@@ -44,6 +44,38 @@ export interface AuthorizeDBSecurityGroupIngressCommandOutput extends AuthorizeD
44
44
  * @see {@link AuthorizeDBSecurityGroupIngressCommandOutput} for command's `response` shape.
45
45
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
46
46
  *
47
+ * @throws {@link AuthorizationAlreadyExistsFault} (client fault)
48
+ * <p>The specified CIDR IP range or Amazon EC2 security group is already authorized for
49
+ * the specified DB security group.</p>
50
+ *
51
+ * @throws {@link AuthorizationQuotaExceededFault} (client fault)
52
+ * <p>The DB security group authorization quota has been reached.</p>
53
+ *
54
+ * @throws {@link DBSecurityGroupNotFoundFault} (client fault)
55
+ * <p>
56
+ * <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group.</p>
57
+ *
58
+ * @throws {@link InvalidDBSecurityGroupStateFault} (client fault)
59
+ * <p>The state of the DB security group doesn't allow deletion.</p>
60
+ *
61
+ *
62
+ * @example To authorize DB security group integress
63
+ * ```javascript
64
+ * // This example authorizes access to the specified security group by the specified CIDR block.
65
+ * const input = {
66
+ * "CIDRIP": "203.0.113.5/32",
67
+ * "DBSecurityGroupName": "mydbsecuritygroup"
68
+ * };
69
+ * const command = new AuthorizeDBSecurityGroupIngressCommand(input);
70
+ * const response = await client.send(command);
71
+ * /* response ==
72
+ * {
73
+ * "DBSecurityGroup": {}
74
+ * }
75
+ * *\/
76
+ * // example id: authorize-db-security-group-ingress-ebf9ab91-8912-4b07-a32e-ca150668164f
77
+ * ```
78
+ *
47
79
  */
48
80
  export declare class AuthorizeDBSecurityGroupIngressCommand extends $Command<AuthorizeDBSecurityGroupIngressCommandInput, AuthorizeDBSecurityGroupIngressCommandOutput, RDSClientResolvedConfig> {
49
81
  readonly input: AuthorizeDBSecurityGroupIngressCommandInput;
@@ -36,6 +36,14 @@ export interface BacktrackDBClusterCommandOutput extends DBClusterBacktrack, __M
36
36
  * @see {@link BacktrackDBClusterCommandOutput} for command's `response` shape.
37
37
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
38
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 InvalidDBClusterStateFault} (client fault)
44
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
45
+ *
46
+ *
39
47
  */
40
48
  export declare class BacktrackDBClusterCommand extends $Command<BacktrackDBClusterCommandInput, BacktrackDBClusterCommandOutput, RDSClientResolvedConfig> {
41
49
  readonly input: BacktrackDBClusterCommandInput;
@@ -30,6 +30,13 @@ export interface CancelExportTaskCommandOutput extends ExportTask, __MetadataBea
30
30
  * @see {@link CancelExportTaskCommandOutput} 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
+ * @throws {@link InvalidExportTaskStateFault} (client fault)
37
+ * <p>You can't cancel an export task that has completed.</p>
38
+ *
39
+ *
33
40
  */
34
41
  export declare class CancelExportTaskCommand extends $Command<CancelExportTaskCommandInput, CancelExportTaskCommandOutput, RDSClientResolvedConfig> {
35
42
  readonly input: CancelExportTaskCommandInput;
@@ -29,6 +29,37 @@ export interface CopyDBClusterParameterGroupCommandOutput extends CopyDBClusterP
29
29
  * @see {@link CopyDBClusterParameterGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @throws {@link DBParameterGroupAlreadyExistsFault} (client fault)
33
+ * <p>A DB parameter group with the same name exists.</p>
34
+ *
35
+ * @throws {@link DBParameterGroupNotFoundFault} (client fault)
36
+ * <p>
37
+ * <code>DBParameterGroupName</code> doesn't refer to an
38
+ * existing DB parameter group.</p>
39
+ *
40
+ * @throws {@link DBParameterGroupQuotaExceededFault} (client fault)
41
+ * <p>The request would result in the user exceeding the allowed number of DB parameter
42
+ * groups.</p>
43
+ *
44
+ *
45
+ * @example To copy a DB cluster parameter group
46
+ * ```javascript
47
+ * // This example copies a DB cluster parameter group.
48
+ * const input = {
49
+ * "SourceDBClusterParameterGroupIdentifier": "mydbclusterparametergroup",
50
+ * "TargetDBClusterParameterGroupDescription": "My DB cluster parameter group copy",
51
+ * "TargetDBClusterParameterGroupIdentifier": "mydbclusterparametergroup-copy"
52
+ * };
53
+ * const command = new CopyDBClusterParameterGroupCommand(input);
54
+ * const response = await client.send(command);
55
+ * /* response ==
56
+ * {
57
+ * "DBClusterParameterGroup": {}
58
+ * }
59
+ * *\/
60
+ * // example id: copy-db-cluster-parameter-group-6fefaffe-cde9-4dba-9f0b-d3f593572fe4
61
+ * ```
62
+ *
32
63
  */
33
64
  export declare class CopyDBClusterParameterGroupCommand extends $Command<CopyDBClusterParameterGroupCommandInput, CopyDBClusterParameterGroupCommandOutput, RDSClientResolvedConfig> {
34
65
  readonly input: CopyDBClusterParameterGroupCommandInput;
@@ -65,6 +65,44 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
65
65
  * @see {@link CopyDBClusterSnapshotCommandOutput} for command's `response` shape.
66
66
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
67
67
  *
68
+ * @throws {@link DBClusterSnapshotAlreadyExistsFault} (client fault)
69
+ * <p>The user already has a DB cluster snapshot with the given identifier.</p>
70
+ *
71
+ * @throws {@link DBClusterSnapshotNotFoundFault} (client fault)
72
+ * <p>
73
+ * <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot.</p>
74
+ *
75
+ * @throws {@link InvalidDBClusterSnapshotStateFault} (client fault)
76
+ * <p>The supplied value isn't a valid DB cluster snapshot state.</p>
77
+ *
78
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
79
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
80
+ *
81
+ * @throws {@link KMSKeyNotAccessibleFault} (client fault)
82
+ * <p>An error occurred accessing an Amazon Web Services KMS key.</p>
83
+ *
84
+ * @throws {@link SnapshotQuotaExceededFault} (client fault)
85
+ * <p>The request would result in the user exceeding the allowed number of DB
86
+ * snapshots.</p>
87
+ *
88
+ *
89
+ * @example To copy a DB cluster snapshot
90
+ * ```javascript
91
+ * // The following example copies an automated snapshot of a DB cluster to a new DB cluster snapshot.
92
+ * const input = {
93
+ * "SourceDBClusterSnapshotIdentifier": "rds:sample-cluster-2016-09-14-10-38",
94
+ * "TargetDBClusterSnapshotIdentifier": "cluster-snapshot-copy-1"
95
+ * };
96
+ * const command = new CopyDBClusterSnapshotCommand(input);
97
+ * const response = await client.send(command);
98
+ * /* response ==
99
+ * {
100
+ * "DBClusterSnapshot": {}
101
+ * }
102
+ * *\/
103
+ * // example id: to-copy-a-db-cluster-snapshot-1473879770564
104
+ * ```
105
+ *
68
106
  */
69
107
  export declare class CopyDBClusterSnapshotCommand extends $Command<CopyDBClusterSnapshotCommandInput, CopyDBClusterSnapshotCommandOutput, RDSClientResolvedConfig> {
70
108
  readonly input: CopyDBClusterSnapshotCommandInput;
@@ -29,6 +29,37 @@ export interface CopyDBParameterGroupCommandOutput extends CopyDBParameterGroupR
29
29
  * @see {@link CopyDBParameterGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @throws {@link DBParameterGroupAlreadyExistsFault} (client fault)
33
+ * <p>A DB parameter group with the same name exists.</p>
34
+ *
35
+ * @throws {@link DBParameterGroupNotFoundFault} (client fault)
36
+ * <p>
37
+ * <code>DBParameterGroupName</code> doesn't refer to an
38
+ * existing DB parameter group.</p>
39
+ *
40
+ * @throws {@link DBParameterGroupQuotaExceededFault} (client fault)
41
+ * <p>The request would result in the user exceeding the allowed number of DB parameter
42
+ * groups.</p>
43
+ *
44
+ *
45
+ * @example To copy a DB parameter group
46
+ * ```javascript
47
+ * // This example copies a DB parameter group.
48
+ * const input = {
49
+ * "SourceDBParameterGroupIdentifier": "mymysqlparametergroup",
50
+ * "TargetDBParameterGroupDescription": "My MySQL parameter group copy",
51
+ * "TargetDBParameterGroupIdentifier": "mymysqlparametergroup-copy"
52
+ * };
53
+ * const command = new CopyDBParameterGroupCommand(input);
54
+ * const response = await client.send(command);
55
+ * /* response ==
56
+ * {
57
+ * "DBParameterGroup": {}
58
+ * }
59
+ * *\/
60
+ * // example id: copy-db-parameter-group-610d4dba-2c87-467f-ae5d-edd7f8e47349
61
+ * ```
62
+ *
32
63
  */
33
64
  export declare class CopyDBParameterGroupCommand extends $Command<CopyDBParameterGroupCommandInput, CopyDBParameterGroupCommandOutput, RDSClientResolvedConfig> {
34
65
  readonly input: CopyDBParameterGroupCommandInput;
@@ -35,6 +35,47 @@ export interface CopyDBSnapshotCommandOutput extends CopyDBSnapshotResult, __Met
35
35
  * @see {@link CopyDBSnapshotCommandOutput} for command's `response` shape.
36
36
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
37
37
  *
38
+ * @throws {@link CustomAvailabilityZoneNotFoundFault} (client fault)
39
+ * <p>
40
+ * <code>CustomAvailabilityZoneId</code> doesn't refer to an existing custom
41
+ * Availability Zone identifier.</p>
42
+ *
43
+ * @throws {@link DBSnapshotAlreadyExistsFault} (client fault)
44
+ * <p>
45
+ * <code>DBSnapshotIdentifier</code> is already used by an existing snapshot.</p>
46
+ *
47
+ * @throws {@link DBSnapshotNotFoundFault} (client fault)
48
+ * <p>
49
+ * <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
50
+ *
51
+ * @throws {@link InvalidDBSnapshotStateFault} (client fault)
52
+ * <p>The state of the DB snapshot doesn't allow deletion.</p>
53
+ *
54
+ * @throws {@link KMSKeyNotAccessibleFault} (client fault)
55
+ * <p>An error occurred accessing an Amazon Web Services KMS key.</p>
56
+ *
57
+ * @throws {@link SnapshotQuotaExceededFault} (client fault)
58
+ * <p>The request would result in the user exceeding the allowed number of DB
59
+ * snapshots.</p>
60
+ *
61
+ *
62
+ * @example To copy a DB snapshot
63
+ * ```javascript
64
+ * // This example copies a DB snapshot.
65
+ * const input = {
66
+ * "SourceDBSnapshotIdentifier": "mydbsnapshot",
67
+ * "TargetDBSnapshotIdentifier": "mydbsnapshot-copy"
68
+ * };
69
+ * const command = new CopyDBSnapshotCommand(input);
70
+ * const response = await client.send(command);
71
+ * /* response ==
72
+ * {
73
+ * "DBSnapshot": {}
74
+ * }
75
+ * *\/
76
+ * // example id: copy-db-snapshot-1b2f0210-bc67-415d-9822-6eecf447dc86
77
+ * ```
78
+ *
38
79
  */
39
80
  export declare class CopyDBSnapshotCommand extends $Command<CopyDBSnapshotCommandInput, CopyDBSnapshotCommandOutput, RDSClientResolvedConfig> {
40
81
  readonly input: CopyDBSnapshotCommandInput;
@@ -29,6 +29,34 @@ export interface CopyOptionGroupCommandOutput extends CopyOptionGroupResult, __M
29
29
  * @see {@link CopyOptionGroupCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @throws {@link OptionGroupAlreadyExistsFault} (client fault)
33
+ * <p>The option group you are trying to create already exists.</p>
34
+ *
35
+ * @throws {@link OptionGroupNotFoundFault} (client fault)
36
+ * <p>The specified option group could not be found.</p>
37
+ *
38
+ * @throws {@link OptionGroupQuotaExceededFault} (client fault)
39
+ * <p>The quota of 20 option groups was exceeded for this Amazon Web Services account.</p>
40
+ *
41
+ *
42
+ * @example To copy an option group
43
+ * ```javascript
44
+ * // This example copies an option group.
45
+ * const input = {
46
+ * "SourceOptionGroupIdentifier": "mymysqloptiongroup",
47
+ * "TargetOptionGroupDescription": "My MySQL option group copy",
48
+ * "TargetOptionGroupIdentifier": "mymysqloptiongroup-copy"
49
+ * };
50
+ * const command = new CopyOptionGroupCommand(input);
51
+ * const response = await client.send(command);
52
+ * /* response ==
53
+ * {
54
+ * "OptionGroup": {}
55
+ * }
56
+ * *\/
57
+ * // example id: copy-option-group-8d5c01c3-8846-4e9c-a4b0-1b7237f7d0ec
58
+ * ```
59
+ *
32
60
  */
33
61
  export declare class CopyOptionGroupCommand extends $Command<CopyOptionGroupCommandInput, CopyOptionGroupCommandOutput, RDSClientResolvedConfig> {
34
62
  readonly input: CopyOptionGroupCommandInput;
@@ -43,6 +43,48 @@ export interface CreateBlueGreenDeploymentCommandOutput extends CreateBlueGreenD
43
43
  * @see {@link CreateBlueGreenDeploymentCommandOutput} for command's `response` shape.
44
44
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
45
45
  *
46
+ * @throws {@link BlueGreenDeploymentAlreadyExistsFault} (client fault)
47
+ * <p>A blue/green deployment with the specified name already exists.</p>
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 DBClusterParameterGroupNotFoundFault} (client fault)
54
+ * <p>
55
+ * <code>DBClusterParameterGroupName</code> doesn't refer to an existing DB
56
+ * cluster parameter group.</p>
57
+ *
58
+ * @throws {@link DBClusterQuotaExceededFault} (client fault)
59
+ * <p>The user attempted to create a new DB cluster and the user has already reached the
60
+ * maximum allowed DB cluster quota.</p>
61
+ *
62
+ * @throws {@link DBInstanceNotFoundFault} (client fault)
63
+ * <p>
64
+ * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
65
+ *
66
+ * @throws {@link DBParameterGroupNotFoundFault} (client fault)
67
+ * <p>
68
+ * <code>DBParameterGroupName</code> doesn't refer to an
69
+ * existing DB parameter group.</p>
70
+ *
71
+ * @throws {@link InstanceQuotaExceededFault} (client fault)
72
+ * <p>The request would result in the user exceeding the allowed number of DB
73
+ * instances.</p>
74
+ *
75
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
76
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
77
+ *
78
+ * @throws {@link InvalidDBInstanceStateFault} (client fault)
79
+ * <p>The DB instance isn't in a valid state.</p>
80
+ *
81
+ * @throws {@link SourceClusterNotSupportedFault} (client fault)
82
+ * <p>The source DB cluster isn't supported for a blue/green deployment.</p>
83
+ *
84
+ * @throws {@link SourceDatabaseNotSupportedFault} (client fault)
85
+ * <p>The source DB instance isn't supported for a blue/green deployment.</p>
86
+ *
87
+ *
46
88
  */
47
89
  export declare class CreateBlueGreenDeploymentCommand extends $Command<CreateBlueGreenDeploymentCommandInput, CreateBlueGreenDeploymentCommandOutput, RDSClientResolvedConfig> {
48
90
  readonly input: CreateBlueGreenDeploymentCommandInput;
@@ -29,6 +29,19 @@ export interface CreateCustomDBEngineVersionCommandOutput extends DBEngineVersio
29
29
  * @see {@link CreateCustomDBEngineVersionCommandOutput} for command's `response` shape.
30
30
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
31
31
  *
32
+ * @throws {@link CustomDBEngineVersionAlreadyExistsFault} (client fault)
33
+ * <p>A CEV with the specified name already exists.</p>
34
+ *
35
+ * @throws {@link CustomDBEngineVersionQuotaExceededFault} (client fault)
36
+ * <p>You have exceeded your CEV quota.</p>
37
+ *
38
+ * @throws {@link Ec2ImagePropertiesNotSupportedFault} (client fault)
39
+ * <p>The AMI configuration prerequisite has not been met.</p>
40
+ *
41
+ * @throws {@link KMSKeyNotAccessibleFault} (client fault)
42
+ * <p>An error occurred accessing an Amazon Web Services KMS key.</p>
43
+ *
44
+ *
32
45
  */
33
46
  export declare class CreateCustomDBEngineVersionCommand extends $Command<CreateCustomDBEngineVersionCommandInput, CreateCustomDBEngineVersionCommandOutput, RDSClientResolvedConfig> {
34
47
  readonly input: CreateCustomDBEngineVersionCommandInput;
@@ -37,6 +37,100 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
37
37
  * @see {@link CreateDBClusterCommandOutput} 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 DBClusterQuotaExceededFault} (client fault)
53
+ * <p>The user attempted to create a new DB cluster and the user has already reached the
54
+ * maximum allowed DB cluster quota.</p>
55
+ *
56
+ * @throws {@link DBInstanceNotFoundFault} (client fault)
57
+ * <p>
58
+ * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
59
+ *
60
+ * @throws {@link DBSubnetGroupDoesNotCoverEnoughAZs} (client fault)
61
+ * <p>Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.</p>
62
+ *
63
+ * @throws {@link DBSubnetGroupNotFoundFault} (client fault)
64
+ * <p>
65
+ * <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>
66
+ *
67
+ * @throws {@link DomainNotFoundFault} (client fault)
68
+ * <p>
69
+ * <code>Domain</code> doesn't refer to an existing Active Directory domain.</p>
70
+ *
71
+ * @throws {@link GlobalClusterNotFoundFault} (client fault)
72
+ * <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster.</p>
73
+ *
74
+ * @throws {@link InsufficientStorageClusterCapacityFault} (client fault)
75
+ * <p>There is insufficient storage available for the current action. You might be able to
76
+ * resolve this error by updating your subnet group to use different Availability Zones
77
+ * that have more storage available.</p>
78
+ *
79
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
80
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
81
+ *
82
+ * @throws {@link InvalidDBInstanceStateFault} (client fault)
83
+ * <p>The DB instance isn't in a valid state.</p>
84
+ *
85
+ * @throws {@link InvalidDBSubnetGroupStateFault} (client fault)
86
+ * <p>The DB subnet group cannot be deleted because it's in use.</p>
87
+ *
88
+ * @throws {@link InvalidGlobalClusterStateFault} (client fault)
89
+ * <p>The global cluster is in an invalid state and can't perform the requested operation.</p>
90
+ *
91
+ * @throws {@link InvalidSubnet} (client fault)
92
+ * <p>The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.</p>
93
+ *
94
+ * @throws {@link InvalidVPCNetworkStateFault} (client fault)
95
+ * <p>The DB subnet group doesn't cover all Availability Zones after it's
96
+ * created because of users' change.</p>
97
+ *
98
+ * @throws {@link KMSKeyNotAccessibleFault} (client fault)
99
+ * <p>An error occurred accessing an Amazon Web Services KMS key.</p>
100
+ *
101
+ * @throws {@link StorageQuotaExceededFault} (client fault)
102
+ * <p>The request would result in the user exceeding the allowed amount of storage
103
+ * available across all DB instances.</p>
104
+ *
105
+ *
106
+ * @example To create a DB cluster
107
+ * ```javascript
108
+ * // This example creates a DB cluster.
109
+ * const input = {
110
+ * "AvailabilityZones": [
111
+ * "us-east-1a"
112
+ * ],
113
+ * "BackupRetentionPeriod": 1,
114
+ * "DBClusterIdentifier": "mydbcluster",
115
+ * "DBClusterParameterGroupName": "mydbclusterparametergroup",
116
+ * "DatabaseName": "myauroradb",
117
+ * "Engine": "aurora",
118
+ * "EngineVersion": "5.6.10a",
119
+ * "MasterUserPassword": "mypassword",
120
+ * "MasterUsername": "myuser",
121
+ * "Port": 3306,
122
+ * "StorageEncrypted": true
123
+ * };
124
+ * const command = new CreateDBClusterCommand(input);
125
+ * const response = await client.send(command);
126
+ * /* response ==
127
+ * {
128
+ * "DBCluster": {}
129
+ * }
130
+ * *\/
131
+ * // example id: create-db-cluster-423b998d-eba9-40dd-8e19-96c5b6e5f31d
132
+ * ```
133
+ *
40
134
  */
41
135
  export declare class CreateDBClusterCommand extends $Command<CreateDBClusterCommandInput, CreateDBClusterCommandOutput, RDSClientResolvedConfig> {
42
136
  readonly input: CreateDBClusterCommandInput;
@@ -32,6 +32,27 @@ export interface CreateDBClusterEndpointCommandOutput extends DBClusterEndpoint,
32
32
  * @see {@link CreateDBClusterEndpointCommandOutput} for command's `response` shape.
33
33
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
34
34
  *
35
+ * @throws {@link DBClusterEndpointAlreadyExistsFault} (client fault)
36
+ * <p>The specified custom endpoint can't be created because it already exists.</p>
37
+ *
38
+ * @throws {@link DBClusterEndpointQuotaExceededFault} (client fault)
39
+ * <p>The cluster already has the maximum number of custom endpoints.</p>
40
+ *
41
+ * @throws {@link DBClusterNotFoundFault} (client fault)
42
+ * <p>
43
+ * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
44
+ *
45
+ * @throws {@link DBInstanceNotFoundFault} (client fault)
46
+ * <p>
47
+ * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
48
+ *
49
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
50
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
51
+ *
52
+ * @throws {@link InvalidDBInstanceStateFault} (client fault)
53
+ * <p>The DB instance isn't in a valid state.</p>
54
+ *
55
+ *
35
56
  */
36
57
  export declare class CreateDBClusterEndpointCommand extends $Command<CreateDBClusterEndpointCommandInput, CreateDBClusterEndpointCommandOutput, RDSClientResolvedConfig> {
37
58
  readonly input: CreateDBClusterEndpointCommandInput;