aws_sdk_securityhub/operation/
describe_standards.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeStandards`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeStandards;
6impl DescribeStandards {
7    /// Creates a new `DescribeStandards`
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::describe_standards::DescribeStandardsInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_standards::DescribeStandardsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_standards::DescribeStandardsError,
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::describe_standards::DescribeStandardsError>()
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::describe_standards::DescribeStandardsOutput>()
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::describe_standards::DescribeStandardsInput,
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("SecurityHub", "DescribeStandards", 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                "SecurityHub.DescribeStandards",
59                "rpc.service" = "SecurityHub",
60                "rpc.method" = "DescribeStandards",
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 DescribeStandards {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeStandards");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DescribeStandardsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DescribeStandardsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DescribeStandards")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "DescribeStandards",
107            "SecurityHub",
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("DescribeStandards")
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                DescribeStandardsTelemetryInputCaptureInterceptor,
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                DescribeStandardsEndpointParamsInterceptor,
137            ))
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
139                crate::operation::describe_standards::DescribeStandardsError,
140            >::new())
141            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
142                crate::operation::describe_standards::DescribeStandardsError,
143            >::new())
144            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
145                crate::operation::describe_standards::DescribeStandardsError,
146            >::new());
147
148        ::std::borrow::Cow::Owned(rcb)
149    }
150}
151
152#[derive(Debug)]
153struct DescribeStandardsTelemetryInputCaptureInterceptor;
154
155#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
156impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeStandardsTelemetryInputCaptureInterceptor {
157    fn name(&self) -> &'static str {
158        "DescribeStandardsTelemetryInputCaptureInterceptor"
159    }
160
161    fn read_before_execution(
162        &self,
163        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
164            '_,
165            ::aws_smithy_runtime_api::client::interceptors::context::Input,
166            ::aws_smithy_runtime_api::client::interceptors::context::Output,
167            ::aws_smithy_runtime_api::client::interceptors::context::Error,
168        >,
169        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
170    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
171        // Nothing to do unless the customer opted in by naming members to record.
172        let ::std::option::Option::Some(requested) = cfg
173            .load::<::aws_smithy_types::telemetry::RequestedTelemetryAttributes>()
174            .filter(|r| !r.is_empty())
175        else {
176            return ::std::result::Result::Ok(());
177        };
178
179        let ::std::option::Option::Some(input) = context.input().downcast_ref::<DescribeStandardsInput>() else {
180            // A mismatched input is not this interceptor's concern; skip quietly.
181            return ::std::result::Result::Ok(());
182        };
183
184        let mut captured = ::aws_smithy_types::telemetry::CapturedTelemetryAttributes::default();
185        if requested.should_capture("NextToken") {
186            if let ::std::option::Option::Some(value) = input.next_token.as_deref() {
187                captured.insert("NextToken", value);
188            }
189        }
190
191        cfg.interceptor_state().store_put(captured);
192        ::std::result::Result::Ok(())
193    }
194}
195#[derive(Debug)]
196struct DescribeStandardsResponseDeserializer;
197impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeStandardsResponseDeserializer {
198    fn deserialize_nonstreaming_with_config(
199        &self,
200        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
201        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
202    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
203        let (success, status) = (response.status().is_success(), response.status().as_u16());
204        let headers = response.headers();
205        let body = response.body().bytes().expect("body loaded");
206        #[allow(unused_mut)]
207        let mut force_error = false;
208        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
209        let parse_result = if !success && status != 200 || force_error {
210            crate::protocol_serde::shape_describe_standards::de_describe_standards_http_error(status, headers, body)
211        } else {
212            crate::protocol_serde::shape_describe_standards::de_describe_standards_http_response(status, headers, body)
213        };
214        crate::protocol_serde::type_erase_result(parse_result)
215    }
216}
217#[derive(Debug)]
218struct DescribeStandardsRequestSerializer;
219impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeStandardsRequestSerializer {
220    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
221    fn serialize_input(
222        &self,
223        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
224        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
225    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
226        let input = input
227            .downcast::<crate::operation::describe_standards::DescribeStandardsInput>()
228            .expect("correct type");
229        let _header_serialization_settings = _cfg
230            .load::<crate::serialization_settings::HeaderSerializationSettings>()
231            .cloned()
232            .unwrap_or_default();
233        let mut request_builder = {
234            #[allow(clippy::uninlined_format_args)]
235            fn uri_base(
236                _input: &crate::operation::describe_standards::DescribeStandardsInput,
237                output: &mut ::std::string::String,
238            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
239                use ::std::fmt::Write as _;
240                ::std::write!(output, "/standards").expect("formatting should succeed");
241                ::std::result::Result::Ok(())
242            }
243            fn uri_query(
244                _input: &crate::operation::describe_standards::DescribeStandardsInput,
245                mut output: &mut ::std::string::String,
246            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
247                let mut query = ::aws_smithy_http::query::Writer::new(output);
248                if let ::std::option::Option::Some(inner_1) = &_input.next_token {
249                    {
250                        query.push_kv("NextToken", &::aws_smithy_http::query::fmt_string(inner_1));
251                    }
252                }
253                if let ::std::option::Option::Some(inner_2) = &_input.max_results {
254                    {
255                        query.push_kv("MaxResults", ::aws_smithy_types::primitive::Encoder::from(*inner_2).encode());
256                    }
257                }
258                if let ::std::option::Option::Some(inner_3) = &_input.providers {
259                    {
260                        for inner_4 in inner_3 {
261                            query.push_kv("Providers", &::aws_smithy_http::query::fmt_string(inner_4.as_str()));
262                        }
263                    }
264                }
265                ::std::result::Result::Ok(())
266            }
267            #[allow(clippy::unnecessary_wraps)]
268            fn update_http_builder(
269                input: &crate::operation::describe_standards::DescribeStandardsInput,
270                builder: ::http_1x::request::Builder,
271            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
272                let mut uri = ::std::string::String::new();
273                uri_base(input, &mut uri)?;
274                uri_query(input, &mut uri)?;
275                ::std::result::Result::Ok(builder.method("GET").uri(uri))
276            }
277            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
278            builder
279        };
280        let body = ::aws_smithy_types::body::SdkBody::from("");
281
282        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
283    }
284}
285#[derive(Debug)]
286struct DescribeStandardsEndpointParamsInterceptor;
287
288#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
289impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeStandardsEndpointParamsInterceptor {
290    fn name(&self) -> &'static str {
291        "DescribeStandardsEndpointParamsInterceptor"
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::<DescribeStandardsInput>()
307            .ok_or("failed to downcast to DescribeStandardsInput")?;
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 `DescribeStandardsError` operation.
328#[non_exhaustive]
329#[derive(::std::fmt::Debug)]
330pub enum DescribeStandardsError {
331    /// <p>Internal server error.</p>
332    InternalException(crate::types::error::InternalException),
333    /// <p>The account doesn't have permission to perform this action.</p>
334    InvalidAccessException(crate::types::error::InvalidAccessException),
335    /// <p>The request was rejected because you supplied an invalid or out-of-range value for an input parameter.</p>
336    InvalidInputException(crate::types::error::InvalidInputException),
337    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
338    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
339    variable wildcard pattern and check `.code()`:
340     \
341    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
342     \
343    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeStandardsError) for what information is available for the error.")]
344    Unhandled(crate::error::sealed_unhandled::Unhandled),
345}
346impl DescribeStandardsError {
347    /// Creates the `DescribeStandardsError::Unhandled` variant from any error type.
348    pub fn unhandled(
349        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
350    ) -> Self {
351        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
352            source: err.into(),
353            meta: ::std::default::Default::default(),
354        })
355    }
356
357    /// Creates the `DescribeStandardsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
358    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
359        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
360            source: err.clone().into(),
361            meta: err,
362        })
363    }
364    ///
365    /// Returns error metadata, which includes the error code, message,
366    /// request ID, and potentially additional information.
367    ///
368    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
369        match self {
370            Self::InternalException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
371            Self::InvalidAccessException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
372            Self::InvalidInputException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
373            Self::Unhandled(e) => &e.meta,
374        }
375    }
376    /// Returns `true` if the error kind is `DescribeStandardsError::InternalException`.
377    pub fn is_internal_exception(&self) -> bool {
378        matches!(self, Self::InternalException(_))
379    }
380    /// Returns `true` if the error kind is `DescribeStandardsError::InvalidAccessException`.
381    pub fn is_invalid_access_exception(&self) -> bool {
382        matches!(self, Self::InvalidAccessException(_))
383    }
384    /// Returns `true` if the error kind is `DescribeStandardsError::InvalidInputException`.
385    pub fn is_invalid_input_exception(&self) -> bool {
386        matches!(self, Self::InvalidInputException(_))
387    }
388}
389impl ::std::error::Error for DescribeStandardsError {
390    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
391        match self {
392            Self::InternalException(_inner) => ::std::option::Option::Some(_inner),
393            Self::InvalidAccessException(_inner) => ::std::option::Option::Some(_inner),
394            Self::InvalidInputException(_inner) => ::std::option::Option::Some(_inner),
395            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
396        }
397    }
398}
399impl ::std::fmt::Display for DescribeStandardsError {
400    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
401        match self {
402            Self::InternalException(_inner) => _inner.fmt(f),
403            Self::InvalidAccessException(_inner) => _inner.fmt(f),
404            Self::InvalidInputException(_inner) => _inner.fmt(f),
405            Self::Unhandled(_inner) => {
406                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
407                    write!(f, "unhandled error ({code})")
408                } else {
409                    f.write_str("unhandled error")
410                }
411            }
412        }
413    }
414}
415impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeStandardsError {
416    fn code(&self) -> ::std::option::Option<&str> {
417        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
418    }
419    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
420        ::std::option::Option::None
421    }
422}
423impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeStandardsError {
424    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
425        match self {
426            Self::InternalException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
427            Self::InvalidAccessException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
428            Self::InvalidInputException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
429            Self::Unhandled(_inner) => &_inner.meta,
430        }
431    }
432}
433impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeStandardsError {
434    fn create_unhandled_error(
435        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
436        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
437    ) -> Self {
438        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
439            source,
440            meta: meta.unwrap_or_default(),
441        })
442    }
443}
444impl ::aws_types::request_id::RequestId for crate::operation::describe_standards::DescribeStandardsError {
445    fn request_id(&self) -> Option<&str> {
446        self.meta().request_id()
447    }
448}
449
450pub use crate::operation::describe_standards::_describe_standards_input::DescribeStandardsInput;
451
452pub use crate::operation::describe_standards::_describe_standards_output::DescribeStandardsOutput;
453
454mod _describe_standards_input;
455
456mod _describe_standards_output;
457
458/// Builders
459pub mod builders;
460
461/// Paginator for this operation
462pub mod paginator;
aws_sdk_securityhub/operation/describe_standards.rs

aws_sdk_securityhub/operation/
describe_standards.rs
