Boto3とAWSクライアントを使ってS3バケットの場所（リージョン）を取得する方法

はじめに

Pythonのboto3ライブラリを使用すると、S3バケットがどのリージョン（場所）に作成されているかを簡単に確認できます。本記事では、get_bucket_location APIを呼び出して、S3上の「Bucket_1」が存在する場所を取得する手順を解説します。

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

ステップ1： 例外処理のためにboto3およびbotocoreの例外クラスをインポートします。

ステップ2： 関数のパラメータとしてバケット名（bucket_name）を受け取ります。

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

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

ステップ5： get_bucket_location_of_s3関数を呼び出し、バケット名を引数として渡します。

ステップ6： バケットの場所情報を含む辞書（dict）が返されます。

ステップ7： 処理中に予期しないエラーが発生した場合に備え、汎用的な例外処理を実装しておきます。

サンプルコード

以下のコードを使用すると、バケットの場所を取得できます。

import boto3
from botocore.exceptions import ClientError

def get_bucket_location_of_s3(bucket_name):
    session = boto3.session.Session()
    s3_client = session.client('s3')
    try:
        result = s3_client.get_bucket_location(Bucket=bucket_name)
    except ClientError as e:
        raise Exception("boto3 client error in get_bucket_location_of_s3: " + e.__str__())
    except Exception as e:
        raise Exception("Unexpected error in get_bucket_location_of_s3 function: " + e.__str__())
    return result

print(get_bucket_location_of_s3("Bucket_1"))

実行結果

{
    'LocationConstraint': 'us-west-2'|'us-west-1'|'us-east-2'|'us-east-1',
    'ResponseMetadata': {
        '...': '...',
    },
}

補足ポイント

LocationConstraintには、バケットが作成されたリージョン名が返されます。なお、デフォルトリージョンのus-east-1に作成されたバケットの場合、LocationConstraintはnull（None）となる点に注意してください。これはAWSの仕様によるものであり、エラーではありません。