import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DBInstanceMessage, DescribeDBInstancesMessage } from "../models/models_0"; import type { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @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(): { [x: string]: unknown; }; }; /** *

Describes provisioned RDS instances. This API supports pagination.

This operation can also return information for Amazon Neptune DB instances and Amazon DocumentDB instances.

 * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { RDSClient, DescribeDBInstancesCommand } from "@aws-sdk/client-rds"; // ES Modules import * // const { RDSClient, DescribeDBInstancesCommand } = require("@aws-sdk/client-rds"); // CommonJS import * // import type { RDSClientConfig } from "@aws-sdk/client-rds"; * const config = {}; // type is RDSClientConfig * const client = new RDSClient(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", * // MasterUsername: "STRING_VALUE", * // DBName: "STRING_VALUE", * // Endpoint: { // Endpoint * // Address: "STRING_VALUE", * // Port: Number("int"), * // HostedZoneId: "STRING_VALUE", * // }, * // AllocatedStorage: Number("int"), * // InstanceCreateTime: new Date("TIMESTAMP"), * // PreferredBackupWindow: "STRING_VALUE", * // BackupRetentionPeriod: Number("int"), * // DBSecurityGroups: [ // DBSecurityGroupMembershipList * // { // DBSecurityGroupMembership * // DBSecurityGroupName: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // VpcSecurityGroups: [ // VpcSecurityGroupMembershipList * // { // VpcSecurityGroupMembership * // VpcSecurityGroupId: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // DBParameterGroups: [ // DBParameterGroupStatusList * // { // DBParameterGroupStatus * // DBParameterGroupName: "STRING_VALUE", * // ParameterApplyStatus: "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", * // }, * // SubnetOutpost: { // Outpost * // Arn: "STRING_VALUE", * // }, * // SubnetStatus: "STRING_VALUE", * // }, * // ], * // DBSubnetGroupArn: "STRING_VALUE", * // SupportedNetworkTypes: [ // StringList * // "STRING_VALUE", * // ], * // }, * // PreferredMaintenanceWindow: "STRING_VALUE", * // UpgradeRolloutOrder: "first" || "second" || "last", * // 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"), * // StorageThroughput: Number("int"), * // DBInstanceIdentifier: "STRING_VALUE", * // StorageType: "STRING_VALUE", * // CACertificateIdentifier: "STRING_VALUE", * // DBSubnetGroupName: "STRING_VALUE", * // PendingCloudwatchLogsExports: { // PendingCloudwatchLogsExports * // LogTypesToEnable: [ // LogTypeList * // "STRING_VALUE", * // ], * // LogTypesToDisable: [ * // "STRING_VALUE", * // ], * // }, * // ProcessorFeatures: [ // ProcessorFeatureList * // { // ProcessorFeature * // Name: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // AutomationMode: "full" || "all-paused", * // ResumeFullAutomationModeTime: new Date("TIMESTAMP"), * // MultiTenant: true || false, * // IAMDatabaseAuthenticationEnabled: true || false, * // DedicatedLogVolume: true || false, * // Engine: "STRING_VALUE", * // AdditionalStorageVolumes: [ // AdditionalStorageVolumesList * // { // AdditionalStorageVolume * // VolumeName: "STRING_VALUE", // required * // AllocatedStorage: Number("int"), * // IOPS: Number("int"), * // MaxAllocatedStorage: Number("int"), * // StorageThroughput: Number("int"), * // StorageType: "STRING_VALUE", * // }, * // ], * // }, * // LatestRestorableTime: new Date("TIMESTAMP"), * // MultiAZ: true || false, * // EngineVersion: "STRING_VALUE", * // AutoMinorVersionUpgrade: true || false, * // ReadReplicaSourceDBInstanceIdentifier: "STRING_VALUE", * // ReadReplicaDBInstanceIdentifiers: [ // ReadReplicaDBInstanceIdentifierList * // "STRING_VALUE", * // ], * // ReadReplicaDBClusterIdentifiers: [ // ReadReplicaDBClusterIdentifierList * // "STRING_VALUE", * // ], * // ReplicaMode: "open-read-only" || "mounted", * // LicenseModel: "STRING_VALUE", * // Iops: Number("int"), * // StorageThroughput: Number("int"), * // OptionGroupMemberships: [ // OptionGroupMembershipList * // { // OptionGroupMembership * // OptionGroupName: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // CharacterSetName: "STRING_VALUE", * // NcharCharacterSetName: "STRING_VALUE", * // SecondaryAvailabilityZone: "STRING_VALUE", * // PubliclyAccessible: true || false, * // StatusInfos: [ // DBInstanceStatusInfoList * // { // DBInstanceStatusInfo * // StatusType: "STRING_VALUE", * // Normal: true || false, * // Status: "STRING_VALUE", * // Message: "STRING_VALUE", * // }, * // ], * // StorageType: "STRING_VALUE", * // StorageEncryptionType: "none" || "sse-kms" || "sse-rds", * // TdeCredentialArn: "STRING_VALUE", * // DbInstancePort: Number("int"), * // DBClusterIdentifier: "STRING_VALUE", * // StorageEncrypted: true || false, * // KmsKeyId: "STRING_VALUE", * // DbiResourceId: "STRING_VALUE", * // CACertificateIdentifier: "STRING_VALUE", * // DomainMemberships: [ // DomainMembershipList * // { // DomainMembership * // Domain: "STRING_VALUE", * // Status: "STRING_VALUE", * // FQDN: "STRING_VALUE", * // IAMRoleName: "STRING_VALUE", * // OU: "STRING_VALUE", * // AuthSecretArn: "STRING_VALUE", * // DnsIps: [ * // "STRING_VALUE", * // ], * // }, * // ], * // CopyTagsToSnapshot: true || false, * // MonitoringInterval: Number("int"), * // EnhancedMonitoringResourceArn: "STRING_VALUE", * // MonitoringRoleArn: "STRING_VALUE", * // PromotionTier: Number("int"), * // DBInstanceArn: "STRING_VALUE", * // Timezone: "STRING_VALUE", * // IAMDatabaseAuthenticationEnabled: true || false, * // DatabaseInsightsMode: "standard" || "advanced", * // PerformanceInsightsEnabled: true || false, * // PerformanceInsightsKMSKeyId: "STRING_VALUE", * // PerformanceInsightsRetentionPeriod: Number("int"), * // EnabledCloudwatchLogsExports: [ * // "STRING_VALUE", * // ], * // ProcessorFeatures: [ * // { * // Name: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // DeletionProtection: true || false, * // AssociatedRoles: [ // DBInstanceRoles * // { // DBInstanceRole * // RoleArn: "STRING_VALUE", * // FeatureName: "STRING_VALUE", * // Status: "STRING_VALUE", * // }, * // ], * // ListenerEndpoint: { * // Address: "STRING_VALUE", * // Port: Number("int"), * // HostedZoneId: "STRING_VALUE", * // }, * // MaxAllocatedStorage: Number("int"), * // TagList: [ // TagList * // { // Tag * // Key: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // AutomationMode: "full" || "all-paused", * // ResumeFullAutomationModeTime: new Date("TIMESTAMP"), * // CustomerOwnedIpEnabled: true || false, * // NetworkType: "STRING_VALUE", * // ActivityStreamStatus: "stopped" || "starting" || "started" || "stopping", * // ActivityStreamKmsKeyId: "STRING_VALUE", * // ActivityStreamKinesisStreamName: "STRING_VALUE", * // ActivityStreamMode: "sync" || "async", * // ActivityStreamEngineNativeAuditFieldsIncluded: true || false, * // AwsBackupRecoveryPointArn: "STRING_VALUE", * // DBInstanceAutomatedBackupsReplications: [ // DBInstanceAutomatedBackupsReplicationList * // { // DBInstanceAutomatedBackupsReplication * // DBInstanceAutomatedBackupsArn: "STRING_VALUE", * // }, * // ], * // BackupTarget: "STRING_VALUE", * // AutomaticRestartTime: new Date("TIMESTAMP"), * // CustomIamInstanceProfile: "STRING_VALUE", * // ActivityStreamPolicyStatus: "locked" || "unlocked" || "locking-policy" || "unlocking-policy", * // CertificateDetails: { // CertificateDetails * // CAIdentifier: "STRING_VALUE", * // ValidTill: new Date("TIMESTAMP"), * // }, * // DBSystemId: "STRING_VALUE", * // MasterUserSecret: { // MasterUserSecret * // SecretArn: "STRING_VALUE", * // SecretStatus: "STRING_VALUE", * // KmsKeyId: "STRING_VALUE", * // }, * // ReadReplicaSourceDBClusterIdentifier: "STRING_VALUE", * // PercentProgress: "STRING_VALUE", * // MultiTenant: true || false, * // DedicatedLogVolume: true || false, * // IsStorageConfigUpgradeAvailable: true || false, * // EngineLifecycleSupport: "STRING_VALUE", * // AdditionalStorageVolumes: [ // AdditionalStorageVolumesOutputList * // { // AdditionalStorageVolumeOutput * // VolumeName: "STRING_VALUE", * // StorageVolumeStatus: "STRING_VALUE", * // AllocatedStorage: Number("int"), * // IOPS: Number("int"), * // MaxAllocatedStorage: Number("int"), * // StorageThroughput: Number("int"), * // StorageType: "STRING_VALUE", * // }, * // ], * // StorageVolumeStatus: "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 RDSClientResolvedConfig | config} for RDSClient's `config` shape. * * @throws {@link DBInstanceNotFoundFault} (client fault) *

DBInstanceIdentifier doesn't refer to an existing DB instance.

* * @throws {@link RDSServiceException} *

Base exception class for all service exceptions from RDS service.

* * * @example To describe a DB instance * ```javascript * // The following example retrieves details about the specified DB instance. * const input = { * DBInstanceIdentifier: "mydbinstancecf" * }; * const command = new DescribeDBInstancesCommand(input); * const response = await client.send(command); * /* response is * { * DBInstances: [ * { * DBInstanceClass: "db.t3.small", * DBInstanceIdentifier: "mydbinstancecf", * DBInstanceStatus: "available", * Endpoint: { * Address: "mydbinstancecf.abcexample.us-east-1.rds.amazonaws.com", * HostedZoneId: "Z2R2ITUGPM61AM", * Port: 3306 * }, * Engine: "mysql", * MasterUsername: "admin" * } * ] * } * *\/ * ``` * * @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; }; }; }