@aws-sdk/client-docdb 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 (54) hide show
  1. package/dist-types/commands/AddSourceIdentifierToSubscriptionCommand.d.ts +21 -0
  2. package/dist-types/commands/AddTagsToResourceCommand.d.ts +4 -0
  3. package/dist-types/commands/ApplyPendingMaintenanceActionCommand.d.ts +18 -0
  4. package/dist-types/commands/CopyDBClusterParameterGroupCommand.d.ts +11 -0
  5. package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +26 -0
  6. package/dist-types/commands/CreateDBClusterCommand.d.ts +62 -0
  7. package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +11 -0
  8. package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +26 -0
  9. package/dist-types/commands/CreateDBInstanceCommand.d.ts +89 -0
  10. package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +21 -0
  11. package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +21 -0
  12. package/dist-types/commands/CreateGlobalClusterCommand.d.ts +25 -0
  13. package/dist-types/commands/DeleteDBClusterCommand.d.ts +62 -0
  14. package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +4 -0
  15. package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +26 -0
  16. package/dist-types/commands/DeleteDBInstanceCommand.d.ts +89 -0
  17. package/dist-types/commands/DeleteDBSubnetGroupCommand.d.ts +4 -0
  18. package/dist-types/commands/DeleteEventSubscriptionCommand.d.ts +21 -0
  19. package/dist-types/commands/DeleteGlobalClusterCommand.d.ts +25 -0
  20. package/dist-types/commands/DescribeCertificatesCommand.d.ts +16 -0
  21. package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +14 -0
  22. package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +20 -0
  23. package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +16 -0
  24. package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +29 -0
  25. package/dist-types/commands/DescribeDBClustersCommand.d.ts +65 -0
  26. package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +28 -0
  27. package/dist-types/commands/DescribeDBInstancesCommand.d.ts +92 -0
  28. package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +24 -0
  29. package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +23 -0
  30. package/dist-types/commands/DescribeEventCategoriesCommand.d.ts +13 -0
  31. package/dist-types/commands/DescribeEventSubscriptionsCommand.d.ts +24 -0
  32. package/dist-types/commands/DescribeEventsCommand.d.ts +18 -0
  33. package/dist-types/commands/DescribeGlobalClustersCommand.d.ts +28 -0
  34. package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +20 -0
  35. package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +21 -0
  36. package/dist-types/commands/FailoverDBClusterCommand.d.ts +62 -0
  37. package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
  38. package/dist-types/commands/ModifyDBClusterCommand.d.ts +62 -0
  39. package/dist-types/commands/ModifyDBClusterParameterGroupCommand.d.ts +6 -0
  40. package/dist-types/commands/ModifyDBClusterSnapshotAttributeCommand.d.ts +16 -0
  41. package/dist-types/commands/ModifyDBInstanceCommand.d.ts +89 -0
  42. package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +21 -0
  43. package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +21 -0
  44. package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +25 -0
  45. package/dist-types/commands/RebootDBInstanceCommand.d.ts +89 -0
  46. package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +25 -0
  47. package/dist-types/commands/RemoveSourceIdentifierFromSubscriptionCommand.d.ts +21 -0
  48. package/dist-types/commands/RemoveTagsFromResourceCommand.d.ts +4 -0
  49. package/dist-types/commands/ResetDBClusterParameterGroupCommand.d.ts +6 -0
  50. package/dist-types/commands/RestoreDBClusterFromSnapshotCommand.d.ts +62 -0
  51. package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +62 -0
  52. package/dist-types/commands/StartDBClusterCommand.d.ts +62 -0
  53. package/dist-types/commands/StopDBClusterCommand.d.ts +62 -0
  54. package/package.json +17 -17
@@ -42,6 +42,27 @@ export interface DescribeEngineDefaultClusterParametersCommandOutput extends Des
42
42
  * };
43
43
  * const command = new DescribeEngineDefaultClusterParametersCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // DescribeEngineDefaultClusterParametersResult
