@aws-sdk/client-rds 3.321.1 → 3.326.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 +4 -0
  2. package/dist-types/commands/AddRoleToDBInstanceCommand.d.ts +4 -0
  3. package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +21 -0
  4. package/dist-types/commands/AddTagsToResourceCommand.d.ts +4 -0
  5. package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +18 -0
  6. package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +26 -0
  7. package/dist-types/commands/BacktrackDBClusterCommand.d.ts +11 -0
  8. package/dist-types/commands/CancelExportTaskCommand.d.ts +23 -0
  9. package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +11 -0
  10. package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +37 -0
  11. package/dist-types/commands/CopyDBParameterGroupCommand.d.ts +11 -0
  12. package/dist-types/commands/CopyDBSnapshotCommand.d.ts +50 -0
  13. package/dist-types/commands/CopyOptionGroupCommand.d.ts +52 -0
  14. package/dist-types/commands/CreateBlueGreenDeploymentCommand.d.ts +34 -0
  15. package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +83 -0
  16. package/dist-types/commands/CreateDBClusterCommand.d.ts +151 -127
  17. package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +19 -0
  18. package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +11 -0
  19. package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +37 -0
  20. package/dist-types/commands/CreateDBInstanceCommand.d.ts +216 -0
  21. package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +216 -0
  22. package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +11 -0
  23. package/dist-types/commands/CreateDBProxyCommand.d.ts +35 -0
  24. package/dist-types/commands/CreateDBProxyEndpointCommand.d.ts +22 -0
  25. package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +26 -0
  26. package/dist-types/commands/CreateDBSnapshotCommand.d.ts +50 -0
  27. package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +27 -0
  28. package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +21 -0
  29. package/dist-types/commands/CreateGlobalClusterCommand.d.ts +31 -0
  30. package/dist-types/commands/CreateOptionGroupCommand.d.ts +52 -0
  31. package/dist-types/commands/DeleteBlueGreenDeploymentCommand.d.ts +34 -0
  32. package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +83 -0
  33. package/dist-types/commands/DeleteDBClusterCommand.d.ts +151 -0
  34. package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts +19 -0
  35. package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +4 -0
  36. package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +37 -0
  37. package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +42 -0
  38. package/dist-types/commands/DeleteDBInstanceCommand.d.ts +216 -0
  39. package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts +4 -0
  40. package/dist-types/commands/DeleteDBProxyCommand.d.ts +35 -0
  41. package/dist-types/commands/DeleteDBProxyEndpointCommand.d.ts +22 -0
  42. package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +4 -0
  43. package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +50 -0
  44. package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +4 -0
  45. package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +21 -0
  46. package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +31 -0
  47. package/dist-types/commands/DeleteOptionGroupCommand.d.ts +4 -0
  48. package/dist-types/commands/DeregisterDBProxyTargetsCommand.d.ts +4 -0
  49. package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +12 -0
  50. package/dist-types/commands/DescribeBlueGreenDeploymentsCommand.d.ts +37 -0
  51. package/dist-types/commands/DescribeCertificatesCommand.d.ts +18 -0
  52. package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +16 -0
  53. package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +24 -0
  54. package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +14 -0
  55. package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +23 -0
  56. package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +16 -0
  57. package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +40 -0
  58. package/dist-types/commands/DescribeDBClustersCommand.d.ts +154 -0
  59. package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +88 -0
  60. package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +45 -0
  61. package/dist-types/commands/DescribeDBInstancesCommand.d.ts +219 -0
  62. package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +13 -0
  63. package/dist-types/commands/DescribeDBParameterGroupsCommand.d.ts +14 -0
  64. package/dist-types/commands/DescribeDBParametersCommand.d.ts +23 -0
  65. package/dist-types/commands/DescribeDBProxiesCommand.d.ts +38 -0
  66. package/dist-types/commands/DescribeDBProxyEndpointsCommand.d.ts +25 -0
  67. package/dist-types/commands/DescribeDBProxyTargetGroupsCommand.d.ts +26 -0
  68. package/dist-types/commands/DescribeDBProxyTargetsCommand.d.ts +22 -0
  69. package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +29 -0
  70. package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +16 -0
  71. package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +53 -0
  72. package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +30 -0
  73. package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +26 -0
  74. package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +26 -0
  75. package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +13 -0
  76. package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +24 -0
  77. package/dist-types/commands/DescribeEventsCommand.d.ts +18 -0
  78. package/dist-types/commands/DescribeExportTasksCommand.d.ts +28 -0
  79. package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +34 -0
  80. package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +52 -0
  81. package/dist-types/commands/DescribeOptionGroupsCommand.d.ts +55 -0
  82. package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +61 -0
  83. package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +21 -0
  84. package/dist-types/commands/DescribeReservedDBInstancesCommand.d.ts +31 -0
  85. package/dist-types/commands/DescribeReservedDBInstancesOfferingsCommand.d.ts +25 -0
  86. package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +14 -0
  87. package/dist-types/commands/DescribeValidDBInstanceModificationsCommand.d.ts +53 -0
  88. package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +8 -0
  89. package/dist-types/commands/FailoverDBClusterCommand.d.ts +151 -0
  90. package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +31 -0
  91. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  92. package/dist-types/commands/ModifyActivityStreamCommand.d.ts +11 -0
  93. package/dist-types/commands/ModifyCertificatesCommand.d.ts +15 -0
  94. package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +10 -0
  95. package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +83 -0
  96. package/dist-types/commands/ModifyDBClusterCommand.d.ts +151 -0
  97. package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +19 -0
  98. package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +6 -0
  99. package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +16 -0
  100. package/dist-types/commands/ModifyDBInstanceCommand.d.ts +216 -49
  101. package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +6 -0
  102. package/dist-types/commands/ModifyDBProxyCommand.d.ts +35 -0
  103. package/dist-types/commands/ModifyDBProxyEndpointCommand.d.ts +22 -0
  104. package/dist-types/commands/ModifyDBProxyTargetGroupCommand.d.ts +23 -0
  105. package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +16 -0
  106. package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +50 -0
  107. package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +27 -0
  108. package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +21 -0
  109. package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +31 -0
  110. package/dist-types/commands/ModifyOptionGroupCommand.d.ts +52 -0
  111. package/dist-types/commands/PromoteReadReplicaCommand.d.ts +216 -0
  112. package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +151 -0
  113. package/dist-types/commands/PurchaseReservedDBInstancesOfferingCommand.d.ts +28 -0
  114. package/dist-types/commands/RebootDBClusterCommand.d.ts +151 -0
  115. package/dist-types/commands/RebootDBInstanceCommand.d.ts +216 -0
  116. package/dist-types/commands/RegisterDBProxyTargetsCommand.d.ts +21 -0
  117. package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +31 -0
  118. package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +4 -0
  119. package/dist-types/commands/RemoveRoleFromDBInstanceCommand.d.ts +4 -0
  120. package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +21 -0
  121. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +4 -0
  122. package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +6 -0
  123. package/dist-types/commands/ResetDBParameterGroupCommand.d.ts +6 -0
  124. package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +151 -0
  125. package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +151 -0
  126. package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +151 -0
  127. package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +216 -0
  128. package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +216 -0
  129. package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +216 -0
  130. package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +26 -0
  131. package/dist-types/commands/StartActivityStreamCommand.d.ts +11 -0
  132. package/dist-types/commands/StartDBClusterCommand.d.ts +151 -0
  133. package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +42 -0
  134. package/dist-types/commands/StartDBInstanceCommand.d.ts +216 -0
  135. package/dist-types/commands/StartExportTaskCommand.d.ts +23 -0
  136. package/dist-types/commands/StopActivityStreamCommand.d.ts +8 -0
  137. package/dist-types/commands/StopDBClusterCommand.d.ts +151 -0
  138. package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +42 -0
  139. package/dist-types/commands/StopDBInstanceCommand.d.ts +216 -0
  140. package/dist-types/commands/SwitchoverBlueGreenDeploymentCommand.d.ts +34 -0
  141. package/dist-types/commands/SwitchoverReadReplicaCommand.d.ts +216 -0
  142. package/package.json +17 -17
