Listar el contenido de un directorio remoto

Antes de recuperar archivos de un servidor SFTP remoto, puede recuperar el contenido de un directorio del servidor SFTP remoto. Para ello, utiliza la llamada a la StartDirectoryListingAPI.

El siguiente ejemplo muestra el contenido de la home carpeta del servidor SFTP remoto, que se especifica en la configuración del conector. Los resultados se colocan en la ubicación /DOC-EXAMPLE-BUCKET/connector-files de Amazon S3 y en un archivo denominadoc-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 

Este AWS CLI comando devuelve un identificador de listado y el nombre del archivo que contiene los resultados.

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

nota

La convención de nomenclatura del archivo de salida esconnector-ID-listing-ID.json.

El archivo JSON contiene la siguiente información:

• filePath: la ruta completa de un archivo remoto, relativa al directorio de la solicitud de listado del conector SFTP en el servidor remoto.

• modifiedTimestamp: la última vez que se modificó el archivo, en segundos, en formato de hora universal coordinada (UTC). Este campo es opcional. Si los atributos del archivo remoto no contienen una marca de tiempo, se omite de la lista de archivos.

• size: el tamaño del archivo, en bytes. Este campo es opcional. Si los atributos del archivo remoto no contienen un tamaño de archivo, se omite de la lista de archivos.

• path: la ruta completa de un directorio remoto, relativa al directorio de la solicitud de listado del conector SFTP del servidor remoto.

• truncated: un indicador que indica si el resultado de la lista contiene todos los elementos contenidos en el directorio remoto o no. Si el valor de truncated salida es verdadero, puede aumentar el valor proporcionado en el atributo de max-items entrada opcional para poder incluir más elementos (hasta el tamaño máximo de lista permitido de 10 000 elementos).

El siguiente es un ejemplo del contenido del archivo de salida (c-AAAA1111BBBB2222C-6666abcd-11aa-22bb-cc33-0000aaaa3333.json), donde el directorio remoto contiene dos archivos y dos subdirectorios (rutas).

{
    "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"
}