File: s3.rst

package info (click to toggle)
python-boto3 1.26.27%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 7,880 kB
  • sloc: python: 12,629; makefile: 128
file content (34 lines) | stat: -rw-r--r-- 946 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
.. _ref_custom_s3:

==========================
S3 customization reference
==========================

S3 transfers
------------

.. note::

   All classes documented below are considered public and thus will not be
   exposed to breaking changes. If a class from the ``boto3.s3.transfer``
   module is not documented below, it is considered internal and users
   should be very cautious in directly using them because breaking changes may
   be introduced from version to version of the library. It is recommended to
   use the variants of the transfer functions injected into the S3 client
   instead.

   .. seealso::
      :py:meth:`S3.Client.upload_file`
      :py:meth:`S3.Client.upload_fileobj`
      :py:meth:`S3.Client.download_file`
      :py:meth:`S3.Client.download_fileobj`



.. autoclass:: boto3.s3.transfer.TransferConfig
   :members:
   :undoc-members:

.. autoclass:: boto3.s3.transfer.S3Transfer
   :members:
   :undoc-members: