aws_sdk_dynamodb/operation/
describe_table.rs

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

aws_sdk_dynamodb/operation/
describe_table.rs
