IoT / Client / describe_scheduled_audit

describe_scheduled_audit

IoT.Client.describe_scheduled_audit(**kwargs)

Gets information about a scheduled audit.

Requires permission to access the DescribeScheduledAudit action.

See also: AWS API Documentation

Request Syntax

response = client.describe_scheduled_audit(
    scheduledAuditName='string'
)

Parameters:

scheduledAuditName (string) –

[REQUIRED]

The name of the scheduled audit whose information you want to get.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

• (dict) –

  • frequency (string) –

    How often the scheduled audit takes place, either one of 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 is will be 1 through 31 or LAST. 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 takes place, either one of SUN, MON, TUE, WED, THU, FRI, or SAT.

  • targetCheckNames (list) –

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

    The name of the scheduled audit.

  • scheduledAuditArn (string) –

    The ARN of the scheduled audit.

Exceptions

• IoT.Client.exceptions.InvalidRequestException

• IoT.Client.exceptions.ResourceNotFoundException

• IoT.Client.exceptions.ThrottlingException

• IoT.Client.exceptions.InternalFailureException