aws_sdk_swf/operation/
request_cancel_workflow_execution.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `RequestCancelWorkflowExecution`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct RequestCancelWorkflowExecution;
6impl RequestCancelWorkflowExecution {
7    /// Creates a new `RequestCancelWorkflowExecution`
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::request_cancel_workflow_execution::RequestCancelWorkflowExecutionInput,
14    ) -> ::std::result::Result<
15        crate::operation::request_cancel_workflow_execution::RequestCancelWorkflowExecutionOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::request_cancel_workflow_execution::RequestCancelWorkflowExecutionError,
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::request_cancel_workflow_execution::RequestCancelWorkflowExecutionError>()
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::request_cancel_workflow_execution::RequestCancelWorkflowExecutionOutput>()
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::request_cancel_workflow_execution::RequestCancelWorkflowExecutionInput,
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(
55            "SWF",
56            "RequestCancelWorkflowExecution",
57            input,
58            runtime_plugins,
59            stop_point,
60        )
61        // Create a parent span for the entire operation. Includes a random, internal-only,
62        // seven-digit ID for the operation orchestration so that it can be correlated in the logs.
63        .instrument(::tracing::debug_span!(
64            "SWF.RequestCancelWorkflowExecution",
65            "rpc.service" = "SWF",
66            "rpc.method" = "RequestCancelWorkflowExecution",
67            "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
68            "rpc.system" = "aws-api",
69        ))
70        .await
71    }
72
73    pub(crate) fn operation_runtime_plugins(
74        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
75        client_config: &crate::config::Config,
76        config_override: ::std::option::Option<crate::config::Builder>,
77    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
78        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
79        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
80            ::aws_runtime::auth::sigv4::SCHEME_ID,
81        ]));
82        if let ::std::option::Option::Some(config_override) = config_override {
83            for plugin in config_override.runtime_plugins.iter().cloned() {
84                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
85            }
86            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
87                config_override,
88                client_config.config.clone(),
89                &client_config.runtime_components,
90            ));
91        }
92        runtime_plugins
93    }
94}
95impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for RequestCancelWorkflowExecution {
96    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
97        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("RequestCancelWorkflowExecution");
98
99        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
100            RequestCancelWorkflowExecutionRequestSerializer,
101        ));
102        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
103            RequestCancelWorkflowExecutionResponseDeserializer,
104        ));
105
106        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
107            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
108        ));
109
110        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
111            "RequestCancelWorkflowExecution",
112            "SWF",
113        ));
114        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
115        signing_options.double_uri_encode = true;
116        signing_options.content_sha256_header = false;
117        signing_options.normalize_uri_path = true;
118        signing_options.payload_override = None;
119
120        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
121            signing_options,
122            ..::std::default::Default::default()
123        });
124
125        ::std::option::Option::Some(cfg.freeze())
126    }
127
128    fn runtime_components(
129        &self,
130        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
131    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
132        #[allow(unused_mut)]
133        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("RequestCancelWorkflowExecution")
134            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
135            .with_interceptor(RequestCancelWorkflowExecutionEndpointParamsInterceptor)
136            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
137                crate::operation::request_cancel_workflow_execution::RequestCancelWorkflowExecutionError,
138            >::new())
139            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
140                crate::operation::request_cancel_workflow_execution::RequestCancelWorkflowExecutionError,
141            >::new())
142            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
143                crate::operation::request_cancel_workflow_execution::RequestCancelWorkflowExecutionError,
144            >::new());
145
146        ::std::borrow::Cow::Owned(rcb)
147    }
148}
149
150#[derive(Debug)]
151struct RequestCancelWorkflowExecutionResponseDeserializer;
152impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for RequestCancelWorkflowExecutionResponseDeserializer {
153    fn deserialize_nonstreaming(
154        &self,
155        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
156    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
157        let (success, status) = (response.status().is_success(), response.status().as_u16());
158        let headers = response.headers();
159        let body = response.body().bytes().expect("body loaded");
160        #[allow(unused_mut)]
161        let mut force_error = false;
162        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
163        let parse_result = if !success && status != 200 || force_error {
164            crate::protocol_serde::shape_request_cancel_workflow_execution::de_request_cancel_workflow_execution_http_error(status, headers, body)
165        } else {
166            crate::protocol_serde::shape_request_cancel_workflow_execution::de_request_cancel_workflow_execution_http_response(status, headers, body)
167        };
168        crate::protocol_serde::type_erase_result(parse_result)
169    }
170}
171#[derive(Debug)]
172struct RequestCancelWorkflowExecutionRequestSerializer;
173impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for RequestCancelWorkflowExecutionRequestSerializer {
174    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
175    fn serialize_input(
176        &self,
177        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
178        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
179    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
180        let input = input
181            .downcast::<crate::operation::request_cancel_workflow_execution::RequestCancelWorkflowExecutionInput>()
182            .expect("correct type");
183        let _header_serialization_settings = _cfg
184            .load::<crate::serialization_settings::HeaderSerializationSettings>()
185            .cloned()
186            .unwrap_or_default();
187        let mut request_builder = {
188            fn uri_base(
189                _input: &crate::operation::request_cancel_workflow_execution::RequestCancelWorkflowExecutionInput,
190                output: &mut ::std::string::String,
191            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
192                use ::std::fmt::Write as _;
193                ::std::write!(output, "/").expect("formatting should succeed");
194                ::std::result::Result::Ok(())
195            }
196            #[allow(clippy::unnecessary_wraps)]
197            fn update_http_builder(
198                input: &crate::operation::request_cancel_workflow_execution::RequestCancelWorkflowExecutionInput,
199                builder: ::http::request::Builder,
200            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
201                let mut uri = ::std::string::String::new();
202                uri_base(input, &mut uri)?;
203                ::std::result::Result::Ok(builder.method("POST").uri(uri))
204            }
205            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
206            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.0");
207            builder = _header_serialization_settings.set_default_header(
208                builder,
209                ::http::header::HeaderName::from_static("x-amz-target"),
210                "SimpleWorkflowService.RequestCancelWorkflowExecution",
211            );
212            builder
213        };
214        let body = ::aws_smithy_types::body::SdkBody::from(
215            crate::protocol_serde::shape_request_cancel_workflow_execution::ser_request_cancel_workflow_execution_input(&input)?,
216        );
217        if let Some(content_length) = body.content_length() {
218            let content_length = content_length.to_string();
219            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
220        }
221        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
222    }
223}
224#[derive(Debug)]
225struct RequestCancelWorkflowExecutionEndpointParamsInterceptor;
226
227impl ::aws_smithy_runtime_api::client::interceptors::Intercept for RequestCancelWorkflowExecutionEndpointParamsInterceptor {
228    fn name(&self) -> &'static str {
229        "RequestCancelWorkflowExecutionEndpointParamsInterceptor"
230    }
231
232    fn read_before_execution(
233        &self,
234        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
235            '_,
236            ::aws_smithy_runtime_api::client::interceptors::context::Input,
237            ::aws_smithy_runtime_api::client::interceptors::context::Output,
238            ::aws_smithy_runtime_api::client::interceptors::context::Error,
239        >,
240        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
241    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
242        let _input = context
243            .input()
244            .downcast_ref::<RequestCancelWorkflowExecutionInput>()
245            .ok_or("failed to downcast to RequestCancelWorkflowExecutionInput")?;
246
247        let params = crate::config::endpoint::Params::builder()
248            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
249            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
250            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
251            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
252            .build()
253            .map_err(|err| {
254                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
255            })?;
256        cfg.interceptor_state()
257            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
258        ::std::result::Result::Ok(())
259    }
260}
261
262// The get_* functions below are generated from JMESPath expressions in the
263// operationContextParams trait. They target the operation's input shape.
264
265/// Error type for the `RequestCancelWorkflowExecutionError` operation.
266#[non_exhaustive]
267#[derive(::std::fmt::Debug)]
268pub enum RequestCancelWorkflowExecutionError {
269    /// <p>Returned when the caller doesn't have sufficient permissions to invoke the action.</p>
270    OperationNotPermittedFault(crate::types::error::OperationNotPermittedFault),
271    /// <p>Returned when the named resource cannot be found with in the scope of this operation (region or domain). This could happen if the named resource was never created or is no longer available for this operation.</p>
272    UnknownResourceFault(crate::types::error::UnknownResourceFault),
273    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
274    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
275    variable wildcard pattern and check `.code()`:
276     \
277    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
278     \
279    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-RequestCancelWorkflowExecutionError) for what information is available for the error.")]
280    Unhandled(crate::error::sealed_unhandled::Unhandled),
281}
282impl RequestCancelWorkflowExecutionError {
283    /// Creates the `RequestCancelWorkflowExecutionError::Unhandled` variant from any error type.
284    pub fn unhandled(
285        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
286    ) -> Self {
287        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
288            source: err.into(),
289            meta: ::std::default::Default::default(),
290        })
291    }
292
293    /// Creates the `RequestCancelWorkflowExecutionError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
294    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
295        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
296            source: err.clone().into(),
297            meta: err,
298        })
299    }
300    ///
301    /// Returns error metadata, which includes the error code, message,
302    /// request ID, and potentially additional information.
303    ///
304    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
305        match self {
306            Self::OperationNotPermittedFault(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
307            Self::UnknownResourceFault(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
308            Self::Unhandled(e) => &e.meta,
309        }
310    }
311    /// Returns `true` if the error kind is `RequestCancelWorkflowExecutionError::OperationNotPermittedFault`.
312    pub fn is_operation_not_permitted_fault(&self) -> bool {
313        matches!(self, Self::OperationNotPermittedFault(_))
314    }
315    /// Returns `true` if the error kind is `RequestCancelWorkflowExecutionError::UnknownResourceFault`.
316    pub fn is_unknown_resource_fault(&self) -> bool {
317        matches!(self, Self::UnknownResourceFault(_))
318    }
319}
320impl ::std::error::Error for RequestCancelWorkflowExecutionError {
321    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
322        match self {
323            Self::OperationNotPermittedFault(_inner) => ::std::option::Option::Some(_inner),
324            Self::UnknownResourceFault(_inner) => ::std::option::Option::Some(_inner),
325            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
326        }
327    }
328}
329impl ::std::fmt::Display for RequestCancelWorkflowExecutionError {
330    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
331        match self {
332            Self::OperationNotPermittedFault(_inner) => _inner.fmt(f),
333            Self::UnknownResourceFault(_inner) => _inner.fmt(f),
334            Self::Unhandled(_inner) => {
335                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
336                    write!(f, "unhandled error ({code})")
337                } else {
338                    f.write_str("unhandled error")
339                }
340            }
341        }
342    }
343}
344impl ::aws_smithy_types::retry::ProvideErrorKind for RequestCancelWorkflowExecutionError {
345    fn code(&self) -> ::std::option::Option<&str> {
346        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
347    }
348    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
349        ::std::option::Option::None
350    }
351}
352impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for RequestCancelWorkflowExecutionError {
353    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
354        match self {
355            Self::OperationNotPermittedFault(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
356            Self::UnknownResourceFault(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
357            Self::Unhandled(_inner) => &_inner.meta,
358        }
359    }
360}
361impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for RequestCancelWorkflowExecutionError {
362    fn create_unhandled_error(
363        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
364        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
365    ) -> Self {
366        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
367            source,
368            meta: meta.unwrap_or_default(),
369        })
370    }
371}
372impl ::aws_types::request_id::RequestId for crate::operation::request_cancel_workflow_execution::RequestCancelWorkflowExecutionError {
373    fn request_id(&self) -> Option<&str> {
374        self.meta().request_id()
375    }
376}
377
378pub use crate::operation::request_cancel_workflow_execution::_request_cancel_workflow_execution_output::RequestCancelWorkflowExecutionOutput;
379
380pub use crate::operation::request_cancel_workflow_execution::_request_cancel_workflow_execution_input::RequestCancelWorkflowExecutionInput;
381
382mod _request_cancel_workflow_execution_input;
383
384mod _request_cancel_workflow_execution_output;
385
386/// Builders
387pub mod builders;