@aws-sdk/client-rds 3.325.0 → 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 +4 -4
@@ -33,6 +33,8 @@ export interface AddRoleToDBClusterCommandOutput extends __MetadataBearer {
33
33
  * };
34
34
  * const command = new AddRoleToDBClusterCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // {};
37
+ *
36
38
  * ```
37
39
  *
38
40
  * @param AddRoleToDBClusterCommandInput - {@link AddRoleToDBClusterCommandInput}
@@ -54,6 +56,8 @@ export interface AddRoleToDBClusterCommandOutput extends __MetadataBearer {
54
56
  * @throws {@link InvalidDBClusterStateFault} (client fault)
55
57
  * <p>The requested operation can't be performed while the cluster is in this state.</p>
56
58
  *
59
+ * @throws {@link RDSServiceException}
60
+ * <p>Base exception class for all service exceptions from RDS service.</p>
57
61
  *
58
62
  * @example To associate an AWS Identity and Access Management (IAM) role with a DB cluster
59
63
  * ```javascript
@@ -37,6 +37,8 @@ export interface AddRoleToDBInstanceCommandOutput extends __MetadataBearer {
37
37
  * };
38
38
  * const command = new AddRoleToDBInstanceCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // {};
41
+ *
40
42
  * ```
41
43
  *
42
44
  * @param AddRoleToDBInstanceCommandInput - {@link AddRoleToDBInstanceCommandInput}
@@ -58,6 +60,8 @@ export interface AddRoleToDBInstanceCommandOutput extends __MetadataBearer {
58
60
  * @throws {@link InvalidDBInstanceStateFault} (client fault)
59
61
  * <p>The DB instance isn't in a valid state.</p>
60
62
  *
63
+ * @throws {@link RDSServiceException}
64
+ * <p>Base exception class for all service exceptions from RDS service.</p>
61
65
  *
62
66
  * @example To associate an AWS Identity and Access Management (IAM) role with a DB instance
63
67
  * ```javascript
@@ -32,6 +32,25 @@ export interface AddSourceIdentifierToSubscriptionCommandOutput extends AddSourc
32
32
  * };
33
33
  * const command = new AddSourceIdentifierToSubscriptionCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // AddSourceIdentifierToSubscriptionResult
36
+ * // EventSubscription: { // EventSubscription
37
+ * // CustomerAwsId: "STRING_VALUE",
38
+ * // CustSubscriptionId: "STRING_VALUE",
39
+ * // SnsTopicArn: "STRING_VALUE",
40
+ * // Status: "STRING_VALUE",
41
+ * // SubscriptionCreationTime: "STRING_VALUE",
42
+ * // SourceType: "STRING_VALUE",
43
+ * // SourceIdsList: [ // SourceIdsList
44
+ * // "STRING_VALUE",
45
+ * // ],
46
+ * // EventCategoriesList: [ // EventCategoriesList
47
+ * // "STRING_VALUE",
48
+ * // ],
49
+ * // Enabled: true || false,
50
+ * // EventSubscriptionArn: "STRING_VALUE",
51
+ * // },
52
+ * // };
53
+ *
35
54
  * ```
36
55
  *
37
56
  * @param AddSourceIdentifierToSubscriptionCommandInput - {@link AddSourceIdentifierToSubscriptionCommandInput}
@@ -46,6 +65,8 @@ export interface AddSourceIdentifierToSubscriptionCommandOutput extends AddSourc
46
65
  * @throws {@link SubscriptionNotFoundFault} (client fault)
47
66
  * <p>The subscription name does not exist.</p>
48
67
  *
68
+ * @throws {@link RDSServiceException}
69
+ * <p>Base exception class for all service exceptions from RDS service.</p>
49
70
  *
50
71
  * @example To add a source identifier to a subscription
51
72
  * ```javascript
@@ -39,6 +39,8 @@ export interface AddTagsToResourceCommandOutput extends __MetadataBearer {
39
39
  * };
40
40
  * const command = new AddTagsToResourceCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // {};
