aws_sdk_apigatewayv2/operation/
get_api.rs

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

aws_sdk_apigatewayv2/operation/
get_api.rs
