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