aws_sdk_networksecuritymanager/operation/
list_scopes.rs

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

aws_sdk_networksecuritymanager/operation/
list_scopes.rs
