AWS Transfer for SFTP
User Guide

DeleteServer

Deletes the Secure File Transfer Protocol (SFTP) server that you specify.

No response returns from this operation.

Request Syntax

{ "ServerId": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ServerId

A unique system-assigned identifier for an SFTP server instance.

Type: String

Pattern: ^s-([0-9a-f]{17})$

Required: Yes

Response Elements

If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.

Errors

For information about the errors that are common to all actions, see Common Errors.

InternalServiceError

This exception is thrown when an error occurs in the AWS Transfer for SFTP service.

HTTP Status Code: 500

InvalidRequestException

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

HTTP Status Code: 400

ResourceNotFoundException

This exception is thrown when a resource is not found by the AWS Transfer for SFTP service.

HTTP Status Code: 400

ServiceUnavailableException

The request has failed because the AWS Transfer for SFTP service is not available.

HTTP Status Code: 500

Examples

Example

The following example deletes an SFTP server.

Sample Request

{ "ServerId": "s-01234567890abcdef" }

Example

Sample Response

{ }

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: