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

問題の概要

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

例

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

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

ステップ1： boto3とbotocoreの例外クラスをインポートし、例外処理に備えます。

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

ステップ3： S3用のAWSリソースを作成します。

ステップ4： head_bucket() 関数を使用します。この関数は、バケットが存在し、ユーザーがアクセス権限を持っている場合に 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_resource = session.resource('s3')
        s3_resource.meta.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() は軽量なAPI呼び出しであり、バケット内のオブジェクト一覧を取得せずに存在確認だけを行えるため、効率的です。また、403エラーが返された場合はバケット自体は存在しているもののアクセス権限がない（プライベートバケットである）ことを意味し、404エラーの場合はバケットが存在しないことを示します。この違いを適切にハンドリングすることで、より正確な存在判定が可能になります。