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.ListActiveViolations

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the active violations for a given Device Defender security profile.

Requires permission to access the ListActiveViolations action.

This operation returns paginated results.

Synopsis

Creating a Request

data ListActiveViolations Source #

See: newListActiveViolations smart constructor.

Constructors

ListActiveViolations'

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
The name of the Device Defender security profile for which violations are listed.
thingName :: Maybe Text
The name of the thing whose active violations are listed.
verificationState :: Maybe VerificationState
The verification state of the violation (detect alarm).

Instances

Instances details

ToHeaders ListActiveViolations Source #
Instance details Defined in Amazonka.IoT.ListActiveViolations Methods toHeaders :: ListActiveViolations -> [Header] #
ToPath ListActiveViolations Source #
Instance details Defined in Amazonka.IoT.ListActiveViolations Methods toPath :: ListActiveViolations -> ByteString #
ToQuery ListActiveViolations Source #
Instance details Defined in Amazonka.IoT.ListActiveViolations Methods toQuery :: ListActiveViolations -> QueryString #
AWSPager ListActiveViolations Source #
Instance details Defined in Amazonka.IoT.ListActiveViolations Methods page :: ListActiveViolations -> AWSResponse ListActiveViolations -> Maybe ListActiveViolations #
AWSRequest ListActiveViolations Source #
Instance details Defined in Amazonka.IoT.ListActiveViolations Associated Types type AWSResponse ListActiveViolations # Methods request :: (Service -> Service) -> ListActiveViolations -> Request ListActiveViolations # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListActiveViolations -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListActiveViolations))) #
Generic ListActiveViolations Source #
Instance details Defined in Amazonka.IoT.ListActiveViolations Associated Types type Rep ListActiveViolations :: Type -> Type # Methods from :: ListActiveViolations -> Rep ListActiveViolations x # to :: Rep ListActiveViolations x -> ListActiveViolations #
Read ListActiveViolations Source #
Instance details Defined in Amazonka.IoT.ListActiveViolations Methods readsPrec :: Int -> ReadS ListActiveViolations # readList :: ReadS [ListActiveViolations] # readPrec :: ReadPrec ListActiveViolations # readListPrec :: ReadPrec [ListActiveViolations] #
Show ListActiveViolations Source #
Instance details Defined in Amazonka.IoT.ListActiveViolations Methods showsPrec :: Int -> ListActiveViolations -> ShowS # show :: ListActiveViolations -> String # showList :: [ListActiveViolations] -> ShowS #
NFData ListActiveViolations Source #
Instance details Defined in Amazonka.IoT.ListActiveViolations Methods rnf :: ListActiveViolations -> () #
Eq ListActiveViolations Source #
Instance details Defined in Amazonka.IoT.ListActiveViolations Methods (==) :: ListActiveViolations -> ListActiveViolations -> Bool # (/=) :: ListActiveViolations -> ListActiveViolations -> Bool #
Hashable ListActiveViolations Source #
Instance details Defined in Amazonka.IoT.ListActiveViolations Methods hashWithSalt :: Int -> ListActiveViolations -> Int # hash :: ListActiveViolations -> Int #
type AWSResponse ListActiveViolations Source #
Instance details Defined in Amazonka.IoT.ListActiveViolations type AWSResponse ListActiveViolations = ListActiveViolationsResponse
type Rep ListActiveViolations Source #
Instance details Defined in Amazonka.IoT.ListActiveViolations type Rep ListActiveViolations = D1 ('MetaData "ListActiveViolations" "Amazonka.IoT.ListActiveViolations" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "ListActiveViolations'" '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))))))

newListActiveViolations :: ListActiveViolations Source #

Create a value of ListActiveViolations 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:ListActiveViolations', listActiveViolations_behaviorCriteriaType - The criteria for a behavior.

$sel:listSuppressedAlerts:ListActiveViolations', listActiveViolations_listSuppressedAlerts - A list of all suppressed alerts.

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

ListActiveViolations, listActiveViolations_nextToken - The token for the next set of results.

ListActiveViolations, listActiveViolations_securityProfileName - The name of the Device Defender security profile for which violations are listed.

ListActiveViolations, listActiveViolations_thingName - The name of the thing whose active violations are listed.

ListActiveViolations, listActiveViolations_verificationState - The verification state of the violation (detect alarm).

Request Lenses

listActiveViolations_behaviorCriteriaType :: Lens' ListActiveViolations (Maybe BehaviorCriteriaType) Source #

The criteria for a behavior.

listActiveViolations_listSuppressedAlerts :: Lens' ListActiveViolations (Maybe Bool) Source #

A list of all suppressed alerts.

listActiveViolations_maxResults :: Lens' ListActiveViolations (Maybe Natural) Source #

The maximum number of results to return at one time.

listActiveViolations_nextToken :: Lens' ListActiveViolations (Maybe Text) Source #

The token for the next set of results.

listActiveViolations_securityProfileName :: Lens' ListActiveViolations (Maybe Text) Source #

The name of the Device Defender security profile for which violations are listed.

listActiveViolations_thingName :: Lens' ListActiveViolations (Maybe Text) Source #

The name of the thing whose active violations are listed.

listActiveViolations_verificationState :: Lens' ListActiveViolations (Maybe VerificationState) Source #

The verification state of the violation (detect alarm).

Destructuring the Response

data ListActiveViolationsResponse Source #

See: newListActiveViolationsResponse smart constructor.

Constructors

ListActiveViolationsResponse'
Fields activeViolations :: Maybe [ActiveViolation] The list of active violations. 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

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

newListActiveViolationsResponse Source #

Arguments

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

Create a value of ListActiveViolationsResponse 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:activeViolations:ListActiveViolationsResponse', listActiveViolationsResponse_activeViolations - The list of active violations.

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

$sel:httpStatus:ListActiveViolationsResponse', listActiveViolationsResponse_httpStatus - The response's http status code.

Response Lenses

listActiveViolationsResponse_activeViolations :: Lens' ListActiveViolationsResponse (Maybe [ActiveViolation]) Source #

The list of active violations.

listActiveViolationsResponse_nextToken :: Lens' ListActiveViolationsResponse (Maybe Text) Source #

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

listActiveViolationsResponse_httpStatus :: Lens' ListActiveViolationsResponse Int Source #

The response's http status code.