aws_sdk_redshift/client/
describe_scheduled_actions.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 [`DescribeScheduledActions`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`scheduled_action_name(impl Into<String>)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::scheduled_action_name) / [`set_scheduled_action_name(Option<String>)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::set_scheduled_action_name):<br>required: **false**<br><p>The name of the scheduled action to retrieve.</p><br>
8    ///   - [`target_action_type(ScheduledActionTypeValues)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::target_action_type) / [`set_target_action_type(Option<ScheduledActionTypeValues>)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::set_target_action_type):<br>required: **false**<br><p>The type of the scheduled actions to retrieve.</p><br>
9    ///   - [`start_time(DateTime)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::start_time) / [`set_start_time(Option<DateTime>)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::set_start_time):<br>required: **false**<br><p>The start time in UTC of the scheduled actions to retrieve. Only active scheduled actions that have invocations after this time are retrieved.</p><br>
10    ///   - [`end_time(DateTime)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::end_time) / [`set_end_time(Option<DateTime>)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::set_end_time):<br>required: **false**<br><p>The end time in UTC of the scheduled action to retrieve. Only active scheduled actions that have invocations before this time are retrieved.</p><br>
11    ///   - [`active(bool)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::active) / [`set_active(Option<bool>)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::set_active):<br>required: **false**<br><p>If true, retrieve only active scheduled actions. If false, retrieve only disabled scheduled actions.</p><br>
12    ///   - [`filters(ScheduledActionFilter)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::filters) / [`set_filters(Option<Vec::<ScheduledActionFilter>>)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::set_filters):<br>required: **false**<br><p>List of scheduled action filters.</p><br>
13    ///   - [`marker(impl Into<String>)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::marker) / [`set_marker(Option<String>)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::set_marker):<br>required: **false**<br><p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <code>DescribeScheduledActions</code> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request.</p><br>
14    ///   - [`max_records(i32)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::max_records) / [`set_max_records(Option<i32>)`](crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::set_max_records):<br>required: **false**<br><p>The maximum number of response records to return in each call. If the number of remaining response records exceeds the specified <code>MaxRecords</code> value, a value is returned in a <code>marker</code> field of the response. You can retrieve the next set of records by retrying the command with the returned marker value.</p> <p>Default: <code>100</code></p> <p>Constraints: minimum 20, maximum 100.</p><br>
15    /// - On success, responds with [`DescribeScheduledActionsOutput`](crate::operation::describe_scheduled_actions::DescribeScheduledActionsOutput) with field(s):
16    ///   - [`marker(Option<String>)`](crate::operation::describe_scheduled_actions::DescribeScheduledActionsOutput::marker): <p>An optional parameter that specifies the starting point to return a set of response records. When the results of a <code>DescribeScheduledActions</code> request exceed the value specified in <code>MaxRecords</code>, Amazon Web Services returns a value in the <code>Marker</code> field of the response. You can retrieve the next set of response records by providing the returned marker value in the <code>Marker</code> parameter and retrying the request.</p>
17    ///   - [`scheduled_actions(Option<Vec::<ScheduledAction>>)`](crate::operation::describe_scheduled_actions::DescribeScheduledActionsOutput::scheduled_actions): <p>List of retrieved scheduled actions.</p>
18    /// - On failure, responds with [`SdkError<DescribeScheduledActionsError>`](crate::operation::describe_scheduled_actions::DescribeScheduledActionsError)
19    pub fn describe_scheduled_actions(&self) -> crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder {
20        crate::operation::describe_scheduled_actions::builders::DescribeScheduledActionsFluentBuilder::new(self.handle.clone())
21    }
22}