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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Start upload containing one or many chunks.

Synopsis

Creating a Request

data StartObject Source #

See: newStartObject smart constructor.

Constructors

StartObject'
Fields throwOnDuplicate :: Maybe Bool Throw an exception if Object name is already exist. backupJobId :: Text Backup job Id for the in-progress backup objectName :: Text Name for the object.

Instances

Instances details

ToJSON StartObject Source #
Instance details Defined in Amazonka.BackupStorage.StartObject Methods toJSON :: StartObject -> Value # toEncoding :: StartObject -> Encoding # toJSONList :: [StartObject] -> Value # toEncodingList :: [StartObject] -> Encoding #
ToHeaders StartObject Source #
Instance details Defined in Amazonka.BackupStorage.StartObject Methods toHeaders :: StartObject -> [Header] #
ToPath StartObject Source #
Instance details Defined in Amazonka.BackupStorage.StartObject Methods toPath :: StartObject -> ByteString #
ToQuery StartObject Source #
Instance details Defined in Amazonka.BackupStorage.StartObject Methods toQuery :: StartObject -> QueryString #
AWSRequest StartObject Source #
Instance details Defined in Amazonka.BackupStorage.StartObject Associated Types type AWSResponse StartObject # Methods request :: (Service -> Service) -> StartObject -> Request StartObject # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StartObject -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StartObject))) #
Generic StartObject Source #
Instance details Defined in Amazonka.BackupStorage.StartObject Associated Types type Rep StartObject :: Type -> Type # Methods from :: StartObject -> Rep StartObject x # to :: Rep StartObject x -> StartObject #
Read StartObject Source #
Instance details Defined in Amazonka.BackupStorage.StartObject Methods readsPrec :: Int -> ReadS StartObject # readList :: ReadS [StartObject] # readPrec :: ReadPrec StartObject # readListPrec :: ReadPrec [StartObject] #
Show StartObject Source #
Instance details Defined in Amazonka.BackupStorage.StartObject Methods showsPrec :: Int -> StartObject -> ShowS # show :: StartObject -> String # showList :: [StartObject] -> ShowS #
NFData StartObject Source #
Instance details Defined in Amazonka.BackupStorage.StartObject Methods rnf :: StartObject -> () #
Eq StartObject Source #
Instance details Defined in Amazonka.BackupStorage.StartObject Methods (==) :: StartObject -> StartObject -> Bool # (/=) :: StartObject -> StartObject -> Bool #
Hashable StartObject Source #
Instance details Defined in Amazonka.BackupStorage.StartObject Methods hashWithSalt :: Int -> StartObject -> Int # hash :: StartObject -> Int #
type AWSResponse StartObject Source #
Instance details Defined in Amazonka.BackupStorage.StartObject type AWSResponse StartObject = StartObjectResponse
type Rep StartObject Source #
Instance details Defined in Amazonka.BackupStorage.StartObject type Rep StartObject = D1 ('MetaData "StartObject" "Amazonka.BackupStorage.StartObject" "amazonka-backupstorage-2.0-LZ4MZsHhisz8sYMq4uJ5tw" 'False) (C1 ('MetaCons "StartObject'" 'PrefixI 'True) (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))))

newStartObject Source #

Arguments

:: Text	`$sel:backupJobId:StartObject'`
-> Text	`$sel:objectName:StartObject'`
-> StartObject

Create a value of StartObject 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:throwOnDuplicate:StartObject', startObject_throwOnDuplicate - Throw an exception if Object name is already exist.

$sel:backupJobId:StartObject', startObject_backupJobId - Backup job Id for the in-progress backup

$sel:objectName:StartObject', startObject_objectName - Name for the object.

Request Lenses

startObject_throwOnDuplicate :: Lens' StartObject (Maybe Bool) Source #

Throw an exception if Object name is already exist.

startObject_backupJobId :: Lens' StartObject Text Source #

Backup job Id for the in-progress backup

startObject_objectName :: Lens' StartObject Text Source #

Name for the object.

Destructuring the Response

data StartObjectResponse Source #

See: newStartObjectResponse smart constructor.

Constructors

StartObjectResponse'
Fields httpStatus :: Int The response's http status code. uploadId :: Text Upload Id for a given upload.

Instances

Instances details

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

newStartObjectResponse Source #

Arguments

:: Int	`$sel:httpStatus:StartObjectResponse'`
-> Text	`$sel:uploadId:StartObjectResponse'`
-> StartObjectResponse

Create a value of StartObjectResponse 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:httpStatus:StartObjectResponse', startObjectResponse_httpStatus - The response's http status code.

$sel:uploadId:StartObjectResponse', startObjectResponse_uploadId - Upload Id for a given upload.

Response Lenses

startObjectResponse_httpStatus :: Lens' StartObjectResponse Int Source #

The response's http status code.

startObjectResponse_uploadId :: Lens' StartObjectResponse Text Source #

Upload Id for a given upload.