aws_sdk_outposts/operation/
list_sites.rs

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

aws_sdk_outposts/operation/
list_sites.rs
