aws_sdk_codegurusecurity/operation/
list_scans.rs

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

aws_sdk_codegurusecurity/operation/
list_scans.rs
