import { Command as $Command } from "@smithy/smithy-client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { StopServerRequest } from "../models/models_0"; import type { ServiceInputTypes, ServiceOutputTypes, TransferClientResolvedConfig } from "../TransferClient"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link StopServerCommand}. */ export interface StopServerCommandInput extends StopServerRequest { } /** * @public * * The output of {@link StopServerCommand}. */ export interface StopServerCommandOutput extends __MetadataBearer { } declare const StopServerCommand_base: { new (input: StopServerCommandInput): import("@smithy/smithy-client").CommandImpl; new (input: StopServerCommandInput): import("@smithy/smithy-client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/middleware-endpoint").EndpointParameterInstructions; }; /** *

Changes the state of a file transfer protocol-enabled server from ONLINE to OFFLINE. An OFFLINE server cannot accept and process file transfer jobs. Information tied to your server, such as server and user properties, are not affected by stopping your server.

Stopping the server does not reduce or impact your file transfer protocol endpoint billing; you must delete the server to stop being billed.

The state of STOPPING indicates that the server is in an intermediate state, either not fully able to respond, or not fully offline. The values of STOP_FAILED can indicate an error condition.

No response is returned from this call.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { TransferClient, StopServerCommand } from "@aws-sdk/client-transfer"; // ES Modules import * // const { TransferClient, StopServerCommand } = require("@aws-sdk/client-transfer"); // CommonJS import * // import type { TransferClientConfig } from "@aws-sdk/client-transfer"; * const config = {}; // type is TransferClientConfig * const client = new TransferClient(config); * const input = { // StopServerRequest * ServerId: "STRING_VALUE", // required * }; * const command = new StopServerCommand(input); * const response = await client.send(command); * // {}; * * ``` * * @param StopServerCommandInput - {@link StopServerCommandInput} * @returns {@link StopServerCommandOutput} * @see {@link StopServerCommandInput} for command's `input` shape. * @see {@link StopServerCommandOutput} for command's `response` shape. * @see {@link TransferClientResolvedConfig | config} for TransferClient's `config` shape. * * @throws {@link InternalServiceError} (server fault) *

This exception is thrown when an error occurs in the Transfer Family service.

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

This exception is thrown when the client submits a malformed request.

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

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

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

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

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

The request was denied due to request throttling.

* * @throws {@link TransferServiceException} *

Base exception class for all service exceptions from Transfer service.

* * * @public */ export declare class StopServerCommand extends StopServerCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: StopServerRequest; output: {}; }; sdk: { input: StopServerCommandInput; output: StopServerCommandOutput; }; }; }