StartFileTransfer - AWS Transfer Family
AnforderungssyntaxAnforderungsparameterAntwortsyntaxAntwortelementeFehlerBeispieleWeitere Informationen finden Sie unter:

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.

StartFileTransfer

Beginnt eine Dateiübertragung zwischen dem lokalen AWS Speicher und einem Remote-AS2- oder SFTP-Server.

  • Bei einem AS2-Connector geben Sie den ConnectorId und einen oder mehrere an, um die Dateien SendFilePaths zu identifizieren, die Sie übertragen möchten.

  • Bei einem SFTP-Connector kann die Dateiübertragung entweder ausgehend oder eingehend erfolgen. In beiden Fällen geben Sie die an. ConnectorId Abhängig von der Richtung der Übertragung geben Sie auch die folgenden Elemente an:

    • Wenn Sie eine Datei vom SFTP-Server eines Partners in den Amazon Web Services Services-Speicher übertragen, geben Sie eine oder mehrere an, RetrieveFilePaths um die Dateien zu identifizieren, die Sie übertragen möchten, und a, LocalDirectoryPath um den Zielordner anzugeben.

    • Wenn Sie eine Datei vom AWS Speicher auf den SFTP-Server eines Partners übertragen, geben Sie eine oder mehrere an, um die Dateien SendFilePaths zu identifizieren, die Sie übertragen möchten, und a, RemoteDirectoryPath um den Zielordner anzugeben.

Anforderungssyntax

{
   "ConnectorId": "string",
   "LocalDirectoryPath": "string",
   "RemoteDirectoryPath": "string",
   "RetrieveFilePaths": [ "string" ],
   "SendFilePaths": [ "string" ]
}

Anforderungsparameter

Informationen zu den Parametern, die alle Aktionen gemeinsam haben, finden Sie unter Allgemeine Parameter.

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ConnectorId

Die eindeutige Kennung für den Connector.

Typ: Zeichenfolge

Längenbeschränkungen: Feste Länge von 19.

Pattern: c-([0-9a-f]{17})

Erforderlich: Ja

LocalDirectoryPath

Bei einer eingehenden Übertragung LocaDirectoryPath gibt der das Ziel für eine oder mehrere Dateien an, die vom SFTP-Server des Partners übertragen werden.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 1024 Zeichen.

Pattern: (.)+

Erforderlich: Nein

RemoteDirectoryPath

Bei einer ausgehenden Übertragung RemoteDirectoryPath gibt der das Ziel für eine oder mehrere Dateien an, die auf den SFTP-Server des Partners übertragen werden. Wenn Sie kein angebenRemoteDirectoryPath, ist das Ziel für die übertragenen Dateien das Home-Verzeichnis des SFTP-Benutzers.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge von 1. Maximale Länge beträgt 1024 Zeichen.

Pattern: (.)+

Erforderlich: Nein

RetrieveFilePaths

Ein oder mehrere Quellpfade für den SFTP-Server des Partners. Jede Zeichenfolge steht für einen Quelldateipfad für eine eingehende Dateiübertragung.

Typ: Zeichenfolgen-Array

Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 10 Elemente.

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 1024 Zeichen.

Pattern: (.)+

Erforderlich: Nein

SendFilePaths

Ein oder mehrere Quellpfade für den Amazon S3 S3-Speicher. Jede Zeichenfolge steht für einen Quelldateipfad für eine ausgehende Dateiübertragung. z. B. DOC-EXAMPLE-BUCKET/myfile.txt .

Anmerkung

DOC-EXAMPLE-BUCKET Ersetzen Sie ihn durch einen Ihrer aktuellen Buckets.

Typ: Zeichenfolgen-Array

Array-Mitglieder: Die Mindestanzahl beträgt 1 Element. Die maximale Anzahl beträgt 10 Elemente.

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 1024 Zeichen.

Pattern: (.)+

Erforderlich: Nein

Antwortsyntax

{
   "TransferId": "string"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

TransferId

Gibt den eindeutigen Bezeichner für die Dateiübertragung zurück.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge von 512.

Pattern: [0-9a-zA-Z./-]+

Fehler

Weitere Informationen zu den allgemeinen Fehlern, die bei allen Aktionen zurückgegeben werden, finden Sie unter Häufige Fehler.

InternalServiceError

Diese Ausnahme wird ausgelöst, wenn im AWS Transfer Family Dienst ein Fehler auftritt.

HTTP Status Code: 500

InvalidRequestException

Diese Ausnahme wird ausgelöst, wenn der Client eine falsch formatierte Anfrage sendet.

HTTP Status Code: 400

ResourceNotFoundException

Diese Ausnahme wird ausgelöst, wenn eine Ressource vom AWS Transfer Family Family-Dienst nicht gefunden wird.

HTTP Status Code: 400

ServiceUnavailableException

Die Anfrage ist fehlgeschlagen, da der AWS Transfer Family Family-Dienst nicht verfügbar ist.

HTTP Status Code: 500

ThrottlingException

Die Anforderung wurde aufgrund der Drosselung von Anforderungen abgelehnt.

HTTP Status Code: 400

Beispiele

Beispiel

Im folgenden Beispiel wird eine AS2-Dateiübertragung von einem Transfer Family Family-Server zum Endpunkt eines Remote-Handelspartners gestartet. DOC-EXAMPLE-BUCKET Ersetzen Sie es durch einen Ihrer aktuellen Buckets.

Beispielanforderung

{    
    "ConnectorId": "c-AAAA1111BBBB2222C",
    "SendFilePaths": [
        "/DOC-EXAMPLE-BUCKET/myfile-1.txt",
        "/DOC-EXAMPLE-BUCKET/myfile-2.txt",
        "/DOC-EXAMPLE-BUCKET/myfile-3.txt"
    ]
}

Beispielantwort

{
   "TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111"
}

Beispiel

Im folgenden Beispiel wird eine Dateiübertragung vom lokalen AWS Speicher auf einen Remote-SFTP-Server gestartet.

Beispielanforderung

{
    "ConnectorId": "c-01234567890abcdef",
    "SendFilePaths": [
        "/DOC-EXAMPLE-BUCKET/myfile-1.txt",
        "/DOC-EXAMPLE-BUCKET/myfile-2.txt",
        "/DOC-EXAMPLE-BUCKET/myfile-3.txt"
    ],
    "RemoteDirectoryPath": "/MySFTPRootFolder/fromTranferFamilyServer"
}

Beispielantwort

{
   "TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222"
}

Beispiel

Im folgenden Beispiel wird eine Dateiübertragung von einem Remote-SFTP-Server zum lokalen AWS Speicher gestartet.

Beispielanforderung

{    
    "ConnectorId": "c-111122223333AAAAA",
    "RetrieveFilePaths": [
        "/MySFTPFolder/toTranferFamily/myfile-1.txt",
        "/MySFTPFolder/toTranferFamily/myfile-2.txt",
        "/MySFTPFolder/toTranferFamily/myfile-3.txt"
    ],
    "LocalDirectoryPath": "/DOC-EXAMPLE-BUCKET/mySourceFiles"
}

Beispielantwort

{
   "TransferId": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa"
}

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: