aws_sdk_lightsail/operation/
get_instance.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetInstance`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetInstance;
6impl GetInstance {
7    /// Creates a new `GetInstance`
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_instance::GetInstanceInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_instance::GetInstanceOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_instance::GetInstanceError,
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_instance::GetInstanceError>()
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_instance::GetInstanceOutput>()
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_instance::GetInstanceInput,
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("Lightsail", "GetInstance", 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                "Lightsail.GetInstance",
59                "rpc.service" = "Lightsail",
60                "rpc.method" = "GetInstance",
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 GetInstance {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetInstance");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            GetInstanceRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            GetInstanceResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("GetInstance")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("GetInstance", "Lightsail"));
106        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
107        signing_options.double_uri_encode = true;
108        signing_options.content_sha256_header = false;
109        signing_options.normalize_uri_path = true;
110        signing_options.payload_override = None;
111
112        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
113            signing_options,
114            ..::std::default::Default::default()
115        });
116
117        ::std::option::Option::Some(cfg.freeze())
118    }
119
120    fn runtime_components(
121        &self,
122        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
123    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
124        #[allow(unused_mut)]
125        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("GetInstance")
126            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
127                ::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default(),
128            ))
129            .with_interceptor(::aws_smithy_runtime_api::client::interceptors::SharedInterceptor::permanent(
130                GetInstanceEndpointParamsInterceptor,
131            ))
132            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
133                crate::operation::get_instance::GetInstanceError,
134            >::new())
135            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
136                crate::operation::get_instance::GetInstanceError,
137            >::new())
138            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
139                crate::operation::get_instance::GetInstanceError,
140            >::new());
141
142        ::std::borrow::Cow::Owned(rcb)
143    }
144}
145
146#[derive(Debug)]
147struct GetInstanceResponseDeserializer;
148impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetInstanceResponseDeserializer {
149    fn deserialize_nonstreaming_with_config(
150        &self,
151        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
152        _cfg: &::aws_smithy_types::config_bag::ConfigBag,
153    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
154        let (success, status) = (response.status().is_success(), response.status().as_u16());
155        let headers = response.headers();
156        let body = response.body().bytes().expect("body loaded");
157        #[allow(unused_mut)]
158        let mut force_error = false;
159        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
160        let parse_result = if !success && status != 200 || force_error {
161            crate::protocol_serde::shape_get_instance::de_get_instance_http_error(status, headers, body)
162        } else {
163            crate::protocol_serde::shape_get_instance::de_get_instance_http_response(status, headers, body)
164        };
165        crate::protocol_serde::type_erase_result(parse_result)
166    }
167}
168#[derive(Debug)]
169struct GetInstanceRequestSerializer;
170impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetInstanceRequestSerializer {
171    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
172    fn serialize_input(
173        &self,
174        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
175        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
176    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
177        let input = input
178            .downcast::<crate::operation::get_instance::GetInstanceInput>()
179            .expect("correct type");
180        let _header_serialization_settings = _cfg
181            .load::<crate::serialization_settings::HeaderSerializationSettings>()
182            .cloned()
183            .unwrap_or_default();
184        let mut request_builder = {
185            #[allow(clippy::uninlined_format_args)]
186            fn uri_base(
187                _input: &crate::operation::get_instance::GetInstanceInput,
188                output: &mut ::std::string::String,
189            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
190                use ::std::fmt::Write as _;
191                ::std::write!(output, "/").expect("formatting should succeed");
192                ::std::result::Result::Ok(())
193            }
194            #[allow(clippy::unnecessary_wraps)]
195            fn update_http_builder(
196                input: &crate::operation::get_instance::GetInstanceInput,
197                builder: ::http_1x::request::Builder,
198            ) -> ::std::result::Result<::http_1x::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
199                let mut uri = ::std::string::String::new();
200                uri_base(input, &mut uri)?;
201                ::std::result::Result::Ok(builder.method("POST").uri(uri))
202            }
203            let mut builder = update_http_builder(&input, ::http_1x::request::Builder::new())?;
204            builder = _header_serialization_settings.set_default_header(builder, ::http_1x::header::CONTENT_TYPE, "application/x-amz-json-1.1");
205            builder = _header_serialization_settings.set_default_header(
206                builder,
207                ::http_1x::header::HeaderName::from_static("x-amz-target"),
208                "Lightsail_20161128.GetInstance",
209            );
210            builder
211        };
212        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_get_instance::ser_get_instance_input(&input)?);
213        if let Some(content_length) = body.content_length() {
214            let content_length = content_length.to_string();
215            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http_1x::header::CONTENT_LENGTH, &content_length);
216        }
217        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
218    }
219}
220#[derive(Debug)]
221struct GetInstanceEndpointParamsInterceptor;
222
223#[::aws_smithy_runtime_api::client::interceptors::dyn_dispatch_hint]
224impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetInstanceEndpointParamsInterceptor {
225    fn name(&self) -> &'static str {
226        "GetInstanceEndpointParamsInterceptor"
227    }
228
229    fn read_before_execution(
230        &self,
231        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
232            '_,
233            ::aws_smithy_runtime_api::client::interceptors::context::Input,
234            ::aws_smithy_runtime_api::client::interceptors::context::Output,
235            ::aws_smithy_runtime_api::client::interceptors::context::Error,
236        >,
237        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
238    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
239        let _input = context
240            .input()
241            .downcast_ref::<GetInstanceInput>()
242            .ok_or("failed to downcast to GetInstanceInput")?;
243
244        let params = crate::config::endpoint::Params::builder()
245            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
246            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
247            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
248            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
249            .build()
250            .map_err(|err| {
251                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
252            })?;
253        cfg.interceptor_state()
254            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
255        ::std::result::Result::Ok(())
256    }
257}
258
259// The get_* functions below are generated from JMESPath expressions in the
260// operationContextParams trait. They target the operation's input shape.
261
262/// Error type for the `GetInstanceError` operation.
263#[non_exhaustive]
264#[derive(::std::fmt::Debug)]
265pub enum GetInstanceError {
266    /// <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
267    AccessDeniedException(crate::types::error::AccessDeniedException),
268    /// <p>Lightsail throws this exception when an account is still in the setup in progress state.</p>
269    AccountSetupInProgressException(crate::types::error::AccountSetupInProgressException),
270    /// <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p><note>
271    /// <p>Domain and distribution APIs are only available in the N. Virginia (<code>us-east-1</code>) Amazon Web Services Region. Please set your Amazon Web Services Region configuration to <code>us-east-1</code> to create, view, or edit these resources.</p>
272    /// </note>
273    InvalidInputException(crate::types::error::InvalidInputException),
274    /// <p>Lightsail throws this exception when it cannot find a resource.</p>
275    NotFoundException(crate::types::error::NotFoundException),
276    /// <p>Lightsail throws this exception when an operation fails to execute.</p>
277    OperationFailureException(crate::types::error::OperationFailureException),
278    /// <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
279    RegionSetupInProgressException(crate::types::error::RegionSetupInProgressException),
280    /// <p>A general service exception.</p>
281    ServiceException(crate::types::error::ServiceException),
282    /// <p>Lightsail throws this exception when the user has not been authenticated.</p>
283    UnauthenticatedException(crate::types::error::UnauthenticatedException),
284    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
285    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
286    variable wildcard pattern and check `.code()`:
287     \
288    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
289     \
290    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetInstanceError) for what information is available for the error.")]
291    Unhandled(crate::error::sealed_unhandled::Unhandled),
292}
293impl GetInstanceError {
294    /// Creates the `GetInstanceError::Unhandled` variant from any error type.
295    pub fn unhandled(
296        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
297    ) -> Self {
298        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
299            source: err.into(),
300            meta: ::std::default::Default::default(),
301        })
302    }
303
304    /// Creates the `GetInstanceError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
305    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
306        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
307            source: err.clone().into(),
308            meta: err,
309        })
310    }
311    ///
312    /// Returns error metadata, which includes the error code, message,
313    /// request ID, and potentially additional information.
314    ///
315    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
316        match self {
317            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
318            Self::AccountSetupInProgressException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
319            Self::InvalidInputException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
320            Self::NotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
321            Self::OperationFailureException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
322            Self::RegionSetupInProgressException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
323            Self::ServiceException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
324            Self::UnauthenticatedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
325            Self::Unhandled(e) => &e.meta,
326        }
327    }
328    /// Returns `true` if the error kind is `GetInstanceError::AccessDeniedException`.
329    pub fn is_access_denied_exception(&self) -> bool {
330        matches!(self, Self::AccessDeniedException(_))
331    }
332    /// Returns `true` if the error kind is `GetInstanceError::AccountSetupInProgressException`.
333    pub fn is_account_setup_in_progress_exception(&self) -> bool {
334        matches!(self, Self::AccountSetupInProgressException(_))
335    }
336    /// Returns `true` if the error kind is `GetInstanceError::InvalidInputException`.
337    pub fn is_invalid_input_exception(&self) -> bool {
338        matches!(self, Self::InvalidInputException(_))
339    }
340    /// Returns `true` if the error kind is `GetInstanceError::NotFoundException`.
341    pub fn is_not_found_exception(&self) -> bool {
342        matches!(self, Self::NotFoundException(_))
343    }
344    /// Returns `true` if the error kind is `GetInstanceError::OperationFailureException`.
345    pub fn is_operation_failure_exception(&self) -> bool {
346        matches!(self, Self::OperationFailureException(_))
347    }
348    /// Returns `true` if the error kind is `GetInstanceError::RegionSetupInProgressException`.
349    pub fn is_region_setup_in_progress_exception(&self) -> bool {
350        matches!(self, Self::RegionSetupInProgressException(_))
351    }
352    /// Returns `true` if the error kind is `GetInstanceError::ServiceException`.
353    pub fn is_service_exception(&self) -> bool {
354        matches!(self, Self::ServiceException(_))
355    }
356    /// Returns `true` if the error kind is `GetInstanceError::UnauthenticatedException`.
357    pub fn is_unauthenticated_exception(&self) -> bool {
358        matches!(self, Self::UnauthenticatedException(_))
359    }
360}
361impl ::std::error::Error for GetInstanceError {
362    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
363        match self {
364            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
365            Self::AccountSetupInProgressException(_inner) => ::std::option::Option::Some(_inner),
366            Self::InvalidInputException(_inner) => ::std::option::Option::Some(_inner),
367            Self::NotFoundException(_inner) => ::std::option::Option::Some(_inner),
368            Self::OperationFailureException(_inner) => ::std::option::Option::Some(_inner),
369            Self::RegionSetupInProgressException(_inner) => ::std::option::Option::Some(_inner),
370            Self::ServiceException(_inner) => ::std::option::Option::Some(_inner),
371            Self::UnauthenticatedException(_inner) => ::std::option::Option::Some(_inner),
372            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
373        }
374    }
375}
376impl ::std::fmt::Display for GetInstanceError {
377    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
378        match self {
379            Self::AccessDeniedException(_inner) => _inner.fmt(f),
380            Self::AccountSetupInProgressException(_inner) => _inner.fmt(f),
381            Self::InvalidInputException(_inner) => _inner.fmt(f),
382            Self::NotFoundException(_inner) => _inner.fmt(f),
383            Self::OperationFailureException(_inner) => _inner.fmt(f),
384            Self::RegionSetupInProgressException(_inner) => _inner.fmt(f),
385            Self::ServiceException(_inner) => _inner.fmt(f),
386            Self::UnauthenticatedException(_inner) => _inner.fmt(f),
387            Self::Unhandled(_inner) => {
388                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
389                    write!(f, "unhandled error ({code})")
390                } else {
391                    f.write_str("unhandled error")
392                }
393            }
394        }
395    }
396}
397impl ::aws_smithy_types::retry::ProvideErrorKind for GetInstanceError {
398    fn code(&self) -> ::std::option::Option<&str> {
399        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
400    }
401    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
402        ::std::option::Option::None
403    }
404}
405impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetInstanceError {
406    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
407        match self {
408            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
409            Self::AccountSetupInProgressException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
410            Self::InvalidInputException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
411            Self::NotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
412            Self::OperationFailureException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
413            Self::RegionSetupInProgressException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
414            Self::ServiceException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
415            Self::UnauthenticatedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
416            Self::Unhandled(_inner) => &_inner.meta,
417        }
418    }
419}
420impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetInstanceError {
421    fn create_unhandled_error(
422        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
423        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
424    ) -> Self {
425        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
426            source,
427            meta: meta.unwrap_or_default(),
428        })
429    }
430}
431impl ::aws_types::request_id::RequestId for crate::operation::get_instance::GetInstanceError {
432    fn request_id(&self) -> Option<&str> {
433        self.meta().request_id()
434    }
435}
436
437pub use crate::operation::get_instance::_get_instance_input::GetInstanceInput;
438
439pub use crate::operation::get_instance::_get_instance_output::GetInstanceOutput;
440
441mod _get_instance_input;
442
443mod _get_instance_output;
444
445/// Builders
446pub mod builders;
aws_sdk_lightsail/operation/get_instance.rs

aws_sdk_lightsail/operation/
get_instance.rs
