aws_sdk_lightsail/operation/
get_alarms.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `GetAlarms`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct GetAlarms;
6impl GetAlarms {
7    /// Creates a new `GetAlarms`
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_alarms::GetAlarmsInput,
14    ) -> ::std::result::Result<
15        crate::operation::get_alarms::GetAlarmsOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::get_alarms::GetAlarmsError,
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_alarms::GetAlarmsError>()
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_alarms::GetAlarmsOutput>()
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_alarms::GetAlarmsInput,
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", "GetAlarms", 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.GetAlarms",
59                "rpc.service" = "Lightsail",
60                "rpc.method" = "GetAlarms",
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 GetAlarms {
88    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
89        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("GetAlarms");
90
91        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
92            GetAlarmsRequestSerializer,
93        ));
94        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
95            GetAlarmsResponseDeserializer,
96        ));
97
98        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
99            crate::config::auth::Params::builder()
100                .operation_name("GetAlarms")
101                .build()
102                .expect("required fields set"),
103        ));
104
105        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new("GetAlarms", "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("GetAlarms")
126            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
127            .with_interceptor(GetAlarmsEndpointParamsInterceptor)
128            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
129                crate::operation::get_alarms::GetAlarmsError,
130            >::new())
131            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
132                crate::operation::get_alarms::GetAlarmsError,
133            >::new())
134            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
135                crate::operation::get_alarms::GetAlarmsError,
136            >::new());
137
138        ::std::borrow::Cow::Owned(rcb)
139    }
140}
141
142#[derive(Debug)]
143struct GetAlarmsResponseDeserializer;
144impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for GetAlarmsResponseDeserializer {
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_alarms::de_get_alarms_http_error(status, headers, body)
157        } else {
158            crate::protocol_serde::shape_get_alarms::de_get_alarms_http_response(status, headers, body)
159        };
160        crate::protocol_serde::type_erase_result(parse_result)
161    }
162}
163#[derive(Debug)]
164struct GetAlarmsRequestSerializer;
165impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for GetAlarmsRequestSerializer {
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_alarms::GetAlarmsInput>().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_alarms::GetAlarmsInput,
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, "/").expect("formatting should succeed");
185                ::std::result::Result::Ok(())
186            }
187            fn uri_query(
188                _input: &crate::operation::get_alarms::GetAlarmsInput,
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                if let ::std::option::Option::Some(inner_1) = &_input.alarm_name {
193                    {
194                        query.push_kv("alarmName", &::aws_smithy_http::query::fmt_string(inner_1));
195                    }
196                }
197                if let ::std::option::Option::Some(inner_2) = &_input.page_token {
198                    {
199                        query.push_kv("pageToken", &::aws_smithy_http::query::fmt_string(inner_2));
200                    }
201                }
202                if let ::std::option::Option::Some(inner_3) = &_input.monitored_resource_name {
203                    {
204                        query.push_kv("monitoredResourceName", &::aws_smithy_http::query::fmt_string(inner_3));
205                    }
206                }
207                ::std::result::Result::Ok(())
208            }
209            #[allow(clippy::unnecessary_wraps)]
210            fn update_http_builder(
211                input: &crate::operation::get_alarms::GetAlarmsInput,
212                builder: ::http::request::Builder,
213            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
214                let mut uri = ::std::string::String::new();
215                uri_base(input, &mut uri)?;
216                uri_query(input, &mut uri)?;
217                ::std::result::Result::Ok(builder.method("POST").uri(uri))
218            }
219            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
220            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.1");
221            builder = _header_serialization_settings.set_default_header(
222                builder,
223                ::http::header::HeaderName::from_static("x-amz-target"),
224                "Lightsail_20161128.GetAlarms",
225            );
226            builder
227        };
228        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_get_alarms::ser_get_alarms_input(&input)?);
229        if let Some(content_length) = body.content_length() {
230            let content_length = content_length.to_string();
231            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
232        }
233        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
234    }
235}
236#[derive(Debug)]
237struct GetAlarmsEndpointParamsInterceptor;
238
239impl ::aws_smithy_runtime_api::client::interceptors::Intercept for GetAlarmsEndpointParamsInterceptor {
240    fn name(&self) -> &'static str {
241        "GetAlarmsEndpointParamsInterceptor"
242    }
243
244    fn read_before_execution(
245        &self,
246        context: &::aws_smithy_runtime_api::client::interceptors::context::BeforeSerializationInterceptorContextRef<
247            '_,
248            ::aws_smithy_runtime_api::client::interceptors::context::Input,
249            ::aws_smithy_runtime_api::client::interceptors::context::Output,
250            ::aws_smithy_runtime_api::client::interceptors::context::Error,
251        >,
252        cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
253    ) -> ::std::result::Result<(), ::aws_smithy_runtime_api::box_error::BoxError> {
254        let _input = context
255            .input()
256            .downcast_ref::<GetAlarmsInput>()
257            .ok_or("failed to downcast to GetAlarmsInput")?;
258
259        let params = crate::config::endpoint::Params::builder()
260            .set_region(cfg.load::<::aws_types::region::Region>().map(|r| r.as_ref().to_owned()))
261            .set_use_dual_stack(cfg.load::<::aws_types::endpoint_config::UseDualStack>().map(|ty| ty.0))
262            .set_use_fips(cfg.load::<::aws_types::endpoint_config::UseFips>().map(|ty| ty.0))
263            .set_endpoint(cfg.load::<::aws_types::endpoint_config::EndpointUrl>().map(|ty| ty.0.clone()))
264            .build()
265            .map_err(|err| {
266                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
267            })?;
268        cfg.interceptor_state()
269            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
270        ::std::result::Result::Ok(())
271    }
272}
273
274// The get_* functions below are generated from JMESPath expressions in the
275// operationContextParams trait. They target the operation's input shape.
276
277/// Error type for the `GetAlarmsError` operation.
278#[non_exhaustive]
279#[derive(::std::fmt::Debug)]
280pub enum GetAlarmsError {
281    /// <p>Lightsail throws this exception when the user cannot be authenticated or uses invalid credentials to access a resource.</p>
282    AccessDeniedException(crate::types::error::AccessDeniedException),
283    /// <p>Lightsail throws this exception when user input does not conform to the validation rules of an input field.</p><note>
284    /// <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>
285    /// </note>
286    InvalidInputException(crate::types::error::InvalidInputException),
287    /// <p>Lightsail throws this exception when it cannot find a resource.</p>
288    NotFoundException(crate::types::error::NotFoundException),
289    /// <p>Lightsail throws this exception when an operation fails to execute.</p>
290    OperationFailureException(crate::types::error::OperationFailureException),
291    /// <p>Lightsail throws this exception when an operation is performed on resources in an opt-in Region that is currently being set up.</p>
292    RegionSetupInProgressException(crate::types::error::RegionSetupInProgressException),
293    /// <p>A general service exception.</p>
294    ServiceException(crate::types::error::ServiceException),
295    /// <p>Lightsail throws this exception when the user has not been authenticated.</p>
296    UnauthenticatedException(crate::types::error::UnauthenticatedException),
297    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
298    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
299    variable wildcard pattern and check `.code()`:
300     \
301    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
302     \
303    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-GetAlarmsError) for what information is available for the error.")]
304    Unhandled(crate::error::sealed_unhandled::Unhandled),
305}
306impl GetAlarmsError {
307    /// Creates the `GetAlarmsError::Unhandled` variant from any error type.
308    pub fn unhandled(
309        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
310    ) -> Self {
311        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
312            source: err.into(),
313            meta: ::std::default::Default::default(),
314        })
315    }
316
317    /// Creates the `GetAlarmsError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
318    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
319        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
320            source: err.clone().into(),
321            meta: err,
322        })
323    }
324    ///
325    /// Returns error metadata, which includes the error code, message,
326    /// request ID, and potentially additional information.
327    ///
328    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
329        match self {
330            Self::AccessDeniedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
331            Self::InvalidInputException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
332            Self::NotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
333            Self::OperationFailureException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
334            Self::RegionSetupInProgressException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
335            Self::ServiceException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
336            Self::UnauthenticatedException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
337            Self::Unhandled(e) => &e.meta,
338        }
339    }
340    /// Returns `true` if the error kind is `GetAlarmsError::AccessDeniedException`.
341    pub fn is_access_denied_exception(&self) -> bool {
342        matches!(self, Self::AccessDeniedException(_))
343    }
344    /// Returns `true` if the error kind is `GetAlarmsError::InvalidInputException`.
345    pub fn is_invalid_input_exception(&self) -> bool {
346        matches!(self, Self::InvalidInputException(_))
347    }
348    /// Returns `true` if the error kind is `GetAlarmsError::NotFoundException`.
349    pub fn is_not_found_exception(&self) -> bool {
350        matches!(self, Self::NotFoundException(_))
351    }
352    /// Returns `true` if the error kind is `GetAlarmsError::OperationFailureException`.
353    pub fn is_operation_failure_exception(&self) -> bool {
354        matches!(self, Self::OperationFailureException(_))
355    }
356    /// Returns `true` if the error kind is `GetAlarmsError::RegionSetupInProgressException`.
357    pub fn is_region_setup_in_progress_exception(&self) -> bool {
358        matches!(self, Self::RegionSetupInProgressException(_))
359    }
360    /// Returns `true` if the error kind is `GetAlarmsError::ServiceException`.
361    pub fn is_service_exception(&self) -> bool {
362        matches!(self, Self::ServiceException(_))
363    }
364    /// Returns `true` if the error kind is `GetAlarmsError::UnauthenticatedException`.
365    pub fn is_unauthenticated_exception(&self) -> bool {
366        matches!(self, Self::UnauthenticatedException(_))
367    }
368}
369impl ::std::error::Error for GetAlarmsError {
370    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
371        match self {
372            Self::AccessDeniedException(_inner) => ::std::option::Option::Some(_inner),
373            Self::InvalidInputException(_inner) => ::std::option::Option::Some(_inner),
374            Self::NotFoundException(_inner) => ::std::option::Option::Some(_inner),
375            Self::OperationFailureException(_inner) => ::std::option::Option::Some(_inner),
376            Self::RegionSetupInProgressException(_inner) => ::std::option::Option::Some(_inner),
377            Self::ServiceException(_inner) => ::std::option::Option::Some(_inner),
378            Self::UnauthenticatedException(_inner) => ::std::option::Option::Some(_inner),
379            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
380        }
381    }
382}
383impl ::std::fmt::Display for GetAlarmsError {
384    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
385        match self {
386            Self::AccessDeniedException(_inner) => _inner.fmt(f),
387            Self::InvalidInputException(_inner) => _inner.fmt(f),
388            Self::NotFoundException(_inner) => _inner.fmt(f),
389            Self::OperationFailureException(_inner) => _inner.fmt(f),
390            Self::RegionSetupInProgressException(_inner) => _inner.fmt(f),
391            Self::ServiceException(_inner) => _inner.fmt(f),
392            Self::UnauthenticatedException(_inner) => _inner.fmt(f),
393            Self::Unhandled(_inner) => {
394                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
395                    write!(f, "unhandled error ({code})")
396                } else {
397                    f.write_str("unhandled error")
398                }
399            }
400        }
401    }
402}
403impl ::aws_smithy_types::retry::ProvideErrorKind for GetAlarmsError {
404    fn code(&self) -> ::std::option::Option<&str> {
405        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
406    }
407    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
408        ::std::option::Option::None
409    }
410}
411impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for GetAlarmsError {
412    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
413        match self {
414            Self::AccessDeniedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
415            Self::InvalidInputException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
416            Self::NotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
417            Self::OperationFailureException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
418            Self::RegionSetupInProgressException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
419            Self::ServiceException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
420            Self::UnauthenticatedException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
421            Self::Unhandled(_inner) => &_inner.meta,
422        }
423    }
424}
425impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for GetAlarmsError {
426    fn create_unhandled_error(
427        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
428        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
429    ) -> Self {
430        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
431            source,
432            meta: meta.unwrap_or_default(),
433        })
434    }
435}
436impl ::aws_types::request_id::RequestId for crate::operation::get_alarms::GetAlarmsError {
437    fn request_id(&self) -> Option<&str> {
438        self.meta().request_id()
439    }
440}
441
442pub use crate::operation::get_alarms::_get_alarms_output::GetAlarmsOutput;
443
444pub use crate::operation::get_alarms::_get_alarms_input::GetAlarmsInput;
445
446mod _get_alarms_input;
447
448mod _get_alarms_output;
449
450/// Builders
451pub mod builders;