aws_sdk_networkmonitor/operation/
get_probe.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetProbe`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetProbe;
6impl GetProbe {
7    /// Creates a new `GetProbe`
8    pub fn new() -> Self {
9        Self
10    }
11    pub(crate) async fn orchestrate(
12        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
13        input: crate::operation::get_probe::GetProbeInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_probe::GetProbeOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_probe::GetProbeError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err =
22            |err: ::aws_smithy_runtime_api::client::result::SdkError<
23                ::aws_smithy_runtime_api::client::interceptors::context::Error,
24                ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
25            >| { err.map_service_error(|err| err.downcast::<crate::operation::get_probe::GetProbeError>().expect("correct error type")) };
26        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
27            .await
28            .map_err(map_err)?;
29        let output = context.finalize().map_err(map_err)?;
30        ::std::result::Result::Ok(
31            output
32                .downcast::<crate::operation::get_probe::GetProbeOutput>()
33                .expect("correct output type"),
34        )
35    }
36
37    pub(crate) async fn orchestrate_with_stop_point(
38        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
39        input: crate::operation::get_probe::GetProbeInput,
40        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
41    ) -> ::std::result::Result<
42        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
43        ::aws_smithy_runtime_api::client::result::SdkError<
44            ::aws_smithy_runtime_api::client::interceptors::context::Error,
45            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
46        >,
47    > {
48        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
49        use ::tracing::Instrument;
50        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("NetworkMonitor", "GetProbe", input, runtime_plugins, stop_point)
51            // Create a parent span for the entire operation. Includes a random, internal-only,
52            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
53            .instrument(::tracing::debug_span!(
54                "NetworkMonitor.GetProbe",
55                "rpc.service" = "NetworkMonitor",
56                "rpc.method" = "GetProbe",
57                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
58                "rpc.system" = "aws-api",
59            ))
60            .await
61    }
62
63    pub(crate) fn operation_runtime_plugins(
64        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
65        client_config: &crate::config::Config,
66        config_override: ::std::option::Option<crate::config::Builder>,
67    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
68        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
69
70        if let ::std::option::Option::Some(config_override) = config_override {
71            for plugin in config_override.runtime_plugins.iter().cloned() {
72                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
73            }
74            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
75                config_override,
76                client_config.config.clone(),
77                &client_config.runtime_components,
78            ));
79        }
80        runtime_plugins
81    }
82}
83impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for GetProbe {
84    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
85        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetProbe");
86
87        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
88            GetProbeRequestSerializer,
89        ));
90        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
91            GetProbeResponseDeserializer,
92        ));
93
94        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
95            crate::config::auth::Params::builder()
96                .operation_name("GetProbe")
97                .build()
98                .expect("required fields set"),
99        ));
100
101        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
102            "GetProbe",
103            "NetworkMonitor",
104        ));
105        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
106        signing_options.double_uri_encode = true;
107        signing_options.content_sha256_header = false;
108        signing_options.normalize_uri_path = true;
109        signing_options.payload_override = None;
110
111        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
112            signing_options,
113            ..::std::default::Default::default()
114        });
115
116        ::std::option::Option::Some(cfg.freeze())
117    }
118
119    fn runtime_components(
120        &self,
121        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
122    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
123        #[allow(unused_mut)]
124        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetProbe")
125            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
126            .with_interceptor(GetProbeEndpointParamsInterceptor)
127            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
128                crate::operation::get_probe::GetProbeError,
129            >::new())
130            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
131                crate::operation::get_probe::GetProbeError,
132            >::new())
133            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
134                crate::operation::get_probe::GetProbeError,
135            >::new());
136
137        ::std::borrow::Cow::Owned(rcb)
138    }
139}
140
141#[derive(Debug)]
142struct GetProbeResponseDeserializer;
143impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetProbeResponseDeserializer {
144    fn deserialize_nonstreaming(
145        &self,
146        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
147    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
148        let (success, status) = (response.status().is_success(), response.status().as_u16());
149        let headers = response.headers();
150        let body = response.body().bytes().expect("body loaded");
151        #[allow(unused_mut)]
152        let mut force_error = false;
153        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
154        let parse_result = if !success && status != 200 || force_error {
155            crate::protocol_serde::shape_get_probe::de_get_probe_http_error(status, headers, body)
156        } else {
157            crate::protocol_serde::shape_get_probe::de_get_probe_http_response(status, headers, body)
158        };
159        crate::protocol_serde::type_erase_result(parse_result)
160    }
161}
162#[derive(Debug)]
163struct GetProbeRequestSerializer;
164impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetProbeRequestSerializer {
165    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
166    fn serialize_input(
167        &self,
168        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
169        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
170    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
171        let input = input.downcast::<crate::operation::get_probe::GetProbeInput>().expect("correct type");
172        let _header_serialization_settings = _cfg
173            .load::<crate::serialization_settings::HeaderSerializationSettings>()
174            .cloned()
175            .unwrap_or_default();
176        let mut request_builder = {
177            #[allow(clippy::uninlined_format_args)]
178            fn uri_base(
179                _input: &crate::operation::get_probe::GetProbeInput,
180                output: &mut ::std::string::String,
181            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
182                use ::std::fmt::Write as _;
183                let input_1 = &_input.monitor_name;
184                let input_1 = input_1
185                    .as_ref()
186                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("monitor_name", "cannot be empty or unset"))?;
187                let monitor_name = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
188                if monitor_name.is_empty() {
189                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
190                        "monitor_name",
191                        "cannot be empty or unset",
192                    ));
193                }
194                let input_2 = &_input.probe_id;
195                let input_2 = input_2
196                    .as_ref()
197                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("probe_id", "cannot be empty or unset"))?;
198                let probe_id = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
199                if probe_id.is_empty() {
200                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
201                        "probe_id",
202                        "cannot be empty or unset",
203                    ));
204                }
205                ::std::write!(
206                    output,
207                    "/monitors/{monitorName}/probes/{probeId}",
208                    monitorName = monitor_name,
209                    probeId = probe_id
210                )
211                .expect("formatting should succeed");
212                ::std::result::Result::Ok(())
213            }
214            #[allow(clippy::unnecessary_wraps)]
215            fn update_http_builder(
216                input: &crate::operation::get_probe::GetProbeInput,
217                builder: ::http::request::Builder,
218            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
219                let mut uri = ::std::string::String::new();
220                uri_base(input, &mut uri)?;
221                ::std::result::Result::Ok(builder.method("GET").uri(uri))
222            }
223            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
224            builder
225        };
226        let body = ::aws_smithy_types::body::SdkBody::from("");
227
228        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
229    }
230}
231#[derive(Debug)]
232struct GetProbeEndpointParamsInterceptor;
233
234impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetProbeEndpointParamsInterceptor {
235    fn name(&self) -> &'static str {
236        "GetProbeEndpointParamsInterceptor"
237    }
238
239    fn read_before_execution(
240        &self,
241        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
242            '_,
243            ::aws_smithy_runtime_api::client::interceptors::context::Input,
244            ::aws_smithy_runtime_api::client::interceptors::context::Output,
245            ::aws_smithy_runtime_api::client::interceptors::context::Error,
246        >,
247        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
248    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
249        let _input = context
250            .input()
251            .downcast_ref::<GetProbeInput>()
252            .ok_or("failed to downcast to GetProbeInput")?;
253
254        let params = crate::config::endpoint::Params::builder()
255            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
256            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
257            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
258            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
259            .build()
260            .map_err(|err| {
261                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
262            })?;
263        cfg.interceptor_state()
264            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
265        ::std::result::Result::Ok(())
266    }
267}
268
269// The get_* functions below are generated from JMESPath expressions in the
270// operationContextParams trait. They target the operation's input shape.
271
272/// Error type for the `GetProbeError` operation.
273#[non_exhaustive]
274#[derive(::std::fmt::Debug)]
275pub enum GetProbeError {
276    /// <p>You do not have sufficient access to perform this action.</p>
277    AccessDeniedException(crate::types::error::AccessDeniedException),
278    /// <p>The request processing has failed because of an unknown error, exception or failure.</p>
279    InternalServerException(crate::types::error::InternalServerException),
280    /// <p>The specified resource does not exist.</p>
281    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
282    /// <p>The request was denied due to request throttling</p>
283    ThrottlingException(crate::types::error::ThrottlingException),
284    /// <p>One of the parameters for the request is not valid.</p>
285    ValidationException(crate::types::error::ValidationException),
286    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
287    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
288    variable wildcard pattern and check `.code()`:
289     \
290    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
291     \
292    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetProbeError) for what information is available for the error.")]
293    Unhandled(crate::error::sealed_unhandled::Unhandled),
294}
295impl GetProbeError {
296    /// Creates the `GetProbeError::Unhandled` variant from any error type.
297    pub fn unhandled(
298        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
299    ) -> Self {
300        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
301            source: err.into(),
302            meta: ::std::default::Default::default(),
303        })
304    }
305
306    /// Creates the `GetProbeError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
307    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
308        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
309            source: err.clone().into(),
310            meta: err,
311        })
312    }
313    ///
314    /// Returns error metadata, which includes the error code, message,
315    /// request ID, and potentially additional information.
316    ///
317    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
318        match self {
319            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
320            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
321            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
322            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
323            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
324            Self::Unhandled(e) => &e.meta,
325        }
326    }
327    /// Returns `true` if the error kind is `GetProbeError::AccessDeniedException`.
328    pub fn is_access_denied_exception(&self) -> bool {
329        matches!(self, Self::AccessDeniedException(_))
330    }
331    /// Returns `true` if the error kind is `GetProbeError::InternalServerException`.
332    pub fn is_internal_server_exception(&self) -> bool {
333        matches!(self, Self::InternalServerException(_))
334    }
335    /// Returns `true` if the error kind is `GetProbeError::ResourceNotFoundException`.
336    pub fn is_resource_not_found_exception(&self) -> bool {
337        matches!(self, Self::ResourceNotFoundException(_))
338    }
339    /// Returns `true` if the error kind is `GetProbeError::ThrottlingException`.
340    pub fn is_throttling_exception(&self) -> bool {
341        matches!(self, Self::ThrottlingException(_))
342    }
343    /// Returns `true` if the error kind is `GetProbeError::ValidationException`.
344    pub fn is_validation_exception(&self) -> bool {
345        matches!(self, Self::ValidationException(_))
346    }
347}
348impl ::std::error::Error for GetProbeError {
349    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
350        match self {
351            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
352            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
353            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
354            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
355            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
356            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
357        }
358    }
359}
360impl ::std::fmt::Display for GetProbeError {
361    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
362        match self {
363            Self::AccessDeniedException(_inner) => _inner.fmt(f),
364            Self::InternalServerException(_inner) => _inner.fmt(f),
365            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
366            Self::ThrottlingException(_inner) => _inner.fmt(f),
367            Self::ValidationException(_inner) => _inner.fmt(f),
368            Self::Unhandled(_inner) => {
369                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
370                    write!(f, "unhandled error ({code})")
371                } else {
372                    f.write_str("unhandled error")
373                }
374            }
375        }
376    }
377}
378impl ::aws_smithy_types::retry::ProvideErrorKind for GetProbeError {
379    fn code(&self) -> ::std::option::Option<&str> {
380        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
381    }
382    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
383        match self {
384            Self::InternalServerException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
385            Self::ThrottlingException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
386            _ => ::std::option::Option::None,
387        }
388    }
389}
390impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetProbeError {
391    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
392        match self {
393            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
394            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
395            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
396            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
397            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
398            Self::Unhandled(_inner) => &_inner.meta,
399        }
400    }
401}
402impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetProbeError {
403    fn create_unhandled_error(
404        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
405        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
406    ) -> Self {
407        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
408            source,
409            meta: meta.unwrap_or_default(),
410        })
411    }
412}
413impl ::aws_types::request_id::RequestId for crate::operation::get_probe::GetProbeError {
414    fn request_id(&self) -> Option<&str> {
415        self.meta().request_id()
416    }
417}
418
419pub use crate::operation::get_probe::_get_probe_output::GetProbeOutput;
420
421pub use crate::operation::get_probe::_get_probe_input::GetProbeInput;
422
423mod _get_probe_input;
424
425mod _get_probe_output;
426
427/// Builders
428pub mod builders;