amazonka-inspector-1.3.6: Amazon Inspector SDK.

Copyright(c) 2013-2015 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone
LanguageHaskell2010

Network.AWS.Inspector.Types

Contents

Description

 

Synopsis

Service Configuration

inspector :: Service Source

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

Errors

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

Prism for AccessDeniedException' errors.

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

Prism for NoSuchEntityException' errors.

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

Prism for OperationInProgressException' errors.

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

Prism for InvalidCrossAccountRoleException' errors.

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

Prism for InvalidInputException' errors.

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

Prism for InternalException' errors.

Agent

data Agent Source

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

See: agent smart constructor.

agent :: Agent Source

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 :: Lens' Agent [Telemetry] Source

The Inspector application data metrics collected by the agent.

aAutoScalingGroup :: Lens' Agent (Maybe Text) Source

This data type property is currently not used.

aAgentHealthCode :: Lens' Agent (Maybe Text) Source

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

aAssessmentARN :: Lens' Agent (Maybe Text) Source

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

aAgentId :: Lens' Agent (Maybe Text) Source

The EC2 instance ID where the agent is installed.

aAccountId :: Lens' Agent (Maybe Text) Source

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

aAgentHealthDetails :: Lens' Agent (Maybe Text) Source

The description for the agent health code.

aAgentHealth :: Lens' Agent (Maybe Text) Source

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

AgentPreview

data AgentPreview Source

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

See: agentPreview smart constructor.

agentPreview :: AgentPreview Source

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 :: Lens' AgentPreview (Maybe Text) Source

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

apAgentId :: Lens' AgentPreview (Maybe Text) Source

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

AgentsFilter

data AgentsFilter Source

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

See: agentsFilter smart constructor.

agentsFilter :: AgentsFilter Source

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 :: Lens' AgentsFilter [Text] Source

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 Source

Contains information about an Inspector application.

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

See: application smart constructor.

application :: Application Source

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 :: Lens' Application (Maybe Text) Source

The ARN specifying the Inspector application.

aResourceGroupARN :: Lens' Application (Maybe Text) Source

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

aApplicationName :: Lens' Application (Maybe Text) Source

The name of the Inspector application.

ApplicationsFilter

applicationsFilter :: ApplicationsFilter Source

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 :: Lens' ApplicationsFilter [Text] Source

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 Source

Contains information about an Inspector assessment.

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

See: assessment smart constructor.

assessment :: Assessment Source

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 :: Lens' Assessment (Maybe Bool) Source

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

assApplicationARN :: Lens' Assessment (Maybe Text) Source

The ARN of the application that corresponds to this assessment.

assStartTime :: Lens' Assessment (Maybe UTCTime) Source

The assessment start time.

assAssessmentARN :: Lens' Assessment (Maybe Text) Source

The ARN of the assessment.

assUserAttributesForFindings :: Lens' Assessment [Attribute] Source

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

assFailureMessage :: Lens' Assessment (Maybe Text) Source

This data type property is not currently used.

assAssessmentState :: Lens' Assessment (Maybe Text) Source

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

assEndTime :: Lens' Assessment (Maybe UTCTime) Source

The assessment end time.

assDurationInSeconds :: Lens' Assessment (Maybe Int) Source

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) Source

The name of the assessment.

AssessmentsFilter

data AssessmentsFilter Source

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

See: assessmentsFilter smart constructor.

assessmentsFilter :: AssessmentsFilter Source

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 :: Lens' AssessmentsFilter (Maybe Bool) Source

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] Source

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) Source

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] Source

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) Source

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) Source

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 Source

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.

attribute :: Attribute Source

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 :: Lens' Attribute (Maybe Text) Source

The value assigned to the attribute key.

aKey :: Lens' Attribute (Maybe Text) Source

The attribute key.

DurationRange

data DurationRange Source

This data type is used in the AssessmentsFilter data type.

See: durationRange smart constructor.

durationRange :: DurationRange Source

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 :: Lens' DurationRange (Maybe Int) Source

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

drMinimum :: Lens' DurationRange (Maybe Int) Source

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

Finding

data Finding Source

Contains information about an Inspector finding.

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

See: finding smart constructor.

finding :: Finding Source

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 :: Lens' Finding (Maybe Text) Source

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) Source

A short description that identifies the finding.

fSeverity :: Lens' Finding (Maybe Text) Source

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

fUserAttributes :: Lens' Finding [Attribute] Source

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

fRuleName :: Lens' Finding (Maybe Text) Source

The rule name that is used to generate the finding.

fAgentId :: Lens' Finding (Maybe Text) Source

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

fRunARN :: Lens' Finding (Maybe Text) Source

