Skip to content

CreateScheduledAuditRequest

Source code in docs_src/capo_iot/types/create_scheduled_audit_request.py
class CreateScheduledAuditRequest(TypedDict, closed=True):
    frequency: "capo_iot.types.audit_frequency.AuditFrequency"
    """<p>How often the scheduled audit takes place, either <code>DAILY</code>, <code>WEEKLY</code>, <code>BIWEEKLY</code> or <code>MONTHLY</code>. The start time of each audit is determined by the system.</p>"""
    day_of_month: NotRequired["capo_iot.types.day_of_month.DayOfMonth"]
    """<p>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 <code>MONTHLY</code>. If days 29 to 31 are specified, and the month doesn't have that many days, the audit takes place on the <code>LAST</code> day of the month.</p>"""
    day_of_week: NotRequired["capo_iot.types.day_of_week.DayOfWeek"]
    """<p>The day of the week on which the scheduled audit takes place, either <code>SUN</code>, <code>MON</code>, <code>TUE</code>, <code>WED</code>, <code>THU</code>, <code>FRI</code>, or <code>SAT</code>. This field is required if the <code>frequency</code> parameter is set to <code>WEEKLY</code> or <code>BIWEEKLY</code>.</p>"""
    target_check_names: "capo_iot.types.target_audit_check_names.TargetAuditCheckNames"
    """<p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p>"""
    scheduled_audit_name: "capo_iot.types.scheduled_audit_name.ScheduledAuditName"
    """<p>The name you want to give to the scheduled audit. (Max. 128 chars)</p>"""
    tags: NotRequired["capo_iot.types.tag_list.TagList"]
    """<p>Metadata that can be used to manage the scheduled audit.</p>"""

day_of_month instance-attribute

day_of_month: NotRequired[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.

day_of_week instance-attribute

day_of_week: NotRequired[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.

frequency instance-attribute

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.

scheduled_audit_name instance-attribute

scheduled_audit_name: ScheduledAuditName

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

tags instance-attribute

tags: NotRequired[TagList]

Metadata that can be used to manage the scheduled audit.

target_check_names instance-attribute

target_check_names: TargetAuditCheckNames

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