Python（boto3）でS3オブジェクトの全バージョン一覧を取得する方法

本記事では、AWSリソース上のS3に保存されているオブジェクトについて、そのすべてのバージョンの一覧を取得する方法を解説します。

実現したいこと

S3バケット「Bucket_1」の「testfolder」配下にある test.zip の全バージョンを一覧表示します。

課題： Pythonの boto3 ライブラリを使用して、S3からオブジェクトの全バージョンの一覧を取得すること。

解決のための手順（アルゴリズム）

• ステップ1： 例外処理のために boto3 および botocore の例外クラスをインポートします。

• ステップ2： bucket_name（バケット名）は必須パラメータです。

• ステップ3： boto3ライブラリを使ってAWSセッションを作成します。

• ステップ4： S3用のAWSクライアントを作成します。

• ステップ5： list_object_versions 関数を使用して、指定したバケット内のオブジェクトの全バージョンを一覧取得し、例外が発生した場合は適切にハンドリングします。

• ステップ6： この関数の戻り値は辞書型で、指定バケット内のオブジェクトの全バージョン情報が含まれています。

• ステップ7： オブジェクトの全バージョンのリストを返します。

サンプルコード

以下のコードで、AWS S3からオブジェクトの全バージョンの一覧を取得できます。

import boto3
from botocore.exceptions import ClientError

def list_all_objects_version(bucket_name, prefix_name):
    session = boto3.session.Session()
    s3_client = session.client('s3')
    try:
        result = s3_client.list_object_versions(Bucket=bucket_name, Prefix=prefix_name)
    except ClientError as e:
        raise Exception("boto3 client error in list_all_objects_version function: " + e.__str__())
    except Exception as e:
        raise Exception("Unexpected error in list_all_objects_version function of s3 helper: " + e.__str__())
print(list_all_objects_version("Bucket_1","testfolder"))

実行結果

{'ResponseMetadata': {'RequestId': 'H4VAGM3YP6', 'HostId': ***********, 'HTTPStatusCode': 200, 'HTTPHeaders': {'x-amz-id-2': ***************, 'x-amz-request-id': 'H4VAGM3YP6', 'date': 'Sat, 03 Apr 2021 08:04:08 GMT', 'content-type': 'application/xml', 'transfer-encoding': 'chunked', 'server': 'AmazonS3'}, 'RetryAttempts': 0}, 'IsTruncated': False, 'KeyMarker': '', 'VersionIdMarker': '',
'Versions': [{'ETag': '"705e2e674b04ca71"', 'Size': 1773, 'StorageClass': 'STANDARD', 'Key': 'testfolder/test.zip', 'VersionId': 'null', 'IsLatest': True, 'LastModified': datetime.datetime(2020, 12, 18, 14, 13, 18, tzinfo=tzutc()), 'Owner': {'DisplayName': 'AWS.Development', 'ID': '928*******************************'}}], 'Name': 'Bucket_1', 'Prefix': 'testfolder', 'MaxKeys': 1000, 'EncodingType': 'url'}

実行結果には、Versions キー配下に各バージョンの情報（ETag、サイズ、ストレージクラス、キー名、VersionId、最終更新日時など）が含まれます。IsLatest が True のものが最新バージョンであることを示しています。