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.Amplify.StopJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Stops a job that is in progress for a branch of an Amplify app.

Synopsis

data StopJob = StopJob' {
- appId :: Text
- branchName :: Text
- jobId :: Text
}
newStopJob :: Text -> Text -> Text -> StopJob
stopJob_appId :: Lens' StopJob Text
stopJob_branchName :: Lens' StopJob Text
stopJob_jobId :: Lens' StopJob Text
data StopJobResponse = StopJobResponse' {
- httpStatus :: Int
- jobSummary :: JobSummary
}
newStopJobResponse :: Int -> JobSummary -> StopJobResponse
stopJobResponse_httpStatus :: Lens' StopJobResponse Int
stopJobResponse_jobSummary :: Lens' StopJobResponse JobSummary

Creating a Request

data StopJob Source #

The request structure for the stop job request.

See: newStopJob smart constructor.

Constructors

StopJob'
Fields appId :: Text The unique ID for an Amplify app. branchName :: Text The name for the branch, for the job. jobId :: Text The unique id for the job.

Instances

Instances details

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

newStopJob Source #

Arguments

:: Text	`$sel:appId:StopJob'`
-> Text	`$sel:branchName:StopJob'`
-> Text	`$sel:jobId:StopJob'`
-> StopJob

Create a value of StopJob 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:appId:StopJob', stopJob_appId - The unique ID for an Amplify app.

$sel:branchName:StopJob', stopJob_branchName - The name for the branch, for the job.

$sel:jobId:StopJob', stopJob_jobId - The unique id for the job.

Request Lenses

stopJob_appId :: Lens' StopJob Text Source #

The unique ID for an Amplify app.

stopJob_branchName :: Lens' StopJob Text Source #

The name for the branch, for the job.

stopJob_jobId :: Lens' StopJob Text Source #

The unique id for the job.

Destructuring the Response

data StopJobResponse Source #

The result structure for the stop job request.

See: newStopJobResponse smart constructor.

Constructors

StopJobResponse'
Fields httpStatus :: Int The response's http status code. jobSummary :: JobSummary The summary for the job.

Instances

Instances details

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

newStopJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:StopJobResponse'`
-> JobSummary	`$sel:jobSummary:StopJobResponse'`
-> StopJobResponse

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

$sel:jobSummary:StopJobResponse', stopJobResponse_jobSummary - The summary for the job.

Response Lenses

stopJobResponse_httpStatus :: Lens' StopJobResponse Int Source #

The response's http status code.

stopJobResponse_jobSummary :: Lens' StopJobResponse JobSummary Source #

The summary for the job.