head_object

Improve the head_object API.

s3pathlib.better_client.head_object.head_object(s3_client: S3Client, bucket: str, key: str, if_match: str = OPT, if_modified_since: datetime = OPT, if_none_match: str = OPT, if_unmodified_since: datetime = OPT, range: str = OPT, version_id: str = OPT, sse_customer_algorithm: str = OPT, sse_customer_key: str = OPT, request_payer: str = OPT, part_number: int = OPT, expected_bucket_owner: str = OPT, checksum_mode: str = OPT, ignore_not_found: bool = False) → dict | HeadObjectOutputTypeDef | None

Wrapper of head_object.

Example:

>>> response = head_object(s3_client, "my-bucket", "file.txt")
>>> if response is None:
...     print("Object not found")
... else:
...     print(response["LastModified"])

Parameters:

• s3_client – See head_object

• bucket – See head_object

• key – See head_object

• if_match – See head_object

• if_modified_since – See head_object

• if_none_match – See head_object

• if_unmodified_since – See head_object

• range – See head_object

• version_id – See head_object

• sse_customer_algorithm – See head_object

• sse_customer_key – See head_object

• request_payer – See head_object

• part_number – See head_object

• expected_bucket_owner – See head_object

• checksum_mode – See head_object

• ignore_not_found – Default is False; if True, return None when object is not found instead of raising an error.

Returns:

See head_object

s3pathlib.better_client.head_object.is_object_exists(s3_client: S3Client, bucket: str, key: str, version_id: str = OPT) → bool

Check if an object exists. If you want to use the head_object API response immediately when the object exists, use head_object() instead.

Example:

>>> is_object_exists(s3_client, "my-bucket", "file.txt")
True

Parameters:

• s3_client – See head_object

• bucket – See head_object

• key – See head_object

• version_id – See head_object

Returns:

A Boolean flag to indicate whether the object exists.