aws_sdk_connect/operation/
describe_rule.rs

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

aws_sdk_connect/operation/
describe_rule.rs
