aws_sdk_mwaaserverless/operation/
stop_workflow_run.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `StopWorkflowRun`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StopWorkflowRun;
6impl StopWorkflowRun {
7    /// Creates a new `StopWorkflowRun`
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_workflow_run::StopWorkflowRunInput,
14    ) -> ::std::result::Result<
15        crate::operation::stop_workflow_run::StopWorkflowRunOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::stop_workflow_run::StopWorkflowRunError,
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::stop_workflow_run::StopWorkflowRunError>()
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::stop_workflow_run::StopWorkflowRunOutput>()
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::stop_workflow_run::StopWorkflowRunInput,
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("MWAA Serverless", "StopWorkflowRun", 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                "MWAA Serverless.StopWorkflowRun",
59                "rpc.service" = "MWAA Serverless",
60                "rpc.method" = "StopWorkflowRun",
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 StopWorkflowRun {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("StopWorkflowRun");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            StopWorkflowRunRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            StopWorkflowRunResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("StopWorkflowRun")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "StopWorkflowRun",
107            "MWAA Serverless",
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("StopWorkflowRun")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(StopWorkflowRunEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::stop_workflow_run::StopWorkflowRunError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::stop_workflow_run::StopWorkflowRunError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::stop_workflow_run::StopWorkflowRunError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct StopWorkflowRunResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StopWorkflowRunResponseDeserializer {
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_stop_workflow_run::de_stop_workflow_run_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_stop_workflow_run::de_stop_workflow_run_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct StopWorkflowRunRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StopWorkflowRunRequestSerializer {
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::stop_workflow_run::StopWorkflowRunInput>()
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            #[allow(clippy::uninlined_format_args)]
184            fn uri_base(
185                _input: &crate::operation::stop_workflow_run::StopWorkflowRunInput,
186                output: &mut ::std::string::String,
187            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
188                use ::std::fmt::Write as _;
189                ::std::write!(output, "/").expect("formatting should succeed");
190                ::std::result::Result::Ok(())
191            }
192            #[allow(clippy::unnecessary_wraps)]
193            fn update_http_builder(
194                input: &crate::operation::stop_workflow_run::StopWorkflowRunInput,
195                builder: ::http::request::Builder,
196            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
197                let mut uri = ::std::string::String::new();
198                uri_base(input, &mut uri)?;
199                ::std::result::Result::Ok(builder.method("POST").uri(uri))
200            }
201            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
202            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.0");
203            builder = _header_serialization_settings.set_default_header(
204                builder,
205                ::http::header::HeaderName::from_static("x-amz-target"),
206                "AmazonMWAAServerless.StopWorkflowRun",
207            );
208            builder
209        };
210        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_stop_workflow_run::ser_stop_workflow_run_input(&input)?);
211        if let Some(content_length) = body.content_length() {
212            let content_length = content_length.to_string();
213            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
214        }
215        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
216    }
217}
218#[derive(Debug)]
219struct StopWorkflowRunEndpointParamsInterceptor;
220
221impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StopWorkflowRunEndpointParamsInterceptor {
222    fn name(&self) -> &'static str {
223        "StopWorkflowRunEndpointParamsInterceptor"
224    }
225
226    fn read_before_execution(
227        &self,
228        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
229            '_,
230            ::aws_smithy_runtime_api::client::interceptors::context::Input,
231            ::aws_smithy_runtime_api::client::interceptors::context::Output,
232            ::aws_smithy_runtime_api::client::interceptors::context::Error,
233        >,
234        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
235    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
236        let _input = context
237            .input()
238            .downcast_ref::<StopWorkflowRunInput>()
239            .ok_or("failed to downcast to StopWorkflowRunInput")?;
240
241        let params = crate::config::endpoint::Params::builder()
242            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
243            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
244            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
245            .build()
246            .map_err(|err| {
247                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
248            })?;
249        cfg.interceptor_state()
250            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
251        ::std::result::Result::Ok(())
252    }
253}
254
255// The get_* functions below are generated from JMESPath expressions in the
256// operationContextParams trait. They target the operation's input shape.
257
258/// Error type for the `StopWorkflowRunError` operation.
259#[non_exhaustive]
260#[derive(::std::fmt::Debug)]
261pub enum StopWorkflowRunError {
262    /// <p>You do not have sufficient permission to perform this action.</p>
263    AccessDeniedException(crate::types::error::AccessDeniedException),
264    /// <p>An unexpected server-side error occurred during request processing.</p>
265    InternalServerException(crate::types::error::InternalServerException),
266    /// <p>The operation timed out.</p>
267    OperationTimeoutException(crate::types::error::OperationTimeoutException),
268    /// <p>The specified resource was not found. You can only access or modify a resource that already exists.</p>
269    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
270    /// <p>The request was denied because too many requests were made in a short period, exceeding the service rate limits. Amazon Managed Workflows for Apache Airflow Serverless implements throttling controls to ensure fair resource allocation across all customers in the multi-tenant environment. This helps maintain service stability and performance. If you encounter throttling, implement exponential backoff and retry logic in your applications, or consider distributing your API calls over a longer time period.</p>
271    ThrottlingException(crate::types::error::ThrottlingException),
272    /// <p>The specified request parameters are invalid, missing, or inconsistent with Amazon Managed Workflows for Apache Airflow Serverless service requirements. This can occur when workflow definitions contain unsupported operators, when required IAM permissions are missing, when S3 locations are inaccessible, or when network configurations are invalid. The service validates workflow definitions, execution roles, and resource configurations to ensure compatibility with the managed Airflow environment and security requirements.</p>
273    ValidationException(crate::types::error::ValidationException),
274    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
275    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
276    variable wildcard pattern and check `.code()`:
277     \
278    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
279     \
280    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StopWorkflowRunError) for what information is available for the error.")]
281    Unhandled(crate::error::sealed_unhandled::Unhandled),
282}
283impl StopWorkflowRunError {
284    /// Creates the `StopWorkflowRunError::Unhandled` variant from any error type.
285    pub fn unhandled(
286        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
287    ) -> Self {
288        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
289            source: err.into(),
290            meta: ::std::default::Default::default(),
291        })
292    }
293
294    /// Creates the `StopWorkflowRunError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
295    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
296        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
297            source: err.clone().into(),
298            meta: err,
299        })
300    }
301    ///
302    /// Returns error metadata, which includes the error code, message,
303    /// request ID, and potentially additional information.
304    ///
305    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
306        match self {
307            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
308            Self::InternalServerException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
309            Self::OperationTimeoutException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
310            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
311            Self::ThrottlingException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
312            Self::ValidationException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
313            Self::Unhandled(e) => &e.meta,
314        }
315    }
316    /// Returns `true` if the error kind is `StopWorkflowRunError::AccessDeniedException`.
317    pub fn is_access_denied_exception(&self) -> bool {
318        matches!(self, Self::AccessDeniedException(_))
319    }
320    /// Returns `true` if the error kind is `StopWorkflowRunError::InternalServerException`.
321    pub fn is_internal_server_exception(&self) -> bool {
322        matches!(self, Self::InternalServerException(_))
323    }
324    /// Returns `true` if the error kind is `StopWorkflowRunError::OperationTimeoutException`.
325    pub fn is_operation_timeout_exception(&self) -> bool {
326        matches!(self, Self::OperationTimeoutException(_))
327    }
328    /// Returns `true` if the error kind is `StopWorkflowRunError::ResourceNotFoundException`.
329    pub fn is_resource_not_found_exception(&self) -> bool {
330        matches!(self, Self::ResourceNotFoundException(_))
331    }
332    /// Returns `true` if the error kind is `StopWorkflowRunError::ThrottlingException`.
333    pub fn is_throttling_exception(&self) -> bool {
334        matches!(self, Self::ThrottlingException(_))
335    }
336    /// Returns `true` if the error kind is `StopWorkflowRunError::ValidationException`.
337    pub fn is_validation_exception(&self) -> bool {
338        matches!(self, Self::ValidationException(_))
339    }
340}
341impl ::std::error::Error for StopWorkflowRunError {
342    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
343        match self {
344            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
345            Self::InternalServerException(_inner) => ::std::option::Option::Some(_inner),
346            Self::OperationTimeoutException(_inner) => ::std::option::Option::Some(_inner),
347            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
348            Self::ThrottlingException(_inner) => ::std::option::Option::Some(_inner),
349            Self::ValidationException(_inner) => ::std::option::Option::Some(_inner),
350            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
351        }
352    }
353}
354impl ::std::fmt::Display for StopWorkflowRunError {
355    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
356        match self {
357            Self::AccessDeniedException(_inner) => _inner.fmt(f),
358            Self::InternalServerException(_inner) => _inner.fmt(f),
359            Self::OperationTimeoutException(_inner) => _inner.fmt(f),
360            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
361            Self::ThrottlingException(_inner) => _inner.fmt(f),
362            Self::ValidationException(_inner) => _inner.fmt(f),
363            Self::Unhandled(_inner) => {
364                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
365                    write!(f, "unhandled error ({code})")
366                } else {
367                    f.write_str("unhandled error")
368                }
369            }
370        }
371    }
372}
373impl ::aws_smithy_types::retry::ProvideErrorKind for StopWorkflowRunError {
374    fn code(&self) -> ::std::option::Option<&str> {
375        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
376    }
377    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
378        match self {
379            Self::InternalServerException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
380            Self::ThrottlingException(inner) => ::std::option::Option::Some(inner.retryable_error_kind()),
381            _ => ::std::option::Option::None,
382        }
383    }
384}
385impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StopWorkflowRunError {
386    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
387        match self {
388            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
389            Self::InternalServerException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
390            Self::OperationTimeoutException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
391            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
392            Self::ThrottlingException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
393            Self::ValidationException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
394            Self::Unhandled(_inner) => &_inner.meta,
395        }
396    }
397}
398impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StopWorkflowRunError {
399    fn create_unhandled_error(
400        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
401        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
402    ) -> Self {
403        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
404            source,
405            meta: meta.unwrap_or_default(),
406        })
407    }
408}
409impl ::aws_types::request_id::RequestId for crate::operation::stop_workflow_run::StopWorkflowRunError {
410    fn request_id(&self) -> Option<&str> {
411        self.meta().request_id()
412    }
413}
414
415pub use crate::operation::stop_workflow_run::_stop_workflow_run_output::StopWorkflowRunOutput;
416
417pub use crate::operation::stop_workflow_run::_stop_workflow_run_input::StopWorkflowRunInput;
418
419mod _stop_workflow_run_input;
420
421mod _stop_workflow_run_output;
422
423/// Builders
424pub mod builders;