aws_sdk_swf/operation/
terminate_workflow_execution.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `TerminateWorkflowExecution`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct TerminateWorkflowExecution;
6impl TerminateWorkflowExecution {
7    /// Creates a new `TerminateWorkflowExecution`
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::terminate_workflow_execution::TerminateWorkflowExecutionInput,
14    ) -> ::std::result::Result<
15        crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionError,
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::terminate_workflow_execution::TerminateWorkflowExecutionError>()
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::terminate_workflow_execution::TerminateWorkflowExecutionOutput>()
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::terminate_workflow_execution::TerminateWorkflowExecutionInput,
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("SWF", "TerminateWorkflowExecution", 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                "SWF.TerminateWorkflowExecution",
59                "rpc.service" = "SWF",
60                "rpc.method" = "TerminateWorkflowExecution",
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 TerminateWorkflowExecution {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("TerminateWorkflowExecution");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            TerminateWorkflowExecutionRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            TerminateWorkflowExecutionResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("TerminateWorkflowExecution")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "TerminateWorkflowExecution",
107            "SWF",
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("TerminateWorkflowExecution")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(TerminateWorkflowExecutionEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct TerminateWorkflowExecutionResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for TerminateWorkflowExecutionResponseDeserializer {
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_terminate_workflow_execution::de_terminate_workflow_execution_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_terminate_workflow_execution::de_terminate_workflow_execution_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct TerminateWorkflowExecutionRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for TerminateWorkflowExecutionRequestSerializer {
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
176            .downcast::<crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionInput>()
177            .expect("correct type");
178        let _header_serialization_settings = _cfg
179            .load::<crate::serialization_settings::HeaderSerializationSettings>()
180            .cloned()
181            .unwrap_or_default();
182        let mut request_builder = {
183            fn uri_base(
184                _input: &crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionInput,
185                output: &mut ::std::string::String,
186            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
187                use ::std::fmt::Write as _;
188                ::std::write!(output, "/").expect("formatting should succeed");
189                ::std::result::Result::Ok(())
190            }
191            #[allow(clippy::unnecessary_wraps)]
192            fn update_http_builder(
193                input: &crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionInput,
194                builder: ::http::request::Builder,
195            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
196                let mut uri = ::std::string::String::new();
197                uri_base(input, &mut uri)?;
198                ::std::result::Result::Ok(builder.method("POST").uri(uri))
199            }
200            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
201            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.0");
202            builder = _header_serialization_settings.set_default_header(
203                builder,
204                ::http::header::HeaderName::from_static("x-amz-target"),
205                "SimpleWorkflowService.TerminateWorkflowExecution",
206            );
207            builder
208        };
209        let body = ::aws_smithy_types::body::SdkBody::from(
210            crate::protocol_serde::shape_terminate_workflow_execution::ser_terminate_workflow_execution_input(&input)?,
211        );
212        if let Some(content_length) = body.content_length() {
213            let content_length = content_length.to_string();
214            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
215        }
216        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
217    }
218}
219#[derive(Debug)]
220struct TerminateWorkflowExecutionEndpointParamsInterceptor;
221
222impl ::aws_smithy_runtime_api::client::interceptors::Intercept for TerminateWorkflowExecutionEndpointParamsInterceptor {
223    fn name(&self) -> &'static str {
224        "TerminateWorkflowExecutionEndpointParamsInterceptor"
225    }
226
227    fn read_before_execution(
228        &self,
229        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
230            '_,
231            ::aws_smithy_runtime_api::client::interceptors::context::Input,
232            ::aws_smithy_runtime_api::client::interceptors::context::Output,
233            ::aws_smithy_runtime_api::client::interceptors::context::Error,
234        >,
235        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
236    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
237        let _input = context
238            .input()
239            .downcast_ref::<TerminateWorkflowExecutionInput>()
240            .ok_or("failed to downcast to TerminateWorkflowExecutionInput")?;
241
242        let params = crate::config::endpoint::Params::builder()
243            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
244            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
245            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
246            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
247            .build()
248            .map_err(|err| {
249                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
250            })?;
251        cfg.interceptor_state()
252            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
253        ::std::result::Result::Ok(())
254    }
255}
256
257// The get_* functions below are generated from JMESPath expressions in the
258// operationContextParams trait. They target the operation's input shape.
259
260/// Error type for the `TerminateWorkflowExecutionError` operation.
261#[non_exhaustive]
262#[derive(::std::fmt::Debug)]
263pub enum TerminateWorkflowExecutionError {
264    /// <p>Returned when the caller doesn't have sufficient permissions to invoke the action.</p>
265    OperationNotPermittedFault(crate::types::error::OperationNotPermittedFault),
266    /// <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>
267    UnknownResourceFault(crate::types::error::UnknownResourceFault),
268    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
269    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
270    variable wildcard pattern and check `.code()`:
271     \
272    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
273     \
274    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-TerminateWorkflowExecutionError) for what information is available for the error.")]
275    Unhandled(crate::error::sealed_unhandled::Unhandled),
276}
277impl TerminateWorkflowExecutionError {
278    /// Creates the `TerminateWorkflowExecutionError::Unhandled` variant from any error type.
279    pub fn unhandled(
280        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
281    ) -> Self {
282        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
283            source: err.into(),
284            meta: ::std::default::Default::default(),
285        })
286    }
287
288    /// Creates the `TerminateWorkflowExecutionError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
289    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
290        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
291            source: err.clone().into(),
292            meta: err,
293        })
294    }
295    ///
296    /// Returns error metadata, which includes the error code, message,
297    /// request ID, and potentially additional information.
298    ///
299    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
300        match self {
301            Self::OperationNotPermittedFault(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
302            Self::UnknownResourceFault(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
303            Self::Unhandled(e) => &e.meta,
304        }
305    }
306    /// Returns `true` if the error kind is `TerminateWorkflowExecutionError::OperationNotPermittedFault`.
307    pub fn is_operation_not_permitted_fault(&self) -> bool {
308        matches!(self, Self::OperationNotPermittedFault(_))
309    }
310    /// Returns `true` if the error kind is `TerminateWorkflowExecutionError::UnknownResourceFault`.
311    pub fn is_unknown_resource_fault(&self) -> bool {
312        matches!(self, Self::UnknownResourceFault(_))
313    }
314}
315impl ::std::error::Error for TerminateWorkflowExecutionError {
316    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
317        match self {
318            Self::OperationNotPermittedFault(_inner) => ::std::option::Option::Some(_inner),
319            Self::UnknownResourceFault(_inner) => ::std::option::Option::Some(_inner),
320            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
321        }
322    }
323}
324impl ::std::fmt::Display for TerminateWorkflowExecutionError {
325    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
326        match self {
327            Self::OperationNotPermittedFault(_inner) => _inner.fmt(f),
328            Self::UnknownResourceFault(_inner) => _inner.fmt(f),
329            Self::Unhandled(_inner) => {
330                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
331                    write!(f, "unhandled error ({code})")
332                } else {
333                    f.write_str("unhandled error")
334                }
335            }
336        }
337    }
338}
339impl ::aws_smithy_types::retry::ProvideErrorKind for TerminateWorkflowExecutionError {
340    fn code(&self) -> ::std::option::Option<&str> {
341        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
342    }
343    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
344        ::std::option::Option::None
345    }
346}
347impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for TerminateWorkflowExecutionError {
348    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
349        match self {
350            Self::OperationNotPermittedFault(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
351            Self::UnknownResourceFault(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
352            Self::Unhandled(_inner) => &_inner.meta,
353        }
354    }
355}
356impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for TerminateWorkflowExecutionError {
357    fn create_unhandled_error(
358        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
359        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
360    ) -> Self {
361        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
362            source,
363            meta: meta.unwrap_or_default(),
364        })
365    }
366}
367impl ::aws_types::request_id::RequestId for crate::operation::terminate_workflow_execution::TerminateWorkflowExecutionError {
368    fn request_id(&self) -> Option<&str> {
369        self.meta().request_id()
370    }
371}
372
373pub use crate::operation::terminate_workflow_execution::_terminate_workflow_execution_output::TerminateWorkflowExecutionOutput;
374
375pub use crate::operation::terminate_workflow_execution::_terminate_workflow_execution_input::TerminateWorkflowExecutionInput;
376
377mod _terminate_workflow_execution_input;
378
379mod _terminate_workflow_execution_output;
380
381/// Builders
382pub mod builders;