github.com/treeverse/lakefs@v1.24.1-0.20240520134607-95648127bfb0/docs/reference/s3.md (about)

     1  ---
     2  title: S3 Gateway API
     3  description: "S3 Gateway API. lakeFS supports the following API operations: Identity and authorization, Bucket operations, Object operations and listing"
     4  parent: Reference
     5  ---
     6  # S3-Supported API
     7  
     8  The S3 Gateway emulates a subset of the [API exposed by S3](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html){:target="_blank"}.
     9  This subset includes all API endpoints relevant to data systems.
    10  
    11  For more information, see [architecture][s3-gateway].
    12  
    13  lakeFS supports the following API operations:
    14  
    15  1. Identity and authorization
    16     1. [SIGv2](https://docs.aws.amazon.com/general/latest/gr/signature-version-2.html){:target="_blank"}
    17     1. [SIGv4](https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html){:target="_blank"}
    18  1. Bucket operations:
    19     1. [HEAD bucket](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadBucket.html){:target="_blank"}
    20  1. Object operations:
    21     1. [DeleteObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObject.html){:target="_blank"}
    22     1. [DeleteObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_DeleteObjects.html){:target="_blank"}
    23     1. [GetObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObject.html){:target="_blank"}
    24        1. Support for caching headers, ETag
    25        1. Support for range requests
    26        1. **No** support for [SSE](https://docs.aws.amazon.com/AmazonS3/latest/dev/serv-side-encryption.html){:target="_blank"}
    27        1. **No** support for [SelectObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_SelectObjectContent.html){:target="_blank"} operations
    28     1. [HeadObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_HeadObject.html){:target="_blank"}
    29     1. [PutObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObject.html){:target="_blank"}
    30        1. Support multi-part uploads
    31        1. **No** support for storage classes
    32        1. **No** object level tagging
    33     1. [CopyObject](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CopyObject.html){:target="_blank}
    34  1. Object Listing:
    35     1. [ListObjects](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjects.html){:target="_blank"}
    36     1. [ListObjectsV2](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html){:target="_blank"}
    37     1. [Delimiter support](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListObjectsV2.html#API_ListObjectsV2_RequestSyntax) (for `"/"` only)
    38  1. Multipart Uploads:
    39     1. [AbortMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_AbortMultipartUpload.html){:target="_blank"}
    40     1. [CompleteMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CompleteMultipartUpload.html){:target="_blank"}
    41     1. [CreateMultipartUpload](https://docs.aws.amazon.com/AmazonS3/latest/API/API_CreateMultipartUpload.html){:target="_blank"}
    42     1. [ListParts](https://docs.aws.amazon.com/AmazonS3/latest/API/API_ListParts.html){:target="_blank"} **Currently supported only on AWS S3.** [Link to tracked issue](https://github.com/treeverse/lakeFS/issues/7600){:target="_blank"}
    43     1. [Upload Part](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPart.html){:target="_blank"}
    44     1. [UploadPartCopy](https://docs.aws.amazon.com/AmazonS3/latest/API/API_UploadPartCopy.html){:target="_blank"}
    45   
    46  
    47  [s3-gateway]:  {% link understand/architecture.md %}#s3-gateway