Boto3とAWSクライアントを使ってS3にバケットが存在するかどうかを判定する方法

課題 − PythonのBoto3ライブラリを使用して、指定したバケット（ルートバケット）がAmazon S3上に存在するかどうかを判定します。

例 − S3上に「bucket_1」というバケットが存在するかどうかを確認します。

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

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

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

ステップ3 − S3用のAWSクライアントオブジェクトを生成します。

ステップ4 − head_bucket() 関数を呼び出します。このAPIは軽量で、バケットが存在し、かつユーザーがアクセス権限を持っている場合は 200 OK を返します。アクセス権限がない場合は 403 Forbidden、バケットが存在しない場合は 404 Not Found が返されます。

ステップ5 − 返却されたレスポンスコードに応じて例外を適切に処理します。

ステップ6 − バケットの存在有無に応じて True / False を返します。

サンプルコード

以下のコードは、指定したバケットがS3上に存在するかどうかをチェックします。

import boto3
from botocore.exceptions import ClientError

# バケットが存在するかどうかを確認する関数
def bucket_exists(bucket_name):
    try:
        session = boto3.session.Session()
        # 必要に応じてアクセスキー、シークレットキー、トークンを渡すことも可能
        s3_client = session.client('s3')
        s3_client.head_bucket(Bucket=bucket_name)
        print("Bucket exists.", bucket_name)
        exists = True
    except ClientError as error:
        error_code = int(error.response['Error']['Code'])
        if error_code == 403:
            print("Private Bucket. Forbidden Access! ", bucket_name)
        elif error_code == 404:
            print("Bucket Does Not Exist!", bucket_name)
        exists = False
    return exists

print(bucket_exists('bucket_1'))
print(bucket_exists('AWS_bucket_1'))

実行結果

Bucket exists. bucket_1
True
Bucket Does Not Exist! AWS_bucket_1
False

ポイント解説

head_bucket() を使うメリット

• バケット内のオブジェクト一覧を取得しないため、list_objects_v2() などと比べて非常に軽量で高速です。
• 存在確認とアクセス権限の確認を同時に行えるため、バケット操作前の事前チェックに最適です。
• 大規模バケットでも追加コストやタイムアウトの心配がほとんどありません。

エラーコードの意味

• 403 Forbidden：バケットは存在するが、現在の認証情報ではアクセス権限がない（プライベートバケット）ことを示します。
• 404 Not Found：指定された名前のバケットがS3上に存在しないことを示します。

このように、head_bucket() と ClientError のハンドリングを組み合わせることで、シンプルかつ確実にS3バケットの存在確認を実装できます。