@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
@@ -48,6 +48,20 @@ export interface DescribeDBClusterBacktracksCommandOutput extends DBClusterBackt
48
48
  * };
49
49
  * const command = new DescribeDBClusterBacktracksCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // DBClusterBacktrackMessage
52
+ * // Marker: "STRING_VALUE",
53
+ * // DBClusterBacktracks: [ // DBClusterBacktrackList
54
+ * // { // DBClusterBacktrack
55
+ * // DBClusterIdentifier: "STRING_VALUE",
56
+ * // BacktrackIdentifier: "STRING_VALUE",
57
+ * // BacktrackTo: new Date("TIMESTAMP"),
58
+ * // BacktrackedFrom: new Date("TIMESTAMP"),
59
+ * // BacktrackRequestCreationTime: new Date("TIMESTAMP"),
60
+ * // Status: "STRING_VALUE",
61
+ * // },
62
+ * // ],
63
+ * // };
64
+ *
51
65
  * ```
52
66
  *
53
67
  * @param DescribeDBClusterBacktracksCommandInput - {@link DescribeDBClusterBacktracksCommandInput}
@@ -64,6 +78,8 @@ export interface DescribeDBClusterBacktracksCommandOutput extends DBClusterBackt
64
78
  * <p>
65
79
  * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
66
80
  *
81
+ * @throws {@link RDSServiceException}
82
+ * <p>Base exception class for all service exceptions from RDS service.</p>
67
83
  *
68
84
  * @example To describe backtracks for a DB cluster
69
85
  * ```javascript
@@ -45,6 +45,28 @@ export interface DescribeDBClusterEndpointsCommandOutput extends DBClusterEndpoi
45
45
  * };
46
46
  * const command = new DescribeDBClusterEndpointsCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // { // DBClusterEndpointMessage
49
+ * // Marker: "STRING_VALUE",
50
+ * // DBClusterEndpoints: [ // DBClusterEndpointList
51
+ * // { // DBClusterEndpoint
52
+ * // DBClusterEndpointIdentifier: "STRING_VALUE",
53
+ * // DBClusterIdentifier: "STRING_VALUE",
54
+ * // DBClusterEndpointResourceIdentifier: "STRING_VALUE",
55
+ * // Endpoint: "STRING_VALUE",
56
+ * // Status: "STRING_VALUE",
57
+ * // EndpointType: "STRING_VALUE",
58
+ * // CustomEndpointType: "STRING_VALUE",
59
+ * // StaticMembers: [ // StringList
60
+ * // "STRING_VALUE",
61
+ * // ],
62
+ * // ExcludedMembers: [
63
+ * // "STRING_VALUE",
64
+ * // ],
65
+ * // DBClusterEndpointArn: "STRING_VALUE",
66
+ * // },
67
+ * // ],
68
+ * // };
69
+ *
48
70
  * ```
49
71
  *
50
72
  * @param DescribeDBClusterEndpointsCommandInput - {@link DescribeDBClusterEndpointsCommandInput}
@@ -57,6 +79,8 @@ export interface DescribeDBClusterEndpointsCommandOutput extends DBClusterEndpoi
57
79
  * <p>
58
80
  * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
59
81
  *
82
+ * @throws {@link RDSServiceException}
83
+ * <p>Base exception class for all service exceptions from RDS service.</p>
60
84
  *
61
85
  * @example To describe DB cluster endpoints
62
86
  * ```javascript
@@ -49,6 +49,18 @@ export interface DescribeDBClusterParameterGroupsCommandOutput extends DBCluster
49
49
  * };
50
50
  * const command = new DescribeDBClusterParameterGroupsCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // { // DBClusterParameterGroupsMessage