46
+ * // EngineDefaults: { // EngineDefaults
47
+ * // DBParameterGroupFamily: "STRING_VALUE",
48
+ * // Marker: "STRING_VALUE",
49
+ * // Parameters: [ // ParametersList
50
+ * // { // Parameter
51
+ * // ParameterName: "STRING_VALUE",
52
+ * // ParameterValue: "STRING_VALUE",
53
+ * // Description: "STRING_VALUE",
54
+ * // Source: "STRING_VALUE",
55
+ * // ApplyType: "STRING_VALUE",
56
+ * // DataType: "STRING_VALUE",
57
+ * // AllowedValues: "STRING_VALUE",
58
+ * // IsModifiable: true || false,
59
+ * // MinimumEngineVersion: "STRING_VALUE",
60
+ * // ApplyMethod: "immediate" || "pending-reboot",
61
+ * // },
62
+ * // ],
63
+ * // },
64
+ * // };
65
+ *
45
66
  * ```
46
67
  *
47
68
  * @param DescribeEngineDefaultClusterParametersCommandInput - {@link DescribeEngineDefaultClusterParametersCommandInput}
@@ -50,6 +71,8 @@ export interface DescribeEngineDefaultClusterParametersCommandOutput extends Des
50
71
  * @see {@link DescribeEngineDefaultClusterParametersCommandOutput} for command's `response` shape.
51
72
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
52
73
  *
74
+ * @throws {@link DocDBServiceException}
75
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
53
76
  *
54
77
  */
55
78
  export declare class DescribeEngineDefaultClusterParametersCommand extends $Command<DescribeEngineDefaultClusterParametersCommandInput, DescribeEngineDefaultClusterParametersCommandOutput, DocDBClientResolvedConfig> {
@@ -40,6 +40,17 @@ export interface DescribeEventCategoriesCommandOutput extends EventCategoriesMes
40
40
  * };
41
41
  * const command = new DescribeEventCategoriesCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // { // EventCategoriesMessage
44
+ * // EventCategoriesMapList: [ // EventCategoriesMapList
45
+ * // { // EventCategoriesMap
46
+ * // SourceType: "STRING_VALUE",
47
+ * // EventCategories: [ // EventCategoriesList
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // },
51
+ * // ],
52
+ * // };
53
+ *
43
54
  * ```
44
55
  *
45
56
  * @param DescribeEventCategoriesCommandInput - {@link DescribeEventCategoriesCommandInput}
@@ -48,6 +59,8 @@ export interface DescribeEventCategoriesCommandOutput extends EventCategoriesMes
48
59
  * @see {@link DescribeEventCategoriesCommandOutput} for command's `response` shape.
49
60
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
50
61
  *
62
+ * @throws {@link DocDBServiceException}
63
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
51
64
  *
52
65
  */
53
66
  export declare class DescribeEventCategoriesCommand extends $Command<DescribeEventCategoriesCommandInput, DescribeEventCategoriesCommandOutput, DocDBClientResolvedConfig> {
@@ -42,6 +42,28 @@ export interface DescribeEventSubscriptionsCommandOutput extends EventSubscripti
42
42
  * };
43
43
  * const command = new DescribeEventSubscriptionsCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // EventSubscriptionsMessage
46
+ * // Marker: "STRING_VALUE",
47
+ * // EventSubscriptionsList: [ // EventSubscriptionsList
48
+ * // { // EventSubscription
49
+ * // CustomerAwsId: "STRING_VALUE",
50
+ * // CustSubscriptionId: "STRING_VALUE",
51
+ * // SnsTopicArn: "STRING_VALUE",
52
+ * // Status: "STRING_VALUE",
53
+ * // SubscriptionCreationTime: "STRING_VALUE",
54
+ * // SourceType: "STRING_VALUE",
55
+ * // SourceIdsList: [ // SourceIdsList
56
+ * // "STRING_VALUE",
57
+ * // ],
58
+ * // EventCategoriesList: [ // EventCategoriesList
59
+ * // "STRING_VALUE",
60
+ * // ],
61
+ * // Enabled: true || false,
62
+ * // EventSubscriptionArn: "STRING_VALUE",
63
+ * // },
64
+ * // ],
65
+ * // };
66
+ *
45
67
  * ```
46
68
  *
47
69
  * @param DescribeEventSubscriptionsCommandInput - {@link DescribeEventSubscriptionsCommandInput}
@@ -53,6 +75,8 @@ export interface DescribeEventSubscriptionsCommandOutput extends EventSubscripti
53
75
  * @throws {@link SubscriptionNotFoundFault} (client fault)
54
76
  * <p>The subscription name does not exist. </p>
55
77
  *
78
+ * @throws {@link DocDBServiceException}
79
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
56
80
  *
57
81
  */
58
82
  export declare class DescribeEventSubscriptionsCommand extends $Command<DescribeEventSubscriptionsCommandInput, DescribeEventSubscriptionsCommandOutput, DocDBClientResolvedConfig> {
@@ -48,6 +48,22 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
48
48
  * };
49
49
  * const command = new DescribeEventsCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // EventsMessage
52
+ * // Marker: "STRING_VALUE",
53
+ * // Events: [ // EventList
54
+ * // { // Event
55
+ * // SourceIdentifier: "STRING_VALUE",
56
+ * // SourceType: "db-instance" || "db-parameter-group" || "db-security-group" || "db-snapshot" || "db-cluster" || "db-cluster-snapshot",
57
+ * // Message: "STRING_VALUE",
58
+ * // EventCategories: [ // EventCategoriesList
59
+ * // "STRING_VALUE",
60
+ * // ],
61
+ * // Date: new Date("TIMESTAMP"),
62
+ * // SourceArn: "STRING_VALUE",
63
+ * // },
64
+ * // ],
65
+ * // };
66
+ *
51
67
  * ```
