Lister le contenu d'un répertoire distant

Avant de récupérer des fichiers depuis un serveur SFTP distant, vous pouvez récupérer le contenu d'un répertoire sur le serveur SFTP distant. Pour ce faire, vous devez utiliser l'appel StartDirectoryListingd'API.

L'exemple suivant répertorie le contenu du home dossier sur le serveur SFTP distant, qui est spécifié dans la configuration du connecteur. Les résultats sont placés dans l'emplacement /DOC-EXAMPLE-BUCKET/connector-files Amazon S3 et dans un fichier nomméc-AAAA1111BBBB2222C-6666abcd-11aa-22bb-cc33-0000aaaa3333.json.

aws transfer start-directory-listing  \
   --connector-id c-AAAA1111BBBB2222C  \ 
   --output-directory-path /DOC-EXAMPLE-BUCKET/example/connector-files  \
   --remote-directory-path /home 

Cette AWS CLI commande renvoie un numéro de liste et le nom du fichier contenant les résultats.

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

Note

La convention de dénomination du fichier de sortie estconnector-ID-listing-ID.json.

Le fichier JSON contient les informations suivantes :

• filePath: le chemin complet d'un fichier distant, relatif au répertoire de la demande de listage pour votre connecteur SFTP sur le serveur distant.

• modifiedTimestamp: la dernière fois que le fichier a été modifié, en secondes, au format UTC (Coordinated Universal Time). Ce champ est facultatif. Si les attributs du fichier distant ne contiennent pas d'horodatage, celui-ci est omis de la liste des fichiers.

• size: taille du fichier, en octets. Ce champ est facultatif. Si les attributs du fichier distant ne contiennent pas de taille de fichier, celui-ci est omis de la liste des fichiers.

• path: le chemin complet d'un répertoire distant, relatif au répertoire de la demande de listage pour votre connecteur SFTP sur le serveur distant.

• truncated: un drapeau indiquant si la sortie de la liste contient tous les éléments contenus dans le répertoire distant ou non. Si votre valeur en truncated sortie est vraie, vous pouvez augmenter la valeur fournie dans l'attribut max-items d'entrée facultatif pour pouvoir répertorier davantage d'éléments (jusqu'à la taille de liste maximale autorisée de 10 000 éléments).

Voici un exemple du contenu du fichier de sortie (c-AAAA1111BBBB2222C-6666abcd-11aa-22bb-cc33-0000aaaa3333.json), où le répertoire distant contient deux fichiers et deux sous-répertoires (chemins).

{
    "files": [
        {
            "filePath": "/home/what.txt",
            "modifiedTimestamp": "2024-01-30T20:34:54Z",
            "size" : 2323
        },
        {
            "filePath": "/home/how.pgp",
            "modifiedTimestamp": "2024-01-30T20:34:54Z",
            "size" : 4691
        }
    ],
    "paths": [
        {
            "path": "/home/magic"
        },
        {
            "path": "/home/aws"
        },
    ],
    "truncated": "false"
}