リモートディレクトリの内容を一覧表示する

リモート SFTP サーバーからファイルを取得する前に、リモート SFTP サーバー上のディレクトリの内容を取得できます。これを行うには、 StartDirectoryListing API コールを使用します。

次の例では、コネクタの設定で指定されているリモート SFTP サーバー上の homeフォルダの内容を一覧表示します。結果は Amazon S3 の場所 に配置され/DOC-EXAMPLE-BUCKET/connector-files、 という名前のファイルに配置されます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 

この AWS CLI コマンドは、リスト ID と結果を含むファイルの名前を返します。

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

注記

出力ファイルの命名規則は ですconnector-ID-listing-ID.json。

JSON ファイルには、次の情報が含まれています。

• filePath: リモートサーバー上の SFTP コネクタのリストリクエストのディレクトリを基準とした、リモートファイルの完全なパス。

• modifiedTimestamp: ファイルが最後に変更された時刻、秒単位、協定世界時 (UTC) 形式。このフィールドはオプションです。リモートファイル属性にタイムスタンプが含まれていない場合、ファイルリストから除外されます。

• size: ファイルのサイズ、バイト単位。このフィールドはオプションです。リモートファイル属性にファイルサイズが含まれていない場合は、ファイルリストから省略されます。

• path: リモートサーバー上の SFTP コネクタのリストリクエストのディレクトリに対するリモートディレクトリの完全なパス。

• truncated: リスト出力にリモートディレクトリに含まれるすべての項目が含まれているかどうかを示すフラグ。truncated 出力値が true の場合、オプションのmax-items入力属性で指定された値を増やして、より多くの項目を一覧表示できます (最大許容リストサイズは 10,000 項目まで）。

以下は、リモートディレクトリに 2 つのファイルと 2 つのサブディレクトリ (パス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" : 4691
        }
    ],
    "paths": [
        {
            "path": "/home/magic"
        },
        {
            "path": "/home/aws"
        },
    ],
    "truncated": "false"
}