1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
| import boto3
S3_ACCESS_KEY = 's3_access_key'
S3_SECRET_KEY = 's3_secret_key'
class S3Client():
def __init__(self, aws_access_key=S3_ACCESS_KEY, aws_secret_key=S3_SECRET_KEY):
self.aws_access_key = aws_access_key
self.aws_secret_key = aws_secret_key
self.client = boto3.client(
's3',
aws_access_key_id=self.aws_access_key,
aws_secret_access_key=self.aws_secret_key)
def list_folder_contents(self, bucket_name, folder_name=None, exclude_self=True):
if folder_name:
folder_name = os.path.join(folder_name, '') # ensure it ends in a slash
else:
folder_name = '' # non-prefixed -- all folders
objects = []
incomplete = True
continuation_token = None
while incomplete:
if continuation_token:
response = self.client.list_objects_v2(
Bucket=bucket_name,
Prefix=folder_name,
ContinuationToken=continuation_token,
)
else:
response = self.client.list_objects_v2(
Bucket=bucket_name,
Prefix=folder_name,
)
objects += response.get('Contents', [])
if response.get('isTruncated', False):
continuation_token = response['NextContinuationToken']
else:
incomplete = False
if exclude_self:
contents = [obj['Key'] for obj in objects if obj['Key'] != folder_name]
else:
contents = [obj['Key'] for obj in objects]
return contents
def move_object(self, source_bucket_name=None, source_name=None, target_name=None, target_bucket_name=None):
"""
Moving an object on S3 requires two steps:
1) copy to destination
2) delete from source
:param source_bucket_name: (str) name of bucket to copy from
:param source_name: (str) object key to copy from
:param target_name: (str) object key to copy to
:param target_bucket_name: (str) name of bucket to copy to. If None, use the source_bucket_name
:return None:
"""
if target_bucket_name is None:
target_bucket_name = source_bucket_name
response = self.client.copy_object(
Bucket=target_bucket_name,
Key=target_name,
CopySource={
'Bucket': source_bucket_name,
'Key': source_name
}
)
if response.get('CopyObjectResult', False):
# Assume it worked
response = self.client.delete_object(
Bucket=source_bucket_name,
Key=source_name
)
def upload_file(self, source_name, target_name, bucket_name):
"""
Uploads the source to the target in the bucket
:params source_name: (str) name of file to upload
:params target_name: (str) name of object on S3 (include any folder or path)
:params bucket_name: (str) bucket to receive file
:returns: None
"""
self.client.upload_file(
source_name,
bucket_name,
target_name
)
def download_file(self, source_name, target_name, bucket_name):
"""
Downloads the source object from the bucket into the target file. Note that the target_name paths should already exist.
:params source_name: (str) object key to download
:params target_name: (str) destination for download -- all paths to the base file must already exist
:params bucket_name: (str) name of bucket to download from
:returns: None
"""
self.client.download_file(
bucket_name,
source_name,
target_name
)
def generate_presigned_url(self, bucket_name, key, expiration=3600):
return self.client.generate_presigned_url(
ClientMethod="get_object",
Params={
"Bucket": bucket_name,
"Key": key,
},
ExpiresIn=expiration, # seconds
)
|