StartServer
Changes the state of a file transfer protocol-enabled server from OFFLINE to
ONLINE. It has no impact on a server that is already ONLINE. An
ONLINE server can accept and process file transfer jobs.
The state of STARTING indicates that the server is in an intermediate state,
either not fully able to respond, or not fully online. The values of START_FAILED
can indicate an error condition.
No response is returned from this call.
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 system-assigned unique identifier for a server that you start.
Type: String
Length Constraints: Fixed length of 19.
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 Family 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 AWSTransfer Family service.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request has failed because the AWSTransfer Family service is not available.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
Examples
Example
The following example starts a server.
Sample Request
{
"ServerId": "s-01234567890abcdef"
}Example
This is a sample response for this API call.
Sample Response
{
"ServerId": "s-01234567890abcdef"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
