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

Inherits:
Struct
  • Object
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

Instance Attribute Details

#accept_rangesString

Indicates that a range of bytes was specified.

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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

#bodyIO

Object data.

Returns:

  • (IO)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_controlString

Specifies caching behavior along the request/reply chain.

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_dispositionString

Specifies presentational information for the object.

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_encodingString

Specifies what content encodings have been applied to the object and thus what decoding mechanisms must be applied to obtain the media-type referenced by the Content-Type header field.

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_languageString

The language the content is in.

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_lengthInteger

Size of the body in bytes.

Returns:

  • (Integer)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_rangeString

The portion of the object returned in the response.

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_typeString

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

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_markerBoolean

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

Returns:

  • (Boolean)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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

#etagString

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

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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

#expirationString

If the object expiration is configured (see PUT Bucket lifecycle), the response includes this header. It includes the expiry-date and rule-id key-value pairs providing object expiration information. The value of the rule-id is URL encoded.

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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

#expiresTime

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

Returns:

  • (Time)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_stringString

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_modifiedTime

Last modified date of the object

Returns:

  • (Time)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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

#metadataHash<String,String>

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

Returns:

  • (Hash<String,String>)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_metaInteger

This is set to the number of metadata entries not returned in x-amz-meta headers. This can happen if you create metadata using an API like SOAP that supports more flexible metadata than the REST API. For example, using SOAP, you can create metadata whose values are not legal HTTP headers.

Returns:

  • (Integer)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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

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)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_modeString

The Object Lock mode currently in place for this object.

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_dateTime

The date and time when this object's Object Lock will expire.

Returns:

  • (Time)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_countInteger

The count of parts this object has.

Returns:

  • (Integer)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_statusString

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

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_chargedString

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

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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

#restoreString

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

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_encryptionString

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

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_algorithmString

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

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_md5String

If server-side encryption with a customer-provided encryption key was requested, the response will include this header to provide round-trip message integrity verification of the customer-provided encryption key.

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_idString

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)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_classString

Provides storage class information of the object. Amazon S3 returns this header for all objects except for S3 Standard storage class objects.

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_countInteger

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

Returns:

  • (Integer)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_idString

Version of the object.

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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_locationString

If the bucket is configured as a website, redirects requests for this object to another object in the same bucket or to an external URL. Amazon S3 stores the value of this header in the object metadata.

Returns:

  • (String)


4731
4732
4733
4734
4735
4736
4737
4738
4739
4740
4741
4742
4743
4744
4745
4746
4747
4748
4749
4750
4751
4752
4753
4754
4755
4756
4757
4758
4759
4760
4761
4762
4763
4764
4765
4766
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 4731

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,
  :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