Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.BackupStorage.PutObject

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Upload object that can store object metadata String and data blob in single API call using inline chunk field.

Synopsis

data PutObject = PutObject' {
- inlineChunkChecksum :: Maybe Text
- inlineChunkChecksumAlgorithm :: Maybe Text
- inlineChunkLength :: Maybe Integer
- metadataString :: Maybe Text
- objectChecksum :: Maybe Text
- objectChecksumAlgorithm :: Maybe SummaryChecksumAlgorithm
- throwOnDuplicate :: Maybe Bool
- backupJobId :: Text
- objectName :: Text
- inlineChunk :: HashedBody
}
newPutObject :: Text -> Text -> HashedBody -> PutObject
putObject_inlineChunkChecksum :: Lens' PutObject (Maybe Text)
putObject_inlineChunkChecksumAlgorithm :: Lens' PutObject (Maybe Text)
putObject_inlineChunkLength :: Lens' PutObject (Maybe Integer)
putObject_metadataString :: Lens' PutObject (Maybe Text)
putObject_objectChecksum :: Lens' PutObject (Maybe Text)
putObject_objectChecksumAlgorithm :: Lens' PutObject (Maybe SummaryChecksumAlgorithm)
putObject_throwOnDuplicate :: Lens' PutObject (Maybe Bool)
putObject_backupJobId :: Lens' PutObject Text
putObject_objectName :: Lens' PutObject Text
putObject_inlineChunk :: Lens' PutObject HashedBody
data PutObjectResponse = PutObjectResponse' {
}
newPutObjectResponse :: Int -> Text -> DataChecksumAlgorithm -> Text -> SummaryChecksumAlgorithm -> PutObjectResponse
putObjectResponse_httpStatus :: Lens' PutObjectResponse Int
putObjectResponse_inlineChunkChecksum :: Lens' PutObjectResponse Text
putObjectResponse_inlineChunkChecksumAlgorithm :: Lens' PutObjectResponse DataChecksumAlgorithm
putObjectResponse_objectChecksum :: Lens' PutObjectResponse Text
putObjectResponse_objectChecksumAlgorithm :: Lens' PutObjectResponse SummaryChecksumAlgorithm

Creating a Request

data PutObject Source #

See: newPutObject smart constructor.

Constructors

PutObject'

Fields

inlineChunkChecksum :: Maybe Text
Inline chunk checksum
inlineChunkChecksumAlgorithm :: Maybe Text
Inline chunk checksum algorithm
inlineChunkLength :: Maybe Integer
Length of the inline chunk data.
metadataString :: Maybe Text
Store user defined metadata like backup checksum, disk ids, restore metadata etc.
objectChecksum :: Maybe Text
object checksum
objectChecksumAlgorithm :: Maybe SummaryChecksumAlgorithm
object checksum algorithm
throwOnDuplicate :: Maybe Bool
Throw an exception if Object name is already exist.
backupJobId :: Text
Backup job Id for the in-progress backup.
objectName :: Text
The name of the Object to be uploaded.
inlineChunk :: HashedBody
Inline chunk data to be uploaded.

Instances

Instances details

ToBody PutObject Source #
Instance details Defined in Amazonka.BackupStorage.PutObject Methods toBody :: PutObject -> RequestBody #
ToHeaders PutObject Source #
Instance details Defined in Amazonka.BackupStorage.PutObject Methods toHeaders :: PutObject -> [Header] #
ToPath PutObject Source #
Instance details Defined in Amazonka.BackupStorage.PutObject Methods toPath :: PutObject -> ByteString #
ToQuery PutObject Source #
Instance details Defined in Amazonka.BackupStorage.PutObject Methods toQuery :: PutObject -> QueryString #
AWSRequest PutObject Source #
Instance details Defined in Amazonka.BackupStorage.PutObject Associated Types type AWSResponse PutObject # Methods request :: (Service -> Service) -> PutObject -> Request PutObject # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy PutObject -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse PutObject))) #
Generic PutObject Source #
Instance details Defined in Amazonka.BackupStorage.PutObject Associated Types type Rep PutObject :: Type -> Type # Methods from :: PutObject -> Rep PutObject x # to :: Rep PutObject x -> PutObject #
Show PutObject Source #
Instance details Defined in Amazonka.BackupStorage.PutObject Methods showsPrec :: Int -> PutObject -> ShowS # show :: PutObject -> String # showList :: [PutObject] -> ShowS #
type AWSResponse PutObject Source #
Instance details Defined in Amazonka.BackupStorage.PutObject type AWSResponse PutObject = PutObjectResponse
type Rep PutObject Source #
Instance details Defined in Amazonka.BackupStorage.PutObject type Rep PutObject = D1 ('MetaData "PutObject" "Amazonka.BackupStorage.PutObject" "amazonka-backupstorage-2.0-LZ4MZsHhisz8sYMq4uJ5tw" 'False) (C1 ('MetaCons "PutObject'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "inlineChunkChecksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "inlineChunkChecksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "inlineChunkLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Integer)) :: (S1 ('MetaSel ('Just "metadataString") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "objectChecksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "objectChecksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SummaryChecksumAlgorithm)) :: S1 ('MetaSel ('Just "throwOnDuplicate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "backupJobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "objectName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "inlineChunk") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 HashedBody))))))

