Network.AWS.Inspector.Types

Service Configuration

inspector :: Service

API version '2015-08-18' of the Amazon Inspector SDK configuration.

Errors

_AccessDeniedException :: AsError a => Getting (First ServiceError) a ServiceError

Prism for AccessDeniedException' errors.

_NoSuchEntityException :: AsError a => Getting (First ServiceError) a ServiceError

Prism for NoSuchEntityException' errors.

_OperationInProgressException :: AsError a => Getting (First ServiceError) a ServiceError

Prism for OperationInProgressException' errors.

_InvalidCrossAccountRoleException :: AsError a => Getting (First ServiceError) a ServiceError

Prism for InvalidCrossAccountRoleException' errors.

_InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError

Prism for InvalidInputException' errors.

_InternalException :: AsError a => Getting (First ServiceError) a ServiceError

Prism for InternalException' errors.

Agent

data Agent

Contains information about an Inspector agent. This data type is used as a response element in the ListAssessmentAgents action.

See: agent smart constructor.

Instances

Eq Agent

Data Agent

Read Agent

Show Agent

Generic Agent

FromJSON Agent

type Rep Agent

agent :: Agent

Creates a value of Agent with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aTelemetry
• aAutoScalingGroup
• aAgentHealthCode
• aAssessmentARN
• aAgentId
• aAccountId
• aAgentHealthDetails
• aAgentHealth

aTelemetry :: Lens' Agent [Telemetry]

The Inspector application data metrics collected by the agent.

aAutoScalingGroup :: Lens' Agent (Maybe Text)

This data type property is currently not used.

aAgentHealthCode :: Lens' Agent (Maybe Text)

The detailed health state of the agent. Values can be set to RUNNING, HEALTHY, UNHEALTHY, UNKNOWN, BLACKLISTED, SHUTDOWN, THROTTLED.

aAssessmentARN :: Lens' Agent (Maybe Text)

The ARN of the assessment that is associated with the agent.

aAgentId :: Lens' Agent (Maybe Text)

The EC2 instance ID where the agent is installed.

aAccountId :: Lens' Agent (Maybe Text)

AWS account of the EC2 instance where the agent is installed.

aAgentHealthDetails :: Lens' Agent (Maybe Text)

The description for the agent health code.

aAgentHealth :: Lens' Agent (Maybe Text)

The current health state of the agent. Values can be set to HEALTHY or UNHEALTHY.

AgentPreview

data AgentPreview

This data type is used as a response element in the PreviewAgentsForResourceGroup action.

See: agentPreview smart constructor.

Instances

Eq AgentPreview

Data AgentPreview

Read AgentPreview

Show AgentPreview

Generic AgentPreview

FromJSON AgentPreview

type Rep AgentPreview

agentPreview :: AgentPreview

Creates a value of AgentPreview with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• apAutoScalingGroup
• apAgentId

apAutoScalingGroup :: Lens' AgentPreview (Maybe Text)

The autoscaling group for the EC2 instance where the agent is installed.

apAgentId :: Lens' AgentPreview (Maybe Text)

The id of the EC2 instance where the agent is intalled.

AgentsFilter

data AgentsFilter

This data type is used as a response element in the ListAssessmentAgents action.

See: agentsFilter smart constructor.

Instances

Eq AgentsFilter

Data AgentsFilter

Read AgentsFilter

Show AgentsFilter

Generic AgentsFilter

ToJSON AgentsFilter

type Rep AgentsFilter

agentsFilter :: AgentsFilter

Creates a value of AgentsFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• afAgentHealthList

afAgentHealthList :: Lens' AgentsFilter [Text]

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the agentHealth property of the Agent data type.

Application

data Application

Contains information about an Inspector application.

This data type is used as the response element in the DescribeApplication action.

See: application smart constructor.

Instances

Eq Application

Data Application

Read Application

Show Application

Generic Application

FromJSON Application

type Rep Application

application :: Application

Creates a value of Application with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aApplicationARN
• aResourceGroupARN
• aApplicationName

aApplicationARN :: Lens' Application (Maybe Text)

The ARN specifying the Inspector application.

aResourceGroupARN :: Lens' Application (Maybe Text)

The ARN specifying the resource group that is associated with the application.

aApplicationName :: Lens' Application (Maybe Text)

The name of the Inspector application.

ApplicationsFilter

data ApplicationsFilter

This data type is used as the request parameter in the ListApplications action.

