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.
DescribeUser
Décrit l'utilisateur affecté au serveur compatible avec le protocole de transfert de fichiers spécifique, tel qu'identifié par sa propriété. ServerId
La réponse de cet appel renvoie les propriétés de l'utilisateur associées à la ServerId valeur spécifiée.
Syntaxe de la requête
{
"ServerId": "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 auquel cet utilisateur est assigné.
Type : chaîne
Contraintes de longueur : longueur fixe de 19.
Modèle :
s-([0-9a-f]{17})Obligatoire : oui
- UserName
-
Nom de l'utilisateur assigné à un ou plusieurs serveurs. Les noms d'utilisateur font partie des informations de connexion permettant d'utiliser le AWS Transfer Family service et d'effectuer des tâches de transfert de fichiers.
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",
"User": {
"Arn": "string",
"HomeDirectory": "string",
"HomeDirectoryMappings": [
{
"Entry": "string",
"Target": "string",
"Type": "string"
}
],
"HomeDirectoryType": "string",
"Policy": "string",
"PosixProfile": {
"Gid": number,
"SecondaryGids": [ number ],
"Uid": number
},
"Role": "string",
"SshPublicKeys": [
{
"DateImported": number,
"SshPublicKeyBody": "string",
"SshPublicKeyId": "string"
}
],
"Tags": [
{
"Key": "string",
"Value": "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 auquel cet utilisateur est assigné.
Type : chaîne
Contraintes de longueur : longueur fixe de 19.
Modèle :
s-([0-9a-f]{17}) - User
-
Un tableau contenant les propriétés de l'utilisateur Transfer Family pour la
ServerIDvaleur que vous avez spécifiée.Type : objet DescribedUser
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
- 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
Exemples
Exemple
L'exemple suivant montre les détails d'un utilisateur existant.
Exemple de demande
aws transfer describe-user --server-id s-1111aaaa2222bbbb3 --user-name bob-testExemple de réponse
{
"ServerId": "s-1111aaaa2222bbbb3",
"User": {
"Arn": "arn:aws:transfer:us-east-1:111122223333:user/s-1111aaaa2222bbbb3/bob-test",
"HomeDirectory": "/DOC-EXAMPLE-BUCKET",
"HomeDirectoryType": "PATH",
"Role": "arn:aws:iam::111122223333:role/bob-role",
"SshPublicKeys": [
{
"DateImported": "2022-03-31T12:27:52.614000-04:00",
"SshPublicKeyBody": "ssh-rsa AAAAB3NzaC1yc..... bobusa@mycomputer.us-east-1.amaazon.com",
"SshPublicKeyId": "key-abcde12345fghik67"
}
],
"Tags": [],
"UserName": "bob-test"
}
}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 :
