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        use ::tracing::Instrument;
31        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
32            // Create a parent span for the entire operation. Includes a random, internal-only,
33            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
34            .instrument(::tracing::debug_span!(
35                "connect.ListInstances",
36                "rpc.service" = "connect",
37                "rpc.method" = "ListInstances",
38                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
39                "rpc.system" = "aws-api",
40            ))
41            .await
42            .map_err(map_err)?;
43        let output = context.finalize().map_err(map_err)?;
44        ::std::result::Result::Ok(
45            output
46                .downcast::<crate::operation::list_instances::ListInstancesOutput>()
47                .expect("correct output type"),
48        )
49    }
50
51    pub(crate) async fn orchestrate_with_stop_point(
52        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
53        input: crate::operation::list_instances::ListInstancesInput,
54        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
55    ) -> ::std::result::Result<
56        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
57        ::aws_smithy_runtime_api::client::result::SdkError<
58            ::aws_smithy_runtime_api::client::interceptors::context::Error,
59            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
60        >,
61    > {
62        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
63        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("connect", "ListInstances", input, runtime_plugins, stop_point).await
64    }
65
66    pub(crate) fn operation_runtime_plugins(
67        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
68        client_config: &crate::config::Config,
69        config_override: ::std::option::Option<crate::config::Builder>,
70    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
71        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
72        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
73            ::aws_runtime::auth::sigv4::SCHEME_ID,
74        ]));
75        if let ::std::option::Option::Some(config_override) = config_override {
76            for plugin in config_override.runtime_plugins.iter().cloned() {
77                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
78            }
79            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
80                config_override,
81                client_config.config.clone(),
82                &client_config.runtime_components,
83            ));
84        }
85        runtime_plugins
86    }
87}
88impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ListInstances {
89    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
90        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListInstances");
91
92        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
93            ListInstancesRequestSerializer,
94        ));
95        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
96            ListInstancesResponseDeserializer,
97        ));
98
99        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
100            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
101        ));
102
103        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::SensitiveOutput);
104        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("ListInstances", "connect"));
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("ListInstances")
125            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
126            .with_interceptor(ListInstancesEndpointParamsInterceptor)
127            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
128                crate::operation::list_instances::ListInstancesError,
129            >::new())
130            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
131                crate::operation::list_instances::ListInstancesError,
132            >::new())
133            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
134                crate::operation::list_instances::ListInstancesError,
135            >::new());
136
137        ::std::borrow::Cow::Owned(rcb)
138    }
139}
140
141#[derive(Debug)]
142struct ListInstancesResponseDeserializer;
143impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListInstancesResponseDeserializer {
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_instances::de_list_instances_http_error(status, headers, body)
156        } else {
157            crate::protocol_serde::shape_list_instances::de_list_instances_http_response(status, headers, body)
158        };
159        crate::protocol_serde::type_erase_result(parse_result)
160    }
161}
162#[derive(Debug)]
163struct ListInstancesRequestSerializer;
164impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListInstancesRequestSerializer {
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_instances::ListInstancesInput>()
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_instances::ListInstancesInput,
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, "/instance").expect("formatting should succeed");
185                ::std::result::Result::Ok(())
186            }
187            fn uri_query(
188                _input: &crate::operation::list_instances::ListInstancesInput,
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                ::std::result::Result::Ok(())
203            }
204            #[allow(clippy::unnecessary_wraps)]
205            fn update_http_builder(
206                input: &crate::operation::list_instances::ListInstancesInput,
207                builder: ::http::request::Builder,
208            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
209                let mut uri = ::std::string::String::new();
210                uri_base(input, &mut uri)?;
211                uri_query(input, &mut uri)?;
212                ::std::result::Result::Ok(builder.method("GET").uri(uri))
213            }
214            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
215            builder
216        };
217        let body = ::aws_smithy_types::body::SdkBody::from("");
218
219        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
220    }
221}
222#[derive(Debug)]
223struct ListInstancesEndpointParamsInterceptor;
224
225impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListInstancesEndpointParamsInterceptor {
226    fn name(&self) -> &'static str {
227        "ListInstancesEndpointParamsInterceptor"
228    }
229
230    fn read_before_execution(
231        &self,
232        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
233            '_,
234            ::aws_smithy_runtime_api::client::interceptors::context::Input,
235            ::aws_smithy_runtime_api::client::interceptors::context::Output,
236            ::aws_smithy_runtime_api::client::interceptors::context::Error,
237        >,
238        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
239    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
240        let _input = context
241            .input()
242            .downcast_ref::<ListInstancesInput>()
243            .ok_or("failed to downcast to ListInstancesInput")?;
244
245        let params = crate::config::endpoint::Params::builder()
246            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
247            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
248            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
249            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
250            .build()
251            .map_err(|err| {
252                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
253            })?;
254        cfg.interceptor_state()
255            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
256        ::std::result::Result::Ok(())
257    }
258}
259
260// The get_* functions below are generated from JMESPath expressions in the
261// operationContextParams trait. They target the operation's input shape.
262
263/// Error type for the `ListInstancesError` operation.
264#[non_exhaustive]
265#[derive(::std::fmt::Debug)]
266pub enum ListInstancesError {
267    /// <p>Request processing failed because of an error or failure with the service.</p>
268    InternalServiceException(crate::types::error::InternalServiceException),
269    /// <p>The request is not valid.</p>
270    InvalidRequestException(crate::types::error::InvalidRequestException),
271    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
272    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
273    variable wildcard pattern and check `.code()`:
274     \
275    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
276     \
277    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListInstancesError) for what information is available for the error.")]
278    Unhandled(crate::error::sealed_unhandled::Unhandled),
279}
280impl ListInstancesError {
281    /// Creates the `ListInstancesError::Unhandled` variant from any error type.
282    pub fn unhandled(
283        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
284    ) -> Self {
285        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
286            source: err.into(),
287            meta: ::std::default::Default::default(),
288        })
289    }
290
291    /// Creates the `ListInstancesError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
292    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
293        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
294            source: err.clone().into(),
295            meta: err,
296        })
297    }
298    ///
299    /// Returns error metadata, which includes the error code, message,
300    /// request ID, and potentially additional information.
301    ///
302    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
303        match self {
304            Self::InternalServiceException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
305            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
306            Self::Unhandled(e) => &e.meta,
307        }
308    }
309    /// Returns `true` if the error kind is `ListInstancesError::InternalServiceException`.
310    pub fn is_internal_service_exception(&self) -> bool {
311        matches!(self, Self::InternalServiceException(_))
312    }
313    /// Returns `true` if the error kind is `ListInstancesError::InvalidRequestException`.
314    pub fn is_invalid_request_exception(&self) -> bool {
315        matches!(self, Self::InvalidRequestException(_))
316    }
317}
318impl ::std::error::Error for ListInstancesError {
319    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
320        match self {
321            Self::InternalServiceException(_inner) => ::std::option::Option::Some(_inner),
322            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
323            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
324        }
325    }
326}
327impl ::std::fmt::Display for ListInstancesError {
328    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
329        match self {
330            Self::InternalServiceException(_inner) => _inner.fmt(f),
331            Self::InvalidRequestException(_inner) => _inner.fmt(f),
332            Self::Unhandled(_inner) => {
333                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
334                    write!(f, "unhandled error ({code})")
335                } else {
336                    f.write_str("unhandled error")
337                }
338            }
339        }
340    }
341}
342impl ::aws_smithy_types::retry::ProvideErrorKind for ListInstancesError {
343    fn code(&self) -> ::std::option::Option<&str> {
344        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
345    }
346    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
347        ::std::option::Option::None
348    }
349}
350impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListInstancesError {
351    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
352        match self {
353            Self::InternalServiceException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
354            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
355            Self::Unhandled(_inner) => &_inner.meta,
356        }
357    }
358}
359impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListInstancesError {
360    fn create_unhandled_error(
361        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
362        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
363    ) -> Self {
364        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
365            source,
366            meta: meta.unwrap_or_default(),
367        })
368    }
369}
370impl ::aws_types::request_id::RequestId for crate::operation::list_instances::ListInstancesError {
371    fn request_id(&self) -> Option<&str> {
372        self.meta().request_id()
373    }
374}
375
376pub use crate::operation::list_instances::_list_instances_output::ListInstancesOutput;
377
378pub use crate::operation::list_instances::_list_instances_input::ListInstancesInput;
379
380mod _list_instances_input;
381
382mod _list_instances_output;
383
384/// Builders
385pub mod builders;
386
387/// Paginator for this operation
388pub mod paginator;