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.

AWS Transfer Family API-Referenz

Das vollständige API-Referenzhandbuch für Transfer Family ist unter AWS Transfer Family API Reference verfügbar.

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:

Server, Benutzer und Rollen werden alle anhand ihres Amazon-Ressourcennamens (ARN) identifiziert. Sie können Entitäten mit einem ARN Tags zuweisen, bei denen es sich um Schlüssel-Wert-Paare handelt. 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:

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

Folgende DNS-Einträge (Endpunkte) werden verwendet:

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

API-Anfragen stellen

Zusätzlich zur Verwendung der Konsole können Sie die AWS Transfer Family API verwenden, um Ihre Server programmgesteuert zu konfigurieren und zu verwalten. In diesem Abschnitt werden die AWS Transfer Family Vorgänge, das Signieren von Anfragen zur Authentifizierung und die Fehlerbehandlung beschrieben. Informationen zu den Regionen und Endpunkten, die für Transfer Family verfügbar sind, finden Sie unter AWS Transfer Family Endpunkte und Kontingente in der Allgemeine AWS-Referenz

Erforderliche Anforderungsheader für Transfer Family

In diesem Abschnitt werden die erforderlichen Header beschrieben, die Sie mit jeder POST-Anfrage an senden müssen. AWS Transfer Family In HTTP-Headern geben Sie wichtige Informationen über die Abfrage an, z. B, die Operation, die aufgerufen werden soll, das Datum der Abfrage und Informationen zur Ihrer Autorisierung als Sender der Abfrage. In Headern muss Groß- und Kleinschreibung beachtet werden; die Reihenfolge der Header ist nicht wichtig.

Das folgende Beispiel zeigt Header, die in der ListServersOperation verwendet werden.

POST / HTTP/1.1
Host: transfer.us-east-1.amazonaws.com
x-amz-target: TransferService.ListServers
x-amz-date: 20220507T012034Z
Authorization: AWS4-HMAC-SHA256 Credential=AKIDEXAMPLE/20220507/us-east-1/transfer/aws4_request,
    SignedHeaders=content-type;host;x-amz-date;x-amz-target,
    Signature=13550350a8681c84c861aac2e5b440161c2b33a3e4f302ac680ca5b686de48de
Content-Type: application/x-amz-json-1.1
Content-Length: 17

{"MaxResults":10}

Im Folgenden sind die Header aufgeführt, die in Ihren POST-Anfragen an Transfer Family enthalten sein müssen. Die unten aufgeführten Header, die mit „x-amz“ beginnen, sind spezifisch für. AWS Alle anderen aufgeführten Header sind allgemeine Header für HTTP-Transaktionen.

Eingaben und Unterschreiben von Familienanfragen übertragen

Alle Anforderungseingaben müssen als Teil der JSON-Nutzlast im Anfragetext gesendet werden. Für Aktionen, bei denen alle Anforderungsfelder optional sind, müssen Sie beispielsweise ListServers immer noch ein leeres JSON-Objekt im Anforderungstext angeben, z. B. {} Die Struktur der Transfer Family Family-Nutzlast request/response ist beispielsweise DescribeServerin der vorhandenen API-Referenz dokumentiert.

Transfer Family unterstützt die Authentifizierung mit AWS Signature Version 4. Einzelheiten finden Sie unter AWS API-Anfragen signieren.

Fehlermeldungen

Bei einem Fehler enthalten die Informationen im Antwort-Header:

Der Textkörper einer Fehlermeldung enthält Informationen zu dem aufgetretenen Fehler. Das folgende Beispiel zeigt eine Fehlerantwort mit der Ausgabesyntax von Antwortelementen für alle Fehlermeldungen.

{
    "__type": "String",
    "Message": "String", <!-- Message is lowercase in some instances -->
    "Resource": "String",
    "ResourceType": "String",
    "RetryAfterSeconds": "String"
}

