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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets information about a Device Defender audit.

Requires permission to access the DescribeAuditTask action.

Synopsis

data DescribeAuditTask = DescribeAuditTask' {
- taskId :: Text
}
newDescribeAuditTask :: Text -> DescribeAuditTask
describeAuditTask_taskId :: Lens' DescribeAuditTask Text
data DescribeAuditTaskResponse = DescribeAuditTaskResponse' {
- auditDetails :: Maybe (HashMap Text AuditCheckDetails)
- taskType :: Maybe AuditTaskType
- taskStartTime :: Maybe POSIX
- taskStatistics :: Maybe TaskStatistics
- scheduledAuditName :: Maybe Text
- taskStatus :: Maybe AuditTaskStatus
- httpStatus :: Int
}
newDescribeAuditTaskResponse :: Int -> DescribeAuditTaskResponse
describeAuditTaskResponse_auditDetails :: Lens' DescribeAuditTaskResponse (Maybe (HashMap Text AuditCheckDetails))
describeAuditTaskResponse_taskType :: Lens' DescribeAuditTaskResponse (Maybe AuditTaskType)
describeAuditTaskResponse_taskStartTime :: Lens' DescribeAuditTaskResponse (Maybe UTCTime)
describeAuditTaskResponse_taskStatistics :: Lens' DescribeAuditTaskResponse (Maybe TaskStatistics)
describeAuditTaskResponse_scheduledAuditName :: Lens' DescribeAuditTaskResponse (Maybe Text)
describeAuditTaskResponse_taskStatus :: Lens' DescribeAuditTaskResponse (Maybe AuditTaskStatus)
describeAuditTaskResponse_httpStatus :: Lens' DescribeAuditTaskResponse Int

Creating a Request

data DescribeAuditTask Source #

See: newDescribeAuditTask smart constructor.

Constructors

DescribeAuditTask'
Fields taskId :: Text The ID of the audit whose information you want to get.

Instances

Instances details

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

newDescribeAuditTask Source #

Arguments

:: Text	`$sel:taskId:DescribeAuditTask'`
-> DescribeAuditTask

Create a value of DescribeAuditTask 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:taskId:DescribeAuditTask', describeAuditTask_taskId - The ID of the audit whose information you want to get.

Request Lenses

describeAuditTask_taskId :: Lens' DescribeAuditTask Text Source #

The ID of the audit whose information you want to get.

Destructuring the Response

data DescribeAuditTaskResponse Source #

See: newDescribeAuditTaskResponse smart constructor.

Constructors

DescribeAuditTaskResponse'

Fields

auditDetails :: Maybe (HashMap Text AuditCheckDetails)
Detailed information about each check performed during this audit.
taskType :: Maybe AuditTaskType
The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".
taskStartTime :: Maybe POSIX
The time the audit started.
taskStatistics :: Maybe TaskStatistics
Statistical information about the audit.
scheduledAuditName :: Maybe Text
The name of the scheduled audit (only if the audit was a scheduled audit).
taskStatus :: Maybe AuditTaskStatus
The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".
httpStatus :: Int
The response's http status code.

Instances

Instances details

