Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.S3.Types.Object

Description

Synopsis

data Object = Object' {
- owner :: Maybe Owner
- eTag :: ETag
- size :: Integer
- key :: ObjectKey
- storageClass :: ObjectStorageClass
- lastModified :: ISO8601
}
newObject :: ETag -> Integer -> ObjectKey -> ObjectStorageClass -> UTCTime -> Object
object_owner :: Lens' Object (Maybe Owner)
object_eTag :: Lens' Object ETag
object_size :: Lens' Object Integer
object_key :: Lens' Object ObjectKey
object_storageClass :: Lens' Object ObjectStorageClass
object_lastModified :: Lens' Object UTCTime

Documentation

data Object Source #

An object consists of data and its descriptive metadata.

See: newObject smart constructor.

Constructors

Object'

Fields

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.
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 :: ISO8601
Creation date of the object.

Instances

Instances details

Eq Object Source #
Instance details Defined in Amazonka.S3.Types.Object Methods (==) :: Object -> Object -> Bool # (/=) :: Object -> Object -> Bool #
Read Object Source #
Instance details Defined in Amazonka.S3.Types.Object Methods readsPrec :: Int -> ReadS Object # readList :: ReadS [Object] # readPrec :: ReadPrec Object # readListPrec :: ReadPrec [Object] #
Show Object Source #
Instance details Defined in Amazonka.S3.Types.Object Methods showsPrec :: Int -> Object -> ShowS # show :: Object -> String # showList :: [Object] -> ShowS #
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 #
NFData Object Source #
Instance details Defined in Amazonka.S3.Types.Object Methods rnf :: Object -> () #
Hashable Object Source #
Instance details Defined in Amazonka.S3.Types.Object Methods hashWithSalt :: Int -> Object -> Int # hash :: Object -> Int #
FromXML Object Source #
Instance details Defined in Amazonka.S3.Types.Object Methods parseXML :: [Node] -> Either String Object #
type Rep Object Source #
Instance details Defined in Amazonka.S3.Types.Object type Rep Object = D1 ('MetaData "Object" "Amazonka.S3.Types.Object" "libZSservicesZSamazonka-s3ZSamazonka-s3" 'False) (C1 ('MetaCons "Object'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "owner") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Owner)) :: (S1 ('MetaSel ('Just "eTag") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ETag) :: S1 ('MetaSel ('Just "size") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Integer))) :: (S1 ('MetaSel ('Just "key") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectKey) :: (S1 ('MetaSel ('Just "storageClass") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ObjectStorageClass) :*: S1 ('MetaSel ('Just "lastModified") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 ISO8601)))))

newObject Source #

Arguments

:: ETag	`$sel:eTag:Object'`
-> Integer	`$sel:size:Object'`
-> ObjectKey	`$sel:key:Object'`
-> ObjectStorageClass	`$sel:storageClass:Object'`
-> UTCTime	`$sel:lastModified:Object'`
-> Object

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

$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_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.

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.