[ aws . iot ]

describe-scheduled-audit

Description

Gets information about a scheduled audit.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-scheduled-audit
--scheduled-audit-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--scheduled-audit-name (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Examples

To get information about a scheduled audit

The following describe-scheduled-audit example gets detailed information about an AWS IOT Device Defender scheduled audit named AWSIoTDeviceDefenderDailyAudit.

aws iot describe-scheduled-audit \
    --scheduled-audit-name AWSIoTDeviceDefenderDailyAudit

Output:

{
    "frequency": "DAILY",
    "targetCheckNames": [
        "AUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK",
        "CONFLICTING_CLIENT_IDS_CHECK",
        "DEVICE_CERTIFICATE_SHARED_CHECK",
        "IOT_POLICY_OVERLY_PERMISSIVE_CHECK",
        "REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK",
        "UNAUTHENTICATED_COGNITO_ROLE_OVERLY_PERMISSIVE_CHECK"
    ],
    "scheduledAuditName": "AWSIoTDeviceDefenderDailyAudit",
    "scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/AWSIoTDeviceDefenderDailyAudit"
}

For more information, see Audit Commands in the AWS IoT Developer Guide.

Output

frequency -> (string)

How often the scheduled audit takes place. 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. 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. 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.