APIReferenz - AWS Transfer Family
Willkommen

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

APIReferenz

In den folgenden Abschnitten werden die AWS Transfer Family API Serviceanfragen, Datentypen, Parameter und Fehler dokumentiert.

Themen

Willkommen auf der AWS Transfer Family API

AWS Transfer Family ist ein sicherer Übertragungsservice, mit dem Sie Dateien über die folgenden Protokolle in den und aus dem Amazon Simple Storage Service (Amazon S3) -Speicher übertragen können:

  • Secure Shell (SSH) Dateiübertragungsprotokoll (SFTP)

  • Sicheres Dateiübertragungsprotokoll (FTPS)

  • Dateiübertragungsprotokoll (FTP)

  • Erklärung zur Anwendbarkeit (2) AS2

Dateiübertragungsprotokolle werden in Datenaustausch-Workflows in verschiedenen Branchen wie Finanzdienstleistungen, Gesundheitswesen, Werbung und Einzelhandel verwendet. AWS Transfer Family vereinfacht die Migration von Dateiübertragungsworkflows zu AWS.

Um den AWS Transfer Family Dienst zu nutzen, instanziieren Sie einen Server in der AWS Region Ihrer Wahl. Sie können den Server erstellen, verfügbare Server auflisten und Server aktualisieren und löschen. Der Server ist die Entität, von der Dateioperationen angefordert AWS Transfer Family werden. Server verfügen über eine Reihe wichtiger Eigenschaften. Der Server ist eine benannte Instance, die mit einer vom System zugewiesenen ServerId identifiziert wird. Sie können einem Server optional einen Host-Namen (auch benutzerdefiniert) zuweisen. Der Service berechnet alle instanziierten Server (auch solcheOFFLINE) und die übertragene Datenmenge.

Benutzer müssen dem Server bekannt sein, der Dateioperationen anfordert. Ein über den Benutzernamen identifizierter Benutzer wird dem Server zugewiesen. Benutzernamen werden zur Authentifizierung von Anfragen verwendet. Ein Server kann nur eine Authentifizierungsmethode haben:AWS_DIRECTORY_SERVICE, SERVICE_MANAGEDAWS_LAMBDA, oder. API_GATEWAY

Sie können jeden der folgenden Identitätsanbietertypen verwenden, um Benutzer zu authentifizieren:

  • Denn SERVICE_MANAGED ein SSH öffentlicher Schlüssel wird mit den Eigenschaften des Benutzers auf einem Server gespeichert. Ein Benutzer kann einen oder mehrere SSH öffentliche Schlüssel für die SERVICE_MANAGED Authentifizierungsmethode gespeichert haben. Wenn ein Client eine Dateioperation für eine SERVICE_MANAGED Methode anfordert, gibt der Client den Benutzernamen und den SSH privaten Schlüssel an, der authentifiziert wird, und der Zugriff wird gewährt.

  • Sie können die Benutzerauthentifizierung und den Zugriff mit Ihren Microsoft Active Directory-Gruppen verwalten, indem Sie die AWS_DIRECTORY_SERVICE Authentifizierungsmethode auswählen.

  • Sie können eine Verbindung zu einem benutzerdefinierten Identitätsanbieter herstellen, indem Sie AWS Lambda Wählen Sie die AWS_LAMBDA Authentifizierungsmethode.

  • Sie können Benutzeranforderungen auch mit einer benutzerdefinierten Authentifizierungsmethode authentifizieren, die Benutzerauthentifizierung und Zugriff bereitstellt. Bei dieser Methode verwendet Amazon API Gateway Ihren API Anruf von Ihrem Identitätsanbieter, um Benutzeranfragen zu validieren. Diese Methode wird API_GATEWAY in API Aufrufen und in der Konsole als Benutzerdefiniert bezeichnet. Sie können mit dieser benutzerdefinierten Methode Benutzer anhand eines Verzeichnis-Services, eines Datenbankname/Passwort-Paars oder eines anderen Mechanismus authentifizieren.

Benutzern wird eine Richtlinie mit einer Vertrauensbeziehung zwischen ihnen und einem Amazon S3 S3-Bucket zugewiesen. Sie können möglicherweise auf den ganzen Bucket oder auf Teile davon zugreifen. Damit ein Server im Namen eines Benutzers handeln kann, muss der Server die Vertrauensbeziehung vom Benutzer erben. Es wird eine Rolle AWS Identity and Access Management (IAM) erstellt, die die Vertrauensstellung enthält, und dieser Rolle wird eine AssumeRole Aktion zugewiesen. Der Server kann dann Dateioperationen ausführen, als wäre er der Benutzer.

Bei Benutzern, für die eine home Verzeichniseigenschaft festgelegt ist, dient dieses Verzeichnis (oder dieser Ordner) als Ziel und Quelle von Dateioperationen. Wenn kein home-Verzeichnis festgelegt ist, wird das root-Verzeichnis des Buckets zum Startverzeichnis.

Server, Benutzer und Rollen werden alle anhand ihres Amazon-Ressourcennamens (ARN) identifiziert. Sie können Entitäten mit einem Tags zuweisen, bei denen es sich um Schlüssel-Wert-Paare handelt. ARN Tags sind Metadaten, die verwendet werden können, um diese Entitäten zu gruppieren oder nach ihnen zu suchen. Tags sind beispielsweise für die Buchhaltung nützlich.

Die folgenden Konventionen werden bei AWS Transfer Family ID-Formaten eingehalten:

  • ServerId-Werte haben das Format s-01234567890abcdef.

  • SshPublicKeyId-Werte haben das Format key-01234567890abcdef.

Die Formate von Amazon Resource Name (ARN) haben die folgende Form:

  • Verwenden ARNs Sie für Server das Formulararn:aws:transfer:region:account-id:server/server-id.

    Ein Beispiel für einen Server ARN ist:arn:aws:transfer:us-east-1:123456789012:server/s-01234567890abcdef.

  • Verwenden ARNs Sie für Benutzer das Formulararn:aws:transfer:region:account-id:user/server-id/username.

    Ein Beispiel ist arn:aws:transfer:us-east-1:123456789012:user/s-01234567890abcdef/user1.

DNSFolgende Einträge (Endpunkte) werden verwendet:

  • APIEndpunkte haben die Form. transfer.region.amazonaws.com

  • Server-Endpunkte haben das Format server.transfer.region.amazonaws.com.

Eine Liste der Transfer Family Family-Endpunkte nach AWS Regionen finden Sie unter AWS Transfer Family Endpunkte und Kontingente in der. Allgemeine AWS-Referenz

Diese API Schnittstellenreferenz für AWS Transfer Family enthält Dokumentation für eine Programmierschnittstelle, die Sie zur Verwaltung verwenden können. AWS Transfer Family Die Referenzstruktur:

  • Eine alphabetische Liste der API Aktionen finden Sie unter Actions.

  • Eine alphabetische Liste der Datentypen finden Sie unter Data Types.

  • Eine Liste der häufigen Abfrageparameter finden Sie unter Häufige Parameter.

  • Beschreibungen der Fehlercodes finden Sie unter Häufige Fehler.

Tipp

Anstatt tatsächlich einen Befehl auszuführen, können Sie den --generate-cli-skeleton Parameter bei jedem API Aufruf verwenden, um eine Parametervorlage zu generieren und anzuzeigen. Anschließend können Sie die generierte Vorlage anpassen und als Eingabe für einen späteren Befehl verwenden. Einzelheiten finden Sie unter Generieren und Verwenden einer Parameter-Skelettdatei.