aws_sdk_pipes/operation/
stop_pipe.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `StopPipe`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StopPipe;
6impl StopPipe {
7    /// Creates a new `StopPipe`
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::stop_pipe::StopPipeInput,
14    ) -> ::std::result::Result<
15        crate::operation::stop_pipe::StopPipeOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::stop_pipe::StopPipeError,
18            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
19        >,
20    > {
21        let map_err =
22            |err: ::aws_smithy_runtime_api::client::result::SdkError<
23                ::aws_smithy_runtime_api::client::interceptors::context::Error,
24                ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
25            >| { err.map_service_error(|err| err.downcast::<crate::operation::stop_pipe::StopPipeError>().expect("correct error type")) };
26        let context = Self::orchestrate_with_stop_point(runtime_plugins, input, ::aws_smithy_runtime::client::orchestrator::StopPoint::None)
27            .await
28            .map_err(map_err)?;
29        let output = context.finalize().map_err(map_err)?;
30        ::std::result::Result::Ok(
31            output
32                .downcast::<crate::operation::stop_pipe::StopPipeOutput>()
33                .expect("correct output type"),
34        )
35    }
36
37    pub(crate) async fn orchestrate_with_stop_point(
38        runtime_plugins: &::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
39        input: crate::operation::stop_pipe::StopPipeInput,
40        stop_point: ::aws_smithy_runtime::client::orchestrator::StopPoint,
41    ) -> ::std::result::Result<
42        ::aws_smithy_runtime_api::client::interceptors::context::InterceptorContext,
43        ::aws_smithy_runtime_api::client::result::SdkError<
44            ::aws_smithy_runtime_api::client::interceptors::context::Error,
45            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
46        >,
47    > {
48        let input = ::aws_smithy_runtime_api::client::interceptors::context::Input::erase(input);
49        ::aws_smithy_runtime::client::orchestrator::invoke_with_stop_point("pipes", "StopPipe", input, runtime_plugins, stop_point).await
50    }
51
52    pub(crate) fn operation_runtime_plugins(
53        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
54        client_config: &crate::config::Config,
55        config_override: ::std::option::Option<crate::config::Builder>,
56    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
57        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
58        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
59            ::aws_runtime::auth::sigv4::SCHEME_ID,
60        ]));
61        if let ::std::option::Option::Some(config_override) = config_override {
62            for plugin in config_override.runtime_plugins.iter().cloned() {
63                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
64            }
65            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
66                config_override,
67                client_config.config.clone(),
68                &client_config.runtime_components,
69            ));
70        }
71        runtime_plugins
72    }
73}
74impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for StopPipe {
75    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
76        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("StopPipe");
77
78        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
79            StopPipeRequestSerializer,
80        ));
81        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
82            StopPipeResponseDeserializer,
83        ));
84
85        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
86            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
87        ));
88
89        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("StopPipe", "pipes"));
90        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
91        signing_options.double_uri_encode = true;
92        signing_options.content_sha256_header = false;
93        signing_options.normalize_uri_path = true;
94        signing_options.payload_override = None;
95
96        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
97            signing_options,
98            ..::std::default::Default::default()
99        });
100
101        ::std::option::Option::Some(cfg.freeze())
102    }
103
104    fn runtime_components(
105        &self,
106        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
107    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
108        #[allow(unused_mut)]
109        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("StopPipe")
110            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
111            .with_interceptor(StopPipeEndpointParamsInterceptor)
112            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
113                crate::operation::stop_pipe::StopPipeError,
114            >::new())
115            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
116                crate::operation::stop_pipe::StopPipeError,
117            >::new())
118            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
119                crate::operation::stop_pipe::StopPipeError,
120            >::new());
121
122        ::std::borrow::Cow::Owned(rcb)
123    }
124}
125
126#[derive(Debug)]
127struct StopPipeResponseDeserializer;
128impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StopPipeResponseDeserializer {
129    fn deserialize_nonstreaming(
130        &self,
131        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
132    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
133        let (success, status) = (response.status().is_success(), response.status().as_u16());
134        let headers = response.headers();
135        let body = response.body().bytes().expect("body loaded");
136        #[allow(unused_mut)]
137        let mut force_error = false;
138        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
139        let parse_result = if !success && status != 200 || force_error {
140            crate::protocol_serde::shape_stop_pipe::de_stop_pipe_http_error(status, headers, body)
141        } else {
142            crate::protocol_serde::shape_stop_pipe::de_stop_pipe_http_response(status, headers, body)
143        };
144        crate::protocol_serde::type_erase_result(parse_result)
145    }
146}
147#[derive(Debug)]
148struct StopPipeRequestSerializer;
149impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StopPipeRequestSerializer {
150    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
151    fn serialize_input(
152        &self,
153        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
154        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
155    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
156        let input = input.downcast::<crate::operation::stop_pipe::StopPipeInput>().expect("correct type");
157        let _header_serialization_settings = _cfg
158            .load::<crate::serialization_settings::HeaderSerializationSettings>()
159            .cloned()
160            .unwrap_or_default();
161        let mut request_builder = {
162            fn uri_base(
163                _input: &crate::operation::stop_pipe::StopPipeInput,
164                output: &mut ::std::string::String,
165            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
166                use ::std::fmt::Write as _;
167                let input_1 = &_input.name;
168                let input_1 = input_1
169                    .as_ref()
170                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("name", "cannot be empty or unset"))?;
171                let name = ::aws_smithy_http::label::fmt_string(input_1, ::aws_smithy_http::label::EncodingStrategy::Default);
172                if name.is_empty() {
173                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
174                        "name",
175                        "cannot be empty or unset",
176                    ));
177                }
178                ::std::write!(output, "/v1/pipes/{Name}/stop", Name = name).expect("formatting should succeed");
179                ::std::result::Result::Ok(())
180            }
181            #[allow(clippy::unnecessary_wraps)]
182            fn update_http_builder(
183                input: &crate::operation::stop_pipe::StopPipeInput,
184                builder: ::http::request::Builder,
185            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
186                let mut uri = ::std::string::String::new();
187                uri_base(input, &mut uri)?;
188                ::std::result::Result::Ok(builder.method("POST").uri(uri))
189            }
190            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
191            builder
192        };
193        let body = ::aws_smithy_types::body::SdkBody::from("");
194
195        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
196    }
197}
198#[derive(Debug)]
199struct StopPipeEndpointParamsInterceptor;
200
201impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StopPipeEndpointParamsInterceptor {
202    fn name(&self) -> &'static str {
203        "StopPipeEndpointParamsInterceptor"
204    }
205
206    fn read_before_execution(
207        &self,
208        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
209            '_,
210            ::aws_smithy_runtime_api::client::interceptors::context::Input,
211            ::aws_smithy_runtime_api::client::interceptors::context::Output,
212            ::aws_smithy_runtime_api::client::interceptors::context::Error,
213        >,
214        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
215    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
216        let _input = context
217            .input()
218            .downcast_ref::<StopPipeInput>()
219            .ok_or("failed to downcast to StopPipeInput")?;
220
221        let params = crate::config::endpoint::Params::builder()
222            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
223            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
224            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
225            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
226            .build()
227            .map_err(|err| {
228                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
229            })?;
230        cfg.interceptor_state()
231            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
232        ::std::result::Result::Ok(())
233    }
234}
235
236// The get_* functions below are generated from JMESPath expressions in the
237// operationContextParams trait. They target the operation's input shape.
238
239/// Error type for the `StopPipeError` operation.
240#[non_exhaustive]
241#[derive(::std::fmt::Debug)]
242pub enum StopPipeError {
243    /// <p>An action you attempted resulted in an exception.</p>
244    ConflictException(crate::types::error::ConflictException),
245    /// <p>This exception occurs due to unexpected causes.</p>
246    InternalException(crate::types::error::InternalException),
247    /// <p>An entity that you specified does not exist.</p>
248    NotFoundException(crate::types::error::NotFoundException),
249    /// <p>An action was throttled.</p>
250    ThrottlingException(crate::types::error::ThrottlingException),
251    /// <p>Indicates that an error has occurred while performing a validate operation.</p>
252    ValidationException(crate::types::error::ValidationException),
253    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
254    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
255    variable wildcard pattern and check `.code()`:
256     \
257    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
258     \
259    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StopPipeError) for what information is available for the error.")]
260    Unhandled(crate::error::sealed_unhandled::Unhandled),
261}
262impl StopPipeError {
263    /// Creates the `StopPipeError::Unhandled` variant from any error type.
264    pub fn unhandled(
265        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
266    ) -> Self {
267        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
268            source: err.into(),
269            meta: ::std::default::Default::default(),
270        })
271    }
272
273    /// Creates the `StopPipeError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
274    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
275        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
276            source: err.clone().into(),
277            meta: err,
278        })
279    }
280    ///
281    /// Returns error metadata, which includes the error code, message,
282    /// request ID, and potentially additional information.
283    ///
284    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
285        match self {
286            Self::ConflictException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
287            Self::InternalException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
288            Self::NotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
289            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
290            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
291            Self::Unhandled(e) => &e.meta,
292        }
293    }
294    /// Returns `true` if the error kind is `StopPipeError::ConflictException`.
295    pub fn is_conflict_exception(&self) -> bool {
296        matches!(self, Self::ConflictException(_))
297    }
298    /// Returns `true` if the error kind is `StopPipeError::InternalException`.
299    pub fn is_internal_exception(&self) -> bool {
300        matches!(self, Self::InternalException(_))
301    }
302    /// Returns `true` if the error kind is `StopPipeError::NotFoundException`.
303    pub fn is_not_found_exception(&self) -> bool {
304        matches!(self, Self::NotFoundException(_))
305    }
306    /// Returns `true` if the error kind is `StopPipeError::ThrottlingException`.
307    pub fn is_throttling_exception(&self) -> bool {
308        matches!(self, Self::ThrottlingException(_))
309    }
310    /// Returns `true` if the error kind is `StopPipeError::ValidationException`.
311    pub fn is_validation_exception(&self) -> bool {
312        matches!(self, Self::ValidationException(_))
313    }
314}
315impl ::std::error::Error for StopPipeError {
316    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
317        match self {
318            Self::ConflictException(_inner) => ::std::option::Option::Some(_inner),
319            Self::InternalException(_inner) => ::std::option::Option::Some(_inner),
320            Self::NotFoundException(_inner) => ::std::option::Option::Some(_inner),
321            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
322            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
323            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
324        }
325    }
326}
327impl ::std::fmt::Display for StopPipeError {
328    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
329        match self {
330            Self::ConflictException(_inner) => _inner.fmt(f),
331            Self::InternalException(_inner) => _inner.fmt(f),
332            Self::NotFoundException(_inner) => _inner.fmt(f),
333            Self::ThrottlingException(_inner) => _inner.fmt(f),
334            Self::ValidationException(_inner) => _inner.fmt(f),
335            Self::Unhandled(_inner) => {
336                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
337                    write!(f, "unhandled error ({code})")
338                } else {
339                    f.write_str("unhandled error")
340                }
341            }
342        }
343    }
344}
345impl ::aws_smithy_types::retry::ProvideErrorKind for StopPipeError {
346    fn code(&self) -> ::std::option::Option<&str> {
347        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
348    }
349    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
350        ::std::option::Option::None
351    }
352}
353impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StopPipeError {
354    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
355        match self {
356            Self::ConflictException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
357            Self::InternalException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
358            Self::NotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
359            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
360            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
361            Self::Unhandled(_inner) => &_inner.meta,
362        }
363    }
364}
365impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StopPipeError {
366    fn create_unhandled_error(
367        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
368        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
369    ) -> Self {
370        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
371            source,
372            meta: meta.unwrap_or_default(),
373        })
374    }
375}
376impl ::aws_types::request_id::RequestId for crate::operation::stop_pipe::StopPipeError {
377    fn request_id(&self) -> Option<&str> {
378        self.meta().request_id()
379    }
380}
381
382pub use crate::operation::stop_pipe::_stop_pipe_output::StopPipeOutput;
383
384pub use crate::operation::stop_pipe::_stop_pipe_input::StopPipeInput;
385
386mod _stop_pipe_input;
387
388mod _stop_pipe_output;
389
390/// Builders
391pub mod builders;