Skip to content

Format examples in presigned urls guide #4483

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jonathan343 merged 1 commit into from
Mar 19, 2025
Merged

Format examples in presigned urls guide #4483

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
45 changes: 26 additions & 19 deletions docs/source/guide/s3-presigned-urls.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,10 +43,11 @@ when the URL is generated.
# Generate a presigned URL for the S3 object
s3_client = boto3.client('s3')
try:
response = s3_client.generate_presigned_url('get_object',
Params={'Bucket': bucket_name,
'Key': object_name},
ExpiresIn=expiration)
response = s3_client.generate_presigned_url(
'get_object',
Params={'Bucket': bucket_name, 'Key': object_name},
ExpiresIn=expiration,
)
except ClientError as e:
logging.error(e)
return None
Expand All @@ -63,7 +64,7 @@ perform a GET request.

.. code-block:: python

import requests # To install: pip install requests
import requests # To install: pip install requests

url = create_presigned_url('amzn-s3-demo-bucket', 'OBJECT_NAME')
if url is not None:
Expand Down Expand Up @@ -92,8 +93,9 @@ the appropriate method so this argument is not normally required.
from botocore.exceptions import ClientError


def create_presigned_url_expanded(client_method_name, method_parameters=None,
expiration=3600, http_method=None):
def create_presigned_url_expanded(
client_method_name, method_parameters=None, expiration=3600, http_method=None
):
"""Generate a presigned URL to invoke an S3.Client method

Not all the client methods provided in the AWS Python SDK are supported.
Expand All @@ -108,10 +110,12 @@ the appropriate method so this argument is not normally required.
# Generate a presigned URL for the S3 client method
s3_client = boto3.client('s3')
try:
response = s3_client.generate_presigned_url(ClientMethod=client_method_name,
Params=method_parameters,
ExpiresIn=expiration,
HttpMethod=http_method)
response = s3_client.generate_presigned_url(
ClientMethod=client_method_name,
Params=method_parameters,
ExpiresIn=expiration,
HttpMethod=http_method,
)
except ClientError as e:
logging.error(e)
return None
Expand All @@ -134,8 +138,9 @@ request and requires additional parameters to be sent as part of the request.
from botocore.exceptions import ClientError


def create_presigned_post(bucket_name, object_name,
fields=None, conditions=None, expiration=3600):
def create_presigned_post(
bucket_name, object_name, fields=None, conditions=None, expiration=3600
):
"""Generate a presigned URL S3 POST request to upload a file

:param bucket_name: string
Expand All @@ -152,11 +157,13 @@ request and requires additional parameters to be sent as part of the request.
# Generate a presigned S3 POST URL
s3_client = boto3.client('s3')
try:
response = s3_client.generate_presigned_post(bucket_name,
object_name,
Fields=fields,
Conditions=conditions,
ExpiresIn=expiration)
response = s3_client.generate_presigned_post(
bucket_name,
object_name,
Fields=fields,
Conditions=conditions,
ExpiresIn=expiration,
)
except ClientError as e:
logging.error(e)
return None
Expand All @@ -172,7 +179,7 @@ presigned POST URL to perform a POST request to upload a file to S3.

.. code-block:: python

import requests # To install: pip install requests
import requests # To install: pip install requests

# Generate a presigned S3 POST URL
object_name = 'OBJECT_NAME'
Expand Down
Loading
⚡