The ARN of the assessment run that generated the finding.

fAttributes :: Lens' Finding [Attribute] Source

The system-defined attributes for the finding.

fRulesPackageARN :: Lens' Finding (Maybe Text) Source

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

fFindingARN :: Lens' Finding (Maybe Text) Source

The ARN specifying the finding.

fDescription :: Lens' Finding (Maybe LocalizedText) Source

The description of the finding.

fRecommendation :: Lens' Finding (Maybe LocalizedText) Source

The recommendation for the finding.

FindingsFilter

data FindingsFilter Source

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

See: findingsFilter smart constructor.

findingsFilter :: FindingsFilter Source

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 :: Lens' FindingsFilter [Text] Source

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] Source

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] Source

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] Source

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] Source

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 Source

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

See: localizedText smart constructor.

localizedText :: LocalizedText Source

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 :: Lens' LocalizedText (Maybe LocalizedTextKey) Source

The facility and id properties of the LocalizedTextKey data type.

ltParameters :: Lens' LocalizedText [Parameter] Source

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

LocalizedTextKey

localizedTextKey :: LocalizedTextKey Source

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 :: Lens' LocalizedTextKey (Maybe Text) Source

The module response source of the text.

ltkId :: Lens' LocalizedTextKey (Maybe Text) Source

Part of the module response source of the text.

MessageTypeTelemetry

data MessageTypeTelemetry Source

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.

messageTypeTelemetry :: MessageTypeTelemetry Source

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 :: Lens' MessageTypeTelemetry (Maybe Integer) Source

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

mttMessageType :: Lens' MessageTypeTelemetry (Maybe Text) Source

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

mttCount :: Lens' MessageTypeTelemetry (Maybe Integer) Source

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

Parameter

data Parameter Source

This data type is used in the LocalizedText data type.

See: parameter smart constructor.

parameter :: Parameter Source

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 :: Lens' Parameter (Maybe Text) Source

The value assigned to the variable that is being replaced.

pName :: Lens' Parameter (Maybe Text) Source

The name of the variable that is being replaced.

ResourceGroup

data ResourceGroup Source

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.

resourceGroup :: ResourceGroup Source

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 :: Lens' ResourceGroup (Maybe Text) Source

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) Source

The ARN of the resource group.

RulesPackage

data RulesPackage Source

Contains information about an Inspector rules package.

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

See: rulesPackage smart constructor.

rulesPackage :: RulesPackage Source

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 :: Lens' RulesPackage (Maybe Text) Source

The version id of the rules package.

rpRulesPackageARN :: Lens' RulesPackage (Maybe Text) Source

The ARN of the rules package.

rpRulesPackageName :: Lens' RulesPackage (Maybe Text) Source

The name of the rules package.

rpDescription :: Lens' RulesPackage (Maybe LocalizedText) Source

The description of the rules package.

rpProvider :: Lens' RulesPackage (Maybe Text) Source

The provider of the rules package.

Run

data Run Source

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.

run :: Run Source

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 :: Lens' Run (Maybe UTCTime) Source

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

runRulesPackages :: Lens' Run [Text] Source

Rules packages selected for the run of the assessment.

runAssessmentARN :: Lens' Run (Maybe Text) Source

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

runRunState :: Lens' Run (Maybe Text) Source

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

runRunName :: Lens' Run (Maybe Text) Source

The auto-generated name for the run.

runCompletionTime :: Lens' Run (Maybe UTCTime) Source

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

runRunARN :: Lens' Run (Maybe Text) Source

The ARN of the run.

RunsFilter

data RunsFilter Source

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

See: runsFilter smart constructor.

runsFilter :: RunsFilter Source

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 :: Lens' RunsFilter (Maybe TimestampRange) Source

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] Source

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] Source

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] Source

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) Source

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 Source

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.

tag :: Tag Source

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 :: Lens' Tag (Maybe Text) Source

The value assigned to a tag key.

tagKey :: Lens' Tag (Maybe Text) Source

The tag key.

Telemetry

data Telemetry Source

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.

telemetry :: Telemetry Source

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 :: Lens' Telemetry (Maybe Text) Source

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

tMessageTypeTelemetries :: Lens' Telemetry [MessageTypeTelemetry] Source

Counts of individual metrics received by Inspector from the agent.

TimestampRange

data TimestampRange Source

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

See: timestampRange smart constructor.

timestampRange :: TimestampRange Source

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 :: Lens' TimestampRange (Maybe UTCTime) Source

The maximum value of the timestamp range.

trMinimum :: Lens' TimestampRange (Maybe UTCTime) Source

The minimum value of the timestamp range.