aws_sdk_outposts/operation/
list_outposts.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListOutposts`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListOutposts;
6impl ListOutposts {
7    /// Creates a new `ListOutposts`
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_outposts::ListOutpostsInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_outposts::ListOutpostsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_outposts::ListOutpostsError,
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_outposts::ListOutpostsError>()
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_outposts::ListOutpostsOutput>()
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_outposts::ListOutpostsInput,
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", "ListOutposts", 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.ListOutposts",
59                "rpc.service" = "Outposts",
60                "rpc.method" = "ListOutposts",
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        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
74            ::aws_runtime::auth::sigv4::SCHEME_ID,
75        ]));
76        if let ::std::option::Option::Some(config_override) = config_override {
77            for plugin in config_override.runtime_plugins.iter().cloned() {
78                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
79            }
80            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
81                config_override,
82                client_config.config.clone(),
83                &client_config.runtime_components,
84            ));
85        }
86        runtime_plugins
87    }
88}
89impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ListOutposts {
90    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
91        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListOutposts");
92
93        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
94            ListOutpostsRequestSerializer,
95        ));
96        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
97            ListOutpostsResponseDeserializer,
98        ));
99
100        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
101            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
102        ));
103
104        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("ListOutposts", "Outposts"));
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("ListOutposts")
125            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
126            .with_interceptor(ListOutpostsEndpointParamsInterceptor)
127            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
128                crate::operation::list_outposts::ListOutpostsError,
129            >::new())
130            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
131                crate::operation::list_outposts::ListOutpostsError,
132            >::new())
133            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
134                crate::operation::list_outposts::ListOutpostsError,
135            >::new());
136
137        ::std::borrow::Cow::Owned(rcb)
138    }
139}
140
141#[derive(Debug)]
142struct ListOutpostsResponseDeserializer;
143impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListOutpostsResponseDeserializer {
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_list_outposts::de_list_outposts_http_error(status, headers, body)
156        } else {
157            crate::protocol_serde::shape_list_outposts::de_list_outposts_http_response(status, headers, body)
158        };
159        crate::protocol_serde::type_erase_result(parse_result)
160    }
161}
162#[derive(Debug)]
163struct ListOutpostsRequestSerializer;
164impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListOutpostsRequestSerializer {
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
172            .downcast::<crate::operation::list_outposts::ListOutpostsInput>()
173            .expect("correct type");
174        let _header_serialization_settings = _cfg
175            .load::<crate::serialization_settings::HeaderSerializationSettings>()
176            .cloned()
177            .unwrap_or_default();
178        let mut request_builder = {
179            fn uri_base(
180                _input: &crate::operation::list_outposts::ListOutpostsInput,
181                output: &mut ::std::string::String,
182            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
183                use ::std::fmt::Write as _;
184                ::std::write!(output, "/outposts").expect("formatting should succeed");
185                ::std::result::Result::Ok(())
186            }
187            fn uri_query(
188                _input: &crate::operation::list_outposts::ListOutpostsInput,
189                mut output: &mut ::std::string::String,
190            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
191                let mut query = ::aws_smithy_http::query::Writer::new(output);
192                if let ::std::option::Option::Some(inner_1) = &_input.next_token {
193                    {
194                        query.push_kv("NextToken", &::aws_smithy_http::query::fmt_string(inner_1));
195                    }
196                }
197                if let ::std::option::Option::Some(inner_2) = &_input.max_results {
198                    {
199                        query.push_kv("MaxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_2).encode());
200                    }
201                }
202                if let ::std::option::Option::Some(inner_3) = &_input.life_cycle_status_filter {
203                    {
204                        for inner_4 in inner_3 {
205                            query.push_kv("LifeCycleStatusFilter", &::aws_smithy_http::query::fmt_string(inner_4));
206                        }
207                    }
208                }
209                if let ::std::option::Option::Some(inner_5) = &_input.availability_zone_filter {
210                    {
211                        for inner_6 in inner_5 {
212                            query.push_kv("AvailabilityZoneFilter", &::aws_smithy_http::query::fmt_string(inner_6));
213                        }
214                    }
215                }
216                if let ::std::option::Option::Some(inner_7) = &_input.availability_zone_id_filter {
217                    {
218                        for inner_8 in inner_7 {
219                            query.push_kv("AvailabilityZoneIdFilter", &::aws_smithy_http::query::fmt_string(inner_8));
220                        }
221                    }
222                }
223                ::std::result::Result::Ok(())
224            }
225            #[allow(clippy::unnecessary_wraps)]
226            fn update_http_builder(
227                input: &crate::operation::list_outposts::ListOutpostsInput,
228                builder: ::http::request::Builder,
229            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
230                let mut uri = ::std::string::String::new();
231                uri_base(input, &mut uri)?;
232                uri_query(input, &mut uri)?;
233                ::std::result::Result::Ok(builder.method("GET").uri(uri))
234            }
235            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
236            builder
237        };
238        let body = ::aws_smithy_types::body::SdkBody::from("");
239
240        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
241    }
242}
243#[derive(Debug)]
244struct ListOutpostsEndpointParamsInterceptor;
245
246impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListOutpostsEndpointParamsInterceptor {
247    fn name(&self) -> &'static str {
248        "ListOutpostsEndpointParamsInterceptor"
249    }
250
251    fn read_before_execution(
252        &self,
253        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
254            '_,
255            ::aws_smithy_runtime_api::client::interceptors::context::Input,
256            ::aws_smithy_runtime_api::client::interceptors::context::Output,
257            ::aws_smithy_runtime_api::client::interceptors::context::Error,
258        >,
259        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
260    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
261        let _input = context
262            .input()
263            .downcast_ref::<ListOutpostsInput>()
264            .ok_or("failed to downcast to ListOutpostsInput")?;
265
266        let params = crate::config::endpoint::Params::builder()
267            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
268            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
269            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
270            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
271            .build()
272            .map_err(|err| {
273                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
274            })?;
275        cfg.interceptor_state()
276            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
277        ::std::result::Result::Ok(())
278    }
279}
280
281// The get_* functions below are generated from JMESPath expressions in the
282// operationContextParams trait. They target the operation's input shape.
283
284/// Error type for the `ListOutpostsError` operation.
285#[non_exhaustive]
286#[derive(::std::fmt::Debug)]
287pub enum ListOutpostsError {
288    /// <p>You do not have permission to perform this operation.</p>
289    AccessDeniedException(crate::types::error::AccessDeniedException),
290    /// <p>An internal error has occurred.</p>
291    InternalServerException(crate::types::error::InternalServerException),
292    /// <p>A parameter is not valid.</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-ListOutpostsError) for what information is available for the error.")]
301    Unhandled(crate::error::sealed_unhandled::Unhandled),
302}
303impl ListOutpostsError {
304    /// Creates the `ListOutpostsError::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 `ListOutpostsError::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::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
330            Self::Unhandled(e) => &e.meta,
331        }
332    }
333    /// Returns `true` if the error kind is `ListOutpostsError::AccessDeniedException`.
334    pub fn is_access_denied_exception(&self) -> bool {
335        matches!(self, Self::AccessDeniedException(_))
336    }
337    /// Returns `true` if the error kind is `ListOutpostsError::InternalServerException`.
338    pub fn is_internal_server_exception(&self) -> bool {
339        matches!(self, Self::InternalServerException(_))
340    }
341    /// Returns `true` if the error kind is `ListOutpostsError::ValidationException`.
342    pub fn is_validation_exception(&self) -> bool {
343        matches!(self, Self::ValidationException(_))
344    }
345}
346impl ::std::error::Error for ListOutpostsError {
347    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
348        match self {
349            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
350            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
351            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
352            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
353        }
354    }
355}
356impl ::std::fmt::Display for ListOutpostsError {
357    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
358        match self {
359            Self::AccessDeniedException(_inner) => _inner.fmt(f),
360            Self::InternalServerException(_inner) => _inner.fmt(f),
361            Self::ValidationException(_inner) => _inner.fmt(f),
362            Self::Unhandled(_inner) => {
363                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
364                    write!(f, "unhandled error ({code})")
365                } else {
366                    f.write_str("unhandled error")
367                }
368            }
369        }
370    }
371}
372impl ::aws_smithy_types::retry::ProvideErrorKind for ListOutpostsError {
373    fn code(&self) -> ::std::option::Option<&str> {
374        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
375    }
376    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
377        ::std::option::Option::None
378    }
379}
380impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListOutpostsError {
381    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
382        match self {
383            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
384            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
385            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
386            Self::Unhandled(_inner) => &_inner.meta,
387        }
388    }
389}
390impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListOutpostsError {
391    fn create_unhandled_error(
392        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
393        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
394    ) -> Self {
395        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
396            source,
397            meta: meta.unwrap_or_default(),
398        })
399    }
400}
401impl ::aws_types::request_id::RequestId for crate::operation::list_outposts::ListOutpostsError {
402    fn request_id(&self) -> Option<&str> {
403        self.meta().request_id()
404    }
405}
406
407pub use crate::operation::list_outposts::_list_outposts_output::ListOutpostsOutput;
408
409pub use crate::operation::list_outposts::_list_outposts_input::ListOutpostsInput;
410
411mod _list_outposts_input;
412
413mod _list_outposts_output;
414
415/// Builders
416pub mod builders;
417
418/// Paginator for this operation
419pub mod paginator;