53
+ * // Marker: "STRING_VALUE",
54
+ * // DBClusterParameterGroups: [ // DBClusterParameterGroupList
55
+ * // { // DBClusterParameterGroup
56
+ * // DBClusterParameterGroupName: "STRING_VALUE",
57
+ * // DBParameterGroupFamily: "STRING_VALUE",
58
+ * // Description: "STRING_VALUE",
59
+ * // DBClusterParameterGroupArn: "STRING_VALUE",
60
+ * // },
61
+ * // ],
62
+ * // };
63
+ *
52
64
  * ```
53
65
  *
54
66
  * @param DescribeDBClusterParameterGroupsCommandInput - {@link DescribeDBClusterParameterGroupsCommandInput}
@@ -62,6 +74,8 @@ export interface DescribeDBClusterParameterGroupsCommandOutput extends DBCluster
62
74
  * <code>DBParameterGroupName</code> doesn't refer to an
63
75
  * existing DB parameter group.</p>
64
76
  *
77
+ * @throws {@link RDSServiceException}
78
+ * <p>Base exception class for all service exceptions from RDS service.</p>
65
79
  *
66
80
  * @example To describe DB cluster parameter groups
67
81
  * ```javascript
@@ -48,6 +48,27 @@ export interface DescribeDBClusterParametersCommandOutput extends DBClusterParam
48
48
  * };
49
49
  * const command = new DescribeDBClusterParametersCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // DBClusterParameterGroupDetails
52
+ * // Parameters: [ // ParametersList
53
+ * // { // Parameter
54
+ * // ParameterName: "STRING_VALUE",
55
+ * // ParameterValue: "STRING_VALUE",
56
+ * // Description: "STRING_VALUE",
57
+ * // Source: "STRING_VALUE",
58
+ * // ApplyType: "STRING_VALUE",
59
+ * // DataType: "STRING_VALUE",
60
+ * // AllowedValues: "STRING_VALUE",
61
+ * // IsModifiable: true || false,
62
+ * // MinimumEngineVersion: "STRING_VALUE",
63
+ * // ApplyMethod: "immediate" || "pending-reboot",
64
+ * // SupportedEngineModes: [ // EngineModeList
65
+ * // "STRING_VALUE",
66
+ * // ],
67
+ * // },
68
+ * // ],
69
+ * // Marker: "STRING_VALUE",
70
+ * // };
71
+ *
51
72
  * ```
52
73
  *
53
74
  * @param DescribeDBClusterParametersCommandInput - {@link DescribeDBClusterParametersCommandInput}
@@ -61,6 +82,8 @@ export interface DescribeDBClusterParametersCommandOutput extends DBClusterParam
61
82
  * <code>DBParameterGroupName</code> doesn't refer to an
62
83
  * existing DB parameter group.</p>
63
84
  *
85
+ * @throws {@link RDSServiceException}
86
+ * <p>Base exception class for all service exceptions from RDS service.</p>
64
87
  *
65
88
  * @example To describe the parameters in a DB cluster parameter group
66
89
  * ```javascript
@@ -38,6 +38,20 @@ export interface DescribeDBClusterSnapshotAttributesCommandOutput extends Descri
38
38
  * };
39
39
  * const command = new DescribeDBClusterSnapshotAttributesCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // DescribeDBClusterSnapshotAttributesResult
42
+ * // DBClusterSnapshotAttributesResult: { // DBClusterSnapshotAttributesResult
43
+ * // DBClusterSnapshotIdentifier: "STRING_VALUE",
44
+ * // DBClusterSnapshotAttributes: [ // DBClusterSnapshotAttributeList
45
+ * // { // DBClusterSnapshotAttribute
46
+ * // AttributeName: "STRING_VALUE",
47
+ * // AttributeValues: [ // AttributeValueList
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // },
51
+ * // ],
52
+ * // },
53
+ * // };
54
+ *
41
55
  * ```
42
56
  *
43
57
  * @param DescribeDBClusterSnapshotAttributesCommandInput - {@link DescribeDBClusterSnapshotAttributesCommandInput}
@@ -50,6 +64,8 @@ export interface DescribeDBClusterSnapshotAttributesCommandOutput extends Descri
50
64
  * <p>
51
65
  * <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot.</p>
52
66
  *
67
+ * @throws {@link RDSServiceException}
68
+ * <p>Base exception class for all service exceptions from RDS service.</p>
53
69
  *
54
70
  * @example To describe the attribute names and values for a DB cluster snapshot
55
71
  * ```javascript
