Skip to main content

aws_sdk_networkfirewall/operation/
describe_rule_group.rs

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