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.Inspector.Types.AssessmentRun

Description

Synopsis

data AssessmentRun = AssessmentRun' {
- startedAt :: Maybe POSIX
- completedAt :: Maybe POSIX
- arn :: Text
- name :: Text
- assessmentTemplateArn :: Text
- state :: AssessmentRunState
- durationInSeconds :: Natural
- rulesPackageArns :: NonEmpty Text
- userAttributesForFindings :: [Attribute]
- createdAt :: POSIX
- stateChangedAt :: POSIX
- dataCollected :: Bool
- stateChanges :: [AssessmentRunStateChange]
- notifications :: [AssessmentRunNotification]
- findingCounts :: HashMap Severity Int
}
newAssessmentRun :: Text -> Text -> Text -> AssessmentRunState -> Natural -> NonEmpty Text -> UTCTime -> UTCTime -> Bool -> AssessmentRun
assessmentRun_startedAt :: Lens' AssessmentRun (Maybe UTCTime)
assessmentRun_completedAt :: Lens' AssessmentRun (Maybe UTCTime)
assessmentRun_arn :: Lens' AssessmentRun Text
assessmentRun_name :: Lens' AssessmentRun Text
assessmentRun_assessmentTemplateArn :: Lens' AssessmentRun Text
assessmentRun_state :: Lens' AssessmentRun AssessmentRunState
assessmentRun_durationInSeconds :: Lens' AssessmentRun Natural
assessmentRun_rulesPackageArns :: Lens' AssessmentRun (NonEmpty Text)
assessmentRun_userAttributesForFindings :: Lens' AssessmentRun [Attribute]
assessmentRun_createdAt :: Lens' AssessmentRun UTCTime
assessmentRun_stateChangedAt :: Lens' AssessmentRun UTCTime
assessmentRun_dataCollected :: Lens' AssessmentRun Bool
assessmentRun_stateChanges :: Lens' AssessmentRun [AssessmentRunStateChange]
assessmentRun_notifications :: Lens' AssessmentRun [AssessmentRunNotification]
assessmentRun_findingCounts :: Lens' AssessmentRun (HashMap Severity Int)

Documentation

data AssessmentRun Source #

A snapshot of an Amazon Inspector assessment run that contains the findings of the assessment run .

Used as the response element in the DescribeAssessmentRuns action.

See: newAssessmentRun smart constructor.

Constructors

AssessmentRun'

Fields

startedAt :: Maybe POSIX
The time when StartAssessmentRun was called.
completedAt :: Maybe POSIX
The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.
arn :: Text
The ARN of the assessment run.
name :: Text
The auto-generated name for the assessment run.
assessmentTemplateArn :: Text
The ARN of the assessment template that is associated with the assessment run.
state :: AssessmentRunState
The state of the assessment run.
durationInSeconds :: Natural
The duration of the assessment run.
rulesPackageArns :: NonEmpty Text
The rules packages selected for the assessment run.
userAttributesForFindings :: [Attribute]
The user-defined attributes that are assigned to every generated finding.
createdAt :: POSIX
The time when StartAssessmentRun was called.
stateChangedAt :: POSIX
The last time when the assessment run's state changed.
dataCollected :: Bool
A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.
stateChanges :: [AssessmentRunStateChange]
A list of the assessment run state changes.
notifications :: [AssessmentRunNotification]
A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.
findingCounts :: HashMap Severity Int
Provides a total count of generated findings per severity.

Instances

Instances details

Eq AssessmentRun Source #
Instance details Defined in Amazonka.Inspector.Types.AssessmentRun Methods (==) :: AssessmentRun -> AssessmentRun -> Bool # (/=) :: AssessmentRun -> AssessmentRun -> Bool #
Read AssessmentRun Source #
Instance details Defined in Amazonka.Inspector.Types.AssessmentRun Methods readsPrec :: Int -> ReadS AssessmentRun # readList :: ReadS [AssessmentRun] # readPrec :: ReadPrec AssessmentRun # readListPrec :: ReadPrec [AssessmentRun] #
Show AssessmentRun Source #
Instance details Defined in Amazonka.Inspector.Types.AssessmentRun Methods showsPrec :: Int -> AssessmentRun -> ShowS # show :: AssessmentRun -> String # showList :: [AssessmentRun] -> ShowS #
Generic AssessmentRun Source #
Instance details Defined in Amazonka.Inspector.Types.AssessmentRun Associated Types type Rep AssessmentRun :: Type -> Type # Methods from :: AssessmentRun -> Rep AssessmentRun x # to :: Rep AssessmentRun x -> AssessmentRun #
NFData AssessmentRun Source #
Instance details Defined in Amazonka.Inspector.Types.AssessmentRun Methods rnf :: AssessmentRun -> () #
Hashable AssessmentRun Source #
Instance details Defined in Amazonka.Inspector.Types.AssessmentRun Methods hashWithSalt :: Int -> AssessmentRun -> Int # hash :: AssessmentRun -> Int #
FromJSON AssessmentRun Source #
Instance details Defined in Amazonka.Inspector.Types.AssessmentRun Methods parseJSON :: Value -> Parser AssessmentRun # parseJSONList :: Value -> Parser [AssessmentRun] #
type Rep AssessmentRun Source #
Instance details Defined in Amazonka.Inspector.Types.AssessmentRun type Rep AssessmentRun = D1 ('MetaData "AssessmentRun" "Amazonka.Inspector.Types.AssessmentRun" "libZSservicesZSamazonka-inspectorZSamazonka-inspector" 'False) (C1 ('MetaCons "AssessmentRun'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "startedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: (S1 ('MetaSel ('Just "completedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: ((S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "assessmentTemplateArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AssessmentRunState) :: S1 ('MetaSel ('Just "durationInSeconds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Natural)))) :: (((S1 ('MetaSel ('Just "rulesPackageArns") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :: S1 ('MetaSel ('Just "userAttributesForFindings") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Attribute])) :: (S1 ('MetaSel ('Just "createdAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "stateChangedAt") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))) :: ((S1 ('MetaSel ('Just "dataCollected") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Bool) :: S1 ('MetaSel ('Just "stateChanges") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AssessmentRunStateChange])) :: (S1 ('MetaSel ('Just "notifications") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [AssessmentRunNotification]) :: S1 ('MetaSel ('Just "findingCounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Severity Int)))))))

