aws_sdk_networkfirewall/client/

describe_rule_group_summary.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeRuleGroupSummary`](crate::operation::describe_rule_group_summary::builders::DescribeRuleGroupSummaryFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`rule_group_name(impl Into<String>)`](crate::operation::describe_rule_group_summary::builders::DescribeRuleGroupSummaryFluentBuilder::rule_group_name) / [`set_rule_group_name(Option<String>)`](crate::operation::describe_rule_group_summary::builders::DescribeRuleGroupSummaryFluentBuilder::set_rule_group_name):<br>required: **false**<br><p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
    ///   - [`rule_group_arn(impl Into<String>)`](crate::operation::describe_rule_group_summary::builders::DescribeRuleGroupSummaryFluentBuilder::rule_group_arn) / [`set_rule_group_arn(Option<String>)`](crate::operation::describe_rule_group_summary::builders::DescribeRuleGroupSummaryFluentBuilder::set_rule_group_arn):<br>required: **false**<br><p>Required. The Amazon Resource Name (ARN) of the rule group.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
    ///   - [`r#type(RuleGroupType)`](crate::operation::describe_rule_group_summary::builders::DescribeRuleGroupSummaryFluentBuilder::type) / [`set_type(Option<RuleGroupType>)`](crate::operation::describe_rule_group_summary::builders::DescribeRuleGroupSummaryFluentBuilder::set_type):<br>required: **false**<br><p>The type of rule group you want a summary for. This is a required field.</p> <p>Valid value: <code>STATEFUL</code></p> <p>Note that <code>STATELESS</code> exists but is not currently supported. If you provide <code>STATELESS</code>, an exception is returned.</p><br>
    /// - On success, responds with [`DescribeRuleGroupSummaryOutput`](crate::operation::describe_rule_group_summary::DescribeRuleGroupSummaryOutput) with field(s):
    ///   - [`rule_group_name(String)`](crate::operation::describe_rule_group_summary::DescribeRuleGroupSummaryOutput::rule_group_name): <p>The descriptive name of the rule group. You can't change the name of a rule group after you create it.</p>
    ///   - [`description(Option<String>)`](crate::operation::describe_rule_group_summary::DescribeRuleGroupSummaryOutput::description): <p>A description of the rule group.</p>
    ///   - [`summary(Option<Summary>)`](crate::operation::describe_rule_group_summary::DescribeRuleGroupSummaryOutput::summary): <p>A complex type that contains rule information based on the rule group's configured summary settings. The content varies depending on the fields that you specified to extract in your SummaryConfiguration. When you haven't configured any summary settings, this returns an empty array. The response might include:</p> <ul>  <li>   <p>Rule identifiers</p></li>  <li>   <p>Rule descriptions</p></li>  <li>   <p>Any metadata fields that you specified in your SummaryConfiguration</p></li> </ul>
    /// - On failure, responds with [`SdkError<DescribeRuleGroupSummaryError>`](crate::operation::describe_rule_group_summary::DescribeRuleGroupSummaryError)
    pub fn describe_rule_group_summary(&self) -> crate::operation::describe_rule_group_summary::builders::DescribeRuleGroupSummaryFluentBuilder {
        crate::operation::describe_rule_group_summary::builders::DescribeRuleGroupSummaryFluentBuilder::new(self.handle.clone())
    }
}