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.IoT.ListViolationEvents

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the Device Defender security profile violations discovered during the given time period. You can use filters to limit the results to those alerts issued for a particular security profile, behavior, or thing (device).

Requires permission to access the ListViolationEvents action.

This operation returns paginated results.

Synopsis

data ListViolationEvents = ListViolationEvents' {
- nextToken :: Maybe Text
- listSuppressedAlerts :: Maybe Bool
- behaviorCriteriaType :: Maybe BehaviorCriteriaType
- securityProfileName :: Maybe Text
- thingName :: Maybe Text
- verificationState :: Maybe VerificationState
- maxResults :: Maybe Natural
- startTime :: POSIX
- endTime :: POSIX
}
newListViolationEvents :: UTCTime -> UTCTime -> ListViolationEvents
listViolationEvents_nextToken :: Lens' ListViolationEvents (Maybe Text)
listViolationEvents_listSuppressedAlerts :: Lens' ListViolationEvents (Maybe Bool)
listViolationEvents_behaviorCriteriaType :: Lens' ListViolationEvents (Maybe BehaviorCriteriaType)
listViolationEvents_securityProfileName :: Lens' ListViolationEvents (Maybe Text)
listViolationEvents_thingName :: Lens' ListViolationEvents (Maybe Text)
listViolationEvents_verificationState :: Lens' ListViolationEvents (Maybe VerificationState)
listViolationEvents_maxResults :: Lens' ListViolationEvents (Maybe Natural)
listViolationEvents_startTime :: Lens' ListViolationEvents UTCTime
listViolationEvents_endTime :: Lens' ListViolationEvents UTCTime
data ListViolationEventsResponse = ListViolationEventsResponse' {
- violationEvents :: Maybe [ViolationEvent]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListViolationEventsResponse :: Int -> ListViolationEventsResponse
listViolationEventsResponse_violationEvents :: Lens' ListViolationEventsResponse (Maybe [ViolationEvent])
listViolationEventsResponse_nextToken :: Lens' ListViolationEventsResponse (Maybe Text)
listViolationEventsResponse_httpStatus :: Lens' ListViolationEventsResponse Int

Creating a Request

data ListViolationEvents Source #

See: newListViolationEvents smart constructor.

Constructors

ListViolationEvents'

Fields

nextToken :: Maybe Text
The token for the next set of results.
listSuppressedAlerts :: Maybe Bool
A list of all suppressed alerts.
behaviorCriteriaType :: Maybe BehaviorCriteriaType
The criteria for a behavior.
securityProfileName :: Maybe Text
A filter to limit results to those alerts generated by the specified security profile.
thingName :: Maybe Text
A filter to limit results to those alerts caused by the specified thing.
verificationState :: Maybe VerificationState
The verification state of the violation (detect alarm).
maxResults :: Maybe Natural
The maximum number of results to return at one time.
startTime :: POSIX
The start time for the alerts to be listed.
endTime :: POSIX
The end time for the alerts to be listed.

Instances

Instances details