@@ -98,6 +98,155 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
98
98
  * };
99
99
  * const command = new ModifyDBClusterCommand(input);
100
100
  * const response = await client.send(command);
101
+ * // { // ModifyDBClusterResult
102
+ * // DBCluster: { // DBCluster
103
+ * // AllocatedStorage: Number("int"),
104
+ * // AvailabilityZones: [ // AvailabilityZones
105
+ * // "STRING_VALUE",
106
+ * // ],
107
+ * // BackupRetentionPeriod: Number("int"),
108
+ * // CharacterSetName: "STRING_VALUE",
109
+ * // DatabaseName: "STRING_VALUE",
110
+ * // DBClusterIdentifier: "STRING_VALUE",
111
+ * // DBClusterParameterGroup: "STRING_VALUE",
112
+ * // DBSubnetGroup: "STRING_VALUE",
113
+ * // Status: "STRING_VALUE",
114
+ * // AutomaticRestartTime: new Date("TIMESTAMP"),
115
+ * // PercentProgress: "STRING_VALUE",
116
+ * // EarliestRestorableTime: new Date("TIMESTAMP"),
117
+ * // Endpoint: "STRING_VALUE",
118
+ * // ReaderEndpoint: "STRING_VALUE",
119
+ * // CustomEndpoints: [ // StringList
120
+ * // "STRING_VALUE",
121
+ * // ],
122
+ * // MultiAZ: true || false,
123
+ * // Engine: "STRING_VALUE",
124
+ * // EngineVersion: "STRING_VALUE",
125
+ * // LatestRestorableTime: new Date("TIMESTAMP"),
126
+ * // Port: Number("int"),
127
+ * // MasterUsername: "STRING_VALUE",
128
+ * // DBClusterOptionGroupMemberships: [ // DBClusterOptionGroupMemberships
129
+ * // { // DBClusterOptionGroupStatus
130
+ * // DBClusterOptionGroupName: "STRING_VALUE",
131
+ * // Status: "STRING_VALUE",
132
+ * // },
133
+ * // ],
134
+ * // PreferredBackupWindow: "STRING_VALUE",
135
+ * // PreferredMaintenanceWindow: "STRING_VALUE",
136
+ * // ReplicationSourceIdentifier: "STRING_VALUE",
137
+ * // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
138
+ * // "STRING_VALUE",
139
+ * // ],
140
+ * // DBClusterMembers: [ // DBClusterMemberList
141
+ * // { // DBClusterMember
142
+ * // DBInstanceIdentifier: "STRING_VALUE",
143
+ * // IsClusterWriter: true || false,
144
+ * // DBClusterParameterGroupStatus: "STRING_VALUE",
145
+ * // PromotionTier: Number("int"),
146
+ * // },
147
+ * // ],
148
+ * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
149
+ * // { // VpcSecurityGroupMembership
150
+ * // VpcSecurityGroupId: "STRING_VALUE",
151
+ * // Status: "STRING_VALUE",
152
+ * // },
153
+ * // ],
154
+ * // HostedZoneId: "STRING_VALUE",
155
+ * // StorageEncrypted: true || false,
156
+ * // KmsKeyId: "STRING_VALUE",
157
+ * // DbClusterResourceId: "STRING_VALUE",
158
+ * // DBClusterArn: "STRING_VALUE",
159
+ * // AssociatedRoles: [ // DBClusterRoles
160
+ * // { // DBClusterRole
161
+ * // RoleArn: "STRING_VALUE",
162
+ * // Status: "STRING_VALUE",
163
+ * // FeatureName: "STRING_VALUE",
164
+ * // },
165
+ * // ],
166
+ * // IAMDatabaseAuthenticationEnabled: true || false,
167
+ * // CloneGroupId: "STRING_VALUE",
168
+ * // ClusterCreateTime: new Date("TIMESTAMP"),
169
+ * // EarliestBacktrackTime: new Date("TIMESTAMP"),
170
+ * // BacktrackWindow: Number("long"),
171
+ * // BacktrackConsumedChangeRecords: Number("long"),
172
+ * // EnabledCloudwatchLogsExports: [ // LogTypeList
173
+ * // "STRING_VALUE",
174
+ * // ],
175
+ * // Capacity: Number("int"),
176
+ * // EngineMode: "STRING_VALUE",
177
+ * // ScalingConfigurationInfo: { // ScalingConfigurationInfo
178
+ * // MinCapacity: Number("int"),
179
+ * // MaxCapacity: Number("int"),
180
+ * // AutoPause: true || false,
181
+ * // SecondsUntilAutoPause: Number("int"),
182
+ * // TimeoutAction: "STRING_VALUE",
183
+ * // SecondsBeforeTimeout: Number("int"),
184
+ * // },
185
+ * // DeletionProtection: true || false,
186
+ * // HttpEndpointEnabled: true || false,
187
+ * // ActivityStreamMode: "sync" || "async",
188
+ * // ActivityStreamStatus: "stopped" || "starting" || "started" || "stopping",
189
+ * // ActivityStreamKmsKeyId: "STRING_VALUE",
190
+ * // ActivityStreamKinesisStreamName: "STRING_VALUE",
191
+ * // CopyTagsToSnapshot: true || false,
192
+ * // CrossAccountClone: true || false,
193
+ * // DomainMemberships: [ // DomainMembershipList
194
+ * // { // DomainMembership
195
+ * // Domain: "STRING_VALUE",
196
+ * // Status: "STRING_VALUE",
197
+ * // FQDN: "STRING_VALUE",
198
+ * // IAMRoleName: "STRING_VALUE",
199
+ * // },
200
+ * // ],
201
+ * // TagList: [ // TagList
202
+ * // { // Tag
203
+ * // Key: "STRING_VALUE",
204
+ * // Value: "STRING_VALUE",
205
+ * // },
206
+ * // ],
207
+ * // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
208
+ * // GlobalWriteForwardingRequested: true || false,
209
+ * // PendingModifiedValues: { // ClusterPendingModifiedValues
210
+ * // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
211
+ * // LogTypesToEnable: [
212
+ * // "STRING_VALUE",
213
+ * // ],
214
+ * // LogTypesToDisable: [
215
+ * // "STRING_VALUE",
216
+ * // ],
217
+ * // },
218
+ * // DBClusterIdentifier: "STRING_VALUE",
219
+ * // MasterUserPassword: "STRING_VALUE",
220
+ * // IAMDatabaseAuthenticationEnabled: true || false,
221
+ * // EngineVersion: "STRING_VALUE",
222
+ * // BackupRetentionPeriod: Number("int"),
223
+ * // AllocatedStorage: Number("int"),
224
+ * // Iops: Number("int"),
225
+ * // },
226
+ * // DBClusterInstanceClass: "STRING_VALUE",
227
+ * // StorageType: "STRING_VALUE",
228
+ * // Iops: Number("int"),
229
+ * // PubliclyAccessible: true || false,
230
+ * // AutoMinorVersionUpgrade: true || false,
231
+ * // MonitoringInterval: Number("int"),
232
+ * // MonitoringRoleArn: "STRING_VALUE",
233
+ * // PerformanceInsightsEnabled: true || false,
234
+ * // PerformanceInsightsKMSKeyId: "STRING_VALUE",
235
+ * // PerformanceInsightsRetentionPeriod: Number("int"),
236
+ * // ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
237
+ * // MinCapacity: Number("double"),
238
+ * // MaxCapacity: Number("double"),
239
+ * // },
240
+ * // NetworkType: "STRING_VALUE",
241
+ * // DBSystemId: "STRING_VALUE",
242
+ * // MasterUserSecret: { // MasterUserSecret
243
+ * // SecretArn: "STRING_VALUE",
244
+ * // SecretStatus: "STRING_VALUE",
245
+ * // KmsKeyId: "STRING_VALUE",
246
+ * // },
247
+ * // },
248
+ * // };
249
+ *
101
250
  * ```
102
251
  *
103
252
  * @param ModifyDBClusterCommandInput - {@link ModifyDBClusterCommandInput}
@@ -152,6 +301,8 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
152
301
  * <p>The request would result in the user exceeding the allowed amount of storage
153
302
  * available across all DB instances.</p>
154
303
  *
304
+ * @throws {@link RDSServiceException}
305
+ * <p>Base exception class for all service exceptions from RDS service.</p>
155
306
  *
156
307
  * @example To modify a DB cluster
157
308
  * ```javascript
