Boto3を使ってAWS Glueデータカタログのクローラーを起動する方法

この記事では、Pythonのboto3ライブラリを使用して、AWS Glueデータカタログ上のクローラーを起動する方法を解説します。

課題

課題: Pythonのboto3ライブラリを使って、クローラーを起動します。

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

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

• ステップ2: 関数のパラメータとしてcrawler_name(クローラー名)を受け取ります。

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

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

• ステップ5: start_crawler関数を呼び出し、パラメータcrawler_nameをNameとして渡します。

• ステップ6: この関数はレスポンスメタデータを返し、スケジュール設定に関係なくクローラーを起動します。なお、クローラーがすでに実行中の場合はCrawlerRunningExceptionが発生します。

• ステップ7: クローラーの起動中に予期しない問題が発生した場合に備えて、汎用例外もハンドリングしておきます。

サンプルコード

以下のコードは、AWS Glueデータカタログ内のクローラーを起動します。

import boto3
from botocore.exceptions import ClientError

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

#1回目： クローラーを起動
print(start_a_crawler("Data Dimension"))
#2回目： クローラーの処理完了前に再度実行
print(start_a_crawler("Data Dimension"))

実行結果

#1回目： クローラーを起動
{'ResponseMetadata': {'RequestId': '73e50130-*****************8e', 'HTTPStatusCode': 200, 'HTTPHeaders': {'date': 'Sun, 28 Mar 2021 07:26:55 GMT', 'content-type': 'application/x-amz-json-1.1', 'content-length': '2', 'connection': 'keep-alive', 'x-amzn-requestid': '73e50130-***************8e'}, 'RetryAttempts': 0}}

#2回目： クローラーの処理完了前に再度実行
Exception: boto3 client error in start_a_crawler: An error occurred (CrawlerRunningException) when calling the StartCrawler operation: Crawler with name Data Dimension has already started

解説

1回目の実行では、クローラーが正常に起動され、HTTPステータスコード200のレスポンスメタデータが返されます。一方、2回目の実行では、同じクローラー「Data Dimension」がまだ処理中であるため、CrawlerRunningExceptionが発生し、「クローラーはすでに起動している」というエラーメッセージが出力されます。

このように、例外処理を適切に実装することで、クローラーが既に稼働中であるケースやその他の予期しないエラーに対しても、わかりやすいエラーメッセージとともに安全に対応できるようになります。