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

Inherits:

Struct

Object
Struct
Aws::S3::Types::HeadObjectOutput

show all

Defined in:: gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[:ssekms_key_id]

Instance Attribute Summary collapse

#accept_ranges ⇒ String
Indicates that a range of bytes was specified.
#archive_status ⇒ String
The archive state of the head object.
#bucket_key_enabled ⇒ Boolean
Indicates whether the object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).
#cache_control ⇒ String
Specifies caching behavior along the request/reply chain.
#content_disposition ⇒ 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.
#content_language ⇒ String
The language the content is in.
#content_length ⇒ Integer
Size of the body in bytes.
#content_type ⇒ 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.
#etag ⇒ 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.
#expires ⇒ Time
The date and time at which the object is no longer cacheable.
#expires_string ⇒ String
#last_modified ⇒ Time
Last modified date of the object.
#metadata ⇒ 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.
#object_lock_legal_hold_status ⇒ 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.
#object_lock_retain_until_date ⇒ Time
The date and time when the Object Lock retention period expires.
#parts_count ⇒ 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 a destination in a replication rule.
#request_charged ⇒ 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][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).
#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.
#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.
#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.
#storage_class ⇒ String
Provides storage class information of the object.
#version_id ⇒ 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.

Instance Attribute Details

#accept_ranges ⇒ `String`

Indicates that a range of bytes was specified.

Returns:

(String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#archive_status ⇒ `String`

The archive state of the head object.

Returns:

(String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#bucket_key_enabled ⇒ `Boolean`

Indicates whether the object uses an S3 Bucket Key for server-side encryption with AWS KMS (SSE-KMS).

Returns:

(Boolean)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#cache_control ⇒ `String`

Specifies caching behavior along the request/reply chain.

Returns:

(String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#content_disposition ⇒ `String`

Specifies presentational information for the object.

Returns:

(String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#content_language ⇒ `String`

The language the content is in.

Returns:

(String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#content_length ⇒ `Integer`

Size of the body in bytes.

Returns:

(Integer)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#content_type ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#expires ⇒ `Time`

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

Returns:

(Time)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#expires_string ⇒ `String`

Returns:

(String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#last_modified ⇒ `Time`

Last modified date of the object

Returns:

(Time)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#metadata ⇒ `Hash<String,String>`

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

Returns:

(Hash<String,String>)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#parts_count ⇒ `Integer`

The count of parts this object has.

Returns:

(Integer)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#replication_status ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#request_charged ⇒ `String`

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

Returns:

(String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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).

Returns:

(String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#version_id ⇒ `String`

Version of the object.

Returns:

(String)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#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)

# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 6375

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :expires,
  :expires_string,
  :website_redirect_location,
  :server_side_encryption,
  :metadata,
  :sse_customer_algorithm,
  :sse_customer_key_md5,
  :ssekms_key_id,
  :bucket_key_enabled,
  :storage_class,
  :request_charged,
  :replication_status,
  :parts_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#accept_ranges ⇒ String

#archive_status ⇒ String

#bucket_key_enabled ⇒ Boolean

#cache_control ⇒ String

#content_disposition ⇒ String

#content_encoding ⇒ String

#content_language ⇒ String

#content_length ⇒ Integer

#content_type ⇒ String

#delete_marker ⇒ Boolean

#etag ⇒ String

#expiration ⇒ String

#expires ⇒ Time

#expires_string ⇒ String

#last_modified ⇒ Time

#metadata ⇒ Hash<String,String>

#missing_meta ⇒ Integer

#object_lock_legal_hold_status ⇒ String

#object_lock_mode ⇒ String

#object_lock_retain_until_date ⇒ Time

#parts_count ⇒ Integer

#replication_status ⇒ String

#request_charged ⇒ String

#restore ⇒ String

#server_side_encryption ⇒ String

#sse_customer_algorithm ⇒ String

#sse_customer_key_md5 ⇒ String

#ssekms_key_id ⇒ String

#storage_class ⇒ String

#version_id ⇒ String

#website_redirect_location ⇒ String

#accept_ranges ⇒ `String`

#archive_status ⇒ `String`

#bucket_key_enabled ⇒ `Boolean`

#cache_control ⇒ `String`

#content_disposition ⇒ `String`

#content_encoding ⇒ `String`

#content_language ⇒ `String`

#content_length ⇒ `Integer`

#content_type ⇒ `String`

#delete_marker ⇒ `Boolean`

#etag ⇒ `String`

#expiration ⇒ `String`

#expires ⇒ `Time`

#expires_string ⇒ `String`

#last_modified ⇒ `Time`

#metadata ⇒ `Hash<String,String>`

#missing_meta ⇒ `Integer`

#object_lock_legal_hold_status ⇒ `String`

#object_lock_mode ⇒ `String`

#object_lock_retain_until_date ⇒ `Time`

#parts_count ⇒ `Integer`

#replication_status ⇒ `String`

#request_charged ⇒ `String`

#restore ⇒ `String`

#server_side_encryption ⇒ `String`

#sse_customer_algorithm ⇒ `String`

#sse_customer_key_md5 ⇒ `String`

#ssekms_key_id ⇒ `String`

#storage_class ⇒ `String`

#version_id ⇒ `String`

#website_redirect_location ⇒ `String`