update-scheduled-audit¶
Description¶
Updates a scheduled audit, including which checks are performed and how often the audit takes place.
Requires permission to access the UpdateScheduledAudit action.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
update-scheduled-audit
[--frequency <value>]
[--day-of-month <value>]
[--day-of-week <value>]
[--target-check-names <value>]
--scheduled-audit-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--frequency (string)
How often the scheduled audit takes place, either
DAILY,WEEKLY,BIWEEKLY, orMONTHLY. The start time of each audit is determined by the system.Possible values:
DAILY
WEEKLY
BIWEEKLY
MONTHLY
--day-of-month (string)
The day of the month on which the scheduled audit takes place. This can be
1through31orLAST. This field is required if thefrequencyparameter is set toMONTHLY. 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.
--day-of-week (string)
The day of the week on which the scheduled audit takes place. This can be one of
SUN,MON,TUE,WED,THU,FRI, orSAT. This field is required if the “frequency” parameter is set toWEEKLYorBIWEEKLY.Possible values:
SUN
MON
TUE
WED
THU
FRI
SAT
--target-check-names (list)
Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use
DescribeAccountAuditConfigurationto see the list of all checks, including those that are enabled or useUpdateAccountAuditConfigurationto select which checks are enabled.)(string)
An audit check name. Checks must be enabled for your account. (Use
DescribeAccountAuditConfigurationto see the list of all checks, including those that are enabled or useUpdateAccountAuditConfigurationto select which checks are enabled.)
Syntax:
"string" "string" ...
--scheduled-audit-name (string)
The name of the scheduled audit. (Max. 128 chars)
--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.
See ‘aws help’ for descriptions of global parameters.
Examples¶
Note
To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.
Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .
To update a scheduled audit definition
The following update-scheduled-audit example changes the target check names for an AWS IoT Device Defender scheduled audit.
aws iot update-scheduled-audit \
--scheduled-audit-name WednesdayCertCheck \
--target-check-names CA_CERTIFICATE_EXPIRING_CHECK DEVICE_CERTIFICATE_EXPIRING_CHECK REVOKED_CA_CERTIFICATE_STILL_ACTIVE_CHECK
Output:
{
"scheduledAuditArn": "arn:aws:iot:us-west-2:123456789012:scheduledaudit/WednesdayCertCheck"
}
For more information, see Audit Commands in the AWS IoT Developer Guide.