Amazonka.BackupStorage.StartObject

Start upload containing one or many chunks.

Creating a Request

data StartObject

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

ToJSON StartObject

Defined in Amazonka.BackupStorage.StartObject

Methods

toJSON :: StartObject -> Value

toEncoding :: StartObject -> Encoding

toJSONList :: [StartObject] -> Value

toEncodingList :: [StartObject] -> Encoding

ToHeaders StartObject

Defined in Amazonka.BackupStorage.StartObject

Methods

toHeaders :: StartObject -> [Header]

ToPath StartObject

Defined in Amazonka.BackupStorage.StartObject

Methods

toPath :: StartObject -> ByteString

ToQuery StartObject

Defined in Amazonka.BackupStorage.StartObject

Methods

toQuery :: StartObject -> QueryString

AWSRequest StartObject

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

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

Defined in Amazonka.BackupStorage.StartObject

Methods

readsPrec :: Int -> ReadS StartObject

readList :: ReadS [StartObject]

readPrec :: ReadPrec StartObject

readListPrec :: ReadPrec [StartObject]

Show StartObject

Defined in Amazonka.BackupStorage.StartObject

Methods

showsPrec :: Int -> StartObject -> ShowS

show :: StartObject -> String

showList :: [StartObject] -> ShowS

NFData StartObject

Defined in Amazonka.BackupStorage.StartObject

Methods

rnf :: StartObject -> ()

Eq StartObject

Defined in Amazonka.BackupStorage.StartObject

Methods

(==) :: StartObject -> StartObject -> Bool

(/=) :: StartObject -> StartObject -> Bool

Hashable StartObject

Defined in Amazonka.BackupStorage.StartObject

Methods

hashWithSalt :: Int -> StartObject -> Int

hash :: StartObject -> Int

type AWSResponse StartObject

Defined in Amazonka.BackupStorage.StartObject

type AWSResponse StartObject = StartObjectResponse

type Rep StartObject

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

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)

Throw an exception if Object name is already exist.

startObject_backupJobId :: Lens' StartObject Text

Backup job Id for the in-progress backup

startObject_objectName :: Lens' StartObject Text

Name for the object.

Destructuring the Response

data StartObjectResponse

See: newStartObjectResponse smart constructor.

Constructors

StartObjectResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• uploadId :: Text

  Upload Id for a given upload.

Instances

Generic StartObjectResponse

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

Defined in Amazonka.BackupStorage.StartObject

Methods

readsPrec :: Int -> ReadS StartObjectResponse

readList :: ReadS [StartObjectResponse]

readPrec :: ReadPrec StartObjectResponse

readListPrec :: ReadPrec [StartObjectResponse]

Show StartObjectResponse

Defined in Amazonka.BackupStorage.StartObject

Methods

showsPrec :: Int -> StartObjectResponse -> ShowS

show :: StartObjectResponse -> String

showList :: [StartObjectResponse] -> ShowS

NFData StartObjectResponse

Defined in Amazonka.BackupStorage.StartObject

Methods

rnf :: StartObjectResponse -> ()

Eq StartObjectResponse

Defined in Amazonka.BackupStorage.StartObject

Methods

(==) :: StartObjectResponse -> StartObjectResponse -> Bool

(/=) :: StartObjectResponse -> StartObjectResponse -> Bool

type Rep StartObjectResponse

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

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

The response's http status code.

startObjectResponse_uploadId :: Lens' StartObjectResponse Text

Upload Id for a given upload.