ActiveScale Management S3 API

1.0 Overview

This guide provides reference information about the ActiveScale S3 API.

Typography

Element	Sample typography
Command line input/output or user input to the graphical user interface	Type `admin`.
Command line input longer than one line is split with the continuation character (\)	`s3cmd \ --dump-config`
User-supplied values	`siteName` or `<siteName>`
File and directory names	accounts.csv
Graphical user interface elements	Click OK.
Graphical user interface menu navigation	Click Configuration > System.
Keyboard keys or sequences	To cancel the operation, press `Ctrl+c`.

Storage notations

Convention	Prefix	Examples	Usage
xB (base 10 notation)	SI prefix: (kilo, mega, giga, tera, peta, exa, zetta, yotta)	1GB = 1 gigabyte = 1,000,000,000 bytes 1TB = 1 terabyte = 1,000,000,000,000 bytes	Disk sizes
xiB (base 2 notation)	Binary prefixes (kibi, mebi, gibi, tebi, pebi, exbi, zebi, yobi)	1GiB = 1 gibibyte = 1,073,741,824 bytes 1TiB = 1 tebibyte = 1,099,511,627,776 bytes	Storage space, and sizes of partitions or file systems

Convention

Prefix

Examples

Usage

xB (base 10 notation)

SI prefix: (kilo, mega, giga, tera, peta, exa, zetta, yotta)

1GB = 1 gigabyte = 1,000,000,000 bytes

1TB = 1 terabyte =
1,000,000,000,000 bytes

Disk sizes

xiB (base 2 notation)

Binary prefixes (kibi, mebi, gibi, tebi, pebi, exbi, zebi, yobi)

1GiB = 1 gibibyte =
1,073,741,824 bytes

1TiB = 1 tebibyte =
1,099,511,627,776 bytes

Storage space, and sizes of partitions or file systems

This document uses a comma (",") for digit grouping; for example, 1,000 is one thousand. This document uses a period (".") as a decimal mark; for example, 12.5%.

Notes and Warnings

Element	Sample notation
Note:	Indicates extra information that has no specific hazardous or damaging consequences.
Tip:	Indicates a faster or more efficient way to do something.
Caution:	Indicates an action that, if taken or avoided, may result in hazardous or damaging consequences.
Warning:	Indicates an action that, if taken or avoided, may result in data loss or unavailability.

2.0 S3 Operations

2.1 About Parameter and Element Tables

The following sections explains how to interpret the values in the columns of parameter and element tables.

2.5 DELETE Bucket Operations

2.5.1 DELETE Bucket

Delete the bucket named in the URI. Before deleting the bucket you must delete all the objects in it.

Permissions

The s3:DeleteBucket permission is needed to delete buckets.

Requests

Syntax

DELETE /HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

None.

Sample request and response

The following tables show a request example and a response example for the DELETEBucketoperation.

The request deletes the images bucket. The response returns a 204NoContent, which means the request was successful, and the images in the bucket no longer exists.

Request

DELETE / HTTP/1.1

Host: images.s3.amazonaws.com

Date: Wed, 01 Mar 2006 12:00:00 GMT

Authorization: authorization string

Response

HTTP/1.1 204 No Content

x-amz-id-2: JuKZqmXuiwFeDQxhD7M8KtsKobSzWA1QEjLbTMTagkKdBX2z7Il/jGhDeJ3j6s80

x-amz-request-id: 32FE2CEB32F5EE25

Date: Wed, 01 Mar 2006 12:00:00 GMT

Connection: close

Server: AmazonS3

Special errors

None.

Related operations

2.9.1 PUT Bucket
2.10.2 DELETE Object

2.5.3 DELETE Bucket Cors

Delete the cors configuration from a bucket. This operation returns a dummy response compatible with Amazon S3.

Permissions

The s3:PutBucketCORS permission is needed to delete CORS config for a bucket.

Requests

Syntax

DELETE /?cors HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string (see Authenticating Requests (AWS Signature Version 4))

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

None.

Sample request and response

This example deletes the cors sub-resource from the specified bucket. This action removes the cors configuration that is stored in the sub-resource.

Request

DELETE /?cors HTTP/1.1

Host: examplebucket.s3.amazonaws.com

Date: Tue, 13 Dec 2011 19:14:42 GMT

Authorization: signatureValue

Response

HTTP/1.1 204 No Content

x-amz-id-2: 0FmFIWsh/PpBuzZ0JFRC55ZGVmQW4SHJ7xVDqKwhEdJmf3q63RtrvH8ZuxW1Bol5

x-amz-request-id: 0CF038E9BCF63097

Date: Tue, 13 Dec 2011 19:14:42 GMT

Server: AmazonS3

Content-Length: 0

Special errors

None.

Related operations

2.6.4 GET Bucket Cors
2.9.5 PUT Bucket Cors
2.13.1 OPTIONS Object

2.5.5 DELETE Bucket Lifecycle

Delete the bucket life cycle settings.

Permissions

The s3:PutLifecycleConfiguration permissions is needed to delete lifecycle configuration for a bucket.

Requests

Syntax

DELETE /?lifecycle HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

None.

Sample request and response

This example deletes the life cycle configuration for the images bucket. The response returns a 204NoContent, which means the request was successful and the life cycle configuration for the images bucket no longer exists.

Request

DELETE /?lifecycle HTTP/1.1

Host: images.s3.amazonaws.com

Content-Length: 0

Date: Mon, 11 Jul 2016 12:08:57 GMT

Authorization: authorization string

Response

HTTP/1.1 204 No Content

x-amz-id-2: ab799629-d4f1-486a-84de-4e6bf12145bfdae08038-4452-4c45-b7f6-c6ff91a961ff x-amz-request-id: 3FC40A223112AD8F

Date: Mon, 11 Jul 2016 12:08:57 GMT

Server: Himalaya

Special errors

None.

Related operations

2.9.7 PUT Bucket Lifecycle
2.6.6 GET Bucket Lifecycle

2.5.7 DELETE Bucket Policy

Delete the bucket policy for an existing bucket.

Permissions

These permissions are needed to delete bucket policies for a bucket :

s3:DeleteBucketPolicy
Must be bucket owner (account) or user under that account.

Requests

Syntax

DELETE /?policy HTTP/1.1

Host: bucket.s3.amazonaws.com

Authorization: authorization string

Parameters

None.

Headers

Table 1: DELETE Bucket policy response headers

Header	Supported	Notes
x-amz-expected-bucket-owner	No	None

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

None.

Sample request and response

This example deletes the bucket policy for the examplebucket bucket. The response returns a 204 No Content, which means the request was successful.

Request

DELETE /?policy HTTP/1.1

Host: examplebucket.s3-eu-west-1.amazonaws.com

Date: 20240302T123525Z

Authorization: authorization string

Response

HTTP/1.1 204 No Content

Date: Sat, 02 Mar 2024 12:35:27 GMT

Server: AmazonS3

x-amz-id-2: H8ukJQMRRXP9GkJfvYcB7cyIFYQan+XXFwyoak+ZPxfH24PSkm2ZrFdef21PT1Oc5P5xkB6O1rk=

x-amz-request-id: 1WFWT9Q5A51ZB7VR

Special errors

Note: When no bucket policy is configured the response returns a 204 No Content.

Related operations

2.6.15 GET Bucket Policy
2.9.11 PUT Bucket Policy

2.5.8 DELETE Bucket Replication

Delete the sub-resource that is associated with the bucket and is replicated in the bucket.

Permissions

The s3:PutReplicationConfiguration permission is needed to delete replication configuration for a bucket.

Requests

Syntax

DELETE /?replication HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

None.

Sample request and response

This example deletes the sub-resource that is associated with and replicated in the images bucket. The response returns a 204 No Content, which means the request was successful and the sub-resource in the images bucket no longer exists.

Request

DELETE /?replication HTTP/1.1

Host: images.amazonaws.com

Content-Length: 0

Date: Mon, 11 Jul 2016 12:08:57 GMT

Authorization: authorization string

Response

HTTP/1.1 204 No Content

x-amz-id-2: Uuag1LuByRx9e6j5OnimrSAMPLEtRPfTaOAa==

x-amz-request-id: 656c76696e672example

Date: Wed, 11 Feb 2015 05:37:16 GMT

Connection: keep-alive

Server: AmazonS3

Special errors

None.

Related operations

2.6.16 GET Bucket Replication
2.9.13 PUT Bucket Replication

2.5.9 DELETE Bucket Tagging

Remove a tag set from the specified bucket. This operation returns a dummy response compatible with Amazon S3.

Permissions

The s3:PutBucketTagging permission is needed to delete tagging configuration for a bucket.

Requests

Syntax

DELETE /?tagging HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string (see Authenticating Requests (AWS Signature Version 4))

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

None.

Sample request and response

This example request deletes the tag set from a specified bucket.

Request

DELETE /?tagging HTTP/1.1

Host: examplebucket.s3.amazonaws.com

Date: Mon, 11 Jul 2016 11:34:37 GMT

Authorization: authorization string

Response

HTTP/1.1 204 No Content x-amz-id-2: 0FmFIWsh/PpBuzZ0JFRC55ZGVmQW4SHJ7xVDqKwhEdJmf3q63RtrvH8ZuxW1Bol5

x-amz-request-id: 0CF038E9BCF63097

Date: Mon, 11 Jul 2016 11:34:37 GMT

Server: AmazonS3

Content-Length: 0

Special errors

None.

Related operations

2.6.18 GET Bucket Tagging
2.9.15 PUT Bucket Tagging

2.5.10 DELETE Bucket Website

Delete the website configuration in a bucket.

Permissions

The s3:DeleteBucketWebsite permission is needed to delete website configuration for a bucket.

Requests

Syntax

DELETE /?website HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

None.

Sample request and response

The following tables show a request example and a response example.

Request

DELETE /?website HTTP/1.1

Host: examplebucket.s3.amazonaws.com

Date: Mon, 11 Jul 2016 11:34:37 GMT

Authorization: authorization string

Response

HTTP/1.1 204 No Content

x-amz-id-2: 0FmFIWsh/PpBuzZ0JFRC55ZGVmQW4SHJ7xVDqKwhEdJmf3q63RtrvH8ZuxW1Bol5 x-amz-request-id: 0CF038E9BCF63097

Date: Mon, 11 Jul 2016 11:34:37

GMT Server: AmazonS3

Content-Length: 0

Special errors

None.

Related operations

2.6.20 GET Bucket Website
2.9.17 PUT Bucket Website

2.6 GET Bucket Operations

2.6.2 GET Bucket ACL

Get the access control list (ACL) of a bucket.

Permissions

The s3:GetBucketAcl (or READ_ACP ACL) permission is needed to get bucket ACL.

Requests

Syntax

GET /?acl HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 2: GET Bucket acl response elements

Element	Supported	Notes
AccessControList	Yes	None
AccesControlPolicy	Yes	None
DisplayName	Yes	None
Grant	Yes	None
Grantee	Yes	None
ID	Yes	None
Owner	Yes	None
Permission	Yes	None

Sample request and response

The following tables show a request example and a response example for the GET Bucket ACL operation.

The request retrieves the access control configuration from the images bucket. The response returns a 200 OK, which means the request was successful. The response also returns the access control configuration.

Request

GET ?acl HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: Wed, 28 Oct 2009 22:32:00 GMT

Authorization: authorization string

Response

HTTP/1.1 200 OK

x-amz-id-2: eftixk72aD6Ap51TnqcoF8eFidJG9Z/2mkiDFu8yU9AS1ed4OpIszj7UDNEHGran x-amz-request-id: 318BC8BC148832E5

Date: Wed, 28 Oct 2009 22:32:00 GMT

Last-Modified: Sun, 1 Jan 2006 12:00:00 GMT

Content-Length: 124Content-Type: text/plain Connection: close Server: Himalaya

<Owner>

<ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>

<DisplayName>CustomersName@amazon.com</DisplayName>

</Owner>

<Grant>

<ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>

<DisplayName>CustomersName@amazon.com</DisplayName>

</Grantee>

<Permission>FULL_CONTROL</Permission>

</Grant>

</AccessControlList>

</AccessControlPolicy>

Special errors

None.

Related operations

2.9.1 PUT Bucket
2.9.3 PUT Bucket ACL

2.6.4 GET Bucket Cors

Get the cross-origin resource sharing (cors) configuration information set for the bucket. This operation returns a dummy response compatible with Amazon S3.

Permissions

The s3:GetBucketCORS permission is needed to get CORS config for a bucket.

Requests

Syntax

GET /?cors HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

Not applicable, because a NoSuchCORSConfiguration error response is returned.

Elements

Not applicable, because a NoSuchCORSConfiguration error response is returned.

Sample request and response

Request

GET /?cors HTTP/1.1

Host: s3test.s3.ActiveScale.com

x-amz-date: 20180126T011603Z

Authorization: authorization string

Response

HTTP/1.1 404 Not Found

x-amz-request-id: D3E4AEDA2CC4B7B1

x-amz-id-2: 37004c82-8320-4d61-a845-9456e2c842035b692ddd-9d7f-4b0b-b412-25c727896984

Content-Type: application/xml

Date: Fri, 26 Jan 2018 01:16:03 GMT

Server: ActiveScale

<Error>

<Code>NoSuchCORSConfiguration</Code>

<Message>The CORS configuration does not exist</Message>

</Error>

Special errors

None.

Related operations

2.5.3 DELETE Bucket Cors
2.9.5 PUT Bucket Cors

2.6.6 GET Bucket Lifecycle

Get the life cycle configuration for a bucket.

Permissions

The s3:GetLifecycleConfiguration permission is needed to get lifecycle configuration for a bucket.

.Requests

Syntax

GET /?lifecycle HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 3: GET Bucket lifecycle response elements

Element	Supported	Notes
And	Yes	None
AbortIncompleteMultipartUp	N/A	None
Date	Yes	None
Days	Yes	None
DayAfterInitiation	N/A	None
Expiration	Yes	None
ExpiredObjectDeleteMarker	Yes	None
ID	Yes	None
LifecycleConfiguration	Yes	None
NonCurrentDays	Yes	None
NewerNoncurrentVersion	No	None
NoncurrentVersionExpiration	Yes	None
NoncurrentVersionTransition	Yes	None
Prefix	Yes	None
Rule	Yes	None
Status	Yes	None
StorageClass	Yes	None
Tag	Yes	None
Transition	Yes	None
Value	Yes	None
And	Yes	None

Sample request and response

This example retrieves the lifecycle configuration from the files bucket. The response returns a 200 OK, which means the request was successful. The response also returns the life cycle configuration.

Request

GET /?lifecycle HTTP/1.1

Host: files.s3.amazonaws.com Content-Length: 0

Date: Mon, 11 Jul 2016 12:19:18 GMT

Authorization: authorization string

Response

HTTP/1.1 200 OK

x-amz-id-2: ab799629-d4f1-486a-84de-4e6bf12145bfdae08038-4452-4c45-b7f6-c6ff91a961ff x-amz-request-id: CAE0056F80DB6B53

Date: Mon, 11 Jul 2016 12:19:18 GMT

Transfer-Encoding: chunked Server: Himalaya

<Rule>

<ID>Expire logs after 100 days</ID>

<Status>Enabled</Status>

</Expiration>

</Rule>

</LifecycleConfiguration>

Special errors

Table 4: GET Bucket lifecycle special errors

Error code	Description	HTTP status code
NoSuchLifecycle Configuration	The life cycle configuration does not exist.	404 Not Found

Related operations

2.9.7 PUT Bucket Lifecycle
2.5.5 DELETE Bucket Lifecycle

2.6.7 GET Bucket Location

Get the region a bucket is in.

Permissions

The s3:GetBucketLocation permission is needed to get bucket location.

Requests

Syntax

GET /?location HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 5: GET Bucket location response elements

Element	Supported	Notes
LocationConstraint	Yes	None

Sample request and response

This example retrieves the bucket location from the files bucket. The response returns a 200 OK, which means the request was successful. The response also returns the location; in this case, EU.

Request

GET /?location HTTP/1.1

Host: myImages.s3.amazonaws.com

Date: Tue, 09 Oct 2007 20:26:04 +0000

Authorization: signatureValue

Response

EU</LocationConstraint>

Special errors

None.

Related operations

2.6.14 GET Bucket Object Versions
2.6.9 GET Bucket (list objects) v1
2.6.10 GET Bucket (list objects) v2
2.9.1 PUT Bucket

2.6.8 GET Bucket Logging

Get the logging status of a bucket. This operation returns a dummy response compatible with Amazon S3.

Permissions

The s3:GetBucketLogging permission is needed to get logging info for a bucket.

Requests

Syntax

GET /?logging HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 6: GET Bucket logging response elements

Element	Supported	Notes
BucketLoggingStatus	Yes	None
EmailAddress	N/A	None
Grant	N/A	None
Grantee	N/A	None
LoggingEnabled	N/A	None
Permission	N/A	None
TargetBucket	N/A	None
TargetGrants	N/A	None
TargetPrefix	N/A	None

Sample request and response

The following tables show a request example and a response example for the GET Bucket logging operation.

The request retrieves the logging status from the mybucket bucket. The response returns a 200 OK, which means the request was successful. The response also returns the logging status.

Request

GET ?logging HTTP/1.1

Host: mybucket.s3.amazonaws.com

Date: Wed, 25 Nov 2009 12:00:00 GMT

Authorization: authorization string

Response

HTTP/1.1 200 OK

Date: Wed, 25 Nov 2009 12:00:00 GMT

Connection: close Server: Himalaya

<TargetBucket>mybucketlogs</TargetBucket>

<TargetPrefix>mybucket-access_log-/</TargetPrefix>

<Grant>

<EmailAddress>user@company.com</EmailAddress>

</Grantee>

</Grant>

</TargetGrants>

</LoggingEnabled>

</BucketLoggingStatus>

Special errors

None.

Related operations

2.9.9 PUT Bucket Logging

2.6.9 GET Bucket (list objects) v1

Get some or all of the objects in a bucket.

Permissions

The s3:ListBucket (or READ ACL) permission is needed to list objects.

Requests

Syntax

GET / HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

Table 7: GET Bucket (list objects) v1 request parameters

Parameter	Supported	Notes
delimiter	Yes	None
encoding-type	Yes	None
marker	Yes	None
max-keys	Yes	None
prefix	Yes	None

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 8: GET Bucket (list objects) v1 response elements

Element	Supported	Notes
Contents	Yes	None
Common Prefixes	Yes	None
Delimiter	Yes	None
DisplayName	Yes	None
Encoding-Type	Yes	None
ETag	Yes	None
ID	Yes	None
IsTruncated	Yes	None
Key	Yes	None
LastModified	Yes	None
MaxKeys	Yes	None
Element	Yes	None
Name	Yes	None
Marker	Yes	None
NextMarker	Yes	None
Owner	Yes	None
Prefix	Yes	None
Size	Yes	None
StorageClass	Yes	None

Sample request and response

This example retrieves the names of the objects that are in the BucketName bucket. The response returns a 200 OK, which means the request was successful. The response also returns a list of the names of the objects.

Request

GET / HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: Wed, 12 Oct 2009 17:50:00 GMT

Authorization: authorization string

Content-Type: text/plain

Response

<?xml version="1.0" encoding="UTF-8"?>

<Name>bucket</Name>

<IsTruncated>false</IsTruncated>

<Key>my-image.jpg</Key>

<StorageClass>STANDARD</StorageClass>

<Owner>

<ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>

<DisplayName>mtd@amazon.com</DisplayName>

</Owner>

</Contents>

<Key>my-third-image.jpg</Key>

<StorageClass>STANDARD_IA</StorageClass></Owner>

</Contents>

</ListBucketResult>

Special errors

Table 9: GET Bucket (list objects) v1 special errors

Error code	Description	HTTP status code
InvalidArgument	An invalid delimiter has been found.	400 Bad Request

Related operations

2.6.10 GET Bucket (list objects) v2
2.6.14 GET Bucket Object Versions
2.16.4 List Multipart Uploads
2.16.5 List Parts

2.6.10 GET Bucket (list objects) v2

Get the number of the objects in a bucket.

Permissions

The s3:ListBucket (or READ ACL) permission is needed to list objects.

Requests

Syntax

GET /?list-type=2 HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

Table 10: GET Bucket (list objects) v2 request parameters

Parameter	Supported	Notes
delimiter	Yes	None
encoding-type	Yes	None
max-keys	Yes	None
prefix	Yes	None
list-type	Yes	None
continuation-token	Yes	None
fetch-after	Yes	None
start-after	Yes	None

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 11: GET Bucket (list objects) v2 response elements

Element	Supported	Notes
Contents	Yes	None
Common Prefixes	Yes	None
Delimiter	Yes	None
DisplayName	Yes	None
Encoding-Type	Yes	None
ETag	Yes	None
ID	Yes	None
IsTruncated	Yes	None
Key	Yes	None
LastModified	Yes	None
MaxKeys	Yes	None
Name	Yes	None
Owner	Yes	None
Prefix	Yes	None
Size	Yes	None
StorageClass	Yes	None
ContinuationToken	Yes	None
KeyCount	Yes	None
NextContinuationToken	Yes	None
StartAfter	Yes	None

Sample request and response

This example retrieves the names of the objects that are in the quotes bucket. The response returns a 200 OK, which means the operation on the quotes bucket was a success. The response also contains a list of the names of the objects.

Request

GET /?list-type=2&max-keys=3&prefix=E&start-after=ExampleGuide.pdf HTTP/1.1

Host: quotes.s3.amazonaws.com

x-amz-date: 20160430T232933Z

Authorization: authorization string

Response

HTTP/1.1 200 OK

x-amz-id-2: gyB+3jRPnrkN98ZajxHXr3u7EFM67bNgSAxexeEHndCX/7GRnfTXxReKUQF28IfP x-amz-request-id: 3B3C7C725673C630

Date: Sat, 30 Apr 2016 23:29:37 GMT

Content-Type: application/xml Content-Length: length Connection: close

Server: Himalaya

<Name>quotes</Name>

<StartAfter>ExampleGuide.pdf</StartAfter>

<IsTruncated>false</IsTruncated>

<Key>ExampleObject.txt</Key>

<StorageClass>REDUCED_REDUNDANCY</StorageClass>

</Contents>

</ListBucketResult>

Special errors

Table 12: GET Bucket (list objects) v2 special errors

Error Code	Description	HTTP Status Code
InvalidArgument	An invalid delimiter has been found.	400 Bad Request

Related operations

2.6.9 GET Bucket (list objects) v1
2.6.14 GET Bucket Object Versions
2.16.4 List Multipart Uploads
2.16.5 List Parts

2.6.12 GET Bucket Notification

The ActiveScale GET Bucket notification operation is used to return the notification configuration for the bucket.

Permissions

The s3:GetBucketNotification permission is needed to get notification configuration for a bucket.

Requests

Syntax

GET /?notification HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

None

Response