43
+ *
42
44
  * ```
43
45
  *
44
46
  * @param AddTagsToResourceCommandInput - {@link AddTagsToResourceCommandInput}
@@ -69,6 +71,8 @@ export interface AddTagsToResourceCommandOutput extends __MetadataBearer {
69
71
  * <p>
70
72
  * <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
71
73
  *
74
+ * @throws {@link RDSServiceException}
75
+ * <p>Base exception class for all service exceptions from RDS service.</p>
72
76
  *
73
77
  * @example To add tags to a resource
74
78
  * ```javascript
@@ -33,6 +33,22 @@ export interface ApplyPendingMaintenanceActionCommandOutput extends ApplyPending
33
33
  * };
34
34
  * const command = new ApplyPendingMaintenanceActionCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // ApplyPendingMaintenanceActionResult
37
+ * // ResourcePendingMaintenanceActions: { // ResourcePendingMaintenanceActions
38
+ * // ResourceIdentifier: "STRING_VALUE",
39
+ * // PendingMaintenanceActionDetails: [ // PendingMaintenanceActionDetails
40
+ * // { // PendingMaintenanceAction
41
+ * // Action: "STRING_VALUE",
42
+ * // AutoAppliedAfterDate: new Date("TIMESTAMP"),
43
+ * // ForcedApplyDate: new Date("TIMESTAMP"),
44
+ * // OptInStatus: "STRING_VALUE",
45
+ * // CurrentApplyDate: new Date("TIMESTAMP"),
46
+ * // Description: "STRING_VALUE",
47
+ * // },
48
+ * // ],
49
+ * // },
50
+ * // };
51
+ *
36
52
  * ```
37
53
  *
38
54
  * @param ApplyPendingMaintenanceActionCommandInput - {@link ApplyPendingMaintenanceActionCommandInput}
@@ -50,6 +66,8 @@ export interface ApplyPendingMaintenanceActionCommandOutput extends ApplyPending
50
66
  * @throws {@link ResourceNotFoundFault} (client fault)
51
67
  * <p>The specified resource ID was not found.</p>
52
68
  *
69
+ * @throws {@link RDSServiceException}
70
+ * <p>Base exception class for all service exceptions from RDS service.</p>
53
71
  *
54
72
  * @example To apply pending maintenance actions
55
73
  * ```javascript
@@ -50,6 +50,30 @@ export interface AuthorizeDBSecurityGroupIngressCommandOutput extends AuthorizeD
50
50
  * };
51
51
  * const command = new AuthorizeDBSecurityGroupIngressCommand(input);
52
52
  * const response = await client.send(command);
53
+ * // { // AuthorizeDBSecurityGroupIngressResult
54
+ * // DBSecurityGroup: { // DBSecurityGroup
55
+ * // OwnerId: "STRING_VALUE",
56
+ * // DBSecurityGroupName: "STRING_VALUE",
57
+ * // DBSecurityGroupDescription: "STRING_VALUE",
58
+ * // VpcId: "STRING_VALUE",
59
+ * // EC2SecurityGroups: [ // EC2SecurityGroupList
60
+ * // { // EC2SecurityGroup
61
+ * // Status: "STRING_VALUE",
62
+ * // EC2SecurityGroupName: "STRING_VALUE",
63
+ * // EC2SecurityGroupId: "STRING_VALUE",
64
+ * // EC2SecurityGroupOwnerId: "STRING_VALUE",
65
+ * // },
66
+ * // ],
67
+ * // IPRanges: [ // IPRangeList
68
+ * // { // IPRange
69
+ * // Status: "STRING_VALUE",
70
+ * // CIDRIP: "STRING_VALUE",
71
+ * // },
72
+ * // ],
73
+ * // DBSecurityGroupArn: "STRING_VALUE",
74
+ * // },
75
+ * // };
76
+ *
53
77
  * ```
54
78
  *
55
79
  * @param AuthorizeDBSecurityGroupIngressCommandInput - {@link AuthorizeDBSecurityGroupIngressCommandInput}
@@ -72,6 +96,8 @@ export interface AuthorizeDBSecurityGroupIngressCommandOutput extends AuthorizeD
72
96
  * @throws {@link InvalidDBSecurityGroupStateFault} (client fault)
73
97
  * <p>The state of the DB security group doesn't allow deletion.</p>
74
98
  *
99
+ * @throws {@link RDSServiceException}
100
+ * <p>Base exception class for all service exceptions from RDS service.</p>
75
101
  *
76
102
  * @example To authorize DB security group integress
77
103
  * ```javascript
