Skip to content

Latest commit

 

History

History
965 lines (647 loc) · 27.6 KB

quick-reference-support-for-aws-apis.adoc

File metadata and controls

965 lines (647 loc) · 27.6 KB
permalink sidebar keywords summary
s3/quick-reference-support-for-aws-apis.html
sidebar
Amazon s3, API, request headers, s3 support, request syntax, supported, aws s3
This page summarizes how StorageGRID supports Amazon Simple Storage Service (S3) APIs.

Quick reference: Supported S3 API requests

This page summarizes how StorageGRID supports Amazon Simple Storage Service (S3) APIs.

This page includes only the S3 operations that are supported by StorageGRID.

Note
To see the AWS documentation for each operation, select the link in the heading.

Common URI query parameters and request headers

Unless noted, the following common URI query parameters are supported:

  • versionId (as required for object operations)

Unless noted, the following common request headers are supported:

  • Authorization

  • Connection

  • Content-Length

  • Content-MD5

  • Content-Type

  • Date

  • Expect

  • Host

  • x-amz-date

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus this additional URI query parameter:

  • uploadId

Request body

None

StorageGRID documentation

Operations for multipart uploads

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus this additional URI query parameter:

  • uploadId

Request body XML tags

StorageGRID supports these request body XML tags:

  • CompleteMultipartUpload

  • ETag

  • Part

  • PartNumber

StorageGRID documentation

CompleteMultipartUpload

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional headers:

  • x-amz-copy-source

  • x-amz-copy-source-if-match

  • x-amz-copy-source-if-modified-since

  • x-amz-copy-source-if-none-match

  • x-amz-copy-source-if-unmodified-since

  • x-amz-copy-source-server-side-encryption-customer-algorithm

  • x-amz-copy-source-server-side-encryption-customer-key

  • x-amz-copy-source-server-side-encryption-customer-key-MD5

  • x-amz-metadata-directive

  • x-amz-object-lock-legal-hold

  • x-amz-object-lock-mode

  • x-amz-object-lock-retain-until-date

  • x-amz-server-side-encryption

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

  • x-amz-storage-class

  • x-amz-tagging

  • x-amz-tagging-directive

  • x-amz-meta-<metadata-name>

Request body

None

StorageGRID documentation

CopyObject

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional headers:

  • x-amz-bucket-object-lock-enabled

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional headers:

  • Cache-Control

  • Content-Disposition

  • Content-Encoding

  • Content-Language

  • Expires

  • x-amz-server-side-encryption

  • x-amz-storage-class

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

  • x-amz-tagging

  • x-amz-object-lock-mode

  • x-amz-object-lock-retain-until-date

  • x-amz-object-lock-legal-hold

  • x-amz-meta-<metadata-name>

Request body

None

StorageGRID documentation

CreateMultipartUpload

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus this additional request header:

  • x-amz-bypass-governance-retention

Request body

None

StorageGRID documentation

Operations on objects

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus this additional request header:

  • x-amz-bypass-governance-retention

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

StorageGRID documentation

Operations on objects

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on objects

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional URI query parameters:

  • partNumber

  • response-cache-control

  • response-content-disposition

  • response-content-encoding

  • response-content-language

  • response-content-type

  • response-expires

And these additional request headers:

  • Range

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

  • If-Match

  • If-Modified-Since

  • If-None-Match

  • If-Unmodified-Since

Request body

None

StorageGRID documentation

GetObject

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on objects

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on objects

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional headers:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

  • If-Match

  • If-Modified-Since

  • If-None-Match

  • If-Unmodified-Since

  • Range

Request body

None

StorageGRID documentation

HeadObject

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

None

StorageGRID documentation

Operations on the service > ListBuckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional parameters:

  • delimiter

  • encoding-type

  • key-marker

  • max-uploads

  • prefix

  • upload-id-marker

Request body

None

StorageGRID documentation

ListMultipartUploads

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional parameters:

  • delimiter

  • encoding-type

  • marker

  • max-keys

  • prefix

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional parameters:

  • continuation-token

  • delimiter

  • encoding-type

  • fetch-owner

  • max-keys

  • prefix

  • start-after

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional parameters:

  • delimiter

  • encoding-type

  • key-marker

  • max-keys

  • prefix

  • version-id-marker

Request body

None

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional parameters:

  • max-parts

  • part-number-marker

  • uploadId

Request body

None

StorageGRID documentation

ListMultipartUploads

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body XML tags

StorageGRID supports these request body XML tags:

  • ApplyServerSideEncryptionByDefault

  • Rule

  • ServerSideEncryptionConfiguration

  • SSEAlgorithm

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body XML tags

StorageGRID supports these request body XML tags:

  • And

  • Days

  • Expiration

  • ExpiredObjectDeleteMarker

  • Filter

  • ID

  • Key

  • LifecycleConfiguration

  • NewerNoncurrentVersions

  • NoncurrentDays

  • NoncurrentVersionExpiration

  • Prefix

  • Rule

  • Status

  • Tag

  • Value

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body XML tags

StorageGRID supports these request body XML tags:

  • Event

  • Filter

  • FilterRule

  • Id

  • Name

  • NotificationConfiguration

  • Prefix

  • S3Key

  • Suffix

  • Topic

  • TopicConfiguration

  • Value

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

For details about the supported JSON body fields, see Use bucket and group access policies.

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body XML tags
  • Bucket

  • Destination

  • Prefix

  • ReplicationConfiguration

  • Rule

  • Status

  • StorageClass

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body parameters

StorageGRID supports these request body parameters:

  • VersioningConfiguration

  • Status

StorageGRID documentation

Operations on buckets

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional headers:

  • Cache-Control

  • Content-Disposition

  • Content-Encoding

  • Content-Language

  • x-amz-server-side-encryption

  • x-amz-storage-class

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

  • x-amz-tagging

  • x-amz-object-lock-mode

  • x-amz-object-lock-retain-until-date

  • x-amz-object-lock-legal-hold

  • x-amz-meta-<metadata-name>

Request body
  • Binary data of the object

StorageGRID documentation

PutObject

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus this additional header:

  • x-amz-bypass-governance-retention

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

StorageGRID supports all request body parameters defined by the Amazon S3 REST API at the time of implementation.

StorageGRID documentation

Operations on objects

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

For details about the supported body fields, see RestoreObject.

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request.

Request body

For details about the supported body fields, see the following:

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional URI query parameters:

  • partNumber

  • uploadId

And these additional request headers:

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

Request body
  • Binary data of the part

StorageGRID documentation

UploadPart

URI query parameters and request headers

StorageGRID supports all common parameters and headers for this request, plus these additional URI query parameters:

  • partNumber

  • uploadId

And these additional request headers:

  • x-amz-copy-source

  • x-amz-copy-source-if-match

  • x-amz-copy-source-if-modified-since

  • x-amz-copy-source-if-none-match

  • x-amz-copy-source-if-unmodified-since

  • x-amz-copy-source-range

  • x-amz-server-side-encryption-customer-algorithm

  • x-amz-server-side-encryption-customer-key

  • x-amz-server-side-encryption-customer-key-MD5

  • x-amz-copy-source-server-side-encryption-customer-algorithm

  • x-amz-copy-source-server-side-encryption-customer-key

  • x-amz-copy-source-server-side-encryption-customer-key-MD5

Request body

None

StorageGRID documentation

UploadPartCopy