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

aws_sdk_transfer/operation/
describe_certificate.rs
