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                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
128            ))
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                ListSitesEndpointParamsInterceptor,
131            ))
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
133                crate::operation::list_sites::ListSitesError,
134            >::new())
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
136                crate::operation::list_sites::ListSitesError,
137            >::new())
138            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
139                crate::operation::list_sites::ListSitesError,
140            >::new());
141
142        ::std::borrow::Cow::Owned(rcb)
143    }
144}
145
146#[derive(Debug)]
147struct ListSitesResponseDeserializer;
148impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListSitesResponseDeserializer {
149    fn deserialize_nonstreaming(
150        &self,
151        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
152    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
153        let (success, status) = (response.status().is_success(), response.status().as_u16());
154        let headers = response.headers();
155        let body = response.body().bytes().expect("body loaded");
156        #[allow(unused_mut)]
157        let mut force_error = false;
158        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
159        let parse_result = if !success && status != 200 || force_error {
160            crate::protocol_serde::shape_list_sites::de_list_sites_http_error(status, headers, body)
161        } else {
162            crate::protocol_serde::shape_list_sites::de_list_sites_http_response(status, headers, body)
163        };
164        crate::protocol_serde::type_erase_result(parse_result)
165    }
166}
167#[derive(Debug)]
168struct ListSitesRequestSerializer;
169impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListSitesRequestSerializer {
170    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
171    fn serialize_input(
172        &self,
173        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
174        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
175    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
176        let input = input.downcast::<crate::operation::list_sites::ListSitesInput>().expect("correct type");
177        let _header_serialization_settings = _cfg
178            .load::<crate::serialization_settings::HeaderSerializationSettings>()
179            .cloned()
180            .unwrap_or_default();
181        let mut request_builder = {
182            #[allow(clippy::uninlined_format_args)]
183            fn uri_base(
184                _input: &crate::operation::list_sites::ListSitesInput,
185                output: &mut ::std::string::String,
186            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
187                use ::std::fmt::Write as _;
188                ::std::write!(output, "/sites").expect("formatting should succeed");
189                ::std::result::Result::Ok(())
190            }
191            fn uri_query(
192                _input: &crate::operation::list_sites::ListSitesInput,
193                mut output: &mut ::std::string::String,
194            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
195                let mut query = ::aws_smithy_http::query::Writer::new(output);
196                if let ::std::option::Option::Some(inner_1) = &_input.next_token {
197                    {
198                        query.push_kv("NextToken", &::aws_smithy_http::query::fmt_string(inner_1));
199                    }
200                }
201                if let ::std::option::Option::Some(inner_2) = &_input.max_results {
202                    {
203                        query.push_kv("MaxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_2).encode());
204                    }
205                }
206                if let ::std::option::Option::Some(inner_3) = &_input.operating_address_country_code_filter {
207                    {
208                        for inner_4 in inner_3 {
209                            query.push_kv("OperatingAddressCountryCodeFilter", &::aws_smithy_http::query::fmt_string(inner_4));
210                        }
211                    }
212                }
213                if let ::std::option::Option::Some(inner_5) = &_input.operating_address_state_or_region_filter {
214                    {
215                        for inner_6 in inner_5 {
216                            query.push_kv("OperatingAddressStateOrRegionFilter", &::aws_smithy_http::query::fmt_string(inner_6));
217                        }
218                    }
219                }
220                if let ::std::option::Option::Some(inner_7) = &_input.operating_address_city_filter {
221                    {
222                        for inner_8 in inner_7 {
223                            query.push_kv("OperatingAddressCityFilter", &::aws_smithy_http::query::fmt_string(inner_8));
224                        }
225                    }
226                }
227                ::std::result::Result::Ok(())
228            }
229            #[allow(clippy::unnecessary_wraps)]
230            fn update_http_builder(
231                input: &crate::operation::list_sites::ListSitesInput,
232                builder: ::http_1x::request::Builder,
233            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
234                let mut uri = ::std::string::String::new();
235                uri_base(input, &mut uri)?;
236                uri_query(input, &mut uri)?;
237                ::std::result::Result::Ok(builder.method("GET").uri(uri))
238            }
239            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
240            builder
241        };
242        let body = ::aws_smithy_types::body::SdkBody::from("");
243
244        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
245    }
246}
247#[derive(Debug)]
248struct ListSitesEndpointParamsInterceptor;
249
250#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
251impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListSitesEndpointParamsInterceptor {
252    fn name(&self) -> &'static str {
253        "ListSitesEndpointParamsInterceptor"
254    }
255
256    fn read_before_execution(
257        &self,
258        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
259            '_,
260            ::aws_smithy_runtime_api::client::interceptors::context::Input,
261            ::aws_smithy_runtime_api::client::interceptors::context::Output,
262            ::aws_smithy_runtime_api::client::interceptors::context::Error,
263        >,
264        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
265    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
266        let _input = context
267            .input()
268            .downcast_ref::<ListSitesInput>()
269            .ok_or("failed to downcast to ListSitesInput")?;
270
271        let params = crate::config::endpoint::Params::builder()
272            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
273            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
274            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
275            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
276            .build()
277            .map_err(|err| {
278                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
279            })?;
280        cfg.interceptor_state()
281            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
282        ::std::result::Result::Ok(())
283    }
284}
285
286// The get_* functions below are generated from JMESPath expressions in the
287// operationContextParams trait. They target the operation's input shape.
288
289/// Error type for the `ListSitesError` operation.
290#[non_exhaustive]
291#[derive(::std::fmt::Debug)]
292pub enum ListSitesError {
293    /// <p>You do not have permission to perform this operation.</p>
294    AccessDeniedException(crate::types::error::AccessDeniedException),
295    /// <p>An internal error has occurred.</p>
296    InternalServerException(crate::types::error::InternalServerException),
297    /// <p>A parameter is not valid.</p>
298    ValidationException(crate::types::error::ValidationException),
299    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
300    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
301    variable wildcard pattern and check `.code()`:
302     \
303    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
304     \
305    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListSitesError) for what information is available for the error.")]
306    Unhandled(crate::error::sealed_unhandled::Unhandled),
307}
308impl ListSitesError {
309    /// Creates the `ListSitesError::Unhandled` variant from any error type.
310    pub fn unhandled(
311        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
312    ) -> Self {
313        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
314            source: err.into(),
315            meta: ::std::default::Default::default(),
316        })
317    }
318
319    /// Creates the `ListSitesError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
320    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
321        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
322            source: err.clone().into(),
323            meta: err,
324        })
325    }
326    ///
327    /// Returns error metadata, which includes the error code, message,
328    /// request ID, and potentially additional information.
329    ///
330    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
331        match self {
332            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
333            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
334            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
335            Self::Unhandled(e) => &e.meta,
336        }
337    }
338    /// Returns `true` if the error kind is `ListSitesError::AccessDeniedException`.
339    pub fn is_access_denied_exception(&self) -> bool {
340        matches!(self, Self::AccessDeniedException(_))
341    }
342    /// Returns `true` if the error kind is `ListSitesError::InternalServerException`.
343    pub fn is_internal_server_exception(&self) -> bool {
344        matches!(self, Self::InternalServerException(_))
345    }
346    /// Returns `true` if the error kind is `ListSitesError::ValidationException`.
347    pub fn is_validation_exception(&self) -> bool {
348        matches!(self, Self::ValidationException(_))
349    }
350}
351impl ::std::error::Error for ListSitesError {
352    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
353        match self {
354            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
355            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
356            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
357            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
358        }
359    }
360}
361impl ::std::fmt::Display for ListSitesError {
362    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
363        match self {
364            Self::AccessDeniedException(_inner) => _inner.fmt(f),
365            Self::InternalServerException(_inner) => _inner.fmt(f),
366            Self::ValidationException(_inner) => _inner.fmt(f),
367            Self::Unhandled(_inner) => {
368                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
369                    write!(f, "unhandled error ({code})")
370                } else {
371                    f.write_str("unhandled error")
372                }
373            }
374        }
375    }
376}
377impl ::aws_smithy_types::retry::ProvideErrorKind for ListSitesError {
378    fn code(&self) -> ::std::option::Option<&str> {
379        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
380    }
381    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
382        ::std::option::Option::None
383    }
384}
385impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListSitesError {
386    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
387        match self {
388            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
389            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
390            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
391            Self::Unhandled(_inner) => &_inner.meta,
392        }
393    }
394}
395impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListSitesError {
396    fn create_unhandled_error(
397        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
398        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
399    ) -> Self {
400        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
401            source,
402            meta: meta.unwrap_or_default(),
403        })
404    }
405}
406impl ::aws_types::request_id::RequestId for crate::operation::list_sites::ListSitesError {
407    fn request_id(&self) -> Option<&str> {
408        self.meta().request_id()
409    }
410}
411
412pub use crate::operation::list_sites::_list_sites_input::ListSitesInput;
413
414pub use crate::operation::list_sites::_list_sites_output::ListSitesOutput;
415
416mod _list_sites_input;
417
418mod _list_sites_output;
419
420/// Builders
421pub mod builders;
422
423/// Paginator for this operation
424pub mod paginator;
aws_sdk_outposts/operation/list_sites.rs

aws_sdk_outposts/operation/
list_sites.rs
