aws_sdk_computeoptimizerautomation/client/
list_automation_rule_preview_summaries.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 [`ListAutomationRulePreviewSummaries`](crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder) operation.
4    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder::into_paginator).
5    ///
6    /// - The fluent builder is configurable:
7    ///   - [`rule_type(RuleType)`](crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder::rule_type) / [`set_rule_type(Option<RuleType>)`](crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder::set_rule_type):<br>required: **true**<br><p>The type of rule.</p><br>
8    ///   - [`organization_scope(OrganizationScope)`](crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder::organization_scope) / [`set_organization_scope(Option<OrganizationScope>)`](crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder::set_organization_scope):<br>required: **false**<br><p>The organizational scope for the rule preview.</p><br>
9    ///   - [`recommended_action_types(RecommendedActionType)`](crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder::recommended_action_types) / [`set_recommended_action_types(Option<Vec::<RecommendedActionType>>)`](crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder::set_recommended_action_types):<br>required: **true**<br><p>The types of recommended actions to include in the preview.</p><br>
10    ///   - [`criteria(Criteria)`](crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder::criteria) / [`set_criteria(Option<Criteria>)`](crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder::set_criteria):<br>required: **false**<br><p>A set of conditions that specify which recommended action qualify for implementation. When a rule is active and a recommended action matches these criteria, Compute Optimizer implements the action at the scheduled run time. You can specify up to 20 conditions per filter criteria and 20 values per condition.</p><br>
11    ///   - [`max_results(i32)`](crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of automation rule preview summaries to return in a single response. Valid range is 1-1000.</p><br>
12    ///   - [`next_token(impl Into<String>)`](crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder::set_next_token):<br>required: **false**<br><p>A token used for pagination to retrieve the next set of results when the response is truncated.</p><br>
13    /// - On success, responds with [`ListAutomationRulePreviewSummariesOutput`](crate::operation::list_automation_rule_preview_summaries::ListAutomationRulePreviewSummariesOutput) with field(s):
14    ///   - [`preview_result_summaries(Option<Vec::<PreviewResultSummary>>)`](crate::operation::list_automation_rule_preview_summaries::ListAutomationRulePreviewSummariesOutput::preview_result_summaries): <p>The list of automation rule preview summaries that match the specified criteria.</p>
15    ///   - [`next_token(Option<String>)`](crate::operation::list_automation_rule_preview_summaries::ListAutomationRulePreviewSummariesOutput::next_token): <p>A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.</p>
16    /// - On failure, responds with [`SdkError<ListAutomationRulePreviewSummariesError>`](crate::operation::list_automation_rule_preview_summaries::ListAutomationRulePreviewSummariesError)
17    pub fn list_automation_rule_preview_summaries(
18        &self,
19    ) -> crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder {
20        crate::operation::list_automation_rule_preview_summaries::builders::ListAutomationRulePreviewSummariesFluentBuilder::new(self.handle.clone())
21    }
22}