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