aws_sdk_swf/operation/
describe_workflow_execution.rs

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

aws_sdk_swf/operation/
describe_workflow_execution.rs