In der folgenden Tabellen werden die Felder der JSON-Fehlerantwort in dieser Syntax erläutert.

Beispiele für Antworten auf Fehler

Der folgende JSON-Hauptteil wird zurückgegeben, wenn Sie die DescribeServer API aufrufen und einen Server angeben, der nicht existiert.

{
  "__type": "ResourceNotFoundException",
  "Message": "Unknown server",
  "Resource": "s-11112222333344444",
  "ResourceType": "Server"
}

Der folgende JSON-Hauptteil wird zurückgegeben, wenn die Ausführung einer API zu einer Drosselung führt.

{
   "__type":"ThrottlingException",
   "RetryAfterSeconds":"1"
}

Der folgende JSON-Hauptteil wird zurückgegeben, wenn Sie die CreateServer API verwenden und nicht über ausreichende Berechtigungen verfügen, um einen Transfer Family Family-Server zu erstellen.

{
  "__type": "AccessDeniedException",
  "Message": "You do not have sufficient access to perform this action."
}

Der folgende JSON-Hauptteil wird zurückgegeben, wenn Sie die CreateUser API verwenden und einen Benutzer angeben, der bereits existiert.

{
  "__type": "ResourceExistsException",
  "Message": "User already exists",
  "Resource": "Alejandro-Rosalez",
  "ResourceType": "User"
}

Verfügbare Bibliotheken

AWS bietet Bibliotheken, Beispielcode, Tutorials und andere Ressourcen für Softwareentwickler, die es vorziehen, Anwendungen mithilfe sprachspezifischer APIs anstelle der Befehlszeilentools und der Abfrage-API zu erstellen. Diese Bibliotheken bieten grundlegende Funktionen (nicht in den APIs enthalten) wie Anforderungsauthentifizierung, Wiederholungen von Anfragen und Fehlerbehandlung, sodass der Einstieg erleichtert wird. Siehe Tools, auf denen Sie aufbauen können AWS

Bibliotheken und Beispielcode in allen Sprachen finden Sie unter Beispielcode und Bibliotheken.

Identitätsanbieter

AWS Transfer Family unterstützt mehrere Identitätsanbietertypen zur Authentifizierung und Verwaltung von Benutzern. Jeder Server kann nur eine Authentifizierungsmethode verwenden, die bei der Erstellung des Servers ausgewählt werden muss.

Für alle Authentifizierungsmethoden werden Benutzern Richtlinien zugewiesen, die ihren Zugriff auf Amazon S3 S3-Buckets oder Amazon Elastic File System-Dateisysteme definieren. Der Server erbt die Vertrauensstellung vom Benutzer über eine IAM-Rolle mit einer AssumeRole Aktion, sodass er Dateioperationen im Namen des Benutzers ausführen kann.

Benennungskonventionen

AWS Transfer Family verwendet standardisierte Formate für Ressourcen-Identifikatoren und Amazon Resource Names (ARNs). Bei der Arbeit mit der API ist es wichtig, diese Konventionen zu verstehen. AWS Transfer Family

ID-Formate

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

ARN-Formate

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

Sie können Entitäten mit einem ARN Tags zuweisen, bei denen es sich um Schlüssel-Wert-Paare handelt. 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.

DNS und Endpunkte

AWS Transfer Family verwendet standardisierte DNS-Namenskonventionen sowohl für API-Endpunkte als auch für Serverendpunkte. Das Verständnis dieser Endpunkte ist für die Konfiguration von Clients und die Durchführung von API-Aufrufen unerlässlich.

API-Endpunkte

API-Endpunkte werden für API-Aufrufe zur Verwaltung AWS Transfer Family von Ressourcen verwendet. Diese Endpunkte haben die folgenden Formen:

Server-Endpunkte

Serverendpunkte werden von Dateiübertragungsclients verwendet, um eine Verbindung zu AWS Transfer Family Servern herzustellen. Diese Endpunkte haben die folgenden Formen:

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