aws_sdk_codegurusecurity/operation/
get_scan.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetScan`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetScan;
6impl GetScan {
7    /// Creates a new `GetScan`
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::get_scan::GetScanInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_scan::GetScanOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_scan::GetScanError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err =
22            |err: ::aws_smithy_runtime_api::client::result::SdkError<
23                ::aws_smithy_runtime_api::client::interceptors::context::Error,
24                ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
25            >| { err.map_service_error(|err| err.downcast::<crate::operation::get_scan::GetScanError>().expect("correct error type")) };
26        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
27            .await
28            .map_err(map_err)?;
29        let output = context.finalize().map_err(map_err)?;
30        ::std::result::Result::Ok(
31            output
32                .downcast::<crate::operation::get_scan::GetScanOutput>()
33                .expect("correct output type"),
34        )
35    }
36
37    pub(crate) async fn orchestrate_with_stop_point(
38        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
39        input: crate::operation::get_scan::GetScanInput,
40        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
41    ) -> ::std::result::Result<
42        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
43        ::aws_smithy_runtime_api::client::result::SdkError<
44            ::aws_smithy_runtime_api::client::interceptors::context::Error,
45            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
46        >,
47    > {
48        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
49        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("codegurusecurity", "GetScan", input, runtime_plugins, stop_point).await
50    }
51
52    pub(crate) fn operation_runtime_plugins(
53        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
54        client_config: &crate::config::Config,
55        config_override: ::std::option::Option<crate::config::Builder>,
56    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
57        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
58        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
59            ::aws_runtime::auth::sigv4::SCHEME_ID,
60        ]));
61        if let ::std::option::Option::Some(config_override) = config_override {
62            for plugin in config_override.runtime_plugins.iter().cloned() {
63                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
64            }
65            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
66                config_override,
67                client_config.config.clone(),
68                &client_config.runtime_components,
69            ));
70        }
71        runtime_plugins
72    }
73}
74impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for GetScan {
75    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
76        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetScan");
77
78        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
79            GetScanRequestSerializer,
80        ));
81        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
82            GetScanResponseDeserializer,
83        ));
84
85        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
86            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
87        ));
88
89        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
90            "GetScan",
91            "codegurusecurity",
92        ));
93        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
94        signing_options.double_uri_encode = true;
95        signing_options.content_sha256_header = false;
96        signing_options.normalize_uri_path = true;
97        signing_options.payload_override = None;
98
99        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
100            signing_options,
101            ..::std::default::Default::default()
102        });
103
104        ::std::option::Option::Some(cfg.freeze())
105    }
106
107    fn runtime_components(
108        &self,
109        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
110    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
111        #[allow(unused_mut)]
112        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetScan")
113            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
114            .with_interceptor(GetScanEndpointParamsInterceptor)
115            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
116                crate::operation::get_scan::GetScanError,
117            >::new())
118            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
119                crate::operation::get_scan::GetScanError,
120            >::new())
121            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
122                crate::operation::get_scan::GetScanError,
123            >::new());
124
125        ::std::borrow::Cow::Owned(rcb)
126    }
127}
128
129#[derive(Debug)]
130struct GetScanResponseDeserializer;
131impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetScanResponseDeserializer {
132    fn deserialize_nonstreaming(
133        &self,
134        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
135    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
136        let (success, status) = (response.status().is_success(), response.status().as_u16());
137        let headers = response.headers();
138        let body = response.body().bytes().expect("body loaded");
139        #[allow(unused_mut)]
140        let mut force_error = false;
141        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
142        let parse_result = if !success && status != 200 || force_error {
143            crate::protocol_serde::shape_get_scan::de_get_scan_http_error(status, headers, body)
144        } else {
145            crate::protocol_serde::shape_get_scan::de_get_scan_http_response(status, headers, body)
146        };
147        crate::protocol_serde::type_erase_result(parse_result)
148    }
149}
150#[derive(Debug)]
151struct GetScanRequestSerializer;
152impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetScanRequestSerializer {
153    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
154    fn serialize_input(
155        &self,
156        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
157        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
158    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
159        let input = input.downcast::<crate::operation::get_scan::GetScanInput>().expect("correct type");
160        let _header_serialization_settings = _cfg
161            .load::<crate::serialization_settings::HeaderSerializationSettings>()
162            .cloned()
163            .unwrap_or_default();
164        let mut request_builder = {
165            fn uri_base(
166                _input: &crate::operation::get_scan::GetScanInput,
167                output: &mut ::std::string::String,
168            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
169                use ::std::fmt::Write as _;
170                let input_1 = &_input.scan_name;
171                let input_1 = input_1
172                    .as_ref()
173                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("scan_name", "cannot be empty or unset"))?;
174                let scan_name = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
175                if scan_name.is_empty() {
176                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
177                        "scan_name",
178                        "cannot be empty or unset",
179                    ));
180                }
181                ::std::write!(output, "/scans/{scanName}", scanName = scan_name).expect("formatting should succeed");
182                ::std::result::Result::Ok(())
183            }
184            fn uri_query(
185                _input: &crate::operation::get_scan::GetScanInput,
186                mut output: &mut ::std::string::String,
187            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
188                let mut query = ::aws_smithy_http::query::Writer::new(output);
189                if let ::std::option::Option::Some(inner_2) = &_input.run_id {
190                    {
191                        query.push_kv("runId", &::aws_smithy_http::query::fmt_string(inner_2));
192                    }
193                }
194                ::std::result::Result::Ok(())
195            }
196            #[allow(clippy::unnecessary_wraps)]
197            fn update_http_builder(
198                input: &crate::operation::get_scan::GetScanInput,
199                builder: ::http::request::Builder,
200            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
201                let mut uri = ::std::string::String::new();
202                uri_base(input, &mut uri)?;
203                uri_query(input, &mut uri)?;
204                ::std::result::Result::Ok(builder.method("GET").uri(uri))
205            }
206            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
207            builder
208        };
209        let body = ::aws_smithy_types::body::SdkBody::from("");
210
211        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
212    }
213}
214#[derive(Debug)]
215struct GetScanEndpointParamsInterceptor;
216
217impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetScanEndpointParamsInterceptor {
218    fn name(&self) -> &'static str {
219        "GetScanEndpointParamsInterceptor"
220    }
221
222    fn read_before_execution(
223        &self,
224        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
225            '_,
226            ::aws_smithy_runtime_api::client::interceptors::context::Input,
227            ::aws_smithy_runtime_api::client::interceptors::context::Output,
228            ::aws_smithy_runtime_api::client::interceptors::context::Error,
229        >,
230        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
231    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
232        let _input = context
233            .input()
234            .downcast_ref::<GetScanInput>()
235            .ok_or("failed to downcast to GetScanInput")?;
236
237        let params = crate::config::endpoint::Params::builder()
238            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
239            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
240            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
241            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
242            .build()
243            .map_err(|err| {
244                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
245            })?;
246        cfg.interceptor_state()
247            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
248        ::std::result::Result::Ok(())
249    }
250}
251
252// The get_* functions below are generated from JMESPath expressions in the
253// operationContextParams trait. They target the operation's input shape.
254
255/// Error type for the `GetScanError` operation.
256#[non_exhaustive]
257#[derive(::std::fmt::Debug)]
258pub enum GetScanError {
259    /// <p>You do not have sufficient access to perform this action.</p>
260    AccessDeniedException(crate::types::error::AccessDeniedException),
261    /// <p>The server encountered an internal error and is unable to complete the request.</p>
262    InternalServerException(crate::types::error::InternalServerException),
263    /// <p>The resource specified in the request was not found.</p>
264    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
265    /// <p>The request was denied due to request throttling.</p>
266    ThrottlingException(crate::types::error::ThrottlingException),
267    /// <p>The input fails to satisfy the specified constraints.</p>
268    ValidationException(crate::types::error::ValidationException),
269    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
270    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
271    variable wildcard pattern and check `.code()`:
272     \
273    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
274     \
275    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetScanError) for what information is available for the error.")]
276    Unhandled(crate::error::sealed_unhandled::Unhandled),
277}
278impl GetScanError {
279    /// Creates the `GetScanError::Unhandled` variant from any error type.
280    pub fn unhandled(
281        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
282    ) -> Self {
283        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
284            source: err.into(),
285            meta: ::std::default::Default::default(),
286        })
287    }
288
289    /// Creates the `GetScanError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
290    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
291        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
292            source: err.clone().into(),
293            meta: err,
294        })
295    }
296    ///
297    /// Returns error metadata, which includes the error code, message,
298    /// request ID, and potentially additional information.
299    ///
300    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
301        match self {
302            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
303            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
304            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
305            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
306            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
307            Self::Unhandled(e) => &e.meta,
308        }
309    }
310    /// Returns `true` if the error kind is `GetScanError::AccessDeniedException`.
311    pub fn is_access_denied_exception(&self) -> bool {
312        matches!(self, Self::AccessDeniedException(_))
313    }
314    /// Returns `true` if the error kind is `GetScanError::InternalServerException`.
315    pub fn is_internal_server_exception(&self) -> bool {
316        matches!(self, Self::InternalServerException(_))
317    }
318    /// Returns `true` if the error kind is `GetScanError::ResourceNotFoundException`.
319    pub fn is_resource_not_found_exception(&self) -> bool {
320        matches!(self, Self::ResourceNotFoundException(_))
321    }
322    /// Returns `true` if the error kind is `GetScanError::ThrottlingException`.
323    pub fn is_throttling_exception(&self) -> bool {
324        matches!(self, Self::ThrottlingException(_))
325    }
326    /// Returns `true` if the error kind is `GetScanError::ValidationException`.
327    pub fn is_validation_exception(&self) -> bool {
328        matches!(self, Self::ValidationException(_))
329    }
330}
331impl ::std::error::Error for GetScanError {
332    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
333        match self {
334            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
335            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
336            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
337            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
338            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
339            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
340        }
341    }
342}
343impl ::std::fmt::Display for GetScanError {
344    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
345        match self {
346            Self::AccessDeniedException(_inner) => _inner.fmt(f),
347            Self::InternalServerException(_inner) => _inner.fmt(f),
348            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
349            Self::ThrottlingException(_inner) => _inner.fmt(f),
350            Self::ValidationException(_inner) => _inner.fmt(f),
351            Self::Unhandled(_inner) => {
352                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
353                    write!(f, "unhandled error ({code})")
354                } else {
355                    f.write_str("unhandled error")
356                }
357            }
358        }
359    }
360}
361impl ::aws_smithy_types::retry::ProvideErrorKind for GetScanError {
362    fn code(&self) -> ::std::option::Option<&str> {
363        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
364    }
365    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
366        match self {
367            Self::InternalServerException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
368            Self::ThrottlingException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
369            _ => ::std::option::Option::None,
370        }
371    }
372}
373impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetScanError {
374    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
375        match self {
376            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
377            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
378            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
379            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
380            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
381            Self::Unhandled(_inner) => &_inner.meta,
382        }
383    }
384}
385impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetScanError {
386    fn create_unhandled_error(
387        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
388        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
389    ) -> Self {
390        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
391            source,
392            meta: meta.unwrap_or_default(),
393        })
394    }
395}
396impl ::aws_types::request_id::RequestId for crate::operation::get_scan::GetScanError {
397    fn request_id(&self) -> Option<&str> {
398        self.meta().request_id()
399    }
400}
401
402pub use crate::operation::get_scan::_get_scan_output::GetScanOutput;
403
404pub use crate::operation::get_scan::_get_scan_input::GetScanInput;
405
406mod _get_scan_input;
407
408mod _get_scan_output;
409
410/// Builders
411pub mod builders;
aws_sdk_codegurusecurity/operation/get_scan.rs

aws_sdk_codegurusecurity/operation/
get_scan.rs
