aws_sdk_connect/operation/
describe_evaluation_form.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeEvaluationForm`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeEvaluationForm;
6impl DescribeEvaluationForm {
7    /// Creates a new `DescribeEvaluationForm`
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_evaluation_form::DescribeEvaluationFormInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_evaluation_form::DescribeEvaluationFormOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_evaluation_form::DescribeEvaluationFormError,
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_evaluation_form::DescribeEvaluationFormError>()
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_evaluation_form::DescribeEvaluationFormOutput>()
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_evaluation_form::DescribeEvaluationFormInput,
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("Connect", "DescribeEvaluationForm", 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                "Connect.DescribeEvaluationForm",
59                "rpc.service" = "Connect",
60                "rpc.method" = "DescribeEvaluationForm",
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 DescribeEvaluationForm {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeEvaluationForm");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            DescribeEvaluationFormRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            DescribeEvaluationFormResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("DescribeEvaluationForm")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "DescribeEvaluationForm",
107            "Connect",
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("DescribeEvaluationForm")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(DescribeEvaluationFormEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::describe_evaluation_form::DescribeEvaluationFormError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::describe_evaluation_form::DescribeEvaluationFormError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::describe_evaluation_form::DescribeEvaluationFormError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct DescribeEvaluationFormResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeEvaluationFormResponseDeserializer {
148    fn deserialize_nonstreaming(
149        &self,
150        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
151    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
152        let (success, status) = (response.status().is_success(), response.status().as_u16());
153        let headers = response.headers();
154        let body = response.body().bytes().expect("body loaded");
155        #[allow(unused_mut)]
156        let mut force_error = false;
157        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
158        let parse_result = if !success && status != 200 || force_error {
159            crate::protocol_serde::shape_describe_evaluation_form::de_describe_evaluation_form_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_describe_evaluation_form::de_describe_evaluation_form_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct DescribeEvaluationFormRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeEvaluationFormRequestSerializer {
169    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
170    fn serialize_input(
171        &self,
172        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
173        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
174    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
175        let input = input
176            .downcast::<crate::operation::describe_evaluation_form::DescribeEvaluationFormInput>()
177            .expect("correct type");
178        let _header_serialization_settings = _cfg
179            .load::<crate::serialization_settings::HeaderSerializationSettings>()
180            .cloned()
181            .unwrap_or_default();
182        let mut request_builder = {
183            #[allow(clippy::uninlined_format_args)]
184            fn uri_base(
185                _input: &crate::operation::describe_evaluation_form::DescribeEvaluationFormInput,
186                output: &mut ::std::string::String,
187            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
188                use ::std::fmt::Write as _;
189                let input_1 = &_input.instance_id;
190                let input_1 = input_1
191                    .as_ref()
192                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("instance_id", "cannot be empty or unset"))?;
193                let instance_id = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
194                if instance_id.is_empty() {
195                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
196                        "instance_id",
197                        "cannot be empty or unset",
198                    ));
199                }
200                let input_2 = &_input.evaluation_form_id;
201                let input_2 = input_2.as_ref().ok_or_else(|| {
202                    ::aws_smithy_types::error::operation::BuildError::missing_field("evaluation_form_id", "cannot be empty or unset")
203                })?;
204                let evaluation_form_id = ::aws_smithy_http::label::fmt_string(input_2, ::aws_smithy_http::label::EncodingStrategy::Default);
205                if evaluation_form_id.is_empty() {
206                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
207                        "evaluation_form_id",
208                        "cannot be empty or unset",
209                    ));
210                }
211                ::std::write!(
212                    output,
213                    "/evaluation-forms/{InstanceId}/{EvaluationFormId}",
214                    InstanceId = instance_id,
215                    EvaluationFormId = evaluation_form_id
216                )
217                .expect("formatting should succeed");
218                ::std::result::Result::Ok(())
219            }
220            fn uri_query(
221                _input: &crate::operation::describe_evaluation_form::DescribeEvaluationFormInput,
222                mut output: &mut ::std::string::String,
223            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
224                let mut query = ::aws_smithy_http::query::Writer::new(output);
225                if let ::std::option::Option::Some(inner_3) = &_input.evaluation_form_version {
226                    {
227                        query.push_kv("version", ::aws_smithy_types::primitive::Encoder::from(*inner_3).encode());
228                    }
229                }
230                ::std::result::Result::Ok(())
231            }
232            #[allow(clippy::unnecessary_wraps)]
233            fn update_http_builder(
234                input: &crate::operation::describe_evaluation_form::DescribeEvaluationFormInput,
235                builder: ::http::request::Builder,
236            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
237                let mut uri = ::std::string::String::new();
238                uri_base(input, &mut uri)?;
239                uri_query(input, &mut uri)?;
240                ::std::result::Result::Ok(builder.method("GET").uri(uri))
241            }
242            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
243            builder
244        };
245        let body = ::aws_smithy_types::body::SdkBody::from("");
246
247        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
248    }
249}
250#[derive(Debug)]
251struct DescribeEvaluationFormEndpointParamsInterceptor;
252
253impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeEvaluationFormEndpointParamsInterceptor {
254    fn name(&self) -> &'static str {
255        "DescribeEvaluationFormEndpointParamsInterceptor"
256    }
257
258    fn read_before_execution(
259        &self,
260        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
261            '_,
262            ::aws_smithy_runtime_api::client::interceptors::context::Input,
263            ::aws_smithy_runtime_api::client::interceptors::context::Output,
264            ::aws_smithy_runtime_api::client::interceptors::context::Error,
265        >,
266        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
267    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
268        let _input = context
269            .input()
270            .downcast_ref::<DescribeEvaluationFormInput>()
271            .ok_or("failed to downcast to DescribeEvaluationFormInput")?;
272
273        let params = crate::config::endpoint::Params::builder()
274            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
275            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
276            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
277            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
278            .build()
279            .map_err(|err| {
280                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
281            })?;
282        cfg.interceptor_state()
283            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
284        ::std::result::Result::Ok(())
285    }
286}
287
288// The get_* functions below are generated from JMESPath expressions in the
289// operationContextParams trait. They target the operation's input shape.
290
291/// Error type for the `DescribeEvaluationFormError` operation.
292#[non_exhaustive]
293#[derive(::std::fmt::Debug)]
294pub enum DescribeEvaluationFormError {
295    /// <p>Request processing failed because of an error or failure with the service.</p>
296    InternalServiceException(crate::types::error::InternalServiceException),
297    /// <p>One or more of the specified parameters are not valid.</p>
298    InvalidParameterException(crate::types::error::InvalidParameterException),
299    /// <p>The specified resource was not found.</p>
300    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
301    /// <p>The throttling limit has been exceeded.</p>
302    ThrottlingException(crate::types::error::ThrottlingException),
303    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
304    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
305    variable wildcard pattern and check `.code()`:
306     \
307    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
308     \
309    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeEvaluationFormError) for what information is available for the error.")]
310    Unhandled(crate::error::sealed_unhandled::Unhandled),
311}
312impl DescribeEvaluationFormError {
313    /// Creates the `DescribeEvaluationFormError::Unhandled` variant from any error type.
314    pub fn unhandled(
315        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
316    ) -> Self {
317        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
318            source: err.into(),
319            meta: ::std::default::Default::default(),
320        })
321    }
322
323    /// Creates the `DescribeEvaluationFormError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
324    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
325        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
326            source: err.clone().into(),
327            meta: err,
328        })
329    }
330    ///
331    /// Returns error metadata, which includes the error code, message,
332    /// request ID, and potentially additional information.
333    ///
334    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
335        match self {
336            Self::InternalServiceException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
337            Self::InvalidParameterException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
338            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
339            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
340            Self::Unhandled(e) => &e.meta,
341        }
342    }
343    /// Returns `true` if the error kind is `DescribeEvaluationFormError::InternalServiceException`.
344    pub fn is_internal_service_exception(&self) -> bool {
345        matches!(self, Self::InternalServiceException(_))
346    }
347    /// Returns `true` if the error kind is `DescribeEvaluationFormError::InvalidParameterException`.
348    pub fn is_invalid_parameter_exception(&self) -> bool {
349        matches!(self, Self::InvalidParameterException(_))
350    }
351    /// Returns `true` if the error kind is `DescribeEvaluationFormError::ResourceNotFoundException`.
352    pub fn is_resource_not_found_exception(&self) -> bool {
353        matches!(self, Self::ResourceNotFoundException(_))
354    }
355    /// Returns `true` if the error kind is `DescribeEvaluationFormError::ThrottlingException`.
356    pub fn is_throttling_exception(&self) -> bool {
357        matches!(self, Self::ThrottlingException(_))
358    }
359}
360impl ::std::error::Error for DescribeEvaluationFormError {
361    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
362        match self {
363            Self::InternalServiceException(_inner) => ::std::option::Option::Some(_inner),
364            Self::InvalidParameterException(_inner) => ::std::option::Option::Some(_inner),
365            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
366            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
367            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
368        }
369    }
370}
371impl ::std::fmt::Display for DescribeEvaluationFormError {
372    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
373        match self {
374            Self::InternalServiceException(_inner) => _inner.fmt(f),
375            Self::InvalidParameterException(_inner) => _inner.fmt(f),
376            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
377            Self::ThrottlingException(_inner) => _inner.fmt(f),
378            Self::Unhandled(_inner) => {
379                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
380                    write!(f, "unhandled error ({code})")
381                } else {
382                    f.write_str("unhandled error")
383                }
384            }
385        }
386    }
387}
388impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeEvaluationFormError {
389    fn code(&self) -> ::std::option::Option<&str> {
390        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
391    }
392    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
393        ::std::option::Option::None
394    }
395}
396impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeEvaluationFormError {
397    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
398        match self {
399            Self::InternalServiceException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
400            Self::InvalidParameterException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
401            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
402            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
403            Self::Unhandled(_inner) => &_inner.meta,
404        }
405    }
406}
407impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeEvaluationFormError {
408    fn create_unhandled_error(
409        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
410        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
411    ) -> Self {
412        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
413            source,
414            meta: meta.unwrap_or_default(),
415        })
416    }
417}
418impl ::aws_types::request_id::RequestId for crate::operation::describe_evaluation_form::DescribeEvaluationFormError {
419    fn request_id(&self) -> Option<&str> {
420        self.meta().request_id()
421    }
422}
423
424pub use crate::operation::describe_evaluation_form::_describe_evaluation_form_output::DescribeEvaluationFormOutput;
425
426pub use crate::operation::describe_evaluation_form::_describe_evaluation_form_input::DescribeEvaluationFormInput;
427
428mod _describe_evaluation_form_input;
429
430mod _describe_evaluation_form_output;
431
432/// Builders
433pub mod builders;