@aws-sdk/client-rds 3.288.0 → 3.290.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-types/commands/AddRoleToDBClusterCommand.d.ts +14 -0
- package/dist-types/commands/AddRoleToDBInstanceCommand.d.ts +14 -0
- package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +24 -0
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +40 -0
- package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +28 -0
- package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +32 -0
- package/dist-types/commands/BacktrackDBClusterCommand.d.ts +8 -0
- package/dist-types/commands/CancelExportTaskCommand.d.ts +7 -0
- package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +31 -0
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +38 -0
- package/dist-types/commands/CopyDBParameterGroupCommand.d.ts +31 -0
- package/dist-types/commands/CopyDBSnapshotCommand.d.ts +41 -0
- package/dist-types/commands/CopyOptionGroupCommand.d.ts +28 -0
- package/dist-types/commands/CreateBlueGreenDeploymentCommand.d.ts +42 -0
- package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +13 -0
- package/dist-types/commands/CreateDBClusterCommand.d.ts +94 -0
- package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +21 -0
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +26 -0
- package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +35 -0
- package/dist-types/commands/CreateDBInstanceCommand.d.ts +100 -0
- package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +102 -0
- package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +26 -0
- package/dist-types/commands/CreateDBProxyCommand.d.ts +10 -0
- package/dist-types/commands/CreateDBProxyEndpointCommand.d.ts +16 -0
- package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +29 -0
- package/dist-types/commands/CreateDBSnapshotCommand.d.ts +33 -0
- package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +40 -0
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +47 -0
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +14 -0
- package/dist-types/commands/CreateOptionGroupCommand.d.ts +26 -0
- package/dist-types/commands/DeleteBlueGreenDeploymentCommand.d.ts +9 -0
- package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +7 -0
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +35 -0
- package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts +10 -0
- package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +22 -0
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +24 -0
- package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +8 -0
- package/dist-types/commands/DeleteDBInstanceCommand.d.ts +41 -0
- package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts +22 -0
- package/dist-types/commands/DeleteDBProxyCommand.d.ts +7 -0
- package/dist-types/commands/DeleteDBProxyEndpointCommand.d.ts +7 -0
- package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +19 -0
- package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +24 -0
- package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +22 -0
- package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +23 -0
- package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +7 -0
- package/dist-types/commands/DeleteOptionGroupCommand.d.ts +18 -0
- package/dist-types/commands/DeregisterDBProxyTargetsCommand.d.ts +13 -0
- package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +10 -0
- package/dist-types/commands/DescribeBlueGreenDeploymentsCommand.d.ts +5 -0
- package/dist-types/commands/DescribeCertificatesCommand.d.ts +18 -0
- package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +9 -0
- package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +5 -0
- package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +17 -0
- package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +18 -0
- package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +21 -0
- package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +17 -0
- package/dist-types/commands/DescribeDBClustersCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +4 -0
- package/dist-types/commands/DescribeDBInstancesCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +19 -0
- package/dist-types/commands/DescribeDBParameterGroupsCommand.d.ts +17 -0
- package/dist-types/commands/DescribeDBParametersCommand.d.ts +19 -0
- package/dist-types/commands/DescribeDBProxiesCommand.d.ts +4 -0
- package/dist-types/commands/DescribeDBProxyEndpointsCommand.d.ts +7 -0
- package/dist-types/commands/DescribeDBProxyTargetGroupsCommand.d.ts +10 -0
- package/dist-types/commands/DescribeDBProxyTargetsCommand.d.ts +13 -0
- package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +21 -0
- package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +19 -0
- package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +17 -0
- package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +17 -0
- package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +12 -0
- package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +15 -0
- package/dist-types/commands/DescribeEventsCommand.d.ts +17 -0
- package/dist-types/commands/DescribeExportTasksCommand.d.ts +4 -0
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +4 -0
- package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +13 -0
- package/dist-types/commands/DescribeOptionGroupsCommand.d.ts +16 -0
- package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +16 -0
- package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +15 -0
- package/dist-types/commands/DescribeReservedDBInstancesCommand.d.ts +19 -0
- package/dist-types/commands/DescribeReservedDBInstancesOfferingsCommand.d.ts +19 -0
- package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +66 -0
- package/dist-types/commands/DescribeValidDBInstanceModificationsCommand.d.ts +8 -0
- package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +21 -0
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +28 -0
- package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +14 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +34 -0
- package/dist-types/commands/ModifyActivityStreamCommand.d.ts +11 -0
- package/dist-types/commands/ModifyCertificatesCommand.d.ts +6 -0
- package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +14 -0
- package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +7 -0
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +65 -0
- package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +17 -0
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +29 -0
- package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +35 -0
- package/dist-types/commands/ModifyDBInstanceCommand.d.ts +98 -0
- package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +29 -0
- package/dist-types/commands/ModifyDBProxyCommand.d.ts +10 -0
- package/dist-types/commands/ModifyDBProxyEndpointCommand.d.ts +13 -0
- package/dist-types/commands/ModifyDBProxyTargetGroupCommand.d.ts +10 -0
- package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +31 -0
- package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +5 -0
- package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +38 -0
- package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +41 -0
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +13 -0
- package/dist-types/commands/ModifyOptionGroupCommand.d.ts +32 -0
- package/dist-types/commands/PromoteReadReplicaCommand.d.ts +26 -0
- package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +8 -0
- package/dist-types/commands/PurchaseReservedDBInstancesOfferingCommand.d.ts +27 -0
- package/dist-types/commands/RebootDBClusterCommand.d.ts +11 -0
- package/dist-types/commands/RebootDBInstanceCommand.d.ts +25 -0
- package/dist-types/commands/RegisterDBProxyTargetsCommand.d.ts +32 -0
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +11 -0
- package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +11 -0
- package/dist-types/commands/RemoveRoleFromDBInstanceCommand.d.ts +12 -0
- package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +24 -0
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +37 -0
- package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +23 -0
- package/dist-types/commands/ResetDBParameterGroupCommand.d.ts +23 -0
- package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +54 -0
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +84 -0
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +84 -0
- package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +174 -0
- package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +67 -0
- package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +180 -0
- package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +31 -0
- package/dist-types/commands/StartActivityStreamCommand.d.ts +21 -0
- package/dist-types/commands/StartDBClusterCommand.d.ts +11 -0
- package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +20 -0
- package/dist-types/commands/StartDBInstanceCommand.d.ts +42 -0
- package/dist-types/commands/StartExportTaskCommand.d.ts +35 -0
- package/dist-types/commands/StopActivityStreamCommand.d.ts +18 -0
- package/dist-types/commands/StopDBClusterCommand.d.ts +11 -0
- package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +8 -0
- package/dist-types/commands/StopDBInstanceCommand.d.ts +19 -0
- package/dist-types/commands/SwitchoverBlueGreenDeploymentCommand.d.ts +9 -0
- package/dist-types/commands/SwitchoverReadReplicaCommand.d.ts +8 -0
- package/package.json +31 -31
|
@@ -37,6 +37,41 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
|
|
|
37
37
|
* @see {@link DeleteDBClusterCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @throws {@link DBClusterNotFoundFault} (client fault)
|
|
41
|
+
* <p>
|
|
42
|
+
* <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link DBClusterSnapshotAlreadyExistsFault} (client fault)
|
|
45
|
+
* <p>The user already has a DB cluster snapshot with the given identifier.</p>
|
|
46
|
+
*
|
|
47
|
+
* @throws {@link InvalidDBClusterSnapshotStateFault} (client fault)
|
|
48
|
+
* <p>The supplied value isn't a valid DB cluster snapshot state.</p>
|
|
49
|
+
*
|
|
50
|
+
* @throws {@link InvalidDBClusterStateFault} (client fault)
|
|
51
|
+
* <p>The requested operation can't be performed while the cluster is in this state.</p>
|
|
52
|
+
*
|
|
53
|
+
* @throws {@link SnapshotQuotaExceededFault} (client fault)
|
|
54
|
+
* <p>The request would result in the user exceeding the allowed number of DB
|
|
55
|
+
* snapshots.</p>
|
|
56
|
+
*
|
|
57
|
+
*
|
|
58
|
+
* @example To delete a DB cluster.
|
|
59
|
+
* ```javascript
|
|
60
|
+
* // This example deletes the specified DB cluster.
|
|
61
|
+
* const input = {
|
|
62
|
+
* "DBClusterIdentifier": "mydbcluster",
|
|
63
|
+
* "SkipFinalSnapshot": true
|
|
64
|
+
* };
|
|
65
|
+
* const command = new DeleteDBClusterCommand(input);
|
|
66
|
+
* const response = await client.send(command);
|
|
67
|
+
* /* response ==
|
|
68
|
+
* {
|
|
69
|
+
* "DBCluster": {}
|
|
70
|
+
* }
|
|
71
|
+
* *\/
|
|
72
|
+
* // example id: delete-db-cluster-927fc2c8-6c67-4075-b1ba-75490be0f7d6
|
|
73
|
+
* ```
|
|
74
|
+
*
|
|
40
75
|
*/
|
|
41
76
|
export declare class DeleteDBClusterCommand extends $Command<DeleteDBClusterCommandInput, DeleteDBClusterCommandOutput, RDSClientResolvedConfig> {
|
|
42
77
|
readonly input: DeleteDBClusterCommandInput;
|
|
@@ -32,6 +32,16 @@ export interface DeleteDBClusterEndpointCommandOutput extends DBClusterEndpoint,
|
|
|
32
32
|
* @see {@link DeleteDBClusterEndpointCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @throws {@link DBClusterEndpointNotFoundFault} (client fault)
|
|
36
|
+
* <p>The specified custom endpoint doesn't exist.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link InvalidDBClusterEndpointStateFault} (client fault)
|
|
39
|
+
* <p>The requested operation can't be performed on the endpoint while the endpoint is in this state.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InvalidDBClusterStateFault} (client fault)
|
|
42
|
+
* <p>The requested operation can't be performed while the cluster is in this state.</p>
|
|
43
|
+
*
|
|
44
|
+
*
|
|
35
45
|
*/
|
|
36
46
|
export declare class DeleteDBClusterEndpointCommand extends $Command<DeleteDBClusterEndpointCommandInput, DeleteDBClusterEndpointCommandOutput, RDSClientResolvedConfig> {
|
|
37
47
|
readonly input: DeleteDBClusterEndpointCommandInput;
|
|
@@ -35,6 +35,28 @@ export interface DeleteDBClusterParameterGroupCommandOutput extends __MetadataBe
|
|
|
35
35
|
* @see {@link DeleteDBClusterParameterGroupCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @throws {@link DBParameterGroupNotFoundFault} (client fault)
|
|
39
|
+
* <p>
|
|
40
|
+
* <code>DBParameterGroupName</code> doesn't refer to an
|
|
41
|
+
* existing DB parameter group.</p>
|
|
42
|
+
*
|
|
43
|
+
* @throws {@link InvalidDBParameterGroupStateFault} (client fault)
|
|
44
|
+
* <p>The DB parameter group is in use or is in an invalid state. If you are attempting
|
|
45
|
+
* to delete the parameter group, you can't delete it when the parameter group is in
|
|
46
|
+
* this state.</p>
|
|
47
|
+
*
|
|
48
|
+
*
|
|
49
|
+
* @example To delete a DB cluster parameter group.
|
|
50
|
+
* ```javascript
|
|
51
|
+
* // This example deletes the specified DB cluster parameter group.
|
|
52
|
+
* const input = {
|
|
53
|
+
* "DBClusterParameterGroupName": "mydbclusterparametergroup"
|
|
54
|
+
* };
|
|
55
|
+
* const command = new DeleteDBClusterParameterGroupCommand(input);
|
|
56
|
+
* await client.send(command);
|
|
57
|
+
* // example id: delete-db-cluster-parameter-group-364f5555-ba0a-4cc8-979c-e769098924fc
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
38
60
|
*/
|
|
39
61
|
export declare class DeleteDBClusterParameterGroupCommand extends $Command<DeleteDBClusterParameterGroupCommandInput, DeleteDBClusterParameterGroupCommandOutput, RDSClientResolvedConfig> {
|
|
40
62
|
readonly input: DeleteDBClusterParameterGroupCommandInput;
|
|
@@ -39,6 +39,30 @@ export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSna
|
|
|
39
39
|
* @see {@link DeleteDBClusterSnapshotCommandOutput} for command's `response` shape.
|
|
40
40
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
41
41
|
*
|
|
42
|
+
* @throws {@link DBClusterSnapshotNotFoundFault} (client fault)
|
|
43
|
+
* <p>
|
|
44
|
+
* <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot.</p>
|
|
45
|
+
*
|
|
46
|
+
* @throws {@link InvalidDBClusterSnapshotStateFault} (client fault)
|
|
47
|
+
* <p>The supplied value isn't a valid DB cluster snapshot state.</p>
|
|
48
|
+
*
|
|
49
|
+
*
|
|
50
|
+
* @example To delete a DB cluster snapshot.
|
|
51
|
+
* ```javascript
|
|
52
|
+
* // This example deletes the specified DB cluster snapshot.
|
|
53
|
+
* const input = {
|
|
54
|
+
* "DBClusterSnapshotIdentifier": "mydbclustersnapshot"
|
|
55
|
+
* };
|
|
56
|
+
* const command = new DeleteDBClusterSnapshotCommand(input);
|
|
57
|
+
* const response = await client.send(command);
|
|
58
|
+
* /* response ==
|
|
59
|
+
* {
|
|
60
|
+
* "DBClusterSnapshot": {}
|
|
61
|
+
* }
|
|
62
|
+
* *\/
|
|
63
|
+
* // example id: delete-db-cluster-snapshot-c67e0d95-670e-4fb5-af90-6d9a70a91b07
|
|
64
|
+
* ```
|
|
65
|
+
*
|
|
42
66
|
*/
|
|
43
67
|
export declare class DeleteDBClusterSnapshotCommand extends $Command<DeleteDBClusterSnapshotCommandInput, DeleteDBClusterSnapshotCommandOutput, RDSClientResolvedConfig> {
|
|
44
68
|
readonly input: DeleteDBClusterSnapshotCommandInput;
|
|
@@ -29,6 +29,14 @@ export interface DeleteDBInstanceAutomatedBackupCommandOutput extends DeleteDBIn
|
|
|
29
29
|
* @see {@link DeleteDBInstanceAutomatedBackupCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link DBInstanceAutomatedBackupNotFoundFault} (client fault)
|
|
33
|
+
* <p>No automated backup for this DB instance was found.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InvalidDBInstanceAutomatedBackupStateFault} (client fault)
|
|
36
|
+
* <p>The automated backup is in an invalid state.
|
|
37
|
+
* For example, this automated backup is associated with an active instance.</p>
|
|
38
|
+
*
|
|
39
|
+
*
|
|
32
40
|
*/
|
|
33
41
|
export declare class DeleteDBInstanceAutomatedBackupCommand extends $Command<DeleteDBInstanceAutomatedBackupCommandInput, DeleteDBInstanceAutomatedBackupCommandOutput, RDSClientResolvedConfig> {
|
|
34
42
|
readonly input: DeleteDBInstanceAutomatedBackupCommandInput;
|
|
@@ -51,6 +51,47 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _
|
|
|
51
51
|
* @see {@link DeleteDBInstanceCommandOutput} for command's `response` shape.
|
|
52
52
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
53
53
|
*
|
|
54
|
+
* @throws {@link DBInstanceAutomatedBackupQuotaExceededFault} (client fault)
|
|
55
|
+
* <p>The quota for retained automated backups was exceeded. This prevents you
|
|
56
|
+
* from retaining any additional automated backups. The retained automated backups
|
|
57
|
+
* quota is the same as your DB Instance quota.</p>
|
|
58
|
+
*
|
|
59
|
+
* @throws {@link DBInstanceNotFoundFault} (client fault)
|
|
60
|
+
* <p>
|
|
61
|
+
* <code>DBInstanceIdentifier</code> doesn't refer to an existing DB instance.</p>
|
|
62
|
+
*
|
|
63
|
+
* @throws {@link DBSnapshotAlreadyExistsFault} (client fault)
|
|
64
|
+
* <p>
|
|
65
|
+
* <code>DBSnapshotIdentifier</code> is already used by an existing snapshot.</p>
|
|
66
|
+
*
|
|
67
|
+
* @throws {@link InvalidDBClusterStateFault} (client fault)
|
|
68
|
+
* <p>The requested operation can't be performed while the cluster is in this state.</p>
|
|
69
|
+
*
|
|
70
|
+
* @throws {@link InvalidDBInstanceStateFault} (client fault)
|
|
71
|
+
* <p>The DB instance isn't in a valid state.</p>
|
|
72
|
+
*
|
|
73
|
+
* @throws {@link SnapshotQuotaExceededFault} (client fault)
|
|
74
|
+
* <p>The request would result in the user exceeding the allowed number of DB
|
|
75
|
+
* snapshots.</p>
|
|
76
|
+
*
|
|
77
|
+
*
|
|
78
|
+
* @example To delete a DB instance.
|
|
79
|
+
* ```javascript
|
|
80
|
+
* // This example deletes the specified DB instance.
|
|
81
|
+
* const input = {
|
|
82
|
+
* "DBInstanceIdentifier": "mymysqlinstance",
|
|
83
|
+
* "SkipFinalSnapshot": true
|
|
84
|
+
* };
|
|
85
|
+
* const command = new DeleteDBInstanceCommand(input);
|
|
86
|
+
* const response = await client.send(command);
|
|
87
|
+
* /* response ==
|
|
88
|
+
* {
|
|
89
|
+
* "DBInstance": {}
|
|
90
|
+
* }
|
|
91
|
+
* *\/
|
|
92
|
+
* // example id: delete-db-instance-4412e650-949c-488a-b32a-7d3038ebccc4
|
|
93
|
+
* ```
|
|
94
|
+
*
|
|
54
95
|
*/
|
|
55
96
|
export declare class DeleteDBInstanceCommand extends $Command<DeleteDBInstanceCommandInput, DeleteDBInstanceCommandOutput, RDSClientResolvedConfig> {
|
|
56
97
|
readonly input: DeleteDBInstanceCommandInput;
|
|
@@ -29,6 +29,28 @@ export interface DeleteDBParameterGroupCommandOutput extends __MetadataBearer {
|
|
|
29
29
|
* @see {@link DeleteDBParameterGroupCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link DBParameterGroupNotFoundFault} (client fault)
|
|
33
|
+
* <p>
|
|
34
|
+
* <code>DBParameterGroupName</code> doesn't refer to an
|
|
35
|
+
* existing DB parameter group.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link InvalidDBParameterGroupStateFault} (client fault)
|
|
38
|
+
* <p>The DB parameter group is in use or is in an invalid state. If you are attempting
|
|
39
|
+
* to delete the parameter group, you can't delete it when the parameter group is in
|
|
40
|
+
* this state.</p>
|
|
41
|
+
*
|
|
42
|
+
*
|
|
43
|
+
* @example To delete a DB parameter group
|
|
44
|
+
* ```javascript
|
|
45
|
+
* // The following example deletes a DB parameter group.
|
|
46
|
+
* const input = {
|
|
47
|
+
* "DBParameterGroupName": "mydbparamgroup3"
|
|
48
|
+
* };
|
|
49
|
+
* const command = new DeleteDBParameterGroupCommand(input);
|
|
50
|
+
* await client.send(command);
|
|
51
|
+
* // example id: to-delete-a-db-parameter-group-1473888796509
|
|
52
|
+
* ```
|
|
53
|
+
*
|
|
32
54
|
*/
|
|
33
55
|
export declare class DeleteDBParameterGroupCommand extends $Command<DeleteDBParameterGroupCommandInput, DeleteDBParameterGroupCommandOutput, RDSClientResolvedConfig> {
|
|
34
56
|
readonly input: DeleteDBParameterGroupCommandInput;
|
|
@@ -29,6 +29,13 @@ export interface DeleteDBProxyCommandOutput extends DeleteDBProxyResponse, __Met
|
|
|
29
29
|
* @see {@link DeleteDBProxyCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link DBProxyNotFoundFault} (client fault)
|
|
33
|
+
* <p>The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link InvalidDBProxyStateFault} (client fault)
|
|
36
|
+
* <p>The requested operation can't be performed while the proxy is in this state.</p>
|
|
37
|
+
*
|
|
38
|
+
*
|
|
32
39
|
*/
|
|
33
40
|
export declare class DeleteDBProxyCommand extends $Command<DeleteDBProxyCommandInput, DeleteDBProxyCommandOutput, RDSClientResolvedConfig> {
|
|
34
41
|
readonly input: DeleteDBProxyCommandInput;
|
|
@@ -31,6 +31,13 @@ export interface DeleteDBProxyEndpointCommandOutput extends DeleteDBProxyEndpoin
|
|
|
31
31
|
* @see {@link DeleteDBProxyEndpointCommandOutput} for command's `response` shape.
|
|
32
32
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
33
33
|
*
|
|
34
|
+
* @throws {@link DBProxyEndpointNotFoundFault} (client fault)
|
|
35
|
+
* <p>The DB proxy endpoint doesn't exist.</p>
|
|
36
|
+
*
|
|
37
|
+
* @throws {@link InvalidDBProxyEndpointStateFault} (client fault)
|
|
38
|
+
* <p>You can't perform this operation while the DB proxy endpoint is in a particular state.</p>
|
|
39
|
+
*
|
|
40
|
+
*
|
|
34
41
|
*/
|
|
35
42
|
export declare class DeleteDBProxyEndpointCommand extends $Command<DeleteDBProxyEndpointCommandInput, DeleteDBProxyEndpointCommandOutput, RDSClientResolvedConfig> {
|
|
36
43
|
readonly input: DeleteDBProxyEndpointCommandInput;
|
|
@@ -37,6 +37,25 @@ export interface DeleteDBSecurityGroupCommandOutput extends __MetadataBearer {
|
|
|
37
37
|
* @see {@link DeleteDBSecurityGroupCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @throws {@link DBSecurityGroupNotFoundFault} (client fault)
|
|
41
|
+
* <p>
|
|
42
|
+
* <code>DBSecurityGroupName</code> doesn't refer to an existing DB security group.</p>
|
|
43
|
+
*
|
|
44
|
+
* @throws {@link InvalidDBSecurityGroupStateFault} (client fault)
|
|
45
|
+
* <p>The state of the DB security group doesn't allow deletion.</p>
|
|
46
|
+
*
|
|
47
|
+
*
|
|
48
|
+
* @example To delete a DB security group
|
|
49
|
+
* ```javascript
|
|
50
|
+
* // The following example deletes a DB security group.
|
|
51
|
+
* const input = {
|
|
52
|
+
* "DBSecurityGroupName": "mysecgroup"
|
|
53
|
+
* };
|
|
54
|
+
* const command = new DeleteDBSecurityGroupCommand(input);
|
|
55
|
+
* await client.send(command);
|
|
56
|
+
* // example id: to-delete-a-db-security-group-1473960141889
|
|
57
|
+
* ```
|
|
58
|
+
*
|
|
40
59
|
*/
|
|
41
60
|
export declare class DeleteDBSecurityGroupCommand extends $Command<DeleteDBSecurityGroupCommandInput, DeleteDBSecurityGroupCommandOutput, RDSClientResolvedConfig> {
|
|
42
61
|
readonly input: DeleteDBSecurityGroupCommandInput;
|
|
@@ -33,6 +33,30 @@ export interface DeleteDBSnapshotCommandOutput extends DeleteDBSnapshotResult, _
|
|
|
33
33
|
* @see {@link DeleteDBSnapshotCommandOutput} for command's `response` shape.
|
|
34
34
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
35
35
|
*
|
|
36
|
+
* @throws {@link DBSnapshotNotFoundFault} (client fault)
|
|
37
|
+
* <p>
|
|
38
|
+
* <code>DBSnapshotIdentifier</code> doesn't refer to an existing DB snapshot.</p>
|
|
39
|
+
*
|
|
40
|
+
* @throws {@link InvalidDBSnapshotStateFault} (client fault)
|
|
41
|
+
* <p>The state of the DB snapshot doesn't allow deletion.</p>
|
|
42
|
+
*
|
|
43
|
+
*
|
|
44
|
+
* @example To delete a DB cluster snapshot.
|
|
45
|
+
* ```javascript
|
|
46
|
+
* // This example deletes the specified DB snapshot.
|
|
47
|
+
* const input = {
|
|
48
|
+
* "DBSnapshotIdentifier": "mydbsnapshot"
|
|
49
|
+
* };
|
|
50
|
+
* const command = new DeleteDBSnapshotCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* /* response ==
|
|
53
|
+
* {
|
|
54
|
+
* "DBSnapshot": {}
|
|
55
|
+
* }
|
|
56
|
+
* *\/
|
|
57
|
+
* // example id: delete-db-snapshot-505d6b4e-8ced-479c-856a-c460a33fe07b
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
36
60
|
*/
|
|
37
61
|
export declare class DeleteDBSnapshotCommand extends $Command<DeleteDBSnapshotCommandInput, DeleteDBSnapshotCommandOutput, RDSClientResolvedConfig> {
|
|
38
62
|
readonly input: DeleteDBSnapshotCommandInput;
|
|
@@ -32,6 +32,28 @@ export interface DeleteDBSubnetGroupCommandOutput extends __MetadataBearer {
|
|
|
32
32
|
* @see {@link DeleteDBSubnetGroupCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @throws {@link DBSubnetGroupNotFoundFault} (client fault)
|
|
36
|
+
* <p>
|
|
37
|
+
* <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link InvalidDBSubnetGroupStateFault} (client fault)
|
|
40
|
+
* <p>The DB subnet group cannot be deleted because it's in use.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link InvalidDBSubnetStateFault} (client fault)
|
|
43
|
+
* <p>The DB subnet isn't in the <i>available</i> state.</p>
|
|
44
|
+
*
|
|
45
|
+
*
|
|
46
|
+
* @example To delete a DB subnet group.
|
|
47
|
+
* ```javascript
|
|
48
|
+
* // This example deletes the specified DB subnetgroup.
|
|
49
|
+
* const input = {
|
|
50
|
+
* "DBSubnetGroupName": "mydbsubnetgroup"
|
|
51
|
+
* };
|
|
52
|
+
* const command = new DeleteDBSubnetGroupCommand(input);
|
|
53
|
+
* await client.send(command);
|
|
54
|
+
* // example id: delete-db-subnet-group-4ae00375-511e-443d-a01d-4b9f552244aa
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
35
57
|
*/
|
|
36
58
|
export declare class DeleteDBSubnetGroupCommand extends $Command<DeleteDBSubnetGroupCommandInput, DeleteDBSubnetGroupCommandOutput, RDSClientResolvedConfig> {
|
|
37
59
|
readonly input: DeleteDBSubnetGroupCommandInput;
|
|
@@ -29,6 +29,29 @@ export interface DeleteEventSubscriptionCommandOutput extends DeleteEventSubscri
|
|
|
29
29
|
* @see {@link DeleteEventSubscriptionCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InvalidEventSubscriptionStateFault} (client fault)
|
|
33
|
+
* <p>This error can occur if someone else is modifying a subscription. You should retry the action.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link SubscriptionNotFoundFault} (client fault)
|
|
36
|
+
* <p>The subscription name does not exist.</p>
|
|
37
|
+
*
|
|
38
|
+
*
|
|
39
|
+
* @example To delete a DB event subscription.
|
|
40
|
+
* ```javascript
|
|
41
|
+
* // This example deletes the specified DB event subscription.
|
|
42
|
+
* const input = {
|
|
43
|
+
* "SubscriptionName": "myeventsubscription"
|
|
44
|
+
* };
|
|
45
|
+
* const command = new DeleteEventSubscriptionCommand(input);
|
|
46
|
+
* const response = await client.send(command);
|
|
47
|
+
* /* response ==
|
|
48
|
+
* {
|
|
49
|
+
* "EventSubscription": {}
|
|
50
|
+
* }
|
|
51
|
+
* *\/
|
|
52
|
+
* // example id: delete-db-event-subscription-d33567e3-1d5d-48ff-873f-0270453f4a75
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
32
55
|
*/
|
|
33
56
|
export declare class DeleteEventSubscriptionCommand extends $Command<DeleteEventSubscriptionCommandInput, DeleteEventSubscriptionCommandOutput, RDSClientResolvedConfig> {
|
|
34
57
|
readonly input: DeleteEventSubscriptionCommandInput;
|
|
@@ -33,6 +33,13 @@ export interface DeleteGlobalClusterCommandOutput extends DeleteGlobalClusterRes
|
|
|
33
33
|
* @see {@link DeleteGlobalClusterCommandOutput} for command's `response` shape.
|
|
34
34
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
35
35
|
*
|
|
36
|
+
* @throws {@link GlobalClusterNotFoundFault} (client fault)
|
|
37
|
+
* <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster.</p>
|
|
38
|
+
*
|
|
39
|
+
* @throws {@link InvalidGlobalClusterStateFault} (client fault)
|
|
40
|
+
* <p>The global cluster is in an invalid state and can't perform the requested operation.</p>
|
|
41
|
+
*
|
|
42
|
+
*
|
|
36
43
|
*/
|
|
37
44
|
export declare class DeleteGlobalClusterCommand extends $Command<DeleteGlobalClusterCommandInput, DeleteGlobalClusterCommandOutput, RDSClientResolvedConfig> {
|
|
38
45
|
readonly input: DeleteGlobalClusterCommandInput;
|
|
@@ -29,6 +29,24 @@ export interface DeleteOptionGroupCommandOutput extends __MetadataBearer {
|
|
|
29
29
|
* @see {@link DeleteOptionGroupCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link InvalidOptionGroupStateFault} (client fault)
|
|
33
|
+
* <p>The option group isn't in the <i>available</i> state.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link OptionGroupNotFoundFault} (client fault)
|
|
36
|
+
* <p>The specified option group could not be found.</p>
|
|
37
|
+
*
|
|
38
|
+
*
|
|
39
|
+
* @example To delete an option group.
|
|
40
|
+
* ```javascript
|
|
41
|
+
* // This example deletes the specified option group.
|
|
42
|
+
* const input = {
|
|
43
|
+
* "OptionGroupName": "mydboptiongroup"
|
|
44
|
+
* };
|
|
45
|
+
* const command = new DeleteOptionGroupCommand(input);
|
|
46
|
+
* await client.send(command);
|
|
47
|
+
* // example id: delete-db-option-group-578be2be-3095-431a-9ea4-9a3c3b0daef4
|
|
48
|
+
* ```
|
|
49
|
+
*
|
|
32
50
|
*/
|
|
33
51
|
export declare class DeleteOptionGroupCommand extends $Command<DeleteOptionGroupCommandInput, DeleteOptionGroupCommandOutput, RDSClientResolvedConfig> {
|
|
34
52
|
readonly input: DeleteOptionGroupCommandInput;
|
|
@@ -29,6 +29,19 @@ export interface DeregisterDBProxyTargetsCommandOutput extends DeregisterDBProxy
|
|
|
29
29
|
* @see {@link DeregisterDBProxyTargetsCommandOutput} for command's `response` shape.
|
|
30
30
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
31
31
|
*
|
|
32
|
+
* @throws {@link DBProxyNotFoundFault} (client fault)
|
|
33
|
+
* <p>The specified proxy name doesn't correspond to a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
|
|
34
|
+
*
|
|
35
|
+
* @throws {@link DBProxyTargetGroupNotFoundFault} (client fault)
|
|
36
|
+
* <p>The specified target group isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
|
|
37
|
+
*
|
|
38
|
+
* @throws {@link DBProxyTargetNotFoundFault} (client fault)
|
|
39
|
+
* <p>The specified RDS DB instance or Aurora DB cluster isn't available for a proxy owned by your Amazon Web Services account in the specified Amazon Web Services Region.</p>
|
|
40
|
+
*
|
|
41
|
+
* @throws {@link InvalidDBProxyStateFault} (client fault)
|
|
42
|
+
* <p>The requested operation can't be performed while the proxy is in this state.</p>
|
|
43
|
+
*
|
|
44
|
+
*
|
|
32
45
|
*/
|
|
33
46
|
export declare class DeregisterDBProxyTargetsCommand extends $Command<DeregisterDBProxyTargetsCommandInput, DeregisterDBProxyTargetsCommandOutput, RDSClientResolvedConfig> {
|
|
34
47
|
readonly input: DeregisterDBProxyTargetsCommandInput;
|
|
@@ -30,6 +30,16 @@ export interface DescribeAccountAttributesCommandOutput extends AccountAttribute
|
|
|
30
30
|
* @see {@link DescribeAccountAttributesCommandOutput} for command's `response` shape.
|
|
31
31
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
32
32
|
*
|
|
33
|
+
*
|
|
34
|
+
* @example To list account attributes
|
|
35
|
+
* ```javascript
|
|
36
|
+
* // This example lists account attributes.
|
|
37
|
+
* const input = {};
|
|
38
|
+
* const command = new DescribeAccountAttributesCommand(input);
|
|
39
|
+
* await client.send(command);
|
|
40
|
+
* // example id: describe-account-attributes-683d3ff7-5524-421a-8da5-e88f1ea2222b
|
|
41
|
+
* ```
|
|
42
|
+
*
|
|
33
43
|
*/
|
|
34
44
|
export declare class DescribeAccountAttributesCommand extends $Command<DescribeAccountAttributesCommandInput, DescribeAccountAttributesCommandOutput, RDSClientResolvedConfig> {
|
|
35
45
|
readonly input: DescribeAccountAttributesCommandInput;
|
|
@@ -34,6 +34,11 @@ export interface DescribeBlueGreenDeploymentsCommandOutput extends DescribeBlueG
|
|
|
34
34
|
* @see {@link DescribeBlueGreenDeploymentsCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @throws {@link BlueGreenDeploymentNotFoundFault} (client fault)
|
|
38
|
+
* <p>
|
|
39
|
+
* <code>BlueGreenDeploymentIdentifier</code> doesn't refer to an existing blue/green deployment.</p>
|
|
40
|
+
*
|
|
41
|
+
*
|
|
37
42
|
*/
|
|
38
43
|
export declare class DescribeBlueGreenDeploymentsCommand extends $Command<DescribeBlueGreenDeploymentsCommandInput, DescribeBlueGreenDeploymentsCommandOutput, RDSClientResolvedConfig> {
|
|
39
44
|
readonly input: DescribeBlueGreenDeploymentsCommandInput;
|
|
@@ -34,6 +34,24 @@ export interface DescribeCertificatesCommandOutput extends CertificateMessage, _
|
|
|
34
34
|
* @see {@link DescribeCertificatesCommandOutput} for command's `response` shape.
|
|
35
35
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
36
36
|
*
|
|
37
|
+
* @throws {@link CertificateNotFoundFault} (client fault)
|
|
38
|
+
* <p>
|
|
39
|
+
* <code>CertificateIdentifier</code> doesn't refer to an
|
|
40
|
+
* existing certificate.</p>
|
|
41
|
+
*
|
|
42
|
+
*
|
|
43
|
+
* @example To list certificates
|
|
44
|
+
* ```javascript
|
|
45
|
+
* // This example lists up to 20 certificates for the specified certificate identifier.
|
|
46
|
+
* const input = {
|
|
47
|
+
* "CertificateIdentifier": "rds-ca-2015",
|
|
48
|
+
* "MaxRecords": 20
|
|
49
|
+
* };
|
|
50
|
+
* const command = new DescribeCertificatesCommand(input);
|
|
51
|
+
* await client.send(command);
|
|
52
|
+
* // example id: describe-certificates-9d71a70d-7908-4444-b43f-321d842c62dc
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
37
55
|
*/
|
|
38
56
|
export declare class DescribeCertificatesCommand extends $Command<DescribeCertificatesCommandInput, DescribeCertificatesCommandOutput, RDSClientResolvedConfig> {
|
|
39
57
|
readonly input: DescribeCertificatesCommandInput;
|
|
@@ -35,6 +35,15 @@ export interface DescribeDBClusterBacktracksCommandOutput extends DBClusterBackt
|
|
|
35
35
|
* @see {@link DescribeDBClusterBacktracksCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @throws {@link DBClusterBacktrackNotFoundFault} (client fault)
|
|
39
|
+
* <p>
|
|
40
|
+
* <code>BacktrackIdentifier</code> doesn't refer to an existing backtrack.</p>
|
|
41
|
+
*
|
|
42
|
+
* @throws {@link DBClusterNotFoundFault} (client fault)
|
|
43
|
+
* <p>
|
|
44
|
+
* <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
|
|
45
|
+
*
|
|
46
|
+
*
|
|
38
47
|
*/
|
|
39
48
|
export declare class DescribeDBClusterBacktracksCommand extends $Command<DescribeDBClusterBacktracksCommandInput, DescribeDBClusterBacktracksCommandOutput, RDSClientResolvedConfig> {
|
|
40
49
|
readonly input: DescribeDBClusterBacktracksCommandInput;
|
|
@@ -32,6 +32,11 @@ export interface DescribeDBClusterEndpointsCommandOutput extends DBClusterEndpoi
|
|
|
32
32
|
* @see {@link DescribeDBClusterEndpointsCommandOutput} for command's `response` shape.
|
|
33
33
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
34
34
|
*
|
|
35
|
+
* @throws {@link DBClusterNotFoundFault} (client fault)
|
|
36
|
+
* <p>
|
|
37
|
+
* <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
|
|
38
|
+
*
|
|
39
|
+
*
|
|
35
40
|
*/
|
|
36
41
|
export declare class DescribeDBClusterEndpointsCommand extends $Command<DescribeDBClusterEndpointsCommandInput, DescribeDBClusterEndpointsCommandOutput, RDSClientResolvedConfig> {
|
|
37
42
|
readonly input: DescribeDBClusterEndpointsCommandInput;
|
|
@@ -37,6 +37,23 @@ export interface DescribeDBClusterParameterGroupsCommandOutput extends DBCluster
|
|
|
37
37
|
* @see {@link DescribeDBClusterParameterGroupsCommandOutput} for command's `response` shape.
|
|
38
38
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
39
39
|
*
|
|
40
|
+
* @throws {@link DBParameterGroupNotFoundFault} (client fault)
|
|
41
|
+
* <p>
|
|
42
|
+
* <code>DBParameterGroupName</code> doesn't refer to an
|
|
43
|
+
* existing DB parameter group.</p>
|
|
44
|
+
*
|
|
45
|
+
*
|
|
46
|
+
* @example To list DB cluster parameter group settings
|
|
47
|
+
* ```javascript
|
|
48
|
+
* // This example lists settings for the specified DB cluster parameter group.
|
|
49
|
+
* const input = {
|
|
50
|
+
* "DBClusterParameterGroupName": "mydbclusterparametergroup"
|
|
51
|
+
* };
|
|
52
|
+
* const command = new DescribeDBClusterParameterGroupsCommand(input);
|
|
53
|
+
* await client.send(command);
|
|
54
|
+
* // example id: describe-db-cluster-parameter-groups-cf9c6e66-664e-4f57-8e29-a9080abfc013
|
|
55
|
+
* ```
|
|
56
|
+
*
|
|
40
57
|
*/
|
|
41
58
|
export declare class DescribeDBClusterParameterGroupsCommand extends $Command<DescribeDBClusterParameterGroupsCommandInput, DescribeDBClusterParameterGroupsCommandOutput, RDSClientResolvedConfig> {
|
|
42
59
|
readonly input: DescribeDBClusterParameterGroupsCommandInput;
|
|
@@ -35,6 +35,24 @@ export interface DescribeDBClusterParametersCommandOutput extends DBClusterParam
|
|
|
35
35
|
* @see {@link DescribeDBClusterParametersCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @throws {@link DBParameterGroupNotFoundFault} (client fault)
|
|
39
|
+
* <p>
|
|
40
|
+
* <code>DBParameterGroupName</code> doesn't refer to an
|
|
41
|
+
* existing DB parameter group.</p>
|
|
42
|
+
*
|
|
43
|
+
*
|
|
44
|
+
* @example To list DB cluster parameters
|
|
45
|
+
* ```javascript
|
|
46
|
+
* // This example lists system parameters for the specified DB cluster parameter group.
|
|
47
|
+
* const input = {
|
|
48
|
+
* "DBClusterParameterGroupName": "mydbclusterparametergroup",
|
|
49
|
+
* "Source": "system"
|
|
50
|
+
* };
|
|
51
|
+
* const command = new DescribeDBClusterParametersCommand(input);
|
|
52
|
+
* await client.send(command);
|
|
53
|
+
* // example id: describe-db-cluster-parameters-98043c28-e489-41a7-b118-bfd96dc779a1
|
|
54
|
+
* ```
|
|
55
|
+
*
|
|
38
56
|
*/
|
|
39
57
|
export declare class DescribeDBClusterParametersCommand extends $Command<DescribeDBClusterParametersCommandInput, DescribeDBClusterParametersCommandOutput, RDSClientResolvedConfig> {
|
|
40
58
|
readonly input: DescribeDBClusterParametersCommandInput;
|
|
@@ -36,6 +36,27 @@ export interface DescribeDBClusterSnapshotAttributesCommandOutput extends Descri
|
|
|
36
36
|
* @see {@link DescribeDBClusterSnapshotAttributesCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @throws {@link DBClusterSnapshotNotFoundFault} (client fault)
|
|
40
|
+
* <p>
|
|
41
|
+
* <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot.</p>
|
|
42
|
+
*
|
|
43
|
+
*
|
|
44
|
+
* @example To list DB cluster snapshot attributes
|
|
45
|
+
* ```javascript
|
|
46
|
+
* // This example lists attributes for the specified DB cluster snapshot.
|
|
47
|
+
* const input = {
|
|
48
|
+
* "DBClusterSnapshotIdentifier": "mydbclustersnapshot"
|
|
49
|
+
* };
|
|
50
|
+
* const command = new DescribeDBClusterSnapshotAttributesCommand(input);
|
|
51
|
+
* const response = await client.send(command);
|
|
52
|
+
* /* response ==
|
|
53
|
+
* {
|
|
54
|
+
* "DBClusterSnapshotAttributesResult": {}
|
|
55
|
+
* }
|
|
56
|
+
* *\/
|
|
57
|
+
* // example id: describe-db-cluster-snapshot-attributes-6752ade3-0c7b-4b06-a8e4-b76bf4e2d3571
|
|
58
|
+
* ```
|
|
59
|
+
*
|
|
39
60
|
*/
|
|
40
61
|
export declare class DescribeDBClusterSnapshotAttributesCommand extends $Command<DescribeDBClusterSnapshotAttributesCommandInput, DescribeDBClusterSnapshotAttributesCommandOutput, RDSClientResolvedConfig> {
|
|
41
62
|
readonly input: DescribeDBClusterSnapshotAttributesCommandInput;
|
|
@@ -35,6 +35,23 @@ export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapsh
|
|
|
35
35
|
* @see {@link DescribeDBClusterSnapshotsCommandOutput} for command's `response` shape.
|
|
36
36
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
37
37
|
*
|
|
38
|
+
* @throws {@link DBClusterSnapshotNotFoundFault} (client fault)
|
|
39
|
+
* <p>
|
|
40
|
+
* <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing DB cluster snapshot.</p>
|
|
41
|
+
*
|
|
42
|
+
*
|
|
43
|
+
* @example To list DB cluster snapshots
|
|
44
|
+
* ```javascript
|
|
45
|
+
* // This example lists settings for the specified, manually-created cluster snapshot.
|
|
46
|
+
* const input = {
|
|
47
|
+
* "DBClusterSnapshotIdentifier": "mydbclustersnapshot",
|
|
48
|
+
* "SnapshotType": "manual"
|
|
49
|
+
* };
|
|
50
|
+
* const command = new DescribeDBClusterSnapshotsCommand(input);
|
|
51
|
+
* await client.send(command);
|
|
52
|
+
* // example id: describe-db-cluster-snapshots-52f38af1-3431-4a51-9a6a-e6bb8c961b32
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
38
55
|
*/
|
|
39
56
|
export declare class DescribeDBClusterSnapshotsCommand extends $Command<DescribeDBClusterSnapshotsCommandInput, DescribeDBClusterSnapshotsCommandOutput, RDSClientResolvedConfig> {
|
|
40
57
|
readonly input: DescribeDBClusterSnapshotsCommandInput;
|
|
@@ -36,6 +36,22 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met
|
|
|
36
36
|
* @see {@link DescribeDBClustersCommandOutput} for command's `response` shape.
|
|
37
37
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
38
38
|
*
|
|
39
|
+
* @throws {@link DBClusterNotFoundFault} (client fault)
|
|
40
|
+
* <p>
|
|
41
|
+
* <code>DBClusterIdentifier</code> doesn't refer to an existing DB cluster.</p>
|
|
42
|
+
*
|
|
43
|
+
*
|
|
44
|
+
* @example To list DB clusters
|
|
45
|
+
* ```javascript
|
|
46
|
+
* // This example lists settings for the specified DB cluster.
|
|
47
|
+
* const input = {
|
|
48
|
+
* "DBClusterIdentifier": "mynewdbcluster"
|
|
49
|
+
* };
|
|
50
|
+
* const command = new DescribeDBClustersCommand(input);
|
|
51
|
+
* await client.send(command);
|
|
52
|
+
* // example id: describe-db-clusters-7aae8861-cb95-4b3b-9042-f62df7698635
|
|
53
|
+
* ```
|
|
54
|
+
*
|
|
39
55
|
*/
|
|
40
56
|
export declare class DescribeDBClustersCommand extends $Command<DescribeDBClustersCommandInput, DescribeDBClustersCommandOutput, RDSClientResolvedConfig> {
|
|
41
57
|
readonly input: DescribeDBClustersCommandInput;
|