aws_sdk_wafv2/operation/
get_ip_set.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetIPSet`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetIPSet;
6impl GetIPSet {
7    /// Creates a new `GetIPSet`
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::get_ip_set::GetIpSetInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_ip_set::GetIpSetOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_ip_set::GetIPSetError,
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| err.downcast::<crate::operation::get_ip_set::GetIPSetError>().expect("correct error type"))
26        };
27        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
28            .await
29            .map_err(map_err)?;
30        let output = context.finalize().map_err(map_err)?;
31        ::std::result::Result::Ok(
32            output
33                .downcast::<crate::operation::get_ip_set::GetIpSetOutput>()
34                .expect("correct output type"),
35        )
36    }
37
38    pub(crate) async fn orchestrate_with_stop_point(
39        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
40        input: crate::operation::get_ip_set::GetIpSetInput,
41        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
42    ) -> ::std::result::Result<
43        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
44        ::aws_smithy_runtime_api::client::result::SdkError<
45            ::aws_smithy_runtime_api::client::interceptors::context::Error,
46            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
47        >,
48    > {
49        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
50        use ::tracing::Instrument;
51        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("WAFV2", "GetIPSet", input, runtime_plugins, stop_point)
52            // Create a parent span for the entire operation. Includes a random, internal-only,
53            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
54            .instrument(::tracing::debug_span!(
55                "WAFV2.GetIPSet",
56                "rpc.service" = "WAFV2",
57                "rpc.method" = "GetIPSet",
58                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
59                "rpc.system" = "aws-api",
60            ))
61            .await
62    }
63
64    pub(crate) fn operation_runtime_plugins(
65        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
66        client_config: &crate::config::Config,
67        config_override: ::std::option::Option<crate::config::Builder>,
68    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
69        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
70
71        if let ::std::option::Option::Some(config_override) = config_override {
72            for plugin in config_override.runtime_plugins.iter().cloned() {
73                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
74            }
75            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
76                config_override,
77                client_config.config.clone(),
78                &client_config.runtime_components,
79            ));
80        }
81        runtime_plugins
82    }
83}
84impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for GetIPSet {
85    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
86        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetIPSet");
87
88        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
89            GetIPSetRequestSerializer,
90        ));
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
92            GetIPSetResponseDeserializer,
93        ));
94
95        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
96            crate::config::auth::Params::builder()
97                .operation_name("GetIPSet")
98                .build()
99                .expect("required fields set"),
100        ));
101
102        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("GetIPSet", "WAFV2"));
103        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
104        signing_options.double_uri_encode = true;
105        signing_options.content_sha256_header = false;
106        signing_options.normalize_uri_path = true;
107        signing_options.payload_override = None;
108
109        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
110            signing_options,
111            ..::std::default::Default::default()
112        });
113
114        ::std::option::Option::Some(cfg.freeze())
115    }
116
117    fn runtime_components(
118        &self,
119        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
120    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
121        #[allow(unused_mut)]
122        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetIPSet")
123            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
124            .with_interceptor(GetIPSetEndpointParamsInterceptor)
125            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
126                crate::operation::get_ip_set::GetIPSetError,
127            >::new())
128            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
129                crate::operation::get_ip_set::GetIPSetError,
130            >::new())
131            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
132                crate::operation::get_ip_set::GetIPSetError,
133            >::new());
134
135        ::std::borrow::Cow::Owned(rcb)
136    }
137}
138
139#[derive(Debug)]
140struct GetIPSetResponseDeserializer;
141impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetIPSetResponseDeserializer {
142    fn deserialize_nonstreaming(
143        &self,
144        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
145    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
146        let (success, status) = (response.status().is_success(), response.status().as_u16());
147        let headers = response.headers();
148        let body = response.body().bytes().expect("body loaded");
149        #[allow(unused_mut)]
150        let mut force_error = false;
151        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
152        let parse_result = if !success && status != 200 || force_error {
153            crate::protocol_serde::shape_get_ip_set::de_get_ip_set_http_error(status, headers, body)
154        } else {
155            crate::protocol_serde::shape_get_ip_set::de_get_ip_set_http_response(status, headers, body)
156        };
157        crate::protocol_serde::type_erase_result(parse_result)
158    }
159}
160#[derive(Debug)]
161struct GetIPSetRequestSerializer;
162impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetIPSetRequestSerializer {
163    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
164    fn serialize_input(
165        &self,
166        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
167        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
168    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
169        let input = input.downcast::<crate::operation::get_ip_set::GetIpSetInput>().expect("correct type");
170        let _header_serialization_settings = _cfg
171            .load::<crate::serialization_settings::HeaderSerializationSettings>()
172            .cloned()
173            .unwrap_or_default();
174        let mut request_builder = {
175            fn uri_base(
176                _input: &crate::operation::get_ip_set::GetIpSetInput,
177                output: &mut ::std::string::String,
178            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
179                use ::std::fmt::Write as _;
180                ::std::write!(output, "/").expect("formatting should succeed");
181                ::std::result::Result::Ok(())
182            }
183            #[allow(clippy::unnecessary_wraps)]
184            fn update_http_builder(
185                input: &crate::operation::get_ip_set::GetIpSetInput,
186                builder: ::http::request::Builder,
187            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
188                let mut uri = ::std::string::String::new();
189                uri_base(input, &mut uri)?;
190                ::std::result::Result::Ok(builder.method("POST").uri(uri))
191            }
192            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
193            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
194            builder = _header_serialization_settings.set_default_header(
195                builder,
196                ::http::header::HeaderName::from_static("x-amz-target"),
197                "AWSWAF_20190729.GetIPSet",
198            );
199            builder
200        };
201        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_get_ip_set::ser_get_ip_set_input(&input)?);
202        if let Some(content_length) = body.content_length() {
203            let content_length = content_length.to_string();
204            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
205        }
206        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
207    }
208}
209#[derive(Debug)]
210struct GetIPSetEndpointParamsInterceptor;
211
212impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetIPSetEndpointParamsInterceptor {
213    fn name(&self) -> &'static str {
214        "GetIPSetEndpointParamsInterceptor"
215    }
216
217    fn read_before_execution(
218        &self,
219        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
220            '_,
221            ::aws_smithy_runtime_api::client::interceptors::context::Input,
222            ::aws_smithy_runtime_api::client::interceptors::context::Output,
223            ::aws_smithy_runtime_api::client::interceptors::context::Error,
224        >,
225        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
226    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
227        let _input = context
228            .input()
229            .downcast_ref::<GetIpSetInput>()
230            .ok_or("failed to downcast to GetIpSetInput")?;
231
232        let params = crate::config::endpoint::Params::builder()
233            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
234            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
235            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
236            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
237            .build()
238            .map_err(|err| {
239                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
240            })?;
241        cfg.interceptor_state()
242            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
243        ::std::result::Result::Ok(())
244    }
245}
246
247// The get_* functions below are generated from JMESPath expressions in the
248// operationContextParams trait. They target the operation's input shape.
249
250/// Error type for the `GetIPSetError` operation.
251#[non_exhaustive]
252#[derive(::std::fmt::Debug)]
253pub enum GetIPSetError {
254    /// <p>Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.</p>
255    WafInternalErrorException(crate::types::error::WafInternalErrorException),
256    /// <p>The operation isn't valid.</p>
257    WafInvalidOperationException(crate::types::error::WafInvalidOperationException),
258    /// <p>The operation failed because WAF didn't recognize a parameter in the request. For example:</p>
259    /// <ul>
260    /// <li>
261    /// <p>You specified a parameter name or value that isn't valid.</p></li>
262    /// <li>
263    /// <p>Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.</p></li>
264    /// <li>
265    /// <p>You tried to update a <code>WebACL</code> with a <code>DefaultAction</code> that isn't among the types available at <code>DefaultAction</code>.</p></li>
266    /// <li>
267    /// <p>Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.</p></li>
268    /// </ul>
269    WafInvalidParameterException(crate::types::error::WafInvalidParameterException),
270    /// <p>WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.</p>
271    WafNonexistentItemException(crate::types::error::WafNonexistentItemException),
272    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
273    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
274    variable wildcard pattern and check `.code()`:
275     \
276    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
277     \
278    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetIPSetError) for what information is available for the error.")]
279    Unhandled(crate::error::sealed_unhandled::Unhandled),
280}
281impl GetIPSetError {
282    /// Creates the `GetIPSetError::Unhandled` variant from any error type.
283    pub fn unhandled(
284        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
285    ) -> Self {
286        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
287            source: err.into(),
288            meta: ::std::default::Default::default(),
289        })
290    }
291
292    /// Creates the `GetIPSetError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
293    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
294        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
295            source: err.clone().into(),
296            meta: err,
297        })
298    }
299    ///
300    /// Returns error metadata, which includes the error code, message,
301    /// request ID, and potentially additional information.
302    ///
303    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
304        match self {
305            Self::WafInternalErrorException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
306            Self::WafInvalidOperationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
307            Self::WafInvalidParameterException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
308            Self::WafNonexistentItemException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
309            Self::Unhandled(e) => &e.meta,
310        }
311    }
312    /// Returns `true` if the error kind is `GetIPSetError::WafInternalErrorException`.
313    pub fn is_waf_internal_error_exception(&self) -> bool {
314        matches!(self, Self::WafInternalErrorException(_))
315    }
316    /// Returns `true` if the error kind is `GetIPSetError::WafInvalidOperationException`.
317    pub fn is_waf_invalid_operation_exception(&self) -> bool {
318        matches!(self, Self::WafInvalidOperationException(_))
319    }
320    /// Returns `true` if the error kind is `GetIPSetError::WafInvalidParameterException`.
321    pub fn is_waf_invalid_parameter_exception(&self) -> bool {
322        matches!(self, Self::WafInvalidParameterException(_))
323    }
324    /// Returns `true` if the error kind is `GetIPSetError::WafNonexistentItemException`.
325    pub fn is_waf_nonexistent_item_exception(&self) -> bool {
326        matches!(self, Self::WafNonexistentItemException(_))
327    }
328}
329impl ::std::error::Error for GetIPSetError {
330    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
331        match self {
332            Self::WafInternalErrorException(_inner) => ::std::option::Option::Some(_inner),
333            Self::WafInvalidOperationException(_inner) => ::std::option::Option::Some(_inner),
334            Self::WafInvalidParameterException(_inner) => ::std::option::Option::Some(_inner),
335            Self::WafNonexistentItemException(_inner) => ::std::option::Option::Some(_inner),
336            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
337        }
338    }
339}
340impl ::std::fmt::Display for GetIPSetError {
341    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
342        match self {
343            Self::WafInternalErrorException(_inner) => _inner.fmt(f),
344            Self::WafInvalidOperationException(_inner) => _inner.fmt(f),
345            Self::WafInvalidParameterException(_inner) => _inner.fmt(f),
346            Self::WafNonexistentItemException(_inner) => _inner.fmt(f),
347            Self::Unhandled(_inner) => {
348                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
349                    write!(f, "unhandled error ({code})")
350                } else {
351                    f.write_str("unhandled error")
352                }
353            }
354        }
355    }
356}
357impl ::aws_smithy_types::retry::ProvideErrorKind for GetIPSetError {
358    fn code(&self) -> ::std::option::Option<&str> {
359        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
360    }
361    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
362        ::std::option::Option::None
363    }
364}
365impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetIPSetError {
366    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
367        match self {
368            Self::WafInternalErrorException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
369            Self::WafInvalidOperationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
370            Self::WafInvalidParameterException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
371            Self::WafNonexistentItemException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
372            Self::Unhandled(_inner) => &_inner.meta,
373        }
374    }
375}
376impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetIPSetError {
377    fn create_unhandled_error(
378        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
379        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
380    ) -> Self {
381        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
382            source,
383            meta: meta.unwrap_or_default(),
384        })
385    }
386}
387impl ::aws_types::request_id::RequestId for crate::operation::get_ip_set::GetIPSetError {
388    fn request_id(&self) -> Option<&str> {
389        self.meta().request_id()
390    }
391}
392
393pub use crate::operation::get_ip_set::_get_ip_set_output::GetIpSetOutput;
394
395pub use crate::operation::get_ip_set::_get_ip_set_input::GetIpSetInput;
396
397mod _get_ip_set_input;
398
399mod _get_ip_set_output;
400
401/// Builders
402pub mod builders;
aws_sdk_wafv2/operation/get_ip_set.rs

aws_sdk_wafv2/operation/
get_ip_set.rs
