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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Initiates a stop request for the current job. AWS Device Farm immediately stops the job on the device where tests have not started. You are not billed for this device. On the device where tests have started, setup suite and teardown suite tests run to completion on the device. You are billed for setup, teardown, and any tests that were in progress or already completed.

Synopsis

data StopJob = StopJob' {
- arn :: Text
}
newStopJob :: Text -> StopJob
stopJob_arn :: Lens' StopJob Text
data StopJobResponse = StopJobResponse' {
- job :: Maybe Job
- httpStatus :: Int
}
newStopJobResponse :: Int -> StopJobResponse
stopJobResponse_job :: Lens' StopJobResponse (Maybe Job)
stopJobResponse_httpStatus :: Lens' StopJobResponse Int

Creating a Request

data StopJob Source #

See: newStopJob smart constructor.

Constructors

StopJob'
Fields arn :: Text Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.

Instances

Instances details

Eq StopJob Source #
Instance details Defined in Amazonka.DeviceFarm.StopJob Methods (==) :: StopJob -> StopJob -> Bool # (/=) :: StopJob -> StopJob -> Bool #
Read StopJob Source #
Instance details Defined in Amazonka.DeviceFarm.StopJob Methods readsPrec :: Int -> ReadS StopJob # readList :: ReadS [StopJob] # readPrec :: ReadPrec StopJob # readListPrec :: ReadPrec [StopJob] #
Show StopJob Source #
Instance details Defined in Amazonka.DeviceFarm.StopJob Methods showsPrec :: Int -> StopJob -> ShowS # show :: StopJob -> String # showList :: [StopJob] -> ShowS #
Generic StopJob Source #
Instance details Defined in Amazonka.DeviceFarm.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.DeviceFarm.StopJob Methods rnf :: StopJob -> () #
Hashable StopJob Source #
Instance details Defined in Amazonka.DeviceFarm.StopJob Methods hashWithSalt :: Int -> StopJob -> Int # hash :: StopJob -> Int #
ToJSON StopJob Source #
Instance details Defined in Amazonka.DeviceFarm.StopJob Methods toJSON :: StopJob -> Value # toEncoding :: StopJob -> Encoding # toJSONList :: [StopJob] -> Value # toEncodingList :: [StopJob] -> Encoding #
AWSRequest StopJob Source #
Instance details Defined in Amazonka.DeviceFarm.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.DeviceFarm.StopJob Methods toHeaders :: StopJob -> [Header] #
ToPath StopJob Source #
Instance details Defined in Amazonka.DeviceFarm.StopJob Methods toPath :: StopJob -> ByteString #
ToQuery StopJob Source #
Instance details Defined in Amazonka.DeviceFarm.StopJob Methods toQuery :: StopJob -> QueryString #
type Rep StopJob Source #
Instance details Defined in Amazonka.DeviceFarm.StopJob type Rep StopJob = D1 ('MetaData "StopJob" "Amazonka.DeviceFarm.StopJob" "libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm" 'False) (C1 ('MetaCons "StopJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopJob Source #
Instance details Defined in Amazonka.DeviceFarm.StopJob type AWSResponse StopJob = StopJobResponse

newStopJob Source #

Arguments

:: Text	`$sel:arn: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:arn:StopJob', stopJob_arn - Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.

Request Lenses

stopJob_arn :: Lens' StopJob Text Source #

Represents the Amazon Resource Name (ARN) of the Device Farm job to stop.

Destructuring the Response

data StopJobResponse Source #

See: newStopJobResponse smart constructor.

Constructors

StopJobResponse'
Fields job :: Maybe Job The job that was stopped. httpStatus :: Int The response's http status code.

Instances

Instances details

Eq StopJobResponse Source #
Instance details Defined in Amazonka.DeviceFarm.StopJob Methods (==) :: StopJobResponse -> StopJobResponse -> Bool # (/=) :: StopJobResponse -> StopJobResponse -> Bool #
Read StopJobResponse Source #
Instance details Defined in Amazonka.DeviceFarm.StopJob Methods readsPrec :: Int -> ReadS StopJobResponse # readList :: ReadS [StopJobResponse] # readPrec :: ReadPrec StopJobResponse # readListPrec :: ReadPrec [StopJobResponse] #
Show StopJobResponse Source #
Instance details Defined in Amazonka.DeviceFarm.StopJob Methods showsPrec :: Int -> StopJobResponse -> ShowS # show :: StopJobResponse -> String # showList :: [StopJobResponse] -> ShowS #
Generic StopJobResponse Source #
Instance details Defined in Amazonka.DeviceFarm.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.DeviceFarm.StopJob Methods rnf :: StopJobResponse -> () #
type Rep StopJobResponse Source #
Instance details Defined in Amazonka.DeviceFarm.StopJob type Rep StopJobResponse = D1 ('MetaData "StopJobResponse" "Amazonka.DeviceFarm.StopJob" "libZSservicesZSamazonka-devicefarmZSamazonka-devicefarm" 'False) (C1 ('MetaCons "StopJobResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "job") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Job)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newStopJobResponse Source #

Arguments

:: Int	`$sel:httpStatus: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:job:StopJobResponse', stopJobResponse_job - The job that was stopped.

$sel:httpStatus:StopJobResponse', stopJobResponse_httpStatus - The response's http status code.

Response Lenses

stopJobResponse_job :: Lens' StopJobResponse (Maybe Job) Source #

The job that was stopped.

stopJobResponse_httpStatus :: Lens' StopJobResponse Int Source #

The response's http status code.