Boto3を使ってAWS Glue Data Catalogから接続の詳細情報を取得する方法

はじめに

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

課題

Pythonのboto3ライブラリを使って、AWS Glue Data Catalog内に存在する特定の接続の詳細情報を取得すること。

例：接続定義「aurora-test」の詳細情報を取得する。

解決のための手順

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

ステップ2：詳細を確認したい接続名（connection_name）をパラメータとして渡します。

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

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

ステップ5：get_connection関数を呼び出し、接続名をNameパラメータとして渡します。

ステップ6：AWS Glue Data Catalogから該当する接続定義の詳細情報が取得されます。

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

サンプルコード

以下のコードを使用して、AWS Glue Data Catalog内の接続定義を取得できます。

import boto3
from botocore.exceptions import ClientError

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

print(get_details_of_a_connection("aurora-poc"))

実行結果

上記のコードを実行すると、以下のようなレスポンスが返されます。接続タイプ、JDBC接続URL、ユーザー名、サブネットID、セキュリティグループなどの詳細情報が含まれています。

{'Connection': {'Name': 'aurora-poc', 'ConnectionType': 'JDBC',
'ConnectionProperties': {'JDBC_CONNECTION_URL': 'jdbc:postgresql://abcpostgresql-cluster.cluster-abc.us-east-1.rds.amazonaws.com:0132/abc,
'JDBC_ENFORCE_SSL': 'false', 'PASSWORD': '******', 'USERNAME':
'abc***'}, 'PhysicalConnectionRequirements': {'SubnetId': 'subnet351*****', 'SecurityGroupIdList': ['sg-caa******', 'sg-*************'],
'AvailabilityZone': 'us-east-1c'}, 'CreationTime':
datetime.datetime(2020, 11, 18, 12, 38, 29, 625000, tzinfo=tzlocal()),
'LastUpdatedTime': datetime.datetime(2020, 11, 18, 12, 51, 16, 59000,
tzinfo=tzlocal())}, 'ResponseMetadata': {'RequestId': '6f13524b-4175-
454b-bc60-c7f408967098', 'HTTPStatusCode': 200, 'HTTPHeaders': {'date':
'Sun, 28 Feb 2021 11:19:18 GMT', 'content-type': 'application/x-amzjson-1.1', 'content-length': '523', 'connection': 'keep-alive', 'x-amznrequestid': '6f13524b-*****************7098'}, 'RetryAttempts': 0}}

まとめ

boto3のget_connection関数を使用することで、AWS Glue Data Catalogに登録された接続の詳細情報を簡単に取得できます。取得できる情報には、接続タイプ、接続プロパティ、物理的な接続要件（サブネットやセキュリティグループなど）、作成日時・更新日時などが含まれます。エラーハンドリングを適切に実装することで、堅牢なコードを作成できます。