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

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_ranges ⇒ String

Indicates that a range of bytes was specified.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#archive_status ⇒ String

The archive state of the head object.

This functionality is not supported for directory buckets.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#cache_control ⇒ String

Specifies caching behavior along the request/reply chain.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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 checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#checksum_crc32c ⇒ String

The Base64 encoded, 32-bit CRC32C checksum of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#checksum_md5 ⇒ String

The Base64 encoded, 128-bit MD5 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#checksum_sha1 ⇒ String

The Base64 encoded, 160-bit SHA1 digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use the API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#checksum_sha256 ⇒ String

The Base64 encoded, 256-bit SHA256 digest of the object. This checksum is only present if the checksum was uploaded with the object. When you use an API operation on an object that was uploaded using multipart uploads, this value may not be a direct checksum value of the full object. Instead, it's a calculation based on the checksum values of each individual part. For more information about how checksums are calculated with multipart uploads, see Checking object integrity in the Amazon S3 User Guide.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#checksum_sha512 ⇒ String

The Base64 encoded, 512-bit SHA512 digest of the object. For more information, see Checking object integrity in the Amazon S3 User Guide.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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 CreateMultipartUpload request. For more information, see Checking object integrity in the Amazon S3 User Guide.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#checksum_xxhash128 ⇒ String

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

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#checksum_xxhash3 ⇒ String

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

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#checksum_xxhash64 ⇒ String

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

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#content_disposition ⇒ String

Specifies presentational information for the object.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#content_language ⇒ String

The language the content is in.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#content_length ⇒ Integer

Size of the body in bytes.

Returns:

  • (Integer)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#content_range ⇒ String

The portion of the object returned in the response for a GET request.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#content_type ⇒ String

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

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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.

This functionality is not supported for directory buckets.

Returns:

  • (Boolean)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#expires ⇒ Time

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

Returns:

  • (Time)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#expires_string ⇒ String

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#last_modified ⇒ Time

Date and time when the object was last modified.

Returns:

  • (Time)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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>)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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.

This functionality is not supported for directory buckets.

Returns:

  • (Integer)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#object_lock_event_hold ⇒ String

The event hold status for this object. This header is only returned if the requester has the s3:GetObjectRetention permission.

This functionality is not supported for directory buckets.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#object_lock_event_hold_duration_days ⇒ Integer

The event hold duration in days for this object. Only returned when the event hold is enabled.

This functionality is not supported for directory buckets.

Returns:

  • (Integer)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#object_lock_event_hold_duration_years ⇒ Integer

The event hold duration in years for this object. Only returned when the event hold is enabled.

This functionality is not supported for directory buckets.

Returns:

  • (Integer)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

Specifies whether a legal hold is in effect for this object. This header is only returned if the requester has the s3:GetObjectLegalHold permission. This header is not returned if the specified version of this object has never had a legal hold applied. For more information about S3 Object Lock, see Object Lock.

This functionality is not supported for directory buckets.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#object_lock_mode ⇒ String

The Object Lock mode, if any, that's in effect for this object. This header is only returned if the requester has the s3:GetObjectRetention permission. For more information about S3 Object Lock, see Object Lock.

This functionality is not supported for directory buckets.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#object_lock_retain_until_date ⇒ Time

The date and time when the Object Lock retention period expires. This header is only returned if the requester has the s3:GetObjectRetention permission.

This functionality is not supported for directory buckets.

Returns:

  • (Time)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#replication_status ⇒ String

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

In replication, you have a source bucket on which you configure replication and destination bucket or buckets where Amazon S3 stores object replicas. When you request an object (GetObject) or object metadata (HeadObject) from these buckets, Amazon S3 will return the x-amz-replication-status header in the response as follows:

  • If requesting an object from the source bucket, Amazon S3 will return the x-amz-replication-status header if the object in your request is eligible for replication.

    For example, suppose that in your replication configuration, you specify object prefix TaxDocs requesting Amazon S3 to replicate objects with key prefix TaxDocs. Any objects you upload with this key name prefix, for example TaxDocs/document1.pdf, are eligible for replication. For any object request with this key name prefix, Amazon S3 will return the x-amz-replication-status header with value PENDING, COMPLETED or FAILED indicating object replication status.

  • If requesting an object from a destination bucket, Amazon S3 will return the x-amz-replication-status header with value REPLICA if the object in your request is a replica that Amazon S3 created and there is no replica modification replication in progress.

  • When replicating objects to multiple destination buckets, the x-amz-replication-status header acts differently. The header of the source object will only return a value of COMPLETED when replication is successful to all destinations. The header will remain at value PENDING until replication has completed for all destinations. If one or more destinations fails replication the header will return FAILED.

For more information, see Replication.

This functionality is not supported for directory buckets.

Returns:

  • (String)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#restore ⇒ String

If the object is an archived object (an object whose storage class is GLACIER), the response includes this header if either the archive restoration is in progress (see RestoreObject or an archive copy is already restored.

If an archive copy is already restored, the header value indicates when Amazon S3 is scheduled to delete the object copy. For example:

x-amz-restore: ongoing-request="false", expiry-date="Fri, 21 Dec 2012 00:00:00 GMT"

If the object restoration is in progress, the header returns the value ongoing-request="true".

For more information about archiving objects, see Transitioning Objects: General Considerations.

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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end

#storage_class ⇒ String

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

For more information, see Storage Classes.

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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  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)


10937
10938
10939
10940
10941
10942
10943
10944
10945
10946
10947
10948
10949
10950
10951
10952
10953
10954
10955
10956
10957
10958
10959
10960
10961
10962
10963
10964
10965
10966
10967
10968
10969
10970
10971
10972
10973
10974
10975
10976
10977
10978
10979
10980
10981
10982
10983
10984
10985
10986
10987
# File 'gems/aws-sdk-s3/lib/aws-sdk-s3/types.rb', line 10937

class HeadObjectOutput < Struct.new(
  :delete_marker,
  :accept_ranges,
  :expiration,
  :restore,
  :archive_status,
  :last_modified,
  :content_length,
  :checksum_crc32,
  :checksum_crc32c,
  :checksum_crc64nvme,
  :checksum_sha1,
  :checksum_sha256,
  :checksum_sha512,
  :checksum_md5,
  :checksum_xxhash64,
  :checksum_xxhash3,
  :checksum_xxhash128,
  :checksum_type,
  :etag,
  :missing_meta,
  :version_id,
  :cache_control,
  :content_disposition,
  :content_encoding,
  :content_language,
  :content_type,
  :content_range,
  :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,
  :object_lock_event_hold,
  :object_lock_event_hold_duration_days,
  :object_lock_event_hold_duration_years)
  SENSITIVE = [:ssekms_key_id]
  include Aws::Structure
end