aws_sdk_computeoptimizerautomation/client/

list_automation_rule_preview.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ListAutomationRulePreview`](crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder) operation.
    /// This operation supports pagination; See [`into_paginator()`](crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder::into_paginator).
    ///
    /// - The fluent builder is configurable:
    ///   - [`rule_type(RuleType)`](crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder::rule_type) / [`set_rule_type(Option<RuleType>)`](crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder::set_rule_type):<br>required: **true**<br><p>The type of rule.</p><note>  <p>Only the management account or a delegated administrator can set the ruleType to be OrganizationRule.</p> </note><br>
    ///   - [`organization_scope(OrganizationScope)`](crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder::organization_scope) / [`set_organization_scope(Option<OrganizationScope>)`](crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder::set_organization_scope):<br>required: **false**<br><p>The organizational scope for the rule preview.</p><br>
    ///   - [`recommended_action_types(RecommendedActionType)`](crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder::recommended_action_types) / [`set_recommended_action_types(Option<Vec::<RecommendedActionType>>)`](crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder::set_recommended_action_types):<br>required: **true**<br><p>The types of recommended actions to include in the preview.</p><br>
    ///   - [`criteria(Criteria)`](crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder::criteria) / [`set_criteria(Option<Criteria>)`](crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder::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.</p><br>
    ///   - [`max_results(i32)`](crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder::max_results) / [`set_max_results(Option<i32>)`](crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder::set_max_results):<br>required: **false**<br><p>The maximum number of automation rule preview results to return in a single response. Valid range is 1-1000.</p><br>
    ///   - [`next_token(impl Into<String>)`](crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder::next_token) / [`set_next_token(Option<String>)`](crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder::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>
    /// - On success, responds with [`ListAutomationRulePreviewOutput`](crate::operation::list_automation_rule_preview::ListAutomationRulePreviewOutput) with field(s):
    ///   - [`preview_results(Option<Vec::<PreviewResult>>)`](crate::operation::list_automation_rule_preview::ListAutomationRulePreviewOutput::preview_results): <p>The list of actions that would be taken based on the specified criteria.</p>
    ///   - [`next_token(Option<String>)`](crate::operation::list_automation_rule_preview::ListAutomationRulePreviewOutput::next_token): <p>A token used for pagination. If present, indicates there are more results available and can be used in subsequent requests.</p>
    /// - On failure, responds with [`SdkError<ListAutomationRulePreviewError>`](crate::operation::list_automation_rule_preview::ListAutomationRulePreviewError)
    pub fn list_automation_rule_preview(&self) -> crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder {
        crate::operation::list_automation_rule_preview::builders::ListAutomationRulePreviewFluentBuilder::new(self.handle.clone())
    }
}