翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
ImportSshPublicKey
特定のファイル転送プロトコル対応サーバーに割り当てられたUserName値によって識別される Transfer Family ユーザーに、 によって識別される Secure Shell (SSH) パブリックキーを追加しますServerId。
レスポンスは UserName 値、ServerId 値、および SshPublicKeyId の名前を返します。
リクエストの構文
{
"ServerId": "string",
"SshPublicKeyBody": "string",
"UserName": "string"
}リクエストパラメータ
すべてのアクションに共通のパラメータの詳細については、「共通パラメータ」を参照してください。
リクエストは、次のJSON形式のデータを受け入れます。
- ServerId
-
システムでサーバーに割り当てられた一意の識別子。
型: 文字列
長さの制限: 固定長は 19 です。
Pattern:
s-([0-9a-f]{17})必須：はい
- SshPublicKeyBody
-
キーペアのパブリックSSHキー部分。
AWS Transfer Family は、RSA、ECDSA、および ED25519キーを受け入れます。
型: 文字列
長さの制限: 最小長は 0 です。最大長は 2,048 です。
必須：はい
- UserName
-
1 つ以上のサーバーに割り当てられている Transfer Family ユーザーの名前。
型: 文字列
長さの制限: 最小長は 3 です。最大長は 100 です。
Pattern:
[\w][\w@.-]{2,99}必須：はい
レスポンスの構文
{
"ServerId": "string",
"SshPublicKeyId": "string",
"UserName": "string"
}レスポンス要素
アクションが成功すると、サービスは 200 HTTP レスポンスを送り返します。
次のデータは、 サービスによって JSON 形式で返されます。
- ServerId
-
システムでサーバーに割り当てられた一意の識別子。
型: 文字列
長さの制限: 固定長は 19 です。
パターン:
s-([0-9a-f]{17}) - SshPublicKeyId
-
インポートされたシステムによってパブリックキーに与えられた名前。
型: 文字列
長さの制限: 固定長は 21 です。
パターン:
key-[0-9a-f]{17} - UserName
-
指定した
ServerID値に割り当てられたユーザー名。型: 文字列
長さの制限: 最小長は 3 です。最大長は 100 です。
Pattern:
[\w][\w@.-]{2,99}
エラー
すべてのアクションに共通のエラーについては、「共通エラー」を参照してください。
- 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
例
例
このコマンドは、 id_ecdsa.pub ファイルに保存されているECDSAキーをインポートします。
aws transfer import-ssh-public-key --server-id s-021345abcdef6789 --ssh-public-key-body file://id_ecdsa.pub --user-name jane-doe
例
先のコマンドを実行すると、システムは以下の情報を返します。
{ "ServerId": "s-021345abcdef6789", "SshPublicKeyId": "key-1234567890abcdef0", "UserName": "jane-doe" }
以下の資料も参照してください。
言語固有の のいずれかAPIでこれを使用する方法の詳細については AWS SDKs、以下を参照してください。
