import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeCacheInput, DescribeCacheOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeCacheCommand}. */ export interface DescribeCacheCommandInput extends DescribeCacheInput { } /** * @public * * The output of {@link DescribeCacheCommand}. */ export interface DescribeCacheCommandOutput extends DescribeCacheOutput, __MetadataBearer { } declare const DescribeCacheCommand_base: { new (input: DescribeCacheCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeCacheCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns information about the cache of a gateway. This operation is only supported in * the cached volume, tape, and file gateway types.

*

The response includes disk IDs that are configured as cache, and it includes the amount * of cache allocated and used.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { StorageGatewayClient, DescribeCacheCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import * // const { StorageGatewayClient, DescribeCacheCommand } = require("@aws-sdk/client-storage-gateway"); // CommonJS import * // import type { StorageGatewayClientConfig } from "@aws-sdk/client-storage-gateway"; * const config = {}; // type is StorageGatewayClientConfig * const client = new StorageGatewayClient(config); * const input = { // DescribeCacheInput * GatewayARN: "STRING_VALUE", // required * }; * const command = new DescribeCacheCommand(input); * const response = await client.send(command); * // { // DescribeCacheOutput * // GatewayARN: "STRING_VALUE", * // DiskIds: [ // DiskIds * // "STRING_VALUE", * // ], * // CacheAllocatedInBytes: Number("long"), * // CacheUsedPercentage: Number("double"), * // CacheDirtyPercentage: Number("double"), * // CacheHitPercentage: Number("double"), * // CacheMissPercentage: Number("double"), * // }; * * ``` * * @param DescribeCacheCommandInput - {@link DescribeCacheCommandInput} * @returns {@link DescribeCacheCommandOutput} * @see {@link DescribeCacheCommandInput} for command's `input` shape. * @see {@link DescribeCacheCommandOutput} for command's `response` shape. * @see {@link StorageGatewayClientResolvedConfig | config} for StorageGatewayClient's `config` shape. * * @throws {@link InternalServerError} (server fault) *

An internal server error has occurred during the request. For more information, see the * error and message fields.

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

An exception occurred because an invalid gateway request was issued to the service. For * more information, see the error and message fields.

* * @throws {@link StorageGatewayServiceException} *

Base exception class for all service exceptions from StorageGateway service.

* * * @example To describe cache information * ```javascript * // Returns information about the cache of a gateway. * const input = { * GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" * }; * const command = new DescribeCacheCommand(input); * const response = await client.send(command); * /* response is * { * CacheAllocatedInBytes: 2199023255552, * CacheDirtyPercentage: 0.07, * CacheHitPercentage: 99.68, * CacheMissPercentage: 0.32, * CacheUsedPercentage: 0.07, * DiskIds: [ * "pci-0000:03:00.0-scsi-0:0:0:0", * "pci-0000:04:00.0-scsi-0:1:0:0" * ], * GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B" * } * *\/ * ``` * * @public */ export declare class DescribeCacheCommand extends DescribeCacheCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeCacheInput; output: DescribeCacheOutput; }; sdk: { input: DescribeCacheCommandInput; output: DescribeCacheCommandOutput; }; }; }