【AWS SDK for .NET 】S3フォルダ内のファイル一覧を取得する

概要

AWSの公式ドキュメントの通りにやると、バケット内のファイル一覧は取得できるけど、特定フォルダー内のファイル一覧の取得方法が分からなかったので調査。
ファイル一覧を取得するにはListObjectsV2Requestを使用する。

コード

BucketName/Test/Template
　　　　　　　 　 └ file1.js
　　　　 　　　　 └ file2.js

というS3の構成でfile1.jsとfile2.jsを取得したい場合以下のようになる

ListObjectsTest.cs

static async Task ListingObjectsAsync()
{
    ListObjectsV2Request request = new ListObjectsV2Request
    {
        BucketName = bucketName,
        Prefix = "Test/Template/",  // ← 一覧を取得したいフォルダのキーをPrefixに指定する。
        MaxKeys = 10
    };

    ListObjectsV2Response response;
    do
    {
        response = await client.ListObjectsV2Async(request);  

        // Process the response.
        foreach (S3Object entry in response.S3Objects)
        {
            Console.WriteLine("key = {0} size = {1}", entry.Key, entry.Size);
            // 以下の内容が取得できる
            // [0] BucketName/Test/Template     ←なぜかPrefixで設定したキーが取得される
            // [1] BucketName/Test/Template/file1.js
            // [2] BucketName/Test/Template/file2.js
        }
        Console.WriteLine("Next Continuation Token: {0}", response.NextContinuationToken);
        request.ContinuationToken = response.NextContinuationToken;
    } while (response.IsTruncated);
}

AWS SDK for .NET を使用したキーのリスト作成

取得結果

// [0] BucketName/Test/Template
// [1] BucketName/Test/Template/file1.js
// [2] BucketName/Test/Template/file2.js

ファイル一覧を取得できるが、ListObjectsV2Request#Prefixで設定した内容が[0]に入る。
これが困る場合、値のSizeは0らしいので、Sizeを見て対応するのがよさそう。

参考

• ListObjectsV2Request
• ListObjectsV2Response
• ListObjectsV2Request(AWS SDK for Java)でS3のファイル一覧を取得する