Boto3を使ってAWS Glue Data Catalogからトリガーの詳細情報を取得する方法

この記事では、Pythonのboto3ライブラリを使用して、AWS Glue Data Catalogに登録されているトリガー（Trigger）の詳細情報を取得する方法を解説します。

例

自分のアカウントで利用可能なトリガーのうち、「01_PythonShellTest1」という名前のトリガーの詳細情報を取得してみましょう。

問題を解決するためのアプローチとアルゴリズム

• ステップ1： 例外処理のために、boto3およびbotocoreの例外モジュールをインポートします。

• ステップ2： この関数の必須パラメータはtrigger_nameです。指定されたトリガー名に対応する詳細情報をユーザーアカウントから取得し、そのメタデータを表示します。

• ステップ3： boto3ライブラリを使用してAWSセッションを作成します。デフォルトプロファイルにregion_nameが設定されていることを確認してください。設定されていない場合は、セッション作成時に明示的にregion_nameを渡す必要があります。

• ステップ4： glueサービス用のAWSクライアントを作成します。

• ステップ5： get_triggerを呼び出し、引数Nameにトリガー名を渡します。

• ステップ6： 指定したトリガーの詳細情報が返されます。

• ステップ7： 処理中に問題が発生した場合に備えて、汎用例外を適切にハンドリングします。

サンプルコード

以下のコードは、ユーザーアカウントに登録されているトリガーの詳細情報を取得します。

import boto3
from botocore.exceptions import ClientError

def get_resource_metadata_of_trigger(trigger_name):
    session = boto3.session.Session()
    glue_client = session.client('glue')
    try:
        response = glue_client.get_trigger(Name=trigger_name)
        return response
    except ClientError as e:
        raise Exception("boto3 client error in get_resource_metadata_of_trigger: " + e.__str__())
    except Exception as e:
        raise Exception("Unexpected error in get_resource_metadata_of_trigger: " + e.__str__())

a = get_resource_metadata_of_trigger('01_PythonShellTest1')
print(a)

出力結果

{'Triggers': [{'Name': '01_PythonShellTest1', 'WorkflowName': 'arn:aws:iam::1234:role/dev-edl', 'Id': 'string', 'Type': 'SCHEDULED'|'CONDITIONAL'|'ON_DEMAND', 'State': 'CREATING'|'CREATED'|'ACTIVATING'|'ACTIVATED'|'DEACTIVATING'|'DEACTIVATED'|'DELETING'|'UPDATING', 'Description': 'string', 'Schedule': 'string'}]}

出力結果の主なフィールド

• Name： トリガーの名前です。

• Type： トリガーの種類を示します。「SCHEDULED」（スケジュール実行）、「CONDITIONAL」（条件付き）、「ON_DEMAND」（オンデマンド）のいずれかです。

• State： トリガーの現在の状態を示します。「CREATED」「ACTIVATED」「DEACTIVATED」などの値が返されます。

• Schedule： スケジュールタイプのトリガーの場合、cron形式のスケジュール式が格納されます。

このように、boto3のget_trigger APIを利用することで、AWS Glue Data Catalog上のトリガー情報を簡単にプログラムから取得できます。ワークフローの監視や自動化スクリプトの構築にも活用できるので、ぜひ参考にしてください。