@@ -41,6 +41,15 @@ export interface BacktrackDBClusterCommandOutput extends DBClusterBacktrack, __M
41
41
  * };
42
42
  * const command = new BacktrackDBClusterCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // DBClusterBacktrack
45
+ * // DBClusterIdentifier: "STRING_VALUE",
46
+ * // BacktrackIdentifier: "STRING_VALUE",
47
+ * // BacktrackTo: new Date("TIMESTAMP"),
48
+ * // BacktrackedFrom: new Date("TIMESTAMP"),
49
+ * // BacktrackRequestCreationTime: new Date("TIMESTAMP"),
50
+ * // Status: "STRING_VALUE",
51
+ * // };
52
+ *
44
53
  * ```
45
54
  *
46
55
  * @param BacktrackDBClusterCommandInput - {@link BacktrackDBClusterCommandInput}
@@ -56,6 +65,8 @@ export interface BacktrackDBClusterCommandOutput extends DBClusterBacktrack, __M
56
65
  * @throws {@link InvalidDBClusterStateFault} (client fault)
57
66
  * <p>The requested operation can't be performed while the cluster is in this state.</p>
58
67
  *
68
+ * @throws {@link RDSServiceException}
69
+ * <p>Base exception class for all service exceptions from RDS service.</p>
59
70
  *
60
71
  */
61
72
  export declare class BacktrackDBClusterCommand extends $Command<BacktrackDBClusterCommandInput, BacktrackDBClusterCommandOutput, RDSClientResolvedConfig> {
@@ -32,6 +32,27 @@ export interface CancelExportTaskCommandOutput extends ExportTask, __MetadataBea
32
32
  * };
33
33
  * const command = new CancelExportTaskCommand(input);
34
34
  * const response = await client.send(command);
35
+ * // { // ExportTask
36
+ * // ExportTaskIdentifier: "STRING_VALUE",
37
+ * // SourceArn: "STRING_VALUE",
38
+ * // ExportOnly: [ // StringList
39
+ * // "STRING_VALUE",
40
+ * // ],
41
+ * // SnapshotTime: new Date("TIMESTAMP"),
42
+ * // TaskStartTime: new Date("TIMESTAMP"),
43
+ * // TaskEndTime: new Date("TIMESTAMP"),
44
+ * // S3Bucket: "STRING_VALUE",
45
+ * // S3Prefix: "STRING_VALUE",
46
+ * // IamRoleArn: "STRING_VALUE",
47
+ * // KmsKeyId: "STRING_VALUE",
48
+ * // Status: "STRING_VALUE",
49
+ * // PercentProgress: Number("int"),
50
+ * // TotalExtractedDataInGB: Number("int"),
51
+ * // FailureCause: "STRING_VALUE",
52
+ * // WarningMessage: "STRING_VALUE",
53
+ * // SourceType: "SNAPSHOT" || "CLUSTER",
54
+ * // };
55
+ *
35
56
  * ```
36
57
  *
37
58
  * @param CancelExportTaskCommandInput - {@link CancelExportTaskCommandInput}
@@ -46,6 +67,8 @@ export interface CancelExportTaskCommandOutput extends ExportTask, __MetadataBea
46
67
  * @throws {@link InvalidExportTaskStateFault} (client fault)
47
68
  * <p>You can't cancel an export task that has completed.</p>
48
69
  *
