aws_sdk_networkfirewall/client/

describe_proxy.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`DescribeProxy`](crate::operation::describe_proxy::builders::DescribeProxyFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`proxy_name(impl Into<String>)`](crate::operation::describe_proxy::builders::DescribeProxyFluentBuilder::proxy_name) / [`set_proxy_name(Option<String>)`](crate::operation::describe_proxy::builders::DescribeProxyFluentBuilder::set_proxy_name):<br>required: **false**<br><p>The descriptive name of the proxy. You can't change the name of a proxy after you create it.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
    ///   - [`proxy_arn(impl Into<String>)`](crate::operation::describe_proxy::builders::DescribeProxyFluentBuilder::proxy_arn) / [`set_proxy_arn(Option<String>)`](crate::operation::describe_proxy::builders::DescribeProxyFluentBuilder::set_proxy_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of a proxy.</p> <p>You must specify the ARN or the name, and you can specify both.</p><br>
    /// - On success, responds with [`DescribeProxyOutput`](crate::operation::describe_proxy::DescribeProxyOutput) with field(s):
    ///   - [`proxy(Option<DescribeProxyResource>)`](crate::operation::describe_proxy::DescribeProxyOutput::proxy): <p>Proxy attached to a NAT gateway.</p>
    ///   - [`update_token(Option<String>)`](crate::operation::describe_proxy::DescribeProxyOutput::update_token): <p>A token used for optimistic locking. Network Firewall returns a token to your requests that access the proxy. The token marks the state of the proxy resource at the time of the request.</p> <p>To make changes to the proxy, you provide the token in your request. Network Firewall uses the token to ensure that the proxy 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 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<DescribeProxyError>`](crate::operation::describe_proxy::DescribeProxyError)
    pub fn describe_proxy(&self) -> crate::operation::describe_proxy::builders::DescribeProxyFluentBuilder {
        crate::operation::describe_proxy::builders::DescribeProxyFluentBuilder::new(self.handle.clone())
    }
}