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:

Instance Attribute Summary collapse

Instance Attribute Details

#accept_rangesString

Returns:

  • (String)

#cache_controlString

Specifies caching behavior along the request/reply chain.

Returns:

  • (String)

    Specifies caching behavior along the request/reply chain.

#content_dispositionString

Specifies presentational information for the object.

Returns:

  • (String)

    Specifies presentational information for the object.

#content_encodingString

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_languageString

The language the content is in.

Returns:

  • (String)

    The language the content is in.

#content_lengthInteger

Size of the body in bytes.

Returns:

  • (Integer)

    Size of the body in bytes.

#content_typeString

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_markerBoolean

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.

#etagString

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.

#expirationString

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.

#expiresTime

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_stringString

Returns:

  • (String)

#last_modifiedTime

Last modified date of the object

Returns:

  • (Time)

    Last modified date of the object.

#metadataHash<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_metaInteger

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.

#parts_countInteger

The count of parts this object has.

Returns:

  • (Integer)

    The count of parts this object has.

#replication_statusString

Possible values:

  • COMPLETE
  • PENDING
  • FAILED
  • REPLICA

Returns:

  • (String)

#request_chargedString

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.

#restoreString

Provides information about object restoration operation and expiration time of the restored object copy.

Returns:

  • (String)

    Provides information about object restoration operation and expiration time of the restored object copy.

#server_side_encryptionString

The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

Possible values:

  • AES256
  • aws:kms

Returns:

  • (String)

    The Server-side encryption algorithm used when storing this object in S3 (e.g., AES256, aws:kms).

#sse_customer_algorithmString

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_md5String

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_idString

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

Returns:

  • (String)

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

#storage_classString

Possible values:

  • STANDARD
  • REDUCED_REDUNDANCY
  • STANDARD_IA

Returns:

  • (String)

#version_idString

Version of the object.

Returns:

  • (String)

    Version of the object.

#website_redirect_locationString

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.