IoT / Paginator / ListScheduledAudits


class IoT.Paginator.ListScheduledAudits#
paginator = client.get_paginator('list_scheduled_audits')

Creates an iterator that will paginate through responses from IoT.Client.list_scheduled_audits().

See also: AWS API Documentation

Request Syntax

response_iterator = paginator.paginate(
        'MaxItems': 123,
        'PageSize': 123,
        'StartingToken': 'string'

PaginationConfig (dict) –

A dictionary that provides parameters to control pagination.

  • MaxItems (integer) –

    The total number of items to return. If the total number of items available is more than the value specified in max-items then a NextToken will be provided in the output that you can use to resume pagination.

  • PageSize (integer) –

    The size of each page.

  • StartingToken (string) –

    A token to specify where to start paginating. This is the NextToken from a previous response.

Return type:



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 to resume pagination.