Boto3とAWSクライアントでS3バケットの通知設定を取得する方法を解説

課題：S3バケットの通知設定の詳細を取得したい

Pythonのboto3ライブラリを使用して、Amazon S3バケットに設定された通知設定（Notification Configuration）の詳細を取得します。例として、S3上の「Bucket_1」というバケットの通知設定内容を確認していきましょう。

S3のイベント通知機能を使うと、オブジェクトの作成や削除などをトリガーに、SNSトピック・SQSキュー・Lambda関数へ自動的に通知を送信できます。本記事のコードを利用すれば、こうした設定内容をプログラムから簡単に一覧できます。

解決のためのアプローチと手順

ステップ1：例外処理のために、boto3とbotocore.exceptionsをインポートします。

ステップ2：関数の引数としてバケット名（bucket_name）を受け取るようにします。

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

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

ステップ5：get_bucket_notification_configurationを呼び出し、バケット名を渡します。

ステップ6：S3の詳細情報を含む辞書が返されます。通知設定が未設定の場合は、空のレスポンスが返ります。

ステップ7：処理中に問題が発生した場合に備え、汎用的な例外処理を実装します。

事前準備

コードを実行する前に、次の点を確認してください。

• AWS認証情報（アクセスキー／シークレットキー）が環境変数または~/.aws/credentialsに設定済みであること
• 対象バケットに対するs3:GetBucketNotification権限を持つIAMポリシーが割り当てられていること
• boto3がインストールされていること（pip install boto3）

サンプルコード

以下のコードで、S3バケットの通知設定の詳細を取得できます。

import boto3
from botocore.exceptions import ClientError

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

print(get_bucket_notificationconfiguration_of_s3("Bucket_1"))

出力結果

実行すると、次のような辞書形式のデータが返されます。

{
    'TopicConfigurations': [
        {
            'Id': 'string',
            'TopicArn': 'string',
            'Events': [
                's3:ReducedRedundancyLostObject' | 's3:ObjectCreated:*' | 's3:ObjectCreated:Put'
                | 's3:ObjectCreated:Post' | 's3:ObjectCreated:Copy'
                | 's3:ObjectCreated:CompleteMultipartUpload' | 's3:ObjectRemoved:*'
                | 's3:ObjectRemoved:Delete' | 's3:ObjectRemoved:DeleteMarkerCreated'
                | 's3:ObjectRestore:*' | 's3:ObjectRestore:Post' | 's3:ObjectRestore:Completed'
                | 's3:Replication:*' | 's3:Replication:OperationFailedReplication'
                | 's3:Replication:OperationNotTracked' | 's3:Replication:OperationMissedThreshold'
                | 's3:Replication:OperationReplicatedAfterThreshold',
            ],
            'Filter': {
                'Key': {
                    'FilterRules': [
                        {
                            'Name': 'prefix' | 'suffix',
                            'Value': 'string'
                        },
                    ]
                }
            }
        },
    ],
    'QueueConfigurations': [
        {
            'Id': 'string',
            'QueueArn': 'string',
            'Events': [※TopicConfigurationsと同一のイベント種別],
            'Filter': {※同一のフィルタ構造}
        },
    ],
    'LambdaFunctionConfigurations': [
        {
            'Id': 'string',
            'LambdaFunctionArn': 'string',
            'Events': [※TopicConfigurationsと同一のイベント種別],
            'Filter': {※同一のフィルタ構造}
        },
    ]
}

出力内容の読み方

• TopicConfigurations：SNSトピックへ通知を送る設定
• QueueConfigurations：SQSキューへ通知を送る設定
• LambdaFunctionConfigurations：Lambda関数を起動する設定

各設定には、設定を識別するID、送信先のARN、トリガーとなるイベント種別（Events）、さらにFilterによるオブジェクトキーの絞り込み（prefix＝前方一致、suffix＝後方一致）が含まれます。

注意点

出力内容はバケットの設定状況や権限によって変わります。デフォルト設定のまま、あるいは未設定の項目は結果から省略されます。また、バケットに通知設定がまったく登録されていない場合は、空の結果が返される点に留意してください。