52
68
  *
53
69
  * @param DescribeEventsCommandInput - {@link DescribeEventsCommandInput}
@@ -56,6 +72,8 @@ export interface DescribeEventsCommandOutput extends EventsMessage, __MetadataBe
56
72
  * @see {@link DescribeEventsCommandOutput} for command's `response` shape.
57
73
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
58
74
  *
75
+ * @throws {@link DocDBServiceException}
76
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
59
77
  *
60
78
  */
61
79
  export declare class DescribeEventsCommand extends $Command<DescribeEventsCommandInput, DescribeEventsCommandOutput, DocDBClientResolvedConfig> {
@@ -44,6 +44,32 @@ export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessa
44
44
  * };
45
45
  * const command = new DescribeGlobalClustersCommand(input);
46
46
  * const response = await client.send(command);
47
+ * // { // GlobalClustersMessage
48
+ * // Marker: "STRING_VALUE",
49
+ * // GlobalClusters: [ // GlobalClusterList
50
+ * // { // GlobalCluster
51
+ * // GlobalClusterIdentifier: "STRING_VALUE",
52
+ * // GlobalClusterResourceId: "STRING_VALUE",
53
+ * // GlobalClusterArn: "STRING_VALUE",
54
+ * // Status: "STRING_VALUE",
55
+ * // Engine: "STRING_VALUE",
56
+ * // EngineVersion: "STRING_VALUE",
57
+ * // DatabaseName: "STRING_VALUE",
58
+ * // StorageEncrypted: true || false,
59
+ * // DeletionProtection: true || false,
60
+ * // GlobalClusterMembers: [ // GlobalClusterMemberList
61
+ * // { // GlobalClusterMember
62
+ * // DBClusterArn: "STRING_VALUE",
63
+ * // Readers: [ // ReadersArnList
64
+ * // "STRING_VALUE",
65
+ * // ],
66
+ * // IsWriter: true || false,
67
+ * // },
68
+ * // ],
69
+ * // },
70
+ * // ],
71
+ * // };
72
+ *
47
73
  * ```
48
74
  *
49
75
  * @param DescribeGlobalClustersCommandInput - {@link DescribeGlobalClustersCommandInput}
@@ -55,6 +81,8 @@ export interface DescribeGlobalClustersCommandOutput extends GlobalClustersMessa
55
81
  * @throws {@link GlobalClusterNotFoundFault} (client fault)
56
82
  * <p>The <code>GlobalClusterIdentifier</code> doesn't refer to an existing global cluster.</p>
57
83
  *
84
+ * @throws {@link DocDBServiceException}
85
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
58
86
  *
59
87
  */
60
88
  export declare class DescribeGlobalClustersCommand extends $Command<DescribeGlobalClustersCommandInput, DescribeGlobalClustersCommandOutput, DocDBClientResolvedConfig> {
@@ -45,6 +45,24 @@ export interface DescribeOrderableDBInstanceOptionsCommandOutput extends Orderab
45
45
  * };
46
46
  * const command = new DescribeOrderableDBInstanceOptionsCommand(input);
47
47
  * const response = await client.send(command);
48
+ * // { // OrderableDBInstanceOptionsMessage
49
+ * // OrderableDBInstanceOptions: [ // OrderableDBInstanceOptionsList
50
+ * // { // OrderableDBInstanceOption
51
+ * // Engine: "STRING_VALUE",
52
+ * // EngineVersion: "STRING_VALUE",
53
+ * // DBInstanceClass: "STRING_VALUE",
54
+ * // LicenseModel: "STRING_VALUE",
55
+ * // AvailabilityZones: [ // AvailabilityZoneList
56
+ * // { // AvailabilityZone
57
+ * // Name: "STRING_VALUE",
58
+ * // },
59
+ * // ],
60
+ * // Vpc: true || false,
61
+ * // },
62
+ * // ],
63
+ * // Marker: "STRING_VALUE",
64
+ * // };
65
+ *
48
66
  * ```
49
67
  *
50
68
  * @param DescribeOrderableDBInstanceOptionsCommandInput - {@link DescribeOrderableDBInstanceOptionsCommandInput}
@@ -53,6 +71,8 @@ export interface DescribeOrderableDBInstanceOptionsCommandOutput extends Orderab
53
71
  * @see {@link DescribeOrderableDBInstanceOptionsCommandOutput} for command's `response` shape.
