Boto3のWaiter（待機）機能を使って、S3バケットにキーが存在しないことを検証する方法

この記事では、Pythonのboto3ライブラリに用意されているWaiter（ウェイター）機能を使って、特定のキーがS3バケット内に存在しないことを確認する方法を解説します。例として、「Bucket_1」というバケット内に「test1.zip」というキーが存在しないことをWaiterでチェックしてみましょう。

boto3のWaiterは、オブジェクトの作成や削除など、時間のかかる非同期処理が完了するまで自動的にポーリング（定期確認）してくれる便利な仕組みです。ここでは「object_not_exists」ウェイターを利用し、オブジェクトが消える（または最初から存在しない）のを待つ処理を実装します。

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

ステップ1 − 例外処理のために、boto3とbotocore.exceptionsをインポートします。

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

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

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

ステップ5 − get_waiter関数を使って、「object_not_exists」のWaiterオブジェクトを生成します。

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

ステップ7 − 検証が正常に完了した場合、戻り値はNoneです。

ステップ8 − チェック中に問題が発生した場合は、汎用例外をキャッチして適切にハンドリングします。

サンプルコード

以下のコードを使うと、Waiterによってキーがバケット内に存在しないことを確認できます。

import boto3
from botocore.exceptions import ClientError

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

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

出力結果

Object does not exist: Bucket_1/testfolder/test1.zip
None

botocore.exceptions.WaiterError: Waiter ObjectNotExists failed: Max attempts exceeded
Exception: Unexpected error in use_waiters_check_object_not_exists:
Waiter ObjectNotExists failed: Max attempts exceeded

実行結果の解説

「Bucket_1/testfolder/test1.zip」の場合、print文の出力とNoneが表示されます。これは、キーが実際に存在せず、Waiterが即座に成功状態になったためです。関数自体は明示的に値を返していないので、Noneが出力されます。

一方、「Bucket_1/testfolder/test.zip」の場合は、このオブジェクトが実際に存在するため、Waiterは成功状態に到達できず、最終的に例外が発生します。

例外メッセージには「Max attempts exceeded（最大試行回数を超過しました）」と記録されており、設定したMaxAttemptsの回数だけポーリングを繰り返してもオブジェクトが消えなかったことが分かります。

まとめ

Waiter機能を活用することで、オブジェクトの存在確認をシンプルかつ堅牢に実装できます。DelayとMaxAttemptsを調整すれば、システムの要件に合わせた柔軟な待機処理が可能になります。削除ジョブの完了確認など、オブジェクトが「なくなる」のを待ちたい場面でぜひ活用してください。