head_object#
Improve the head_object API.
- s3pathlib.better_client.head_object.head_object(s3_client: S3Client, bucket: str, key: str, if_match: str = Sentinel('NOTHING'), if_modified_since: datetime = Sentinel('NOTHING'), if_none_match: str = Sentinel('NOTHING'), if_unmodified_since: datetime = Sentinel('NOTHING'), range: str = Sentinel('NOTHING'), version_id: str = Sentinel('NOTHING'), sse_customer_algorithm: str = Sentinel('NOTHING'), sse_customer_key: str = Sentinel('NOTHING'), request_payer: str = Sentinel('NOTHING'), part_number: int = Sentinel('NOTHING'), expected_bucket_owner: str = Sentinel('NOTHING'), checksum_mode: str = Sentinel('NOTHING'), ignore_not_found: bool = False) dict | HeadObjectOutputTypeDef | None [source]#
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
; ifTrue
, returnNone
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 = Sentinel('NOTHING')) bool [source]#
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.