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

aws_sdk_imagebuilder/operation/
get_image.rs
