import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DBSnapshotMessage, DescribeDBSnapshotsMessage } from "../models/models_0"; import type { RDSClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RDSClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeDBSnapshotsCommand}. */ export interface DescribeDBSnapshotsCommandInput extends DescribeDBSnapshotsMessage { } /** * @public * * The output of {@link DescribeDBSnapshotsCommand}. */ export interface DescribeDBSnapshotsCommandOutput extends DBSnapshotMessage, __MetadataBearer { } declare const DescribeDBSnapshotsCommand_base: { new (input: DescribeDBSnapshotsCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeDBSnapshotsCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

Returns information about DB snapshots. This API action supports pagination.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { RDSClient, DescribeDBSnapshotsCommand } from "@aws-sdk/client-rds"; // ES Modules import * // const { RDSClient, DescribeDBSnapshotsCommand } = 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 = { // DescribeDBSnapshotsMessage * DBInstanceIdentifier: "STRING_VALUE", * DBSnapshotIdentifier: "STRING_VALUE", * SnapshotType: "STRING_VALUE", * Filters: [ // FilterList * { // Filter * Name: "STRING_VALUE", // required * Values: [ // FilterValueList // required * "STRING_VALUE", * ], * }, * ], * MaxRecords: Number("int"), * Marker: "STRING_VALUE", * IncludeShared: true || false, * IncludePublic: true || false, * DbiResourceId: "STRING_VALUE", * }; * const command = new DescribeDBSnapshotsCommand(input); * const response = await client.send(command); * // { // DBSnapshotMessage * // Marker: "STRING_VALUE", * // DBSnapshots: [ // DBSnapshotList * // { // DBSnapshot * // DBSnapshotIdentifier: "STRING_VALUE", * // DBInstanceIdentifier: "STRING_VALUE", * // SnapshotCreateTime: new Date("TIMESTAMP"), * // Engine: "STRING_VALUE", * // AllocatedStorage: Number("int"), * // Status: "STRING_VALUE", * // Port: Number("int"), * // AvailabilityZone: "STRING_VALUE", * // VpcId: "STRING_VALUE", * // InstanceCreateTime: new Date("TIMESTAMP"), * // MasterUsername: "STRING_VALUE", * // EngineVersion: "STRING_VALUE", * // LicenseModel: "STRING_VALUE", * // SnapshotType: "STRING_VALUE", * // Iops: Number("int"), * // StorageThroughput: Number("int"), * // OptionGroupName: "STRING_VALUE", * // PercentProgress: Number("int"), * // SourceRegion: "STRING_VALUE", * // SourceDBSnapshotIdentifier: "STRING_VALUE", * // StorageType: "STRING_VALUE", * // TdeCredentialArn: "STRING_VALUE", * // Encrypted: true || false, * // StorageEncryptionType: "none" || "sse-kms" || "sse-rds", * // BackupRetentionPeriod: Number("int"), * // PreferredBackupWindow: "STRING_VALUE", * // KmsKeyId: "STRING_VALUE", * // DBSnapshotArn: "STRING_VALUE", * // Timezone: "STRING_VALUE", * // IAMDatabaseAuthenticationEnabled: true || false, * // ProcessorFeatures: [ // ProcessorFeatureList * // { // ProcessorFeature * // Name: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // DbiResourceId: "STRING_VALUE", * // TagList: [ // TagList * // { // Tag * // Key: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // SnapshotTarget: "STRING_VALUE", * // OriginalSnapshotCreateTime: new Date("TIMESTAMP"), * // SnapshotDatabaseTime: new Date("TIMESTAMP"), * // DBSystemId: "STRING_VALUE", * // MultiTenant: true || false, * // DedicatedLogVolume: true || false, * // AdditionalStorageVolumes: [ // AdditionalStorageVolumesList * // { // AdditionalStorageVolume * // VolumeName: "STRING_VALUE", // required * // AllocatedStorage: Number("int"), * // IOPS: Number("int"), * // MaxAllocatedStorage: Number("int"), * // StorageThroughput: Number("int"), * // StorageType: "STRING_VALUE", * // }, * // ], * // SnapshotAvailabilityZone: "STRING_VALUE", * // }, * // ], * // }; * * ``` * * @param DescribeDBSnapshotsCommandInput - {@link DescribeDBSnapshotsCommandInput} * @returns {@link DescribeDBSnapshotsCommandOutput} * @see {@link DescribeDBSnapshotsCommandInput} for command's `input` shape. * @see {@link DescribeDBSnapshotsCommandOutput} for command's `response` shape. * @see {@link RDSClientResolvedConfig | config} for RDSClient's `config` shape. * * @throws {@link DBSnapshotNotFoundFault} (client fault) *

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

* * @throws {@link RDSServiceException} *

Base exception class for all service exceptions from RDS service.

* * * @example To describe a DB snapshot for a DB instance * ```javascript * // The following example retrieves the details of a DB snapshot for a DB instance. * const input = { * DBSnapshotIdentifier: "mydbsnapshot" * }; * const command = new DescribeDBSnapshotsCommand(input); * const response = await client.send(command); * /* response is * { * DBSnapshots: [ * { * AllocatedStorage: 20, * AvailabilityZone: "us-east-1f", * DBInstanceIdentifier: "mysqldb", * DBSnapshotArn: "arn:aws:rds:us-east-1:123456789012:snapshot:mydbsnapshot", * DBSnapshotIdentifier: "mydbsnapshot", * DbiResourceId: "db-AKIAIOSFODNN7EXAMPLE", * Encrypted: false, * Engine: "mysql", * EngineVersion: "5.6.37", * IAMDatabaseAuthenticationEnabled: false, * InstanceCreateTime: "2018-02-08T22:24:55.973Z", * LicenseModel: "general-public-license", * MasterUsername: "mysqladmin", * OptionGroupName: "default:mysql-5-6", * PercentProgress: 100, * Port: 3306, * ProcessorFeatures: [], * SnapshotCreateTime: "2018-02-08T22:28:08.598Z", * SnapshotType: "manual", * Status: "available", * StorageType: "gp2", * VpcId: "vpc-6594f31c" * } * ] * } * *\/ * ``` * * @public */ export declare class DescribeDBSnapshotsCommand extends DescribeDBSnapshotsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeDBSnapshotsMessage; output: DBSnapshotMessage; }; sdk: { input: DescribeDBSnapshotsCommandInput; output: DescribeDBSnapshotsCommandOutput; }; }; }