@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
@@ -33,6 +33,25 @@ export interface AddSourceIdentifierToSubscriptionCommandOutput extends AddSourc
33
33
  * };
34
34
  * const command = new AddSourceIdentifierToSubscriptionCommand(input);
35
35
  * const response = await client.send(command);
36
+ * // { // AddSourceIdentifierToSubscriptionResult
37
+ * // EventSubscription: { // EventSubscription
38
+ * // CustomerAwsId: "STRING_VALUE",
39
+ * // CustSubscriptionId: "STRING_VALUE",
40
+ * // SnsTopicArn: "STRING_VALUE",
41
+ * // Status: "STRING_VALUE",
42
+ * // SubscriptionCreationTime: "STRING_VALUE",
43
+ * // SourceType: "STRING_VALUE",
44
+ * // SourceIdsList: [ // SourceIdsList
45
+ * // "STRING_VALUE",
46
+ * // ],
47
+ * // EventCategoriesList: [ // EventCategoriesList
48
+ * // "STRING_VALUE",
49
+ * // ],
50
+ * // Enabled: true || false,
51
+ * // EventSubscriptionArn: "STRING_VALUE",
52
+ * // },
53
+ * // };
54
+ *
36
55
  * ```
37
56
  *
38
57
  * @param AddSourceIdentifierToSubscriptionCommandInput - {@link AddSourceIdentifierToSubscriptionCommandInput}
@@ -47,6 +66,8 @@ export interface AddSourceIdentifierToSubscriptionCommandOutput extends AddSourc
47
66
  * @throws {@link SubscriptionNotFoundFault} (client fault)
48
67
  * <p>The subscription name does not exist. </p>
49
68
  *
69
+ * @throws {@link DocDBServiceException}
70
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
50
71
  *
51
72
  */
52
73
  export declare class AddSourceIdentifierToSubscriptionCommand extends $Command<AddSourceIdentifierToSubscriptionCommandInput, AddSourceIdentifierToSubscriptionCommandOutput, DocDBClientResolvedConfig> {
@@ -40,6 +40,8 @@ export interface AddTagsToResourceCommandOutput extends __MetadataBearer {
40
40
  * };
41
41
  * const command = new AddTagsToResourceCommand(input);
42
42
  * const response = await client.send(command);
43
+ * // {};
44
+ *
43
45
  * ```
44
46
  *
45
47
  * @param AddTagsToResourceCommandInput - {@link AddTagsToResourceCommandInput}
