StartDirectoryListing

Ruft eine Liste des Inhalts eines Verzeichnisses von einem Remote-SFTP-Server ab. Sie geben die Connector-ID, den Ausgabepfad und den Remote-Verzeichnispfad an. Sie können auch den optionalen MaxItems Wert angeben, um die maximale Anzahl von Elementen zu steuern, die im Remote-Verzeichnis aufgelistet werden. Diese API gibt eine Liste aller Dateien und Verzeichnisse im Remote-Verzeichnis zurück (bis zum Maximalwert), gibt jedoch keine Dateien oder Ordner in Unterverzeichnissen zurück. Das heißt, sie gibt nur eine Liste von Dateien und Verzeichnissen zurück, die eine Ebene tief sind.

Nachdem Sie die Auflistungsdatei erhalten haben, können Sie die Dateien, die Sie übertragen möchten, an den RetrieveFilePaths Parameter des StartFileTransfer API-Aufrufs übergeben.

Die Benennungskonvention für die Ausgabedatei lautet connector-ID-listing-ID.json. Die Ausgabedatei enthält die folgenden Informationen:

• filePath: Der vollständige Pfad einer Remote-Datei, relativ zum Verzeichnis der Listing-Anfrage für Ihren SFTP-Connector auf dem Remoteserver.

• modifiedTimestamp: das letzte Mal, als die Datei geändert wurde, im UTC-Zeitformat. Dies ist ein optionales Feld. Wenn die Attribute der entfernten Datei keinen Zeitstempel enthalten, wird er in der Dateiliste weggelassen.

• size: Die Größe der Datei in Byte. Dies ist ein optionales Feld. Wenn die Remote-Dateiattribute keine Dateigröße enthalten, wird sie in der Dateiliste weggelassen.

• path: der vollständige Pfad eines Remote-Verzeichnisses, relativ zum Verzeichnis der Listing-Anfrage für Ihren SFTP-Connector auf dem Remoteserver.

• truncated: ein Flag, das angibt, ob die Listenausgabe alle im Remote-Verzeichnis enthaltenen Elemente enthält oder nicht. Wenn Ihr Truncated Ausgabewert wahr ist, können Sie den im optionalen max-items Eingabeattribut angegebenen Wert erhöhen, um mehr Elemente auflisten zu können (bis zur maximal zulässigen Listengröße von 10.000 Elementen).

Anforderungssyntax

{
   "ConnectorId": "string",
   "MaxItems": number,
   "OutputDirectoryPath": "string",
   "RemoteDirectoryPath": "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 Konnektor.

Typ: Zeichenfolge

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

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

Erforderlich: Ja

MaxItems

Ein optionaler Parameter, mit dem Sie die maximale Anzahl der abzurufenden Datei-/Verzeichnisnamen angeben können. Der Standardwert lautet 1.000.

Typ: Ganzzahl

Gültiger Bereich: Mindestwert 1. Maximaler Wert von 10000.

Erforderlich: Nein

OutputDirectoryPath

Gibt den Pfad (Bucket und Präfix) im Amazon S3 S3-Speicher an, um die Ergebnisse der Verzeichnisliste zu speichern.

Typ: Zeichenfolge

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

Pattern: (.)+

Erforderlich: Ja

RemoteDirectoryPath

Gibt das Verzeichnis auf dem Remote-SFTP-Server an, dessen Inhalt Sie auflisten möchten.

Typ: Zeichenfolge

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

Pattern: (.)+

Erforderlich: Ja

Antwortsyntax

{
   "ListingId": "string",
   "OutputFileName": "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.

ListingId

Gibt einen eindeutigen Bezeichner für den Verzeichnisauflistungsaufruf zurück.

Typ: Zeichenfolge

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

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

OutputFileName

Gibt den Namen der Datei zurück, in der die Ergebnisse gespeichert sind. Dies ist eine Kombination aus der Connector-ID und der Listing-ID:<connector-id>-<listing-id>.json.

Typ: Zeichenfolge

Längenbeschränkungen: Mindestlänge von 26. Die maximale Länge beträgt 537.

Pattern: c-([0-9a-f]{17})-[0-9a-zA-Z./-]+.json

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 der Inhalt des home Ordners auf dem Remote-SFTP-Server aufgeführt, der durch den angegebenen Connector identifiziert wird. Die Ergebnisse werden am Amazon S3 S3-Speicherort /DOC-EXAMPLE-BUCKET/connector-files und in einer Datei mit dem Namen abgelegtc-AAAA1111BBBB2222C-6666abcd-11aa-22bb-cc33-0000aaaa3333.json.

Beispielanforderung

{    
    "ConnectorId": "c-AAAA1111BBBB2222C",
    "MaxItems": "10",
    "OutputDirectoryPath": "/DOC-EXAMPLE-BUCKET/connector-files",
    "RemoteDirectoryPath": "/home"
}

Beispielantwort

{
    "ListingId": "6666abcd-11aa-22bb-cc33-0000aaaa3333",
    "OutputFileName": "c-AAAA1111BBBB2222C-6666abcd-11aa-22bb-cc33-0000aaaa3333.json"
}

// under bucket "DOC-EXAMPLE-BUCKET"
connector-files/c-AAAA1111BBBB2222C-6666abcd-11aa-22bb-cc33-0000aaaa3333.json
{
    "files": [
        {
            "filePath": "/home/what.txt",
            "modifiedTimestamp": "2024-01-30T20:34:54Z",
            "size" : 2323
        },
        {
            "filePath": "/home/how.pgp",
            "modifiedTimestamp": "2024-01-30T20:34:54Z",
            "size" : 51238
        }
    ],
    "paths": [
        {
            "path": "/home/magic"
        },
        {
            "path": "/home/aws"
        },
    ],
    "truncated": false
}

Weitere Informationen finden Sie unter:

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

• AWS -Befehlszeilenschnittstelle

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go v2

• AWS SDK for Java V2

• AWS SDK für JavaScript V3

• AWS SDK for PHP V3

• AWS SDK für Python

• AWS SDK for Ruby V3