@@ -51,6 +51,44 @@ export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapsh
51
51
  * };
52
52
  * const command = new DescribeDBClusterSnapshotsCommand(input);
53
53
  * const response = await client.send(command);
54
+ * // { // DBClusterSnapshotMessage
55
+ * // Marker: "STRING_VALUE",
56
+ * // DBClusterSnapshots: [ // DBClusterSnapshotList
57
+ * // { // DBClusterSnapshot
58
+ * // AvailabilityZones: [ // AvailabilityZones
59
+ * // "STRING_VALUE",
60
+ * // ],
61
+ * // DBClusterSnapshotIdentifier: "STRING_VALUE",
62
+ * // DBClusterIdentifier: "STRING_VALUE",
63
+ * // SnapshotCreateTime: new Date("TIMESTAMP"),
64
+ * // Engine: "STRING_VALUE",
65
+ * // EngineMode: "STRING_VALUE",
66
+ * // AllocatedStorage: Number("int"),
67
+ * // Status: "STRING_VALUE",
68
+ * // Port: Number("int"),
69
+ * // VpcId: "STRING_VALUE",
70
+ * // ClusterCreateTime: new Date("TIMESTAMP"),
71
+ * // MasterUsername: "STRING_VALUE",
72
+ * // EngineVersion: "STRING_VALUE",
73
+ * // LicenseModel: "STRING_VALUE",
74
+ * // SnapshotType: "STRING_VALUE",
75
+ * // PercentProgress: Number("int"),
76
+ * // StorageEncrypted: true || false,
77
+ * // KmsKeyId: "STRING_VALUE",
78
+ * // DBClusterSnapshotArn: "STRING_VALUE",
79
+ * // SourceDBClusterSnapshotArn: "STRING_VALUE",
80
+ * // IAMDatabaseAuthenticationEnabled: true || false,
81
+ * // TagList: [ // TagList
82
+ * // { // Tag
83
+ * // Key: "STRING_VALUE",
84
+ * // Value: "STRING_VALUE",
85
+ * // },
86
+ * // ],
87
+ * // DBSystemId: "STRING_VALUE",
88
+ * // },
89
+ * // ],
90
+ * // };
91
+ *
54
92
  * ```
55
93
  *
56
94
  * @param DescribeDBClusterSnapshotsCommandInput - {@link DescribeDBClusterSnapshotsCommandInput}
@@ -63,6 +101,8 @@ export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapsh
63
101
  * <p>
64
102
  * <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot.</p>
65
103
  *
104
+ * @throws {@link RDSServiceException}
105
+ * <p>Base exception class for all service exceptions from RDS service.</p>
66
106
  *
67
107
  * @example To describe a DB cluster snapshot for a DB cluster
68
108
  * ```javascript
@@ -49,6 +49,158 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met
49
49
  * };
50
50
  * const command = new DescribeDBClustersCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // { // DBClusterMessage
53
+ * // Marker: "STRING_VALUE",
54
+ * // DBClusters: [ // DBClusterList
55
+ * // { // DBCluster
56
+ * // AllocatedStorage: Number("int"),
57
+ * // AvailabilityZones: [ // AvailabilityZones
58
+ * // "STRING_VALUE",
59
+ * // ],
60
+ * // BackupRetentionPeriod: Number("int"),
61
+ * // CharacterSetName: "STRING_VALUE",
62
+ * // DatabaseName: "STRING_VALUE",
63
+ * // DBClusterIdentifier: "STRING_VALUE",
64
+ * // DBClusterParameterGroup: "STRING_VALUE",
65
+ * // DBSubnetGroup: "STRING_VALUE",
66
+ * // Status: "STRING_VALUE",
67
+ * // AutomaticRestartTime: new Date("TIMESTAMP"),
68
+ * // PercentProgress: "STRING_VALUE",
69
+ * // EarliestRestorableTime: new Date("TIMESTAMP"),
70
+ * // Endpoint: "STRING_VALUE",
71
+ * // ReaderEndpoint: "STRING_VALUE",
72
+ * // CustomEndpoints: [ // StringList
73
+ * // "STRING_VALUE",
74
+ * // ],
75
+ * // MultiAZ: true || false,
76
+ * // Engine: "STRING_VALUE",
77
+ * // EngineVersion: "STRING_VALUE",
78
+ * // LatestRestorableTime: new Date("TIMESTAMP"),
79
+ * // Port: Number("int"),
80
+ * // MasterUsername: "STRING_VALUE",
81
+ * // DBClusterOptionGroupMemberships: [ // DBClusterOptionGroupMemberships
82
+ * // { // DBClusterOptionGroupStatus
83
+ * // DBClusterOptionGroupName: "STRING_VALUE",
84
+ * // Status: "STRING_VALUE",
85
+ * // },
86
+ * // ],
87
+ * // PreferredBackupWindow: "STRING_VALUE",
88
+ * // PreferredMaintenanceWindow: "STRING_VALUE",
89
+ * // ReplicationSourceIdentifier: "STRING_VALUE",
90
+ * // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
91
+ * // "STRING_VALUE",
92
+ * // ],
93
+ * // DBClusterMembers: [ // DBClusterMemberList
94
+ * // { // DBClusterMember
95
+ * // DBInstanceIdentifier: "STRING_VALUE",
96
+ * // IsClusterWriter: true || false,
97
+ * // DBClusterParameterGroupStatus: "STRING_VALUE",
98
+ * // PromotionTier: Number("int"),
99
+ * // },
100
+ * // ],
101
+ * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
102
+ * // { // VpcSecurityGroupMembership
103
+ * // VpcSecurityGroupId: "STRING_VALUE",
104
+ * // Status: "STRING_VALUE",
105
+ * // },
106
+ * // ],
107
+ * // HostedZoneId: "STRING_VALUE",
108
+ * // StorageEncrypted: true || false,
109
+ * // KmsKeyId: "STRING_VALUE",
110
+ * // DbClusterResourceId: "STRING_VALUE",
111
+ * // DBClusterArn: "STRING_VALUE",
112
+ * // AssociatedRoles: [ // DBClusterRoles
113
+ * // { // DBClusterRole
114
+ * // RoleArn: "STRING_VALUE",
115
+ * // Status: "STRING_VALUE",
116
+ * // FeatureName: "STRING_VALUE",
117
+ * // },
118
+ * // ],
119
+ * // IAMDatabaseAuthenticationEnabled: true || false,
120
+ * // CloneGroupId: "STRING_VALUE",
121
+ * // ClusterCreateTime: new Date("TIMESTAMP"),
122
+ * // EarliestBacktrackTime: new Date("TIMESTAMP"),
123
+ * // BacktrackWindow: Number("long"),
124
+ * // BacktrackConsumedChangeRecords: Number("long"),
125
+ * // EnabledCloudwatchLogsExports: [ // LogTypeList
126
+ * // "STRING_VALUE",
127
+ * // ],
128
+ * // Capacity: Number("int"),
129
+ * // EngineMode: "STRING_VALUE",
130
+ * // ScalingConfigurationInfo: { // ScalingConfigurationInfo
131
+ * // MinCapacity: Number("int"),
132
+ * // MaxCapacity: Number("int"),
133
+ * // AutoPause: true || false,
134
+ * // SecondsUntilAutoPause: Number("int"),
135
+ * // TimeoutAction: "STRING_VALUE",
136
+ * // SecondsBeforeTimeout: Number("int"),
137
+ * // },
138
+ * // DeletionProtection: true || false,
139
+ * // HttpEndpointEnabled: true || false,
140
+ * // ActivityStreamMode: "sync" || "async",
141
+ * // ActivityStreamStatus: "stopped" || "starting" || "started" || "stopping",
142
+ * // ActivityStreamKmsKeyId: "STRING_VALUE",
143
+ * // ActivityStreamKinesisStreamName: "STRING_VALUE",
144
+ * // CopyTagsToSnapshot: true || false,
145
+ * // CrossAccountClone: true || false,
146
+ * // DomainMemberships: [ // DomainMembershipList
147
+ * // { // DomainMembership
148
+ * // Domain: "STRING_VALUE",
149
+ * // Status: "STRING_VALUE",
150
+ * // FQDN: "STRING_VALUE",
151
+ * // IAMRoleName: "STRING_VALUE",
152
+ * // },
153
+ * // ],
154
+ * // TagList: [ // TagList
155
+ * // { // Tag
156
+ * // Key: "STRING_VALUE",
157
+ * // Value: "STRING_VALUE",
158
+ * // },
159
+ * // ],
160
+ * // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
161
+ * // GlobalWriteForwardingRequested: true || false,
162
+ * // PendingModifiedValues: { // ClusterPendingModifiedValues
163
+ * // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
164
+ * // LogTypesToEnable: [
165
+ * // "STRING_VALUE",
166
+ * // ],
167
+ * // LogTypesToDisable: [
168
+ * // "STRING_VALUE",
169
+ * // ],
170
+ * // },
171
+ * // DBClusterIdentifier: "STRING_VALUE",
172
+ * // MasterUserPassword: "STRING_VALUE",
173
+ * // IAMDatabaseAuthenticationEnabled: true || false,
174
+ * // EngineVersion: "STRING_VALUE",
175
+ * // BackupRetentionPeriod: Number("int"),
176
+ * // AllocatedStorage: Number("int"),
177
+ * // Iops: Number("int"),
178
+ * // },
179
+ * // DBClusterInstanceClass: "STRING_VALUE",
180
+ * // StorageType: "STRING_VALUE",
181
+ * // Iops: Number("int"),
182
+ * // PubliclyAccessible: true || false,
183
+ * // AutoMinorVersionUpgrade: true || false,
184
+ * // MonitoringInterval: Number("int"),
185
+ * // MonitoringRoleArn: "STRING_VALUE",
186
+ * // PerformanceInsightsEnabled: true || false,
187
+ * // PerformanceInsightsKMSKeyId: "STRING_VALUE",
188
+ * // PerformanceInsightsRetentionPeriod: Number("int"),
189
+ * // ServerlessV2ScalingConfiguration: { // ServerlessV2ScalingConfigurationInfo
190
+ * // MinCapacity: Number("double"),
191
+ * // MaxCapacity: Number("double"),
192
+ * // },
193
+ * // NetworkType: "STRING_VALUE",
194
+ * // DBSystemId: "STRING_VALUE",
195
+ * // MasterUserSecret: { // MasterUserSecret
196
+ * // SecretArn: "STRING_VALUE",
197
+ * // SecretStatus: "STRING_VALUE",
198
+ * // KmsKeyId: "STRING_VALUE",
199
+ * // },
200
+ * // },
201
+ * // ],
202
+ * // };
203
+ *
52
204
  * ```
53
205
  *
54
206
  * @param DescribeDBClustersCommandInput - {@link DescribeDBClustersCommandInput}
@@ -61,6 +213,8 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met
61
213
  * <p>
62
214
  * <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
63
215
  *
216
+ * @throws {@link RDSServiceException}
217
+ * <p>Base exception class for all service exceptions from RDS service.</p>
64
218
  *
65
219
  * @example To describe a DB cluster
66
220
  * ```javascript