@@ -42,6 +42,23 @@ export interface ModifyDBClusterEndpointCommandOutput extends DBClusterEndpoint,
42
42
  * };
43
43
  * const command = new ModifyDBClusterEndpointCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // DBClusterEndpoint
46
+ * // DBClusterEndpointIdentifier: "STRING_VALUE",
47
+ * // DBClusterIdentifier: "STRING_VALUE",
48
+ * // DBClusterEndpointResourceIdentifier: "STRING_VALUE",
49
+ * // Endpoint: "STRING_VALUE",
50
+ * // Status: "STRING_VALUE",
51
+ * // EndpointType: "STRING_VALUE",
52
+ * // CustomEndpointType: "STRING_VALUE",
53
+ * // StaticMembers: [ // StringList
54
+ * // "STRING_VALUE",
55
+ * // ],
56
+ * // ExcludedMembers: [
57
+ * // "STRING_VALUE",
58
+ * // ],
59
+ * // DBClusterEndpointArn: "STRING_VALUE",
60
+ * // };
61
+ *
45
62
  * ```
46
63
  *
47
64
  * @param ModifyDBClusterEndpointCommandInput - {@link ModifyDBClusterEndpointCommandInput}
@@ -66,6 +83,8 @@ export interface ModifyDBClusterEndpointCommandOutput extends DBClusterEndpoint,
66
83
  * @throws {@link InvalidDBInstanceStateFault} (client fault)
67
84
  * <p>The DB instance isn't in a valid state.</p>
68
85
  *
86
+ * @throws {@link RDSServiceException}
87
+ * <p>Base exception class for all service exceptions from RDS service.</p>
69
88
  *
70
89
  * @example To modify a custom DB cluster endpoint
71
90
  * ```javascript
