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

aws_sdk_codegurusecurity/operation/
get_scan.rs
