@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.
- package/dist-types/commands/AddRoleToDBClusterCommand.d.ts +4 -0
- package/dist-types/commands/AddRoleToDBInstanceCommand.d.ts +4 -0
- package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/AddTagsToResourceCommand.d.ts +4 -0
- package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +18 -0
- package/dist-types/commands/AuthorizeDBSecurityGroupIngressCommand.d.ts +26 -0
- package/dist-types/commands/BacktrackDBClusterCommand.d.ts +11 -0
- package/dist-types/commands/CancelExportTaskCommand.d.ts +23 -0
- package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +37 -0
- package/dist-types/commands/CopyDBParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/CopyDBSnapshotCommand.d.ts +50 -0
- package/dist-types/commands/CopyOptionGroupCommand.d.ts +52 -0
- package/dist-types/commands/CreateBlueGreenDeploymentCommand.d.ts +34 -0
- package/dist-types/commands/CreateCustomDBEngineVersionCommand.d.ts +83 -0
- package/dist-types/commands/CreateDBClusterCommand.d.ts +151 -127
- package/dist-types/commands/CreateDBClusterEndpointCommand.d.ts +19 -0
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +37 -0
- package/dist-types/commands/CreateDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/CreateDBInstanceReadReplicaCommand.d.ts +216 -0
- package/dist-types/commands/CreateDBParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/CreateDBProxyCommand.d.ts +35 -0
- package/dist-types/commands/CreateDBProxyEndpointCommand.d.ts +22 -0
- package/dist-types/commands/CreateDBSecurityGroupCommand.d.ts +26 -0
- package/dist-types/commands/CreateDBSnapshotCommand.d.ts +50 -0
- package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +27 -0
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/CreateOptionGroupCommand.d.ts +52 -0
- package/dist-types/commands/DeleteBlueGreenDeploymentCommand.d.ts +34 -0
- package/dist-types/commands/DeleteCustomDBEngineVersionCommand.d.ts +83 -0
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/DeleteDBClusterEndpointCommand.d.ts +19 -0
- package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +37 -0
- package/dist-types/commands/DeleteDBInstanceAutomatedBackupCommand.d.ts +42 -0
- package/dist-types/commands/DeleteDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/DeleteDBParameterGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDBProxyCommand.d.ts +35 -0
- package/dist-types/commands/DeleteDBProxyEndpointCommand.d.ts +22 -0
- package/dist-types/commands/DeleteDBSecurityGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDBSnapshotCommand.d.ts +50 -0
- package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/DeleteOptionGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeregisterDBProxyTargetsCommand.d.ts +4 -0
- package/dist-types/commands/DescribeAccountAttributesCommand.d.ts +12 -0
- package/dist-types/commands/DescribeBlueGreenDeploymentsCommand.d.ts +37 -0
- package/dist-types/commands/DescribeCertificatesCommand.d.ts +18 -0
- package/dist-types/commands/DescribeDBClusterBacktracksCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBClusterEndpointsCommand.d.ts +24 -0
- package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +14 -0
- package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +23 -0
- package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +40 -0
- package/dist-types/commands/DescribeDBClustersCommand.d.ts +154 -0
- package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +88 -0
- package/dist-types/commands/DescribeDBInstanceAutomatedBackupsCommand.d.ts +45 -0
- package/dist-types/commands/DescribeDBInstancesCommand.d.ts +219 -0
- package/dist-types/commands/DescribeDBLogFilesCommand.d.ts +13 -0
- package/dist-types/commands/DescribeDBParameterGroupsCommand.d.ts +14 -0
- package/dist-types/commands/DescribeDBParametersCommand.d.ts +23 -0
- package/dist-types/commands/DescribeDBProxiesCommand.d.ts +38 -0
- package/dist-types/commands/DescribeDBProxyEndpointsCommand.d.ts +25 -0
- package/dist-types/commands/DescribeDBProxyTargetGroupsCommand.d.ts +26 -0
- package/dist-types/commands/DescribeDBProxyTargetsCommand.d.ts +22 -0
- package/dist-types/commands/DescribeDBSecurityGroupsCommand.d.ts +29 -0
- package/dist-types/commands/DescribeDBSnapshotAttributesCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBSnapshotsCommand.d.ts +53 -0
- package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +30 -0
- package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +26 -0
- package/dist-types/commands/DescribeEngineDefaultParametersCommand.d.ts +26 -0
- package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +13 -0
- package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +24 -0
- package/dist-types/commands/DescribeEventsCommand.d.ts +18 -0
- package/dist-types/commands/DescribeExportTasksCommand.d.ts +28 -0
- package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +34 -0
- package/dist-types/commands/DescribeOptionGroupOptionsCommand.d.ts +52 -0
- package/dist-types/commands/DescribeOptionGroupsCommand.d.ts +55 -0
- package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +61 -0
- package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +21 -0
- package/dist-types/commands/DescribeReservedDBInstancesCommand.d.ts +31 -0
- package/dist-types/commands/DescribeReservedDBInstancesOfferingsCommand.d.ts +25 -0
- package/dist-types/commands/DescribeSourceRegionsCommand.d.ts +14 -0
- package/dist-types/commands/DescribeValidDBInstanceModificationsCommand.d.ts +53 -0
- package/dist-types/commands/DownloadDBLogFilePortionCommand.d.ts +8 -0
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/FailoverGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
- package/dist-types/commands/ModifyActivityStreamCommand.d.ts +11 -0
- package/dist-types/commands/ModifyCertificatesCommand.d.ts +15 -0
- package/dist-types/commands/ModifyCurrentDBClusterCapacityCommand.d.ts +10 -0
- package/dist-types/commands/ModifyCustomDBEngineVersionCommand.d.ts +83 -0
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/ModifyDBClusterEndpointCommand.d.ts +19 -0
- package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +6 -0
- package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +16 -0
- package/dist-types/commands/ModifyDBInstanceCommand.d.ts +216 -49
- package/dist-types/commands/ModifyDBParameterGroupCommand.d.ts +6 -0
- package/dist-types/commands/ModifyDBProxyCommand.d.ts +35 -0
- package/dist-types/commands/ModifyDBProxyEndpointCommand.d.ts +22 -0
- package/dist-types/commands/ModifyDBProxyTargetGroupCommand.d.ts +23 -0
- package/dist-types/commands/ModifyDBSnapshotAttributeCommand.d.ts +16 -0
- package/dist-types/commands/ModifyDBSnapshotCommand.d.ts +50 -0
- package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +27 -0
- package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/ModifyOptionGroupCommand.d.ts +52 -0
- package/dist-types/commands/PromoteReadReplicaCommand.d.ts +216 -0
- package/dist-types/commands/PromoteReadReplicaDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/PurchaseReservedDBInstancesOfferingCommand.d.ts +28 -0
- package/dist-types/commands/RebootDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/RebootDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/RegisterDBProxyTargetsCommand.d.ts +21 -0
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +31 -0
- package/dist-types/commands/RemoveRoleFromDBClusterCommand.d.ts +4 -0
- package/dist-types/commands/RemoveRoleFromDBInstanceCommand.d.ts +4 -0
- package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +4 -0
- package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +6 -0
- package/dist-types/commands/ResetDBParameterGroupCommand.d.ts +6 -0
- package/dist-types/commands/RestoreDBClusterFromS3Command.d.ts +151 -0
- package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +151 -0
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +151 -0
- package/dist-types/commands/RestoreDBInstanceFromDBSnapshotCommand.d.ts +216 -0
- package/dist-types/commands/RestoreDBInstanceFromS3Command.d.ts +216 -0
- package/dist-types/commands/RestoreDBInstanceToPointInTimeCommand.d.ts +216 -0
- package/dist-types/commands/RevokeDBSecurityGroupIngressCommand.d.ts +26 -0
- package/dist-types/commands/StartActivityStreamCommand.d.ts +11 -0
- package/dist-types/commands/StartDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/StartDBInstanceAutomatedBackupsReplicationCommand.d.ts +42 -0
- package/dist-types/commands/StartDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/StartExportTaskCommand.d.ts +23 -0
- package/dist-types/commands/StopActivityStreamCommand.d.ts +8 -0
- package/dist-types/commands/StopDBClusterCommand.d.ts +151 -0
- package/dist-types/commands/StopDBInstanceAutomatedBackupsReplicationCommand.d.ts +42 -0
- package/dist-types/commands/StopDBInstanceCommand.d.ts +216 -0
- package/dist-types/commands/SwitchoverBlueGreenDeploymentCommand.d.ts +34 -0
- package/dist-types/commands/SwitchoverReadReplicaCommand.d.ts +216 -0
- package/package.json +17 -17
|
@@ -43,6 +43,34 @@ export interface DescribeDBSubnetGroupsCommandOutput extends DBSubnetGroupMessag
|
|
|
43
43
|
* };
|
|
44
44
|
* const command = new DescribeDBSubnetGroupsCommand(input);
|
|
45
45
|
* const response = await client.send(command);
|
|
46
|
+
* // { // DBSubnetGroupMessage
|
|
47
|
+
* // Marker: "STRING_VALUE",
|
|
48
|
+
* // DBSubnetGroups: [ // DBSubnetGroups
|
|
49
|
+
* // { // DBSubnetGroup
|
|
50
|
+
* // DBSubnetGroupName: "STRING_VALUE",
|
|
51
|
+
* // DBSubnetGroupDescription: "STRING_VALUE",
|
|
52
|
+
* // VpcId: "STRING_VALUE",
|
|
53
|
+
* // SubnetGroupStatus: "STRING_VALUE",
|
|
54
|
+
* // Subnets: [ // SubnetList
|
|
55
|
+
* // { // Subnet
|
|
56
|
+
* // SubnetIdentifier: "STRING_VALUE",
|
|
57
|
+
* // SubnetAvailabilityZone: { // AvailabilityZone
|
|
58
|
+
* // Name: "STRING_VALUE",
|
|
59
|
+
* // },
|
|
60
|
+
* // SubnetOutpost: { // Outpost
|
|
61
|
+
* // Arn: "STRING_VALUE",
|
|
62
|
+
* // },
|
|
63
|
+
* // SubnetStatus: "STRING_VALUE",
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // DBSubnetGroupArn: "STRING_VALUE",
|
|
67
|
+
* // SupportedNetworkTypes: [ // StringList
|
|
68
|
+
* // "STRING_VALUE",
|
|
69
|
+
* // ],
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // };
|
|
73
|
+
*
|
|
46
74
|
* ```
|
|
47
75
|
*
|
|
48
76
|
* @param DescribeDBSubnetGroupsCommandInput - {@link DescribeDBSubnetGroupsCommandInput}
|
|
@@ -55,6 +83,8 @@ export interface DescribeDBSubnetGroupsCommandOutput extends DBSubnetGroupMessag
|
|
|
55
83
|
* <p>
|
|
56
84
|
* <code>DBSubnetGroupName</code> doesn't refer to an existing DB subnet group.</p>
|
|
57
85
|
*
|
|
86
|
+
* @throws {@link RDSServiceException}
|
|
87
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
58
88
|
*
|
|
59
89
|
* @example To describe a DB subnet group
|
|
60
90
|
* ```javascript
|
|
@@ -44,6 +44,30 @@ export interface DescribeEngineDefaultClusterParametersCommandOutput extends Des
|
|
|
44
44
|
* };
|
|
45
45
|
* const command = new DescribeEngineDefaultClusterParametersCommand(input);
|
|
46
46
|
* const response = await client.send(command);
|
|
47
|
+
* // { // DescribeEngineDefaultClusterParametersResult
|
|
48
|
+
* // EngineDefaults: { // EngineDefaults
|
|
49
|
+
* // DBParameterGroupFamily: "STRING_VALUE",
|
|
50
|
+
* // Marker: "STRING_VALUE",
|
|
51
|
+
* // Parameters: [ // ParametersList
|
|
52
|
+
* // { // Parameter
|
|
53
|
+
* // ParameterName: "STRING_VALUE",
|
|
54
|
+
* // ParameterValue: "STRING_VALUE",
|
|
55
|
+
* // Description: "STRING_VALUE",
|
|
56
|
+
* // Source: "STRING_VALUE",
|
|
57
|
+
* // ApplyType: "STRING_VALUE",
|
|
58
|
+
* // DataType: "STRING_VALUE",
|
|
59
|
+
* // AllowedValues: "STRING_VALUE",
|
|
60
|
+
* // IsModifiable: true || false,
|
|
61
|
+
* // MinimumEngineVersion: "STRING_VALUE",
|
|
62
|
+
* // ApplyMethod: "immediate" || "pending-reboot",
|
|
63
|
+
* // SupportedEngineModes: [ // EngineModeList
|
|
64
|
+
* // "STRING_VALUE",
|
|
65
|
+
* // ],
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // },
|
|
69
|
+
* // };
|
|
70
|
+
*
|
|
47
71
|
* ```
|
|
48
72
|
*
|
|
49
73
|
* @param DescribeEngineDefaultClusterParametersCommandInput - {@link DescribeEngineDefaultClusterParametersCommandInput}
|
|
@@ -52,6 +76,8 @@ export interface DescribeEngineDefaultClusterParametersCommandOutput extends Des
|
|
|
52
76
|
* @see {@link DescribeEngineDefaultClusterParametersCommandOutput} for command's `response` shape.
|
|
53
77
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
54
78
|
*
|
|
79
|
+
* @throws {@link RDSServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
55
81
|
*
|
|
56
82
|
* @example To describe the default engine and system parameter information for the Aurora database engine
|
|
57
83
|
* ```javascript
|
|
@@ -41,6 +41,30 @@ export interface DescribeEngineDefaultParametersCommandOutput extends DescribeEn
|
|
|
41
41
|
* };
|
|
42
42
|
* const command = new DescribeEngineDefaultParametersCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
|
+
* // { // DescribeEngineDefaultParametersResult
|
|
45
|
+
* // EngineDefaults: { // EngineDefaults
|
|
46
|
+
* // DBParameterGroupFamily: "STRING_VALUE",
|
|
47
|
+
* // Marker: "STRING_VALUE",
|
|
48
|
+
* // Parameters: [ // ParametersList
|
|
49
|
+
* // { // Parameter
|
|
50
|
+
* // ParameterName: "STRING_VALUE",
|
|
51
|
+
* // ParameterValue: "STRING_VALUE",
|
|
52
|
+
* // Description: "STRING_VALUE",
|
|
53
|
+
* // Source: "STRING_VALUE",
|
|
54
|
+
* // ApplyType: "STRING_VALUE",
|
|
55
|
+
* // DataType: "STRING_VALUE",
|
|
56
|
+
* // AllowedValues: "STRING_VALUE",
|
|
57
|
+
* // IsModifiable: true || false,
|
|
58
|
+
* // MinimumEngineVersion: "STRING_VALUE",
|
|
59
|
+
* // ApplyMethod: "immediate" || "pending-reboot",
|
|
60
|
+
* // SupportedEngineModes: [ // EngineModeList
|
|
61
|
+
* // "STRING_VALUE",
|
|
62
|
+
* // ],
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // },
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
44
68
|
* ```
|
|
45
69
|
*
|
|
46
70
|
* @param DescribeEngineDefaultParametersCommandInput - {@link DescribeEngineDefaultParametersCommandInput}
|
|
@@ -49,6 +73,8 @@ export interface DescribeEngineDefaultParametersCommandOutput extends DescribeEn
|
|
|
49
73
|
* @see {@link DescribeEngineDefaultParametersCommandOutput} for command's `response` shape.
|
|
50
74
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
51
75
|
*
|
|
76
|
+
* @throws {@link RDSServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
52
78
|
*
|
|
53
79
|
* @example To describe the default engine and system parameter information for the database engine
|
|
54
80
|
* ```javascript
|
|
@@ -45,6 +45,17 @@ export interface DescribeEventCategoriesCommandOutput extends EventCategoriesMes
|
|
|
45
45
|
* };
|
|
46
46
|
* const command = new DescribeEventCategoriesCommand(input);
|
|
47
47
|
* const response = await client.send(command);
|
|
48
|
+
* // { // EventCategoriesMessage
|
|
49
|
+
* // EventCategoriesMapList: [ // EventCategoriesMapList
|
|
50
|
+
* // { // EventCategoriesMap
|
|
51
|
+
* // SourceType: "STRING_VALUE",
|
|
52
|
+
* // EventCategories: [ // EventCategoriesList
|
|
53
|
+
* // "STRING_VALUE",
|
|
54
|
+
* // ],
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // };
|
|
58
|
+
*
|
|
48
59
|
* ```
|
|
49
60
|
*
|
|
50
61
|
* @param DescribeEventCategoriesCommandInput - {@link DescribeEventCategoriesCommandInput}
|
|
@@ -53,6 +64,8 @@ export interface DescribeEventCategoriesCommandOutput extends EventCategoriesMes
|
|
|
53
64
|
* @see {@link DescribeEventCategoriesCommandOutput} for command's `response` shape.
|
|
54
65
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
55
66
|
*
|
|
67
|
+
* @throws {@link RDSServiceException}
|
|
68
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
56
69
|
*
|
|
57
70
|
* @example To describe event categories
|
|
58
71
|
* ```javascript
|
|
@@ -43,6 +43,28 @@ export interface DescribeEventSubscriptionsCommandOutput extends EventSubscripti
|
|
|
43
43
|
* };
|
|
44
44
|
* const command = new DescribeEventSubscriptionsCommand(input);
|
|
45
45
|
* const response = await client.send(command);
|
|
46
|
+
* // { // EventSubscriptionsMessage
|
|
47
|
+
* // Marker: "STRING_VALUE",
|
|
48
|
+
* // EventSubscriptionsList: [ // EventSubscriptionsList
|
|
49
|
+
* // { // EventSubscription
|
|
50
|
+
* // CustomerAwsId: "STRING_VALUE",
|
|
51
|
+
* // CustSubscriptionId: "STRING_VALUE",
|
|
52
|
+
* // SnsTopicArn: "STRING_VALUE",
|
|
53
|
+
* // Status: "STRING_VALUE",
|
|
54
|
+
* // SubscriptionCreationTime: "STRING_VALUE",
|
|
55
|
+
* // SourceType: "STRING_VALUE",
|
|
56
|
+
* // SourceIdsList: [ // SourceIdsList
|
|
57
|
+
* // "STRING_VALUE",
|
|
58
|
+
* // ],
|
|
59
|
+
* // EventCategoriesList: [ // EventCategoriesList
|
|
60
|
+
* // "STRING_VALUE",
|
|
61
|
+
* // ],
|
|
62
|
+
* // Enabled: true || false,
|
|
63
|
+
* // EventSubscriptionArn: "STRING_VALUE",
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // };
|
|
67
|
+
*
|
|
46
68
|
* ```
|
|
47
69
|
*
|
|
48
70
|
* @param DescribeEventSubscriptionsCommandInput - {@link DescribeEventSubscriptionsCommandInput}
|
|
@@ -54,6 +76,8 @@ export interface DescribeEventSubscriptionsCommandOutput extends EventSubscripti
|
|
|
54
76
|
* @throws {@link SubscriptionNotFoundFault} (client fault)
|
|
55
77
|
* <p>The subscription name does not exist.</p>
|
|
56
78
|
*
|
|
79
|
+
* @throws {@link RDSServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
57
81
|
*
|
|
58
82
|
* @example To describe event subscriptions
|
|
59
83
|
* ```javascript
|
|
@@ -55,6 +55,22 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
|
|
|
55
55
|
* };
|
|
56
56
|
* const command = new DescribeEventsCommand(input);
|
|
57
57
|
* const response = await client.send(command);
|
|
58
|
+
* // { // EventsMessage
|
|
59
|
+
* // Marker: "STRING_VALUE",
|
|
60
|
+
* // Events: [ // EventList
|
|
61
|
+
* // { // Event
|
|
62
|
+
* // SourceIdentifier: "STRING_VALUE",
|
|
63
|
+
* // SourceType: "db-instance" || "db-parameter-group" || "db-security-group" || "db-snapshot" || "db-cluster" || "db-cluster-snapshot" || "custom-engine-version" || "db-proxy" || "blue-green-deployment",
|
|
64
|
+
* // Message: "STRING_VALUE",
|
|
65
|
+
* // EventCategories: [ // EventCategoriesList
|
|
66
|
+
* // "STRING_VALUE",
|
|
67
|
+
* // ],
|
|
68
|
+
* // Date: new Date("TIMESTAMP"),
|
|
69
|
+
* // SourceArn: "STRING_VALUE",
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // };
|
|
73
|
+
*
|
|
58
74
|
* ```
|
|
59
75
|
*
|
|
60
76
|
* @param DescribeEventsCommandInput - {@link DescribeEventsCommandInput}
|
|
@@ -63,6 +79,8 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
|
|
|
63
79
|
* @see {@link DescribeEventsCommandOutput} for command's `response` shape.
|
|
64
80
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
65
81
|
*
|
|
82
|
+
* @throws {@link RDSServiceException}
|
|
83
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
66
84
|
*
|
|
67
85
|
* @example To describe events
|
|
68
86
|
* ```javascript
|
|
@@ -44,6 +44,32 @@ export interface DescribeExportTasksCommandOutput extends ExportTasksMessage, __
|
|
|
44
44
|
* };
|
|
45
45
|
* const command = new DescribeExportTasksCommand(input);
|
|
46
46
|
* const response = await client.send(command);
|
|
47
|
+
* // { // ExportTasksMessage
|
|
48
|
+
* // Marker: "STRING_VALUE",
|
|
49
|
+
* // ExportTasks: [ // ExportTasksList
|
|
50
|
+
* // { // ExportTask
|
|
51
|
+
* // ExportTaskIdentifier: "STRING_VALUE",
|
|
52
|
+
* // SourceArn: "STRING_VALUE",
|
|
53
|
+
* // ExportOnly: [ // StringList
|
|
54
|
+
* // "STRING_VALUE",
|
|
55
|
+
* // ],
|
|
56
|
+
* // SnapshotTime: new Date("TIMESTAMP"),
|
|
57
|
+
* // TaskStartTime: new Date("TIMESTAMP"),
|
|
58
|
+
* // TaskEndTime: new Date("TIMESTAMP"),
|
|
59
|
+
* // S3Bucket: "STRING_VALUE",
|
|
60
|
+
* // S3Prefix: "STRING_VALUE",
|
|
61
|
+
* // IamRoleArn: "STRING_VALUE",
|
|
62
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
63
|
+
* // Status: "STRING_VALUE",
|
|
64
|
+
* // PercentProgress: Number("int"),
|
|
65
|
+
* // TotalExtractedDataInGB: Number("int"),
|
|
66
|
+
* // FailureCause: "STRING_VALUE",
|
|
67
|
+
* // WarningMessage: "STRING_VALUE",
|
|
68
|
+
* // SourceType: "SNAPSHOT" || "CLUSTER",
|
|
69
|
+
* // },
|
|
70
|
+
* // ],
|
|
71
|
+
* // };
|
|
72
|
+
*
|
|
47
73
|
* ```
|
|
48
74
|
*
|
|
49
75
|
* @param DescribeExportTasksCommandInput - {@link DescribeExportTasksCommandInput}
|
|
@@ -55,6 +81,8 @@ export interface DescribeExportTasksCommandOutput extends ExportTasksMessage, __
|
|
|
55
81
|
* @throws {@link ExportTaskNotFoundFault} (client fault)
|
|
56
82
|
* <p>The export task doesn't exist.</p>
|
|
57
83
|
*
|
|
84
|
+
* @throws {@link RDSServiceException}
|
|
85
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
58
86
|
*
|
|
59
87
|
* @example To describe snapshot export tasks
|
|
60
88
|
* ```javascript
|
|
@@ -46,6 +46,38 @@ export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessa
|
|
|
46
46
|
* };
|
|
47
47
|
* const command = new DescribeGlobalClustersCommand(input);
|
|
48
48
|
* const response = await client.send(command);
|
|
49
|
+
* // { // GlobalClustersMessage
|
|
50
|
+
* // Marker: "STRING_VALUE",
|
|
51
|
+
* // GlobalClusters: [ // GlobalClusterList
|
|
52
|
+
* // { // GlobalCluster
|
|
53
|
+
* // GlobalClusterIdentifier: "STRING_VALUE",
|
|
54
|
+
* // GlobalClusterResourceId: "STRING_VALUE",
|
|
55
|
+
* // GlobalClusterArn: "STRING_VALUE",
|
|
56
|
+
* // Status: "STRING_VALUE",
|
|
57
|
+
* // Engine: "STRING_VALUE",
|
|
58
|
+
* // EngineVersion: "STRING_VALUE",
|
|
59
|
+
* // DatabaseName: "STRING_VALUE",
|
|
60
|
+
* // StorageEncrypted: true || false,
|
|
61
|
+
* // DeletionProtection: true || false,
|
|
62
|
+
* // GlobalClusterMembers: [ // GlobalClusterMemberList
|
|
63
|
+
* // { // GlobalClusterMember
|
|
64
|
+
* // DBClusterArn: "STRING_VALUE",
|
|
65
|
+
* // Readers: [ // ReadersArnList
|
|
66
|
+
* // "STRING_VALUE",
|
|
67
|
+
* // ],
|
|
68
|
+
* // IsWriter: true || false,
|
|
69
|
+
* // GlobalWriteForwardingStatus: "enabled" || "disabled" || "enabling" || "disabling" || "unknown",
|
|
70
|
+
* // },
|
|
71
|
+
* // ],
|
|
72
|
+
* // FailoverState: { // FailoverState
|
|
73
|
+
* // Status: "pending" || "failing-over" || "cancelling",
|
|
74
|
+
* // FromDbClusterArn: "STRING_VALUE",
|
|
75
|
+
* // ToDbClusterArn: "STRING_VALUE",
|
|
76
|
+
* // },
|
|
77
|
+
* // },
|
|
78
|
+
* // ],
|
|
79
|
+
* // };
|
|
80
|
+
*
|
|
49
81
|
* ```
|
|
50
82
|
*
|
|
51
83
|
* @param DescribeGlobalClustersCommandInput - {@link DescribeGlobalClustersCommandInput}
|
|
@@ -57,6 +89,8 @@ export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessa
|
|
|
57
89
|
* @throws {@link GlobalClusterNotFoundFault} (client fault)
|
|
58
90
|
* <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global database cluster.</p>
|
|
59
91
|
*
|
|
92
|
+
* @throws {@link RDSServiceException}
|
|
93
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
60
94
|
*
|
|
61
95
|
* @example To describe global DB clusters
|
|
62
96
|
* ```javascript
|
|
@@ -42,6 +42,56 @@ export interface DescribeOptionGroupOptionsCommandOutput extends OptionGroupOpti
|
|
|
42
42
|
* };
|
|
43
43
|
* const command = new DescribeOptionGroupOptionsCommand(input);
|
|
44
44
|
* const response = await client.send(command);
|
|
45
|
+
* // { // OptionGroupOptionsMessage
|
|
46
|
+
* // OptionGroupOptions: [ // OptionGroupOptionsList
|
|
47
|
+
* // { // OptionGroupOption
|
|
48
|
+
* // Name: "STRING_VALUE",
|
|
49
|
+
* // Description: "STRING_VALUE",
|
|
50
|
+
* // EngineName: "STRING_VALUE",
|
|
51
|
+
* // MajorEngineVersion: "STRING_VALUE",
|
|
52
|
+
* // MinimumRequiredMinorEngineVersion: "STRING_VALUE",
|
|
53
|
+
* // PortRequired: true || false,
|
|
54
|
+
* // DefaultPort: Number("int"),
|
|
55
|
+
* // OptionsDependedOn: [ // OptionsDependedOn
|
|
56
|
+
* // "STRING_VALUE",
|
|
57
|
+
* // ],
|
|
58
|
+
* // OptionsConflictsWith: [ // OptionsConflictsWith
|
|
59
|
+
* // "STRING_VALUE",
|
|
60
|
+
* // ],
|
|
61
|
+
* // Persistent: true || false,
|
|
62
|
+
* // Permanent: true || false,
|
|
63
|
+
* // RequiresAutoMinorEngineVersionUpgrade: true || false,
|
|
64
|
+
* // VpcOnly: true || false,
|
|
65
|
+
* // SupportsOptionVersionDowngrade: true || false,
|
|
66
|
+
* // OptionGroupOptionSettings: [ // OptionGroupOptionSettingsList
|
|
67
|
+
* // { // OptionGroupOptionSetting
|
|
68
|
+
* // SettingName: "STRING_VALUE",
|
|
69
|
+
* // SettingDescription: "STRING_VALUE",
|
|
70
|
+
* // DefaultValue: "STRING_VALUE",
|
|
71
|
+
* // ApplyType: "STRING_VALUE",
|
|
72
|
+
* // AllowedValues: "STRING_VALUE",
|
|
73
|
+
* // IsModifiable: true || false,
|
|
74
|
+
* // IsRequired: true || false,
|
|
75
|
+
* // MinimumEngineVersionPerAllowedValue: [ // MinimumEngineVersionPerAllowedValueList
|
|
76
|
+
* // { // MinimumEngineVersionPerAllowedValue
|
|
77
|
+
* // AllowedValue: "STRING_VALUE",
|
|
78
|
+
* // MinimumEngineVersion: "STRING_VALUE",
|
|
79
|
+
* // },
|
|
80
|
+
* // ],
|
|
81
|
+
* // },
|
|
82
|
+
* // ],
|
|
83
|
+
* // OptionGroupOptionVersions: [ // OptionGroupOptionVersionsList
|
|
84
|
+
* // { // OptionVersion
|
|
85
|
+
* // Version: "STRING_VALUE",
|
|
86
|
+
* // IsDefault: true || false,
|
|
87
|
+
* // },
|
|
88
|
+
* // ],
|
|
89
|
+
* // CopyableCrossAccount: true || false,
|
|
90
|
+
* // },
|
|
91
|
+
* // ],
|
|
92
|
+
* // Marker: "STRING_VALUE",
|
|
93
|
+
* // };
|
|
94
|
+
*
|
|
45
95
|
* ```
|
|
46
96
|
*
|
|
47
97
|
* @param DescribeOptionGroupOptionsCommandInput - {@link DescribeOptionGroupOptionsCommandInput}
|
|
@@ -50,6 +100,8 @@ export interface DescribeOptionGroupOptionsCommandOutput extends OptionGroupOpti
|
|
|
50
100
|
* @see {@link DescribeOptionGroupOptionsCommandOutput} for command's `response` shape.
|
|
51
101
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
52
102
|
*
|
|
103
|
+
* @throws {@link RDSServiceException}
|
|
104
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
53
105
|
*
|
|
54
106
|
* @example To describe all available options
|
|
55
107
|
* ```javascript
|
|
@@ -43,6 +43,59 @@ export interface DescribeOptionGroupsCommandOutput extends OptionGroups, __Metad
|
|
|
43
43
|
* };
|
|
44
44
|
* const command = new DescribeOptionGroupsCommand(input);
|
|
45
45
|
* const response = await client.send(command);
|
|
46
|
+
* // { // OptionGroups
|
|
47
|
+
* // OptionGroupsList: [ // OptionGroupsList
|
|
48
|
+
* // { // OptionGroup
|
|
49
|
+
* // OptionGroupName: "STRING_VALUE",
|
|
50
|
+
* // OptionGroupDescription: "STRING_VALUE",
|
|
51
|
+
* // EngineName: "STRING_VALUE",
|
|
52
|
+
* // MajorEngineVersion: "STRING_VALUE",
|
|
53
|
+
* // Options: [ // OptionsList
|
|
54
|
+
* // { // Option
|
|
55
|
+
* // OptionName: "STRING_VALUE",
|
|
56
|
+
* // OptionDescription: "STRING_VALUE",
|
|
57
|
+
* // Persistent: true || false,
|
|
58
|
+
* // Permanent: true || false,
|
|
59
|
+
* // Port: Number("int"),
|
|
60
|
+
* // OptionVersion: "STRING_VALUE",
|
|
61
|
+
* // OptionSettings: [ // OptionSettingConfigurationList
|
|
62
|
+
* // { // OptionSetting
|
|
63
|
+
* // Name: "STRING_VALUE",
|
|
64
|
+
* // Value: "STRING_VALUE",
|
|
65
|
+
* // DefaultValue: "STRING_VALUE",
|
|
66
|
+
* // Description: "STRING_VALUE",
|
|
67
|
+
* // ApplyType: "STRING_VALUE",
|
|
68
|
+
* // DataType: "STRING_VALUE",
|
|
69
|
+
* // AllowedValues: "STRING_VALUE",
|
|
70
|
+
* // IsModifiable: true || false,
|
|
71
|
+
* // IsCollection: true || false,
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // DBSecurityGroupMemberships: [ // DBSecurityGroupMembershipList
|
|
75
|
+
* // { // DBSecurityGroupMembership
|
|
76
|
+
* // DBSecurityGroupName: "STRING_VALUE",
|
|
77
|
+
* // Status: "STRING_VALUE",
|
|
78
|
+
* // },
|
|
79
|
+
* // ],
|
|
80
|
+
* // VpcSecurityGroupMemberships: [ // VpcSecurityGroupMembershipList
|
|
81
|
+
* // { // VpcSecurityGroupMembership
|
|
82
|
+
* // VpcSecurityGroupId: "STRING_VALUE",
|
|
83
|
+
* // Status: "STRING_VALUE",
|
|
84
|
+
* // },
|
|
85
|
+
* // ],
|
|
86
|
+
* // },
|
|
87
|
+
* // ],
|
|
88
|
+
* // AllowsVpcAndNonVpcInstanceMemberships: true || false,
|
|
89
|
+
* // VpcId: "STRING_VALUE",
|
|
90
|
+
* // OptionGroupArn: "STRING_VALUE",
|
|
91
|
+
* // SourceOptionGroup: "STRING_VALUE",
|
|
92
|
+
* // SourceAccountId: "STRING_VALUE",
|
|
93
|
+
* // CopyTimestamp: new Date("TIMESTAMP"),
|
|
94
|
+
* // },
|
|
95
|
+
* // ],
|
|
96
|
+
* // Marker: "STRING_VALUE",
|
|
97
|
+
* // };
|
|
98
|
+
*
|
|
46
99
|
* ```
|
|
47
100
|
*
|
|
48
101
|
* @param DescribeOptionGroupsCommandInput - {@link DescribeOptionGroupsCommandInput}
|
|
@@ -54,6 +107,8 @@ export interface DescribeOptionGroupsCommandOutput extends OptionGroups, __Metad
|
|
|
54
107
|
* @throws {@link OptionGroupNotFoundFault} (client fault)
|
|
55
108
|
* <p>The specified option group could not be found.</p>
|
|
56
109
|
*
|
|
110
|
+
* @throws {@link RDSServiceException}
|
|
111
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
57
112
|
*
|
|
58
113
|
* @example To describe the available option groups
|
|
59
114
|
* ```javascript
|
|
@@ -46,6 +46,65 @@ export interface DescribeOrderableDBInstanceOptionsCommandOutput extends Orderab
|
|
|
46
46
|
* };
|
|
47
47
|
* const command = new DescribeOrderableDBInstanceOptionsCommand(input);
|
|
48
48
|
* const response = await client.send(command);
|
|
49
|
+
* // { // OrderableDBInstanceOptionsMessage
|
|
50
|
+
* // OrderableDBInstanceOptions: [ // OrderableDBInstanceOptionsList
|
|
51
|
+
* // { // OrderableDBInstanceOption
|
|
52
|
+
* // Engine: "STRING_VALUE",
|
|
53
|
+
* // EngineVersion: "STRING_VALUE",
|
|
54
|
+
* // DBInstanceClass: "STRING_VALUE",
|
|
55
|
+
* // LicenseModel: "STRING_VALUE",
|
|
56
|
+
* // AvailabilityZoneGroup: "STRING_VALUE",
|
|
57
|
+
* // AvailabilityZones: [ // AvailabilityZoneList
|
|
58
|
+
* // { // AvailabilityZone
|
|
59
|
+
* // Name: "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // ],
|
|
62
|
+
* // MultiAZCapable: true || false,
|
|
63
|
+
* // ReadReplicaCapable: true || false,
|
|
64
|
+
* // Vpc: true || false,
|
|
65
|
+
* // SupportsStorageEncryption: true || false,
|
|
66
|
+
* // StorageType: "STRING_VALUE",
|
|
67
|
+
* // SupportsIops: true || false,
|
|
68
|
+
* // SupportsEnhancedMonitoring: true || false,
|
|
69
|
+
* // SupportsIAMDatabaseAuthentication: true || false,
|
|
70
|
+
* // SupportsPerformanceInsights: true || false,
|
|
71
|
+
* // MinStorageSize: Number("int"),
|
|
72
|
+
* // MaxStorageSize: Number("int"),
|
|
73
|
+
* // MinIopsPerDbInstance: Number("int"),
|
|
74
|
+
* // MaxIopsPerDbInstance: Number("int"),
|
|
75
|
+
* // MinIopsPerGib: Number("double"),
|
|
76
|
+
* // MaxIopsPerGib: Number("double"),
|
|
77
|
+
* // AvailableProcessorFeatures: [ // AvailableProcessorFeatureList
|
|
78
|
+
* // { // AvailableProcessorFeature
|
|
79
|
+
* // Name: "STRING_VALUE",
|
|
80
|
+
* // DefaultValue: "STRING_VALUE",
|
|
81
|
+
* // AllowedValues: "STRING_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // ],
|
|
84
|
+
* // SupportedEngineModes: [ // EngineModeList
|
|
85
|
+
* // "STRING_VALUE",
|
|
86
|
+
* // ],
|
|
87
|
+
* // SupportsStorageAutoscaling: true || false,
|
|
88
|
+
* // SupportsKerberosAuthentication: true || false,
|
|
89
|
+
* // OutpostCapable: true || false,
|
|
90
|
+
* // SupportedActivityStreamModes: [ // ActivityStreamModeList
|
|
91
|
+
* // "STRING_VALUE",
|
|
92
|
+
* // ],
|
|
93
|
+
* // SupportsGlobalDatabases: true || false,
|
|
94
|
+
* // SupportsClusters: true || false,
|
|
95
|
+
* // SupportedNetworkTypes: [ // StringList
|
|
96
|
+
* // "STRING_VALUE",
|
|
97
|
+
* // ],
|
|
98
|
+
* // SupportsStorageThroughput: true || false,
|
|
99
|
+
* // MinStorageThroughputPerDbInstance: Number("int"),
|
|
100
|
+
* // MaxStorageThroughputPerDbInstance: Number("int"),
|
|
101
|
+
* // MinStorageThroughputPerIops: Number("double"),
|
|
102
|
+
* // MaxStorageThroughputPerIops: Number("double"),
|
|
103
|
+
* // },
|
|
104
|
+
* // ],
|
|
105
|
+
* // Marker: "STRING_VALUE",
|
|
106
|
+
* // };
|
|
107
|
+
*
|
|
49
108
|
* ```
|
|
50
109
|
*
|
|
51
110
|
* @param DescribeOrderableDBInstanceOptionsCommandInput - {@link DescribeOrderableDBInstanceOptionsCommandInput}
|
|
@@ -54,6 +113,8 @@ export interface DescribeOrderableDBInstanceOptionsCommandOutput extends Orderab
|
|
|
54
113
|
* @see {@link DescribeOrderableDBInstanceOptionsCommandOutput} for command's `response` shape.
|
|
55
114
|
* @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape.
|
|
56
115
|
*
|
|
116
|
+
* @throws {@link RDSServiceException}
|
|
117
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
57
118
|
*
|
|
58
119
|
* @example To describe orderable DB instance options
|
|
59
120
|
* ```javascript
|
|
@@ -41,6 +41,25 @@ export interface DescribePendingMaintenanceActionsCommandOutput extends PendingM
|
|
|
41
41
|
* };
|
|
42
42
|
* const command = new DescribePendingMaintenanceActionsCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
|
+
* // { // PendingMaintenanceActionsMessage
|
|
45
|
+
* // PendingMaintenanceActions: [ // PendingMaintenanceActions
|
|
46
|
+
* // { // ResourcePendingMaintenanceActions
|
|
47
|
+
* // ResourceIdentifier: "STRING_VALUE",
|
|
48
|
+
* // PendingMaintenanceActionDetails: [ // PendingMaintenanceActionDetails
|
|
49
|
+
* // { // PendingMaintenanceAction
|
|
50
|
+
* // Action: "STRING_VALUE",
|
|
51
|
+
* // AutoAppliedAfterDate: new Date("TIMESTAMP"),
|
|
52
|
+
* // ForcedApplyDate: new Date("TIMESTAMP"),
|
|
53
|
+
* // OptInStatus: "STRING_VALUE",
|
|
54
|
+
* // CurrentApplyDate: new Date("TIMESTAMP"),
|
|
55
|
+
* // Description: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // ],
|
|
58
|
+
* // },
|
|
59
|
+
* // ],
|
|
60
|
+
* // Marker: "STRING_VALUE",
|
|
61
|
+
* // };
|
|
62
|
+
*
|
|
44
63
|
* ```
|
|
45
64
|
*
|
|
46
65
|
* @param DescribePendingMaintenanceActionsCommandInput - {@link DescribePendingMaintenanceActionsCommandInput}
|
|
@@ -52,6 +71,8 @@ export interface DescribePendingMaintenanceActionsCommandOutput extends PendingM
|
|
|
52
71
|
* @throws {@link ResourceNotFoundFault} (client fault)
|
|
53
72
|
* <p>The specified resource ID was not found.</p>
|
|
54
73
|
*
|
|
74
|
+
* @throws {@link RDSServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
55
76
|
*
|
|
56
77
|
* @example To list resources with at least one pending maintenance action
|
|
57
78
|
* ```javascript
|
|
@@ -48,6 +48,35 @@ export interface DescribeReservedDBInstancesCommandOutput extends ReservedDBInst
|
|
|
48
48
|
* };
|
|
49
49
|
* const command = new DescribeReservedDBInstancesCommand(input);
|
|
50
50
|
* const response = await client.send(command);
|
|
51
|
+
* // { // ReservedDBInstanceMessage
|
|
52
|
+
* // Marker: "STRING_VALUE",
|
|
53
|
+
* // ReservedDBInstances: [ // ReservedDBInstanceList
|
|
54
|
+
* // { // ReservedDBInstance
|
|
55
|
+
* // ReservedDBInstanceId: "STRING_VALUE",
|
|
56
|
+
* // ReservedDBInstancesOfferingId: "STRING_VALUE",
|
|
57
|
+
* // DBInstanceClass: "STRING_VALUE",
|
|
58
|
+
* // StartTime: new Date("TIMESTAMP"),
|
|
59
|
+
* // Duration: Number("int"),
|
|
60
|
+
* // FixedPrice: Number("double"),
|
|
61
|
+
* // UsagePrice: Number("double"),
|
|
62
|
+
* // CurrencyCode: "STRING_VALUE",
|
|
63
|
+
* // DBInstanceCount: Number("int"),
|
|
64
|
+
* // ProductDescription: "STRING_VALUE",
|
|
65
|
+
* // OfferingType: "STRING_VALUE",
|
|
66
|
+
* // MultiAZ: true || false,
|
|
67
|
+
* // State: "STRING_VALUE",
|
|
68
|
+
* // RecurringCharges: [ // RecurringChargeList
|
|
69
|
+
* // { // RecurringCharge
|
|
70
|
+
* // RecurringChargeAmount: Number("double"),
|
|
71
|
+
* // RecurringChargeFrequency: "STRING_VALUE",
|
|
72
|
+
* // },
|
|
73
|
+
* // ],
|
|
74
|
+
* // ReservedDBInstanceArn: "STRING_VALUE",
|
|
75
|
+
* // LeaseId: "STRING_VALUE",
|
|
76
|
+
* // },
|
|
77
|
+
* // ],
|
|
78
|
+
* // };
|
|
79
|
+
*
|
|
51
80
|
* ```
|
|
52
81
|
*
|
|
53
82
|
* @param DescribeReservedDBInstancesCommandInput - {@link DescribeReservedDBInstancesCommandInput}
|
|
@@ -59,6 +88,8 @@ export interface DescribeReservedDBInstancesCommandOutput extends ReservedDBInst
|
|
|
59
88
|
* @throws {@link ReservedDBInstanceNotFoundFault} (client fault)
|
|
60
89
|
* <p>The specified reserved DB Instance not found.</p>
|
|
61
90
|
*
|
|
91
|
+
* @throws {@link RDSServiceException}
|
|
92
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
62
93
|
*
|
|
63
94
|
* @example To describe reserved DB instances
|
|
64
95
|
* ```javascript
|
|
@@ -46,6 +46,29 @@ export interface DescribeReservedDBInstancesOfferingsCommandOutput extends Reser
|
|
|
46
46
|
* };
|
|
47
47
|
* const command = new DescribeReservedDBInstancesOfferingsCommand(input);
|
|
48
48
|
* const response = await client.send(command);
|
|
49
|
+
* // { // ReservedDBInstancesOfferingMessage
|
|
50
|
+
* // Marker: "STRING_VALUE",
|
|
51
|
+
* // ReservedDBInstancesOfferings: [ // ReservedDBInstancesOfferingList
|
|
52
|
+
* // { // ReservedDBInstancesOffering
|
|
53
|
+
* // ReservedDBInstancesOfferingId: "STRING_VALUE",
|
|
54
|
+
* // DBInstanceClass: "STRING_VALUE",
|
|
55
|
+
* // Duration: Number("int"),
|
|
56
|
+
* // FixedPrice: Number("double"),
|
|
57
|
+
* // UsagePrice: Number("double"),
|
|
58
|
+
* // CurrencyCode: "STRING_VALUE",
|
|
59
|
+
* // ProductDescription: "STRING_VALUE",
|
|
60
|
+
* // OfferingType: "STRING_VALUE",
|
|
61
|
+
* // MultiAZ: true || false,
|
|
62
|
+
* // RecurringCharges: [ // RecurringChargeList
|
|
63
|
+
* // { // RecurringCharge
|
|
64
|
+
* // RecurringChargeAmount: Number("double"),
|
|
65
|
+
* // RecurringChargeFrequency: "STRING_VALUE",
|
|
66
|
+
* // },
|
|
67
|
+
* // ],
|
|
68
|
+
* // },
|
|
69
|
+
* // ],
|
|
70
|
+
* // };
|
|
71
|
+
*
|
|
49
72
|
* ```
|
|
50
73
|
*
|
|
51
74
|
* @param DescribeReservedDBInstancesOfferingsCommandInput - {@link DescribeReservedDBInstancesOfferingsCommandInput}
|
|
@@ -57,6 +80,8 @@ export interface DescribeReservedDBInstancesOfferingsCommandOutput extends Reser
|
|
|
57
80
|
* @throws {@link ReservedDBInstancesOfferingNotFoundFault} (client fault)
|
|
58
81
|
* <p>Specified offering does not exist.</p>
|
|
59
82
|
*
|
|
83
|
+
* @throws {@link RDSServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from RDS service.</p>
|
|
60
85
|
*
|
|
61
86
|
* @example To describe reserved DB instance offerings
|
|
62
87
|
* ```javascript
|