amazonka-inspector-2.0: Amazon Inspector 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.Inspector.StopAssessmentRun

Description

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

Synopsis

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

ToHeaders StopAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

ToPath StopAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

ToQuery StopAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

AWSRequest StopAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

Associated Types

type AWSResponse StopAssessmentRun #

Generic StopAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

Associated Types

type Rep StopAssessmentRun :: Type -> Type #

Read StopAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

Show StopAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

NFData StopAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

Methods

rnf :: StopAssessmentRun -> () #

Eq StopAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

Hashable StopAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

type AWSResponse StopAssessmentRun Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

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 #

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.

Instances

Instances details
Generic StopAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

Associated Types

type Rep StopAssessmentRunResponse :: Type -> Type #

Read StopAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

Show StopAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

NFData StopAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

Eq StopAssessmentRunResponse Source # 
Instance details

Defined in Amazonka.Inspector.StopAssessmentRun

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.