Class: Aws::S3::Types::GetObjectOutput

Inherits:

Struct

Object
Struct
Aws::S3::Types::GetObjectOutput

show all

Includes:: Aws::Structure

Defined in:: 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.
#body ⇒ IO

Object data.
#bucket_key_enabled ⇒ Boolean

Indicates whether the object uses an S3 Bucket Key for server-side encryption with Amazon Web Services 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_range ⇒ String

The portion of the object returned in the response.
#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

Creation 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

Indicates whether this object has an active legal hold.
#object_lock_mode ⇒ String

The Object Lock mode currently in place for this object.
#object_lock_retain_until_date ⇒ Time

The date and time when this object’s Object Lock will expire.
#parts_count ⇒ Integer

The count of parts this object has.
#replication_status ⇒ String

Amazon S3 can return this 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.
#restore ⇒ String

Provides information about object restoration action and expiration time of the restored object copy.
#server_side_encryption ⇒ String

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 Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.
#storage_class ⇒ String

Provides storage class information of the object.
#tag_count ⇒ Integer

The number of tags, if any, on 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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#body ⇒ `IO`

Object data.

Returns:

(IO)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 Amazon Web Services KMS (SSE-KMS).

Returns:

(Boolean)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#content_range ⇒ `String`

The portion of the object returned in the response.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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`

Creation date of the object.

Returns:

(Time)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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`

Indicates whether this object has an active legal hold. This field is only returned if you have permission to view an object’s legal hold status.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 currently in place for this object.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 this object’s Object Lock will expire.

Returns:

(Time)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 if your request involves a bucket that is either a source or destination in a replication rule.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#restore ⇒ `String`

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

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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`

The server-side encryption algorithm used when storing this object in Amazon S3 (for example, AES256, aws:kms).

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 Amazon Web Services Key Management Service (Amazon Web Services KMS) symmetric customer managed key that was used for the object.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_count,
  :object_lock_mode,
  :object_lock_retain_until_date,
  :object_lock_legal_hold_status)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#tag_count ⇒ `Integer`

The number of tags, if any, on the object.

Returns:

(Integer)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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 'lib/aws-sdk-s3/types.rb', line 5532

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_range,
  :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,
  :tag_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::GetObjectOutput

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#accept_ranges ⇒ String

#body ⇒ IO

#bucket_key_enabled ⇒ Boolean

#cache_control ⇒ String

#content_disposition ⇒ String

#content_encoding ⇒ String

#content_language ⇒ String

#content_length ⇒ Integer

#content_range ⇒ String

#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

#tag_count ⇒ Integer

#version_id ⇒ String

#website_redirect_location ⇒ String

#accept_ranges ⇒ `String`

#body ⇒ `IO`

#bucket_key_enabled ⇒ `Boolean`

#cache_control ⇒ `String`

#content_disposition ⇒ `String`

#content_encoding ⇒ `String`

#content_language ⇒ `String`

#content_length ⇒ `Integer`

#content_range ⇒ `String`

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

#tag_count ⇒ `Integer`

#version_id ⇒ `String`

#website_redirect_location ⇒ `String`