class Aws::S3::Types::HeadObjectOutput

@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObjectOutput AWS API Documentation
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html </note>
<note markdown=“1”> This functionality is not supported for directory buckets. Lock].
applied. For more information about S3 Object Lock, see [Object
the specified version of this object has never had a legal hold
`s3:GetObjectLegalHold` permission. This header is not returned if
header is only returned if the requester has the
Specifies whether a legal hold is in effect for this object. This
@!attribute [rw] object_lock_legal_hold_status
@return [Time]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
‘s3:GetObjectRetention` permission.
This header is only returned if the requester has the
The date and time when the Object Lock retention period expires.
@!attribute [rw] object_lock_retain_until_date
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html </note>
<note markdown=“1”> This functionality is not supported for directory buckets.
Object Lock, see [Object Lock].
`s3:GetObjectRetention` permission. For more information about S3
This header is only returned if the requester has the
The Object Lock mode, if any, that’s in effect for this object.
@!attribute [rw] object_lock_mode
@return [Integer]
as a multipart upload.
you specify ‘partNumber` in your request and the object was uploaded
The count of parts this object has. This value is only returned if
@!attribute [rw] parts_count
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html </note>
<note markdown=“1”> This functionality is not supported for directory buckets.
For more information, see [Replication].
header will return FAILED.
destinations. If one or more destinations fails replication the
remain at value PENDING until replication has completed for all
replication is successful to all destinations. The header will
the source object will only return a value of COMPLETED when
`x-amz-replication-status` header acts differently. The header of
* **When replicating objects to multiple destination buckets**, the
progress.
created and there is no replica modification replication in
REPLICA if the object in your request is a replica that Amazon S3
will return the `x-amz-replication-status` header with value
* **If requesting an object from a destination bucket**, Amazon S3
replication status.
header with value PENDING, COMPLETED or FAILED indicating object
name prefix, Amazon S3 will return the `x-amz-replication-status`
eligible for replication. For any object request with this key
this key name prefix, for example `TaxDocs/document1.pdf`, are
objects with key prefix `TaxDocs`. Any objects you upload with
specify object prefix `TaxDocs` requesting Amazon S3 to replicate
For example, suppose that in your replication configuration, you
request is eligible for replication.
return the `x-amz-replication-status` header if the object in your
* **If requesting an object from the source bucket**, Amazon S3 will
the `x-amz-replication-status` header in the response as follows:
metadata (`HeadObject`) from these buckets, Amazon S3 will return
object replicas. When you request an object (`GetObject`) or object
replication and destination bucket or buckets where Amazon S3 stores
In replication, you have a source bucket on which you configure
that is either a source or a destination in a replication rule.
Amazon S3 can return this header if your request involves a bucket
@!attribute [rw] replication_status
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
for the request.
If present, indicates that the requester was successfully charged
@!attribute [rw] request_charged
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html </note>
class is supported by directory buckets to store objects.
<note markdown=“1”> Directory buckets - Only the S3 Express One Zone storage
For more information, see [Storage Classes].
objects.
this header for all objects except for S3 Standard storage class
Provides storage class information of the object. Amazon S3 returns
@!attribute [rw] storage_class
@return [Boolean]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
encryption with Key Management Service (KMS) keys (SSE-KMS).
Indicates whether the object uses an S3 Bucket Key for server-side
@!attribute [rw] bucket_key_enabled
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
object.
symmetric encryption customer managed key that was used for the
If present, indicates the ID of the Key Management Service (KMS)
@!attribute [rw] ssekms_key_id
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
encryption key.
round-trip message integrity verification of the customer-provided
was requested, the response will include this header to provide the
If server-side encryption with a customer-provided encryption key
@!attribute [rw] sse_customer_key_md5
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
encryption algorithm that’s used.
was requested, the response will include this header to confirm the
If server-side encryption with a customer-provided encryption key
@!attribute [rw] sse_customer_algorithm
@return [Hash<String,String>]
A map of metadata to store with the object in S3.
@!attribute [rw] metadata
@return [String]
</note>
managed keys (SSE-S3) (‘AES256`) is supported.
<note markdown=“1”> For directory buckets, only server-side encryption with Amazon S3
in Amazon S3 (for example, `AES256`, `aws:kms`, `aws:kms:dsse`).
The server-side encryption algorithm used when you store this object
@!attribute [rw] server_side_encryption
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
metadata.
URL. Amazon S3 stores the value of this header in the object
this object to another object in the same bucket or to an external
If the bucket is configured as a website, redirects requests for
@!attribute [rw] website_redirect_location
@return [String]
@!attribute [rw] expires_string
@return [Time]
The date and time at which the object is no longer cacheable.
@!attribute [rw] expires
@return [String]
A standard MIME type describing the format of the object data.
@!attribute [rw] content_type
@return [String]
The language the content is in.
@!attribute [rw] content_language
@return [String]
media-type referenced by the Content-Type header field.
thus what decoding mechanisms must be applied to obtain the
Indicates what content encodings have been applied to the object and
@!attribute [rw] content_encoding
@return [String]
Specifies presentational information for the object.
@!attribute [rw] content_disposition
@return [String]
Specifies caching behavior along the request/reply chain.
@!attribute [rw] cache_control
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
Version ID of the object.
@!attribute [rw] version_id
@return [Integer]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
are not legal HTTP headers.
API. For example, using SOAP, you can create metadata whose values
an API like SOAP that supports more flexible metadata than the REST
`x-amz-meta` headers. This can happen if you create metadata using
This is set to the number of metadata entries not returned in
@!attribute [rw] missing_meta
@return [String]
server to a specific version of a resource found at a URL.
An entity tag (ETag) is an opaque identifier assigned by a web
@!attribute [rw] etag
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums integrity][1] in the *Amazon S3 User Guide*.
calculated with multipart uploads, see [ Checking object
each individual part. For more information about how checksums are
object. Instead, it’s a calculation based on the checksum values of
uploads, this value may not be a direct checksum value of the full
API operation on an object that was uploaded using multipart
only be present if it was uploaded with the object. When you use an
The base64-encoded, 256-bit SHA-256 digest of the object. This will
@!attribute [rw] checksum_sha256
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums integrity][1] in the *Amazon S3 User Guide*.
calculated with multipart uploads, see [ Checking object
each individual part. For more information about how checksums are
object. Instead, it’s a calculation based on the checksum values of
uploads, this value may not be a direct checksum value of the full
API operation on an object that was uploaded using multipart
only be present if it was uploaded with the object. When you use the
The base64-encoded, 160-bit SHA-1 digest of the object. This will
@!attribute [rw] checksum_sha1
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums integrity][1] in the *Amazon S3 User Guide*.
calculated with multipart uploads, see [ Checking object
each individual part. For more information about how checksums are
object. Instead, it’s a calculation based on the checksum values of
uploads, this value may not be a direct checksum value of the full
API operation on an object that was uploaded using multipart
only be present if it was uploaded with the object. When you use an
The base64-encoded, 32-bit CRC32C checksum of the object. This will
@!attribute [rw] checksum_crc32c
@return [String] : docs.aws.amazon.com/AmazonS3/latest/userguide/checking-object-integrity.html#large-object-checksums integrity][1] in the *Amazon S3 User Guide*.
calculated with multipart uploads, see [ Checking object
each individual part. For more information about how checksums are
object. Instead, it’s a calculation based on the checksum values of
uploads, this value may not be a direct checksum value of the full
API operation on an object that was uploaded using multipart
only be present if it was uploaded with the object. When you use an
The base64-encoded, 32-bit CRC32 checksum of the object. This will
@!attribute [rw] checksum_crc32
@return [Integer]
Size of the body in bytes.
@!attribute [rw] content_length
@return [Time]
Date and time when the object was last modified.
@!attribute [rw] last_modified
@return [String]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
The archive state of the head object.
@!attribute [rw] archive_status
@return [String] : docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations [1]: docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html </note>
to store objects.
S3 Express One Zone storage class is supported by directory buckets
<note markdown=“1”> This functionality is not supported for directory buckets. Only the
Objects: General Considerations].
For more information about archiving objects, see [Transitioning
value ‘ongoing-request=“true”`.
If the object restoration is in progress, the header returns the
2012 00:00:00 GMT“`
`x-amz-restore: ongoing-request=”false“, expiry-date=”Fri, 21 Dec
when Amazon S3 is scheduled to delete the object copy. For example:
If an archive copy is already restored, the header value indicates
copy is already restored.
restoration is in progress (see [RestoreObject] or an archive
is GLACIER), the response includes this header if either the archive
If the object is an archived object (an object whose storage class
@!attribute [rw] restore
@return [String] : docs.aws.amazon.com/AmazonS3/latest/API/API_PutBucketLifecycleConfiguration.html </note>
<note markdown=“1”> This functionality is not supported for directory buckets.
is URL-encoded.
providing object expiration information. The value of the `rule-id`
header. It includes the `expiry-date` and `rule-id` key-value pairs
`PutBucketLifecycleConfiguration` ][1]), the response includes this
If the object expiration is configured (see [
@!attribute [rw] expiration
@return [String]
Indicates that a range of bytes was specified.
@!attribute [rw] accept_ranges
@return [Boolean]
</note>
<note markdown=“1”> This functionality is not supported for directory buckets.
the response.
a Delete Marker. If false, this response header does not appear in
Specifies whether the object retrieved was (true) or was not (false)
@!attribute [rw] delete_marker

class Aws::S3::Types::HeadObjectOutput

Namespace

Included Modules

Defined in