boto3を使用してS3オブジェクトをファイルに保存する方法

AWSの新しいboto3クライアントで「hello world」を実行しようとしています。

私の使用例はかなり単純です。S3からオブジェクトを取得してファイルに保存します。

boto 2.XIでは、次のようにします。

import boto
key = boto.connect_s3().get_bucket('foo').get_key('foo')
key.get_contents_to_filename('/tmp/foo')

ボト3。同じことをするためのクリーンな方法が見つからないため、「Streaming」オブジェクトを手動で反復しています。

import boto3
key = boto3.resource('s3').Object('fooo', 'docker/my-image.tar.gz').get()
with open('/tmp/my-image.tar.gz', 'w') as f:
    chunk = key['Body'].read(1024*8)
    while chunk:
        f.write(chunk)
        chunk = key['Body'].read(1024*8)

または

import boto3
key = boto3.resource('s3').Object('fooo', 'docker/my-image.tar.gz').get()
with open('/tmp/my-image.tar.gz', 'w') as f:
    for chunk in iter(lambda: key['Body'].read(4096), b''):
        f.write(chunk)

そして、それはうまくいきます。同じタスクを実行する「ネイティブ」のboto3関数はあるのでしょうか。

Boto3に最近導入されたカスタマイズにより、（特に）これに役立ちます。現在、低レベルのS3クライアントで公開されており、次のように使用できます。

s3_client = boto3.client('s3')
open('hello.txt').write('Hello, world!')

# Upload the file to S3
s3_client.upload_file('hello.txt', 'MyBucket', 'hello-remote.txt')

# Download the file from S3
s3_client.download_file('MyBucket', 'hello-remote.txt', 'hello2.txt')
print(open('hello2.txt').read())

これらの関数は、ファイルの読み取り/書き込みを自動的に処理し、大きなファイルのマルチパートアップロードを並行して実行します。

ただしs3_client.download_file、ディレクトリは作成されません。として作成できますpathlib.Path('/path/to/file.txt').parent.mkdir(parents=True, exist_ok=True)。

boto3は、クライアントよりも優れたインターフェースを備えています。

resource = boto3.resource('s3')
my_bucket = resource.Bucket('MyBucket')
my_bucket.download_file(key, local_filename)

これだけでclientは、受け入れられた回答よりもそれほど優れているわけではありませんが（ドキュメントでは、失敗時にアップロードとダウンロードを再試行する方がより良いジョブを行うと述べています）、リソースは一般的に人間工学的であることを考慮しています（たとえば、s3 バケットとオブジェクトリソース）クライアントメソッドよりも優れています）これにより、ドロップダウンすることなくリソースレイヤーに留まることができます。

Resources 通常、クライアントと同じ方法で作成でき、同じ引数のすべてまたはほとんどを受け取り、内部クライアントに転送するだけです。

set_contents_from_stringlike boto2メソッドをシミュレートしたい方は、

import boto3
from cStringIO import StringIO

s3c = boto3.client('s3')
contents = 'My string to save to S3 object'
target_bucket = 'hello-world.by.vor'
target_file = 'data/hello.txt'
fake_handle = StringIO(contents)

# notice if you do fake_handle.read() it reads like a file handle
s3c.put_object(Bucket=target_bucket, Key=target_file, Body=fake_handle.read())

Python3の場合：

python3では、StringIOと cStringIOの両方がなくなりました。次のStringIOようにインポートを使用します。

from io import StringIO

両方のバージョンをサポートするには：

try:
   from StringIO import StringIO
except ImportError:
   from io import StringIO

# Preface: File is json with contents: {'name': 'Android', 'status': 'ERROR'}

import boto3
import io

s3 = boto3.resource('s3')

obj = s3.Object('my-bucket', 'key-to-file.json')
data = io.BytesIO()
obj.download_fileobj(data)

# object is now a bytes string, Converting it to a dict:
new_dict = json.loads(data.getvalue().decode("utf-8"))

print(new_dict['status']) 
# Should print "Error"

デフォルトの構成とは異なる構成のファイルを読みたい場合は、mpu.aws.s3_download(s3path, destination)直接使用するか、コピーして貼り付けたコードを使用してください。

def s3_download(source, destination,
                exists_strategy='raise',
                profile_name=None):
    """
    Copy a file from an S3 source to a local destination.

    Parameters
    ----------
    source : str
        Path starting with s3://, e.g. 's3://bucket-name/key/foo.bar'
    destination : str
    exists_strategy : {'raise', 'replace', 'abort'}
        What is done when the destination already exists?
    profile_name : str, optional
        AWS profile

    Raises
    ------
    botocore.exceptions.NoCredentialsError
        Botocore is not able to find your credentials. Either specify
        profile_name or add the environment variables AWS_ACCESS_KEY_ID,
        AWS_SECRET_ACCESS_KEY and AWS_SESSION_TOKEN.
        See https://boto3.readthedocs.io/en/latest/guide/configuration.html
    """
    exists_strategies = ['raise', 'replace', 'abort']
    if exists_strategy not in exists_strategies:
        raise ValueError('exists_strategy \'{}\' is not in {}'
                         .format(exists_strategy, exists_strategies))
    session = boto3.Session(profile_name=profile_name)
    s3 = session.resource('s3')
    bucket_name, key = _s3_path_split(source)
    if os.path.isfile(destination):
        if exists_strategy is 'raise':
            raise RuntimeError('File \'{}\' already exists.'
                               .format(destination))
        elif exists_strategy is 'abort':
            return
    s3.Bucket(bucket_name).download_file(key, destination)

from collections import namedtuple

S3Path = namedtuple("S3Path", ["bucket_name", "key"])


def _s3_path_split(s3_path):
    """
    Split an S3 path into bucket and key.

    Parameters
    ----------
    s3_path : str

    Returns
    -------
    splitted : (str, str)
        (bucket, key)

    Examples
    --------
    >>> _s3_path_split('s3://my-bucket/foo/bar.jpg')
    S3Path(bucket_name='my-bucket', key='foo/bar.jpg')
    """
    if not s3_path.startswith("s3://"):
        raise ValueError(
            "s3_path is expected to start with 's3://', " "but was {}"
            .format(s3_path)
        )
    bucket_key = s3_path[len("s3://"):]
    bucket_name, key = bucket_key.split("/", 1)
    return S3Path(bucket_name, key)

注：認証を個別に構成していることを前提としています。以下のコードは、S3バケットから単一のオブジェクトをダウンロードすることです。

import boto3

#initiate s3 client 
s3 = boto3.resource('s3')

#Download object to the file    
s3.Bucket('mybucket').download_file('hello.txt', '/tmp/hello.txt')