aws_sdk_quicksight/operation/
describe_ip_restriction.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeIpRestriction`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeIpRestriction;
6impl DescribeIpRestriction {
7    /// Creates a new `DescribeIpRestriction`
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_ip_restriction::DescribeIpRestrictionInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_ip_restriction::DescribeIpRestrictionOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_ip_restriction::DescribeIpRestrictionError,
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_ip_restriction::DescribeIpRestrictionError>()
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_ip_restriction::DescribeIpRestrictionOutput>()
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_ip_restriction::DescribeIpRestrictionInput,
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("QuickSight", "DescribeIpRestriction", 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                "QuickSight.DescribeIpRestriction",
59                "rpc.service" = "QuickSight",
60                "rpc.method" = "DescribeIpRestriction",
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        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
74            ::aws_runtime::auth::sigv4::SCHEME_ID,
75        ]));
76        if let ::std::option::Option::Some(config_override) = config_override {
77            for plugin in config_override.runtime_plugins.iter().cloned() {
78                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
79            }
80            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
81                config_override,
82                client_config.config.clone(),
83                &client_config.runtime_components,
84            ));
85        }
86        runtime_plugins
87    }
88}
89impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for DescribeIpRestriction {
90    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
91        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeIpRestriction");
92
93        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
94            DescribeIpRestrictionRequestSerializer,
95        ));
96        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
97            DescribeIpRestrictionResponseDeserializer,
98        ));
99
100        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
101            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
102        ));
103
104        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
105            "DescribeIpRestriction",
106            "QuickSight",
107        ));
108        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
109        signing_options.double_uri_encode = true;
110        signing_options.content_sha256_header = false;
111        signing_options.normalize_uri_path = true;
112        signing_options.payload_override = None;
113
114        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
115            signing_options,
116            ..::std::default::Default::default()
117        });
118
119        ::std::option::Option::Some(cfg.freeze())
120    }
121
122    fn runtime_components(
123        &self,
124        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
125    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
126        #[allow(unused_mut)]
127        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeIpRestriction")
128            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
129            .with_interceptor(DescribeIpRestrictionEndpointParamsInterceptor)
130            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
131                crate::operation::describe_ip_restriction::DescribeIpRestrictionError,
132            >::new())
133            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
134                crate::operation::describe_ip_restriction::DescribeIpRestrictionError,
135            >::new())
136            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
137                crate::operation::describe_ip_restriction::DescribeIpRestrictionError,
138            >::new());
139
140        ::std::borrow::Cow::Owned(rcb)
141    }
142}
143
144#[derive(Debug)]
145struct DescribeIpRestrictionResponseDeserializer;
146impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeIpRestrictionResponseDeserializer {
147    fn deserialize_nonstreaming(
148        &self,
149        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
150    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
151        let (success, status) = (response.status().is_success(), response.status().as_u16());
152        let headers = response.headers();
153        let body = response.body().bytes().expect("body loaded");
154        #[allow(unused_mut)]
155        let mut force_error = false;
156        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
157        let parse_result = if !success && status != 200 || force_error {
158            crate::protocol_serde::shape_describe_ip_restriction::de_describe_ip_restriction_http_error(status, headers, body)
159        } else {
160            crate::protocol_serde::shape_describe_ip_restriction::de_describe_ip_restriction_http_response(status, headers, body)
161        };
162        crate::protocol_serde::type_erase_result(parse_result)
163    }
164}
165#[derive(Debug)]
166struct DescribeIpRestrictionRequestSerializer;
167impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeIpRestrictionRequestSerializer {
168    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
169    fn serialize_input(
170        &self,
171        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
172        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
173    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
174        let input = input
175            .downcast::<crate::operation::describe_ip_restriction::DescribeIpRestrictionInput>()
176            .expect("correct type");
177        let _header_serialization_settings = _cfg
178            .load::<crate::serialization_settings::HeaderSerializationSettings>()
179            .cloned()
180            .unwrap_or_default();
181        let mut request_builder = {
182            fn uri_base(
183                _input: &crate::operation::describe_ip_restriction::DescribeIpRestrictionInput,
184                output: &mut ::std::string::String,
185            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
186                use ::std::fmt::Write as _;
187                let input_1 = &_input.aws_account_id;
188                let input_1 = input_1
189                    .as_ref()
190                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("aws_account_id", "cannot be empty or unset"))?;
191                let aws_account_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
192                if aws_account_id.is_empty() {
193                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
194                        "aws_account_id",
195                        "cannot be empty or unset",
196                    ));
197                }
198                ::std::write!(output, "/accounts/{AwsAccountId}/ip-restriction", AwsAccountId = aws_account_id).expect("formatting should succeed");
199                ::std::result::Result::Ok(())
200            }
201            #[allow(clippy::unnecessary_wraps)]
202            fn update_http_builder(
203                input: &crate::operation::describe_ip_restriction::DescribeIpRestrictionInput,
204                builder: ::http::request::Builder,
205            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
206                let mut uri = ::std::string::String::new();
207                uri_base(input, &mut uri)?;
208                ::std::result::Result::Ok(builder.method("GET").uri(uri))
209            }
210            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
211            builder
212        };
213        let body = ::aws_smithy_types::body::SdkBody::from("");
214
215        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
216    }
217}
218#[derive(Debug)]
219struct DescribeIpRestrictionEndpointParamsInterceptor;
220
221impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeIpRestrictionEndpointParamsInterceptor {
222    fn name(&self) -> &'static str {
223        "DescribeIpRestrictionEndpointParamsInterceptor"
224    }
225
226    fn read_before_execution(
227        &self,
228        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
229            '_,
230            ::aws_smithy_runtime_api::client::interceptors::context::Input,
231            ::aws_smithy_runtime_api::client::interceptors::context::Output,
232            ::aws_smithy_runtime_api::client::interceptors::context::Error,
233        >,
234        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
235    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
236        let _input = context
237            .input()
238            .downcast_ref::<DescribeIpRestrictionInput>()
239            .ok_or("failed to downcast to DescribeIpRestrictionInput")?;
240
241        let params = crate::config::endpoint::Params::builder()
242            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
243            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
244            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
245            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
246            .build()
247            .map_err(|err| {
248                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
249            })?;
250        cfg.interceptor_state()
251            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
252        ::std::result::Result::Ok(())
253    }
254}
255
256// The get_* functions below are generated from JMESPath expressions in the
257// operationContextParams trait. They target the operation's input shape.
258
259/// Error type for the `DescribeIpRestrictionError` operation.
260#[non_exhaustive]
261#[derive(::std::fmt::Debug)]
262pub enum DescribeIpRestrictionError {
263    /// <p>You don't have access to this item. The provided credentials couldn't be validated. You might not be authorized to carry out the request. Make sure that your account is authorized to use the Amazon QuickSight service, that your policies have the correct permissions, and that you are using the correct credentials.</p>
264    AccessDeniedException(crate::types::error::AccessDeniedException),
265    /// <p>An internal failure occurred.</p>
266    InternalFailureException(crate::types::error::InternalFailureException),
267    /// <p>One or more parameters has a value that isn't valid.</p>
268    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
269    /// <p>One or more resources can't be found.</p>
270    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
271    /// <p>Access is throttled.</p>
272    ThrottlingException(crate::types::error::ThrottlingException),
273    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
274    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
275    variable wildcard pattern and check `.code()`:
276     \
277    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
278     \
279    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeIpRestrictionError) for what information is available for the error.")]
280    Unhandled(crate::error::sealed_unhandled::Unhandled),
281}
282impl DescribeIpRestrictionError {
283    /// Creates the `DescribeIpRestrictionError::Unhandled` variant from any error type.
284    pub fn unhandled(
285        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
286    ) -> Self {
287        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
288            source: err.into(),
289            meta: ::std::default::Default::default(),
290        })
291    }
292
293    /// Creates the `DescribeIpRestrictionError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
294    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
295        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
296            source: err.clone().into(),
297            meta: err,
298        })
299    }
300    ///
301    /// Returns error metadata, which includes the error code, message,
302    /// request ID, and potentially additional information.
303    ///
304    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
305        match self {
306            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
307            Self::InternalFailureException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
308            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
309            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
310            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
311            Self::Unhandled(e) => &e.meta,
312        }
313    }
314    /// Returns `true` if the error kind is `DescribeIpRestrictionError::AccessDeniedException`.
315    pub fn is_access_denied_exception(&self) -> bool {
316        matches!(self, Self::AccessDeniedException(_))
317    }
318    /// Returns `true` if the error kind is `DescribeIpRestrictionError::InternalFailureException`.
319    pub fn is_internal_failure_exception(&self) -> bool {
320        matches!(self, Self::InternalFailureException(_))
321    }
322    /// Returns `true` if the error kind is `DescribeIpRestrictionError::InvalidParameterValueException`.
323    pub fn is_invalid_parameter_value_exception(&self) -> bool {
324        matches!(self, Self::InvalidParameterValueException(_))
325    }
326    /// Returns `true` if the error kind is `DescribeIpRestrictionError::ResourceNotFoundException`.
327    pub fn is_resource_not_found_exception(&self) -> bool {
328        matches!(self, Self::ResourceNotFoundException(_))
329    }
330    /// Returns `true` if the error kind is `DescribeIpRestrictionError::ThrottlingException`.
331    pub fn is_throttling_exception(&self) -> bool {
332        matches!(self, Self::ThrottlingException(_))
333    }
334}
335impl ::std::error::Error for DescribeIpRestrictionError {
336    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
337        match self {
338            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
339            Self::InternalFailureException(_inner) => ::std::option::Option::Some(_inner),
340            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
341            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
342            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
343            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
344        }
345    }
346}
347impl ::std::fmt::Display for DescribeIpRestrictionError {
348    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
349        match self {
350            Self::AccessDeniedException(_inner) => _inner.fmt(f),
351            Self::InternalFailureException(_inner) => _inner.fmt(f),
352            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
353            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
354            Self::ThrottlingException(_inner) => _inner.fmt(f),
355            Self::Unhandled(_inner) => {
356                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
357                    write!(f, "unhandled error ({code})")
358                } else {
359                    f.write_str("unhandled error")
360                }
361            }
362        }
363    }
364}
365impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeIpRestrictionError {
366    fn code(&self) -> ::std::option::Option<&str> {
367        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
368    }
369    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
370        ::std::option::Option::None
371    }
372}
373impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeIpRestrictionError {
374    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
375        match self {
376            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
377            Self::InternalFailureException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
378            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
379            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
380            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
381            Self::Unhandled(_inner) => &_inner.meta,
382        }
383    }
384}
385impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeIpRestrictionError {
386    fn create_unhandled_error(
387        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
388        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
389    ) -> Self {
390        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
391            source,
392            meta: meta.unwrap_or_default(),
393        })
394    }
395}
396impl ::aws_types::request_id::RequestId for crate::operation::describe_ip_restriction::DescribeIpRestrictionError {
397    fn request_id(&self) -> Option<&str> {
398        self.meta().request_id()
399    }
400}
401
402pub use crate::operation::describe_ip_restriction::_describe_ip_restriction_output::DescribeIpRestrictionOutput;
403
404pub use crate::operation::describe_ip_restriction::_describe_ip_restriction_input::DescribeIpRestrictionInput;
405
406mod _describe_ip_restriction_input;
407
408mod _describe_ip_restriction_output;
409
410/// Builders
411pub mod builders;
aws_sdk_quicksight/operation/describe_ip_restriction.rs

aws_sdk_quicksight/operation/
describe_ip_restriction.rs
