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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the Device Defender audits that have been performed during a given time period.

Requires permission to access the ListAuditTasks action.

This operation returns paginated results.

Synopsis

data ListAuditTasks = ListAuditTasks' {
- taskType :: Maybe AuditTaskType
- nextToken :: Maybe Text
- maxResults :: Maybe Natural
- taskStatus :: Maybe AuditTaskStatus
- startTime :: POSIX
- endTime :: POSIX
}
newListAuditTasks :: UTCTime -> UTCTime -> ListAuditTasks
listAuditTasks_taskType :: Lens' ListAuditTasks (Maybe AuditTaskType)
listAuditTasks_nextToken :: Lens' ListAuditTasks (Maybe Text)
listAuditTasks_maxResults :: Lens' ListAuditTasks (Maybe Natural)
listAuditTasks_taskStatus :: Lens' ListAuditTasks (Maybe AuditTaskStatus)
listAuditTasks_startTime :: Lens' ListAuditTasks UTCTime
listAuditTasks_endTime :: Lens' ListAuditTasks UTCTime
data ListAuditTasksResponse = ListAuditTasksResponse' {
- tasks :: Maybe [AuditTaskMetadata]
- nextToken :: Maybe Text
- httpStatus :: Int
}
newListAuditTasksResponse :: Int -> ListAuditTasksResponse
listAuditTasksResponse_tasks :: Lens' ListAuditTasksResponse (Maybe [AuditTaskMetadata])
listAuditTasksResponse_nextToken :: Lens' ListAuditTasksResponse (Maybe Text)
listAuditTasksResponse_httpStatus :: Lens' ListAuditTasksResponse Int

Creating a Request

data ListAuditTasks Source #

See: newListAuditTasks smart constructor.

Constructors

ListAuditTasks'

Fields

taskType :: Maybe AuditTaskType
A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".
nextToken :: Maybe Text
The token for the next set of results.
maxResults :: Maybe Natural
The maximum number of results to return at one time. The default is 25.
taskStatus :: Maybe AuditTaskStatus
A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
startTime :: POSIX
The beginning of the time period. Audit information is retained for a limited time (90 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".
endTime :: POSIX
The end of the time period.

Instances

Instances details

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

newListAuditTasks Source #

Arguments

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

Create a value of ListAuditTasks 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:taskType:ListAuditTasks', listAuditTasks_taskType - A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".

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

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

$sel:taskStatus:ListAuditTasks', listAuditTasks_taskStatus - A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

$sel:startTime:ListAuditTasks', listAuditTasks_startTime - The beginning of the time period. Audit information is retained for a limited time (90 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".

$sel:endTime:ListAuditTasks', listAuditTasks_endTime - The end of the time period.

Request Lenses

listAuditTasks_taskType :: Lens' ListAuditTasks (Maybe AuditTaskType) Source #

A filter to limit the output to the specified type of audit: can be one of "ON_DEMAND_AUDIT_TASK" or "SCHEDULED__AUDIT_TASK".

listAuditTasks_nextToken :: Lens' ListAuditTasks (Maybe Text) Source #

The token for the next set of results.

listAuditTasks_maxResults :: Lens' ListAuditTasks (Maybe Natural) Source #

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

listAuditTasks_taskStatus :: Lens' ListAuditTasks (Maybe AuditTaskStatus) Source #

A filter to limit the output to audits with the specified completion status: can be one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

listAuditTasks_startTime :: Lens' ListAuditTasks UTCTime Source #

The beginning of the time period. Audit information is retained for a limited time (90 days). Requesting a start time prior to what is retained results in an "InvalidRequestException".

listAuditTasks_endTime :: Lens' ListAuditTasks UTCTime Source #

The end of the time period.

Destructuring the Response

data ListAuditTasksResponse Source #

See: newListAuditTasksResponse smart constructor.

Constructors

ListAuditTasksResponse'
Fields tasks :: Maybe [AuditTaskMetadata] The audits that were performed during the specified time period. 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 ListAuditTasksResponse Source #
Instance details Defined in Amazonka.IoT.ListAuditTasks Methods (==) :: ListAuditTasksResponse -> ListAuditTasksResponse -> Bool # (/=) :: ListAuditTasksResponse -> ListAuditTasksResponse -> Bool #
Read ListAuditTasksResponse Source #
Instance details Defined in Amazonka.IoT.ListAuditTasks Methods readsPrec :: Int -> ReadS ListAuditTasksResponse # readList :: ReadS [ListAuditTasksResponse] # readPrec :: ReadPrec ListAuditTasksResponse # readListPrec :: ReadPrec [ListAuditTasksResponse] #
Show ListAuditTasksResponse Source #
Instance details Defined in Amazonka.IoT.ListAuditTasks Methods showsPrec :: Int -> ListAuditTasksResponse -> ShowS # show :: ListAuditTasksResponse -> String # showList :: [ListAuditTasksResponse] -> ShowS #
Generic ListAuditTasksResponse Source #
Instance details Defined in Amazonka.IoT.ListAuditTasks Associated Types type Rep ListAuditTasksResponse :: Type -> Type # Methods from :: ListAuditTasksResponse -> Rep ListAuditTasksResponse x # to :: Rep ListAuditTasksResponse x -> ListAuditTasksResponse #
NFData ListAuditTasksResponse Source #
Instance details Defined in Amazonka.IoT.ListAuditTasks Methods rnf :: ListAuditTasksResponse -> () #
type Rep ListAuditTasksResponse Source #
Instance details Defined in Amazonka.IoT.ListAuditTasks type Rep ListAuditTasksResponse = D1 ('MetaData "ListAuditTasksResponse" "Amazonka.IoT.ListAuditTasks" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "ListAuditTasksResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tasks") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [AuditTaskMetadata])) :: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListAuditTasksResponse Source #

Arguments

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

Create a value of ListAuditTasksResponse 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:tasks:ListAuditTasksResponse', listAuditTasksResponse_tasks - The audits that were performed during the specified time period.

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

$sel:httpStatus:ListAuditTasksResponse', listAuditTasksResponse_httpStatus - The response's http status code.

Response Lenses

listAuditTasksResponse_tasks :: Lens' ListAuditTasksResponse (Maybe [AuditTaskMetadata]) Source #

The audits that were performed during the specified time period.

listAuditTasksResponse_nextToken :: Lens' ListAuditTasksResponse (Maybe Text) Source #

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

listAuditTasksResponse_httpStatus :: Lens' ListAuditTasksResponse Int Source #

The response's http status code.