class Aws::S3::Types::HeadObjectOutput

@!attribute [rw] delete_marker

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.
@return [Boolean]

@!attribute [rw] accept_ranges

Indicates that a range of bytes was specified.
@return [String]

@!attribute [rw] expiration

If the object expiration is configured (see PUT Bucket lifecycle),
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.
@return [String]

@!attribute [rw] 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][1] 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][2].

[1]: https://docs.aws.amazon.com/AmazonS3/latest/API/API_RestoreObject.html
[2]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lifecycle-mgmt.html#lifecycle-transition-general-considerations
@return [String]

@!attribute [rw] archive_status

The archive state of the head object.
@return [String]

@!attribute [rw] last_modified

Creation date of the object.
@return [Time]

@!attribute [rw] content_length

Size of the body in bytes.
@return [Integer]

@!attribute [rw] etag

An ETag is an opaque identifier assigned by a web server to a
specific version of a resource found at a URL.
@return [String]

@!attribute [rw] missing_meta

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.
@return [Integer]

@!attribute [rw] version_id

Version of the object.
@return [String]

@!attribute [rw] cache_control

Specifies caching behavior along the request/reply chain.
@return [String]

@!attribute [rw] content_disposition

Specifies presentational information for the object.
@return [String]

@!attribute [rw] content_encoding

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.
@return [String]

@!attribute [rw] content_language

The language the content is in.
@return [String]

@!attribute [rw] content_type

A standard MIME type describing the format of the object data.
@return [String]

@!attribute [rw] expires

The date and time at which the object is no longer cacheable.
@return [Time]

@!attribute [rw] expires_string

@return [String]

@!attribute [rw] website_redirect_location

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.
@return [String]

@!attribute [rw] server_side_encryption

If the object is stored using server-side encryption either with an
Amazon Web Services KMS customer master key (CMK) or an Amazon
S3-managed encryption key, the response includes this header with
the value of the server-side encryption algorithm used when storing
this object in Amazon S3 (for example, AES256, aws:kms).
@return [String]

@!attribute [rw] metadata

A map of metadata to store with the object in S3.
@return [Hash<String,String>]

@!attribute [rw] sse_customer_algorithm

If server-side encryption with a customer-provided encryption key
was requested, the response will include this header confirming the
encryption algorithm used.
@return [String]

@!attribute [rw] sse_customer_key_md5

If server-side encryption with a customer-provided encryption key
was requested, the response will include this header to provide
round-trip message integrity verification of the customer-provided
encryption key.
@return [String]

@!attribute [rw] ssekms_key_id

If present, specifies the ID of the Amazon Web Services Key
Management Service (Amazon Web Services KMS) symmetric customer
managed customer master key (CMK) that was used for the object.
@return [String]

@!attribute [rw] bucket_key_enabled

Indicates whether the object uses an S3 Bucket Key for server-side
encryption with Amazon Web Services KMS (SSE-KMS).
@return [Boolean]

@!attribute [rw] storage_class

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][1].

[1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/storage-class-intro.html
@return [String]

@!attribute [rw] request_charged

If present, indicates that the requester was successfully charged
for the request.
@return [String]

@!attribute [rw] replication_status

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][1].

[1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/NotificationHowTo.html
@return [String]

@!attribute [rw] parts_count

The count of parts this object has.
@return [Integer]

@!attribute [rw] object_lock_mode

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][1].

[1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
@return [String]

@!attribute [rw] object_lock_retain_until_date

The date and time when the Object Lock retention period expires.
This header is only returned if the requester has the
`s3:GetObjectRetention` permission.
@return [Time]

@!attribute [rw] object_lock_legal_hold_status

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][1].

[1]: https://docs.aws.amazon.com/AmazonS3/latest/dev/object-lock.html
@return [String]

@see docs.aws.amazon.com/goto/WebAPI/s3-2006-03-01/HeadObjectOutput AWS API Documentation

Constants

SENSITIVE