See: applicationsFilter smart constructor.

Instances

Eq ApplicationsFilter

Data ApplicationsFilter

Read ApplicationsFilter

Show ApplicationsFilter

Generic ApplicationsFilter

ToJSON ApplicationsFilter

type Rep ApplicationsFilter

applicationsFilter :: ApplicationsFilter

Creates a value of ApplicationsFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• afApplicationNamePatterns

afApplicationNamePatterns :: Lens' ApplicationsFilter [Text]

For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the applicationName property of the Application data type.

Assessment

data Assessment

Contains information about an Inspector assessment.

This data type is used as the response element in the DescribeAssessment action.

See: assessment smart constructor.

Instances

Eq Assessment

Data Assessment

Read Assessment

Show Assessment

Generic Assessment

FromJSON Assessment

type Rep Assessment

assessment :: Assessment

Creates a value of Assessment with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• assDataCollected
• assApplicationARN
• assStartTime
• assAssessmentARN
• assUserAttributesForFindings
• assFailureMessage
• assAssessmentState
• assEndTime
• assDurationInSeconds
• assAssessmentName

assDataCollected :: Lens' Assessment (Maybe Bool)

Boolean value (true or false) specifying whether the data collection process is completed.

assApplicationARN :: Lens' Assessment (Maybe Text)

The ARN of the application that corresponds to this assessment.

assStartTime :: Lens' Assessment (Maybe UTCTime)

The assessment start time.

assAssessmentARN :: Lens' Assessment (Maybe Text)

The ARN of the assessment.

assUserAttributesForFindings :: Lens' Assessment [Attribute]

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

assFailureMessage :: Lens' Assessment (Maybe Text)

This data type property is not currently used.

assAssessmentState :: Lens' Assessment (Maybe Text)

The state of the assessment. Values can be set to Created, /Collecting Data, Stopping, and Completed/.

assEndTime :: Lens' Assessment (Maybe UTCTime)

The assessment end time.

assDurationInSeconds :: Lens' Assessment (Maybe Int)

The assessment duration in seconds. The default value is 3600 seconds (one hour). The maximum value is 86400 seconds (one day).

assAssessmentName :: Lens' Assessment (Maybe Text)

The name of the assessment.

AssessmentsFilter

data AssessmentsFilter

This data type is used as the request parameter in the ListAssessments and ListAttachedAssessments actions.

See: assessmentsFilter smart constructor.

Instances

Eq AssessmentsFilter

Data AssessmentsFilter

Read AssessmentsFilter

Show AssessmentsFilter

Generic AssessmentsFilter

ToJSON AssessmentsFilter

type Rep AssessmentsFilter

assessmentsFilter :: AssessmentsFilter

Creates a value of AssessmentsFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• afDataCollected
• afAssessmentStates
• afStartTimeRange
• afAssessmentNamePatterns
• afEndTimeRange
• afDurationRange

afDataCollected :: Lens' AssessmentsFilter (Maybe Bool)

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the dataCollected property of the Assessment data type.

afAssessmentStates :: Lens' AssessmentsFilter [Text]

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the assessmentState property of the Assessment data type.

afStartTimeRange :: Lens' AssessmentsFilter (Maybe TimestampRange)

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the startTime property of the Assessment data type.

afAssessmentNamePatterns :: Lens' AssessmentsFilter [Text]

For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the assessmentName property of the Assessment data type.

afEndTimeRange :: Lens' AssessmentsFilter (Maybe TimestampRange)

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the endTime property of the Assessment data type.

afDurationRange :: Lens' AssessmentsFilter (Maybe DurationRange)

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the durationInSeconds property of the Assessment data type.

Attribute

data Attribute

This data type is used as a response element in the AddAttributesToFindings action and a request parameter in the CreateAssessment action.

See: attribute smart constructor.

Instances

Eq Attribute

Data Attribute

Read Attribute

Show Attribute

Generic Attribute

ToJSON Attribute

FromJSON Attribute

type Rep Attribute

attribute :: Attribute

Creates a value of Attribute with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• aValue
• aKey

aValue :: Lens' Attribute (Maybe Text)

The value assigned to the attribute key.

aKey :: Lens' Attribute (Maybe Text)

The attribute key.

DurationRange

data DurationRange

This data type is used in the AssessmentsFilter data type.

See: durationRange smart constructor.

Instances

Eq DurationRange

