Boto3とAWSクライアントを使ってS3バケットのライフサイクル構成を取得する方法

はじめに

本記事では、Pythonのboto3ライブラリを使用して、Amazon S3バケットに設定されたライフサイクル構成（Lifecycle Configuration）を取得する方法を解説します。具体例として、S3上の「Bucket_1」に登録されているライフサイクルルールの情報を取得してみましょう。

S3のライフサイクル構成を把握しておくと、ストレージクラスへの移行タイミングやオブジェクトの有効期限ポリシーなどをプログラムから確認でき、コスト管理や運用自動化に役立ちます。

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

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

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

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

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

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

ステップ6 − 戻り値として、S3バケットのライフサイクル詳細を含む辞書（dict）が返されます。

ステップ7 − 処理中に問題が発生した場合に備え、ClientErrorなどの例外を捕捉し、適切にハンドリングします。

サンプルコード

以下のコードを使用すると、指定したバケットのライフサイクル構成を取得できます。

import boto3
from botocore.exceptions import ClientError

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

print(get_bucket_lifecycle_of_s3("Bucket_1"))

実行結果

{
    'Rules': [
        {
            'ID': 'Rule for TaxDocs/',
            'Prefix': 'TaxDocs',
            'Status': 'Enabled',
            'Transitions': [
                {
                    'Days': 365,
                    'StorageClass': 'STANDARD_IA',
                },
            ],
        },
    ],
    'ResponseMetadata': {
        '...': '...',
    },
}

結果の見方

この出力例では、「TaxDocs」というプレフィックスを持つオブジェクトに対して、作成から365日後にストレージクラス「STANDARD_IA」（低頻度アクセス）へ移行するルールが有効（Enabled）になっていることが分かります。このように、get_bucket_lifecycle_configurationを使えば、バケットごとのライフサイクルルールを簡単にプログラムから確認できます。