aws_sdk_transfer/operation/
describe_certificate.rs

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

aws_sdk_transfer/operation/
describe_certificate.rs
