import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeClusterSnapshotsMessage, SnapshotMessage } from "../models/models_0"; import type { RedshiftClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../RedshiftClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeClusterSnapshotsCommand}. */ export interface DescribeClusterSnapshotsCommandInput extends DescribeClusterSnapshotsMessage { } /** * @public * * The output of {@link DescribeClusterSnapshotsCommand}. */ export interface DescribeClusterSnapshotsCommandOutput extends SnapshotMessage, __MetadataBearer { } declare const DescribeClusterSnapshotsCommand_base: { new (input: DescribeClusterSnapshotsCommandInput): import("@smithy/smithy-client").CommandImpl; new (...[input]: [] | [DescribeClusterSnapshotsCommandInput]): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Returns one or more snapshot objects, which contain metadata about your cluster * snapshots. By default, this operation returns information about all snapshots of all * clusters that are owned by your Amazon Web Services account. No information is returned for * snapshots owned by inactive Amazon Web Services accounts.

*

If you specify both tag keys and tag values in the same request, Amazon Redshift returns * all snapshots that match any combination of the specified keys and values. For example, * if you have owner and environment for tag keys, and * admin and test for tag values, all snapshots that have any * combination of those values are returned. Only snapshots that you own are returned in * the response; shared snapshots are not returned with the tag key and tag value request * parameters.

*

If both tag keys and values are omitted from the request, snapshots are returned * regardless of whether they have tag keys or values associated with them.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { RedshiftClient, DescribeClusterSnapshotsCommand } from "@aws-sdk/client-redshift"; // ES Modules import * // const { RedshiftClient, DescribeClusterSnapshotsCommand } = require("@aws-sdk/client-redshift"); // CommonJS import * // import type { RedshiftClientConfig } from "@aws-sdk/client-redshift"; * const config = {}; // type is RedshiftClientConfig * const client = new RedshiftClient(config); * const input = { // DescribeClusterSnapshotsMessage * ClusterIdentifier: "STRING_VALUE", * SnapshotIdentifier: "STRING_VALUE", * SnapshotArn: "STRING_VALUE", * SnapshotType: "STRING_VALUE", * StartTime: new Date("TIMESTAMP"), * EndTime: new Date("TIMESTAMP"), * MaxRecords: Number("int"), * Marker: "STRING_VALUE", * OwnerAccount: "STRING_VALUE", * TagKeys: [ // TagKeyList * "STRING_VALUE", * ], * TagValues: [ // TagValueList * "STRING_VALUE", * ], * ClusterExists: true || false, * SortingEntities: [ // SnapshotSortingEntityList * { // SnapshotSortingEntity * Attribute: "SOURCE_TYPE" || "TOTAL_SIZE" || "CREATE_TIME", // required * SortOrder: "ASC" || "DESC", * }, * ], * }; * const command = new DescribeClusterSnapshotsCommand(input); * const response = await client.send(command); * // { // SnapshotMessage * // Marker: "STRING_VALUE", * // Snapshots: [ // SnapshotList * // { // Snapshot * // SnapshotIdentifier: "STRING_VALUE", * // ClusterIdentifier: "STRING_VALUE", * // SnapshotCreateTime: new Date("TIMESTAMP"), * // Status: "STRING_VALUE", * // Port: Number("int"), * // AvailabilityZone: "STRING_VALUE", * // ClusterCreateTime: new Date("TIMESTAMP"), * // MasterUsername: "STRING_VALUE", * // ClusterVersion: "STRING_VALUE", * // EngineFullVersion: "STRING_VALUE", * // SnapshotType: "STRING_VALUE", * // NodeType: "STRING_VALUE", * // NumberOfNodes: Number("int"), * // DBName: "STRING_VALUE", * // VpcId: "STRING_VALUE", * // Encrypted: true || false, * // KmsKeyId: "STRING_VALUE", * // EncryptedWithHSM: true || false, * // AccountsWithRestoreAccess: [ // AccountsWithRestoreAccessList * // { // AccountWithRestoreAccess * // AccountId: "STRING_VALUE", * // AccountAlias: "STRING_VALUE", * // }, * // ], * // OwnerAccount: "STRING_VALUE", * // TotalBackupSizeInMegaBytes: Number("double"), * // ActualIncrementalBackupSizeInMegaBytes: Number("double"), * // BackupProgressInMegaBytes: Number("double"), * // CurrentBackupRateInMegaBytesPerSecond: Number("double"), * // EstimatedSecondsToCompletion: Number("long"), * // ElapsedTimeInSeconds: Number("long"), * // SourceRegion: "STRING_VALUE", * // Tags: [ // TagList * // { // Tag * // Key: "STRING_VALUE", * // Value: "STRING_VALUE", * // }, * // ], * // RestorableNodeTypes: [ // RestorableNodeTypeList * // "STRING_VALUE", * // ], * // EnhancedVpcRouting: true || false, * // MaintenanceTrackName: "STRING_VALUE", * // ManualSnapshotRetentionPeriod: Number("int"), * // ManualSnapshotRemainingDays: Number("int"), * // SnapshotRetentionStartTime: new Date("TIMESTAMP"), * // MasterPasswordSecretArn: "STRING_VALUE", * // MasterPasswordSecretKmsKeyId: "STRING_VALUE", * // SnapshotArn: "STRING_VALUE", * // }, * // ], * // }; * * ``` * * @param DescribeClusterSnapshotsCommandInput - {@link DescribeClusterSnapshotsCommandInput} * @returns {@link DescribeClusterSnapshotsCommandOutput} * @see {@link DescribeClusterSnapshotsCommandInput} for command's `input` shape. * @see {@link DescribeClusterSnapshotsCommandOutput} for command's `response` shape. * @see {@link RedshiftClientResolvedConfig | config} for RedshiftClient's `config` shape. * * @throws {@link ClusterNotFoundFault} (client fault) *

The ClusterIdentifier parameter does not refer to an existing cluster. *

* * @throws {@link ClusterSnapshotNotFoundFault} (client fault) *

The snapshot identifier does not refer to an existing cluster snapshot.

* * @throws {@link InvalidTagFault} (client fault) *

The tag is invalid.

* * @throws {@link UnsupportedOperationFault} (client fault) *

The requested operation isn't supported.

* * @throws {@link RedshiftServiceException} *

Base exception class for all service exceptions from Redshift service.

* * * @public */ export declare class DescribeClusterSnapshotsCommand extends DescribeClusterSnapshotsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeClusterSnapshotsMessage; output: SnapshotMessage; }; sdk: { input: DescribeClusterSnapshotsCommandInput; output: DescribeClusterSnapshotsCommandOutput; }; }; }