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

Description

Updates a scheduled audit, including which checks are performed and how often the audit takes place.

Requires permission to access the UpdateScheduledAudit action.

Synopsis

Creating a Request

data UpdateScheduledAudit Source #

See: newUpdateScheduledAudit smart constructor.

Constructors

UpdateScheduledAudit' 

Fields

  • frequency :: Maybe AuditFrequency

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

  • dayOfMonth :: Maybe Text

    The day of the month on which the scheduled audit takes place. This can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY. 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.

  • 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.)

  • dayOfWeek :: Maybe DayOfWeek

    The day of the week on which the scheduled audit takes place. This can be one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the "frequency" parameter is set to WEEKLY or BIWEEKLY.

  • scheduledAuditName :: Text

    The name of the scheduled audit. (Max. 128 chars)

Instances

Instances details
Eq UpdateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

Read UpdateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

Show UpdateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

Generic UpdateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

Associated Types

type Rep UpdateScheduledAudit :: Type -> Type #

NFData UpdateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

Methods

rnf :: UpdateScheduledAudit -> () #

Hashable UpdateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

ToJSON UpdateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

AWSRequest UpdateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

Associated Types

type AWSResponse UpdateScheduledAudit #

ToHeaders UpdateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

ToPath UpdateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

ToQuery UpdateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

type Rep UpdateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

type Rep UpdateScheduledAudit = D1 ('MetaData "UpdateScheduledAudit" "Amazonka.IoT.UpdateScheduledAudit" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "UpdateScheduledAudit'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "frequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AuditFrequency)) :*: S1 ('MetaSel ('Just "dayOfMonth") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "targetCheckNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: (S1 ('MetaSel ('Just "dayOfWeek") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe DayOfWeek)) :*: S1 ('MetaSel ('Just "scheduledAuditName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse UpdateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

newUpdateScheduledAudit Source #

Create a value of UpdateScheduledAudit 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:frequency:UpdateScheduledAudit', updateScheduledAudit_frequency - How often the scheduled audit takes place, either DAILY, WEEKLY, BIWEEKLY, or MONTHLY. The start time of each audit is determined by the system.

$sel:dayOfMonth:UpdateScheduledAudit', updateScheduledAudit_dayOfMonth - The day of the month on which the scheduled audit takes place. This can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY. 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.

$sel:targetCheckNames:UpdateScheduledAudit', updateScheduledAudit_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:dayOfWeek:UpdateScheduledAudit', updateScheduledAudit_dayOfWeek - The day of the week on which the scheduled audit takes place. This can be one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the "frequency" parameter is set to WEEKLY or BIWEEKLY.

$sel:scheduledAuditName:UpdateScheduledAudit', updateScheduledAudit_scheduledAuditName - The name of the scheduled audit. (Max. 128 chars)

Request Lenses

updateScheduledAudit_frequency :: Lens' UpdateScheduledAudit (Maybe AuditFrequency) Source #

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

updateScheduledAudit_dayOfMonth :: Lens' UpdateScheduledAudit (Maybe Text) Source #

The day of the month on which the scheduled audit takes place. This can be 1 through 31 or LAST. This field is required if the frequency parameter is set to MONTHLY. 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.

updateScheduledAudit_targetCheckNames :: Lens' UpdateScheduledAudit (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.)

updateScheduledAudit_dayOfWeek :: Lens' UpdateScheduledAudit (Maybe DayOfWeek) Source #

The day of the week on which the scheduled audit takes place. This can be one of SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the "frequency" parameter is set to WEEKLY or BIWEEKLY.

updateScheduledAudit_scheduledAuditName :: Lens' UpdateScheduledAudit Text Source #

The name of the scheduled audit. (Max. 128 chars)

Destructuring the Response

data UpdateScheduledAuditResponse Source #

See: newUpdateScheduledAuditResponse smart constructor.

Constructors

UpdateScheduledAuditResponse' 

Fields

Instances

Instances details
Eq UpdateScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

Read UpdateScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

Show UpdateScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

Generic UpdateScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

Associated Types

type Rep UpdateScheduledAuditResponse :: Type -> Type #

NFData UpdateScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

type Rep UpdateScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.UpdateScheduledAudit

type Rep UpdateScheduledAuditResponse = D1 ('MetaData "UpdateScheduledAuditResponse" "Amazonka.IoT.UpdateScheduledAudit" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "UpdateScheduledAuditResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "scheduledAuditArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateScheduledAuditResponse Source #

Create a value of UpdateScheduledAuditResponse 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:scheduledAuditArn:UpdateScheduledAuditResponse', updateScheduledAuditResponse_scheduledAuditArn - The ARN of the scheduled audit.

$sel:httpStatus:UpdateScheduledAuditResponse', updateScheduledAuditResponse_httpStatus - The response's http status code.

Response Lenses