54
72
  * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
55
73
  *
74
+ * @throws {@link DocDBServiceException}
75
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
56
76
  *
57
77
  */
58
78
  export declare class DescribeOrderableDBInstanceOptionsCommand extends $Command<DescribeOrderableDBInstanceOptionsCommandInput, DescribeOrderableDBInstanceOptionsCommandOutput, DocDBClientResolvedConfig> {
@@ -42,6 +42,25 @@ export interface DescribePendingMaintenanceActionsCommandOutput extends PendingM
42
42
  * };
43
43
  * const command = new DescribePendingMaintenanceActionsCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // PendingMaintenanceActionsMessage
46
+ * // PendingMaintenanceActions: [ // PendingMaintenanceActions
47
+ * // { // ResourcePendingMaintenanceActions
48
+ * // ResourceIdentifier: "STRING_VALUE",
49
+ * // PendingMaintenanceActionDetails: [ // PendingMaintenanceActionDetails
50
+ * // { // PendingMaintenanceAction
51
+ * // Action: "STRING_VALUE",
52
+ * // AutoAppliedAfterDate: new Date("TIMESTAMP"),
53
+ * // ForcedApplyDate: new Date("TIMESTAMP"),
54
+ * // OptInStatus: "STRING_VALUE",
55
+ * // CurrentApplyDate: new Date("TIMESTAMP"),
56
+ * // Description: "STRING_VALUE",
57
+ * // },
58
+ * // ],
59
+ * // },
60
+ * // ],
61
+ * // Marker: "STRING_VALUE",
62
+ * // };
63
+ *
45
64
  * ```
46
65
  *
47
66
  * @param DescribePendingMaintenanceActionsCommandInput - {@link DescribePendingMaintenanceActionsCommandInput}
@@ -53,6 +72,8 @@ export interface DescribePendingMaintenanceActionsCommandOutput extends PendingM
53
72
  * @throws {@link ResourceNotFoundFault} (client fault)
54
73
  * <p>The specified resource ID was not found.</p>
55
74
  *
75
+ * @throws {@link DocDBServiceException}
76
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
56
77
  *
57
78
  */
58
79
  export declare class DescribePendingMaintenanceActionsCommand extends $Command<DescribePendingMaintenanceActionsCommandInput, DescribePendingMaintenanceActionsCommandOutput, DocDBClientResolvedConfig> {
@@ -34,6 +34,66 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
34
34
  * };
35
35
  * const command = new FailoverDBClusterCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // FailoverDBClusterResult
38
+ * // DBCluster: { // DBCluster
39
+ * // AvailabilityZones: [ // AvailabilityZones
40
+ * // "STRING_VALUE",
41
+ * // ],
42
+ * // BackupRetentionPeriod: Number("int"),
43
+ * // DBClusterIdentifier: "STRING_VALUE",
44
+ * // DBClusterParameterGroup: "STRING_VALUE",
45
+ * // DBSubnetGroup: "STRING_VALUE",
46
+ * // Status: "STRING_VALUE",
47
+ * // PercentProgress: "STRING_VALUE",
48
+ * // EarliestRestorableTime: new Date("TIMESTAMP"),
49
+ * // Endpoint: "STRING_VALUE",
50
+ * // ReaderEndpoint: "STRING_VALUE",
51
+ * // MultiAZ: true || false,
52
+ * // Engine: "STRING_VALUE",
53
+ * // EngineVersion: "STRING_VALUE",
54
+ * // LatestRestorableTime: new Date("TIMESTAMP"),
55
+ * // Port: Number("int"),
56
+ * // MasterUsername: "STRING_VALUE",
57
+ * // PreferredBackupWindow: "STRING_VALUE",
58
+ * // PreferredMaintenanceWindow: "STRING_VALUE",
59
+ * // ReplicationSourceIdentifier: "STRING_VALUE",
60
+ * // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
61
+ * // "STRING_VALUE",
62
+ * // ],
63
+ * // DBClusterMembers: [ // DBClusterMemberList
64
+ * // { // DBClusterMember
65
+ * // DBInstanceIdentifier: "STRING_VALUE",
66
+ * // IsClusterWriter: true || false,
67
+ * // DBClusterParameterGroupStatus: "STRING_VALUE",
68
+ * // PromotionTier: Number("int"),
69
+ * // },
70
+ * // ],
71
+ * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
72
+ * // { // VpcSecurityGroupMembership
73
+ * // VpcSecurityGroupId: "STRING_VALUE",
74
+ * // Status: "STRING_VALUE",
75
+ * // },
76
+ * // ],
77
+ * // HostedZoneId: "STRING_VALUE",
78
+ * // StorageEncrypted: true || false,
79
+ * // KmsKeyId: "STRING_VALUE",
80
+ * // DbClusterResourceId: "STRING_VALUE",
81
+ * // DBClusterArn: "STRING_VALUE",
82
+ * // AssociatedRoles: [ // DBClusterRoles
83
+ * // { // DBClusterRole
84
+ * // RoleArn: "STRING_VALUE",
85
+ * // Status: "STRING_VALUE",
86
+ * // },
87
+ * // ],
88
+ * // CloneGroupId: "STRING_VALUE",
89
+ * // ClusterCreateTime: new Date("TIMESTAMP"),
90
+ * // EnabledCloudwatchLogsExports: [ // LogTypeList
91
+ * // "STRING_VALUE",
92
+ * // ],
93
+ * // DeletionProtection: true || false,
94
+ * // },
95
+ * // };
96
+ *
37
97
  * ```