70
+ * @throws {@link RDSServiceException}
71
+ * <p>Base exception class for all service exceptions from RDS service.</p>
49
72
  *
50
73
  * @example To cancel a snapshot export to Amazon S3
51
74
  * ```javascript
@@ -39,6 +39,15 @@ export interface CopyDBClusterParameterGroupCommandOutput extends CopyDBClusterP
39
39
  * };
40
40
  * const command = new CopyDBClusterParameterGroupCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // CopyDBClusterParameterGroupResult
43
+ * // DBClusterParameterGroup: { // DBClusterParameterGroup
44
+ * // DBClusterParameterGroupName: "STRING_VALUE",
45
+ * // DBParameterGroupFamily: "STRING_VALUE",
46
+ * // Description: "STRING_VALUE",
47
+ * // DBClusterParameterGroupArn: "STRING_VALUE",
48
+ * // },
49
+ * // };
50
+ *
42
51
  * ```
43
52
  *
44
53
  * @param CopyDBClusterParameterGroupCommandInput - {@link CopyDBClusterParameterGroupCommandInput}
@@ -59,6 +68,8 @@ export interface CopyDBClusterParameterGroupCommandOutput extends CopyDBClusterP
59
68
  * <p>The request would result in the user exceeding the allowed number of DB parameter
60
69
  * groups.</p>
61
70
  *
71
+ * @throws {@link RDSServiceException}
72
+ * <p>Base exception class for all service exceptions from RDS service.</p>
62
73
  *
63
74
  * @example To copy a DB cluster parameter group
64
75
  * ```javascript
@@ -77,6 +77,41 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
77
77
  * };
78
78
  * const command = new CopyDBClusterSnapshotCommand(input);
79
79
  * const response = await client.send(command);
80
+ * // { // CopyDBClusterSnapshotResult
81
+ * // DBClusterSnapshot: { // DBClusterSnapshot
82
+ * // AvailabilityZones: [ // AvailabilityZones
83
+ * // "STRING_VALUE",
84
+ * // ],
85
+ * // DBClusterSnapshotIdentifier: "STRING_VALUE",
86
+ * // DBClusterIdentifier: "STRING_VALUE",
87
+ * // SnapshotCreateTime: new Date("TIMESTAMP"),
88
+ * // Engine: "STRING_VALUE",
89
+ * // EngineMode: "STRING_VALUE",
90
+ * // AllocatedStorage: Number("int"),
91
+ * // Status: "STRING_VALUE",
92
+ * // Port: Number("int"),
93
+ * // VpcId: "STRING_VALUE",
94
+ * // ClusterCreateTime: new Date("TIMESTAMP"),
95
+ * // MasterUsername: "STRING_VALUE",
96
+ * // EngineVersion: "STRING_VALUE",
97
+ * // LicenseModel: "STRING_VALUE",
98
+ * // SnapshotType: "STRING_VALUE",
99
+ * // PercentProgress: Number("int"),
100
+ * // StorageEncrypted: true || false,
101
+ * // KmsKeyId: "STRING_VALUE",
102
+ * // DBClusterSnapshotArn: "STRING_VALUE",
103
+ * // SourceDBClusterSnapshotArn: "STRING_VALUE",
104
+ * // IAMDatabaseAuthenticationEnabled: true || false,
105
+ * // TagList: [ // TagList
106
+ * // { // Tag
107
+ * // Key: "STRING_VALUE",
108
+ * // Value: "STRING_VALUE",
109
+ * // },
110
+ * // ],
111
+ * // DBSystemId: "STRING_VALUE",
112
+ * // },
113
+ * // };
114
+ *
80
115
  * ```
81
116
  *
82
117
  * @param CopyDBClusterSnapshotCommandInput - {@link CopyDBClusterSnapshotCommandInput}
@@ -105,6 +140,8 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
105
140
  * <p>The request would result in the user exceeding the allowed number of DB
106
141
  * snapshots.</p>
107
142
  *
143
+ * @throws {@link RDSServiceException}
144
+ * <p>Base exception class for all service exceptions from RDS service.</p>
108
145
  *