@@ -47,6 +47,92 @@ export interface DescribeDBEngineVersionsCommandOutput extends DBEngineVersionMe
47
47
  * };
48
48
  * const command = new DescribeDBEngineVersionsCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // { // DBEngineVersionMessage
51
+ * // Marker: "STRING_VALUE",
52
+ * // DBEngineVersions: [ // DBEngineVersionList
53
+ * // { // DBEngineVersion
54
+ * // Engine: "STRING_VALUE",
55
+ * // EngineVersion: "STRING_VALUE",
56
+ * // DBParameterGroupFamily: "STRING_VALUE",
57
+ * // DBEngineDescription: "STRING_VALUE",
58
+ * // DBEngineVersionDescription: "STRING_VALUE",
59
+ * // DefaultCharacterSet: { // CharacterSet
60
+ * // CharacterSetName: "STRING_VALUE",
61
+ * // CharacterSetDescription: "STRING_VALUE",
62
+ * // },
63
+ * // Image: { // CustomDBEngineVersionAMI
64
+ * // ImageId: "STRING_VALUE",
65
+ * // Status: "STRING_VALUE",
66
+ * // },
67
+ * // DBEngineMediaType: "STRING_VALUE",
68
+ * // SupportedCharacterSets: [ // SupportedCharacterSetsList
69
+ * // {
70
+ * // CharacterSetName: "STRING_VALUE",
71
+ * // CharacterSetDescription: "STRING_VALUE",
72
+ * // },
73
+ * // ],
74
+ * // SupportedNcharCharacterSets: [
75
+ * // {
76
+ * // CharacterSetName: "STRING_VALUE",
77
+ * // CharacterSetDescription: "STRING_VALUE",
78
+ * // },
79
+ * // ],
80
+ * // ValidUpgradeTarget: [ // ValidUpgradeTargetList
81
+ * // { // UpgradeTarget
82
+ * // Engine: "STRING_VALUE",
83
+ * // EngineVersion: "STRING_VALUE",
84
+ * // Description: "STRING_VALUE",
85
+ * // AutoUpgrade: true || false,
86
+ * // IsMajorVersionUpgrade: true || false,
87
+ * // SupportedEngineModes: [ // EngineModeList
88
+ * // "STRING_VALUE",
89
+ * // ],
90
+ * // SupportsParallelQuery: true || false,
91
+ * // SupportsGlobalDatabases: true || false,
92
+ * // SupportsBabelfish: true || false,
93
+ * // },
94
+ * // ],
95
+ * // SupportedTimezones: [ // SupportedTimezonesList
96
+ * // { // Timezone
97
+ * // TimezoneName: "STRING_VALUE",
98
+ * // },
99
+ * // ],
100
+ * // ExportableLogTypes: [ // LogTypeList
101
+ * // "STRING_VALUE",
102
+ * // ],
103
+ * // SupportsLogExportsToCloudwatchLogs: true || false,
104
+ * // SupportsReadReplica: true || false,
105
+ * // SupportedEngineModes: [
106
+ * // "STRING_VALUE",
107
+ * // ],
108
+ * // SupportedFeatureNames: [ // FeatureNameList
109
+ * // "STRING_VALUE",
110
+ * // ],
111
+ * // Status: "STRING_VALUE",
112
+ * // SupportsParallelQuery: true || false,
113
+ * // SupportsGlobalDatabases: true || false,
114
+ * // MajorEngineVersion: "STRING_VALUE",
115
+ * // DatabaseInstallationFilesS3BucketName: "STRING_VALUE",
116
+ * // DatabaseInstallationFilesS3Prefix: "STRING_VALUE",
117
+ * // DBEngineVersionArn: "STRING_VALUE",
118
+ * // KMSKeyId: "STRING_VALUE",
119
+ * // CreateTime: new Date("TIMESTAMP"),
120
+ * // TagList: [ // TagList
121
+ * // { // Tag
122
+ * // Key: "STRING_VALUE",
123
+ * // Value: "STRING_VALUE",
124
+ * // },
125
+ * // ],
126
+ * // SupportsBabelfish: true || false,
127
+ * // CustomDBEngineVersionManifest: "STRING_VALUE",
128
+ * // SupportsCertificateRotationWithoutRestart: true || false,
129
+ * // SupportedCACertificateIdentifiers: [ // CACertificateIdentifiersList
130
+ * // "STRING_VALUE",
131
+ * // ],
132
+ * // },
133
+ * // ],
134
+ * // };
135
+ *
50
136
  * ```
51
137
  *
52
138
  * @param DescribeDBEngineVersionsCommandInput - {@link DescribeDBEngineVersionsCommandInput}
@@ -55,6 +141,8 @@ export interface DescribeDBEngineVersionsCommandOutput extends DBEngineVersionMe
55
141
  * @see {@link DescribeDBEngineVersionsCommandOutput} for command's `response` shape.
56
142
  * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
57
143
  *
144
+ * @throws {@link RDSServiceException}
145
+ * <p>Base exception class for all service exceptions from RDS service.</p>
58
146
  *
59
147
  * @example To describe the DB engine versions for the MySQL DB engine
60
148
  * ```javascript
