aws_sdk_securityhub/operation/
list_security_control_definitions.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `ListSecurityControlDefinitions`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct ListSecurityControlDefinitions;
6impl ListSecurityControlDefinitions {
7    /// Creates a new `ListSecurityControlDefinitions`
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_security_control_definitions::ListSecurityControlDefinitionsInput,
14    ) -> ::std::result::Result<
15        crate::operation::list_security_control_definitions::ListSecurityControlDefinitionsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::list_security_control_definitions::ListSecurityControlDefinitionsError,
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_security_control_definitions::ListSecurityControlDefinitionsError>()
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_security_control_definitions::ListSecurityControlDefinitionsOutput>()
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_security_control_definitions::ListSecurityControlDefinitionsInput,
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(
55            "SecurityHub",
56            "ListSecurityControlDefinitions",
57            input,
58            runtime_plugins,
59            stop_point,
60        )
61        // Create a parent span for the entire operation. Includes a random, internal-only,
62        // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
63        .instrument(::tracing::debug_span!(
64            "SecurityHub.ListSecurityControlDefinitions",
65            "rpc.service" = "SecurityHub",
66            "rpc.method" = "ListSecurityControlDefinitions",
67            "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
68            "rpc.system" = "aws-api",
69        ))
70        .await
71    }
72
73    pub(crate) fn operation_runtime_plugins(
74        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
75        client_config: &crate::config::Config,
76        config_override: ::std::option::Option<crate::config::Builder>,
77    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
78        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
79
80        if let ::std::option::Option::Some(config_override) = config_override {
81            for plugin in config_override.runtime_plugins.iter().cloned() {
82                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
83            }
84            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
85                config_override,
86                client_config.config.clone(),
87                &client_config.runtime_components,
88            ));
89        }
90        runtime_plugins
91    }
92}
93impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for ListSecurityControlDefinitions {
94    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
95        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("ListSecurityControlDefinitions");
96
97        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
98            ListSecurityControlDefinitionsRequestSerializer,
99        ));
100        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
101            ListSecurityControlDefinitionsResponseDeserializer,
102        ));
103
104        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
105            crate::config::auth::Params::builder()
106                .operation_name("ListSecurityControlDefinitions")
107                .build()
108                .expect("required fields set"),
109        ));
110
111        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
112            "ListSecurityControlDefinitions",
113            "SecurityHub",
114        ));
115        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
116        signing_options.double_uri_encode = true;
117        signing_options.content_sha256_header = false;
118        signing_options.normalize_uri_path = true;
119        signing_options.payload_override = None;
120
121        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
122            signing_options,
123            ..::std::default::Default::default()
124        });
125
126        ::std::option::Option::Some(cfg.freeze())
127    }
128
129    fn runtime_components(
130        &self,
131        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
132    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
133        #[allow(unused_mut)]
134        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("ListSecurityControlDefinitions")
135            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
136                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
137            ))
138            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
139                ListSecurityControlDefinitionsEndpointParamsInterceptor,
140            ))
141            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
142                crate::operation::list_security_control_definitions::ListSecurityControlDefinitionsError,
143            >::new())
144            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
145                crate::operation::list_security_control_definitions::ListSecurityControlDefinitionsError,
146            >::new())
147            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
148                crate::operation::list_security_control_definitions::ListSecurityControlDefinitionsError,
149            >::new());
150
151        ::std::borrow::Cow::Owned(rcb)
152    }
153}
154
155#[derive(Debug)]
156struct ListSecurityControlDefinitionsResponseDeserializer;
157impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for ListSecurityControlDefinitionsResponseDeserializer {
158    fn deserialize_nonstreaming(
159        &self,
160        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
161    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
162        let (success, status) = (response.status().is_success(), response.status().as_u16());
163        let headers = response.headers();
164        let body = response.body().bytes().expect("body loaded");
165        #[allow(unused_mut)]
166        let mut force_error = false;
167        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
168        let parse_result = if !success && status != 200 || force_error {
169            crate::protocol_serde::shape_list_security_control_definitions::de_list_security_control_definitions_http_error(status, headers, body)
170        } else {
171            crate::protocol_serde::shape_list_security_control_definitions::de_list_security_control_definitions_http_response(status, headers, body)
172        };
173        crate::protocol_serde::type_erase_result(parse_result)
174    }
175}
176#[derive(Debug)]
177struct ListSecurityControlDefinitionsRequestSerializer;
178impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for ListSecurityControlDefinitionsRequestSerializer {
179    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
180    fn serialize_input(
181        &self,
182        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
183        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
184    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
185        let input = input
186            .downcast::<crate::operation::list_security_control_definitions::ListSecurityControlDefinitionsInput>()
187            .expect("correct type");
188        let _header_serialization_settings = _cfg
189            .load::<crate::serialization_settings::HeaderSerializationSettings>()
190            .cloned()
191            .unwrap_or_default();
192        let mut request_builder = {
193            #[allow(clippy::uninlined_format_args)]
194            fn uri_base(
195                _input: &crate::operation::list_security_control_definitions::ListSecurityControlDefinitionsInput,
196                output: &mut ::std::string::String,
197            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
198                use ::std::fmt::Write as _;
199                ::std::write!(output, "/securityControls/definitions").expect("formatting should succeed");
200                ::std::result::Result::Ok(())
201            }
202            fn uri_query(
203                _input: &crate::operation::list_security_control_definitions::ListSecurityControlDefinitionsInput,
204                mut output: &mut ::std::string::String,
205            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
206                let mut query = ::aws_smithy_http::query::Writer::new(output);
207                if let ::std::option::Option::Some(inner_1) = &_input.standards_arn {
208                    {
209                        query.push_kv("StandardsArn", &::aws_smithy_http::query::fmt_string(inner_1));
210                    }
211                }
212                if let ::std::option::Option::Some(inner_2) = &_input.next_token {
213                    {
214                        query.push_kv("NextToken", &::aws_smithy_http::query::fmt_string(inner_2));
215                    }
216                }
217                if let ::std::option::Option::Some(inner_3) = &_input.max_results {
218                    {
219                        query.push_kv("MaxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
220                    }
221                }
222                ::std::result::Result::Ok(())
223            }
224            #[allow(clippy::unnecessary_wraps)]
225            fn update_http_builder(
226                input: &crate::operation::list_security_control_definitions::ListSecurityControlDefinitionsInput,
227                builder: ::http_1x::request::Builder,
228            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
229                let mut uri = ::std::string::String::new();
230                uri_base(input, &mut uri)?;
231                uri_query(input, &mut uri)?;
232                ::std::result::Result::Ok(builder.method("GET").uri(uri))
233            }
234            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
235            builder
236        };
237        let body = ::aws_smithy_types::body::SdkBody::from("");
238
239        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
240    }
241}
242#[derive(Debug)]
243struct ListSecurityControlDefinitionsEndpointParamsInterceptor;
244
245#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
246impl ::aws_smithy_runtime_api::client::interceptors::Intercept for ListSecurityControlDefinitionsEndpointParamsInterceptor {
247    fn name(&self) -> &'static str {
248        "ListSecurityControlDefinitionsEndpointParamsInterceptor"
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::<ListSecurityControlDefinitionsInput>()
264            .ok_or("failed to downcast to ListSecurityControlDefinitionsInput")?;
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 `ListSecurityControlDefinitionsError` operation.
285#[non_exhaustive]
286#[derive(::std::fmt::Debug)]
287pub enum ListSecurityControlDefinitionsError {
288    /// <p>Internal server error.</p>
289    InternalException(crate::types::error::InternalException),
290    /// <p>The account doesn't have permission to perform this action.</p>
291    InvalidAccessException(crate::types::error::InvalidAccessException),
292    /// <p>The request was rejected because you supplied an invalid or out-of-range value for an input parameter.</p>
293    InvalidInputException(crate::types::error::InvalidInputException),
294    /// <p>The request was rejected because it attempted to create resources beyond the current Amazon Web Services account or throttling limits. The error code describes the limit exceeded.</p>
295    LimitExceededException(crate::types::error::LimitExceededException),
296    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
297    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
298    variable wildcard pattern and check `.code()`:
299     \
300    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
301     \
302    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-ListSecurityControlDefinitionsError) for what information is available for the error.")]
303    Unhandled(crate::error::sealed_unhandled::Unhandled),
304}
305impl ListSecurityControlDefinitionsError {
306    /// Creates the `ListSecurityControlDefinitionsError::Unhandled` variant from any error type.
307    pub fn unhandled(
308        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
309    ) -> Self {
310        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
311            source: err.into(),
312            meta: ::std::default::Default::default(),
313        })
314    }
315
316    /// Creates the `ListSecurityControlDefinitionsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
317    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
318        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
319            source: err.clone().into(),
320            meta: err,
321        })
322    }
323    ///
324    /// Returns error metadata, which includes the error code, message,
325    /// request ID, and potentially additional information.
326    ///
327    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
328        match self {
329            Self::InternalException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
330            Self::InvalidAccessException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
331            Self::InvalidInputException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
332            Self::LimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
333            Self::Unhandled(e) => &e.meta,
334        }
335    }
336    /// Returns `true` if the error kind is `ListSecurityControlDefinitionsError::InternalException`.
337    pub fn is_internal_exception(&self) -> bool {
338        matches!(self, Self::InternalException(_))
339    }
340    /// Returns `true` if the error kind is `ListSecurityControlDefinitionsError::InvalidAccessException`.
341    pub fn is_invalid_access_exception(&self) -> bool {
342        matches!(self, Self::InvalidAccessException(_))
343    }
344    /// Returns `true` if the error kind is `ListSecurityControlDefinitionsError::InvalidInputException`.
345    pub fn is_invalid_input_exception(&self) -> bool {
346        matches!(self, Self::InvalidInputException(_))
347    }
348    /// Returns `true` if the error kind is `ListSecurityControlDefinitionsError::LimitExceededException`.
349    pub fn is_limit_exceeded_exception(&self) -> bool {
350        matches!(self, Self::LimitExceededException(_))
351    }
352}
353impl ::std::error::Error for ListSecurityControlDefinitionsError {
354    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
355        match self {
356            Self::InternalException(_inner) => ::std::option::Option::Some(_inner),
357            Self::InvalidAccessException(_inner) => ::std::option::Option::Some(_inner),
358            Self::InvalidInputException(_inner) => ::std::option::Option::Some(_inner),
359            Self::LimitExceededException(_inner) => ::std::option::Option::Some(_inner),
360            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
361        }
362    }
363}
364impl ::std::fmt::Display for ListSecurityControlDefinitionsError {
365    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
366        match self {
367            Self::InternalException(_inner) => _inner.fmt(f),
368            Self::InvalidAccessException(_inner) => _inner.fmt(f),
369            Self::InvalidInputException(_inner) => _inner.fmt(f),
370            Self::LimitExceededException(_inner) => _inner.fmt(f),
371            Self::Unhandled(_inner) => {
372                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
373                    write!(f, "unhandled error ({code})")
374                } else {
375                    f.write_str("unhandled error")
376                }
377            }
378        }
379    }
380}
381impl ::aws_smithy_types::retry::ProvideErrorKind for ListSecurityControlDefinitionsError {
382    fn code(&self) -> ::std::option::Option<&str> {
383        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
384    }
385    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
386        ::std::option::Option::None
387    }
388}
389impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for ListSecurityControlDefinitionsError {
390    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
391        match self {
392            Self::InternalException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
393            Self::InvalidAccessException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
394            Self::InvalidInputException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
395            Self::LimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
396            Self::Unhandled(_inner) => &_inner.meta,
397        }
398    }
399}
400impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for ListSecurityControlDefinitionsError {
401    fn create_unhandled_error(
402        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
403        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
404    ) -> Self {
405        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
406            source,
407            meta: meta.unwrap_or_default(),
408        })
409    }
410}
411impl ::aws_types::request_id::RequestId for crate::operation::list_security_control_definitions::ListSecurityControlDefinitionsError {
412    fn request_id(&self) -> Option<&str> {
413        self.meta().request_id()
414    }
415}
416
417pub use crate::operation::list_security_control_definitions::_list_security_control_definitions_input::ListSecurityControlDefinitionsInput;
418
419pub use crate::operation::list_security_control_definitions::_list_security_control_definitions_output::ListSecurityControlDefinitionsOutput;
420
421mod _list_security_control_definitions_input;
422
423mod _list_security_control_definitions_output;
424
425/// Builders
426pub mod builders;
427
428/// Paginator for this operation
429pub mod paginator;
aws_sdk_securityhub/operation/list_security_control_definitions.rs

aws_sdk_securityhub/operation/
list_security_control_definitions.rs