Data DurationRange

Read DurationRange

Show DurationRange

Generic DurationRange

ToJSON DurationRange

type Rep DurationRange

durationRange :: DurationRange

Creates a value of DurationRange with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• drMaximum
• drMinimum

drMaximum :: Lens' DurationRange (Maybe Int)

The maximum value of the duration range. Must be less than or equal to 604800 seconds (1 week).

drMinimum :: Lens' DurationRange (Maybe Int)

The minimum value of the duration range. Must be greater than zero.

Finding

data Finding

Contains information about an Inspector finding.

This data type is used as the response element in the DescribeFinding action.

See: finding smart constructor.

Instances

Eq Finding

Data Finding

Read Finding

Show Finding

Generic Finding

FromJSON Finding

type Rep Finding

finding :: Finding

Creates a value of Finding with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• fAutoScalingGroup
• fFinding
• fSeverity
• fUserAttributes
• fRuleName
• fAgentId
• fRunARN
• fAttributes
• fRulesPackageARN
• fFindingARN
• fDescription
• fRecommendation

fAutoScalingGroup :: Lens' Finding (Maybe Text)

The autoscaling group of the EC2 instance where the agent is installed that is used during the assessment that generates the finding.

fFinding :: Lens' Finding (Maybe LocalizedText)

A short description that identifies the finding.

fSeverity :: Lens' Finding (Maybe Text)

The finding severity. Values can be set to High, Medium, Low, and Informational.

fUserAttributes :: Lens' Finding [Attribute]

The user-defined attributes that are assigned to the finding.

fRuleName :: Lens' Finding (Maybe Text)

The rule name that is used to generate the finding.

fAgentId :: Lens' Finding (Maybe Text)

The EC2 instance ID where the agent is installed that is used during the assessment that generates the finding.

fRunARN :: Lens' Finding (Maybe Text)

The ARN of the assessment run that generated the finding.

fAttributes :: Lens' Finding [Attribute]

The system-defined attributes for the finding.

fRulesPackageARN :: Lens' Finding (Maybe Text)

The ARN of the rules package that is used to generate the finding.

fFindingARN :: Lens' Finding (Maybe Text)

The ARN specifying the finding.

fDescription :: Lens' Finding (Maybe LocalizedText)

The description of the finding.

fRecommendation :: Lens' Finding (Maybe LocalizedText)

The recommendation for the finding.

FindingsFilter

data FindingsFilter

This data type is used as a request parameter in the ListFindings action.

See: findingsFilter smart constructor.

Instances

Eq FindingsFilter

Data FindingsFilter

Read FindingsFilter

Show FindingsFilter

Generic FindingsFilter

ToJSON FindingsFilter

type Rep FindingsFilter

findingsFilter :: FindingsFilter

Creates a value of FindingsFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ffRuleNames
• ffUserAttributes
• ffRulesPackageARNs
• ffAttributes
• ffSeverities

ffRuleNames :: Lens' FindingsFilter [Text]

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the ruleName property of the Finding data type.

ffUserAttributes :: Lens' FindingsFilter [Attribute]

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the userAttributes property of the Finding data type.

ffRulesPackageARNs :: Lens' FindingsFilter [Text]

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the rulesPackageArn property of the Finding data type.

ffAttributes :: Lens' FindingsFilter [Attribute]

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the attributes property of the Finding data type.

ffSeverities :: Lens' FindingsFilter [Text]

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the severity property of the Finding data type.

LocalizedText

data LocalizedText

The textual identifier. This data type is used as the request parameter in the LocalizeText action.

See: localizedText smart constructor.

Instances

Eq LocalizedText

Data LocalizedText

Read LocalizedText

Show LocalizedText

Generic LocalizedText

ToJSON LocalizedText

FromJSON LocalizedText

type Rep LocalizedText

localizedText :: LocalizedText

Creates a value of LocalizedText with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ltKey
• ltParameters

ltKey :: Lens' LocalizedText (Maybe LocalizedTextKey)

The facility and id properties of the LocalizedTextKey data type.

ltParameters :: Lens' LocalizedText [Parameter]

Values for the dynamic elements of the string specified by the textual identifier.

LocalizedTextKey

data LocalizedTextKey

This data type is used in the LocalizedText data type.

See: localizedTextKey smart constructor.

Instances

Eq LocalizedTextKey

Data LocalizedTextKey

Read LocalizedTextKey

