Skip to content

Commit

Permalink
Add internal links to S3 upload/download args (#3863)
Browse files Browse the repository at this point in the history
  • Loading branch information
@tim-finnigan
tim-finnigan authored Oct 15, 2024
1 parent 7f4ecb0 commit 0bb608c
Showing 1 changed file with 15 additions and 15 deletions.
30 changes: 15 additions & 15 deletions boto3/s3/inject.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ def upload_file(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed upload arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down Expand Up @@ -178,7 +178,7 @@ def download_file(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed download arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down Expand Up @@ -222,7 +222,7 @@ def bucket_upload_file(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed upload arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down Expand Up @@ -266,7 +266,7 @@ def bucket_download_file(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed download arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down Expand Up @@ -307,7 +307,7 @@ def object_upload_file(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed upload arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down Expand Up @@ -348,7 +348,7 @@ def object_download_file(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed download arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down Expand Up @@ -409,7 +409,7 @@ def copy(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed download arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down Expand Up @@ -488,7 +488,7 @@ def bucket_copy(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed download arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down Expand Up @@ -551,7 +551,7 @@ def object_copy(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed download arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down Expand Up @@ -610,7 +610,7 @@ def upload_fileobj(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed upload arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down Expand Up @@ -671,7 +671,7 @@ def bucket_upload_fileobj(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed upload arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down Expand Up @@ -718,7 +718,7 @@ def object_upload_fileobj(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed upload arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_UPLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down Expand Up @@ -769,7 +769,7 @@ def download_fileobj(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed download arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down Expand Up @@ -830,7 +830,7 @@ def bucket_download_fileobj(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed download arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down Expand Up @@ -877,7 +877,7 @@ def object_download_fileobj(
:type ExtraArgs: dict
:param ExtraArgs: Extra arguments that may be passed to the
client operation. For allowed download arguments see
boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS.
:py:attr:`boto3.s3.transfer.S3Transfer.ALLOWED_DOWNLOAD_ARGS`.
:type Callback: function
:param Callback: A method which takes a number of bytes transferred to
Expand Down

0 comments on commit 0bb608c

Please sign in to comment.