@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
@@ -47,6 +47,90 @@ export interface RestoreDBClusterFromSnapshotCommandOutput extends RestoreDBClus
47
47
  * @see {@link RestoreDBClusterFromSnapshotCommandOutput} for command's `response` shape.
48
48
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
49
49
  *
50
+ * @throws {@link DBClusterAlreadyExistsFault} (client fault)
51
+ * <p>The user already has a DB cluster with the given identifier.</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 DBClusterSnapshotNotFoundFault} (client fault)
63
+ * <p>
64
+ * <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot.</p>
65
+ *
66
+ * @throws {@link DBSnapshotNotFoundFault} (client fault)
67
+ * <p>
68
+ * <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
69
+ *
70
+ * @throws {@link DBSubnetGroupNotFoundFault} (client fault)
71
+ * <p>
72
+ * <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>
73
+ *
74
+ * @throws {@link DomainNotFoundFault} (client fault)
75
+ * <p>
76
+ * <code>Domain</code> doesn't refer to an existing Active Directory domain.</p>
77
+ *
78
+ * @throws {@link InsufficientDBClusterCapacityFault} (client fault)
79
+ * <p>The DB cluster doesn't have enough capacity for the current operation.</p>
80
+ *
81
+ * @throws {@link InsufficientStorageClusterCapacityFault} (client fault)
82
+ * <p>There is insufficient storage available for the current action. You might be able to
83
+ * resolve this error by updating your subnet group to use different Availability Zones
84
+ * that have more storage available.</p>
85
+ *
86
+ * @throws {@link InvalidDBClusterSnapshotStateFault} (client fault)
87
+ * <p>The supplied value isn't a valid DB cluster snapshot state.</p>
88
+ *
89
+ * @throws {@link InvalidDBInstanceStateFault} (client fault)
90
+ * <p>The DB instance isn't in a valid state.</p>
91
+ *
92
+ * @throws {@link InvalidDBSnapshotStateFault} (client fault)
93
+ * <p>The state of the DB snapshot doesn't allow deletion.</p>
94
+ *
95
+ * @throws {@link InvalidRestoreFault} (client fault)
96
+ * <p>Cannot restore from VPC backup to non-VPC DB instance.</p>
97
+ *
98
+ * @throws {@link InvalidSubnet} (client fault)
99
+ * <p>The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.</p>
100
+ *
101
+ * @throws {@link InvalidVPCNetworkStateFault} (client fault)
102
+ * <p>The DB subnet group doesn't cover all Availability Zones after it's
103
+ * created because of users' change.</p>
104
+ *
105
+ * @throws {@link KMSKeyNotAccessibleFault} (client fault)
106
+ * <p>An error occurred accessing an Amazon Web Services KMS key.</p>
107
+ *
108
+ * @throws {@link OptionGroupNotFoundFault} (client fault)
109
+ * <p>The specified option group could not be found.</p>
110
+ *
111
+ * @throws {@link StorageQuotaExceededFault} (client fault)
112
+ * <p>The request would result in the user exceeding the allowed amount of storage
113
+ * available across all DB instances.</p>
114
+ *
115
+ *
116
+ * @example To restore an Amazon Aurora DB cluster from a DB cluster snapshot
117
+ * ```javascript
118
+ * // The following example restores an Amazon Aurora DB cluster from a DB cluster snapshot.
119
+ * const input = {
120
+ * "DBClusterIdentifier": "restored-cluster1",
121
+ * "Engine": "aurora",
122
+ * "SnapshotIdentifier": "sample-cluster-snapshot1"
123
+ * };
124
+ * const command = new RestoreDBClusterFromSnapshotCommand(input);
125
+ * const response = await client.send(command);
126
+ * /* response ==
127
+ * {
128
+ * "DBCluster": {}
129
+ * }
130
+ * *\/
131
+ * // example id: to-restore-an-amazon-aurora-db-cluster-from-a-db-cluster-snapshot-1473958144325
132
+ * ```
133
+ *
50
134
  */
