aws_sdk_apigateway/operation/
put_rest_api.rs

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