import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeFileCachesRequest, DescribeFileCachesResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeFileCachesCommand}. */ export interface DescribeFileCachesCommandInput extends DescribeFileCachesRequest { } /** * @public * * The output of {@link DescribeFileCachesCommand}. */ export interface DescribeFileCachesCommandOutput extends DescribeFileCachesResponse, __MetadataBearer { } declare const DescribeFileCachesCommand_base: { new (input: DescribeFileCachesCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeFileCachesCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns the description of a specific Amazon File Cache resource, if a * FileCacheIds value is provided for that cache. Otherwise, it * returns descriptions of all caches owned by your Amazon Web Services account in the * Amazon Web Services Region of the endpoint that you're calling.

*

When retrieving all cache descriptions, you can optionally specify the * MaxResults parameter to limit the number of descriptions in a response. * If more cache descriptions remain, the operation returns a * NextToken value in the response. In this case, send a later request * with the NextToken request parameter set to the value of * NextToken from the last response.

*

This operation is used in an iterative process to retrieve a list of your cache * descriptions. DescribeFileCaches is called first without a * NextTokenvalue. Then the operation continues to be called with the * NextToken parameter set to the value of the last NextToken * value until a response has no NextToken.

*

When using this operation, keep the following in mind:

* * @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { FSxClient, DescribeFileCachesCommand } from "@aws-sdk/client-fsx"; // ES Modules import * // const { FSxClient, DescribeFileCachesCommand } = require("@aws-sdk/client-fsx"); // CommonJS import * // import type { FSxClientConfig } from "@aws-sdk/client-fsx"; * const config = {}; // type is FSxClientConfig * const client = new FSxClient(config); * const input = { // DescribeFileCachesRequest * FileCacheIds: [ // FileCacheIds * "STRING_VALUE", * ], * MaxResults: Number("int"), * NextToken: "STRING_VALUE", * }; * const command = new DescribeFileCachesCommand(input); * const response = await client.send(command); * // { // DescribeFileCachesResponse * // FileCaches: [ // FileCaches * // { // FileCache * // OwnerId: "STRING_VALUE", * // CreationTime: new Date("TIMESTAMP"), * // FileCacheId: "STRING_VALUE", * // FileCacheType: "LUSTRE", * // FileCacheTypeVersion: "STRING_VALUE", * // Lifecycle: "AVAILABLE" || "CREATING" || "DELETING" || "UPDATING" || "FAILED", * // FailureDetails: { // FileCacheFailureDetails * // Message: "STRING_VALUE", * // }, * // StorageCapacity: Number("int"), * // VpcId: "STRING_VALUE", * // SubnetIds: [ // SubnetIds * // "STRING_VALUE", * // ], * // NetworkInterfaceIds: [ // NetworkInterfaceIds * // "STRING_VALUE", * // ], * // DNSName: "STRING_VALUE", * // KmsKeyId: "STRING_VALUE", * // ResourceARN: "STRING_VALUE", * // LustreConfiguration: { // FileCacheLustreConfiguration * // PerUnitStorageThroughput: Number("int"), * // DeploymentType: "CACHE_1", * // MountName: "STRING_VALUE", * // WeeklyMaintenanceStartTime: "STRING_VALUE", * // MetadataConfiguration: { // FileCacheLustreMetadataConfiguration * // StorageCapacity: Number("int"), // required * // }, * // LogConfiguration: { // LustreLogConfiguration * // Level: "DISABLED" || "WARN_ONLY" || "ERROR_ONLY" || "WARN_ERROR", // required * // Destination: "STRING_VALUE", * // }, * // }, * // DataRepositoryAssociationIds: [ // DataRepositoryAssociationIds * // "STRING_VALUE", * // ], * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeFileCachesCommandInput - {@link DescribeFileCachesCommandInput} * @returns {@link DescribeFileCachesCommandOutput} * @see {@link DescribeFileCachesCommandInput} for command's `input` shape. * @see {@link DescribeFileCachesCommandOutput} for command's `response` shape. * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape. * * @throws {@link BadRequest} (client fault) *

A generic error indicating a failure with a client request.

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

No caches were found based upon supplied parameters.

* * @throws {@link InternalServerError} (server fault) *

A generic error indicating a server-side failure.

* * @throws {@link FSxServiceException} *

Base exception class for all service exceptions from FSx service.

* * * @public */ export declare class DescribeFileCachesCommand extends DescribeFileCachesCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeFileCachesRequest; output: DescribeFileCachesResponse; }; sdk: { input: DescribeFileCachesCommandInput; output: DescribeFileCachesCommandOutput; }; }; }