aws_sdk_networksecuritymanager/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("Network Security Manager", "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                "Network Security Manager.GetScope",
55                "rpc.service" = "Network Security Manager",
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            "Network Security Manager",
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            .with_retry_classifier(::aws_runtime::service_clock_skew::ServiceClockSkewClassifier::<
144                crate::operation::get_scope::GetScopeError,
145            >::new());
146
147        ::std::borrow::Cow::Owned(rcb)
148    }
149}
150
151#[derive(Debug)]
152struct GetScopeTelemetryInputCaptureInterceptor;
153
154#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
155impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetScopeTelemetryInputCaptureInterceptor {
156    fn name(&self) -> &'static str {
157        "GetScopeTelemetryInputCaptureInterceptor"
158    }
159
160    fn read_before_execution(
161        &self,
162        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
163            '_,
164            ::aws_smithy_runtime_api::client::interceptors::context::Input,
165            ::aws_smithy_runtime_api::client::interceptors::context::Output,
166            ::aws_smithy_runtime_api::client::interceptors::context::Error,
167        >,
168        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
169    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
170        // Nothing to do unless the customer opted in by naming members to record.
171        let ::std::option::Option::Some(requested) = cfg
172            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
173            .filter(|r| !r.is_empty())
174        else {
175            return ::std::result::Result::Ok(());
176        };
177
178        let ::std::option::Option::Some(input) = context.input().downcast_ref::<GetScopeInput>() else {
179            // A mismatched input is not this interceptor's concern; skip quietly.
180            return ::std::result::Result::Ok(());
181        };
182
183        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
184        if requested.should_capture("scopeIdentifier") {
185            if let ::std::option::Option::Some(value) = input.scope_identifier.as_deref() {
186                captured.insert("scopeIdentifier", value);
187            }
188        }
189
190        cfg.interceptor_state().store_put(captured);
191        ::std::result::Result::Ok(())
192    }
193}
194#[derive(Debug)]
195struct GetScopeResponseDeserializer;
196impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetScopeResponseDeserializer {
197    fn deserialize_nonstreaming_with_config(
198        &self,
199        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
200        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
201    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
202        let (success, status) = (response.status().is_success(), response.status().as_u16());
203        let headers = response.headers();
204        let body = response.body().bytes().expect("body loaded");
205        #[allow(unused_mut)]
206        let mut force_error = false;
207        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
208        let parse_result = if !success && status != 200 || force_error {
209            crate::protocol_serde::shape_get_scope::de_get_scope_http_error(status, headers, body, _cfg)
210        } else {
211            crate::protocol_serde::shape_get_scope::de_get_scope_http_response(status, headers, body, _cfg)
212        };
213        crate::protocol_serde::type_erase_result(parse_result)
214    }
215}
216#[derive(Debug)]
217struct GetScopeRequestSerializer;
218impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetScopeRequestSerializer {
219    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
220    fn serialize_input(
221        &self,
222        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
223        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
224    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
225        let input = input.downcast::<crate::operation::get_scope::GetScopeInput>().expect("correct type");
226        let _header_serialization_settings = _cfg
227            .load::<crate::serialization_settings::HeaderSerializationSettings>()
228            .cloned()
229            .unwrap_or_default();
230        let mut request_builder = {
231            #[allow(clippy::uninlined_format_args)]
232            fn uri_base(
233                _input: &crate::operation::get_scope::GetScopeInput,
234                output: &mut ::std::string::String,
235            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
236                use ::std::fmt::Write as _;
237                let input_1 = &_input.scope_identifier;
238                let input_1 = input_1
239                    .as_ref()
240                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("scope_identifier", "cannot be empty or unset"))?;
241                let scope_identifier = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
242                if scope_identifier.is_empty() {
243                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
244                        "scope_identifier",
245                        "cannot be empty or unset",
246                    ));
247                }
248                ::std::write!(output, "/scopes/{scopeIdentifier}", scopeIdentifier = scope_identifier).expect("formatting should succeed");
249                ::std::result::Result::Ok(())
250            }
251            #[allow(clippy::unnecessary_wraps)]
252            fn update_http_builder(
253                input: &crate::operation::get_scope::GetScopeInput,
254                builder: ::http_1x::request::Builder,
255            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
256                let mut uri = ::std::string::String::new();
257                uri_base(input, &mut uri)?;
258                ::std::result::Result::Ok(builder.method("GET").uri(uri))
259            }
260            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
261            builder
262        };
263        let body = ::aws_smithy_types::body::SdkBody::from("");
264
265        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
266    }
267}
268#[derive(Debug)]
269struct GetScopeEndpointParamsInterceptor;
270
271#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
272impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetScopeEndpointParamsInterceptor {
273    fn name(&self) -> &'static str {
274        "GetScopeEndpointParamsInterceptor"
275    }
276
277    fn read_before_execution(
278        &self,
279        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
280            '_,
281            ::aws_smithy_runtime_api::client::interceptors::context::Input,
282            ::aws_smithy_runtime_api::client::interceptors::context::Output,
283            ::aws_smithy_runtime_api::client::interceptors::context::Error,
284        >,
285        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
286    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
287        let _input = context
288            .input()
289            .downcast_ref::<GetScopeInput>()
290            .ok_or("failed to downcast to GetScopeInput")?;
291
292        let params = crate::config::endpoint::Params::builder()
293            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
294            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
295            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
296            .build()
297            .map_err(|err| {
298                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
299            })?;
300        cfg.interceptor_state()
301            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
302        ::std::result::Result::Ok(())
303    }
304}
305
306// The get_* functions below are generated from JMESPath expressions in the
307// operationContextParams trait. They target the operation's input shape.
308
309/// Error type for the `GetScopeError` operation.
310#[non_exhaustive]
311#[derive(::std::fmt::Debug)]
312pub enum GetScopeError {
313    /// <p>You do not have sufficient permissions to perform this action.</p>
314    AccessDeniedException(crate::types::error::AccessDeniedException),
315    /// <p>The request processing failed because of an internal error in the service. This is a retryable error.</p>
316    InternalServerException(crate::types::error::InternalServerException),
317    /// <p>The specified resource was not found. Verify that the resource identifier is correct and that the resource exists, then try your request again.</p>
318    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
319    /// <p>The request was denied because of request throttling. Reduce your request rate and try again.</p>
320    ThrottlingException(crate::types::error::ThrottlingException),
321    /// <p>The request failed validation. For details, see the <code>reason</code> and <code>fieldList</code> members of the response.</p>
322    ValidationException(crate::types::error::ValidationException),
323    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
324    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
325    variable wildcard pattern and check `.code()`:
326     \
327    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
328     \
329    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetScopeError) for what information is available for the error.")]
330    Unhandled(crate::error::sealed_unhandled::Unhandled),
331}
332impl GetScopeError {
333    /// Creates the `GetScopeError::Unhandled` variant from any error type.
334    pub fn unhandled(
335        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
336    ) -> Self {
337        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
338            source: err.into(),
339            meta: ::std::default::Default::default(),
340        })
341    }
342
343    /// Creates the `GetScopeError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
344    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
345        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
346            source: err.clone().into(),
347            meta: err,
348        })
349    }
350    ///
351    /// Returns error metadata, which includes the error code, message,
352    /// request ID, and potentially additional information.
353    ///
354    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
355        match self {
356            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
357            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
358            Self::ResourceNotFoundException(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::ThrottlingException`.
377    pub fn is_throttling_exception(&self) -> bool {
378        matches!(self, Self::ThrottlingException(_))
379    }
380    /// Returns `true` if the error kind is `GetScopeError::ValidationException`.
381    pub fn is_validation_exception(&self) -> bool {
382        matches!(self, Self::ValidationException(_))
383    }
384}
385impl ::std::error::Error for GetScopeError {
386    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
387        match self {
388            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
389            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
390            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
391            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
392            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
393            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
394        }
395    }
396}
397impl ::std::fmt::Display for GetScopeError {
398    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
399        match self {
400            Self::AccessDeniedException(_inner) => _inner.fmt(f),
401            Self::InternalServerException(_inner) => _inner.fmt(f),
402            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
403            Self::ThrottlingException(_inner) => _inner.fmt(f),
404            Self::ValidationException(_inner) => _inner.fmt(f),
405            Self::Unhandled(_inner) => {
406                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
407                    write!(f, "unhandled error ({code})")
408                } else {
409                    f.write_str("unhandled error")
410                }
411            }
412        }
413    }
414}
415impl ::aws_smithy_types::retry::ProvideErrorKind for GetScopeError {
416    fn code(&self) -> ::std::option::Option<&str> {
417        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
418    }
419    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
420        match self {
421            Self::InternalServerException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
422            Self::ThrottlingException(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 GetScopeError {
428    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
429        match self {
430            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
431            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
432            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
433            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
434            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
435            Self::Unhandled(_inner) => &_inner.meta,
436        }
437    }
438}
439impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetScopeError {
440    fn create_unhandled_error(
441        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
442        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
443    ) -> Self {
444        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
445            source,
446            meta: meta.unwrap_or_default(),
447        })
448    }
449}
450impl ::aws_types::request_id::RequestId for crate::operation::get_scope::GetScopeError {
451    fn request_id(&self) -> Option<&str> {
452        self.meta().request_id()
453    }
454}
455
456pub use crate::operation::get_scope::_get_scope_input::GetScopeInput;
457
458pub use crate::operation::get_scope::_get_scope_output::GetScopeOutput;
459
460mod _get_scope_input;
461
462mod _get_scope_output;
463
464/// Builders
465pub mod builders;
aws_sdk_networksecuritymanager/operation/get_scope.rs

aws_sdk_networksecuritymanager/operation/
get_scope.rs
