Skip to main content

aws_sdk_cloudformation/operation/
list_stack_instances.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListStackInstances`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListStackInstances;
6impl ListStackInstances {
7    /// Creates a new `ListStackInstances`
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_stack_instances::ListStackInstancesInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_stack_instances::ListStackInstancesOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_stack_instances::ListStackInstancesError,
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_stack_instances::ListStackInstancesError>()
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_stack_instances::ListStackInstancesOutput>()
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_stack_instances::ListStackInstancesInput,
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("CloudFormation", "ListStackInstances", 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                "CloudFormation.ListStackInstances",
59                "rpc.service" = "CloudFormation",
60                "rpc.method" = "ListStackInstances",
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 ListStackInstances {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListStackInstances");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            ListStackInstancesRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            ListStackInstancesResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("ListStackInstances")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "ListStackInstances",
107            "CloudFormation",
108        ));
109        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
110        signing_options.double_uri_encode = true;
111        signing_options.content_sha256_header = false;
112        signing_options.normalize_uri_path = true;
113        signing_options.payload_override = None;
114
115        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
116            signing_options,
117            ..::std::default::Default::default()
118        });
119
120        ::std::option::Option::Some(cfg.freeze())
121    }
122
123    fn runtime_components(
124        &self,
125        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
126    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
127        #[allow(unused_mut)]
128        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListStackInstances")
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                ListStackInstancesTelemetryInputCaptureInterceptor,
131            ))
132            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
133                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
134            ))
135            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
136                ListStackInstancesEndpointParamsInterceptor,
137            ))
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
139                crate::operation::list_stack_instances::ListStackInstancesError,
140            >::new())
141            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
142                crate::operation::list_stack_instances::ListStackInstancesError,
143            >::new())
144            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
145                crate::operation::list_stack_instances::ListStackInstancesError,
146            >::new())
147            .with_retry_classifier(::aws_runtime::service_clock_skew::ServiceClockSkewClassifier::<
148                crate::operation::list_stack_instances::ListStackInstancesError,
149            >::new());
150
151        ::std::borrow::Cow::Owned(rcb)
152    }
153}
154
155#[derive(Debug)]
156struct ListStackInstancesTelemetryInputCaptureInterceptor;
157
158#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
159impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListStackInstancesTelemetryInputCaptureInterceptor {
160    fn name(&self) -> &'static str {
161        "ListStackInstancesTelemetryInputCaptureInterceptor"
162    }
163
164    fn read_before_execution(
165        &self,
166        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
167            '_,
168            ::aws_smithy_runtime_api::client::interceptors::context::Input,
169            ::aws_smithy_runtime_api::client::interceptors::context::Output,
170            ::aws_smithy_runtime_api::client::interceptors::context::Error,
171        >,
172        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
173    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
174        // Nothing to do unless the customer opted in by naming members to record.
175        let ::std::option::Option::Some(requested) = cfg
176            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
177            .filter(|r| !r.is_empty())
178        else {
179            return ::std::result::Result::Ok(());
180        };
181
182        let ::std::option::Option::Some(input) = context.input().downcast_ref::<ListStackInstancesInput>() else {
183            // A mismatched input is not this interceptor's concern; skip quietly.
184            return ::std::result::Result::Ok(());
185        };
186
187        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
188        if requested.should_capture("StackSetName") {
189            if let ::std::option::Option::Some(value) = input.stack_set_name.as_deref() {
190                captured.insert("StackSetName", value);
191            }
192        }
193        if requested.should_capture("NextToken") {
194            if let ::std::option::Option::Some(value) = input.next_token.as_deref() {
195                captured.insert("NextToken", value);
196            }
197        }
198        if requested.should_capture("StackInstanceAccount") {
199            if let ::std::option::Option::Some(value) = input.stack_instance_account.as_deref() {
200                captured.insert("StackInstanceAccount", value);
201            }
202        }
203        if requested.should_capture("StackInstanceRegion") {
204            if let ::std::option::Option::Some(value) = input.stack_instance_region.as_deref() {
205                captured.insert("StackInstanceRegion", value);
206            }
207        }
208
209        cfg.interceptor_state().store_put(captured);
210        ::std::result::Result::Ok(())
211    }
212}
213#[derive(Debug)]
214struct ListStackInstancesResponseDeserializer;
215impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListStackInstancesResponseDeserializer {
216    fn deserialize_nonstreaming_with_config(
217        &self,
218        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
219        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
220    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
221        let (success, status) = (response.status().is_success(), response.status().as_u16());
222        let headers = response.headers();
223        let body = response.body().bytes().expect("body loaded");
224        #[allow(unused_mut)]
225        let mut force_error = false;
226        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
227        let parse_result = if !success && status != 200 || force_error {
228            crate::protocol_serde::shape_list_stack_instances::de_list_stack_instances_http_error(status, headers, body)
229        } else {
230            crate::protocol_serde::shape_list_stack_instances::de_list_stack_instances_http_response(status, headers, body)
231        };
232        crate::protocol_serde::type_erase_result(parse_result)
233    }
234}
235#[derive(Debug)]
236struct ListStackInstancesRequestSerializer;
237impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListStackInstancesRequestSerializer {
238    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
239    fn serialize_input(
240        &self,
241        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
242        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
243    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
244        let input = input
245            .downcast::<crate::operation::list_stack_instances::ListStackInstancesInput>()
246            .expect("correct type");
247        let _header_serialization_settings = _cfg
248            .load::<crate::serialization_settings::HeaderSerializationSettings>()
249            .cloned()
250            .unwrap_or_default();
251        let mut request_builder = {
252            #[allow(clippy::uninlined_format_args)]
253            fn uri_base(
254                _input: &crate::operation::list_stack_instances::ListStackInstancesInput,
255                output: &mut ::std::string::String,
256            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
257                use ::std::fmt::Write as _;
258                ::std::write!(output, "/").expect("formatting should succeed");
259                ::std::result::Result::Ok(())
260            }
261            #[allow(clippy::unnecessary_wraps)]
262            fn update_http_builder(
263                input: &crate::operation::list_stack_instances::ListStackInstancesInput,
264                builder: ::http_1x::request::Builder,
265            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
266                let mut uri = ::std::string::String::new();
267                uri_base(input, &mut uri)?;
268                ::std::result::Result::Ok(builder.method("POST").uri(uri))
269            }
270            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
271            builder =
272                _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-www-form-urlencoded");
273            builder
274        };
275        let body = ::aws_smithy_types::body::SdkBody::from(
276            crate::protocol_serde::shape_list_stack_instances_input::ser_list_stack_instances_input_input_input(&input)?,
277        );
278        if let Some(content_length) = body.content_length() {
279            let content_length = content_length.to_string();
280            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
281        }
282        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
283    }
284}
285#[derive(Debug)]
286struct ListStackInstancesEndpointParamsInterceptor;
287
288#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
289impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListStackInstancesEndpointParamsInterceptor {
290    fn name(&self) -> &'static str {
291        "ListStackInstancesEndpointParamsInterceptor"
292    }
293
294    fn read_before_execution(
295        &self,
296        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
297            '_,
298            ::aws_smithy_runtime_api::client::interceptors::context::Input,
299            ::aws_smithy_runtime_api::client::interceptors::context::Output,
300            ::aws_smithy_runtime_api::client::interceptors::context::Error,
301        >,
302        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
303    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
304        let _input = context
305            .input()
306            .downcast_ref::<ListStackInstancesInput>()
307            .ok_or("failed to downcast to ListStackInstancesInput")?;
308
309        let params = crate::config::endpoint::Params::builder()
310            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
311            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
312            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
313            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
314            .build()
315            .map_err(|err| {
316                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
317            })?;
318        cfg.interceptor_state()
319            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
320        ::std::result::Result::Ok(())
321    }
322}
323
324// The get_* functions below are generated from JMESPath expressions in the
325// operationContextParams trait. They target the operation's input shape.
326
327/// Error type for the `ListStackInstancesError` operation.
328#[non_exhaustive]
329#[derive(::std::fmt::Debug)]
330pub enum ListStackInstancesError {
331    /// <p>The specified StackSet doesn't exist.</p>
332    StackSetNotFoundException(crate::types::error::StackSetNotFoundException),
333    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
334    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
335    variable wildcard pattern and check `.code()`:
336     \
337    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
338     \
339    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListStackInstancesError) for what information is available for the error.")]
340    Unhandled(crate::error::sealed_unhandled::Unhandled),
341}
342impl ListStackInstancesError {
343    /// Creates the `ListStackInstancesError::Unhandled` variant from any error type.
344    pub fn unhandled(
345        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
346    ) -> Self {
347        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
348            source: err.into(),
349            meta: ::std::default::Default::default(),
350        })
351    }
352
353    /// Creates the `ListStackInstancesError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
354    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
355        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
356            source: err.clone().into(),
357            meta: err,
358        })
359    }
360    ///
361    /// Returns error metadata, which includes the error code, message,
362    /// request ID, and potentially additional information.
363    ///
364    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
365        match self {
366            Self::StackSetNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
367            Self::Unhandled(e) => &e.meta,
368        }
369    }
370    /// Returns `true` if the error kind is `ListStackInstancesError::StackSetNotFoundException`.
371    pub fn is_stack_set_not_found_exception(&self) -> bool {
372        matches!(self, Self::StackSetNotFoundException(_))
373    }
374}
375impl ::std::error::Error for ListStackInstancesError {
376    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
377        match self {
378            Self::StackSetNotFoundException(_inner) => ::std::option::Option::Some(_inner),
379            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
380        }
381    }
382}
383impl ::std::fmt::Display for ListStackInstancesError {
384    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
385        match self {
386            Self::StackSetNotFoundException(_inner) => _inner.fmt(f),
387            Self::Unhandled(_inner) => {
388                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
389                    write!(f, "unhandled error ({code})")
390                } else {
391                    f.write_str("unhandled error")
392                }
393            }
394        }
395    }
396}
397impl ::aws_smithy_types::retry::ProvideErrorKind for ListStackInstancesError {
398    fn code(&self) -> ::std::option::Option<&str> {
399        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
400    }
401    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
402        ::std::option::Option::None
403    }
404}
405impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListStackInstancesError {
406    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
407        match self {
408            Self::StackSetNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
409            Self::Unhandled(_inner) => &_inner.meta,
410        }
411    }
412}
413impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListStackInstancesError {
414    fn create_unhandled_error(
415        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
416        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
417    ) -> Self {
418        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
419            source,
420            meta: meta.unwrap_or_default(),
421        })
422    }
423}
424impl ::aws_types::request_id::RequestId for crate::operation::list_stack_instances::ListStackInstancesError {
425    fn request_id(&self) -> Option<&str> {
426        self.meta().request_id()
427    }
428}
429
430pub use crate::operation::list_stack_instances::_list_stack_instances_input::ListStackInstancesInput;
431
432pub use crate::operation::list_stack_instances::_list_stack_instances_output::ListStackInstancesOutput;
433
434mod _list_stack_instances_input;
435
436mod _list_stack_instances_output;
437
438/// Builders
439pub mod builders;
440
441/// Paginator for this operation
442pub mod paginator;