sync#
Sync file, folder between s3-to-s3, s3-to-local, local-to-s3.
- class s3pathlib.core.sync.SyncAPIMixin[source]#
A mixin class that implements aws s3 sync feature.
- classmethod sync(src: S3Path | str | Path | Path, dst: S3Path | str | Path | Path, bsm: BotoSesManager | None = None, quite: bool = True, include: str | None = None, exclude: str | None = None, acl: str | None = None, only_show_errors: bool = False, no_progress: bool = False, page_size: str | None = None, delete: bool = False, verbose: bool = True)[source]#
Implement the aws s3 sync CLI behavior.
- Parameters:
src –
dst –
bsm –
quite –
include –
exclude –
acl –
only_show_errors –
no_progress –
page_size –
delete –
verbose –
New in version 1.2.1.
TODO: add support for all aws s3 sync supported arguments
- sync_from(src: S3Path | str | Path | Path, bsm: BotoSesManager | None = None, quite: bool = True, include: str | None = None, exclude: str | None = None, acl: str | None = None, only_show_errors: bool = False, no_progress: bool = False, page_size: str | None = None, delete: bool = False, verbose: bool = True)[source]#
Sync data from external place to this S3 location.
- sync_to(dst: S3Path | str | Path | Path, bsm: BotoSesManager | None = None, quite: bool = True, include: str | None = None, exclude: str | None = None, acl: str | None = None, only_show_errors: bool = False, no_progress: bool = False, page_size: str | None = None, delete: bool = False, verbose: bool = True)[source]#
Sync the data at this S3 location to external place.