@@ -60,6 +62,8 @@ export interface AddTagsToResourceCommandOutput extends __MetadataBearer {
60
62
  * <p>
61
63
  * <code>DBSnapshotIdentifier</code> doesn't refer to an existing snapshot. </p>
62
64
  *
65
+ * @throws {@link DocDBServiceException}
66
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
63
67
  *
64
68
  */
65
69
  export declare class AddTagsToResourceCommand extends $Command<AddTagsToResourceCommandInput, AddTagsToResourceCommandOutput, DocDBClientResolvedConfig> {
@@ -34,6 +34,22 @@ export interface ApplyPendingMaintenanceActionCommandOutput extends ApplyPending
34
34
  * };
35
35
  * const command = new ApplyPendingMaintenanceActionCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // ApplyPendingMaintenanceActionResult
38
+ * // ResourcePendingMaintenanceActions: { // ResourcePendingMaintenanceActions
39
+ * // ResourceIdentifier: "STRING_VALUE",
40
+ * // PendingMaintenanceActionDetails: [ // PendingMaintenanceActionDetails
41
+ * // { // PendingMaintenanceAction
42
+ * // Action: "STRING_VALUE",
43
+ * // AutoAppliedAfterDate: new Date("TIMESTAMP"),
44
+ * // ForcedApplyDate: new Date("TIMESTAMP"),
45
+ * // OptInStatus: "STRING_VALUE",
46
+ * // CurrentApplyDate: new Date("TIMESTAMP"),
47
+ * // Description: "STRING_VALUE",
48
+ * // },
49
+ * // ],
50
+ * // },
51
+ * // };
52
+ *
37
53
  * ```
38
54
  *
39
55
  * @param ApplyPendingMaintenanceActionCommandInput - {@link ApplyPendingMaintenanceActionCommandInput}
@@ -52,6 +68,8 @@ export interface ApplyPendingMaintenanceActionCommandOutput extends ApplyPending
52
68
  * @throws {@link ResourceNotFoundFault} (client fault)
53
69
  * <p>The specified resource ID was not found.</p>
54
70
  *
71
+ * @throws {@link DocDBServiceException}
72
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
55
73
  *
56
74
  */
57
75
  export declare class ApplyPendingMaintenanceActionCommand extends $Command<ApplyPendingMaintenanceActionCommandInput, ApplyPendingMaintenanceActionCommandOutput, DocDBClientResolvedConfig> {
@@ -39,6 +39,15 @@ export interface CopyDBClusterParameterGroupCommandOutput extends CopyDBClusterP
39
39
  * };
40
40
  * const command = new CopyDBClusterParameterGroupCommand(input);
41
41
  * const response = await client.send(command);
42
+ * // { // CopyDBClusterParameterGroupResult
43
+ * // DBClusterParameterGroup: { // DBClusterParameterGroup
44
+ * // DBClusterParameterGroupName: "STRING_VALUE",
45
+ * // DBParameterGroupFamily: "STRING_VALUE",
46
+ * // Description: "STRING_VALUE",
47
+ * // DBClusterParameterGroupArn: "STRING_VALUE",
48
+ * // },
49
+ * // };
50
+ *
42
51
  * ```
43
52
  *
44
53
  * @param CopyDBClusterParameterGroupCommandInput - {@link CopyDBClusterParameterGroupCommandInput}
@@ -57,6 +66,8 @@ export interface CopyDBClusterParameterGroupCommandOutput extends CopyDBClusterP
57
66
  * @throws {@link DBParameterGroupQuotaExceededFault} (client fault)
58
67
  * <p>This request would cause you to exceed the allowed number of parameter groups.</p>
59
68
  *
69
+ * @throws {@link DocDBServiceException}
70
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
60
71
  *
61
72
  */
62
73
  export declare class CopyDBClusterParameterGroupCommand extends $Command<CopyDBClusterParameterGroupCommandInput, CopyDBClusterParameterGroupCommandOutput, DocDBClientResolvedConfig> {
@@ -50,6 +50,30 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
50
50
  * };
51
51
  * const command = new CopyDBClusterSnapshotCommand(input);
52
52
  * const response = await client.send(command);
53
+ * // { // CopyDBClusterSnapshotResult
54
+ * // DBClusterSnapshot: { // DBClusterSnapshot
55
+ * // AvailabilityZones: [ // AvailabilityZones
56
+ * // "STRING_VALUE",
57
+ * // ],
58
+ * // DBClusterSnapshotIdentifier: "STRING_VALUE",
59
+ * // DBClusterIdentifier: "STRING_VALUE",
60
+ * // SnapshotCreateTime: new Date("TIMESTAMP"),
61
+ * // Engine: "STRING_VALUE",
62
+ * // Status: "STRING_VALUE",
63
+ * // Port: Number("int"),
64
+ * // VpcId: "STRING_VALUE",
65
+ * // ClusterCreateTime: new Date("TIMESTAMP"),
66
+ * // MasterUsername: "STRING_VALUE",
67
+ * // EngineVersion: "STRING_VALUE",
68
+ * // SnapshotType: "STRING_VALUE",
69
+ * // PercentProgress: Number("int"),
70
+ * // StorageEncrypted: true || false,
71
+ * // KmsKeyId: "STRING_VALUE",
72
+ * // DBClusterSnapshotArn: "STRING_VALUE",
73
+ * // SourceDBClusterSnapshotArn: "STRING_VALUE",
74
+ * // },
75
+ * // };
76
+ *
53
77
  * ```
54
78
  *
55
79
  * @param CopyDBClusterSnapshotCommandInput - {@link CopyDBClusterSnapshotCommandInput}
@@ -77,6 +101,8 @@ export interface CopyDBClusterSnapshotCommandOutput extends CopyDBClusterSnapsho
77
101
  * @throws {@link SnapshotQuotaExceededFault} (client fault)
78
102
  * <p>The request would cause you to exceed the allowed number of snapshots.</p>
79
103
  *
104
+ * @throws {@link DocDBServiceException}
105
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
80
106
  *
81
107
  */
82
108
  export declare class CopyDBClusterSnapshotCommand extends $Command<CopyDBClusterSnapshotCommandInput, CopyDBClusterSnapshotCommandOutput, DocDBClientResolvedConfig> {
@@ -61,6 +61,66 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
61
61
  * };
62
62
  * const command = new CreateDBClusterCommand(input);
63
63
  * const response = await client.send(command);
64
+ * // { // CreateDBClusterResult
65
+ * // DBCluster: { // DBCluster
66
+ * // AvailabilityZones: [ // AvailabilityZones
67
+ * // "STRING_VALUE",
68
+ * // ],
69
+ * // BackupRetentionPeriod: Number("int"),
70
+ * // DBClusterIdentifier: "STRING_VALUE",
71
+ * // DBClusterParameterGroup: "STRING_VALUE",
72
+ * // DBSubnetGroup: "STRING_VALUE",
73
+ * // Status: "STRING_VALUE",
74
+ * // PercentProgress: "STRING_VALUE",
75
+ * // EarliestRestorableTime: new Date("TIMESTAMP"),
76
+ * // Endpoint: "STRING_VALUE",
77
+ * // ReaderEndpoint: "STRING_VALUE",
78
+ * // MultiAZ: true || false,
79
+ * // Engine: "STRING_VALUE",
80
+ * // EngineVersion: "STRING_VALUE",
81
+ * // LatestRestorableTime: new Date("TIMESTAMP"),
82
+ * // Port: Number("int"),
83
+ * // MasterUsername: "STRING_VALUE",
84
+ * // PreferredBackupWindow: "STRING_VALUE",
85
+ * // PreferredMaintenanceWindow: "STRING_VALUE",
86
+ * // ReplicationSourceIdentifier: "STRING_VALUE",
87
+ * // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
88
+ * // "STRING_VALUE",
89
+ * // ],
90
+ * // DBClusterMembers: [ // DBClusterMemberList
91
+ * // { // DBClusterMember
92
+ * // DBInstanceIdentifier: "STRING_VALUE",
93
+ * // IsClusterWriter: true || false,
94
+ * // DBClusterParameterGroupStatus: "STRING_VALUE",
95
+ * // PromotionTier: Number("int"),
96
+ * // },
97
+ * // ],
98
+ * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
99
+ * // { // VpcSecurityGroupMembership
100
+ * // VpcSecurityGroupId: "STRING_VALUE",
101
+ * // Status: "STRING_VALUE",
102
+ * // },
103
+ * // ],
104
+ * // HostedZoneId: "STRING_VALUE",
105
+ * // StorageEncrypted: true || false,
106
+ * // KmsKeyId: "STRING_VALUE",
107
+ * // DbClusterResourceId: "STRING_VALUE",
108
+ * // DBClusterArn: "STRING_VALUE",
109
+ * // AssociatedRoles: [ // DBClusterRoles
110
+ * // { // DBClusterRole
111
+ * // RoleArn: "STRING_VALUE",
112
+ * // Status: "STRING_VALUE",
113
+ * // },
114
+ * // ],
115
+ * // CloneGroupId: "STRING_VALUE",
116
+ * // ClusterCreateTime: new Date("TIMESTAMP"),
117
+ * // EnabledCloudwatchLogsExports: [ // LogTypeList
118
+ * // "STRING_VALUE",
119
+ * // ],
120
+ * // DeletionProtection: true || false,
121
+ * // },
122
+ * // };
123
+ *
64
124
  * ```
65
125
  *
66
126
  * @param CreateDBClusterCommandInput - {@link CreateDBClusterCommandInput}
@@ -128,6 +188,8 @@ export interface CreateDBClusterCommandOutput extends CreateDBClusterResult, __M
128
188
  * <p>The request would cause you to exceed the allowed amount of storage available across
129
189
  * all instances.</p>
130
190
  *
191
+ * @throws {@link DocDBServiceException}
192
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
131
193
  *
132
194
  */
133
195
  export declare class CreateDBClusterCommand extends $Command<CreateDBClusterCommandInput, CreateDBClusterCommandOutput, DocDBClientResolvedConfig> {
@@ -57,6 +57,15 @@ export interface CreateDBClusterParameterGroupCommandOutput extends CreateDBClus
57
57
  * };
58
58
  * const command = new CreateDBClusterParameterGroupCommand(input);
59
59
  * const response = await client.send(command);
60
+ * // { // CreateDBClusterParameterGroupResult
61
+ * // DBClusterParameterGroup: { // DBClusterParameterGroup
62
+ * // DBClusterParameterGroupName: "STRING_VALUE",
63
+ * // DBParameterGroupFamily: "STRING_VALUE",
64
+ * // Description: "STRING_VALUE",
65
+ * // DBClusterParameterGroupArn: "STRING_VALUE",
66
+ * // },
67
+ * // };
68
+ *
60
69
  * ```
61
70
  *
62
71
  * @param CreateDBClusterParameterGroupCommandInput - {@link CreateDBClusterParameterGroupCommandInput}
@@ -71,6 +80,8 @@ export interface CreateDBClusterParameterGroupCommandOutput extends CreateDBClus
71
80
  * @throws {@link DBParameterGroupQuotaExceededFault} (client fault)
72
81
  * <p>This request would cause you to exceed the allowed number of parameter groups.</p>
73
82
  *
83
+ * @throws {@link DocDBServiceException}
84
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
74
85
  *
75
86
  */
76
87
  export declare class CreateDBClusterParameterGroupCommand extends $Command<CreateDBClusterParameterGroupCommandInput, CreateDBClusterParameterGroupCommandOutput, DocDBClientResolvedConfig> {
@@ -38,6 +38,30 @@ export interface CreateDBClusterSnapshotCommandOutput extends CreateDBClusterSna
38
38
  * };
39
39
  * const command = new CreateDBClusterSnapshotCommand(input);
40
40
  * const response = await client.send(command);
41
+ * // { // CreateDBClusterSnapshotResult
42
+ * // DBClusterSnapshot: { // DBClusterSnapshot
43
+ * // AvailabilityZones: [ // AvailabilityZones
44
+ * // "STRING_VALUE",
45
+ * // ],
46
+ * // DBClusterSnapshotIdentifier: "STRING_VALUE",
47
+ * // DBClusterIdentifier: "STRING_VALUE",
48
+ * // SnapshotCreateTime: new Date("TIMESTAMP"),
49
+ * // Engine: "STRING_VALUE",
50
+ * // Status: "STRING_VALUE",
51
+ * // Port: Number("int"),
52
+ * // VpcId: "STRING_VALUE",
53
+ * // ClusterCreateTime: new Date("TIMESTAMP"),
54
+ * // MasterUsername: "STRING_VALUE",
55
+ * // EngineVersion: "STRING_VALUE",
56
+ * // SnapshotType: "STRING_VALUE",
57
+ * // PercentProgress: Number("int"),
58
+ * // StorageEncrypted: true || false,
59
+ * // KmsKeyId: "STRING_VALUE",
60
+ * // DBClusterSnapshotArn: "STRING_VALUE",
61
+ * // SourceDBClusterSnapshotArn: "STRING_VALUE",
62
+ * // },
63
+ * // };
64
+ *
41
65
  * ```
42
66
  *
43
67
  * @param CreateDBClusterSnapshotCommandInput - {@link CreateDBClusterSnapshotCommandInput}
@@ -62,6 +86,8 @@ export interface CreateDBClusterSnapshotCommandOutput extends CreateDBClusterSna
62
86
  * @throws {@link SnapshotQuotaExceededFault} (client fault)
63
87
  * <p>The request would cause you to exceed the allowed number of snapshots.</p>
64
88
  *
89
+ * @throws {@link DocDBServiceException}
90
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
65
91
  *
66
92
  */
67
93
  export declare class CreateDBClusterSnapshotCommand extends $Command<CreateDBClusterSnapshotCommandInput, CreateDBClusterSnapshotCommandOutput, DocDBClientResolvedConfig> {
@@ -47,6 +47,93 @@ export interface CreateDBInstanceCommandOutput extends CreateDBInstanceResult, _
47
47
  * };
48
48
  * const command = new CreateDBInstanceCommand(input);
49
49
  * const response = await client.send(command);
50
+ * // { // CreateDBInstanceResult
51
+ * // DBInstance: { // DBInstance
52
+ * // DBInstanceIdentifier: "STRING_VALUE",
53
+ * // DBInstanceClass: "STRING_VALUE",
54
+ * // Engine: "STRING_VALUE",
55
+ * // DBInstanceStatus: "STRING_VALUE",
56
+ * // Endpoint: { // Endpoint
57
+ * // Address: "STRING_VALUE",
58
+ * // Port: Number("int"),
59
+ * // HostedZoneId: "STRING_VALUE",
60
+ * // },
61
+ * // InstanceCreateTime: new Date("TIMESTAMP"),
62
+ * // PreferredBackupWindow: "STRING_VALUE",
63
+ * // BackupRetentionPeriod: Number("int"),
64
+ * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
65
+ * // { // VpcSecurityGroupMembership
66
+ * // VpcSecurityGroupId: "STRING_VALUE",
67
+ * // Status: "STRING_VALUE",
68
+ * // },
69
+ * // ],
70
+ * // AvailabilityZone: "STRING_VALUE",
71
+ * // DBSubnetGroup: { // DBSubnetGroup
72
+ * // DBSubnetGroupName: "STRING_VALUE",
73
+ * // DBSubnetGroupDescription: "STRING_VALUE",
74
+ * // VpcId: "STRING_VALUE",
75
+ * // SubnetGroupStatus: "STRING_VALUE",
76
+ * // Subnets: [ // SubnetList
77
+ * // { // Subnet
78
+ * // SubnetIdentifier: "STRING_VALUE",
79
+ * // SubnetAvailabilityZone: { // AvailabilityZone
80
+ * // Name: "STRING_VALUE",
81
+ * // },
82
+ * // SubnetStatus: "STRING_VALUE",
83
+ * // },
84
+ * // ],
85
+ * // DBSubnetGroupArn: "STRING_VALUE",
86
+ * // },
87
+ * // PreferredMaintenanceWindow: "STRING_VALUE",
88
+ * // PendingModifiedValues: { // PendingModifiedValues
89
+ * // DBInstanceClass: "STRING_VALUE",
90
+ * // AllocatedStorage: Number("int"),
91
+ * // MasterUserPassword: "STRING_VALUE",
92
+ * // Port: Number("int"),
93
+ * // BackupRetentionPeriod: Number("int"),
94
+ * // MultiAZ: true || false,
95
+ * // EngineVersion: "STRING_VALUE",
96
+ * // LicenseModel: "STRING_VALUE",
97
+ * // Iops: Number("int"),
98
+ * // DBInstanceIdentifier: "STRING_VALUE",
99
+ * // StorageType: "STRING_VALUE",
100
+ * // CACertificateIdentifier: "STRING_VALUE",
101
+ * // DBSubnetGroupName: "STRING_VALUE",
102
+ * // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
103
+ * // LogTypesToEnable: [ // LogTypeList
104
+ * // "STRING_VALUE",
105
+ * // ],
106
+ * // LogTypesToDisable: [
107
+ * // "STRING_VALUE",
108
+ * // ],
109
+ * // },
110
+ * // },
111
+ * // LatestRestorableTime: new Date("TIMESTAMP"),
112
+ * // EngineVersion: "STRING_VALUE",
113
+ * // AutoMinorVersionUpgrade: true || false,
114
+ * // PubliclyAccessible: true || false,
115
+ * // StatusInfos: [ // DBInstanceStatusInfoList
116
+ * // { // DBInstanceStatusInfo
117
+ * // StatusType: "STRING_VALUE",
118
+ * // Normal: true || false,
119
+ * // Status: "STRING_VALUE",
120
+ * // Message: "STRING_VALUE",
121
+ * // },
122
+ * // ],
123
+ * // DBClusterIdentifier: "STRING_VALUE",
124
+ * // StorageEncrypted: true || false,
125
+ * // KmsKeyId: "STRING_VALUE",
126
+ * // DbiResourceId: "STRING_VALUE",
127
+ * // CACertificateIdentifier: "STRING_VALUE",
128
+ * // CopyTagsToSnapshot: true || false,
129
+ * // PromotionTier: Number("int"),
130
+ * // DBInstanceArn: "STRING_VALUE",
131
+ * // EnabledCloudwatchLogsExports: [
132
+ * // "STRING_VALUE",
133
+ * // ],
134
+ * // },
135
+ * // };
136
+ *
50
137
  * ```
51
138
  *
52
139
  * @param CreateDBInstanceCommandInput - {@link CreateDBInstanceCommandInput}
@@ -109,6 +196,8 @@ export interface CreateDBInstanceCommandOutput extends CreateDBInstanceResult, _
109
196
  * <p>Storage of the specified <code>StorageType</code> can't be associated with the DB
110
197
  * instance. </p>
111
198
  *
199
+ * @throws {@link DocDBServiceException}
200
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
112
201
  *
113
202
  */
114
203
  export declare class CreateDBInstanceCommand extends $Command<CreateDBInstanceCommandInput, CreateDBInstanceCommandOutput, DocDBClientResolvedConfig> {
@@ -42,6 +42,25 @@ export interface CreateDBSubnetGroupCommandOutput extends CreateDBSubnetGroupRes
42
42
  * };
43
43
  * const command = new CreateDBSubnetGroupCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // CreateDBSubnetGroupResult
46
+ * // DBSubnetGroup: { // DBSubnetGroup
47
+ * // DBSubnetGroupName: "STRING_VALUE",
48
+ * // DBSubnetGroupDescription: "STRING_VALUE",
49
+ * // VpcId: "STRING_VALUE",
50
+ * // SubnetGroupStatus: "STRING_VALUE",
51
+ * // Subnets: [ // SubnetList
52
+ * // { // Subnet
53
+ * // SubnetIdentifier: "STRING_VALUE",
54
+ * // SubnetAvailabilityZone: { // AvailabilityZone
55
+ * // Name: "STRING_VALUE",
56
+ * // },
57
+ * // SubnetStatus: "STRING_VALUE",
58
+ * // },
59
+ * // ],
60
+ * // DBSubnetGroupArn: "STRING_VALUE",
61
+ * // },
62
+ * // };
63
+ *
45
64
  * ```
46
65
  *
47
66
  * @param CreateDBSubnetGroupCommandInput - {@link CreateDBSubnetGroupCommandInput}
@@ -67,6 +86,8 @@ export interface CreateDBSubnetGroupCommandOutput extends CreateDBSubnetGroupRes
67
86
  * <p>The requested subnet is not valid, or multiple subnets were requested that are not all
68
87
  * in a common virtual private cloud (VPC).</p>
69
88
  *
89
+ * @throws {@link DocDBServiceException}
90
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
70
91
  *
71
92
  */
72
93
  export declare class CreateDBSubnetGroupCommand extends $Command<CreateDBSubnetGroupCommandInput, CreateDBSubnetGroupCommandOutput, DocDBClientResolvedConfig> {
@@ -48,6 +48,25 @@ export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscri
48
48
  * };
49
49
  * const command = new CreateEventSubscriptionCommand(input);
50
50
  * const response = await client.send(command);
51
+ * // { // CreateEventSubscriptionResult
52
+ * // EventSubscription: { // EventSubscription
53
+ * // CustomerAwsId: "STRING_VALUE",
54
+ * // CustSubscriptionId: "STRING_VALUE",
55
+ * // SnsTopicArn: "STRING_VALUE",
56
+ * // Status: "STRING_VALUE",
57
+ * // SubscriptionCreationTime: "STRING_VALUE",
58
+ * // SourceType: "STRING_VALUE",
59
+ * // SourceIdsList: [ // SourceIdsList
60
+ * // "STRING_VALUE",
61
+ * // ],
62
+ * // EventCategoriesList: [ // EventCategoriesList
63
+ * // "STRING_VALUE",
64
+ * // ],
65
+ * // Enabled: true || false,
66
+ * // EventSubscriptionArn: "STRING_VALUE",
67
+ * // },
68
+ * // };
69
+ *
51
70
  * ```
52
71
  *
53
72
  * @param CreateEventSubscriptionCommandInput - {@link CreateEventSubscriptionCommandInput}
@@ -77,6 +96,8 @@ export interface CreateEventSubscriptionCommandOutput extends CreateEventSubscri
77
96
  * @throws {@link SubscriptionCategoryNotFoundFault} (client fault)
78
97
  * <p>The provided category does not exist. </p>
79
98
  *
99
+ * @throws {@link DocDBServiceException}
100
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
80
101
  *
81
102
  */
82
103
  export declare class CreateEventSubscriptionCommand extends $Command<CreateEventSubscriptionCommandInput, CreateEventSubscriptionCommandOutput, DocDBClientResolvedConfig> {
@@ -42,6 +42,29 @@ export interface CreateGlobalClusterCommandOutput extends CreateGlobalClusterRes
42
42
  * };
43
43
  * const command = new CreateGlobalClusterCommand(input);
44
44
  * const response = await client.send(command);
45
+ * // { // CreateGlobalClusterResult
46
+ * // GlobalCluster: { // GlobalCluster
47
+ * // GlobalClusterIdentifier: "STRING_VALUE",
48
+ * // GlobalClusterResourceId: "STRING_VALUE",
49
+ * // GlobalClusterArn: "STRING_VALUE",
50
+ * // Status: "STRING_VALUE",
51
+ * // Engine: "STRING_VALUE",
52
+ * // EngineVersion: "STRING_VALUE",
53
+ * // DatabaseName: "STRING_VALUE",
54
+ * // StorageEncrypted: true || false,
55
+ * // DeletionProtection: true || false,
56
+ * // GlobalClusterMembers: [ // GlobalClusterMemberList
57
+ * // { // GlobalClusterMember
58
+ * // DBClusterArn: "STRING_VALUE",
59
+ * // Readers: [ // ReadersArnList
60
+ * // "STRING_VALUE",
61
+ * // ],
62
+ * // IsWriter: true || false,
63
+ * // },
64
+ * // ],
65
+ * // },
66
+ * // };
67
+ *
45
68
  * ```
46
69
  *
47
70
  * @param CreateGlobalClusterCommandInput - {@link CreateGlobalClusterCommandInput}
@@ -63,6 +86,8 @@ export interface CreateGlobalClusterCommandOutput extends CreateGlobalClusterRes
63
86
  * @throws {@link InvalidDBClusterStateFault} (client fault)
64
87
  * <p>The cluster isn't in a valid state.</p>
65
88
  *
89
+ * @throws {@link DocDBServiceException}
90
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
66
91
  *
67
92
  */
68
93
  export declare class CreateGlobalClusterCommand extends $Command<CreateGlobalClusterCommandInput, CreateGlobalClusterCommandOutput, DocDBClientResolvedConfig> {
@@ -34,6 +34,66 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
34
34
  * };
35
35
  * const command = new DeleteDBClusterCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DeleteDBClusterResult
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 DeleteDBClusterCommandInput - {@link DeleteDBClusterCommandInput}
@@ -58,6 +118,8 @@ export interface DeleteDBClusterCommandOutput extends DeleteDBClusterResult, __M
58
118
  * @throws {@link SnapshotQuotaExceededFault} (client fault)
59
119
  * <p>The request would cause you to exceed the allowed number of snapshots.</p>
60
120
  *
121
+ * @throws {@link DocDBServiceException}
122
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
61
123
  *
62
124
  */
63
125
  export declare class DeleteDBClusterCommand extends $Command<DeleteDBClusterCommandInput, DeleteDBClusterCommandOutput, DocDBClientResolvedConfig> {
@@ -31,6 +31,8 @@ export interface DeleteDBClusterParameterGroupCommandOutput extends __MetadataBe
31
31
  * };
32
32
  * const command = new DeleteDBClusterParameterGroupCommand(input);
33
33
  * const response = await client.send(command);
34
+ * // {};
35
+ *
34
36
  * ```
35
37
  *
36
38
  * @param DeleteDBClusterParameterGroupCommandInput - {@link DeleteDBClusterParameterGroupCommandInput}
@@ -46,6 +48,8 @@ export interface DeleteDBClusterParameterGroupCommandOutput extends __MetadataBe
46
48
  * @throws {@link InvalidDBParameterGroupStateFault} (client fault)
47
49
  * <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>
48
50
  *
51
+ * @throws {@link DocDBServiceException}
52
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
49
53
  *
50
54
  */
51
55
  export declare class DeleteDBClusterParameterGroupCommand extends $Command<DeleteDBClusterParameterGroupCommandInput, DeleteDBClusterParameterGroupCommandOutput, DocDBClientResolvedConfig> {
@@ -34,6 +34,30 @@ export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSna
34
34
  * };
35
35
  * const command = new DeleteDBClusterSnapshotCommand(input);
36
36
  * const response = await client.send(command);
37
+ * // { // DeleteDBClusterSnapshotResult
38
+ * // DBClusterSnapshot: { // DBClusterSnapshot
39
+ * // AvailabilityZones: [ // AvailabilityZones
40
+ * // "STRING_VALUE",
41
+ * // ],
42
+ * // DBClusterSnapshotIdentifier: "STRING_VALUE",
43
+ * // DBClusterIdentifier: "STRING_VALUE",
44
+ * // SnapshotCreateTime: new Date("TIMESTAMP"),
45
+ * // Engine: "STRING_VALUE",
46
+ * // Status: "STRING_VALUE",
47
+ * // Port: Number("int"),
48
+ * // VpcId: "STRING_VALUE",
49
+ * // ClusterCreateTime: new Date("TIMESTAMP"),
50
+ * // MasterUsername: "STRING_VALUE",
51
+ * // EngineVersion: "STRING_VALUE",
52
+ * // SnapshotType: "STRING_VALUE",
53
+ * // PercentProgress: Number("int"),
54
+ * // StorageEncrypted: true || false,
55
+ * // KmsKeyId: "STRING_VALUE",
56
+ * // DBClusterSnapshotArn: "STRING_VALUE",
57
+ * // SourceDBClusterSnapshotArn: "STRING_VALUE",
58
+ * // },
59
+ * // };
60
+ *
37
61
  * ```
38
62
  *
39
63
  * @param DeleteDBClusterSnapshotCommandInput - {@link DeleteDBClusterSnapshotCommandInput}
@@ -49,6 +73,8 @@ export interface DeleteDBClusterSnapshotCommandOutput extends DeleteDBClusterSna
49
73
  * @throws {@link InvalidDBClusterSnapshotStateFault} (client fault)
50
74
  * <p>The provided value isn't a valid cluster snapshot state.</p>
51
75
  *
76
+ * @throws {@link DocDBServiceException}
77
+ * <p>Base exception class for all service exceptions from DocDB service.</p>
52
78
  *
53
79
  */
54
80
  export declare class DeleteDBClusterSnapshotCommand extends $Command<DeleteDBClusterSnapshotCommandInput, DeleteDBClusterSnapshotCommandOutput, DocDBClientResolvedConfig> {