aws_sdk_dynamodb/operation/
describe_time_to_live.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2/// Orchestration and serialization glue logic for `DescribeTimeToLive`.
3#[derive(::std::clone::Clone, ::std::default::Default, ::std::fmt::Debug)]
4#[non_exhaustive]
5pub struct DescribeTimeToLive;
6impl DescribeTimeToLive {
7    /// Creates a new `DescribeTimeToLive`
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::describe_time_to_live::DescribeTimeToLiveInput,
14    ) -> ::std::result::Result<
15        crate::operation::describe_time_to_live::DescribeTimeToLiveOutput,
16        ::aws_smithy_runtime_api::client::result::SdkError<
17            crate::operation::describe_time_to_live::DescribeTimeToLiveError,
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::describe_time_to_live::DescribeTimeToLiveError>()
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::describe_time_to_live::DescribeTimeToLiveOutput>()
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::describe_time_to_live::DescribeTimeToLiveInput,
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("DynamoDB", "DescribeTimeToLive", 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                "DynamoDB.DescribeTimeToLive",
59                "rpc.service" = "DynamoDB",
60                "rpc.method" = "DescribeTimeToLive",
61                "sdk_invocation_id" = ::fastrand::u32(1_000_000..10_000_000),
62                "rpc.system" = "aws-api",
63            ))
64            .await
65    }
66
67    pub(crate) fn operation_runtime_plugins(
68        client_runtime_plugins: ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins,
69        client_config: &crate::config::Config,
70        config_override: ::std::option::Option<crate::config::Builder>,
71    ) -> ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugins {
72        let mut runtime_plugins = client_runtime_plugins.with_operation_plugin(Self::new());
73        runtime_plugins = runtime_plugins.with_client_plugin(crate::auth_plugin::DefaultAuthOptionsPlugin::new(vec![
74            ::aws_runtime::auth::sigv4::SCHEME_ID,
75        ]));
76        if let ::std::option::Option::Some(config_override) = config_override {
77            for plugin in config_override.runtime_plugins.iter().cloned() {
78                runtime_plugins = runtime_plugins.with_operation_plugin(plugin);
79            }
80            runtime_plugins = runtime_plugins.with_operation_plugin(crate::config::ConfigOverrideRuntimePlugin::new(
81                config_override,
82                client_config.config.clone(),
83                &client_config.runtime_components,
84            ));
85        }
86        runtime_plugins
87    }
88}
89impl ::aws_smithy_runtime_api::client::runtime_plugin::RuntimePlugin for DescribeTimeToLive {
90    fn config(&self) -> ::std::option::Option<::aws_smithy_types::config_bag::FrozenLayer> {
91        let mut cfg = ::aws_smithy_types::config_bag::Layer::new("DescribeTimeToLive");
92
93        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedRequestSerializer::new(
94            DescribeTimeToLiveRequestSerializer,
95        ));
96        cfg.store_put(::aws_smithy_runtime_api::client::ser_de::SharedResponseDeserializer::new(
97            DescribeTimeToLiveResponseDeserializer,
98        ));
99
100        cfg.store_put(::aws_smithy_runtime_api::client::auth::AuthSchemeOptionResolverParams::new(
101            ::aws_smithy_runtime_api::client::auth::static_resolver::StaticAuthSchemeOptionResolverParams::new(),
102        ));
103
104        cfg.store_put(::aws_smithy_runtime_api::client::orchestrator::Metadata::new(
105            "DescribeTimeToLive",
106            "DynamoDB",
107        ));
108        let mut signing_options = ::aws_runtime::auth::SigningOptions::default();
109        signing_options.double_uri_encode = true;
110        signing_options.content_sha256_header = false;
111        signing_options.normalize_uri_path = true;
112        signing_options.payload_override = None;
113
114        cfg.store_put(::aws_runtime::auth::SigV4OperationSigningConfig {
115            signing_options,
116            ..::std::default::Default::default()
117        });
118
119        ::std::option::Option::Some(cfg.freeze())
120    }
121
122    fn runtime_components(
123        &self,
124        _: &::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder,
125    ) -> ::std::borrow::Cow<'_, ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder> {
126        #[allow(unused_mut)]
127        let mut rcb = ::aws_smithy_runtime_api::client::runtime_components::RuntimeComponentsBuilder::new("DescribeTimeToLive")
128            .with_interceptor(::aws_smithy_runtime::client::stalled_stream_protection::StalledStreamProtectionInterceptor::default())
129            .with_interceptor(DescribeTimeToLiveEndpointParamsInterceptor)
130            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::TransientErrorClassifier::<
131                crate::operation::describe_time_to_live::DescribeTimeToLiveError,
132            >::new())
133            .with_retry_classifier(::aws_smithy_runtime::client::retries::classifiers::ModeledAsRetryableClassifier::<
134                crate::operation::describe_time_to_live::DescribeTimeToLiveError,
135            >::new())
136            .with_retry_classifier(::aws_runtime::retries::classifiers::AwsErrorCodeClassifier::<
137                crate::operation::describe_time_to_live::DescribeTimeToLiveError,
138            >::new());
139
140        ::std::borrow::Cow::Owned(rcb)
141    }
142}
143
144#[derive(Debug)]
145struct DescribeTimeToLiveResponseDeserializer;
146impl ::aws_smithy_runtime_api::client::ser_de::DeserializeResponse for DescribeTimeToLiveResponseDeserializer {
147    fn deserialize_nonstreaming(
148        &self,
149        response: &::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
150    ) -> ::aws_smithy_runtime_api::client::interceptors::context::OutputOrError {
151        let (success, status) = (response.status().is_success(), response.status().as_u16());
152        let headers = response.headers();
153        let body = response.body().bytes().expect("body loaded");
154        #[allow(unused_mut)]
155        let mut force_error = false;
156        ::tracing::debug!(request_id = ?::aws_types::request_id::RequestId::request_id(response));
157        let parse_result = if !success && status != 200 || force_error {
158            crate::protocol_serde::shape_describe_time_to_live::de_describe_time_to_live_http_error(status, headers, body)
159        } else {
160            crate::protocol_serde::shape_describe_time_to_live::de_describe_time_to_live_http_response(status, headers, body)
161        };
162        crate::protocol_serde::type_erase_result(parse_result)
163    }
164}
165#[derive(Debug)]
166struct DescribeTimeToLiveRequestSerializer;
167impl ::aws_smithy_runtime_api::client::ser_de::SerializeRequest for DescribeTimeToLiveRequestSerializer {
168    #[allow(unused_mut, clippy::let_and_return, clippy::needless_borrow, clippy::useless_conversion)]
169    fn serialize_input(
170        &self,
171        input: ::aws_smithy_runtime_api::client::interceptors::context::Input,
172        _cfg: &mut ::aws_smithy_types::config_bag::ConfigBag,
173    ) -> ::std::result::Result<::aws_smithy_runtime_api::client::orchestrator::HttpRequest, ::aws_smithy_runtime_api::box_error::BoxError> {
174        let input = input
175            .downcast::<crate::operation::describe_time_to_live::DescribeTimeToLiveInput>()
176            .expect("correct type");
177        let _header_serialization_settings = _cfg
178            .load::<crate::serialization_settings::HeaderSerializationSettings>()
179            .cloned()
180            .unwrap_or_default();
181        let mut request_builder = {
182            fn uri_base(
183                _input: &crate::operation::describe_time_to_live::DescribeTimeToLiveInput,
184                output: &mut ::std::string::String,
185            ) -> ::std::result::Result<(), ::aws_smithy_types::error::operation::BuildError> {
186                use ::std::fmt::Write as _;
187                ::std::write!(output, "/").expect("formatting should succeed");
188                ::std::result::Result::Ok(())
189            }
190            #[allow(clippy::unnecessary_wraps)]
191            fn update_http_builder(
192                input: &crate::operation::describe_time_to_live::DescribeTimeToLiveInput,
193                builder: ::http::request::Builder,
194            ) -> ::std::result::Result<::http::request::Builder, ::aws_smithy_types::error::operation::BuildError> {
195                let mut uri = ::std::string::String::new();
196                uri_base(input, &mut uri)?;
197                ::std::result::Result::Ok(builder.method("POST").uri(uri))
198            }
199            let mut builder = update_http_builder(&input, ::http::request::Builder::new())?;
200            builder = _header_serialization_settings.set_default_header(builder, ::http::header::CONTENT_TYPE, "application/x-amz-json-1.0");
201            builder = _header_serialization_settings.set_default_header(
202                builder,
203                ::http::header::HeaderName::from_static("x-amz-target"),
204                "DynamoDB_20120810.DescribeTimeToLive",
205            );
206            builder
207        };
208        let body = ::aws_smithy_types::body::SdkBody::from(crate::protocol_serde::shape_describe_time_to_live::ser_describe_time_to_live_input(
209            &input,
210        )?);
211        if let Some(content_length) = body.content_length() {
212            let content_length = content_length.to_string();
213            request_builder = _header_serialization_settings.set_default_header(request_builder, ::http::header::CONTENT_LENGTH, &content_length);
214        }
215        ::std::result::Result::Ok(request_builder.body(body).expect("valid request").try_into().unwrap())
216    }
217}
218#[derive(Debug)]
219struct DescribeTimeToLiveEndpointParamsInterceptor;
220
221impl ::aws_smithy_runtime_api::client::interceptors::Intercept for DescribeTimeToLiveEndpointParamsInterceptor {
222    fn name(&self) -> &'static str {
223        "DescribeTimeToLiveEndpointParamsInterceptor"
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::<DescribeTimeToLiveInput>()
239            .ok_or("failed to downcast to DescribeTimeToLiveInput")?;
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            .set_account_id_endpoint_mode(::std::option::Option::Some(
247                cfg.load::<::aws_types::endpoint_config::AccountIdEndpointMode>()
248                    .cloned()
249                    .unwrap_or_default()
250                    .to_string(),
251            ))
252            .set_resource_arn(Some(
253                _input
254                    .table_name
255                    .clone()
256                    .filter(|f| !AsRef::<str>::as_ref(f).trim().is_empty())
257                    .ok_or_else(|| ::aws_smithy_types::error::operation::BuildError::missing_field("table_name", "A required field was not set"))?,
258            ))
259            .build()
260            .map_err(|err| {
261                ::aws_smithy_runtime_api::client::interceptors::error::ContextAttachedError::new("endpoint params could not be built", err)
262            })?;
263        cfg.interceptor_state()
264            .store_put(::aws_smithy_runtime_api::client::endpoint::EndpointResolverParams::new(params));
265        ::std::result::Result::Ok(())
266    }
267}
268
269// The get_* functions below are generated from JMESPath expressions in the
270// operationContextParams trait. They target the operation's input shape.
271
272/// Error type for the `DescribeTimeToLiveError` operation.
273#[non_exhaustive]
274#[derive(::std::fmt::Debug)]
275pub enum DescribeTimeToLiveError {
276    /// <p>An error occurred on the server side.</p>
277    InternalServerError(crate::types::error::InternalServerError),
278    #[allow(missing_docs)] // documentation missing in model
279    InvalidEndpointException(crate::types::error::InvalidEndpointException),
280    /// <p>The operation tried to access a nonexistent table or index. The resource might not be specified correctly, or its status might not be <code>ACTIVE</code>.</p>
281    ResourceNotFoundException(crate::types::error::ResourceNotFoundException),
282    /// An unexpected error occurred (e.g., invalid JSON returned by the service or an unknown error code).
283    #[deprecated(note = "Matching `Unhandled` directly is not forwards compatible. Instead, match using a \
284    variable wildcard pattern and check `.code()`:
285     \
286    &nbsp;&nbsp;&nbsp;`err if err.code() == Some(\"SpecificExceptionCode\") => { /* handle the error */ }`
287     \
288    See [`ProvideErrorMetadata`](#impl-ProvideErrorMetadata-for-DescribeTimeToLiveError) for what information is available for the error.")]
289    Unhandled(crate::error::sealed_unhandled::Unhandled),
290}
291impl DescribeTimeToLiveError {
292    /// Creates the `DescribeTimeToLiveError::Unhandled` variant from any error type.
293    pub fn unhandled(
294        err: impl ::std::convert::Into<::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>>,
295    ) -> Self {
296        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
297            source: err.into(),
298            meta: ::std::default::Default::default(),
299        })
300    }
301
302    /// Creates the `DescribeTimeToLiveError::Unhandled` variant from an [`ErrorMetadata`](::aws_smithy_types::error::ErrorMetadata).
303    pub fn generic(err: ::aws_smithy_types::error::ErrorMetadata) -> Self {
304        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
305            source: err.clone().into(),
306            meta: err,
307        })
308    }
309    ///
310    /// Returns error metadata, which includes the error code, message,
311    /// request ID, and potentially additional information.
312    ///
313    pub fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
314        match self {
315            Self::InternalServerError(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
316            Self::InvalidEndpointException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
317            Self::ResourceNotFoundException(e) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(e),
318            Self::Unhandled(e) => &e.meta,
319        }
320    }
321    /// Returns `true` if the error kind is `DescribeTimeToLiveError::InternalServerError`.
322    pub fn is_internal_server_error(&self) -> bool {
323        matches!(self, Self::InternalServerError(_))
324    }
325    /// Returns `true` if the error kind is `DescribeTimeToLiveError::InvalidEndpointException`.
326    pub fn is_invalid_endpoint_exception(&self) -> bool {
327        matches!(self, Self::InvalidEndpointException(_))
328    }
329    /// Returns `true` if the error kind is `DescribeTimeToLiveError::ResourceNotFoundException`.
330    pub fn is_resource_not_found_exception(&self) -> bool {
331        matches!(self, Self::ResourceNotFoundException(_))
332    }
333}
334impl ::std::error::Error for DescribeTimeToLiveError {
335    fn source(&self) -> ::std::option::Option<&(dyn ::std::error::Error + 'static)> {
336        match self {
337            Self::InternalServerError(_inner) => ::std::option::Option::Some(_inner),
338            Self::InvalidEndpointException(_inner) => ::std::option::Option::Some(_inner),
339            Self::ResourceNotFoundException(_inner) => ::std::option::Option::Some(_inner),
340            Self::Unhandled(_inner) => ::std::option::Option::Some(&*_inner.source),
341        }
342    }
343}
344impl ::std::fmt::Display for DescribeTimeToLiveError {
345    fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> ::std::fmt::Result {
346        match self {
347            Self::InternalServerError(_inner) => _inner.fmt(f),
348            Self::InvalidEndpointException(_inner) => _inner.fmt(f),
349            Self::ResourceNotFoundException(_inner) => _inner.fmt(f),
350            Self::Unhandled(_inner) => {
351                if let ::std::option::Option::Some(code) = ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self) {
352                    write!(f, "unhandled error ({code})")
353                } else {
354                    f.write_str("unhandled error")
355                }
356            }
357        }
358    }
359}
360impl ::aws_smithy_types::retry::ProvideErrorKind for DescribeTimeToLiveError {
361    fn code(&self) -> ::std::option::Option<&str> {
362        ::aws_smithy_types::error::metadata::ProvideErrorMetadata::code(self)
363    }
364    fn retryable_error_kind(&self) -> ::std::option::Option<::aws_smithy_types::retry::ErrorKind> {
365        ::std::option::Option::None
366    }
367}
368impl ::aws_smithy_types::error::metadata::ProvideErrorMetadata for DescribeTimeToLiveError {
369    fn meta(&self) -> &::aws_smithy_types::error::ErrorMetadata {
370        match self {
371            Self::InternalServerError(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
372            Self::InvalidEndpointException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
373            Self::ResourceNotFoundException(_inner) => ::aws_smithy_types::error::metadata::ProvideErrorMetadata::meta(_inner),
374            Self::Unhandled(_inner) => &_inner.meta,
375        }
376    }
377}
378impl ::aws_smithy_runtime_api::client::result::CreateUnhandledError for DescribeTimeToLiveError {
379    fn create_unhandled_error(
380        source: ::std::boxed::Box<dyn ::std::error::Error + ::std::marker::Send + ::std::marker::Sync + 'static>,
381        meta: ::std::option::Option<::aws_smithy_types::error::ErrorMetadata>,
382    ) -> Self {
383        Self::Unhandled(crate::error::sealed_unhandled::Unhandled {
384            source,
385            meta: meta.unwrap_or_default(),
386        })
387    }
388}
389impl ::aws_types::request_id::RequestId for crate::operation::describe_time_to_live::DescribeTimeToLiveError {
390    fn request_id(&self) -> Option<&str> {
391        self.meta().request_id()
392    }
393}
394
395pub use crate::operation::describe_time_to_live::_describe_time_to_live_output::DescribeTimeToLiveOutput;
396
397pub use crate::operation::describe_time_to_live::_describe_time_to_live_input::DescribeTimeToLiveInput;
398
399mod _describe_time_to_live_input;
400
401mod _describe_time_to_live_output;
402
403/// Builders
404pub mod builders;
aws_sdk_dynamodb/operation/describe_time_to_live.rs

aws_sdk_dynamodb/operation/
describe_time_to_live.rs