38
98
  *
39
99
  * @param FailoverDBClusterCommandInput - {@link FailoverDBClusterCommandInput}
@@ -53,6 +113,8 @@ export interface FailoverDBClusterCommandOutput extends FailoverDBClusterResult,
53
113
  * <p> The specified instance isn't in the <i>available</i> state.
54
114
  * </p>
55
115
  *
116
+ * @throws {@link DocDBServiceException}
117
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
56
118
  *
57
119
  */
58
120
  export declare class FailoverDBClusterCommand extends $Command<FailoverDBClusterCommandInput, FailoverDBClusterCommandOutput, DocDBClientResolvedConfig> {
@@ -39,6 +39,15 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta
39
39
  * };
40
40
  * const command = new ListTagsForResourceCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // TagListMessage
43
+ * // TagList: [ // TagList
44
+ * // { // Tag
45
+ * // Key: "STRING_VALUE",
46
+ * // Value: "STRING_VALUE",
47
+ * // },
48
+ * // ],
49
+ * // };
50
+ *
42
51
  * ```
43
52
  *
44
53
  * @param ListTagsForResourceCommandInput - {@link ListTagsForResourceCommandInput}
@@ -59,6 +68,8 @@ export interface ListTagsForResourceCommandOutput extends TagListMessage, __Meta
59
68
  * <p>
60
69
  * <code>DBSnapshotIdentifier</code> doesn't refer to an existing snapshot. </p>
61
70
  *
71
+ * @throws {@link DocDBServiceException}
72
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
62
73
  *
63
74
  */
64
75
  export declare class ListTagsForResourceCommand extends $Command<ListTagsForResourceCommandInput, ListTagsForResourceCommandOutput, DocDBClientResolvedConfig> {
@@ -54,6 +54,66 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
54
54
  * };
55
55
  * const command = new ModifyDBClusterCommand(input);
56
56
  * const response = await client.send(command);
57
+ * // { // ModifyDBClusterResult
58
+ * // DBCluster: { // DBCluster
59
+ * // AvailabilityZones: [ // AvailabilityZones
60
+ * // "STRING_VALUE",
61
+ * // ],
62
+ * // BackupRetentionPeriod: Number("int"),
63
+ * // DBClusterIdentifier: "STRING_VALUE",
64
+ * // DBClusterParameterGroup: "STRING_VALUE",
65
+ * // DBSubnetGroup: "STRING_VALUE",
66
+ * // Status: "STRING_VALUE",
67
+ * // PercentProgress: "STRING_VALUE",
68
+ * // EarliestRestorableTime: new Date("TIMESTAMP"),
69
+ * // Endpoint: "STRING_VALUE",
70
+ * // ReaderEndpoint: "STRING_VALUE",
71
+ * // MultiAZ: true || false,
72
+ * // Engine: "STRING_VALUE",
73
+ * // EngineVersion: "STRING_VALUE",
74
+ * // LatestRestorableTime: new Date("TIMESTAMP"),
75
+ * // Port: Number("int"),
76
+ * // MasterUsername: "STRING_VALUE",
77
+ * // PreferredBackupWindow: "STRING_VALUE",
78
+ * // PreferredMaintenanceWindow: "STRING_VALUE",
79
+ * // ReplicationSourceIdentifier: "STRING_VALUE",
80
+ * // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
81
+ * // "STRING_VALUE",
82
+ * // ],
83
+ * // DBClusterMembers: [ // DBClusterMemberList
84
+ * // { // DBClusterMember
85
+ * // DBInstanceIdentifier: "STRING_VALUE",
86
+ * // IsClusterWriter: true || false,
87
+ * // DBClusterParameterGroupStatus: "STRING_VALUE",
88
+ * // PromotionTier: Number("int"),
89
+ * // },
90
+ * // ],
91
+ * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
92
+ * // { // VpcSecurityGroupMembership
93
+ * // VpcSecurityGroupId: "STRING_VALUE",
94
+ * // Status: "STRING_VALUE",
95
+ * // },
96
+ * // ],
97
+ * // HostedZoneId: "STRING_VALUE",
98
+ * // StorageEncrypted: true || false,
99
+ * // KmsKeyId: "STRING_VALUE",
100
+ * // DbClusterResourceId: "STRING_VALUE",
101
+ * // DBClusterArn: "STRING_VALUE",
102
+ * // AssociatedRoles: [ // DBClusterRoles
103
+ * // { // DBClusterRole
104
+ * // RoleArn: "STRING_VALUE",
105
+ * // Status: "STRING_VALUE",
106
+ * // },
107
+ * // ],
108
+ * // CloneGroupId: "STRING_VALUE",
109
+ * // ClusterCreateTime: new Date("TIMESTAMP"),
110
+ * // EnabledCloudwatchLogsExports: [ // LogTypeList
111
+ * // "STRING_VALUE",
112
+ * // ],
113
+ * // DeletionProtection: true || false,
114
+ * // },
115
+ * // };
116
+ *
57
117
  * ```
