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.ImportExport.UpdateJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

You use this operation to change the parameters specified in the original manifest file by supplying a new manifest file. The manifest file attached to this request replaces the original manifest file. You can only use the operation after a CreateJob request but before the data transfer starts and you can only use it on jobs you own.

Synopsis

data UpdateJob = UpdateJob' {
- aPIVersion :: Maybe Text
- jobId :: Text
- manifest :: Text
- jobType :: JobType
- validateOnly :: Bool
}
newUpdateJob :: Text -> Text -> JobType -> Bool -> UpdateJob
updateJob_aPIVersion :: Lens' UpdateJob (Maybe Text)
updateJob_jobId :: Lens' UpdateJob Text
updateJob_manifest :: Lens' UpdateJob Text
updateJob_jobType :: Lens' UpdateJob JobType
updateJob_validateOnly :: Lens' UpdateJob Bool
data UpdateJobResponse = UpdateJobResponse' {
- success :: Maybe Bool
- warningMessage :: Maybe Text
- artifactList :: Maybe [Artifact]
- httpStatus :: Int
}
newUpdateJobResponse :: Int -> UpdateJobResponse
updateJobResponse_success :: Lens' UpdateJobResponse (Maybe Bool)
updateJobResponse_warningMessage :: Lens' UpdateJobResponse (Maybe Text)
updateJobResponse_artifactList :: Lens' UpdateJobResponse (Maybe [Artifact])
updateJobResponse_httpStatus :: Lens' UpdateJobResponse Int

Creating a Request

data UpdateJob Source #

Input structure for the UpateJob operation.

See: newUpdateJob smart constructor.

Constructors

UpdateJob'
Fields aPIVersion :: Maybe Text jobId :: Text manifest :: Text jobType :: JobType validateOnly :: Bool

Instances

Instances details

Eq UpdateJob Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Methods (==) :: UpdateJob -> UpdateJob -> Bool # (/=) :: UpdateJob -> UpdateJob -> Bool #
Read UpdateJob Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Methods readsPrec :: Int -> ReadS UpdateJob # readList :: ReadS [UpdateJob] # readPrec :: ReadPrec UpdateJob # readListPrec :: ReadPrec [UpdateJob] #
Show UpdateJob Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Methods showsPrec :: Int -> UpdateJob -> ShowS # show :: UpdateJob -> String # showList :: [UpdateJob] -> ShowS #
Generic UpdateJob Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Associated Types type Rep UpdateJob :: Type -> Type # Methods from :: UpdateJob -> Rep UpdateJob x # to :: Rep UpdateJob x -> UpdateJob #
NFData UpdateJob Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Methods rnf :: UpdateJob -> () #
Hashable UpdateJob Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Methods hashWithSalt :: Int -> UpdateJob -> Int # hash :: UpdateJob -> Int #
AWSRequest UpdateJob Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Associated Types type AWSResponse UpdateJob # Methods request :: UpdateJob -> Request UpdateJob # response :: MonadResource m => Logger -> Service -> Proxy UpdateJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateJob))) #
ToHeaders UpdateJob Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Methods toHeaders :: UpdateJob -> [Header] #
ToPath UpdateJob Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Methods toPath :: UpdateJob -> ByteString #
ToQuery UpdateJob Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Methods toQuery :: UpdateJob -> QueryString #
type Rep UpdateJob Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob type Rep UpdateJob = D1 ('MetaData "UpdateJob" "Amazonka.ImportExport.UpdateJob" "libZSservicesZSamazonka-importexportZSamazonka-importexport" 'False) (C1 ('MetaCons "UpdateJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aPIVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "jobId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "manifest") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "jobType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 JobType) :: S1 ('MetaSel ('Just "validateOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool)))))
type AWSResponse UpdateJob Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob type AWSResponse UpdateJob = UpdateJobResponse

newUpdateJob Source #

Arguments

:: Text	`$sel:jobId:UpdateJob'`
-> Text	`$sel:manifest:UpdateJob'`
-> JobType	`$sel:jobType:UpdateJob'`
-> Bool	`$sel:validateOnly:UpdateJob'`
-> UpdateJob

Create a value of UpdateJob 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:aPIVersion:UpdateJob', updateJob_aPIVersion - Undocumented member.

$sel:jobId:UpdateJob', updateJob_jobId - Undocumented member.

$sel:manifest:UpdateJob', updateJob_manifest - Undocumented member.

$sel:jobType:UpdateJob', updateJob_jobType - Undocumented member.

$sel:validateOnly:UpdateJob', updateJob_validateOnly - Undocumented member.

Request Lenses

updateJob_aPIVersion :: Lens' UpdateJob (Maybe Text) Source #

Undocumented member.

updateJob_jobId :: Lens' UpdateJob Text Source #

Undocumented member.

updateJob_manifest :: Lens' UpdateJob Text Source #

Undocumented member.

updateJob_jobType :: Lens' UpdateJob JobType Source #

Undocumented member.

updateJob_validateOnly :: Lens' UpdateJob Bool Source #

Undocumented member.

Destructuring the Response

data UpdateJobResponse Source #

Output structure for the UpateJob operation.

See: newUpdateJobResponse smart constructor.

Constructors

UpdateJobResponse'
Fields success :: Maybe Bool warningMessage :: Maybe Text artifactList :: Maybe [Artifact] httpStatus :: Int The response's http status code.

Instances

Instances details

Eq UpdateJobResponse Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Methods (==) :: UpdateJobResponse -> UpdateJobResponse -> Bool # (/=) :: UpdateJobResponse -> UpdateJobResponse -> Bool #
Read UpdateJobResponse Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Methods readsPrec :: Int -> ReadS UpdateJobResponse # readList :: ReadS [UpdateJobResponse] # readPrec :: ReadPrec UpdateJobResponse # readListPrec :: ReadPrec [UpdateJobResponse] #
Show UpdateJobResponse Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Methods showsPrec :: Int -> UpdateJobResponse -> ShowS # show :: UpdateJobResponse -> String # showList :: [UpdateJobResponse] -> ShowS #
Generic UpdateJobResponse Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Associated Types type Rep UpdateJobResponse :: Type -> Type # Methods from :: UpdateJobResponse -> Rep UpdateJobResponse x # to :: Rep UpdateJobResponse x -> UpdateJobResponse #
NFData UpdateJobResponse Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob Methods rnf :: UpdateJobResponse -> () #
type Rep UpdateJobResponse Source #
Instance details Defined in Amazonka.ImportExport.UpdateJob type Rep UpdateJobResponse = D1 ('MetaData "UpdateJobResponse" "Amazonka.ImportExport.UpdateJob" "libZSservicesZSamazonka-importexportZSamazonka-importexport" 'False) (C1 ('MetaCons "UpdateJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "success") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: S1 ('MetaSel ('Just "warningMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "artifactList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Artifact])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))