Show LocalizedTextKey

Generic LocalizedTextKey

ToJSON LocalizedTextKey

FromJSON LocalizedTextKey

type Rep LocalizedTextKey

localizedTextKey :: LocalizedTextKey

Creates a value of LocalizedTextKey with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• ltkFacility
• ltkId

ltkFacility :: Lens' LocalizedTextKey (Maybe Text)

The module response source of the text.

ltkId :: Lens' LocalizedTextKey (Maybe Text)

Part of the module response source of the text.

MessageTypeTelemetry

data MessageTypeTelemetry

This data type is used in the Telemetry data type.

This is metadata about the behavioral data collected by the Inspector agent on your EC2 instances during an assessment and passed to the Inspector service for analysis.

See: messageTypeTelemetry smart constructor.

Instances

Eq MessageTypeTelemetry

Data MessageTypeTelemetry

Read MessageTypeTelemetry

Show MessageTypeTelemetry

Generic MessageTypeTelemetry

FromJSON MessageTypeTelemetry

type Rep MessageTypeTelemetry

messageTypeTelemetry :: MessageTypeTelemetry

Creates a value of MessageTypeTelemetry with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• mttDataSize
• mttMessageType
• mttCount

mttDataSize :: Lens' MessageTypeTelemetry (Maybe Integer)

The total size of the behavioral data that is collected by the agent during an assessment.

mttMessageType :: Lens' MessageTypeTelemetry (Maybe Text)

A specific type of behavioral data that is collected by the agent.

mttCount :: Lens' MessageTypeTelemetry (Maybe Integer)

The number of times that the behavioral data is collected by the agent during an assessment.

Parameter

data Parameter

This data type is used in the LocalizedText data type.

See: parameter smart constructor.

Instances

Eq Parameter

Data Parameter

Read Parameter

Show Parameter

Generic Parameter

ToJSON Parameter

FromJSON Parameter

type Rep Parameter

parameter :: Parameter

Creates a value of Parameter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• pValue
• pName

pValue :: Lens' Parameter (Maybe Text)

The value assigned to the variable that is being replaced.

pName :: Lens' Parameter (Maybe Text)

The name of the variable that is being replaced.

ResourceGroup

data ResourceGroup

Contains information about a resource group. The resource group defines a set of tags that, when queried, identify the AWS resources that comprise the application.

This data type is used as the response element in the DescribeResourceGroup action.

See: resourceGroup smart constructor.

Instances

Eq ResourceGroup

Data ResourceGroup

Read ResourceGroup

Show ResourceGroup

Generic ResourceGroup

FromJSON ResourceGroup

type Rep ResourceGroup

resourceGroup :: ResourceGroup

Creates a value of ResourceGroup with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rgResourceGroupTags
• rgResourceGroupARN

rgResourceGroupTags :: Lens' ResourceGroup (Maybe Text)

The tags (key and value pairs) of the resource group.

This data type property is used in the CreateResourceGroup action.

A collection of keys and an array of possible values in JSON format.

For example, [{ "key1" : ["Value1","Value2"]},{"Key2": ["Value3"]}]

rgResourceGroupARN :: Lens' ResourceGroup (Maybe Text)

The ARN of the resource group.

RulesPackage

data RulesPackage

Contains information about an Inspector rules package.

This data type is used as the response element in the DescribeRulesPackage action.

See: rulesPackage smart constructor.

Instances

Eq RulesPackage

Data RulesPackage

Read RulesPackage

Show RulesPackage

Generic RulesPackage

FromJSON RulesPackage

type Rep RulesPackage

rulesPackage :: RulesPackage

Creates a value of RulesPackage with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rpVersion
• rpRulesPackageARN
• rpRulesPackageName
• rpDescription
• rpProvider

rpVersion :: Lens' RulesPackage (Maybe Text)

The version id of the rules package.

rpRulesPackageARN :: Lens' RulesPackage (Maybe Text)

The ARN of the rules package.

rpRulesPackageName :: Lens' RulesPackage (Maybe Text)

The name of the rules package.

rpDescription :: Lens' RulesPackage (Maybe LocalizedText)

The description of the rules package.

rpProvider :: Lens' RulesPackage (Maybe Text)

The provider of the rules package.

Run

data Run

A snapshot of an Inspector assessment that contains the assessment's findings.

This data type is used as the response element in the DescribeRun action.

See: run smart constructor.

Instances

Eq Run