109
146
  * @example To copy a DB cluster snapshot
110
147
  * ```javascript
@@ -39,6 +39,15 @@ export interface CopyDBParameterGroupCommandOutput extends CopyDBParameterGroupR
39
39
  * };
40
40
  * const command = new CopyDBParameterGroupCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // CopyDBParameterGroupResult
43
+ * // DBParameterGroup: { // DBParameterGroup
44
+ * // DBParameterGroupName: "STRING_VALUE",
45
+ * // DBParameterGroupFamily: "STRING_VALUE",
46
+ * // Description: "STRING_VALUE",
47
+ * // DBParameterGroupArn: "STRING_VALUE",
48
+ * // },
49
+ * // };
50
+ *
42
51
  * ```
43
52
  *
44
53
  * @param CopyDBParameterGroupCommandInput - {@link CopyDBParameterGroupCommandInput}
@@ -59,6 +68,8 @@ export interface CopyDBParameterGroupCommandOutput extends CopyDBParameterGroupR
59
68
  * <p>The request would result in the user exceeding the allowed number of DB parameter
60
69
  * groups.</p>
61
70
  *
71
+ * @throws {@link RDSServiceException}
72
+ * <p>Base exception class for all service exceptions from RDS service.</p>
62
73
  *
63
74
  * @example To copy a DB parameter group
64
75
  * ```javascript
@@ -50,6 +50,54 @@ export interface CopyDBSnapshotCommandOutput extends CopyDBSnapshotResult, __Met
50
50
  * };
51
51
  * const command = new CopyDBSnapshotCommand(input);
52
52
  * const response = await client.send(command);
53
+ * // { // CopyDBSnapshotResult
54
+ * // DBSnapshot: { // DBSnapshot
55
+ * // DBSnapshotIdentifier: "STRING_VALUE",
56
+ * // DBInstanceIdentifier: "STRING_VALUE",
57
+ * // SnapshotCreateTime: new Date("TIMESTAMP"),
58
+ * // Engine: "STRING_VALUE",
59
+ * // AllocatedStorage: Number("int"),
60
+ * // Status: "STRING_VALUE",
61
+ * // Port: Number("int"),
62
+ * // AvailabilityZone: "STRING_VALUE",
63
+ * // VpcId: "STRING_VALUE",
64
+ * // InstanceCreateTime: new Date("TIMESTAMP"),
65
+ * // MasterUsername: "STRING_VALUE",
66
+ * // EngineVersion: "STRING_VALUE",
67
+ * // LicenseModel: "STRING_VALUE",
68
+ * // SnapshotType: "STRING_VALUE",
69
+ * // Iops: Number("int"),
70
+ * // OptionGroupName: "STRING_VALUE",
71
+ * // PercentProgress: Number("int"),
72
+ * // SourceRegion: "STRING_VALUE",
73
+ * // SourceDBSnapshotIdentifier: "STRING_VALUE",
74
+ * // StorageType: "STRING_VALUE",
75
+ * // TdeCredentialArn: "STRING_VALUE",
76
+ * // Encrypted: true || false,
77
+ * // KmsKeyId: "STRING_VALUE",
78
+ * // DBSnapshotArn: "STRING_VALUE",
79
+ * // Timezone: "STRING_VALUE",
80
+ * // IAMDatabaseAuthenticationEnabled: true || false,
81
+ * // ProcessorFeatures: [ // ProcessorFeatureList
82
+ * // { // ProcessorFeature
83
+ * // Name: "STRING_VALUE",
84
+ * // Value: "STRING_VALUE",
85
+ * // },
86
+ * // ],
87
+ * // DbiResourceId: "STRING_VALUE",
88
+ * // TagList: [ // TagList
89
+ * // { // Tag
90
+ * // Key: "STRING_VALUE",
91
+ * // Value: "STRING_VALUE",
92
+ * // },
93
+ * // ],
94
+ * // OriginalSnapshotCreateTime: new Date("TIMESTAMP"),
95
+ * // SnapshotDatabaseTime: new Date("TIMESTAMP"),
96
+ * // SnapshotTarget: "STRING_VALUE",
97
+ * // StorageThroughput: Number("int"),
98
+ * // },
99
+ * // };
100
+ *
53
101
  * ```
