aws_sdk_computeoptimizerautomation/client/
get_automation_rule.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 [`GetAutomationRule`](crate::operation::get_automation_rule::builders::GetAutomationRuleFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`rule_arn(impl Into<String>)`](crate::operation::get_automation_rule::builders::GetAutomationRuleFluentBuilder::rule_arn) / [`set_rule_arn(Option<String>)`](crate::operation::get_automation_rule::builders::GetAutomationRuleFluentBuilder::set_rule_arn):<br>required: **true**<br><p>The ARN of the rule to retrieve.</p><br>
7    /// - On success, responds with [`GetAutomationRuleOutput`](crate::operation::get_automation_rule::GetAutomationRuleOutput) with field(s):
8    ///   - [`rule_arn(Option<String>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::rule_arn): <p>The Amazon Resource Name (ARN) of the automation rule.</p>
9    ///   - [`rule_id(Option<String>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::rule_id): <p>The unique identifier of the automation rule.</p>
10    ///   - [`name(Option<String>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::name): <p>The name of the automation rule.</p>
11    ///   - [`description(Option<String>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::description): <p>A description of the automation rule.</p>
12    ///   - [`rule_type(Option<RuleType>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::rule_type): <p>The type of automation rule.</p>
13    ///   - [`rule_revision(Option<i64>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::rule_revision): <p>The revision number of the automation rule.</p>
14    ///   - [`account_id(Option<String>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::account_id): <p>The 12-digit Amazon Web Services account ID that owns this automation rule.</p>
15    ///   - [`organization_configuration(Option<OrganizationConfiguration>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::organization_configuration): <p>Configuration settings for organization-wide automation rules.</p>
16    ///   - [`priority(Option<String>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::priority): <p>A string representation of a decimal number between 0 and 1 (having up to 30 digits after the decimal point) that determines the priority of the rule.</p>
17    ///   - [`recommended_action_types(Option<Vec::<RecommendedActionType>>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::recommended_action_types): <p>List of recommended action types that this rule can execute.</p>
18    ///   - [`criteria(Option<Criteria>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::criteria): <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>
19    ///   - [`schedule(Option<Schedule>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::schedule): <p>Configuration for scheduling when automation rules should execute, including timing and execution windows.</p>
20    ///   - [`status(Option<RuleStatus>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::status): <p>The current status of the automation rule (Active or Inactive).</p>
21    ///   - [`tags(Option<Vec::<Tag>>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::tags): <p>The tags associated with the automation rule.</p>
22    ///   - [`created_timestamp(Option<DateTime>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::created_timestamp): <p>The timestamp when the automation rule was created.</p>
23    ///   - [`last_updated_timestamp(Option<DateTime>)`](crate::operation::get_automation_rule::GetAutomationRuleOutput::last_updated_timestamp): <p>The timestamp when the automation rule was last updated.</p>
24    /// - On failure, responds with [`SdkError<GetAutomationRuleError>`](crate::operation::get_automation_rule::GetAutomationRuleError)
25    pub fn get_automation_rule(&self) -> crate::operation::get_automation_rule::builders::GetAutomationRuleFluentBuilder {
26        crate::operation::get_automation_rule::builders::GetAutomationRuleFluentBuilder::new(self.handle.clone())
27    }
28}