DescribeAccess - 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.

DescribeAccess

Décrit l'accès attribué au serveur compatible avec le protocole de transfert de fichiers spécifique, tel qu'identifié par ses ServerId propriétés et ses. ExternalId

La réponse de cet appel renvoie les propriétés de l'accès associé à la ServerId valeur spécifiée.

Syntaxe de la requête

{
   "ExternalId": "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.

ExternalId

Identifiant unique requis pour identifier des groupes spécifiques au sein de votre annuaire. Les utilisateurs du groupe que vous associez ont accès à vos EFS ressources Amazon S3 ou Amazon via les protocoles activés à l'aide de AWS Transfer Family. Si vous connaissez le nom du groupe, vous pouvez afficher les SID valeurs en exécutant la commande suivante sous Windows PowerShell.

Get-ADGroup -Filter {samAccountName -like "YourGroupName*"} -Properties * | Select SamAccountName,ObjectSid

Dans cette commande, remplacez YourGroupNamepar le nom de votre groupe Active Directory.

L'expression régulière utilisée pour valider ce paramètre est une chaîne de caractères composée de caractères alphanumériques majuscules et minuscules sans espaces. Vous pouvez également inclure des traits de soulignement ou l'un des caractères suivants : =, . @ : /-

Type : String

Contraintes de longueur : longueur minimum de 1. Longueur maximum de 256.

Modèle : S-1-[\d-]+

Obligatoire : oui

ServerId

Identifiant unique attribué par le système à un serveur auquel cet accès est attribué.

Type : String

Contraintes de longueur : longueur fixe de 19.

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

Obligatoire : oui

Syntaxe de la réponse

{
   "Access": { 
      "ExternalId": "string",
      "HomeDirectory": "string",
      "HomeDirectoryMappings": [ 
         { 
            "Entry": "string",
            "Target": "string",
            "Type": "string"
         }
      ],
      "HomeDirectoryType": "string",
      "Policy": "string",
      "PosixProfile": { 
         "Gid": number,
         "SecondaryGids": [ number ],
         "Uid": number
      },
      "Role": "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.

Access

Identifiant externe du serveur auquel l'accès est rattaché.

Type : objet DescribedAccess

ServerId

Identifiant unique attribué par le système à un serveur auquel cet accès est attribué.

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

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 :