aws_sdk_networksecuritymanager/client/
get_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 [`GetRule`](crate::operation::get_rule::builders::GetRuleFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`rule_identifier(impl Into<String>)`](crate::operation::get_rule::builders::GetRuleFluentBuilder::rule_identifier) / [`set_rule_identifier(Option<String>)`](crate::operation::get_rule::builders::GetRuleFluentBuilder::set_rule_identifier):<br>required: **true**<br><p>The identifier of the rule. This is the rule's Amazon Resource Name (ARN).</p><br>
7    /// - On success, responds with [`GetRuleOutput`](crate::operation::get_rule::GetRuleOutput) with field(s):
8    ///   - [`rule_id(String)`](crate::operation::get_rule::GetRuleOutput::rule_id): <p>The service-generated id of the rule.</p>
9    ///   - [`rule_arn(String)`](crate::operation::get_rule::GetRuleOutput::rule_arn): <p>The Amazon Resource Name (ARN) of the rule.</p>
10    ///   - [`rule_name(String)`](crate::operation::get_rule::GetRuleOutput::rule_name): <p>The name of the rule.</p>
11    ///   - [`firewall_type(RuleFirewallType)`](crate::operation::get_rule::GetRuleOutput::firewall_type): <p>The firewall type associated with the resource.</p>
12    ///   - [`rule_type(Option<RuleType>)`](crate::operation::get_rule::GetRuleOutput::rule_type): <p>The type of the rule. <code>CONFIGURATION</code> rules contain firewall settings, and <code>INSPECTION</code> rules contain rule groups.</p>
13    ///   - [`rule_description(Option<String>)`](crate::operation::get_rule::GetRuleOutput::rule_description): <p>A description of the rule.</p>
14    ///   - [`configuration(Document)`](crate::operation::get_rule::GetRuleOutput::configuration): <p>The firewall configuration for the rule, as a JSON document. The structure depends on the rule's firewall type and rule type.</p>
15    ///   - [`status(EntityStatus)`](crate::operation::get_rule::GetRuleOutput::status): <p>The current status of the resource: <code>DRAFT</code> (unpublished, editable) or <code>ACTIVE</code> (published, in use).</p>
16    ///   - [`version(String)`](crate::operation::get_rule::GetRuleOutput::version): <p>The version of the resource.</p>
17    ///   - [`update_token(Option<String>)`](crate::operation::get_rule::GetRuleOutput::update_token): <p>A token used for optimistic concurrency control. Each read and write returns an <code>updateToken</code>. Provide the most recent value on your next update to detect and prevent conflicting concurrent modifications.</p>
18    ///   - [`is_snapshot(Option<bool>)`](crate::operation::get_rule::GetRuleOutput::is_snapshot): <p>Specifies whether the resource is a snapshot of a published version.</p>
19    ///   - [`has_published_version(Option<bool>)`](crate::operation::get_rule::GetRuleOutput::has_published_version): <p>Specifies whether a published version of the resource exists.</p>
20    ///   - [`updated_at(Option<DateTime>)`](crate::operation::get_rule::GetRuleOutput::updated_at): <p>The time when the resource was last updated.</p>
21    /// - On failure, responds with [`SdkError<GetRuleError>`](crate::operation::get_rule::GetRuleError)
22    pub fn get_rule(&self) -> crate::operation::get_rule::builders::GetRuleFluentBuilder {
23        crate::operation::get_rule::builders::GetRuleFluentBuilder::new(self.handle.clone())
24    }
25}
aws_sdk_networksecuritymanager/client/get_rule.rs

aws_sdk_networksecuritymanager/client/
get_rule.rs