54
102
  *
55
103
  * @param CopyDBSnapshotCommandInput - {@link CopyDBSnapshotCommandInput}
@@ -81,6 +129,8 @@ export interface CopyDBSnapshotCommandOutput extends CopyDBSnapshotResult, __Met
81
129
  * <p>The request would result in the user exceeding the allowed number of DB
82
130
  * snapshots.</p>
83
131
  *
132
+ * @throws {@link RDSServiceException}
133
+ * <p>Base exception class for all service exceptions from RDS service.</p>
84
134
  *
85
135
  * @example To copy a DB snapshot
86
136
  * ```javascript
@@ -39,6 +39,56 @@ export interface CopyOptionGroupCommandOutput extends CopyOptionGroupResult, __M
39
39
  * };
40
40
  * const command = new CopyOptionGroupCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // CopyOptionGroupResult
43
+ * // OptionGroup: { // OptionGroup
44
+ * // OptionGroupName: "STRING_VALUE",
45
+ * // OptionGroupDescription: "STRING_VALUE",
46
+ * // EngineName: "STRING_VALUE",
47
+ * // MajorEngineVersion: "STRING_VALUE",
48
+ * // Options: [ // OptionsList
49
+ * // { // Option
50
+ * // OptionName: "STRING_VALUE",
51
+ * // OptionDescription: "STRING_VALUE",
52
+ * // Persistent: true || false,
53
+ * // Permanent: true || false,
54
+ * // Port: Number("int"),
55
+ * // OptionVersion: "STRING_VALUE",
56
+ * // OptionSettings: [ // OptionSettingConfigurationList
57
+ * // { // OptionSetting
58
+ * // Name: "STRING_VALUE",
59
+ * // Value: "STRING_VALUE",
60
+ * // DefaultValue: "STRING_VALUE",
61
+ * // Description: "STRING_VALUE",
62
+ * // ApplyType: "STRING_VALUE",
63
+ * // DataType: "STRING_VALUE",
64
+ * // AllowedValues: "STRING_VALUE",
65
+ * // IsModifiable: true || false,
66
+ * // IsCollection: true || false,
67
+ * // },
68
+ * // ],
69
+ * // DBSecurityGroupMemberships: [ // DBSecurityGroupMembershipList
70
+ * // { // DBSecurityGroupMembership
71
+ * // DBSecurityGroupName: "STRING_VALUE",
72
+ * // Status: "STRING_VALUE",
73
+ * // },
74
+ * // ],
75
+ * // VpcSecurityGroupMemberships: [ // VpcSecurityGroupMembershipList
76
+ * // { // VpcSecurityGroupMembership
77
+ * // VpcSecurityGroupId: "STRING_VALUE",
78
+ * // Status: "STRING_VALUE",
79
+ * // },
80
+ * // ],
81
+ * // },
82
+ * // ],
83
+ * // AllowsVpcAndNonVpcInstanceMemberships: true || false,
84
+ * // VpcId: "STRING_VALUE",
85
+ * // OptionGroupArn: "STRING_VALUE",
86
+ * // SourceOptionGroup: "STRING_VALUE",
87
+ * // SourceAccountId: "STRING_VALUE",
88
+ * // CopyTimestamp: new Date("TIMESTAMP"),
89
+ * // },
90
+ * // };
91
+ *
42
92
  * ```
43
93
  *
44
94
  * @param CopyOptionGroupCommandInput - {@link CopyOptionGroupCommandInput}
@@ -56,6 +106,8 @@ export interface CopyOptionGroupCommandOutput extends CopyOptionGroupResult, __M
56
106
  * @throws {@link OptionGroupQuotaExceededFault} (client fault)
