aws_sdk_controlcatalog/operation/
list_common_controls.rs

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

aws_sdk_controlcatalog/operation/
list_common_controls.rs