@@ -73,6 +73,10 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
73
73
  * };
74
74
  * const command = new ModifyDBClusterParameterGroupCommand(input);
75
75
  * const response = await client.send(command);
76
+ * // { // DBClusterParameterGroupNameMessage
77
+ * // DBClusterParameterGroupName: "STRING_VALUE",
78
+ * // };
79
+ *
76
80
  * ```
77
81
  *
78
82
  * @param ModifyDBClusterParameterGroupCommandInput - {@link ModifyDBClusterParameterGroupCommandInput}
@@ -91,6 +95,8 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
91
95
  * to delete the parameter group, you can't delete it when the parameter group is in
92
96
  * this state.</p>
93
97
  *
98
+ * @throws {@link RDSServiceException}
99
+ * <p>Base exception class for all service exceptions from RDS service.</p>
94
100
  *
95
101
  * @example To modify parameters in a DB cluster parameter group
96
102
  * ```javascript
@@ -56,6 +56,20 @@ export interface ModifyDBClusterSnapshotAttributeCommandOutput extends ModifyDBC
56
56
  * };
57
57
  * const command = new ModifyDBClusterSnapshotAttributeCommand(input);
58
58
  * const response = await client.send(command);
59
+ * // { // ModifyDBClusterSnapshotAttributeResult
60
+ * // DBClusterSnapshotAttributesResult: { // DBClusterSnapshotAttributesResult
61
+ * // DBClusterSnapshotIdentifier: "STRING_VALUE",
62
+ * // DBClusterSnapshotAttributes: [ // DBClusterSnapshotAttributeList
63
+ * // { // DBClusterSnapshotAttribute
64
+ * // AttributeName: "STRING_VALUE",
65
+ * // AttributeValues: [ // AttributeValueList
66
+ * // "STRING_VALUE",
67
+ * // ],
68
+ * // },
69
+ * // ],
70
+ * // },
71
+ * // };
72
+ *
59
73
  * ```
60
74
  *
61
75
  * @param ModifyDBClusterSnapshotAttributeCommandInput - {@link ModifyDBClusterSnapshotAttributeCommandInput}
@@ -74,6 +88,8 @@ export interface ModifyDBClusterSnapshotAttributeCommandOutput extends ModifyDBC
74
88
  * @throws {@link SharedSnapshotQuotaExceededFault} (client fault)
75
89
  * <p>You have exceeded the maximum number of accounts that you can share a manual DB snapshot with.</p>
76
90
  *
91
+ * @throws {@link RDSServiceException}
92
+ * <p>Base exception class for all service exceptions from RDS service.</p>
77
93
  *
78
94
  * @example To modify a DB cluster snapshot attribute
79
95
  * ```javascript
