aws_sdk_config/operation/
start_config_rules_evaluation.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `StartConfigRulesEvaluation`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StartConfigRulesEvaluation;
6impl StartConfigRulesEvaluation {
7    /// Creates a new `StartConfigRulesEvaluation`
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::start_config_rules_evaluation::StartConfigRulesEvaluationInput,
14    ) -> ::std::result::Result<
15        crate::operation::start_config_rules_evaluation::StartConfigRulesEvaluationOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::start_config_rules_evaluation::StartConfigRulesEvaluationError,
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::start_config_rules_evaluation::StartConfigRulesEvaluationError>()
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::start_config_rules_evaluation::StartConfigRulesEvaluationOutput>()
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::start_config_rules_evaluation::StartConfigRulesEvaluationInput,
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(
55            "Config Service",
56            "StartConfigRulesEvaluation",
57            input,
58            runtime_plugins,
59            stop_point,
60        )
61        // Create a parent span for the entire operation. Includes a random, internal-only,
62        // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
63        .instrument(::tracing::debug_span!(
64            "Config Service.StartConfigRulesEvaluation",
65            "rpc.service" = "Config Service",
66            "rpc.method" = "StartConfigRulesEvaluation",
67            "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
68            "rpc.system" = "aws-api",
69        ))
70        .await
71    }
72
73    pub(crate) fn operation_runtime_plugins(
74        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
75        client_config: &crate::config::Config,
76        config_override: ::std::option::Option<crate::config::Builder>,
77    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
78        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
79        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
80            ::aws_runtime::auth::sigv4::SCHEME_ID,
81        ]));
82        if let ::std::option::Option::Some(config_override) = config_override {
83            for plugin in config_override.runtime_plugins.iter().cloned() {
84                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
85            }
86            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
87                config_override,
88                client_config.config.clone(),
89                &client_config.runtime_components,
90            ));
91        }
92        runtime_plugins
93    }
94}
95impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for StartConfigRulesEvaluation {
96    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
97        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("StartConfigRulesEvaluation");
98
99        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
100            StartConfigRulesEvaluationRequestSerializer,
101        ));
102        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
103            StartConfigRulesEvaluationResponseDeserializer,
104        ));
105
106        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
107            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
108        ));
109
110        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
111            "StartConfigRulesEvaluation",
112            "Config Service",
113        ));
114        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
115        signing_options.double_uri_encode = true;
116        signing_options.content_sha256_header = false;
117        signing_options.normalize_uri_path = true;
118        signing_options.payload_override = None;
119
120        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
121            signing_options,
122            ..::std::default::Default::default()
123        });
124
125        ::std::option::Option::Some(cfg.freeze())
126    }
127
128    fn runtime_components(
129        &self,
130        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
131    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
132        #[allow(unused_mut)]
133        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("StartConfigRulesEvaluation")
134            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
135            .with_interceptor(StartConfigRulesEvaluationEndpointParamsInterceptor)
136            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
137                crate::operation::start_config_rules_evaluation::StartConfigRulesEvaluationError,
138            >::new())
139            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
140                crate::operation::start_config_rules_evaluation::StartConfigRulesEvaluationError,
141            >::new())
142            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
143                crate::operation::start_config_rules_evaluation::StartConfigRulesEvaluationError,
144            >::new());
145
146        ::std::borrow::Cow::Owned(rcb)
147    }
148}
149
150#[derive(Debug)]
151struct StartConfigRulesEvaluationResponseDeserializer;
152impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StartConfigRulesEvaluationResponseDeserializer {
153    fn deserialize_nonstreaming(
154        &self,
155        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
156    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
157        let (success, status) = (response.status().is_success(), response.status().as_u16());
158        let headers = response.headers();
159        let body = response.body().bytes().expect("body loaded");
160        #[allow(unused_mut)]
161        let mut force_error = false;
162        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
163        let parse_result = if !success && status != 200 || force_error {
164            crate::protocol_serde::shape_start_config_rules_evaluation::de_start_config_rules_evaluation_http_error(status, headers, body)
165        } else {
166            crate::protocol_serde::shape_start_config_rules_evaluation::de_start_config_rules_evaluation_http_response(status, headers, body)
167        };
168        crate::protocol_serde::type_erase_result(parse_result)
169    }
170}
171#[derive(Debug)]
172struct StartConfigRulesEvaluationRequestSerializer;
173impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StartConfigRulesEvaluationRequestSerializer {
174    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
175    fn serialize_input(
176        &self,
177        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
178        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
179    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
180        let input = input
181            .downcast::<crate::operation::start_config_rules_evaluation::StartConfigRulesEvaluationInput>()
182            .expect("correct type");
183        let _header_serialization_settings = _cfg
184            .load::<crate::serialization_settings::HeaderSerializationSettings>()
185            .cloned()
186            .unwrap_or_default();
187        let mut request_builder = {
188            fn uri_base(
189                _input: &crate::operation::start_config_rules_evaluation::StartConfigRulesEvaluationInput,
190                output: &mut ::std::string::String,
191            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
192                use ::std::fmt::Write as _;
193                ::std::write!(output, "/").expect("formatting should succeed");
194                ::std::result::Result::Ok(())
195            }
196            #[allow(clippy::unnecessary_wraps)]
197            fn update_http_builder(
198                input: &crate::operation::start_config_rules_evaluation::StartConfigRulesEvaluationInput,
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                ::std::result::Result::Ok(builder.method("POST").uri(uri))
204            }
205            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
206            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
207            builder = _header_serialization_settings.set_default_header(
208                builder,
209                ::http::header::HeaderName::from_static("x-amz-target"),
210                "StarlingDoveService.StartConfigRulesEvaluation",
211            );
212            builder
213        };
214        let body = ::aws_smithy_types::body::SdkBody::from(
215            crate::protocol_serde::shape_start_config_rules_evaluation::ser_start_config_rules_evaluation_input(&input)?,
216        );
217        if let Some(content_length) = body.content_length() {
218            let content_length = content_length.to_string();
219            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
220        }
221        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
222    }
223}
224#[derive(Debug)]
225struct StartConfigRulesEvaluationEndpointParamsInterceptor;
226
227impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartConfigRulesEvaluationEndpointParamsInterceptor {
228    fn name(&self) -> &'static str {
229        "StartConfigRulesEvaluationEndpointParamsInterceptor"
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::<StartConfigRulesEvaluationInput>()
245            .ok_or("failed to downcast to StartConfigRulesEvaluationInput")?;
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 `StartConfigRulesEvaluationError` operation.
266#[non_exhaustive]
267#[derive(::std::fmt::Debug)]
268pub enum StartConfigRulesEvaluationError {
269    /// <p>One or more of the specified parameters are not valid. Verify that your parameters are valid and try again.</p>
270    InvalidParameterValueException(crate::types::error::InvalidParameterValueException),
271    /// <p>For <code>PutServiceLinkedConfigurationRecorder</code> API, this exception is thrown if the number of service-linked roles in the account exceeds the limit.</p>
272    /// <p>For <code>StartConfigRulesEvaluation</code> API, this exception is thrown if an evaluation is in progress or if you call the <code>StartConfigRulesEvaluation</code> API more than once per minute.</p>
273    /// <p>For <code>PutConfigurationAggregator</code> API, this exception is thrown if the number of accounts and aggregators exceeds the limit.</p>
274    LimitExceededException(crate::types::error::LimitExceededException),
275    /// <p>The Config rule in the request is not valid. Verify that the rule is an Config Process Check rule, that the rule name is correct, and that valid Amazon Resouce Names (ARNs) are used before trying again.</p>
276    NoSuchConfigRuleException(crate::types::error::NoSuchConfigRuleException),
277    /// <p>You see this exception in the following cases:</p>
278    /// <ul>
279    /// <li>
280    /// <p>For DeleteConfigRule, Config is deleting this rule. Try your request again later.</p></li>
281    /// <li>
282    /// <p>For DeleteConfigRule, the rule is deleting your evaluation results. Try your request again later.</p></li>
283    /// <li>
284    /// <p>For DeleteConfigRule, a remediation action is associated with the rule and Config cannot delete this rule. Delete the remediation action associated with the rule before deleting the rule and try your request again later.</p></li>
285    /// <li>
286    /// <p>For PutConfigOrganizationRule, organization Config rule deletion is in progress. Try your request again later.</p></li>
287    /// <li>
288    /// <p>For DeleteOrganizationConfigRule, organization Config rule creation is in progress. Try your request again later.</p></li>
289    /// <li>
290    /// <p>For PutConformancePack and PutOrganizationConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.</p></li>
291    /// <li>
292    /// <p>For DeleteConformancePack, a conformance pack creation, update, and deletion is in progress. Try your request again later.</p></li>
293    /// </ul>
294    ResourceInUseException(crate::types::error::ResourceInUseException),
295    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
296    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
297    variable wildcard pattern and check `.code()`:
298     \
299    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
300     \
301    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StartConfigRulesEvaluationError) for what information is available for the error.")]
302    Unhandled(crate::error::sealed_unhandled::Unhandled),
303}
304impl StartConfigRulesEvaluationError {
305    /// Creates the `StartConfigRulesEvaluationError::Unhandled` variant from any error type.
306    pub fn unhandled(
307        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
308    ) -> Self {
309        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
310            source: err.into(),
311            meta: ::std::default::Default::default(),
312        })
313    }
314
315    /// Creates the `StartConfigRulesEvaluationError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
316    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
317        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
318            source: err.clone().into(),
319            meta: err,
320        })
321    }
322    ///
323    /// Returns error metadata, which includes the error code, message,
324    /// request ID, and potentially additional information.
325    ///
326    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
327        match self {
328            Self::InvalidParameterValueException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
329            Self::LimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
330            Self::NoSuchConfigRuleException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
331            Self::ResourceInUseException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
332            Self::Unhandled(e) => &e.meta,
333        }
334    }
335    /// Returns `true` if the error kind is `StartConfigRulesEvaluationError::InvalidParameterValueException`.
336    pub fn is_invalid_parameter_value_exception(&self) -> bool {
337        matches!(self, Self::InvalidParameterValueException(_))
338    }
339    /// Returns `true` if the error kind is `StartConfigRulesEvaluationError::LimitExceededException`.
340    pub fn is_limit_exceeded_exception(&self) -> bool {
341        matches!(self, Self::LimitExceededException(_))
342    }
343    /// Returns `true` if the error kind is `StartConfigRulesEvaluationError::NoSuchConfigRuleException`.
344    pub fn is_no_such_config_rule_exception(&self) -> bool {
345        matches!(self, Self::NoSuchConfigRuleException(_))
346    }
347    /// Returns `true` if the error kind is `StartConfigRulesEvaluationError::ResourceInUseException`.
348    pub fn is_resource_in_use_exception(&self) -> bool {
349        matches!(self, Self::ResourceInUseException(_))
350    }
351}
352impl ::std::error::Error for StartConfigRulesEvaluationError {
353    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
354        match self {
355            Self::InvalidParameterValueException(_inner) => ::std::option::Option::Some(_inner),
356            Self::LimitExceededException(_inner) => ::std::option::Option::Some(_inner),
357            Self::NoSuchConfigRuleException(_inner) => ::std::option::Option::Some(_inner),
358            Self::ResourceInUseException(_inner) => ::std::option::Option::Some(_inner),
359            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
360        }
361    }
362}
363impl ::std::fmt::Display for StartConfigRulesEvaluationError {
364    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
365        match self {
366            Self::InvalidParameterValueException(_inner) => _inner.fmt(f),
367            Self::LimitExceededException(_inner) => _inner.fmt(f),
368            Self::NoSuchConfigRuleException(_inner) => _inner.fmt(f),
369            Self::ResourceInUseException(_inner) => _inner.fmt(f),
370            Self::Unhandled(_inner) => {
371                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
372                    write!(f, "unhandled error ({code})")
373                } else {
374                    f.write_str("unhandled error")
375                }
376            }
377        }
378    }
379}
380impl ::aws_smithy_types::retry::ProvideErrorKind for StartConfigRulesEvaluationError {
381    fn code(&self) -> ::std::option::Option<&str> {
382        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
383    }
384    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
385        ::std::option::Option::None
386    }
387}
388impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StartConfigRulesEvaluationError {
389    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
390        match self {
391            Self::InvalidParameterValueException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
392            Self::LimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
393            Self::NoSuchConfigRuleException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
394            Self::ResourceInUseException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
395            Self::Unhandled(_inner) => &_inner.meta,
396        }
397    }
398}
399impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StartConfigRulesEvaluationError {
400    fn create_unhandled_error(
401        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
402        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
403    ) -> Self {
404        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
405            source,
406            meta: meta.unwrap_or_default(),
407        })
408    }
409}
410impl ::aws_types::request_id::RequestId for crate::operation::start_config_rules_evaluation::StartConfigRulesEvaluationError {
411    fn request_id(&self) -> Option<&str> {
412        self.meta().request_id()
413    }
414}
415
416pub use crate::operation::start_config_rules_evaluation::_start_config_rules_evaluation_output::StartConfigRulesEvaluationOutput;
417
418pub use crate::operation::start_config_rules_evaluation::_start_config_rules_evaluation_input::StartConfigRulesEvaluationInput;
419
420mod _start_config_rules_evaluation_input;
421
422mod _start_config_rules_evaluation_output;
423
424/// Builders
425pub mod builders;