tagging

Tagging related API.

class s3pathlib.core.tagging.TaggingAPIMixin

A mixin class that implements the tagging related methods.

get_tags(version_id: str = Sentinel('NOTHING'), expected_bucket_owner: str = Sentinel('NOTHING'), request_payer: str = Sentinel('NOTHING'), bsm: BotoSesManager | None = None) → Tuple[str | None, Dict[str, str]]

Get s3 object tags in key value pairs dict.

Returns:

(version_id, tags), tags is in string key value pairs dict.

New in version 1.1.1.

Changed in version 2.0.1: Add version_id, expected_bucket_owner, request_payer parameter.

put_tags(tags: Dict[str, str], version_id: str = Sentinel('NOTHING'), content_md5: str = Sentinel('NOTHING'), checksum_algorithm: str = Sentinel('NOTHING'), expected_bucket_owner: str = Sentinel('NOTHING'), request_payer: str = Sentinel('NOTHING'), bsm: BotoSesManager | None = None) → Tuple[str | None, Dict[str, str]]

Do full replacement of s3 object tags.

Parameters:

tags – the s3 object tags in string key value pairs dict.

Returns:

(version_id, tags), tags is in string key value pairs dict.

New in version 1.1.1.

Changed in version 2.0.1: Add version_id, expected_bucket_owner, request_payer parameter.

update_tags(tags: Dict[str, str], version_id: str = Sentinel('NOTHING'), content_md5: str = Sentinel('NOTHING'), checksum_algorithm: str = Sentinel('NOTHING'), expected_bucket_owner: str = Sentinel('NOTHING'), request_payer: str = Sentinel('NOTHING'), bsm: BotoSesManager | None = None) → Tuple[str | None, Dict[str, str]]

Do partial updates of s3 object tags.

Parameters:

tags – the s3 object tags in string key value pairs dict.

Returns:

(version_id, tags), tags is the latest, merged object tags in string key value pairs dict.

New in version 1.1.1.