aws_sdk_iot/client/update_scheduled_audit.rs
1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3 /// Constructs a fluent builder for the [`UpdateScheduledAudit`](crate::operation::update_scheduled_audit::builders::UpdateScheduledAuditFluentBuilder) operation.
4 ///
5 /// - The fluent builder is configurable:
6 /// - [`frequency(AuditFrequency)`](crate::operation::update_scheduled_audit::builders::UpdateScheduledAuditFluentBuilder::frequency) / [`set_frequency(Option<AuditFrequency>)`](crate::operation::update_scheduled_audit::builders::UpdateScheduledAuditFluentBuilder::set_frequency):<br>required: **false**<br><p>How often the scheduled audit takes place, either <code>DAILY</code>, <code>WEEKLY</code>, <code>BIWEEKLY</code>, or <code>MONTHLY</code>. The start time of each audit is determined by the system.</p><br>
7 /// - [`day_of_month(impl Into<String>)`](crate::operation::update_scheduled_audit::builders::UpdateScheduledAuditFluentBuilder::day_of_month) / [`set_day_of_month(Option<String>)`](crate::operation::update_scheduled_audit::builders::UpdateScheduledAuditFluentBuilder::set_day_of_month):<br>required: **false**<br><p>The day of the month on which the scheduled audit takes place. This can be <code>1</code> through <code>31</code> or <code>LAST</code>. This field is required if the <code>frequency</code> parameter is set to <code>MONTHLY</code>. 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.</p><br>
8 /// - [`day_of_week(DayOfWeek)`](crate::operation::update_scheduled_audit::builders::UpdateScheduledAuditFluentBuilder::day_of_week) / [`set_day_of_week(Option<DayOfWeek>)`](crate::operation::update_scheduled_audit::builders::UpdateScheduledAuditFluentBuilder::set_day_of_week):<br>required: **false**<br><p>The day of the week on which the scheduled audit takes place. This can be one of <code>SUN</code>, <code>MON</code>, <code>TUE</code>, <code>WED</code>, <code>THU</code>, <code>FRI</code>, or <code>SAT</code>. This field is required if the "frequency" parameter is set to <code>WEEKLY</code> or <code>BIWEEKLY</code>.</p><br>
9 /// - [`target_check_names(impl Into<String>)`](crate::operation::update_scheduled_audit::builders::UpdateScheduledAuditFluentBuilder::target_check_names) / [`set_target_check_names(Option<Vec::<String>>)`](crate::operation::update_scheduled_audit::builders::UpdateScheduledAuditFluentBuilder::set_target_check_names):<br>required: **false**<br><p>Which checks are performed during the scheduled audit. Checks must be enabled for your account. (Use <code>DescribeAccountAuditConfiguration</code> to see the list of all checks, including those that are enabled or use <code>UpdateAccountAuditConfiguration</code> to select which checks are enabled.)</p><br>
10 /// - [`scheduled_audit_name(impl Into<String>)`](crate::operation::update_scheduled_audit::builders::UpdateScheduledAuditFluentBuilder::scheduled_audit_name) / [`set_scheduled_audit_name(Option<String>)`](crate::operation::update_scheduled_audit::builders::UpdateScheduledAuditFluentBuilder::set_scheduled_audit_name):<br>required: **true**<br><p>The name of the scheduled audit. (Max. 128 chars)</p><br>
11 /// - On success, responds with [`UpdateScheduledAuditOutput`](crate::operation::update_scheduled_audit::UpdateScheduledAuditOutput) with field(s):
12 /// - [`scheduled_audit_arn(Option<String>)`](crate::operation::update_scheduled_audit::UpdateScheduledAuditOutput::scheduled_audit_arn): <p>The ARN of the scheduled audit.</p>
13 /// - On failure, responds with [`SdkError<UpdateScheduledAuditError>`](crate::operation::update_scheduled_audit::UpdateScheduledAuditError)
14 pub fn update_scheduled_audit(&self) -> crate::operation::update_scheduled_audit::builders::UpdateScheduledAuditFluentBuilder {
15 crate::operation::update_scheduled_audit::builders::UpdateScheduledAuditFluentBuilder::new(self.handle.clone())
16 }
17}