@@ -102,6 +102,220 @@ export interface ModifyDBInstanceCommandOutput extends ModifyDBInstanceResult, _
102
102
  * };
103
103
  * const command = new ModifyDBInstanceCommand(input);
104
104
  * const response = await client.send(command);
105
+ * // { // ModifyDBInstanceResult
106
+ * // DBInstance: { // DBInstance
107
+ * // DBInstanceIdentifier: "STRING_VALUE",
108
+ * // DBInstanceClass: "STRING_VALUE",
109
+ * // Engine: "STRING_VALUE",
110
+ * // DBInstanceStatus: "STRING_VALUE",
111
+ * // AutomaticRestartTime: new Date("TIMESTAMP"),
112
+ * // MasterUsername: "STRING_VALUE",
113
+ * // DBName: "STRING_VALUE",
114
+ * // Endpoint: { // Endpoint
115
+ * // Address: "STRING_VALUE",
116
+ * // Port: Number("int"),
117
+ * // HostedZoneId: "STRING_VALUE",
118
+ * // },
119
+ * // AllocatedStorage: Number("int"),
120
+ * // InstanceCreateTime: new Date("TIMESTAMP"),
121
+ * // PreferredBackupWindow: "STRING_VALUE",
122
+ * // BackupRetentionPeriod: Number("int"),
123
+ * // DBSecurityGroups: [ // DBSecurityGroupMembershipList
124
+ * // { // DBSecurityGroupMembership
125
+ * // DBSecurityGroupName: "STRING_VALUE",
126
+ * // Status: "STRING_VALUE",
127
+ * // },
128
+ * // ],
129
+ * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
130
+ * // { // VpcSecurityGroupMembership
131
+ * // VpcSecurityGroupId: "STRING_VALUE",
132
+ * // Status: "STRING_VALUE",
133
+ * // },
134
+ * // ],
135
+ * // DBParameterGroups: [ // DBParameterGroupStatusList
136
+ * // { // DBParameterGroupStatus
137
+ * // DBParameterGroupName: "STRING_VALUE",
138
+ * // ParameterApplyStatus: "STRING_VALUE",
139
+ * // },
140
+ * // ],
141
+ * // AvailabilityZone: "STRING_VALUE",
142
+ * // DBSubnetGroup: { // DBSubnetGroup
143
+ * // DBSubnetGroupName: "STRING_VALUE",
144
+ * // DBSubnetGroupDescription: "STRING_VALUE",
145
+ * // VpcId: "STRING_VALUE",
146
+ * // SubnetGroupStatus: "STRING_VALUE",
147
+ * // Subnets: [ // SubnetList
148
+ * // { // Subnet
149
+ * // SubnetIdentifier: "STRING_VALUE",
150
+ * // SubnetAvailabilityZone: { // AvailabilityZone
151
+ * // Name: "STRING_VALUE",
152
+ * // },
153
+ * // SubnetOutpost: { // Outpost
154
+ * // Arn: "STRING_VALUE",
155
+ * // },
156
+ * // SubnetStatus: "STRING_VALUE",
157
+ * // },
158
+ * // ],
159
+ * // DBSubnetGroupArn: "STRING_VALUE",
160
+ * // SupportedNetworkTypes: [ // StringList
161
+ * // "STRING_VALUE",
162
+ * // ],
163
+ * // },
164
+ * // PreferredMaintenanceWindow: "STRING_VALUE",
165
+ * // PendingModifiedValues: { // PendingModifiedValues
166
+ * // DBInstanceClass: "STRING_VALUE",
167
+ * // AllocatedStorage: Number("int"),
168
+ * // MasterUserPassword: "STRING_VALUE",
169
+ * // Port: Number("int"),
170
+ * // BackupRetentionPeriod: Number("int"),
171
+ * // MultiAZ: true || false,
172
+ * // EngineVersion: "STRING_VALUE",
173
+ * // LicenseModel: "STRING_VALUE",
174
+ * // Iops: Number("int"),
175
+ * // DBInstanceIdentifier: "STRING_VALUE",
176
+ * // StorageType: "STRING_VALUE",
177
+ * // CACertificateIdentifier: "STRING_VALUE",
178
+ * // DBSubnetGroupName: "STRING_VALUE",
179
+ * // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
180
+ * // LogTypesToEnable: [ // LogTypeList
181
+ * // "STRING_VALUE",
182
+ * // ],
183
+ * // LogTypesToDisable: [
184
+ * // "STRING_VALUE",
185
+ * // ],
186
+ * // },
187
+ * // ProcessorFeatures: [ // ProcessorFeatureList
188
+ * // { // ProcessorFeature
189
+ * // Name: "STRING_VALUE",
190
+ * // Value: "STRING_VALUE",
191
+ * // },
192
+ * // ],
193
+ * // IAMDatabaseAuthenticationEnabled: true || false,
194
+ * // AutomationMode: "full" || "all-paused",
195
+ * // ResumeFullAutomationModeTime: new Date("TIMESTAMP"),
196
+ * // StorageThroughput: Number("int"),
197
+ * // },
198
+ * // LatestRestorableTime: new Date("TIMESTAMP"),
199
+ * // MultiAZ: true || false,
200
+ * // EngineVersion: "STRING_VALUE",
201
+ * // AutoMinorVersionUpgrade: true || false,
202
+ * // ReadReplicaSourceDBInstanceIdentifier: "STRING_VALUE",
203
+ * // ReadReplicaDBInstanceIdentifiers: [ // ReadReplicaDBInstanceIdentifierList
204
+ * // "STRING_VALUE",
205
+ * // ],
206
+ * // ReadReplicaDBClusterIdentifiers: [ // ReadReplicaDBClusterIdentifierList
207
+ * // "STRING_VALUE",
208
+ * // ],
209
+ * // ReplicaMode: "open-read-only" || "mounted",
210
+ * // LicenseModel: "STRING_VALUE",
211
+ * // Iops: Number("int"),
212
+ * // OptionGroupMemberships: [ // OptionGroupMembershipList
213
+ * // { // OptionGroupMembership
214
+ * // OptionGroupName: "STRING_VALUE",
215
+ * // Status: "STRING_VALUE",
216
+ * // },
217
+ * // ],
218
+ * // CharacterSetName: "STRING_VALUE",
219
+ * // NcharCharacterSetName: "STRING_VALUE",
220
+ * // SecondaryAvailabilityZone: "STRING_VALUE",
221
+ * // PubliclyAccessible: true || false,
222
+ * // StatusInfos: [ // DBInstanceStatusInfoList
223
+ * // { // DBInstanceStatusInfo
224
+ * // StatusType: "STRING_VALUE",
225
+ * // Normal: true || false,
226
+ * // Status: "STRING_VALUE",
227
+ * // Message: "STRING_VALUE",
228
+ * // },
229
+ * // ],
230
+ * // StorageType: "STRING_VALUE",
231
+ * // TdeCredentialArn: "STRING_VALUE",
232
+ * // DbInstancePort: Number("int"),
233
+ * // DBClusterIdentifier: "STRING_VALUE",
234
+ * // StorageEncrypted: true || false,
235
+ * // KmsKeyId: "STRING_VALUE",
236
+ * // DbiResourceId: "STRING_VALUE",
237
+ * // CACertificateIdentifier: "STRING_VALUE",
238
+ * // DomainMemberships: [ // DomainMembershipList
239
+ * // { // DomainMembership
240
+ * // Domain: "STRING_VALUE",
241
+ * // Status: "STRING_VALUE",
242
+ * // FQDN: "STRING_VALUE",
243
+ * // IAMRoleName: "STRING_VALUE",
244
+ * // },
245
+ * // ],
246
+ * // CopyTagsToSnapshot: true || false,
247
+ * // MonitoringInterval: Number("int"),
248
+ * // EnhancedMonitoringResourceArn: "STRING_VALUE",
249
+ * // MonitoringRoleArn: "STRING_VALUE",
250
+ * // PromotionTier: Number("int"),
251
+ * // DBInstanceArn: "STRING_VALUE",
252
+ * // Timezone: "STRING_VALUE",
253
+ * // IAMDatabaseAuthenticationEnabled: true || false,
254
+ * // PerformanceInsightsEnabled: true || false,
255
+ * // PerformanceInsightsKMSKeyId: "STRING_VALUE",
256
+ * // PerformanceInsightsRetentionPeriod: Number("int"),
257
+ * // EnabledCloudwatchLogsExports: [
258
+ * // "STRING_VALUE",
259
+ * // ],
260
+ * // ProcessorFeatures: [
261
+ * // {
262
+ * // Name: "STRING_VALUE",
263
+ * // Value: "STRING_VALUE",
264
+ * // },
265
+ * // ],
266
+ * // DeletionProtection: true || false,
267
+ * // AssociatedRoles: [ // DBInstanceRoles
268
+ * // { // DBInstanceRole
269
+ * // RoleArn: "STRING_VALUE",
270
+ * // FeatureName: "STRING_VALUE",
271
+ * // Status: "STRING_VALUE",
272
+ * // },
273
+ * // ],
274
+ * // ListenerEndpoint: {
275
+ * // Address: "STRING_VALUE",
276
+ * // Port: Number("int"),
277
+ * // HostedZoneId: "STRING_VALUE",
278
+ * // },
279
+ * // MaxAllocatedStorage: Number("int"),
280
+ * // TagList: [ // TagList
281
+ * // { // Tag
282
+ * // Key: "STRING_VALUE",
283
+ * // Value: "STRING_VALUE",
284
+ * // },
285
+ * // ],
286
+ * // DBInstanceAutomatedBackupsReplications: [ // DBInstanceAutomatedBackupsReplicationList
287
+ * // { // DBInstanceAutomatedBackupsReplication
288
+ * // DBInstanceAutomatedBackupsArn: "STRING_VALUE",
289
+ * // },
290
+ * // ],
291
+ * // CustomerOwnedIpEnabled: true || false,
292
+ * // AwsBackupRecoveryPointArn: "STRING_VALUE",
293
+ * // ActivityStreamStatus: "stopped" || "starting" || "started" || "stopping",
294
+ * // ActivityStreamKmsKeyId: "STRING_VALUE",
295
+ * // ActivityStreamKinesisStreamName: "STRING_VALUE",
296
+ * // ActivityStreamMode: "sync" || "async",
297
+ * // ActivityStreamEngineNativeAuditFieldsIncluded: true || false,
298
+ * // AutomationMode: "full" || "all-paused",
299
+ * // ResumeFullAutomationModeTime: new Date("TIMESTAMP"),
300
+ * // CustomIamInstanceProfile: "STRING_VALUE",
301
+ * // BackupTarget: "STRING_VALUE",
302
+ * // NetworkType: "STRING_VALUE",
303
+ * // ActivityStreamPolicyStatus: "locked" || "unlocked" || "locking-policy" || "unlocking-policy",
304
+ * // StorageThroughput: Number("int"),
305
+ * // DBSystemId: "STRING_VALUE",
306
+ * // MasterUserSecret: { // MasterUserSecret
307
+ * // SecretArn: "STRING_VALUE",
308
+ * // SecretStatus: "STRING_VALUE",
309
+ * // KmsKeyId: "STRING_VALUE",
310
+ * // },
311
+ * // CertificateDetails: { // CertificateDetails
312
+ * // CAIdentifier: "STRING_VALUE",
313
+ * // ValidTill: new Date("TIMESTAMP"),
314
+ * // },
315
+ * // ReadReplicaSourceDBClusterIdentifier: "STRING_VALUE",
316
+ * // },
317
+ * // };
318
+ *
105
319
  * ```
106
320
  *
107
321
  * @param ModifyDBInstanceCommandInput - {@link ModifyDBInstanceCommandInput}
@@ -184,55 +398,8 @@ export interface ModifyDBInstanceCommandOutput extends ModifyDBInstanceResult, _
184
398
  * <p>Storage of the <code>StorageType</code> specified can't be associated
185
399
  * with the DB instance.</p>
186
400
  *
187
- *
188
- * @example To modify parameters in a DB cluster parameter group
189
- * ```javascript
190
- * // The following example associates an option group and a parameter group with a compatible Microsoft SQL Server DB instance. The ApplyImmediately parameter causes the option and parameter groups to be associated immediately, instead of waiting until the next maintenance window.
191
- * const input = {
192
- * "ApplyImmediately": true,
193
- * "DBInstanceIdentifier": "database-2",
194
- * "DBParameterGroupName": "test-sqlserver-se-2017",
195
- * "OptionGroupName": "test-se-2017"
196
- * };
197
- * const command = new ModifyDBInstanceCommand(input);
198
- * const response = await client.send(command);
199
- * /* response ==
200
- * {
201
- * "DBInstance": {
202
- * "AssociatedRoles": [],
203
- * "AutoMinorVersionUpgrade": false,
204
- * "AvailabilityZone": "us-west-2d",
205
- * "CharacterSetName": "SQL_Latin1_General_CP1_CI_AS",
206
- * "DBInstanceClass": "db.r4.large",
207
- * "DBInstanceIdentifier": "database-2",
208
- * "DBInstanceStatus": "available",
209
- * "DBParameterGroups": [
210
- * {
211
- * "DBParameterGroupName": "test-sqlserver-se-2017",
212
- * "ParameterApplyStatus": "applying"
213
- * }
214
- * ],
215
- * "DeletionProtection": false,
216
- * "Engine": "sqlserver-se",
217
- * "EngineVersion": "14.00.3281.6.v1",
218
- * "LicenseModel": "license-included",
219
- * "MaxAllocatedStorage": 1000,
220
- * "MultiAZ": true,
221
- * "OptionGroupMemberships": [
222
- * {
223
- * "OptionGroupName": "test-se-2017",
224
- * "Status": "pending-apply"
225
- * }
226
- * ],
227
- * "PubliclyAccessible": true,
228
- * "ReadReplicaDBInstanceIdentifiers": [],
229
- * "SecondaryAvailabilityZone": "us-west-2c",
230
- * "StorageType": "gp2"
231
- * }
232
- * }
233
- * *\/
234
- * // example id: to-modify-parameters-in-a-db-cluster-parameter-group-1680377584537
235
- * ```
401
+ * @throws {@link RDSServiceException}
402
+ * <p>Base exception class for all service exceptions from RDS service.</p>
236
403
  *
237
404
  * @example To modify a DB instance
238
405
  * ```javascript
@@ -61,6 +61,10 @@ export interface ModifyDBParameterGroupCommandOutput extends DBParameterGroupNam
61
61
  * };
62
62
  * const command = new ModifyDBParameterGroupCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // DBParameterGroupNameMessage
65
+ * // DBParameterGroupName: "STRING_VALUE",
66
+ * // };
67
+ *
64
68
  * ```
65
69
  *
66
70
  * @param ModifyDBParameterGroupCommandInput - {@link ModifyDBParameterGroupCommandInput}
@@ -79,6 +83,8 @@ export interface ModifyDBParameterGroupCommandOutput extends DBParameterGroupNam
79
83
  * to delete the parameter group, you can't delete it when the parameter group is in
80
84
  * this state.</p>
81
85
  *
86
+ * @throws {@link RDSServiceException}
87
+ * <p>Base exception class for all service exceptions from RDS service.</p>
82
88
  *
83
89
  * @example To modify a DB parameter group
84
90
  * ```javascript
@@ -49,6 +49,39 @@ export interface ModifyDBProxyCommandOutput extends ModifyDBProxyResponse, __Met
49
49
  * };
50
50
  * const command = new ModifyDBProxyCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // { // ModifyDBProxyResponse
53
+ * // DBProxy: { // DBProxy
54
+ * // DBProxyName: "STRING_VALUE",
55
+ * // DBProxyArn: "STRING_VALUE",
56
+ * // Status: "available" || "modifying" || "incompatible-network" || "insufficient-resource-limits" || "creating" || "deleting" || "suspended" || "suspending" || "reactivating",
57
+ * // EngineFamily: "STRING_VALUE",
58
+ * // VpcId: "STRING_VALUE",
59
+ * // VpcSecurityGroupIds: [ // StringList
60
+ * // "STRING_VALUE",
61
+ * // ],
62
+ * // VpcSubnetIds: [
63
+ * // "STRING_VALUE",
64
+ * // ],
65
+ * // Auth: [ // UserAuthConfigInfoList
66
+ * // { // UserAuthConfigInfo
67
+ * // Description: "STRING_VALUE",
68
+ * // UserName: "STRING_VALUE",
69
+ * // AuthScheme: "SECRETS",
70
+ * // SecretArn: "STRING_VALUE",
71
+ * // IAMAuth: "DISABLED" || "REQUIRED" || "ENABLED",
72
+ * // ClientPasswordAuthType: "MYSQL_NATIVE_PASSWORD" || "POSTGRES_SCRAM_SHA_256" || "POSTGRES_MD5" || "SQL_SERVER_AUTHENTICATION",
73
+ * // },
74
+ * // ],
75
+ * // RoleArn: "STRING_VALUE",
76
+ * // Endpoint: "STRING_VALUE",
77
+ * // RequireTLS: true || false,
78
+ * // IdleClientTimeout: Number("int"),
79
+ * // DebugLogging: true || false,
80
+ * // CreatedDate: new Date("TIMESTAMP"),
81
+ * // UpdatedDate: new Date("TIMESTAMP"),
82
+ * // },
83
+ * // };
84
+ *
52
85
  * ```
53
86
  *
54
87
  * @param ModifyDBProxyCommandInput - {@link ModifyDBProxyCommandInput}
@@ -66,6 +99,8 @@ export interface ModifyDBProxyCommandOutput extends ModifyDBProxyResponse, __Met
66
99
  * @throws {@link InvalidDBProxyStateFault} (client fault)
67
100
  * <p>The requested operation can't be performed while the proxy is in this state.</p>
68
101
  *
102
+ * @throws {@link RDSServiceException}
103
+ * <p>Base exception class for all service exceptions from RDS service.</p>
69
104
  *
70
105
  */
