aws_sdk_iotsitewise/operation/
describe_gateway_capability_configuration.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeGatewayCapabilityConfiguration`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeGatewayCapabilityConfiguration;
6impl DescribeGatewayCapabilityConfiguration {
7    /// Creates a new `DescribeGatewayCapabilityConfiguration`
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_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationError,
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_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationError>()
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_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationOutput>()
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_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationInput,
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            "IoTSiteWise",
56            "DescribeGatewayCapabilityConfiguration",
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            "IoTSiteWise.DescribeGatewayCapabilityConfiguration",
65            "rpc.service" = "IoTSiteWise",
66            "rpc.method" = "DescribeGatewayCapabilityConfiguration",
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 DescribeGatewayCapabilityConfiguration {
94    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
95        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeGatewayCapabilityConfiguration");
96
97        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
98            DescribeGatewayCapabilityConfigurationRequestSerializer,
99        ));
100        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
101            DescribeGatewayCapabilityConfigurationResponseDeserializer,
102        ));
103
104        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
105            crate::config::auth::Params::builder()
106                .operation_name("DescribeGatewayCapabilityConfiguration")
107                .build()
108                .expect("required fields set"),
109        ));
110
111        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
112            "DescribeGatewayCapabilityConfiguration",
113            "IoTSiteWise",
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("DescribeGatewayCapabilityConfiguration")
135            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
136            .with_interceptor(DescribeGatewayCapabilityConfigurationEndpointParamsInterceptor)
137            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
138                crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationError,
139            >::new())
140            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
141                crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationError,
142            >::new())
143            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
144                crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationError,
145            >::new());
146
147        ::std::borrow::Cow::Owned(rcb)
148    }
149}
150
151#[derive(Debug)]
152struct DescribeGatewayCapabilityConfigurationResponseDeserializer;
153impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeGatewayCapabilityConfigurationResponseDeserializer {
154    fn deserialize_nonstreaming(
155        &self,
156        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
157    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
158        let (success, status) = (response.status().is_success(), response.status().as_u16());
159        let headers = response.headers();
160        let body = response.body().bytes().expect("body loaded");
161        #[allow(unused_mut)]
162        let mut force_error = false;
163        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
164        let parse_result = if !success && status != 200 || force_error {
165            crate::protocol_serde::shape_describe_gateway_capability_configuration::de_describe_gateway_capability_configuration_http_error(
166                status, headers, body,
167            )
168        } else {
169            crate::protocol_serde::shape_describe_gateway_capability_configuration::de_describe_gateway_capability_configuration_http_response(
170                status, headers, body,
171            )
172        };
173        crate::protocol_serde::type_erase_result(parse_result)
174    }
175}
176#[derive(Debug)]
177struct DescribeGatewayCapabilityConfigurationRequestSerializer;
178impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeGatewayCapabilityConfigurationRequestSerializer {
179    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
180    fn serialize_input(
181        &self,
182        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
183        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
184    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
185        let input = input
186            .downcast::<crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationInput>()
187            .expect("correct type");
188        let _header_serialization_settings = _cfg
189            .load::<crate::serialization_settings::HeaderSerializationSettings>()
190            .cloned()
191            .unwrap_or_default();
192        let mut request_builder = {
193            #[allow(clippy::uninlined_format_args)]
194            fn uri_base(
195                _input: &crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationInput,
196                output: &mut ::std::string::String,
197            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
198                use ::std::fmt::Write as _;
199                let input_1 = &_input.gateway_id;
200                let input_1 = input_1
201                    .as_ref()
202                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("gateway_id", "cannot be empty or unset"))?;
203                let gateway_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
204                if gateway_id.is_empty() {
205                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
206                        "gateway_id",
207                        "cannot be empty or unset",
208                    ));
209                }
210                let input_2 = &_input.capability_namespace;
211                let input_2 = input_2.as_ref().ok_or_else(|| {
212                    ::aws_smithy_types::error::operation::BuildError::missing_field("capability_namespace", "cannot be empty or unset")
213                })?;
214                let capability_namespace = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
215                if capability_namespace.is_empty() {
216                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
217                        "capability_namespace",
218                        "cannot be empty or unset",
219                    ));
220                }
221                ::std::write!(
222                    output,
223                    "/20200301/gateways/{gatewayId}/capability/{capabilityNamespace}",
224                    gatewayId = gateway_id,
225                    capabilityNamespace = capability_namespace
226                )
227                .expect("formatting should succeed");
228                ::std::result::Result::Ok(())
229            }
230            #[allow(clippy::unnecessary_wraps)]
231            fn update_http_builder(
232                input: &crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationInput,
233                builder: ::http::request::Builder,
234            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
235                let mut uri = ::std::string::String::new();
236                uri_base(input, &mut uri)?;
237                ::std::result::Result::Ok(builder.method("GET").uri(uri))
238            }
239            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
240            builder
241        };
242        let body = ::aws_smithy_types::body::SdkBody::from("");
243
244        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
245    }
246}
247#[derive(Debug)]
248struct DescribeGatewayCapabilityConfigurationEndpointParamsInterceptor;
249
250impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeGatewayCapabilityConfigurationEndpointParamsInterceptor {
251    fn name(&self) -> &'static str {
252        "DescribeGatewayCapabilityConfigurationEndpointParamsInterceptor"
253    }
254
255    fn read_before_execution(
256        &self,
257        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
258            '_,
259            ::aws_smithy_runtime_api::client::interceptors::context::Input,
260            ::aws_smithy_runtime_api::client::interceptors::context::Output,
261            ::aws_smithy_runtime_api::client::interceptors::context::Error,
262        >,
263        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
264    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
265        let _input = context
266            .input()
267            .downcast_ref::<DescribeGatewayCapabilityConfigurationInput>()
268            .ok_or("failed to downcast to DescribeGatewayCapabilityConfigurationInput")?;
269
270        let endpoint_prefix = ::aws_smithy_runtime_api::client::endpoint::EndpointPrefix::new("api.").map_err(|err| {
271            ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint prefix could not be built", err)
272        })?;
273        cfg.interceptor_state().store_put(endpoint_prefix);
274
275        let params = crate::config::endpoint::Params::builder()
276            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
277            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
278            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
279            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
280            .build()
281            .map_err(|err| {
282                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
283            })?;
284        cfg.interceptor_state()
285            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
286        ::std::result::Result::Ok(())
287    }
288}
289
290// The get_* functions below are generated from JMESPath expressions in the
291// operationContextParams trait. They target the operation's input shape.
292
293/// Error type for the `DescribeGatewayCapabilityConfigurationError` operation.
294#[non_exhaustive]
295#[derive(::std::fmt::Debug)]
296pub enum DescribeGatewayCapabilityConfigurationError {
297    /// <p>IoT SiteWise can't process your request right now. Try again later.</p>
298    InternalFailureException(crate::types::error::InternalFailureException),
299    /// <p>The request isn't valid. This can occur if your request contains malformed JSON or unsupported characters. Check your request and try again.</p>
300    InvalidRequestException(crate::types::error::InvalidRequestException),
301    /// <p>The requested resource can't be found.</p>
302    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
303    /// <p>Your request exceeded a rate limit. For example, you might have exceeded the number of IoT SiteWise assets that can be created per second, the allowed number of messages per second, and so on.</p>
304    /// <p>For more information, see <a href="https://docs.aws.amazon.com/iot-sitewise/latest/userguide/quotas.html">Quotas</a> in the <i>IoT SiteWise User Guide</i>.</p>
305    ThrottlingException(crate::types::error::ThrottlingException),
306    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
307    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
308    variable wildcard pattern and check `.code()`:
309     \
310    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
311     \
312    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeGatewayCapabilityConfigurationError) for what information is available for the error.")]
313    Unhandled(crate::error::sealed_unhandled::Unhandled),
314}
315impl DescribeGatewayCapabilityConfigurationError {
316    /// Creates the `DescribeGatewayCapabilityConfigurationError::Unhandled` variant from any error type.
317    pub fn unhandled(
318        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
319    ) -> Self {
320        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
321            source: err.into(),
322            meta: ::std::default::Default::default(),
323        })
324    }
325
326    /// Creates the `DescribeGatewayCapabilityConfigurationError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
327    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
328        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
329            source: err.clone().into(),
330            meta: err,
331        })
332    }
333    ///
334    /// Returns error metadata, which includes the error code, message,
335    /// request ID, and potentially additional information.
336    ///
337    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
338        match self {
339            Self::InternalFailureException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
340            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
341            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
342            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
343            Self::Unhandled(e) => &e.meta,
344        }
345    }
346    /// Returns `true` if the error kind is `DescribeGatewayCapabilityConfigurationError::InternalFailureException`.
347    pub fn is_internal_failure_exception(&self) -> bool {
348        matches!(self, Self::InternalFailureException(_))
349    }
350    /// Returns `true` if the error kind is `DescribeGatewayCapabilityConfigurationError::InvalidRequestException`.
351    pub fn is_invalid_request_exception(&self) -> bool {
352        matches!(self, Self::InvalidRequestException(_))
353    }
354    /// Returns `true` if the error kind is `DescribeGatewayCapabilityConfigurationError::ResourceNotFoundException`.
355    pub fn is_resource_not_found_exception(&self) -> bool {
356        matches!(self, Self::ResourceNotFoundException(_))
357    }
358    /// Returns `true` if the error kind is `DescribeGatewayCapabilityConfigurationError::ThrottlingException`.
359    pub fn is_throttling_exception(&self) -> bool {
360        matches!(self, Self::ThrottlingException(_))
361    }
362}
363impl ::std::error::Error for DescribeGatewayCapabilityConfigurationError {
364    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
365        match self {
366            Self::InternalFailureException(_inner) => ::std::option::Option::Some(_inner),
367            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
368            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
369            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
370            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
371        }
372    }
373}
374impl ::std::fmt::Display for DescribeGatewayCapabilityConfigurationError {
375    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
376        match self {
377            Self::InternalFailureException(_inner) => _inner.fmt(f),
378            Self::InvalidRequestException(_inner) => _inner.fmt(f),
379            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
380            Self::ThrottlingException(_inner) => _inner.fmt(f),
381            Self::Unhandled(_inner) => {
382                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
383                    write!(f, "unhandled error ({code})")
384                } else {
385                    f.write_str("unhandled error")
386                }
387            }
388        }
389    }
390}
391impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeGatewayCapabilityConfigurationError {
392    fn code(&self) -> ::std::option::Option<&str> {
393        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
394    }
395    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
396        ::std::option::Option::None
397    }
398}
399impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeGatewayCapabilityConfigurationError {
400    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
401        match self {
402            Self::InternalFailureException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
403            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
404            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
405            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
406            Self::Unhandled(_inner) => &_inner.meta,
407        }
408    }
409}
410impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeGatewayCapabilityConfigurationError {
411    fn create_unhandled_error(
412        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
413        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
414    ) -> Self {
415        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
416            source,
417            meta: meta.unwrap_or_default(),
418        })
419    }
420}
421impl ::aws_types::request_id::RequestId for crate::operation::describe_gateway_capability_configuration::DescribeGatewayCapabilityConfigurationError {
422    fn request_id(&self) -> Option<&str> {
423        self.meta().request_id()
424    }
425}
426
427pub use crate::operation::describe_gateway_capability_configuration::_describe_gateway_capability_configuration_output::DescribeGatewayCapabilityConfigurationOutput;
428
429pub use crate::operation::describe_gateway_capability_configuration::_describe_gateway_capability_configuration_input::DescribeGatewayCapabilityConfigurationInput;
430
431mod _describe_gateway_capability_configuration_input;
432
433mod _describe_gateway_capability_configuration_output;
434
435/// Builders
436pub mod builders;
aws_sdk_iotsitewise/operation/describe_gateway_capability_configuration.rs

aws_sdk_iotsitewise/operation/
describe_gateway_capability_configuration.rs
