aws_sdk_dynamodb/operation/
describe_global_table.rs

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

aws_sdk_dynamodb/operation/
describe_global_table.rs