51
135
  export declare class RestoreDBClusterFromSnapshotCommand extends $Command<RestoreDBClusterFromSnapshotCommandInput, RestoreDBClusterFromSnapshotCommandOutput, RDSClientResolvedConfig> {
52
136
  readonly input: RestoreDBClusterFromSnapshotCommandInput;
@@ -48,6 +48,90 @@ export interface RestoreDBClusterToPointInTimeCommandOutput extends RestoreDBClu
48
48
  * @see {@link RestoreDBClusterToPointInTimeCommandOutput} for command's `response` shape.
49
49
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
50
50
  *
51
+ * @throws {@link DBClusterAlreadyExistsFault} (client fault)
52
+ * <p>The user already has a DB cluster with the given identifier.</p>
53
+ *
54
+ * @throws {@link DBClusterNotFoundFault} (client fault)
55
+ * <p>
56
+ * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
57
+ *
58
+ * @throws {@link DBClusterParameterGroupNotFoundFault} (client fault)
59
+ * <p>
60
+ * <code>DBClusterParameterGroupName</code> doesn't refer to an existing DB
61
+ * cluster parameter group.</p>
62
+ *
63
+ * @throws {@link DBClusterQuotaExceededFault} (client fault)
64
+ * <p>The user attempted to create a new DB cluster and the user has already reached the
65
+ * maximum allowed DB cluster quota.</p>
66
+ *
67
+ * @throws {@link DBClusterSnapshotNotFoundFault} (client fault)
68
+ * <p>
69
+ * <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot.</p>
70
+ *
71
+ * @throws {@link DBSubnetGroupNotFoundFault} (client fault)
72
+ * <p>
73
+ * <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>
74
+ *
75
+ * @throws {@link DomainNotFoundFault} (client fault)
76
+ * <p>
77
+ * <code>Domain</code> doesn't refer to an existing Active Directory domain.</p>
78
+ *
79
+ * @throws {@link InsufficientDBClusterCapacityFault} (client fault)
80
+ * <p>The DB cluster doesn't have enough capacity for the current operation.</p>
81
+ *
82
+ * @throws {@link InsufficientStorageClusterCapacityFault} (client fault)
83
+ * <p>There is insufficient storage available for the current action. You might be able to
84
+ * resolve this error by updating your subnet group to use different Availability Zones
85
+ * that have more storage available.</p>
86
+ *
87
+ * @throws {@link InvalidDBClusterSnapshotStateFault} (client fault)
88
+ * <p>The supplied value isn't a valid DB cluster snapshot state.</p>
89
+ *
90
+ * @throws {@link InvalidDBClusterStateFault} (client fault)
91
+ * <p>The requested operation can't be performed while the cluster is in this state.</p>
92
+ *
93
+ * @throws {@link InvalidDBSnapshotStateFault} (client fault)
94
+ * <p>The state of the DB snapshot doesn't allow deletion.</p>
95
+ *
96
+ * @throws {@link InvalidRestoreFault} (client fault)
97
+ * <p>Cannot restore from VPC backup to non-VPC DB instance.</p>
98
+ *
99
+ * @throws {@link InvalidSubnet} (client fault)
100
+ * <p>The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.</p>
101
+ *
102
+ * @throws {@link InvalidVPCNetworkStateFault} (client fault)
103
+ * <p>The DB subnet group doesn't cover all Availability Zones after it's
104
+ * created because of users' change.</p>
105
+ *
106
+ * @throws {@link KMSKeyNotAccessibleFault} (client fault)
107
+ * <p>An error occurred accessing an Amazon Web Services KMS key.</p>
108
+ *
109
+ * @throws {@link OptionGroupNotFoundFault} (client fault)
110
+ * <p>The specified option group could not be found.</p>
111
+ *
112
+ * @throws {@link StorageQuotaExceededFault} (client fault)
113
+ * <p>The request would result in the user exceeding the allowed amount of storage
114
+ * available across all DB instances.</p>
115
+ *
116
+ *
117
+ * @example To restore a DB cluster to a point in time.
118
+ * ```javascript
119
+ * // The following example restores a DB cluster to a new DB cluster at a point in time from the source DB cluster.
120
+ * const input = {
121
+ * "DBClusterIdentifier": "sample-restored-cluster1",
122
+ * "RestoreToTime": "2016-09-13T18:45:00Z",
123
+ * "SourceDBClusterIdentifier": "sample-cluster1"
124
+ * };
125
+ * const command = new RestoreDBClusterToPointInTimeCommand(input);
126
+ * const response = await client.send(command);
127
+ * /* response ==
128
+ * {
129
+ * "DBCluster": {}
130
+ * }
131
+ * *\/
132
+ * // example id: to-restore-a-db-cluster-to-a-point-in-time-1473962082214
133
+ * ```
134
+ *
51
135
  */
52
136
  export declare class RestoreDBClusterToPointInTimeCommand extends $Command<RestoreDBClusterToPointInTimeCommandInput, RestoreDBClusterToPointInTimeCommandOutput, RDSClientResolvedConfig> {
53
137
  readonly input: RestoreDBClusterToPointInTimeCommandInput;
@@ -42,6 +42,180 @@ export interface RestoreDBInstanceFromDBSnapshotCommandOutput extends RestoreDBI
42
42
  * @see {@link RestoreDBInstanceFromDBSnapshotCommandOutput} for command's `response` shape.
43
43
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
44
44
  *
45
+ * @throws {@link AuthorizationNotFoundFault} (client fault)
46
+ * <p>The specified CIDR IP range or Amazon EC2 security group might not be authorized
47
+ * for the specified DB security group.</p>
48
+ * <p>Or, RDS might not be authorized to perform necessary actions using IAM on your
49
+ * behalf.</p>
50
+ *
51
+ * @throws {@link BackupPolicyNotFoundFault} (client fault)
52
+ *
53
+ * @throws {@link DBClusterSnapshotNotFoundFault} (client fault)
54
+ * <p>
55
+ * <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot.</p>
56
+ *
57
+ * @throws {@link DBInstanceAlreadyExistsFault} (client fault)
58
+ * <p>The user already has a DB instance with the given identifier.</p>
59
+ *
60
+ * @throws {@link DBParameterGroupNotFoundFault} (client fault)
61
+ * <p>
62
+ * <code>DBParameterGroupName</code> doesn't refer to an
63
+ * existing DB parameter group.</p>
64
+ *
65
+ * @throws {@link DBSecurityGroupNotFoundFault} (client fault)
66
+ * <p>
67
+ * <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group.</p>
68
+ *
69
+ * @throws {@link DBSnapshotNotFoundFault} (client fault)
70
+ * <p>
71
+ * <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
72
+ *
73
+ * @throws {@link DBSubnetGroupDoesNotCoverEnoughAZs} (client fault)
74
+ * <p>Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.</p>
75
+ *
76
+ * @throws {@link DBSubnetGroupNotFoundFault} (client fault)
77
+ * <p>
78
+ * <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>
79
+ *
80
+ * @throws {@link DomainNotFoundFault} (client fault)
81
+ * <p>
82
+ * <code>Domain</code> doesn't refer to an existing Active Directory domain.</p>
83
+ *
84
+ * @throws {@link InstanceQuotaExceededFault} (client fault)
85
+ * <p>The request would result in the user exceeding the allowed number of DB
86
+ * instances.</p>
87
+ *
88
+ * @throws {@link InsufficientDBInstanceCapacityFault} (client fault)
89
+ * <p>The specified DB instance class isn't available in the specified Availability
90
+ * Zone.</p>
91
+ *
92
+ * @throws {@link InvalidDBSnapshotStateFault} (client fault)
93
+ * <p>The state of the DB snapshot doesn't allow deletion.</p>
94
+ *
95
+ * @throws {@link InvalidRestoreFault} (client fault)
96
+ * <p>Cannot restore from VPC backup to non-VPC DB instance.</p>
97
+ *
98
+ * @throws {@link InvalidSubnet} (client fault)
99
+ * <p>The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.</p>
100
+ *
101
+ * @throws {@link InvalidVPCNetworkStateFault} (client fault)
102
+ * <p>The DB subnet group doesn't cover all Availability Zones after it's
103
+ * created because of users' change.</p>
104
+ *
105
+ * @throws {@link KMSKeyNotAccessibleFault} (client fault)
106
+ * <p>An error occurred accessing an Amazon Web Services KMS key.</p>
107
+ *
108
+ * @throws {@link NetworkTypeNotSupported} (client fault)
109
+ * <p>The network type is invalid for the DB instance. Valid nework type values are <code>IPV4</code> and <code>DUAL</code>.</p>
110
+ *
111
+ * @throws {@link OptionGroupNotFoundFault} (client fault)
112
+ * <p>The specified option group could not be found.</p>
113
+ *
114
+ * @throws {@link ProvisionedIopsNotAvailableInAZFault} (client fault)
115
+ * <p>Provisioned IOPS not available in the specified Availability Zone.</p>
116
+ *
117
+ * @throws {@link StorageQuotaExceededFault} (client fault)
118
+ * <p>The request would result in the user exceeding the allowed amount of storage
119
+ * available across all DB instances.</p>
120
+ *
121
+ * @throws {@link StorageTypeNotSupportedFault} (client fault)
122
+ * <p>Storage of the <code>StorageType</code> specified can't be associated
123
+ * with the DB instance.</p>
124
+ *
125
+ *
126
+ * @example To restore a DB instance from a DB snapshot.
127
+ * ```javascript
128
+ * // The following example restores a DB instance from a DB snapshot.
129
+ * const input = {
130
+ * "DBInstanceIdentifier": "mysqldb-restored",
131
+ * "DBSnapshotIdentifier": "rds:mysqldb-2014-04-22-08-15"
132
+ * };
133
+ * const command = new RestoreDBInstanceFromDBSnapshotCommand(input);
134
+ * const response = await client.send(command);
135
+ * /* response ==
136
+ * {
137
+ * "DBInstance": {
138
+ * "AllocatedStorage": 200,
139
+ * "AutoMinorVersionUpgrade": true,
140
+ * "AvailabilityZone": "us-west-2b",
141
+ * "BackupRetentionPeriod": 7,
142
+ * "CACertificateIdentifier": "rds-ca-2015",
143
+ * "CopyTagsToSnapshot": false,
144
+ * "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:mysqldb-restored",
145
+ * "DBInstanceClass": "db.t2.small",
146
+ * "DBInstanceIdentifier": "mysqldb-restored",
147
+ * "DBInstanceStatus": "available",
148
+ * "DBName": "sample",
149
+ * "DBParameterGroups": [
150
+ * {
151
+ * "DBParameterGroupName": "default.mysql5.6",
152
+ * "ParameterApplyStatus": "in-sync"
153
+ * }
154
+ * ],
155
+ * "DBSecurityGroups": [],
156
+ * "DBSubnetGroup": {
157
+ * "DBSubnetGroupDescription": "default",
158
+ * "DBSubnetGroupName": "default",
159
+ * "SubnetGroupStatus": "Complete",
160
+ * "Subnets": [
161
+ * {
162
+ * "SubnetAvailabilityZone": {
163
+ * "Name": "us-west-2a"
164
+ * },
165
+ * "SubnetIdentifier": "subnet-77e8db03",
166
+ * "SubnetStatus": "Active"
167
+ * },
168
+ * {
169
+ * "SubnetAvailabilityZone": {
170
+ * "Name": "us-west-2b"
171
+ * },
172
+ * "SubnetIdentifier": "subnet-c39989a1",
173
+ * "SubnetStatus": "Active"
174
+ * },
175
+ * {
176
+ * "SubnetAvailabilityZone": {
177
+ * "Name": "us-west-2c"
178
+ * },
179
+ * "SubnetIdentifier": "subnet-4b267b0d",
180
+ * "SubnetStatus": "Active"
181
+ * }
182
+ * ],
183
+ * "VpcId": "vpc-c1c5b3a3"
184
+ * },
185
+ * "DbInstancePort": 0,
186
+ * "DbiResourceId": "db-VNZUCCBTEDC4WR7THXNJO72HVQ",
187
+ * "DomainMemberships": [],
188
+ * "Engine": "mysql",
189
+ * "EngineVersion": "5.6.27",
190
+ * "LicenseModel": "general-public-license",
191
+ * "MasterUsername": "mymasteruser",
192
+ * "MonitoringInterval": 0,
193
+ * "MultiAZ": false,
194
+ * "OptionGroupMemberships": [
195
+ * {
196
+ * "OptionGroupName": "default:mysql-5-6",
197
+ * "Status": "in-sync"
198
+ * }
199
+ * ],
200
+ * "PendingModifiedValues": {},
201
+ * "PreferredBackupWindow": "12:58-13:28",
202
+ * "PreferredMaintenanceWindow": "tue:10:16-tue:10:46",
203
+ * "PubliclyAccessible": true,
204
+ * "ReadReplicaDBInstanceIdentifiers": [],
205
+ * "StorageEncrypted": false,
206
+ * "StorageType": "gp2",
207
+ * "VpcSecurityGroups": [
208
+ * {
209
+ * "Status": "active",
210
+ * "VpcSecurityGroupId": "sg-e5e5b0d2"
211
+ * }
212
+ * ]
213
+ * }
214
+ * }
215
+ * *\/
216
+ * // example id: to-restore-a-db-instance-from-a-db-snapshot-1473961657311
217
+ * ```
218
+ *
45
219
  */
46
220
  export declare class RestoreDBInstanceFromDBSnapshotCommand extends $Command<RestoreDBInstanceFromDBSnapshotCommandInput, RestoreDBInstanceFromDBSnapshotCommandOutput, RDSClientResolvedConfig> {
47
221
  readonly input: RestoreDBInstanceFromDBSnapshotCommandInput;
@@ -37,6 +37,73 @@ export interface RestoreDBInstanceFromS3CommandOutput extends RestoreDBInstanceF
37
37
  * @see {@link RestoreDBInstanceFromS3CommandOutput} for command's `response` shape.
38
38
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
39
39
  *
40
+ * @throws {@link AuthorizationNotFoundFault} (client fault)
41
+ * <p>The specified CIDR IP range or Amazon EC2 security group might not be authorized
42
+ * for the specified DB security group.</p>
43
+ * <p>Or, RDS might not be authorized to perform necessary actions using IAM on your
44
+ * behalf.</p>
45
+ *
46
+ * @throws {@link BackupPolicyNotFoundFault} (client fault)
47
+ *
48
+ * @throws {@link DBInstanceAlreadyExistsFault} (client fault)
49
+ * <p>The user already has a DB instance with the given identifier.</p>
50
+ *
51
+ * @throws {@link DBParameterGroupNotFoundFault} (client fault)
52
+ * <p>
53
+ * <code>DBParameterGroupName</code> doesn't refer to an
54
+ * existing DB parameter group.</p>
55
+ *
56
+ * @throws {@link DBSecurityGroupNotFoundFault} (client fault)
57
+ * <p>
58
+ * <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group.</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 InstanceQuotaExceededFault} (client fault)
68
+ * <p>The request would result in the user exceeding the allowed number of DB
69
+ * instances.</p>
70
+ *
71
+ * @throws {@link InsufficientDBInstanceCapacityFault} (client fault)
72
+ * <p>The specified DB instance class isn't available in the specified Availability
73
+ * Zone.</p>
74
+ *
75
+ * @throws {@link InvalidS3BucketFault} (client fault)
76
+ * <p>The specified Amazon S3 bucket name can't be found or Amazon RDS isn't
77
+ * authorized to access the specified Amazon S3 bucket. Verify the <b>SourceS3BucketName</b> and <b>S3IngestionRoleArn</b> values and try again.</p>
78
+ *
79
+ * @throws {@link InvalidSubnet} (client fault)
80
+ * <p>The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.</p>
81
+ *
82
+ * @throws {@link InvalidVPCNetworkStateFault} (client fault)
83
+ * <p>The DB subnet group doesn't cover all Availability Zones after it's
84
+ * created because of users' change.</p>
85
+ *
86
+ * @throws {@link KMSKeyNotAccessibleFault} (client fault)
87
+ * <p>An error occurred accessing an Amazon Web Services KMS key.</p>
88
+ *
89
+ * @throws {@link NetworkTypeNotSupported} (client fault)
90
+ * <p>The network type is invalid for the DB instance. Valid nework type values are <code>IPV4</code> and <code>DUAL</code>.</p>
91
+ *
92
+ * @throws {@link OptionGroupNotFoundFault} (client fault)
93
+ * <p>The specified option group could not be found.</p>
94
+ *
95
+ * @throws {@link ProvisionedIopsNotAvailableInAZFault} (client fault)
96
+ * <p>Provisioned IOPS not available in the specified Availability Zone.</p>
97
+ *
98
+ * @throws {@link StorageQuotaExceededFault} (client fault)
99
+ * <p>The request would result in the user exceeding the allowed amount of storage
100
+ * available across all DB instances.</p>
101
+ *
102
+ * @throws {@link StorageTypeNotSupportedFault} (client fault)
103
+ * <p>Storage of the <code>StorageType</code> specified can't be associated
104
+ * with the DB instance.</p>
105
+ *
106
+ *
40
107
  */
41
108
  export declare class RestoreDBInstanceFromS3Command extends $Command<RestoreDBInstanceFromS3CommandInput, RestoreDBInstanceFromS3CommandOutput, RDSClientResolvedConfig> {
42
109
  readonly input: RestoreDBInstanceFromS3CommandInput;
@@ -38,6 +38,186 @@ export interface RestoreDBInstanceToPointInTimeCommandOutput extends RestoreDBIn
38
38
  * @see {@link RestoreDBInstanceToPointInTimeCommandOutput} for command's `response` shape.
39
39
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
40
40
  *
41
+ * @throws {@link AuthorizationNotFoundFault} (client fault)
42
+ * <p>The specified CIDR IP range or Amazon EC2 security group might not be authorized
43
+ * for the specified DB security group.</p>
44
+ * <p>Or, RDS might not be authorized to perform necessary actions using IAM on your
45
+ * behalf.</p>
46
+ *
47
+ * @throws {@link BackupPolicyNotFoundFault} (client fault)
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 DBInstanceAutomatedBackupNotFoundFault} (client fault)
53
+ * <p>No automated backup for this DB instance was found.</p>
54
+ *
55
+ * @throws {@link DBInstanceNotFoundFault} (client fault)
56
+ * <p>
57
+ * <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
58
+ *
59
+ * @throws {@link DBParameterGroupNotFoundFault} (client fault)
60
+ * <p>
61
+ * <code>DBParameterGroupName</code> doesn't refer to an
62
+ * existing DB parameter group.</p>
63
+ *
64
+ * @throws {@link DBSecurityGroupNotFoundFault} (client fault)
65
+ * <p>
66
+ * <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group.</p>
67
+ *
68
+ * @throws {@link DBSubnetGroupDoesNotCoverEnoughAZs} (client fault)
69
+ * <p>Subnets in the DB subnet group should cover at least two Availability Zones unless there is only one Availability Zone.</p>
70
+ *
71
+ * @throws {@link DBSubnetGroupNotFoundFault} (client fault)
72
+ * <p>
73
+ * <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>
74
+ *
75
+ * @throws {@link DomainNotFoundFault} (client fault)
76
+ * <p>
77
+ * <code>Domain</code> doesn't refer to an existing Active Directory domain.</p>
78
+ *
79
+ * @throws {@link InstanceQuotaExceededFault} (client fault)
80
+ * <p>The request would result in the user exceeding the allowed number of DB
81
+ * instances.</p>
82
+ *
83
+ * @throws {@link InsufficientDBInstanceCapacityFault} (client fault)
84
+ * <p>The specified DB instance class isn't available in the specified Availability
85
+ * Zone.</p>
86
+ *
87
+ * @throws {@link InvalidDBInstanceStateFault} (client fault)
88
+ * <p>The DB instance isn't in a valid state.</p>
89
+ *
90
+ * @throws {@link InvalidRestoreFault} (client fault)
91
+ * <p>Cannot restore from VPC backup to non-VPC DB instance.</p>
92
+ *
93
+ * @throws {@link InvalidSubnet} (client fault)
94
+ * <p>The requested subnet is invalid, or multiple subnets were requested that are not all in a common VPC.</p>
95
+ *
96
+ * @throws {@link InvalidVPCNetworkStateFault} (client fault)
97
+ * <p>The DB subnet group doesn't cover all Availability Zones after it's
98
+ * created because of users' change.</p>
99
+ *
100
+ * @throws {@link KMSKeyNotAccessibleFault} (client fault)
101
+ * <p>An error occurred accessing an Amazon Web Services KMS key.</p>
102
+ *
103
+ * @throws {@link NetworkTypeNotSupported} (client fault)
104
+ * <p>The network type is invalid for the DB instance. Valid nework type values are <code>IPV4</code> and <code>DUAL</code>.</p>
105
+ *
106
+ * @throws {@link OptionGroupNotFoundFault} (client fault)
107
+ * <p>The specified option group could not be found.</p>
108
+ *
109
+ * @throws {@link PointInTimeRestoreNotEnabledFault} (client fault)
110
+ * <p>
111
+ * <code>SourceDBInstanceIdentifier</code>
112
+ * refers to a DB instance with
113
+ * <code>BackupRetentionPeriod</code> equal to 0.</p>
114
+ *
115
+ * @throws {@link ProvisionedIopsNotAvailableInAZFault} (client fault)
116
+ * <p>Provisioned IOPS not available in the specified Availability Zone.</p>
117
+ *
118
+ * @throws {@link StorageQuotaExceededFault} (client fault)
119
+ * <p>The request would result in the user exceeding the allowed amount of storage
120
+ * available across all DB instances.</p>
121
+ *
122
+ * @throws {@link StorageTypeNotSupportedFault} (client fault)
123
+ * <p>Storage of the <code>StorageType</code> specified can't be associated
124
+ * with the DB instance.</p>
125
+ *
126
+ *
127
+ * @example To restore a DB instance to a point in time.
128
+ * ```javascript
129
+ * // The following example restores a DB instance to a new DB instance at a point in time from the source DB instance.
130
+ * const input = {
131
+ * "RestoreTime": "2016-09-13T18:45:00Z",
132
+ * "SourceDBInstanceIdentifier": "mysql-sample",
133
+ * "TargetDBInstanceIdentifier": "mysql-sample-restored"
134
+ * };
135
+ * const command = new RestoreDBInstanceToPointInTimeCommand(input);
136
+ * const response = await client.send(command);
137
+ * /* response ==
138
+ * {
139
+ * "DBInstance": {
140
+ * "AllocatedStorage": 200,
141
+ * "AutoMinorVersionUpgrade": true,
142
+ * "AvailabilityZone": "us-west-2b",
143
+ * "BackupRetentionPeriod": 7,
144
+ * "CACertificateIdentifier": "rds-ca-2015",
145
+ * "CopyTagsToSnapshot": false,
146
+ * "DBInstanceArn": "arn:aws:rds:us-west-2:123456789012:db:mysql-sample-restored",
147
+ * "DBInstanceClass": "db.t2.small",
148
+ * "DBInstanceIdentifier": "mysql-sample-restored",
149
+ * "DBInstanceStatus": "available",
150
+ * "DBName": "sample",
151
+ * "DBParameterGroups": [
152
+ * {
153
+ * "DBParameterGroupName": "default.mysql5.6",
154
+ * "ParameterApplyStatus": "in-sync"
155
+ * }
156
+ * ],
157
+ * "DBSecurityGroups": [],
158
+ * "DBSubnetGroup": {
159
+ * "DBSubnetGroupDescription": "default",
160
+ * "DBSubnetGroupName": "default",
161
+ * "SubnetGroupStatus": "Complete",
162
+ * "Subnets": [
163
+ * {
164
+ * "SubnetAvailabilityZone": {
165
+ * "Name": "us-west-2a"
166
+ * },
167
+ * "SubnetIdentifier": "subnet-77e8db03",
168
+ * "SubnetStatus": "Active"
169
+ * },
170
+ * {
171
+ * "SubnetAvailabilityZone": {
172
+ * "Name": "us-west-2b"
173
+ * },
174
+ * "SubnetIdentifier": "subnet-c39989a1",
175
+ * "SubnetStatus": "Active"
176
+ * },
177
+ * {
178
+ * "SubnetAvailabilityZone": {
179
+ * "Name": "us-west-2c"
180
+ * },
181
+ * "SubnetIdentifier": "subnet-4b267b0d",
182
+ * "SubnetStatus": "Active"
183
+ * }
184
+ * ],
185
+ * "VpcId": "vpc-c1c5b3a3"
186
+ * },
187
+ * "DbInstancePort": 0,
188
+ * "DbiResourceId": "db-VNZUCCBTEDC4WR7THXNJO72HVQ",
189
+ * "DomainMemberships": [],
190
+ * "Engine": "mysql",
191
+ * "EngineVersion": "5.6.27",
192
+ * "LicenseModel": "general-public-license",
193
+ * "MasterUsername": "mymasteruser",
194
+ * "MonitoringInterval": 0,
195
+ * "MultiAZ": false,
196
+ * "OptionGroupMemberships": [
197
+ * {
198
+ * "OptionGroupName": "default:mysql-5-6",
199
+ * "Status": "in-sync"
200
+ * }
201
+ * ],
202
+ * "PendingModifiedValues": {},
203
+ * "PreferredBackupWindow": "12:58-13:28",
204
+ * "PreferredMaintenanceWindow": "tue:10:16-tue:10:46",
205
+ * "PubliclyAccessible": true,
206
+ * "ReadReplicaDBInstanceIdentifiers": [],
207
+ * "StorageEncrypted": false,
208
+ * "StorageType": "gp2",
209
+ * "VpcSecurityGroups": [
210
+ * {
211
+ * "Status": "active",
212
+ * "VpcSecurityGroupId": "sg-e5e5b0d2"
213
+ * }
214
+ * ]
215
+ * }
216
+ * }
217
+ * *\/
218
+ * // example id: to-restore-a-db-instance-to-a-point-in-time-1473962652154
219
+ * ```
220
+ *
41
221
  */
42
222
  export declare class RestoreDBInstanceToPointInTimeCommand extends $Command<RestoreDBInstanceToPointInTimeCommandInput, RestoreDBInstanceToPointInTimeCommandOutput, RDSClientResolvedConfig> {
43
223
  readonly input: RestoreDBInstanceToPointInTimeCommandInput;
@@ -38,6 +38,37 @@ export interface RevokeDBSecurityGroupIngressCommandOutput extends RevokeDBSecur
38
38
  * @see {@link RevokeDBSecurityGroupIngressCommandOutput} for command's `response` shape.
39
39
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
40
40
  *
41
+ * @throws {@link AuthorizationNotFoundFault} (client fault)
42
+ * <p>The specified CIDR IP range or Amazon EC2 security group might not be authorized
43
+ * for the specified DB security group.</p>
44
+ * <p>Or, RDS might not be authorized to perform necessary actions using IAM on your
45
+ * behalf.</p>
46
+ *
47
+ * @throws {@link DBSecurityGroupNotFoundFault} (client fault)
48
+ * <p>
49
+ * <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group.</p>
50
+ *
51
+ * @throws {@link InvalidDBSecurityGroupStateFault} (client fault)
52
+ * <p>The state of the DB security group doesn't allow deletion.</p>
53
+ *
54
+ *
55
+ * @example To revoke ingress for a DB security group
56
+ * ```javascript
57
+ * // This example revokes ingress for the specified CIDR block associated with the specified DB security group.
58
+ * const input = {
59
+ * "CIDRIP": "203.0.113.5/32",
60
+ * "DBSecurityGroupName": "mydbsecuritygroup"
61
+ * };
62
+ * const command = new RevokeDBSecurityGroupIngressCommand(input);
63
+ * const response = await client.send(command);
64
+ * /* response ==
65
+ * {
66
+ * "DBSecurityGroup": {}
67
+ * }
68
+ * *\/
69
+ * // example id: revoke-db-security-group-ingress-ce5b2c1c-bd4e-4809-b04a-6d78ec448813
70
+ * ```
71
+ *
41
72
  */
42
73
  export declare class RevokeDBSecurityGroupIngressCommand extends $Command<RevokeDBSecurityGroupIngressCommandInput, RevokeDBSecurityGroupIngressCommandOutput, RDSClientResolvedConfig> {
43
74
  readonly input: RevokeDBSecurityGroupIngressCommandInput;