HTTP/1.1 200 OK

x-amz-id-2: YgIPIfBiKa2bj0KMgUAdQkf3ShJTOOpXUueF6QKo

x-amz-request-id: 236A8905248E5A02

Date: Wed, 15 May 2019 16:59:04 GMT

Server: AmazonS3

<?xml version="1.0" encoding="UTF-8"?>

{

"TopicConfigurations": [

{

"Id": "nJXWQObDvvs9VtaY81yItqVlN2XTskTFEgINhTJr4mor2Jhg", "TopicArn": "arn:aws:sns:us-east-1:1:testons",

"Events": [

"s3:ObjectCreated:Put",

"s3:ObjectCreated:Copy",

"s3:ObjectCreated:CompleteMultipartUpload",

"s3:ObjectRemoved:Delete",

"s3:ObjectRemoved:DeleteMarkerCreated"

]

}

]

}

Special errors

This implementation of the operation does not return special errors.

Related operations

2.6.9 GET Bucket (list objects) v1
2.6.10 GET Bucket (list objects) v2
2.6.14 GET Bucket Object Versions

2.6.13 GET Bucket Object Lock Configuration

Get the object lock configuration of a bucket. Further information about the GET Bucket object lock configuration operation is found on the following Amazon API Reference page.

https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetBucketInventoryConfiguration.html

Permissions

The s3:GetBucketObjectLockConfiguration permission is needed to get object lock configuration for a bucket.

Requests

Syntax

GET /?object-lock HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 13: GET Bucket Object Lock Configuration response elements

Element	Supported	Notes
ObjectLockConfiguration	Yes	None
ObjectLockEnabled	Yes	None
Rule	Yes	None
DefaultRetention	Yes	None
Mode	Yes	None
Years	Yes	None
Days	Yes	None

Sample request and response

The following tables show a request example and a response example for this operation.

The request retrieves the Object Lock Configuration of a bucket. The response returns an HTTP 200, which means the request was successful. The response also returns the object lock configuration.

Request

GET /?object-lock HTTP/1.1

Host: locked-bucket.s3.amazonaws.com

Content-Length: 0

Date: 20201029T103439Z

x-amz-content-sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855\r

Authorization: AWS4-HMAC-SHA256 Credential=AK0B7YPKCQAAJIXNPPU7/20201029/us-east-1/s3/aws4_request,SignedHeaders=content-length;date;host;x-amz-content-sha256,Signature=ba0344d0aa8eb6b7a57d368d2bd514cb49c5a06525e6bb9b4f2aaf427ab8bdf7

Response

HTTP/1.1 200 OK

x-amz-id-2: 9933c1f7-b288-434e-9bcb-de3fee9872b2c5260c0a-714c-4fc9-a94f-

b0ba092e8367

x-amz-request-id: E0A1C59B087CE4C6

Date: Thu, 29 Oct 2020 10:34:39 GMT

Transfer-Encoding: chunked

Server: Quantum-ActiveScale

<?xml version="1.0" encoding="UTF-8"?>

<ObjectLockEnabled>Enabled</ObjectLockEnabled>

<Rule>

<Mode>COMPLIANCE</Mode>

</DefaultRetention>

</Rule>

</ObjectLockConfiguration>

Special errors

None.

Related operations

2.9.1 PUT Bucket
2.9.8 PUT Bucket Object Lock Configuration

2.6.14 GET Bucket Object Versions

Get a metadata list about all of the versions of objects in a bucket.

Permissions

The s3:ListBucketVersions (or READ ACL) permission is needed to list object versions.

Requests

Syntax

GET /?versions HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

Table 14: GET Bucket Object versions request parameters

Parameter	Supported	Notes
delimiter	Yes	None
encoding-type	Yes	None
key-marker	Yes	None
max-keys	Yes	None
prefix	Yes	None
version-id-marker	Yes	None

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 15: GET Object versions response elements

Element	Supported	Notes
CommonPrefixes	Yes	None
Delimiter	Yes	None
DeleteMarker	Yes	None
DisplayName	Yes	None
Encoding-Type	Yes	None
ETag	Yes	None
ID	Yes	None
IsLatest	Yes	None
IsTruncated	Yes	None
Key	Yes	None
KeyMarker	Yes	None
LastModified	Yes	None
ListVersionsResult	Yes	None
MaxKeys	Yes	None
Name	Yes	None
NextKeyMarker	Yes	None
NextVersionIdMarker	Yes	None
Owner	Yes	None
Prefix	Yes	None
Size	Yes	None
StorageClass	Yes	None

Sample request and response

This example compiles a list of metadata about all of the versions of objects in the BucketName bucket. The response returns the list.

Request

GET /?versions HTTP/1.1

Host: BucketName.s3.amazonaws.com

Date: Wed, 28 Oct 2009 22:32:00 +0000

Authorization: authorization string

Response

<?xml version="1.0"?>

<Name>bucket</Name>

<IsTruncated>false</IsTruncated>

<Key>my-image.jpg</Key>

<VersionId>3/L4kqtJl40Nr8X8gdRQBpUMLUo</VersionId>

<StorageClass>STANDARD</StorageClass>

<Owner>

<ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>

<DisplayName>mtd@amazon.com</DisplayName>

</Owner>

</Version>

<Key>my-second-image.jpg</Key>

<VersionId>03jpff543dhffds434rfdsFDN943fdsFkdmqnh892</VersionId>

<IsLatest>true

</IsLatest>

<Owner>

<ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>

<DisplayName>mtd@amazon.com</DisplayName>

</Owner>

</DeleteMarker>

<Key>my-second-image.jpg</Key>

<VersionId>QUpfdndhfd8438MNFDN93jdnJFkdmqnh893</VersionId>

<IsLatest>false</IsLatest>

<StorageClass>STANDARD</StorageClass>

<Owner>

<ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>

<DisplayName>mtd@amazon.com</DisplayName>

</Owner>

</Version>

<Key>my-third-image.jpg</Key>

<VersionId>03jpff543dhffds434rfdsFDN943fdsFkdmqnh892</VersionId>

<Owner>

<ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>

<DisplayName>mtd@amazon.com</DisplayName>

</Owner>

</DeleteMarker>

<Key>my-third-image.jpg</Key>

<VersionId>UIORUnfndfhnw89493jJFJ</VersionId>

<IsLatest>false</IsLatest>

<StorageClass>STANDARD</StorageClass>

<Owner>

<ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>

<DisplayName>mtd@amazon.com</DisplayName>

</Owner>

</Version>

</ListVersionsResult>

Special errors

Table 16: GET Bucket Object versions special errors

Error code	Description	HTTP status code
InvalidArgument	An invalid delimiter was found.	404 Not Found

Related operations

2.11.1 GET Object
2.15.1 PUT Object

2.6.15 GET Bucket Policy

Get the bucket policy for an existing bucket and show other identities allowed permissions.

Permissions

These permissions are needed to get bucket policies for a bucket :

s3:GetBucketPolicy
Must be bucket owner (account) or user under that account.

Requests

Syntax

GET /?policy HTTP/1.1

Host: bucket.s3.amazonaws.com

Authorization: authorization string

Parameters

None.

Headers

Table 17: GET Bucket policy request headers

Header	Supported	Notes
x-amz-expected-bucket-owner	No	None

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 18: GET Bucket policy response elements

Header	Supported	Notes
Version	Yes	Only version “2012-10-17” is supported by ActiveScale IAM. For more information on IAM version refer to the AWS documentation.
Id	Yes	(optional) Policy Identifier
Statement	Yes	Multiple statements ([ {..}, {..} ]) or a single statement ({..}).
Statement.Effect	Yes	Allow or Deny the actions in the statement.
Statement.Principal	Yes	Supported principal types: : all principals (including anonymous) AWS: account root user by arn (no wildcards), IAM user by arn (no wildcards), account identifier, CanonicalUser: account root user by account canonical id
Statement.NotPrincipal	Yes	Refer to Statement.Principal
Statement.Sid	Yes	Policy Statement Identifier
Statement.Action	Yes	* An action in Supported Actions (may include wildcards)
Statement.NotAction	Yes	Refer to Action
Statement.Resource	Yes	Supported resource types : S3 bucket ARN: needs to be for the bucket to which the bucket policy is applied - ie. "arn:aws:s3:::{{bucket_name}}" S3 object ARN: needs to be scoped to the bucket to which the bucket policy is applied - ie. "arn:aws:s3:::{{bucket_name}}/{{object_path}}" (the object path can contain wildcards) Note: Policy Variables are supported from ActiveScale 7.1 and above.
Statement.NotResource	Yes	Refer to Resource
Statement.Condition	Yes	Supported from ActiveScale 7.1 and above.

Sample request and response

This example gets the permissions for the examplebucket bucket and shows that the account with identifier 391107088064 can perform put and get object operations. The response returns a 200 OK, which means the request was successful.

Request

GET /?policy HTTP/1.1

Host: examplebucket.s3-eu-west-1.amazonaws.com

Date: 20240302T123525Z

Authorization: authorization string

Response

HTTP/1.1 200 OK

Content-Type: application/json

Date: Sat, 02 Mar 2024 12:35:27 GMT

Server: AmazonS3

x-amz-id-2: rEv+tE9zORXMHysTPJeUeqF/oUnLAvXdks58wcVulrd5lXdVXAfEm5qQvxrx/UnEiVF1yelROeU=

x-amz-request-id: 6V3C914H7DGK8E7Z

