aws_sdk_networkmanager/operation/
get_sites.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetSites`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetSites;
6impl GetSites {
7    /// Creates a new `GetSites`
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_sites::GetSitesInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_sites::GetSitesOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_sites::GetSitesError,
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_sites::GetSitesError>().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_sites::GetSitesOutput>()
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_sites::GetSitesInput,
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("NetworkManager", "GetSites", 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                "NetworkManager.GetSites",
55                "rpc.service" = "NetworkManager",
56                "rpc.method" = "GetSites",
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        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
70            ::aws_runtime::auth::sigv4::SCHEME_ID,
71        ]));
72        if let ::std::option::Option::Some(config_override) = config_override {
73            for plugin in config_override.runtime_plugins.iter().cloned() {
74                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
75            }
76            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
77                config_override,
78                client_config.config.clone(),
79                &client_config.runtime_components,
80            ));
81        }
82        runtime_plugins
83    }
84}
85impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for GetSites {
86    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
87        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetSites");
88
89        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
90            GetSitesRequestSerializer,
91        ));
92        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
93            GetSitesResponseDeserializer,
94        ));
95
96        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
97            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
98        ));
99
100        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
101        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
102            "GetSites",
103            "NetworkManager",
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("GetSites")
125            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
126            .with_interceptor(GetSitesEndpointParamsInterceptor)
127            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
128                crate::operation::get_sites::GetSitesError,
129            >::new())
130            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
131                crate::operation::get_sites::GetSitesError,
132            >::new())
133            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
134                crate::operation::get_sites::GetSitesError,
135            >::new());
136
137        ::std::borrow::Cow::Owned(rcb)
138    }
139}
140
141#[derive(Debug)]
142struct GetSitesResponseDeserializer;
143impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetSitesResponseDeserializer {
144    fn deserialize_nonstreaming(
145        &self,
146        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
147    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
148        let (success, status) = (response.status().is_success(), response.status().as_u16());
149        let headers = response.headers();
150        let body = response.body().bytes().expect("body loaded");
151        #[allow(unused_mut)]
152        let mut force_error = false;
153        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
154        let parse_result = if !success && status != 200 || force_error {
155            crate::protocol_serde::shape_get_sites::de_get_sites_http_error(status, headers, body)
156        } else {
157            crate::protocol_serde::shape_get_sites::de_get_sites_http_response(status, headers, body)
158        };
159        crate::protocol_serde::type_erase_result(parse_result)
160    }
161}
162#[derive(Debug)]
163struct GetSitesRequestSerializer;
164impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetSitesRequestSerializer {
165    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
166    fn serialize_input(
167        &self,
168        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
169        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
170    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
171        let input = input.downcast::<crate::operation::get_sites::GetSitesInput>().expect("correct type");
172        let _header_serialization_settings = _cfg
173            .load::<crate::serialization_settings::HeaderSerializationSettings>()
174            .cloned()
175            .unwrap_or_default();
176        let mut request_builder = {
177            fn uri_base(
178                _input: &crate::operation::get_sites::GetSitesInput,
179                output: &mut ::std::string::String,
180            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
181                use ::std::fmt::Write as _;
182                let input_1 = &_input.global_network_id;
183                let input_1 = input_1.as_ref().ok_or_else(|| {
184                    ::aws_smithy_types::error::operation::BuildError::missing_field("global_network_id", "cannot be empty or unset")
185                })?;
186                let global_network_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
187                if global_network_id.is_empty() {
188                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
189                        "global_network_id",
190                        "cannot be empty or unset",
191                    ));
192                }
193                ::std::write!(output, "/global-networks/{GlobalNetworkId}/sites", GlobalNetworkId = global_network_id)
194                    .expect("formatting should succeed");
195                ::std::result::Result::Ok(())
196            }
197            fn uri_query(
198                _input: &crate::operation::get_sites::GetSitesInput,
199                mut output: &mut ::std::string::String,
200            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
201                let mut query = ::aws_smithy_http::query::Writer::new(output);
202                if let ::std::option::Option::Some(inner_2) = &_input.site_ids {
203                    {
204                        for inner_3 in inner_2 {
205                            query.push_kv("siteIds", &::aws_smithy_http::query::fmt_string(inner_3));
206                        }
207                    }
208                }
209                if let ::std::option::Option::Some(inner_4) = &_input.max_results {
210                    {
211                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_4).encode());
212                    }
213                }
214                if let ::std::option::Option::Some(inner_5) = &_input.next_token {
215                    {
216                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_5));
217                    }
218                }
219                ::std::result::Result::Ok(())
220            }
221            #[allow(clippy::unnecessary_wraps)]
222            fn update_http_builder(
223                input: &crate::operation::get_sites::GetSitesInput,
224                builder: ::http::request::Builder,
225            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
226                let mut uri = ::std::string::String::new();
227                uri_base(input, &mut uri)?;
228                uri_query(input, &mut uri)?;
229                ::std::result::Result::Ok(builder.method("GET").uri(uri))
230            }
231            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
232            builder
233        };
234        let body = ::aws_smithy_types::body::SdkBody::from("");
235
236        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
237    }
238}
239#[derive(Debug)]
240struct GetSitesEndpointParamsInterceptor;
241
242impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetSitesEndpointParamsInterceptor {
243    fn name(&self) -> &'static str {
244        "GetSitesEndpointParamsInterceptor"
245    }
246
247    fn read_before_execution(
248        &self,
249        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
250            '_,
251            ::aws_smithy_runtime_api::client::interceptors::context::Input,
252            ::aws_smithy_runtime_api::client::interceptors::context::Output,
253            ::aws_smithy_runtime_api::client::interceptors::context::Error,
254        >,
255        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
256    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
257        let _input = context
258            .input()
259            .downcast_ref::<GetSitesInput>()
260            .ok_or("failed to downcast to GetSitesInput")?;
261
262        let params = crate::config::endpoint::Params::builder()
263            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
264            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
265            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
266            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
267            .build()
268            .map_err(|err| {
269                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
270            })?;
271        cfg.interceptor_state()
272            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
273        ::std::result::Result::Ok(())
274    }
275}
276
277// The get_* functions below are generated from JMESPath expressions in the
278// operationContextParams trait. They target the operation's input shape.
279
280/// Error type for the `GetSitesError` operation.
281#[non_exhaustive]
282#[derive(::std::fmt::Debug)]
283pub enum GetSitesError {
284    /// <p>You do not have sufficient access to perform this action.</p>
285    AccessDeniedException(crate::types::error::AccessDeniedException),
286    /// <p>The request has failed due to an internal error.</p>
287    InternalServerException(crate::types::error::InternalServerException),
288    /// <p>The specified resource could not be found.</p>
289    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
290    /// <p>The request was denied due to request throttling.</p>
291    ThrottlingException(crate::types::error::ThrottlingException),
292    /// <p>The input fails to satisfy the constraints.</p>
293    ValidationException(crate::types::error::ValidationException),
294    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
295    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
296    variable wildcard pattern and check `.code()`:
297     \
298    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
299     \
300    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetSitesError) for what information is available for the error.")]
301    Unhandled(crate::error::sealed_unhandled::Unhandled),
302}
303impl GetSitesError {
304    /// Creates the `GetSitesError::Unhandled` variant from any error type.
305    pub fn unhandled(
306        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
307    ) -> Self {
308        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
309            source: err.into(),
310            meta: ::std::default::Default::default(),
311        })
312    }
313
314    /// Creates the `GetSitesError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
315    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
316        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
317            source: err.clone().into(),
318            meta: err,
319        })
320    }
321    ///
322    /// Returns error metadata, which includes the error code, message,
323    /// request ID, and potentially additional information.
324    ///
325    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
326        match self {
327            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
328            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
329            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
330            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
331            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
332            Self::Unhandled(e) => &e.meta,
333        }
334    }
335    /// Returns `true` if the error kind is `GetSitesError::AccessDeniedException`.
336    pub fn is_access_denied_exception(&self) -> bool {
337        matches!(self, Self::AccessDeniedException(_))
338    }
339    /// Returns `true` if the error kind is `GetSitesError::InternalServerException`.
340    pub fn is_internal_server_exception(&self) -> bool {
341        matches!(self, Self::InternalServerException(_))
342    }
343    /// Returns `true` if the error kind is `GetSitesError::ResourceNotFoundException`.
344    pub fn is_resource_not_found_exception(&self) -> bool {
345        matches!(self, Self::ResourceNotFoundException(_))
346    }
347    /// Returns `true` if the error kind is `GetSitesError::ThrottlingException`.
348    pub fn is_throttling_exception(&self) -> bool {
349        matches!(self, Self::ThrottlingException(_))
350    }
351    /// Returns `true` if the error kind is `GetSitesError::ValidationException`.
352    pub fn is_validation_exception(&self) -> bool {
353        matches!(self, Self::ValidationException(_))
354    }
355}
356impl ::std::error::Error for GetSitesError {
357    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
358        match self {
359            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
360            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
361            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
362            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
363            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
364            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
365        }
366    }
367}
368impl ::std::fmt::Display for GetSitesError {
369    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
370        match self {
371            Self::AccessDeniedException(_inner) => _inner.fmt(f),
372            Self::InternalServerException(_inner) => _inner.fmt(f),
373            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
374            Self::ThrottlingException(_inner) => _inner.fmt(f),
375            Self::ValidationException(_inner) => _inner.fmt(f),
376            Self::Unhandled(_inner) => {
377                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
378                    write!(f, "unhandled error ({code})")
379                } else {
380                    f.write_str("unhandled error")
381                }
382            }
383        }
384    }
385}
386impl ::aws_smithy_types::retry::ProvideErrorKind for GetSitesError {
387    fn code(&self) -> ::std::option::Option<&str> {
388        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
389    }
390    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
391        ::std::option::Option::None
392    }
393}
394impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetSitesError {
395    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
396        match self {
397            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
398            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
399            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
400            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
401            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
402            Self::Unhandled(_inner) => &_inner.meta,
403        }
404    }
405}
406impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetSitesError {
407    fn create_unhandled_error(
408        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
409        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
410    ) -> Self {
411        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
412            source,
413            meta: meta.unwrap_or_default(),
414        })
415    }
416}
417impl ::aws_types::request_id::RequestId for crate::operation::get_sites::GetSitesError {
418    fn request_id(&self) -> Option<&str> {
419        self.meta().request_id()
420    }
421}
422
423pub use crate::operation::get_sites::_get_sites_output::GetSitesOutput;
424
425pub use crate::operation::get_sites::_get_sites_input::GetSitesInput;
426
427mod _get_sites_input;
428
429mod _get_sites_output;
430
431/// Builders
432pub mod builders;
433
434/// Paginator for this operation
435pub mod paginator;