Skip to content

Commit

Permalink
add note on version
Browse files Browse the repository at this point in the history
  • Loading branch information
zzstoatzz committed Nov 26, 2024
1 parent 942b869 commit 5df582e
Showing 1 changed file with 11 additions and 3 deletions.
14 changes: 11 additions & 3 deletions src/integrations/prefect-aws/prefect_aws/s3.py
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ async def adownload_from_bucket(
"""
Downloads an object with a given key from a given S3 bucket.
Added in prefect-aws==0.5.3.
Args:
bucket: Name of bucket to download object from. Required if a default value was
not supplied when creating the task.
Expand Down Expand Up @@ -159,6 +161,8 @@ async def aupload_to_bucket(
"""
Asynchronously uploads data to an S3 bucket.
Added in prefect-aws==0.5.3.
Args:
data: Bytes representation of data to upload to S3.
bucket: Name of bucket to upload data to. Required if a default value was not
Expand Down Expand Up @@ -295,6 +299,8 @@ async def acopy_objects(
object. If the credentials do not have those permissions, try using
`S3Bucket.stream_from`.
Added in prefect-aws==0.5.3.
Args:
source_path: The path to the object to copy. Can be a string or `Path`.
target_path: The path to copy the object to. Can be a string or `Path`.
Expand Down Expand Up @@ -499,6 +505,8 @@ async def amove_objects(
permissions, this method will raise an error. If the credentials have permission to
read the source object but not delete it, the object will be copied but not deleted.
Added in prefect-aws==0.5.3.
Args:
source_path: The path of the object to move
target_path: The path to move the object to
Expand Down Expand Up @@ -626,6 +634,8 @@ async def alist_objects(
"""
Asynchronously lists details of objects in a given S3 bucket.
Added in prefect-aws==0.5.3.
Args:
bucket: Name of bucket to list items from. Required if a default value was not
supplied when creating the task.
Expand Down Expand Up @@ -699,7 +709,6 @@ def list_objects(
) -> List[Dict[str, Any]]:
"""
Lists details of objects in a given S3 bucket.
Added in version 0.5.3.
Args:
bucket: Name of bucket to list items from. Required if a default value was not
Expand Down Expand Up @@ -2076,7 +2085,7 @@ async def aupload_from_folder(
) -> Union[str, None]:
"""
Asynchronously uploads files *within* a folder (excluding the folder itself)
to the object storage service folder.
to the object storage service folder. Added in version prefect-aws==0.5.3.
Args:
from_folder: The path to the folder to upload from.
Expand Down Expand Up @@ -2148,7 +2157,6 @@ def upload_from_folder(
"""
Uploads files *within* a folder (excluding the folder itself)
to the object storage service folder.
Added in version 0.5.3.
Args:
from_folder: The path to the folder to upload from.
Expand Down

0 comments on commit 5df582e

Please sign in to comment.