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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This operation cancels a specified job. Only the job owner can cancel it. The operation fails if the job has already started or is complete.

Synopsis

data CancelJob = CancelJob' {
- aPIVersion :: Maybe Text
- jobId :: Text
}
newCancelJob :: Text -> CancelJob
cancelJob_aPIVersion :: Lens' CancelJob (Maybe Text)
cancelJob_jobId :: Lens' CancelJob Text
data CancelJobResponse = CancelJobResponse' {
- success :: Maybe Bool
- httpStatus :: Int
}
newCancelJobResponse :: Int -> CancelJobResponse
cancelJobResponse_success :: Lens' CancelJobResponse (Maybe Bool)
cancelJobResponse_httpStatus :: Lens' CancelJobResponse Int

Creating a Request

data CancelJob Source #

Input structure for the CancelJob operation.

See: newCancelJob smart constructor.

Constructors

CancelJob'
Fields aPIVersion :: Maybe Text jobId :: Text

Instances

Instances details

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

newCancelJob Source #

Arguments

:: Text	`$sel:jobId:CancelJob'`
-> CancelJob

Create a value of CancelJob 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:CancelJob', cancelJob_aPIVersion - Undocumented member.

$sel:jobId:CancelJob', cancelJob_jobId - Undocumented member.

Request Lenses

cancelJob_aPIVersion :: Lens' CancelJob (Maybe Text) Source #

Undocumented member.

cancelJob_jobId :: Lens' CancelJob Text Source #

Undocumented member.

Destructuring the Response

data CancelJobResponse Source #

Output structure for the CancelJob operation.

See: newCancelJobResponse smart constructor.

Constructors

CancelJobResponse'
Fields success :: Maybe Bool httpStatus :: Int The response's http status code.

Instances

Instances details

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

newCancelJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:CancelJobResponse'`
-> CancelJobResponse

Create a value of CancelJobResponse 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:success:CancelJobResponse', cancelJobResponse_success - Undocumented member.

$sel:httpStatus:CancelJobResponse', cancelJobResponse_httpStatus - The response's http status code.

Response Lenses

cancelJobResponse_success :: Lens' CancelJobResponse (Maybe Bool) Source #

Undocumented member.

cancelJobResponse_httpStatus :: Lens' CancelJobResponse Int Source #

The response's http status code.