Boto3とAWSクライアントを使ってS3バケットのロギング設定情報を取得する方法

課題

Pythonのboto3ライブラリを使用して、S3バケットのロギング設定（ログ記録）の詳細情報を取得します。ここでは、例としてS3上の「Bucket_1」のロギング詳細を取得するケースを扱います。

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

ステップ1 − 例外を適切に処理できるよう、boto3とbotocoreの例外モジュールをインポートします。

ステップ2 − 関数の引数としてbucket_name（バケット名）を受け取ります。

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

ステップ4 − 作成したセッションからS3用のAWSクライアントを生成します。

ステップ5 − get_bucket_logging関数を呼び出し、対象のバケット名を渡します。

ステップ6 − 戻り値として、S3バケットのロギング設定内容を含む辞書（dict）が返されます。

ステップ7 − 処理中に予期しない問題が発生した場合に備え、汎用的な例外ハンドリングを行います。

実装例

以下のコードを実行すると、指定したバケットのロギング詳細を取得できます。

import boto3
from botocore.exceptions import ClientError

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

print(get_bucket_logging_of_s3("Bucket_1"))

実行結果

コードが正常に実行されると、次のような辞書形式でロギング設定の詳細が出力されます。LoggingEnabledキーには、ログの保存先バケット（TargetBucket）、アクセス権限（TargetGrants）、ログオブジェクト名のプレフィックス（TargetPrefix）などの情報が含まれます。

{
    'LoggingEnabled': {
        'TargetBucket': 'string',
        'TargetGrants': [
            {
                'Grantee': {
                    'DisplayName': 'string',
                    'EmailAddress': 'string',
                    'ID': 'string',
                    'Type': 'CanonicalUser'|'AmazonCustomerByEmail'|'Group',
                    'URI': 'string'
                },
                'Permission': 'FULL_CONTROL'|'READ'|'WRITE'
            },
        ],
        'TargetPrefix': 'string'
    }
}