@Mutable @NotThreadSafe public static interface HeadObjectResponse.Builder extends S3Response.Builder, SdkPojo, CopyableBuilder<HeadObjectResponse.Builder,HeadObjectResponse>
| Modifier and Type | Method and Description |
|---|---|
HeadObjectResponse.Builder |
acceptRanges(String acceptRanges)
Indicates that a range of bytes was specified.
|
HeadObjectResponse.Builder |
archiveStatus(ArchiveStatus archiveStatus)
The archive state of the head object.
|
HeadObjectResponse.Builder |
archiveStatus(String archiveStatus)
The archive state of the head object.
|
HeadObjectResponse.Builder |
bucketKeyEnabled(Boolean bucketKeyEnabled)
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service
(KMS) keys (SSE-KMS).
|
HeadObjectResponse.Builder |
cacheControl(String cacheControl)
Specifies caching behavior along the request/reply chain.
|
HeadObjectResponse.Builder |
checksumCRC32(String checksumCRC32)
The Base64 encoded, 32-bit
CRC32 checksum of the object. |
HeadObjectResponse.Builder |
checksumCRC32C(String checksumCRC32C)
The Base64 encoded, 32-bit
CRC32C checksum of the object. |
HeadObjectResponse.Builder |
checksumCRC64NVME(String checksumCRC64NVME)
The Base64 encoded, 64-bit
CRC64NVME checksum of the object. |
HeadObjectResponse.Builder |
checksumSHA1(String checksumSHA1)
The Base64 encoded, 160-bit
SHA1 digest of the object. |
HeadObjectResponse.Builder |
checksumSHA256(String checksumSHA256)
The Base64 encoded, 256-bit
SHA256 digest of the object. |
HeadObjectResponse.Builder |
checksumType(ChecksumType checksumType)
The checksum type, which determines how part-level checksums are combined to create an object-level checksum
for multipart objects.
|
HeadObjectResponse.Builder |
checksumType(String checksumType)
The checksum type, which determines how part-level checksums are combined to create an object-level checksum
for multipart objects.
|
HeadObjectResponse.Builder |
contentDisposition(String contentDisposition)
Specifies presentational information for the object.
|
HeadObjectResponse.Builder |
contentEncoding(String contentEncoding)
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.
|
HeadObjectResponse.Builder |
contentLanguage(String contentLanguage)
The language the content is in.
|
HeadObjectResponse.Builder |
contentLength(Long contentLength)
Size of the body in bytes.
|
HeadObjectResponse.Builder |
contentRange(String contentRange)
The portion of the object returned in the response for a
GET request. |
HeadObjectResponse.Builder |
contentType(String contentType)
A standard MIME type describing the format of the object data.
|
HeadObjectResponse.Builder |
deleteMarker(Boolean deleteMarker)
Specifies whether the object retrieved was (true) or was not (false) a Delete Marker.
|
HeadObjectResponse.Builder |
eTag(String eTag)
An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource
found at a URL.
|
HeadObjectResponse.Builder |
expiration(String expiration)
If the object expiration is configured (see
PutBucketLifecycleConfiguration ), the response includes this header. |
HeadObjectResponse.Builder |
expires(Instant expires)
Deprecated.
Usage of the Expires field is deprecated in favor of the more flexible and less error prone
ExpiresString
|
HeadObjectResponse.Builder |
expiresString(String expiresString)
The date and time at which the object is no longer cacheable
|
HeadObjectResponse.Builder |
ibmRestoredCopyStorageClass(String ibmRestoredCopyStorageClass) |
HeadObjectResponse.Builder |
ibmTransition(String ibmTransitionId) |
HeadObjectResponse.Builder |
lastModified(Instant lastModified)
Date and time when the object was last modified.
|
HeadObjectResponse.Builder |
metadata(Map<String,String> metadata)
A map of metadata to store with the object in S3.
|
HeadObjectResponse.Builder |
missingMeta(Integer missingMeta)
This is set to the number of metadata entries not returned in
x-amz-meta headers. |
HeadObjectResponse.Builder |
objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
Specifies whether a legal hold is in effect for this object.
|
HeadObjectResponse.Builder |
objectLockLegalHoldStatus(String objectLockLegalHoldStatus)
Specifies whether a legal hold is in effect for this object.
|
HeadObjectResponse.Builder |
objectLockMode(ObjectLockMode objectLockMode)
The Object Lock mode, if any, that's in effect for this object.
|
HeadObjectResponse.Builder |
objectLockMode(String objectLockMode)
The Object Lock mode, if any, that's in effect for this object.
|
HeadObjectResponse.Builder |
objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
The date and time when the Object Lock retention period expires.
|
HeadObjectResponse.Builder |
partsCount(Integer partsCount)
The count of parts this object has.
|
HeadObjectResponse.Builder |
replicationStatus(ReplicationStatus replicationStatus)
Amazon S3 can return this header if your request involves a bucket that is either a source or a destination
in a replication rule.
|
HeadObjectResponse.Builder |
replicationStatus(String replicationStatus)
Amazon S3 can return this header if your request involves a bucket that is either a source or a destination
in a replication rule.
|
HeadObjectResponse.Builder |
requestCharged(RequestCharged requestCharged)
Sets the value of the RequestCharged property for this object.
|
HeadObjectResponse.Builder |
requestCharged(String requestCharged)
Sets the value of the RequestCharged property for this object.
|
HeadObjectResponse.Builder |
restore(String restore)
If the object is an archived object (an object whose storage class is GLACIER), the response includes this
header if either the archive restoration is in progress (see RestoreObject or an archive
copy is already restored.
|
HeadObjectResponse.Builder |
retentionExpirationDate(Instant retentionExpirationDate)
Date on which it will be legal to delete or modify the object.
|
HeadObjectResponse.Builder |
retentionLegalHoldCount(Integer retentionLegalHoldCount)
The number of legal holds applied to the object.
|
HeadObjectResponse.Builder |
retentionPeriod(Long retentionPeriod)
Retention period to store on the object in seconds.
|
HeadObjectResponse.Builder |
serverSideEncryption(ServerSideEncryption serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256, aws:kms, aws:kms:dsse). |
HeadObjectResponse.Builder |
serverSideEncryption(String serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256, aws:kms, aws:kms:dsse). |
HeadObjectResponse.Builder |
sseCustomerAlgorithm(String sseCustomerAlgorithm)
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.
|
HeadObjectResponse.Builder |
sseCustomerKeyMD5(String sseCustomerKeyMD5)
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.
|
HeadObjectResponse.Builder |
ssekmsKeyId(String ssekmsKeyId)
If present, indicates the ID of the KMS key that was used for object encryption.
|
HeadObjectResponse.Builder |
storageClass(StorageClass storageClass)
Provides storage class information of the object.
|
HeadObjectResponse.Builder |
storageClass(String storageClass)
Provides storage class information of the object.
|
HeadObjectResponse.Builder |
versionId(String versionId)
Version ID of the object.
|
HeadObjectResponse.Builder |
websiteRedirectLocation(String websiteRedirectLocation)
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.
|
build, responseMetadata, responseMetadatasdkHttpResponse, sdkHttpResponseequalsBySdkFields, sdkFieldNameToField, sdkFieldscopyapplyMutation, buildHeadObjectResponse.Builder deleteMarker(Boolean deleteMarker)
Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.
This functionality is not supported for directory buckets.
deleteMarker - Specifies whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this
response header does not appear in the response. This functionality is not supported for directory buckets.
HeadObjectResponse.Builder acceptRanges(String acceptRanges)
Indicates that a range of bytes was specified.
acceptRanges - Indicates that a range of bytes was specified.HeadObjectResponse.Builder expiration(String expiration)
If the object expiration is configured (see
PutBucketLifecycleConfiguration ), the response includes this header. It includes the
expiry-date and rule-id key-value pairs providing object expiration information.
The value of the rule-id is URL-encoded.
Object expiration information is not returned in directory buckets and this header returns the value "
NotImplemented" in all responses for directory buckets.
expiration - If the object expiration is configured (see
PutBucketLifecycleConfiguration ), the response includes this header. It includes the
expiry-date and rule-id key-value pairs providing object expiration
information. The value of the rule-id is URL-encoded.
Object expiration information is not returned in directory buckets and this header returns the value "
NotImplemented" in all responses for directory buckets.
HeadObjectResponse.Builder restore(String restore)
If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.
If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:
x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"
If the object restoration is in progress, the header returns the value ongoing-request="true".
For more information about archiving objects, see Transitioning Objects: General Considerations.
This functionality is not supported for directory buckets. Directory buckets only support
EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and
ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
restore - If the object is an archived object (an object whose storage class is GLACIER), the response includes
this header if either the archive restoration is in progress (see RestoreObject or an
archive copy is already restored.
If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:
x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"
If the object restoration is in progress, the header returns the value
ongoing-request="true".
For more information about archiving objects, see Transitioning Objects: General Considerations.
This functionality is not supported for directory buckets. Directory buckets only support
EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and
ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.
HeadObjectResponse.Builder archiveStatus(String archiveStatus)
The archive state of the head object.
This functionality is not supported for directory buckets.
archiveStatus - The archive state of the head object. This functionality is not supported for directory buckets.
ArchiveStatus,
ArchiveStatusHeadObjectResponse.Builder archiveStatus(ArchiveStatus archiveStatus)
The archive state of the head object.
This functionality is not supported for directory buckets.
archiveStatus - The archive state of the head object. This functionality is not supported for directory buckets.
ArchiveStatus,
ArchiveStatusHeadObjectResponse.Builder lastModified(Instant lastModified)
Date and time when the object was last modified.
lastModified - Date and time when the object was last modified.HeadObjectResponse.Builder contentLength(Long contentLength)
Size of the body in bytes.
contentLength - Size of the body in bytes.HeadObjectResponse.Builder checksumCRC32(String checksumCRC32)
The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only be present if the
checksum was uploaded with the object. When you use an API operation on an object that was uploaded using
multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a
calculation based on the checksum values of each individual part. For more information about how checksums
are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
checksumCRC32 - The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only be present
if the checksum was uploaded with the object. When you use an API operation on an object that was
uploaded using multipart uploads, this value may not be a direct checksum value of the full object.
Instead, it's a calculation based on the checksum values of each individual part. For more information
about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.HeadObjectResponse.Builder checksumCRC32C(String checksumCRC32C)
The Base64 encoded, 32-bit CRC32C checksum of the object. This checksum is only present if the
checksum was uploaded with the object. When you use an API operation on an object that was uploaded using
multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a
calculation based on the checksum values of each individual part. For more information about how checksums
are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
checksumCRC32C - The Base64 encoded, 32-bit CRC32C checksum of the object. This checksum is only present
if the checksum was uploaded with the object. When you use an API operation on an object that was
uploaded using multipart uploads, this value may not be a direct checksum value of the full object.
Instead, it's a calculation based on the checksum values of each individual part. For more information
about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.HeadObjectResponse.Builder checksumCRC64NVME(String checksumCRC64NVME)
The Base64 encoded, 64-bit CRC64NVME checksum of the object. For more information, see Checking object
integrity in the Amazon S3 User Guide.
checksumCRC64NVME - The Base64 encoded, 64-bit CRC64NVME checksum of the object. For more information, see Checking
object integrity in the Amazon S3 User Guide.HeadObjectResponse.Builder checksumSHA1(String checksumSHA1)
The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object
was uploaded with the object. When you use the API operation on an object that was uploaded using multipart
uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based
on the checksum values of each individual part. For more information about how checksums are calculated with
multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
checksumSHA1 - The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the
object was uploaded with the object. When you use the API operation on an object that was uploaded
using multipart uploads, this value may not be a direct checksum value of the full object. Instead,
it's a calculation based on the checksum values of each individual part. For more information about
how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.HeadObjectResponse.Builder checksumSHA256(String checksumSHA256)
The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object
was uploaded with the object. When you use an API operation on an object that was uploaded using multipart
uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based
on the checksum values of each individual part. For more information about how checksums are calculated with
multipart uploads, see Checking object integrity in the Amazon S3 User Guide.
checksumSHA256 - The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the
object was uploaded with the object. When you use an API operation on an object that was uploaded
using multipart uploads, this value may not be a direct checksum value of the full object. Instead,
it's a calculation based on the checksum values of each individual part. For more information about
how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.HeadObjectResponse.Builder checksumType(String checksumType)
The checksum type, which determines how part-level checksums are combined to create an object-level checksum
for multipart objects. You can use this header response to verify that the checksum type that is received is
the same checksum type that was specified in CreateMultipartUpload request. For more
information, see Checking object
integrity in the Amazon S3 User Guide.
checksumType - The checksum type, which determines how part-level checksums are combined to create an object-level
checksum for multipart objects. You can use this header response to verify that the checksum type that
is received is the same checksum type that was specified in CreateMultipartUpload
request. For more information, see Checking
object integrity in the Amazon S3 User Guide.ChecksumType,
ChecksumTypeHeadObjectResponse.Builder checksumType(ChecksumType checksumType)
The checksum type, which determines how part-level checksums are combined to create an object-level checksum
for multipart objects. You can use this header response to verify that the checksum type that is received is
the same checksum type that was specified in CreateMultipartUpload request. For more
information, see Checking object
integrity in the Amazon S3 User Guide.
checksumType - The checksum type, which determines how part-level checksums are combined to create an object-level
checksum for multipart objects. You can use this header response to verify that the checksum type that
is received is the same checksum type that was specified in CreateMultipartUpload
request. For more information, see Checking
object integrity in the Amazon S3 User Guide.ChecksumType,
ChecksumTypeHeadObjectResponse.Builder eTag(String eTag)
An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a resource found at a URL.
eTag - An entity tag (ETag) is an opaque identifier assigned by a web server to a specific version of a
resource found at a URL.HeadObjectResponse.Builder missingMeta(Integer missingMeta)
This is set to the number of metadata entries not returned in x-amz-meta headers. This can
happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API.
For example, using SOAP, you can create metadata whose values are not legal HTTP headers.
This functionality is not supported for directory buckets.
missingMeta - This is set to the number of metadata entries not returned in x-amz-meta headers. This
can happen if you create metadata using an API like SOAP that supports more flexible metadata than the
REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP
headers. This functionality is not supported for directory buckets.
HeadObjectResponse.Builder versionId(String versionId)
Version ID of the object.
This functionality is not supported for directory buckets.
versionId - Version ID of the object. This functionality is not supported for directory buckets.
HeadObjectResponse.Builder cacheControl(String cacheControl)
Specifies caching behavior along the request/reply chain.
cacheControl - Specifies caching behavior along the request/reply chain.HeadObjectResponse.Builder contentDisposition(String contentDisposition)
Specifies presentational information for the object.
contentDisposition - Specifies presentational information for the object.HeadObjectResponse.Builder contentEncoding(String contentEncoding)
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.
contentEncoding - 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.HeadObjectResponse.Builder contentLanguage(String contentLanguage)
The language the content is in.
contentLanguage - The language the content is in.HeadObjectResponse.Builder contentType(String contentType)
A standard MIME type describing the format of the object data.
contentType - A standard MIME type describing the format of the object data.HeadObjectResponse.Builder contentRange(String contentRange)
The portion of the object returned in the response for a GET request.
contentRange - The portion of the object returned in the response for a GET request.@Deprecated HeadObjectResponse.Builder expires(Instant expires)
The date and time at which the object is no longer cacheable.
expires - The date and time at which the object is no longer cacheable.HeadObjectResponse.Builder websiteRedirectLocation(String websiteRedirectLocation)
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. Amazon S3 stores the value of this header in the object metadata.
This functionality is not supported for directory buckets.
websiteRedirectLocation - 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. Amazon S3 stores the value of this header in the object
metadata. This functionality is not supported for directory buckets.
HeadObjectResponse.Builder serverSideEncryption(String serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256, aws:kms, aws:kms:dsse).
serverSideEncryption - The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256, aws:kms, aws:kms:dsse).ServerSideEncryption,
ServerSideEncryptionHeadObjectResponse.Builder serverSideEncryption(ServerSideEncryption serverSideEncryption)
The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256, aws:kms, aws:kms:dsse).
serverSideEncryption - The server-side encryption algorithm used when you store this object in Amazon S3 (for example,
AES256, aws:kms, aws:kms:dsse).ServerSideEncryption,
ServerSideEncryptionHeadObjectResponse.Builder metadata(Map<String,String> metadata)
A map of metadata to store with the object in S3.
metadata - A map of metadata to store with the object in S3.HeadObjectResponse.Builder sseCustomerAlgorithm(String sseCustomerAlgorithm)
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.
This functionality is not supported for directory buckets.
sseCustomerAlgorithm - 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. This functionality is not supported for directory buckets.
HeadObjectResponse.Builder sseCustomerKeyMD5(String sseCustomerKeyMD5)
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.
This functionality is not supported for directory buckets.
sseCustomerKeyMD5 - 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. This functionality is not supported for directory buckets.
HeadObjectResponse.Builder ssekmsKeyId(String ssekmsKeyId)
If present, indicates the ID of the KMS key that was used for object encryption.
ssekmsKeyId - If present, indicates the ID of the KMS key that was used for object encryption.HeadObjectResponse.Builder bucketKeyEnabled(Boolean bucketKeyEnabled)
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
bucketKeyEnabled - Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management
Service (KMS) keys (SSE-KMS).HeadObjectResponse.Builder storageClass(String storageClass)
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One
Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access
storage class) in Dedicated Local Zones.
storageClass - Provides storage class information of the object. Amazon S3 returns this header for all objects except
for S3 Standard storage class objects.
For more information, see Storage Classes.
Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3
Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One
Zone-Infrequent Access storage class) in Dedicated Local Zones.
StorageClass,
StorageClassHeadObjectResponse.Builder storageClass(StorageClass storageClass)
Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.
For more information, see Storage Classes.
Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One
Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access
storage class) in Dedicated Local Zones.
storageClass - Provides storage class information of the object. Amazon S3 returns this header for all objects except
for S3 Standard storage class objects.
For more information, see Storage Classes.
Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3
Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One
Zone-Infrequent Access storage class) in Dedicated Local Zones.
StorageClass,
StorageClassHeadObjectResponse.Builder requestCharged(String requestCharged)
requestCharged - The new value for the RequestCharged property for this object.RequestCharged,
RequestChargedHeadObjectResponse.Builder requestCharged(RequestCharged requestCharged)
requestCharged - The new value for the RequestCharged property for this object.RequestCharged,
RequestChargedHeadObjectResponse.Builder replicationStatus(String replicationStatus)
Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.
In replication, you have a source bucket on which you configure replication and destination bucket or buckets
where Amazon S3 stores object replicas. When you request an object (GetObject) or object
metadata (HeadObject) from these buckets, Amazon S3 will return the
x-amz-replication-status header in the response as follows:
If requesting an object from the source bucket, Amazon S3 will return the
x-amz-replication-status header if the object in your request is eligible for replication.
For example, suppose that in your replication configuration, you specify object prefix TaxDocs
requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with
this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any
object request with this key name prefix, Amazon S3 will return the x-amz-replication-status
header with value PENDING, COMPLETED or FAILED indicating object replication status.
If requesting an object from a destination bucket, Amazon S3 will return the
x-amz-replication-status header with value REPLICA if the object in your request is a replica
that Amazon S3 created and there is no replica modification replication in progress.
When replicating objects to multiple destination buckets, the x-amz-replication-status
header acts differently. The header of the source object will only return a value of COMPLETED when
replication is successful to all destinations. The header will remain at value PENDING until replication has
completed for all destinations. If one or more destinations fails replication the header will return FAILED.
For more information, see Replication.
This functionality is not supported for directory buckets.
replicationStatus - Amazon S3 can return this header if your request involves a bucket that is either a source or a
destination in a replication rule.
In replication, you have a source bucket on which you configure replication and destination bucket or
buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or
object metadata (HeadObject) from these buckets, Amazon S3 will return the
x-amz-replication-status header in the response as follows:
If requesting an object from the source bucket, Amazon S3 will return the
x-amz-replication-status header if the object in your request is eligible for
replication.
For example, suppose that in your replication configuration, you specify object prefix
TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs.
Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are
eligible for replication. For any object request with this key name prefix, Amazon S3 will return the
x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object
replication status.
If requesting an object from a destination bucket, Amazon S3 will return the
x-amz-replication-status header with value REPLICA if the object in your request is a
replica that Amazon S3 created and there is no replica modification replication in progress.
When replicating objects to multiple destination buckets, the
x-amz-replication-status header acts differently. The header of the source object will
only return a value of COMPLETED when replication is successful to all destinations. The header will
remain at value PENDING until replication has completed for all destinations. If one or more
destinations fails replication the header will return FAILED.
For more information, see Replication.
This functionality is not supported for directory buckets.
ReplicationStatus,
ReplicationStatusHeadObjectResponse.Builder replicationStatus(ReplicationStatus replicationStatus)
Amazon S3 can return this header if your request involves a bucket that is either a source or a destination in a replication rule.
In replication, you have a source bucket on which you configure replication and destination bucket or buckets
where Amazon S3 stores object replicas. When you request an object (GetObject) or object
metadata (HeadObject) from these buckets, Amazon S3 will return the
x-amz-replication-status header in the response as follows:
If requesting an object from the source bucket, Amazon S3 will return the
x-amz-replication-status header if the object in your request is eligible for replication.
For example, suppose that in your replication configuration, you specify object prefix TaxDocs
requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with
this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any
object request with this key name prefix, Amazon S3 will return the x-amz-replication-status
header with value PENDING, COMPLETED or FAILED indicating object replication status.
If requesting an object from a destination bucket, Amazon S3 will return the
x-amz-replication-status header with value REPLICA if the object in your request is a replica
that Amazon S3 created and there is no replica modification replication in progress.
When replicating objects to multiple destination buckets, the x-amz-replication-status
header acts differently. The header of the source object will only return a value of COMPLETED when
replication is successful to all destinations. The header will remain at value PENDING until replication has
completed for all destinations. If one or more destinations fails replication the header will return FAILED.
For more information, see Replication.
This functionality is not supported for directory buckets.
replicationStatus - Amazon S3 can return this header if your request involves a bucket that is either a source or a
destination in a replication rule.
In replication, you have a source bucket on which you configure replication and destination bucket or
buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or
object metadata (HeadObject) from these buckets, Amazon S3 will return the
x-amz-replication-status header in the response as follows:
If requesting an object from the source bucket, Amazon S3 will return the
x-amz-replication-status header if the object in your request is eligible for
replication.
For example, suppose that in your replication configuration, you specify object prefix
TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs.
Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are
eligible for replication. For any object request with this key name prefix, Amazon S3 will return the
x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object
replication status.
If requesting an object from a destination bucket, Amazon S3 will return the
x-amz-replication-status header with value REPLICA if the object in your request is a
replica that Amazon S3 created and there is no replica modification replication in progress.
When replicating objects to multiple destination buckets, the
x-amz-replication-status header acts differently. The header of the source object will
only return a value of COMPLETED when replication is successful to all destinations. The header will
remain at value PENDING until replication has completed for all destinations. If one or more
destinations fails replication the header will return FAILED.
For more information, see Replication.
This functionality is not supported for directory buckets.
ReplicationStatus,
ReplicationStatusHeadObjectResponse.Builder partsCount(Integer partsCount)
The count of parts this object has. This value is only returned if you specify partNumber in
your request and the object was uploaded as a multipart upload.
partsCount - The count of parts this object has. This value is only returned if you specify partNumber
in your request and the object was uploaded as a multipart upload.HeadObjectResponse.Builder objectLockMode(String objectLockMode)
The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester
has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.
This functionality is not supported for directory buckets.
objectLockMode - The Object Lock mode, if any, that's in effect for this object. This header is only returned if the
requester has the s3:GetObjectRetention permission. For more information about S3 Object
Lock, see Object Lock.
This functionality is not supported for directory buckets.
ObjectLockMode,
ObjectLockModeHeadObjectResponse.Builder objectLockMode(ObjectLockMode objectLockMode)
The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester
has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.
This functionality is not supported for directory buckets.
objectLockMode - The Object Lock mode, if any, that's in effect for this object. This header is only returned if the
requester has the s3:GetObjectRetention permission. For more information about S3 Object
Lock, see Object Lock.
This functionality is not supported for directory buckets.
ObjectLockMode,
ObjectLockModeHeadObjectResponse.Builder objectLockRetainUntilDate(Instant objectLockRetainUntilDate)
The date and time when the Object Lock retention period expires. This header is only returned if the
requester has the s3:GetObjectRetention permission.
This functionality is not supported for directory buckets.
objectLockRetainUntilDate - The date and time when the Object Lock retention period expires. This header is only returned if the
requester has the s3:GetObjectRetention permission. This functionality is not supported for directory buckets.
HeadObjectResponse.Builder objectLockLegalHoldStatus(String objectLockLegalHoldStatus)
Specifies whether a legal hold is in effect for this object. This header is only returned if the requester
has the s3:GetObjectLegalHold permission. This header is not returned if the specified version
of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.
This functionality is not supported for directory buckets.
objectLockLegalHoldStatus - Specifies whether a legal hold is in effect for this object. This header is only returned if the
requester has the s3:GetObjectLegalHold permission. This header is not returned if the
specified version of this object has never had a legal hold applied. For more information about S3
Object Lock, see Object
Lock. This functionality is not supported for directory buckets.
ObjectLockLegalHoldStatus,
ObjectLockLegalHoldStatusHeadObjectResponse.Builder objectLockLegalHoldStatus(ObjectLockLegalHoldStatus objectLockLegalHoldStatus)
Specifies whether a legal hold is in effect for this object. This header is only returned if the requester
has the s3:GetObjectLegalHold permission. This header is not returned if the specified version
of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.
This functionality is not supported for directory buckets.
objectLockLegalHoldStatus - Specifies whether a legal hold is in effect for this object. This header is only returned if the
requester has the s3:GetObjectLegalHold permission. This header is not returned if the
specified version of this object has never had a legal hold applied. For more information about S3
Object Lock, see Object
Lock. This functionality is not supported for directory buckets.
ObjectLockLegalHoldStatus,
ObjectLockLegalHoldStatusHeadObjectResponse.Builder expiresString(String expiresString)
The date and time at which the object is no longer cacheable
expiresString - The date and time at which the object is no longer cacheableHeadObjectResponse.Builder ibmTransition(String ibmTransitionId)
HeadObjectResponse.Builder ibmRestoredCopyStorageClass(String ibmRestoredCopyStorageClass)
HeadObjectResponse.Builder retentionExpirationDate(Instant retentionExpirationDate)
Date on which it will be legal to delete or modify the object.
retentionExpirationDate - HeadObjectResponse.Builder retentionLegalHoldCount(Integer retentionLegalHoldCount)
The number of legal holds applied to the object.
retentionLegalHoldCount - HeadObjectResponse.Builder retentionPeriod(Long retentionPeriod)
Retention period to store on the object in seconds.
retentionPeriod - Copyright © 2026. All rights reserved.