Skip to main content

aws_sdk_imagebuilder/operation/
get_workflow.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetWorkflow`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetWorkflow;
6impl GetWorkflow {
7    /// Creates a new `GetWorkflow`
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::get_workflow::GetWorkflowInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_workflow::GetWorkflowOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_workflow::GetWorkflowError,
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::get_workflow::GetWorkflowError>()
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::get_workflow::GetWorkflowOutput>()
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::get_workflow::GetWorkflowInput,
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("imagebuilder", "GetWorkflow", 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                "imagebuilder.GetWorkflow",
59                "rpc.service" = "imagebuilder",
60                "rpc.method" = "GetWorkflow",
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 GetWorkflow {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetWorkflow");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            GetWorkflowRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            GetWorkflowResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("GetWorkflow")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
106            "GetWorkflow",
107            "imagebuilder",
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("GetWorkflow")
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
131            ))
132            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
133                GetWorkflowEndpointParamsInterceptor,
134            ))
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
136                crate::operation::get_workflow::GetWorkflowError,
137            >::new())
138            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
139                crate::operation::get_workflow::GetWorkflowError,
140            >::new())
141            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
142                crate::operation::get_workflow::GetWorkflowError,
143            >::new());
144
145        ::std::borrow::Cow::Owned(rcb)
146    }
147}
148
149#[derive(Debug)]
150struct GetWorkflowResponseDeserializer;
151impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetWorkflowResponseDeserializer {
152    fn deserialize_nonstreaming(
153        &self,
154        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
155    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
156        let (success, status) = (response.status().is_success(), response.status().as_u16());
157        let headers = response.headers();
158        let body = response.body().bytes().expect("body loaded");
159        #[allow(unused_mut)]
160        let mut force_error = false;
161        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
162        let parse_result = if !success && status != 200 || force_error {
163            crate::protocol_serde::shape_get_workflow::de_get_workflow_http_error(status, headers, body)
164        } else {
165            crate::protocol_serde::shape_get_workflow::de_get_workflow_http_response(status, headers, body)
166        };
167        crate::protocol_serde::type_erase_result(parse_result)
168    }
169}
170#[derive(Debug)]
171struct GetWorkflowRequestSerializer;
172impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetWorkflowRequestSerializer {
173    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
174    fn serialize_input(
175        &self,
176        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
177        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
178    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
179        let input = input
180            .downcast::<crate::operation::get_workflow::GetWorkflowInput>()
181            .expect("correct type");
182        let _header_serialization_settings = _cfg
183            .load::<crate::serialization_settings::HeaderSerializationSettings>()
184            .cloned()
185            .unwrap_or_default();
186        let mut request_builder = {
187            #[allow(clippy::uninlined_format_args)]
188            fn uri_base(
189                _input: &crate::operation::get_workflow::GetWorkflowInput,
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, "/GetWorkflow").expect("formatting should succeed");
194                ::std::result::Result::Ok(())
195            }
196            fn uri_query(
197                _input: &crate::operation::get_workflow::GetWorkflowInput,
198                mut output: &mut ::std::string::String,
199            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
200                let mut query = ::aws_smithy_http::query::Writer::new(output);
201                let inner_1 = &_input.workflow_build_version_arn;
202                let inner_1 = inner_1.as_ref().ok_or_else(|| {
203                    ::aws_smithy_types::error::operation::BuildError::missing_field("workflow_build_version_arn", "cannot be empty or unset")
204                })?;
205                if inner_1.is_empty() {
206                    return ::std::result::Result::Err(::aws_smithy_types::error::operation::BuildError::missing_field(
207                        "workflow_build_version_arn",
208                        "cannot be empty or unset",
209                    ));
210                }
211                query.push_kv("workflowBuildVersionArn", &::aws_smithy_http::query::fmt_string(inner_1));
212                ::std::result::Result::Ok(())
213            }
214            #[allow(clippy::unnecessary_wraps)]
215            fn update_http_builder(
216                input: &crate::operation::get_workflow::GetWorkflowInput,
217                builder: ::http_1x::request::Builder,
218            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
219                let mut uri = ::std::string::String::new();
220                uri_base(input, &mut uri)?;
221                uri_query(input, &mut uri)?;
222                ::std::result::Result::Ok(builder.method("GET").uri(uri))
223            }
224            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
225            builder
226        };
227        let body = ::aws_smithy_types::body::SdkBody::from("");
228
229        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
230    }
231}
232#[derive(Debug)]
233struct GetWorkflowEndpointParamsInterceptor;
234
235#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
236impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetWorkflowEndpointParamsInterceptor {
237    fn name(&self) -> &'static str {
238        "GetWorkflowEndpointParamsInterceptor"
239    }
240
241    fn read_before_execution(
242        &self,
243        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
244            '_,
245            ::aws_smithy_runtime_api::client::interceptors::context::Input,
246            ::aws_smithy_runtime_api::client::interceptors::context::Output,
247            ::aws_smithy_runtime_api::client::interceptors::context::Error,
248        >,
249        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
250    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
251        let _input = context
252            .input()
253            .downcast_ref::<GetWorkflowInput>()
254            .ok_or("failed to downcast to GetWorkflowInput")?;
255
256        let params = crate::config::endpoint::Params::builder()
257            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
258            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
259            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
260            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
261            .build()
262            .map_err(|err| {
263                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
264            })?;
265        cfg.interceptor_state()
266            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
267        ::std::result::Result::Ok(())
268    }
269}
270
271// The get_* functions below are generated from JMESPath expressions in the
272// operationContextParams trait. They target the operation's input shape.
273
274/// Error type for the `GetWorkflowError` operation.
275#[non_exhaustive]
276#[derive(::std::fmt::Debug)]
277pub enum GetWorkflowError {
278    /// <p>You have exceeded the permitted request rate for the specific operation.</p>
279    CallRateLimitExceededException(crate::types::error::CallRateLimitExceededException),
280    /// <p>These errors are usually caused by a client action, such as using an action or resource on behalf of a user that doesn't have permissions to use the action or resource, or specifying an invalid resource identifier.</p>
281    ClientException(crate::types::error::ClientException),
282    /// <p>You are not authorized to perform the requested operation.</p>
283    ForbiddenException(crate::types::error::ForbiddenException),
284    /// <p>You have requested an action that that the service doesn't support.</p>
285    InvalidRequestException(crate::types::error::InvalidRequestException),
286    /// <p>This exception is thrown when the service encounters an unrecoverable exception.</p>
287    ServiceException(crate::types::error::ServiceException),
288    /// <p>The service is unable to process your request at this time.</p>
289    ServiceUnavailableException(crate::types::error::ServiceUnavailableException),
290    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
291    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
292    variable wildcard pattern and check `.code()`:
293     \
294    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
295     \
296    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetWorkflowError) for what information is available for the error.")]
297    Unhandled(crate::error::sealed_unhandled::Unhandled),
298}
299impl GetWorkflowError {
300    /// Creates the `GetWorkflowError::Unhandled` variant from any error type.
301    pub fn unhandled(
302        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
303    ) -> Self {
304        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
305            source: err.into(),
306            meta: ::std::default::Default::default(),
307        })
308    }
309
310    /// Creates the `GetWorkflowError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
311    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
312        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
313            source: err.clone().into(),
314            meta: err,
315        })
316    }
317    ///
318    /// Returns error metadata, which includes the error code, message,
319    /// request ID, and potentially additional information.
320    ///
321    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
322        match self {
323            Self::CallRateLimitExceededException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
324            Self::ClientException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
325            Self::ForbiddenException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
326            Self::InvalidRequestException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
327            Self::ServiceException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
328            Self::ServiceUnavailableException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
329            Self::Unhandled(e) => &e.meta,
330        }
331    }
332    /// Returns `true` if the error kind is `GetWorkflowError::CallRateLimitExceededException`.
333    pub fn is_call_rate_limit_exceeded_exception(&self) -> bool {
334        matches!(self, Self::CallRateLimitExceededException(_))
335    }
336    /// Returns `true` if the error kind is `GetWorkflowError::ClientException`.
337    pub fn is_client_exception(&self) -> bool {
338        matches!(self, Self::ClientException(_))
339    }
340    /// Returns `true` if the error kind is `GetWorkflowError::ForbiddenException`.
341    pub fn is_forbidden_exception(&self) -> bool {
342        matches!(self, Self::ForbiddenException(_))
343    }
344    /// Returns `true` if the error kind is `GetWorkflowError::InvalidRequestException`.
345    pub fn is_invalid_request_exception(&self) -> bool {
346        matches!(self, Self::InvalidRequestException(_))
347    }
348    /// Returns `true` if the error kind is `GetWorkflowError::ServiceException`.
349    pub fn is_service_exception(&self) -> bool {
350        matches!(self, Self::ServiceException(_))
351    }
352    /// Returns `true` if the error kind is `GetWorkflowError::ServiceUnavailableException`.
353    pub fn is_service_unavailable_exception(&self) -> bool {
354        matches!(self, Self::ServiceUnavailableException(_))
355    }
356}
357impl ::std::error::Error for GetWorkflowError {
358    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
359        match self {
360            Self::CallRateLimitExceededException(_inner) => ::std::option::Option::Some(_inner),
361            Self::ClientException(_inner) => ::std::option::Option::Some(_inner),
362            Self::ForbiddenException(_inner) => ::std::option::Option::Some(_inner),
363            Self::InvalidRequestException(_inner) => ::std::option::Option::Some(_inner),
364            Self::ServiceException(_inner) => ::std::option::Option::Some(_inner),
365            Self::ServiceUnavailableException(_inner) => ::std::option::Option::Some(_inner),
366            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
367        }
368    }
369}
370impl ::std::fmt::Display for GetWorkflowError {
371    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
372        match self {
373            Self::CallRateLimitExceededException(_inner) => _inner.fmt(f),
374            Self::ClientException(_inner) => _inner.fmt(f),
375            Self::ForbiddenException(_inner) => _inner.fmt(f),
376            Self::InvalidRequestException(_inner) => _inner.fmt(f),
377            Self::ServiceException(_inner) => _inner.fmt(f),
378            Self::ServiceUnavailableException(_inner) => _inner.fmt(f),
379            Self::Unhandled(_inner) => {
380                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
381                    write!(f, "unhandled error ({code})")
382                } else {
383                    f.write_str("unhandled error")
384                }
385            }
386        }
387    }
388}
389impl ::aws_smithy_types::retry::ProvideErrorKind for GetWorkflowError {
390    fn code(&self) -> ::std::option::Option<&str> {
391        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
392    }
393    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
394        ::std::option::Option::None
395    }
396}
397impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetWorkflowError {
398    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
399        match self {
400            Self::CallRateLimitExceededException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
401            Self::ClientException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
402            Self::ForbiddenException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
403            Self::InvalidRequestException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
404            Self::ServiceException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
405            Self::ServiceUnavailableException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
406            Self::Unhandled(_inner) => &_inner.meta,
407        }
408    }
409}
410impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetWorkflowError {
411    fn create_unhandled_error(
412        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
413        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
414    ) -> Self {
415        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
416            source,
417            meta: meta.unwrap_or_default(),
418        })
419    }
420}
421impl ::aws_types::request_id::RequestId for crate::operation::get_workflow::GetWorkflowError {
422    fn request_id(&self) -> Option<&str> {
423        self.meta().request_id()
424    }
425}
426
427pub use crate::operation::get_workflow::_get_workflow_input::GetWorkflowInput;
428
429pub use crate::operation::get_workflow::_get_workflow_output::GetWorkflowOutput;
430
431mod _get_workflow_input;
432
433mod _get_workflow_output;
434
435/// Builders
436pub mod builders;