iter_object_versions#

List object versions related API.

class s3pathlib.core.iter_object_versions.IterObjectVersionsAPIMixin[source]#

A mixin class that implements the iter object versions methods.

list_object_versions(batch_size: int = 1000, limit: int = Sentinel('NOTHING'), delimiter: str = Sentinel('NOTHING'), encoding_type: str = Sentinel('NOTHING'), expected_bucket_owner: str = Sentinel('NOTHING'), bsm: BotoSesManager | None = None) → S3PathIterProxy[source]#

Recursively iterate objects under this prefix, yield S3Path.

Parameters:

  • batch_size – Number of s3 object returned per paginator, valid value is from 1 ~ 1000. large number can reduce IO.

  • limit – Total number of s3 object to return.

  • delimiter – See ListObjectVersions.

  • encoding_type – See ListObjectVersions.

  • expected_bucket_owner – See ListObjectVersions.

  • bsm – See bsm.

New in version 2.0.1.