58
118
  *
59
119
  * @param ModifyDBClusterCommandInput - {@link ModifyDBClusterCommandInput}
@@ -102,6 +162,8 @@ export interface ModifyDBClusterCommandOutput extends ModifyDBClusterResult, __M
102
162
  * <p>The request would cause you to exceed the allowed amount of storage available across
103
163
  * all instances.</p>
104
164
  *
165
+ * @throws {@link DocDBServiceException}
166
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
105
167
  *
106
168
  */
107
169
  export declare class ModifyDBClusterCommand extends $Command<ModifyDBClusterCommandInput, ModifyDBClusterCommandOutput, DocDBClientResolvedConfig> {
@@ -63,6 +63,10 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
63
63
  * };
64
64
  * const command = new ModifyDBClusterParameterGroupCommand(input);
65
65
  * const response = await client.send(command);
66
+ * // { // DBClusterParameterGroupNameMessage
67
+ * // DBClusterParameterGroupName: "STRING_VALUE",
68
+ * // };
69
+ *
66
70
  * ```
67
71
  *
68
72
  * @param ModifyDBClusterParameterGroupCommandInput - {@link ModifyDBClusterParameterGroupCommandInput}
@@ -78,6 +82,8 @@ export interface ModifyDBClusterParameterGroupCommandOutput extends DBClusterPar
78
82
  * @throws {@link InvalidDBParameterGroupStateFault} (client fault)
79
83
  * <p>The parameter group is in use, or it is in a state that is not valid. If you are trying to delete the parameter group, you can't delete it when the parameter group is in this state.</p>
80
84
  *
85
+ * @throws {@link DocDBServiceException}
86
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
81
87
  *
82
88
  */
83
89
  export declare class ModifyDBClusterParameterGroupCommand extends $Command<ModifyDBClusterParameterGroupCommandInput, ModifyDBClusterParameterGroupCommandOutput, DocDBClientResolvedConfig> {
@@ -39,6 +39,20 @@ export interface ModifyDBClusterSnapshotAttributeCommandOutput extends ModifyDBC
39
39
  * };
40
40
  * const command = new ModifyDBClusterSnapshotAttributeCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // ModifyDBClusterSnapshotAttributeResult
43
+ * // DBClusterSnapshotAttributesResult: { // DBClusterSnapshotAttributesResult
44
+ * // DBClusterSnapshotIdentifier: "STRING_VALUE",
45
+ * // DBClusterSnapshotAttributes: [ // DBClusterSnapshotAttributeList
46
+ * // { // DBClusterSnapshotAttribute
47
+ * // AttributeName: "STRING_VALUE",
48
+ * // AttributeValues: [ // AttributeValueList
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // },
52
+ * // ],
53
+ * // },
54
+ * // };
55
+ *
42
56
  * ```
43
57
  *
44
58
  * @param ModifyDBClusterSnapshotAttributeCommandInput - {@link ModifyDBClusterSnapshotAttributeCommandInput}
@@ -58,6 +72,8 @@ export interface ModifyDBClusterSnapshotAttributeCommandOutput extends ModifyDBC
58
72
  * <p>You have exceeded the maximum number of accounts that you can share a manual DB
59
73
  * snapshot with. </p>
60
74
  *
75
+ * @throws {@link DocDBServiceException}
76
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
61
77
  *
62
78
  */
63
79
  export declare class ModifyDBClusterSnapshotAttributeCommand extends $Command<ModifyDBClusterSnapshotAttributeCommandInput, ModifyDBClusterSnapshotAttributeCommandOutput, DocDBClientResolvedConfig> {
@@ -41,6 +41,93 @@ export interface ModifyDBInstanceCommandOutput extends ModifyDBInstanceResult, _
41
41
  * };
42
42
  * const command = new ModifyDBInstanceCommand(input);
43
43
  * const response = await client.send(command);
44
+ * // { // ModifyDBInstanceResult
45
+ * // DBInstance: { // DBInstance
46
+ * // DBInstanceIdentifier: "STRING_VALUE",
47
+ * // DBInstanceClass: "STRING_VALUE",
48
+ * // Engine: "STRING_VALUE",
49
+ * // DBInstanceStatus: "STRING_VALUE",
50
+ * // Endpoint: { // Endpoint
51
+ * // Address: "STRING_VALUE",
52
+ * // Port: Number("int"),
53
+ * // HostedZoneId: "STRING_VALUE",
54
+ * // },
55
+ * // InstanceCreateTime: new Date("TIMESTAMP"),
56
+ * // PreferredBackupWindow: "STRING_VALUE",
57
+ * // BackupRetentionPeriod: Number("int"),
58
+ * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
59
+ * // { // VpcSecurityGroupMembership
60
+ * // VpcSecurityGroupId: "STRING_VALUE",
61
+ * // Status: "STRING_VALUE",
62
+ * // },
63
+ * // ],
64
+ * // AvailabilityZone: "STRING_VALUE",
65
+ * // DBSubnetGroup: { // DBSubnetGroup
66
+ * // DBSubnetGroupName: "STRING_VALUE",
67
+ * // DBSubnetGroupDescription: "STRING_VALUE",
68
+ * // VpcId: "STRING_VALUE",
69
+ * // SubnetGroupStatus: "STRING_VALUE",
70
+ * // Subnets: [ // SubnetList
71
+ * // { // Subnet
72
+ * // SubnetIdentifier: "STRING_VALUE",
73
+ * // SubnetAvailabilityZone: { // AvailabilityZone
74
+ * // Name: "STRING_VALUE",
75
+ * // },
76
+ * // SubnetStatus: "STRING_VALUE",
77
+ * // },
78
+ * // ],
79
+ * // DBSubnetGroupArn: "STRING_VALUE",
80
+ * // },
81
+ * // PreferredMaintenanceWindow: "STRING_VALUE",
82
+ * // PendingModifiedValues: { // PendingModifiedValues
83
+ * // DBInstanceClass: "STRING_VALUE",
84
+ * // AllocatedStorage: Number("int"),
85
+ * // MasterUserPassword: "STRING_VALUE",
86
+ * // Port: Number("int"),
87
+ * // BackupRetentionPeriod: Number("int"),
88
+ * // MultiAZ: true || false,
89
+ * // EngineVersion: "STRING_VALUE",
90
+ * // LicenseModel: "STRING_VALUE",
91
+ * // Iops: Number("int"),
92
+ * // DBInstanceIdentifier: "STRING_VALUE",
93
+ * // StorageType: "STRING_VALUE",
94
+ * // CACertificateIdentifier: "STRING_VALUE",
95
+ * // DBSubnetGroupName: "STRING_VALUE",
96
+ * // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
97
+ * // LogTypesToEnable: [ // LogTypeList
98
+ * // "STRING_VALUE",
99
+ * // ],
100
+ * // LogTypesToDisable: [
101
+ * // "STRING_VALUE",
102
+ * // ],
103
+ * // },
104
+ * // },
105
+ * // LatestRestorableTime: new Date("TIMESTAMP"),
106
+ * // EngineVersion: "STRING_VALUE",
107
+ * // AutoMinorVersionUpgrade: true || false,
108
+ * // PubliclyAccessible: true || false,
109
+ * // StatusInfos: [ // DBInstanceStatusInfoList
110
+ * // { // DBInstanceStatusInfo
111
+ * // StatusType: "STRING_VALUE",
112
+ * // Normal: true || false,
113
+ * // Status: "STRING_VALUE",
114
+ * // Message: "STRING_VALUE",
115
+ * // },
116
+ * // ],
117
+ * // DBClusterIdentifier: "STRING_VALUE",
118
+ * // StorageEncrypted: true || false,
119
+ * // KmsKeyId: "STRING_VALUE",
120
+ * // DbiResourceId: "STRING_VALUE",
121
+ * // CACertificateIdentifier: "STRING_VALUE",
122
+ * // CopyTagsToSnapshot: true || false,
123
+ * // PromotionTier: Number("int"),
124
+ * // DBInstanceArn: "STRING_VALUE",
125
+ * // EnabledCloudwatchLogsExports: [
126
+ * // "STRING_VALUE",
127
+ * // ],
128
+ * // },
129
+ * // };
130
+ *
44
131
  * ```
45
132
  *
46
133
  * @param ModifyDBInstanceCommandInput - {@link ModifyDBInstanceCommandInput}
@@ -98,6 +185,8 @@ export interface ModifyDBInstanceCommandOutput extends ModifyDBInstanceResult, _
98
185
  * <p>Storage of the specified <code>StorageType</code> can't be associated with the DB
99
186
  * instance. </p>
100
187
  *
188
+ * @throws {@link DocDBServiceException}
189
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
101
190
  *
102
191
  */
103
192
  export declare class ModifyDBInstanceCommand extends $Command<ModifyDBInstanceCommandInput, ModifyDBInstanceCommandOutput, DocDBClientResolvedConfig> {
@@ -35,6 +35,25 @@ export interface ModifyDBSubnetGroupCommandOutput extends ModifyDBSubnetGroupRes
35
35
  * };
36
36
  * const command = new ModifyDBSubnetGroupCommand(input);
37
37
  * const response = await client.send(command);
38
+ * // { // ModifyDBSubnetGroupResult
39
+ * // DBSubnetGroup: { // DBSubnetGroup
40
+ * // DBSubnetGroupName: "STRING_VALUE",
41
+ * // DBSubnetGroupDescription: "STRING_VALUE",
42
+ * // VpcId: "STRING_VALUE",
43
+ * // SubnetGroupStatus: "STRING_VALUE",
44
+ * // Subnets: [ // SubnetList
45
+ * // { // Subnet
46
+ * // SubnetIdentifier: "STRING_VALUE",
47
+ * // SubnetAvailabilityZone: { // AvailabilityZone
48
+ * // Name: "STRING_VALUE",
49
+ * // },
50
+ * // SubnetStatus: "STRING_VALUE",
51
+ * // },
52
+ * // ],
53
+ * // DBSubnetGroupArn: "STRING_VALUE",
54
+ * // },
55
+ * // };
56
+ *
38
57
  * ```