57
107
  * <p>The quota of 20 option groups was exceeded for this Amazon Web Services account.</p>
58
108
  *
109
+ * @throws {@link RDSServiceException}
110
+ * <p>Base exception class for all service exceptions from RDS service.</p>
59
111
  *
60
112
  * @example To copy an option group
61
113
  * ```javascript
@@ -55,6 +55,38 @@ export interface CreateBlueGreenDeploymentCommandOutput extends CreateBlueGreenD
55
55
  * };
56
56
  * const command = new CreateBlueGreenDeploymentCommand(input);
57
57
  * const response = await client.send(command);
58
+ * // { // CreateBlueGreenDeploymentResponse
59
+ * // BlueGreenDeployment: { // BlueGreenDeployment
60
+ * // BlueGreenDeploymentIdentifier: "STRING_VALUE",
61
+ * // BlueGreenDeploymentName: "STRING_VALUE",
62
+ * // Source: "STRING_VALUE",
63
+ * // Target: "STRING_VALUE",
64
+ * // SwitchoverDetails: [ // SwitchoverDetailList
65
+ * // { // SwitchoverDetail
66
+ * // SourceMember: "STRING_VALUE",
67
+ * // TargetMember: "STRING_VALUE",
68
+ * // Status: "STRING_VALUE",
69
+ * // },
70
+ * // ],
71
+ * // Tasks: [ // BlueGreenDeploymentTaskList
72
+ * // { // BlueGreenDeploymentTask
73
+ * // Name: "STRING_VALUE",
74
+ * // Status: "STRING_VALUE",
75
+ * // },
76
+ * // ],
77
+ * // Status: "STRING_VALUE",
78
+ * // StatusDetails: "STRING_VALUE",
79
+ * // CreateTime: new Date("TIMESTAMP"),
80
+ * // DeleteTime: new Date("TIMESTAMP"),
81
+ * // TagList: [ // TagList
82
+ * // { // Tag
83
+ * // Key: "STRING_VALUE",
84
+ * // Value: "STRING_VALUE",
85
+ * // },
86
+ * // ],
87
+ * // },
88
+ * // };
89
+ *
58
90
  * ```
59
91
  *
60
92
  * @param CreateBlueGreenDeploymentCommandInput - {@link CreateBlueGreenDeploymentCommandInput}
@@ -104,6 +136,8 @@ export interface CreateBlueGreenDeploymentCommandOutput extends CreateBlueGreenD
104
136
  * @throws {@link SourceDatabaseNotSupportedFault} (client fault)
105
137
  * <p>The source DB instance isn't supported for a blue/green deployment.</p>
106
138
  *
139
+ * @throws {@link RDSServiceException}
140
+ * <p>Base exception class for all service exceptions from RDS service.</p>
107
141
  *
108
142
  * @example To create a blue/green deployment for an RDS for MySQL DB instance
