@aws-sdk/client-docdb 3.325.0 → 3.327.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/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/CopyDBClusterParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/CopyDBClusterSnapshotCommand.d.ts +26 -0
- package/dist-types/commands/CreateDBClusterCommand.d.ts +62 -0
- package/dist-types/commands/CreateDBClusterParameterGroupCommand.d.ts +11 -0
- package/dist-types/commands/CreateDBClusterSnapshotCommand.d.ts +26 -0
- package/dist-types/commands/CreateDBInstanceCommand.d.ts +89 -0
- package/dist-types/commands/CreateDBSubnetGroupCommand.d.ts +21 -0
- package/dist-types/commands/CreateEventSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/CreateGlobalClusterCommand.d.ts +25 -0
- package/dist-types/commands/DeleteDBClusterCommand.d.ts +62 -0
- package/dist-types/commands/DeleteDBClusterParameterGroupCommand.d.ts +4 -0
- package/dist-types/commands/DeleteDBClusterSnapshotCommand.d.ts +26 -0
- package/dist-types/commands/DeleteDBInstanceCommand.d.ts +89 -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 +25 -0
- package/dist-types/commands/DescribeCertificatesCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBClusterParameterGroupsCommand.d.ts +14 -0
- package/dist-types/commands/DescribeDBClusterParametersCommand.d.ts +20 -0
- package/dist-types/commands/DescribeDBClusterSnapshotAttributesCommand.d.ts +16 -0
- package/dist-types/commands/DescribeDBClusterSnapshotsCommand.d.ts +29 -0
- package/dist-types/commands/DescribeDBClustersCommand.d.ts +65 -0
- package/dist-types/commands/DescribeDBEngineVersionsCommand.d.ts +28 -0
- package/dist-types/commands/DescribeDBInstancesCommand.d.ts +92 -0
- package/dist-types/commands/DescribeDBSubnetGroupsCommand.d.ts +24 -0
- package/dist-types/commands/DescribeEngineDefaultClusterParametersCommand.d.ts +23 -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/DescribeGlobalClustersCommand.d.ts +28 -0
- package/dist-types/commands/DescribeOrderableDBInstanceOptionsCommand.d.ts +20 -0
- package/dist-types/commands/DescribePendingMaintenanceActionsCommand.d.ts +21 -0
- package/dist-types/commands/FailoverDBClusterCommand.d.ts +62 -0
- package/dist-types/commands/ListTagsForResourceCommand.d.ts +11 -0
- package/dist-types/commands/ModifyDBClusterCommand.d.ts +62 -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 +89 -0
- package/dist-types/commands/ModifyDBSubnetGroupCommand.d.ts +21 -0
- package/dist-types/commands/ModifyEventSubscriptionCommand.d.ts +21 -0
- package/dist-types/commands/ModifyGlobalClusterCommand.d.ts +25 -0
- package/dist-types/commands/RebootDBInstanceCommand.d.ts +89 -0
- package/dist-types/commands/RemoveFromGlobalClusterCommand.d.ts +25 -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/RestoreDBClusterFromSnapshotCommand.d.ts +62 -0
- package/dist-types/commands/RestoreDBClusterToPointInTimeCommand.d.ts +62 -0
- package/dist-types/commands/StartDBClusterCommand.d.ts +62 -0
- package/dist-types/commands/StopDBClusterCommand.d.ts +62 -0
- package/package.json +8 -8
|
@@ -31,6 +31,93 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new DeleteDBInstanceCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // DeleteDBInstanceResult
|
|
35
|
+
* // DBInstance: { // DBInstance
|
|
36
|
+
* // DBInstanceIdentifier: "STRING_VALUE",
|
|
37
|
+
* // DBInstanceClass: "STRING_VALUE",
|
|
38
|
+
* // Engine: "STRING_VALUE",
|
|
39
|
+
* // DBInstanceStatus: "STRING_VALUE",
|
|
40
|
+
* // Endpoint: { // Endpoint
|
|
41
|
+
* // Address: "STRING_VALUE",
|
|
42
|
+
* // Port: Number("int"),
|
|
43
|
+
* // HostedZoneId: "STRING_VALUE",
|
|
44
|
+
* // },
|
|
45
|
+
* // InstanceCreateTime: new Date("TIMESTAMP"),
|
|
46
|
+
* // PreferredBackupWindow: "STRING_VALUE",
|
|
47
|
+
* // BackupRetentionPeriod: Number("int"),
|
|
48
|
+
* // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
|
|
49
|
+
* // { // VpcSecurityGroupMembership
|
|
50
|
+
* // VpcSecurityGroupId: "STRING_VALUE",
|
|
51
|
+
* // Status: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // AvailabilityZone: "STRING_VALUE",
|
|
55
|
+
* // DBSubnetGroup: { // DBSubnetGroup
|
|
56
|
+
* // DBSubnetGroupName: "STRING_VALUE",
|
|
57
|
+
* // DBSubnetGroupDescription: "STRING_VALUE",
|
|
58
|
+
* // VpcId: "STRING_VALUE",
|
|
59
|
+
* // SubnetGroupStatus: "STRING_VALUE",
|
|
60
|
+
* // Subnets: [ // SubnetList
|
|
61
|
+
* // { // Subnet
|
|
62
|
+
* // SubnetIdentifier: "STRING_VALUE",
|
|
63
|
+
* // SubnetAvailabilityZone: { // AvailabilityZone
|
|
64
|
+
* // Name: "STRING_VALUE",
|
|
65
|
+
* // },
|
|
66
|
+
* // SubnetStatus: "STRING_VALUE",
|
|
67
|
+
* // },
|
|
68
|
+
* // ],
|
|
69
|
+
* // DBSubnetGroupArn: "STRING_VALUE",
|
|
70
|
+
* // },
|
|
71
|
+
* // PreferredMaintenanceWindow: "STRING_VALUE",
|
|
72
|
+
* // PendingModifiedValues: { // PendingModifiedValues
|
|
73
|
+
* // DBInstanceClass: "STRING_VALUE",
|
|
74
|
+
* // AllocatedStorage: Number("int"),
|
|
75
|
+
* // MasterUserPassword: "STRING_VALUE",
|
|
76
|
+
* // Port: Number("int"),
|
|
77
|
+
* // BackupRetentionPeriod: Number("int"),
|
|
78
|
+
* // MultiAZ: true || false,
|
|
79
|
+
* // EngineVersion: "STRING_VALUE",
|
|
80
|
+
* // LicenseModel: "STRING_VALUE",
|
|
81
|
+
* // Iops: Number("int"),
|
|
82
|
+
* // DBInstanceIdentifier: "STRING_VALUE",
|
|
83
|
+
* // StorageType: "STRING_VALUE",
|
|
84
|
+
* // CACertificateIdentifier: "STRING_VALUE",
|
|
85
|
+
* // DBSubnetGroupName: "STRING_VALUE",
|
|
86
|
+
* // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
|
|
87
|
+
* // LogTypesToEnable: [ // LogTypeList
|
|
88
|
+
* // "STRING_VALUE",
|
|
89
|
+
* // ],
|
|
90
|
+
* // LogTypesToDisable: [
|
|
91
|
+
* // "STRING_VALUE",
|
|
92
|
+
* // ],
|
|
93
|
+
* // },
|
|
94
|
+
* // },
|
|
95
|
+
* // LatestRestorableTime: new Date("TIMESTAMP"),
|
|
96
|
+
* // EngineVersion: "STRING_VALUE",
|
|
97
|
+
* // AutoMinorVersionUpgrade: true || false,
|
|
98
|
+
* // PubliclyAccessible: true || false,
|
|
99
|
+
* // StatusInfos: [ // DBInstanceStatusInfoList
|
|
100
|
+
* // { // DBInstanceStatusInfo
|
|
101
|
+
* // StatusType: "STRING_VALUE",
|
|
102
|
+
* // Normal: true || false,
|
|
103
|
+
* // Status: "STRING_VALUE",
|
|
104
|
+
* // Message: "STRING_VALUE",
|
|
105
|
+
* // },
|
|
106
|
+
* // ],
|
|
107
|
+
* // DBClusterIdentifier: "STRING_VALUE",
|
|
108
|
+
* // StorageEncrypted: true || false,
|
|
109
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
110
|
+
* // DbiResourceId: "STRING_VALUE",
|
|
111
|
+
* // CACertificateIdentifier: "STRING_VALUE",
|
|
112
|
+
* // CopyTagsToSnapshot: true || false,
|
|
113
|
+
* // PromotionTier: Number("int"),
|
|
114
|
+
* // DBInstanceArn: "STRING_VALUE",
|
|
115
|
+
* // EnabledCloudwatchLogsExports: [
|
|
116
|
+
* // "STRING_VALUE",
|
|
117
|
+
* // ],
|
|
118
|
+
* // },
|
|
119
|
+
* // };
|
|
120
|
+
*
|
|
34
121
|
* ```
|
|
35
122
|
*
|
|
36
123
|
* @param DeleteDBInstanceCommandInput - {@link DeleteDBInstanceCommandInput}
|
|
@@ -57,6 +144,8 @@ export interface DeleteDBInstanceCommandOutput extends DeleteDBInstanceResult, _
|
|
|
57
144
|
* @throws {@link SnapshotQuotaExceededFault} (client fault)
|
|
58
145
|
* <p>The request would cause you to exceed the allowed number of snapshots.</p>
|
|
59
146
|
*
|
|
147
|
+
* @throws {@link DocDBServiceException}
|
|
148
|
+
* <p>Base exception class for all service exceptions from DocDB service.</p>
|
|
60
149
|
*
|
|
61
150
|
*/
|
|
62
151
|
export declare class DeleteDBInstanceCommand extends $Command<DeleteDBInstanceCommandInput, DeleteDBInstanceCommandOutput, DocDBClientResolvedConfig> {
|
|
@@ -35,6 +35,8 @@ export interface DeleteDBSubnetGroupCommandOutput extends __MetadataBearer {
|
|
|
35
35
|
* };
|
|
36
36
|
* const command = new DeleteDBSubnetGroupCommand(input);
|
|
37
37
|
* const response = await client.send(command);
|
|
38
|
+
* // {};
|
|
39
|
+
*
|
|
38
40
|
* ```
|
|
39
41
|
*
|
|
40
42
|
* @param DeleteDBSubnetGroupCommandInput - {@link DeleteDBSubnetGroupCommandInput}
|
|
@@ -53,6 +55,8 @@ export interface DeleteDBSubnetGroupCommandOutput extends __MetadataBearer {
|
|
|
53
55
|
* @throws {@link InvalidDBSubnetStateFault} (client fault)
|
|
54
56
|
* <p> The subnet isn't in the <i>available</i> state. </p>
|
|
55
57
|
*
|
|
58
|
+
* @throws {@link DocDBServiceException}
|
|
59
|
+
* <p>Base exception class for all service exceptions from DocDB service.</p>
|
|
56
60
|
*
|
|
57
61
|
*/
|
|
58
62
|
export declare class DeleteDBSubnetGroupCommand extends $Command<DeleteDBSubnetGroupCommandInput, DeleteDBSubnetGroupCommandOutput, DocDBClientResolvedConfig> {
|
|
@@ -31,6 +31,25 @@ export interface DeleteEventSubscriptionCommandOutput extends DeleteEventSubscri
|
|
|
31
31
|
* };
|
|
32
32
|
* const command = new DeleteEventSubscriptionCommand(input);
|
|
33
33
|
* const response = await client.send(command);
|
|
34
|
+
* // { // DeleteEventSubscriptionResult
|
|
35
|
+
* // EventSubscription: { // EventSubscription
|
|
36
|
+
* // CustomerAwsId: "STRING_VALUE",
|
|
37
|
+
* // CustSubscriptionId: "STRING_VALUE",
|
|
38
|
+
* // SnsTopicArn: "STRING_VALUE",
|
|
39
|
+
* // Status: "STRING_VALUE",
|
|
40
|
+
* // SubscriptionCreationTime: "STRING_VALUE",
|
|
41
|
+
* // SourceType: "STRING_VALUE",
|
|
42
|
+
* // SourceIdsList: [ // SourceIdsList
|
|
43
|
+
* // "STRING_VALUE",
|
|
44
|
+
* // ],
|
|
45
|
+
* // EventCategoriesList: [ // EventCategoriesList
|
|
46
|
+
* // "STRING_VALUE",
|
|
47
|
+
* // ],
|
|
48
|
+
* // Enabled: true || false,
|
|
49
|
+
* // EventSubscriptionArn: "STRING_VALUE",
|
|
50
|
+
* // },
|
|
51
|
+
* // };
|
|
52
|
+
*
|
|
34
53
|
* ```
|
|
35
54
|
*
|
|
36
55
|
* @param DeleteEventSubscriptionCommandInput - {@link DeleteEventSubscriptionCommandInput}
|
|
@@ -46,6 +65,8 @@ export interface DeleteEventSubscriptionCommandOutput extends DeleteEventSubscri
|
|
|
46
65
|
* @throws {@link SubscriptionNotFoundFault} (client fault)
|
|
47
66
|
* <p>The subscription name does not exist. </p>
|
|
48
67
|
*
|
|
68
|
+
* @throws {@link DocDBServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from DocDB service.</p>
|
|
49
70
|
*
|
|
50
71
|
*/
|
|
51
72
|
export declare class DeleteEventSubscriptionCommand extends $Command<DeleteEventSubscriptionCommandInput, DeleteEventSubscriptionCommandOutput, DocDBClientResolvedConfig> {
|
|
@@ -34,6 +34,29 @@ export interface DeleteGlobalClusterCommandOutput extends DeleteGlobalClusterRes
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new DeleteGlobalClusterCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // DeleteGlobalClusterResult
|
|
38
|
+
* // GlobalCluster: { // GlobalCluster
|
|
39
|
+
* // GlobalClusterIdentifier: "STRING_VALUE",
|
|
40
|
+
* // GlobalClusterResourceId: "STRING_VALUE",
|
|
41
|
+
* // GlobalClusterArn: "STRING_VALUE",
|
|
42
|
+
* // Status: "STRING_VALUE",
|
|
43
|
+
* // Engine: "STRING_VALUE",
|
|
44
|
+
* // EngineVersion: "STRING_VALUE",
|
|
45
|
+
* // DatabaseName: "STRING_VALUE",
|
|
46
|
+
* // StorageEncrypted: true || false,
|
|
47
|
+
* // DeletionProtection: true || false,
|
|
48
|
+
* // GlobalClusterMembers: [ // GlobalClusterMemberList
|
|
49
|
+
* // { // GlobalClusterMember
|
|
50
|
+
* // DBClusterArn: "STRING_VALUE",
|
|
51
|
+
* // Readers: [ // ReadersArnList
|
|
52
|
+
* // "STRING_VALUE",
|
|
53
|
+
* // ],
|
|
54
|
+
* // IsWriter: true || false,
|
|
55
|
+
* // },
|
|
56
|
+
* // ],
|
|
57
|
+
* // },
|
|
58
|
+
* // };
|
|
59
|
+
*
|
|
37
60
|
* ```
|
|
38
61
|
*
|
|
39
62
|
* @param DeleteGlobalClusterCommandInput - {@link DeleteGlobalClusterCommandInput}
|
|
@@ -48,6 +71,8 @@ export interface DeleteGlobalClusterCommandOutput extends DeleteGlobalClusterRes
|
|
|
48
71
|
* @throws {@link InvalidGlobalClusterStateFault} (client fault)
|
|
49
72
|
* <p>The requested operation can't be performed while the cluster is in this state.</p>
|
|
50
73
|
*
|
|
74
|
+
* @throws {@link DocDBServiceException}
|
|
75
|
+
* <p>Base exception class for all service exceptions from DocDB service.</p>
|
|
51
76
|
*
|
|
52
77
|
*/
|
|
53
78
|
export declare class DeleteGlobalClusterCommand extends $Command<DeleteGlobalClusterCommandInput, DeleteGlobalClusterCommandOutput, DocDBClientResolvedConfig> {
|
|
@@ -41,6 +41,20 @@ export interface DescribeCertificatesCommandOutput extends CertificateMessage, _
|
|
|
41
41
|
* };
|
|
42
42
|
* const command = new DescribeCertificatesCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
|
+
* // { // CertificateMessage
|
|
45
|
+
* // Certificates: [ // CertificateList
|
|
46
|
+
* // { // Certificate
|
|
47
|
+
* // CertificateIdentifier: "STRING_VALUE",
|
|
48
|
+
* // CertificateType: "STRING_VALUE",
|
|
49
|
+
* // Thumbprint: "STRING_VALUE",
|
|
50
|
+
* // ValidFrom: new Date("TIMESTAMP"),
|
|
51
|
+
* // ValidTill: new Date("TIMESTAMP"),
|
|
52
|
+
* // CertificateArn: "STRING_VALUE",
|
|
53
|
+
* // },
|
|
54
|
+
* // ],
|
|
55
|
+
* // Marker: "STRING_VALUE",
|
|
56
|
+
* // };
|
|
57
|
+
*
|
|
44
58
|
* ```
|
|
45
59
|
*
|
|
46
60
|
* @param DescribeCertificatesCommandInput - {@link DescribeCertificatesCommandInput}
|
|
@@ -53,6 +67,8 @@ export interface DescribeCertificatesCommandOutput extends CertificateMessage, _
|
|
|
53
67
|
* <p>
|
|
54
68
|
* <code>CertificateIdentifier</code> doesn't refer to an existing certificate. </p>
|
|
55
69
|
*
|
|
70
|
+
* @throws {@link DocDBServiceException}
|
|
71
|
+
* <p>Base exception class for all service exceptions from DocDB service.</p>
|
|
56
72
|
*
|
|
57
73
|
*/
|
|
58
74
|
export declare class DescribeCertificatesCommand extends $Command<DescribeCertificatesCommandInput, DescribeCertificatesCommandOutput, DocDBClientResolvedConfig> {
|
|
@@ -41,6 +41,18 @@ export interface DescribeDBClusterParameterGroupsCommandOutput extends DBCluster
|
|
|
41
41
|
* };
|
|
42
42
|
* const command = new DescribeDBClusterParameterGroupsCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
|
+
* // { // DBClusterParameterGroupsMessage
|
|
45
|
+
* // Marker: "STRING_VALUE",
|
|
46
|
+
* // DBClusterParameterGroups: [ // DBClusterParameterGroupList
|
|
47
|
+
* // { // DBClusterParameterGroup
|
|
48
|
+
* // DBClusterParameterGroupName: "STRING_VALUE",
|
|
49
|
+
* // DBParameterGroupFamily: "STRING_VALUE",
|
|
50
|
+
* // Description: "STRING_VALUE",
|
|
51
|
+
* // DBClusterParameterGroupArn: "STRING_VALUE",
|
|
52
|
+
* // },
|
|
53
|
+
* // ],
|
|
54
|
+
* // };
|
|
55
|
+
*
|
|
44
56
|
* ```
|
|
45
57
|
*
|
|
46
58
|
* @param DescribeDBClusterParameterGroupsCommandInput - {@link DescribeDBClusterParameterGroupsCommandInput}
|
|
@@ -53,6 +65,8 @@ export interface DescribeDBClusterParameterGroupsCommandOutput extends DBCluster
|
|
|
53
65
|
* <p>
|
|
54
66
|
* <code>DBParameterGroupName</code> doesn't refer to an existing parameter group. </p>
|
|
55
67
|
*
|
|
68
|
+
* @throws {@link DocDBServiceException}
|
|
69
|
+
* <p>Base exception class for all service exceptions from DocDB service.</p>
|
|
56
70
|
*
|
|
57
71
|
*/
|
|
58
72
|
export declare class DescribeDBClusterParameterGroupsCommand extends $Command<DescribeDBClusterParameterGroupsCommandInput, DescribeDBClusterParameterGroupsCommandOutput, DocDBClientResolvedConfig> {
|
|
@@ -43,6 +43,24 @@ export interface DescribeDBClusterParametersCommandOutput extends DBClusterParam
|
|
|
43
43
|
* };
|
|
44
44
|
* const command = new DescribeDBClusterParametersCommand(input);
|
|
45
45
|
* const response = await client.send(command);
|
|
46
|
+
* // { // DBClusterParameterGroupDetails
|
|
47
|
+
* // Parameters: [ // ParametersList
|
|
48
|
+
* // { // Parameter
|
|
49
|
+
* // ParameterName: "STRING_VALUE",
|
|
50
|
+
* // ParameterValue: "STRING_VALUE",
|
|
51
|
+
* // Description: "STRING_VALUE",
|
|
52
|
+
* // Source: "STRING_VALUE",
|
|
53
|
+
* // ApplyType: "STRING_VALUE",
|
|
54
|
+
* // DataType: "STRING_VALUE",
|
|
55
|
+
* // AllowedValues: "STRING_VALUE",
|
|
56
|
+
* // IsModifiable: true || false,
|
|
57
|
+
* // MinimumEngineVersion: "STRING_VALUE",
|
|
58
|
+
* // ApplyMethod: "immediate" || "pending-reboot",
|
|
59
|
+
* // },
|
|
60
|
+
* // ],
|
|
61
|
+
* // Marker: "STRING_VALUE",
|
|
62
|
+
* // };
|
|
63
|
+
*
|
|
46
64
|
* ```
|
|
47
65
|
*
|
|
48
66
|
* @param DescribeDBClusterParametersCommandInput - {@link DescribeDBClusterParametersCommandInput}
|
|
@@ -55,6 +73,8 @@ export interface DescribeDBClusterParametersCommandOutput extends DBClusterParam
|
|
|
55
73
|
* <p>
|
|
56
74
|
* <code>DBParameterGroupName</code> doesn't refer to an existing parameter group. </p>
|
|
57
75
|
*
|
|
76
|
+
* @throws {@link DocDBServiceException}
|
|
77
|
+
* <p>Base exception class for all service exceptions from DocDB service.</p>
|
|
58
78
|
*
|
|
59
79
|
*/
|
|
60
80
|
export declare class DescribeDBClusterParametersCommand extends $Command<DescribeDBClusterParametersCommandInput, DescribeDBClusterParametersCommandOutput, DocDBClientResolvedConfig> {
|
|
@@ -34,6 +34,20 @@ export interface DescribeDBClusterSnapshotAttributesCommandOutput extends Descri
|
|
|
34
34
|
* };
|
|
35
35
|
* const command = new DescribeDBClusterSnapshotAttributesCommand(input);
|
|
36
36
|
* const response = await client.send(command);
|
|
37
|
+
* // { // DescribeDBClusterSnapshotAttributesResult
|
|
38
|
+
* // DBClusterSnapshotAttributesResult: { // DBClusterSnapshotAttributesResult
|
|
39
|
+
* // DBClusterSnapshotIdentifier: "STRING_VALUE",
|
|
40
|
+
* // DBClusterSnapshotAttributes: [ // DBClusterSnapshotAttributeList
|
|
41
|
+
* // { // DBClusterSnapshotAttribute
|
|
42
|
+
* // AttributeName: "STRING_VALUE",
|
|
43
|
+
* // AttributeValues: [ // AttributeValueList
|
|
44
|
+
* // "STRING_VALUE",
|
|
45
|
+
* // ],
|
|
46
|
+
* // },
|
|
47
|
+
* // ],
|
|
48
|
+
* // },
|
|
49
|
+
* // };
|
|
50
|
+
*
|
|
37
51
|
* ```
|
|
38
52
|
*
|
|
39
53
|
* @param DescribeDBClusterSnapshotAttributesCommandInput - {@link DescribeDBClusterSnapshotAttributesCommandInput}
|
|
@@ -46,6 +60,8 @@ export interface DescribeDBClusterSnapshotAttributesCommandOutput extends Descri
|
|
|
46
60
|
* <p>
|
|
47
61
|
* <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing cluster snapshot. </p>
|
|
48
62
|
*
|
|
63
|
+
* @throws {@link DocDBServiceException}
|
|
64
|
+
* <p>Base exception class for all service exceptions from DocDB service.</p>
|
|
49
65
|
*
|
|
50
66
|
*/
|
|
51
67
|
export declare class DescribeDBClusterSnapshotAttributesCommand extends $Command<DescribeDBClusterSnapshotAttributesCommandInput, DescribeDBClusterSnapshotAttributesCommandOutput, DocDBClientResolvedConfig> {
|
|
@@ -45,6 +45,33 @@ export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapsh
|
|
|
45
45
|
* };
|
|
46
46
|
* const command = new DescribeDBClusterSnapshotsCommand(input);
|
|
47
47
|
* const response = await client.send(command);
|
|
48
|
+
* // { // DBClusterSnapshotMessage
|
|
49
|
+
* // Marker: "STRING_VALUE",
|
|
50
|
+
* // DBClusterSnapshots: [ // DBClusterSnapshotList
|
|
51
|
+
* // { // DBClusterSnapshot
|
|
52
|
+
* // AvailabilityZones: [ // AvailabilityZones
|
|
53
|
+
* // "STRING_VALUE",
|
|
54
|
+
* // ],
|
|
55
|
+
* // DBClusterSnapshotIdentifier: "STRING_VALUE",
|
|
56
|
+
* // DBClusterIdentifier: "STRING_VALUE",
|
|
57
|
+
* // SnapshotCreateTime: new Date("TIMESTAMP"),
|
|
58
|
+
* // Engine: "STRING_VALUE",
|
|
59
|
+
* // Status: "STRING_VALUE",
|
|
60
|
+
* // Port: Number("int"),
|
|
61
|
+
* // VpcId: "STRING_VALUE",
|
|
62
|
+
* // ClusterCreateTime: new Date("TIMESTAMP"),
|
|
63
|
+
* // MasterUsername: "STRING_VALUE",
|
|
64
|
+
* // EngineVersion: "STRING_VALUE",
|
|
65
|
+
* // SnapshotType: "STRING_VALUE",
|
|
66
|
+
* // PercentProgress: Number("int"),
|
|
67
|
+
* // StorageEncrypted: true || false,
|
|
68
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
69
|
+
* // DBClusterSnapshotArn: "STRING_VALUE",
|
|
70
|
+
* // SourceDBClusterSnapshotArn: "STRING_VALUE",
|
|
71
|
+
* // },
|
|
72
|
+
* // ],
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
48
75
|
* ```
|
|
49
76
|
*
|
|
50
77
|
* @param DescribeDBClusterSnapshotsCommandInput - {@link DescribeDBClusterSnapshotsCommandInput}
|
|
@@ -57,6 +84,8 @@ export interface DescribeDBClusterSnapshotsCommandOutput extends DBClusterSnapsh
|
|
|
57
84
|
* <p>
|
|
58
85
|
* <code>DBClusterSnapshotIdentifier</code> doesn't refer to an existing cluster snapshot. </p>
|
|
59
86
|
*
|
|
87
|
+
* @throws {@link DocDBServiceException}
|
|
88
|
+
* <p>Base exception class for all service exceptions from DocDB service.</p>
|
|
60
89
|
*
|
|
61
90
|
*/
|
|
62
91
|
export declare class DescribeDBClusterSnapshotsCommand extends $Command<DescribeDBClusterSnapshotsCommandInput, DescribeDBClusterSnapshotsCommandOutput, DocDBClientResolvedConfig> {
|
|
@@ -46,6 +46,69 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met
|
|
|
46
46
|
* };
|
|
47
47
|
* const command = new DescribeDBClustersCommand(input);
|
|
48
48
|
* const response = await client.send(command);
|
|
49
|
+
* // { // DBClusterMessage
|
|
50
|
+
* // Marker: "STRING_VALUE",
|
|
51
|
+
* // DBClusters: [ // DBClusterList
|
|
52
|
+
* // { // DBCluster
|
|
53
|
+
* // AvailabilityZones: [ // AvailabilityZones
|
|
54
|
+
* // "STRING_VALUE",
|
|
55
|
+
* // ],
|
|
56
|
+
* // BackupRetentionPeriod: Number("int"),
|
|
57
|
+
* // DBClusterIdentifier: "STRING_VALUE",
|
|
58
|
+
* // DBClusterParameterGroup: "STRING_VALUE",
|
|
59
|
+
* // DBSubnetGroup: "STRING_VALUE",
|
|
60
|
+
* // Status: "STRING_VALUE",
|
|
61
|
+
* // PercentProgress: "STRING_VALUE",
|
|
62
|
+
* // EarliestRestorableTime: new Date("TIMESTAMP"),
|
|
63
|
+
* // Endpoint: "STRING_VALUE",
|
|
64
|
+
* // ReaderEndpoint: "STRING_VALUE",
|
|
65
|
+
* // MultiAZ: true || false,
|
|
66
|
+
* // Engine: "STRING_VALUE",
|
|
67
|
+
* // EngineVersion: "STRING_VALUE",
|
|
68
|
+
* // LatestRestorableTime: new Date("TIMESTAMP"),
|
|
69
|
+
* // Port: Number("int"),
|
|
70
|
+
* // MasterUsername: "STRING_VALUE",
|
|
71
|
+
* // PreferredBackupWindow: "STRING_VALUE",
|
|
72
|
+
* // PreferredMaintenanceWindow: "STRING_VALUE",
|
|
73
|
+
* // ReplicationSourceIdentifier: "STRING_VALUE",
|
|
74
|
+
* // ReadReplicaIdentifiers: [ // ReadReplicaIdentifierList
|
|
75
|
+
* // "STRING_VALUE",
|
|
76
|
+
* // ],
|
|
77
|
+
* // DBClusterMembers: [ // DBClusterMemberList
|
|
78
|
+
* // { // DBClusterMember
|
|
79
|
+
* // DBInstanceIdentifier: "STRING_VALUE",
|
|
80
|
+
* // IsClusterWriter: true || false,
|
|
81
|
+
* // DBClusterParameterGroupStatus: "STRING_VALUE",
|
|
82
|
+
* // PromotionTier: Number("int"),
|
|
83
|
+
* // },
|
|
84
|
+
* // ],
|
|
85
|
+
* // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
|
|
86
|
+
* // { // VpcSecurityGroupMembership
|
|
87
|
+
* // VpcSecurityGroupId: "STRING_VALUE",
|
|
88
|
+
* // Status: "STRING_VALUE",
|
|
89
|
+
* // },
|
|
90
|
+
* // ],
|
|
91
|
+
* // HostedZoneId: "STRING_VALUE",
|
|
92
|
+
* // StorageEncrypted: true || false,
|
|
93
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
94
|
+
* // DbClusterResourceId: "STRING_VALUE",
|
|
95
|
+
* // DBClusterArn: "STRING_VALUE",
|
|
96
|
+
* // AssociatedRoles: [ // DBClusterRoles
|
|
97
|
+
* // { // DBClusterRole
|
|
98
|
+
* // RoleArn: "STRING_VALUE",
|
|
99
|
+
* // Status: "STRING_VALUE",
|
|
100
|
+
* // },
|
|
101
|
+
* // ],
|
|
102
|
+
* // CloneGroupId: "STRING_VALUE",
|
|
103
|
+
* // ClusterCreateTime: new Date("TIMESTAMP"),
|
|
104
|
+
* // EnabledCloudwatchLogsExports: [ // LogTypeList
|
|
105
|
+
* // "STRING_VALUE",
|
|
106
|
+
* // ],
|
|
107
|
+
* // DeletionProtection: true || false,
|
|
108
|
+
* // },
|
|
109
|
+
* // ],
|
|
110
|
+
* // };
|
|
111
|
+
*
|
|
49
112
|
* ```
|
|
50
113
|
*
|
|
51
114
|
* @param DescribeDBClustersCommandInput - {@link DescribeDBClustersCommandInput}
|
|
@@ -58,6 +121,8 @@ export interface DescribeDBClustersCommandOutput extends DBClusterMessage, __Met
|
|
|
58
121
|
* <p>
|
|
59
122
|
* <code>DBClusterIdentifier</code> doesn't refer to an existing cluster. </p>
|
|
60
123
|
*
|
|
124
|
+
* @throws {@link DocDBServiceException}
|
|
125
|
+
* <p>Base exception class for all service exceptions from DocDB service.</p>
|
|
61
126
|
*
|
|
62
127
|
*/
|
|
63
128
|
export declare class DescribeDBClustersCommand extends $Command<DescribeDBClustersCommandInput, DescribeDBClustersCommandOutput, DocDBClientResolvedConfig> {
|
|
@@ -46,6 +46,32 @@ export interface DescribeDBEngineVersionsCommandOutput extends DBEngineVersionMe
|
|
|
46
46
|
* };
|
|
47
47
|
* const command = new DescribeDBEngineVersionsCommand(input);
|
|
48
48
|
* const response = await client.send(command);
|
|
49
|
+
* // { // DBEngineVersionMessage
|
|
50
|
+
* // Marker: "STRING_VALUE",
|
|
51
|
+
* // DBEngineVersions: [ // DBEngineVersionList
|
|
52
|
+
* // { // DBEngineVersion
|
|
53
|
+
* // Engine: "STRING_VALUE",
|
|
54
|
+
* // EngineVersion: "STRING_VALUE",
|
|
55
|
+
* // DBParameterGroupFamily: "STRING_VALUE",
|
|
56
|
+
* // DBEngineDescription: "STRING_VALUE",
|
|
57
|
+
* // DBEngineVersionDescription: "STRING_VALUE",
|
|
58
|
+
* // ValidUpgradeTarget: [ // ValidUpgradeTargetList
|
|
59
|
+
* // { // UpgradeTarget
|
|
60
|
+
* // Engine: "STRING_VALUE",
|
|
61
|
+
* // EngineVersion: "STRING_VALUE",
|
|
62
|
+
* // Description: "STRING_VALUE",
|
|
63
|
+
* // AutoUpgrade: true || false,
|
|
64
|
+
* // IsMajorVersionUpgrade: true || false,
|
|
65
|
+
* // },
|
|
66
|
+
* // ],
|
|
67
|
+
* // ExportableLogTypes: [ // LogTypeList
|
|
68
|
+
* // "STRING_VALUE",
|
|
69
|
+
* // ],
|
|
70
|
+
* // SupportsLogExportsToCloudwatchLogs: true || false,
|
|
71
|
+
* // },
|
|
72
|
+
* // ],
|
|
73
|
+
* // };
|
|
74
|
+
*
|
|
49
75
|
* ```
|
|
50
76
|
*
|
|
51
77
|
* @param DescribeDBEngineVersionsCommandInput - {@link DescribeDBEngineVersionsCommandInput}
|
|
@@ -54,6 +80,8 @@ export interface DescribeDBEngineVersionsCommandOutput extends DBEngineVersionMe
|
|
|
54
80
|
* @see {@link DescribeDBEngineVersionsCommandOutput} for command's `response` shape.
|
|
55
81
|
* @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape.
|
|
56
82
|
*
|
|
83
|
+
* @throws {@link DocDBServiceException}
|
|
84
|
+
* <p>Base exception class for all service exceptions from DocDB service.</p>
|
|
57
85
|
*
|
|
58
86
|
*/
|
|
59
87
|
export declare class DescribeDBEngineVersionsCommand extends $Command<DescribeDBEngineVersionsCommandInput, DescribeDBEngineVersionsCommandOutput, DocDBClientResolvedConfig> {
|
|
@@ -41,6 +41,96 @@ export interface DescribeDBInstancesCommandOutput extends DBInstanceMessage, __M
|
|
|
41
41
|
* };
|
|
42
42
|
* const command = new DescribeDBInstancesCommand(input);
|
|
43
43
|
* const response = await client.send(command);
|
|
44
|
+
* // { // DBInstanceMessage
|
|
45
|
+
* // Marker: "STRING_VALUE",
|
|
46
|
+
* // DBInstances: [ // DBInstanceList
|
|
47
|
+
* // { // DBInstance
|
|
48
|
+
* // DBInstanceIdentifier: "STRING_VALUE",
|
|
49
|
+
* // DBInstanceClass: "STRING_VALUE",
|
|
50
|
+
* // Engine: "STRING_VALUE",
|
|
51
|
+
* // DBInstanceStatus: "STRING_VALUE",
|
|
52
|
+
* // Endpoint: { // Endpoint
|
|
53
|
+
* // Address: "STRING_VALUE",
|
|
54
|
+
* // Port: Number("int"),
|
|
55
|
+
* // HostedZoneId: "STRING_VALUE",
|
|
56
|
+
* // },
|
|
57
|
+
* // InstanceCreateTime: new Date("TIMESTAMP"),
|
|
58
|
+
* // PreferredBackupWindow: "STRING_VALUE",
|
|
59
|
+
* // BackupRetentionPeriod: Number("int"),
|
|
60
|
+
* // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList
|
|
61
|
+
* // { // VpcSecurityGroupMembership
|
|
62
|
+
* // VpcSecurityGroupId: "STRING_VALUE",
|
|
63
|
+
* // Status: "STRING_VALUE",
|
|
64
|
+
* // },
|
|
65
|
+
* // ],
|
|
66
|
+
* // AvailabilityZone: "STRING_VALUE",
|
|
67
|
+
* // DBSubnetGroup: { // DBSubnetGroup
|
|
68
|
+
* // DBSubnetGroupName: "STRING_VALUE",
|
|
69
|
+
* // DBSubnetGroupDescription: "STRING_VALUE",
|
|
70
|
+
* // VpcId: "STRING_VALUE",
|
|
71
|
+
* // SubnetGroupStatus: "STRING_VALUE",
|
|
72
|
+
* // Subnets: [ // SubnetList
|
|
73
|
+
* // { // Subnet
|
|
74
|
+
* // SubnetIdentifier: "STRING_VALUE",
|
|
75
|
+
* // SubnetAvailabilityZone: { // AvailabilityZone
|
|
76
|
+
* // Name: "STRING_VALUE",
|
|
77
|
+
* // },
|
|
78
|
+
* // SubnetStatus: "STRING_VALUE",
|
|
79
|
+
* // },
|
|
80
|
+
* // ],
|
|
81
|
+
* // DBSubnetGroupArn: "STRING_VALUE",
|
|
82
|
+
* // },
|
|
83
|
+
* // PreferredMaintenanceWindow: "STRING_VALUE",
|
|
84
|
+
* // PendingModifiedValues: { // PendingModifiedValues
|
|
85
|
+
* // DBInstanceClass: "STRING_VALUE",
|
|
86
|
+
* // AllocatedStorage: Number("int"),
|
|
87
|
+
* // MasterUserPassword: "STRING_VALUE",
|
|
88
|
+
* // Port: Number("int"),
|
|
89
|
+
* // BackupRetentionPeriod: Number("int"),
|
|
90
|
+
* // MultiAZ: true || false,
|
|
91
|
+
* // EngineVersion: "STRING_VALUE",
|
|
92
|
+
* // LicenseModel: "STRING_VALUE",
|
|
93
|
+
* // Iops: Number("int"),
|
|
94
|
+
* // DBInstanceIdentifier: "STRING_VALUE",
|
|
95
|
+
* // StorageType: "STRING_VALUE",
|
|
96
|
+
* // CACertificateIdentifier: "STRING_VALUE",
|
|
97
|
+
* // DBSubnetGroupName: "STRING_VALUE",
|
|
98
|
+
* // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports
|
|
99
|
+
* // LogTypesToEnable: [ // LogTypeList
|
|
100
|
+
* // "STRING_VALUE",
|
|
101
|
+
* // ],
|
|
102
|
+
* // LogTypesToDisable: [
|
|
103
|
+
* // "STRING_VALUE",
|
|
104
|
+
* // ],
|
|
105
|
+
* // },
|
|
106
|
+
* // },
|
|
107
|
+
* // LatestRestorableTime: new Date("TIMESTAMP"),
|
|
108
|
+
* // EngineVersion: "STRING_VALUE",
|
|
109
|
+
* // AutoMinorVersionUpgrade: true || false,
|
|
110
|
+
* // PubliclyAccessible: true || false,
|
|
111
|
+
* // StatusInfos: [ // DBInstanceStatusInfoList
|
|
112
|
+
* // { // DBInstanceStatusInfo
|
|
113
|
+
* // StatusType: "STRING_VALUE",
|
|
114
|
+
* // Normal: true || false,
|
|
115
|
+
* // Status: "STRING_VALUE",
|
|
116
|
+
* // Message: "STRING_VALUE",
|
|
117
|
+
* // },
|
|
118
|
+
* // ],
|
|
119
|
+
* // DBClusterIdentifier: "STRING_VALUE",
|
|
120
|
+
* // StorageEncrypted: true || false,
|
|
121
|
+
* // KmsKeyId: "STRING_VALUE",
|
|
122
|
+
* // DbiResourceId: "STRING_VALUE",
|
|
123
|
+
* // CACertificateIdentifier: "STRING_VALUE",
|
|
124
|
+
* // CopyTagsToSnapshot: true || false,
|
|
125
|
+
* // PromotionTier: Number("int"),
|
|
126
|
+
* // DBInstanceArn: "STRING_VALUE",
|
|
127
|
+
* // EnabledCloudwatchLogsExports: [
|
|
128
|
+
* // "STRING_VALUE",
|
|
129
|
+
* // ],
|
|
130
|
+
* // },
|
|
131
|
+
* // ],
|
|
132
|
+
* // };
|
|
133
|
+
*
|
|
44
134
|
* ```
|
|
45
135
|
*
|
|
46
136
|
* @param DescribeDBInstancesCommandInput - {@link DescribeDBInstancesCommandInput}
|
|
@@ -53,6 +143,8 @@ export interface DescribeDBInstancesCommandOutput extends DBInstanceMessage, __M
|
|
|
53
143
|
* <p>
|
|
54
144
|
* <code>DBInstanceIdentifier</code> doesn't refer to an existing instance. </p>
|
|
55
145
|
*
|
|
146
|
+
* @throws {@link DocDBServiceException}
|
|
147
|
+
* <p>Base exception class for all service exceptions from DocDB service.</p>
|
|
56
148
|
*
|
|
57
149
|
*/
|
|
58
150
|
export declare class DescribeDBInstancesCommand extends $Command<DescribeDBInstancesCommandInput, DescribeDBInstancesCommandOutput, DocDBClientResolvedConfig> {
|
|
@@ -42,6 +42,28 @@ export interface DescribeDBSubnetGroupsCommandOutput extends DBSubnetGroupMessag
|
|
|
42
42
|
* };
|
|
43
43
|
* const command = new DescribeDBSubnetGroupsCommand(input);
|
|
44
44
|
* const response = await client.send(command);
|
|
45
|
+
* // { // DBSubnetGroupMessage
|
|
46
|
+
* // Marker: "STRING_VALUE",
|
|
47
|
+
* // DBSubnetGroups: [ // DBSubnetGroups
|
|
48
|
+
* // { // DBSubnetGroup
|
|
49
|
+
* // DBSubnetGroupName: "STRING_VALUE",
|
|
50
|
+
* // DBSubnetGroupDescription: "STRING_VALUE",
|
|
51
|
+
* // VpcId: "STRING_VALUE",
|
|
52
|
+
* // SubnetGroupStatus: "STRING_VALUE",
|
|
53
|
+
* // Subnets: [ // SubnetList
|
|
54
|
+
* // { // Subnet
|
|
55
|
+
* // SubnetIdentifier: "STRING_VALUE",
|
|
56
|
+
* // SubnetAvailabilityZone: { // AvailabilityZone
|
|
57
|
+
* // Name: "STRING_VALUE",
|
|
58
|
+
* // },
|
|
59
|
+
* // SubnetStatus: "STRING_VALUE",
|
|
60
|
+
* // },
|
|
61
|
+
* // ],
|
|
62
|
+
* // DBSubnetGroupArn: "STRING_VALUE",
|
|
63
|
+
* // },
|
|
64
|
+
* // ],
|
|
65
|
+
* // };
|
|
66
|
+
*
|
|
45
67
|
* ```
|
|
46
68
|
*
|
|
47
69
|
* @param DescribeDBSubnetGroupsCommandInput - {@link DescribeDBSubnetGroupsCommandInput}
|
|
@@ -54,6 +76,8 @@ export interface DescribeDBSubnetGroupsCommandOutput extends DBSubnetGroupMessag
|
|
|
54
76
|
* <p>
|
|
55
77
|
* <code>DBSubnetGroupName</code> doesn't refer to an existing subnet group. </p>
|
|
56
78
|
*
|
|
79
|
+
* @throws {@link DocDBServiceException}
|
|
80
|
+
* <p>Base exception class for all service exceptions from DocDB service.</p>
|
|
57
81
|
*
|
|
58
82
|
*/
|
|
59
83
|
export declare class DescribeDBSubnetGroupsCommand extends $Command<DescribeDBSubnetGroupsCommandInput, DescribeDBSubnetGroupsCommandOutput, DocDBClientResolvedConfig> {
|