Boto3を使ってAWS Glueのジョブ実行(Job Run)をページネーションで取得する方法

この記事では、AWS Glueに存在するジョブのすべてのジョブ実行(Job Run)を、ページネーション処理を使って効率的に取得する方法を解説します。

例

課題: Pythonのboto3ライブラリを使用して、自分のアカウント内に作成されたAWS Glueデータカタログのジョブについて、そのジョブ実行をページネーションで順次取得します。

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

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

• ステップ2: job_nameは必須パラメータです。一方、max_items、page_size、starting_tokenは任意のパラメータです。

  • max_items: 取得するレコードの総数を指定します。利用可能なレコード数がmax_itemsを超える場合、レスポンスにNextTokenが返され、これを使ってページネーションを再開できます。

  • page_size: 1ページあたりのサイズを指定します。

  • starting_token: ページネーションの開始位置を指定するためのもので、前回のレスポンスから取得したNextTokenを使用します。

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

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

• ステップ5: get_job_runsを使用して、すべてのジョブ実行情報を保持するpaginator(ページネーター)オブジェクトを作成します。

• ステップ6: paginate関数を呼び出し、max_items、page_size、starting_tokenをPaginationConfigパラメータとして渡します。

• ステップ7: MaxItemsとPageSizeの設定に基づいた件数のレコードが返されます。

• ステップ8: ページネーション処理中にエラーが発生した場合は、汎用例外を適切にハンドリングします。

サンプルコード

以下のコードを使用すると、ユーザーアカウントに作成されたジョブのすべてのジョブ実行をページネーションで取得できます。

import boto3
from botocore.exceptions import ClientError

def paginate_through_job_runs(job_name, max_items=None, page_size=None, starting_token=None):
    session = boto3.session.Session()
    glue_client = session.client('glue')
    try:
        paginator = glue_client.get_paginator('get_job_runs')
        response = paginator.paginate(
            JobName=job_name,
            PaginationConfig={
                'MaxItems': max_items,
                'PageSize': page_size,
                'StartingToken': starting_token
            }
        )
        return response
    except ClientError as e:
        raise Exception("boto3 client error in paginate_through_job_runs: " + str(e))
    except Exception as e:
        raise Exception("Unexpected error in paginate_through_job_runs: " + str(e))

a = paginate_through_job_runs("glue_test_job", 1, 5)
print(*a)

出力結果

上記のコードを実行すると、指定したジョブのジョブ実行情報が辞書形式で返されます。NextTokenが含まれている場合、まだ未取得のジョブ実行が存在することを意味し、このトークンをStartingTokenとして渡すことで続きのデータを取得できます。

{'JobRuns': [
{'Id': 'jr_435b66cfe451adf5fa7c7f914be3c87d199616f52bd13bdd91bb1269f02db705', 'Attempt': 0, 'JobName': 'glue_test_job', 'StartedOn': datetime.datetime(2021, 1, 25, 22, 19, 56, 52000, tzinfo=tzlocal()), 'LastModifiedOn': datetime.datetime(2021, 1, 25, 22, 21, 50, 603000, tzinfo=tzlocal()), 'CompletedOn': datetime.datetime(2021, 1, 25, 22, 21, 50, 603000, tzinfo=tzlocal()), 'JobRunState': 'SUCCEEDED', 'Arguments': {'--additional-python-modules': 'pandas==1.1.5', '--enable-glue-datacatalog': 'true', '--extra-files': 's3://glue/job/test', '--job-bookmark-option': 'job-bookmark-disable', 'step': '0'}, 'PredecessorRuns': [], 'AllocatedCapacity': 2, 'ExecutionTime': 107, 'Timeout': 2880, 'MaxCapacity': 2.0, 'WorkerType': 'G.1X', 'NumberOfWorkers': 2, 'LogGroupName': '/aws-glue/jobs', 'GlueVersion': '2.0'}],
'NextToken': 'eyJleHBpcmF0aW9uIjp7InNlY29uZHMiOjE2MTc0NTQ0NDgsIm5hbm9zIjo2OTUwMDAwMDB9LCJsYXN0RXZhbHVhdGVkS2V5Ijp7ImpvYklkIjp7InMiOiJqXzdlYzIzNTYwOWRkMGVmYjRhNTgyNDU2YWVlZmQ4NmFlMTgwYTAyNDQ3NWY2ODRkMzc4YWFiZDBmYTk1MGJmMDcifSwicnVuSWQiOnsicyI6ImpyXzJjNDFkMmJmMzY1NGZhZGFhYzkzMjU1ZTY0OTkxOTg2YTE0Yjk2MjIyMTRlNDc4ZGNkOWE0ZTY5N2M3MGZmY2YifSwic3RhcnRlZE9uIjp7Im4iOiIxNjExMjA3MjcwODIyIn19fQ==',
'ResponseMetadata': {'RequestId': '1874370e-***********-40d', 'HTTPStatusCode': 200, 'HTTPHeaders': {'date': 'Fri, 02 Apr 2021 12:54:08 GMT', 'content-type': 'application/x-amz-json-1.1', 'content-length': '6509', 'connection': 'keep-alive', 'x-amzn-requestid': '1874370e-**************40d'}, 'RetryAttempts': 0}}

まとめ

boto3のpaginator機能を活用することで、大量のジョブ実行履歴を持つAWS Glueジョブでも、API呼び出しの回数や取得データ量を制御しながら安定して情報を収集できます。PaginationConfigの各パラメータ(MaxItems、PageSize、StartingToken)を適切に組み合わせることで、バッチ処理や監視ツールなどでの活用範囲が大きく広がります。