aws_sdk_redshift/client/

modify_scheduled_action.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ModifyScheduledAction`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`scheduled_action_name(impl Into<String>)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::scheduled_action_name) / [`set_scheduled_action_name(Option<String>)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::set_scheduled_action_name):<br>required: **true**<br><p>The name of the scheduled action to modify.</p><br>
    ///   - [`target_action(ScheduledActionType)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::target_action) / [`set_target_action(Option<ScheduledActionType>)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::set_target_action):<br>required: **false**<br><p>A modified JSON format of the scheduled action. For more information about this parameter, see <code>ScheduledAction</code>.</p><br>
    ///   - [`schedule(impl Into<String>)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::schedule) / [`set_schedule(Option<String>)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::set_schedule):<br>required: **false**<br><p>A modified schedule in either <code>at( )</code> or <code>cron( )</code> format. For more information about this parameter, see <code>ScheduledAction</code>.</p><br>
    ///   - [`iam_role(impl Into<String>)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::iam_role) / [`set_iam_role(Option<String>)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::set_iam_role):<br>required: **false**<br><p>A different IAM role to assume to run the target action. For more information about this parameter, see <code>ScheduledAction</code>.</p><br>
    ///   - [`scheduled_action_description(impl Into<String>)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::scheduled_action_description) / [`set_scheduled_action_description(Option<String>)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::set_scheduled_action_description):<br>required: **false**<br><p>A modified description of the scheduled action.</p><br>
    ///   - [`start_time(DateTime)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::set_start_time):<br>required: **false**<br><p>A modified start time of the scheduled action. For more information about this parameter, see <code>ScheduledAction</code>.</p><br>
    ///   - [`end_time(DateTime)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::set_end_time):<br>required: **false**<br><p>A modified end time of the scheduled action. For more information about this parameter, see <code>ScheduledAction</code>.</p><br>
    ///   - [`enable(bool)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::enable) / [`set_enable(Option<bool>)`](crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::set_enable):<br>required: **false**<br><p>A modified enable flag of the scheduled action. If true, the scheduled action is active. If false, the scheduled action is disabled.</p><br>
    /// - On success, responds with [`ModifyScheduledActionOutput`](crate::operation::modify_scheduled_action::ModifyScheduledActionOutput) with field(s):
    ///   - [`scheduled_action_name(Option<String>)`](crate::operation::modify_scheduled_action::ModifyScheduledActionOutput::scheduled_action_name): <p>The name of the scheduled action.</p>
    ///   - [`target_action(Option<ScheduledActionType>)`](crate::operation::modify_scheduled_action::ModifyScheduledActionOutput::target_action): <p>A JSON format string of the Amazon Redshift API operation with input parameters.</p> <p>"<code>{\"ResizeCluster\":{\"NodeType\":\"ra3.4xlarge\",\"ClusterIdentifier\":\"my-test-cluster\",\"NumberOfNodes\":3}}</code>".</p>
    ///   - [`schedule(Option<String>)`](crate::operation::modify_scheduled_action::ModifyScheduledActionOutput::schedule): <p>The schedule for a one-time (at format) or recurring (cron format) scheduled action. Schedule invocations must be separated by at least one hour.</p> <p>Format of at expressions is "<code>at(yyyy-mm-ddThh:mm:ss)</code>". For example, "<code>at(2016-03-04T17:27:00)</code>".</p> <p>Format of cron expressions is "<code>cron(Minutes Hours Day-of-month Month Day-of-week Year)</code>". For example, "<code>cron(0 10 ? * MON *)</code>". For more information, see <a href="https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html#CronExpressions">Cron Expressions</a> in the <i>Amazon CloudWatch Events User Guide</i>.</p>
    ///   - [`iam_role(Option<String>)`](crate::operation::modify_scheduled_action::ModifyScheduledActionOutput::iam_role): <p>The IAM role to assume to run the scheduled action. This IAM role must have permission to run the Amazon Redshift API operation in the scheduled action. This IAM role must allow the Amazon Redshift scheduler (Principal scheduler.redshift.amazonaws.com) to assume permissions on your behalf. For more information about the IAM role to use with the Amazon Redshift scheduler, see <a href="https://docs.aws.amazon.com/redshift/latest/mgmt/redshift-iam-access-control-identity-based.html">Using Identity-Based Policies for Amazon Redshift</a> in the <i>Amazon Redshift Cluster Management Guide</i>.</p>
    ///   - [`scheduled_action_description(Option<String>)`](crate::operation::modify_scheduled_action::ModifyScheduledActionOutput::scheduled_action_description): <p>The description of the scheduled action.</p>
    ///   - [`state(Option<ScheduledActionState>)`](crate::operation::modify_scheduled_action::ModifyScheduledActionOutput::state): <p>The state of the scheduled action. For example, <code>DISABLED</code>.</p>
    ///   - [`next_invocations(Option<Vec::<DateTime>>)`](crate::operation::modify_scheduled_action::ModifyScheduledActionOutput::next_invocations): <p>List of times when the scheduled action will run.</p>
    ///   - [`start_time(Option<DateTime>)`](crate::operation::modify_scheduled_action::ModifyScheduledActionOutput::start_time): <p>The start time in UTC when the schedule is active. Before this time, the scheduled action does not trigger.</p>
    ///   - [`end_time(Option<DateTime>)`](crate::operation::modify_scheduled_action::ModifyScheduledActionOutput::end_time): <p>The end time in UTC when the schedule is no longer active. After this time, the scheduled action does not trigger.</p>
    /// - On failure, responds with [`SdkError<ModifyScheduledActionError>`](crate::operation::modify_scheduled_action::ModifyScheduledActionError)
    pub fn modify_scheduled_action(&self) -> crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder {
        crate::operation::modify_scheduled_action::builders::ModifyScheduledActionFluentBuilder::new(self.handle.clone())
    }
}