newPutObject Source #

Arguments

:: Text	`$sel:backupJobId:PutObject'`
-> Text	`$sel:objectName:PutObject'`
-> HashedBody	`$sel:inlineChunk:PutObject'`
-> PutObject

Create a value of PutObject 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:

PutObject, putObject_inlineChunkChecksum - Inline chunk checksum

PutObject, putObject_inlineChunkChecksumAlgorithm - Inline chunk checksum algorithm

$sel:inlineChunkLength:PutObject', putObject_inlineChunkLength - Length of the inline chunk data.

PutObject, putObject_metadataString - Store user defined metadata like backup checksum, disk ids, restore metadata etc.

PutObject, putObject_objectChecksum - object checksum

PutObject, putObject_objectChecksumAlgorithm - object checksum algorithm

$sel:throwOnDuplicate:PutObject', putObject_throwOnDuplicate - Throw an exception if Object name is already exist.

$sel:backupJobId:PutObject', putObject_backupJobId - Backup job Id for the in-progress backup.

$sel:objectName:PutObject', putObject_objectName - The name of the Object to be uploaded.

$sel:inlineChunk:PutObject', putObject_inlineChunk - Inline chunk data to be uploaded.

Request Lenses

putObject_inlineChunkChecksum :: Lens' PutObject (Maybe Text) Source #

Inline chunk checksum

putObject_inlineChunkChecksumAlgorithm :: Lens' PutObject (Maybe Text) Source #

Inline chunk checksum algorithm

putObject_inlineChunkLength :: Lens' PutObject (Maybe Integer) Source #

Length of the inline chunk data.

putObject_metadataString :: Lens' PutObject (Maybe Text) Source #

Store user defined metadata like backup checksum, disk ids, restore metadata etc.

putObject_objectChecksum :: Lens' PutObject (Maybe Text) Source #

object checksum

putObject_objectChecksumAlgorithm :: Lens' PutObject (Maybe SummaryChecksumAlgorithm) Source #

object checksum algorithm

putObject_throwOnDuplicate :: Lens' PutObject (Maybe Bool) Source #

Throw an exception if Object name is already exist.

putObject_backupJobId :: Lens' PutObject Text Source #

Backup job Id for the in-progress backup.

putObject_objectName :: Lens' PutObject Text Source #

The name of the Object to be uploaded.

putObject_inlineChunk :: Lens' PutObject HashedBody Source #

Inline chunk data to be uploaded.

Destructuring the Response

data PutObjectResponse Source #

See: newPutObjectResponse smart constructor.

Constructors

PutObjectResponse'
Fields httpStatus :: Int The response's http status code. inlineChunkChecksum :: Text Inline chunk checksum inlineChunkChecksumAlgorithm :: DataChecksumAlgorithm Inline chunk checksum algorithm objectChecksum :: Text object checksum objectChecksumAlgorithm :: SummaryChecksumAlgorithm object checksum algorithm

Instances

Instances details

Generic PutObjectResponse Source #
Instance details Defined in Amazonka.BackupStorage.PutObject Associated Types type Rep PutObjectResponse :: Type -> Type # Methods from :: PutObjectResponse -> Rep PutObjectResponse x # to :: Rep PutObjectResponse x -> PutObjectResponse #
Read PutObjectResponse Source #
Instance details Defined in Amazonka.BackupStorage.PutObject Methods readsPrec :: Int -> ReadS PutObjectResponse # readList :: ReadS [PutObjectResponse] # readPrec :: ReadPrec PutObjectResponse # readListPrec :: ReadPrec [PutObjectResponse] #
Show PutObjectResponse Source #
Instance details Defined in Amazonka.BackupStorage.PutObject Methods showsPrec :: Int -> PutObjectResponse -> ShowS # show :: PutObjectResponse -> String # showList :: [PutObjectResponse] -> ShowS #
NFData PutObjectResponse Source #
Instance details Defined in Amazonka.BackupStorage.PutObject Methods rnf :: PutObjectResponse -> () #
Eq PutObjectResponse Source #
Instance details Defined in Amazonka.BackupStorage.PutObject Methods (==) :: PutObjectResponse -> PutObjectResponse -> Bool # (/=) :: PutObjectResponse -> PutObjectResponse -> Bool #
type Rep PutObjectResponse Source #
Instance details Defined in Amazonka.BackupStorage.PutObject type Rep PutObjectResponse = D1 ('MetaData "PutObjectResponse" "Amazonka.BackupStorage.PutObject" "amazonka-backupstorage-2.0-LZ4MZsHhisz8sYMq4uJ5tw" 'False) (C1 ('MetaCons "PutObjectResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "inlineChunkChecksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "inlineChunkChecksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DataChecksumAlgorithm) :: (S1 ('MetaSel ('Just "objectChecksum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "objectChecksumAlgorithm") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SummaryChecksumAlgorithm)))))

newPutObjectResponse Source #

Arguments

:: Int	`$sel:httpStatus:PutObjectResponse'`
-> Text	`PutObject`
-> DataChecksumAlgorithm	`PutObject`
-> Text	`PutObject`
-> SummaryChecksumAlgorithm	`PutObject`
-> PutObjectResponse