aws_sdk_networkfirewall/client/

describe_proxy_rule_group.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeProxyRuleGroup`](crate::operation::describe_proxy_rule_group::builders::DescribeProxyRuleGroupFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`proxy_rule_group_name(impl Into<String>)`](crate::operation::describe_proxy_rule_group::builders::DescribeProxyRuleGroupFluentBuilder::proxy_rule_group_name) / [`set_proxy_rule_group_name(Option<String>)`](crate::operation::describe_proxy_rule_group::builders::DescribeProxyRuleGroupFluentBuilder::set_proxy_rule_group_name):<br>required: **false**<br><p>The descriptive name of the proxy rule group. You can't change the name of a proxy rule group after you create it.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
    ///   - [`proxy_rule_group_arn(impl Into<String>)`](crate::operation::describe_proxy_rule_group::builders::DescribeProxyRuleGroupFluentBuilder::proxy_rule_group_arn) / [`set_proxy_rule_group_arn(Option<String>)`](crate::operation::describe_proxy_rule_group::builders::DescribeProxyRuleGroupFluentBuilder::set_proxy_rule_group_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of a proxy rule group.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
    /// - On success, responds with [`DescribeProxyRuleGroupOutput`](crate::operation::describe_proxy_rule_group::DescribeProxyRuleGroupOutput) with field(s):
    ///   - [`proxy_rule_group(Option<ProxyRuleGroup>)`](crate::operation::describe_proxy_rule_group::DescribeProxyRuleGroupOutput::proxy_rule_group): <p>The configuration for the specified proxy rule group.</p>
    ///   - [`update_token(Option<String>)`](crate::operation::describe_proxy_rule_group::DescribeProxyRuleGroupOutput::update_token): <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy rule group. The token marks the state of the proxy rule group resource at the time of the request.</p> <p>To make changes to the proxy rule group, you provide the token in your request. Network Firewall uses the token to ensure that the proxy rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an <code>InvalidTokenException</code>. If this happens, retrieve the proxy rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.</p>
    /// - On failure, responds with [`SdkError<DescribeProxyRuleGroupError>`](crate::operation::describe_proxy_rule_group::DescribeProxyRuleGroupError)
    pub fn describe_proxy_rule_group(&self) -> crate::operation::describe_proxy_rule_group::builders::DescribeProxyRuleGroupFluentBuilder {
        crate::operation::describe_proxy_rule_group::builders::DescribeProxyRuleGroupFluentBuilder::new(self.handle.clone())
    }
}