Object
DeleteObject
Removes an object from a bucket.
Request Properties
- Name
Bucket- Type
- string SupportedRequiredPath
- Description
- The bucket name of the bucket containing the object.
- Name
Key- Type
- string SupportedRequiredPath
- Description
- Key name of the object to delete.
- Name
versionid- Type
- string Not SupportedHeader
- Description
- Version ID used to reference a specific version of the object.
- Name
x-amz-bypass-governance-retention- Type
- string Not SupportedHeader
- Description
- Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:BypassGovernanceRetention permission.
- Name
x-amz-expected-bucket-owner- Type
- string Not SupportedHeader
- Description
- The account ID of the expected bucket owner.
- Name
x-amz-mfa- Type
- string Not SupportedHeader
- Description
- The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
- Name
x-amz-request-payer- Type
- string Not SupportedHeader
- Description
- Confirms that the requester knows that they will be charged for the request.
Response Properties
- Name
x-amz-delete-markerNot SupportedHeader- Description
- Indicates whether the specified object version that was permanently deleted was (true) or was not (false) a delete marker before deletion.
- Name
x-amz-request-chargedNot SupportedHeader- Description
- If present, indicates that the requester was successfully charged for the request.
- Name
x-amz-version-idNot SupportedHeader- Description
- Version ID of the newly created object, in case the bucket has versioning turned on.
Request
DELETE /Key+?versionId=VersionId HTTP/1.1
Host: Bucket.Endpoint
x-amz-mfa: MFA
x-amz-request-payer: RequestPayer
x-amz-bypass-governance-retention: BypassGovernanceRetention
x-amz-expected-bucket-owner: ExpectedBucketOwnerResponse
HTTP/1.1 204
x-amz-delete-marker: DeleteMarker
x-amz-version-id: VersionId
x-amz-request-charged: RequestChargedDeleteObjects
This operation enables you to delete multiple objects from a bucket using a single HTTP request. If you know the object keys that you want to delete, then this operation provides a suitable alternative to sending individual delete requests, reducing per-request overhead.
Request Properties
- Name
Bucket- Type
- string SupportedRequiredPath
- Description
- The bucket name containing the objects to delete.
- Name
x-amz-bypass-governance-retention- Type
- string Not SupportedHeader
- Description
- Indicates whether S3 Object Lock should bypass Governance-mode restrictions to process this operation. To use this header, you must have the s3:BypassGovernanceRetention permission.
- Name
x-amz-expected-bucket-owner- Type
- string Not SupportedHeader
- Description
- The account ID of the expected bucket owner.
- Name
x-amz-mfa- Type
- string Not SupportedHeader
- Description
- The concatenation of the authentication device's serial number, a space, and the value that is displayed on your authentication device.
- Name
x-amz-request-payer- Type
- string Not SupportedHeader
- Description
- Confirms that the requester knows that they will be charged for the request.
- Name
x-amz-sdk-checksum-algorithm- Type
- string Not SupportedHeader
- Description
- Indicates the algorithm used to create the checksum for the object when you use the SDK.
- Name
Delete- Type
- Delete SupportedRequiredBody
- Description
- Root level tag for the Delete parameters.
- Name
Object- Type
- Object SupportedRequiredBody
- Description
- Container element for an object to be deleted. Type: Array of ObjectIdentifier types.
- Name
Quiet- Type
- boolean Not SupportedBody
- Description
- Element to enable quiet mode for the request. When you add this element, you must set its value to true.
Response Properties
- Name
x-amz-request-chargedNot SupportedHeader- Description
- If present, indicates that the requester was successfully charged for the request.
- Name
DeleteResult- Type
- DeleteResult SupportedBody
- Description
- Root level tag for the DeleteResult parameters.
- Name
Deleted- Type
- Deleted SupportedBody
- Description
- Container element for a successful delete. It identifies the object that was successfully deleted. Type: Array of DeletedObject data types
- Name
Error- Type
- Error SupportedBody
- Description
- Container for a failed delete action that describes the object that Anzen Store attempted to delete and the error it encountered. Type: Array of Error data types
Request
POST /?delete HTTP/1.1
Host: Bucket.Endpoint
x-amz-mfa: MFA
x-amz-request-payer: RequestPayer
x-amz-bypass-governance-retention: BypassGovernanceRetention
x-amz-expected-bucket-owner: ExpectedBucketOwner
x-amz-sdk-checksum-algorithm: ChecksumAlgorithm
<?xml version="1.0" encoding="UTF-8"?>
<Delete>
<Object>
<Key>string</Key>
<VersionId>string</VersionId>
</Object>
...
<Quiet>boolean</Quiet>
</Delete>Response
HTTP/1.1 200
x-amz-request-charged: RequestCharged
<?xml version="1.0" encoding="UTF-8"?>
<DeleteResult>
<Deleted>
<DeleteMarker>boolean</DeleteMarker>
<DeleteMarkerVersionId>string</DeleteMarkerVersionId>
<Key>string</Key>
<VersionId>string</VersionId>
</Deleted>
...
<Error>
<Code>string</Code>
<Key>string</Key>
<Message>string</Message>
<VersionId>string</VersionId>
</Error>
...
</DeleteResult>GetObject
Retrieves an object from AnzenStore.
Request Properties
- Name
Bucket- Type
- string SupportedRequiredPath
- Description
- Represents the bucket within which the object exsits.
- Name
Key- Type
- string SupportedRequiredPath
- Description
- Key of the object to get.
- Name
If-MatchNot SupportedHeader- Description
- Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise, return a 412 Precondition Failed error.
- Name
If-Modified-SinceNot SupportedHeader- Description
- Return the object only if it has been modified since the specified time; otherwise, return a 304 Not Modified error.
- Name
If-None-MatchNot SupportedHeader- Description
- Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a 304 Not Modified error.
- Name
If-Unmodified-SinceNot SupportedHeader- Description
- Return the object only if it has not been modified since the specified time; otherwise, return a 412 Precondition Failed error.
- Name
RangeNot SupportedHeader- Description
- Downloads the specified byte range of an object.
- Name
partNumberNot SupportedHeader- Description
- Part number of the object being read.
- Name
response-cache-controlNot SupportedHeader- Description
- Sets the Cache-Control header of the response.
- Name
response-content-dispositionNot SupportedHeader- Description
- Sets the Content-Disposition header of the response.
- Name
response-content-encodingNot SupportedHeader- Description
- Sets the Content-Encoding header of the response.
- Name
response-content-languageNot SupportedHeader- Description
- Sets the Content-Language header of the response.
- Name
response-content-typeNot SupportedHeader- Description
- Sets the Content-Type header of the response.
- Name
response-expiresNot SupportedHeader- Description
- Sets the Expires header of the response.
- Name
x-amz-checksum-modeNot SupportedHeader- Description
- To retrieve the checksum, this mode must be enabled.
- Name
x-amz-expected-bucket-owner- Type
- string Not SupportedHeader
- Description
- The account ID of the expected bucket owner.
- Name
x-amz-request-payer- Type
- string Not SupportedHeader
- Description
- Confirms that the requester knows that they will be charged for the request.
- Name
x-amz-server-side-encryption-customer-algorithm- Type
- string Not SupportedHeader
- Description
- pecifies the algorithm to use when decrypting the object (for example, AES256).
- Name
x-amz-server-side-encryption-customer-keyNot SupportedHeader- Description
- The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm.
- Name
x-amz-server-side-encryption-customer-key-MD5Not SupportedHeader- Description
- The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm.
- Name
VersionId- Type
- string Not SupportedQuery
- Description
- Version ID used to reference a specific version of the object.
Response Properties
- Name
Cache-ControlNot SupportedHeader- Description
- Specifies caching behavior along the request/reply chain.
- Name
Content-DispositionNot SupportedHeader- Description
- Specifies presentational information for the object.
- Name
Content-EncodingNot SupportedHeader- Description
- Indicates what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
- Name
Content-LanguageNot SupportedHeader- Description
- The language the content is in.
- Name
Content-LengthNot SupportedHeader- Description
- Size of the body in bytes.
- Name
Content-RangeNot SupportedHeader- Description
- The portion of the object returned in the response.
- Name
Content-TypeNot SupportedHeader- Description
- A standard MIME type describing the format of the object data.
- Name
ETagNot SupportedHeader- Description
- An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
- Name
ExpiresNot SupportedHeader- Description
- The date and time at which the object is no longer cacheable.
- Name
Last-ModifiedNot SupportedHeader- Description
- Date and time when the object was last modified.
- Name
accept-rangesNot SupportedHeader- Description
- Indicates that a range of bytes was specified in the request.
- Name
x-amz-checksum-crc32Not SupportedHeader- Description
- The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object.
- Name
x-amz-checksum-crc32cNot SupportedHeader- Description
- The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object.
- Name
x-amz-checksum-sha1Not SupportedHeader- Description
- The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object.
- Name
x-amz-checksum-sha256Not SupportedHeader- Description
- The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object.
- Name
x-amz-delete-markerNot SupportedHeader- Description
- Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
- Name
x-amz-expirationNot SupportedHeader- Description
- If the object expiration is configured (see PutBucketLifecycleConfiguration), the response includes this header.
- Name
x-amz-missing-metaNot SupportedHeader- Description
- This is set to the number of metadata entries not returned in the headers that are prefixed with x-amz-meta-.
- Name
x-amz-mp-parts-countNot SupportedHeader- Description
- The count of parts this object has.
- Name
x-amz-object-lock-legal-holdNot SupportedHeader- Description
- Indicates whether this object has an active legal hold.
- Name
x-amz-object-lock-modeNot SupportedHeader- Description
- The Object Lock mode that's currently in place for this object.
- Name
x-amz-object-lock-retain-until-dateNot SupportedHeader- Description
- The date and time when this object's Object Lock will expire.
- Name
x-amz-replication-statusNot SupportedHeader- Description
- Anzen Store can return this if your request involves a bucket that is either a source or destination in a replication rule.
- Name
x-amz-request-chargedNot SupportedHeader- Description
- If present, indicates that the requester was successfully charged for the request.
- Name
x-amz-restoreNot SupportedHeader- Description
- Provides information about object restoration action and expiration time of the restored object copy.
- Name
x-amz-server-side-encryptionNot SupportedHeader- Description
- The server-side encryption algorithm used when you store this object in Anzen Store (for example, AES256, aws:kms, aws:kms:dsse).
- Name
x-amz-server-side-encryption-aws-kms-key-idNot SupportedHeader- Description
- If present, indicates the ID of the AWS Key Management Service (AWS KMS) symmetric encryption customer managed key that was used for the object.
- Name
x-amz-server-side-encryption-bucket-key-enabledNot SupportedHeader- Description
- Indicates whether the object uses an S3 Bucket Key for server-side encryption with AWS Key Management Service (AWS KMS) keys (SSE-KMS).
- Name
x-amz-server-side-encryption-customer-algorithmNot SupportedHeader- Description
- If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
- Name
x-amz-server-side-encryption-customer-key-MD5Not SupportedHeader- Description
- If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
- Name
x-amz-storage-classNot SupportedHeader- Description
- Provides storage class information of the object.
- Name
x-amz-tagging-countNot SupportedHeader- Description
- The number of tags, if any, on the object, when you have the relevant permission to read object tags.
- Name
x-amz-version-idNot SupportedHeader- Description
- Version ID of the object.
- Name
x-amz-website-redirect-locationNot SupportedHeader- Description
- If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Anzen Store stores the value of this header in the object metadata.
Request
GET /Key+?partNumber=PartNumber&response-cache-control=ResponseCacheControl&response-content-disposition=ResponseContentDisposition&response-content-encoding=ResponseContentEncoding&response-content-language=ResponseContentLanguage&response-content-type=ResponseContentType&response-expires=ResponseExpires&versionId=VersionId HTTP/1.1
Host: Bucket.Endpoint
If-Match: IfMatch
If-Modified-Since: IfModifiedSince
If-None-Match: IfNoneMatch
If-Unmodified-Since: IfUnmodifiedSince
Range: Range
x-amz-server-side-encryption-customer-algorithm: SSECustomerAlgorithm
x-amz-server-side-encryption-customer-key: SSECustomerKey
x-amz-server-side-encryption-customer-key-MD5: SSECustomerKeyMD5
x-amz-request-payer: RequestPayer
x-amz-expected-bucket-owner: ExpectedBucketOwner
x-amz-checksum-mode: ChecksumModeResponse
HTTP/1.1 200
x-amz-delete-marker: DeleteMarker
accept-ranges: AcceptRanges
x-amz-expiration: Expiration
x-amz-restore: Restore
Last-Modified: LastModified
Content-Length: ContentLength
ETag: ETag
x-amz-checksum-crc32: ChecksumCRC32
x-amz-checksum-crc32c: ChecksumCRC32C
x-amz-checksum-sha1: ChecksumSHA1
x-amz-checksum-sha256: ChecksumSHA256
x-amz-missing-meta: MissingMeta
x-amz-version-id: VersionId
Cache-Control: CacheControl
Content-Disposition: ContentDisposition
Content-Encoding: ContentEncoding
Content-Language: ContentLanguage
Content-Range: ContentRange
Content-Type: ContentType
Expires: Expires
x-amz-website-redirect-location: WebsiteRedirectLocation
x-amz-server-side-encryption: ServerSideEncryption
x-amz-server-side-encryption-customer-algorithm: SSECustomerAlgorithm
x-amz-server-side-encryption-customer-key-MD5: SSECustomerKeyMD5
x-amz-server-side-encryption-aws-kms-key-id: SSEKMSKeyId
x-amz-server-side-encryption-bucket-key-enabled: BucketKeyEnabled
x-amz-storage-class: StorageClass
x-amz-request-charged: RequestCharged
x-amz-replication-status: ReplicationStatus
x-amz-mp-parts-count: PartsCount
x-amz-tagging-count: TagCount
x-amz-object-lock-mode: ObjectLockMode
x-amz-object-lock-retain-until-date: ObjectLockRetainUntilDate
x-amz-object-lock-legal-hold: ObjectLockLegalHoldStatus
BodyHeadObject
The HEAD operation retrieves metadata from an object without returning the object itself. This operation is useful if you're interested only in an object's metadata.
Request Properties
- Name
Bucket- Type
- string SupportedRequiredPath
- Description
- Represents the bucket within which the object exsits.
- Name
Key- Type
- string SupportedRequiredPath
- Description
- Key of the object to get.
- Name
If-MatchNot SupportedHeader- Description
- Return the object only if its entity tag (ETag) is the same as the one specified in this header; otherwise, return a 412 Precondition Failed error.
- Name
If-Modified-SinceNot SupportedHeader- Description
- Return the object only if it has been modified since the specified time; otherwise, return a 304 Not Modified error.
- Name
If-None-MatchNot SupportedHeader- Description
- Return the object only if its entity tag (ETag) is different from the one specified in this header; otherwise, return a 304 Not Modified error.
- Name
If-Unmodified-SinceNot SupportedHeader- Description
- Return the object only if it has not been modified since the specified time; otherwise, return a 412 Precondition Failed error.
- Name
RangeNot SupportedHeader- Description
- HeadObject returns only the metadata for an object. If the Range is satisfiable, only the ContentLength is affected in the response. If the Range is not satisfiable, S3 returns a 416 - Requested Range Not Satisfiable error.
- Name
partNumberNot SupportedHeader- Description
- Part number of the object being read. This is a positive integer between 1 and 10,000. Effectively performs a 'ranged' HEAD request for the part specified. Useful querying about the size of the part and the number of parts in this object.
- Name
response-cache-controlNot SupportedHeader- Description
- Sets the Cache-Control header of the response.
- Name
response-content-dispositionNot SupportedHeader- Description
- Sets the Content-Disposition header of the response.
- Name
response-content-encodingNot SupportedHeader- Description
- Sets the Content-Encoding header of the response.
- Name
response-content-languageNot SupportedHeader- Description
- Sets the Content-Language header of the response.
- Name
response-content-typeNot SupportedHeader- Description
- Sets the Content-Type header of the response.
- Name
response-expiresNot SupportedHeader- Description
- Sets the Expires header of the response.
- Name
x-amz-checksum-modeNot SupportedHeader- Description
- To retrieve the checksum, this mode must be enabled.
- Name
x-amz-expected-bucket-owner- Type
- string Not SupportedHeader
- Description
- The account ID of the expected bucket owner.
- Name
x-amz-request-payer- Type
- string Not SupportedHeader
- Description
- Confirms that the requester knows that they will be charged for the request.
- Name
x-amz-server-side-encryption-customer-algorithm- Type
- string Not SupportedHeader
- Description
- pecifies the algorithm to use when decrypting the object (for example, AES256).
- Name
x-amz-server-side-encryption-customer-keyNot SupportedHeader- Description
- The server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm.
- Name
x-amz-server-side-encryption-customer-key-MD5Not SupportedHeader- Description
- The MD5 server-side encryption (SSE) customer managed key. This parameter is needed only when the object was created using a checksum algorithm.
- Name
VersionId- Type
- string Not SupportedQuery
- Description
- Version ID used to reference a specific version of the object.
Response Properties
- Name
Cache-ControlNot SupportedHeader- Description
- Specifies caching behavior along the request/reply chain.
- Name
Content-DispositionNot SupportedHeader- Description
- Specifies presentational information for the object.
- Name
Content-EncodingNot SupportedHeader- Description
- Indicates what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
- Name
Content-LanguageNot SupportedHeader- Description
- The language the content is in.
- Name
Content-LengthNot SupportedHeader- Description
- Size of the body in bytes.
- Name
Content-TypeNot SupportedHeader- Description
- A standard MIME type describing the format of the object data.
- Name
ETagNot SupportedHeader- Description
- An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
- Name
ExpiresNot SupportedHeader- Description
- The date and time at which the object is no longer cacheable.
- Name
Last-ModifiedNot SupportedHeader- Description
- Date and time when the object was last modified.
- Name
accept-rangesNot SupportedHeader- Description
- Indicates that a range of bytes was specified in the request.
- Name
x-amz-archive-statusNot SupportedHeader- Description
- The archive state of the head object.
- Name
x-amz-checksum-crc32Not SupportedHeader- Description
- The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object.
- Name
x-amz-checksum-crc32cNot SupportedHeader- Description
- The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object.
- Name
x-amz-checksum-sha1Not SupportedHeader- Description
- The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object.
- Name
x-amz-checksum-sha256Not SupportedHeader- Description
- The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object.
- Name
x-amz-delete-markerNot SupportedHeader- Description
- Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
- Name
x-amz-expirationNot SupportedHeader- Description
- If the object expiration is configured (see PutBucketLifecycleConfiguration), the response includes this header.
- Name
x-amz-missing-metaNot SupportedHeader- Description
- This is set to the number of metadata entries not returned in the headers that are prefixed with x-amz-meta-.
- Name
x-amz-mp-parts-countNot SupportedHeader- Description
- The count of parts this object has.
- Name
x-amz-object-lock-legal-holdNot SupportedHeader- Description
- Indicates whether this object has an active legal hold.
- Name
x-amz-object-lock-modeNot SupportedHeader- Description
- The Object Lock mode that's currently in place for this object.
- Name
x-amz-object-lock-retain-until-dateNot SupportedHeader- Description
- The date and time when this object's Object Lock will expire.
- Name
x-amz-replication-statusNot SupportedHeader- Description
- Anzen Store can return this if your request involves a bucket that is either a source or destination in a replication rule.
- Name
x-amz-request-chargedNot SupportedHeader- Description
- If present, indicates that the requester was successfully charged for the request.
- Name
x-amz-restoreNot SupportedHeader- Description
- Provides information about object restoration action and expiration time of the restored object copy.
- Name
x-amz-server-side-encryptionNot SupportedHeader- Description
- The server-side encryption algorithm used when you store this object in Anzen Store (for example, AES256, aws:kms, aws:kms:dsse).
- Name
x-amz-server-side-encryption-aws-kms-key-idNot SupportedHeader- Description
- If present, indicates the ID of the AWS Key Management Service (AWS KMS) symmetric encryption customer managed key that was used for the object.
- Name
x-amz-server-side-encryption-bucket-key-enabledNot SupportedHeader- Description
- Indicates whether the object uses an S3 Bucket Key for server-side encryption with AWS Key Management Service (AWS KMS) keys (SSE-KMS).
- Name
x-amz-server-side-encryption-customer-algorithmNot SupportedHeader- Description
- If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
- Name
x-amz-server-side-encryption-customer-key-MD5Not SupportedHeader- Description
- If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
- Name
x-amz-storage-classNot SupportedHeader- Description
- Provides storage class information of the object.
- Name
x-amz-version-idNot SupportedHeader- Description
- Version ID of the object.
- Name
x-amz-website-redirect-locationNot SupportedHeader- Description
- If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Anzen Store stores the value of this header in the object metadata.
Request
HEAD /Key+?partNumber=PartNumber&response-cache-control=ResponseCacheControl&response-content-disposition=ResponseContentDisposition&response-content-encoding=ResponseContentEncoding&response-content-language=ResponseContentLanguage&response-content-type=ResponseContentType&response-expires=ResponseExpires&versionId=VersionId HTTP/1.1
Host: Bucket.Endpoint
If-Match: IfMatch
If-Modified-Since: IfModifiedSince
If-None-Match: IfNoneMatch
If-Unmodified-Since: IfUnmodifiedSince
Range: Range
x-amz-server-side-encryption-customer-algorithm: SSECustomerAlgorithm
x-amz-server-side-encryption-customer-key: SSECustomerKey
x-amz-server-side-encryption-customer-key-MD5: SSECustomerKeyMD5
x-amz-request-payer: RequestPayer
x-amz-expected-bucket-owner: ExpectedBucketOwner
x-amz-checksum-mode: ChecksumModeResponse
HTTP/1.1 200
x-amz-delete-marker: DeleteMarker
accept-ranges: AcceptRanges
x-amz-expiration: Expiration
x-amz-restore: Restore
x-amz-archive-status: ArchiveStatus
Last-Modified: LastModified
Content-Length: ContentLength
x-amz-checksum-crc32: ChecksumCRC32
x-amz-checksum-crc32c: ChecksumCRC32C
x-amz-checksum-sha1: ChecksumSHA1
x-amz-checksum-sha256: ChecksumSHA256
ETag: ETag
x-amz-missing-meta: MissingMeta
x-amz-version-id: VersionId
Cache-Control: CacheControl
Content-Disposition: ContentDisposition
Content-Encoding: ContentEncoding
Content-Language: ContentLanguage
Content-Type: ContentType
Expires: Expires
x-amz-website-redirect-location: WebsiteRedirectLocation
x-amz-server-side-encryption: ServerSideEncryption
x-amz-server-side-encryption-customer-algorithm: SSECustomerAlgorithm
x-amz-server-side-encryption-customer-key-MD5: SSECustomerKeyMD5
x-amz-server-side-encryption-aws-kms-key-id: SSEKMSKeyId
x-amz-server-side-encryption-bucket-key-enabled: BucketKeyEnabled
x-amz-storage-class: StorageClass
x-amz-request-charged: RequestCharged
x-amz-replication-status: ReplicationStatus
x-amz-mp-parts-count: PartsCount
x-amz-object-lock-mode: ObjectLockMode
x-amz-object-lock-retain-until-date: ObjectLockRetainUntilDate
x-amz-object-lock-legal-hold: ObjectLockLegalHoldStatusListObjectsV2
Returns some or all (up to 1,000) of the objects in a bucket with each request. You can use the request parameters as selection criteria to return a subset of the objects in a bucket. A 200 OK response can contain valid or invalid XML. Make sure to design your application to parse the contents of the response and handle it appropriately.
Request Properties
- Name
Bucket- Type
- string SupportedRequiredPath
- Description
- Represents the bucket within which the object exsits.
- Name
x-amz-expected-bucket-owner- Type
- string Not SupportedHeader
- Description
- The account ID of the expected bucket owner.
- Name
x-amz-optional-object-attributes- Type
- string Not SupportedHeader
- Description
- Specifies the optional fields that you want returned in the response.
- Name
x-amz-request-payer- Type
- string Not SupportedHeader
- Description
- Confirms that the requester knows that they will be charged for the request.
- Name
continuation-tokenNot SupportedQuery- Description
- ContinuationToken indicates to Amazon S3 that the list is being continued on this bucket with a token. ContinuationToken is obfuscated and is not a real key. You can use this ContinuationToken for pagination of the list results.
- Name
delimiterSupportedQuery- Description
- A delimiter is a character that you use to group keys.
- Name
encoding-typeNot SupportedQuery- Description
- Encoding type used by AnzenStore to encode the object keys in the response.
- Name
fetch-ownerNot SupportedQuery- Description
- The owner field is not present in ListObjectsV2 by default. If you want to return the owner field with each key in the result, then set the FetchOwner field to true.
- Name
max-keysSupportedQuery- Description
- Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
- Name
prefixSupportedQuery- Description
- Limits the response to keys that begin with the specified prefix.
- Name
start-afterNot SupportedQuery- Description
- StartAfter is where you want Anzen Store to start listing from. Amazon S3 starts listing after this specified key. StartAfter can be any key in the bucket.
Response Properties
- Name
x-amz-request-chargedNot SupportedHeader- Description
- If present, indicates that the requester was successfully charged for the request.
- Name
CommonPrefixes- Type
- CommonPrefixes SupportedBody
- Description
- All of the keys (up to 1,000) that share the same prefix are grouped together.
- Name
Contents- Type
- Contents SupportedBody
- Description
- Metadata about each object returned.
- Name
ContinuationToken- Type
- string SupportedBody
- Description
- If ContinuationToken was sent with the request, it is included in the response. You can use the returned ContinuationToken for pagination of the list response. You can use this ContinuationToken for pagination of the list results.
- Name
Delimiter- Type
- string SupportedBody
- Description
- Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.
- Name
EncodingType- Type
- string SupportedBody
- Description
- Encoding type used by Anzen Store to encode object key names in the XML response. If you specify the encoding-type request parameter, Anzen Store includes this element in the response, and returns encoded key name values in the following response elements: Delimiter, Prefix, Key, and StartAfter.
- Name
IsTruncated- Type
- boolean Not SupportedBody
- Description
- Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.
- Name
KeyCount- Type
- Integer Not SupportedBody
- Description
- KeyCount is the number of keys returned with this request. KeyCount will always be less than or equal to the MaxKeys field. For example, if you ask for 50 keys, your result will include 50 keys or fewer.
- Name
ListBucketResult- Type
- ListBucketResult SupportedBody
- Description
- Root level tag for the ListBucketResult parameters.
- Name
MaxKeys- Type
- Integer Not SupportedBody
- Description
- Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
- Name
Name- Type
- string Not SupportedBody
- Description
- The bucket name.
- Name
NextContinuationToken- Type
- string Not SupportedBody
- Description
- NextContinuationToken is sent when isTruncated is true, which means there are more keys in the bucket that can be listed. The next list requests to Anzen Store can be continued with this NextContinuationToken. NextContinuationToken is obfuscated and is not a real key
- Name
Prefix- Type
- string Not SupportedBody
- Description
- Keys that begin with the indicated prefix.
- Name
StartAfter- Type
- string Not SupportedBody
- Description
- If StartAfter was sent with the request, it is included in the response.
Request
GET /?list-type=2&continuation-token=ContinuationToken&delimiter=Delimiter&encoding-type=EncodingType&fetch-owner=FetchOwner&max-keys=MaxKeys&prefix=Prefix&start-after=StartAfter HTTP/1.1
Host: Bucket.Endpoint
x-amz-request-payer: RequestPayer
x-amz-expected-bucket-owner: ExpectedBucketOwner
x-amz-optional-object-attributes: OptionalObjectAttributesResponse
HTTP/1.1 200
x-amz-request-charged: RequestCharged
<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult>
<IsTruncated>boolean</IsTruncated>
<Contents>
<ChecksumAlgorithm>string</ChecksumAlgorithm>
...
<ETag>string</ETag>
<Key>string</Key>
<LastModified>timestamp</LastModified>
<Owner>
<DisplayName>string</DisplayName>
<ID>string</ID>
</Owner>
<RestoreStatus>
<IsRestoreInProgress>boolean</IsRestoreInProgress>
<RestoreExpiryDate>timestamp</RestoreExpiryDate>
</RestoreStatus>
<Size>long</Size>
<StorageClass>string</StorageClass>
</Contents>
...
<Name>string</Name>
<Prefix>string</Prefix>
<Delimiter>string</Delimiter>
<MaxKeys>integer</MaxKeys>
<CommonPrefixes>
<Prefix>string</Prefix>
</CommonPrefixes>
...
<EncodingType>string</EncodingType>
<KeyCount>integer</KeyCount>
<ContinuationToken>string</ContinuationToken>
<NextContinuationToken>string</NextContinuationToken>
<StartAfter>string</StartAfter>
</ListBucketResult>ListObjects
Request Properties
- Name
Bucket- Type
- string SupportedRequiredPath
- Description
- Represents the bucket within which the object exsits.
- Name
x-amz-expected-bucket-owner- Type
- string Not SupportedHeader
- Description
- The account ID of the expected bucket owner.
- Name
x-amz-optional-object-attributes- Type
- string Not SupportedHeader
- Description
- Specifies the optional fields that you want returned in the response.
- Name
x-amz-request-payer- Type
- string Not SupportedHeader
- Description
- Confirms that the requester knows that they will be charged for the request.
- Name
delimiterSupportedQuery- Description
- A delimiter is a character that you use to group keys.
- Name
encoding-typeNot SupportedQuery- Description
- Encoding type used by AnzenStore to encode the object keys in the response.
- Name
markerNot SupportedQuery- Description
- Marker is where you want Anzen Store to start listing from. Anzen Store starts listing after this specified key. Marker can be any key in the bucket.
- Name
max-keysSupportedQuery- Description
- Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
- Name
prefixSupportedQuery- Description
- Limits the response to keys that begin with the specified prefix.
Response Properties
- Name
x-amz-request-chargedNot SupportedHeader- Description
- If present, indicates that the requester was successfully charged for the request.
- Name
CommonPrefixes- Type
- CommonPrefixes SupportedBody
- Description
- All of the keys (up to 1,000) that share the same prefix are grouped together.
- Name
Contents- Type
- Contents SupportedBody
- Description
- Metadata about each object returned.
- Name
Delimiter- Type
- string SupportedBody
- Description
- Causes keys that contain the same string between the prefix and the first occurrence of the delimiter to be rolled up into a single result element in the CommonPrefixes collection. These rolled-up keys are not returned elsewhere in the response. Each rolled-up result counts as only one return against the MaxKeys value.
- Name
EncodingType- Type
- string SupportedBody
- Description
- Encoding type used by Anzen Store to encode object key names in the XML response. If you specify the encoding-type request parameter, Anzen Store includes this element in the response, and returns encoded key name values in the following response elements: Delimiter, Prefix, Key, and StartAfter.
- Name
IsTruncated- Type
- boolean Not SupportedBody
- Description
- Set to false if all of the results were returned. Set to true if more keys are available to return. If the number of results exceeds that specified by MaxKeys, all of the results might not be returned.
- Name
ListBucketResult- Type
- ListBucketResult SupportedBody
- Description
- Root level tag for the ListBucketResult parameters.
- Name
Marker- Type
- string Not SupportedBody
- Description
- Indicates where in the bucket listing begins. Marker is included in the response if it was sent with the request.
- Name
MaxKeys- Type
- Integer Not SupportedBody
- Description
- Sets the maximum number of keys returned in the response. By default, the action returns up to 1,000 key names. The response might contain fewer keys but will never contain more.
- Name
Name- Type
- string Not SupportedBody
- Description
- The bucket name.
- Name
NextMarker- Type
- string Not SupportedBody
- Description
- When the response is truncated (the IsTruncated element value in the response is true) , you can use the key name in this field as the marker parameter in the subsequent request to get the next set of objects. Anzen Store lists objects in alphabetical order.
- Name
Prefix- Type
- string Not SupportedBody
- Description
- Keys that begin with the indicated prefix.
Request
GET /?delimiter=Delimiter&encoding-type=EncodingType&marker=Marker&max-keys=MaxKeys&prefix=Prefix HTTP/1.1
Host: Bucket.Endpoint
x-amz-request-payer: RequestPayer
x-amz-expected-bucket-owner: ExpectedBucketOwner
x-amz-optional-object-attributes: OptionalObjectAttributesResponse
HTTP/1.1 200
x-amz-request-charged: RequestCharged
<?xml version="1.0" encoding="UTF-8"?>
<ListBucketResult>
<IsTruncated>boolean</IsTruncated>
<Marker>string</Marker>
<NextMarker>string</NextMarker>
<Contents>
<ChecksumAlgorithm>string</ChecksumAlgorithm>
...
<ETag>string</ETag>
<Key>string</Key>
<LastModified>timestamp</LastModified>
<Owner>
<DisplayName>string</DisplayName>
<ID>string</ID>
</Owner>
<RestoreStatus>
<IsRestoreInProgress>boolean</IsRestoreInProgress>
<RestoreExpiryDate>timestamp</RestoreExpiryDate>
</RestoreStatus>
<Size>long</Size>
<StorageClass>string</StorageClass>
</Contents>
...
<Name>string</Name>
<Prefix>string</Prefix>
<Delimiter>string</Delimiter>
<MaxKeys>integer</MaxKeys>
<CommonPrefixes>
<Prefix>string</Prefix>
</CommonPrefixes>
...
<EncodingType>string</EncodingType>
</ListBucketResult>PutObject
Adds an object to a bucket.
Request Properties
- Name
Bucket- Type
- string SupportedRequiredPath
- Description
- The bucket name to which the PUT action was initiated.
- Name
Key- Type
- string SupportedRequiredPath
- Description
- The key name for the object that you want upload in parts.
- Name
Content-DispositionSupportedHeader- Description
- Specifies presentational information for the object.
- Name
Content-LengthSupportedHeader- Description
- Size of the body in bytes. This parameter is useful when the size of the body cannot be determined automatically.
- Name
Content-MD5SupportedHeader- Description
- The base64-encoded 128-bit MD5 digest of the message (without the headers) according to RFC 1864. This header can be used as a message integrity check to verify that the data is the same data that was originally sent.
- Name
ExpiresSupportedHeader- Description
- The date and time at which the object is no longer cacheable.
- Name
If-None-MatchNot SupportedHeader- Description
- Uploads the object only if the object key name does not already exist in the bucket specified. Otherwise, Anzen Store returns a 412 Precondition Failed error.
- Name
cache-controlSupportedHeader- Description
- Specifies caching behavior along the request/reply chain.
- Name
content-EncodingSupportedHeader- Description
- Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.
- Name
content-LanguageSupportedHeader- Description
- The language that the content is in.
- Name
content-TypeSupportedHeader- Description
- A standard MIME type describing the format of the object data.
- Name
x-amz-aclNot SupportedHeader- Description
- The canned ACL to apply to the object. Anzen Store supports a set of predefined ACLs, known as canned ACLs. Each canned ACL has a predefined set of grantees and permissions.
- Name
x-amz-checksum-crc32Not SupportedHeader- Description
- This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32 checksum of the object.
- Name
x-amz-checksum-crc32cNot SupportedHeader- Description
- This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 32-bit CRC32C checksum of the object.
- Name
x-amz-checksum-sha1Not SupportedHeader- Description
- This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 160-bit SHA-1 digest of the object.
- Name
x-amz-checksum-sha256Not SupportedHeader- Description
- This header can be used as a data integrity check to verify that the data received is the same data that was originally sent. This header specifies the base64-encoded, 256-bit SHA-256 digest of the object.
- Name
x-amz-expected-bucket-owner- Type
- string Not SupportedHeader
- Description
- The account ID of the expected bucket owner.
- Name
x-amz-grant-full-controlNot SupportedHeader- Description
- Specify access permissions explicitly to give the grantee READ, READ_ACP, and WRITE_ACP permissions on the object.
- Name
x-amz-grant-readNot SupportedHeader- Description
- Specify access permissions explicitly to allow grantee to read the object data and its metadata.
- Name
x-amz-grant-read-acpNot SupportedHeader- Description
- Specify access permissions explicitly to allows grantee to read the object ACL.
- Name
x-amz-grant-write-acpNot SupportedHeader- Description
- Specify access permissions explicitly to allows grantee to allow grantee to write the ACL for the applicable object.
- Name
x-amz-object-lock-legal-holdNot SupportedHeader- Description
- Specifies whether you want to apply a legal hold to the uploaded object.
- Name
x-amz-object-lock-modeNot SupportedHeader- Description
- Specifies the Object Lock mode that you want to apply to the uploaded object.
- Name
x-amz-object-lock-retain-until-dateNot SupportedHeader- Description
- Specifies the date and time when you want the Object Lock to expire.
- Name
x-amz-request-payer- Type
- string Not SupportedHeader
- Description
- Confirms that the requester knows that they will be charged for the request.
- Name
x-amz-sdk-checksum-algorithmNot SupportedHeader- Description
- Indicates the algorithm used to create the checksum for the object when you use the SDK.
- Name
x-amz-server-side-encryptionNot SupportedHeader- Description
- The server-side encryption algorithm used when storing this object (for example, AES256, aws:kms).
- Name
x-amz-server-side-encryption-aws-kms-key-idNot SupportedHeader- Description
- If present, indicates the ID of the AWS Key Management Service (AWS KMS) symmetric encryption customer managed key that was used for the object
- Name
x-amz-server-side-encryption-bucket-key-enabledNot SupportedHeader- Description
- Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS Key Management Service (AWS KMS) keys (SSE-KMS).
- Name
x-amz-server-side-encryption-contextNot SupportedHeader- Description
- Specifies the AWS KMS Encryption Context to use for object encryption.
- Name
x-amz-server-side-encryption-customer-algorithmNot SupportedHeader- Description
- Specifies the algorithm to use when encrypting the object (for example, AES256).
- Name
x-amz-server-side-encryption-customer-keyNot SupportedHeader- Description
- Specifies the customer-provided encryption key for Anzen Store to use in encrypting data. This value is used to store the object and then it is discarded; Anzen Store does not store the encryption key. The key must be appropriate for use with the algorithm specified in the x-amz-server-side-encryption-customer-algorithm header.
- Name
x-amz-server-side-encryption-customer-key-MD5Not SupportedHeader- Description
- Specifies the 128-bit MD5 digest of the customer-provided encryption key according to RFC 1321. Anzen Store uses this header for a message integrity check to ensure that the encryption key was transmitted without error.
- Name
x-amz-storage-classNot SupportedHeader- Description
- By default, Anzen Store uses the STANDARD Storage Class to store newly created objects. The STANDARD storage class provides high durability and high availability. Depending on performance needs, you can specify a different Storage Class.
- Name
x-amz-taggingNot SupportedHeader- Description
- The tag-set for the object. The tag-set must be encoded as URL Query parameters.
- Name
x-amz-website-redirect-locationNot SupportedHeader- Description
- If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Anzen Store stores the value of this header in the object metadata.
Response Properties
- Name
ETagNot SupportedHeader- Description
- Entity tag for the uploaded object.
- Name
x-amz-checksum-crc32Not SupportedHeader- Description
- The base64-encoded, 32-bit CRC32 checksum of the object. This will only be present if it was uploaded with the object.
- Name
x-amz-checksum-crc32cNot SupportedHeader- Description
- The base64-encoded, 32-bit CRC32C checksum of the object. This will only be present if it was uploaded with the object.
- Name
x-amz-checksum-sha1Not SupportedHeader- Description
- The base64-encoded, 160-bit SHA-1 digest of the object. This will only be present if it was uploaded with the object.
- Name
x-amz-checksum-sha256Not SupportedHeader- Description
- The base64-encoded, 256-bit SHA-256 digest of the object. This will only be present if it was uploaded with the object.
- Name
x-amz-expirationNot SupportedHeader- Description
- If the object expiration is configured (see PutBucketLifecycleConfiguration), the response includes this header.
- Name
x-amz-request-chargedNot SupportedHeader- Description
- If present, indicates that the requester was successfully charged for the request.
- Name
x-amz-server-side-encryptionNot SupportedHeader- Description
- The server-side encryption algorithm used when storing this object (for example, AES256, aws:kms).
- Name
x-amz-server-side-encryption-aws-kms-key-idNot SupportedHeader- Description
- If present, indicates the ID of the AWS Key Management Service (AWS KMS) symmetric encryption customer managed key that was used for the object
- Name
x-amz-server-side-encryption-bucket-key-enabledNot SupportedHeader- Description
- Indicates whether the multipart upload uses an S3 Bucket Key for server-side encryption with AWS Key Management Service (AWS KMS) keys (SSE-KMS).
- Name
x-amz-server-side-encryption-contextNot SupportedHeader- Description
- If present, indicates the AWS KMS Encryption Context to use for object encryption. The value of this header is a base64-encoded UTF-8 string holding JSON with the encryption context key-value pairs.
- Name
x-amz-server-side-encryption-customer-algorithmNot SupportedHeader- Description
- If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's used.
- Name
x-amz-server-side-encryption-customer-key-MD5Not SupportedHeader- Description
- If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide the round-trip message integrity verification of the customer-provided encryption key.
- Name
x-amz-version-idNot SupportedHeader- Description
- Version ID of the object.
Request
PUT /Key+ HTTP/1.1
Host: Bucket.Endpoint
x-amz-acl: ACL
Cache-Control: CacheControl
Content-Disposition: ContentDisposition
Content-Encoding: ContentEncoding
Content-Language: ContentLanguage
Content-Length: ContentLength
Content-MD5: ContentMD5
Content-Type: ContentType
x-amz-sdk-checksum-algorithm: ChecksumAlgorithm
x-amz-checksum-crc32: ChecksumCRC32
x-amz-checksum-crc32c: ChecksumCRC32C
x-amz-checksum-sha1: ChecksumSHA1
x-amz-checksum-sha256: ChecksumSHA256
Expires: Expires
If-None-Match: IfNoneMatch
x-amz-grant-full-control: GrantFullControl
x-amz-grant-read: GrantRead
x-amz-grant-read-acp: GrantReadACP
x-amz-grant-write-acp: GrantWriteACP
x-amz-server-side-encryption: ServerSideEncryption
x-amz-storage-class: StorageClass
x-amz-website-redirect-location: WebsiteRedirectLocation
x-amz-server-side-encryption-customer-algorithm: SSECustomerAlgorithm
x-amz-server-side-encryption-customer-key: SSECustomerKey
x-amz-server-side-encryption-customer-key-MD5: SSECustomerKeyMD5
x-amz-server-side-encryption-aws-kms-key-id: SSEKMSKeyId
x-amz-server-side-encryption-context: SSEKMSEncryptionContext
x-amz-server-side-encryption-bucket-key-enabled: BucketKeyEnabled
x-amz-request-payer: RequestPayer
x-amz-tagging: Tagging
x-amz-object-lock-mode: ObjectLockMode
x-amz-object-lock-retain-until-date: ObjectLockRetainUntilDate
x-amz-object-lock-legal-hold: ObjectLockLegalHoldStatus
x-amz-expected-bucket-owner: ExpectedBucketOwner
BodyResponse
HTTP/1.1 200
x-amz-expiration: Expiration
ETag: ETag
x-amz-checksum-crc32: ChecksumCRC32
x-amz-checksum-crc32c: ChecksumCRC32C
x-amz-checksum-sha1: ChecksumSHA1
x-amz-checksum-sha256: ChecksumSHA256
x-amz-server-side-encryption: ServerSideEncryption
x-amz-version-id: VersionId
x-amz-server-side-encryption-customer-algorithm: SSECustomerAlgorithm
x-amz-server-side-encryption-customer-key-MD5: SSECustomerKeyMD5
x-amz-server-side-encryption-aws-kms-key-id: SSEKMSKeyId
x-amz-server-side-encryption-context: SSEKMSEncryptionContext
x-amz-server-side-encryption-bucket-key-enabled: BucketKeyEnabled
x-amz-request-charged: RequestCharged