{

"Version": "2012-10-17",

"Statement": {

"Effect":"Allow",

"Principal": {

"AWS":"391107088064"

"Action":["s3:PutObject","s3:GetObject"],

"Resource":"arn:aws:s3:::examplebucket/*"

}

Special errors

Table 19: GET Bucket policy special errors

Error code	Description	HTTP Status code
NoSuchBucketPolicy	The bucket policy cannot be found.	404 Not Found

Related operations

2.9.11 PUT Bucket Policy
2.5.7 DELETE Bucket Policy

2.6.16 GET Bucket Replication

Get the replication configuration of a bucket.

Permissions

The s3:GetReplicationConfiguration permission is needed to get replication configuration for a bucket.

Requests

Syntax

GET /?replication HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 20: GET Bucket replication response elements

Name	Supported	Notes
ReplicationConfiguration	N/A	None
Role	N/A	None
Rule	N/A	None
ID	N/A	None
Status	N/A	None
Prefix	N/A	None
Destination	N/A	None
Bucket	N/A	None
StorageClass	N/A	None

Sample request and response

The following tables show a request example and a response example for the GET Bucket replication operation.

The request retrieves the replication configuration from the examplebucket bucket. The response returns a 200 OK, which means the request was successful. The response also lists the replication configuration details.

Request

GET /?replication HTTP/1.1

Host: examplebucket.s3.amazonaws.com

x-amz-date: Tue, 10 Feb 2015 00:17:21 GMT

Authorization: signatureValue

Response

HTTP/1.1 200 OK

x-amz-id-2: ITnGT1y4RyTmXa3rPi4hklTXouTf0hccUjo0iCPjz6FnfIutBj3M7fPGlWO2SEWp x-amz-request-id: 51991C342example

Date: Tue, 10 Feb 2015 00:17:23 GMT

Server: AmazonS3

Content-Length: contentlength

<?xml version="1.0" encoding="UTF-8"?>

<Rule>

<Status>Enabled</Status>

<Bucket>arn:aws:s3:::exampletargetbucket</Bucket>

<StorageClass>STANDARD_IA</StorageClass>

</Destination>

</Rule>

<Role>arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3</Role>

</ReplicationConfiguration>

Special errors

Table 21: GET Bucket replication special errors

Error code	Description	HTTP Status code
NoSuchReplication	The replicated subsource was not located.	404 Not Found

Related operations

2.9.13 PUT Bucket Replication
2.5.8 DELETE Bucket Replication

2.6.17 GET Bucket requestPayment

Get the request payment configuration of a bucket.

Permissions

The s3:GetBucketRequestPayment permission is needed to get request payment info for a bucket.

Requests

Syntax

GET ?requestPayment HTTP/1.1

Host: BucketName.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 22: GET Bucket requestPayment response elements

Name	Supported	Notes
Payer	Yes	None
RequestPaymentConfiguration	Yes	None

Sample request and response

The following tables show a request example and a response example for the GET Bucket requestPayment operation.

The request retrieves the request payment configuration from the colorpictures bucket. The response returns a 200 OK, which means the request was successful. The response also lists the request payment configuration details.

Request

GET ?requestPayment HTTP/1.1

Host: colorpictures.s3.amazonaws.com

Date: Wed, 01 Mar 2009 12:00:00 GMT

Authorization: authorization string

Response

HTTP/1.1 200 OK

x-amz-id-2: YgIPIfBiKa2bj0KMg95r/0zo3emzU4dzsD4rcKCHQUAdQkf3ShJTOOpXUueF6QKo x-amz-request-id: 236A8905248E5A01

Date: Wed, 01 Mar 2009 12:00:00 GMT

Content-Type: [type] Content-Length: 0 Connection: close Server: Himalaya

<?xml version="1.0" encoding="UTF-8"?>

<Payer>Requester</Payer>

</RequestPaymentConfiguration>

Special errors

None.

Related operations

2.9.14 PUT Bucket requestPayment

2.6.18 GET Bucket Tagging

Get the tag set associated with a bucket.

Permissions

The s3:GetBucketTagging permission is needed to get tagging configuration for a bucket.

Requests

Syntax

GET /?tagging HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

Not applicable, because a NoSuchTagSet error response is returned.

Elements

Not applicable, because a NoSuchTagSet error response is returned.

Sample request and response

Request

GET /?tagging HTTP/1.1

Host: s3test.s3.ActiveScale.com

x-amz-date: 20180126T012243Z

Authorization: authorization string

Response

HTTP/1.1 404 Not Found

x-amz-request-id: 6680995ADA9A3BE2

x-amz-id-2: 37004c82-8320-4d61-a845-9456e2c842035b692ddd-9d7f-4b0b-b412-25c727896984

Content-Type: application/xml

Date: Fri, 26 Jan 2018 01:22:43 GMT

Server: ActiveScale

<?xml version="1.0" encoding="UTF-8"?>

<Error>

<Code>NoSuchTagSet</Code>

<Message>The TagSet does not exist</Message>

</Error>

Special errors

None.

Related operations

2.5.9 DELETE Bucket Tagging
2.9.15 PUT Bucket Tagging

2.6.19 GET Bucket Versioning

Get the versioning state of a bucket.

Permissions

The s3:GetBucketVersioning permission is needed to get versioning configuration for a bucket.

Requests

Syntax

GET /?versioning HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 23: GET Bucket versioning response elements

Element	Supported	Notes
MfaDelete	N/A	MFA is not supported.
Status	Yes	None
VersioningConfiguration	Yes	None

Sample request and response

This example retrieves the versioning configuration from the myBucket bucket. The response returns the versioning status of the myBucket bucket.

Request

GET /?versioning HTTP/1.1

Host: myBucket.s3.amazonaws.com

Date: Wed, 12 Oct 2009 17:50:00 GMT

Authorization: authorization string

Content-Type: text/plain

Response

<Status>Enabled</Status>

</VersioningConfiguration>

Special errors

None.

Related operations

2.9.16 PUT Bucket Versioning

2.6.20 GET Bucket Website

Get the website configuration associated with a bucket.

Permissions

The s3:GetBucketWebsite permission is needed to get website configuration for a bucket.

Requests

Syntax

GET /?website HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string (see Authenticating Requests (AWS Signature Version 4))

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

The response elements include the same elements that were uploaded when you configured the bucket as a website.

Sample request and response

Request

GET /?website HTTP/1.1

Host: s3test.s3.ActiveScale.com

x-amz-date: 20180126T012403Z

Authorization: authorization string

Response

HTTP/1.1 404 Not Found

x-amz-request-id: 1A7D2CD465B2E64A

x-amz-id-2: 37004c82-8320-4d61-a845-9456e2c842035b692ddd-9d7f-4b0b-b412-25c727896984

Content-Type: application/xml

Date: Fri, 26 Jan 2018 01:24:03 GMT

Server: ActiveScale

<?xml version="1.0" encoding="UTF-8"?>

<Error>

<Code>NoSuchWebsiteConfiguration</Code>

<Message>The specified bucket does not have a website configuration</Message>

</Error>

Special errors

None.

Related operations

2.5.10 DELETE Bucket Website
2.9.17 PUT Bucket Website

2.7 HEAD Bucket Operations

2.7.1 HEAD Bucket

Determine if a bucket exists and that you have permission to access it.

Permissions

The s3:ListBucket permission is needed to head buckets.

Requests

Syntax

HEAD / HTTP/1.1

Host: BucketName.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

None.

Elements

None.

Sample request and response

This example pings the myawsbucket bucket to determine if it exists. The response returns a 200 OK, which means the operation on the myawsbucket bucket was a success and that the bucket exists.

Request

HEAD / HTTP/1.1

Date: Fri, 10 Feb 2012 21:34:55 GMT

Authorization: authorization string

Host: myawsbucket.s3.amazonaws.com

Connection: Keep-Alive

Response

HTTP/1.1 200 OK

x-amz-id-2: JuKZqmXuiwFeDQxhD7M8KtsKobSzWA1QEjLbTMTagkKdBX2z7Il/jGhDeJ3j6s80 x-amz-request-id: 32FE2CEB32F5EE25

Date: Fri, 10 2012 21:34:56 GMT

Server: AmazonS3

Special errors

The operation returns a 200 OK if the bucket exists and you have permission to access it. Otherwise, the operation might return responses such as 404 Not Found or 403 Forbidden.

Related operations

2.6.19 GET Bucket Versioning

2.9 PUT Bucket Operations

2.9.1 PUT Bucket

Create a new bucket.

Permissions

These permissions are needed to create buckets:

s3:CreateBucket
s3:PutBucketAcl (or WRITE_ACP ACL) for x-amz-acl and x-amz-grant-* headers
s3:PutBucketObjectLockConfiguration and s3:PutBucketVersioning for enabling object lock via the x-amz-bucket-object-lock-enabled header.
Must be an authenticated identity (not anonymous).

Requests

Syntax

PUT / HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

<?xml version="1.0" encoding="UTF-8"?>

...

</CreateBucketConfiguration>

Note: The xml portion of the preceding operation is not required.

Parameters

None.

Headers

Table 24: PUT Bucket request headers

Header	Supported	Notes
x-amz-acl	Yes	None
x-amz-bucket-object-lock-enabled	Yes	None
x-amz-grant-read	Yes	`EmailAddress`, `ID`, and `URI` are fully supported. http://acs.amazonaws.com/groups/s3/LogDelivery is not supported.
x-amz-grant-write	Yes	`EmailAddress`, `ID`, and `URI` are fully supported. http://acs.amazonaws.com/groups/s3/LogDelivery is not supported.
x-amz-grant-read-acp	Yes	.`EmailAddress`, `ID`, and `URI` are fully supported. http://acs.amazonaws.com/groups/s3/LogDelivery is not supported.
x-amz-grant-write-acp	Yes	`EmailAddress`, `ID`, and `URI` are fully supported. http://acs.amazonaws.com/groups/s3/LogDelivery is not supported.
x-amz-grant-full-control	Yes	`EmailAddress`, `ID`, and `URI` are fully supported. http://acs.amazonaws.com/groups/s3/LogDelivery is not supported.

Elements

Table 25: PUT Bucket request elements

Element	Supported	Notes
CreateBucketConfiguration	Yes	None
LocationConstraint	Yes	The `LocationConstraint` element is ignored.

Responses

Headers

None.

Elements

None.

Sample request and response

This example creates the colorpictures bucket. The response returns a 200 OK, which means the request was successful. The response also lists the location of the bucket.

Request

PUT / HTTP/1.1

Host: colorpictures.s3.amazonaws.com Content-Length: 0

Date: Wed, 01 Mar 2006 12:00:00 GMT

Authorization: authorization string

Response

HTTP/1.1 200 OK

x-amz-id-2: YgIPIfBiKa2bj0KMg95r/0zo3emzU4dzsD4rcKCHQUAdQkf3ShJTOOpXUueF6QKo x-amz-request-id: 236A8905248E5A01

Date: Wed, 01 Mar 2006 12:00:00 GMT

Location: /colorpictures

Content-Length: 0

Connection: close

Server: AmazonS3

Special errors

For buckets in region us-east-1, Amazon S3 allows the use of PUT Bucket to change the ACL of an existing bucket owned by you. For buckets in different regions, Amazon S3 responds with HTTP 409 Conflict and the S3 error code BucketAlreadyOwnedByYou. Only the latter response is supported.

Related operations

2.15.1 PUT Object
2.5.1 DELETE Bucket

2.9.3 PUT Bucket ACL

Set the permissions for an existing bucket using the ACL.

Permissions

The s3:PutBucketAcl (or WRITE_ACP ACL) permission is needed to put bucket ACL.

Requests

Syntax

PUT /?acl HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

<Owner>

<DisplayName>EmailAddress</DisplayName>

</Owner>

<Grant>

<DisplayName>EmailAddress</DisplayName>

</Grantee>

<Permission>Permission</Permission>

</Grant>

</AccessControlList>

</AccessControlPolicy>

Parameters

None.

Headers

Table 26: PUT Bucket acl request headers

Header	Supported	Notes
x-amz-acl	Yes	None
x-amz-grant-read	Yes	`EmailAddress`, `ID`, and `URI` are fully supported. http://acs.amazonaws.com/groups/s3/LogDelivery is not supported.
x-amz-grant-write	Yes	`EmailAddress`, `ID`, and `URI` are fully supported. http://acs.amazonaws.com/groups/s3/LogDelivery is not supported.
x-amz-grant-read-acp	Yes	`EmailAddress`, `ID`, and `URI` are fully supported. http://acs.amazonaws.com/groups/s3/LogDelivery is not supported.
x-amz-grant-write-acp	Yes	`EmailAddress`, `ID`, and `URI` are fully supported. http://acs.amazonaws.com/groups/s3/LogDelivery is not supported.
x-amz-grant-full-control	Yes	`EmailAddress`, `ID`, and `URI` are fully supported. http://acs.amazonaws.com/groups/s3/LogDelivery is not supported.

Elements

Table 27: PUT Bucket acl request elements

Element	Supported	Notes
AccessControlList	Yes	None
AccessControlPolicy	Yes	None
DisplayName	Yes	None
Grant	Yes	None
Grantee	Yes	`URI` at http://acs.amazonaws.com/groups/s3/ LogDelivery is not supported.
ID	Yes	None
Owner	Yes	None
Permission	Yes	None

Responses

Headers

None.

Elements

None.

Sample request and response

This example sets the permissions for the examplebucket bucket. The response returns a 200 OK, which means the request was successful.

Request

PUT ?acl HTTP/1.1

Host: examplebucket.s3.amazonaws.com

x-amz-date: Sun, 29 Apr 2012 22:00:57 GMT

x-amz-grant-write: uri="http://acs.amazonaws.com/groups/s3/LogDelivery", emailAddress="xyz@amazon.com"

x-amz-grant-read: uri="http://acs.amazonaws.com/groups/global/AllUsers" Accept: */*

Authorization: authorization string

Response

HTTP/1.1 200 OK

x-amz-id-2: 0w9iImt23VF9s6QofOTDzelF7mrryz7d04Mw23FQCi4O205Zw28Zn+d340/RytoQ x-amz-request-id: A6A8F01A38EC7138

Date: Sun, 29 Apr 2012 22:01:10 GMT

Content-Length: 0

Server: AmazonS3

Special errors

None.

Related operations

2.9.1 PUT Bucket
2.5.1 DELETE Bucket

2.9.7 PUT Bucket Lifecycle

Create a new life cycle configuration on the bucket or replaces an existing life cycle configuration.

Permissions

The s3:PutLifecycleConfiguration permission is needed to put lifecycle configuration for a bucket.

Requests

Syntax

PUT /?lifecycle HTTP/1.1

Host: bucket name.s3.amazonaws.com

Content-Length: length

Date: date

Authorization: authorization string

Content-MD5: MD5Lifecycle configuration in the request body

Parameters

None.

Headers

Table 28: PUT Bucket lifecycle request headers

Header	Supported	Notes
Content-MD5	Yes	This header is required.

Elements

Table 29: PUT Bucket lifecycle request elements

Element	Supported	Notes
AbortIncompleteMultipartUpload	No	None
And	No	None
Date	Yes	None
Days	Yes	None
DaysAfterInitiation	No	None
Expiration	Yes	This element requires a `Days` value and on a `Dates` value with an `ExpiredObjectDeleteMarker` element specified.
ExpiredObjectDeleteMarker	Yes	None
Filter	No	None
ID	Yes	None
Key	No	None
LifecycleConfiguration	Yes	None
NewerNoncurrentVersions	No	None
NoncurrentDays	Yes	None
NoncurrentVersionExpiration	Yes	This element requires a `NoncurrentDays` value.
NoncurrentVersionTransition	Yes	This element requires `NoncurrentDays` and `StorageClass` value.
Prefix	Yes	None
Rule	Yes	None
Status	Yes	None
StorageClass	Yes	`GLACIER` and `DEEP_ARCHIVE` storage classes are only supported in ASCS
Tag	No	None
Transition	Yes	This element requires either a `Days` or `Date` value and `StorageClass` value
Value	No	None

Responses

Headers

None.

Elements

None.

Limitations

The maximum permissible year value is 9999, which implies maximum allowed Date value is: 9999-12-31T00:00:00.000.
Addition of time zones after the date is not supported. A date format like
2016-08-18T04:00:00.000+04 is invalid.

Example of Expiration of objects

This sample request creates a life cycle configuration with a rule defined for log expiry. It expires all the objects that have a prefix “logs/” after 100 days:

Request

PUT /?lifecycle HTTP/1.1

Host: examplebucket.s3.amazonaws.com

Content-Length: 295

Content-MD5: VASqcc61rAZBrn+m2F0z1A==

Date: Mon, 11 Jul 2016 11:34:37 GMT

Authorization: <authorization string>

<?xml version="1.0"?>

<Rule>

<ID>Expire logs after 100 days</ID>

<Status>Enabled</Status>

</Expiration>

</Rule>

</LifecycleConfiguration>

Response

HTTP/1.1 200 OK

x-amz-id-2: ab799629-d4f1-486a-84de-4e6bf12145bfdae08038-4452-4c45-b7f6-c6ff91a961ff

x-amz-request-id: 04D5996F47C53ECB

Date: Mon, 11 Jul 2016 11:34:37 GMT

Content-Length: 0

Server: Himalaya

Example of Non-Current Version Expiration

When versioning is enabled, objects that are overwritten are not deleted. Instead, the old version is kept on the system and the new version becomes the current visible version.

To clean up old versions, set a Lifecycle Policy for expiration of non-current versions on the bucket. In the following example, the policy sets an expiration of 5 days for non-current versions. This means that any 'old' versions will be retained for 5 days and automatically deleted after 5 days have passed. The 'current' (i.e. the newest) version remains untouched.

Request

PUT /?lifecycle HTTP/1.1

Host: <bucket-name>.<host-name>

<?xml version="1.0" encoding="UTF-8"?>

<Rule>

<Status>Enabled</Status>

</NoncurrentVersionExpiration>

</Expiration>

<ID>5days-noncurrent-object-expiration</ID>

</Rule>

</LifecycleConfiguration>

Response

HTTP/1.1 200 OK

x-amz-id-2: 7d76fa62-59a7-4060-8fa3-a7ba3bf2b523b9225ccc-e647-4e7f-983a-bf7ea03465f9

Date: Tue, 28 Jul 2020 15:13:57 GMT

Transfer-Encoding: chunked

x-amz-request-id: 68DD2DEBE106C9C2

Server: Quantum-ActiveScale

Example of Transition of Objects

This sample request creates a life cycle configuration with a rule defined for transitioning objects to Cold Storage. The rule will ensure that all object that have a prefix “cold_storage/” will have their storage class changed to DEEP_ARCHIVE after 150 days.

Request

PUT /?lifecycle HTTP/1.1

Host: <bucket-name>.<host-name>

<?xml version="1.0" encoding="UTF-8"?>

<Rule>

<Status>Enabled</Status>

<Prefix>cold_storage/</Prefix>

<StorageClass>DEEP_ARCHIVE</StorageClass>

</Transition>

<ID>150days-deep-archive-transition</ID>

</Rule>

</LifecycleConfiguration>

Response

HTTP/1.1 200 OK

Content-Length: 0

Date: Wed, 02 Mar 2022 23:19:11 GMT

Server: Quantum-ActiveScale

x-amz-id-2: 81be954e-cf8a-450d-91cc-b0579a5e4f72f9fe6f8b-1648-47c7-81e8-8f8e24a31803

x-amz-request-id: 1383DC93CE0B735C

Special errors

None.

Related operations

2.6.6 GET Bucket Lifecycle
2.14.2 POST Object Restore

2.9.8 PUT Bucket Object Lock Configuration

Sets the default lock for a bucket. Further information about the PUT Bucket object lock configuration operation is found on the following Amazon API Reference page.

https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectLockConfiguration.html

Permissions

The s3:PutBucketObjectLockConfiguration permission is needed to put object lock configuration for a bucket.

Requests

Syntax

PUT /?object-lock HTTP/1.1

Host: Bucket.s3.amazonaws.com

Content-MD5: ContentMD5

<?xml version="1.0" encoding="UTF-8"?>

<ObjectLockEnabled>string</ObjectLockEnabled>

<Rule>

<Days>integer</Days>

<Mode>string</Mode>

<Years>integer</Years>

</DefaultRetention>

</Rule>

</ObjectLockConfiguration>

Parameters

None.

Headers

None

Elements

Table 30: PUT Bucket object lock configuration request elements

Element	Supported	Notes
ObjectLockConfiguration	Yes	None
ObjectLockEnabled	Yes	None
Rule	Yes	None
DefaultRetention	Yes	None
Days	Yes	The request must include either the Days or Years element, but not both
Years	Yes	The request must include either the Days or Years element, but not both
Mode	Yes	ActiveScale only supports COMPLIANCE mode

Responses

Headers

None.

Elements

None.

Sample request and response

This example sets the default retention period for a bucket. The response returns a 200, which means the request was successful.

Request

PUT /?object-lock HTTP/1.1

Host: locked-bucket.s3.amazonaws.com

Content-Length: 220

Content-MD5: uyytnogu94pAxmcZIGcX7g==

Date: 20201029T103439Z

x-amz-content-sha256: 4958e4b8102fc8d1e99912e9ad9e38772351822bc607a4272b9fc82c2dd290ca\rAuthorization: AWS4-HMAC-SHA256 Credential=AK0B7YPKCQAAJIXNPPU7/20201029/us-east-1/s3/aws4_request,SignedHeaders=content-length;content-md5;date;host;x-amz-content-sha256,Signature=855beaf23051bc866521282b9c35f33d77c387d32d76350a264a19cd41e2f558

<ObjectLockEnabled>Enabled</ObjectLockEnabled>

<Rule>

<Mode>COMPLIANCE</Mode>

</DefaultRetention>

</Rule>

</ObjectLockConfiguration>

Response

HTTP/1.1 200 OKx-amz-id-2: 9933c1f7-b288-434e-9bcb-de3fee9872b2c5260c0a-714c-4fc9-a94f-b0ba092e8367

x-amz-request-id: 6B3A0E6B677AF460

Date: Thu, 29 Oct 2020 10:34:39 GMT

Content-Length: 0

Server: Quantum-ActiveScale

Special errors

ActiveScale returns an error if the retention mode is something other than COMPLIANCE.

Related operations

2.9.1 PUT Bucket
2.6.13 GET Bucket Object Lock Configuration

2.9.11 PUT Bucket Policy

Set the permissions for an existing bucket using the bucket policy.

Permissions

These permissions are needed to put bucket policies for a bucket:

s3:PutBucketPolicy
Must be bucket owner (account) or user under that account.

Syntax

PUT /?notification HTTP/1.1

PUT /?policy HTTP/1.1

Host: bucket.s3.amazonaws.com

Content-MD5: ContentMD5

Content-Length: ContentLength

Authorization: authorization string

{

"Version": "2012-10-17",

"Statement": {

"Effect":"Allow",

"Principal": {

"AWS":"{{ account_id }}"

"Action":"*",

"Resource":"arn:aws:s3:::{{ bucket.name }}/*"

}

Note: The bucket policy size cannot exceed 20480 bytes.

Parameters

None.

Headers

Table 31: PUT Bucket policy request headers

Header	Supported	Notes
Content-MD5	Yes	This header is not required, but recommended to be set.
x-amz-confirm-remove-self-bucket-access	No	In ActiveScale the bucket access cannot be revoked from the owner account.
x-amz-expected-bucket-owner	No	None.

Elements

Table 32: PUT Bucket policy request elements

Header	Supported	Notes
Version	Yes	Only version “2012-10-17” is supported by ActiveScale IAM. For more information on IAM version refer to the AWS documentation.
Id	Yes	(optional) Policy Identifier
Statement	Yes	Multiple statements ([ {..}, {..} ]) or a single statement ({..}).
Statement.Effect	Yes	Allow or Deny the actions in the statement.
Statement.Principal	Yes	Supported principal types: : all principals (including anonymous) AWS: account root user by arn (no wildcards), IAM user by arn (no wildcards), account identifier, CanonicalUser: account root user by account canonical id
Statement.NotPrincipal	Yes	Refer to Statement.Principal
Statement.Sid	Yes	(optional) Policy Statement Identifier
Statement.Action	Yes	* An action in Supported Actions (may include wildcards)
Statement.NotAction	Yes	Refer to Action
Statement.Resource	Yes	Supported resource types : S3 bucket ARN: needs to be for the bucket to which the bucket policy is applied - ie. "arn:aws:s3:::{{bucket_name}}" S3 object ARN: needs to be scoped to the bucket to which the bucket policy is applied - ie. "arn:aws:s3:::{{bucket_name}}/{{object_path}}" (the object path can contain wildcards) Note: Policy Variables are supported from ActiveScale 7.1
Statement.NotResource	Yes	Refer to Resource
Statement.Condition	Yes	Supported from ActiveScale 7.1 and above.

Responses

Headers

None.

Elements

None.

Sample request and response

This example sets the permissions for the examplebucket bucket and allows the account with identifier 391107088064 to put and get objects. The response returns a 204 No Content, which means the request was successful.

Request

PUT /?policy HTTP/1.1

Host: examplebucket.s3-eu-west-1.amazonaws.com

Content-MD5: tpu0L/pNnFeBq4KdxwkOSA==

Content-Length: 248

Date: 20240302T123525Z

x-amz-content-sha256: fae0b1bacc4702b16ad4acebdd670d1a4d47925a18b07d4556603aeec691899e\r

Authorization: authorization string

{

"Version": "2012-10-17",

"Statement": {

"Effect":"Allow",

"Principal": {

"AWS":"391107088064"

"Action":["s3:PutObject","s3:GetObject"],

"Resource":"arn:aws:s3:::examplebucket/*"

}

Response

HTTP/1.1 204 No Content

Date: Sat, 02 Mar 2024 12:35:27 GMT

Server: AmazonS3

x-amz-id-2: q3jSYIqYT8erIKiTVCDC4Hl1ggK2+Hl8RBxBWcM5pqnEQgaIl0N2Ap90ds2pxjLVAzCvgUg1hEo=

x-amz-request-id: KSYSZKJ1MQZNS613

Special errors

Error Code	Description	HTTP Status Code
`MalformedPolicy`	Normalized policy document exceeds the maximum allowed size of 20480 bytes.	4`00 Bad Request`
`MalformedPolicy`	Policies must be valid JSON and the first byte must be '{'.	`400 Bad Request`
`MalformedPolicy`	This policy contains invalid Json.	`400 Bad Request`
`MalformedPolicy`	The policy must contain a valid version string.	`400 Bad Request`
`MalformedPolicy`	Could not parse the policy: Statement is empty!	`400 Bad Request`
`MalformedPolicy`	Missing required field <instance_name> Instance names: Action Principal Statement Resource	`400 Bad Request`
`MalformedPolicy`	Could not parse the policy: Statement is not well formatted.	`400 Bad Request`
`MalformedPolicy`	Invalid policy syntax.	`400 Bad Request`
`MalformedPolicy`	Invalid effect: <effect>.	`400 Bad Request`
`MalformedPolicy`	Missing required field <instance_name> cannot be empty Instance names: Principal Action Resource	`400 Bad Request`
`MalformedPolicy`	Statement/policy already has instance of <instance_name> Instance names: Version Id Effect Statement Sid Principal Action Resource	`400 Bad Request`
`MalformedPolicy`	Invalid principal in policy.	`400 Bad Request`
`MalformedPolicy`	Policy has invalid <instance_name> Instance names: Action Resource	`400 Bad Request`
`MalformedPolicy`	Action does not apply to any resource(s) in statement.	`400 Bad Request`
`MalformedPolicy`	Allow with NotPrincipal is not allowed.	`400 Bad Request`
`MalformedPolicy`	Conditions do not apply to combination of actions and resources in statement.	`400 Bad Request`
`MalformedPolicy`	Unsatisfiable combination of condition keys for combination of action and resource(s) in statement.	`400 Bad Request`
`MalformedPolicy`	Policy has an invalid condition key.	`400 Bad Request`
`MalformedPolicy`	Invalid condition prefix: <condition_operator_qualifier>	`400 Bad Request`
`MalformedPolicy`	Invalid Condition type : <condition_operator>	`400 Bad Request`
`MalformedPolicy`	Policy contains one or more invalid variable declarations.	`400 Bad Request`
`MalformedPolicy`	Invalid IP address in Conditions.	`400 Bad Request`
`MalformedPolicy`	Value used for ARN condition is incorrect type: STRING string: "<arn_condition_value>”.	`400 Bad Request`

Related operations

2.6.15 GET Bucket Policy
2.5.7 DELETE Bucket Policy

2.9.12 PUT Bucket Notification

Create a new notification configuration or replace an existing one.

Permissions

The s3:PutBucketNotification permission is needed to put notification configuration for a bucket.

Syntax

PUT /?notification HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

<Id>TopicId</Id>

<Event>EventType</Event>

<Topic>TopicARN</Topic>

</TopicConfiguration>

</NotificationConfiguration>

The format of <Topic> tag in ActiveScale is as follows: arn:aws:sns:<region>:<KafkadestinationId>:<topic name>. The default region for ActiveScale is us-east-1.

Sample Request and Response

Request

<Id>TopicId</Id>

<Event>s3:ObjectCreated:*</Event>

<Topic>arn:aws:sns:us-east-1:1:TopicName</Topic>

</TopicConfiguration>

</NotificationConfiguration>

Response

HTTP/1.1 200 OK

x-amz-id-2: r+qR7+nhXtJDDIJ0JJYcd+1j5nM/rUFiiiZ/fNbDOsd3JUE8NWMLNHXmvPfwMpdc x-amz-request-id: 9E26D08072A8EF9E

Date: Wed, 24 Jun 2019 02:11:22 GMT

Content-Length: 0

Server: AmazonS3

Differences with AWS

A system-wide notification policy is required with appropriate topic destination information with status ENABLED, in order to be able to put a new bucket notification configuration. This should be done with the ASCLI.
Only Notification configurations with Topic Configurations are supported. Cloud function configurations (CloudFunctionConfiguration) and/or queue configurations (QueueConfiguration) are not supported.
If filter rules are specified in a topic configuration, only the empty prefix and/or empty suffix are allowed.

Related operations

2.6.12 GET Bucket Notification

2.9.13 PUT Bucket Replication

Create a new replication configuration or to replace an existing one.

The configuration is stored in a replication sub-resource associated with the bucket. If a replication sub-resource does not exist, it is created. If it does exist, the new configuration replaces the configuration that is currently stored in the sub-resource.

ActiveScale cannot validate the destination bucket.
ActiveScale cannot compare the access control translation account with the account of the destination bucket owner.
ActiveScale does not support access control translation.
ActiveScale does not support replication of encrypted objects with AWS KMS-managed encryption keys.
ActiveScale only supports one replication configuration rule.
ActiveScale only allows empty rule prefixes.

Permissions

The s3:PutReplicationConfiguration permission is needed to put replication configuration for a bucket.

Requests

Syntax

PUT /?replication HTTP/1.1

Host: bucket name.s3.amazonaws.com

Content-Length: length

Date: date

Authorization: authorization string

Content-MD5: MD5

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

None.

Elements

None.

Sample request and response

Request

PUT /?replication HTTP/1.1

Host: examplebucket.s3.amazonaws.com

Date: Wed, 11 Jun 2019 02:11:21 GMT

Content-MD5: q6yJDlIkcBaGGfb3QLY69A==

Authorization: authorization string

Content-Length: 406

<Role>arn:aws:iam::35667example:role/CrossRegionReplicationRoleForS3</Role>

<Rule>

<Prefix>TaxDocs</Prefix>

<Status>Enabled</Status>

<Bucket>arn:aws:s3:::exampletargetbucket</Bucket>

</Destination>

</Rule>

</ReplicationConfiguration>

Response

HTTP/1.1 200 OK

x-amz-id-2: r+qR7+nhXtJDDIJ0JJYcd+1j5nM/rUFiiiZ/fNbDOsd3JUE8NWMLNHXmvPfwMpdc

x-amz-request-id: 9E26D08072A8EF9E

Date: Wed, 11 Jun 2019 02:11:22 GMT

Content-Length: 0

Server: AmazonS3

Special errors

ActiveScale returns a special error if replication is not enabled.

Related operations

2.6.16 GET Bucket Replication
2.5.8 DELETE Bucket Replication

2.9.16 PUT Bucket Versioning

Set the versioning state of an existing bucket.

Permissions

The s3:PutBucketVersioning permission is needed to put versioning configuration for a bucket.

Requests

Syntax

PUT /?versioning HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

...

</VersioningConfiguration>

Parameters

None.

Headers

Table 33: Bucket versioning request headers

Header	Supported	Notes
x-amz-mfa	No	This header is not supported.

Elements

Table 34: PUT Bucket versioning request elements

Element	Supported	Notes
VersioningConfiguration	Yes	None
Status	Yes	None
MfaDelete	No	None

Responses

Headers

None.

Elements

None.

Sample request and response

This example sets the versioning status of the bucket to suspended. The response returns a 200 OK, which means the request was successful and the versioning status has been set to suspended.

Request

PUT /?versioning HTTP/1.1 Host: bucket.s3.amazonaws.com

Date: Wed, 12 Oct 2009 17:50:00 GMT

Authorization: authorization string

Content-Type: text/plain

Content-Length: 124

<Status>Suspended</Status>

</VersioningConfiguration>

Response

HTTP/1.1 200 OK

x-amz-id-2: YgIPIfBiKa2bj0KMg95r/0zo3emzU4dzsD4rcKCHQUAdQkf3ShJTOOpXUueF6QKo x-amz-request-id: 236A8905248E5A01

Date: Wed, 01 March 2006 12:00:00 GMTSpecialerrors

None.

Related operations

2.5.1 DELETE Bucket
2.9.1 PUT Bucket

2.10 DELETE Object Operations

2.10.1 DELETE Multiple Objects

Delete multiple objects from a bucket.

Permissions

These permissions are needed to delete objects:

s3:DeleteObject (or WRITE ACL) for each object for which Delete.Object.VersionId is not provided.
s3:DeleteObjectVersion for each object for which Delete.Object.VersionId is provided.

Requests

Syntax

POST /?delete HTTP/1.1

Host: bucketname.s3.amazonaws.com Date: date

Authorization: authorization string

Content-Length: length

Content-MD5: content-md5

<?xml version="1.0" encoding="UTF-8"?>

...

</Delete>

Parameters

Table 35: Delete Multiple Objects request parameters

Parameter	Supported	Notes
delete	Yes	None

Headers

Table 36: Delete Multiple Objects request headers

Parameter	Supported	Notes
Content-MD5	Yes	This header is required.
Content-Length	Yes	This header is required.
x-amz-mfa	No	This header is not supported.

Elements

Table 37: Delete Multiple Objects request elements

Parameter	Supported	Notes
Delete	Yes	None
Quiet	Yes	None
Object	Yes	None
Key	Yes	None
VersionId	Yes	None

Responses

Headers

None.

Elements

Table 38: Delete Multiple Objects response elements

Parameter	Supported	Notes
DeleteResult	Yes	None
Deleted	Yes	None
Key	Yes	None
VersionId	Yes	None
DeleteMarker	Yes	None
DeleteMarkerVersionId	Yes	None
Error	Yes	None
Code	Yes	None
Message	Yes	None

Sample request and response

This example deletes the sample1.txt and sample2.txt files from the bucketname bucket. The response returns a 204 No Content, which means the request was successful and the two files are deleted out of the bucketname bucket.

Request

POST /?delete HTTP/1.1

Host: bucketname.s3.amazonaws.com Accept: */*

x-amz-date: Wed, 30 Nov 2011 03:39:05 GMT Content-MD5: p5/WA/oEr30qrEEl21PAqw==

Authorization: AWS AKIAIOSFODNN7EXAMPLE:W0qPYCLe6JwkZAD1ei6hp9XZIee= Content-Length: 125

Connection: Keep-Alive

<Key>sample1.txt</Key>

</Object>

<Key>sample2.txt</Key>

</Object>

</Delete>

Response

HTTP/1.1 200 OK

x-amz-id-2: 5h4FxSNCUS7wP5z92eGCWDshNpMnRuXvETa4HH3LvvH6VAIr0jU7tH9kM7X+njXx x-amz-request-id: A437B3B641629AEE

Date: Fri, 02 Dec 2011 01:53:42 GMT

Content-Type: application/xml Server: Himalaya

Content-Length: 251

<?xml version="1.0" encoding="UTF-8"?>

Special errors

None.

Related operations

2.16.3 Initiate Multipart Upload
2.16.6 Upload Part
2.16.2 Complete Multipart Upload

2.10.2 DELETE Object

Delete a single object.

Options

To remove a specific version, you must use the versionId sub-resource. Using this subresource permanently deletes the version. If the object deleted is a delete marker, S3 sets the response header x-amz-delete-marker to true.

Permissions

These permissions are needed to delete objects:

s3:DeleteObject (or WRITE ACL) if versionId is not provided.
s3:DeleteObjectVersion if versionId is provided.

Requests

Syntax

DELETE /objectname HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

Table 39: Delete Object request headers

Header	Supported	Notes
x-amz-mfa	No	This header is not supported.

Elements

None.

Responses

Headers

Table 40: Delete Object response headers

Header	Supported	Notes
x-amz-delete-marker	Yes	None
x-amz-version-id	Yes	None

Elements

None.

Sample request and response

This example deletes the my-second-image.jpg file from the bucket bucket. The response returns a 204 No Content, which means the request was successful and the file are deleted out of the bucket bucket.

Request

DELETE /my-second-image.jpg HTTP/1.1

Host: bucket.s3.amazonaws.com

Date: Wed, 12 Oct 2009 17:50:00 GMT

Authorization: authorization string

Content-Type: text/plain

Response

HTTP/1.1 204

x-amz-id-2: LriYPLdmOdAiIfgSm/F1YsViT1LW94/xUQxMsF7xiEb1a0wiIOIxl+zbwZ163pt7 x-amz-request-id: 0A49CE4060975EAC

Date: Wed, 12 Oct 2009 17:50:00 GMT

Content-Length: 0

Connection: close

Server: Himalaya

Special errors

None.

Related operations

2.15.1 PUT Object
2.10.1 DELETE Multiple Objects

2.11 GET Object Operations

2.11.1 GET Object

Get the current version number of an object.

Options

By default, the GET Object operation returns the current version of an object. To return a different version, use the versionId subresource.

Permissions

These permissions are needed to get objects:

s3:GetObject (or READ ACL) if versionId is not provided.
s3:GetObjectVersion (or READ ACL) if versionId is provided.
Optional : s3:ListBucket (or READ ACL) to get a 404 instead of 403 if the object isn't found.
Optional : s3:GetObjectRetention to return object lock info in x-amz-object-lock-* headers.
Optional : s3:GetObjectversion (or READ ACL) if versionId is not provided to return x-amz-version-id header.

Requests

Syntax

GET /objectname HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

Table 41: GET Object request parameters

Parameter	Supported	Notes
response-cache-control	Yes	This parameter is stored and returned in a response header for the `GET Object` and `HEAD Object` operations.
response-content-disposition	Yes	This parameter is stored and returned in a response header for the `GET Object` and `HEAD Object` operations.
response-content-encoding	Yes	This parameter is stored and returned in a response header for the `GET Object` and `HEAD Object` operations.
response-content-language	Yes	This parameter is stored and returned in a response header for the `GET Object` and `HEAD Object` operations.
response-content-type	Yes	This parameter is stored and returned in a response header for the `GET Object` and `HEAD Object` operations.
response-expires	Yes	This parameter is stored and returned in a response header for the `GET Object` and `HEAD Object` operations.
versionId	Yes	This parameter is stored and returned in a response header for the `GET Object` and `HEAD Object` operations.

Headers

Table 42: GET Object request headers

Header	Supported	Notes
If-Modified-Since	Yes	None
If-Unmodified-Since	Yes	None
If-Match	Yes	None
If-None-Match	Yes	None
If-Range	Partially	The object is always considered to be changed. The message `200 OK with full content` is returned. Ignoring this header could cause an incorrect `206 Partial content` response.
Range	Yes	None
x-amz-server-side-encryption-customer-algorithm	No	This header is not allowed by default. Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key	No	This header is not allowed by default. Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key-MD5	No	This header is not allowed by default. Customer-provided encryption keys are not supported.
x-amz-te x-amz-transfer-encoding	No	This parameter is allowed, but ignored.

Elements

None.

Responses

Headers

Table 43: GET Object response headers

Headers	Supported	Notes
Cache-Control	Yes	None
Content-Disposition	Yes	None
Content-Encoding	Yes	None
Content-Language	Yes	None
Content-Type	Yes	None
Expires	Yes	None
x-amz-delete-marker	Yes	None
x-amz-expiration	Yes	None
x-amz-object-lock-mode	Yes	None
x-amz-object-lock-retain-until-date	Yes	None
x-amz-meta-*	Yes	None
x-amz-replication-status	Yes	None
x-amz-restore-expiry-days	Requires Cold Storage	None
x-amz-restore-request-date	Requires Cold Storage	None.
x-amz-restore-tier	Requires Cold Storage	None
x-amz-restore	Requires Cold Storage	None
x-amz-server-side-encryption	Yes	The value `AES256` is supported. The value `aws:kms` is not supported.
x-amz-server-side-encryption-aws-kms-key-id	N/A	The encryption algorithm aws:kms is not supported.
x-amz-server-side-encryption-customer-algorithm	N/A	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key-MD5	N/A	Customer-provided encryption keys are not supported.
x-amz-storage-class	Yes	None
x-amz-tagging-count	N/A	Object tagging is not supported
x-amz-version-id	Yes	None
x-amz-website-redirect-location	Yes	None
x-amz-te x-amz-transfer-encoding	No	The header will not be returned, even if the x-amzte request header was set.

Elements

Table 44: GET Object response elements

Element	Supported	Notes
Cache-Control	Yes	None
Content-Disposition	Yes	None
Key	Yes	None
VersionID	Yes	None
DeleteMarker	Yes	None
DeleteMarkerVersionId	Yes	None
Error	Yes	None
Code	Yes	None
Message	Yes	None

Sample request and response

This example retrieves the version number of my-image.jpg in the bucket bucket. The response returns a 200OK, which means the request was successful. The response also returns the version number.

Request

GET /my-image.jpg HTTP/1.1

Host: bucket.s3.amazonaws.com

Date: Mon, 3 Oct 2016 22:32:00 GMT

Authorization: authorization string

Response

HTTP/1.1 200 OK

x-amz-id-2: eftixk72aD6Ap51TnqcoF8eFidJG9Z/2mkiDFu8yU9AS1ed4OpIszj7UDNEHGran x-amz-request-id: 318BC8BC148832E5

Date: Mon, 3 Oct 2016 22:32:00 GMT

Last-Modified: Wed, 12 Oct 2009 17:50:00 GMT

ETag: "fba9dede5f27731c9771645a39863328"

Content-Length: 434234 [434234 bytes of object data]

Special errors

Error code	Description	HTTP Status code
InvalidObjectState	The object is stored on Cold Storage and must be restored (see 2.14.2 POST Object Restore) before GET requests can be issued.	403 Forbidden

Related operations

2.17.1 GET Service
2.11.2 GET Object ACL

2.11.2 GET Object ACL

Get the access control list (ACL) of an object.

Because object owners and object ACLs are not supported, this operation maps to GET Bucket acl and returns the bucket owner and the bucket ACL. The bucket owner and the bucket ACL are effectively the object owner and the object ACL.

Permissions

These permissions are needed to get object ACL:

s3:GetObjectAcl (or READ_ACP ACL) if versionId is not provided.
s3:GetObjectVersionAcl (or READ_ACP ACL) if versionId is provided.
Optional : s3:ListBucket (or READ ACL) to get a 404 instead of 403 if the object isn't found.

Requests

Syntax

GET /objectname?acl HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

Table 45: GET Object acl request parameters

Parameter	Supported	Notes
versionID	Yes	This parameter is stored and returned in a response header for `GET Object`and `HEAD Object`operations.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 46: Object acl response elements

Element	Supported	Notes
AccessControlList	Yes	None
AccessControlPolicy	Yes	None
DisplayName	Yes	None
Grant	Yes	None
Grantee	Yes	None
ID	Yes	None
Owner	Yes	None
Permission	Yes	None

Sample request and response

This request retrieves the access control list for my-image.jpg in the bucket bucket. The response returns a 200 OK, which means the request was successful. The response also returns the access control list details.

Request

GET /my-image.jpg?acl HTTP/1.1

Host: bucket.s3.amazonaws.com

Date: Wed, 28 Oct 2009 22:32:00 GMT

Authorization: authorization string

Response

HTTP/1.1 200 OK

x-amz-id-2: eftixk72aD6Ap51TnqcoF8eFidJG9Z/2mkiDFu8yU9AS1ed4OpIszj7UDNEHGran x-amz-request-id: 318BC8BC148832E5

x-amz-version-id: 4HL4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nrjfkd Date: Wed, 28 Oct 2009 22:32:00 GMT

Last-Modified: Sun, 1 Jan 2006 12:00:00 GMT

Content-Length: 124 Content-Type: text/plain Connection: close Server: Himalaya

<Owner>

<ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>

<DisplayName>mtd@amazon.com</DisplayName>

</Owner>

<Grant>

<ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>

<DisplayName>mtd@amazon.com</DisplayName>

</Grantee>

<Permission>FULL_CONTROL</Permission>

</Grant>

</AccessControlList>

</AccessControlPolicy>

Special errors

None.

Related operations

2.11.1 GET Object
2.15.1 PUT Object
2.10.2 DELETE Object

2.11.3 GET Object Retention

Requests to an object’s retention settings. Further information about the GET Object retention operation is found on the following Amazon API Reference page.

https://docs.aws.amazon.com/AmazonS3/latest/API/API_GetObjectRetention.html

Permissions

These permissions are needed to get object retention:

s3:GetObjectRetention
Optional : s3:ListBucket (or READ ACL) to get a 404 instead of 403 if the object isn't found.

Requests

Syntax

GET /objectname?retention&versionId=versionID HTTP/1.1

Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

Table 47: GET Object retention request parameters

Parameter	Supported	Notes
VersionID	Yes	Optional

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 48: GET Object retention response elements

Element	Supported	Notes
Retention	Yes	None
Mode	Yes	None
RetainUntilDate	Yes	None

Sample request and response

This example requests the default retention period for a bucket. The response returns a 200, which means the request was successful.

Request

GET /objectname?retention HTTP/1.1

Host: locked-bucket.s3.amazonaws.com

Content-Length: 0

Date: 20201029T102545Z

x-amz-content-sha256: e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855

Authorization: AWS4-HMAC-SHA256 Credential=AK0B7YPKCQAAJIXNPPU7/20201029/us-east-1/s3/aws4_request,SignedHeaders=content-length;date;host;x-amz-content-sha256,Signature=92192e28c486c113f2ab593e446edc6cd5aaf023a4a5eb8a4c0c6cd121f039f3

Response

HTTP/1.1 200 OKx-amz-id-2: 9933c1f7-b288-434e-9bcb-de3fee9872b2c5260c0a-714c-4fc9-a94f-b0ba092e8367

x-amz-request-id: A74F26F74FB9CA4A

Date: Thu, 29 Oct 2020 10:25:45 GMT

Transfer-Encoding: chunked

Server: Quantum-ActiveScale

<?xml version="1.0" encoding="UTF-8"?>

<Mode>COMPLIANCE</Mode>

</Retention>

Special errors

None.

Related operations

ActiveScale Management S3 API

2.12 HEAD Object Operations

2.12.1 HEAD Object

Get the current version of an object.

Options

By default, the HEAD Object operation returns the current version of an object. To return a different version, use the versionId subresource.

Permissions

These permissions are needed to head objects:

s3:GetObject (or READ ACL) if versionId is not provided.
s3:GetObjectVersion (or READ ACL) if versionId is provided.
Optional : s3:ListBucket (or READ ACL) to get a 404 instead of 403 if the object isn't found.
Optional : s3:GetObjectRetention to return object lock info in x-amz-object-lock-* headers.
Optional : s3:GetObjectversion (or READ ACL) if versionId is not provided to return x-amz-version-id header.

Requests

Syntax

HEAD /objectname HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

Table 49: HEAD Object request parameters

Parameter	Supported	Notes
response-cache-control	Yes	This parameter is stored and returned in a response header for `GET Object` and `HEAD Object` operations.
response-content-disposition	Yes	This parameter is stored and returned in a response header for `GET Object` and `HEAD Object` operations.
response-content-encoding	Yes	This parameter is stored and returned in a response header for `GET Object` and `HEAD Object` operations.
response-content-language	Yes	This parameter is stored and returned in a response header for `GET Object` and `HEAD Object` operations.
response-content-type	Yes	This parameter is stored and returned in a response header for `GET Object` and `HEAD Object` operations.
response-expires	Yes	This parameter is stored and returned in a response header for `GET Object` and `HEAD Object` operations.
versionId	Yes	This parameter is stored and returned in a response header for `GET Object` and `HEAD Object` operations.

Headers

Table 50: HEAD Object request headers

Header	Supported	Notes
If-Modified-Since	Yes	None
If-Unmodified-Since	Yes	None
If-Match	Yes	None
If-None-Match	Yes	None
If-Range	Partially	None
Range	Yes	This object is always considered as changed. `200 OK with full content` is returned. Ignoring this header could cause an incorrect `206 Partial Content` response.
x-amz-server-side-encryption-customer-algorithm	No	None
x-amz-server-side-encryption-customer-key	No	By default, this header is not allowed. Customer-provided encryption keys are not allowed. supported.
x-amz-server-side-encryption-customer-key-MD5	No	By default, this header is not allowed. Customer-provided encryption keys are not allowed. supported.

Elements

None.

Responses

Headers

Table 51: HEAD Object response headers

Header	Supported	Notes
Cache-Control	Yes	None
Content-Disposition	Yes	None
Content-Encoding	Yes	None
Content-Language	Yes	None
Content-Type	Yes	None
Expires	Yes	None
x-amz-delete-marker	Yes	None
x-amz-expiration	Yes	None
x-amz-meta-*	Yes	Some limitations apply.
x-amz-missing-meta	N/A	The SOAP API is not supported.
x-amz-object-lock-mode	Yes	None
x-amz-object-lock-retain-until-date	Yes	None
x-amz-replication-status	Yes	None
x-amz-restore-expiry-days	Requires Cold Storage	None
x-amz-restore-request-date	Requires Cold Storage	None
x-amz-restore-tier	Requires Cold Storage	None
x-amz-restore	Requires Cold Storage	None
x-amz-server-side-encryption	Yes	The value `AES256` is supported. The value `aws:kms` is not supported.
x-amz-server-side-encryption-aws-kms-key-id	N/A	The encryption algorithm `aws:kms` is not supported.
x-amz-server-side-encryption-customer-algorithm	N/A	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key-MD5	N/A	Customer-provided encryption keys are not supported.
x-amz-storage-class	Yes	None
x-amz-restore	N/A	None
x-amz-tagging-count	N/A	Object tagging is not supported.
x-amz-version-id	Yes	None
x-amz-website-redirect-location	Yes	None

Elements

None.

Sample request and response

The request retrieves the version number of my-image.jpg in the bucket bucket. The response returns a 200 OK, which means the request was successful. The response also returns the version number.

Request

GET /my-image.jpg HTTP/1.1

Host: bucket.s3.amazonaws.com

Date: Mon, 3 Oct 2016 22:32:00 GMT

Authorization: authorization string

Response

HTTP/1.1 200 OK

x-amz-id-2: eftixk72aD6Ap51TnqcoF8eFidJG9Z/2mkiDFu8yU9AS1ed4OpIszj7UDNEHGran x-amz-request-id: 318BC8BC148832E5

Date: Mon, 3 Oct 2016 22:32:00 GMT

Last-Modified: Wed, 12 Oct 2009 17:50:00 GMT ETag: "fba9dede5f27731c9771645a39863328"

Content-Length: 434234 [434234 bytes of object data]

Special errors

None.

Related operations

2.17.1 GET Service
2.11.2 GET Object ACL

2.14 POST Object Operations

2.14.2 POST Object Restore

Request an object stored on ActiveScale Cold Storage (ASCS) to be restored back in ActiveScale as a temporary copy on disk storage, the original object remains on tape. Refer to the Cold Storage documentation for more information on the difference between Cold Storage and ActiveScale. Once this call successfully completes, the object will be scheduled for restore in a background job. When the background jobs finish, the object will be available for GET Object calls like other regular objects.

Permissions

These permissions are needed to restore objects:

s3:RestoreObject
Optional : s3:ListBucket (or READ ACL) to get a 404 instead of 403 if the object isn't found.

Requests

Syntax

POST /object-name?restore HTTP/1.1

Host: bucketname.s3.amazonaws.com

Content-Length: content length

Date: date

Range: bytes=42-9000

Authorization: authorization string

<?xml version="1.0" encoding="UTF-8"?>

<Tier>STANDARD</Tier>

</GlacierJobParameters>

</RestoreRequest>

Parameters

None.

Headers

ActiveScale 7.1 and above adds support for the Range header in addition to the common request headers. See the section Quantum Extensions for more information.

Elements

Element	Supported	Notes
RestoreRequest	Requires Cold Storage	None
Days	Requires Cold Storage	None
GlacierJobParameters	Requires Cold Storage	None
Tier	Requires Cold Storage	Supported values: Standard, Bulk, Expedited

Note: The call is only permitted for objects with storage class GLACIER or DEEP_ARCHIVE which are not currently restoring. Refer to the Cold Storage documentation for more information.

Responses

Headers

This operation uses common response headers only.

Sample request and response

The following tables show a request example and a response example for the POST Object restore operation. This sample will restore the object with object name object-name in a bucket called bucket-name from Cold Storage for one day on the disk storage. The response returns a 202 Accepted, meaning that the request has been successfully accepted; the actual restore will happen at some point in the future.

Requests

POST /object-name?restore HTTP/1.1

Host: bucket-name.s3.amazonaws.com

Content-Length: content length

Date: date

Authorization: authorization string

<?xml version="1.0" encoding="UTF-8"?>

</RestoreRequest>

Response

HTTP/1.1 202 Accepted

Content-Length: 0

Date: date

Server: Quantum-ActiveScale

x-amz-id-2: host identifier

x-amz-request-id: request ID

Elements

Element	Supported	Notes
RestoreAlreadyInProgress	The object has already been scheduled for restore	409 Conflict

Quantum Extensions

ActiveScale 7.1 and above adds a Quantum extension to the S3 Post Object Restore API. ActiveScale ASCS systems now support the Range header allowing S3 clients to specify they only want to partially restore an object.

Amazon AWS also accepts this range header, but ignores it and always restores the full object. When restoring multipart object with a range header specified ActiveScale will restore the minimal parts needed that contain the specified byte range instead of restoring the full object. This enables S3 clients to have a lower time to first byte for large cold storage objects, if they are only interested in reading a part of the object.

For single part objects ActiveScale will keep restoring the full object. Once restored only the restored parts will be available for GET requests while trying to get the non-restored parts will result in a InvalidObjectState error.

Multiple ranges can be restored at the same time, the last processed restore will determine the retain until date for all restored parts.

2.15 PUT Object Operations

2.15.1 PUT Object

Add an object to a bucket.

Permissions

The s3:PutObject (or WRITE ACL) permission is needed to put objects.

Requests

Syntax

PUT /objectname HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

Content-Length: lengthcontent

Parameters

Table 52: PUT Object request parameters

Parameter	Supported	Notes
x-amz-acl	No	Allowed, but ignored.
x-amz-grant-*	No	Allowed, but ignored.
x-amz-meta-*	Yes	Some limitations apply.
x-amz-server-side-encryption	Yes	The value `AES256` is supported. The value `aws:kms` is not supported.
x-amz-storage-class	Yes	`GLACIER` and `DEEP_ARCHIVE` are only supported in Cold Storage.

Headers

Table 53: PUT Object request headers

Header	Supported	Notes
Cache-Control	Yes	This information is stored and returned in a response header for the `GET Object` and `HEAD Object` operations.
Content-Disposition	Yes	This information is stored and returned in a response header for the `GET Object` and `HEAD Object` operations.
Content-Encoding	Yes	This information is stored and returned in a response header for the `GET Object` and `HEAD Object` operations.
Content-Language	Yes	This information is stored and returned in a response header for the `GET Object` and `HEAD Object` operations.
Content-MD5	Yes	This information is stored and returned in a response header for the `GET Object` and `HEAD Object` operations.
Content-Type	Yes	The information is stored and returned in a response header for `GET Object` and `HEAD Object`.
Expect	Yes	The value for Expect must be `100-continue.`
Expires	Yes	The information is stored and returned in a response header for `GET Object` and `HEAD Object`.
x-amz-acl	No	This parameter is allowed, but ignored.
x-amz-checksum-*	No	By default, this parameter is not allowed because only the MD5 sum is supported as a data integrity check.
x-amz-grant-*	No	This parameter is allowed, but ignored.
x-amz-meta-*	Yes	Some limitations apply.
x-amz-object-lock-legal-hold	No	Ignored if the value is OFF.
x-amz-object-lock-mode	Yes	ActiveScale only supports COMPLIANCE mode.
x-amz-object-lock-retain-until-date	Yes	None
x-amz-server-side-encryption	Yes	The value `AES256` is supported. The value `aws:kms` is not supported.
x-amz-server-side-encryption-aws-kms-key-id	No	By default, this parameter is not allowed because the encryption algorithm `aws:kms` is not supported.
x-amz-server-side-encryption-context	No	By default, this parameter is not allowed because the encryption algorithm `aws:kms` is not supported.
x-amz-server-side-encryption-customer-algorithm	No	By default, this parameter is not allowed because customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key	No	By default, this parameter is not allowed because customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key-MD5	No	By default, this parameter is not allowed because customer-provided encryption keys are not supported.
x-amz-storage-class	Yes	None

Elements

None.

Response elements

There are no response elements that are associated with the PUT Object operation.

Responses

Headers

Note: The header x-amz-checksum-* is not supported. By default, this parameter is not allowed because only the MD5 sum is supported as a data integrity check.

Table 54: PUT Object response headers

Header	Supported	Notes
x-amz-expiration	Yes	None
x-amz-server-side-encryption	Yes	The value `AES256` is supported. The value `aws:kms` is not supported.
x-amz-server-side-encryption-aws-kms-key-id	N/A	The encryption algorithm `aws:kms` is not supported.
x-amz-server-side-encryption-customer-algorithm	N/A	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key-MD5	N/A	Customer-provided encryption keys are not supported.
x-amz-storage-class	Yes	None
x-amz-version-id	Yes	None

Elements

None.

Sample request and response

This example adds the file TestObject.txt to the myBucket bucket. The response returns a 200 OK, which means the request was successful.

Request

PUT TestObject.txt HTTP/1.1

Host: myBucket.s3.amazonaws.com

x-amz-date: Fri, 13 Apr 2012 05:40:14 GMT

Authorization: authorization string

x-amz-grant-write-acp: id=8a6925ce4adf588a4532142d3f74dd8c71fa124ExampleCanonicalUserID x-amz-grant-full-control: emailAddress="ExampleUser@amazon.com"

x-amz-grant-write: emailAddress="ExampleUser1@amazon.com",

emailAddress="ExampleUser2@amazon.com"

Response

HTTP/1.1 200 OK

x-amz-id-2: RUxG2sZJUfS+ezeAS2i0Xj6w/ST6xqF/8pFNHjTjTrECW56SCAUWGg+7QLVoj1GH x-amz-request-id: 8D017A90827290BA

Date: Fri, 13 Apr 2012 05:40:25 GMT ETag: "dd038b344cf9553547f8b395a814b274"

Content-Length: 0 Server: Himalaya

Content-Length: 300 Expect: 100-continue Connection: Keep-Alive

...Object data in the body...

Special errors

None.

Related operations

2.15.3 PUT Object-Copy
2.11.1 GET Object

2.15.3 PUT Object-Copy

Create a copy of an object that is already stored in a bucket.

Permissions

These permissions are needed to copy objects:

s3:PutObject (or WRITE ACL) for the destination object.
s3:GetObject (or READ ACL) for the source object if x-amz-copy-source does not include a version id.
s3:GetObjectVersion (or READ ACL) for the source object if x-amz-copy-source does include a version id.
Optional : s3:ListBucket (or READ ACL) for the source bucket to get a 404 instead of 403 if the source object isn't found.

Requests

Syntax

PUT /objectname HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

x-amz-copy-source: /sourcebucketname/sourceobjectname

Parameters

Table 55: PUT Object-Copy

Parameter	Supported	Notes
x-amz-acl	No	None
x-amz-grant-*	No	None
x-amz-meta-*	Yes	Some limitations apply.
x-amz-server-side-encryption	Yes	The value `AES256` is supported. The value `aws:kms` is not supported.
x-amz-storage-class	Yes	`GLACIER` and `DEEP_ARCHIVE` are only supported in ASCS

Headers

Table 56: PUT Object-Copy request headers

Header	Supported	Notes
x-amz-acl	No	None
x-amz-grant-*	No	None
x-amz-copy-source	Yes	None
x-amz-copy-source-if-match	Yes	None
x-amz-copy-source-if-modified-since	Yes	None
x-amz-copy-source-if-none-match	Yes	None
x-amz-copy-source-if-unmodified-since	Yes	None
x-amz-copy-source-server-side-encryption-customer-algorithm	No	Customer-provided encryption keys are not supported.
x-amz-copy-source-server-side-encryption-customer-key	No	Customer-provided encryption keys are not supported.
x-amz-copy-source-server-side-encryption-customer-key-MD5	No	Customer-provided encryption keys are not supported.
x-amz-meta-*	Yes	Some limitations apply.
x-amz-metadata-directive	Yes	None
x-amz-server-side-encryption	Yes	The value `AES256` is supported. The value `aws:kms` is not supported.
x-amz-server-side-encryption-aws-kms-key-id	No	The encryption algorithm `aws:kms` is not supported.
x-amz-server-side-encryption-context	No	The encryption algorithm `aws:kms` is not supported.
x-amz-server-side-encryption-customer-	No	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key	No	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key-MD5	No	Customer-provided encryption keys are not supported.
x-amz-storage-class	Yes	None
x-amz-tagging-directive	No	Object tagging is not supported.
x-amz-website-redirect-location	Yes	The information is stored and returned in a response header for `GET Object` and `HEAD Object`.
x-amz-acl	No	None

Elements

None.

Responses

Headers

Table 57: PUT Object-Copy response headers

Header	Supported	Notes
x-amz-copy-source-version-id	Yes	None
x-amz-expiration	Yes	None
x-amz-server-side-encryption	Yes	The value `AES256` is supported. The value aws:kms is not supported.
x-amz-server-side-encryption-aws-kms-key-id	N/A	The encryption algorithm aws:kms is not supported.
x-amz-server-side-encryption-customer-algorithm	N/A	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key-MD5	N/A	Customer-provided encryption keys are not supported.
x-amz-storage-class	Yes	None
x-amz-version-id	Yes	None

Elements

Table 58: PUT Object-Copy response elements

Element	Supported	Notes
CopyObjectResult	Yes	None
ETag	Yes	None
LastModified	Yes	None

Sample request and response

This example adds the file my-second-image.jpg to the bucket bucket. The response returns a 200 OK, which means the request was successful.

Request

PUT /my-second-image.jpg HTTP/1.1

Host: bucket.s3.amazonaws.com

Date: Wed, 28 Oct 2009 22:32:00 GMT

x-amz-copy-source: /bucket/my-image.jpg

Authorization: authorization string

Response

HTTP/1.1 200 OK

x-amz-id-2: eftixk72aD6Ap51TnqcoF8eFidJG9Z/2mkiDFu8yU9AS1ed4OpIszj7UDNEHGran x-amz-request-id: 318BC8BC148832E5

x-amz-copy-source-version-id: 3/L4kqtJlcpXroDTDmJ+rmSpXd3dIbrHY+MTRCxf3vjVBH40Nr8X8gdRQBpUMLUo

x-amz-version-id: QUpfdndhfd8438MNFDN93jdnJFkdmqnh893 Date: Wed, 28 Oct 2009 22:32:00 GMT

Connection: close Server: AmazonS3

</CopyObjectResult>

Special errors

None.

Related operations

2.15.1 PUT Object
2.11.1 GET Object

2.15.4 PUT Object Retention

Places an Object Retention Configuration on an object. Further information about the PUT Object retention operation is found on the following Amazon API Reference page.

https://docs.aws.amazon.com/AmazonS3/latest/API/API_PutObjectRetention.html

Permissions

These permissions are needed to put object retention:

s3:PutObjectRetention
Optional : s3:ListBucket (or READ ACL) to get a 404 instead of 403 if the object isn't found.

Requests

Syntax

PUT /objectname?retention&versionId=VersionId HTTP/1.1

Host: bucket.s3.amazonaws.com

Content-MD5: ContentMD5

<?xml version="1.0" encoding="UTF-8"?>

<Mode>string</Mode>

<RetainUntilDate>timestamp</RetainUntilDate>

</Retention>

Parameters

Table 59: PUT Object retention parameters

Parameter	Supported	Notes
Content-MD5	Yes
versionId	Yes	Optional

Headers

None.

Elements

The PUT Object retention request should contain the following elements:

Table 60: PUT Object retention elements

Element	Supported	Notes
Mode	Yes	None
RetainUntilDate	Yes	None
Retention	Yes	None

Sample request and response

Request

PUT /objectname?retention HTTP/1.1

Host: locked-bucket.s3.amazonaws.com

Content-Length: 108

Content-MD5: emc4mTn/Y8FvMdM+TKNBAQ==

Date: 20201029T100902Z

x-amz-content-sha256: 69e6713da0bbf7f43dbd883a1ccde7ce64b8ba3abc12749df865f25013125187

Authorization: AWS4-HMAC-SHA256 Credential=AK0B7YPKCQAAJIXNPPU7/20201029/us-east-1/s3/aws4_request,SignedHeaders=content-length;content-md5;date;host;x-amz-content-sha256,Signature=0ec2570d2fcb87f8dc52e41573d63b634b2dc617f769c0a73f64b9423de9e5ef

<Mode>COMPLIANCE</Mode>

</Retention>

Response

HTTP/1.1 200 OK

x-amz-id-2: 9933c1f7-b288-434e-9bcb-de3fee9872b2c5260c0a-714c-4fc9-a94f-b0ba092e8367

x-amz-request-id: EC753CEBEC5547E7

Date: Thu, 29 Oct 2020 10:09:02 GMT

x-amz-version-id: EYGazHnmAbNZkkdim2HqxY3VEsPCvx_VkKsnVtL3AR1DJ09.

Content-Length: 0

Server: Quantum-ActiveScale

Special errors

ActiveScale returns an error if the retention mode is something other than COMPLIANCE.

Related operations

2.11.3 GET Object Retention

2.16 Part Operations

This section contains reference information about ActiveScale S3 API part operations.

2.16.1 Abort Multipart Upload

Stop a multipart upload.

Permissions

The s3:AbortMultipartUpload permission is needed to abort multipart uploads.

Requests

Syntax

DELETE /objectname?uploadId=uploadid HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

This operation uses common response elements only.

Sample request and response

This example stops the example-object upload to the example-bucket bucket. The response returns a 204 OK, which means the request was successful and that there is no additional content to send.

Request

DELETE /example-object? uploadId=VXBsb2FkIElEIGZvciBlbHZpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZ HTTP/1.1

Host: example-bucket.s3.amazonaws.com

Date: Min, 1 Nov 2010 20:34:56 GMT

Authorization: authorization string

Response

HTTP/1.1 204 OK

x-amz-id-2: Weag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg== x-amz-request-id: 996c76696e6727732072657175657374

Date: Mon, 1 Nov 2010 20:34:56 GMT

Content-Length: 0

Connection: keep-alive

Server: AmazonS3

Special errors

None.

Related operations

2.16.5 List Parts
2.16.6 Upload Part
2.16.7 Upload Part-Copy

2.16.2 Complete Multipart Upload

Complete a multipart upload by assembling previously uploaded parts.

Permissions

The s3:PutObject (or WRITE ACL) permission is needed to complete multipart uploads.

Requests

Syntax

POST /objectname?uploadId=uploadid HTTP/1.1 Host: bucketname.s3.amazonaws.com

Date: date

Authorization: authorization string

Content-Length: length

<?xml version="1.0" encoding="UTF-8"?>

...

</CompleteMultipartUpload>

Parameters

None.

Headers

This operation uses common request headers only.

The header x-amz-checksum-* is not supported. By default, this parameter is not allowed because only the MD5 sum is supported as a data integrity check.

Elements

Table 61: Complete Multipart Upload request elements

Element	Supported	Notes
CompleteMultipartUpload	Yes	None
Part	Yes	None
PartNumber	Yes	None
ETag	Yes	None

Responses

Headers

Note: The header x-amz-checksum-* is not supported. By default, this parameter is not allowed because only the MD5 sum is supported as a data integrity check.

Table 62: Complete Multipart Upload response headers

Header	Supported	Notes
x-amz-expiration	Yes	None
x-amz-server-side-encryption	Yes	The value `AES256` is supported. The value `aws:kms` is not supported.
x-amz-server-side-encryption-aws-kms-key-id	N/A	The encryption algorithm aws:kms is not supported.
x-amz-server-side-encryption-customer-algorithm	N/A	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key-MD5	N/A	Customer-provided encryption keys are not supported.
x-amz-version-id	Yes	None

Elements

Table 63: Complete Multipart Upload response elements

Element	Supported	Notes
Complete MultipartUploadResult	Yes	None
Location	Yes	None
Bucket	Yes	None
Key	Yes	None
ETag	Yes	None

Sample request and response

This example completes the multipart upload by assembling parts 1, 2, and 3 to form a single object. The response returns a 200 OK, which means the request was successful. It also returns the name of the assembled object and the bucket it was assembled in.

Request

POST /example-object? uploadId=AAAsb2FkIElEIGZvciBlbHZpbmcncyWeeS1tb3ZpZS5tMnRzIRRwbG9hZA HTTP/1.1

Host: example-bucket.s3.amazonaws.com

Date: Mon, 1 Nov 2010 20:34:56 GMT

Content-Length: 391

Authorization: authorization string

<Part>

</Part>

<Part>

</Part>

<Part>

<ETag>"acbd18db4cc2f85cedef654fccc4a4d8"</ETag>

</Part>

</<Bucket>Example-Bucket</Bucket>

<Key>Example-Object</Key>

</CompleteMultipartUploadResult>

Response

HTTP/1.1 200 OK

x-amz-id-2: Uuag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg== x-amz-request-id: 656c76696e6727732072657175657374

Date: Mon, 1 Nov 2010 20:34:56 GMT

Connection: close

Server: AmazonS3

<?xml version="1.0" encoding="UTF-8"?>

<Location>http://Example-Bucket.s3.amazonaws.com/Example-Object</Location>

Special errors

Table 64: Complete Multipart Upload special errors

Error Message	Description	HTTP Status Code	SOAP Fault Code Prefix
NoSuchUpload	The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.	404 Not Found	Client

Related operations

2.16.1 Abort Multipart Upload
2.16.3 Initiate Multipart Upload
2.16.4 List Multipart Uploads

2.16.3 Initiate Multipart Upload

Start a multipart upload and return an upload ID.

Permissions

The s3:PutObject (or WRITE ACL) permission is needed to initiate multipart uploads.

Requests

Syntax

POST /objectname?uploads HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

Table 65: Initiate Multipart Upload request parameters

Parameter	Supported	Notes
x-amz-acl	No	None
x-amz-grant-*	No	None
x-amz-meta-*	Yes	Some limitations apply.
x-amz-server-side-encryption	Yes	The value `AES256` is supported. The value `aws:kms` is not
x-amz-storage-class	Yes	`GLACIER` and `DEEP_ARCHIVE` are only supported in Cold Storage.

Headers

Table 66: Initiate Multipart Upload request headers

Header	Supported	Notes
Cache-Control	Yes	The information is stored and returned in a response header for `GET Object` and `HEAD Object`.
Content-Disposition	Yes	The information is stored and returned in a response header for `GET Object` and `HEAD Object`.
Content-Encoding	Yes	The information is stored and returned in a response header for `GET Object` and `HEAD Object`.
Content-Language	Yes	The information is stored and returned in a response header for `GET Object` and `HEAD Object`.
Content-Type	Yes	The information is stored and returned in a response header for `GET Object` and `HEAD Object`.
Expires	Yes	The information is stored and returned in a response header for `GET Object` and `HEAD Object`.
x-amz-acl	No	None
x-amz-grant-*	No	Customer-provided encryption keys are not supported.
x-amz-meta-*	Yes	Some limitations apply.
x-amz-server-side-encryption	Yes	The value `AES256` is supported. The value `aws:kms` is not supported.
x-amz-server-side-encryption-aws-kms-key-id	No	The encryption algorithm `aws:kms` is not supported.
x-amz-server-side-encryption-context	No	The encryption algorithm aws:kms is not supported.
x-amz-server-side-encryption-customer-algorithm	No	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key	No	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key-MD5	No	Customer-provided encryption keys are not supported.
x-amz-storage-class	Yes	None
x-amz-website-redirect-location	Yes	The information is stored and returned in a response header for `GET Object` and `HEAD Object`.

Elements

None.

Responses

Headers

Table 67: Initiate Multipart Upload response headers

Header	Supported	Notes
x-amz-abort-date	N/A	The lifecycle action `Abort Incomplete Multipart Upload` is not supported.
x-amz-abort-rule-id	N/A	The lifecycle action `Abort Incomplete Multipart Upload` is not supported.
x-amz-server-side-encryption-aws-kms-key-id	N/A	The encryption algorithm `aws:kms` is not supported.
x-amz-server-side-encryption-customer-algorithm	N/A	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key-MD5	N/A	Customer-provided encryption keys are not supported.
x-amz-version-id	Yes	Versioning is not supported.

Elements

Table 68: Initiate Multipart Upload response elements

Element	Supported	Notes
`InitiateMultipartUploadResult`	Yes	None
`Bucket`	Yes	None
`Key`	Yes	None
`UploadId`	Yes	None

Sample request and response

This example starts a multipart upload. The response The response returns a 200 OK, which means the request was successful. The response also returns an upload ID.

Request

POST /example-object?uploads HTTP/1.1

Host: example-bucket.s3.amazonaws.com

Date: Mon, 1 Nov 2010 20:34:56 GMT

Authorization: authorization string

Response

HTTP/1.1 200 OK

x-amz-id-2: Uuag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg== x-amz-request-id: 656c76696e6727732072657175657374

Date: Mon, 1 Nov 2010 20:34:56 GMT

Content-Length: 197

Connection: keep-alive

Server: Himalaya

<?xml version="1.0" encoding="UTF-8"?>

<Bucket>example-bucket</Bucket>

<Key>example-object</Key>

<UploadId>VXBsb2FkIElEIGZvciA2aWWpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA</UploadId>

</InitiateMultipartUploadResult>

Special errors

None.

Related operations

2.16.1 Abort Multipart Upload
2.16.2 Complete Multipart Upload
2.16.4 List Multipart Uploads

2.16.4 List Multipart Uploads

List in-progress multipart uploads.

Permissions

The s3:ListBucketMultipartUploads (or READ ACL) permission is needed to list multipart uploads for a bucket.

Requests

Syntax

GET /?uploads HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

Table 69: List Multipart Upload request parameters

Parameters	Supported	Notes
delimiter	Yes	None
encoding-type	Yes	None
max-uploads	Yes	None
key-marker	Yes	None
prefix	Yes	None
upload-id-marker	Yes	None

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 70: List Multipart Upload response elements

Elements	Supported	Notes
ListMultipartUploadsResult	Yes	None
Bucket	Yes	None
KeyMarker	Yes	None
UploadIdMarker	Yes	None
NextKeyMarker	Yes	None
NextUploadIdMarker	Yes	None
Encoding-Type	Yes	None
MaxUploads	Yes	None
IsTruncated	Yes	None
Upload	Yes	None
Key	Yes	None
UploadId	Yes	None
Initiator	Yes	None
ID	Yes	None
DisplayName	Yes	None
Owner	Yes	None
StorageClass	Yes	None
Initiated	Yes	None
ListMultipartUploadsResult.Prefix	Yes	None
Delimiter	Yes	None
CommonPrefixes	Yes	None
CommonPrefixes.Prefix	Yes	None

Sample request and response

The following tables show an example of the request and response operations for List Multipart Upload.

The request compiles a list of in-progress multipart uploads. The response returns a 200 OK, which means the request was successful.

Request

GET /?uploads&max-uploads=3 HTTP/1.1

Host: example-bucket.s3.amazonaws.com

Date: Mon, 1 Nov 2010 20:34:56 GMT

Authorization: authorization string

Response

HTTP/1.1 200 OK

x-amz-id-2: Uuag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg== x-amz-request-id: 656c76696e6727732072657175657374

Date: Mon, 1 Nov 2010 20:34:56 GMT

Content-Length: 1330 Connection: keep-alive Server: Himalaya

<?xml version="1.0" encoding="UTF-8"?>

<Bucket>bucket</Bucket>

<NextKeyMarker>my-movie.m2ts</NextKeyMarker>

<NextUploadIdMarker>YW55IGlkZWEgd2h5IGVsdmluZydzIHVwbG9hZCBmYWlsZWQ</ NextUploadIdMarker>

<Key>my-divisor</Key>

<UploadId>XMgbGlrZSBlbHZpbmcncyBub3QgaGF2aW5nIG11Y2ggbHVjaw</UploadId>

</Initiator>

<Owner>

<ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>

<DisplayName>OwnerDisplayName</DisplayName>

</Owner>

<<StorageClass>STANDARD</StorageClass>

</Upload>

<Key>my-movie.m2ts</Key>

<UploadId>VXBsb2FkIElEIGZvciBlbHZpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZA</UploadId>

<DisplayName>InitiatorDisplayName</DisplayName>

</Initiator>

<Owner>

<DisplayName>OwnerDisplayName</DisplayName>

</Owner>

<StorageClass>STANDARD</StorageClass>

</Upload>

<Key>my-movie.m2ts</Key>

<UploadId>YW55IGlkZWEgd2h5IGVsdmluZydzIHVwbG9hZCBmYWlsZWQ</UploadId>

<ID>arn:aws:iam::444455556666:user/user1-22222a31-17b5-4fb7-9df5-b222222f13de</

ID>

</Initiator>

<Owner>

<DisplayName>OwnerDisplayName</DisplayName>

</Owner>

<StorageClass>STANDARD</StorageClass>

</Upload>

</ListMultipartUploadsResult>

Special errors

None.

Related operations

2.16.1 Abort Multipart Upload
2.16.2 Complete Multipart Upload
2.16.3 Initiate Multipart Upload

2.16.5 List Parts

Get a list of the parts that have been uploaded for a specific multipart upload.

Permissions

The s3:ListMultipartUploadParts permission is needed to list parts.

Requests

Syntax

GET /objectname?uploadId=uploadid HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

Table 71: List Parts request parameters

Parameters	Supported	Notes
encoding-type	Yes	None
max-parts	Yes	None
part-number-marker	Yes	None
uploadId	Yes	None

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

Table 72: List Parts response headers

Header	Supported	Notes
x-amz-abort-date	Yes	None
x-amz-abort-rule-id	Yes	None

Elements

Table 73: List Parts response elements

Elements	Supported	Notes
ListPartsResult	Yes	None
Bucket	Yes	None
Encoding-Type	Yes	None
Key	Yes	None
UploadId	Yes	None
Initiator	Yes	None
ID	Yes	None
DisplayName	Yes	None
Owner	Yes	None
StorageClass	Yes	None
PartNumberMarker	Yes	None
NextPartNumberMarker	Yes	None
MaxParts	Yes	None
IsTruncated	Yes	None
Part	Yes	None
Owner	Yes	None
PartNumber	Yes	None
LastModified	Yes	None
ETag	Yes	None
Size	Yes	None

Sample request and response

The following tables show an example request/response for a List Parts operation.

The request compiles a list of the parts that have been uploaded in a specific multipart upload. The response returns a 200 OK, which means the request was successful. The response also displays the list.

Request

GET /example-object? uploadId=XXBsb2FkIElEIGZvciBlbHZpbmcncyVcdS1tb3ZpZS5tMnRzEEEwbG9hZA&max-parts=2&part-number-marker=1 HTTP/1.1

Host: example-bucket.s3.amazonaws.com

Date: Mon, 1 Nov 2010 20:34:56 GMT

Authorization: authorization string

Response

HTTP/1.1 200 OK

x-amz-id-2: Uuag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg== x-amz-request-id: 656c76696e6727732072657175657374

Date: Mon, 1 Nov 2010 20:34:56 GMT

Content-Length: 985 Connection: keep-alive Server: AmazonS3

<?xml version="1.0" encoding="UTF-8"?>

<Bucket>example-bucket</Bucket>

<Key>example-object</Key>

<UploadId>XXBsb2FkIElEIGZvciBlbHZpbmcncyVcdS1tb3ZpZS5tMnRzEEEwbG9hZA</UploadId>

</Initiator>

<Owner>

<ID>75aa57f09aa0c8caeab4f8c24e99d10f8e7faeebf76c078efc7c6caea54ba06a</ID>

<DisplayName>someName</DisplayName>

</Owner>

<StorageClass>STANDARD</StorageClass>

<Part>

<LastModified>2010-11-10T20:48:34.000Z</

LastModified><ETag>"7778aef83f66abc1fa1e8477f296d394"</ETag>

</Part>

<Part>

<ETag>"aaaa18db4cc2f85cedef654fccc4a4x8"</ETag>

</Part>

</ListPartsResult>

Special errors

None.

Related operations

2.16.5 List Parts
2.16.6 Upload Part
2.16.7 Upload Part-Copy

2.16.6 Upload Part

Upload a part in a multipart upload.

Permissions

The s3:PutObject (or WRITE ACL) permission is needed to upload parts.

Requests

Syntax

PUT /objectname?partNumber=partnumber&uploadId=uploadid HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

Content-Length: lengthcontent

Parameters

None.

Headers

Table 74: Upload Part request headers

Header	Supported	Notes
x-amz-checksum-*	No	By default, this parameter is not allowed because only the MD5 sum is supported as a data integrity check.
x-amz-server-side-encryption-customer-algorithm	No	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key	No	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key-MD5	No	Customer-provided encryption keys are not supported.

Elements

None.

Responses

Headers

Note: The header x-amz-checksum-* is not supported. By default, this parameter is not allowed because only the MD5 sum is supported as a data integrity check.

Table 75: Upload Part response headers

Header	Supported	Notes
x-amz-server-side-encryption	Yes	None
x-amz-server-side-encryption-aws-kms-key-id	N/A	The encryption algorithm `aws:kms` is not supported.
x-amz-server-side-encryption-customer-algorithm	N/A	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key-MD5	N/A	Customer-provided encryption keys are not supported.

Elements

None.

Sample request and response

The following tables show an example of the request and response operations for Upload Part.

The request uploads the my-movie.m2ts file to the example-bucket bucket. The response returns a 200 OK, which means the request was successful.

Request

PUT /my-movie.m2ts? partNumber=1&uploadId=VCVsb2FkIElEIGZvciBlbZZpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZR

HTTP/1.1

Host: example-bucket.s3.amazonaws.com

Date: Mon, 1 Nov 2010 20:34:56 GMT

Content-Length: 10485760

Content-MD5: pUNXr/BjKK5G2UKvaRRrOA==

Authorization: authorization string

***part data omitted***

Response

HTTP/1.1 200 OK

x-amz-id-2: Vvag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg== x-amz-request-id: 656c76696e6727732072657175657374

Date: Mon, 1 Nov 2010 20:34:56 GMT

ETag: "b54357faf0632cce46e942fa68356b38"

Content-Length: 0

Connection: keep-alive

Server: Himalaya

Special errors

Table 76: Upload Part special errors

Error message	Description	HTTP status code
NoSuchUpload	The upload cannot be completed.	404 Not Found

Related operations

2.16.1 Abort Multipart Upload
2.16.2 Complete Multipart Upload
2.16.3 Initiate Multipart Upload

2.16.7 Upload Part-Copy

Upload a part by copying data from an existing object.

Permissions

These permissions are needed to upload part copies:

s3:PutObject (or WRITE ACL) for the destination object.
s3:GetObject (or READ ACL) for the source object if x-amz-copy-source does not include a version id.
s3:GetObjectVersion (or READ ACL) for the source object if x-amz-copy-source does include a version id.
Optional : s3:ListBucket (or READ ACL) for the source bucket to get a 404 instead of 403 if the source object isn’t found.

Requests

Syntax

PUT /objectname?partNumber=partnumber&uploadId=uploadid HTTP/1.1

Host: bucket name.s3.amazonaws.com

Date: date

Authorization: authorization string

x-amz-copy-source: /sourcebucketname/sourceobjectname

Parameters

None.

Headers

Table 77: Upload Part-Copy request headers

Header	Supported	Notes
x-amz-copy-source	Yes	None
x-amz-copy-source-if-match	Yes	None
x-amz-copy-source-if-modified-since	Yes	None
x-amz-copy-source-if-none-match	Yes	None
x-amz-copy-source-if-unmodified-since	Yes	None
x-amz-copy-source-server-side-encryption-customer-algorithm	No	Customer-provided encryption keys are not supported.
x-amz-copy-source-server-side-encryption-customer-key	No	Customer-provided encryption keys are not supported.
x-amz-copy-source-server-side-encryption-customer-key-MD5	No	Customer-provided encryption keys are not supported.
x-amz-meta-*	Yes	Some limitations apply.
x-amz-metadata-directive	Yes	None
x-amz-server-side-encryption	Yes	The value AES256 is supported. The value aws:kms is not supported.
x-amz-server-side-encryption-aws-kms-key-id	No	The encryption algorithm `aws:kms` is not supported.
x-amz-server-side-encryption-context	No	The encryption algorithm `aws:kms` is not supported.
x-amz-server-side-encryption-customer-algorithm	No	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key	No	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key-MD5	No	Customer-provided encryption keys are not supported.

Elements

None.

Responses

Headers

Table 78: Upload Part-Copy response headers

Header	Supported	Notes
x-amz-copy-source-version-id	Yes	None
x-amz-server-side-encryption	Yes	None
x-amz-server-side-encryption-aws-kms-key-id	N/A	The encryption algorithm aws:kms is not supported.
x-amz-server-side-encryption-customer-algorithm	N/A	Customer-provided encryption keys are not supported.
x-amz-server-side-encryption-customer-key-MD5	N/A	Customer-provided encryption keys are not supported.

Elements

Table 79: Upload Part-copy response elements

Element	Supported	Notes
CopyPartResult	Yes	None
ETag	Yes	None
LastModified	Yes	None

Sample request and response

The following tables show an example of the request and response operations for Upload Part-Copy.

The request uploads the newobject file to the target-bucket bucket. The response returns a 200 OK, which means the request was successful.

Request

PUT /newobject? partNumber=2&uploadId=VCVsb2FkIElEIGZvciBlbZZpbmcncyBteS1tb3ZpZS5tMnRzIHVwbG9hZR

HTTP/1.1

Host: target-bucket.s3.amazonaws.com Date: Mon, 11 Apr 2011 20:34:56 GMT

x-amz-copy-source: /source-bucket/sourceobject x-amz-copy-source-range:bytes=500-6291456 Authorization: authorization string

Response

HTTP/1.1 200 OK

x-amz-id-2: Vvag1LuByRx9e6j5Onimru9pO4ZVKnJ2Qz7/C1NPcfTWAtRPfTaOFg== x-amz-request-id: 656c76696e6727732072657175657374

Date: Mon, 11 Apr 2011 20:34:56 GMT

Server: AmazonS3

</CopyPartResult>

Special errors

Table 80: Upload Part-Copy special errors

Error Message	Description	HTTP Status Code
NoSuchUpload	The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.	404 Not Found
InvalidObjectState	The object is stored on Cold Storage and must be restored (see ActiveScale Management S3 API) before GET requests can be issued.	403 Forbidden
InvalidRequest	The specified copy source is not supported as a byte-range copy source.	400 Bad Request

Related operations

2.16.1 Abort Multipart Upload
2.16.2 Complete Multipart Upload
2.16.6 Upload Part

2.17 Service Operations

This section contains reference information about ActiveScale S3 API service operations.

2.17.1 GET Service

Get a list of all buckets owned by the authenticated sender of the request.

Permissions

These permissions are needed to list an account's buckets:

s3:ListAllMyBuckets
Must be an authenticated identity (not anonymous).

Requests

Syntax

GET / HTTP/1.1

Host: s3.amazonaws.com

Date: date

Authorization: authorization string

Parameters

None.

Headers

This operation uses common request headers only.

Elements

None.

Responses

Headers

This operation uses common response headers only.

Elements

Table 81: GET Service response elements

Element	Supported	Notes
Bucket	Yes	None
Buckets	Yes	None
CreationDate	Yes	None
DisplayName	Yes	None
ID	Yes	None
ListAllMyBucketsResult	Yes	None
Name	Yes	None
Owner	Yes	None

Sample request and response

The following tables show an example request/response for a GET Service operation.

Request

GET / HTTP/1.1

Host: s3.amazonaws.com

Date: Wed,01 Mar 2006 12:00:00 GMT

Authorization: authorization string

Response

<?xml version="1.0" encoding="UTF-8"?>

<Owner>

<DisplayName>webfile</DisplayName>

</Owner>

<Name>quotes</Name>

</Bucket>

<Name>samples</Name>

</Bucket>

</Buckets>

</ListAllMyBucketsResult>

Special errors

None.

Related operations

2.6.9 GET Bucket (list objects) v1
2.11.1 GET Object

3.0 S3 Error Codes

3.1 Error Codes

The table below enumerates all error codes the ActiveScale S3 API may send, and includes codes not sent by AWS S3.

Table 82: Error codes

Error code	Description	HTTP status code
AccessDenied	Access is denied.	403 Forbidden
AccountProblem	There is a problem with your AWS account that prevents the operation from completing successfully. Use Contact Us for help.	403 Forbidden
AccountRequiredForAccess ControlTranslationOwner	The account must be specified if the Owner in `AccessControlTranslation` has a value.	400 Bad Request
ACPCannedACLAndGrantHeader	Canned ACLs and Header Grants were specified. This is not allowed.	400 Bad Request
ACPInvalidArgumentFormat	The argument format was not recognized.	400 Bad Request
ACPInvalidCannedACL	An invalid Canned ACL was found.	400 Bad Request
ACPInvalidGroupURI	An invalid group URI was found.	400 Bad Request
ACPInvalidID	An invalid ID was found.	400 Bad Request
ACPTooManyGrants	The request specified more grants than are allowed.	400 Bad Request
AmbiguousGrantByEmailAddress	The e-mail address you provided is associated with more than one account. Retry your request using a different identification method after resolving the ambiguity.	400 Bad Request
AnonymousAccessForbidden	Anonymous access is forbidden for this operation.	403 Forbidden
AuthorizationComponentMalformed	The authorization header is malformed. The authorization component `“<component>`” is malformed.".	400 Bad Request
AuthorizationHeaderNeedsOneSpace	An invalid authorization header was found. Only one ' ' (space) is required.	400 Bad Request
AuthorizationHeaderRequiresThreeComponents	The authorization header is malformed. The authorization header requires three components, `Credential`, `SignedHeaders`, and `Signature`.	400 Bad Request
AuthorizationHeadersNotSigned	There were headers present in the request which were not signed.	403 Forbidden
AWSAuthenticationRequiresDate	The AWS authentication operation requires a valid `Date` or `x-amz-date` header.	403 Forbidden
BadDigest	The `Content-MD5` element you specified did not match what we received.	400 Bad Request
BadDigestClient	The `Content-MD5` you specified does not match what we received.	400 Bad Request
BadOptionsRequest	There is insufficient information in the request. The origin request header is needed.	400 Bad Request
BadReplicaChecksum	The replica checksum that was specified did not match what we received.	400 Bad Request
BadRequest	An error occurred while parsing the HTTP request.	400 Bad Request
BadRequestInvalidURI	The specified URL could not be parsed.	400 Bad Request
BucketAlreadyExists	The requested bucket name is not available. The bucket name space is shared by all users of the system. Select a different name and try again.	409 Conflict
BucketAlreadyOwnedByYou	Your previous request to create the named bucket succeeded and you already own it. You will get this error in all AWS regions except the US East (N. Virginia) region, `us-east-1`. In the `us-east-1` region, you will get a 200 OK status code, but it is no-op (if bucket exists, Amazon S3 will not do anything)	409 Conflict (in all regions except the US East (N. Virginia) region).
BucketLifecycleActionDateMustBeMidnightGMT	Some overlapping prefixes were found.	400 Bad Request
BucketLifecycleActionDateNotBeforeEpoch	The `'Date'` parameter must be no earlier than 1970-01-01T00:00:00.000Z.	400 Bad Request
BucketLifecycleActionDaysMustBePositiveInteger	A bucket lifecycle action days that was provided must be a positive integer.	400 Bad Request
BucketLifecycleActionNotImplemented	A bucket lifecycle action that was provided implies functionality that is not implemented.	501 Not Implemented
BucketLifecycleOverlappingPrefixesForSameActionType	Overlapping prefixes were found.	400 Bad Request
BucketLifecycleRuleIDMustBeUnique	Rule ID must be unique. The same ID was found for more than one rule.	400 Bad Request
BucketLifecycleRuleIDTooLong	The ID length should not exceed allowed limit of 255.	400 Bad Request
BucketLifecycleRuleNeedsAtLeastOneAction	At least one action has to be specified in a rule.	400 Bad Request
BucketLifecycleRulePrefixTooLong	The specified prefix is longer than maximum allowed key length of 1024.	400 Bad Request
BucketLifecycleRulesWithSamePrefix	The same prefix was found in two rules.	400 Bad Request
BucketNotEmpty	The bucket you tried to delete is not empty.	409 Conflict
BucketNotVersioningEnabled	This operation requires versioning to be enabled on the target bucket.	409 Conflict
CannotChangeVersioningStateIfReplicationIsEnabled	A replication configuration is present on this bucket, so the versioning state cannot be changed. To change the versioning state, first delete the replication configuration.	409 Conflict
CannotSetBothRangeAndPartnumber	Cannot specify both the `Range` header and the `partNumber` query parameter	400 Bad Request
ChangingReplicaOwnerNotSupported	Changing the owner of a replicated object is not supported.	501 Not Implemented
Content_MD5_Missing	A required header for the request `Content-MD5` was missing.	400 Bad Request
CopyIllegalCopyHeader	An illegal copy header was found.	400 Bad Request
CopyInvalidSource	The `Copy Source` element must specify the source bucket and key in the elements `sourcebucket` and `sourcekey`.	400 Bad Request
CopyInvalidSourceEncoding	Invalid copy source encoding was found.	400 Bad Request
CopyInvalidSourceParameter	An unsupported `copy source` parameter was found.	400 Bad Request
CopyInvalidSourceRange	The `x-amz-copy-source-range` value must be in a certain format. Bytes should be first-last, where first and last are the zero-based offsets of the first and last bytes to copy.	400 Bad Request
CopyInvalidSourceUri	An invalid copy source URI was found.	400 Bad Request
CopySourceTooBig	The specified copy source is larger than the maximum allowable size.	400 Bad Request
CredentialDateNotSameAsXamzDate	Invalid credential date.	400 Bad Request
CredentialsNotSupported	This request does not support credentials that were provided.	400 Bad Request
CrossLocationLoggingProhibited	Cross-location logging is not allowed. Buckets in one geographic location cannot log information to a bucket in another location.	403 Forbidden
EmptyContentSha256	The provided `x-amz-content-sha256` header must be a valid SHA256.	400 Bad Request
EmptyOrNullReplicationDestinationBucket	The destination bucket cannot be null or empty.	400 Bad Request
EmptyVersionId	The `Version-Id` string cannot must contain a value.	400 Bad Request
EmptyVersionIdMarker	A `version-id` marker cannot be empty.	400 Bad Request
EncryptionDisallowed	Access is denied. The message header `x-amz-server-side-encryption` is not allowed.	403 Forbidden
EncryptionRequired	Access is denied. The message header `x-amz-server-side-encryption` is required.	403 Forbidden
EntityTooLarge	Your proposed upload exceeds the maximum allowed object size.	400 Bad Request
EntityTooSmall	Your proposed upload is smaller than the minimum allowed object size.	400 Bad Request
ExpiredToken	The provided token has expired.	400 Bad Request
IllegalLocationConstraint	The location constraint is incompatible for the region specific endpoint this request was sent to.	400 Bad Request
IllegalVersioningConfigurationException	Indicates that the versioning configuration specified in the request is invalid.	400 Bad Request
InappropriateReplicationVersionId	The version ID that was provided cannot be replicated with this operation.	400 Bad Request
IncompleteBody	You did not provide the number of bytes specified in the `Content-Length` HTTP header.	400 Bad Request
IncompleteBodyBodyTerminatedUnexpectedly	The request body terminated unexpectedly.	400 Bad Request
IncorrectNumberOfFilesInPostRequest	The `POST` operation requires exactly one file upload per request.	400 Bad Request
InlineDataTooLarge	The in-line data exceeds the maximum size allowed.	400 Bad Request
InsufficientStorage	The storage is full.	507 Insufficient Storage
InternalError	An internal error was encountered. Try again.	500 Internal Server Error
InvalidAccessKeyId	The AWS access key ID you provided does not exist in our records.	403 Forbidden
InvalidAccountId	The account must contain a valid `AccountId`.	400 Bad Request
InvalidAddressingHeader	You must specify the anonymous role.	N/A
InvalidArgument	Invalid Argument.	400 Bad Request
InvalidArgument	An invalid argument was provided.	400 Bad Request
InvalidArgument	An invalid replica checksumwas specified.	400 Bad Request
InvalidArgument	The ARN is not well-formed.	400 Bad Request
InvalidArgument	The notification destination service region is not valid for the bucket location constraint.	400 Bad Request
InvalidArgument	The event is not supported for notifications.	400 Bad Request
InvalidArgument	There are overlapping configurations. Configurations on the same bucket cannot share a common event type.	400 Bad Request
InvalidArgument	The ID length exceeded allowed limit of `<max id size>`.	400 Bad Request
InvalidArgument	Same ID is used for multiple configurations. IDs must be unique.	400 Bad Request
InvalidArgument	The filter rule name must be either prefix or suffix.	400 Bad Request
InvalidArgument	The filter rule value must be empty.	400 Bad Request
InvalidArgument	Cannot specify more than one prefix rule in a filter.	400 Bad Request
InvalidArgument	Cannot specify more than one suffix rule in a filter.	400 Bad Request
InvalidArgument	Configuration is ambiguously defined. Cannot have overlapping suffixes in two rules if the prefixes are overlapping for the same event type.	400 Bad Request
InvalidArgument	The storage class specified is unsupported	400 Bad Request
InvalidArgument	Unable to validate the destination configurations.	400 Bad Request
InvalidArgumentBucketName	The specified bucket is not valid.	400 Bad Request
InvalidArgumentGlacier	GLACIER is not allowed.	400 Bad Request
InvalidBucketARN	The ARN for the bucket is invalid.	400 Bad Request
InvalidBucketName	The specified bucket is not valid.	400 Bad Request
InvalidBucketState	The request is not valid because of the current state of the bucket.	409 Conflict
InvalidChunkSizeError	Only the last chunk is allowed to have a size less than 8192 bytes.	403 Forbidden
InvalidContentSha256	x-amz-content-sha256 must be `UNSIGNED-PAYLOAD`, `STREAMING-AWS4-HMAC-SHA256-PAYLOA`D, or a valid SHA256 value.	400 Bad Request
InvalidCopySourceMethod	Only a copy source header can be specified for a copy request.	400 Bad Request
InvalidCopyToSelf	This copy request is illegal because it is trying to copy an object to itself without changing the metadata, storage class, website redirect location, or encryption attributes.	400 Bad Request
InvalidDate	An invalid date was found. This should be seconds since epoch.	403 Forbidden
InvalidDelimiter	An invalid delimiter was found.	400 Bad Request
InvalidDigest	The `Content-MD5` you specified was invalid.	400 Bad Request
InvalidEncodingMethod	There is an invalid encoding method specified in the request.	400 Bad Request
InvalidEncryptionAlgorithmError	The encryption request you specified is not valid. The valid value is `AES256`.	400 Bad Request
InvalidEncryptionMethod	The encryption method specified is not supported.	400 Bad Request
InvalidHeaderForContext	The specified header is not valid in this context.	400 Bad Request
InvalidHeaderValue	An invalid header value was found.	400 Bad Request
InvalidKeyMarker	An invalid key marker was found.	400 Bad Request
InvalidLocationConstraint	The specified location constraint is not valid. For more information about regions, see How to Select a Region for Your Buckets.	400 Bad Request
InvalidMarker	An invalid marker was found.	400 Bad Request
InvalidMaxKeys	The `max-keys` parameter that was provided is not an integer or within integer range.	400 Bad Request
InvalidMaxUploads	The `max-uploads` element that was provided is not an integer or it is not within integer range.	400 Bad Request
InvalidMetadataDirective	An unknown metadata directive was found.	400 Bad Request
InvalidObjectState	The operation is not valid because of the current state of the object.	403 Forbidden
InvalidPart	One or more of the specified parts could not be found. The part might not have been uploaded, or the specified entity tag might not have matched the part's entity tag.	400 Bad Request
InvalidPartNumber	The part number is invalid. A part number must be an integer between 1 and 10000, inclusive.	400 Bad Request
InvalidPartOrder	The list of parts was not in ascending order. Lists must be specified in order by part number.	400 Bad Request
InvalidPayer	All access to this object has been disabled.	403 Forbidden
InvalidPolicyDocument	The content of the form does not meet the conditions specified in the policy document.	400 Bad Request
InvalidPrefix	An invalid prefix was found.	400 Bad Request
InvalidRange	The requested range cannot be satisfied.	416 Requested Range Not Satisfiable
InvalidRedirectLocation	The website redirect location must have a prefix of http:// or https:// or /.	400 Bad Request
InvalidRedirectLocation_TooLong	The length of the website redirect location cannot exceed 2,048 characters.	400 Bad Request
InvalidReplicationStatus	The replication status you provided is valid, but it is not allowed.	400 Bad Request
InvalidRequest	S3 Transfer Acceleration is not supported for buckets with non-DNS compliant names.	400 Bad Request
InvalidRequest	S3 Transfer Acceleration is not supported for buckets with periods (.) in their names.	400 Bad Request
InvalidRequest	S3 Transfer Accelerate endpoints support only virtual style requests.	400 Bad Request
InvalidRequest	SOAP requests must be made over an HTTPS connection.	400 Bad Request
InvalidRequest	Use `AWS4-HMAC-SHA256` as your encryption scheme.	400 Bad Request
InvalidRequest	`S3 Transfer Accelerate` is not configured on this bucket.	400 Bad Request
InvalidRequest	`S3 Transfer Accelerate` is disabled on this bucket.	400 Bad Request
InvalidRequest	`S3 Transfer Acceleration` is not supported on this bucket. Contact AWS support for more information.	400 Bad Request
InvalidRequest	`S3 Transfer Acceleration` cannot be enabled on this bucket. Contact AWS support for more information.	400 Bad Request
InvalidRequest	SOAP requests must be made over an HTTPS connection.	400 Bad Request
InvalidRequest	Too many configurations submitted. The maximum number of configurations is `<max num configurations>`.	400 Bad Request
InvalidRuleId	The rule ID cannot be greater than 1000.	400 Bad Request
InvalidSecurity	The provided security credentials are not valid.	403 Forbidden
InvalidSiteId	An invalid site ID was specified.	400 Bad Request
InvalidSiteIdAndStatusCombination	The replication-site-id (`<site id>`) and replication-desired-status (`<status>`) combination is invalid.	400 Bad Request
InvalidSOAPRequest	The provided SOAP request body is invalid.	400 Bad Request
InvalidStorageClass	The storage class you specified is not valid.	400 Bad Request
InvalidTargetBucketForLogging	The target bucket for logging does not exist, is not owned by you, or does not have the appropriate grants for the log-delivery group.	400 Bad Request
InvalidToken	The provided token is malformed or otherwise invalid.	400 Bad Request
InvalidUploadIdMarker	There is an invalid uploadId marker specified in the request.	400 Bad Request
InvalidURI	The URI that was specified could not be parsed.	400 Bad Request
InvalidURI_EOF	The specified URI could not be parsed.	400 Bad Request
InvalidURI_isHexDigit	The specified URI could not be parsed.	400 Bad Request
InvalidV2AuthorizationHeader	An invalid AWS authorization header was found. An `AwsAccessKeyId:signature` was expected.	400 Bad Request
InvalidValue	The value must be a sequence of Unicode characters which cannot include null.	400 Bad Request
InvalidVersionId	An invalid version ID was specified.	400 Bad Request
KeyTooLong	The key that was provided key is too long.	400 Bad Request
MalformedACLError	The XML you provided was not well-formed or did not validate against our published schema.	400 Bad Request
MalformedPOSTRequest	The body of your `POST` request is not well-formed multipart form-data.	400 Bad Request
MalformedXML	The user sent malformed XML for the configuration. The error message is `The XML you provided was not well- formed or did not validate against our published schema.`	400 Bad Request
MaxMessageLengthExceeded	The request that was provided was too large.	400 Bad Request
MaxNumberOfReplicationRulesExceeded	The number of defined replication rules cannot exceed.	400 Bad Request
MaxPostPreDataLengthExceededError	The `POST` request fields preceding the upload file were too large.	400 Bad Request
MetadataInContext	The metadata cannot be specified in this context.	400 Bad Request
MetadataTooLarge	Your metadata headers exceed the maximum allowed metadata size.	400 Bad Request
MethodNotAllowed	The specified method is not allowed for this resource.	405 Method Not Allowed
MissingAttachment	A SOAP attachment was expected, but none were found.	N/A
MissingAuthorizationCredential	The authorization header is malformed. It is missing the `Credential` component.	400 Bad Request
MissingAuthorizationSignature	The authorization header is malformed. It is missing the `Signature` component.	400 Bad Request
MissingAuthorizationSignedHeaders	The authorization header is malformed. It is missing the `SignedHeaders` component.	400 Bad Request
MissingContentLength	You must provide the `Content-Length` HTTP header.	411 Length Required
MissingContentSha256	There is a missing required `x-amz-content-sha256` header for this request.	400 Bad Request
MissingRequestBodyError	The user sent an empty XML document as a request. The error message is `Request body is empty.`	400 Bad Request
MissingSecurityElement	The SOAP 1.1 request is missing a security element.	400 Bad Request
MissingSecurityHeader	The request is missing a required header.	400 Bad Request
MultipartAlreadyInitialized	Multipart is already initialized for the requested object version.	409 Conflict
MultipartReplicaVersionIdNotAvailable	The destination bucket cannot be null or empty.	409 Conflict
NoLoggingStatusForKey	There is no such thing as a logging status subresource for a key.	400 Bad Request
NonEmptyBody	The request included a body. Requests of this type must not include a non-empty body.	400 Bad Request
NonEmptyReplicationRulePrefix	The rule prefix must be empty.	400 Bad Request
NonOverridableResponseHeader	The given parameter `<name>` is not in the set of overridable response headers. Refer to the S3 API documentation for a complete list of overridable response headers. https://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html	400 Bad Request
NoPartsSpecified	At least one part must be specified.	400 Bad Request
NoSuchBucket	The specified bucket does not exist.	404 Not Found
NoSuchBucketPolicy	The specified bucket does not have a bucket policy.	404 Not Found
NoSuchCORSConfiguration	The CORS configuration does not exist.	404 Not Found
NoSuchKey	The specified key does not exist.	404 Not Found
NoSuchLifecycleConfiguration	The specified lifecycle configuration does not exist.	404 Not Found
NoSuchObjectLockConfiguration	The object does not have a lock configuration	404 Not Found
NoSuchTagSet	The TagSet does not exist.	404 Not Found
NoSuchUpload	The specified multipart upload does not exist. The upload ID might be invalid, or the multipart upload might have been aborted or completed.	404 Not Found
NoSuchVersion	The version ID specified in the request does not match an existing version.	404 Not Found
NoSuchWebsiteConfiguration	The specified bucket does not have a website configuration.	404 Not Found
NotAllReplicationHeadersProvided	Not all required replication headers were provided.	400 Bad Request
NotAllV4QueryParametersProvided	Query-string authentication version 4 requires the `X-Amz-Algorithm, X-Amz-Credential, X-Amz-Signature, X-Amz-Date, X-Amz-SignedHeaders`, and `X-Amz-Expire`s parameters.	400 Bad Request
NotificationNotActivated OnSystemError	The notification is not activated on the system.	400 Bad Request
NotImplemented	A header you provided implies functionality that is not implemented	501 Not Implemented
NotModified	An invalid precondition header was found.	400 Bad Request
NotSignedUp	Your account has not been signed up for the Amazon S3 service. You must sign up before you can use Amazon S3. You can sign up at https://aws.amazon.com/s3.	403 Forbidden
NoVersionsStatusForKey	There is no such thing as the `? versions` sub-resource for a key.	400 Bad Request
ObjectsNotEquivalent	The object is not equivalent to the original.	409 Conflict
ObjectLockConfigurationNotFoundError	The bucket does not have an object lock configuration	404 Not Found
OnlyOneAuthMechanismAllowed	Only one authorization element is allowed. The element would be either the `X-Amz-Algorithm` query parameter, the `Signature` query string parameter, or the `Authorization` header should be specified.	400 Bad Request
OnlyOneEncryptionAlgorithmAllowed	The encryption request you specified is not valid. Only one encryption algorithm can be specified.	400 Bad Request
OnlyOneMetadataDirectiveAllowed	Only one value should be specified.	400 Bad Request
OnlyOneWebsiteRedirectLocationAllowed	Only one header for website redirect location may be specified.	400 Bad Request
OperationAborted	A conflicting conditional operation is currently in progress for this resource. Try the operation again.	409 Conflict
PermanentRedirect	The bucket you are attempting to access must be addressed using the specified endpoint. Send all future requests to this endpoint.	301 Moved Permanently
PreconditionFailed	At least one of the preconditions you specified did not hold.	412 Precondition Failed
QueryAuthenticationRequiresParameters	The Query-string authentication operation requires the `Signature`, `Expires`, and `AWSAccessKeyId` parameters.	403 Forbidden
QueryParamNotImplemented	A query parameter implies functionality that is not implemented.	400 Bad Request
QuotaExceeded	Request refused due to account quota restrictions.	403 Forbidden
RangeIsNotSupportedInCopy	The `RANGE` parameter is not supported in `Copy`.	400 Bad Request
RangeNotSatisfiable	The requested part number is not satisfiable	416 Requested Range Not Satisfiable
Redirect	The data has been temporarily redirected.	307 Temporary Redirect
ReplicaKmsKeyIDRequiredForSseKmsEncryptedObjects	The `ReplicaKmsKeyID` must be specified if the `SseKmsEncryptedObjects` tag is present.	400 Bad Request
ReplicaKmsKeyIDRequiredInEncryptionConfiguration	The `ReplicaKmsKeyID` tag must be specified in the encryption configuration.	400 Bad Request
ReplicationConfigurationNotFoundError	The replication configuration was not found.	404 Not Found
ReplicationNotActivatedOnSystemError	Replication is not activated on the system.	400 Bad Request
ReplicationOfKmsEncryptedObjectsNotSupported	Replication of KMS-encrypted objects is not supported.	501 Not Implemented
ReplicationSourceBucketNotVersioningEnabled	Versioning must be enabled on the bucket to apply a replication configuration.	400 Bad Request
ReplicationStatusNotAllowed	The replication status that you provided is invalid.	400 Bad Request
RequestExpired	The request has expired.	403 Forbidden
RequestIsNotMultiPartContent	The `BucketPOST` operation must be enclosure-type multipart form-data.	400 Bad Request
RequestPartNumberOfBucket	A key must be specified.	400 Bad Request
RequestTimeout	The socket connection to the server was not read from or written to within the timeout period. Idle connections are closed.	400 Bad Request
RequestTimeTooSkewed	The difference between the request time and the server time is too large.	403 Forbidden
RequestTorrentOfBucketError	Requesting the torrent file of a bucket is not permitted.	400 Bad Request
RequestUploadIdOfBucket	A key must be specified.	400 Bad Request
RestoreAlreadyInProgress	The restoration of the object is already in progress.	409 Conflict
ServiceUnavailable	Reduce your request rate.	503 Service Unavailable
ServerSideEncryptionConfigurationNotFoundError	The bucket does not have encryption configuration	404 Not Found
SignatureDoesNotMatch	The request signature we calculated does not match the signature you provided. Check your AWS secret access key and signing method.	403 Forbidden
SlowDown	Reduce your request rate.	503 Service Unavailable
SmallPartNumber	The part number must be equal to or greater than one.	400 Bad Request
SourceCopyMayNotBeDeleteMarker	The source of a copy request may not specifically refer to a delete marker by version ID.	400 Bad Request
SseKmsEncryptedObjectsRequiredForEncryptionConfiguration	The `SseKmsEncryptedObjects` must be specified if the encryption configuration is present.	400 Bad Request
SseKmsEncryptedObjectsRequiredInSourceSelectionCriteria	The account must be specified if the Owner in `AccessControlTranslation` has a value.	400 Bad Request
StorageClassNotSupportedForReplication	The storage class is not supported for replication.	400 Bad Request
TemporaryRedirect	You are being redirected to the bucket while DNS updates.	307 Moved Temporarily
TokenRefreshRequired	The token that was provided must be refreshed.	400 Bad Request
TooManyBuckets	You have attempted to create more buckets than allowed.	400 Bad Request
TooManyUploadParts	The `CompleteMultipartUpload` request was made for than 10000 parts.	400 Bad Request
UnexpectedContent	This request does not support content.	400 Bad Request
UnexpectedQueryStringParameter	An unexpected query string parameter was found.	400 Bad Request
UnresolvableGrantByEmailAddress	The e-mail address you provided does not match any account on record.	400 Bad Request
UnsupportedAuthorizationType	An unsupported authorization type was found.	400 Bad Request
UploadsExpectsNoKey	A key is not expected for the GET operation ? uploads subresource.	400 Bad Request
UseNoAuthorizationMechanism	The authorization mechanism you have provided is not supported. Do not use any authorization mechanism.	400 Bad Request
User_Key_Not_Specified	The user key must be specified.	400 Bad Request
UserKeyMustBeSpecified	The `BucketPOST` operation must contain the specified field name. If it is specified, check the order of the fields.	400 Bad Request
UseV2AuthorizationMechanism	The authorization mechanism you have provided is not supported. Use AWS.	400 Bad Request
UseV4AuthorizationMechanism	The authorization mechanism you have provided is not supported. Use AWS4-HMAC-SHA256.	400 Bad Request
V4MHAuthorizationCredentialMalformed	The authorization header is malformed. The Credential element is malformed. A `<YOUR-AKID>/YYYYMMDD/REGION/SERVICE/aws4_request` was expected.	400 Bad Request
V4MHEmptyAuthorizationAccessKey	The authorization header is malformed. A non-empty `Access Key` must be specified in the credential.	400 Bad Request
V4MHEmptyAuthorizationRegion	The authorization header is malformed. A non-empty `Region` must be provided in the credential.	400 Bad Request
V4MHIncorrectAuthorizationDateFormat	The authorization header is malformed. It has an incorrect date format.	400 Bad Request
V4MHIncorrectAuthorizationRegion	The authorization header is malformed. `'<region>’'` is syntactically incorrect. `‘<region>’` is the proper syntax.	400 Bad Request
V4MHIncorrectAuthorizationRequestType	The authorization header is malformed. incorrect terminal `“<terminal>"` is syntactically incorrect. This endpoint requires `"aws4_request"`.	400 Bad Request
V4MHIncorrectAuthorizationService	The authorization header is malformed. `“<service>”` is syntactically incorrect.	400 Bad Request
V4QPAuthorizationCredentialMalformed	There was an error parsing the `X-Amz-Credential` parameter. The Credential is malformed. `"<YOUR-AKID>/YYYYMMDD/REGION/SERVICE/aws4_request`" was expected.	400 Bad Request
V4QPEmptyAuthorizationAccessKey	There was an error parsing the `X-Amz-Credential` parameter. A non-empty Access Key (AKID) must be provided in the credential.	400 Bad Request
V4QPEmptyAuthorizationRegion	There was an error parsing the `X-Amz-Credential` parameter. A non-empty region must be provided in the credential.	400 Bad Request
V4QPIncorrectAuthorizationDateFormat	There was an error parsing the `X-Amz-Credential` parameter. The `“<date>”` is formatted incorrectly. The date in the parameter must be in the format `yyyyMMdd`.	400 Bad Request
V4QPIncorrectAuthorizationRegion	There was and error parsing the `X-Amz-Credential` parameter. The `'<region>’'` parameter is wrong.	400 Bad Request
V4QPIncorrectAuthorizationService	There was an error parsing the `X-Amz-Credential` parameter. `"<service>”` is not correct.	400 Bad Request
VersionedBucketNotEmpty	The bucket you tried to delete is not empty. You must delete all versions in the bucket.	409 Conflict
VersionIdMarkerWithoutKeyMarker	A `version-id` marker cannot be specified without a key marker.	400 Bad Request
VersionIdMethodMismatch	This operation does not accept a `Version-Id` string.	400 Bad Request
VersionIdNotAvailableForReplication	The version ID that was provided is not available for replication.	409 Conflict
VersionIdTooLong	The version ID is too long.	400 Bad Request
XAmzAlgorithmUnsupported	`X-Amz-Algorithm` only supports AWS4-HMAC-SHA256.	400 Bad Request
XAmzContentSHA256Mismatch	The `x-amz-content-sha256` header that was provided does not match what was computed.	400 Bad Request
XAmzDateIncorrectFormat	`X-Amz-Date` must be in the ISO8601 long format. The format would be `"yyyyMMdd'T'HHmmss'Z'".`	400 Bad Request
XAmzExpiresLongerThanAWeek	The `X-Amz-Expires` parameter must be less than a week in seconds. It must be less than 604800 seconds.	400 Bad Request
XAmzExpiresMustBeNonNegative	`X-Amz-Expires` must be non-negative.	400 Bad Request
XAmzExpiresShouldBeANumber	`X-Amz-Expires` should be a number.	400 Bad Request
XAmzServerSideEncryptionHeaderNotSupportedForThisOperation	The `x-amz-server-side-encryption` header is not supported for this operation.	400 Bad Request
XAmzWebsiteRedirectLocationNotSupportedForThisOperation	The `x-amz-website-redirect-location` header is not supported for this operation.	400 Bad Request

4.0 S3 HTTP Status Codes

4.1 Status Codes

The ActiveScale S3 API may send the following HTTP status codes.

Table 83: HTTP status codes

Status code	Type	Description
100 - Continue	Success	The client should continue with the request.
201 - Object Created	Success	The request was successfully executed and the object was created.
304 - Not Modified	Redirection	The precondition is not satisfied.
400 - Bad Request	Error	The request could not be understood by the server due to malformed syntax. The client should not repeat the request without performing modifications to the request.
401 - Unauthorized	Error	The request failed because of lack of permissions.
403 - Forbidden	Error	The server understood the request, but it refused to fulfill it.
404 - Object Not Found	Error	The server has not found anything matching the request URI.
409 - Conflict	Error	The operation was aborted because of a conflict.
412 - Precondition Failed	Error	The precondition given in the request header field evaluated to false when it was tested on the server.
413 - Request Entity Too Large	Error	The requested data, object, customer, or data, is larger than the server was able to process.
500 - Metastore <id> is full	Error	There is no more free space in the given meta-store.
501 - Internal Server Error	Error	The server encountered an internal error.
505 - HTTP Version Not Supported	Failure	The server does not support the HTTP protocol version that was used in the request message.
507 - Insufficient Storage	Error	There is no more free space in the block-stores.

5.0 Differences Between AWS and this Release

The ActiveScale S3 API provides a subset of the AWS S3 API. This section describes the differences between AWS S3 API and ActiveScale S3 API, and between the current and previous three releases of ActiveScale S3 API.

5.2 Differences Between Amazon S3 API and ActiveScale S3 API

The following sections provide information about the differences between Amazon S3 and ActiveScale S3.

5.2.1 Differences in Bucket Operations

This section provides information about the differences between AWS S3 bucket operations and ActiveScale S3 bucket operations.

Table 84: Differences in bucket operations

Application	Amazon S3	ActiveScale S3
Executing `PUT Bucket` with an existing bucket name.	Amazon S3 returns an `HTTP 409 Conflict` message.	ActiveScale S3 returns an `HTTP 200 OK` message during a small grace period if you are the owner of the bucket.
Executing `PUT Bucket` with a bucket name containing any of the following special characters. { } < > [ ] \| ` ^ "	Amazon S3 returns an `HTTP 400 Bad Request` message.	ActiveScale S3 returns a `400 Bad Request` message.
Creating too many buckets for the same user.		ActiveScale S3 reports the following missing elements. CurrentNumberOfBuckets AllowedNumberOfBuckets HostId
Executing `DELETE Bucket` on an bucket that is not empty.
Executing `GETBucket (List` `Objects)` with a max-keys value greater than 1000.	Amazon S3 returns a maximum of 1,000 keys.	ActiveScale S3 returns an `HTTP 400 Invalid Argument` message.
Executing `HEAD Bucket`.		ActiveScale S3 returns an extra `charset=UTF-8` in the Content-Type in the header.
Executing `HEAD Bucket` for a bucket or key that does not exist.	Amazon S3 returns an `HTTP 404 Page Not Found` message.	ActiveScale S3 returns `HTTP404 PageNotFound` and with the messages `NoSuchBucket` or `NoSuchKey` in the body.
Executing `HEAD Bucket` without sufficient permissions to access that bucket.	Amazon S3 returns an `HTTP 403 Forbidden` message.	ActiveScale S3 returns an `HTTP 403 Forbidden` message with the message `Access Denied` in the body.
Executing `GET Bucket` with a maximum key value greater than 1,000.	Amazon S3 returns a maximum of 1,000 keys.	ActiveScale S3 returns an `HTTP 400 Invalid Argument` message.
Executing `GET Bucket (List Objects)` with a maximum key value greater than 1000.	Amazon S3 returns a maximum of 1,000 keys.	ActiveScale S3 does not allow a maximum key value greater than 1000, due to a possible stack overflow. ActiveScale S3 returns an `Invalid Parameter` message.
Executing `HEAD Bucket` for a bucket or key that does not exist.	Amazon S3 returns an `HTTP 404 Page Not Found` message.	ActiveScale S3 returns `HTTP 404 Page Not Found` together with the messages `NoSuchBucket` or `NoSuchKey` in the body.
Executing `HEAD Bucket` without sufficient permissions to access that bucket.	Amazon S3 returns an `HTTP 403 Forbidden` message.	ActiveScale S3 returns an `HTTP 403 Forbidden` message with the message `Access Denied` in the body.

5.2.2 Differences in Object Operations

This section provides information about the differences between Amazon S3 object operations and ActiveScale S3 object operations.

Table 85: Differences in object operations

Application	Amazon S3	ActiveScale S3
Specifying an object key name.	Amazon S3 allows a maximum of 1024 characters.	ActiveScale S3 allows more than 1024 characters.
Specifying an object with a name containing the following special characters, using s3cmd. [ ] \ ^	Amazon S3 returns an `HTTP 200 OK` message.	ActiveScale S3 returns an `HTTP 501 Not Implemented` message.
Adding custom metadata to objects.	Amazon S3 allows a maximum of 2 KiB for custom metadata in objects.	ActiveScale S3 allows custom metadata to exceed 2 KiB. However, this is not recommended.
Executing `DELETE Object` on an object that does not exist.	Amazon S3 returns an `HTTP 200 OK` message.	ActiveScale S3 returns errors.
Executing `PUT Object` for an object larger than 5 GB.	Amazon S3 does not support this operation. You must use the multipart upload APIs.	ActiveScale S3 supports thisoperation. However, it may produce errors.
Executing `PUT Object` on a bucket that does not exist.		ActiveScale S3 returns the following missing elements. `BucketName` HostId
Executing PUT Object with the following headers. x-amz-server-sideencryption x-amz-website-redirectlocation x-amz-grant-read x-amz-grant-write x-amz-grant-read-acp x-amz-grant-write-acp x-amz-grant-fullcontrol		ActiveScale S3 returns an `HTTP 501 Not Implemented` message.
Canceling a multipart upload and then trying to upload another part.	Amazon S3 returns a socket timeout.	ActiveScaleS3 returns an `HTTP 404 Not Found`, with a message in the body, `NoSuchUpload`.

5.2.3 Differences in Service Operations

This section provides information about the differences between AWS S3 service operations and ActiveScale S3 service operations.

Table 86: Differences in service operations

Application	Amazon S3	ActiveScale S3
Executing `GET Service` with query parameters using a WebDrive client.		ActiveScale S3 does not handle multiple query parameters when they are using a WebDrive client. Be sure to specify a bucket name in the request.

5.2.4 Differences in Requests

This section provides information about the differences between AWS S3 requests and ActiveScale S3 requests.

Table 87: Differences in requests

Application	Amazon S3	ActiveScale S3
Sending dummy headers.	Amazon S3 returns an `HTTP 200 OK` message.	ActiveScale S3 returns errors.
Sending a request with an `Expires` parameter.	Amazon S3 returns an `HTTP 200 OK` message.	ActiveScale S3 returns an `HTTP 501 Not Implemented` message.
Sending a request with a `TE` parameter.	Amazon S3 returns an `HTTP 200 OK` message.	ActiveScale S3 returns an `HTTP 501 Not Implemented` message.
Sending a request with a timezone of `CETrandomstring`.	Amazon S3 interprets the string as `CET`.	ActiveScale S3 interprets the string as `CETran`, which is an unknown timezone.
Sending a request with an unsupported time zone format.	Amazon S3 returns an `HTTP 403 Forbidden` message.	ActiveScale S3 returns an `HTTP 500 Internal Server Error` message.
Sending a request without the HTTP `Date` header.	Amazon S3 returns an `HTTP 403 Forbidden` message.	ActiveScale S3 returns an `HTTP 500 Internal Server Error` message.
Sending a request with an unsupported HTTP version.	Amazon S3 returns an `HTTP 505 HTTP Version Not Supported` message.	ActiveScale S3 returns an `HTTP 500 Internal Server Error` message.
Sending a request with bad URL encoding.	Amazon S3 returns an `HTTP 400 Invalid URI: EOF` message.	ActiveScale S3 returns an `HTTP 501 Not Implemented` message.
Sending a request with an invalid path.	Amazon S3 returns an `HTTP 400 Invalid URI` message.	ActiveScale S3 returns an `HTTP 500 Internal Server Error` message.
Sending a request with a different `Host` value than the one configured in ActiveScale.	Amazon S3 returns an `HTTP 301 Moved Permanently` message.	ActiveScale S3 returns an `HTTP 400 Bad Request` message.
Specifying an incorrect md5sum value.	AWS S3 returns the error message `The Content-MD5 you specified did not match what we received`.	ActiveScale S3 returns the error message `The Content-MD5 you specified was an invalid`.
Sending a request with Accept- Encoding: Identity.	Amazon S3 chunks Transfer-Encoding.	ActiveScale S3 ignores the header. Transfer-Encoding is not chunked.
Sending a `GET` request with `If- Range` in the header.	AWS S3 returns an `HTTP 200 OK` message.	ActiveScale S3 returns an `HTTP 501 Not Implemented` message.

5.3 Headers

The following sections provide information about headers.

5.3.1 Common Request Headers

The following table lists the common request headers for the ActiveScale S3 API.

Header	Supported	Notes
Authorization	Yes	None
Content-Length	Yes	None
Content-Type	Yes	None
Content-MD5	Yes	None
Date	Yes	None
Expect	Yes	None
Host	Yes	None
x-amz-content-sha256	Yes	None
x-amz-date	Yes	None
x-amz-security-token	No	None

Note: See RFC2616 for more information about headers.

5.3.2 Common Response Headers

The following table lists the common response headers for the ActiveScale S3 API.

Header	Supported	Notes
Content-Length	Yes	None
Content-Type	Yes	None
Connection	Yes	None
Date	Yes	None
ETag	Yes	None
Server	Yes	None
x-amz-delete-marker	Yes	None
x-amz-id-2	Yes	None
x-amz-request-id	Yes	None

Note: See RFC2616 for more information about headers.

5.4 Identity and Access Management

ActiveScale Identity and Access Management (IAM) is a web service that helps to securely control user access to resources. IAM authentication controls who can use the resources.

5.4.3 Comparing ActiveScale and AWS IAMs

The following table outlines a comparison between ActiveScale and AWS.

Table 88: Comparing ActiveScale Identities and AWS IAM

ActiveScale	AWS IAM
Three identities, Storage Admin, Account, and User.	Two identities, AWS Accounts and IAM Users.
Two groups, authenticated users and all users.	Two global groups, authenticated users and unauthenticated users.
Simpler than AWS.	The user who uploads the objects is the object owner.
More oriented towards the private cloud than the ISP cloud.
Per-object READ permission is granted automatically for every object in a specific bucket.

5.14 Storage Classes

Storage classes are partially supported in the ActiveScale API. All objects will be stored with the system configured storage durability policy. In order to allow compatibility with some S3 applications, the ActiveScaleActiveScale S3 API will not reject a PUT Object, Initiate Multipart Upload, and Put Object - Copy operations that include the x-amz-storage-class header. Additionally, the specified storage class will be stored in the object metadata so that it is visible during a GET Object or HEAD Object operation.

The following table lists both the supported and unsupported storage classes.

Class	Supported
DEEP_ARCHIVE	Treated as synonym of GLACIER
GLACIER	ASCS only
GLACIER_IR	Treated as synonym of STANDARD
INTELLIGENT_TIERING	Treated as synonym of STANDARD
ONEZONE_IA	Treated as synonym of STANDARD
REDUCED_REDUNDANCY	Treated as synonym of STANDARD
STANDARD	Yes
STANDARD_IA	Treated as synonym of STANDARD

5.15 User Defined Metadata

User defined metadata is provided in the x-amz-meta- request header in PUT Object, PUT Object - Copy, and Initiate Multipart UploadActiveScale API requests. User defined metadata is returned in the x-amz- meta- response header in reply to GET Object and HEAD Object requests.

S3 supports MIME-encoded words in user defined metadata. This means you can use values with encodings that are not ASCII. S3 converts the provided MIME-encoded words into UTF-8 characters and returns the MIME-encoded words in UTF-8 characters as a reply to any HEAD Object or GET Object request.

MIME-encoded words of the form =?charset?encoding?text?= in the x-amz-meta- requests are partially supported.
MIME-encoded words are not converted to UTF-8, but are stored exactly as provided in the request.
Maximum length calculation is not fully compatible with Amazon S3, because it is based on the length of the MIME- encoded word rather than on the UTF-8 encoding of the MIME-encoded text.
The set of supported character sets is by default limited to the following sets:
- ASCII
- ISO-8859-1
- ISO8859-1
- UTF-8
- UTF8
- UTF-16
- UTF16
- UTF-32
- UTF32

6.0 Differences Between ActiveScale S3 API Releases

This section describes the differences between the current and previous three releases of ActiveScale S3 API.

6.1 Common Request Headers

Table 89: Support for common request headers

Request header	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
Authorization	V2, V4	V2, V4	V2, V4	V2, V4	V2, V4
Content-Length	a	a	a	a	a
Content-Type	a	a	a	a	a
Content-MD5	a	a	a	a	a
Date	a	a	a	a	a
Expect	a	a	a	a	a
Host	a	a	a	a	a
x-amz-content-sha256	a	a	a	a	a
x-amz-date	a	a	a	a	a
x-amz-security-token	r	r	r	r	r
x-amz-api-version	r	r	r	r	r

http://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonRequestHeaders.html

6.2 Common Response Headers

Table 90: Support for common response headers

Response header	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
Content-Length	a	a	a	a	a
Content-Type	a	a	a	a	a
Connection	a	a	a	a	a
Date	a	a	a	a	a
ETag	a	a	a	a	a
Server	a	a	a	a	a
x-amz-delete-marker	a	a	a	a	a
x-amz-id-2	a	a	a	a	a
x-amz-request-id	a	a	a	a	a
x-amz-version-id	a	a	a	a	a
x-amz-api-version	ignored	ignored	r	r	r

http://docs.aws.amazon.com/AmazonS3/latest/API/RESTCommonResponseHeaders.html

6.3 PUT Bucket Request/Response Headers

Table 91: Support for PUT Bucket request/response headers

Request header	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
x-amz-acl	a	a	a	a	a
x-amz-bucket-object-lock-enabled	a	r	r	r	r
x-amz-grant-read	a	a	a	a	a
x-amz-grant-write	a	a	a	a	a
x-amz-grant-read-acp	a	a	a	a	a
x-amz-grant-write-acp	a	a	a	a	a
x-amx-grant-full-control	a	a	a	a	a

Table 92: Support for PUT Bucket request elements

Request element	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
CreateBucketConfiguration	a	a	a	a	a
LocationConstraint	ignored	ignored	ignored	ignored	ignored

http://docs.aws.amazon.com/AmazonS3/latest/API/RESTBucketPUT.html

6.4 PUT Object Request/Response Parameters and Headers

Table 93: Support for PUT Object request parameters

Request parameter	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
x-amz-acl	ignored	ignored	ignored	ignored	ignored
x-amz-grant-*	ignored	ignored	ignored	ignored	ignored
x-amz-meta	a	a	a	a	a
x-amz-server-side-encryption	a AES256	a AES256	a AES256	a AES256	a AES256
x-amz-storage-class	a	a	a	a	a

Table 94: Support for PUT Object request headers

Request header	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
Cache-Control	a	a	a	a	a
Content-Disposition	a	a	a	a	a
Content-Encoding	a	a	a	a	a
Content-Language	a	a	a	a	a
Content-Type	a	a	a	a	a
Expires	a	a	a	a	a
x-amz-acl	ignored	ignored	ignored	ignored	ignored
x-amz-grant-*	ignored	ignored	ignored	ignored	ignored
x-amz-meta-*	a	a	a	a	a
x-amz-object-lock-legal-hold	partial	r	r	r	r
x-amz-object-lock-mode	a	r	r	r	r
x-amz-object-lock-retain-until-date	a	r	r	r	r
x-amz-server-side-encryption	a	a	a	a	a
x-amz-server-side-encryption-aws-kms-key-id	r	r	r	r	r
x-amz-server-side-encryption-context	r	r	r	r	r
x-amz-server-side-encryption-customer-algorithm	r	r	r	r	r
x-amz-server-side-encryption-customer-key	r	r	r	r	r
x-amz-server-side-encryption-customer-key-MD5	r	r	r	r	r
x-amz-storage-class	a	a	a	a	a
x-amz-website-redirect-location	a	a	a	a	a

http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPUT.html

6.5 GET Object Request/Response Parameters and Headers

Table 95: Support for GET Object request parameters

Request parameter	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
response-cache-control	a	a	a	a	a
response-content-disposition	a	a	a	a	a
response-content-encoding	a	a	a	a	a
response-content-language	a	a	a	a	a
response-content-type	a	a	a	a	a
response-expires	a	a	a	a	a

Table 96: Support for GET Object request header

Request header	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
Range	a	a	a	a	a
If-Modified-Since	a	a	a	a	a
If-Unmodified-Since	a	a	a	a	a
If-Match	a	a	a	a	a
If-none-Match	a	a	a	a	a
x-amz-object-lock-legal-hold	a	r	r	r	r
x-amz-object-lock-mode	a	r	r	r	r
x-amz-object-lock-retain-until-date	a	r	r	r	r
x-amz-server-side-encryption-customer-algorithm	r	r	r	r	r
x-amz-server-side-encryption-customer-key	r	r	r	r	r
x-amz-server-side-encryption-customer-key-md5	r	r	r	r	r
x-amz-te x-amz-transfer-encoding	ignored	ignored	r	r	r
x-amz-acl	ignored	ignored	r	r	r

Table 97: Support for GET Object response headers

Response header	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
Cache-Control	a	a	a	a	a
Content-Disposition	a	a	a	a	a
Content-Encoding	a	a	a	a	a
Content-Language	a	a	a	a	a
Content-Type	a	a	a	a	a
Expires	a	a	a	a	a
x-amz-delete-marker	a	a	a	a	a
x-amz-expiration	a	a	a	a	a
x-amz-meta-*	a	a	a	a	a
x-amz-replication-status	a	a	a	a	a
x-amz-restore-expiry-days	a	r	r	r	r
x-amz-restore-request-date	a	r	r	r	r
x-amz-restore-tier	a	r	r	r	r
x-amz-restore	a	r	r	r	r
x-amz-server-side-encryption	a	a	a	a	a
x-amz-server-side-encryption-aws-kms-key-id	r	r	r	r	r
x-amz-server-side-encryption-customer-algorithm	r	r	r	r	r
x-amz-server-side-encryption-customer-key-md5	r	r	r	r	r
x-amz-storage-class	a	a	a	a	a
x-amz-version-id	a	a	a	a	a
x-amz-website-redirect-location	a	a	a	a	a
x-amz-te x-amz-transfer-encoding	r	r	r	r	r
x-amz-acl	r	r	r	r	r

http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectGET.html

6.6 Authentication with AWS Signature V4

Table 98: Support for AWS authentication v4 authentication headers

HTTP authentication header component	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
AWS4-HMAC-SHA256	a	a	a	a	a
Credential	a	a	a	a	a
SignedHeaders	a	a	a	a	a
Signature	a	a	a	a	a

Table 99: Support for AWS authentication v4 request parameters

Query parameter	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
X-Amz-Algorithm	a	a	a	a	a
X-Amz-Credential	a	a	a	a	a
X-Amz-Date	a	a	a	a	a
X-Amz-Expires	a	a	a	a	a
X-Amz-SignedHeaders	a	a	a	a	a
X-Amz-Signature	a	a	a	a	a

Table 100: Support for AWS authentication v4 request headers related payloads

Request Headers Related To (Signed) Payload Transfer	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
x-amz-content-sha256	a	a	a	a	a
x-amz-decoded-content-length	a	a	a	a	a
Content-Encoding: aws-chunked	a	a	a	a	a
Transfer-Encoding: chunked	a	a	a	a	a

http://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html

6.7 Authentication with AWS Signature V2

Figure 1: Support for AWS authentication v2 authentication headers

HTTP authorization header	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
AWS	a	a	a	a	a
AWS-AccessKeyID	a	a	a	a	a
Signature	a	a	a	a	a

Table 101: Support for AWS authentication v2 request parameters

Query parameter	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
AWS	a	a	a	a	a
AWS-AccessKeyID	a	a	a	a	a
Signature	a	a	a	a	a

http://docs.aws.amazon.com/AmazonS3/latest/dev/RESTAuthentication.html

6.8 AWS S3 API

Table 102: Support for AWS S3 API

Name	Applies to	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
GET service	Service	a	a	a	a	a
DELETE Bucket	Buckets	a	a	a	a	a
DELETE Bucket cors	Buckets	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)
DELETE Bucket lifecycle	Buckets	a	a	a	a	a
DELETE Bucket policy	Buckets	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)
DELETE Bucket replication	Buckets	a	a	a	a	a
DELETE Bucket tagging	Buckets	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)
DELETE Bucket website	Buckets	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)
DELETE encryption	Buckets	r	r	r	r	r
GET Bucket (List Objects) V1	Buckets	a	a	a	a	a
GET Bucket (List Objects) V2	Buckets	a	a	a	a	a
GET Bucket accelerate	Buckets	r	r	r	r	r
GET Bucket acl	Buckets	a	a	a	a	a
GET Bucket cors	Buckets	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)
GET Bucket lifecycle	Buckets	a	a	a	a	a
GET Bucket location	Buckets	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)
GET Bucket logging	Buckets	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)
GET Bucket notification	Buckets	a	a	r	r	r
Get Bucket object lock configuration	Buckets	a	r	r	r	r
GET Bucket object versions	Buckets	a	a	a	a	a
GET Bucket policy	Buckets	a	a	a	a	a
GET Bucket replication	Buckets	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)
GET Bucket requestPayment	Buckets	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)
GET Bucket tagging	Buckets	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)
GET Bucket versioning	Buckets	a	a	a	a	a
GET Bucket website	Buckets	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)	a(dummy response)
GET encryption	Buckets	a	r	r	r	r
HEAD Bucket	Buckets	a	r	r	r	r
List Multipart Uploads	Buckets	a	a	a	a	a
PUT Bucket	Buckets	a	a	a	a	a
PUT Bucket accelerate	Buckets	r	r	r	r	r
PUT Bucket acl	Buckets	a	a	a	a	a
PUT Bucket cors	Buckets	r	r	r	r	r
PUT Bucket lifecycle	Buckets	a actions "Expiration" & "NoncurrentVers ionExpiration"	a actions "Expiration" & "NoncurrentVers ionExpiration"	a actions "Expiration" & "NoncurrentVers ionExpiration"	a actions "Expiration" & "NoncurrentVers ionExpiration"	a actions "Expiration" & "NoncurrentVers ionExpiration"
PUT Bucket logging	Buckets	r	r	r	r	r
PUT Bucket notification	Buckets	a	a	r	r	r
PUT Bucket object lock configuration	Buckets	a	r	r	r	r
PUT Bucket policy	Buckets	r	r	r	r	r
PUT bucket replication	Buckets	a	a	a	a	a
PUT Bucket requestPayment	Buckets	r	r	r	r	r
PUT Bucket tagging	Buckets	r	r	r	r	r
PUT Bucket versioning	Buckets	a	a	a	a	a
PUT Bucket website	Buckets	r	r	r	r	r
PUT encryption	Buckets	r	r	r	r	r
PUT lifecycle	Buckets	a Actions “Expiration” & “NonCurrentVersionExpiration” & “Transition” & “NoncurrentVersionTransition”	r	r	r	r
DELETE Object	Objects	a	a	a	a	a
Delete Multiple Objects	Objects	a	a	a	a	a
GET Object	Objects	a	a	a	a	a
GET Object acl	Objects	Same as GET Bucket acl	Same as GET Bucket acl	Same as GET Bucket acl	Same as GET Bucket acl	Same as GET Bucket acl
GET Object retention	Object	a	r	r	r	r
GET Object torrent	Objects	r	r	r	r	r
HEAD Object	Objects	a	a	a	a	a
OPTIONS object	Objects	r	r	r	r	r
POST Object	Objects	r	r	r	r	r
POST Object restore	Objects	r	r	r	r	r
PUT Object	Objects	a	a	a	a	a
PUT Object acl	Objects	r	r	r	r	r
PUT Object - Copy	Objects	a	a	a	a	a
PUT Object retention	Objects	a	r	r	r	r
Initiate Multipart Upload	Objects	a	a	a	a	a
Upload Part	Objects	a	a	a	a	a
Upload Part - Copy	Objects	a	a	a	a	a
Complete Multipart Upload	Objects	a	a	a	a	a
Abort Multipart Upload	Objects	a	a	a	a	a
List Parts	Objects	a	a	a	a	a

http://docs.aws.amazon.com/AmazonS3/latest/API/APIRest.html

6.9 AWS S3 Error Codes

The list below represents ActiveScale support for error codes as defined by the AWS S3 API.For a comprehensive of all ActiveScale possible error codes, see Error codes.

Table 103: Support for AWS S3 error codes

Name	HTTP status	ActiveScale OS 6.1	ActiveScale OS 6.0.2	ActiveScale OS 6.0.1	ActiveScale OS 6.0	ActiveScale OS 5.7
AccessDenied	403 Forbidden	a	a	a	a	a
AccountProblem	403 Forbidden	r	r	r	r	r
AmbiguousGrantByEmailAddress	400 Bad Request	r	r	r	r	r
BadDigest	400 Bad Request	a	a	a	a	a
BucketAlreadyExists	409 Conflict	a	a	a	a	a
BucketAlreadyOwnedByYou	409 Conflict	a	a	a	a	a
BucketNotEmpty	409 Conflict	a	a	a	a	a
CredentialsNotSupported	400 Bad Request	r	r	r	r	r
CrossLocationLoggingProhibited	403 Forbidden	r	r	r	r	r
EntityTooSmall	400 Bad Request	a	a	a	a	a
EntityTooLarge	400 Bad Request	a	a	a	a	a
ExpiredToken	400 Bad Request	r	r	r	r	r
IllegalVersioningConfigurationE xception	400 Bad Request	a	a	a	a	a
IncompleteBody	400 Bad Request	a	a	a	a	a
IncorrectNumberOfFilesInPostReq uest	400 Bad Request	r	r	r	r	r
InlineDataTooLarge	400 Bad Request	r	r	r	r	r
InternalError	500 Internal Server Error	a	a	a	a	a
InvalidAccessKeyId	403 Forbidden	a	a	a	a	a
InvalidAddressingHeader	N/A	r	r	r	r	r
InvalidArgument	400 Bad Request	a	a	a	a	a
InvalidBucketName	400 Bad Request	a	a	a	a	a
InvalidBucketState	409 Conflict	a	a	a	a	a
InvalidDigest	400 Bad Request	a	a	a	a	a
InvalidEncryptionAlgorithmError	400 Bad Request	a	a	a	a	a
InvalidLocationConstraint	400 Bad Request	a	a	a	a	a
InvalidObjectState	403 Forbidden	ASCS Only	r	r	r	r
InvalidPart	400 Bad Request	a	a	a	a	a
InvalidPartOrder	400 Bad Request	a	a	a	a	a
InvalidPayer	403 Forbidden	r	r	r	r	r
InvalidPolicyDocument	400 Bad Request	r	r	r	r	r
InvalidRange	416 Requested Range Not Satisfiable	a	a	a	a	a
InvalidRequest	400 Bad Request	a	a	a	a	a
InvalidSecurity	403 Forbidden	r	r	r	r	r
InvalidSOAPRequest	400 Bad Request	r	r	r	r	r
InvalidStorageClass	400 Bad Request	a	a	a	a	a
InvalidTargetBucketForLogging	400 Bad Request	r	r	r	r	r
InvalidToken	400 Bad Request	r	r	r	r	r
InvalidURI	400 Bad Request	a	a	a	a	a
KeyTooLong	400 Bad Request	a	a	a	a	a
MalformedACLError	400 Bad Request	a	a	a	a	a
MalformedPOSTRequest	400 Bad Request	r	r	r	r	r
MalformedXML	400 Bad Request	a	a	a	a	a
MaxMessageLengthExceeded	400 Bad Request	r	r	r	r	r
MaxPostPreDataLengthExceededError	400 Bad Request	r	r	r	r	r
MetadataTooLarge	400 Bad Request	a	a	a	a	a
MethodNotAllowed	405 Method Not Allowed	a	a	a	a	a
MissingAttachment	N/A	a	a	a	a	a
MissingContentLength	411 Length Required	a	a	a	a	a
MissingRequestBodyError	400 Bad Request	a	a	a	a	a
MissingSecurityElement	400 Bad Request	r	r	r	r	r
MissingSecurityHeader	400 Bad Request	a	a	a	a	a
NoLoggingStatusForKey	400 Bad Request	a	a	a	a	a
NoSuchBucket	404 Not Found	a	a	a	a	a
NoSuchKey	404 Not Found	a	a	a	a	a
NoSuchLifecycleConfiguration	404 Not Found	a	a	a	a	a
NoSuchObjectLockConfiguration	404 Not Found	a	r	r	r	r
NoSuchUpload	404 Not Found	a	a	a	a	a
NoSuchVersion	404 Not Found	a	a	a	a	a
NotImplemented	501 Not Implemented	a	a	a	a	a
NotSignedUp	403Forbidden	r	r	r	r	r
NoSuchBucketPolicy	404 Not Found	a	a	a	a	a
ObjectLockConfigurationNotFoundError	404 Not Found	a	r	r	r	r
OperationAborted	409 Conflict	r	r	r	r	r
PermanentRedirect	301 Moved Permanently	r	r	r	r	r
PreconditionFailed	412 Precondition Failed	a	a	a	a	a
Redirect	307 Moved Temporarily	r	r	r	r	r
RestoreAlreadyInProgress	409 Conflict	ASCS Only	r	r	r	r
RequestIsNotMultiPartContent	400 Bad Request	r	r	r	r	r
RequestTimeout	400 Bad Request	a	a	a	a	a
RequestTimeTooSkewed	403 Forbidden	a	a	a	a	a
RequestTorrentOfBucketError	400 Bad Request	a	a	a	a	a
SignatureDoesNotMatch	403 Forbidden	a	a	a	a	a
ServiceUnavailable	503 Service Unavailable	a	a	a	a	a
ServerSideEncryptionConfigurationNotFoundError	404 Not Found	a	r	r	r	r
SlowDown	503 Slow Down	r	r	r	r	r
TemporaryRedirect	307 Moved Temporarily
TokenRefreshRequired	400 Bad Request	r	r	r	r	r
TooManyBuckets	400 Bad Request
UnexpectedContent	400 Bad Request
UnresolvableGrantByEmailAddress	400 Bad Request
UserKeyMustBeSpecified	400 Bad Request

http://docs.aws.amazon.com/AmazonS3/latest/API/ErrorResponses.html#ErrorCodeList