amazonka-iot-2.0: Amazon IoT SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.IoT.DescribeScheduledAudit

Description

Gets information about a scheduled audit.

Requires permission to access the DescribeScheduledAudit action.

Synopsis

Creating a Request

data DescribeScheduledAudit Source #

See: newDescribeScheduledAudit smart constructor.

Constructors

DescribeScheduledAudit' 

Fields

Instances

Instances details
ToHeaders DescribeScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

ToPath DescribeScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

ToQuery DescribeScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

AWSRequest DescribeScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

Associated Types

type AWSResponse DescribeScheduledAudit #

Generic DescribeScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

Associated Types

type Rep DescribeScheduledAudit :: Type -> Type #

Read DescribeScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

Show DescribeScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

NFData DescribeScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

Methods

rnf :: DescribeScheduledAudit -> () #

Eq DescribeScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

Hashable DescribeScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

type AWSResponse DescribeScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

type Rep DescribeScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

type Rep DescribeScheduledAudit = D1 ('MetaData "DescribeScheduledAudit" "Amazonka.IoT.DescribeScheduledAudit" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeScheduledAudit'" 'PrefixI 'True) (S1 ('MetaSel ('Just "scheduledAuditName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeScheduledAudit Source #

Create a value of DescribeScheduledAudit 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:

DescribeScheduledAudit, describeScheduledAudit_scheduledAuditName - The name of the scheduled audit whose information you want to get.

Request Lenses

describeScheduledAudit_scheduledAuditName :: Lens' DescribeScheduledAudit Text Source #

The name of the scheduled audit whose information you want to get.

Destructuring the Response

data DescribeScheduledAuditResponse Source #

See: newDescribeScheduledAuditResponse smart constructor.

Constructors

DescribeScheduledAuditResponse' 

Fields

  • dayOfMonth :: Maybe Text

    The day of the month on which the scheduled audit takes place. This is will be 1 through 31 or LAST. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the LAST day of the month.

  • dayOfWeek :: Maybe DayOfWeek

    The day of the week on which the scheduled audit takes place, either one of SUN, MON, TUE, WED, THU, FRI, or SAT.

  • frequency :: Maybe AuditFrequency

    How often the scheduled audit takes place, either one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.

  • scheduledAuditArn :: Maybe Text

    The ARN of the scheduled audit.

  • scheduledAuditName :: Maybe Text

    The name of the scheduled audit.

  • targetCheckNames :: Maybe [Text]

    Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic DescribeScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

Associated Types

type Rep DescribeScheduledAuditResponse :: Type -> Type #

Read DescribeScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

Show DescribeScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

NFData DescribeScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

Eq DescribeScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

type Rep DescribeScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.DescribeScheduledAudit

type Rep DescribeScheduledAuditResponse = D1 ('MetaData "DescribeScheduledAuditResponse" "Amazonka.IoT.DescribeScheduledAudit" "amazonka-iot-2.0-6w03vgAfmrM1SG22OsNJXL" 'False) (C1 ('MetaCons "DescribeScheduledAuditResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "dayOfMonth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "dayOfWeek") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DayOfWeek)) :*: S1 ('MetaSel ('Just "frequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuditFrequency)))) :*: ((S1 ('MetaSel ('Just "scheduledAuditArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "scheduledAuditName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "targetCheckNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newDescribeScheduledAuditResponse Source #

Create a value of DescribeScheduledAuditResponse 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:

DescribeScheduledAuditResponse, describeScheduledAuditResponse_dayOfMonth - The day of the month on which the scheduled audit takes place. This is will be 1 through 31 or LAST. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the LAST day of the month.

DescribeScheduledAuditResponse, describeScheduledAuditResponse_dayOfWeek - The day of the week on which the scheduled audit takes place, either one of SUN, MON, TUE, WED, THU, FRI, or SAT.

DescribeScheduledAuditResponse, describeScheduledAuditResponse_frequency - How often the scheduled audit takes place, either one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.

DescribeScheduledAuditResponse, describeScheduledAuditResponse_scheduledAuditArn - The ARN of the scheduled audit.

DescribeScheduledAudit, describeScheduledAuditResponse_scheduledAuditName - The name of the scheduled audit.

$sel:targetCheckNames:DescribeScheduledAuditResponse', describeScheduledAuditResponse_targetCheckNames - Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)

$sel:httpStatus:DescribeScheduledAuditResponse', describeScheduledAuditResponse_httpStatus - The response's http status code.

Response Lenses

describeScheduledAuditResponse_dayOfMonth :: Lens' DescribeScheduledAuditResponse (Maybe Text) Source #

The day of the month on which the scheduled audit takes place. This is will be 1 through 31 or LAST. If days 29-31 are specified, and the month does not have that many days, the audit takes place on the LAST day of the month.

describeScheduledAuditResponse_dayOfWeek :: Lens' DescribeScheduledAuditResponse (Maybe DayOfWeek) Source #

The day of the week on which the scheduled audit takes place, either one of SUN, MON, TUE, WED, THU, FRI, or SAT.

describeScheduledAuditResponse_frequency :: Lens' DescribeScheduledAuditResponse (Maybe AuditFrequency) Source #

How often the scheduled audit takes place, either one of DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.

describeScheduledAuditResponse_targetCheckNames :: Lens' DescribeScheduledAuditResponse (Maybe [Text]) Source #

Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use DescribeAccountAuditConfiguration to see the list of all checks, including those that are enabled or use UpdateAccountAuditConfiguration to select which checks are enabled.)