Eq ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods (==) :: ListViolationEvents -> ListViolationEvents -> Bool # (/=) :: ListViolationEvents -> ListViolationEvents -> Bool #
Read ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods readsPrec :: Int -> ReadS ListViolationEvents # readList :: ReadS [ListViolationEvents] # readPrec :: ReadPrec ListViolationEvents # readListPrec :: ReadPrec [ListViolationEvents] #
Show ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods showsPrec :: Int -> ListViolationEvents -> ShowS # show :: ListViolationEvents -> String # showList :: [ListViolationEvents] -> ShowS #
Generic ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Associated Types type Rep ListViolationEvents :: Type -> Type # Methods from :: ListViolationEvents -> Rep ListViolationEvents x # to :: Rep ListViolationEvents x -> ListViolationEvents #
NFData ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods rnf :: ListViolationEvents -> () #
Hashable ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods hashWithSalt :: Int -> ListViolationEvents -> Int # hash :: ListViolationEvents -> Int #
AWSPager ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods page :: ListViolationEvents -> AWSResponse ListViolationEvents -> Maybe ListViolationEvents #
AWSRequest ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Associated Types type AWSResponse ListViolationEvents # Methods request :: ListViolationEvents -> Request ListViolationEvents # response :: MonadResource m => Logger -> Service -> Proxy ListViolationEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListViolationEvents))) #
ToHeaders ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods toHeaders :: ListViolationEvents -> [Header] #
ToPath ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods toPath :: ListViolationEvents -> ByteString #
ToQuery ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods toQuery :: ListViolationEvents -> QueryString #
type Rep ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents type Rep ListViolationEvents = D1 ('MetaData "ListViolationEvents" "Amazonka.IoT.ListViolationEvents" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "ListViolationEvents'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "listSuppressedAlerts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "behaviorCriteriaType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BehaviorCriteriaType)) :: S1 ('MetaSel ('Just "securityProfileName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((S1 ('MetaSel ('Just "thingName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "verificationState") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe VerificationState))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: (S1 ('MetaSel ('Just "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))
type AWSResponse ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents type AWSResponse ListViolationEvents = ListViolationEventsResponse

newListViolationEvents Source #

Arguments

:: UTCTime	`$sel:startTime:ListViolationEvents'`
-> UTCTime	`$sel:endTime:ListViolationEvents'`
-> ListViolationEvents

Create a value of ListViolationEvents 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:nextToken:ListViolationEvents', listViolationEvents_nextToken - The token for the next set of results.

$sel:listSuppressedAlerts:ListViolationEvents', listViolationEvents_listSuppressedAlerts - A list of all suppressed alerts.

$sel:behaviorCriteriaType:ListViolationEvents', listViolationEvents_behaviorCriteriaType - The criteria for a behavior.

$sel:securityProfileName:ListViolationEvents', listViolationEvents_securityProfileName - A filter to limit results to those alerts generated by the specified security profile.

$sel:thingName:ListViolationEvents', listViolationEvents_thingName - A filter to limit results to those alerts caused by the specified thing.

$sel:verificationState:ListViolationEvents', listViolationEvents_verificationState - The verification state of the violation (detect alarm).

$sel:maxResults:ListViolationEvents', listViolationEvents_maxResults - The maximum number of results to return at one time.

$sel:startTime:ListViolationEvents', listViolationEvents_startTime - The start time for the alerts to be listed.

$sel:endTime:ListViolationEvents', listViolationEvents_endTime - The end time for the alerts to be listed.

Request Lenses

listViolationEvents_nextToken :: Lens' ListViolationEvents (Maybe Text) Source #

The token for the next set of results.

listViolationEvents_listSuppressedAlerts :: Lens' ListViolationEvents (Maybe Bool) Source #

A list of all suppressed alerts.

listViolationEvents_behaviorCriteriaType :: Lens' ListViolationEvents (Maybe BehaviorCriteriaType) Source #

The criteria for a behavior.

listViolationEvents_securityProfileName :: Lens' ListViolationEvents (Maybe Text) Source #

A filter to limit results to those alerts generated by the specified security profile.

listViolationEvents_thingName :: Lens' ListViolationEvents (Maybe Text) Source #

A filter to limit results to those alerts caused by the specified thing.

listViolationEvents_verificationState :: Lens' ListViolationEvents (Maybe VerificationState) Source #

The verification state of the violation (detect alarm).

listViolationEvents_maxResults :: Lens' ListViolationEvents (Maybe Natural) Source #

The maximum number of results to return at one time.

listViolationEvents_startTime :: Lens' ListViolationEvents UTCTime Source #

The start time for the alerts to be listed.

listViolationEvents_endTime :: Lens' ListViolationEvents UTCTime Source #

The end time for the alerts to be listed.

Destructuring the Response

data ListViolationEventsResponse Source #

See: newListViolationEventsResponse smart constructor.

Constructors

ListViolationEventsResponse'

Fields

violationEvents :: Maybe [ViolationEvent]
The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device) violating.
nextToken :: Maybe Text
A token that can be used to retrieve the next set of results, or null if there are no additional results.
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq ListViolationEventsResponse Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods (==) :: ListViolationEventsResponse -> ListViolationEventsResponse -> Bool # (/=) :: ListViolationEventsResponse -> ListViolationEventsResponse -> Bool #
Read ListViolationEventsResponse Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods readsPrec :: Int -> ReadS ListViolationEventsResponse # readList :: ReadS [ListViolationEventsResponse] # readPrec :: ReadPrec ListViolationEventsResponse # readListPrec :: ReadPrec [ListViolationEventsResponse] #
Show ListViolationEventsResponse Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods showsPrec :: Int -> ListViolationEventsResponse -> ShowS # show :: ListViolationEventsResponse -> String # showList :: [ListViolationEventsResponse] -> ShowS #
Generic ListViolationEventsResponse Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Associated Types type Rep ListViolationEventsResponse :: Type -> Type # Methods from :: ListViolationEventsResponse -> Rep ListViolationEventsResponse x # to :: Rep ListViolationEventsResponse x -> ListViolationEventsResponse #
NFData ListViolationEventsResponse Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods rnf :: ListViolationEventsResponse -> () #
type Rep ListViolationEventsResponse Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents type Rep ListViolationEventsResponse = D1 ('MetaData "ListViolationEventsResponse" "Amazonka.IoT.ListViolationEvents" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "ListViolationEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "violationEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ViolationEvent])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListViolationEventsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListViolationEventsResponse'`
-> ListViolationEventsResponse

Create a value of ListViolationEventsResponse 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:violationEvents:ListViolationEventsResponse', listViolationEventsResponse_violationEvents - The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device) violating.

$sel:nextToken:ListViolationEvents', listViolationEventsResponse_nextToken - A token that can be used to retrieve the next set of results, or null if there are no additional results.

$sel:httpStatus:ListViolationEventsResponse', listViolationEventsResponse_httpStatus - The response's http status code.

Response Lenses

listViolationEventsResponse_violationEvents :: Lens' ListViolationEventsResponse (Maybe [ViolationEvent]) Source #

The security profile violation alerts issued for this account during the given time period, potentially filtered by security profile, behavior violated, or thing (device) violating.

listViolationEventsResponse_nextToken :: Lens' ListViolationEventsResponse (Maybe Text) Source #

A token that can be used to retrieve the next set of results, or null if there are no additional results.

listViolationEventsResponse_httpStatus :: Lens' ListViolationEventsResponse Int Source #

The response's http status code.