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

Amazonka.IoT.ListViolationEvents

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

Creating a Request

data ListViolationEvents Source #

See: newListViolationEvents smart constructor.

Constructors

ListViolationEvents' 

Fields

Instances

Instances details
Eq ListViolationEvents Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

Read ListViolationEvents Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

Show ListViolationEvents Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

Generic ListViolationEvents Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

Associated Types

type Rep ListViolationEvents :: Type -> Type #

NFData ListViolationEvents Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

Methods

rnf :: ListViolationEvents -> () #

Hashable ListViolationEvents Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

AWSPager ListViolationEvents Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

AWSRequest ListViolationEvents Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

Associated Types

type AWSResponse ListViolationEvents #

ToHeaders ListViolationEvents Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

ToPath ListViolationEvents Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

ToQuery ListViolationEvents Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

type Rep ListViolationEvents Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

type AWSResponse ListViolationEvents Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

newListViolationEvents Source #

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

Read ListViolationEventsResponse Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

Show ListViolationEventsResponse Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

Generic ListViolationEventsResponse Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

Associated Types

type Rep ListViolationEventsResponse :: Type -> Type #

NFData ListViolationEventsResponse Source # 
Instance details

Defined in Amazonka.IoT.ListViolationEvents

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 #

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.