import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { EvictFilesFailingUploadInput, EvictFilesFailingUploadOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link EvictFilesFailingUploadCommand}. */ export interface EvictFilesFailingUploadCommandInput extends EvictFilesFailingUploadInput { } /** * @public * * The output of {@link EvictFilesFailingUploadCommand}. */ export interface EvictFilesFailingUploadCommandOutput extends EvictFilesFailingUploadOutput, __MetadataBearer { } declare const EvictFilesFailingUploadCommand_base: { new (input: EvictFilesFailingUploadCommandInput): import("@smithy/core/client").CommandImpl; new (input: EvictFilesFailingUploadCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Starts a process that cleans the specified file share's cache of file entries that are * failing upload to Amazon S3. This API operation reports success if the request is * received with valid arguments, and there are no other cache clean operations currently * in-progress for the specified file share. After a successful request, the cache clean * operation occurs asynchronously and reports progress using CloudWatch logs and * notifications.

* *

If ForceRemove is set to True, the cache clean operation * will delete file data from the gateway which might otherwise be recoverable. We * recommend using this operation only after all other methods to clear files failing * upload have been exhausted, and if your business need outweighs the potential data * loss.

*
* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { StorageGatewayClient, EvictFilesFailingUploadCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import * // const { StorageGatewayClient, EvictFilesFailingUploadCommand } = 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 = { // EvictFilesFailingUploadInput * FileShareARN: "STRING_VALUE", // required * ForceRemove: true || false, * }; * const command = new EvictFilesFailingUploadCommand(input); * const response = await client.send(command); * // { // EvictFilesFailingUploadOutput * // NotificationId: "STRING_VALUE", * // }; * * ``` * * @param EvictFilesFailingUploadCommandInput - {@link EvictFilesFailingUploadCommandInput} * @returns {@link EvictFilesFailingUploadCommandOutput} * @see {@link EvictFilesFailingUploadCommandInput} for command's `input` shape. * @see {@link EvictFilesFailingUploadCommandOutput} 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.

* * * @public */ export declare class EvictFilesFailingUploadCommand extends EvictFilesFailingUploadCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: EvictFilesFailingUploadInput; output: EvictFilesFailingUploadOutput; }; sdk: { input: EvictFilesFailingUploadCommandInput; output: EvictFilesFailingUploadCommandOutput; }; }; }