Debian Codegraph @

docs/source/reference/customizations/s3.rst

raw
1 .. _ref_custom_s3:
2
3 ==========================
4 S3 customization reference
5 ==========================
6
7 S3 transfers
8 ------------
9
10 .. note::
11
12 All classes documented below are considered public and thus will not be
13 exposed to breaking changes. If a class from the ``boto3.s3.transfer``
14 module is not documented below, it is considered internal and users
15 should be very cautious in directly using them because breaking changes may
16 be introduced from version to version of the library. It is recommended to
17 use the variants of the transfer functions injected into the S3 client
18 instead.
19
20 .. seealso::
21 :py:meth:`S3.Client.upload_file`
22 :py:meth:`S3.Client.upload_fileobj`
23 :py:meth:`S3.Client.download_file`
24 :py:meth:`S3.Client.download_fileobj`
25
26
27
28 .. autoclass:: boto3.s3.transfer.TransferConfig
29 :members:
30 :undoc-members:
31
32 .. autoclass:: boto3.s3.transfer.S3Transfer
33 :members:
34 :undoc-members: