【Python】Boto3を使ってAWS Secrets Managerの全シークレット一覧を取得する方法

課題

Pythonのboto3ライブラリを使用して、AWS Secrets Manager（AWSシークレットマネージャー）に保存されているすべてのシークレットの一覧を取得する方法を解説します。

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

• ステップ1： 例外処理のために boto3 および botocore.exceptions をインポートします。
• ステップ2： この処理には入力パラメータは不要です。
• ステップ3： boto3ライブラリを使ってAWSセッションを作成します。デフォルトプロファイルに region_name が設定されていることを確認してください。設定されていない場合は、セッション作成時に明示的に region_name を渡す必要があります。
• ステップ4： secretmanager 用のAWSクライアントを作成します。
• ステップ5： list_secrets 関数を呼び出して、すべてのシークレット情報を取得します。
• ステップ6： 戻り値として、すべてのシークレットのメタデータが返されます。
• ステップ7： シークレット一覧の取得中に問題が発生した場合に備え、汎用例外のハンドリングを行います。

サンプルコード

以下のコードを使用すると、AWS Secrets Manager内のすべてのシークレット一覧を取得できます。

import boto3
from botocore.exceptions import ClientError

def get_all_secrets():
    session = boto3.session.Session()
    secrets_client = session.client('secretmanager')
    try:
        response = secrets_client.list_secrets()
        return response
    except ClientError as e:
        raise Exception("boto3 client error in get_all_secrets: " + e.__str__())
    except Exception as e:
        raise Exception("Unexpected error in get_all_secrets: " + e.__str__())

a = get_all_secrets()
for details in a['SecretList']:
    print(details['Name'])

実行結果

tests/secrets
tests/aws/secrets
tests/aws/users

補足：大量のシークレットを扱う場合の注意点

list_secrets APIは、デフォルトで最大100件までの結果を返すページング方式のAPIです。シークレットの数が多い場合は、レスポンスに含まれる NextToken を次のリクエストに渡すことで、残りのシークレットを順次取得できます。

paginator = secrets_client.get_paginator('list_secrets')
for page in paginator.paginate():
    for secret in page['SecretList']:
        print(secret['Name'])

ページネーター（paginator）を利用すると、NextTokenの管理を自動的に行ってくれるため、大量のシークレットでも漏れなく一覧を取得でき、コードも簡潔になります。