Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

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

Creating a Request

data ListViolationEvents Source #

See: newListViolationEvents smart constructor.

Constructors

ListViolationEvents'

Fields

behaviorCriteriaType :: Maybe BehaviorCriteriaType
The criteria for a behavior.
listSuppressedAlerts :: Maybe Bool
A list of all suppressed alerts.
maxResults :: Maybe Natural
The maximum number of results to return at one time.
nextToken :: Maybe Text
The token for the next set of results.
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).
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

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 #
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 :: (Service -> Service) -> ListViolationEvents -> Request ListViolationEvents # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListViolationEvents -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListViolationEvents))) #
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 #
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 #
NFData ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods rnf :: ListViolationEvents -> () #
Eq ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods (==) :: ListViolationEvents -> ListViolationEvents -> Bool # (/=) :: ListViolationEvents -> ListViolationEvents -> Bool #
Hashable ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods hashWithSalt :: Int -> ListViolationEvents -> Int # hash :: ListViolationEvents -> Int #
type AWSResponse ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents type AWSResponse ListViolationEvents = ListViolationEventsResponse
type Rep ListViolationEvents Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents type Rep ListViolationEvents = D1 ('MetaData "ListViolationEvents" "Amazonka.IoT.ListViolationEvents" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListViolationEvents'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "behaviorCriteriaType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe BehaviorCriteriaType)) :: S1 ('MetaSel ('Just "listSuppressedAlerts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool))) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: ((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 "startTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "endTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))))

newListViolationEvents Source #

Arguments

:: UTCTime	`ListViolationEvents`
-> UTCTime	`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:behaviorCriteriaType:ListViolationEvents', listViolationEvents_behaviorCriteriaType - The criteria for a behavior.

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

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

ListViolationEvents, listViolationEvents_nextToken - The token for the next set of results.

ListViolationEvents, listViolationEvents_securityProfileName - A filter to limit results to those alerts generated by the specified security profile.

ListViolationEvents, listViolationEvents_thingName - A filter to limit results to those alerts caused by the specified thing.

ListViolationEvents, listViolationEvents_verificationState - The verification state of the violation (detect alarm).

ListViolationEvents, listViolationEvents_startTime - The start time for the alerts to be listed.

ListViolationEvents, listViolationEvents_endTime - The end time for the alerts to be listed.

Request Lenses

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

The criteria for a behavior.

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

A list of all suppressed alerts.

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

The maximum number of results to return at one time.

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

The token for the next set of results.

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_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

nextToken :: Maybe Text
A token that can be used to retrieve the next set of results, or null if there are no additional results.
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.
httpStatus :: Int
The response's http status code.

Instances

Instances details

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 #
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 #
NFData ListViolationEventsResponse Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods rnf :: ListViolationEventsResponse -> () #
Eq ListViolationEventsResponse Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents Methods (==) :: ListViolationEventsResponse -> ListViolationEventsResponse -> Bool # (/=) :: ListViolationEventsResponse -> ListViolationEventsResponse -> Bool #
type Rep ListViolationEventsResponse Source #
Instance details Defined in Amazonka.IoT.ListViolationEvents type Rep ListViolationEventsResponse = D1 ('MetaData "ListViolationEventsResponse" "Amazonka.IoT.ListViolationEvents" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListViolationEventsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "violationEvents") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ViolationEvent])) :: 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:

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: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:httpStatus:ListViolationEventsResponse', listViolationEventsResponse_httpStatus - The response's http status code.

Response Lenses

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_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_httpStatus :: Lens' ListViolationEventsResponse Int Source #

The response's http status code.