Skip to content

Commit

Permalink
Update bucket names in examples (#4325)
Browse files Browse the repository at this point in the history
  • Loading branch information
@alexgromero
alexgromero authored Nov 1, 2024
1 parent 7857f10 commit 9e12dfd
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 25 deletions.
14 changes: 7 additions & 7 deletions boto3/examples/s3.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ the objects in the bucket.
import boto3
s3 = boto3.resource('s3')
bucket = s3.Bucket('my-bucket')
bucket = s3.Bucket('amzn-s3-demo-bucket')
for obj in bucket.objects.all():
print(obj.key)
Expand All @@ -26,7 +26,7 @@ Amazon S3 bucket:
client = boto3.client('s3')
paginator = client.get_paginator('list_objects')
result = paginator.paginate(Bucket='my-bucket', Delimiter='/')
result = paginator.paginate(Bucket='amzn-s3-demo-bucket', Delimiter='/')
for prefix in result.search('CommonPrefixes'):
print(prefix.get('Prefix'))
Expand All @@ -43,7 +43,7 @@ restoration is finished.
import boto3
s3 = boto3.resource('s3')
bucket = s3.Bucket('glacier-bucket')
bucket = s3.Bucket('amzn-s3-demo-bucket')
for obj_sum in bucket.objects.all():
obj = s3.Object(obj_sum.bucket_name, obj_sum.key)
if obj.storage_class == 'GLACIER':
Expand Down Expand Up @@ -80,7 +80,7 @@ object; S3 already knows how to decrypt the object.
import boto3
import os
BUCKET = 'your-bucket-name'
BUCKET = 'amzn-s3-demo-bucket'
s3 = boto3.client('s3')
keyid = '<the key id>'
Expand Down Expand Up @@ -122,7 +122,7 @@ Boto3 will automatically compute this value for us.
import boto3
import os
BUCKET = 'your-bucket-name'
BUCKET = 'amzn-s3-demo-bucket'
KEY = os.urandom(32)
s3 = boto3.client('s3')
Expand Down Expand Up @@ -158,7 +158,7 @@ S3 object.
s3 = boto3.client('s3')
s3.download_file(
"bucket-name", "key-name", "tmp.txt",
"amzn-s3-demo-bucket", "key-name", "tmp.txt",
ExtraArgs={"VersionId": "my-version-id"}
)
Expand All @@ -175,7 +175,7 @@ using JMESPath.
s3 = boto3.client("s3")
s3_paginator = s3.get_paginator('list_objects_v2')
s3_iterator = s3_paginator.paginate(Bucket='your-bucket-name')
s3_iterator = s3_paginator.paginate(Bucket='amzn-s3-demo-bucket')
filtered_iterator = s3_iterator.search(
"Contents[?to_string(LastModified)>='\"2022-01-05 08:05:37+00:00\"'].Key"
Expand Down
36 changes: 18 additions & 18 deletions boto3/s3/inject.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ def upload_file(
import boto3
s3 = boto3.client('s3')
s3.upload_file('/tmp/hello.txt', 'mybucket', 'hello.txt')
s3.upload_file('/tmp/hello.txt', 'amzn-s3-demo-bucket', 'hello.txt')
Similar behavior as S3Transfer's upload_file() method, except that
argument names are capitalized. Detailed examples can be found at
Expand Down Expand Up @@ -160,7 +160,7 @@ def download_file(
import boto3
s3 = boto3.client('s3')
s3.download_file('mybucket', 'hello.txt', '/tmp/hello.txt')
s3.download_file('amzn-s3-demo-bucket', 'hello.txt', '/tmp/hello.txt')
Similar behavior as S3Transfer's download_file() method,
except that parameters are capitalized. Detailed examples can be found at
Expand Down Expand Up @@ -207,7 +207,7 @@ def bucket_upload_file(
import boto3
s3 = boto3.resource('s3')
s3.Bucket('mybucket').upload_file('/tmp/hello.txt', 'hello.txt')
s3.Bucket('amzn-s3-demo-bucket').upload_file('/tmp/hello.txt', 'hello.txt')
Similar behavior as S3Transfer's upload_file() method,
except that parameters are capitalized. Detailed examples can be found at
Expand Down Expand Up @@ -251,7 +251,7 @@ def bucket_download_file(
import boto3
s3 = boto3.resource('s3')
s3.Bucket('mybucket').download_file('hello.txt', '/tmp/hello.txt')
s3.Bucket('amzn-s3-demo-bucket').download_file('hello.txt', '/tmp/hello.txt')
Similar behavior as S3Transfer's download_file() method,
except that parameters are capitalized. Detailed examples can be found at
Expand Down Expand Up @@ -295,7 +295,7 @@ def object_upload_file(
import boto3
s3 = boto3.resource('s3')
s3.Object('mybucket', 'hello.txt').upload_file('/tmp/hello.txt')
s3.Object('amzn-s3-demo-bucket', 'hello.txt').upload_file('/tmp/hello.txt')
Similar behavior as S3Transfer's upload_file() method,
except that parameters are capitalized. Detailed examples can be found at
Expand Down Expand Up @@ -336,7 +336,7 @@ def object_download_file(
import boto3
s3 = boto3.resource('s3')
s3.Object('mybucket', 'hello.txt').download_file('/tmp/hello.txt')
s3.Object('amzn-s3-demo-bucket', 'hello.txt').download_file('/tmp/hello.txt')
Similar behavior as S3Transfer's download_file() method,
except that parameters are capitalized. Detailed examples can be found at
Expand Down Expand Up @@ -388,10 +388,10 @@ def copy(
import boto3
s3 = boto3.resource('s3')
copy_source = {
'Bucket': 'mybucket',
'Bucket': 'amzn-s3-demo-bucket1',
'Key': 'mykey'
}
s3.meta.client.copy(copy_source, 'otherbucket', 'otherkey')
s3.meta.client.copy(copy_source, 'amzn-s3-demo-bucket2', 'otherkey')
:type CopySource: dict
:param CopySource: The name of the source bucket, key name of the
Expand Down Expand Up @@ -469,10 +469,10 @@ def bucket_copy(
import boto3
s3 = boto3.resource('s3')
copy_source = {
'Bucket': 'mybucket',
'Bucket': 'amzn-s3-demo-bucket1',
'Key': 'mykey'
}
bucket = s3.Bucket('otherbucket')
bucket = s3.Bucket('amzn-s3-demo-bucket2')
bucket.copy(copy_source, 'otherkey')
:type CopySource: dict
Expand Down Expand Up @@ -534,10 +534,10 @@ def object_copy(
import boto3
s3 = boto3.resource('s3')
copy_source = {
'Bucket': 'mybucket',
'Bucket': 'amzn-s3-demo-bucket1',
'Key': 'mykey'
}
bucket = s3.Bucket('otherbucket')
bucket = s3.Bucket('amzn-s3-demo-bucket2')
obj = bucket.Object('otherkey')
obj.copy(copy_source)
Expand Down Expand Up @@ -595,7 +595,7 @@ def upload_fileobj(
s3 = boto3.client('s3')
with open('filename', 'rb') as data:
s3.upload_fileobj(data, 'mybucket', 'mykey')
s3.upload_fileobj(data, 'amzn-s3-demo-bucket', 'mykey')
:type Fileobj: a file-like object
:param Fileobj: A file-like object to upload. At a minimum, it must
Expand Down Expand Up @@ -656,7 +656,7 @@ def bucket_upload_fileobj(
import boto3
s3 = boto3.resource('s3')
bucket = s3.Bucket('mybucket')
bucket = s3.Bucket('amzn-s3-demo-bucket')
with open('filename', 'rb') as data:
bucket.upload_fileobj(data, 'mykey')
Expand Down Expand Up @@ -705,7 +705,7 @@ def object_upload_fileobj(
import boto3
s3 = boto3.resource('s3')
bucket = s3.Bucket('mybucket')
bucket = s3.Bucket('amzn-s3-demo-bucket')
obj = bucket.Object('mykey')
with open('filename', 'rb') as data:
Expand Down Expand Up @@ -754,7 +754,7 @@ def download_fileobj(
s3 = boto3.client('s3')
with open('filename', 'wb') as data:
s3.download_fileobj('mybucket', 'mykey', data)
s3.download_fileobj('amzn-s3-demo-bucket', 'mykey', data)
:type Bucket: str
:param Bucket: The name of the bucket to download from.
Expand Down Expand Up @@ -815,7 +815,7 @@ def bucket_download_fileobj(
import boto3
s3 = boto3.resource('s3')
bucket = s3.Bucket('mybucket')
bucket = s3.Bucket('amzn-s3-demo-bucket')
with open('filename', 'wb') as data:
bucket.download_fileobj('mykey', data)
Expand Down Expand Up @@ -864,7 +864,7 @@ def object_download_fileobj(
import boto3
s3 = boto3.resource('s3')
bucket = s3.Bucket('mybucket')
bucket = s3.Bucket('amzn-s3-demo-bucket')
obj = bucket.Object('mykey')
with open('filename', 'wb') as data:
Expand Down

0 comments on commit 9e12dfd

Please sign in to comment.