ImportSshPublicKey - AWS Transfer Family

Les traductions sont fournies par des outils de traduction automatique. En cas de conflit entre le contenu d'une traduction et celui de la version originale en anglais, la version anglaise prévaudra.

ImportSshPublicKey

Ajoute une clé publique Secure Shell (SSH) à un utilisateur de Transfer Family identifié par une UserName valeur attribuée au serveur compatible avec le protocole de transfert de fichiers spécifique, identifié par. ServerId

La réponse renvoie la UserName valeur, la ServerId valeur et le nom duSshPublicKeyId.

Syntaxe de la requête

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

Paramètres de demande

Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.

Cette demande accepte les données suivantes au format JSON.

ServerId

Identifiant unique attribué par le système à un serveur.

Type : chaîne

Contraintes de longueur : longueur fixe de 19.

Modèle : s-([0-9a-f]{17})

Obligatoire : oui

SshPublicKeyBody

La partie clé publique d'une paire de clés SSH.

AWS Transfer Family accepte les clés RSA, ECDSA et ED25519.

Type : chaîne

Contraintes de longueur : longueur minimale de 0. Longueur maximale de 2048.

Obligatoire : oui

UserName

Nom de l'utilisateur Transfer Family attribué à un ou plusieurs serveurs.

Type : chaîne

Contraintes de longueur : Longueur minimum de 3. Longueur maximum de 100.

Modèle : [\w][\w@.-]{2,99}

Obligatoire : oui

Syntaxe de la réponse

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

Eléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON par le service.

ServerId

Identifiant unique attribué par le système à un serveur.

Type : chaîne

Contraintes de longueur : longueur fixe de 19.

Modèle : s-([0-9a-f]{17})

SshPublicKeyId

Nom donné à une clé publique par le système importé.

Type : chaîne

Contraintes de longueur : longueur fixe de 21.

Modèle : key-[0-9a-f]{17}

UserName

Nom d'utilisateur attribué à la ServerID valeur que vous avez spécifiée.

Type : chaîne

Contraintes de longueur : Longueur minimum de 3. Longueur maximum de 100.

Modèle : [\w][\w@.-]{2,99}

Erreurs

Pour plus d'informations sur les erreurs courantes pour toutes les actions, consultez Erreurs courantes.

InternalServiceError

Cette exception est levée lorsqu'une erreur se produit dans le AWS Transfer Family service.

Code d’état HTTP : 500

InvalidRequestException

Cette exception est levée lorsque le client soumet une demande mal formée.

Code d’état HTTP : 400

ResourceExistsException

La ressource demandée n'existe pas ou existe dans une région autre que celle spécifiée pour la commande.

Code d’état HTTP : 400

ResourceNotFoundException

Cette exception est levée lorsqu'aucune ressource n'est trouvée par le service AWS Transfer Family.

Code d’état HTTP : 400

ServiceUnavailableException

La demande a échoué car le service AWS Transfer Family n'est pas disponible.

Code d’état HTTP : 500

ThrottlingException

La demande a été refusée suite à une limitation des demandes.

Code d’état HTTP : 400

Exemples

Exemple

Cette commande importe une clé ECDSA stockée dans le id_ecdsa.pub fichier.

aws transfer import-ssh-public-key --server-id s-021345abcdef6789 --ssh-public-key-body file://id_ecdsa.pub --user-name jane-doe

Exemple

Si vous exécutez la commande précédente, le système renvoie les informations suivantes.

{ "ServerId": "s-021345abcdef6789", "SshPublicKeyId": "key-1234567890abcdef0", "UserName": "jane-doe" }

consultez aussi

Pour plus d'informations sur l'utilisation de cette API dans l'un des AWS SDK spécifiques au langage, consultez les pages suivantes :