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

aws_sdk_apigatewayv2/operation/
get_api.rs
