aws_sdk_pinpointsmsvoicev2/operation/
put_keyword.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `PutKeyword`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct PutKeyword;
6impl PutKeyword {
7    /// Creates a new `PutKeyword`
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_keyword::PutKeywordInput,
14    ) -> ::std::result::Result<
15        crate::operation::put_keyword::PutKeywordOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::put_keyword::PutKeywordError,
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_keyword::PutKeywordError>()
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_keyword::PutKeywordOutput>()
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_keyword::PutKeywordInput,
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("Pinpoint SMS Voice V2", "PutKeyword", 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                "Pinpoint SMS Voice V2.PutKeyword",
59                "rpc.service" = "Pinpoint SMS Voice V2",
60                "rpc.method" = "PutKeyword",
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 PutKeyword {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("PutKeyword");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            PutKeywordRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            PutKeywordResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("PutKeyword")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "PutKeyword",
107            "Pinpoint SMS Voice V2",
108        ));
109        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
110        signing_options.double_uri_encode = true;
111        signing_options.content_sha256_header = false;
112        signing_options.normalize_uri_path = true;
113        signing_options.payload_override = None;
114
115        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
116            signing_options,
117            ..::std::default::Default::default()
118        });
119
120        ::std::option::Option::Some(cfg.freeze())
121    }
122
123    fn runtime_components(
124        &self,
125        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
126    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
127        #[allow(unused_mut)]
128        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("PutKeyword")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(PutKeywordEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::put_keyword::PutKeywordError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::put_keyword::PutKeywordError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::put_keyword::PutKeywordError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct PutKeywordResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for PutKeywordResponseDeserializer {
148    fn deserialize_nonstreaming(
149        &self,
150        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
151    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
152        let (success, status) = (response.status().is_success(), response.status().as_u16());
153        let headers = response.headers();
154        let body = response.body().bytes().expect("body loaded");
155        #[allow(unused_mut)]
156        let mut force_error = false;
157        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
158        let parse_result = if !success && status != 200 || force_error {
159            crate::protocol_serde::shape_put_keyword::de_put_keyword_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_put_keyword::de_put_keyword_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct PutKeywordRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for PutKeywordRequestSerializer {
169    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
170    fn serialize_input(
171        &self,
172        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
173        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
174    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
175        let input = input.downcast::<crate::operation::put_keyword::PutKeywordInput>().expect("correct type");
176        let _header_serialization_settings = _cfg
177            .load::<crate::serialization_settings::HeaderSerializationSettings>()
178            .cloned()
179            .unwrap_or_default();
180        let mut request_builder = {
181            #[allow(clippy::uninlined_format_args)]
182            fn uri_base(
183                _input: &crate::operation::put_keyword::PutKeywordInput,
184                output: &mut ::std::string::String,
185            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
186                use ::std::fmt::Write as _;
187                ::std::write!(output, "/").expect("formatting should succeed");
188                ::std::result::Result::Ok(())
189            }
190            #[allow(clippy::unnecessary_wraps)]
191            fn update_http_builder(
192                input: &crate::operation::put_keyword::PutKeywordInput,
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("POST").uri(uri))
198            }
199            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
200            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.0");
201            builder = _header_serialization_settings.set_default_header(
202                builder,
203                ::http::header::HeaderName::from_static("x-amz-target"),
204                "PinpointSMSVoiceV2.PutKeyword",
205            );
206            builder
207        };
208        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_put_keyword::ser_put_keyword_input(&input)?);
209        if let Some(content_length) = body.content_length() {
210            let content_length = content_length.to_string();
211            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
212        }
213        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
214    }
215}
216#[derive(Debug)]
217struct PutKeywordEndpointParamsInterceptor;
218
219impl ::aws_smithy_runtime_api::client::interceptors::Intercept for PutKeywordEndpointParamsInterceptor {
220    fn name(&self) -> &'static str {
221        "PutKeywordEndpointParamsInterceptor"
222    }
223
224    fn read_before_execution(
225        &self,
226        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
227            '_,
228            ::aws_smithy_runtime_api::client::interceptors::context::Input,
229            ::aws_smithy_runtime_api::client::interceptors::context::Output,
230            ::aws_smithy_runtime_api::client::interceptors::context::Error,
231        >,
232        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
233    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
234        let _input = context
235            .input()
236            .downcast_ref::<PutKeywordInput>()
237            .ok_or("failed to downcast to PutKeywordInput")?;
238
239        let params = crate::config::endpoint::Params::builder()
240            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
241            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
242            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
243            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
244            .build()
245            .map_err(|err| {
246                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
247            })?;
248        cfg.interceptor_state()
249            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
250        ::std::result::Result::Ok(())
251    }
252}
253
254// The get_* functions below are generated from JMESPath expressions in the
255// operationContextParams trait. They target the operation's input shape.
256
257/// Error type for the `PutKeywordError` operation.
258#[non_exhaustive]
259#[derive(::std::fmt::Debug)]
260pub enum PutKeywordError {
261    /// <p>The request was denied because you don't have sufficient permissions to access the resource.</p>
262    AccessDeniedException(crate::types::error::AccessDeniedException),
263    /// <p>Your request has conflicting operations. This can occur if you're trying to perform more than one operation on the same resource at the same time or it could be that the requested action isn't valid for the current state or configuration of the resource.</p>
264    ConflictException(crate::types::error::ConflictException),
265    /// <p>The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.</p>
266    InternalServerException(crate::types::error::InternalServerException),
267    /// <p>A requested resource couldn't be found.</p>
268    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
269    /// <p>The request would cause a service quota to be exceeded.</p>
270    ServiceQuotaExceededException(crate::types::error::ServiceQuotaExceededException),
271    /// <p>An error that occurred because too many requests were sent during a certain amount of time.</p>
272    ThrottlingException(crate::types::error::ThrottlingException),
273    /// <p>A validation exception for a field.</p>
274    ValidationException(crate::types::error::ValidationException),
275    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
276    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
277    variable wildcard pattern and check `.code()`:
278     \
279    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
280     \
281    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-PutKeywordError) for what information is available for the error.")]
282    Unhandled(crate::error::sealed_unhandled::Unhandled),
283}
284impl PutKeywordError {
285    /// Creates the `PutKeywordError::Unhandled` variant from any error type.
286    pub fn unhandled(
287        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
288    ) -> Self {
289        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
290            source: err.into(),
291            meta: ::std::default::Default::default(),
292        })
293    }
294
295    /// Creates the `PutKeywordError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
296    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
297        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
298            source: err.clone().into(),
299            meta: err,
300        })
301    }
302    ///
303    /// Returns error metadata, which includes the error code, message,
304    /// request ID, and potentially additional information.
305    ///
306    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
307        match self {
308            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
309            Self::ConflictException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
310            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
311            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
312            Self::ServiceQuotaExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
313            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
314            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
315            Self::Unhandled(e) => &e.meta,
316        }
317    }
318    /// Returns `true` if the error kind is `PutKeywordError::AccessDeniedException`.
319    pub fn is_access_denied_exception(&self) -> bool {
320        matches!(self, Self::AccessDeniedException(_))
321    }
322    /// Returns `true` if the error kind is `PutKeywordError::ConflictException`.
323    pub fn is_conflict_exception(&self) -> bool {
324        matches!(self, Self::ConflictException(_))
325    }
326    /// Returns `true` if the error kind is `PutKeywordError::InternalServerException`.
327    pub fn is_internal_server_exception(&self) -> bool {
328        matches!(self, Self::InternalServerException(_))
329    }
330    /// Returns `true` if the error kind is `PutKeywordError::ResourceNotFoundException`.
331    pub fn is_resource_not_found_exception(&self) -> bool {
332        matches!(self, Self::ResourceNotFoundException(_))
333    }
334    /// Returns `true` if the error kind is `PutKeywordError::ServiceQuotaExceededException`.
335    pub fn is_service_quota_exceeded_exception(&self) -> bool {
336        matches!(self, Self::ServiceQuotaExceededException(_))
337    }
338    /// Returns `true` if the error kind is `PutKeywordError::ThrottlingException`.
339    pub fn is_throttling_exception(&self) -> bool {
340        matches!(self, Self::ThrottlingException(_))
341    }
342    /// Returns `true` if the error kind is `PutKeywordError::ValidationException`.
343    pub fn is_validation_exception(&self) -> bool {
344        matches!(self, Self::ValidationException(_))
345    }
346}
347impl ::std::error::Error for PutKeywordError {
348    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
349        match self {
350            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
351            Self::ConflictException(_inner) => ::std::option::Option::Some(_inner),
352            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
353            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
354            Self::ServiceQuotaExceededException(_inner) => ::std::option::Option::Some(_inner),
355            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
356            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
357            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
358        }
359    }
360}
361impl ::std::fmt::Display for PutKeywordError {
362    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
363        match self {
364            Self::AccessDeniedException(_inner) => _inner.fmt(f),
365            Self::ConflictException(_inner) => _inner.fmt(f),
366            Self::InternalServerException(_inner) => _inner.fmt(f),
367            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
368            Self::ServiceQuotaExceededException(_inner) => _inner.fmt(f),
369            Self::ThrottlingException(_inner) => _inner.fmt(f),
370            Self::ValidationException(_inner) => _inner.fmt(f),
371            Self::Unhandled(_inner) => {
372                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
373                    write!(f, "unhandled error ({code})")
374                } else {
375                    f.write_str("unhandled error")
376                }
377            }
378        }
379    }
380}
381impl ::aws_smithy_types::retry::ProvideErrorKind for PutKeywordError {
382    fn code(&self) -> ::std::option::Option<&str> {
383        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
384    }
385    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
386        match self {
387            Self::InternalServerException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
388            Self::ThrottlingException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
389            _ => ::std::option::Option::None,
390        }
391    }
392}
393impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for PutKeywordError {
394    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
395        match self {
396            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
397            Self::ConflictException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
398            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
399            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
400            Self::ServiceQuotaExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
401            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
402            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
403            Self::Unhandled(_inner) => &_inner.meta,
404        }
405    }
406}
407impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for PutKeywordError {
408    fn create_unhandled_error(
409        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
410        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
411    ) -> Self {
412        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
413            source,
414            meta: meta.unwrap_or_default(),
415        })
416    }
417}
418impl ::aws_types::request_id::RequestId for crate::operation::put_keyword::PutKeywordError {
419    fn request_id(&self) -> Option<&str> {
420        self.meta().request_id()
421    }
422}
423
424pub use crate::operation::put_keyword::_put_keyword_output::PutKeywordOutput;
425
426pub use crate::operation::put_keyword::_put_keyword_input::PutKeywordInput;
427
428mod _put_keyword_input;
429
430mod _put_keyword_output;
431
432/// Builders
433pub mod builders;