aws_sdk_appmesh/operation/
describe_route.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeRoute`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeRoute;
6impl DescribeRoute {
7    /// Creates a new `DescribeRoute`
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_route::DescribeRouteInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_route::DescribeRouteOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_route::DescribeRouteError,
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_route::DescribeRouteError>()
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_route::DescribeRouteOutput>()
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_route::DescribeRouteInput,
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("App Mesh", "DescribeRoute", 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                "App Mesh.DescribeRoute",
59                "rpc.service" = "App Mesh",
60                "rpc.method" = "DescribeRoute",
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 DescribeRoute {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeRoute");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DescribeRouteRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DescribeRouteResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DescribeRoute")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("DescribeRoute", "App Mesh"));
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("DescribeRoute")
126            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
127            .with_interceptor(DescribeRouteEndpointParamsInterceptor)
128            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
129                crate::operation::describe_route::DescribeRouteError,
130            >::new())
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
132                crate::operation::describe_route::DescribeRouteError,
133            >::new())
134            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
135                crate::operation::describe_route::DescribeRouteError,
136            >::new());
137
138        ::std::borrow::Cow::Owned(rcb)
139    }
140}
141
142#[derive(Debug)]
143struct DescribeRouteResponseDeserializer;
144impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeRouteResponseDeserializer {
145    fn deserialize_nonstreaming(
146        &self,
147        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
148    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
149        let (success, status) = (response.status().is_success(), response.status().as_u16());
150        let headers = response.headers();
151        let body = response.body().bytes().expect("body loaded");
152        #[allow(unused_mut)]
153        let mut force_error = false;
154        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
155        let parse_result = if !success && status != 200 || force_error {
156            crate::protocol_serde::shape_describe_route::de_describe_route_http_error(status, headers, body)
157        } else {
158            crate::protocol_serde::shape_describe_route::de_describe_route_http_response(status, headers, body)
159        };
160        crate::protocol_serde::type_erase_result(parse_result)
161    }
162}
163#[derive(Debug)]
164struct DescribeRouteRequestSerializer;
165impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeRouteRequestSerializer {
166    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
167    fn serialize_input(
168        &self,
169        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
170        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
171    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
172        let input = input
173            .downcast::<crate::operation::describe_route::DescribeRouteInput>()
174            .expect("correct type");
175        let _header_serialization_settings = _cfg
176            .load::<crate::serialization_settings::HeaderSerializationSettings>()
177            .cloned()
178            .unwrap_or_default();
179        let mut request_builder = {
180            fn uri_base(
181                _input: &crate::operation::describe_route::DescribeRouteInput,
182                output: &mut ::std::string::String,
183            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
184                use ::std::fmt::Write as _;
185                let input_1 = &_input.mesh_name;
186                let input_1 = input_1
187                    .as_ref()
188                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("mesh_name", "cannot be empty or unset"))?;
189                let mesh_name = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
190                if mesh_name.is_empty() {
191                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
192                        "mesh_name",
193                        "cannot be empty or unset",
194                    ));
195                }
196                let input_2 = &_input.virtual_router_name;
197                let input_2 = input_2.as_ref().ok_or_else(|| {
198                    ::aws_smithy_types::error::operation::BuildError::missing_field("virtual_router_name", "cannot be empty or unset")
199                })?;
200                let virtual_router_name = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
201                if virtual_router_name.is_empty() {
202                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
203                        "virtual_router_name",
204                        "cannot be empty or unset",
205                    ));
206                }
207                let input_3 = &_input.route_name;
208                let input_3 = input_3
209                    .as_ref()
210                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("route_name", "cannot be empty or unset"))?;
211                let route_name = ::aws_smithy_http::label::fmt_string(input_3, ::aws_smithy_http::label::EncodingStrategy::Default);
212                if route_name.is_empty() {
213                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
214                        "route_name",
215                        "cannot be empty or unset",
216                    ));
217                }
218                ::std::write!(
219                    output,
220                    "/v20190125/meshes/{meshName}/virtualRouter/{virtualRouterName}/routes/{routeName}",
221                    meshName = mesh_name,
222                    virtualRouterName = virtual_router_name,
223                    routeName = route_name
224                )
225                .expect("formatting should succeed");
226                ::std::result::Result::Ok(())
227            }
228            fn uri_query(
229                _input: &crate::operation::describe_route::DescribeRouteInput,
230                mut output: &mut ::std::string::String,
231            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
232                let mut query = ::aws_smithy_http::query::Writer::new(output);
233                if let ::std::option::Option::Some(inner_4) = &_input.mesh_owner {
234                    {
235                        query.push_kv("meshOwner", &::aws_smithy_http::query::fmt_string(inner_4));
236                    }
237                }
238                ::std::result::Result::Ok(())
239            }
240            #[allow(clippy::unnecessary_wraps)]
241            fn update_http_builder(
242                input: &crate::operation::describe_route::DescribeRouteInput,
243                builder: ::http::request::Builder,
244            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
245                let mut uri = ::std::string::String::new();
246                uri_base(input, &mut uri)?;
247                uri_query(input, &mut uri)?;
248                ::std::result::Result::Ok(builder.method("GET").uri(uri))
249            }
250            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
251            builder
252        };
253        let body = ::aws_smithy_types::body::SdkBody::from("");
254
255        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
256    }
257}
258#[derive(Debug)]
259struct DescribeRouteEndpointParamsInterceptor;
260
261impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeRouteEndpointParamsInterceptor {
262    fn name(&self) -> &'static str {
263        "DescribeRouteEndpointParamsInterceptor"
264    }
265
266    fn read_before_execution(
267        &self,
268        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
269            '_,
270            ::aws_smithy_runtime_api::client::interceptors::context::Input,
271            ::aws_smithy_runtime_api::client::interceptors::context::Output,
272            ::aws_smithy_runtime_api::client::interceptors::context::Error,
273        >,
274        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
275    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
276        let _input = context
277            .input()
278            .downcast_ref::<DescribeRouteInput>()
279            .ok_or("failed to downcast to DescribeRouteInput")?;
280
281        let params = crate::config::endpoint::Params::builder()
282            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
283            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
284            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
285            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
286            .build()
287            .map_err(|err| {
288                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
289            })?;
290        cfg.interceptor_state()
291            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
292        ::std::result::Result::Ok(())
293    }
294}
295
296// The get_* functions below are generated from JMESPath expressions in the
297// operationContextParams trait. They target the operation's input shape.
298
299/// Error type for the `DescribeRouteError` operation.
300#[non_exhaustive]
301#[derive(::std::fmt::Debug)]
302pub enum DescribeRouteError {
303    /// <p>The request syntax was malformed. Check your request syntax and try again.</p>
304    BadRequestException(crate::types::error::BadRequestException),
305    /// <p>You don't have permissions to perform this action.</p>
306    ForbiddenException(crate::types::error::ForbiddenException),
307    /// <p>The request processing has failed because of an unknown error, exception, or failure.</p>
308    InternalServerErrorException(crate::types::error::InternalServerErrorException),
309    /// <p>The specified resource doesn't exist. Check your request syntax and try again.</p>
310    NotFoundException(crate::types::error::NotFoundException),
311    /// <p>The request has failed due to a temporary failure of the service.</p>
312    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
313    /// <p>The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.</p>
314    TooManyRequestsException(crate::types::error::TooManyRequestsException),
315    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
316    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
317    variable wildcard pattern and check `.code()`:
318     \
319    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
320     \
321    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeRouteError) for what information is available for the error.")]
322    Unhandled(crate::error::sealed_unhandled::Unhandled),
323}
324impl DescribeRouteError {
325    /// Creates the `DescribeRouteError::Unhandled` variant from any error type.
326    pub fn unhandled(
327        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
328    ) -> Self {
329        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
330            source: err.into(),
331            meta: ::std::default::Default::default(),
332        })
333    }
334
335    /// Creates the `DescribeRouteError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
336    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
337        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
338            source: err.clone().into(),
339            meta: err,
340        })
341    }
342    ///
343    /// Returns error metadata, which includes the error code, message,
344    /// request ID, and potentially additional information.
345    ///
346    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
347        match self {
348            Self::BadRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
349            Self::ForbiddenException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
350            Self::InternalServerErrorException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
351            Self::NotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
352            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
353            Self::TooManyRequestsException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
354            Self::Unhandled(e) => &e.meta,
355        }
356    }
357    /// Returns `true` if the error kind is `DescribeRouteError::BadRequestException`.
358    pub fn is_bad_request_exception(&self) -> bool {
359        matches!(self, Self::BadRequestException(_))
360    }
361    /// Returns `true` if the error kind is `DescribeRouteError::ForbiddenException`.
362    pub fn is_forbidden_exception(&self) -> bool {
363        matches!(self, Self::ForbiddenException(_))
364    }
365    /// Returns `true` if the error kind is `DescribeRouteError::InternalServerErrorException`.
366    pub fn is_internal_server_error_exception(&self) -> bool {
367        matches!(self, Self::InternalServerErrorException(_))
368    }
369    /// Returns `true` if the error kind is `DescribeRouteError::NotFoundException`.
370    pub fn is_not_found_exception(&self) -> bool {
371        matches!(self, Self::NotFoundException(_))
372    }
373    /// Returns `true` if the error kind is `DescribeRouteError::ServiceUnavailableException`.
374    pub fn is_service_unavailable_exception(&self) -> bool {
375        matches!(self, Self::ServiceUnavailableException(_))
376    }
377    /// Returns `true` if the error kind is `DescribeRouteError::TooManyRequestsException`.
378    pub fn is_too_many_requests_exception(&self) -> bool {
379        matches!(self, Self::TooManyRequestsException(_))
380    }
381}
382impl ::std::error::Error for DescribeRouteError {
383    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
384        match self {
385            Self::BadRequestException(_inner) => ::std::option::Option::Some(_inner),
386            Self::ForbiddenException(_inner) => ::std::option::Option::Some(_inner),
387            Self::InternalServerErrorException(_inner) => ::std::option::Option::Some(_inner),
388            Self::NotFoundException(_inner) => ::std::option::Option::Some(_inner),
389            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
390            Self::TooManyRequestsException(_inner) => ::std::option::Option::Some(_inner),
391            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
392        }
393    }
394}
395impl ::std::fmt::Display for DescribeRouteError {
396    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
397        match self {
398            Self::BadRequestException(_inner) => _inner.fmt(f),
399            Self::ForbiddenException(_inner) => _inner.fmt(f),
400            Self::InternalServerErrorException(_inner) => _inner.fmt(f),
401            Self::NotFoundException(_inner) => _inner.fmt(f),
402            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
403            Self::TooManyRequestsException(_inner) => _inner.fmt(f),
404            Self::Unhandled(_inner) => {
405                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
406                    write!(f, "unhandled error ({code})")
407                } else {
408                    f.write_str("unhandled error")
409                }
410            }
411        }
412    }
413}
414impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeRouteError {
415    fn code(&self) -> ::std::option::Option<&str> {
416        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
417    }
418    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
419        match self {
420            Self::InternalServerErrorException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
421            Self::ServiceUnavailableException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
422            Self::TooManyRequestsException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
423            _ => ::std::option::Option::None,
424        }
425    }
426}
427impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeRouteError {
428    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
429        match self {
430            Self::BadRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
431            Self::ForbiddenException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
432            Self::InternalServerErrorException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
433            Self::NotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
434            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
435            Self::TooManyRequestsException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
436            Self::Unhandled(_inner) => &_inner.meta,
437        }
438    }
439}
440impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeRouteError {
441    fn create_unhandled_error(
442        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
443        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
444    ) -> Self {
445        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
446            source,
447            meta: meta.unwrap_or_default(),
448        })
449    }
450}
451impl ::aws_types::request_id::RequestId for crate::operation::describe_route::DescribeRouteError {
452    fn request_id(&self) -> Option<&str> {
453        self.meta().request_id()
454    }
455}
456
457pub use crate::operation::describe_route::_describe_route_output::DescribeRouteOutput;
458
459pub use crate::operation::describe_route::_describe_route_input::DescribeRouteInput;
460
461mod _describe_route_input;
462
463mod _describe_route_output;
464
465/// Builders
466pub mod builders;