aws_sdk_iot/operation/
describe_endpoint.rs

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

aws_sdk_iot/operation/
describe_endpoint.rs
