amazonka-s3-2.0: Amazon Simple Storage Service SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.S3.Types.Object

Description

 
Synopsis

Documentation

data Object Source #

An object consists of data and its descriptive metadata.

See: newObject smart constructor.

Constructors

Object' 

Fields

  • checksumAlgorithm :: Maybe [ChecksumAlgorithm]

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

  • owner :: Maybe Owner

    The owner of the object

  • eTag :: ETag

    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.
  • size :: Integer

    Size in bytes of the object

  • key :: ObjectKey

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

  • storageClass :: ObjectStorageClass

    The class of storage used to store the object.

  • lastModified :: RFC822

    Creation date of the object.

Instances

Instances details
FromXML Object Source # 
Instance details

Defined in Amazonka.S3.Types.Object

Generic Object Source # 
Instance details

Defined in Amazonka.S3.Types.Object

Associated Types

type Rep Object :: Type -> Type #

Methods

from :: Object -> Rep Object x #

to :: Rep Object x -> Object #

Read Object Source # 
Instance details

Defined in Amazonka.S3.Types.Object

Show Object Source # 
Instance details

Defined in Amazonka.S3.Types.Object

NFData Object Source # 
Instance details

Defined in Amazonka.S3.Types.Object

Methods

rnf :: Object -> () #

Eq Object Source # 
Instance details

Defined in Amazonka.S3.Types.Object

Methods

(==) :: Object -> Object -> Bool #

(/=) :: Object -> Object -> Bool #

Hashable Object Source # 
Instance details

Defined in Amazonka.S3.Types.Object

Methods

hashWithSalt :: Int -> Object -> Int #

hash :: Object -> Int #

type Rep Object Source # 
Instance details

Defined in Amazonka.S3.Types.Object

newObject Source #

Create a value of Object with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:checksumAlgorithm:Object', object_checksumAlgorithm - The algorithm that was used to create a checksum of the object.

$sel:owner:Object', object_owner - The owner of the object

$sel:eTag:Object', object_eTag - 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.

$sel:size:Object', object_size - Size in bytes of the object

$sel:key:Object', object_key - The name that you assign to an object. You use the object key to retrieve the object.

$sel:storageClass:Object', object_storageClass - The class of storage used to store the object.

$sel:lastModified:Object', object_lastModified - Creation date of the object.

object_checksumAlgorithm :: Lens' Object (Maybe [ChecksumAlgorithm]) Source #

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

object_owner :: Lens' Object (Maybe Owner) Source #

The owner of the object

object_eTag :: Lens' Object ETag Source #

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.

object_size :: Lens' Object Integer Source #

Size in bytes of the object

object_key :: Lens' Object ObjectKey Source #

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

object_storageClass :: Lens' Object ObjectStorageClass Source #

The class of storage used to store the object.

object_lastModified :: Lens' Object UTCTime Source #

Creation date of the object.