ListAccesses - AWS Transfer Family
Syntaxe de la requêteParamètres de demandeSyntaxe de la réponseEléments de réponseErreursconsultez aussi

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.

ListAccesses

Répertorie les détails de tous les accès que vous avez sur votre serveur.

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 maximum d'accès SIDs à renvoyer.

Type : entier

Plage valide : valeur minimum de 1. La valeur maximale est 1 000.

Obligatoire : non

NextToken

Lorsque vous pouvez obtenir des résultats supplémentaires à partir de l'ListAccessesappel, un NextToken paramètre est renvoyé dans la sortie. Vous pouvez ensuite transmettre une commande ultérieure au NextToken paramètre pour continuer à répertorier les accès supplémentaires.

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

{
   "Accesses": [ 
      { 
         "ExternalId": "string",
         "HomeDirectory": "string",
         "HomeDirectoryType": "string",
         "Role": "string"
      }
   ],
   "NextToken": "string",
   "ServerId": "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.

Accesses

Renvoie les accès et leurs propriétés pour la ServerId valeur que vous spécifiez.

Type : tableau d’objets ListedAccess

NextToken

Lorsque vous pouvez obtenir des résultats supplémentaires à partir de l'ListAccessesappel, un NextToken paramètre est renvoyé dans la sortie. Vous pouvez ensuite transmettre une commande ultérieure au NextToken paramètre pour continuer à répertorier les accès 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 des utilisateurs sont assignés.

Type : String

Contraintes de longueur : longueur fixe de 19.

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

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 NextToken paramè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

consultez aussi

Pour plus d'informations sur son utilisation API dans l'une des langues spécifiques AWS SDKs, consultez ce qui suit :