Class: Aws::S3::Types::Object

Inherits:

Struct

• Object
• Struct
• Aws::S3::Types::Object

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-s3/types.rb

Overview

An object consists of data and its descriptive metadata.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #checksum_algorithm ⇒ Array<String>

  The algorithm that was used to create a checksum of the object.

• #etag ⇒ String

  The entity tag is a hash of the object.

• #key ⇒ String

  The name that you assign to an object.

• #last_modified ⇒ Time

  Creation date of the object.

• #owner ⇒ Types::Owner

  The owner of the object.

• #restore_status ⇒ Types::RestoreStatus

  Specifies the restoration status of an object.

• #size ⇒ Integer

  Size in bytes of the object.

• #storage_class ⇒ String

  The class of storage used to store the object.

Instance Attribute Details

#checksum_algorithm ⇒ Array<String>

The algorithm that was used to create a checksum of the object.

Returns:

• (Array<String>)

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

class Object < Struct.new(
  :key,
  :last_modified,
  :etag,
  :checksum_algorithm,
  :size,
  :storage_class,
  :owner,
  :restore_status)
  SENSITIVE = []
  include Aws::Structure
end

#etag ⇒ String

The entity tag is a hash of the object. The ETag reflects changes only to the contents of an object, not its metadata. The ETag may or may not be an MD5 digest of the object data. Whether or not it is depends on how the object was created and how it is encrypted as described below:

• Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-S3 or plaintext, have ETags that are an MD5 digest of their object data.

• Objects created by the PUT Object, POST Object, or Copy operation, or through the Amazon Web Services Management Console, and are encrypted by SSE-C or SSE-KMS, have ETags that are not an MD5 digest of their object data.

• If an object is created by either the Multipart Upload or Part Copy operation, the ETag is not an MD5 digest, regardless of the method of encryption. If an object is larger than 16 MB, the Amazon Web Services Management Console will upload or copy that object as a Multipart Upload, and therefore the ETag will not be an MD5 digest.

<note markdown=“1”> **Directory buckets** - MD5 is not supported by directory buckets.

</note>

Returns:

• (String)

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

class Object < Struct.new(
  :key,
  :last_modified,
  :etag,
  :checksum_algorithm,
  :size,
  :storage_class,
  :owner,
  :restore_status)
  SENSITIVE = []
  include Aws::Structure
end

#key ⇒ String

The name that you assign to an object. You use the object key to retrieve the object.

Returns:

• (String)

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

class Object < Struct.new(
  :key,
  :last_modified,
  :etag,
  :checksum_algorithm,
  :size,
  :storage_class,
  :owner,
  :restore_status)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified ⇒ Time

Creation date of the object.

Returns:

• (Time)

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

class Object < Struct.new(
  :key,
  :last_modified,
  :etag,
  :checksum_algorithm,
  :size,
  :storage_class,
  :owner,
  :restore_status)
  SENSITIVE = []
  include Aws::Structure
end

#owner ⇒ Types::Owner

The owner of the object

<note markdown=“1”> **Directory buckets** - The bucket owner is returned as the object owner.

</note>

Returns:

• (Types::Owner)

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

class Object < Struct.new(
  :key,
  :last_modified,
  :etag,
  :checksum_algorithm,
  :size,
  :storage_class,
  :owner,
  :restore_status)
  SENSITIVE = []
  include Aws::Structure
end

#restore_status ⇒ Types::RestoreStatus

Specifies the restoration status of an object. Objects in certain storage classes must be restored before they can be retrieved. For more information about these storage classes and how to work with archived objects, see [ Working with archived objects] in the *Amazon S3 User Guide*.

<note markdown=“1”> This functionality is not supported for directory buckets. Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

</note>

[1]: docs.aws.amazon.com/AmazonS3/latest/userguide/archived-objects.html

Returns:

• (Types::RestoreStatus)

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

class Object < Struct.new(
  :key,
  :last_modified,
  :etag,
  :checksum_algorithm,
  :size,
  :storage_class,
  :owner,
  :restore_status)
  SENSITIVE = []
  include Aws::Structure
end

#size ⇒ Integer

Size in bytes of the object

Returns:

• (Integer)

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

class Object < Struct.new(
  :key,
  :last_modified,
  :etag,
  :checksum_algorithm,
  :size,
  :storage_class,
  :owner,
  :restore_status)
  SENSITIVE = []
  include Aws::Structure
end

#storage_class ⇒ String

The class of storage used to store the object.

<note markdown=“1”> **Directory buckets** - Only the S3 Express One Zone storage class is supported by directory buckets to store objects.

</note>

Returns:

• (String)

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

class Object < Struct.new(
  :key,
  :last_modified,
  :etag,
  :checksum_algorithm,
  :size,
  :storage_class,
  :owner,
  :restore_status)
  SENSITIVE = []
  include Aws::Structure
end