Skip to content

s3.md

Latest commit

 

History

History
225 lines (188 loc) · 7.96 KB

s3.md

File metadata and controls

225 lines (188 loc) · 7.96 KB
Raw

S3

AWS's storage service · portable interface driver.Bucket · AWS index

Operations (35)

Operation Description
AbortMultipartUpload
CompleteMultipartUpload
CopyObject
CreateBucket
CreateMultipartUpload Multipart uploads
DeleteBucket
DeleteBucketPolicy
DeleteBucketTagging
DeleteCORSConfig
DeleteObject
DeleteObjectTagging
EvaluateLifecycle
GeneratePresignedURL Presigned URLs
GetBucketPolicy
GetBucketTagging
GetBucketVersioning
GetCORSConfig
GetEncryptionConfig
GetLifecycleConfig
GetObject
GetObjectTagging
HeadObject
ListBuckets
ListMultipartUploads
ListObjects
ListParts ListParts returns the parts buffered so far for an in-progress upload,
PutBucketPolicy Bucket Policy
PutBucketTagging Bucket Tagging
PutCORSConfig CORS
PutEncryptionConfig Encryption
PutLifecycleConfig Lifecycle policies
PutObject
PutObjectTagging Object Tagging
SetBucketVersioning Versioning
UploadPart

Optional capabilities

Discovered by type assertion; only some providers implement these.

BucketCreator

BucketCreator is an OPTIONAL capability (discovered by type assertion) for a

Operation Description
CreateBucketWithOptions

ConditionalBucket

ConditionalBucket is an OPTIONAL capability (discovered by type assertion like

Operation Description
PutObjectConditional

ObjectCopier

ObjectCopier is an OPTIONAL capability (discovered by type assertion, like

Operation Description
CopyObjectV2

ObjectLockBucket

ObjectLockBucket is an OPTIONAL S3-specific capability (discovered by type

Operation Description
AbortMultipartUpload
CompleteMultipartUpload
CopyObject
CreateBucket
CreateMultipartUpload Multipart uploads
DeleteBucket
DeleteBucketPolicy
DeleteBucketTagging
DeleteCORSConfig
DeleteObject
DeleteObjectTagging
DeleteObjectVersion DeleteObjectVersion removes a specific version when versionID != "".
DeleteObjectVersionWithBypass DeleteObjectVersionWithBypass is DeleteObjectVersion with Object Lock
EnableObjectLock EnableObjectLock marks a bucket Object-Lock-enabled and turns on versioning
EvaluateLifecycle
GeneratePresignedURL Presigned URLs
GetBucketPolicy
GetBucketTagging
GetBucketVersioning
GetCORSConfig
GetEncryptionConfig
GetLifecycleConfig
GetObject
GetObjectLegalHold GetObjectLegalHold reports whether legal hold is ON for a version (current
GetObjectLockConfiguration
GetObjectRetention GetObjectRetention returns the retention on a version (the current version
GetObjectTagging
GetObjectVersion GetObjectVersion / HeadObjectVersion fetch a specific version by ID. A
HeadObject
HeadObjectVersion
ListBuckets
ListMultipartUploads
ListObjectVersions ListObjectVersions returns the full version history matching opts.
ListObjects
ListParts ListParts returns the parts buffered so far for an in-progress upload,
ObjectLockEnabled ObjectLockEnabled reports whether the bucket was created with Object Lock
PutBucketPolicy Bucket Policy
PutBucketTagging Bucket Tagging
PutCORSConfig CORS
PutEncryptionConfig Encryption
PutLifecycleConfig Lifecycle policies
PutObject
PutObjectLegalHold PutObjectLegalHold sets legal hold ON/OFF for a version (current when
PutObjectLockConfiguration PutObjectLockConfiguration enables Object Lock on the bucket (which must
PutObjectRetention PutObjectRetention sets the retention on a version (current when
PutObjectTagging Object Tagging
PutObjectWithLock PutObjectWithLock is PutObjectWithSystemProps that also sets the new
SetBucketVersioning Versioning
SetVersioningStatus SetVersioningStatus sets the bucket's versioning status: "Enabled" or
UploadPart
VersioningStatus

ObjectRestorer

ObjectRestorer is an OPTIONAL S3-specific capability (discovered by type

Operation Description
RestoreObject

ObjectTagValidator

ObjectTagValidator is an OPTIONAL capability (discovered by type assertion)

Operation Description
ValidateObjectTags

RawBucketConfig

RawBucketConfig is an OPTIONAL capability (discovered by type assertion, like

Operation Description
DeleteBucketConfig DeleteBucketConfig removes the stored document (idempotent).
GetBucketConfig GetBucketConfig returns the stored document, or NotFound when none was set.
PutBucketConfig PutBucketConfig stores document body under the sub-resource name (e.g.

RegionalBucket

RegionalBucket is an OPTIONAL capability a storage provider implements to

Operation Description
CreateBucketInRegion

SystemPropsBucket

SystemPropsBucket is an OPTIONAL capability (discovered by type assertion like

Operation Description
PutObjectWithSystemProps

VersionedBucket

VersionedBucket is an optional extension a storage provider implements when

Operation Description
AbortMultipartUpload
CompleteMultipartUpload
CopyObject
CreateBucket
CreateMultipartUpload Multipart uploads
DeleteBucket
DeleteBucketPolicy
DeleteBucketTagging
DeleteCORSConfig
DeleteObject
DeleteObjectTagging
DeleteObjectVersion DeleteObjectVersion removes a specific version when versionID != "".
EvaluateLifecycle
GeneratePresignedURL Presigned URLs
GetBucketPolicy
GetBucketTagging
GetBucketVersioning
GetCORSConfig
GetEncryptionConfig
GetLifecycleConfig
GetObject
GetObjectTagging
GetObjectVersion GetObjectVersion / HeadObjectVersion fetch a specific version by ID. A
HeadObject
HeadObjectVersion
ListBuckets
ListMultipartUploads
ListObjectVersions ListObjectVersions returns the full version history matching opts.
ListObjects
ListParts ListParts returns the parts buffered so far for an in-progress upload,
PutBucketPolicy Bucket Policy
PutBucketTagging Bucket Tagging
PutCORSConfig CORS
PutEncryptionConfig Encryption
PutLifecycleConfig Lifecycle policies
PutObject
PutObjectTagging Object Tagging
SetBucketVersioning Versioning
SetVersioningStatus SetVersioningStatus sets the bucket's versioning status: "Enabled" or
UploadPart
VersioningStatus

Not in scope

  • Azure: on the bare emulator host (such as https://127.0.0.1:4568/), Blob, Queue and Table share one endpoint, and the account-root calls (GET /?comp=list, ?restype=service, ?restype=account) look the same for each service. They go to Blob unless the User-Agent carries an Azure SDK Queue or Table product token (azsdk-go-azqueue, azsdk-python-storage-queue, azsdk-java-azure-storage-queue, azsdk-js-storage-queue, azsdk-net-Storage.Queues, and the matching data-tables clients). Other Queue and Table clients should use the {account}.queue.core.windows.net or {account}.table.core.windows.net host, or the path-style /{account}/ form.
  • Azure: Queue and Table Set Service Properties validate the request and return 202, but do not store logging, metrics or CORS settings. Get Service Stats and Get User Delegation Key are not served.