39
58
  *
40
59
  * @param ModifyDBSubnetGroupCommandInput - {@link ModifyDBSubnetGroupCommandInput}
@@ -60,6 +79,8 @@ export interface ModifyDBSubnetGroupCommandOutput extends ModifyDBSubnetGroupRes
60
79
  * @throws {@link SubnetAlreadyInUse} (client fault)
61
80
  * <p>The subnet is already in use in the Availability Zone.</p>
62
81
  *
82
+ * @throws {@link DocDBServiceException}
83
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
63
84
  *
64
85
  */
65
86
  export declare class ModifyDBSubnetGroupCommand extends $Command<ModifyDBSubnetGroupCommandInput, ModifyDBSubnetGroupCommandOutput, DocDBClientResolvedConfig> {
@@ -37,6 +37,25 @@ export interface ModifyEventSubscriptionCommandOutput extends ModifyEventSubscri
37
37
  * };
38
38
  * const command = new ModifyEventSubscriptionCommand(input);
39
39
  * const response = await client.send(command);
40
+ * // { // ModifyEventSubscriptionResult
41
+ * // EventSubscription: { // EventSubscription
42
+ * // CustomerAwsId: "STRING_VALUE",
43
+ * // CustSubscriptionId: "STRING_VALUE",
44
+ * // SnsTopicArn: "STRING_VALUE",
45
+ * // Status: "STRING_VALUE",
46
+ * // SubscriptionCreationTime: "STRING_VALUE",
47
+ * // SourceType: "STRING_VALUE",
48
+ * // SourceIdsList: [ // SourceIdsList
49
+ * // "STRING_VALUE",
50
+ * // ],
51
+ * // EventCategoriesList: [ // EventCategoriesList
52
+ * // "STRING_VALUE",
53
+ * // ],
54
+ * // Enabled: true || false,
55
+ * // EventSubscriptionArn: "STRING_VALUE",
56
+ * // },
57
+ * // };
58
+ *
40
59
  * ```
41
60
  *
42
61
  * @param ModifyEventSubscriptionCommandInput - {@link ModifyEventSubscriptionCommandInput}
@@ -63,6 +82,8 @@ export interface ModifyEventSubscriptionCommandOutput extends ModifyEventSubscri
63
82
  * @throws {@link SubscriptionNotFoundFault} (client fault)
64
83
  * <p>The subscription name does not exist. </p>
65
84
  *
85
+ * @throws {@link DocDBServiceException}
86
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
66
87
  *
67
88
  */
68
89
  export declare class ModifyEventSubscriptionCommand extends $Command<ModifyEventSubscriptionCommandInput, ModifyEventSubscriptionCommandOutput, DocDBClientResolvedConfig> {