71
106
  export declare class ModifyDBProxyCommand extends $Command<ModifyDBProxyCommandInput, ModifyDBProxyCommandOutput, RDSClientResolvedConfig> {
@@ -35,6 +35,26 @@ export interface ModifyDBProxyEndpointCommandOutput extends ModifyDBProxyEndpoin
35
35
  * };
36
36
  * const command = new ModifyDBProxyEndpointCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ModifyDBProxyEndpointResponse
39
+ * // DBProxyEndpoint: { // DBProxyEndpoint
40
+ * // DBProxyEndpointName: "STRING_VALUE",
41
+ * // DBProxyEndpointArn: "STRING_VALUE",
42
+ * // DBProxyName: "STRING_VALUE",
43
+ * // Status: "available" || "modifying" || "incompatible-network" || "insufficient-resource-limits" || "creating" || "deleting",
44
+ * // VpcId: "STRING_VALUE",
45
+ * // VpcSecurityGroupIds: [ // StringList
46
+ * // "STRING_VALUE",
47
+ * // ],
48
+ * // VpcSubnetIds: [
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // Endpoint: "STRING_VALUE",
52
+ * // CreatedDate: new Date("TIMESTAMP"),
53
+ * // TargetRole: "READ_WRITE" || "READ_ONLY",
54
+ * // IsDefault: true || false,
55
+ * // },
56
+ * // };
57
+ *
38
58
  * ```
39
59
  *
40
60
  * @param ModifyDBProxyEndpointCommandInput - {@link ModifyDBProxyEndpointCommandInput}
@@ -55,6 +75,8 @@ export interface ModifyDBProxyEndpointCommandOutput extends ModifyDBProxyEndpoin
55
75
  * @throws {@link InvalidDBProxyStateFault} (client fault)
56
76
  * <p>The requested operation can't be performed while the proxy is in this state.</p>
57
77
  *
78
+ * @throws {@link RDSServiceException}
79
+ * <p>Base exception class for all service exceptions from RDS service.</p>
58
80
  *
59
81
  */
60
82
  export declare class ModifyDBProxyEndpointCommand extends $Command<ModifyDBProxyEndpointCommandInput, ModifyDBProxyEndpointCommandOutput, RDSClientResolvedConfig> {