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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the findings (results) of a Device Defender audit or of the audits performed during a specified time period. (Findings are retained for 90 days.)

Requires permission to access the ListAuditFindings action.

This operation returns paginated results.

Synopsis

data ListAuditFindings = ListAuditFindings' {
- startTime :: Maybe POSIX
- taskId :: Maybe Text
- checkName :: Maybe Text
- listSuppressedFindings :: Maybe Bool
- nextToken :: Maybe Text
- endTime :: Maybe POSIX
- maxResults :: Maybe Natural
- resourceIdentifier :: Maybe ResourceIdentifier
}
newListAuditFindings :: ListAuditFindings
listAuditFindings_startTime :: Lens' ListAuditFindings (Maybe UTCTime)
listAuditFindings_taskId :: Lens' ListAuditFindings (Maybe Text)
listAuditFindings_checkName :: Lens' ListAuditFindings (Maybe Text)
listAuditFindings_listSuppressedFindings :: Lens' ListAuditFindings (Maybe Bool)
listAuditFindings_nextToken :: Lens' ListAuditFindings (Maybe Text)
listAuditFindings_endTime :: Lens' ListAuditFindings (Maybe UTCTime)
listAuditFindings_maxResults :: Lens' ListAuditFindings (Maybe Natural)
listAuditFindings_resourceIdentifier :: Lens' ListAuditFindings (Maybe ResourceIdentifier)
data ListAuditFindingsResponse = ListAuditFindingsResponse' {
- nextToken :: Maybe Text
- findings :: Maybe [AuditFinding]
- httpStatus :: Int
}
newListAuditFindingsResponse :: Int -> ListAuditFindingsResponse
listAuditFindingsResponse_nextToken :: Lens' ListAuditFindingsResponse (Maybe Text)
listAuditFindingsResponse_findings :: Lens' ListAuditFindingsResponse (Maybe [AuditFinding])
listAuditFindingsResponse_httpStatus :: Lens' ListAuditFindingsResponse Int

Creating a Request

data ListAuditFindings Source #

See: newListAuditFindings smart constructor.

Constructors

ListAuditFindings'

Fields

startTime :: Maybe POSIX
A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.
taskId :: Maybe Text
A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.
checkName :: Maybe Text
A filter to limit results to the findings for the specified audit check.
listSuppressedFindings :: Maybe Bool
Boolean flag indicating whether only the suppressed findings or the unsuppressed findings should be listed. If this parameter isn't provided, the response will list both suppressed and unsuppressed findings.
nextToken :: Maybe Text
The token for the next set of results.
endTime :: Maybe POSIX
A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.
maxResults :: Maybe Natural
The maximum number of results to return at one time. The default is 25.
resourceIdentifier :: Maybe ResourceIdentifier
Information identifying the noncompliant resource.

Instances

Instances details

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

newListAuditFindings :: ListAuditFindings Source #

Create a value of ListAuditFindings 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:startTime:ListAuditFindings', listAuditFindings_startTime - A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.

$sel:taskId:ListAuditFindings', listAuditFindings_taskId - A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.

$sel:checkName:ListAuditFindings', listAuditFindings_checkName - A filter to limit results to the findings for the specified audit check.

$sel:listSuppressedFindings:ListAuditFindings', listAuditFindings_listSuppressedFindings - Boolean flag indicating whether only the suppressed findings or the unsuppressed findings should be listed. If this parameter isn't provided, the response will list both suppressed and unsuppressed findings.

$sel:nextToken:ListAuditFindings', listAuditFindings_nextToken - The token for the next set of results.

$sel:endTime:ListAuditFindings', listAuditFindings_endTime - A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.

$sel:maxResults:ListAuditFindings', listAuditFindings_maxResults - The maximum number of results to return at one time. The default is 25.

$sel:resourceIdentifier:ListAuditFindings', listAuditFindings_resourceIdentifier - Information identifying the noncompliant resource.

Request Lenses

listAuditFindings_startTime :: Lens' ListAuditFindings (Maybe UTCTime) Source #

A filter to limit results to those found after the specified time. You must specify either the startTime and endTime or the taskId, but not both.

listAuditFindings_taskId :: Lens' ListAuditFindings (Maybe Text) Source #

A filter to limit results to the audit with the specified ID. You must specify either the taskId or the startTime and endTime, but not both.

listAuditFindings_checkName :: Lens' ListAuditFindings (Maybe Text) Source #

A filter to limit results to the findings for the specified audit check.

listAuditFindings_listSuppressedFindings :: Lens' ListAuditFindings (Maybe Bool) Source #

Boolean flag indicating whether only the suppressed findings or the unsuppressed findings should be listed. If this parameter isn't provided, the response will list both suppressed and unsuppressed findings.

listAuditFindings_nextToken :: Lens' ListAuditFindings (Maybe Text) Source #

The token for the next set of results.

listAuditFindings_endTime :: Lens' ListAuditFindings (Maybe UTCTime) Source #

A filter to limit results to those found before the specified time. You must specify either the startTime and endTime or the taskId, but not both.

listAuditFindings_maxResults :: Lens' ListAuditFindings (Maybe Natural) Source #

The maximum number of results to return at one time. The default is 25.

listAuditFindings_resourceIdentifier :: Lens' ListAuditFindings (Maybe ResourceIdentifier) Source #

Information identifying the noncompliant resource.

Destructuring the Response

data ListAuditFindingsResponse Source #

See: newListAuditFindingsResponse smart constructor.

Constructors

ListAuditFindingsResponse'
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. findings :: Maybe [AuditFinding] The findings (results) of the audit. httpStatus :: Int The response's http status code.

Instances

Instances details

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

newListAuditFindingsResponse Source #

Arguments

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

Create a value of ListAuditFindingsResponse 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:ListAuditFindings', listAuditFindingsResponse_nextToken - A token that can be used to retrieve the next set of results, or null if there are no additional results.

$sel:findings:ListAuditFindingsResponse', listAuditFindingsResponse_findings - The findings (results) of the audit.

$sel:httpStatus:ListAuditFindingsResponse', listAuditFindingsResponse_httpStatus - The response's http status code.

Response Lenses

listAuditFindingsResponse_nextToken :: Lens' ListAuditFindingsResponse (Maybe Text) Source #

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

listAuditFindingsResponse_findings :: Lens' ListAuditFindingsResponse (Maybe [AuditFinding]) Source #

The findings (results) of the audit.

listAuditFindingsResponse_httpStatus :: Lens' ListAuditFindingsResponse Int Source #

The response's http status code.