You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::S3::Types::HeadObjectOutput

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#accept_ranges ⇒ String

Indicates that a range of bytes was specified.

Returns:

  • (String) —

    Indicates that a range of bytes was specified.

#archive_status ⇒ String

The archive state of the head object.

Possible values:

  • ARCHIVE_ACCESS
  • DEEP_ARCHIVE_ACCESS

Returns:

  • (String) —

    The archive state of the head object.

#cache_control ⇒ String

Specifies caching behavior along the request/reply chain.

Returns:

  • (String) —

    Specifies caching behavior along the request/reply chain.

#content_disposition ⇒ String

Specifies presentational information for the object.

Returns:

  • (String) —

    Specifies presentational information for the object.

#content_encoding ⇒ String

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.

Returns:

  • (String) —

    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.

#content_language ⇒ String

The language the content is in.

Returns:

  • (String) —

    The language the content is in.

#content_length ⇒ Integer

Size of the body in bytes.

Returns:

  • (Integer) —

    Size of the body in bytes.

#content_type ⇒ String

A standard MIME type describing the format of the object data.

Returns:

  • (String) —

    A standard MIME type describing the format of the object data.

#delete_marker ⇒ Boolean

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.

Returns:

  • (Boolean) —

    Specifies whether the object retrieved was (true) or was not (false) a Delete Marker.

#etag ⇒ String

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

Returns:

  • (String) —

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

#expiration ⇒ String

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.

Returns:

  • (String) —

    If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header.

#expires ⇒ Time

The date and time at which the object is no longer cacheable.

Returns:

  • (Time) —

    The date and time at which the object is no longer cacheable.

#expires_string ⇒ String

Returns:

  • (String)

#last_modified ⇒ Time

Last modified date of the object

Returns:

  • (Time) —

    Last modified date of the object.

#metadata ⇒ Hash<String,String>

A map of metadata to store with the object in S3.

Returns:

  • (Hash<String,String>) —

    A map of metadata to store with the object in S3.

#missing_meta ⇒ Integer

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.

Returns:

  • (Integer) —

    This is set to the number of metadata entries not returned in x-amz-meta headers.

#object_lock_legal_hold_status ⇒ String

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.

Returns:

  • (String) —

    Specifies whether a legal hold is in effect for this object.

#object_lock_mode ⇒ String

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.

Returns:

  • (String) —

    The Object Lock mode, if any, that\'s in effect for this object.

#object_lock_retain_until_date ⇒ Time

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

Returns:

  • (Time) —

    The date and time when the Object Lock retention period expires.

#parts_count ⇒ Integer

The count of parts this object has.

Returns:

  • (Integer) —

    The count of parts this object has.

#replication_status ⇒ String

Amazon S3 can return this header if your request involves a bucket that is either a source or destination in a replication rule.

In replication, you have a source bucket on which you configure replication and destination bucket 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 the 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.

For more information, see Replication.

Returns:

  • (String) —

    Amazon S3 can return this header if your request involves a bucket that is either a source or destination in a replication rule.

#request_charged ⇒ String

If present, indicates that the requester was successfully charged for the request.

Possible values:

  • requester

Returns:

  • (String) —

    If present, indicates that the requester was successfully charged for the request.

    .

#restore ⇒ String

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, 23 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.

Returns:

  • (String) —

    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.

#server_side_encryption ⇒ String

If the object is stored using server-side encryption either with an AWS 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).

Possible values:

  • AES256
  • aws:kms

Returns:

  • (String) —

    If the object is stored using server-side encryption either with an AWS 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).

#sse_customer_algorithm ⇒ String

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

Returns:

  • (String) —

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

#sse_customer_key_md5 ⇒ String

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.

Returns:

  • (String) —

    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.

#ssekms_key_id ⇒ String

If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.

Returns:

  • (String) —

    If present, specifies the ID of the AWS Key Management Service (AWS KMS) symmetric customer managed customer master key (CMK) that was used for the object.

#storage_class ⇒ String

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.

Returns:

  • (String) —

    Provides storage class information of the object.

#version_id ⇒ String

Version of the object.

Returns:

  • (String) —

    Version of the object.

#website_redirect_location ⇒ String

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.

Returns:

  • (String) —

    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.