翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
StopServer
ファイル転送プロトコル対応サーバーの状態を ONLINE から OFFLINE に変更します。OFFLINE サーバーはファイル転送ジョブを受け入れて処理することができません。サーバーやユーザーのプロパティなど、サーバーに関連付けられている情報は、サーバーを停止しても影響を受けません。
注記
サーバーを停止しても、ファイル転送プロトコルのエンドポイント課金は減らないし、影響もありません。
STOPPING のステータスは、サーバーが中間状態である (完全なレスポンスができないか完全にオフラインでない) ことを示します。STOP_FAILED の値は、エラー条件を示す可能性あります。
この呼び出しからレスポンスは返りません。
リクエストの構文
{
"ServerId": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- ServerId
-
停止したサーバーにシステムで割り当てられた一意の識別子。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
s-([0-9a-f]{17})必須：はい
レスポンス要素
アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード：500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード：400
- ResourceNotFoundException
-
この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。
HTTP ステータスコード：400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード：500
- ThrottlingException
-
リクエストのスロットリングにより、リクエストが拒否されました。
HTTP ステータスコード：400
例
例
次の例では サーバーを停止します。
リクエスト例
{
"ServerId": "s-01234567890abcdef"
}例
これは、この API コールに対するレスポンスのサンプルです。
レスポンス例
{
"ServerId": "s-01234567890abcdef"
}その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