Eq DescribeAuditTaskResponse Source #
Instance details Defined in Amazonka.IoT.DescribeAuditTask Methods (==) :: DescribeAuditTaskResponse -> DescribeAuditTaskResponse -> Bool # (/=) :: DescribeAuditTaskResponse -> DescribeAuditTaskResponse -> Bool #
Read DescribeAuditTaskResponse Source #
Instance details Defined in Amazonka.IoT.DescribeAuditTask Methods readsPrec :: Int -> ReadS DescribeAuditTaskResponse # readList :: ReadS [DescribeAuditTaskResponse] # readPrec :: ReadPrec DescribeAuditTaskResponse # readListPrec :: ReadPrec [DescribeAuditTaskResponse] #
Show DescribeAuditTaskResponse Source #
Instance details Defined in Amazonka.IoT.DescribeAuditTask Methods showsPrec :: Int -> DescribeAuditTaskResponse -> ShowS # show :: DescribeAuditTaskResponse -> String # showList :: [DescribeAuditTaskResponse] -> ShowS #
Generic DescribeAuditTaskResponse Source #
Instance details Defined in Amazonka.IoT.DescribeAuditTask Associated Types type Rep DescribeAuditTaskResponse :: Type -> Type # Methods from :: DescribeAuditTaskResponse -> Rep DescribeAuditTaskResponse x # to :: Rep DescribeAuditTaskResponse x -> DescribeAuditTaskResponse #
NFData DescribeAuditTaskResponse Source #
Instance details Defined in Amazonka.IoT.DescribeAuditTask Methods rnf :: DescribeAuditTaskResponse -> () #
type Rep DescribeAuditTaskResponse Source #
Instance details Defined in Amazonka.IoT.DescribeAuditTask type Rep DescribeAuditTaskResponse = D1 ('MetaData "DescribeAuditTaskResponse" "Amazonka.IoT.DescribeAuditTask" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "DescribeAuditTaskResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "auditDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text AuditCheckDetails))) :: (S1 ('MetaSel ('Just "taskType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuditTaskType)) :: S1 ('MetaSel ('Just "taskStartTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "taskStatistics") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe TaskStatistics)) :: S1 ('MetaSel ('Just "scheduledAuditName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "taskStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuditTaskStatus)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeAuditTaskResponse Source #

Arguments

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

Create a value of DescribeAuditTaskResponse 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:auditDetails:DescribeAuditTaskResponse', describeAuditTaskResponse_auditDetails - Detailed information about each check performed during this audit.

$sel:taskType:DescribeAuditTaskResponse', describeAuditTaskResponse_taskType - The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

$sel:taskStartTime:DescribeAuditTaskResponse', describeAuditTaskResponse_taskStartTime - The time the audit started.

$sel:taskStatistics:DescribeAuditTaskResponse', describeAuditTaskResponse_taskStatistics - Statistical information about the audit.

$sel:scheduledAuditName:DescribeAuditTaskResponse', describeAuditTaskResponse_scheduledAuditName - The name of the scheduled audit (only if the audit was a scheduled audit).

$sel:taskStatus:DescribeAuditTaskResponse', describeAuditTaskResponse_taskStatus - The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

$sel:httpStatus:DescribeAuditTaskResponse', describeAuditTaskResponse_httpStatus - The response's http status code.

Response Lenses

describeAuditTaskResponse_auditDetails :: Lens' DescribeAuditTaskResponse (Maybe (HashMap Text AuditCheckDetails)) Source #

Detailed information about each check performed during this audit.

describeAuditTaskResponse_taskType :: Lens' DescribeAuditTaskResponse (Maybe AuditTaskType) Source #

The type of audit: "ON_DEMAND_AUDIT_TASK" or "SCHEDULED_AUDIT_TASK".

describeAuditTaskResponse_taskStartTime :: Lens' DescribeAuditTaskResponse (Maybe UTCTime) Source #

The time the audit started.

describeAuditTaskResponse_taskStatistics :: Lens' DescribeAuditTaskResponse (Maybe TaskStatistics) Source #

Statistical information about the audit.

describeAuditTaskResponse_scheduledAuditName :: Lens' DescribeAuditTaskResponse (Maybe Text) Source #

The name of the scheduled audit (only if the audit was a scheduled audit).

describeAuditTaskResponse_taskStatus :: Lens' DescribeAuditTaskResponse (Maybe AuditTaskStatus) Source #

The status of the audit: one of "IN_PROGRESS", "COMPLETED", "FAILED", or "CANCELED".

describeAuditTaskResponse_httpStatus :: Lens' DescribeAuditTaskResponse Int Source #

The response's http status code.