| 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.CreateScheduledAudit
Description
Creates a scheduled audit that is run at a specified time interval.
Requires permission to access the CreateScheduledAudit action.
Synopsis
- data CreateScheduledAudit = CreateScheduledAudit' {
- dayOfMonth :: Maybe Text
- dayOfWeek :: Maybe DayOfWeek
- tags :: Maybe [Tag]
- frequency :: AuditFrequency
- targetCheckNames :: [Text]
- scheduledAuditName :: Text
- newCreateScheduledAudit :: AuditFrequency -> Text -> CreateScheduledAudit
- createScheduledAudit_dayOfMonth :: Lens' CreateScheduledAudit (Maybe Text)
- createScheduledAudit_dayOfWeek :: Lens' CreateScheduledAudit (Maybe DayOfWeek)
- createScheduledAudit_tags :: Lens' CreateScheduledAudit (Maybe [Tag])
- createScheduledAudit_frequency :: Lens' CreateScheduledAudit AuditFrequency
- createScheduledAudit_targetCheckNames :: Lens' CreateScheduledAudit [Text]
- createScheduledAudit_scheduledAuditName :: Lens' CreateScheduledAudit Text
- data CreateScheduledAuditResponse = CreateScheduledAuditResponse' {}
- newCreateScheduledAuditResponse :: Int -> CreateScheduledAuditResponse
- createScheduledAuditResponse_scheduledAuditArn :: Lens' CreateScheduledAuditResponse (Maybe Text)
- createScheduledAuditResponse_httpStatus :: Lens' CreateScheduledAuditResponse Int
Creating a Request
data CreateScheduledAudit Source #
See: newCreateScheduledAudit smart constructor.
Constructors
| CreateScheduledAudit' | |
Fields
| |
Instances
newCreateScheduledAudit Source #
Arguments
| :: AuditFrequency | |
| -> Text | |
| -> CreateScheduledAudit |
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
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
createScheduledAuditResponse_scheduledAuditArn :: Lens' CreateScheduledAuditResponse (Maybe Text) Source #
The ARN of the scheduled audit.
createScheduledAuditResponse_httpStatus :: Lens' CreateScheduledAuditResponse Int Source #
The response's http status code.