newAssessmentRun Source #

Create a value of AssessmentRun 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:startedAt:AssessmentRun', assessmentRun_startedAt - The time when StartAssessmentRun was called.

$sel:completedAt:AssessmentRun', assessmentRun_completedAt - The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.

$sel:arn:AssessmentRun', assessmentRun_arn - The ARN of the assessment run.

$sel:name:AssessmentRun', assessmentRun_name - The auto-generated name for the assessment run.

$sel:assessmentTemplateArn:AssessmentRun', assessmentRun_assessmentTemplateArn - The ARN of the assessment template that is associated with the assessment run.

$sel:state:AssessmentRun', assessmentRun_state - The state of the assessment run.

$sel:durationInSeconds:AssessmentRun', assessmentRun_durationInSeconds - The duration of the assessment run.

$sel:rulesPackageArns:AssessmentRun', assessmentRun_rulesPackageArns - The rules packages selected for the assessment run.

$sel:userAttributesForFindings:AssessmentRun', assessmentRun_userAttributesForFindings - The user-defined attributes that are assigned to every generated finding.

$sel:createdAt:AssessmentRun', assessmentRun_createdAt - The time when StartAssessmentRun was called.

$sel:stateChangedAt:AssessmentRun', assessmentRun_stateChangedAt - The last time when the assessment run's state changed.

$sel:dataCollected:AssessmentRun', assessmentRun_dataCollected - A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.

$sel:stateChanges:AssessmentRun', assessmentRun_stateChanges - A list of the assessment run state changes.

$sel:notifications:AssessmentRun', assessmentRun_notifications - A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.

$sel:findingCounts:AssessmentRun', assessmentRun_findingCounts - Provides a total count of generated findings per severity.

assessmentRun_startedAt :: Lens' AssessmentRun (Maybe UTCTime) Source #

The time when StartAssessmentRun was called.

assessmentRun_completedAt :: Lens' AssessmentRun (Maybe UTCTime) Source #

The assessment run completion time that corresponds to the rules packages evaluation completion time or failure.

assessmentRun_arn :: Lens' AssessmentRun Text Source #

The ARN of the assessment run.

assessmentRun_name :: Lens' AssessmentRun Text Source #

The auto-generated name for the assessment run.

assessmentRun_assessmentTemplateArn :: Lens' AssessmentRun Text Source #

The ARN of the assessment template that is associated with the assessment run.

assessmentRun_state :: Lens' AssessmentRun AssessmentRunState Source #

The state of the assessment run.

assessmentRun_durationInSeconds :: Lens' AssessmentRun Natural Source #

The duration of the assessment run.

assessmentRun_rulesPackageArns :: Lens' AssessmentRun (NonEmpty Text) Source #

The rules packages selected for the assessment run.

assessmentRun_userAttributesForFindings :: Lens' AssessmentRun [Attribute] Source #

The user-defined attributes that are assigned to every generated finding.

assessmentRun_createdAt :: Lens' AssessmentRun UTCTime Source #

The time when StartAssessmentRun was called.

assessmentRun_stateChangedAt :: Lens' AssessmentRun UTCTime Source #

The last time when the assessment run's state changed.

assessmentRun_dataCollected :: Lens' AssessmentRun Bool Source #

A Boolean value (true or false) that specifies whether the process of collecting data from the agents is completed.

assessmentRun_stateChanges :: Lens' AssessmentRun [AssessmentRunStateChange] Source #

A list of the assessment run state changes.

assessmentRun_notifications :: Lens' AssessmentRun [AssessmentRunNotification] Source #

A list of notifications for the event subscriptions. A notification about a particular generated finding is added to this list only once.

assessmentRun_findingCounts :: Lens' AssessmentRun (HashMap Severity Int) Source #

Provides a total count of generated findings per severity.

:: Text	`$sel:arn:AssessmentRun'`
-> Text	`$sel:name:AssessmentRun'`
-> Text	`$sel:assessmentTemplateArn:AssessmentRun'`
-> AssessmentRunState	`$sel:state:AssessmentRun'`
-> Natural	`$sel:durationInSeconds:AssessmentRun'`
-> NonEmpty Text	`$sel:rulesPackageArns:AssessmentRun'`
-> UTCTime	`$sel:createdAt:AssessmentRun'`
-> UTCTime	`$sel:stateChangedAt:AssessmentRun'`
-> Bool	`$sel:dataCollected:AssessmentRun'`
-> AssessmentRun