From 343f7962ab6f53d78d69f3f77a31fbb7738b1fd7 Mon Sep 17 00:00:00 2001 From: Tim Finnigan Date: Wed, 20 Sep 2023 10:06:28 -0700 Subject: [PATCH] Add internal links to S3 upload/download args --- boto3/s3/inject.py | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/boto3/s3/inject.py b/boto3/s3/inject.py index c62dc3ce22..cecce71e57 100644 --- a/boto3/s3/inject.py +++ b/boto3/s3/inject.py @@ -129,7 +129,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 @@ -176,7 +176,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 @@ -220,7 +220,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 @@ -264,7 +264,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 @@ -305,7 +305,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 @@ -346,7 +346,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 @@ -407,7 +407,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 @@ -482,7 +482,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 @@ -545,7 +545,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 @@ -604,7 +604,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 @@ -665,7 +665,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 @@ -712,7 +712,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 @@ -763,7 +763,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 @@ -824,7 +824,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 @@ -871,7 +871,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