aws_sdk_imagebuilder/operation/
get_image.rs

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