aws_sdk_networkfirewall/operation/
describe_proxy.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeProxy`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeProxy;
6impl DescribeProxy {
7    /// Creates a new `DescribeProxy`
8    pub fn new() -> Self {
9        Self
10    }
11    pub(crate) async fn orchestrate(
12        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
13        input: crate::operation::describe_proxy::DescribeProxyInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_proxy::DescribeProxyOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_proxy::DescribeProxyError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err = |err: ::aws_smithy_runtime_api::client::result::SdkError<
22            ::aws_smithy_runtime_api::client::interceptors::context::Error,
23            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
24        >| {
25            err.map_service_error(|err| {
26                err.downcast::<crate::operation::describe_proxy::DescribeProxyError>()
27                    .expect("correct error type")
28            })
29        };
30        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
31            .await
32            .map_err(map_err)?;
33        let output = context.finalize().map_err(map_err)?;
34        ::std::result::Result::Ok(
35            output
36                .downcast::<crate::operation::describe_proxy::DescribeProxyOutput>()
37                .expect("correct output type"),
38        )
39    }
40
41    pub(crate) async fn orchestrate_with_stop_point(
42        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
43        input: crate::operation::describe_proxy::DescribeProxyInput,
44        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
45    ) -> ::std::result::Result<
46        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
47        ::aws_smithy_runtime_api::client::result::SdkError<
48            ::aws_smithy_runtime_api::client::interceptors::context::Error,
49            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
50        >,
51    > {
52        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
53        use ::tracing::Instrument;
54        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("Network Firewall", "DescribeProxy", input, runtime_plugins, stop_point)
55            // Create a parent span for the entire operation. Includes a random, internal-only,
56            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
57            .instrument(::tracing::debug_span!(
58                "Network Firewall.DescribeProxy",
59                "rpc.service" = "Network Firewall",
60                "rpc.method" = "DescribeProxy",
61                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
62                "rpc.system" = "aws-api",
63            ))
64            .await
65    }
66
67    pub(crate) fn operation_runtime_plugins(
68        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
69        client_config: &crate::config::Config,
70        config_override: ::std::option::Option<crate::config::Builder>,
71    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
72        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
73
74        if let ::std::option::Option::Some(config_override) = config_override {
75            for plugin in config_override.runtime_plugins.iter().cloned() {
76                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
77            }
78            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
79                config_override,
80                client_config.config.clone(),
81                &client_config.runtime_components,
82            ));
83        }
84        runtime_plugins
85    }
86}
87impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for DescribeProxy {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeProxy");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DescribeProxyRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DescribeProxyResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DescribeProxy")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "DescribeProxy",
107            "Network Firewall",
108        ));
109        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
110        signing_options.double_uri_encode = true;
111        signing_options.content_sha256_header = false;
112        signing_options.normalize_uri_path = true;
113        signing_options.payload_override = None;
114
115        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
116            signing_options,
117            ..::std::default::Default::default()
118        });
119
120        ::std::option::Option::Some(cfg.freeze())
121    }
122
123    fn runtime_components(
124        &self,
125        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
126    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
127        #[allow(unused_mut)]
128        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeProxy")
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                DescribeProxyTelemetryInputCaptureInterceptor,
131            ))
132            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
133                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
134            ))
135            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
136                DescribeProxyEndpointParamsInterceptor,
137            ))
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
139                crate::operation::describe_proxy::DescribeProxyError,
140            >::new())
141            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
142                crate::operation::describe_proxy::DescribeProxyError,
143            >::new())
144            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
145                crate::operation::describe_proxy::DescribeProxyError,
146            >::new());
147
148        ::std::borrow::Cow::Owned(rcb)
149    }
150}
151
152#[derive(Debug)]
153struct DescribeProxyTelemetryInputCaptureInterceptor;
154
155#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
156impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeProxyTelemetryInputCaptureInterceptor {
157    fn name(&self) -> &'static str {
158        "DescribeProxyTelemetryInputCaptureInterceptor"
159    }
160
161    fn read_before_execution(
162        &self,
163        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
164            '_,
165            ::aws_smithy_runtime_api::client::interceptors::context::Input,
166            ::aws_smithy_runtime_api::client::interceptors::context::Output,
167            ::aws_smithy_runtime_api::client::interceptors::context::Error,
168        >,
169        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
170    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
171        // Nothing to do unless the customer opted in by naming members to record.
172        let ::std::option::Option::Some(requested) = cfg
173            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
174            .filter(|r| !r.is_empty())
175        else {
176            return ::std::result::Result::Ok(());
177        };
178
179        let ::std::option::Option::Some(input) = context.input().downcast_ref::<DescribeProxyInput>() else {
180            // A mismatched input is not this interceptor's concern; skip quietly.
181            return ::std::result::Result::Ok(());
182        };
183
184        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
185        if requested.should_capture("ProxyName") {
186            if let ::std::option::Option::Some(value) = input.proxy_name.as_deref() {
187                captured.insert("ProxyName", value);
188            }
189        }
190        if requested.should_capture("ProxyArn") {
191            if let ::std::option::Option::Some(value) = input.proxy_arn.as_deref() {
192                captured.insert("ProxyArn", value);
193            }
194        }
195
196        cfg.interceptor_state().store_put(captured);
197        ::std::result::Result::Ok(())
198    }
199}
200#[derive(Debug)]
201struct DescribeProxyResponseDeserializer;
202impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeProxyResponseDeserializer {
203    fn deserialize_nonstreaming_with_config(
204        &self,
205        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
206        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
207    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
208        let (success, status) = (response.status().is_success(), response.status().as_u16());
209        let headers = response.headers();
210        let body = response.body().bytes().expect("body loaded");
211        #[allow(unused_mut)]
212        let mut force_error = false;
213        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
214        let parse_result = if !success && status != 200 || force_error {
215            crate::protocol_serde::shape_describe_proxy::de_describe_proxy_http_error(status, headers, body)
216        } else {
217            crate::protocol_serde::shape_describe_proxy::de_describe_proxy_http_response(status, headers, body)
218        };
219        crate::protocol_serde::type_erase_result(parse_result)
220    }
221}
222#[derive(Debug)]
223struct DescribeProxyRequestSerializer;
224impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeProxyRequestSerializer {
225    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
226    fn serialize_input(
227        &self,
228        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
229        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
230    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
231        let input = input
232            .downcast::<crate::operation::describe_proxy::DescribeProxyInput>()
233            .expect("correct type");
234        let _header_serialization_settings = _cfg
235            .load::<crate::serialization_settings::HeaderSerializationSettings>()
236            .cloned()
237            .unwrap_or_default();
238        let mut request_builder = {
239            #[allow(clippy::uninlined_format_args)]
240            fn uri_base(
241                _input: &crate::operation::describe_proxy::DescribeProxyInput,
242                output: &mut ::std::string::String,
243            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
244                use ::std::fmt::Write as _;
245                ::std::write!(output, "/").expect("formatting should succeed");
246                ::std::result::Result::Ok(())
247            }
248            #[allow(clippy::unnecessary_wraps)]
249            fn update_http_builder(
250                input: &crate::operation::describe_proxy::DescribeProxyInput,
251                builder: ::http_1x::request::Builder,
252            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
253                let mut uri = ::std::string::String::new();
254                uri_base(input, &mut uri)?;
255                ::std::result::Result::Ok(builder.method("POST").uri(uri))
256            }
257            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
258            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-amz-json-1.0");
259            builder = _header_serialization_settings.set_default_header(
260                builder,
261                ::http_1x::header::HeaderName::from_static("x-amz-target"),
262                "NetworkFirewall_20201112.DescribeProxy",
263            );
264            builder
265        };
266        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_describe_proxy::ser_describe_proxy_input(&input)?);
267        if let Some(content_length) = body.content_length() {
268            let content_length = content_length.to_string();
269            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
270        }
271        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
272    }
273}
274#[derive(Debug)]
275struct DescribeProxyEndpointParamsInterceptor;
276
277#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
278impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeProxyEndpointParamsInterceptor {
279    fn name(&self) -> &'static str {
280        "DescribeProxyEndpointParamsInterceptor"
281    }
282
283    fn read_before_execution(
284        &self,
285        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
286            '_,
287            ::aws_smithy_runtime_api::client::interceptors::context::Input,
288            ::aws_smithy_runtime_api::client::interceptors::context::Output,
289            ::aws_smithy_runtime_api::client::interceptors::context::Error,
290        >,
291        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
292    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
293        let _input = context
294            .input()
295            .downcast_ref::<DescribeProxyInput>()
296            .ok_or("failed to downcast to DescribeProxyInput")?;
297
298        let params = crate::config::endpoint::Params::builder()
299            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
300            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
301            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
302            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
303            .build()
304            .map_err(|err| {
305                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
306            })?;
307        cfg.interceptor_state()
308            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
309        ::std::result::Result::Ok(())
310    }
311}
312
313// The get_* functions below are generated from JMESPath expressions in the
314// operationContextParams trait. They target the operation's input shape.
315
316/// Error type for the `DescribeProxyError` operation.
317#[non_exhaustive]
318#[derive(::std::fmt::Debug)]
319pub enum DescribeProxyError {
320    /// <p>Your request is valid, but Network Firewall couldn't perform the operation because of a system problem. Retry your request.</p>
321    InternalServerError(crate::types::error::InternalServerError),
322    /// <p>The operation failed because of a problem with your request. Examples include:</p>
323    /// <ul>
324    /// <li>
325    /// <p>You specified an unsupported parameter name or value.</p></li>
326    /// <li>
327    /// <p>You tried to update a property with a value that isn't among the available types.</p></li>
328    /// <li>
329    /// <p>Your request references an ARN that is malformed, or corresponds to a resource that isn't valid in the context of the request.</p></li>
330    /// </ul>
331    InvalidRequestException(crate::types::error::InvalidRequestException),
332    /// <p>Unable to locate a resource using the parameters that you provided.</p>
333    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
334    /// <p>Unable to process the request due to throttling limitations.</p>
335    ThrottlingException(crate::types::error::ThrottlingException),
336    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
337    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
338    variable wildcard pattern and check `.code()`:
339     \
340    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
341     \
342    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeProxyError) for what information is available for the error.")]
343    Unhandled(crate::error::sealed_unhandled::Unhandled),
344}
345impl DescribeProxyError {
346    /// Creates the `DescribeProxyError::Unhandled` variant from any error type.
347    pub fn unhandled(
348        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
349    ) -> Self {
350        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
351            source: err.into(),
352            meta: ::std::default::Default::default(),
353        })
354    }
355
356    /// Creates the `DescribeProxyError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
357    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
358        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
359            source: err.clone().into(),
360            meta: err,
361        })
362    }
363    ///
364    /// Returns error metadata, which includes the error code, message,
365    /// request ID, and potentially additional information.
366    ///
367    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
368        match self {
369            Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
370            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
371            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
372            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
373            Self::Unhandled(e) => &e.meta,
374        }
375    }
376    /// Returns `true` if the error kind is `DescribeProxyError::InternalServerError`.
377    pub fn is_internal_server_error(&self) -> bool {
378        matches!(self, Self::InternalServerError(_))
379    }
380    /// Returns `true` if the error kind is `DescribeProxyError::InvalidRequestException`.
381    pub fn is_invalid_request_exception(&self) -> bool {
382        matches!(self, Self::InvalidRequestException(_))
383    }
384    /// Returns `true` if the error kind is `DescribeProxyError::ResourceNotFoundException`.
385    pub fn is_resource_not_found_exception(&self) -> bool {
386        matches!(self, Self::ResourceNotFoundException(_))
387    }
388    /// Returns `true` if the error kind is `DescribeProxyError::ThrottlingException`.
389    pub fn is_throttling_exception(&self) -> bool {
390        matches!(self, Self::ThrottlingException(_))
391    }
392}
393impl ::std::error::Error for DescribeProxyError {
394    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
395        match self {
396            Self::InternalServerError(_inner) => ::std::option::Option::Some(_inner),
397            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
398            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
399            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
400            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
401        }
402    }
403}
404impl ::std::fmt::Display for DescribeProxyError {
405    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
406        match self {
407            Self::InternalServerError(_inner) => _inner.fmt(f),
408            Self::InvalidRequestException(_inner) => _inner.fmt(f),
409            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
410            Self::ThrottlingException(_inner) => _inner.fmt(f),
411            Self::Unhandled(_inner) => {
412                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
413                    write!(f, "unhandled error ({code})")
414                } else {
415                    f.write_str("unhandled error")
416                }
417            }
418        }
419    }
420}
421impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeProxyError {
422    fn code(&self) -> ::std::option::Option<&str> {
423        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
424    }
425    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
426        ::std::option::Option::None
427    }
428}
429impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeProxyError {
430    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
431        match self {
432            Self::InternalServerError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
433            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
434            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
435            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
436            Self::Unhandled(_inner) => &_inner.meta,
437        }
438    }
439}
440impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeProxyError {
441    fn create_unhandled_error(
442        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
443        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
444    ) -> Self {
445        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
446            source,
447            meta: meta.unwrap_or_default(),
448        })
449    }
450}
451impl ::aws_types::request_id::RequestId for crate::operation::describe_proxy::DescribeProxyError {
452    fn request_id(&self) -> Option<&str> {
453        self.meta().request_id()
454    }
455}
456
457pub use crate::operation::describe_proxy::_describe_proxy_input::DescribeProxyInput;
458
459pub use crate::operation::describe_proxy::_describe_proxy_output::DescribeProxyOutput;
460
461mod _describe_proxy_input;
462
463mod _describe_proxy_output;
464
465/// Builders
466pub mod builders;
aws_sdk_networkfirewall/operation/describe_proxy.rs

aws_sdk_networkfirewall/operation/
describe_proxy.rs
