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

Description

Creates a scheduled audit that is run at a specified time interval.

Requires permission to access the CreateScheduledAudit action.

Synopsis

Creating a Request

data CreateScheduledAudit Source #

See: newCreateScheduledAudit smart constructor.

Constructors

CreateScheduledAudit' 

Fields

  • 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 to 31 are specified, and the month doesn't 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 SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.

  • tags :: Maybe [Tag]

    Metadata that can be used to manage the scheduled audit.

  • frequency :: 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.

  • targetCheckNames :: [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.)

  • scheduledAuditName :: Text

    The name you want to give to the scheduled audit. (Max. 128 chars)

Instances

Instances details
Eq CreateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

Read CreateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

Show CreateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

Generic CreateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

Associated Types

type Rep CreateScheduledAudit :: Type -> Type #

NFData CreateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

Methods

rnf :: CreateScheduledAudit -> () #

Hashable CreateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

ToJSON CreateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

AWSRequest CreateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

Associated Types

type AWSResponse CreateScheduledAudit #

ToHeaders CreateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

ToPath CreateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

ToQuery CreateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

type Rep CreateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

type Rep CreateScheduledAudit = D1 ('MetaData "CreateScheduledAudit" "Amazonka.IoT.CreateScheduledAudit" "libZSservicesZSamazonka-iotZSamazonka-iot" 'False) (C1 ('MetaCons "CreateScheduledAudit'" '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 "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Tag])))) :*: (S1 ('MetaSel ('Just "frequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AuditFrequency) :*: (S1 ('MetaSel ('Just "targetCheckNames") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "scheduledAuditName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateScheduledAudit Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

newCreateScheduledAudit Source #

Create a value of CreateScheduledAudit 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:dayOfMonth:CreateScheduledAudit', createScheduledAudit_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 to 31 are specified, and the month doesn't have that many days, the audit takes place on the LAST day of the month.

$sel:dayOfWeek:CreateScheduledAudit', createScheduledAudit_dayOfWeek - The day of the week on which the scheduled audit takes place, either SUN, MON, TUE, WED, THU, FRI, or SAT. This field is required if the frequency parameter is set to WEEKLY or BIWEEKLY.

$sel:tags:CreateScheduledAudit', createScheduledAudit_tags - Metadata that can be used to manage the scheduled audit.

$sel:frequency:CreateScheduledAudit', createScheduledAudit_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:targetCheckNames:CreateScheduledAudit', createScheduledAudit_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:scheduledAuditName:CreateScheduledAudit', createScheduledAudit_scheduledAuditName - The name you want to give to the scheduled audit. (Max. 128 chars)

Request Lenses

createScheduledAudit_dayOfMonth :: Lens' CreateScheduledAudit (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 to 31 are specified, and the month doesn't have that many days, the audit takes place on the LAST day of the month.

createScheduledAudit_dayOfWeek :: Lens' CreateScheduledAudit (Maybe DayOfWeek) Source #

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

createScheduledAudit_tags :: Lens' CreateScheduledAudit (Maybe [Tag]) Source #

Metadata that can be used to manage the scheduled audit.

createScheduledAudit_frequency :: Lens' CreateScheduledAudit 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.

createScheduledAudit_targetCheckNames :: Lens' CreateScheduledAudit [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.)

createScheduledAudit_scheduledAuditName :: Lens' CreateScheduledAudit Text Source #

The name you want to give to the scheduled audit. (Max. 128 chars)

Destructuring the Response

data CreateScheduledAuditResponse Source #

See: newCreateScheduledAuditResponse smart constructor.

Constructors

CreateScheduledAuditResponse' 

Fields

Instances

Instances details
Eq CreateScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

Read CreateScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

Show CreateScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

Generic CreateScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

Associated Types

type Rep CreateScheduledAuditResponse :: Type -> Type #

NFData CreateScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

type Rep CreateScheduledAuditResponse Source # 
Instance details

Defined in Amazonka.IoT.CreateScheduledAudit

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

newCreateScheduledAuditResponse Source #

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

$sel:httpStatus:CreateScheduledAuditResponse', createScheduledAuditResponse_httpStatus - The response's http status code.

Response Lenses