翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ImportHostKey
ServerIdパラメータで指定されたホストキーをサーバーに追加します。
リクエストの構文
{
"Description": "string",
"HostKeyBody": "string",
"ServerId": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
]
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは以下の JSON 形式のデータを受け入れます。
- Description
-
このホストキーを識別するテキスト説明。
型: 文字列
長さの制限: 最小長は 0 です。最大長は 200 です。
Pattern:
[\p{Print}]*必須: いいえ
- HostKeyBody
-
SSH キーペアのプライベートキー部分。
AWS Transfer Family は、RSA、ECDSA、ED25519 キーを受け入れます。
型: 文字列
長さの制限: 最小長は 0 です。最大長は 4,096 です。
必須: はい
- ServerId
-
インポートするホストキーを含むサーバーの識別子。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
s-([0-9a-f]{17})必須：はい
- Tags
-
ホストキーのグループ化および検索に使用できるキーバリューペア。
型: Tag オブジェクトの配列
配列メンバー：最小数は 1 項目です。最大数は 50 項目です。
必須：いいえ
レスポンスの構文
{
"HostKeyId": "string",
"ServerId": "string"
}レスポンス要素
アクションが成功すると、サービスは HTTP 200 レスポンスを返します。
サービスから以下のデータが JSON 形式で返されます。
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- InternalServiceError
-
この例外は、 AWS Transfer Family サービスでエラーが発生した場合にスローされます。
HTTP ステータスコード：500
- InvalidRequestException
-
この例外は、クライアントが不正な形式のリクエストを送信した場合にスローされます。
HTTP ステータスコード：400
- ResourceExistsException
-
要求されたリソースは存在しないか、コマンドに指定されたリージョン以外のリージョンに存在します。
HTTP ステータスコード：400
- ResourceNotFoundException
-
この例外は、 AWS Transfer Family サービスによってリソースが見つからない場合にスローされます。
HTTP ステータスコード：400
- ServiceUnavailableException
-
AWS Transfer Family サービスが利用できないため、リクエストは失敗しました。
HTTP ステータスコード：500
- ThrottlingException
-
リクエストのスロットリングにより、リクエストが拒否されました。
HTTP ステータスコード：400
その他の参照資料
言語固有の AWS SDKs のいずれかでこの API を使用する方法の詳細については、以下を参照してください。