Data Run

Read Run

Show Run

Generic Run

FromJSON Run

type Rep Run

run :: Run

Creates a value of Run with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• runCreationTime
• runRulesPackages
• runAssessmentARN
• runRunState
• runRunName
• runCompletionTime
• runRunARN

runCreationTime :: Lens' Run (Maybe UTCTime)

Run creation time that corresponds to the data collection completion time or failure.

runRulesPackages :: Lens' Run [Text]

Rules packages selected for the run of the assessment.

runAssessmentARN :: Lens' Run (Maybe Text)

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

runRunState :: Lens' Run (Maybe Text)

The state of the run. Values can be set to DataCollectionComplete, EvaluatingPolicies, EvaluatingPoliciesErrorCanRetry, Completed, Failed, TombStoned.

runRunName :: Lens' Run (Maybe Text)

The auto-generated name for the run.

runCompletionTime :: Lens' Run (Maybe UTCTime)

Run completion time that corresponds to the rules packages evaluation completion time or failure.

runRunARN :: Lens' Run (Maybe Text)

The ARN of the run.

RunsFilter

data RunsFilter

This data type is used as the request parameter in the ListRuns action.

See: runsFilter smart constructor.

Instances

Eq RunsFilter

Data RunsFilter

Read RunsFilter

Show RunsFilter

Generic RunsFilter

ToJSON RunsFilter

type Rep RunsFilter

runsFilter :: RunsFilter

Creates a value of RunsFilter with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• rfCreationTime
• rfRulesPackages
• rfRunStates
• rfRunNamePatterns
• rfCompletionTime

rfCreationTime :: Lens' RunsFilter (Maybe TimestampRange)

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the creationTime property of the Run data type.

rfRulesPackages :: Lens' RunsFilter [Text]

For a record to match a filter, the value specified for this data type property must match a list of values of the rulesPackages property of the Run data type.

rfRunStates :: Lens' RunsFilter [Text]

For a record to match a filter, the value specified for this data type property must be the exact match of the value of the runState property of the Run data type.

rfRunNamePatterns :: Lens' RunsFilter [Text]

For a record to match a filter, an explicit value or a string containing a wildcard specified for this data type property must match the value of the runName property of the Run data type.

rfCompletionTime :: Lens' RunsFilter (Maybe TimestampRange)

For a record to match a filter, the value specified for this data type property must inclusively match any value between the specified minimum and maximum values of the completionTime property of the Run data type.

Tag

data Tag

A key and value pair.

This data type is used as a request parameter in the SetTagsForResource action and a response element in the ListTagsForResource action.

See: tag smart constructor.

Instances

Eq Tag

Data Tag

Read Tag

Show Tag

Generic Tag

ToJSON Tag

FromJSON Tag

type Rep Tag

tag :: Tag

Creates a value of Tag with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tagValue
• tagKey

tagValue :: Lens' Tag (Maybe Text)

The value assigned to a tag key.

tagKey :: Lens' Tag (Maybe Text)

The tag key.

Telemetry

data Telemetry

The metadata about the Inspector application data metrics collected by the agent.

This data type is used as the response element in the GetAssessmentTelemetry action.

See: telemetry smart constructor.

Instances

Eq Telemetry

Data Telemetry

Read Telemetry

Show Telemetry

Generic Telemetry

FromJSON Telemetry

type Rep Telemetry

telemetry :: Telemetry

Creates a value of Telemetry with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• tStatus
• tMessageTypeTelemetries

tStatus :: Lens' Telemetry (Maybe Text)

The category of the individual metrics that together constitute the telemetry that Inspector received from the agent.

tMessageTypeTelemetries :: Lens' Telemetry [MessageTypeTelemetry]

Counts of individual metrics received by Inspector from the agent.

TimestampRange

data TimestampRange

This data type is used in the AssessmentsFilter and RunsFilter data types.

See: timestampRange smart constructor.

Instances

Eq TimestampRange

Data TimestampRange

Read TimestampRange

Show TimestampRange

Generic TimestampRange

ToJSON TimestampRange

type Rep TimestampRange

timestampRange :: TimestampRange

Creates a value of TimestampRange with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• trMaximum
• trMinimum

trMaximum :: Lens' TimestampRange (Maybe UTCTime)

The maximum value of the timestamp range.

trMinimum :: Lens' TimestampRange (Maybe UTCTime)

The minimum value of the timestamp range.