aws_sdk_apigateway/operation/
get_documentation_part.rs

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

aws_sdk_apigateway/operation/
get_documentation_part.rs
