S3 operations

S3 operations

HS5 implements the following AWS S3 API operations. Requests are authenticated with AWS Signature Version 4 (header-based, presigned URLs and aws-chunked streaming payloads). Presigned URLs using AWS Signature Version 2 are also accepted. Operations not listed here are not supported.

Buckets

OperationRequestNotes
ListBucketsGET /Only buckets the caller is allowed to list are returned.
CreateBucketPUT /{bucket}Supports x-amz-bucket-object-lock-enabled.
DeleteBucketDELETE /{bucket} 
HeadBucketHEAD /{bucket} 
GetBucketLocationGET /{bucket}?location 
GetBucketVersioningGET /{bucket}?versioning 
PutBucketVersioningPUT /{bucket}?versioning 
GetBucketCorsGET /{bucket}?cors 
PutBucketCorsPUT /{bucket}?corsAt most 100 rules. CORS preflight (OPTIONS) requests are answered based on this configuration.
GetObjectLockConfigurationGET /{bucket}?object-lock 
PutObjectLockConfigurationPUT /{bucket}?object-lock 

Listing

OperationRequestNotes
ListObjectsGET /{bucket}Supports prefix, delimiter, marker, max-keys and encoding-type. Delimiter must be a single character.
ListObjectsV2GET /{bucket}?list-type=2Supports prefix, delimiter, continuation-token, start-after, max-keys and encoding-type. Delimiter must be a single character.
ListObjectVersionsGET /{bucket}?versions 
ListMultipartUploadsGET /{bucket}?uploads 

Objects

OperationRequestNotes
PutObjectPUT /{bucket}/{key}Supports user metadata, Content-MD5, conditional writes (If-Match, If-None-Match), object lock headers and additional checksums (CRC32, CRC32C, CRC64NVME, SHA1, SHA256).
GetObjectGET /{bucket}/{key}Supports Range, partNumber, versionId, conditional headers (If-Match, If-None-Match, If-Modified-Since, If-Unmodified-Since), response-* header overrides and x-amz-checksum-mode.
HeadObjectHEAD /{bucket}/{key}Same options as GetObject.
GetObjectAttributesGET /{bucket}/{key}?attributes 
CopyObjectPUT /{bucket}/{key} with x-amz-copy-sourceSupports x-amz-metadata-directive and x-amz-copy-source-if-* conditions. Maximum source size 5 GiB.
DeleteObjectDELETE /{bucket}/{key}Supports versionId and x-amz-bypass-governance-retention.
DeleteObjectsPOST /{bucket}?deleteAt most 1000 keys per request.
PostObjectPOST /{bucket} (HTML form)Browser-based uploads with POST policy.
PutObjectLegalHoldPUT /{bucket}/{key}?legal-hold 
PutObjectRetentionPUT /{bucket}/{key}?retentionSupports x-amz-bypass-governance-retention.

Multipart uploads

OperationRequestNotes
CreateMultipartUploadPOST /{bucket}/{key}?uploadsSupports user metadata, object lock headers and x-amz-checksum-algorithm / x-amz-checksum-type.
UploadPartPUT /{bucket}/{key}?partNumber=N&uploadId=IDSupports Content-MD5 and additional checksums.
UploadPartCopyPUT /{bucket}/{key}?partNumber=N&uploadId=ID with x-amz-copy-sourceSupports x-amz-copy-source-range and x-amz-copy-source-if-* conditions.
CompleteMultipartUploadPOST /{bucket}/{key}?uploadId=ID 
AbortMultipartUploadDELETE /{bucket}/{key}?uploadId=ID 
ListPartsGET /{bucket}/{key}?uploadId=IDSupports max-parts and part-number-marker.