IoT / Client / list_scheduled_audits

list_scheduled_audits#

IoT.Client.list_scheduled_audits(**kwargs)#

Lists all of your scheduled audits.

Requires permission to access the ListScheduledAudits action.

See also: AWS API Documentation

Request Syntax

response = client.list_scheduled_audits(
    nextToken='string',
    maxResults=123
)
Parameters:

  • nextToken (string) – The token for the next set of results.

  • maxResults (integer) – The maximum number of results to return at one time. The default is 25.

Return type:

dict

Returns:

Response Syntax

{
    'scheduledAudits': [
        {
            'scheduledAuditName': 'string',
            'scheduledAuditArn': 'string',
            'frequency': 'DAILY'|'WEEKLY'|'BIWEEKLY'|'MONTHLY',
            'dayOfMonth': 'string',
            'dayOfWeek': 'SUN'|'MON'|'TUE'|'WED'|'THU'|'FRI'|'SAT'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • scheduledAudits (list) –

      The list of scheduled audits.

      • (dict) –

        Information about the scheduled audit.

        • scheduledAuditName (string) –

          The name of the scheduled audit.

        • scheduledAuditArn (string) –

          The ARN of the scheduled audit.

        • frequency (string) –

          How often the scheduled audit occurs.

        • dayOfMonth (string) –

          The day of the month on which the scheduled audit is run (if the frequency is “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.

        • dayOfWeek (string) –

          The day of the week on which the scheduled audit is run (if the frequency is “WEEKLY” or “BIWEEKLY”).

    • nextToken (string) –

      A token that can be used to retrieve the next set of results, or null if there are no additional results.

Exceptions