aws_sdk_sns/operation/
subscribe.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `Subscribe`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct Subscribe;
6impl Subscribe {
7    /// Creates a new `Subscribe`
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::subscribe::SubscribeInput,
14    ) -> ::std::result::Result<
15        crate::operation::subscribe::SubscribeOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::subscribe::SubscribeError,
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| err.downcast::<crate::operation::subscribe::SubscribeError>().expect("correct error type"))
26        };
27        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
28            .await
29            .map_err(map_err)?;
30        let output = context.finalize().map_err(map_err)?;
31        ::std::result::Result::Ok(
32            output
33                .downcast::<crate::operation::subscribe::SubscribeOutput>()
34                .expect("correct output type"),
35        )
36    }
37
38    pub(crate) async fn orchestrate_with_stop_point(
39        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
40        input: crate::operation::subscribe::SubscribeInput,
41        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
42    ) -> ::std::result::Result<
43        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
44        ::aws_smithy_runtime_api::client::result::SdkError<
45            ::aws_smithy_runtime_api::client::interceptors::context::Error,
46            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
47        >,
48    > {
49        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
50        use ::tracing::Instrument;
51        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("SNS", "Subscribe", input, runtime_plugins, stop_point)
52            // Create a parent span for the entire operation. Includes a random, internal-only,
53            // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
54            .instrument(::tracing::debug_span!(
55                "SNS.Subscribe",
56                "rpc.service" = "SNS",
57                "rpc.method" = "Subscribe",
58                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
59                "rpc.system" = "aws-api",
60            ))
61            .await
62    }
63
64    pub(crate) fn operation_runtime_plugins(
65        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
66        client_config: &crate::config::Config,
67        config_override: ::std::option::Option<crate::config::Builder>,
68    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
69        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
70
71        if let ::std::option::Option::Some(config_override) = config_override {
72            for plugin in config_override.runtime_plugins.iter().cloned() {
73                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
74            }
75            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
76                config_override,
77                client_config.config.clone(),
78                &client_config.runtime_components,
79            ));
80        }
81        runtime_plugins
82    }
83}
84impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for Subscribe {
85    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
86        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("Subscribe");
87
88        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
89            SubscribeRequestSerializer,
90        ));
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
92            SubscribeResponseDeserializer,
93        ));
94
95        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
96            crate::config::auth::Params::builder()
97                .operation_name("Subscribe")
98                .build()
99                .expect("required fields set"),
100        ));
101
102        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("Subscribe", "SNS"));
103        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
104        signing_options.double_uri_encode = true;
105        signing_options.content_sha256_header = false;
106        signing_options.normalize_uri_path = true;
107        signing_options.payload_override = None;
108
109        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
110            signing_options,
111            ..::std::default::Default::default()
112        });
113
114        ::std::option::Option::Some(cfg.freeze())
115    }
116
117    fn runtime_components(
118        &self,
119        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
120    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
121        #[allow(unused_mut)]
122        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("Subscribe")
123            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
124            .with_interceptor(SubscribeEndpointParamsInterceptor)
125            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
126                crate::operation::subscribe::SubscribeError,
127            >::new())
128            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
129                crate::operation::subscribe::SubscribeError,
130            >::new())
131            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
132                crate::operation::subscribe::SubscribeError,
133            >::new());
134
135        ::std::borrow::Cow::Owned(rcb)
136    }
137}
138
139#[derive(Debug)]
140struct SubscribeResponseDeserializer;
141impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for SubscribeResponseDeserializer {
142    fn deserialize_nonstreaming(
143        &self,
144        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
145    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
146        let (success, status) = (response.status().is_success(), response.status().as_u16());
147        let headers = response.headers();
148        let body = response.body().bytes().expect("body loaded");
149        #[allow(unused_mut)]
150        let mut force_error = false;
151        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
152        let parse_result = if !success && status != 200 || force_error {
153            crate::protocol_serde::shape_subscribe::de_subscribe_http_error(status, headers, body)
154        } else {
155            crate::protocol_serde::shape_subscribe::de_subscribe_http_response(status, headers, body)
156        };
157        crate::protocol_serde::type_erase_result(parse_result)
158    }
159}
160#[derive(Debug)]
161struct SubscribeRequestSerializer;
162impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for SubscribeRequestSerializer {
163    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
164    fn serialize_input(
165        &self,
166        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
167        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
168    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
169        let input = input.downcast::<crate::operation::subscribe::SubscribeInput>().expect("correct type");
170        let _header_serialization_settings = _cfg
171            .load::<crate::serialization_settings::HeaderSerializationSettings>()
172            .cloned()
173            .unwrap_or_default();
174        let mut request_builder = {
175            fn uri_base(
176                _input: &crate::operation::subscribe::SubscribeInput,
177                output: &mut ::std::string::String,
178            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
179                use ::std::fmt::Write as _;
180                ::std::write!(output, "/").expect("formatting should succeed");
181                ::std::result::Result::Ok(())
182            }
183            #[allow(clippy::unnecessary_wraps)]
184            fn update_http_builder(
185                input: &crate::operation::subscribe::SubscribeInput,
186                builder: ::http::request::Builder,
187            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
188                let mut uri = ::std::string::String::new();
189                uri_base(input, &mut uri)?;
190                ::std::result::Result::Ok(builder.method("POST").uri(uri))
191            }
192            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
193            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-www-form-urlencoded");
194            builder
195        };
196        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_subscribe_input::ser_subscribe_input_input_input(&input)?);
197        if let Some(content_length) = body.content_length() {
198            let content_length = content_length.to_string();
199            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
200        }
201        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
202    }
203}
204#[derive(Debug)]
205struct SubscribeEndpointParamsInterceptor;
206
207impl ::aws_smithy_runtime_api::client::interceptors::Intercept for SubscribeEndpointParamsInterceptor {
208    fn name(&self) -> &'static str {
209        "SubscribeEndpointParamsInterceptor"
210    }
211
212    fn read_before_execution(
213        &self,
214        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
215            '_,
216            ::aws_smithy_runtime_api::client::interceptors::context::Input,
217            ::aws_smithy_runtime_api::client::interceptors::context::Output,
218            ::aws_smithy_runtime_api::client::interceptors::context::Error,
219        >,
220        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
221    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
222        let _input = context
223            .input()
224            .downcast_ref::<SubscribeInput>()
225            .ok_or("failed to downcast to SubscribeInput")?;
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 `SubscribeError` operation.
246#[non_exhaustive]
247#[derive(::std::fmt::Debug)]
248pub enum SubscribeError {
249    /// <p>Indicates that the user has been denied access to the requested resource.</p>
250    AuthorizationErrorException(crate::types::error::AuthorizationErrorException),
251    /// <p>Indicates that the number of filter polices in your Amazon Web Services account exceeds the limit. To add more filter polices, submit an Amazon SNS Limit Increase case in the Amazon Web Services Support Center.</p>
252    FilterPolicyLimitExceededException(crate::types::error::FilterPolicyLimitExceededException),
253    /// <p>Indicates an internal service error.</p>
254    InternalErrorException(crate::types::error::InternalErrorException),
255    /// <p>Indicates that a request parameter does not comply with the associated constraints.</p>
256    InvalidParameterException(crate::types::error::InvalidParameterException),
257    /// <p>The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.</p>
258    InvalidSecurityException(crate::types::error::InvalidSecurityException),
259    /// <p>Indicates that the requested resource does not exist.</p>
260    NotFoundException(crate::types::error::NotFoundException),
261    /// <p>Indicates that the request parameter has exceeded the maximum number of concurrent message replays.</p>
262    ReplayLimitExceededException(crate::types::error::ReplayLimitExceededException),
263    /// <p>Indicates that the customer already owns the maximum allowed number of subscriptions.</p>
264    SubscriptionLimitExceededException(crate::types::error::SubscriptionLimitExceededException),
265    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
266    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
267    variable wildcard pattern and check `.code()`:
268     \
269    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
270     \
271    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-SubscribeError) for what information is available for the error.")]
272    Unhandled(crate::error::sealed_unhandled::Unhandled),
273}
274impl SubscribeError {
275    /// Creates the `SubscribeError::Unhandled` variant from any error type.
276    pub fn unhandled(
277        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
278    ) -> Self {
279        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
280            source: err.into(),
281            meta: ::std::default::Default::default(),
282        })
283    }
284
285    /// Creates the `SubscribeError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
286    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
287        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
288            source: err.clone().into(),
289            meta: err,
290        })
291    }
292    ///
293    /// Returns error metadata, which includes the error code, message,
294    /// request ID, and potentially additional information.
295    ///
296    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
297        match self {
298            Self::AuthorizationErrorException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
299            Self::FilterPolicyLimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
300            Self::InternalErrorException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
301            Self::InvalidParameterException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
302            Self::InvalidSecurityException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
303            Self::NotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
304            Self::ReplayLimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
305            Self::SubscriptionLimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
306            Self::Unhandled(e) => &e.meta,
307        }
308    }
309    /// Returns `true` if the error kind is `SubscribeError::AuthorizationErrorException`.
310    pub fn is_authorization_error_exception(&self) -> bool {
311        matches!(self, Self::AuthorizationErrorException(_))
312    }
313    /// Returns `true` if the error kind is `SubscribeError::FilterPolicyLimitExceededException`.
314    pub fn is_filter_policy_limit_exceeded_exception(&self) -> bool {
315        matches!(self, Self::FilterPolicyLimitExceededException(_))
316    }
317    /// Returns `true` if the error kind is `SubscribeError::InternalErrorException`.
318    pub fn is_internal_error_exception(&self) -> bool {
319        matches!(self, Self::InternalErrorException(_))
320    }
321    /// Returns `true` if the error kind is `SubscribeError::InvalidParameterException`.
322    pub fn is_invalid_parameter_exception(&self) -> bool {
323        matches!(self, Self::InvalidParameterException(_))
324    }
325    /// Returns `true` if the error kind is `SubscribeError::InvalidSecurityException`.
326    pub fn is_invalid_security_exception(&self) -> bool {
327        matches!(self, Self::InvalidSecurityException(_))
328    }
329    /// Returns `true` if the error kind is `SubscribeError::NotFoundException`.
330    pub fn is_not_found_exception(&self) -> bool {
331        matches!(self, Self::NotFoundException(_))
332    }
333    /// Returns `true` if the error kind is `SubscribeError::ReplayLimitExceededException`.
334    pub fn is_replay_limit_exceeded_exception(&self) -> bool {
335        matches!(self, Self::ReplayLimitExceededException(_))
336    }
337    /// Returns `true` if the error kind is `SubscribeError::SubscriptionLimitExceededException`.
338    pub fn is_subscription_limit_exceeded_exception(&self) -> bool {
339        matches!(self, Self::SubscriptionLimitExceededException(_))
340    }
341}
342impl ::std::error::Error for SubscribeError {
343    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
344        match self {
345            Self::AuthorizationErrorException(_inner) => ::std::option::Option::Some(_inner),
346            Self::FilterPolicyLimitExceededException(_inner) => ::std::option::Option::Some(_inner),
347            Self::InternalErrorException(_inner) => ::std::option::Option::Some(_inner),
348            Self::InvalidParameterException(_inner) => ::std::option::Option::Some(_inner),
349            Self::InvalidSecurityException(_inner) => ::std::option::Option::Some(_inner),
350            Self::NotFoundException(_inner) => ::std::option::Option::Some(_inner),
351            Self::ReplayLimitExceededException(_inner) => ::std::option::Option::Some(_inner),
352            Self::SubscriptionLimitExceededException(_inner) => ::std::option::Option::Some(_inner),
353            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
354        }
355    }
356}
357impl ::std::fmt::Display for SubscribeError {
358    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
359        match self {
360            Self::AuthorizationErrorException(_inner) => _inner.fmt(f),
361            Self::FilterPolicyLimitExceededException(_inner) => _inner.fmt(f),
362            Self::InternalErrorException(_inner) => _inner.fmt(f),
363            Self::InvalidParameterException(_inner) => _inner.fmt(f),
364            Self::InvalidSecurityException(_inner) => _inner.fmt(f),
365            Self::NotFoundException(_inner) => _inner.fmt(f),
366            Self::ReplayLimitExceededException(_inner) => _inner.fmt(f),
367            Self::SubscriptionLimitExceededException(_inner) => _inner.fmt(f),
368            Self::Unhandled(_inner) => {
369                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
370                    write!(f, "unhandled error ({code})")
371                } else {
372                    f.write_str("unhandled error")
373                }
374            }
375        }
376    }
377}
378impl ::aws_smithy_types::retry::ProvideErrorKind for SubscribeError {
379    fn code(&self) -> ::std::option::Option<&str> {
380        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
381    }
382    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
383        ::std::option::Option::None
384    }
385}
386impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for SubscribeError {
387    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
388        match self {
389            Self::AuthorizationErrorException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
390            Self::FilterPolicyLimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
391            Self::InternalErrorException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
392            Self::InvalidParameterException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
393            Self::InvalidSecurityException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
394            Self::NotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
395            Self::ReplayLimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
396            Self::SubscriptionLimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
397            Self::Unhandled(_inner) => &_inner.meta,
398        }
399    }
400}
401impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for SubscribeError {
402    fn create_unhandled_error(
403        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
404        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
405    ) -> Self {
406        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
407            source,
408            meta: meta.unwrap_or_default(),
409        })
410    }
411}
412impl ::aws_types::request_id::RequestId for crate::operation::subscribe::SubscribeError {
413    fn request_id(&self) -> Option<&str> {
414        self.meta().request_id()
415    }
416}
417
418pub use crate::operation::subscribe::_subscribe_output::SubscribeOutput;
419
420pub use crate::operation::subscribe::_subscribe_input::SubscribeInput;
421
422mod _subscribe_input;
423
424mod _subscribe_output;
425
426/// Builders
427pub mod builders;
aws_sdk_sns/operation/subscribe.rs

aws_sdk_sns/operation/
subscribe.rs
