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

aws_sdk_outposts/operation/
list_sites.rs
