Method metadata

pyathena/filesystem/s3.py:1418–1444

Return the metadata of the path. Args: path: S3 path (s3://bucket/key) to get metadata for. **kwargs: Additional parameters passed to the HeadObject API. Returns: S3Metadata, which behaves as a read-only mapping of the user-defined me

(self, path: str, **kwargs)

        )

    def metadata(self, path: str, **kwargs) -> S3Metadata:
        """Return the metadata of the path.

        Args:
            path: S3 path (s3://bucket/key) to get metadata for.
            **kwargs: Additional parameters passed to the HeadObject API.

        Returns:
            S3Metadata, which behaves as a read-only mapping of the
            user-defined metadata (``x-amz-meta-*``) and exposes the
            system-defined metadata (content type, encryption settings,
            etc.) as typed properties.
        """
        bucket, key, version_id = self.parse_path(path)
        if not key:
            raise ValueError("Cannot get metadata of a bucket.")
        request: dict[str, Any] = {"Bucket": bucket, "Key": key}
        if version_id:
            request.update({"VersionId": version_id})

        _logger.debug(f"Head object metadata: s3://{bucket}/{key}?versionId={version_id}")
        response = self._call(
            self._client.head_object,
            **request,
            **kwargs,
        )
        return S3Metadata(response)

    def getxattr(self, path: str, attr_name: str, **kwargs) -> str | None:
        """Get an attribute from the user-defined metadata of the path.