PythonのBoto3を使ってAWSのS3バケット一覧を取得する方法

本記事では、PythonのBoto3ライブラリとS3クライアントを使用して、AWSアカウント内に存在するすべてのバケットの一覧を取得する方法を解説します。

実現したいこと

例として、BUCKET_1、BUCKET_2、BUCKET_3 のようなバケット名の一覧を取得することを目標とします。

解決の手順・アルゴリズム

1. ステップ1: boto3 と botocore.exceptions をインポートし、例外処理に備えます。
2. ステップ2: Boto3ライブラリを使用してAWSセッションを作成します。
3. ステップ3: S3用のAWSクライアントを作成します。
4. ステップ4: list_buckets() 関数を実行し、ResponseMetadata や Buckets などのレスポンス情報を辞書形式で取得します。
5. ステップ5: for ループを使って、辞書からバケットごとの詳細情報(名前、作成日など)を取り出します。
6. ステップ6: バケットの辞書から名前(Name)のみを抽出し、リストに格納します。
7. ステップ7: 予期しない例外が発生した場合に対応できるよう、例外処理を実装します。
8. ステップ8: バケット名のリストを返します。

サンプルコード

以下のコードは、S3に存在するバケットの一覧を取得します。

import boto3
from botocore.exceptions import ClientError

# S3クライアントを使用してAWS上のバケット一覧を取得する
def get_buckets_client():
    session = boto3.session.Session()
    # 必要に応じてアクセスキー、シークレットキー、トークンを渡すことも可能
    s3_client = session.client('s3')
    try:
        response = s3_client.list_buckets()
        buckets = []
        for bucket in response['Buckets']:
            buckets.append(bucket["Name"])
    except ClientError:
        print("バケットを取得できませんでした。")
        raise
    else:
        return buckets

print(get_buckets_client())

実行結果

['BUCKET_1', 'BUCKET_2', 'BUCKET_3'……]

補足ポイント

• boto3.session.Session() を明示的に作成せず、boto3.client('s3') を直接呼び出すことも可能です。認証情報は環境変数や ~/.aws/credentials ファイルから自動的に読み込まれます。
• 特定のIAMユーザーの権限で実行する場合は、s3:ListAllMyBuckets アクションが許可されている必要があります。
• 大規模な環境では、返却されるバケット数が多い場合もあるため、必要に応じてリージョン指定やフィルタリングを検討するとよいでしょう。