amazonka-devicefarm-2.0: Amazon Device Farm SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.DeviceFarm.StopJob

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

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
ToJSON StopJob Source # 
Instance details

Defined in Amazonka.DeviceFarm.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

AWSRequest StopJob Source # 
Instance details

Defined in Amazonka.DeviceFarm.StopJob

Associated Types

type AWSResponse StopJob #

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 #

Read StopJob Source # 
Instance details

Defined in Amazonka.DeviceFarm.StopJob

Show StopJob Source # 
Instance details

Defined in Amazonka.DeviceFarm.StopJob

NFData StopJob Source # 
Instance details

Defined in Amazonka.DeviceFarm.StopJob

Methods

rnf :: StopJob -> () #

Eq StopJob Source # 
Instance details

Defined in Amazonka.DeviceFarm.StopJob

Methods

(==) :: StopJob -> StopJob -> Bool #

(/=) :: StopJob -> StopJob -> Bool #

Hashable StopJob Source # 
Instance details

Defined in Amazonka.DeviceFarm.StopJob

Methods

hashWithSalt :: Int -> StopJob -> Int #

hash :: StopJob -> Int #

type AWSResponse StopJob Source # 
Instance details

Defined in Amazonka.DeviceFarm.StopJob

type Rep StopJob Source # 
Instance details

Defined in Amazonka.DeviceFarm.StopJob

type Rep StopJob = D1 ('MetaData "StopJob" "Amazonka.DeviceFarm.StopJob" "amazonka-devicefarm-2.0-2e4KvZvQ9bT8TNjEPvmW9Q" 'False) (C1 ('MetaCons "StopJob'" 'PrefixI 'True) (S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopJob Source #

Arguments

:: Text

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:

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

Instances

Instances details
Generic StopJobResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.StopJob

Associated Types

type Rep StopJobResponse :: Type -> Type #

Read StopJobResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.StopJob

Show StopJobResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.StopJob

NFData StopJobResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.StopJob

Methods

rnf :: StopJobResponse -> () #

Eq StopJobResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.StopJob

type Rep StopJobResponse Source # 
Instance details

Defined in Amazonka.DeviceFarm.StopJob

type Rep StopJobResponse = D1 ('MetaData "StopJobResponse" "Amazonka.DeviceFarm.StopJob" "amazonka-devicefarm-2.0-2e4KvZvQ9bT8TNjEPvmW9Q" '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 #

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:

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.