DeleteUser - AWS Transfer Family

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

DeleteUser

指定したファイル転送プロトコル対応サーバーに属するユーザーを削除します。

このオペレーションからレスポンスは返りません。

注記

サーバーからユーザーを削除すると、ユーザーの情報は失われます。

リクエストの構文

{ "ServerId": "string", "UserName": "string" }

リクエストパラメータ

すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。

リクエストは以下の JSON 形式のデータを受け入れます。

ServerId

ユーザーの割り当て先サーバーインスタンスにシステムで割り当てられた一意の識別子。

型: 文字列

長さの制限: 固定長は 19 です。

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

必須:はい

UserName

サーバーから削除されるユーザーを識別する一意の文字列。

型: 文字列

長さの制限: 最小長は 3 です。最大長は 100 です。

パターン: [\w][\w@.-]{2,99}

必須:はい

レスポンス要素

アクションが成功した場合、サービスは空の HTTP 本文を持つ HTTP 200 レスポンスを返します。

エラー

すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。

InternalServiceError

この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。

HTTP ステータスコード:500

InvalidRequestException

この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。

HTTP ステータスコード:400

ResourceNotFoundException

この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。

HTTP ステータスコード:400

ServiceUnavailableException

AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。

HTTP ステータスコード:500

次の例では、Transfer Family ユーザーを削除します。

リクエスト例

{ "ServerId": "s-01234567890abcdef", "UserNames": "my_user" }

その他の参照資料

言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。