import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { CancelRetrievalInput, CancelRetrievalOutput } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link CancelRetrievalCommand}. */ export interface CancelRetrievalCommandInput extends CancelRetrievalInput { } /** * @public * * The output of {@link CancelRetrievalCommand}. */ export interface CancelRetrievalCommandOutput extends CancelRetrievalOutput, __MetadataBearer { } declare const CancelRetrievalCommand_base: { new (input: CancelRetrievalCommandInput): import("@smithy/core/client").CommandImpl; new (input: CancelRetrievalCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after * the retrieval process is initiated. The virtual tape is returned to the VTS. This operation * is only supported in the tape gateway type.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { StorageGatewayClient, CancelRetrievalCommand } from "@aws-sdk/client-storage-gateway"; // ES Modules import * // const { StorageGatewayClient, CancelRetrievalCommand } = 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 = { // CancelRetrievalInput * GatewayARN: "STRING_VALUE", // required * TapeARN: "STRING_VALUE", // required * }; * const command = new CancelRetrievalCommand(input); * const response = await client.send(command); * // { // CancelRetrievalOutput * // TapeARN: "STRING_VALUE", * // }; * * ``` * * @param CancelRetrievalCommandInput - {@link CancelRetrievalCommandInput} * @returns {@link CancelRetrievalCommandOutput} * @see {@link CancelRetrievalCommandInput} for command's `input` shape. * @see {@link CancelRetrievalCommandOutput} 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 cancel virtual tape retrieval * ```javascript * // Cancels retrieval of a virtual tape from the virtual tape shelf (VTS) to a gateway after the retrieval process is initiated. * const input = { * GatewayARN: "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B", * TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" * }; * const command = new CancelRetrievalCommand(input); * const response = await client.send(command); * /* response is * { * TapeARN: "arn:aws:storagegateway:us-east-1:999999999999:tape/AMZN01A2A4" * } * *\/ * ``` * * @public */ export declare class CancelRetrievalCommand extends CancelRetrievalCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: CancelRetrievalInput; output: CancelRetrievalOutput; }; sdk: { input: CancelRetrievalCommandInput; output: CancelRetrievalCommandOutput; }; }; }