109
143
  * ```javascript
@@ -44,6 +44,87 @@ export interface CreateCustomDBEngineVersionCommandOutput extends DBEngineVersio
44
44
  * };
45
45
  * const command = new CreateCustomDBEngineVersionCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // DBEngineVersion
48
+ * // Engine: "STRING_VALUE",
49
+ * // EngineVersion: "STRING_VALUE",
50
+ * // DBParameterGroupFamily: "STRING_VALUE",
51
+ * // DBEngineDescription: "STRING_VALUE",
52
+ * // DBEngineVersionDescription: "STRING_VALUE",
53
+ * // DefaultCharacterSet: { // CharacterSet
54
+ * // CharacterSetName: "STRING_VALUE",
55
+ * // CharacterSetDescription: "STRING_VALUE",
56
+ * // },
57
+ * // Image: { // CustomDBEngineVersionAMI
58
+ * // ImageId: "STRING_VALUE",
59
+ * // Status: "STRING_VALUE",
60
+ * // },
61
+ * // DBEngineMediaType: "STRING_VALUE",
62
+ * // SupportedCharacterSets: [ // SupportedCharacterSetsList
63
+ * // {
64
+ * // CharacterSetName: "STRING_VALUE",
65
+ * // CharacterSetDescription: "STRING_VALUE",
66
+ * // },
67
+ * // ],
68
+ * // SupportedNcharCharacterSets: [
69
+ * // {
70
+ * // CharacterSetName: "STRING_VALUE",
71
+ * // CharacterSetDescription: "STRING_VALUE",
72
+ * // },
73
+ * // ],
74
+ * // ValidUpgradeTarget: [ // ValidUpgradeTargetList
75
+ * // { // UpgradeTarget
76
+ * // Engine: "STRING_VALUE",
77
+ * // EngineVersion: "STRING_VALUE",
78
+ * // Description: "STRING_VALUE",
79
+ * // AutoUpgrade: true || false,
80
+ * // IsMajorVersionUpgrade: true || false,
81
+ * // SupportedEngineModes: [ // EngineModeList
82
+ * // "STRING_VALUE",
83
+ * // ],
84
+ * // SupportsParallelQuery: true || false,
85
+ * // SupportsGlobalDatabases: true || false,
86
+ * // SupportsBabelfish: true || false,
87
+ * // },
88
+ * // ],
89
+ * // SupportedTimezones: [ // SupportedTimezonesList
90
+ * // { // Timezone
91
+ * // TimezoneName: "STRING_VALUE",
92
+ * // },
93
+ * // ],
94
+ * // ExportableLogTypes: [ // LogTypeList
95
+ * // "STRING_VALUE",
96
+ * // ],
97
+ * // SupportsLogExportsToCloudwatchLogs: true || false,
98
+ * // SupportsReadReplica: true || false,
99
+ * // SupportedEngineModes: [
100
+ * // "STRING_VALUE",
101
+ * // ],
102
+ * // SupportedFeatureNames: [ // FeatureNameList
103
+ * // "STRING_VALUE",
104
+ * // ],
105
+ * // Status: "STRING_VALUE",
106
+ * // SupportsParallelQuery: true || false,
107
+ * // SupportsGlobalDatabases: true || false,
108
+ * // MajorEngineVersion: "STRING_VALUE",
109
+ * // DatabaseInstallationFilesS3BucketName: "STRING_VALUE",
110
+ * // DatabaseInstallationFilesS3Prefix: "STRING_VALUE",
111
+ * // DBEngineVersionArn: "STRING_VALUE",
112
+ * // KMSKeyId: "STRING_VALUE",
113
+ * // CreateTime: new Date("TIMESTAMP"),
114
+ * // TagList: [ // TagList
115
+ * // { // Tag
116
+ * // Key: "STRING_VALUE",
117
+ * // Value: "STRING_VALUE",
118
+ * // },
119
+ * // ],
120
+ * // SupportsBabelfish: true || false,
121
+ * // CustomDBEngineVersionManifest: "STRING_VALUE",
122
+ * // SupportsCertificateRotationWithoutRestart: true || false,
123
+ * // SupportedCACertificateIdentifiers: [ // CACertificateIdentifiersList
124
+ * // "STRING_VALUE",
125
+ * // ],
126
+ * // };
127
+ *
47
128
  * ```
48
129
  *
49
130
  * @param CreateCustomDBEngineVersionCommandInput - {@link CreateCustomDBEngineVersionCommandInput}
@@ -67,6 +148,8 @@ export interface CreateCustomDBEngineVersionCommandOutput extends DBEngineVersio
67
148
  * @throws {@link KMSKeyNotAccessibleFault} (client fault)
68
149
  * <p>An error occurred accessing an Amazon Web Services KMS key.</p>
69
150
  *
151
+ * @throws {@link RDSServiceException}
152
+ * <p>Base exception class for all service exceptions from RDS service.</p>
70
153
  *
71
154
  */
72
155
  export declare class CreateCustomDBEngineVersionCommand extends $Command<CreateCustomDBEngineVersionCommandInput, CreateCustomDBEngineVersionCommandOutput, RDSClientResolvedConfig> {