aws_sdk_connect/operation/
list_instances.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListInstances`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListInstances;
6impl ListInstances {
7    /// Creates a new `ListInstances`
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_instances::ListInstancesInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_instances::ListInstancesOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_instances::ListInstancesError,
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_instances::ListInstancesError>()
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_instances::ListInstancesOutput>()
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_instances::ListInstancesInput,
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        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("connect", "ListInstances", input, runtime_plugins, stop_point).await
54    }
55
56    pub(crate) fn operation_runtime_plugins(
57        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
58        client_config: &crate::config::Config,
59        config_override: ::std::option::Option<crate::config::Builder>,
60    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
61        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
62        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
63            ::aws_runtime::auth::sigv4::SCHEME_ID,
64        ]));
65        if let ::std::option::Option::Some(config_override) = config_override {
66            for plugin in config_override.runtime_plugins.iter().cloned() {
67                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
68            }
69            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
70                config_override,
71                client_config.config.clone(),
72                &client_config.runtime_components,
73            ));
74        }
75        runtime_plugins
76    }
77}
78impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ListInstances {
79    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
80        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListInstances");
81
82        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
83            ListInstancesRequestSerializer,
84        ));
85        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
86            ListInstancesResponseDeserializer,
87        ));
88
89        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
90            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
91        ));
92
93        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
94        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("ListInstances", "connect"));
95        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
96        signing_options.double_uri_encode = true;
97        signing_options.content_sha256_header = false;
98        signing_options.normalize_uri_path = true;
99        signing_options.payload_override = None;
100
101        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
102            signing_options,
103            ..::std::default::Default::default()
104        });
105
106        ::std::option::Option::Some(cfg.freeze())
107    }
108
109    fn runtime_components(
110        &self,
111        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
112    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
113        #[allow(unused_mut)]
114        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListInstances")
115            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
116            .with_interceptor(ListInstancesEndpointParamsInterceptor)
117            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
118                crate::operation::list_instances::ListInstancesError,
119            >::new())
120            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
121                crate::operation::list_instances::ListInstancesError,
122            >::new())
123            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
124                crate::operation::list_instances::ListInstancesError,
125            >::new());
126
127        ::std::borrow::Cow::Owned(rcb)
128    }
129}
130
131#[derive(Debug)]
132struct ListInstancesResponseDeserializer;
133impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListInstancesResponseDeserializer {
134    fn deserialize_nonstreaming(
135        &self,
136        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
137    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
138        let (success, status) = (response.status().is_success(), response.status().as_u16());
139        let headers = response.headers();
140        let body = response.body().bytes().expect("body loaded");
141        #[allow(unused_mut)]
142        let mut force_error = false;
143        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
144        let parse_result = if !success && status != 200 || force_error {
145            crate::protocol_serde::shape_list_instances::de_list_instances_http_error(status, headers, body)
146        } else {
147            crate::protocol_serde::shape_list_instances::de_list_instances_http_response(status, headers, body)
148        };
149        crate::protocol_serde::type_erase_result(parse_result)
150    }
151}
152#[derive(Debug)]
153struct ListInstancesRequestSerializer;
154impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListInstancesRequestSerializer {
155    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
156    fn serialize_input(
157        &self,
158        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
159        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
160    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
161        let input = input
162            .downcast::<crate::operation::list_instances::ListInstancesInput>()
163            .expect("correct type");
164        let _header_serialization_settings = _cfg
165            .load::<crate::serialization_settings::HeaderSerializationSettings>()
166            .cloned()
167            .unwrap_or_default();
168        let mut request_builder = {
169            fn uri_base(
170                _input: &crate::operation::list_instances::ListInstancesInput,
171                output: &mut ::std::string::String,
172            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
173                use ::std::fmt::Write as _;
174                ::std::write!(output, "/instance").expect("formatting should succeed");
175                ::std::result::Result::Ok(())
176            }
177            fn uri_query(
178                _input: &crate::operation::list_instances::ListInstancesInput,
179                mut output: &mut ::std::string::String,
180            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
181                let mut query = ::aws_smithy_http::query::Writer::new(output);
182                if let ::std::option::Option::Some(inner_1) = &_input.next_token {
183                    {
184                        query.push_kv("nextToken", &::aws_smithy_http::query::fmt_string(inner_1));
185                    }
186                }
187                if let ::std::option::Option::Some(inner_2) = &_input.max_results {
188                    {
189                        query.push_kv("maxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_2).encode());
190                    }
191                }
192                ::std::result::Result::Ok(())
193            }
194            #[allow(clippy::unnecessary_wraps)]
195            fn update_http_builder(
196                input: &crate::operation::list_instances::ListInstancesInput,
197                builder: ::http::request::Builder,
198            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
199                let mut uri = ::std::string::String::new();
200                uri_base(input, &mut uri)?;
201                uri_query(input, &mut uri)?;
202                ::std::result::Result::Ok(builder.method("GET").uri(uri))
203            }
204            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
205            builder
206        };
207        let body = ::aws_smithy_types::body::SdkBody::from("");
208
209        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
210    }
211}
212#[derive(Debug)]
213struct ListInstancesEndpointParamsInterceptor;
214
215impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListInstancesEndpointParamsInterceptor {
216    fn name(&self) -> &'static str {
217        "ListInstancesEndpointParamsInterceptor"
218    }
219
220    fn read_before_execution(
221        &self,
222        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
223            '_,
224            ::aws_smithy_runtime_api::client::interceptors::context::Input,
225            ::aws_smithy_runtime_api::client::interceptors::context::Output,
226            ::aws_smithy_runtime_api::client::interceptors::context::Error,
227        >,
228        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
229    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
230        let _input = context
231            .input()
232            .downcast_ref::<ListInstancesInput>()
233            .ok_or("failed to downcast to ListInstancesInput")?;
234
235        let params = crate::config::endpoint::Params::builder()
236            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
237            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
238            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
239            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
240            .build()
241            .map_err(|err| {
242                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
243            })?;
244        cfg.interceptor_state()
245            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
246        ::std::result::Result::Ok(())
247    }
248}
249
250// The get_* functions below are generated from JMESPath expressions in the
251// operationContextParams trait. They target the operation's input shape.
252
253/// Error type for the `ListInstancesError` operation.
254#[non_exhaustive]
255#[derive(::std::fmt::Debug)]
256pub enum ListInstancesError {
257    /// <p>Request processing failed because of an error or failure with the service.</p>
258    InternalServiceException(crate::types::error::InternalServiceException),
259    /// <p>The request is not valid.</p>
260    InvalidRequestException(crate::types::error::InvalidRequestException),
261    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
262    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
263    variable wildcard pattern and check `.code()`:
264     \
265    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
266     \
267    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListInstancesError) for what information is available for the error.")]
268    Unhandled(crate::error::sealed_unhandled::Unhandled),
269}
270impl ListInstancesError {
271    /// Creates the `ListInstancesError::Unhandled` variant from any error type.
272    pub fn unhandled(
273        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
274    ) -> Self {
275        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
276            source: err.into(),
277            meta: ::std::default::Default::default(),
278        })
279    }
280
281    /// Creates the `ListInstancesError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
282    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
283        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
284            source: err.clone().into(),
285            meta: err,
286        })
287    }
288    ///
289    /// Returns error metadata, which includes the error code, message,
290    /// request ID, and potentially additional information.
291    ///
292    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
293        match self {
294            Self::InternalServiceException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
295            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
296            Self::Unhandled(e) => &e.meta,
297        }
298    }
299    /// Returns `true` if the error kind is `ListInstancesError::InternalServiceException`.
300    pub fn is_internal_service_exception(&self) -> bool {
301        matches!(self, Self::InternalServiceException(_))
302    }
303    /// Returns `true` if the error kind is `ListInstancesError::InvalidRequestException`.
304    pub fn is_invalid_request_exception(&self) -> bool {
305        matches!(self, Self::InvalidRequestException(_))
306    }
307}
308impl ::std::error::Error for ListInstancesError {
309    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
310        match self {
311            Self::InternalServiceException(_inner) => ::std::option::Option::Some(_inner),
312            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
313            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
314        }
315    }
316}
317impl ::std::fmt::Display for ListInstancesError {
318    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
319        match self {
320            Self::InternalServiceException(_inner) => _inner.fmt(f),
321            Self::InvalidRequestException(_inner) => _inner.fmt(f),
322            Self::Unhandled(_inner) => {
323                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
324                    write!(f, "unhandled error ({code})")
325                } else {
326                    f.write_str("unhandled error")
327                }
328            }
329        }
330    }
331}
332impl ::aws_smithy_types::retry::ProvideErrorKind for ListInstancesError {
333    fn code(&self) -> ::std::option::Option<&str> {
334        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
335    }
336    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
337        ::std::option::Option::None
338    }
339}
340impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListInstancesError {
341    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
342        match self {
343            Self::InternalServiceException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
344            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
345            Self::Unhandled(_inner) => &_inner.meta,
346        }
347    }
348}
349impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListInstancesError {
350    fn create_unhandled_error(
351        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
352        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
353    ) -> Self {
354        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
355            source,
356            meta: meta.unwrap_or_default(),
357        })
358    }
359}
360impl ::aws_types::request_id::RequestId for crate::operation::list_instances::ListInstancesError {
361    fn request_id(&self) -> Option<&str> {
362        self.meta().request_id()
363    }
364}
365
366pub use crate::operation::list_instances::_list_instances_output::ListInstancesOutput;
367
368pub use crate::operation::list_instances::_list_instances_input::ListInstancesInput;
369
370mod _list_instances_input;
371
372mod _list_instances_output;
373
374/// Builders
375pub mod builders;
376
377/// Paginator for this operation
378pub mod paginator;