aws_sdk_networkflowmonitor/operation/
get_scope.rs

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

aws_sdk_networkflowmonitor/operation/
get_scope.rs
