aws_sdk_apigateway/operation/
get_documentation_version.rs

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

aws_sdk_apigateway/operation/
get_documentation_version.rs
