boto3：PythonでAWSを操作

boto3とは

boto3は、Pythonを用いてAWSの各種サービスにアクセスするためのライブラリです。
AWSのAPIをPythonコードからシームレスに操作できるようにするツールで、PythonのオブジェクトのようにAWSリソースを扱うことができます。

基本的な概念

boto3を効果的に利用するためには、「セッション」と「クライアントとリソース」という2つの概念を理解することが重要です。

・セッション

セッションは、boto3がAWSサービスにアクセスするために使用するコンテキストを提供するオブジェクトです。セッションを使うことで、AWSの認証情報（アクセスキーやシークレットキーなど）や、デフォルトリージョン、使用するプロファイルを設定できます。boto3は、デフォルトでは、環境変数や設定ファイルから認証情報を自動的に取得しますが、セッションを明示的に作成することで、複数のAWSアカウントやリージョンを簡単に切り替えて使用することができます。

たとえば、次のようにしてセッションを作成し、特定のプロファイルやリージョンを指定します。

import boto3

# デフォルトのセッションを作成
default_session = boto3.Session()

# 特定のプロファイルを使用するセッションの作成
profile_session = boto3.Session(profile_name='my-profile')

# リージョンを指定してセッションを作成
region_session = boto3.Session(region_name='us-west-2')

このようにセッションを使うことで、同じコードベースで異なるAWSアカウントやリージョンにアクセスできるようになります。

・クライアント

クライアントは、低レベルのAWS API操作を行うためのインターフェースを提供します。クライアントを使用すると、AWS SDKのAPIを直接呼び出し、サービスの詳細な機能にアクセスすることができます。クライアントは非常に具体的で、AWSの公式ドキュメントに記載されているAPIとほぼ一対一で対応するため、正確で詳細な制御が可能です。

例えば、S3バケットのオブジェクトをリストするには、以下のようにクライアントを使用します。

s3_client = boto3.client('s3')
response = s3_client.list_objects_v2(Bucket='my-bucket')
for obj in response['Contents']:
    print(obj['Key'])

クライアントを使用するメリットは、明確にAPIリクエストを発行するための制御が可能である点です。ただ、コードがやや冗長になることもあり、読みやすさやメンテナンス性の面では少し複雑になる場合があります。

・リソース

リソースは、高レベルの抽象化されたAPIを提供し、よりオブジェクト指向な方法でAWSリソースを操作できるようにします。リソースAPIは、直感的で使いやすくコードがシンプルで理解しやすくなるように設計されています。
例えば、S3バケットの操作をリソースAPIで行う場合、次のように記述します。

s3 = boto3.resource('s3')
bucket = s3.Bucket('my-bucket')
for obj in bucket.objects.all():
    print(obj.key)

リソースAPIを使うと、バケットやオブジェクトをまるでPythonオブジェクトのように操作できるため、コードが自然で読みやすくなります。

クライアントとリソースの使い分け

クライアントとリソースのどちらを使用するかは、目的や必要な詳細度によって異なります。低レベルの詳細な操作や、APIエンドポイントごとの直接操作が必要な場合にはクライアントを使用し、簡潔でオブジェクト指向な操作が求められる場合にはリソースを使うと良いでしょう。たとえば、S3オブジェクトの大規模なアップロードやストレージ操作ではクライアントが適していることが多いですが、シンプルなCRUD操作であればリソースを使用したほうがコードが見やすくなります。

各サービスの操作方法

・S3

ファイルをS3バケットにアップロード

import boto3

# S3のリソースオブジェクトを作成
s3 = boto3.resource('s3')

# ファイルをS3にアップロード
bucket_name = 'my-bucket'
file_path = 'local_file.txt'
s3.Object(bucket_name, 'uploaded_file.txt').upload_file(file_path)

ファイルをダウンロード

# S3からファイルをダウンロード
s3.Object(bucket_name, 'uploaded_file.txt').download_file('downloaded_file.txt')

・EC2

EC2インスタンスの起動

ec2_client = boto3.client('ec2')

# EC2インスタンスの起動
response = ec2_client.run_instances(
    ImageId='ami-0abcdef1234567890',
    InstanceType='t2.micro',
    MinCount=1,
    MaxCount=1
)
instance_id = response['Instances'][0]['InstanceId']
print(f'Instance started: {instance_id}')

インスタンスの停止

# EC2インスタンスの停止
ec2_client.stop_instances(InstanceIds=[instance_id])

インスタンスの終了

# EC2インスタンスの終了
ec2_client.terminate_instances(InstanceIds=[instance_id])

・Lambda関数

関数の作成

lambda_client = boto3.client('lambda')

# Lambda関数の作成
response = lambda_client.create_function(
    FunctionName='MyLambdaFunction',
    Runtime='python3.9',
    Role='arn:aws:iam::123456789012:role/MyLambdaRole',
    Handler='lambda_function.lambda_handler',
    Code={'ZipFile': open('function.zip', 'rb').read()}
)

関数の更新

# Lambda関数の更新
lambda_client.update_function_code(
    FunctionName='MyLambdaFunction',
    ZipFile=open('new_function.zip', 'rb').read()
)

関数の削除

# Lambda関数の削除
lambda_client.delete_function(FunctionName='MyLambdaFunction')

エラーハンドリングと例外処理

boto3で発生する主な例外の種類

botocore.exceptions.NoCredentialsError:
AWSの認証情報が見つからない場合に発生します。正しいアクセスキーやシークレットキーが設定されていないときに起こります。

botocore.exceptions.PartialCredentialsError:
認証情報が不完全な場合に発生します。アクセスキーが設定されているが、シークレットキーが欠けている場合などです。

botocore.exceptions.ClientError:
AWSサービスへのリクエスト中にエラーが発生した場合に発生する例外です。このエラーはさまざまな原因によって引き起こされます。

botocore.exceptions.EndpointConnectionError:
指定されたエンドポイントへの接続が失敗した場合に発生します。ネットワークの問題やエンドポイントの設定ミスが原因となることが多いです。

エラーハンドリングの基本構文

import boto3
from botocore.exceptions import NoCredentialsError, PartialCredentialsError, ClientError, EndpointConnectionError

s3_client = boto3.client('s3')

try:
    # 存在しないバケットの情報を取得しようとする
    s3_client.head_bucket(Bucket='non-existent-bucket')
except NoCredentialsError:
    print('AWS認証情報が設定されていません。正しい認証情報を設定してください。')
except PartialCredentialsError:
    print('認証情報が不完全です。完全な認証情報を提供してください。')
except EndpointConnectionError:
    print('指定されたエンドポイントに接続できません。ネットワーク設定を確認してください。')
except ClientError as e:
    error_code = e.response['Error']['Code']
    if error_code == '404':
        print('指定されたバケットが見つかりません。')
    else:
        print(f'クライアントエラーが発生しました: {e}')