IoT / Client / create_scheduled_audit

create_scheduled_audit

IoT.Client.create_scheduled_audit(**kwargs)

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

Requires permission to access the CreateScheduledAudit action.

See also: AWS API Documentation

Request Syntax

response = client.create_scheduled_audit(
    frequency='DAILY'|'WEEKLY'|'BIWEEKLY'|'MONTHLY',
    dayOfMonth='string',
    dayOfWeek='SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT',
    targetCheckNames=[
        'string',
    ],
    scheduledAuditName='string',
    tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

• frequency (string) –

  [REQUIRED]

  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 (string) – 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 (string) – 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.

• targetCheckNames (list) –

  [REQUIRED]

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

  • (string) –

    An audit check name. 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 (string) –

  [REQUIRED]

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

• tags (list) –

  Metadata that can be used to manage the scheduled audit.

  • (dict) –

    A set of key/value pairs that are used to manage the resource.

    • Key (string) – [REQUIRED]

      The tag’s key.

    • Value (string) –

      The tag’s value.

Return type:

dict

Returns:

Response Syntax

{
    'scheduledAuditArn': 'string'
}

Response Structure

• (dict) –

  • scheduledAuditArn (string) –

    The ARN of the scheduled audit.

Exceptions

• IoT.Client.exceptions.InvalidRequestException

• IoT.Client.exceptions.ResourceAlreadyExistsException

• IoT.Client.exceptions.ThrottlingException

• IoT.Client.exceptions.InternalFailureException

• IoT.Client.exceptions.LimitExceededException