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.
ListUsers
Répertorie les utilisateurs d'un serveur compatible avec le protocole de transfert de fichiers que vous spécifiez en transmettant le paramètre. ServerId
Syntaxe de la requête
{
"MaxResults": number,
"NextToken": "string",
"ServerId": "string"
}Paramètres de demande
Pour plus d'informations sur les paramètres courants pour toutes les actions, consultez Paramètres courants.
La demande accepte les données suivantes au JSON format suivant.
- MaxResults
-
Spécifie le nombre d'utilisateurs à renvoyer en réponse à la
ListUsersdemande.Type : entier
Plage valide : valeur minimum de 1. La valeur maximale est 1 000.
Obligatoire : non
- NextToken
-
Si l'
ListUsersappel donne des résultats supplémentaires, unNextTokenparamètre est renvoyé dans la sortie. Vous pouvez ensuite passer la commandeNextTokenà uneListUserscommande suivante, pour continuer à répertorier d'autres utilisateurs.Type : String
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 6 144.
Obligatoire : non
- ServerId
-
Identifiant unique attribué par le système à un serveur auquel des utilisateurs sont assignés.
Type : String
Contraintes de longueur : longueur fixe de 19.
Modèle :
s-([0-9a-f]{17})Obligatoire : oui
Syntaxe de la réponse
{
"NextToken": "string",
"ServerId": "string",
"Users": [
{
"Arn": "string",
"HomeDirectory": "string",
"HomeDirectoryType": "string",
"Role": "string",
"SshPublicKeyCount": number,
"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 sous JSON forme formatée par le service.
- NextToken
-
Lorsque vous pouvez obtenir des résultats supplémentaires à partir de l'
ListUsersappel, unNextTokenparamètre est renvoyé dans la sortie. Vous pouvez ensuite transmettre une commande ultérieure auNextTokenparamètre pour continuer à répertorier les utilisateurs supplémentaires.Type : String
Contraintes de longueur : longueur minimum de 1. Longueur maximum de 6 144.
- ServerId
-
Identifiant unique attribué par le système à un serveur auquel les utilisateurs sont affectés.
Type : String
Contraintes de longueur : longueur fixe de 19.
Modèle :
s-([0-9a-f]{17}) - Users
-
Renvoie les utilisateurs de Transfer Family et leurs propriétés pour la
ServerIdvaleur que vous spécifiez.Type : tableau d’objets ListedUser
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.
HTTPCode de statut : 500
- InvalidNextTokenException
-
Le
NextTokenparamètre transmis n'est pas valide.HTTPCode de statut : 400
- InvalidRequestException
-
Cette exception est levée lorsque le client soumet une demande mal formée.
HTTPCode de statut : 400
- ResourceNotFoundException
-
Cette exception est levée lorsqu'aucune ressource n'est trouvée par le service AWS Transfer Family.
HTTPCode de statut : 400
- ServiceUnavailableException
-
La demande a échoué car le service AWS Transfer Family n'est pas disponible.
HTTPCode de statut : 500
Exemples
Exemple
L'ListUsersAPIappel renvoie une liste d'utilisateurs associés à un serveur que vous spécifiez.
Exemple de demande
{
"MaxResults": 100,
"NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
"ServerId": "s-01234567890abcdef"
}
Exemple
Voici un exemple de réponse pour cet API appel.
Exemple de réponse
{
"NextToken": "eyJNYXJrZXIiOiBudWxsLCAiYm90b1X0cnVuU2F0ZV9hbW91bnQiOiAyfQ==",
"ServerId": "s-01234567890abcdef",
"Users": [
{
"Arn": "arn:aws:transfer:us-east-1:176354371281:user/s-01234567890abcdef/charlie",
"HomeDirectory": "/tests/home/charlie",
"SshPublicKeyCount": 1,
"Role": "arn:aws:iam::176354371281:role/transfer-role1",
"Tags": [
{
"Key": "Name",
"Value": "user1"
}
],
"UserName": "my_user"
}
]
}consultez aussi
Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :
