APIréférence - AWS Transfer Family
Bienvenue

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.

APIréférence

Les sections suivantes décrivent les appels AWS Transfer Family API de service, les types de données, les paramètres et les erreurs.

Rubriques

Bienvenue sur le AWS Transfer Family API

AWS Transfer Family est un service de transfert sécurisé que vous pouvez utiliser pour transférer des fichiers vers et depuis le stockage Amazon Simple Storage Service (Amazon S3) via les protocoles suivants :

  • Protocole de transfert de fichiers Secure Shell (SSHSFTP)

  • Protocole de transfert de fichiers sécurisé (FTPS)

  • Protocole de transfert de fichiers (FTP)

  • Déclaration d'applicabilité (2) AS2

Les protocoles de transfert de fichiers sont utilisés dans les flux de travail d'échange de données dans différents secteurs tels que les services financiers, les soins de santé, la publicité et le commerce de détail, entre autres. AWS Transfer Family simplifie la migration des flux de transfert de fichiers vers AWS.

Pour utiliser le AWS Transfer Family service, vous instanciez un serveur dans la AWS région de votre choix. Vous pouvez créer le serveur, répertorier les serveurs disponibles, mettre à jour et supprimer des serveurs. Le serveur est l'entité qui demande des opérations sur les fichiers AWS Transfer Family. Les serveurs ont un certain nombre de propriétés importantes. Le serveur est une instance nommée identifiée par un identifiant ServerId attribué par le système. Vous pouvez éventuellement attribuer un nom d'hôte à un serveur, voire un nom d'hôte personnalisé. Le service facture tous les serveurs instanciés (même les serveursOFFLINE) et la quantité de données transférées.

Les utilisateurs doivent être connus du serveur qui demande les opérations sur les fichiers. Un utilisateur identifié par son nom d'utilisateur est affecté à un serveur. Les noms d'utilisateur sont utilisés pour authentifier les demandes. Un serveur ne peut avoir qu'une seule méthode d'authentification : AWS_DIRECTORY_SERVICESERVICE_MANAGED,AWS_LAMBDA, ouAPI_GATEWAY.

Vous pouvez utiliser l'un des types de fournisseurs d'identité suivants pour authentifier les utilisateurs :

  • En SERVICE_MANAGED effet, une clé SSH publique est stockée avec les propriétés de l'utilisateur sur un serveur. Un utilisateur peut avoir une ou plusieurs clés SSH publiques enregistrées pour la méthode SERVICE_MANAGED d'authentification. Lorsqu'un client demande une opération de fichier pour une SERVICE_MANAGED méthode, le client fournit le nom d'utilisateur et la clé SSH privée, qui sont authentifiés, et l'accès est fourni.

  • Vous pouvez gérer l'authentification et l'accès des utilisateurs avec vos groupes Microsoft Active Directory en sélectionnant la méthode AWS_DIRECTORY_SERVICE d'authentification.

  • Vous pouvez vous connecter à un fournisseur d'identité personnalisé en utilisant AWS Lambda. Choisissez la méthode AWS_LAMBDA d'authentification.

  • Vous pouvez également authentifier les demandes d'utilisateurs à l'aide d'une méthode d'authentification personnalisée qui fournit à la fois l'authentification et l'accès aux utilisateurs. Cette méthode repose sur Amazon API Gateway pour utiliser votre API appel de votre fournisseur d'identité afin de valider les demandes des utilisateurs. Cette méthode est appelée « API_GATEWAY dans les API appels » et « personnalisée » dans la console. Vous pouvez utiliser cette méthode personnalisée pour authentifier les utilisateurs par rapport à un service d'annuaire, une paire nom/mot de passe de base de données ou un autre mécanisme.

Les utilisateurs se voient attribuer une politique établissant une relation de confiance entre eux et un compartiment Amazon S3. Ils peuvent avoir accès à tout ou partie d'un compartiment. Pour qu'un serveur agisse au nom d'un utilisateur, il doit hériter de la relation de confiance de l'utilisateur. Un rôle AWS Identity and Access Management (IAM) contenant la relation de confiance est créé, et une AssumeRole action est affectée à ce rôle. Le serveur peut alors effectuer des opérations sur les fichiers comme s'il s'agissait de l'utilisateur.

Les utilisateurs dont les propriétés de home répertoire sont définies verront ce répertoire (ou dossier) servir de cible et de source pour les opérations sur les fichiers. Quand aucun répertoire home n'est défini, le répertoire root du compartiment devient le répertoire de destination.

Les serveurs, les utilisateurs et les rôles sont tous identifiés par leur Amazon Resource Name (ARN). Vous pouvez attribuer des balises, qui sont des paires clé-valeur, aux entités dotées d'un. ARN Les balises sont des métadonnées qui peuvent être utilisées pour regrouper ou rechercher ces entités. Les balises s'avèrent utiles dans le domaine de la comptabilité, notamment.

Les conventions suivantes sont respectées dans les formats AWS Transfer Family d'identification :

  • Les valeurs ServerId se présentent sous la forme s-01234567890abcdef.

  • Les valeurs SshPublicKeyId se présentent sous la forme key-01234567890abcdef.

Les formats Amazon Resource Name (ARN) se présentent sous la forme suivante :

  • Pour les serveurs, ARNs utilisez le formulairearn:aws:transfer:region:account-id:server/server-id.

    Un exemple de serveur ARN est :arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef.

  • Pour les utilisateurs, ARNs utilisez le formulairearn:aws:transfer:region:account-id:user/server-id/username.

    Par exemple : arn:aws:transfer:us-east-1:123456789012:user/s-01234567890abcdef/user1.

DNSles entrées (points de terminaison) utilisées sont les suivantes :

  • APIles points de terminaison prennent la formetransfer.region.amazonaws.com.

  • Les points de terminaison de serveur se présentent sous la forme server.transfer.region.amazonaws.com.

Pour obtenir la liste des points de terminaison Transfer Family par AWS région, consultez les AWS Transfer Family points de terminaison et les quotas dans le. Références générales AWS

Cette référence API d'interface AWS Transfer Family contient la documentation d'une interface de programmation que vous pouvez utiliser pour gérer AWS Transfer Family. La structure du document de référence se présente comme suit :

  • Pour la liste alphabétique des API actions, voir Actions.

  • Pour la liste alphabétique des types de données, voir Data Types.

  • Pour consulter la liste des paramètres de requête courants, reportez-vous à la page Paramètres courants.

  • Pour la description des codes d'erreur, consultez la page Erreurs courantes.

Astuce

Plutôt que d'exécuter une commande, vous pouvez utiliser le --generate-cli-skeleton paramètre avec n'importe quel API appel pour générer et afficher un modèle de paramètre. Vous pouvez ensuite utiliser le modèle généré pour le personnaliser et l'utiliser comme entrée dans une commande ultérieure. Pour plus de détails, voir Générer et utiliser un fichier squelette de paramètres.