import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DBInstanceMessage, DescribeDBInstancesMessage } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeDBInstancesCommand}. */ export interface DescribeDBInstancesCommandInput extends DescribeDBInstancesMessage { } /** * @public * * The output of {@link DescribeDBInstancesCommand}. */ export interface DescribeDBInstancesCommandOutput extends DBInstanceMessage, __MetadataBearer { } declare const DescribeDBInstancesCommand_base: { new (input: DescribeDBInstancesCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeDBInstancesCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns information about provisioned Amazon DocumentDB instances. This API supports pagination.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { DocDBClient, DescribeDBInstancesCommand } from "@aws-sdk/client-docdb"; // ES Modules import * // const { DocDBClient, DescribeDBInstancesCommand } = require("@aws-sdk/client-docdb"); // CommonJS import * // import type { DocDBClientConfig } from "@aws-sdk/client-docdb"; * const config = {}; // type is DocDBClientConfig * const client = new DocDBClient(config); * const input = { // DescribeDBInstancesMessage * DBInstanceIdentifier: "STRING_VALUE", * Filters: [ // FilterList * { // Filter * Name: "STRING_VALUE", // required * Values: [ // FilterValueList // required * "STRING_VALUE", * ], * }, * ], * MaxRecords: Number("int"), * Marker: "STRING_VALUE", * }; * const command = new DescribeDBInstancesCommand(input); * const response = await client.send(command); * // { // DBInstanceMessage * // Marker: "STRING_VALUE", * // DBInstances: [ // DBInstanceList * // { // DBInstance * // DBInstanceIdentifier: "STRING_VALUE", * // DBInstanceClass: "STRING_VALUE", * // Engine: "STRING_VALUE", * // DBInstanceStatus: "STRING_VALUE", * // Endpoint: { // Endpoint * // Address: "STRING_VALUE", * // Port: Number("int"), * // HostedZoneId: "STRING_VALUE", * // }, * // InstanceCreateTime: new Date("TIMESTAMP"), * // PreferredBackupWindow: "STRING_VALUE", * // BackupRetentionPeriod: Number("int"), * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList * // { // VpcSecurityGroupMembership * // VpcSecurityGroupId: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // AvailabilityZone: "STRING_VALUE", * // DBSubnetGroup: { // DBSubnetGroup * // DBSubnetGroupName: "STRING_VALUE", * // DBSubnetGroupDescription: "STRING_VALUE", * // VpcId: "STRING_VALUE", * // SubnetGroupStatus: "STRING_VALUE", * // Subnets: [ // SubnetList * // { // Subnet * // SubnetIdentifier: "STRING_VALUE", * // SubnetAvailabilityZone: { // AvailabilityZone * // Name: "STRING_VALUE", * // }, * // SubnetStatus: "STRING_VALUE", * // }, * // ], * // DBSubnetGroupArn: "STRING_VALUE", * // SupportedNetworkTypes: [ // NetworkTypeList * // "STRING_VALUE", * // ], * // }, * // PreferredMaintenanceWindow: "STRING_VALUE", * // PendingModifiedValues: { // PendingModifiedValues * // DBInstanceClass: "STRING_VALUE", * // AllocatedStorage: Number("int"), * // MasterUserPassword: "STRING_VALUE", * // Port: Number("int"), * // BackupRetentionPeriod: Number("int"), * // MultiAZ: true || false, * // EngineVersion: "STRING_VALUE", * // LicenseModel: "STRING_VALUE", * // Iops: Number("int"), * // DBInstanceIdentifier: "STRING_VALUE", * // StorageType: "STRING_VALUE", * // CACertificateIdentifier: "STRING_VALUE", * // DBSubnetGroupName: "STRING_VALUE", * // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports * // LogTypesToEnable: [ // LogTypeList * // "STRING_VALUE", * // ], * // LogTypesToDisable: [ * // "STRING_VALUE", * // ], * // }, * // }, * // LatestRestorableTime: new Date("TIMESTAMP"), * // EngineVersion: "STRING_VALUE", * // AutoMinorVersionUpgrade: true || false, * // PubliclyAccessible: true || false, * // StatusInfos: [ // DBInstanceStatusInfoList * // { // DBInstanceStatusInfo * // StatusType: "STRING_VALUE", * // Normal: true || false, * // Status: "STRING_VALUE", * // Message: "STRING_VALUE", * // }, * // ], * // DBClusterIdentifier: "STRING_VALUE", * // StorageEncrypted: true || false, * // KmsKeyId: "STRING_VALUE", * // DbiResourceId: "STRING_VALUE", * // CACertificateIdentifier: "STRING_VALUE", * // CopyTagsToSnapshot: true || false, * // PromotionTier: Number("int"), * // DBInstanceArn: "STRING_VALUE", * // EnabledCloudwatchLogsExports: [ * // "STRING_VALUE", * // ], * // CertificateDetails: { // CertificateDetails * // CAIdentifier: "STRING_VALUE", * // ValidTill: new Date("TIMESTAMP"), * // }, * // PerformanceInsightsEnabled: true || false, * // PerformanceInsightsKMSKeyId: "STRING_VALUE", * // }, * // ], * // }; * * ``` * * @param DescribeDBInstancesCommandInput - {@link DescribeDBInstancesCommandInput} * @returns {@link DescribeDBInstancesCommandOutput} * @see {@link DescribeDBInstancesCommandInput} for command's `input` shape. * @see {@link DescribeDBInstancesCommandOutput} for command's `response` shape. * @see {@link DocDBClientResolvedConfig | config} for DocDBClient's `config` shape. * * @throws {@link DBInstanceNotFoundFault} (client fault) *

* DBInstanceIdentifier doesn't refer to an existing instance.

* * @throws {@link DocDBServiceException} *

Base exception class for all service exceptions from DocDB service.

* * * @public */ export declare class DescribeDBInstancesCommand extends DescribeDBInstancesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeDBInstancesMessage; output: DBInstanceMessage; }; sdk: { input: DescribeDBInstancesCommandInput; output: DescribeDBInstancesCommandOutput; }; }; }