Boto3を使ってAWS Glue Data Catalog内のすべての接続の詳細を取得する方法

課題

Pythonでboto3ライブラリを使用して、AWS Glue Data Catalogに登録されているすべての接続の詳細情報を取得します。

例

AWS Glue Data Catalog内のすべての接続定義の詳細を取得します。

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

ステップ1

boto3とbotocoreの例外クラスをインポートし、例外処理に備えます。

ステップ2

この操作ではパラメータは不要です。

ステップ3

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

ステップ4

Glue用のAWSクライアントを作成します。

ステップ5

get_connections関数を呼び出します。

ステップ6

AWS Glue Data Catalogから接続定義の詳細が取得されます。

ステップ7

処理中に予期しない問題が発生した場合に備えて、汎用的な例外ハンドリングを実装します。

サンプルコード

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

import boto3
from botocore.exceptions import ClientError

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

出力結果

このコードを実行すると、接続名、接続タイプ（JDBCなど）、接続プロパティ（JDBC接続URL、ユーザー名、パスワード）、サブネットIDやセキュリティグループなどの物理接続要件、作成日時・最終更新日時といった詳細情報が含まれたレスポンスが返されます。

{'ConnectionList': [
{'Name': '01_Daily', 'Description': '', 'ConnectionType': 'JDBC',
'ConnectionProperties': {'JDBC_CONNECTION_URL':
'jdbc:redshift://**********.us-east-1.redshift.amazonaws.com:5439/abc',
'JDBC_ENFORCE_SSL': 'false', 'PASSWORD': '!*******', 'USERNAME':
'********'}, 'PhysicalConnectionRequirements': {'SubnetId': 'subneta******e', 'SecurityGroupIdList': ['sg-********3'], 'AvailabilityZone':
'us-east-1a'}, 'CreationTime': datetime.datetime(2020, 12, 11, 17, 1,
51, 519000, tzinfo=tzlocal()), 'LastUpdatedTime':
datetime.datetime(2020, 12, 11, 17, 1, 51, 519000, tzinfo=tzlocal())},
{'Name': 'aurora-poc', 'ConnectionType': 'JDBC', 'ConnectionProperties':
{'JDBC_CONNECTION_URL': 'jdbc:postgresql://**********-cluster.clustercv********6p.us-east-1.rds.amazonaws.com:5432/*******,
'JDBC_ENFORCE_SSL': 'false', 'PASSWORD': '******', 'USERNAME': user'},
'PhysicalConnectionRequirements': {'SubnetId': 'subnet-35******e',
'SecurityGroupIdList': ['sg-*******d', 'sg-0***********'],
'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())},
{'Name': 'dev-ods', 'ConnectionType': 'JDBC', 'ConnectionProperties':
{'JDBC_CONNECTION_URL': 'jdbc:postgresql://*****************.us-east1.rds.amazonaws.com:5432/store', 'JDBC_ENFORCE_SSL': 'false',
'PASSWORD': '***********', 'USERNAME': user'},
'PhysicalConnectionRequirements': {'SubnetId': 'subnet-a********',
'SecurityGroupIdList': ['sg-*********b7', 'sg-a8********e'],
'AvailabilityZone': 'us-east-1a'}, 'CreationTime':
datetime.datetime(2020, 5, 27, 3, 10, 24, 538000, tzinfo=tzlocal()),
'LastUpdatedTime': datetime.datetime(2021, 2, 26, 5, 50, 53, 991000,
tzinfo=tzlocal())}],
'ResponseMetadata': {'RequestId': '58bae80d-*******************87',
'HTTPStatusCode': 200, 'HTTPHeaders': {'date': 'Sun, 28 Feb 2021
11:21:55 GMT', 'content-type': 'application/x-amz-json-1.1', 'contentlength': '11568', 'connection': 'keep-alive', 'x-amzn-requestid':
'58bae80d-************************87'}, 'RetryAttempts': 0}}