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            #[allow(clippy::uninlined_format_args)]
176            fn uri_base(
177                _input: &crate::operation::subscribe::SubscribeInput,
178                output: &mut ::std::string::String,
179            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
180                use ::std::fmt::Write as _;
181                ::std::write!(output, "/").expect("formatting should succeed");
182                ::std::result::Result::Ok(())
183            }
184            #[allow(clippy::unnecessary_wraps)]
185            fn update_http_builder(
186                input: &crate::operation::subscribe::SubscribeInput,
187                builder: ::http::request::Builder,
188            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
189                let mut uri = ::std::string::String::new();
190                uri_base(input, &mut uri)?;
191                ::std::result::Result::Ok(builder.method("POST").uri(uri))
192            }
193            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
194            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-www-form-urlencoded");
195            builder
196        };
197        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_subscribe_input::ser_subscribe_input_input_input(&input)?);
198        if let Some(content_length) = body.content_length() {
199            let content_length = content_length.to_string();
200            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
201        }
202        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
203    }
204}
205#[derive(Debug)]
206struct SubscribeEndpointParamsInterceptor;
207
208impl ::aws_smithy_runtime_api::client::interceptors::Intercept for SubscribeEndpointParamsInterceptor {
209    fn name(&self) -> &'static str {
210        "SubscribeEndpointParamsInterceptor"
211    }
212
213    fn read_before_execution(
214        &self,
215        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
216            '_,
217            ::aws_smithy_runtime_api::client::interceptors::context::Input,
218            ::aws_smithy_runtime_api::client::interceptors::context::Output,
219            ::aws_smithy_runtime_api::client::interceptors::context::Error,
220        >,
221        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
222    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
223        let _input = context
224            .input()
225            .downcast_ref::<SubscribeInput>()
226            .ok_or("failed to downcast to SubscribeInput")?;
227
228        let params = crate::config::endpoint::Params::builder()
229            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
230            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
231            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
232            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
233            .build()
234            .map_err(|err| {
235                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
236            })?;
237        cfg.interceptor_state()
238            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
239        ::std::result::Result::Ok(())
240    }
241}
242
243// The get_* functions below are generated from JMESPath expressions in the
244// operationContextParams trait. They target the operation's input shape.
245
246/// Error type for the `SubscribeError` operation.
247#[non_exhaustive]
248#[derive(::std::fmt::Debug)]
249pub enum SubscribeError {
250    /// <p>Indicates that the user has been denied access to the requested resource.</p>
251    AuthorizationErrorException(crate::types::error::AuthorizationErrorException),
252    /// <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 ServicesSupport Center.</p>
253    FilterPolicyLimitExceededException(crate::types::error::FilterPolicyLimitExceededException),
254    /// <p>Indicates an internal service error.</p>
255    InternalErrorException(crate::types::error::InternalErrorException),
256    /// <p>Indicates that a request parameter does not comply with the associated constraints.</p>
257    InvalidParameterException(crate::types::error::InvalidParameterException),
258    /// <p>The credential signature isn't valid. You must use an HTTPS endpoint and sign your request using Signature Version 4.</p>
259    InvalidSecurityException(crate::types::error::InvalidSecurityException),
260    /// <p>Indicates that the requested resource does not exist.</p>
261    NotFoundException(crate::types::error::NotFoundException),
262    /// <p>Indicates that the request parameter has exceeded the maximum number of concurrent message replays.</p>
263    ReplayLimitExceededException(crate::types::error::ReplayLimitExceededException),
264    /// <p>Indicates that the customer already owns the maximum allowed number of subscriptions.</p>
265    SubscriptionLimitExceededException(crate::types::error::SubscriptionLimitExceededException),
266    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
267    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
268    variable wildcard pattern and check `.code()`:
269     \
270    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
271     \
272    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-SubscribeError) for what information is available for the error.")]
273    Unhandled(crate::error::sealed_unhandled::Unhandled),
274}
275impl SubscribeError {
276    /// Creates the `SubscribeError::Unhandled` variant from any error type.
277    pub fn unhandled(
278        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
279    ) -> Self {
280        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
281            source: err.into(),
282            meta: ::std::default::Default::default(),
283        })
284    }
285
286    /// Creates the `SubscribeError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
287    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
288        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
289            source: err.clone().into(),
290            meta: err,
291        })
292    }
293    ///
294    /// Returns error metadata, which includes the error code, message,
295    /// request ID, and potentially additional information.
296    ///
297    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
298        match self {
299            Self::AuthorizationErrorException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
300            Self::FilterPolicyLimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
301            Self::InternalErrorException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
302            Self::InvalidParameterException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
303            Self::InvalidSecurityException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
304            Self::NotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
305            Self::ReplayLimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
306            Self::SubscriptionLimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
307            Self::Unhandled(e) => &e.meta,
308        }
309    }
310    /// Returns `true` if the error kind is `SubscribeError::AuthorizationErrorException`.
311    pub fn is_authorization_error_exception(&self) -> bool {
312        matches!(self, Self::AuthorizationErrorException(_))
313    }
314    /// Returns `true` if the error kind is `SubscribeError::FilterPolicyLimitExceededException`.
315    pub fn is_filter_policy_limit_exceeded_exception(&self) -> bool {
316        matches!(self, Self::FilterPolicyLimitExceededException(_))
317    }
318    /// Returns `true` if the error kind is `SubscribeError::InternalErrorException`.
319    pub fn is_internal_error_exception(&self) -> bool {
320        matches!(self, Self::InternalErrorException(_))
321    }
322    /// Returns `true` if the error kind is `SubscribeError::InvalidParameterException`.
323    pub fn is_invalid_parameter_exception(&self) -> bool {
324        matches!(self, Self::InvalidParameterException(_))
325    }
326    /// Returns `true` if the error kind is `SubscribeError::InvalidSecurityException`.
327    pub fn is_invalid_security_exception(&self) -> bool {
328        matches!(self, Self::InvalidSecurityException(_))
329    }
330    /// Returns `true` if the error kind is `SubscribeError::NotFoundException`.
331    pub fn is_not_found_exception(&self) -> bool {
332        matches!(self, Self::NotFoundException(_))
333    }
334    /// Returns `true` if the error kind is `SubscribeError::ReplayLimitExceededException`.
335    pub fn is_replay_limit_exceeded_exception(&self) -> bool {
336        matches!(self, Self::ReplayLimitExceededException(_))
337    }
338    /// Returns `true` if the error kind is `SubscribeError::SubscriptionLimitExceededException`.
339    pub fn is_subscription_limit_exceeded_exception(&self) -> bool {
340        matches!(self, Self::SubscriptionLimitExceededException(_))
341    }
342}
343impl ::std::error::Error for SubscribeError {
344    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
345        match self {
346            Self::AuthorizationErrorException(_inner) => ::std::option::Option::Some(_inner),
347            Self::FilterPolicyLimitExceededException(_inner) => ::std::option::Option::Some(_inner),
348            Self::InternalErrorException(_inner) => ::std::option::Option::Some(_inner),
349            Self::InvalidParameterException(_inner) => ::std::option::Option::Some(_inner),
350            Self::InvalidSecurityException(_inner) => ::std::option::Option::Some(_inner),
351            Self::NotFoundException(_inner) => ::std::option::Option::Some(_inner),
352            Self::ReplayLimitExceededException(_inner) => ::std::option::Option::Some(_inner),
353            Self::SubscriptionLimitExceededException(_inner) => ::std::option::Option::Some(_inner),
354            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
355        }
356    }
357}
358impl ::std::fmt::Display for SubscribeError {
359    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
360        match self {
361            Self::AuthorizationErrorException(_inner) => _inner.fmt(f),
362            Self::FilterPolicyLimitExceededException(_inner) => _inner.fmt(f),
363            Self::InternalErrorException(_inner) => _inner.fmt(f),
364            Self::InvalidParameterException(_inner) => _inner.fmt(f),
365            Self::InvalidSecurityException(_inner) => _inner.fmt(f),
366            Self::NotFoundException(_inner) => _inner.fmt(f),
367            Self::ReplayLimitExceededException(_inner) => _inner.fmt(f),
368            Self::SubscriptionLimitExceededException(_inner) => _inner.fmt(f),
369            Self::Unhandled(_inner) => {
370                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
371                    write!(f, "unhandled error ({code})")
372                } else {
373                    f.write_str("unhandled error")
374                }
375            }
376        }
377    }
378}
379impl ::aws_smithy_types::retry::ProvideErrorKind for SubscribeError {
380    fn code(&self) -> ::std::option::Option<&str> {
381        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
382    }
383    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
384        ::std::option::Option::None
385    }
386}
387impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for SubscribeError {
388    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
389        match self {
390            Self::AuthorizationErrorException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
391            Self::FilterPolicyLimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
392            Self::InternalErrorException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
393            Self::InvalidParameterException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
394            Self::InvalidSecurityException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
395            Self::NotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
396            Self::ReplayLimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
397            Self::SubscriptionLimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
398            Self::Unhandled(_inner) => &_inner.meta,
399        }
400    }
401}
402impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for SubscribeError {
403    fn create_unhandled_error(
404        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
405        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
406    ) -> Self {
407        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
408            source,
409            meta: meta.unwrap_or_default(),
410        })
411    }
412}
413impl ::aws_types::request_id::RequestId for crate::operation::subscribe::SubscribeError {
414    fn request_id(&self) -> Option<&str> {
415        self.meta().request_id()
416    }
417}
418
419pub use crate::operation::subscribe::_subscribe_output::SubscribeOutput;
420
421pub use crate::operation::subscribe::_subscribe_input::SubscribeInput;
422
423mod _subscribe_input;
424
425mod _subscribe_output;
426
427/// Builders
428pub mod builders;
aws_sdk_sns/operation/subscribe.rs

aws_sdk_sns/operation/
subscribe.rs