@@ -49,6 +49,49 @@ export interface DescribeDBInstanceAutomatedBackupsCommandOutput extends DBInsta
49
49
  * };
50
50
  * const command = new DescribeDBInstanceAutomatedBackupsCommand(input);
51
51
  * const response = await client.send(command);
52
+ * // { // DBInstanceAutomatedBackupMessage
53
+ * // Marker: "STRING_VALUE",
54
+ * // DBInstanceAutomatedBackups: [ // DBInstanceAutomatedBackupList
55
+ * // { // DBInstanceAutomatedBackup
56
+ * // DBInstanceArn: "STRING_VALUE",
57
+ * // DbiResourceId: "STRING_VALUE",
58
+ * // Region: "STRING_VALUE",
59
+ * // DBInstanceIdentifier: "STRING_VALUE",
60
+ * // RestoreWindow: { // RestoreWindow
61
+ * // EarliestTime: new Date("TIMESTAMP"),
62
+ * // LatestTime: new Date("TIMESTAMP"),
63
+ * // },
64
+ * // AllocatedStorage: Number("int"),
65
+ * // Status: "STRING_VALUE",
66
+ * // Port: Number("int"),
67
+ * // AvailabilityZone: "STRING_VALUE",
68
+ * // VpcId: "STRING_VALUE",
69
+ * // InstanceCreateTime: new Date("TIMESTAMP"),
70
+ * // MasterUsername: "STRING_VALUE",
71
+ * // Engine: "STRING_VALUE",
72
+ * // EngineVersion: "STRING_VALUE",
73
+ * // LicenseModel: "STRING_VALUE",
74
+ * // Iops: Number("int"),
75
+ * // OptionGroupName: "STRING_VALUE",
76
+ * // TdeCredentialArn: "STRING_VALUE",
77
+ * // Encrypted: true || false,
78
+ * // StorageType: "STRING_VALUE",
79
+ * // KmsKeyId: "STRING_VALUE",
80
+ * // Timezone: "STRING_VALUE",
81
+ * // IAMDatabaseAuthenticationEnabled: true || false,
82
+ * // BackupRetentionPeriod: Number("int"),
83
+ * // DBInstanceAutomatedBackupsArn: "STRING_VALUE",
84
+ * // DBInstanceAutomatedBackupsReplications: [ // DBInstanceAutomatedBackupsReplicationList
85
+ * // { // DBInstanceAutomatedBackupsReplication
86
+ * // DBInstanceAutomatedBackupsArn: "STRING_VALUE",
87
+ * // },
88
+ * // ],
89
+ * // BackupTarget: "STRING_VALUE",
90
+ * // StorageThroughput: Number("int"),
91
+ * // },
92
+ * // ],
93
+ * // };
94
+ *
52
95
  * ```
53
96
  *
54
97
  * @param DescribeDBInstanceAutomatedBackupsCommandInput - {@link DescribeDBInstanceAutomatedBackupsCommandInput}
@@ -60,6 +103,8 @@ export interface DescribeDBInstanceAutomatedBackupsCommandOutput extends DBInsta
60
103
  * @throws {@link DBInstanceAutomatedBackupNotFoundFault} (client fault)
61
104
  * <p>No automated backup for this DB instance was found.</p>
62
105
  *
106
+ * @throws {@link RDSServiceException}
107
+ * <p>Base exception class for all service exceptions from RDS service.</p>
63
108
  *
64
109
  * @example To describe the automated backups for a DB instance
65
110
  * ```javascript