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

Inherits:

Struct

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

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 in the request.
#body ⇒ IO
Object data.
#bucket_key_enabled ⇒ Boolean
Indicates whether the object uses an S3 Bucket Key for server-side encryption with Key Management Service (KMS) keys (SSE-KMS).
#cache_control ⇒ String
Specifies caching behavior along the request/reply chain.
#checksum_crc32 ⇒ String
The Base64 encoded, 32-bit CRC32 checksum of the object.
#checksum_crc32c ⇒ String
The Base64 encoded, 32-bit CRC32C checksum of the object.
#checksum_crc64nvme ⇒ String
The Base64 encoded, 64-bit CRC64NVME checksum of the object.
#checksum_sha1 ⇒ String
The Base64 encoded, 160-bit SHA1 digest of the object.
#checksum_sha256 ⇒ String
The Base64 encoded, 256-bit SHA256 digest of the object.
#checksum_type ⇒ String
The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects.
#content_disposition ⇒ String
Specifies presentational information for the object.
#content_encoding ⇒ String
Indicates 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
Indicates whether the object retrieved was (true) or was not (false) a Delete Marker.
#etag ⇒ String
An entity tag (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 [ PutBucketLifecycleConfiguration ][1]), 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
Date and time when the object was last modified.
#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 the headers that are prefixed with x-amz-meta-.
#object_lock_legal_hold_status ⇒ String
Indicates whether this object has an active legal hold.
#object_lock_mode ⇒ String
The Object Lock mode that's 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 you store this object in Amazon S3 or Amazon FSx.
#sse_customer_algorithm ⇒ String
If server-side encryption with a customer-provided encryption key was requested, the response will include this header to confirm the encryption algorithm that's 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 the round-trip message integrity verification of the customer-provided encryption key.
#ssekms_key_id ⇒ String
If present, indicates the ID of the KMS key that was used for object encryption.
#storage_class ⇒ String
Provides storage class information of the object.
#tag_count ⇒ Integer
The number of tags, if any, on the object, when you have the relevant permission to read object tags.
#version_id ⇒ String
Version ID 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 in the request.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8257

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 Key Management Service (KMS) keys (SSE-KMS).

Returns:

(Boolean)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8257

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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

#checksum_crc32 ⇒ `String`

The Base64 encoded, 32-bit CRC32 checksum of the object. This checksum is only present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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

#checksum_crc32c ⇒ `String`

The Base64 encoded, 32-bit CRC32C checksum of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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

#checksum_crc64nvme ⇒ `String`

The Base64 encoded, 64-bit CRC64NVME checksum of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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

#checksum_sha1 ⇒ `String`

The Base64 encoded, 160-bit SHA1 digest of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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

#checksum_sha256 ⇒ `String`

The Base64 encoded, 256-bit SHA256 digest of the object. This will only be present if the object was uploaded with the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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

#checksum_type ⇒ `String`

The checksum type, which determines how part-level checksums are combined to create an object-level checksum for multipart objects. You can use this header response to verify that the checksum type that is received is the same checksum type that was specified in the CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8257

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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`

Indicates 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 8257

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8257

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8257

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8257

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8257

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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`

Indicates whether the object retrieved was (true) or was not (false) a Delete Marker. If false, this response header does not appear in the response.

* If the current version of the object is a delete marker, Amazon S3 behaves as if the object was deleted and includes x-amz-delete-marker: true in the response.

If the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

Returns:

(Boolean)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 entity tag (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 8257

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 PutBucketLifecycleConfiguration ), 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.

Object expiration information is not returned in directory buckets and this header returns the value "NotImplemented" in all responses for directory buckets.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8257

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8257

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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`

Date and time when the object was last modified.

General purpose buckets - When you specify a versionId of the object in your request, if the specified version in the request is a delete marker, the response returns a 405 Method Not Allowed error and the Last-Modified: timestamp response header.

Returns:

(Time)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 8257

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 the headers that are prefixed with x-amz-meta-. 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.

This functionality is not supported for directory buckets.

Returns:

(Integer)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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.

This functionality is not supported for directory buckets.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 that's currently in place for this object.

This functionality is not supported for directory buckets.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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.

This functionality is not supported for directory buckets.

Returns:

(Time)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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. This value is only returned if you specify partNumber in your request and the object was uploaded as a multipart upload.

Returns:

(Integer)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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.

This functionality is not supported for directory buckets.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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. For more information, see Using Requester Pays buckets for storage transfers and usage in the Amazon Simple Storage Service user guide.

This functionality is not supported for directory buckets.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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.

This functionality is not supported for directory buckets. Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 you store this object in Amazon S3 or Amazon FSx.

When accessing data stored in Amazon FSx file systems using S3 access points, the only valid server side encryption option is aws:fsx.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 to confirm the encryption algorithm that's used.

This functionality is not supported for directory buckets.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 the round-trip message integrity verification of the customer-provided encryption key.

This functionality is not supported for directory buckets.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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, indicates the ID of the KMS key that was used for object encryption.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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.

Directory buckets - Directory buckets only support EXPRESS_ONEZONE (the S3 Express One Zone storage class) in Availability Zones and ONEZONE_IA (the S3 One Zone-Infrequent Access storage class) in Dedicated Local Zones.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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, when you have the relevant permission to read object tags.

You can use GetObjectTagging to retrieve the tag set associated with an object.

This functionality is not supported for directory buckets.

Returns:

(Integer)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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 ID of the object.

This functionality is not supported for directory buckets.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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.

This functionality is not supported for directory buckets.

Returns:

(String)

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

class GetObjectOutput < Struct.new(
  :body,
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :last_modified,
  :content_length,
  :etag,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_type,
  :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

#checksum_crc32 ⇒ String

#checksum_crc32c ⇒ String

#checksum_crc64nvme ⇒ String

#checksum_sha1 ⇒ String

#checksum_sha256 ⇒ String

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

#checksum_crc32 ⇒ `String`

#checksum_crc32c ⇒ `String`

#checksum_crc64nvme ⇒ `String`

#checksum_sha1 ⇒ `String`

#checksum_sha256 ⇒ `String`

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