Boto3とAWSクライアントでbucket_not_existsのウェイター機能を使う方法

課題 − Pythonのboto3ライブラリを使用して、ウェイター（waiter）機能によりバケットが存在しないことを確認します。例として、S3上に「Bucket_2」が存在しないことをウェイターでチェックするケースを考えます。

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

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

ステップ2 − 関数の引数としてbucket_nameを受け取ります。

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

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

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

ステップ6 − ウェイトオブジェクトを使って、バケットが存在しないことを検証します。デフォルトでは5秒ごとにチェックが行われ、成功状態（＝対象バケットがS3に存在しない状態）に達するまで処理が繰り返されます。20回チェックが失敗するとエラーが返されます。なお、ポーリング間隔（Delay）と最大試行回数（MaxAttempts）はユーザーが自由に設定できます。

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

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

コード例

以下のコードを使用して、ウェイターでbucket_not_existsをチェックします。

import boto3
from botocore.exceptions import ClientError

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

print(use_waiters_check_bucket_not_exists("Bucket_2"))
print(use_waiters_check_bucket_not_exists("Bucket_1"))

出力

Bucket not exist: Bucket_2
None

botocore.exceptions.WaiterError: Waiter BucketNotExists failed: Max
attempts exceeded
"Unexpected error in use_waiters_check_bucket_not_exists: " +
e.__str__())
Exception: Unexpected error in use_waiters_check_bucket_not_exists:
Waiter BucketNotExists failed: Max attempts exceed

「Bucket_2」の場合、出力はprint文のメッセージとNoneになります。wait関数のレスポンス自体は何も値を返さないため、Noneが出力される点に注意してください。

一方、「Bucket_1」の場合は例外が発生します。これは、最大試行回数に達してもそのバケットが存在し続けているためです。

例外メッセージには「Max attempts exceeded（最大試行回数を超過）」という内容が表示され、ウェイターが指定回数内に成功状態へ到達できなかったことが分かります。