使用 Python 和 Boto3 列出 S3 存储桶的目录内容？

Question

我正在尝试使用 Python 和 Boto3 列出 S3 存储桶中的所有目录。

我正在使用以下代码：

s3 = session.resource('s3')  # I already have a boto3 Session object
bucket_names = [
    'this/bucket/',
    'that/bucket/'
]
for name in bucket_names:
    bucket = s3.Bucket(name)
    for obj in bucket.objects.all():  # this raises an exception
        # handle obj

当我运行它时，我得到以下异常堆栈跟踪：

File "botolist.py", line 67, in <module>
  for obj in bucket.objects.all():
File "/Library/Python/2.7/site-packages/boto3/resources/collection.py", line 82, in __iter__
  for page in self.pages():
File "/Library/Python/2.7/site-packages/boto3/resources/collection.py", line 165, in pages
  for page in pages:
File "/Library/Python/2.7/site-packages/botocore/paginate.py", line 83, in __iter__
  response = self._make_request(current_kwargs)
File "/Library/Python/2.7/site-packages/botocore/paginate.py", line 155, in _make_request
  return self._method(**current_kwargs)
File "/Library/Python/2.7/site-packages/botocore/client.py", line 270, in _api_call
  return self._make_api_call(operation_name, kwargs)
File "/Library/Python/2.7/site-packages/botocore/client.py", line 335, in _make_api_call
  raise ClientError(parsed_response, operation_name)

botocore.exceptions.ClientError: An error occurred (NoSuchKey) when calling the ListObjects operation: The specified key does not exist.

列出存储桶内目录的正确方法是什么？

Answer 1

所有这些其他反应都不尽如人意。 使用

client.list_objects()

将您限制为最多 1k 个结果。 其余的答案要么错误，要么过于复杂。

自己处理延续令牌是一个糟糕的主意。 只需使用分页器，它会为您处理该逻辑

你想要的解决方案是：

[e['Key'] for p in client.get_paginator("list_objects_v2")\
                         .paginate(Bucket='my_bucket')
          for e in p['Contents']]

Answer 2

如果您有会话，请创建一个客户端并获取客户端list_objects的CommonPrefixes ：

client = session.client('s3', 
                        # region_name='eu-west-1'
                        )

result = client.list_objects(Bucket='MyBucket', Delimiter='/')
for obj in result.get('CommonPrefixes'):
    #handle obj.get('Prefix')

可能有很多文件夹，但您可能希望从一个子文件夹开始。 这样的事情可以处理：

def folders(client, bucket, prefix=''):
    paginator = client.get_paginator('list_objects')
    for result in paginator.paginate(Bucket=bucket, Prefix=prefix, Delimiter='/'):
        for prefix in result.get('CommonPrefixes', []):
            yield prefix.get('Prefix')

gen_folders = folders(client, 'MyBucket')
list(gen_folders)

gen_subfolders = folders(client, 'MyBucket', prefix='MySubFolder/')
list(gen_subfolders)

Answer 3

或者，您可能想使用boto3.client

例子

import boto3 
client = boto3.client('s3')
client.list_objects(Bucket='MyBucket')

list_objects还支持迭代结果可能需要的其他参数：Bucket、Delimiter、EncodingType、Marker、MaxKeys、Prefix

Answer 4

获取 S3 存储桶中具有特定前缀的所有对象列表的最佳方法是使用list_objects_v2和ContinuationToken来克服 1000 个对象分页限制。

import boto3
s3 = boto3.client('s3')

s3_bucket = 'your-bucket'
s3_prefix = 'your/prefix'
partial_list = s3.list_objects_v2(
        Bucket=s3_bucket, 
        Prefix=s3_prefix)
obj_list = partial_list['Contents']
while partial_list['IsTruncated']:
    next_token = partial_list['NextContinuationToken']
    partial_list = s3.list_objects_v2(
        Bucket=s3_bucket, 
        Prefix=s3_prefix, 
        ContinuationToken=next_token)
    obj_list.extend(partial_list['Contents'])

Answer 5

如果文件夹中的对象少于 1,000 个，则可以使用以下代码：

import boto3

s3 = boto3.client('s3')
object_listing = s3.list_objects_v2(Bucket='bucket_name',
                                    Prefix='folder/sub-folder/')

Answer 6

我原以为存储桶名称中不能有斜杠。 您说要列出存储桶中的所有目录，但您的代码尝试列出多个存储桶中的所有内容（不一定是目录）。 这些存储桶可能不存在（因为它们具有非法名称）。 所以当你跑

bucket = s3.Bucket(name)

桶可能为空，随后的列表将失败。