Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Inspector.StopAssessmentRun

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

Stops the assessment run that is specified by the ARN of the assessment run.

Creating a Request

data StopAssessmentRun Source #

See: newStopAssessmentRun smart constructor.

Constructors

StopAssessmentRun'

Fields

stopAction :: Maybe StopAction
An input option that can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated.
assessmentRunArn :: Text
The ARN of the assessment run that you want to stop.

Instances

Instances details

ToJSON StopAssessmentRun Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Methods toJSON :: StopAssessmentRun -> Value # toEncoding :: StopAssessmentRun -> Encoding # toJSONList :: [StopAssessmentRun] -> Value # toEncodingList :: [StopAssessmentRun] -> Encoding #
ToHeaders StopAssessmentRun Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Methods toHeaders :: StopAssessmentRun -> [Header] #
ToPath StopAssessmentRun Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Methods toPath :: StopAssessmentRun -> ByteString #
ToQuery StopAssessmentRun Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Methods toQuery :: StopAssessmentRun -> QueryString #
AWSRequest StopAssessmentRun Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Associated Types type AWSResponse StopAssessmentRun # Methods request :: (Service -> Service) -> StopAssessmentRun -> Request StopAssessmentRun # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopAssessmentRun -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopAssessmentRun))) #
Generic StopAssessmentRun Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Associated Types type Rep StopAssessmentRun :: Type -> Type # Methods from :: StopAssessmentRun -> Rep StopAssessmentRun x # to :: Rep StopAssessmentRun x -> StopAssessmentRun #
Read StopAssessmentRun Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Methods readsPrec :: Int -> ReadS StopAssessmentRun # readList :: ReadS [StopAssessmentRun] # readPrec :: ReadPrec StopAssessmentRun # readListPrec :: ReadPrec [StopAssessmentRun] #
Show StopAssessmentRun Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Methods showsPrec :: Int -> StopAssessmentRun -> ShowS # show :: StopAssessmentRun -> String # showList :: [StopAssessmentRun] -> ShowS #
NFData StopAssessmentRun Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Methods rnf :: StopAssessmentRun -> () #
Eq StopAssessmentRun Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Methods (==) :: StopAssessmentRun -> StopAssessmentRun -> Bool # (/=) :: StopAssessmentRun -> StopAssessmentRun -> Bool #
Hashable StopAssessmentRun Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Methods hashWithSalt :: Int -> StopAssessmentRun -> Int # hash :: StopAssessmentRun -> Int #
type AWSResponse StopAssessmentRun Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun type AWSResponse StopAssessmentRun = StopAssessmentRunResponse
type Rep StopAssessmentRun Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun type Rep StopAssessmentRun = D1 ('MetaData "StopAssessmentRun" "Amazonka.Inspector.StopAssessmentRun" "amazonka-inspector-2.0-DbkSB2KDR0U54GYFqTMz6L" 'False) (C1 ('MetaCons "StopAssessmentRun'" 'PrefixI 'True) (S1 ('MetaSel ('Just "stopAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StopAction)) :*: S1 ('MetaSel ('Just "assessmentRunArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopAssessmentRun Source #

Arguments

:: Text	`StopAssessmentRun`
-> StopAssessmentRun

Create a value of StopAssessmentRun 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:stopAction:StopAssessmentRun', stopAssessmentRun_stopAction - An input option that can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated.

StopAssessmentRun, stopAssessmentRun_assessmentRunArn - The ARN of the assessment run that you want to stop.

Request Lenses

stopAssessmentRun_stopAction :: Lens' StopAssessmentRun (Maybe StopAction) Source #

An input option that can be set to either START_EVALUATION or SKIP_EVALUATION. START_EVALUATION (the default value), stops the AWS agent from collecting data and begins the results evaluation and the findings generation process. SKIP_EVALUATION cancels the assessment run immediately, after which no findings are generated.

stopAssessmentRun_assessmentRunArn :: Lens' StopAssessmentRun Text Source #

The ARN of the assessment run that you want to stop.

Destructuring the Response

data StopAssessmentRunResponse Source #

See: newStopAssessmentRunResponse smart constructor.

Constructors

StopAssessmentRunResponse'

Instances

Instances details

Generic StopAssessmentRunResponse Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Associated Types type Rep StopAssessmentRunResponse :: Type -> Type # Methods from :: StopAssessmentRunResponse -> Rep StopAssessmentRunResponse x # to :: Rep StopAssessmentRunResponse x -> StopAssessmentRunResponse #
Read StopAssessmentRunResponse Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Methods readsPrec :: Int -> ReadS StopAssessmentRunResponse # readList :: ReadS [StopAssessmentRunResponse] # readPrec :: ReadPrec StopAssessmentRunResponse # readListPrec :: ReadPrec [StopAssessmentRunResponse] #
Show StopAssessmentRunResponse Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Methods showsPrec :: Int -> StopAssessmentRunResponse -> ShowS # show :: StopAssessmentRunResponse -> String # showList :: [StopAssessmentRunResponse] -> ShowS #
NFData StopAssessmentRunResponse Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Methods rnf :: StopAssessmentRunResponse -> () #
Eq StopAssessmentRunResponse Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun Methods (==) :: StopAssessmentRunResponse -> StopAssessmentRunResponse -> Bool # (/=) :: StopAssessmentRunResponse -> StopAssessmentRunResponse -> Bool #
type Rep StopAssessmentRunResponse Source #
Instance details Defined in Amazonka.Inspector.StopAssessmentRun type Rep StopAssessmentRunResponse = D1 ('MetaData "StopAssessmentRunResponse" "Amazonka.Inspector.StopAssessmentRun" "amazonka-inspector-2.0-DbkSB2KDR0U54GYFqTMz6L" 'False) (C1 ('MetaCons "StopAssessmentRunResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newStopAssessmentRunResponse :: StopAssessmentRunResponse Source #

Create a value of StopAssessmentRunResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.