Boto3のウェイター（待機）機能を使ってS3バケット内にキーが存在するかどうかを確認する方法

プログラムの中で、ウェイター（待機）機能を利用してバケット内の特定のキーが存在するかどうかを検証したいケースはよくあります。

問題

Pythonのboto3ライブラリを使い、ウェイター機能によってバケット内にキーが存在するかどうかを確認します。例として、Bucket_1 内に test.zip というキーが存在するかどうかをウェイターでチェックしてみましょう。

解決のためのアプローチ／アルゴリズム

ステップ1 − boto3 および botocore の例外処理用モジュールをインポートします。

ステップ2 − 関数の引数として bucket_name（バケット名）と key（キー名）を受け取ります。

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

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

ステップ5 − get_waiter 関数を使って、object_exists 用のウェイターオブジェクトを作成します。

ステップ6 − ウェイターオブジェクトを使って、指定したバケット内にキーが存在するかどうかを検証します。デフォルトでは成功状態に達するまで5秒ごとにポーリングを実行し、20回失敗するとエラーを返します。なお、ポーリング間隔（Delay）と最大試行回数（MaxAttempts）はユーザーが自由に設定できます。

ステップ7 − 正常に完了した場合は None を返します。

ステップ8 − バケットの確認中に何らかの問題が発生した場合は、汎用例外をハンドリングします。

サンプルコード

以下のコードを使用すると、ウェイターでバケット内にキーが存在するかどうかを確認できます。

import boto3
from botocore.exceptions import ClientError

def use_waiters_check_object_exists(bucket_name, key_name):
    session = boto3.session.Session()
    s3_client = session.client('s3')
    try:
        waiter = s3_client.get_waiter('object_exists')
        waiter.wait(Bucket=bucket_name, Key=key_name,
                    WaiterConfig={
                        'Delay': 2, 'MaxAttempts': 5})
        print('Object exists: ' + bucket_name + '/' + key_name)
    except ClientError as e:
        raise Exception("boto3 client error in use_waiters_check_object_exists: " + e.__str__())
    except Exception as e:
        raise Exception("Unexpected error in use_waiters_check_object_exists: " + e.__str__())

print(use_waiters_check_object_exists("Bucket_1", "testfolder/test.zip"))
print(use_waiters_check_object_exists("Bucket_1", "testfolder/test1.zip"))

出力結果

Object exists: Bucket_1/testfolder/test.zip
None

botocore.exceptions.WaiterError: Waiter ObjectExists failed: Max
attempts exceeded
Exception: Unexpected error in use_waiters_check_object_exists: Waiter
ObjectExists failed: Max attempts exceeded

Bucket_1/testfolder/test.zip の場合、出力は print 文によるメッセージと None になります。ウェイターの応答自体は何も値を返さないため、None が表示されるのです。

一方、Bucket_1/testfolder/test1.zip の場合は該当オブジェクトが存在しないため、例外が発生します。

例外メッセージには「Max attempts exceeded（最大試行回数を超過しました）」という内容が含まれており、このことからキーがバケット内に存在しないことが確認できます。