aws_sdk_swf/operation/
start_workflow_execution.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `StartWorkflowExecution`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct StartWorkflowExecution;
6impl StartWorkflowExecution {
7    /// Creates a new `StartWorkflowExecution`
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::start_workflow_execution::StartWorkflowExecutionInput,
14    ) -> ::std::result::Result<
15        crate::operation::start_workflow_execution::StartWorkflowExecutionOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::start_workflow_execution::StartWorkflowExecutionError,
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::start_workflow_execution::StartWorkflowExecutionError>()
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::start_workflow_execution::StartWorkflowExecutionOutput>()
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::start_workflow_execution::StartWorkflowExecutionInput,
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", "StartWorkflowExecution", 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.StartWorkflowExecution",
59                "rpc.service" = "SWF",
60                "rpc.method" = "StartWorkflowExecution",
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 StartWorkflowExecution {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("StartWorkflowExecution");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            StartWorkflowExecutionRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            StartWorkflowExecutionResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("StartWorkflowExecution")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "StartWorkflowExecution",
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("StartWorkflowExecution")
129            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
130            .with_interceptor(StartWorkflowExecutionEndpointParamsInterceptor)
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
132                crate::operation::start_workflow_execution::StartWorkflowExecutionError,
133            >::new())
134            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
135                crate::operation::start_workflow_execution::StartWorkflowExecutionError,
136            >::new())
137            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
138                crate::operation::start_workflow_execution::StartWorkflowExecutionError,
139            >::new());
140
141        ::std::borrow::Cow::Owned(rcb)
142    }
143}
144
145#[derive(Debug)]
146struct StartWorkflowExecutionResponseDeserializer;
147impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for StartWorkflowExecutionResponseDeserializer {
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_start_workflow_execution::de_start_workflow_execution_http_error(status, headers, body)
160        } else {
161            crate::protocol_serde::shape_start_workflow_execution::de_start_workflow_execution_http_response(status, headers, body)
162        };
163        crate::protocol_serde::type_erase_result(parse_result)
164    }
165}
166#[derive(Debug)]
167struct StartWorkflowExecutionRequestSerializer;
168impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for StartWorkflowExecutionRequestSerializer {
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::start_workflow_execution::StartWorkflowExecutionInput>()
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::start_workflow_execution::StartWorkflowExecutionInput,
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::start_workflow_execution::StartWorkflowExecutionInput,
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.StartWorkflowExecution",
206            );
207            builder
208        };
209        let body = ::aws_smithy_types::body::SdkBody::from(
210            crate::protocol_serde::shape_start_workflow_execution::ser_start_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 StartWorkflowExecutionEndpointParamsInterceptor;
221
222impl ::aws_smithy_runtime_api::client::interceptors::Intercept for StartWorkflowExecutionEndpointParamsInterceptor {
223    fn name(&self) -> &'static str {
224        "StartWorkflowExecutionEndpointParamsInterceptor"
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::<StartWorkflowExecutionInput>()
240            .ok_or("failed to downcast to StartWorkflowExecutionInput")?;
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 `StartWorkflowExecutionError` operation.
261#[non_exhaustive]
262#[derive(::std::fmt::Debug)]
263pub enum StartWorkflowExecutionError {
264    /// <p>The <code>StartWorkflowExecution</code> API action was called without the required parameters set.</p>
265    /// <p>Some workflow execution parameters, such as the decision <code>taskList</code>, must be set to start the execution. However, these parameters might have been set as defaults when the workflow type was registered. In this case, you can omit these parameters from the <code>StartWorkflowExecution</code> call and Amazon SWF uses the values defined in the workflow type.</p><note>
266    /// <p>If these parameters aren't set and no default parameters were defined in the workflow type, this error is displayed.</p>
267    /// </note>
268    DefaultUndefinedFault(crate::types::error::DefaultUndefinedFault),
269    /// <p>Returned by any operation if a system imposed limitation has been reached. To address this fault you should either clean up unused resources or increase the limit by contacting AWS.</p>
270    LimitExceededFault(crate::types::error::LimitExceededFault),
271    /// <p>Returned when the caller doesn't have sufficient permissions to invoke the action.</p>
272    OperationNotPermittedFault(crate::types::error::OperationNotPermittedFault),
273    /// <p>Returned when the specified activity or workflow type was already deprecated.</p>
274    TypeDeprecatedFault(crate::types::error::TypeDeprecatedFault),
275    /// <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>
276    UnknownResourceFault(crate::types::error::UnknownResourceFault),
277    /// <p>Returned by <code>StartWorkflowExecution</code> when an open execution with the same workflowId is already running in the specified domain.</p>
278    WorkflowExecutionAlreadyStartedFault(crate::types::error::WorkflowExecutionAlreadyStartedFault),
279    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
280    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
281    variable wildcard pattern and check `.code()`:
282     \
283    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
284     \
285    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-StartWorkflowExecutionError) for what information is available for the error.")]
286    Unhandled(crate::error::sealed_unhandled::Unhandled),
287}
288impl StartWorkflowExecutionError {
289    /// Creates the `StartWorkflowExecutionError::Unhandled` variant from any error type.
290    pub fn unhandled(
291        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
292    ) -> Self {
293        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
294            source: err.into(),
295            meta: ::std::default::Default::default(),
296        })
297    }
298
299    /// Creates the `StartWorkflowExecutionError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
300    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
301        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
302            source: err.clone().into(),
303            meta: err,
304        })
305    }
306    ///
307    /// Returns error metadata, which includes the error code, message,
308    /// request ID, and potentially additional information.
309    ///
310    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
311        match self {
312            Self::DefaultUndefinedFault(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
313            Self::LimitExceededFault(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
314            Self::OperationNotPermittedFault(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
315            Self::TypeDeprecatedFault(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
316            Self::UnknownResourceFault(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
317            Self::WorkflowExecutionAlreadyStartedFault(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
318            Self::Unhandled(e) => &e.meta,
319        }
320    }
321    /// Returns `true` if the error kind is `StartWorkflowExecutionError::DefaultUndefinedFault`.
322    pub fn is_default_undefined_fault(&self) -> bool {
323        matches!(self, Self::DefaultUndefinedFault(_))
324    }
325    /// Returns `true` if the error kind is `StartWorkflowExecutionError::LimitExceededFault`.
326    pub fn is_limit_exceeded_fault(&self) -> bool {
327        matches!(self, Self::LimitExceededFault(_))
328    }
329    /// Returns `true` if the error kind is `StartWorkflowExecutionError::OperationNotPermittedFault`.
330    pub fn is_operation_not_permitted_fault(&self) -> bool {
331        matches!(self, Self::OperationNotPermittedFault(_))
332    }
333    /// Returns `true` if the error kind is `StartWorkflowExecutionError::TypeDeprecatedFault`.
334    pub fn is_type_deprecated_fault(&self) -> bool {
335        matches!(self, Self::TypeDeprecatedFault(_))
336    }
337    /// Returns `true` if the error kind is `StartWorkflowExecutionError::UnknownResourceFault`.
338    pub fn is_unknown_resource_fault(&self) -> bool {
339        matches!(self, Self::UnknownResourceFault(_))
340    }
341    /// Returns `true` if the error kind is `StartWorkflowExecutionError::WorkflowExecutionAlreadyStartedFault`.
342    pub fn is_workflow_execution_already_started_fault(&self) -> bool {
343        matches!(self, Self::WorkflowExecutionAlreadyStartedFault(_))
344    }
345}
346impl ::std::error::Error for StartWorkflowExecutionError {
347    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
348        match self {
349            Self::DefaultUndefinedFault(_inner) => ::std::option::Option::Some(_inner),
350            Self::LimitExceededFault(_inner) => ::std::option::Option::Some(_inner),
351            Self::OperationNotPermittedFault(_inner) => ::std::option::Option::Some(_inner),
352            Self::TypeDeprecatedFault(_inner) => ::std::option::Option::Some(_inner),
353            Self::UnknownResourceFault(_inner) => ::std::option::Option::Some(_inner),
354            Self::WorkflowExecutionAlreadyStartedFault(_inner) => ::std::option::Option::Some(_inner),
355            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
356        }
357    }
358}
359impl ::std::fmt::Display for StartWorkflowExecutionError {
360    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
361        match self {
362            Self::DefaultUndefinedFault(_inner) => _inner.fmt(f),
363            Self::LimitExceededFault(_inner) => _inner.fmt(f),
364            Self::OperationNotPermittedFault(_inner) => _inner.fmt(f),
365            Self::TypeDeprecatedFault(_inner) => _inner.fmt(f),
366            Self::UnknownResourceFault(_inner) => _inner.fmt(f),
367            Self::WorkflowExecutionAlreadyStartedFault(_inner) => _inner.fmt(f),
368            Self::Unhandled(_inner) => {
369                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
370                    write!(f, "unhandled error ({code})")
371                } else {
372                    f.write_str("unhandled error")
373                }
374            }
375        }
376    }
377}
378impl ::aws_smithy_types::retry::ProvideErrorKind for StartWorkflowExecutionError {
379    fn code(&self) -> ::std::option::Option<&str> {
380        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
381    }
382    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
383        ::std::option::Option::None
384    }
385}
386impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for StartWorkflowExecutionError {
387    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
388        match self {
389            Self::DefaultUndefinedFault(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
390            Self::LimitExceededFault(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
391            Self::OperationNotPermittedFault(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
392            Self::TypeDeprecatedFault(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
393            Self::UnknownResourceFault(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
394            Self::WorkflowExecutionAlreadyStartedFault(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
395            Self::Unhandled(_inner) => &_inner.meta,
396        }
397    }
398}
399impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for StartWorkflowExecutionError {
400    fn create_unhandled_error(
401        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
402        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
403    ) -> Self {
404        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
405            source,
406            meta: meta.unwrap_or_default(),
407        })
408    }
409}
410impl ::aws_types::request_id::RequestId for crate::operation::start_workflow_execution::StartWorkflowExecutionError {
411    fn request_id(&self) -> Option<&str> {
412        self.meta().request_id()
413    }
414}
415
416pub use crate::operation::start_workflow_execution::_start_workflow_execution_output::StartWorkflowExecutionOutput;
417
418pub use crate::operation::start_workflow_execution::_start_workflow_execution_input::StartWorkflowExecutionInput;
419
420mod _start_workflow_execution_input;
421
422mod _start_workflow_execution_output;
423
424/// Builders
425pub mod builders;
aws_sdk_swf/operation/start_workflow_execution.rs

aws_sdk_swf/operation/
start_workflow_execution.rs
