aws_sdk_inspector2/operation/
enable.rs

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

aws_sdk_inspector2/operation/
enable.rs
