Boto3を使ってAWS Glueのすべてのジョブをページネーションで取得する方法

この記事では、AWS Glueに存在するすべてのジョブをページネーション（ページ分割）しながら効率的に取得する方法を解説します。

例

問題: Pythonのboto3ライブラリを使用して、自分のアカウントに作成されたAWS Glue Data Catalog内のジョブをページネーションで一覧取得します。

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

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

• ステップ2: 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_jobsを使用して、すべてのジョブ情報を扱うpaginatorオブジェクトを作成します。

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

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

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

サンプルコード

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

import boto3
from botocore.exceptions import ClientError

def paginate_through_jobs(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_jobs')
        response = paginator.paginate(PaginationConfig={
            'MaxItems': max_items,
            'PageSize': page_size,
            'StartingToken': starting_token}
        )
        return response
    except ClientError as e:
        raise Exception("boto3 client error in paginate_through_jobs: " + e.__str__())
    except Exception as e:
        raise Exception("Unexpected error in paginate_through_jobs: " + e.__str__())

a = paginate_through_jobs(2, 5)
print(*a)

出力結果

上記のコードを実行すると、ジョブ情報の辞書と次ページ取得用のNextTokenが出力されます。以下は出力例です。

{'Jobs': [{'Name': 'PythonShellTest1', 'Role': 'arn:aws:iam::7***********:role/dev-edl-glue-role', 'CreatedOn': datetime.datetime(2021, 1, 6, 19, 59, 19, 387000, tzinfo=tzlocal()), 'LastModifiedOn': datetime.datetime(2021, 2, 9, 21, 47, 31, 614000, tzinfo=tzlocal()), 'ExecutionProperty': {'MaxConcurrentRuns': 1}, 'Command': {'Name': 'pythonshell', 'ScriptLocation': 's3://pythonShellTest/test1/', 'PythonVersion': '3'}, 'DefaultArguments': {'--job-bookmark-option': 'job-bookmark-disable', '--job-language': 'python'}, 'MaxRetries': 0, 'AllocatedCapacity': 0, 'Timeout': 2880, 'MaxCapacity': 0.0625, 'GlueVersion': '1.0'}, {'Name': 'pythonSHELL_14012021', 'Role': 'arn:aws:iam::7*************:role/dev-edl-glue-role', 'CreatedOn': datetime.datetime(2021, 1, 14, 20, 22, 40, 965000, tzinfo=tzlocal()), 'LastModifiedOn': datetime.datetime(2021, 1, 14, 20, 22, 40, 965000, tzinfo=tzlocal()), 'ExecutionProperty': {'MaxConcurrentRuns': 1}, 'Command': {'Name': 'pythonshell'}, 'DefaultArguments': {'--job-bookmark-option': 'job-bookmark-disable'}, 'MaxRetries': 0, 'AllocatedCapacity': 0, 'Timeout': 2880, 'MaxCapacity': 0.0625, 'GlueVersion': '1.0'}],
'NextToken': 'eyJleHBpcmF0aW9uIjp7InNlY29uZHMiOjE2MTc0NTUzOTYsIm5hbm9zIjo1MjUwMDAwMDB9LCJsYXN0RXZhbHVhdGVkS2V5Ijp7ImpvYk5hbWUiOnsicyI6IlRpY2tkYXRhLXBlcmZvcm1hbmNldGVzdC1qZXR0ZWxhIn0sImFjY291bnRJZCI6eyJzIjoiNzgyMjU4NDg1ODQxIn0sImpvYklkIjp7InMiOiJqXzkyZGQ5ZDNhMWRkOGY2NTJkYzA4MzNmMTM0ZTRiNDRhNmE0YzEzNWY0ZTYwZTkwNmYyOTBhY2NiZDZiMWIxZTcifX19',
'ResponseMetadata': {'RequestId': '3be6708e-*************-389', 'HTTPStatusCode': 200, 'HTTPHeaders': {'date': 'Fri, 02 Apr 2021 13:09:56 GMT', 'content-type': 'application/x-amz-json-1.1', 'content-length': '3182', 'connection': 'keep-alive', 'x-amzn-requestid': '3be6708e-*************-8389'}, 'RetryAttempts': 0}}